@cdx-forge/di-typescript-sdk 0.1.0-beta.1 → 1.0.0

package/dist/generated/src/models/IntermediaryBankDetailsIntlWireForeignIntermediary.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Foreign (non-US) intermediary on a **WIRE_INTERNATIONAL** payment. Omit **intermediaryBankDetails** unless the FI has international intermediary enabled.
+ *
+ * **intermediaryBankType** must be **INTERNATIONAL**. **intermediaryBankName** is required (max 45 characters per API validation). At least one of **intermediaryBankSwiftNumber** or **intermediaryBankAccountNumber** must be present; the API requires at least one non-null identifier. When SWIFT/BIC is sent it is validated; when an account number is sent it is validated as an international account number.
+ *
+ * @export
+ * @interface IntermediaryBankDetailsIntlWireForeignIntermediary
+ */
+export interface IntermediaryBankDetailsIntlWireForeignIntermediary {
+    /**
+     * Must be **INTERNATIONAL** when the intermediary is identified by name and SWIFT and/or account number.
+     * @type {IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum}
+     * @memberof IntermediaryBankDetailsIntlWireForeignIntermediary
+     */
+    intermediaryBankType: IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum;
+    /**
+     * Intermediary bank name; required (max 45 characters).
+     * @type {string}
+     * @memberof IntermediaryBankDetailsIntlWireForeignIntermediary
+     */
+    intermediaryBankName: string;
+    /**
+     * Intermediary SWIFT/BIC (this branch requires SWIFT; **intermediaryBankAccountNumber** may also be sent).
+     * @type {string}
+     * @memberof IntermediaryBankDetailsIntlWireForeignIntermediary
+     */
+    intermediaryBankSwiftNumber: string;
+    /**
+     * Intermediary account at the intermediary bank (this branch requires account number; **intermediaryBankSwiftNumber** may also be sent).
+     * @type {string}
+     * @memberof IntermediaryBankDetailsIntlWireForeignIntermediary
+     */
+    intermediaryBankAccountNumber: string;
+}
+/**
+ * @export
+ */
+export declare const IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum: {
+    readonly INTERNATIONAL: "INTERNATIONAL";
+};
+export type IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum = typeof IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum[keyof typeof IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum];
+/**
+ * Check if a given object implements the IntermediaryBankDetailsIntlWireForeignIntermediary interface.
+ */
+export declare function instanceOfIntermediaryBankDetailsIntlWireForeignIntermediary(value: object): value is IntermediaryBankDetailsIntlWireForeignIntermediary;
+export declare function IntermediaryBankDetailsIntlWireForeignIntermediaryFromJSON(json: any): IntermediaryBankDetailsIntlWireForeignIntermediary;
+export declare function IntermediaryBankDetailsIntlWireForeignIntermediaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntermediaryBankDetailsIntlWireForeignIntermediary;
+export declare function IntermediaryBankDetailsIntlWireForeignIntermediaryToJSON(json: any): IntermediaryBankDetailsIntlWireForeignIntermediary;
+export declare function IntermediaryBankDetailsIntlWireForeignIntermediaryToJSONTyped(value?: IntermediaryBankDetailsIntlWireForeignIntermediary | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/IntermediaryBankDetailsIntlWireForeignIntermediary.js

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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
+ */
+export const IntermediaryBankDetailsIntlWireForeignIntermediaryIntermediaryBankTypeEnum = {
+    INTERNATIONAL: 'INTERNATIONAL'
+};
+/**
+ * Check if a given object implements the IntermediaryBankDetailsIntlWireForeignIntermediary interface.
+ */
+export function instanceOfIntermediaryBankDetailsIntlWireForeignIntermediary(value) {
+    if (!('intermediaryBankType' in value) || value['intermediaryBankType'] === undefined)
+        return false;
+    if (!('intermediaryBankName' in value) || value['intermediaryBankName'] === undefined)
+        return false;
+    if (!('intermediaryBankSwiftNumber' in value) || value['intermediaryBankSwiftNumber'] === undefined)
+        return false;
+    if (!('intermediaryBankAccountNumber' in value) || value['intermediaryBankAccountNumber'] === undefined)
+        return false;
+    return true;
+}
+export function IntermediaryBankDetailsIntlWireForeignIntermediaryFromJSON(json) {
+    return IntermediaryBankDetailsIntlWireForeignIntermediaryFromJSONTyped(json, false);
+}
+export function IntermediaryBankDetailsIntlWireForeignIntermediaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'intermediaryBankType': json['intermediaryBankType'],
+        'intermediaryBankName': json['intermediaryBankName'],
+        'intermediaryBankSwiftNumber': json['intermediaryBankSwiftNumber'],
+        'intermediaryBankAccountNumber': json['intermediaryBankAccountNumber'],
+    };
+}
+export function IntermediaryBankDetailsIntlWireForeignIntermediaryToJSON(json) {
+    return IntermediaryBankDetailsIntlWireForeignIntermediaryToJSONTyped(json, false);
+}
+export function IntermediaryBankDetailsIntlWireForeignIntermediaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'intermediaryBankType': value['intermediaryBankType'],
+        'intermediaryBankName': value['intermediaryBankName'],
+        'intermediaryBankSwiftNumber': value['intermediaryBankSwiftNumber'],
+        'intermediaryBankAccountNumber': value['intermediaryBankAccountNumber'],
+    };
+}
+//# sourceMappingURL=IntermediaryBankDetailsIntlWireForeignIntermediary.js.map

