@northstake/northstakeapi 1.0.12 → 1.0.14

package/model/{validatorKeyHolderEnum.ts → rFQDocumentSellerStatusFilter.ts}

@@ -10,9 +10,13 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export enum ValidatorKeyHolderEnum {
-    Northstake = <any> 'northstake',
-    SelfManaged = <any> 'self_managed'
-}
+export type RFQDocumentSellerStatusFilter = 
+'active' | 
+'accepted' | 
+'escrow_paid' | 
+'reward_recipient_settled' | 
+'escrow_released' | 
+'rejected' | 
+'expired';
+

package/model/rFQDocumentStatus.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 type RFQDocumentStatus = 
+'active' | 
+'expired' | 
+'rejected' | 
+'finished';
+

package/model/rFQDocumentUpdate.ts

@@ -10,40 +10,39 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class RFQDocumentUpdate {
-    'bestQuote': number;
-    'liquidityId': string;
-    'sellerStatus': string;
-    'liquiditySettlementHash': string;
-    'spWithdrawalTxHash'?: string;
+   'best_quote': number;
+   'liquidity_id': string;
+   'seller_status': string;
+   'liquidity_settlement_hash': string;
+   'sp_withdrawal_tx_hash'?: string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "bestQuote",
+            "name": "best_quote",
             "baseName": "best_quote",
             "type": "number"
         },
         {
-            "name": "liquidityId",
+            "name": "liquidity_id",
             "baseName": "liquidity_id",
             "type": "string"
         },
         {
-            "name": "sellerStatus",
+            "name": "seller_status",
             "baseName": "seller_status",
             "type": "string"
         },
         {
-            "name": "liquiditySettlementHash",
+            "name": "liquidity_settlement_hash",
             "baseName": "liquidity_settlement_hash",
             "type": "string"
         },
         {
-            "name": "spWithdrawalTxHash",
+            "name": "sp_withdrawal_tx_hash",
             "baseName": "sp_withdrawal_tx_hash",
             "type": "string"
         }    ];
@@ -53,3 +52,4 @@ export class RFQDocumentUpdate {
     }
 }
 
+

package/model/rFQUpdatePayload.ts

@@ -10,21 +10,20 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class RFQUpdatePayload {
     /**
-    * Unique identifier for the RFQ document.
+    * Unique identifier for the RFQ.
     */
-    'rfqId'?: string;
+   'rfqId'?: string;
     /**
-    * New status of the RFQ document.
+    * New status of the RFQ.
     */
-    'status'?: string;
+   'status'?: string;
     /**
     * The best quote for the RFQ, if available.
     */
-    'bestQuote'?: number;
+   'bestQuote'?: number;
 
     static discriminator: string | undefined = undefined;
 
@@ -50,3 +49,4 @@ export class RFQUpdatePayload {
     }
 }
 
+

package/model/rFQWebhookEventType.ts

@@ -10,13 +10,17 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export enum RFQWebhookEventType {
-    RfqAvailable = <any> 'RFQAvailable',
-    RfqBidReceived = <any> 'RFQBidReceived',
-    RfqBidAccepted = <any> 'RFQBidAccepted',
-    RfqEscrowEvent = <any> 'RFQEscrowEvent',
-    RfqValidatorWithdrawalChange = <any> 'RFQValidatorWithdrawalChange',
-    RfqEscrowReleased = <any> 'RFQEscrowReleased'
-}
+/**
+* The types of events a webhook may subscribe to
+*/
+export type RFQWebhookEventType = 
+'RFQAvailable' | 
+'RFQBidReceived' | 
+'RFQBidAccepted' | 
+'RFQEscrowEvent' | 
+'RFQTransferProposalReceived' | 
+'RFQValidatorWithdrawalChange' | 
+'RFQEscrowReleased' | 
+'RFQValidatorExited';
+

package/model/{rejectQuoteForRFQDocumentRequest.ts → registerWithdrawalRecipientSettlementRequest.ts}

@@ -10,22 +10,22 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export class RejectQuoteForRFQDocumentRequest {
-    'quoteId': string;
+export class RegisterWithdrawalRecipientSettlementRequest {
+   'transaction_hash': string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "quoteId",
-            "baseName": "quoteId",
+            "name": "transaction_hash",
+            "baseName": "transaction_hash",
             "type": "string"
         }    ];
 
     static getAttributeTypeMap() {
-        return RejectQuoteForRFQDocumentRequest.attributeTypeMap;
+        return RegisterWithdrawalRecipientSettlementRequest.attributeTypeMap;
     }
 }
 
+

package/model/settlementStepAcceptedQuote.ts

@@ -10,18 +10,17 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class SettlementStepAcceptedQuote {
-    'quoteId': string | null;
-    'amount': number | null;
-    'timestamp': Date | null;
+   'quote_id': string | null;
+   'amount': number | null;
+   'timestamp': Date | null;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "quoteId",
+            "name": "quote_id",
             "baseName": "quote_id",
             "type": "string"
         },
