/** * 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;