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

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

@@ -0,0 +1,52 @@
+/* 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 Frequency = {
+    ONETIME: 'ONETIME',
+    DAILY: 'DAILY',
+    WEEKLY: 'WEEKLY',
+    BIWEEKLY: 'BIWEEKLY',
+    TWICEMONTHLY: 'TWICEMONTHLY',
+    MONTHLY: 'MONTHLY',
+    EVERY4_WEEKS: 'EVERY4WEEKS',
+    EVERY8_WEEKS: 'EVERY8WEEKS',
+    QUARTERLY: 'QUARTERLY',
+    SEMIANNUALLY: 'SEMIANNUALLY',
+    ANNUALLY: 'ANNUALLY'
+};
+export function instanceOfFrequency(value) {
+    for (const key in Frequency) {
+        if (Object.prototype.hasOwnProperty.call(Frequency, key)) {
+            if (Frequency[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function FrequencyFromJSON(json) {
+    return FrequencyFromJSONTyped(json, false);
+}
+export function FrequencyFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FrequencyToJSON(value) {
+    return value;
+}
+export function FrequencyToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,39 @@
+/**
+ * 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 GetUser404Response
+ */
+export interface GetUser404Response {
+    [key: string]: any | any;
+    /**
+     *
+     * @type {string}
+     * @memberof GetUser404Response
+     */
+    error?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetUser404Response
+     */
+    message?: string;
+}
+/**
+ * Check if a given object implements the GetUser404Response interface.
+ */
+export declare function instanceOfGetUser404Response(value: object): value is GetUser404Response;
+export declare function GetUser404ResponseFromJSON(json: any): GetUser404Response;
+export declare function GetUser404ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUser404Response;
+export declare function GetUser404ResponseToJSON(json: any): GetUser404Response;
+export declare function GetUser404ResponseToJSONTyped(value?: GetUser404Response | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,45 @@
+/* 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 GetUser404Response interface.
+ */
+export function instanceOfGetUser404Response(value) {
+    return true;
+}
+export function GetUser404ResponseFromJSON(json) {
+    return GetUser404ResponseFromJSONTyped(json, false);
+}
+export function GetUser404ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        ...json,
+        'error': json['error'] == null ? undefined : json['error'],
+        'message': json['message'] == null ? undefined : json['message'],
+    };
+}
+export function GetUser404ResponseToJSON(json) {
+    return GetUser404ResponseToJSONTyped(json, false);
+}
+export function GetUser404ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        ...value,
+        'error': value['error'],
+        'message': value['message'],
+    };
+}

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

@@ -0,0 +1,45 @@
+/**
+ * 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 GetWidgetUrl200Response
+ */
+export interface GetWidgetUrl200Response {
+    [key: string]: any | any;
+    /**
+     * The widget redirect URL with embedded session token
+     * @type {string}
+     * @memberof GetWidgetUrl200Response
+     */
+    url?: string;
+    /**
+     * Widget type identifier
+     * @type {string}
+     * @memberof GetWidgetUrl200Response
+     */
+    type?: string;
+    /**
+     * MX user identifier
+     * @type {string}
+     * @memberof GetWidgetUrl200Response
+     */
+    userId?: string;
+}
+/**
+ * Check if a given object implements the GetWidgetUrl200Response interface.
+ */
+export declare function instanceOfGetWidgetUrl200Response(value: object): value is GetWidgetUrl200Response;
+export declare function GetWidgetUrl200ResponseFromJSON(json: any): GetWidgetUrl200Response;
+export declare function GetWidgetUrl200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetWidgetUrl200Response;
+export declare function GetWidgetUrl200ResponseToJSON(json: any): GetWidgetUrl200Response;
+export declare function GetWidgetUrl200ResponseToJSONTyped(value?: GetWidgetUrl200Response | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,47 @@
+/* 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 GetWidgetUrl200Response interface.
+ */
+export function instanceOfGetWidgetUrl200Response(value) {
+    return true;
+}
+export function GetWidgetUrl200ResponseFromJSON(json) {
+    return GetWidgetUrl200ResponseFromJSONTyped(json, false);
+}
+export function GetWidgetUrl200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        ...json,
+        'url': json['url'] == null ? undefined : json['url'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'userId': json['user_id'] == null ? undefined : json['user_id'],
+    };
+}
+export function GetWidgetUrl200ResponseToJSON(json) {
+    return GetWidgetUrl200ResponseToJSONTyped(json, false);
+}
+export function GetWidgetUrl200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        ...value,
+        'url': value['url'],
+        'type': value['type'],
+        'user_id': value['userId'],
+    };
+}

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