@@ -41,3 +40,4 @@ export class SettlementStepAcceptedQuote {
     }
 }
 
+

package/model/settlementStepEscrowPayment.ts

@@ -10,12 +10,11 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class SettlementStepEscrowPayment {
-    'timestamp': string;
-    'transactionHash': string;
-    'amount': number;
+   'timestamp': string;
+   'transaction_hash': string;
+   'amount': number;
 
     static discriminator: string | undefined = undefined;
 
@@ -26,7 +25,7 @@ export class SettlementStepEscrowPayment {
             "type": "string"
         },
         {
-            "name": "transactionHash",
+            "name": "transaction_hash",
             "baseName": "transaction_hash",
             "type": "string"
         },
@@ -41,3 +40,4 @@ export class SettlementStepEscrowPayment {
     }
 }
 
+

package/model/settlementStepEscrowReleased.ts

@@ -10,13 +10,12 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class SettlementStepEscrowReleased {
-    'timestamp': string;
-    'transactionHash': string;
-    'amount': number;
-    'gasAmount': number;
+   'timestamp': string;
+   'transaction_hash': string;
+   'amount': number;
+   'gas_amount': number;
 
     static discriminator: string | undefined = undefined;
 
@@ -27,7 +26,7 @@ export class SettlementStepEscrowReleased {
             "type": "string"
         },
         {
-            "name": "transactionHash",
+            "name": "transaction_hash",
             "baseName": "transaction_hash",
             "type": "string"
         },
@@ -37,7 +36,7 @@ export class SettlementStepEscrowReleased {
             "type": "number"
         },
         {
-            "name": "gasAmount",
+            "name": "gas_amount",
             "baseName": "gas_amount",
             "type": "number"
         }    ];
@@ -47,3 +46,4 @@ export class SettlementStepEscrowReleased {
     }
 }
 
+

package/model/settlementStepWithdrawalRecipientSettlement.ts

@@ -10,11 +10,10 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class SettlementStepWithdrawalRecipientSettlement {
-    'timestamp': string;
-    'transactionHash': string;
+   'timestamp': string;
+   'transaction_hash': string;
 
     static discriminator: string | undefined = undefined;
 
@@ -25,7 +24,7 @@ export class SettlementStepWithdrawalRecipientSettlement {
             "type": "string"
         },
         {
-            "name": "transactionHash",
+            "name": "transaction_hash",
             "baseName": "transaction_hash",
             "type": "string"
         }    ];
@@ -35,3 +34,4 @@ export class SettlementStepWithdrawalRecipientSettlement {
     }
 }
 
+

package/model/settlementSteps.ts

@@ -10,38 +10,37 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { SettlementStepAcceptedQuote } from './settlementStepAcceptedQuote';
 import { SettlementStepEscrowPayment } from './settlementStepEscrowPayment';
 import { SettlementStepEscrowReleased } from './settlementStepEscrowReleased';
 import { SettlementStepWithdrawalRecipientSettlement } from './settlementStepWithdrawalRecipientSettlement';
 
 export class SettlementSteps {
-    'acceptedQuote'?: SettlementStepAcceptedQuote;
-    'escrowPayment'?: SettlementStepEscrowPayment;
-    'withdrawalRecipientSettlement'?: SettlementStepWithdrawalRecipientSettlement;
-    'escrowReleased'?: SettlementStepEscrowReleased;
+   'accepted_quote'?: SettlementStepAcceptedQuote;
+   'escrow_payment'?: SettlementStepEscrowPayment;
+   'withdrawal_recipient_settlement'?: SettlementStepWithdrawalRecipientSettlement;
+   'escrow_released'?: SettlementStepEscrowReleased;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "acceptedQuote",
+            "name": "accepted_quote",
             "baseName": "accepted_quote",
             "type": "SettlementStepAcceptedQuote"
         },
         {
-            "name": "escrowPayment",
+            "name": "escrow_payment",
             "baseName": "escrow_payment",
             "type": "SettlementStepEscrowPayment"
         },
         {
-            "name": "withdrawalRecipientSettlement",
+            "name": "withdrawal_recipient_settlement",
             "baseName": "withdrawal_recipient_settlement",
             "type": "SettlementStepWithdrawalRecipientSettlement"
         },
         {
-            "name": "escrowReleased",
+            "name": "escrow_released",
             "baseName": "escrow_released",
             "type": "SettlementStepEscrowReleased"
         }    ];
@@ -51,3 +50,4 @@ export class SettlementSteps {
     }
 }
 
+

package/model/{getTransactionStatistics200ResponseInner.ts → smartContract.ts}

@@ -10,52 +10,58 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
+import { Asset } from './asset';
 