package/dist/generated/src/models/IntermediaryBankDetailsIntlWireForeignIntermediary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntermediaryBankDetailsIntlWireForeignIntermediary.js","sourceRoot":"","sources":["../../../../generated/src/models/IntermediaryBankDetailsIntlWireForeignIntermediary.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAuCH;;GAEG;AACH,MAAM,CAAC,MAAM,0EAA0E,GAAG;IACtF,aAAa,EAAE,eAAe;CACxB,CAAC;AAIX;;GAEG;AACH,MAAM,UAAU,4DAA4D,CAAC,KAAa;IACtF,IAAI,CAAC,CAAC,sBAAsB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpG,IAAI,CAAC,CAAC,sBAAsB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpG,IAAI,CAAC,CAAC,6BAA6B,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClH,IAAI,CAAC,CAAC,+BAA+B,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,+BAA+B,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtH,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,0DAA0D,CAAC,IAAS;IAChF,OAAO,+DAA+D,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACxF,CAAC;AAED,MAAM,UAAU,+DAA+D,CAAC,IAAS,EAAE,mBAA4B;IACnH,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC;QACpD,sBAAsB,EAAE,IAAI,CAAC,sBAAsB,CAAC;QACpD,6BAA6B,EAAE,IAAI,CAAC,6BAA6B,CAAC;QAClE,+BAA+B,EAAE,IAAI,CAAC,+BAA+B,CAAC;KACzE,CAAC;AACN,CAAC;AAED,MAAM,UAAU,wDAAwD,CAAC,IAAS;IAC9E,OAAO,6DAA6D,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,6DAA6D,CAAC,KAAiE,EAAE,sBAA+B,KAAK;IACjL,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,CAAC;QACrD,sBAAsB,EAAE,KAAK,CAAC,sBAAsB,CAAC;QACrD,6BAA6B,EAAE,KAAK,CAAC,6BAA6B,CAAC;QACnE,+BAA+B,EAAE,KAAK,CAAC,+BAA+B,CAAC;KAC1E,CAAC;AACN,CAAC"}

