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

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

@@ -1,66 +0,0 @@
-/**
- * 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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
- * @interface PhoneNumber
- */
-export interface PhoneNumber {
-    /**
-     * Unique id for the phone
-     * @type {string}
-     * @memberof PhoneNumber
-     */
-    id?: string;
-    /**
-     * Phone country code
-     * @type {string}
-     * @memberof PhoneNumber
-     */
-    countryCode?: string;
-    /**
-     * Phone number
-     * @type {string}
-     * @memberof PhoneNumber
-     */
-    number?: string;
-    /**
-     * Phone protocol
-     * @type {PhoneNumberProtocolEnum}
-     * @memberof PhoneNumber
-     */
-    protocol?: PhoneNumberProtocolEnum;
-    /**
-     * Phone is activated or not
-     * @type {boolean}
-     * @memberof PhoneNumber
-     */
-    activated?: boolean;
-}
-/**
- * @export
- */
-export declare const PhoneNumberProtocolEnum: {
-    readonly VOICE: "VOICE";
-    readonly SMS: "SMS";
-    readonly EMAIL: "EMAIL";
-    readonly TOKEN: "TOKEN";
-};
-export type PhoneNumberProtocolEnum = typeof PhoneNumberProtocolEnum[keyof typeof PhoneNumberProtocolEnum];
-/**
- * Check if a given object implements the PhoneNumber interface.
- */
-export declare function instanceOfPhoneNumber(value: object): value is PhoneNumber;
-export declare function PhoneNumberFromJSON(json: any): PhoneNumber;
-export declare function PhoneNumberFromJSONTyped(json: any, ignoreDiscriminator: boolean): PhoneNumber;
-export declare function PhoneNumberToJSON(json: any): PhoneNumber;
-export declare function PhoneNumberToJSONTyped(value?: PhoneNumber | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,58 +0,0 @@
-/* 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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 PhoneNumberProtocolEnum = {
-    VOICE: 'VOICE',
-    SMS: 'SMS',
-    EMAIL: 'EMAIL',
-    TOKEN: 'TOKEN'
-};
-/**
- * Check if a given object implements the PhoneNumber interface.
- */
-export function instanceOfPhoneNumber(value) {
-    return true;
-}
-export function PhoneNumberFromJSON(json) {
-    return PhoneNumberFromJSONTyped(json, false);
-}
-export function PhoneNumberFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'id': json['id'] == null ? undefined : json['id'],
-        'countryCode': json['countryCode'] == null ? undefined : json['countryCode'],
-        'number': json['number'] == null ? undefined : json['number'],
-        'protocol': json['protocol'] == null ? undefined : json['protocol'],
-        'activated': json['activated'] == null ? undefined : json['activated'],
-    };
-}
-export function PhoneNumberToJSON(json) {
-    return PhoneNumberToJSONTyped(json, false);
-}
-export function PhoneNumberToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'id': value['id'],
-        'countryCode': value['countryCode'],
-        'number': value['number'],
-        'protocol': value['protocol'],
-        'activated': value['activated'],
-    };
-}

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