@@ -0,0 +1,64 @@
+/**
+ * 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 GroupBaseRequestDTO
+ */
+export interface GroupBaseRequestDTO {
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseRequestDTO
+     */
+    groupName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseRequestDTO
+     */
+    groupDescription?: string;
+    /**
+     * Required only for a create and must always be EXPERIENCE_GROUP
+     * @type {GroupBaseRequestDTOGroupTypeEnum}
+     * @memberof GroupBaseRequestDTO
+     */
+    groupType?: GroupBaseRequestDTOGroupTypeEnum;
+    /**
+     * Required only for a create and must always be RETAIL_BANKING
+     * @type {GroupBaseRequestDTOGroupPlatformEnum}
+     * @memberof GroupBaseRequestDTO
+     */
+    groupPlatform?: GroupBaseRequestDTOGroupPlatformEnum;
+}
+/**
+ * @export
+ */
+export declare const GroupBaseRequestDTOGroupTypeEnum: {
+    readonly EXPERIENCE_GROUP: "EXPERIENCE_GROUP";
+};
+export type GroupBaseRequestDTOGroupTypeEnum = typeof GroupBaseRequestDTOGroupTypeEnum[keyof typeof GroupBaseRequestDTOGroupTypeEnum];
+/**
+ * @export
+ */
+export declare const GroupBaseRequestDTOGroupPlatformEnum: {
+    readonly RETAIL_BANKING: "RETAIL_BANKING";
+};
+export type GroupBaseRequestDTOGroupPlatformEnum = typeof GroupBaseRequestDTOGroupPlatformEnum[keyof typeof GroupBaseRequestDTOGroupPlatformEnum];
+/**
+ * Check if a given object implements the GroupBaseRequestDTO interface.
+ */
+export declare function instanceOfGroupBaseRequestDTO(value: object): value is GroupBaseRequestDTO;
+export declare function GroupBaseRequestDTOFromJSON(json: any): GroupBaseRequestDTO;
+export declare function GroupBaseRequestDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupBaseRequestDTO;
+export declare function GroupBaseRequestDTOToJSON(json: any): GroupBaseRequestDTO;
+export declare function GroupBaseRequestDTOToJSONTyped(value?: GroupBaseRequestDTO | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,61 @@
+/* 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 GroupBaseRequestDTOGroupTypeEnum = {
+    EXPERIENCE_GROUP: 'EXPERIENCE_GROUP'
+};
+/**
+ * @export
+ */
+export const GroupBaseRequestDTOGroupPlatformEnum = {
+    RETAIL_BANKING: 'RETAIL_BANKING'
+};
+/**
+ * Check if a given object implements the GroupBaseRequestDTO interface.
+ */
+export function instanceOfGroupBaseRequestDTO(value) {
+    if (!('groupName' in value) || value['groupName'] === undefined)
+        return false;
+    return true;
+}
+export function GroupBaseRequestDTOFromJSON(json) {
+    return GroupBaseRequestDTOFromJSONTyped(json, false);
+}
+export function GroupBaseRequestDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'groupName': json['groupName'],
+        'groupDescription': json['groupDescription'] == null ? undefined : json['groupDescription'],
+        'groupType': json['groupType'] == null ? undefined : json['groupType'],
+        'groupPlatform': json['groupPlatform'] == null ? undefined : json['groupPlatform'],
+    };
+}
+export function GroupBaseRequestDTOToJSON(json) {
+    return GroupBaseRequestDTOToJSONTyped(json, false);
+}
+export function GroupBaseRequestDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'groupName': value['groupName'],
+        'groupDescription': value['groupDescription'],
+        'groupType': value['groupType'],
+        'groupPlatform': value['groupPlatform'],
+    };
+}

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

