@northstake/northstakeapi 1.0.19 → 1.0.20

package/.openapi-generator/FILES

@@ -103,6 +103,8 @@ model/webhookPayloadRFQValidatorExited.ts
 model/webhookPayloadRFQValidatorExitedDetails.ts
 model/webhookPayloadRFQValidatorWithdrawalChange.ts
 model/webhookPayloadRFQValidatorWithdrawalChangeDetails.ts
+model/webhookPayloadRFQWithdrawalClaimable.ts
+model/webhookPayloadRFQWithdrawalClaimableDetails.ts
 model/webhookRegistration.ts
 model/webhookRegistrationDetails.ts
 model/withdrawalRecipientSettlement.ts

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.7.0-SNAPSHOT
+7.8.0-SNAPSHOT

package/api/validatorMarketplaceWebhooksApi.ts

@@ -264,7 +264,7 @@ export class ValidatorMarketplaceWebhooksApi {
     } )
 }
     /**
-     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\"       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source. 
+     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\",       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source. 
      * @summary Register a webhook to track Northstake validator marketplace events
      * @param webhookRegistration 
      */

package/api.ts

@@ -99,6 +99,8 @@ export * from './model/./webhookPayloadRFQValidatorExited';
 export * from './model/./webhookPayloadRFQValidatorExitedDetails';
 export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
 export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
+export * from './model/./webhookPayloadRFQWithdrawalClaimable';
+export * from './model/./webhookPayloadRFQWithdrawalClaimableDetails';
 export * from './model/./webhookRegistration';
 export * from './model/./webhookRegistrationDetails';
 export * from './model/./withdrawalRecipientSettlement';

package/dist/api/apis.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export * from './accountApi';
 import { AccountApi } from './accountApi';
 export * from './depositAddressesApi';

package/dist/api/validatorMarketplaceWebhooksApi.d.ts

@@ -62,7 +62,7 @@ export declare class ValidatorMarketplaceWebhooksApi {
         status: number;
     }>;
     /**
-     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\"       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
+     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\",       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
      * @summary Register a webhook to track Northstake validator marketplace events
      * @param webhookRegistration
      */

package/dist/api/validatorMarketplaceWebhooksApi.js