package/dist/generated/src/models/InternationalWireTransaction.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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 type { IntermediaryBankDetailsInternational } from './IntermediaryBankDetailsInternational.js';
+import type { BeneficiaryDetails } from './BeneficiaryDetails.js';
+import type { CurrencyCode6 } from './CurrencyCode6.js';
+import type { BeneficiaryBankDetailsInternational } from './BeneficiaryBankDetailsInternational.js';
+/**
+ * Wire transaction body for **WIRE_INTERNATIONAL**. When **sendInForeignCurrency** or **transactInForeignCurrency** is true, **foreignCurrencyCode** is required; when **transactInForeignCurrency** is true, **foreignCurrencyAmount** is also required. Do not set both currency flags to true. When both are false, the wire settles in **currencyCode** without separate foreign currency fields.
+ *
+ * @export
+ * @interface InternationalWireTransaction
+ */
+export interface InternationalWireTransaction {
+    /**
+     * Transaction identifier
+     * @type {string}
+     * @memberof InternationalWireTransaction
+     */
+    id?: string;
+    /**
+     * Transaction amount
+     * @type {number}
+     * @memberof InternationalWireTransaction
+     */
+    amount: number;
+    /**
+     * Price per transaction (optional)
+     * @type {number}
+     * @memberof InternationalWireTransaction
+     */
+    transactionPrice?: number;
+    /**
+     *
+     * @type {CurrencyCode6}
+     * @memberof InternationalWireTransaction
+     */
+    currencyCode: CurrencyCode6;
+    /**
+     * Parent payment identifier
+     * @type {string}
+     * @memberof InternationalWireTransaction
+     */
+    paymentId?: string;
+    /**
+     *
+     * @type {BeneficiaryDetails}
+     * @memberof InternationalWireTransaction
+     */
+    beneficiaryDetails: BeneficiaryDetails;
+    /**
+     *
+     * @type {BeneficiaryBankDetailsInternational}
+     * @memberof InternationalWireTransaction
+     */
+    beneficiaryBankDetails: BeneficiaryBankDetailsInternational;
+    /**
+     *
+     * @type {IntermediaryBankDetailsInternational}
+     * @memberof InternationalWireTransaction
+     */
+    intermediaryBankDetails?: IntermediaryBankDetailsInternational;
+    /**
+     *
+     * @type {boolean}
+     * @memberof InternationalWireTransaction
+     */
+    sendInForeignCurrency: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof InternationalWireTransaction
+     */
+    transactInForeignCurrency: boolean;
+    /**
+     *
+     * @type {CurrencyCode6}
+     * @memberof InternationalWireTransaction
+     */
+    foreignCurrencyCode: CurrencyCode6;
+    /**
+     * Optional display label for the foreign currency. **foreignCurrencyCode** must match the **#/components/schemas/CurrencyCode** enum (e.g. **EUR**).
+     * @type {string}
+     * @memberof InternationalWireTransaction
+     */
+    foreignCurrencyName?: string;
+    /**
+     * Amount in foreign currency
+     * @type {number}
+     * @memberof InternationalWireTransaction
+     */
+    foreignCurrencyAmount: number;
+    /**
+     * Exchange rate applied
+     * @type {number}
+     * @memberof InternationalWireTransaction
+     */
+    exchangeRate?: number;
+}
+/**
+ * Check if a given object implements the InternationalWireTransaction interface.
+ */
+export declare function instanceOfInternationalWireTransaction(value: object): value is InternationalWireTransaction;
+export declare function InternationalWireTransactionFromJSON(json: any): InternationalWireTransaction;
+export declare function InternationalWireTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): InternationalWireTransaction;
+export declare function InternationalWireTransactionToJSON(json: any): InternationalWireTransaction;
+export declare function InternationalWireTransactionToJSONTyped(value?: InternationalWireTransaction | null, ignoreDiscriminator?: boolean): any;