@@ -0,0 +1,109 @@
+/**
+ * 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 { GroupExperienceDTO } from './GroupExperienceDTO.js';
+/**
+ *
+ * @export
+ * @interface GroupBaseResponseDTO
+ */
+export interface GroupBaseResponseDTO {
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupDescription?: string;
+    /**
+     *
+     * @type {GroupBaseResponseDTOGroupTypeEnum}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupType?: GroupBaseResponseDTOGroupTypeEnum;
+    /**
+     *
+     * @type {GroupBaseResponseDTOGroupPlatformEnum}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupPlatform?: GroupBaseResponseDTOGroupPlatformEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupLastUpdatedDateTime?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupParticipantCount?: number;
+    /**
+     *
+     * @type {GroupExperienceDTO}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupExperience?: GroupExperienceDTO;
+    /**
+     *
+     * @type {string}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupExperienceName?: string;
+    /**
+     *
+     * @type {GroupBaseResponseDTOGroupStatusEnum}
+     * @memberof GroupBaseResponseDTO
+     */
+    groupStatus?: GroupBaseResponseDTOGroupStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const GroupBaseResponseDTOGroupTypeEnum: {
+    readonly EXPERIENCE_GROUP: "EXPERIENCE_GROUP";
+};
+export type GroupBaseResponseDTOGroupTypeEnum = typeof GroupBaseResponseDTOGroupTypeEnum[keyof typeof GroupBaseResponseDTOGroupTypeEnum];
+/**
+ * @export
+ */
+export declare const GroupBaseResponseDTOGroupPlatformEnum: {
+    readonly RETAIL_BANKING: "RETAIL_BANKING";
+};
+export type GroupBaseResponseDTOGroupPlatformEnum = typeof GroupBaseResponseDTOGroupPlatformEnum[keyof typeof GroupBaseResponseDTOGroupPlatformEnum];
+/**
+ * @export
+ */
+export declare const GroupBaseResponseDTOGroupStatusEnum: {
+    readonly ACTIVE: "ACTIVE";
+    readonly DELETED: "DELETED";
+};
+export type GroupBaseResponseDTOGroupStatusEnum = typeof GroupBaseResponseDTOGroupStatusEnum[keyof typeof GroupBaseResponseDTOGroupStatusEnum];
+/**
+ * Check if a given object implements the GroupBaseResponseDTO interface.
+ */
+export declare function instanceOfGroupBaseResponseDTO(value: object): value is GroupBaseResponseDTO;
+export declare function GroupBaseResponseDTOFromJSON(json: any): GroupBaseResponseDTO;
+export declare function GroupBaseResponseDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): GroupBaseResponseDTO;
+export declare function GroupBaseResponseDTOToJSON(json: any): GroupBaseResponseDTO;
+export declare function GroupBaseResponseDTOToJSONTyped(value?: GroupBaseResponseDTO | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,79 @@
+/* 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 { GroupExperienceDTOFromJSON, GroupExperienceDTOToJSON, } from './GroupExperienceDTO.js';
+/**
+ * @export
+ */
+export const GroupBaseResponseDTOGroupTypeEnum = {
+    EXPERIENCE_GROUP: 'EXPERIENCE_GROUP'
+};
+/**
+ * @export
+ */
+export const GroupBaseResponseDTOGroupPlatformEnum = {
+    RETAIL_BANKING: 'RETAIL_BANKING'
+};
+/**
+ * @export
+ */
+export const GroupBaseResponseDTOGroupStatusEnum = {
+    ACTIVE: 'ACTIVE',
+    DELETED: 'DELETED'
+};
+/**
+ * Check if a given object implements the GroupBaseResponseDTO interface.
+ */
+export function instanceOfGroupBaseResponseDTO(value) {
+    return true;
+}
+export function GroupBaseResponseDTOFromJSON(json) {
+    return GroupBaseResponseDTOFromJSONTyped(json, false);
+}
+export function GroupBaseResponseDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'groupId': json['groupId'] == null ? undefined : json['groupId'],
+        'groupName': json['groupName'] == null ? undefined : json['groupName'],
+        'groupDescription': json['groupDescription'] == null ? undefined : json['groupDescription'],
+        'groupType': json['groupType'] == null ? undefined : json['groupType'],
+        'groupPlatform': json['groupPlatform'] == null ? undefined : json['groupPlatform'],
+        'groupLastUpdatedDateTime': json['groupLastUpdatedDateTime'] == null ? undefined : json['groupLastUpdatedDateTime'],
+        'groupParticipantCount': json['groupParticipantCount'] == null ? undefined : json['groupParticipantCount'],
+        'groupExperience': json['groupExperience'] == null ? undefined : GroupExperienceDTOFromJSON(json['groupExperience']),
+        'groupExperienceName': json['groupExperienceName'] == null ? undefined : json['groupExperienceName'],
+        'groupStatus': json['groupStatus'] == null ? undefined : json['groupStatus'],
+    };
+}
+export function GroupBaseResponseDTOToJSON(json) {
+    return GroupBaseResponseDTOToJSONTyped(json, false);
+}
+export function GroupBaseResponseDTOToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'groupId': value['groupId'],
+        'groupName': value['groupName'],
+        'groupDescription': value['groupDescription'],
+        'groupType': value['groupType'],
+        'groupPlatform': value['groupPlatform'],
+        'groupLastUpdatedDateTime': value['groupLastUpdatedDateTime'],
+        'groupParticipantCount': value['groupParticipantCount'],
+        'groupExperience': GroupExperienceDTOToJSON(value['groupExperience']),
+        'groupExperienceName': value['groupExperienceName'],
+        'groupStatus': value['groupStatus'],
+    };
+}