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

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { FileMetadata } from './FileMetadata.js';
+/**
+ *
+ * @export
+ * @interface UserListsWithFileMetadata
+ */
+export interface UserListsWithFileMetadata {
+    /**
+     *
+     * @type {FileMetadata}
+     * @memberof UserListsWithFileMetadata
+     */
+    fileMetadata?: FileMetadata;
+}
+/**
+ * Check if a given object implements the UserListsWithFileMetadata interface.
+ */
+export declare function instanceOfUserListsWithFileMetadata(value: object): value is UserListsWithFileMetadata;
+export declare function UserListsWithFileMetadataFromJSON(json: any): UserListsWithFileMetadata;
+export declare function UserListsWithFileMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserListsWithFileMetadata;
+export declare function UserListsWithFileMetadataToJSON(json: any): UserListsWithFileMetadata;
+export declare function UserListsWithFileMetadataToJSONTyped(value?: UserListsWithFileMetadata | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,42 @@
+/* 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 { FileMetadataFromJSON, FileMetadataToJSON, } from './FileMetadata.js';
+/**
+ * Check if a given object implements the UserListsWithFileMetadata interface.
+ */
+export function instanceOfUserListsWithFileMetadata(value) {
+    return true;
+}
+export function UserListsWithFileMetadataFromJSON(json) {
+    return UserListsWithFileMetadataFromJSONTyped(json, false);
+}
+export function UserListsWithFileMetadataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileMetadata': json['fileMetadata'] == null ? undefined : FileMetadataFromJSON(json['fileMetadata']),
+    };
+}
+export function UserListsWithFileMetadataToJSON(json) {
+    return UserListsWithFileMetadataToJSONTyped(json, false);
+}
+export function UserListsWithFileMetadataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileMetadata': FileMetadataToJSON(value['fileMetadata']),
+    };
+}

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

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ * Boolean flags for digital banking customer state—access, enrollment, and email validity.
+ * @export
+ * @interface UserStatus
+ */
+export interface UserStatus {
+    /**
+     * Boolean flag indicating if the user account is currently active.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    active?: boolean;
+    /**
+     * Boolean flag indicating if the account is temporarily placed on hold.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    onHold?: boolean;
+    /**
+     * Boolean flag indicating if the account is locked due to repeated failed login attempts.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    locked?: boolean;
+    /**
+     * Boolean flag indicating if the user’s password has been reset.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    reset?: boolean;
+    /**
+     * Boolean flag indicating if the user has successfully completed the registration process.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    registered?: boolean;
+    /**
+     * Boolean flag indicating if the user has been approved to access online banking services.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    approved?: boolean;
+    /**
+     * Boolean flag indicating if the user has been denied access to online banking services.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    rejected?: boolean;
+    /**
+     * Boolean flag indicating if the user’s email address is incorrectly formatted.
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    invalidEmailId?: boolean;
+    /**
+     * Boolean flag indicating if the user has accepted required primary disclosure terms (typically during registration).
+     * @type {boolean}
+     * @memberof UserStatus
+     */
+    acceptedDisclosure?: boolean;
+}
+/**
+ * Check if a given object implements the UserStatus interface.
+ */
+export declare function instanceOfUserStatus(value: object): value is UserStatus;
+export declare function UserStatusFromJSON(json: any): UserStatus;
+export declare function UserStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserStatus;
+export declare function UserStatusToJSON(json: any): UserStatus;
+export declare function UserStatusToJSONTyped(value?: UserStatus | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,57 @@
+/* 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 UserStatus interface.
+ */
+export function instanceOfUserStatus(value) {
+    return true;
+}
+export function UserStatusFromJSON(json) {
+    return UserStatusFromJSONTyped(json, false);
+}
+export function UserStatusFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'active': json['active'] == null ? undefined : json['active'],
+        'onHold': json['onHold'] == null ? undefined : json['onHold'],
+        'locked': json['locked'] == null ? undefined : json['locked'],
+        'reset': json['reset'] == null ? undefined : json['reset'],
+        'registered': json['registered'] == null ? undefined : json['registered'],
+        'approved': json['approved'] == null ? undefined : json['approved'],
+        'rejected': json['rejected'] == null ? undefined : json['rejected'],
+        'invalidEmailId': json['invalidEmailId'] == null ? undefined : json['invalidEmailId'],
+        'acceptedDisclosure': json['acceptedDisclosure'] == null ? undefined : json['acceptedDisclosure'],
+    };
+}
+export function UserStatusToJSON(json) {
+    return UserStatusToJSONTyped(json, false);
+}
+export function UserStatusToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'active': value['active'],
+        'onHold': value['onHold'],
+        'locked': value['locked'],
+        'reset': value['reset'],
+        'registered': value['registered'],
+        'approved': value['approved'],
+        'rejected': value['rejected'],
+        'invalidEmailId': value['invalidEmailId'],
+        'acceptedDisclosure': value['acceptedDisclosure'],
+    };
+}

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

