@northstake/northstakeapi 1.0.12 → 1.0.13

package/model/orderDocument.ts

@@ -10,20 +10,24 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
+import { EthereumValidatorKey } from './ethereumValidatorKey';
 import { OrderDocumentSteps } from './orderDocumentSteps';
 import { TokenEnum } from './tokenEnum';
 import { Wallet } from './wallet';
 
+/**
+* Detailed information about a specific order.
+*/
 export class OrderDocument {
-    'orderId': string;
-    'userId': string;
-    'type': OrderDocument.TypeEnum;
-    'amount': number;
-    'token': TokenEnum;
-    'status'?: OrderDocument.StatusEnum;
-    'targetWallet'?: Wallet;
-    'steps'?: OrderDocumentSteps;
+   'orderId': string;
+   'userId': string;
+   'type': OrderDocument;
+   'amount'?: number;
+   'asset': TokenEnum;
+   'status'?: OrderDocument;
+   'targetWallet'?: Wallet;
+   'validatorKey'?: EthereumValidatorKey | null;
+   'steps'?: OrderDocumentSteps;
 
     static discriminator: string | undefined = undefined;
 
@@ -49,8 +53,8 @@ export class OrderDocument {
             "type": "number"
         },
         {
-            "name": "token",
-            "baseName": "token",
+            "name": "asset",
+            "baseName": "asset",
             "type": "TokenEnum"
         },
         {
@@ -63,6 +67,11 @@ export class OrderDocument {
             "baseName": "targetWallet",
             "type": "Wallet"
         },
+        {
+            "name": "validatorKey",
+            "baseName": "validatorKey",
+            "type": "EthereumValidatorKey"
+        },
         {
             "name": "steps",
             "baseName": "steps",
@@ -75,18 +84,23 @@ export class OrderDocument {
 }
 
 export namespace OrderDocument {
-    export enum TypeEnum {
-        Stake = <any> 'stake',
-        Unstake = <any> 'unstake',
-        Withdraw = <any> 'withdraw'
-    }
-    export enum StatusEnum {
-        Cancelled = <any> 'cancelled',
-        Completed = <any> 'completed',
-        Accepted = <any> 'accepted',
-        Submitted = <any> 'submitted',
-        Pending = <any> 'pending',
-        Failed = <any> 'failed',
-        Rejected = <any> 'rejected'
-    }
+/**
+* 
+*/
+export type typeEnum = 
+'stake' | 
+'unstake' | 
+'withdraw';
+/**
+* 
+*/
+export type statusEnum = 
+'cancelled' | 
+'completed' | 
+'accepted' | 
+'submitted' | 
+'pending' | 
+'failed' | 
+'rejected';
 }
+

package/model/orderDocumentSteps.ts

@@ -10,7 +10,6 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { StakeStepElement } from './stakeStepElement';
 import { StepStatus } from './stepStatus';
 import { UnstakeStep } from './unstakeStep';
@@ -18,8 +17,8 @@ import { UnstakeStepElement } from './unstakeStepElement';
 import { WithdrawalStepElement } from './withdrawalStepElement';
 
 export class OrderDocumentSteps {
-    'steps'?: Array<UnstakeStep>;
-    'status'?: StepStatus;
+   'steps'?: Array<UnstakeStep>;
+   'status'?: StepStatus;
 
     static discriminator: string | undefined = undefined;
 
@@ -42,3 +41,4 @@ export class OrderDocumentSteps {
 
 export namespace OrderDocumentSteps {
 }
+

package/model/orderUpdatePayload.ts

@@ -10,21 +10,20 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class OrderUpdatePayload {
     /**
     * Unique identifier for the updated order.
     */
-    'orderId'?: string;
+   'orderId'?: string;
     /**
     * New status of the order.
     */
-    'status'?: string;
+   'status'?: string;
     /**
     * Additional details regarding the order update.
     */
-    'details'?: object;
+   'details'?: object;
 
     static discriminator: string | undefined = undefined;
 
@@ -50,3 +49,4 @@ export class OrderUpdatePayload {
     }
 }
 
+

package/model/portfolioEntity.ts

@@ -10,13 +10,15 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { TokenEnum } from './tokenEnum';
 
+/**
+* Overview of a managed user\'s account portfolio.
+*/
 export class PortfolioEntity {
-    'asset': TokenEnum;
-    'totalAmount': string;
-    'stakedAmount': string;
+   'asset': TokenEnum;
+   'totalAmount': string;
+   'stakedAmount': string;
 
     static discriminator: string | undefined = undefined;
 
@@ -44,3 +46,4 @@ export class PortfolioEntity {
 
 export namespace PortfolioEntity {
 }
+

package/model/provideEscrowHashForRFQDocumentRequest.ts

@@ -10,16 +10,15 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class ProvideEscrowHashForRFQDocumentRequest {
-    'transactionHash': string;
+   'transaction_hash': string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "transactionHash",
+            "name": "transaction_hash",
             "baseName": "transaction_hash",
             "type": "string"
         }    ];
@@ -29,3 +28,4 @@ export class ProvideEscrowHashForRFQDocumentRequest {
     }
 }
 
+

package/model/quote.ts

@@ -10,18 +10,17 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class Quote {
-    'quoteId': string;
-    'quote': number;
-    'timestamp': Date;
+   'quote_id': string;
+   'quote': number;
+   'timestamp': Date;
 
     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 Quote {
     }
 }
 
+

package/model/rFQBids.ts

@@ -10,24 +10,23 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class RFQBids {
-    'rfqId': string;
-    'liquidityProviderId': string;
-    'quote': number;
-    'settlementHash': string;
+   'rfq_id': string;
+   'liquidity_provider_id': string;
+   'quote': number;
+   'settlement_hash': string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "rfqId",
+            "name": "rfq_id",
             "baseName": "rfq_id",
             "type": "string"
         },
         {
-            "name": "liquidityProviderId",
+            "name": "liquidity_provider_id",
             "baseName": "liquidity_provider_id",
             "type": "string"
         },
@@ -37,7 +36,7 @@ export class RFQBids {
             "type": "number"
         },
         {
-            "name": "settlementHash",
+            "name": "settlement_hash",
             "baseName": "settlement_hash",
             "type": "string"
         }    ];
@@ -47,3 +46,4 @@ export class RFQBids {
     }
 }
 
+

package/model/rFQDocumentBase.ts

@@ -10,19 +10,18 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { RFQDocumentBaseUniqueEscrowVault } from './rFQDocumentBaseUniqueEscrowVault';
 import { RFQDocumentStatusEnum } from './rFQDocumentStatusEnum';
 import { SettlementSteps } from './settlementSteps';
 
 export class RFQDocumentBase {
-    'id': string;
-    'status': RFQDocumentStatusEnum;
-    'totalBalance': number;
-    'paymentAddress': string;
-    'estimatedAllValidatorsExitedAt': Date;
-    'uniqueEscrowVault'?: RFQDocumentBaseUniqueEscrowVault;
-    'settlementSteps'?: SettlementSteps;
+   'id': string;
+   'status': RFQDocumentStatusEnum;
+   'total_balance': number;
+   'payment_address': string;
+   'estimated_all_validators_exited_at': Date;
+   'unique_escrow_vault'?: RFQDocumentBaseUniqueEscrowVault;
+   'settlement_steps'?: SettlementSteps;
 
     static discriminator: string | undefined = undefined;
 
@@ -38,27 +37,27 @@ export class RFQDocumentBase {
             "type": "RFQDocumentStatusEnum"
         },
         {
-            "name": "totalBalance",
+            "name": "total_balance",
             "baseName": "total_balance",
             "type": "number"
         },
         {
-            "name": "paymentAddress",
+            "name": "payment_address",
             "baseName": "payment_address",
             "type": "string"
         },
         {
-            "name": "estimatedAllValidatorsExitedAt",
+            "name": "estimated_all_validators_exited_at",
             "baseName": "estimated_all_validators_exited_at",
             "type": "Date"
         },
         {
-            "name": "uniqueEscrowVault",
+            "name": "unique_escrow_vault",
             "baseName": "unique_escrow_vault",
             "type": "RFQDocumentBaseUniqueEscrowVault"
         },
         {
-            "name": "settlementSteps",
+            "name": "settlement_steps",
             "baseName": "settlement_steps",
             "type": "SettlementSteps"
         }    ];
@@ -70,3 +69,4 @@ export class RFQDocumentBase {
 
 export namespace RFQDocumentBase {
 }
+

package/model/rFQDocumentBaseUniqueEscrowVault.ts

@@ -10,16 +10,15 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
 export class RFQDocumentBaseUniqueEscrowVault {
-    'vaultAddress': string;
+   'vault_address': string;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "vaultAddress",
+            "name": "vault_address",
             "baseName": "vault_address",
             "type": "string"
         }    ];
@@ -29,3 +28,4 @@ export class RFQDocumentBaseUniqueEscrowVault {
     }
 }
 
+

package/model/rFQDocumentBuyer.ts

@@ -10,7 +10,6 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { Quote } from './quote';
 import { RFQDocumentBaseUniqueEscrowVault } from './rFQDocumentBaseUniqueEscrowVault';
 import { RFQDocumentBuyerAllOfValidators } from './rFQDocumentBuyerAllOfValidators';
@@ -18,15 +17,15 @@ import { RFQDocumentStatusEnum } from './rFQDocumentStatusEnum';
 import { SettlementSteps } from './settlementSteps';
 
 export class RFQDocumentBuyer {
-    'id': string;
-    'status': RFQDocumentStatusEnum;
-    'totalBalance': number;
-    'paymentAddress': string;
-    'estimatedAllValidatorsExitedAt': Date;
-    'uniqueEscrowVault'?: RFQDocumentBaseUniqueEscrowVault;
-    'settlementSteps'?: SettlementSteps;
-    'validators': Array<RFQDocumentBuyerAllOfValidators>;
-    'quote'?: Quote;
+   'id': string;
+   'status': RFQDocumentStatusEnum;
+   'total_balance': number;
+   'payment_address': string;
+   'estimated_all_validators_exited_at': Date;
+   'unique_escrow_vault'?: RFQDocumentBaseUniqueEscrowVault;
+   'settlement_steps'?: SettlementSteps;
+   'validators': Array<RFQDocumentBuyerAllOfValidators>;
+   'quote'?: Quote;
 
     static discriminator: string | undefined = undefined;
 
@@ -42,27 +41,27 @@ export class RFQDocumentBuyer {
             "type": "RFQDocumentStatusEnum"
         },
         {
-            "name": "totalBalance",
+            "name": "total_balance",
             "baseName": "total_balance",
             "type": "number"
         },
         {
-            "name": "paymentAddress",
+            "name": "payment_address",
             "baseName": "payment_address",
             "type": "string"
         },
         {
-            "name": "estimatedAllValidatorsExitedAt",
+            "name": "estimated_all_validators_exited_at",
             "baseName": "estimated_all_validators_exited_at",
             "type": "Date"
         },
         {
-            "name": "uniqueEscrowVault",
+            "name": "unique_escrow_vault",
             "baseName": "unique_escrow_vault",
             "type": "RFQDocumentBaseUniqueEscrowVault"
         },
         {
-            "name": "settlementSteps",
+            "name": "settlement_steps",
             "baseName": "settlement_steps",
             "type": "SettlementSteps"
         },
@@ -84,3 +83,4 @@ export class RFQDocumentBuyer {
 
 export namespace RFQDocumentBuyer {
 }
+

package/model/rFQDocumentBuyerAllOfValidators.ts

@@ -10,19 +10,18 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { ExitEstimateBase } from './exitEstimateBase';
 
 export class RFQDocumentBuyerAllOfValidators {
-    'validatorIndex': number;
-    'balance': number;
-    'exitEstimate': ExitEstimateBase;
+   'validator_index': number;
+   'balance': number;
+   'exit_estimate': ExitEstimateBase;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "validatorIndex",
+            "name": "validator_index",
             "baseName": "validator_index",
             "type": "number"
         },
@@ -32,7 +31,7 @@ export class RFQDocumentBuyerAllOfValidators {
             "type": "number"
         },
         {
-            "name": "exitEstimate",
+            "name": "exit_estimate",
             "baseName": "exit_estimate",
             "type": "ExitEstimateBase"
         }    ];
@@ -42,3 +41,4 @@ export class RFQDocumentBuyerAllOfValidators {
     }
 }
 
+

package/model/rFQDocumentBuyerStatusFilterEnum.ts

@@ -10,13 +10,12 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export enum RFQDocumentBuyerStatusFilterEnum {
-    Open = <any> 'open',
-    Submitted = <any> 'submitted',
-    Accepted = <any> 'accepted',
-    Outbid = <any> 'outbid',
-    Rejected = <any> 'rejected',
-    Expired = <any> 'expired'
-}
+export type RFQDocumentBuyerStatusFilterEnum = 
+'open' | 
+'submitted' | 
+'accepted' | 
+'outbid' | 
+'rejected' | 
+'expired';
+

package/model/rFQDocumentSeller.ts

@@ -10,7 +10,6 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { Quote } from './quote';
 import { RFQDocumentBaseUniqueEscrowVault } from './rFQDocumentBaseUniqueEscrowVault';
 import { RFQDocumentSellerAllOfValidators } from './rFQDocumentSellerAllOfValidators';
@@ -18,16 +17,16 @@ import { RFQDocumentStatusEnum } from './rFQDocumentStatusEnum';
 import { SettlementSteps } from './settlementSteps';
 
 export class RFQDocumentSeller {
-    'id': string;
-    'status': RFQDocumentStatusEnum;
-    'totalBalance': number;
-    'paymentAddress': string;
-    'estimatedAllValidatorsExitedAt': Date;
-    'uniqueEscrowVault'?: RFQDocumentBaseUniqueEscrowVault;
-    'settlementSteps'?: SettlementSteps;
-    'validators': Array<RFQDocumentSellerAllOfValidators>;
-    'estimatedExitTransactionDeadline': Date;
-    'bestQuote'?: Quote;
+   'id': string;
+   'status': RFQDocumentStatusEnum;
+   'total_balance': number;
+   'payment_address': string;
+   'estimated_all_validators_exited_at': Date;
+   'unique_escrow_vault'?: RFQDocumentBaseUniqueEscrowVault;
+   'settlement_steps'?: SettlementSteps;
+   'validators': Array<RFQDocumentSellerAllOfValidators>;
+   'estimated_exit_transaction_deadline': Date;
+   'best_quote'?: Quote;
 
     static discriminator: string | undefined = undefined;
 
@@ -43,27 +42,27 @@ export class RFQDocumentSeller {
             "type": "RFQDocumentStatusEnum"
         },
         {
-            "name": "totalBalance",
+            "name": "total_balance",
             "baseName": "total_balance",
             "type": "number"
         },
         {
-            "name": "paymentAddress",
+            "name": "payment_address",
             "baseName": "payment_address",
             "type": "string"
         },
         {
-            "name": "estimatedAllValidatorsExitedAt",
+            "name": "estimated_all_validators_exited_at",
             "baseName": "estimated_all_validators_exited_at",
             "type": "Date"
         },
         {
-            "name": "uniqueEscrowVault",
+            "name": "unique_escrow_vault",
             "baseName": "unique_escrow_vault",
             "type": "RFQDocumentBaseUniqueEscrowVault"
         },
         {
-            "name": "settlementSteps",
+            "name": "settlement_steps",
             "baseName": "settlement_steps",
             "type": "SettlementSteps"
         },
@@ -73,12 +72,12 @@ export class RFQDocumentSeller {
             "type": "Array<RFQDocumentSellerAllOfValidators>"
         },
         {
-            "name": "estimatedExitTransactionDeadline",
+            "name": "estimated_exit_transaction_deadline",
             "baseName": "estimated_exit_transaction_deadline",
             "type": "Date"
         },
         {
-            "name": "bestQuote",
+            "name": "best_quote",
             "baseName": "best_quote",
             "type": "Quote"
         }    ];
@@ -90,3 +89,4 @@ export class RFQDocumentSeller {
 
 export namespace RFQDocumentSeller {
 }
+

package/model/rFQDocumentSellerAllOfValidators.ts

@@ -10,19 +10,18 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 import { ExitEstimateSeller } from './exitEstimateSeller';
 
 export class RFQDocumentSellerAllOfValidators {
-    'validatorIndex': number;
-    'balance': number;
-    'exitEstimate': ExitEstimateSeller;
+   'validator_index': number;
+   'balance': number;
+   'exit_estimate': ExitEstimateSeller;
 
     static discriminator: string | undefined = undefined;
 
     static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
         {
-            "name": "validatorIndex",
+            "name": "validator_index",
             "baseName": "validator_index",
             "type": "number"
         },
@@ -32,7 +31,7 @@ export class RFQDocumentSellerAllOfValidators {
             "type": "number"
         },
         {
-            "name": "exitEstimate",
+            "name": "exit_estimate",
             "baseName": "exit_estimate",
             "type": "ExitEstimateSeller"
         }    ];
@@ -42,3 +41,4 @@ export class RFQDocumentSellerAllOfValidators {
     }
 }
 
+

package/model/rFQDocumentSellerStatusFilterEnum.ts

@@ -10,14 +10,13 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export enum RFQDocumentSellerStatusFilterEnum {
-    Active = <any> 'active',
-    Accepted = <any> 'accepted',
-    EscrowPaid = <any> 'escrow_paid',
-    RewardRecipientSettled = <any> 'reward_recipient_settled',
-    EscrowReleased = <any> 'escrow_released',
-    Rejected = <any> 'rejected',
-    Expired = <any> 'expired'
-}
+export type RFQDocumentSellerStatusFilterEnum = 
+'active' | 
+'accepted' | 
+'escrow_paid' | 
+'reward_recipient_settled' | 
+'escrow_released' | 
+'rejected' | 
+'expired';
+

package/model/rFQDocumentStatusEnum.ts

@@ -10,11 +10,10 @@
  * Do not edit the class manually.
  */
 
-import { RequestFile } from './models';
 
-export enum RFQDocumentStatusEnum {
-    Active = <any> 'active',
-    Expired = <any> 'expired',
-    Rejected = <any> 'rejected',
-    Finished = <any> 'finished'
-}
+export type RFQDocumentStatusEnum = 
+'active' | 
+'expired' | 
+'rejected' | 
+'finished';
+