package/dist/generated/src/models/InternationalWireTransaction.js

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Candescent DI API
+ * Welcome to the **Candescent Digital Insight API** documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.  ## Getting Started  New to the Candescent API? Start here:  - **[Quick Start Guide](/guides/getting-started/quickstart/)** - Make your first API call in minutes - **[API Categories Overview](/guides/getting-started/api-overview/)** - Explore all available API categories - **[Error Codes Reference](/guides/getting-started/error-codes/)** - Handle errors effectively  ## API Categories  | Category | Description | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **Note:** This documentation primarily references the **Stage** environment for examples.  ## Authentication Overview  Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:  ### Step 1: Obtain Client Credentials  Get your `Client ID` and `Client Secret` from the Candescent Developer Console.  ### Step 2: Generate an Access Token  ```bash curl -X POST \'https://api.stage.candescent.com/oauth2/v1/token\' \\   -H \'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>\' \\   -H \'Content-Type: application/x-www-form-urlencoded\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -d \'grant_type=client_credentials\' ```  ### Step 3: Make Authenticated Requests  Include the token in the `Authorization` header:  ```bash curl \'https://api.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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 { IntermediaryBankDetailsInternationalFromJSON, IntermediaryBankDetailsInternationalToJSON, } from './IntermediaryBankDetailsInternational.js';
+import { BeneficiaryDetailsFromJSON, BeneficiaryDetailsToJSON, } from './BeneficiaryDetails.js';
+import { CurrencyCode6FromJSON, CurrencyCode6ToJSON, } from './CurrencyCode6.js';
+import { BeneficiaryBankDetailsInternationalFromJSON, BeneficiaryBankDetailsInternationalToJSON, } from './BeneficiaryBankDetailsInternational.js';
+/**
+ * Check if a given object implements the InternationalWireTransaction interface.
+ */
+export function instanceOfInternationalWireTransaction(value) {
+    if (!('amount' in value) || value['amount'] === undefined)
+        return false;
+    if (!('currencyCode' in value) || value['currencyCode'] === undefined)
+        return false;
+    if (!('beneficiaryDetails' in value) || value['beneficiaryDetails'] === undefined)
+        return false;
+    if (!('beneficiaryBankDetails' in value) || value['beneficiaryBankDetails'] === undefined)
+        return false;
+    if (!('sendInForeignCurrency' in value) || value['sendInForeignCurrency'] === undefined)
+        return false;
+    if (!('transactInForeignCurrency' in value) || value['transactInForeignCurrency'] === undefined)
+        return false;
+    if (!('foreignCurrencyCode' in value) || value['foreignCurrencyCode'] === undefined)
+        return false;
+    if (!('foreignCurrencyAmount' in value) || value['foreignCurrencyAmount'] === undefined)
+        return false;
+    return true;
+}
+export function InternationalWireTransactionFromJSON(json) {
+    return InternationalWireTransactionFromJSONTyped(json, false);
+}
+export function InternationalWireTransactionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'amount': json['amount'],
+        'transactionPrice': json['transactionPrice'] == null ? undefined : json['transactionPrice'],
+        'currencyCode': CurrencyCode6FromJSON(json['currencyCode']),
+        'paymentId': json['paymentId'] == null ? undefined : json['paymentId'],
+        'beneficiaryDetails': BeneficiaryDetailsFromJSON(json['beneficiaryDetails']),
+        'beneficiaryBankDetails': BeneficiaryBankDetailsInternationalFromJSON(json['beneficiaryBankDetails']),
+        'intermediaryBankDetails': json['intermediaryBankDetails'] == null ? undefined : IntermediaryBankDetailsInternationalFromJSON(json['intermediaryBankDetails']),
+        'sendInForeignCurrency': json['sendInForeignCurrency'],
+        'transactInForeignCurrency': json['transactInForeignCurrency'],
+        'foreignCurrencyCode': CurrencyCode6FromJSON(json['foreignCurrencyCode']),
+        'foreignCurrencyName': json['foreignCurrencyName'] == null ? undefined : json['foreignCurrencyName'],
+        'foreignCurrencyAmount': json['foreignCurrencyAmount'],
+        'exchangeRate': json['exchangeRate'] == null ? undefined : json['exchangeRate'],
+    };
+}
+export function InternationalWireTransactionToJSON(json) {
+    return InternationalWireTransactionToJSONTyped(json, false);
+}
+export function InternationalWireTransactionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'amount': value['amount'],
+        'transactionPrice': value['transactionPrice'],
+        'currencyCode': CurrencyCode6ToJSON(value['currencyCode']),
+        'paymentId': value['paymentId'],
+        'beneficiaryDetails': BeneficiaryDetailsToJSON(value['beneficiaryDetails']),
+        'beneficiaryBankDetails': BeneficiaryBankDetailsInternationalToJSON(value['beneficiaryBankDetails']),
+        'intermediaryBankDetails': IntermediaryBankDetailsInternationalToJSON(value['intermediaryBankDetails']),
+        'sendInForeignCurrency': value['sendInForeignCurrency'],
+        'transactInForeignCurrency': value['transactInForeignCurrency'],
+        'foreignCurrencyCode': CurrencyCode6ToJSON(value['foreignCurrencyCode']),
+        'foreignCurrencyName': value['foreignCurrencyName'],
+        'foreignCurrencyAmount': value['foreignCurrencyAmount'],
+        'exchangeRate': value['exchangeRate'],
+    };
+}
+//# sourceMappingURL=InternationalWireTransaction.js.map