@@ -203,7 +203,7 @@ class ValidatorMarketplaceWebhooksApi {
         });
     }
     /**
-     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\"       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
+     * Registers a webhook URL for receiving push notifications from Northstake regarding events in the Validator Marketplace. When registered events occur, webhooks are triggered, and JSON payloads are sent as POST requests to the specified URL.  A webhook can subscribe to different event types. Here are descriptions and example payloads for each supported event. These payloads are what will be POST\'ed to your Webhook endpoint.  (For more details regarding webhook payloads, refer to the schemas for the WebhookPayload_XXXX types in documentation)  - `RFQAvailable`: Triggered when a new RFQ document becomes available. The payload includes detailed information about validators, their balances, exit estimates, and other RFQ-specific details.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQAvailable\",     \"details\": {       \"id\": \"rfq123\",       \"validators\": [         {           \"validator_index\": 1,           \"balance\": 32,           \"exit_estimates\": [             {               \"estimated_exit_time\": \"2025-03-01T12:00:00Z\",               \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",               \"timestamp\": \"2024-03-01T12:00:00Z\"             }           ]         }       ],       \"total_balance\": 32,       \"payment_address\": \"0xabcd\",       \"estimated_exit_transaction_deadline\": \"2025-03-01T12:00:00Z\",       \"estimated_all_validators_exited_at\": \"2025-03-01T12:00:00Z\",       \"unique_escrow_vault\": \"vault123\"     }   }   ```  - `RFQBidReceived`: Triggered when a new bid is received on an RFQ. Includes the latest quote ID and the bid amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidReceived\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-01T13:00:00Z\"     }   }   ```  - `RFQBidAccepted`: Triggered when a bid is accepted. Includes the quote ID and the accepted amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQBidAccepted\",     \"details\": {       \"quote_id\": \"quote789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-02T14:30:00Z\",       \"escrow_address\": \"0x12345\"     }   }   ```  - `RFQEscrowEvent`: Triggered when an escrow payment is made. Includes transaction hash and payment amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowEvent\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"amount\": 5000,       \"timestamp\": \"2024-03-03T15:45:00Z\"     }   }   ```  - `RFQTransferProposalReceived`: Notifies an RFQ seller of a new transfer proposal on their RFQ   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQTransferProposalReceived\",     \"details\": {       \"transaction_hash\": \"0xabc123\",       \"timestamp\": \"2024-03-03T15:45:00Z\",       \"proposal_id\": \"0x12345\"\"     }   }   ```  - `RFQValidatorWithdrawalChange`: Triggered when a validator withdrawal status changes. Includes transaction hash and validator index.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorWithdrawalChange\",     \"details\": [{       \"transaction_hash\": \"0xdef456\",       \"validator_index\": 1,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     {       \"transaction_hash\": \"0xdef457\",       \"validator_index\": 2,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },                 {       \"transaction_hash\": \"0xdef458\",       \"validator_index\": 3,       \"timestamp\": \"2024-03-04T16:50:00Z\"     },     ]   }   ```  - `RFQEscrowReleased`: Triggered when escrow funds are released. Includes transaction hash and the released amount.   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQEscrowReleased\",     \"details\": {       \"transaction_hash\": \"0xghi789\",       \"amount\": 5000,       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  - `RFQValidatorExited `: Notifies the owner whenever a validator exits the ethereum network   ```json   {     \"document_id\": \"rfq123\",     \"event\": \"RFQValidatorExited\",     \"details\": {       \"validator_index\": \"0xghi789\",       \"timestamp\": \"2024-03-05T17:55:00Z\"     }   }   ```  **Webhook Security Note:** All webhook requests include a `Bearer` token in the `Authorization` header. Recipients must validate this token to ensure the notifications are from a trusted source.
      * @summary Register a webhook to track Northstake validator marketplace events
      * @param webhookRegistration
      */

package/dist/api.d.ts

@@ -97,6 +97,8 @@ export * from './model/./webhookPayloadRFQValidatorExited';
 export * from './model/./webhookPayloadRFQValidatorExitedDetails';
 export * from './model/./webhookPayloadRFQValidatorWithdrawalChange';
 export * from './model/./webhookPayloadRFQValidatorWithdrawalChangeDetails';
+export * from './model/./webhookPayloadRFQWithdrawalClaimable';
+export * from './model/./webhookPayloadRFQWithdrawalClaimableDetails';
 export * from './model/./webhookRegistration';
 export * from './model/./webhookRegistrationDetails';
 export * from './model/./withdrawalRecipientSettlement';

package/dist/api.js