@@ -1,94 +0,0 @@
-/**
- * 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Postal or street address used for customer profile.
- * @export
- * @interface PostalAddress1
- */
-export interface PostalAddress1 {
-    /**
-     * Key or sequence for this address when the customer has multiple postal addresses (ordering, selection, or updates).
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    index?: string;
-    /**
-     * Primary street address line (street number and name).
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    address1: string;
-    /**
-     * Secondary address line (e.g. unit, suite). Required for customer registration; contact-info update APIs may not require a value in this field.
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    address2?: string;
-    /**
-     * Optional third address line for additional location detail.
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    address3?: string;
-    /**
-     * City or locality name.
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    city: string;
-    /**
-     * State, province, or region code (e.g. US state abbreviation).
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    state: string;
-    /**
-     * Postal or ZIP code.
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    postalCode?: string;
-    /**
-     * Country code (typically ISO 3166-1 alpha-2, e.g. US).
-     * @type {string}
-     * @memberof PostalAddress1
-     */
-    country?: string;
-    /**
-     * Address classification: physical vs mailing, home vs work, seasonal, temporary, or tax reporting. Use UNKNOWN when not specified.
-     * @type {PostalAddress1TypeEnum}
-     * @memberof PostalAddress1
-     */
-    type?: PostalAddress1TypeEnum;
-}
-/**
- * @export
- */
-export declare const PostalAddress1TypeEnum: {
-    readonly UNKNOWN: "UNKNOWN";
-    readonly PHYSICAL_HOME_ADDRESS: "PHYSICAL_HOME_ADDRESS";
-    readonly MAILING_HOME_ADDRESS: "MAILING_HOME_ADDRESS";
-    readonly PHYSICAL_WORK_ADDRESS: "PHYSICAL_WORK_ADDRESS";
-    readonly MAILING_WORK_ADDRESS: "MAILING_WORK_ADDRESS";
-    readonly SEASONAL_OR_VACATION_ADDRESS: "SEASONAL_OR_VACATION_ADDRESS";
-    readonly TEMPORARY_ADDRESS: "TEMPORARY_ADDRESS";
-    readonly TAX_REPORTING_ADDRESS: "TAX_REPORTING_ADDRESS";
-};
-export type PostalAddress1TypeEnum = typeof PostalAddress1TypeEnum[keyof typeof PostalAddress1TypeEnum];
-/**
- * Check if a given object implements the PostalAddress1 interface.
- */
-export declare function instanceOfPostalAddress1(value: object): value is PostalAddress1;
-export declare function PostalAddress1FromJSON(json: any): PostalAddress1;
-export declare function PostalAddress1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostalAddress1;
-export declare function PostalAddress1ToJSON(json: any): PostalAddress1;
-export declare function PostalAddress1ToJSONTyped(value?: PostalAddress1 | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,76 +0,0 @@
-/* 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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 PostalAddress1TypeEnum = {
-    UNKNOWN: 'UNKNOWN',
-    PHYSICAL_HOME_ADDRESS: 'PHYSICAL_HOME_ADDRESS',
-    MAILING_HOME_ADDRESS: 'MAILING_HOME_ADDRESS',
-    PHYSICAL_WORK_ADDRESS: 'PHYSICAL_WORK_ADDRESS',
-    MAILING_WORK_ADDRESS: 'MAILING_WORK_ADDRESS',
-    SEASONAL_OR_VACATION_ADDRESS: 'SEASONAL_OR_VACATION_ADDRESS',
-    TEMPORARY_ADDRESS: 'TEMPORARY_ADDRESS',
-    TAX_REPORTING_ADDRESS: 'TAX_REPORTING_ADDRESS'
-};
-/**
- * Check if a given object implements the PostalAddress1 interface.
- */
-export function instanceOfPostalAddress1(value) {
-    if (!('address1' in value) || value['address1'] === undefined)
-        return false;
-    if (!('city' in value) || value['city'] === undefined)
-        return false;
-    if (!('state' in value) || value['state'] === undefined)
-        return false;
-    return true;
-}
-export function PostalAddress1FromJSON(json) {
-    return PostalAddress1FromJSONTyped(json, false);
-}
-export function PostalAddress1FromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'index': json['index'] == null ? undefined : json['index'],
-        'address1': json['address1'],
-        'address2': json['address2'] == null ? undefined : json['address2'],
-        'address3': json['address3'] == null ? undefined : json['address3'],
-        'city': json['city'],
-        'state': json['state'],
-        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
-        'country': json['country'] == null ? undefined : json['country'],
-        'type': json['type'] == null ? undefined : json['type'],
-    };
-}
-export function PostalAddress1ToJSON(json) {
-    return PostalAddress1ToJSONTyped(json, false);
-}
-export function PostalAddress1ToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'index': value['index'],
-        'address1': value['address1'],
-        'address2': value['address2'],
-        'address3': value['address3'],
-        'city': value['city'],
-        'state': value['state'],
-        'postalCode': value['postalCode'],
-        'country': value['country'],
-        'type': value['type'],
-    };
-}

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