package/dist/generated/src/models/InternationalWireTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternationalWireTransaction.js","sourceRoot":"","sources":["../../../../generated/src/models/InternationalWireTransaction.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAIH,OAAO,EACH,4CAA4C,EAE5C,0CAA0C,GAE7C,MAAM,2CAA2C,CAAC;AAEnD,OAAO,EACH,0BAA0B,EAE1B,wBAAwB,GAE3B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACH,qBAAqB,EAErB,mBAAmB,GAEtB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACH,2CAA2C,EAE3C,yCAAyC,GAE5C,MAAM,0CAA0C,CAAC;AAiGlD;;GAEG;AACH,MAAM,UAAU,sCAAsC,CAAC,KAAa;IAChE,IAAI,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,CAAC,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACpF,IAAI,CAAC,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAChG,IAAI,CAAC,CAAC,wBAAwB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxG,IAAI,CAAC,CAAC,uBAAuB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtG,IAAI,CAAC,CAAC,2BAA2B,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC9G,IAAI,CAAC,CAAC,qBAAqB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAClG,IAAI,CAAC,CAAC,uBAAuB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACtG,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,oCAAoC,CAAC,IAAS;IAC1D,OAAO,yCAAyC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,yCAAyC,CAAC,IAAS,EAAE,mBAA4B;IAC7F,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,OAAO;QAEH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACjD,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QACxB,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC;QAC3F,cAAc,EAAE,qBAAqB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3D,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;QACtE,oBAAoB,EAAE,0BAA0B,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC5E,wBAAwB,EAAE,2CAA2C,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QACrG,yBAAyB,EAAE,IAAI,CAAC,yBAAyB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,4CAA4C,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC9J,uBAAuB,EAAE,IAAI,CAAC,uBAAuB,CAAC;QACtD,2BAA2B,EAAE,IAAI,CAAC,2BAA2B,CAAC;QAC9D,qBAAqB,EAAE,qBAAqB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QACzE,qBAAqB,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;QACpG,uBAAuB,EAAE,IAAI,CAAC,uBAAuB,CAAC;QACtD,cAAc,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC;KAClF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,IAAS;IACxD,OAAO,uCAAuC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,uCAAuC,CAAC,KAA2C,EAAE,sBAA+B,KAAK;IACrI,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO;QAEH,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;QACjB,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,kBAAkB,EAAE,KAAK,CAAC,kBAAkB,CAAC;QAC7C,cAAc,EAAE,mBAAmB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC1D,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;QAC/B,oBAAoB,EAAE,wBAAwB,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC3E,wBAAwB,EAAE,yCAAyC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACpG,yBAAyB,EAAE,0CAA0C,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;QACvG,uBAAuB,EAAE,KAAK,CAAC,uBAAuB,CAAC;QACvD,2BAA2B,EAAE,KAAK,CAAC,2BAA2B,CAAC;QAC/D,qBAAqB,EAAE,mBAAmB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACxE,qBAAqB,EAAE,KAAK,CAAC,qBAAqB,CAAC;QACnD,uBAAuB,EAAE,KAAK,CAAC,uBAAuB,CAAC;QACvD,cAAc,EAAE,KAAK,CAAC,cAAc,CAAC;KACxC,CAAC;AACN,CAAC"}