@@ -116,6 +116,8 @@ __exportStar(require("./model/./webhookPayloadRFQValidatorExited"), exports);
 __exportStar(require("./model/./webhookPayloadRFQValidatorExitedDetails"), exports);
 __exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChange"), exports);
 __exportStar(require("./model/./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
+__exportStar(require("./model/./webhookPayloadRFQWithdrawalClaimable"), exports);
+__exportStar(require("./model/./webhookPayloadRFQWithdrawalClaimableDetails"), exports);
 __exportStar(require("./model/./webhookRegistration"), exports);
 __exportStar(require("./model/./webhookRegistrationDetails"), exports);
 __exportStar(require("./model/./withdrawalRecipientSettlement"), exports);

package/dist/model/models.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import localVarRequest from 'request';
 export * from './acceptedQuote';
 export * from './accountEntity';
@@ -83,6 +81,8 @@ export * from './webhookPayloadRFQValidatorExited';
 export * from './webhookPayloadRFQValidatorExitedDetails';
 export * from './webhookPayloadRFQValidatorWithdrawalChange';
 export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
+export * from './webhookPayloadRFQWithdrawalClaimable';
+export * from './webhookPayloadRFQWithdrawalClaimableDetails';
 export * from './webhookRegistration';
 export * from './webhookRegistrationDetails';
 export * from './withdrawalRecipientSettlement';

package/dist/model/models.js

@@ -110,6 +110,8 @@ __exportStar(require("./webhookPayloadRFQValidatorExited"), exports);
 __exportStar(require("./webhookPayloadRFQValidatorExitedDetails"), exports);
 __exportStar(require("./webhookPayloadRFQValidatorWithdrawalChange"), exports);
 __exportStar(require("./webhookPayloadRFQValidatorWithdrawalChangeDetails"), exports);
+__exportStar(require("./webhookPayloadRFQWithdrawalClaimable"), exports);
+__exportStar(require("./webhookPayloadRFQWithdrawalClaimableDetails"), exports);
 __exportStar(require("./webhookRegistration"), exports);
 __exportStar(require("./webhookRegistrationDetails"), exports);
 __exportStar(require("./withdrawalRecipientSettlement"), exports);
@@ -187,6 +189,8 @@ const webhookPayloadRFQValidatorExited_1 = require("./webhookPayloadRFQValidator
 const webhookPayloadRFQValidatorExitedDetails_1 = require("./webhookPayloadRFQValidatorExitedDetails");
 const webhookPayloadRFQValidatorWithdrawalChange_1 = require("./webhookPayloadRFQValidatorWithdrawalChange");
 const webhookPayloadRFQValidatorWithdrawalChangeDetails_1 = require("./webhookPayloadRFQValidatorWithdrawalChangeDetails");
+const webhookPayloadRFQWithdrawalClaimable_1 = require("./webhookPayloadRFQWithdrawalClaimable");
+const webhookPayloadRFQWithdrawalClaimableDetails_1 = require("./webhookPayloadRFQWithdrawalClaimableDetails");
 const webhookRegistration_1 = require("./webhookRegistration");
 const webhookRegistrationDetails_1 = require("./webhookRegistrationDetails");
 const withdrawalRecipientSettlement_1 = require("./withdrawalRecipientSettlement");
@@ -281,6 +285,8 @@ let typeMap = {
     "WebhookPayloadRFQValidatorExitedDetails": webhookPayloadRFQValidatorExitedDetails_1.WebhookPayloadRFQValidatorExitedDetails,
     "WebhookPayloadRFQValidatorWithdrawalChange": webhookPayloadRFQValidatorWithdrawalChange_1.WebhookPayloadRFQValidatorWithdrawalChange,
     "WebhookPayloadRFQValidatorWithdrawalChangeDetails": webhookPayloadRFQValidatorWithdrawalChangeDetails_1.WebhookPayloadRFQValidatorWithdrawalChangeDetails,
+    "WebhookPayloadRFQWithdrawalClaimable": webhookPayloadRFQWithdrawalClaimable_1.WebhookPayloadRFQWithdrawalClaimable,
+    "WebhookPayloadRFQWithdrawalClaimableDetails": webhookPayloadRFQWithdrawalClaimableDetails_1.WebhookPayloadRFQWithdrawalClaimableDetails,
     "WebhookRegistration": webhookRegistration_1.WebhookRegistration,
     "WebhookRegistrationDetails": webhookRegistrationDetails_1.WebhookRegistrationDetails,
     "WithdrawalRecipientSettlement": withdrawalRecipientSettlement_1.WithdrawalRecipientSettlement,

package/dist/model/rFQWebhookEventType.d.ts

@@ -12,4 +12,4 @@
 /**
 * The types of events a webhook may subscribe to
 */
-export type RFQWebhookEventType = 'RFQAvailable' | 'RFQBidReceived' | 'RFQBidAccepted' | 'RFQEscrowEvent' | 'RFQTransferProposalReceived' | 'RFQValidatorWithdrawalChange' | 'RFQEscrowReleased' | 'RFQValidatorExited';
+export type RFQWebhookEventType = 'RFQAvailable' | 'RFQBidReceived' | 'RFQBidAccepted' | 'RFQEscrowEvent' | 'RFQTransferProposalReceived' | 'RFQValidatorWithdrawalChange' | 'RFQEscrowReleased' | 'RFQValidatorExited' | 'RFQWithdrawalClaimable';

package/dist/model/webhookPayloadRFQWithdrawalClaimable.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RFQWebhookEventType } from './rFQWebhookEventType';
+import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
+export declare class WebhookPayloadRFQWithdrawalClaimable {
+    'document_id'?: string;
+    'event'?: RFQWebhookEventType;
+    'details'?: WebhookPayloadRFQWithdrawalClaimableDetails;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}
+export declare namespace WebhookPayloadRFQWithdrawalClaimable {
+}

package/dist/model/webhookPayloadRFQWithdrawalClaimable.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookPayloadRFQWithdrawalClaimable = void 0;
+class WebhookPayloadRFQWithdrawalClaimable {
+    static getAttributeTypeMap() {
+        return WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap;
+    }
+}
+exports.WebhookPayloadRFQWithdrawalClaimable = WebhookPayloadRFQWithdrawalClaimable;
+WebhookPayloadRFQWithdrawalClaimable.discriminator = undefined;
+WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap = [
+    {
+        "name": "document_id",
+        "baseName": "document_id",
+        "type": "string"
+    },
+    {
+        "name": "event",
+        "baseName": "event",
+        "type": "RFQWebhookEventType"
+    },
+    {
+        "name": "details",
+        "baseName": "details",
+        "type": "WebhookPayloadRFQWithdrawalClaimableDetails"
+    }
+];

package/dist/model/webhookPayloadRFQWithdrawalClaimableDetails.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare class WebhookPayloadRFQWithdrawalClaimableDetails {
+    'validator_index'?: number;
+    'amount'?: number;
+    'timestamp'?: Date;
+    'beneficiary_address'?: string;
+    'block'?: number;
+    static discriminator: string | undefined;
+    static attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+    }[];
+}

package/dist/model/webhookPayloadRFQWithdrawalClaimableDetails.js

@@ -0,0 +1,48 @@
+"use strict";
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookPayloadRFQWithdrawalClaimableDetails = void 0;
+class WebhookPayloadRFQWithdrawalClaimableDetails {
+    static getAttributeTypeMap() {
+        return WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap;
+    }
+}
+exports.WebhookPayloadRFQWithdrawalClaimableDetails = WebhookPayloadRFQWithdrawalClaimableDetails;
+WebhookPayloadRFQWithdrawalClaimableDetails.discriminator = undefined;
+WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap = [
+    {
+        "name": "validator_index",
+        "baseName": "validator_index",
+        "type": "number"
+    },
+    {
+        "name": "amount",
+        "baseName": "amount",
+        "type": "number"
+    },
+    {
+        "name": "timestamp",
+        "baseName": "timestamp",
+        "type": "Date"
+    },
+    {
+        "name": "beneficiary_address",
+        "baseName": "beneficiary_address",
+        "type": "string"
+    },
+    {
+        "name": "block",
+        "baseName": "block",
+        "type": "number"
+    }
+];

package/model/models.ts

@@ -84,6 +84,8 @@ export * from './webhookPayloadRFQValidatorExited';
 export * from './webhookPayloadRFQValidatorExitedDetails';
 export * from './webhookPayloadRFQValidatorWithdrawalChange';
 export * from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
+export * from './webhookPayloadRFQWithdrawalClaimable';
+export * from './webhookPayloadRFQWithdrawalClaimableDetails';
 export * from './webhookRegistration';
 export * from './webhookRegistrationDetails';
 export * from './withdrawalRecipientSettlement';
@@ -350,6 +352,12 @@ import { WebhookPayloadRFQValidatorWithdrawalChange } from './webhookPayloadRFQV
 import { WebhookPayloadRFQValidatorWithdrawalChangeDetails } from './webhookPayloadRFQValidatorWithdrawalChangeDetails';
 
 
+import { WebhookPayloadRFQWithdrawalClaimable } from './webhookPayloadRFQWithdrawalClaimable';
+
+
+import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
+
+
 import { WebhookRegistration } from './webhookRegistration';
 
 
@@ -458,6 +466,8 @@ let typeMap: {[index: string]: any} = {
     "WebhookPayloadRFQValidatorExitedDetails": WebhookPayloadRFQValidatorExitedDetails,
     "WebhookPayloadRFQValidatorWithdrawalChange": WebhookPayloadRFQValidatorWithdrawalChange,
     "WebhookPayloadRFQValidatorWithdrawalChangeDetails": WebhookPayloadRFQValidatorWithdrawalChangeDetails,
+    "WebhookPayloadRFQWithdrawalClaimable": WebhookPayloadRFQWithdrawalClaimable,
+    "WebhookPayloadRFQWithdrawalClaimableDetails": WebhookPayloadRFQWithdrawalClaimableDetails,
     "WebhookRegistration": WebhookRegistration,
     "WebhookRegistrationDetails": WebhookRegistrationDetails,
     "WithdrawalRecipientSettlement": WithdrawalRecipientSettlement,

package/model/rFQWebhookEventType.ts

@@ -22,5 +22,6 @@ export type RFQWebhookEventType =
 'RFQTransferProposalReceived' | 
 'RFQValidatorWithdrawalChange' | 
 'RFQEscrowReleased' | 
-'RFQValidatorExited';
+'RFQValidatorExited' | 
+'RFQWithdrawalClaimable';
 

package/model/webhookPayloadRFQWithdrawalClaimable.ts

@@ -0,0 +1,47 @@
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { RFQWebhookEventType } from './rFQWebhookEventType';
+import { WebhookPayloadRFQWithdrawalClaimableDetails } from './webhookPayloadRFQWithdrawalClaimableDetails';
+
+export class WebhookPayloadRFQWithdrawalClaimable {
+   'document_id'?: string;
+   'event'?: RFQWebhookEventType;
+   'details'?: WebhookPayloadRFQWithdrawalClaimableDetails;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "document_id",
+            "baseName": "document_id",
+            "type": "string"
+        },
+        {
+            "name": "event",
+            "baseName": "event",
+            "type": "RFQWebhookEventType"
+        },
+        {
+            "name": "details",
+            "baseName": "details",
+            "type": "WebhookPayloadRFQWithdrawalClaimableDetails"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return WebhookPayloadRFQWithdrawalClaimable.attributeTypeMap;
+    }
+}
+
+export namespace WebhookPayloadRFQWithdrawalClaimable {
+}
+

package/model/webhookPayloadRFQWithdrawalClaimableDetails.ts

@@ -0,0 +1,55 @@
+/**
+ * Northstake
+ * Northstake api
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export class WebhookPayloadRFQWithdrawalClaimableDetails {
+   'validator_index'?: number;
+   'amount'?: number;
+   'timestamp'?: Date;
+   'beneficiary_address'?: string;
+   'block'?: number;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "validator_index",
+            "baseName": "validator_index",
+            "type": "number"
+        },
+        {
+            "name": "amount",
+            "baseName": "amount",
+            "type": "number"
+        },
+        {
+            "name": "timestamp",
+            "baseName": "timestamp",
+            "type": "Date"
+        },
+        {
+            "name": "beneficiary_address",
+            "baseName": "beneficiary_address",
+            "type": "string"
+        },
+        {
+            "name": "block",
+            "baseName": "block",
+            "type": "number"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return WebhookPayloadRFQWithdrawalClaimableDetails.attributeTypeMap;
+    }
+}
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@northstake/northstakeapi",
-   "version": "1.0.19",
+   "version": "1.0.20",
    "description": "Northstake SDK",
    "main": "dist/api.js",
    "types": "dist/api.d.ts",
@@ -21,7 +21,7 @@
    "author": "Northstake build process <buildadmin@northstake.dk>",
    "license": "ISC",
    "devDependencies": {
-      "@types/node": "^20.14.2",
-      "typescript": "^5.4.5"
+      "@types/node": "^22.0.2",
+      "typescript": "^5.5.4"
    }
 }