@dynamic-labs/sdk-api 0.24.0 → 0.25.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynamic-labs/sdk-api",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "author": "Dynamic Labs",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/index.cjs

@@ -376,6 +376,7 @@ var FlowSettlementStateEnum = require('./models/FlowSettlementStateEnum.cjs');
 var FlowSourceResponse = require('./models/FlowSourceResponse.cjs');
 var FlowSourceTypeEnum = require('./models/FlowSourceTypeEnum.cjs');
 var FlowTokenInfo = require('./models/FlowTokenInfo.cjs');
+var FlowUIConfig = require('./models/FlowUIConfig.cjs');
 var Forbidden = require('./models/Forbidden.cjs');
 var ForbiddenErrorPayload = require('./models/ForbiddenErrorPayload.cjs');
 var ForbiddenWithErrorAndPayload = require('./models/ForbiddenWithErrorAndPayload.cjs');
@@ -2283,6 +2284,9 @@ exports.FlowSourceTypeEnumToJSON = FlowSourceTypeEnum.FlowSourceTypeEnumToJSON;
 exports.FlowTokenInfoFromJSON = FlowTokenInfo.FlowTokenInfoFromJSON;
 exports.FlowTokenInfoFromJSONTyped = FlowTokenInfo.FlowTokenInfoFromJSONTyped;
 exports.FlowTokenInfoToJSON = FlowTokenInfo.FlowTokenInfoToJSON;
+exports.FlowUIConfigFromJSON = FlowUIConfig.FlowUIConfigFromJSON;
+exports.FlowUIConfigFromJSONTyped = FlowUIConfig.FlowUIConfigFromJSONTyped;
+exports.FlowUIConfigToJSON = FlowUIConfig.FlowUIConfigToJSON;
 exports.ForbiddenFromJSON = Forbidden.ForbiddenFromJSON;
 exports.ForbiddenFromJSONTyped = Forbidden.ForbiddenFromJSONTyped;
 exports.ForbiddenToJSON = Forbidden.ForbiddenToJSON;

package/src/index.js