@@ -0,0 +1,284 @@
+/**
+ * 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 UserStatus1
+ */
+export interface UserStatus1 {
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    acceptedDisclosure?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    active?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    adminApprovedIBRegistrationInMC?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    alertsScheduled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    appliedForBPElectronicRegistration?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof UserStatus1
+     */
+    billpayId?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    billpayScheduled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    bpFrontPageFalseBpPendingPaymentsTrue?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    bpOptOut?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof UserStatus1
+     */
+    daysInactive?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    deleted?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    emailMfaEnrolled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    entitlements?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    fiApprovalPending?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    fiApproved?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    fiApprovedReset?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    fiRejected?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    inquiryOnly?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    invalidEmailId?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    issoUserEnrolled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    limbo?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    locked?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    mfaEnrolledCookie?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    mfaMandatory?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    mfaOptional?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    mustChangeAltUserId?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    mustChangePassword?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    needsToAcceptDisclosure?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    needsToAcceptSecondaryDisclosure?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    newUser?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    onHold?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    registered?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    reinitiated?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    reset?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    resetIssoUserEnrolled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    segmentAssigned?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    smsMobileActivationConfirmed?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    smsMobileEnrolled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    srtScheduled?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    subscribedToNewsletter?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    subscribedToPromotionalMessages?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    temporaryPassword?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UserStatus1
+     */
+    uspEnrolled?: boolean;
+}
+/**
+ * Check if a given object implements the UserStatus1 interface.
+ */
+export declare function instanceOfUserStatus1(value: object): value is UserStatus1;
+export declare function UserStatus1FromJSON(json: any): UserStatus1;
+export declare function UserStatus1FromJSONTyped(json: any, ignoreDiscriminator: boolean): UserStatus1;
+export declare function UserStatus1ToJSON(json: any): UserStatus1;
+export declare function UserStatus1ToJSONTyped(value?: UserStatus1 | null, ignoreDiscriminator?: boolean): any;

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