-export class GetTransactionStatistics200ResponseInner {
-    'date'?: Date;
-    'type'?: string;
-    'amount'?: number;
-    'currency'?: string;
-    'transactionId'?: string;
-    'status'?: string;
+/**
+* Details about a smart contract including name, asset, address and type.
+*/
+export class SmartContract {
+   'name': string;
+   'asset': Asset;
+   'address': string;
+   'type'?: string;
+   'deployedAt': Date;
+   'deployedBy'?: string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "date",
-            "baseName": "date",
-            "type": "Date"
-        },
-        {
-            "name": "type",
-            "baseName": "type",
+            "name": "name",
+            "baseName": "name",
             "type": "string"
         },
         {
-            "name": "amount",
-            "baseName": "amount",
-            "type": "number"
+            "name": "asset",
+            "baseName": "asset",
+            "type": "Asset"
         },
         {
-            "name": "currency",
-            "baseName": "currency",
+            "name": "address",
+            "baseName": "address",
             "type": "string"
         },
         {
-            "name": "transactionId",
-            "baseName": "transactionId",
+            "name": "type",
+            "baseName": "type",
             "type": "string"
         },
         {
-            "name": "status",
-            "baseName": "status",
+            "name": "deployedAt",
+            "baseName": "deployedAt",
+            "type": "Date"
+        },
+        {
+            "name": "deployedBy",
+            "baseName": "deployedBy",
             "type": "string"
         }    ];
 
     static getAttributeTypeMap() {
-        return GetTransactionStatistics200ResponseInner.attributeTypeMap;
+        return SmartContract.attributeTypeMap;
     }
 }
 
+export namespace SmartContract {
+}
+

package/model/stakeStep.ts

@@ -10,17 +10,16 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class StakeStep {
     /**
     * Specifies current status of the staking process.
     */
-    'type'?: string;
+   'type'?: string;
     /**
     * The timestamp when the step was processed.
     */
-    'timestamp'?: Date;
+   'timestamp'?: Date;
 
     static discriminator: string | undefined = undefined;
 
@@ -41,3 +40,4 @@ export class StakeStep {
     }
 }
 
+

package/model/stakeStepElement.ts

@@ -10,13 +10,12 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { StakeStep } from './stakeStep';
 import { StepStatus } from './stepStatus';
 
 export class StakeStepElement {
-    'steps'?: Array<StakeStep>;
-    'status'?: StepStatus;
+   'steps'?: Array<StakeStep>;
+   'status'?: StepStatus;
 
     static discriminator: string | undefined = undefined;
 
@@ -39,3 +38,4 @@ export class StakeStepElement {
 
 export namespace StakeStepElement {
 }
+

package/model/stepStatus.ts

@@ -10,13 +10,12 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 /**
 * Current status of the staking processing sequence.
 */
-export enum StepStatus {
-    Running = <any> 'running',
-    Done = <any> 'done',
-    Failed = <any> 'failed'
-}
+export type StepStatus = 
+'running' | 
+'done' | 
+'failed';
+

package/model/{submitQuoteForRFQDocumentRequest.ts → submittedQuote.ts}

@@ -10,22 +10,22 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export class SubmitQuoteForRFQDocumentRequest {
-    'ethAmount': number;
+export class SubmittedQuote {
+   'eth_amount': number;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "ethAmount",
+            "name": "eth_amount",
             "baseName": "eth_amount",
             "type": "number"
         }    ];
 
     static getAttributeTypeMap() {
-        return SubmitQuoteForRFQDocumentRequest.attributeTypeMap;
+        return SubmittedQuote.attributeTypeMap;
     }
 }
 
+

package/model/transaction.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { Asset } from './asset';
+import { TransactionEventType } from './transactionEventType';
+
+/**
+* Details of transactions including type, amount, and asset.
+*/
+export class Transaction {
+    /**
+    * The date and time when the transaction occurred.
+    */
+   'eventTime': Date;
+   'eventType': TransactionEventType;
+    /**
+    * Asset amount involved in the transaction.
+    */
+   'assetAmount': number;
+   'asset': Asset;
+    /**
+    * Unique identifier for the order associated with the transaction.
+    */
+   'orderId'?: string;
+    /**
+    * Unique identifier for the transaction.
+    */
+   'eventId'?: string;
+
+    static discriminator: string | undefined = undefined;
+
+    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            "name": "eventTime",
+            "baseName": "eventTime",
+            "type": "Date"
+        },
+        {
+            "name": "eventType",
+            "baseName": "eventType",
+            "type": "TransactionEventType"
+        },
+        {
+            "name": "assetAmount",
+            "baseName": "assetAmount",
+            "type": "number"
+        },
+        {
+            "name": "asset",
+            "baseName": "asset",
+            "type": "Asset"
+        },
+        {
+            "name": "orderId",
+            "baseName": "orderId",
+            "type": "string"
+        },
+        {
+            "name": "eventId",
+            "baseName": "eventId",
+            "type": "string"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return Transaction.attributeTypeMap;
+    }
+}
+
+export namespace Transaction {
+}
+

package/model/transactionEventType.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+
+
+/**
+* Supported transaction types.
+*/
+export type TransactionEventType = 
+'stake' | 
+'unstake' | 
+'withdrawal' | 
+'deposit' | 
+'reward';
+