@@ -372,6 +372,7 @@ export { FlowSettlementStateEnum, FlowSettlementStateEnumFromJSON, FlowSettlemen
 export { FlowSourceResponseFromJSON, FlowSourceResponseFromJSONTyped, FlowSourceResponseToJSON } from './models/FlowSourceResponse.js';
 export { FlowSourceTypeEnum, FlowSourceTypeEnumFromJSON, FlowSourceTypeEnumFromJSONTyped, FlowSourceTypeEnumToJSON } from './models/FlowSourceTypeEnum.js';
 export { FlowTokenInfoFromJSON, FlowTokenInfoFromJSONTyped, FlowTokenInfoToJSON } from './models/FlowTokenInfo.js';
+export { FlowUIConfigFromJSON, FlowUIConfigFromJSONTyped, FlowUIConfigToJSON } from './models/FlowUIConfig.js';
 export { ForbiddenFromJSON, ForbiddenFromJSONTyped, ForbiddenToJSON } from './models/Forbidden.js';
 export { ForbiddenErrorPayloadFromJSON, ForbiddenErrorPayloadFromJSONTyped, ForbiddenErrorPayloadToJSON } from './models/ForbiddenErrorPayload.js';
 export { ForbiddenWithErrorAndPayloadFromJSON, ForbiddenWithErrorAndPayloadFromJSONTyped, ForbiddenWithErrorAndPayloadToJSON } from './models/ForbiddenWithErrorAndPayload.js';

package/src/models/Flow.cjs

@@ -14,6 +14,7 @@ var FlowRiskStateEnum = require('./FlowRiskStateEnum.cjs');
 var FlowSettlementData = require('./FlowSettlementData.cjs');
 var FlowSettlementStateEnum = require('./FlowSettlementStateEnum.cjs');
 var FlowSourceTypeEnum = require('./FlowSourceTypeEnum.cjs');
+var FlowUIConfig = require('./FlowUIConfig.cjs');
 var SettlementConfigInput = require('./SettlementConfigInput.cjs');
 
 /* tslint:disable */
@@ -60,7 +61,7 @@ function FlowFromJSONTyped(json, ignoreDiscriminator) {
         'exchangeSource': !runtime.exists(json, 'exchangeSource') ? undefined : FlowExchangeSource.FlowExchangeSourceFromJSON(json['exchangeSource']),
         'pegStablecoins': !runtime.exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !runtime.exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !runtime.exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !runtime.exists(json, 'uiConfig') ? undefined : FlowUIConfig.FlowUIConfigFromJSON(json['uiConfig']),
         'settlementConfig': !runtime.exists(json, 'settlementConfig') ? undefined : SettlementConfigInput.SettlementConfigInputFromJSON(json['settlementConfig']),
         'destinationConfig': !runtime.exists(json, 'destinationConfig') ? undefined : DestinationConfigInput.DestinationConfigInputFromJSON(json['destinationConfig']),
     };
@@ -108,7 +109,7 @@ function FlowToJSON(value) {
         'exchangeSource': FlowExchangeSource.FlowExchangeSourceToJSON(value.exchangeSource),
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfig.FlowUIConfigToJSON(value.uiConfig),
         'settlementConfig': SettlementConfigInput.SettlementConfigInputToJSON(value.settlementConfig),
         'destinationConfig': DestinationConfigInput.DestinationConfigInputToJSON(value.destinationConfig),
     };

package/src/models/Flow.d.ts

@@ -20,6 +20,7 @@ import { FlowRiskStateEnum } from './FlowRiskStateEnum';
 import { FlowSettlementData } from './FlowSettlementData';
 import { FlowSettlementStateEnum } from './FlowSettlementStateEnum';
 import { FlowSourceTypeEnum } from './FlowSourceTypeEnum';
+import { FlowUIConfig } from './FlowUIConfig';
 import { SettlementConfigInput } from './SettlementConfigInput';
 /**
  * A single payment, deposit, or withdraw flow. Collapses the former Checkout and CheckoutTransaction into one resource.
@@ -238,11 +239,11 @@ export interface Flow {
      */
     disableSwaps?: boolean;
     /**
-     * Payer app URL to redirect to once the flow reaches a specific state. Redirected to as `returnUrl?status=success|failure&flowId=...`.
-     * @type {string}
+     *
+     * @type {FlowUIConfig}
      * @memberof Flow
      */
-    returnUrl?: string;
+    uiConfig?: FlowUIConfig;
     /**
      *
      * @type {SettlementConfigInput}

package/src/models/Flow.js

@@ -10,6 +10,7 @@ import { FlowRiskStateEnumFromJSON, FlowRiskStateEnumToJSON } from './FlowRiskSt
 import { FlowSettlementDataFromJSON, FlowSettlementDataToJSON } from './FlowSettlementData.js';
 import { FlowSettlementStateEnumFromJSON, FlowSettlementStateEnumToJSON } from './FlowSettlementStateEnum.js';
 import { FlowSourceTypeEnumFromJSON, FlowSourceTypeEnumToJSON } from './FlowSourceTypeEnum.js';
+import { FlowUIConfigFromJSON, FlowUIConfigToJSON } from './FlowUIConfig.js';
 import { SettlementConfigInputFromJSON, SettlementConfigInputToJSON } from './SettlementConfigInput.js';
 
 /* tslint:disable */
@@ -56,7 +57,7 @@ function FlowFromJSONTyped(json, ignoreDiscriminator) {
         'exchangeSource': !exists(json, 'exchangeSource') ? undefined : FlowExchangeSourceFromJSON(json['exchangeSource']),
         'pegStablecoins': !exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !exists(json, 'uiConfig') ? undefined : FlowUIConfigFromJSON(json['uiConfig']),
         'settlementConfig': !exists(json, 'settlementConfig') ? undefined : SettlementConfigInputFromJSON(json['settlementConfig']),
         'destinationConfig': !exists(json, 'destinationConfig') ? undefined : DestinationConfigInputFromJSON(json['destinationConfig']),
     };
@@ -104,7 +105,7 @@ function FlowToJSON(value) {
         'exchangeSource': FlowExchangeSourceToJSON(value.exchangeSource),
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfigToJSON(value.uiConfig),
         'settlementConfig': SettlementConfigInputToJSON(value.settlementConfig),
         'destinationConfig': DestinationConfigInputToJSON(value.destinationConfig),
     };

package/src/models/FlowCreateRequest.cjs

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var runtime = require('../runtime.cjs');
 var DestinationConfigInput = require('./DestinationConfigInput.cjs');
 var FlowFeeConfig = require('./FlowFeeConfig.cjs');
+var FlowUIConfig = require('./FlowUIConfig.cjs');
 var SettlementConfigInput = require('./SettlementConfigInput.cjs');
 
 /* tslint:disable */
@@ -25,7 +26,7 @@ function FlowCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
         'expiresIn': !runtime.exists(json, 'expiresIn') ? undefined : json['expiresIn'],
         'pegStablecoins': !runtime.exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !runtime.exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !runtime.exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !runtime.exists(json, 'uiConfig') ? undefined : FlowUIConfig.FlowUIConfigFromJSON(json['uiConfig']),
     };
 }
 function FlowCreateRequestToJSON(value) {
@@ -45,7 +46,7 @@ function FlowCreateRequestToJSON(value) {
         'expiresIn': value.expiresIn,
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfig.FlowUIConfigToJSON(value.uiConfig),
     };
 }
 

