@dynamic-labs/sdk-api 0.0.1041 → 0.0.1043

package/src/models/CheckoutTransaction.d.ts

@@ -10,15 +10,15 @@
  * Do not edit the class manually.
  */
 import { ChainEnum } from './ChainEnum';
-import { CheckoutExecutionStateEnum } from './CheckoutExecutionStateEnum';
-import { CheckoutFailure } from './CheckoutFailure';
-import { CheckoutRiskStateEnum } from './CheckoutRiskStateEnum';
-import { CheckoutSettlementData } from './CheckoutSettlementData';
-import { CheckoutSettlementStateEnum } from './CheckoutSettlementStateEnum';
-import { CheckoutSourceTypeEnum } from './CheckoutSourceTypeEnum';
 import { CheckoutTransactionDestinationAddress } from './CheckoutTransactionDestinationAddress';
-import { CheckoutTransactionExchangeSource } from './CheckoutTransactionExchangeSource';
-import { CheckoutTransactionQuote } from './CheckoutTransactionQuote';
+import { FlowExchangeSource } from './FlowExchangeSource';
+import { FlowExecutionStateEnum } from './FlowExecutionStateEnum';
+import { FlowFailure } from './FlowFailure';
+import { FlowQuote } from './FlowQuote';
+import { FlowRiskStateEnum } from './FlowRiskStateEnum';
+import { FlowSettlementData } from './FlowSettlementData';
+import { FlowSettlementStateEnum } from './FlowSettlementStateEnum';
+import { FlowSourceTypeEnum } from './FlowSourceTypeEnum';
 /**
  *
  * @export
@@ -69,28 +69,28 @@ export interface CheckoutTransaction {
     destinationAddresses?: Array<CheckoutTransactionDestinationAddress>;
     /**
      *
-     * @type {CheckoutExecutionStateEnum}
+     * @type {FlowExecutionStateEnum}
      * @memberof CheckoutTransaction
      */
-    executionState: CheckoutExecutionStateEnum;
+    executionState: FlowExecutionStateEnum;
     /**
      *
-     * @type {CheckoutSettlementStateEnum}
+     * @type {FlowSettlementStateEnum}
      * @memberof CheckoutTransaction
      */
-    settlementState: CheckoutSettlementStateEnum;
+    settlementState: FlowSettlementStateEnum;
     /**
      *
-     * @type {CheckoutRiskStateEnum}
+     * @type {FlowRiskStateEnum}
      * @memberof CheckoutTransaction
      */
-    riskState: CheckoutRiskStateEnum;
+    riskState: FlowRiskStateEnum;
     /**
      *
-     * @type {CheckoutSourceTypeEnum}
+     * @type {FlowSourceTypeEnum}
      * @memberof CheckoutTransaction
      */
-    sourceType?: CheckoutSourceTypeEnum;
+    sourceType?: FlowSourceTypeEnum;
     /**
      * Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)
      * @type {string}
@@ -147,10 +147,10 @@ export interface CheckoutTransaction {
     quoteVersion: number;
     /**
      *
-     * @type {CheckoutTransactionQuote}
+     * @type {FlowQuote}
      * @memberof CheckoutTransaction
      */
-    quote?: CheckoutTransactionQuote;
+    quote?: FlowQuote;
     /**
      * A string with a max length of 4096 characters
      * @type {string}
@@ -177,10 +177,10 @@ export interface CheckoutTransaction {
     confirmations?: number;
     /**
      *
-     * @type {CheckoutSettlementData}
+     * @type {FlowSettlementData}
      * @memberof CheckoutTransaction
      */
-    settlement?: CheckoutSettlementData;
+    settlement?: FlowSettlementData;
     /**
      * ISO 8601 timestamp of when the transaction was completed
      * @type {Date}
@@ -189,10 +189,10 @@ export interface CheckoutTransaction {
     completedAt?: Date;
     /**
      *
-     * @type {CheckoutFailure}
+     * @type {FlowFailure}
      * @memberof CheckoutTransaction
      */