@@ -1,112 +0,0 @@
-/**
- * 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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 { AdditionalFilters } from './AdditionalFilters.js';
-/**
- *
- * @export
- * @interface SearchCriteriaRequestBody
- */
-export interface SearchCriteriaRequestBody {
-    /**
-     * Start range for search in ISO-8601 date/time/time-zone format.
-     * @type {Date}
-     * @memberof SearchCriteriaRequestBody
-     */
-    startTime: Date;
-    /**
-     * End range for search in ISO-8601 date/time/time-zone format.
-     * @type {Date}
-     * @memberof SearchCriteriaRequestBody
-     */
-    endTime: Date;
-    /**
-     * The size limit for number of banking activities per response. The server can always override this value as needed and
-     * thus the limit passed can not be guaranteed. However, server will try to honor the limit when it can.
-     *
-     * @type {number}
-     * @memberof SearchCriteriaRequestBody
-     */
-    pageSize?: number;
-    /**
-     * List of event identifiers to filter on. When not present, the API will return all events matching other criterias.
-     * @type {Array<string>}
-     * @memberof SearchCriteriaRequestBody
-     */
-    eventIds?: Array<string>;
-    /**
-     * The type of user requested. When not specified, result will contain both user types.
-     * @type {SearchCriteriaRequestBodyUserTypeEnum}
-     * @memberof SearchCriteriaRequestBody
-     */
-    userType?: SearchCriteriaRequestBodyUserTypeEnum;
-    /**
-     * The type of userId provided. The type must present when userId value is present.
-     * @type {SearchCriteriaRequestBodyUserIdTypeEnum}
-     * @memberof SearchCriteriaRequestBody
-     */
-    userIdType?: SearchCriteriaRequestBodyUserIdTypeEnum;
-    /**
-     * User's member number or login identifier value based on type specified in userIdType.
-     * @type {string}
-     * @memberof SearchCriteriaRequestBody
-     */
-    userId?: string;
-    /**
-     * List of attribute identifiers to return in data set. When not present, the API will return all attributes.
-     * Despite the filter, these fields will always be in the response - timestamp, eventId, guid, ReqCtx_loginId or
-     * member (based on the userId type provided), companyId (if it was passed without userId).
-     *
-     * @type {Array<string>}
-     * @memberof SearchCriteriaRequestBody
-     */
-    requestedAttributes?: Array<string>;
-    /**
-     * Additional filters to be applied and their conditional relation to one another. The conditional relation can be `and` or `or`.
-     * There can be sub group of filters passed if both conditional relations are desired.
-     *
-     * @type {Array<AdditionalFilters>}
-     * @memberof SearchCriteriaRequestBody
-     */
-    additionalFilters?: Array<AdditionalFilters>;
-    /**
-     * Allows retrieval of the next page of banking activities from a previous query. A hashed value of last index sent by the server.
-     * This value needs to be sent as it was received in response.
-     *
-     * @type {string}
-     * @memberof SearchCriteriaRequestBody
-     */
-    nextPageToken?: string;
-}
-/**
- * @export
- */
-export declare const SearchCriteriaRequestBodyUserTypeEnum: {
-    readonly RETAIL: "retail";
-    readonly BUSINESS: "business";
-};
-export type SearchCriteriaRequestBodyUserTypeEnum = typeof SearchCriteriaRequestBodyUserTypeEnum[keyof typeof SearchCriteriaRequestBodyUserTypeEnum];
-/**
- * @export
- */
-export declare const SearchCriteriaRequestBodyUserIdTypeEnum: {
-    readonly LOGIN_ID: "loginId";
-    readonly MEMBER_ID: "memberId";
-};
-export type SearchCriteriaRequestBodyUserIdTypeEnum = typeof SearchCriteriaRequestBodyUserIdTypeEnum[keyof typeof SearchCriteriaRequestBodyUserIdTypeEnum];
-/**
- * Check if a given object implements the SearchCriteriaRequestBody interface.
- */
-export declare function instanceOfSearchCriteriaRequestBody(value: object): value is SearchCriteriaRequestBody;
-export declare function SearchCriteriaRequestBodyFromJSON(json: any): SearchCriteriaRequestBody;
-export declare function SearchCriteriaRequestBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchCriteriaRequestBody;
-export declare function SearchCriteriaRequestBodyToJSON(json: any): SearchCriteriaRequestBody;
-export declare function SearchCriteriaRequestBodyToJSONTyped(value?: SearchCriteriaRequestBody | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,78 +0,0 @@
-/* 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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 { AdditionalFiltersFromJSON, AdditionalFiltersToJSON, } from './AdditionalFilters.js';
-/**
- * @export
- */
-export const SearchCriteriaRequestBodyUserTypeEnum = {
-    RETAIL: 'retail',
-    BUSINESS: 'business'
-};
-/**
- * @export
- */
-export const SearchCriteriaRequestBodyUserIdTypeEnum = {
-    LOGIN_ID: 'loginId',
-    MEMBER_ID: 'memberId'
-};
-/**
- * Check if a given object implements the SearchCriteriaRequestBody interface.
- */
-export function instanceOfSearchCriteriaRequestBody(value) {
-    if (!('startTime' in value) || value['startTime'] === undefined)
-        return false;
-    if (!('endTime' in value) || value['endTime'] === undefined)
-        return false;
-    return true;
-}
-export function SearchCriteriaRequestBodyFromJSON(json) {
-    return SearchCriteriaRequestBodyFromJSONTyped(json, false);
-}
-export function SearchCriteriaRequestBodyFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'startTime': (new Date(json['startTime'])),
-        'endTime': (new Date(json['endTime'])),
-        'pageSize': json['pageSize'] == null ? undefined : json['pageSize'],
-        'eventIds': json['eventIds'] == null ? undefined : json['eventIds'],
-        'userType': json['userType'] == null ? undefined : json['userType'],
-        'userIdType': json['userIdType'] == null ? undefined : json['userIdType'],
-        'userId': json['userId'] == null ? undefined : json['userId'],
-        'requestedAttributes': json['requestedAttributes'] == null ? undefined : json['requestedAttributes'],
-        'additionalFilters': json['additionalFilters'] == null ? undefined : (json['additionalFilters'].map(AdditionalFiltersFromJSON)),
-        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
-    };
-}
-export function SearchCriteriaRequestBodyToJSON(json) {
-    return SearchCriteriaRequestBodyToJSONTyped(json, false);
-}
-export function SearchCriteriaRequestBodyToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'startTime': value['startTime'].toISOString(),
-        'endTime': value['endTime'].toISOString(),
-        'pageSize': value['pageSize'],
-        'eventIds': value['eventIds'],
-        'userType': value['userType'],
-        'userIdType': value['userIdType'],
-        'userId': value['userId'],
-        'requestedAttributes': value['requestedAttributes'],
-        'additionalFilters': value['additionalFilters'] == null ? undefined : (value['additionalFilters'].map(AdditionalFiltersToJSON)),
-        'nextPageToken': value['nextPageToken'],
-    };
-}

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