@@ -0,0 +1,125 @@
+/* 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 UserStatus1 interface.
+ */
+export function instanceOfUserStatus1(value) {
+    return true;
+}
+export function UserStatus1FromJSON(json) {
+    return UserStatus1FromJSONTyped(json, false);
+}
+export function UserStatus1FromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'acceptedDisclosure': json['acceptedDisclosure'] == null ? undefined : json['acceptedDisclosure'],
+        'active': json['active'] == null ? undefined : json['active'],
+        'adminApprovedIBRegistrationInMC': json['adminApprovedIBRegistrationInMC'] == null ? undefined : json['adminApprovedIBRegistrationInMC'],
+        'alertsScheduled': json['alertsScheduled'] == null ? undefined : json['alertsScheduled'],
+        'appliedForBPElectronicRegistration': json['appliedForBPElectronicRegistration'] == null ? undefined : json['appliedForBPElectronicRegistration'],
+        'billpayId': json['billpayId'] == null ? undefined : json['billpayId'],
+        'billpayScheduled': json['billpayScheduled'] == null ? undefined : json['billpayScheduled'],
+        'bpFrontPageFalseBpPendingPaymentsTrue': json['bpFrontPageFalseBpPendingPaymentsTrue'] == null ? undefined : json['bpFrontPageFalseBpPendingPaymentsTrue'],
+        'bpOptOut': json['bpOptOut'] == null ? undefined : json['bpOptOut'],
+        'daysInactive': json['daysInactive'] == null ? undefined : json['daysInactive'],
+        'deleted': json['deleted'] == null ? undefined : json['deleted'],
+        'emailMfaEnrolled': json['emailMfaEnrolled'] == null ? undefined : json['emailMfaEnrolled'],
+        'entitlements': json['entitlements'] == null ? undefined : json['entitlements'],
+        'fiApprovalPending': json['fiApprovalPending'] == null ? undefined : json['fiApprovalPending'],
+        'fiApproved': json['fiApproved'] == null ? undefined : json['fiApproved'],
+        'fiApprovedReset': json['fiApprovedReset'] == null ? undefined : json['fiApprovedReset'],
+        'fiRejected': json['fiRejected'] == null ? undefined : json['fiRejected'],
+        'inquiryOnly': json['inquiryOnly'] == null ? undefined : json['inquiryOnly'],
+        'invalidEmailId': json['invalidEmailId'] == null ? undefined : json['invalidEmailId'],
+        'issoUserEnrolled': json['issoUserEnrolled'] == null ? undefined : json['issoUserEnrolled'],
+        'limbo': json['limbo'] == null ? undefined : json['limbo'],
+        'locked': json['locked'] == null ? undefined : json['locked'],
+        'mfaEnrolledCookie': json['mfaEnrolledCookie'] == null ? undefined : json['mfaEnrolledCookie'],
+        'mfaMandatory': json['mfaMandatory'] == null ? undefined : json['mfaMandatory'],
+        'mfaOptional': json['mfaOptional'] == null ? undefined : json['mfaOptional'],
+        'mustChangeAltUserId': json['mustChangeAltUserId'] == null ? undefined : json['mustChangeAltUserId'],
+        'mustChangePassword': json['mustChangePassword'] == null ? undefined : json['mustChangePassword'],
+        'needsToAcceptDisclosure': json['needsToAcceptDisclosure'] == null ? undefined : json['needsToAcceptDisclosure'],
+        'needsToAcceptSecondaryDisclosure': json['needsToAcceptSecondaryDisclosure'] == null ? undefined : json['needsToAcceptSecondaryDisclosure'],
+        'newUser': json['newUser'] == null ? undefined : json['newUser'],
+        'onHold': json['onHold'] == null ? undefined : json['onHold'],
+        'registered': json['registered'] == null ? undefined : json['registered'],
+        'reinitiated': json['reinitiated'] == null ? undefined : json['reinitiated'],
+        'reset': json['reset'] == null ? undefined : json['reset'],
+        'resetIssoUserEnrolled': json['resetIssoUserEnrolled'] == null ? undefined : json['resetIssoUserEnrolled'],
+        'segmentAssigned': json['segmentAssigned'] == null ? undefined : json['segmentAssigned'],
+        'smsMobileActivationConfirmed': json['smsMobileActivationConfirmed'] == null ? undefined : json['smsMobileActivationConfirmed'],
+        'smsMobileEnrolled': json['smsMobileEnrolled'] == null ? undefined : json['smsMobileEnrolled'],
+        'srtScheduled': json['srtScheduled'] == null ? undefined : json['srtScheduled'],
+        'subscribedToNewsletter': json['subscribedToNewsletter'] == null ? undefined : json['subscribedToNewsletter'],
+        'subscribedToPromotionalMessages': json['subscribedToPromotionalMessages'] == null ? undefined : json['subscribedToPromotionalMessages'],
+        'temporaryPassword': json['temporaryPassword'] == null ? undefined : json['temporaryPassword'],
+        'uspEnrolled': json['uspEnrolled'] == null ? undefined : json['uspEnrolled'],
+    };
+}
+export function UserStatus1ToJSON(json) {
+    return UserStatus1ToJSONTyped(json, false);
+}
+export function UserStatus1ToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'acceptedDisclosure': value['acceptedDisclosure'],
+        'active': value['active'],
+        'adminApprovedIBRegistrationInMC': value['adminApprovedIBRegistrationInMC'],
+        'alertsScheduled': value['alertsScheduled'],
+        'appliedForBPElectronicRegistration': value['appliedForBPElectronicRegistration'],
+        'billpayId': value['billpayId'],
+        'billpayScheduled': value['billpayScheduled'],
+        'bpFrontPageFalseBpPendingPaymentsTrue': value['bpFrontPageFalseBpPendingPaymentsTrue'],
+        'bpOptOut': value['bpOptOut'],
+        'daysInactive': value['daysInactive'],
+        'deleted': value['deleted'],
+        'emailMfaEnrolled': value['emailMfaEnrolled'],
+        'entitlements': value['entitlements'],
+        'fiApprovalPending': value['fiApprovalPending'],
+        'fiApproved': value['fiApproved'],
+        'fiApprovedReset': value['fiApprovedReset'],
+        'fiRejected': value['fiRejected'],
+        'inquiryOnly': value['inquiryOnly'],
+        'invalidEmailId': value['invalidEmailId'],
+        'issoUserEnrolled': value['issoUserEnrolled'],
+        'limbo': value['limbo'],
+        'locked': value['locked'],
+        'mfaEnrolledCookie': value['mfaEnrolledCookie'],
+        'mfaMandatory': value['mfaMandatory'],
+        'mfaOptional': value['mfaOptional'],
+        'mustChangeAltUserId': value['mustChangeAltUserId'],
+        'mustChangePassword': value['mustChangePassword'],
+        'needsToAcceptDisclosure': value['needsToAcceptDisclosure'],
+        'needsToAcceptSecondaryDisclosure': value['needsToAcceptSecondaryDisclosure'],
+        'newUser': value['newUser'],
+        'onHold': value['onHold'],
+        'registered': value['registered'],
+        'reinitiated': value['reinitiated'],
+        'reset': value['reset'],
+        'resetIssoUserEnrolled': value['resetIssoUserEnrolled'],
+        'segmentAssigned': value['segmentAssigned'],
+        'smsMobileActivationConfirmed': value['smsMobileActivationConfirmed'],
+        'smsMobileEnrolled': value['smsMobileEnrolled'],
+        'srtScheduled': value['srtScheduled'],
+        'subscribedToNewsletter': value['subscribedToNewsletter'],
+        'subscribedToPromotionalMessages': value['subscribedToPromotionalMessages'],
+        'temporaryPassword': value['temporaryPassword'],
+        'uspEnrolled': value['uspEnrolled'],
+    };
+}