-    failure?: CheckoutFailure;
+    failure?: FlowFailure;
     /**
      * ISO 8601 timestamp of when the transaction expires
      * @type {Date}
@@ -213,10 +213,10 @@ export interface CheckoutTransaction {
     updatedAt: Date;
     /**
      *
-     * @type {CheckoutTransactionExchangeSource}
+     * @type {FlowExchangeSource}
      * @memberof CheckoutTransaction
      */
-    exchangeSource?: CheckoutTransactionExchangeSource;
+    exchangeSource?: FlowExchangeSource;
 }
 export declare function CheckoutTransactionFromJSON(json: any): CheckoutTransaction;
 export declare function CheckoutTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CheckoutTransaction;

package/src/models/CheckoutTransaction.js

@@ -1,14 +1,14 @@
 import { exists } from '../runtime.js';
 import { ChainEnumFromJSON, ChainEnumToJSON } from './ChainEnum.js';
-import { CheckoutExecutionStateEnumFromJSON, CheckoutExecutionStateEnumToJSON } from './CheckoutExecutionStateEnum.js';
-import { CheckoutFailureFromJSON, CheckoutFailureToJSON } from './CheckoutFailure.js';
-import { CheckoutRiskStateEnumFromJSON, CheckoutRiskStateEnumToJSON } from './CheckoutRiskStateEnum.js';
-import { CheckoutSettlementDataFromJSON, CheckoutSettlementDataToJSON } from './CheckoutSettlementData.js';
-import { CheckoutSettlementStateEnumFromJSON, CheckoutSettlementStateEnumToJSON } from './CheckoutSettlementStateEnum.js';
-import { CheckoutSourceTypeEnumFromJSON, CheckoutSourceTypeEnumToJSON } from './CheckoutSourceTypeEnum.js';
 import { CheckoutTransactionDestinationAddressFromJSON, CheckoutTransactionDestinationAddressToJSON } from './CheckoutTransactionDestinationAddress.js';