package/src/models/FlowCreateRequest.d.ts

@@ -11,6 +11,7 @@
  */
 import { DestinationConfigInput } from './DestinationConfigInput';
 import { FlowFeeConfig } from './FlowFeeConfig';
+import { FlowUIConfig } from './FlowUIConfig';
 import { SettlementConfigInput } from './SettlementConfigInput';
 /**
  * Create-time payload for a flow. amount, currency, settlementConfig and destinationConfig are written once here (by a trusted API-key caller) and are accepted by no later endpoint. mode is supplied in the URL path.
@@ -73,11 +74,11 @@ export interface FlowCreateRequest {
      */
     disableSwaps?: boolean;
     /**
-     * Payer app URL to redirect to once the flow reaches a specific state. Origin must be a registered CORS origin for the environment. Redirected to as `returnUrl?status=success|failure&flowId=...`.
-     * @type {string}
+     *
+     * @type {FlowUIConfig}
      * @memberof FlowCreateRequest
      */
-    returnUrl?: string;
+    uiConfig?: FlowUIConfig;
 }
 export declare function FlowCreateRequestFromJSON(json: any): FlowCreateRequest;
 export declare function FlowCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlowCreateRequest;

package/src/models/FlowCreateRequest.js

@@ -1,6 +1,7 @@
 import { exists } from '../runtime.js';
 import { DestinationConfigInputFromJSON, DestinationConfigInputToJSON } from './DestinationConfigInput.js';
 import { FlowFeeConfigFromJSON, FlowFeeConfigToJSON } from './FlowFeeConfig.js';
+import { FlowUIConfigFromJSON, FlowUIConfigToJSON } from './FlowUIConfig.js';
 import { SettlementConfigInputFromJSON, SettlementConfigInputToJSON } from './SettlementConfigInput.js';
 
 /* tslint:disable */
@@ -21,7 +22,7 @@ function FlowCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
         'expiresIn': !exists(json, 'expiresIn') ? undefined : json['expiresIn'],
         'pegStablecoins': !exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !exists(json, 'uiConfig') ? undefined : FlowUIConfigFromJSON(json['uiConfig']),
     };
 }
 function FlowCreateRequestToJSON(value) {
@@ -41,7 +42,7 @@ function FlowCreateRequestToJSON(value) {
         'expiresIn': value.expiresIn,
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfigToJSON(value.uiConfig),
     };
 }
 

package/src/models/FlowPaymentLinkCreateRequest.cjs

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var runtime = require('../runtime.cjs');
 var DestinationConfigInput = require('./DestinationConfigInput.cjs');
 var FlowFeeConfig = require('./FlowFeeConfig.cjs');
+var FlowUIConfig = require('./FlowUIConfig.cjs');
 var SettlementConfigInput = require('./SettlementConfigInput.cjs');
 
 /* tslint:disable */
@@ -25,7 +26,7 @@ function FlowPaymentLinkCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
         'expiresIn': !runtime.exists(json, 'expiresIn') ? undefined : json['expiresIn'],
         'pegStablecoins': !runtime.exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !runtime.exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !runtime.exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !runtime.exists(json, 'uiConfig') ? undefined : FlowUIConfig.FlowUIConfigFromJSON(json['uiConfig']),
         'baseUrl': json['baseUrl'],
     };
 }
@@ -46,7 +47,7 @@ function FlowPaymentLinkCreateRequestToJSON(value) {
         'expiresIn': value.expiresIn,
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfig.FlowUIConfigToJSON(value.uiConfig),
         'baseUrl': value.baseUrl,
     };
 }

package/src/models/FlowPaymentLinkCreateRequest.d.ts

@@ -11,6 +11,7 @@
  */
 import { DestinationConfigInput } from './DestinationConfigInput';
 import { FlowFeeConfig } from './FlowFeeConfig';
+import { FlowUIConfig } from './FlowUIConfig';
 import { SettlementConfigInput } from './SettlementConfigInput';
 /**
  *
@@ -73,11 +74,11 @@ export interface FlowPaymentLinkCreateRequest {
      */
     disableSwaps?: boolean;
     /**
-     * Payer app URL to redirect to once the flow reaches a specific state. Origin must be a registered CORS origin for the environment. Redirected to as `returnUrl?status=success|failure&flowId=...`.
-     * @type {string}
+     *
+     * @type {FlowUIConfig}
      * @memberof FlowPaymentLinkCreateRequest
      */