@@ -1,40 +0,0 @@
-/**
- * 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.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
- * @interface SearchResultResponse
- */
-export interface SearchResultResponse {
-    /**
-     * List of banking activities that match given request. The banking activity will contain only requested attributes if present in request.
-     * @type {Array<object>}
-     * @memberof SearchResultResponse
-     */
-    bankingActivities?: Array<object>;
-    /**
-     * Allows retrieval of the next page of banking activities from a previous query. This value needs to be sent as it was received in response.
-     * If this value is null or not present, there are no further banking activities to fetch.
-     *
-     * @type {string}
-     * @memberof SearchResultResponse
-     */
-    nextPageToken?: string;
-}
-/**
- * Check if a given object implements the SearchResultResponse interface.
- */
-export declare function instanceOfSearchResultResponse(value: object): value is SearchResultResponse;
-export declare function SearchResultResponseFromJSON(json: any): SearchResultResponse;
-export declare function SearchResultResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchResultResponse;
-export declare function SearchResultResponseToJSON(json: any): SearchResultResponse;
-export declare function SearchResultResponseToJSONTyped(value?: SearchResultResponse | null, ignoreDiscriminator?: boolean): any;

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

@@ -1,43 +0,0 @@
-/* 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 | |----------|-------------| | **[Accounts](/api/generated/accounts/)** | Account information, transactions, and banking images | | **[Alert Configuration](/api/generated/alert-configuration/)** | Alert types and templates | | **[Alert Delivery](/api/generated/alert-delivery/)** | Alert delivery history | | **[Alert Preferences](/api/generated/alert-preferences/)** | End-user notification preferences | | **[Authentication](/api/generated/authentication/)** | OAuth 2.0 token management and authorization | | **[Business Banking](/api/generated/business-banking/)** | Business banking services | | **[Customer Campaigns](/api/generated/customer-campaigns/)** | User segmentation and promotions | | **[Customer Management](/api/generated/customer-management/)** | Customer profiles, registration, and self-service | | **[Documents and Preferences](/api/generated/documents-and-preferences/)** | Disclosures and e-statement preferences | | **[Money Movement](/api/generated/money-movement/)** | Recipients and fund transfers | | **[MX](/api/generated/mx/)** | Account aggregation and financial insights | | **[Notification Channels](/api/generated/notification-channels/)** | Notification channels for alert delivery |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Stage       | `https://api.candescent.com/digitalbanking/stage` | | Production  | `https://api.candescent.com/digitalbanking` |  > **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.candescent.com/digitalbanking/stage/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.candescent.com/digitalbanking/stage/accounts/v1/accounts\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/authentication/)**.
- *
- * The version of the OpenAPI document: 1.4.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * Check if a given object implements the SearchResultResponse interface.
- */
-export function instanceOfSearchResultResponse(value) {
-    return true;
-}
-export function SearchResultResponseFromJSON(json) {
-    return SearchResultResponseFromJSONTyped(json, false);
-}
-export function SearchResultResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'bankingActivities': json['bankingActivities'] == null ? undefined : json['bankingActivities'],
-        'nextPageToken': json['nextPageToken'] == null ? undefined : json['nextPageToken'],
-    };
-}
-export function SearchResultResponseToJSON(json) {
-    return SearchResultResponseToJSONTyped(json, false);
-}
-export function SearchResultResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'bankingActivities': value['bankingActivities'],
-        'nextPageToken': value['nextPageToken'],
-    };
-}