-import { CheckoutTransactionExchangeSourceFromJSON, CheckoutTransactionExchangeSourceToJSON } from './CheckoutTransactionExchangeSource.js';
-import { CheckoutTransactionQuoteFromJSON, CheckoutTransactionQuoteToJSON } from './CheckoutTransactionQuote.js';
+import { FlowExchangeSourceFromJSON, FlowExchangeSourceToJSON } from './FlowExchangeSource.js';
+import { FlowExecutionStateEnumFromJSON, FlowExecutionStateEnumToJSON } from './FlowExecutionStateEnum.js';
+import { FlowFailureFromJSON, FlowFailureToJSON } from './FlowFailure.js';
+import { FlowQuoteFromJSON, FlowQuoteToJSON } from './FlowQuote.js';
+import { FlowRiskStateEnumFromJSON, FlowRiskStateEnumToJSON } from './FlowRiskStateEnum.js';
+import { FlowSettlementDataFromJSON, FlowSettlementDataToJSON } from './FlowSettlementData.js';
+import { FlowSettlementStateEnumFromJSON, FlowSettlementStateEnumToJSON } from './FlowSettlementStateEnum.js';
+import { FlowSourceTypeEnumFromJSON, FlowSourceTypeEnumToJSON } from './FlowSourceTypeEnum.js';
 
 /* tslint:disable */
 function CheckoutTransactionFromJSON(json) {
@@ -26,10 +26,10 @@ function CheckoutTransactionFromJSONTyped(json, ignoreDiscriminator) {
         'amount': json['amount'],
         'currency': json['currency'],
         'destinationAddresses': !exists(json, 'destinationAddresses') ? undefined : (json['destinationAddresses'].map(CheckoutTransactionDestinationAddressFromJSON)),
-        'executionState': CheckoutExecutionStateEnumFromJSON(json['executionState']),
-        'settlementState': CheckoutSettlementStateEnumFromJSON(json['settlementState']),
-        'riskState': CheckoutRiskStateEnumFromJSON(json['riskState']),
-        'sourceType': !exists(json, 'sourceType') ? undefined : CheckoutSourceTypeEnumFromJSON(json['sourceType']),
+        'executionState': FlowExecutionStateEnumFromJSON(json['executionState']),
+        'settlementState': FlowSettlementStateEnumFromJSON(json['settlementState']),
+        'riskState': FlowRiskStateEnumFromJSON(json['riskState']),
+        'sourceType': !exists(json, 'sourceType') ? undefined : FlowSourceTypeEnumFromJSON(json['sourceType']),
         'fromAddress': !exists(json, 'fromAddress') ? undefined : json['fromAddress'],
         'fromChainId': !exists(json, 'fromChainId') ? undefined : json['fromChainId'],
         'fromChainName': !exists(json, 'fromChainName') ? undefined : ChainEnumFromJSON(json['fromChainName']),
@@ -39,18 +39,18 @@ function CheckoutTransactionFromJSONTyped(json, ignoreDiscriminator) {
         'toChainName': !exists(json, 'toChainName') ? undefined : ChainEnumFromJSON(json['toChainName']),
         'toToken': !exists(json, 'toToken') ? undefined : json['toToken'],
         'quoteVersion': json['quoteVersion'],
-        'quote': !exists(json, 'quote') ? undefined : CheckoutTransactionQuoteFromJSON(json['quote']),
+        'quote': !exists(json, 'quote') ? undefined : FlowQuoteFromJSON(json['quote']),
         'txHash': !exists(json, 'txHash') ? undefined : json['txHash'],
         'broadcastedAt': !exists(json, 'broadcastedAt') ? undefined : (new Date(json['broadcastedAt'])),
         'sourceConfirmedAt': !exists(json, 'sourceConfirmedAt') ? undefined : (new Date(json['sourceConfirmedAt'])),
         'confirmations': !exists(json, 'confirmations') ? undefined : json['confirmations'],
-        'settlement': !exists(json, 'settlement') ? undefined : CheckoutSettlementDataFromJSON(json['settlement']),
+        'settlement': !exists(json, 'settlement') ? undefined : FlowSettlementDataFromJSON(json['settlement']),
         'completedAt': !exists(json, 'completedAt') ? undefined : (new Date(json['completedAt'])),
-        'failure': !exists(json, 'failure') ? undefined : CheckoutFailureFromJSON(json['failure']),
+        'failure': !exists(json, 'failure') ? undefined : FlowFailureFromJSON(json['failure']),
         'expiresAt': !exists(json, 'expiresAt') ? undefined : (new Date(json['expiresAt'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
-        'exchangeSource': !exists(json, 'exchangeSource') ? undefined : CheckoutTransactionExchangeSourceFromJSON(json['exchangeSource']),
+        'exchangeSource': !exists(json, 'exchangeSource') ? undefined : FlowExchangeSourceFromJSON(json['exchangeSource']),
     };
 }
 function CheckoutTransactionToJSON(value) {
@@ -68,10 +68,10 @@ function CheckoutTransactionToJSON(value) {
         'amount': value.amount,
         'currency': value.currency,
         'destinationAddresses': value.destinationAddresses === undefined ? undefined : (value.destinationAddresses.map(CheckoutTransactionDestinationAddressToJSON)),
-        'executionState': CheckoutExecutionStateEnumToJSON(value.executionState),
-        'settlementState': CheckoutSettlementStateEnumToJSON(value.settlementState),
-        'riskState': CheckoutRiskStateEnumToJSON(value.riskState),
-        'sourceType': CheckoutSourceTypeEnumToJSON(value.sourceType),
+        'executionState': FlowExecutionStateEnumToJSON(value.executionState),
+        'settlementState': FlowSettlementStateEnumToJSON(value.settlementState),
+        'riskState': FlowRiskStateEnumToJSON(value.riskState),
+        'sourceType': FlowSourceTypeEnumToJSON(value.sourceType),
         'fromAddress': value.fromAddress,
         'fromChainId': value.fromChainId,
         'fromChainName': ChainEnumToJSON(value.fromChainName),
@@ -81,18 +81,18 @@ function CheckoutTransactionToJSON(value) {
         'toChainName': ChainEnumToJSON(value.toChainName),
         'toToken': value.toToken,
         'quoteVersion': value.quoteVersion,
-        'quote': CheckoutTransactionQuoteToJSON(value.quote),
+        'quote': FlowQuoteToJSON(value.quote),
         'txHash': value.txHash,
         'broadcastedAt': value.broadcastedAt === undefined ? undefined : (value.broadcastedAt.toISOString()),
         'sourceConfirmedAt': value.sourceConfirmedAt === undefined ? undefined : (value.sourceConfirmedAt.toISOString()),
         'confirmations': value.confirmations,
-        'settlement': CheckoutSettlementDataToJSON(value.settlement),
+        'settlement': FlowSettlementDataToJSON(value.settlement),
         'completedAt': value.completedAt === undefined ? undefined : (value.completedAt.toISOString()),
-        'failure': CheckoutFailureToJSON(value.failure),
+        'failure': FlowFailureToJSON(value.failure),
         'expiresAt': value.expiresAt === undefined ? undefined : (value.expiresAt.toISOString()),
         'createdAt': (value.createdAt.toISOString()),
         'updatedAt': (value.updatedAt.toISOString()),
-        'exchangeSource': CheckoutTransactionExchangeSourceToJSON(value.exchangeSource),
+        'exchangeSource': FlowExchangeSourceToJSON(value.exchangeSource),
     };
 }
 

package/src/models/Flow.cjs

@@ -0,0 +1,109 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+var ChainEnum = require('./ChainEnum.cjs');
+var DestinationConfigInput = require('./DestinationConfigInput.cjs');
+var FlowExchangeSource = require('./FlowExchangeSource.cjs');
+var FlowExecutionStateEnum = require('./FlowExecutionStateEnum.cjs');
+var FlowFailure = require('./FlowFailure.cjs');
+var FlowModeEnum = require('./FlowModeEnum.cjs');
+var FlowQuote = require('./FlowQuote.cjs');
+var FlowRiskStateEnum = require('./FlowRiskStateEnum.cjs');
+var FlowSettlementData = require('./FlowSettlementData.cjs');
+var FlowSettlementStateEnum = require('./FlowSettlementStateEnum.cjs');
+var FlowSourceTypeEnum = require('./FlowSourceTypeEnum.cjs');
+var SettlementConfigInput = require('./SettlementConfigInput.cjs');
+
+/* tslint:disable */
+function FlowFromJSON(json) {
+    return FlowFromJSONTyped(json);
+}
+function FlowFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'mode': FlowModeEnum.FlowModeEnumFromJSON(json['mode']),
+        'amount': json['amount'],
+        'currency': json['currency'],
+        'settlementConfig': SettlementConfigInput.SettlementConfigInputFromJSON(json['settlementConfig']),
+        'destinationConfig': !runtime.exists(json, 'destinationConfig') ? undefined : DestinationConfigInput.DestinationConfigInputFromJSON(json['destinationConfig']),
+        'memo': !runtime.exists(json, 'memo') ? undefined : json['memo'],
+        'userId': !runtime.exists(json, 'userId') ? undefined : json['userId'],
+        'executionState': FlowExecutionStateEnum.FlowExecutionStateEnumFromJSON(json['executionState']),
+        'settlementState': FlowSettlementStateEnum.FlowSettlementStateEnumFromJSON(json['settlementState']),
+        'riskState': FlowRiskStateEnum.FlowRiskStateEnumFromJSON(json['riskState']),
+        'sourceType': !runtime.exists(json, 'sourceType') ? undefined : FlowSourceTypeEnum.FlowSourceTypeEnumFromJSON(json['sourceType']),
+        'fromAddress': !runtime.exists(json, 'fromAddress') ? undefined : json['fromAddress'],
+        'fromChainId': !runtime.exists(json, 'fromChainId') ? undefined : json['fromChainId'],
+        'fromChainName': !runtime.exists(json, 'fromChainName') ? undefined : ChainEnum.ChainEnumFromJSON(json['fromChainName']),
+        'fromToken': !runtime.exists(json, 'fromToken') ? undefined : json['fromToken'],
+        'toAddress': !runtime.exists(json, 'toAddress') ? undefined : json['toAddress'],
+        'toChainId': !runtime.exists(json, 'toChainId') ? undefined : json['toChainId'],
+        'toChainName': !runtime.exists(json, 'toChainName') ? undefined : ChainEnum.ChainEnumFromJSON(json['toChainName']),
+        'toToken': !runtime.exists(json, 'toToken') ? undefined : json['toToken'],
+        'quoteVersion': json['quoteVersion'],
+        'quote': !runtime.exists(json, 'quote') ? undefined : FlowQuote.FlowQuoteFromJSON(json['quote']),
+        'txHash': !runtime.exists(json, 'txHash') ? undefined : json['txHash'],
+        'broadcastedAt': !runtime.exists(json, 'broadcastedAt') ? undefined : (new Date(json['broadcastedAt'])),
+        'sourceConfirmedAt': !runtime.exists(json, 'sourceConfirmedAt') ? undefined : (new Date(json['sourceConfirmedAt'])),
+        'confirmations': !runtime.exists(json, 'confirmations') ? undefined : json['confirmations'],
+        'settlement': !runtime.exists(json, 'settlement') ? undefined : FlowSettlementData.FlowSettlementDataFromJSON(json['settlement']),
+        'completedAt': !runtime.exists(json, 'completedAt') ? undefined : (new Date(json['completedAt'])),
+        'failure': !runtime.exists(json, 'failure') ? undefined : FlowFailure.FlowFailureFromJSON(json['failure']),
+        'expiresAt': !runtime.exists(json, 'expiresAt') ? undefined : (new Date(json['expiresAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'exchangeSource': !runtime.exists(json, 'exchangeSource') ? undefined : FlowExchangeSource.FlowExchangeSourceFromJSON(json['exchangeSource']),
+    };
+}
+function FlowToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'mode': FlowModeEnum.FlowModeEnumToJSON(value.mode),
+        'amount': value.amount,
+        'currency': value.currency,
+        'settlementConfig': SettlementConfigInput.SettlementConfigInputToJSON(value.settlementConfig),
+        'destinationConfig': DestinationConfigInput.DestinationConfigInputToJSON(value.destinationConfig),
+        'memo': value.memo,
+        'userId': value.userId,
+        'executionState': FlowExecutionStateEnum.FlowExecutionStateEnumToJSON(value.executionState),
+        'settlementState': FlowSettlementStateEnum.FlowSettlementStateEnumToJSON(value.settlementState),
+        'riskState': FlowRiskStateEnum.FlowRiskStateEnumToJSON(value.riskState),
+        'sourceType': FlowSourceTypeEnum.FlowSourceTypeEnumToJSON(value.sourceType),
+        'fromAddress': value.fromAddress,
+        'fromChainId': value.fromChainId,
+        'fromChainName': ChainEnum.ChainEnumToJSON(value.fromChainName),
+        'fromToken': value.fromToken,
+        'toAddress': value.toAddress,
+        'toChainId': value.toChainId,
+        'toChainName': ChainEnum.ChainEnumToJSON(value.toChainName),
+        'toToken': value.toToken,
+        'quoteVersion': value.quoteVersion,
+        'quote': FlowQuote.FlowQuoteToJSON(value.quote),
+        'txHash': value.txHash,
+        'broadcastedAt': value.broadcastedAt === undefined ? undefined : (value.broadcastedAt.toISOString()),
+        'sourceConfirmedAt': value.sourceConfirmedAt === undefined ? undefined : (value.sourceConfirmedAt.toISOString()),
+        'confirmations': value.confirmations,
+        'settlement': FlowSettlementData.FlowSettlementDataToJSON(value.settlement),
+        'completedAt': value.completedAt === undefined ? undefined : (value.completedAt.toISOString()),
+        'failure': FlowFailure.FlowFailureToJSON(value.failure),
+        'expiresAt': value.expiresAt === undefined ? undefined : (value.expiresAt.toISOString()),
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+        'exchangeSource': FlowExchangeSource.FlowExchangeSourceToJSON(value.exchangeSource),
+    };
+}
+
+exports.FlowFromJSON = FlowFromJSON;
+exports.FlowFromJSONTyped = FlowFromJSONTyped;
+exports.FlowToJSON = FlowToJSON;

package/src/models/Flow.d.ts

@@ -0,0 +1,231 @@
+/**
+ * Dashboard API
+ * Dashboard API documentation
+ *
+ * The version of the OpenAPI document: 1.0.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 { ChainEnum } from './ChainEnum';
+import { DestinationConfigInput } from './DestinationConfigInput';
+import { FlowExchangeSource } from './FlowExchangeSource';
+import { FlowExecutionStateEnum } from './FlowExecutionStateEnum';
+import { FlowFailure } from './FlowFailure';
+import { FlowModeEnum } from './FlowModeEnum';
+import { FlowQuote } from './FlowQuote';
+import { FlowRiskStateEnum } from './FlowRiskStateEnum';
+import { FlowSettlementData } from './FlowSettlementData';
+import { FlowSettlementStateEnum } from './FlowSettlementStateEnum';
+import { FlowSourceTypeEnum } from './FlowSourceTypeEnum';
+import { SettlementConfigInput } from './SettlementConfigInput';
+/**
+ * A single payment, deposit, or withdraw flow. Collapses the former Checkout and CheckoutTransaction into one resource.
+ * @export
+ * @interface Flow
+ */
+export interface Flow {
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    id: string;
+    /**
+     *
+     * @type {FlowModeEnum}
+     * @memberof Flow
+     */
+    mode: FlowModeEnum;
+    /**
+     * Amount in the specified currency. Set once at create by the API-key caller and immutable thereafter.
+     * @type {string}
+     * @memberof Flow
+     */
+    amount: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    currency: string;
+    /**
+     *
+     * @type {SettlementConfigInput}
+     * @memberof Flow
+     */
+    settlementConfig: SettlementConfigInput;
+    /**
+     *
+     * @type {DestinationConfigInput}
+     * @memberof Flow
+     */
+    destinationConfig?: DestinationConfigInput;
+    /**
+     * Arbitrary metadata attached to the flow
+     * @type {object}
+     * @memberof Flow
+     */
+    memo?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    userId?: string;
+    /**
+     *
+     * @type {FlowExecutionStateEnum}
+     * @memberof Flow
+     */
+    executionState: FlowExecutionStateEnum;
+    /**
+     *
+     * @type {FlowSettlementStateEnum}
+     * @memberof Flow
+     */
+    settlementState: FlowSettlementStateEnum;
+    /**
+     *
+     * @type {FlowRiskStateEnum}
+     * @memberof Flow
+     */
+    riskState: FlowRiskStateEnum;
+    /**
+     *
+     * @type {FlowSourceTypeEnum}
+     * @memberof Flow
+     */
+    sourceType?: FlowSourceTypeEnum;
+    /**
+     * Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)
+     * @type {string}
+     * @memberof Flow
+     */
+    fromAddress?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    fromChainId?: string;
+    /**
+     *
+     * @type {ChainEnum}
+     * @memberof Flow
+     */
+    fromChainName?: ChainEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    fromToken?: string;
+    /**
+     * Valid blockchain wallet address, must be an alphanumeric string (underscores allowed for chains like Midnight, hyphens allowed for chains using base64url-encoded addresses like TON)
+     * @type {string}
+     * @memberof Flow
+     */
+    toAddress?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    toChainId?: string;
+    /**
+     *
+     * @type {ChainEnum}
+     * @memberof Flow
+     */
+    toChainName?: ChainEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof Flow
+     */
+    toToken?: string;
+    /**
+     * Version number of the quote used for this flow
+     * @type {number}
+     * @memberof Flow
+     */
+    quoteVersion: number;
+    /**
+     *
+     * @type {FlowQuote}
+     * @memberof Flow
+     */
+    quote?: FlowQuote;
+    /**
+     * A string with a max length of 4096 characters
+     * @type {string}
+     * @memberof Flow
+     */
+    txHash?: string;
+    /**
+     * ISO 8601 timestamp of when the flow was broadcast to the network
+     * @type {Date}
+     * @memberof Flow
+     */
+    broadcastedAt?: Date;
+    /**
+     * ISO 8601 timestamp of when the source chain confirmed the transaction
+     * @type {Date}
+     * @memberof Flow
+     */
+    sourceConfirmedAt?: Date;
+    /**
+     * Number of blockchain confirmations received
+     * @type {number}
+     * @memberof Flow
+     */
+    confirmations?: number;
+    /**
+     *
+     * @type {FlowSettlementData}
+     * @memberof Flow
+     */
+    settlement?: FlowSettlementData;
+    /**
+     * ISO 8601 timestamp of when the flow was completed
+     * @type {Date}
+     * @memberof Flow
+     */
+    completedAt?: Date;
+    /**
+     *
+     * @type {FlowFailure}
+     * @memberof Flow
+     */
+    failure?: FlowFailure;
+    /**
+     * ISO 8601 timestamp of when the flow expires
+     * @type {Date}
+     * @memberof Flow
+     */
+    expiresAt?: Date;
+    /**
+     * ISO 8601 timestamp of when the flow was created
+     * @type {Date}
+     * @memberof Flow
+     */
+    createdAt: Date;
+    /**
+     * ISO 8601 timestamp of when the flow was last updated
+     * @type {Date}
+     * @memberof Flow
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {FlowExchangeSource}
+     * @memberof Flow
+     */
+    exchangeSource?: FlowExchangeSource;
+}
+export declare function FlowFromJSON(json: any): Flow;
+export declare function FlowFromJSONTyped(json: any, ignoreDiscriminator: boolean): Flow;
+export declare function FlowToJSON(value?: Flow | null): any;

package/src/models/Flow.js

@@ -0,0 +1,103 @@
+import { exists } from '../runtime.js';
+import { ChainEnumFromJSON, ChainEnumToJSON } from './ChainEnum.js';
+import { DestinationConfigInputFromJSON, DestinationConfigInputToJSON } from './DestinationConfigInput.js';
+import { FlowExchangeSourceFromJSON, FlowExchangeSourceToJSON } from './FlowExchangeSource.js';
+import { FlowExecutionStateEnumFromJSON, FlowExecutionStateEnumToJSON } from './FlowExecutionStateEnum.js';
+import { FlowFailureFromJSON, FlowFailureToJSON } from './FlowFailure.js';
+import { FlowModeEnumFromJSON, FlowModeEnumToJSON } from './FlowModeEnum.js';
+import { FlowQuoteFromJSON, FlowQuoteToJSON } from './FlowQuote.js';
+import { FlowRiskStateEnumFromJSON, FlowRiskStateEnumToJSON } from './FlowRiskStateEnum.js';
+import { FlowSettlementDataFromJSON, FlowSettlementDataToJSON } from './FlowSettlementData.js';
+import { FlowSettlementStateEnumFromJSON, FlowSettlementStateEnumToJSON } from './FlowSettlementStateEnum.js';
+import { FlowSourceTypeEnumFromJSON, FlowSourceTypeEnumToJSON } from './FlowSourceTypeEnum.js';
+import { SettlementConfigInputFromJSON, SettlementConfigInputToJSON } from './SettlementConfigInput.js';
+
+/* tslint:disable */
+function FlowFromJSON(json) {
+    return FlowFromJSONTyped(json);
+}
+function FlowFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'mode': FlowModeEnumFromJSON(json['mode']),
+        'amount': json['amount'],
+        'currency': json['currency'],
+        'settlementConfig': SettlementConfigInputFromJSON(json['settlementConfig']),
+        'destinationConfig': !exists(json, 'destinationConfig') ? undefined : DestinationConfigInputFromJSON(json['destinationConfig']),
+        'memo': !exists(json, 'memo') ? undefined : json['memo'],
+        'userId': !exists(json, 'userId') ? undefined : json['userId'],
+        'executionState': FlowExecutionStateEnumFromJSON(json['executionState']),
+        'settlementState': FlowSettlementStateEnumFromJSON(json['settlementState']),
+        'riskState': FlowRiskStateEnumFromJSON(json['riskState']),
+        'sourceType': !exists(json, 'sourceType') ? undefined : FlowSourceTypeEnumFromJSON(json['sourceType']),
+        'fromAddress': !exists(json, 'fromAddress') ? undefined : json['fromAddress'],
+        'fromChainId': !exists(json, 'fromChainId') ? undefined : json['fromChainId'],
+        'fromChainName': !exists(json, 'fromChainName') ? undefined : ChainEnumFromJSON(json['fromChainName']),
+        'fromToken': !exists(json, 'fromToken') ? undefined : json['fromToken'],
+        'toAddress': !exists(json, 'toAddress') ? undefined : json['toAddress'],
+        'toChainId': !exists(json, 'toChainId') ? undefined : json['toChainId'],
+        'toChainName': !exists(json, 'toChainName') ? undefined : ChainEnumFromJSON(json['toChainName']),
+        'toToken': !exists(json, 'toToken') ? undefined : json['toToken'],
+        'quoteVersion': json['quoteVersion'],
+        'quote': !exists(json, 'quote') ? undefined : FlowQuoteFromJSON(json['quote']),
+        'txHash': !exists(json, 'txHash') ? undefined : json['txHash'],
+        'broadcastedAt': !exists(json, 'broadcastedAt') ? undefined : (new Date(json['broadcastedAt'])),
+        'sourceConfirmedAt': !exists(json, 'sourceConfirmedAt') ? undefined : (new Date(json['sourceConfirmedAt'])),
+        'confirmations': !exists(json, 'confirmations') ? undefined : json['confirmations'],
+        'settlement': !exists(json, 'settlement') ? undefined : FlowSettlementDataFromJSON(json['settlement']),
+        'completedAt': !exists(json, 'completedAt') ? undefined : (new Date(json['completedAt'])),
+        'failure': !exists(json, 'failure') ? undefined : FlowFailureFromJSON(json['failure']),
+        'expiresAt': !exists(json, 'expiresAt') ? undefined : (new Date(json['expiresAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+        'exchangeSource': !exists(json, 'exchangeSource') ? undefined : FlowExchangeSourceFromJSON(json['exchangeSource']),
+    };
+}
+function FlowToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'mode': FlowModeEnumToJSON(value.mode),
+        'amount': value.amount,
+        'currency': value.currency,
+        'settlementConfig': SettlementConfigInputToJSON(value.settlementConfig),
+        'destinationConfig': DestinationConfigInputToJSON(value.destinationConfig),
+        'memo': value.memo,
+        'userId': value.userId,
+        'executionState': FlowExecutionStateEnumToJSON(value.executionState),
+        'settlementState': FlowSettlementStateEnumToJSON(value.settlementState),
+        'riskState': FlowRiskStateEnumToJSON(value.riskState),
+        'sourceType': FlowSourceTypeEnumToJSON(value.sourceType),
+        'fromAddress': value.fromAddress,
+        'fromChainId': value.fromChainId,
+        'fromChainName': ChainEnumToJSON(value.fromChainName),
+        'fromToken': value.fromToken,
+        'toAddress': value.toAddress,
+        'toChainId': value.toChainId,
+        'toChainName': ChainEnumToJSON(value.toChainName),
+        'toToken': value.toToken,
+        'quoteVersion': value.quoteVersion,
+        'quote': FlowQuoteToJSON(value.quote),
+        'txHash': value.txHash,
+        'broadcastedAt': value.broadcastedAt === undefined ? undefined : (value.broadcastedAt.toISOString()),
+        'sourceConfirmedAt': value.sourceConfirmedAt === undefined ? undefined : (value.sourceConfirmedAt.toISOString()),
+        'confirmations': value.confirmations,
+        'settlement': FlowSettlementDataToJSON(value.settlement),
+        'completedAt': value.completedAt === undefined ? undefined : (value.completedAt.toISOString()),
+        'failure': FlowFailureToJSON(value.failure),
+        'expiresAt': value.expiresAt === undefined ? undefined : (value.expiresAt.toISOString()),
+        'createdAt': (value.createdAt.toISOString()),
+        'updatedAt': (value.updatedAt.toISOString()),
+        'exchangeSource': FlowExchangeSourceToJSON(value.exchangeSource),
+    };
+}
+
+export { FlowFromJSON, FlowFromJSONTyped, FlowToJSON };