-    returnUrl?: string;
+    uiConfig?: FlowUIConfig;
     /**
      * Merchant-hosted payer app URL
      * @type {string}

package/src/models/FlowPaymentLinkCreateRequest.js

@@ -1,6 +1,7 @@
 import { exists } from '../runtime.js';
 import { DestinationConfigInputFromJSON, DestinationConfigInputToJSON } from './DestinationConfigInput.js';
 import { FlowFeeConfigFromJSON, FlowFeeConfigToJSON } from './FlowFeeConfig.js';
+import { FlowUIConfigFromJSON, FlowUIConfigToJSON } from './FlowUIConfig.js';
 import { SettlementConfigInputFromJSON, SettlementConfigInputToJSON } from './SettlementConfigInput.js';
 
 /* tslint:disable */
@@ -21,7 +22,7 @@ function FlowPaymentLinkCreateRequestFromJSONTyped(json, ignoreDiscriminator) {
         'expiresIn': !exists(json, 'expiresIn') ? undefined : json['expiresIn'],
         'pegStablecoins': !exists(json, 'pegStablecoins') ? undefined : json['pegStablecoins'],
         'disableSwaps': !exists(json, 'disableSwaps') ? undefined : json['disableSwaps'],
-        'returnUrl': !exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+        'uiConfig': !exists(json, 'uiConfig') ? undefined : FlowUIConfigFromJSON(json['uiConfig']),
         'baseUrl': json['baseUrl'],
     };
 }
@@ -42,7 +43,7 @@ function FlowPaymentLinkCreateRequestToJSON(value) {
         'expiresIn': value.expiresIn,
         'pegStablecoins': value.pegStablecoins,
         'disableSwaps': value.disableSwaps,
-        'returnUrl': value.returnUrl,
+        'uiConfig': FlowUIConfigToJSON(value.uiConfig),
         'baseUrl': value.baseUrl,
     };
 }

package/src/models/FlowUIConfig.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var runtime = require('../runtime.cjs');
+
+/* tslint:disable */
+function FlowUIConfigFromJSON(json) {
+    return FlowUIConfigFromJSONTyped(json);
+}
+function FlowUIConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'returnUrl': !runtime.exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+    };
+}
+function FlowUIConfigToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'returnUrl': value.returnUrl,
+    };
+}
+
+exports.FlowUIConfigFromJSON = FlowUIConfigFromJSON;
+exports.FlowUIConfigFromJSONTyped = FlowUIConfigFromJSONTyped;
+exports.FlowUIConfigToJSON = FlowUIConfigToJSON;

package/src/models/FlowUIConfig.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+/**
+ * Payer-facing UI config for a flow, set once at creation. Not part of the execution/settlement record.
+ * @export
+ * @interface FlowUIConfig
+ */
+export interface FlowUIConfig {
+    /**
+     * Payer app URL to redirect to once the flow reaches a specific state. Origin must be a registered CORS origin for the environment. Redirected to as `returnUrl?status=success|failure&flowId=...`.
+     * @type {string}
+     * @memberof FlowUIConfig
+     */
+    returnUrl?: string;
+}
+export declare function FlowUIConfigFromJSON(json: any): FlowUIConfig;
+export declare function FlowUIConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): FlowUIConfig;
+export declare function FlowUIConfigToJSON(value?: FlowUIConfig | null): any;

package/src/models/FlowUIConfig.js

@@ -0,0 +1,27 @@
+import { exists } from '../runtime.js';
+
+/* tslint:disable */
+function FlowUIConfigFromJSON(json) {
+    return FlowUIConfigFromJSONTyped(json);
+}
+function FlowUIConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'returnUrl': !exists(json, 'returnUrl') ? undefined : json['returnUrl'],
+    };
+}
+function FlowUIConfigToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'returnUrl': value.returnUrl,
+    };
+}
+
+export { FlowUIConfigFromJSON, FlowUIConfigFromJSONTyped, FlowUIConfigToJSON };

package/src/models/index.d.ts

@@ -320,6 +320,7 @@ export * from './FlowSettlementStateEnum';
 export * from './FlowSourceResponse';
 export * from './FlowSourceTypeEnum';
 export * from './FlowTokenInfo';
+export * from './FlowUIConfig';
 export * from './Forbidden';
 export * from './ForbiddenErrorPayload';
 export * from './ForbiddenWithErrorAndPayload';