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

package/dist/generated/src/apis/CustomerManagementApi.d.ts

@@ -0,0 +1,452 @@
+/**
+ * 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 * as runtime from '../runtime.js';
+import type { ContactInfo, ContactMethodResponse, CustomerInformation, FICustomer, InstitutionUser, RegisterCustomerRequest, RegisterCustomerResponse, ResetPasswordRequest, UserStatus2 } from '../models/index.js';
+export interface CustomerManagementApiGetContactMethodsRequest {
+    customerId: string;
+    userIdType?: GetContactMethodsUserIdTypeEnum;
+}
+export interface CustomerManagementApiGetCustomerRequest {
+    fiId: string;
+    fiCustomerId: string;
+    date?: string;
+    originatingIp?: string;
+    userAgent?: string;
+    offeringId?: string;
+    accept?: string;
+    cacheControl?: string;
+    fiCustomerIdType?: string;
+    operation?: string;
+}
+export interface CustomerManagementApiGetInformationRequest {
+    customerId: string;
+    userIdType?: GetInformationUserIdTypeEnum;
+}
+export interface CustomerManagementApiGetInstitutionUserRequest {
+    institutionUserId: string;
+    userIdType?: GetInstitutionUserUserIdTypeEnum;
+}
+export interface CustomerManagementApiGetUserStatusRequest {
+    userId: string;
+    userIdType: GetUserStatusUserIdTypeEnum;
+}
+export interface CustomerManagementApiRegisterRequest {
+    diFiid: string;
+    body: RegisterCustomerRequest;
+    contentType?: string;
+}
+export interface CustomerManagementApiResetPasswordOperationRequest {
+    customerId: string;
+    resetPasswordRequest: ResetPasswordRequest;
+}
+export interface CustomerManagementApiUnlockUserRequest {
+    customerId: string;
+}
+export interface CustomerManagementApiUpdateContactInfoRequest {
+    customerId: string;
+    contactInfo: ContactInfo;
+}
+/**
+ * CustomerManagementApi - interface
+ *
+ * @export
+ * @interface CustomerManagementApiInterface
+ */
+export interface CustomerManagementApiInterface {
+    /**
+     * Creates request options for getContactMethods without sending the request
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {'CUSTOMER_ID' | 'LOGIN_ID'} [userIdType] Unique identifier of user id type
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getContactMethodsRequestOpts(requestParameters: CustomerManagementApiGetContactMethodsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * @summary Fetch the contact methods for a given customer
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {'CUSTOMER_ID' | 'LOGIN_ID'} [userIdType] Unique identifier of user id type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getContactMethodsRaw(requestParameters: CustomerManagementApiGetContactMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactMethodResponse>>;
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * Fetch the contact methods for a given customer
+     */
+    getContactMethods(requestParameters: CustomerManagementApiGetContactMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactMethodResponse>;
+    /**
+     * Creates request options for getCustomer without sending the request
+     * @param {string} fiId the ID assigned to the financial institution.
+     * @param {string} fiCustomerId the ID for the requested customer.  This may be specified with various values, depending on the fiCustomerIDType parameter.  The default is to send the internal ID.
+     * @param {string} [date] The date and time that the message was sent. The expected format is UTC, e.g., &#x60;1994-11-05T13:15:30Z&#x60;.
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided, the IP address logged will be extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request (e.g., if a mobile device is used, the IP address should be that of the mobile device, rather than a back-end service).
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60;.
+     * @param {string} [offeringId] Uniquely identifies the name of the client app making the request. When not provided, this is derived based on a property held against the application within Apigee.
+     * @param {string} [accept] Optional. The data format the client expects to receive in the response. Currently the only supported value application/xml. In the future we will support application/json. If no value is provided, the default is application/xml.
+     * @param {string} [cacheControl] Optional. Valid value is no-cache. If the caller includes this header value, CBS will empty the cache for the user (regardless of its age) and go to the database to get a fresh copy of the data.
+     * @param {string} [fiCustomerIdType] Optional. Valid values are GUID (default, internal ID), MEMNUMBER, LOGINID, and HOSTID. If not specified, the value for fiCustomers in the URL must the be the internal GUID. If the value is MEMNUMBER, the value for fiCustomers in the URL must be the ID value known to the financial institution\&#39;s core system.  If the value is LOGINID the value is the customer\&#39;s digital banking login ID.
+     * @param {string} [operation] Optional. Supported values are getPFMUser.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getCustomerRequestOpts(requestParameters: CustomerManagementApiGetCustomerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves digital banking profile information for a customer. This endpoint provides comprehensive customer data from the Digital Banking system.  **Requires V1 OAuth Token**  **Data Retrieved:** - Contact information (name, phone, email) - User credentials (login ID, member number) - User status (Active, On Hold, Locked, etc.) - Product information (Digital Banking, Mobile, Bill Pay) - Channel login information and status  **Customer ID Types:** Use the `fiCustomerIdType` query parameter to specify the ID type: - `GUID` (default) - Internal system ID - `MEMNUMBER` - Financial institution\'s core system ID - `LOGINID` - Customer\'s digital banking login ID - `HOSTID` - Host system identifier
+     * @summary Get FI customer
+     * @param {string} fiId the ID assigned to the financial institution.
+     * @param {string} fiCustomerId the ID for the requested customer.  This may be specified with various values, depending on the fiCustomerIDType parameter.  The default is to send the internal ID.
+     * @param {string} [date] The date and time that the message was sent. The expected format is UTC, e.g., &#x60;1994-11-05T13:15:30Z&#x60;.
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided, the IP address logged will be extracted from the HTTP request. **Note:** This should be the originating device, rather than the client making the request (e.g., if a mobile device is used, the IP address should be that of the mobile device, rather than a back-end service).
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60;.
+     * @param {string} [offeringId] Uniquely identifies the name of the client app making the request. When not provided, this is derived based on a property held against the application within Apigee.
+     * @param {string} [accept] Optional. The data format the client expects to receive in the response. Currently the only supported value application/xml. In the future we will support application/json. If no value is provided, the default is application/xml.
+     * @param {string} [cacheControl] Optional. Valid value is no-cache. If the caller includes this header value, CBS will empty the cache for the user (regardless of its age) and go to the database to get a fresh copy of the data.
+     * @param {string} [fiCustomerIdType] Optional. Valid values are GUID (default, internal ID), MEMNUMBER, LOGINID, and HOSTID. If not specified, the value for fiCustomers in the URL must the be the internal GUID. If the value is MEMNUMBER, the value for fiCustomers in the URL must be the ID value known to the financial institution\&#39;s core system.  If the value is LOGINID the value is the customer\&#39;s digital banking login ID.
+     * @param {string} [operation] Optional. Supported values are getPFMUser.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getCustomerRaw(requestParameters: CustomerManagementApiGetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FICustomer>>;
+    /**
+     * Retrieves digital banking profile information for a customer. This endpoint provides comprehensive customer data from the Digital Banking system.  **Requires V1 OAuth Token**  **Data Retrieved:** - Contact information (name, phone, email) - User credentials (login ID, member number) - User status (Active, On Hold, Locked, etc.) - Product information (Digital Banking, Mobile, Bill Pay) - Channel login information and status  **Customer ID Types:** Use the `fiCustomerIdType` query parameter to specify the ID type: - `GUID` (default) - Internal system ID - `MEMNUMBER` - Financial institution\'s core system ID - `LOGINID` - Customer\'s digital banking login ID - `HOSTID` - Host system identifier
+     * Get FI customer
+     */
+    getCustomer(requestParameters: CustomerManagementApiGetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FICustomer>;
+    /**
+     * Creates request options for getInformation without sending the request
+     * @param {string} customerId Unique identifier of the financial institution\&#39;s customer
+     * @param {'CUSTOMER_ID' | 'LOGIN_ID'} [userIdType] Specifies the format of the customerId provided in the path. Supported values: - &#x60;CUSTOMER_ID&#x60; - Unique customer identifier - &#x60;LOGIN_ID&#x60; - Customer’s login identifier
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getInformationRequestOpts(requestParameters: CustomerManagementApiGetInformationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the customer\'s digital banking profile for the given identifier: name and demographics, login identifiers, user status and role, contact methods, postal addresses, and entitled customer relationships. Authentication is required. By default `customerId` in the path is the financial institution customer ID; set the `userIdType` query parameter to `LOGIN_ID` when the path value is the customer\'s login ID instead.
+     * @summary Retrieve customer profile
+     * @param {string} customerId Unique identifier of the financial institution\&#39;s customer
+     * @param {'CUSTOMER_ID' | 'LOGIN_ID'} [userIdType] Specifies the format of the customerId provided in the path. Supported values: - &#x60;CUSTOMER_ID&#x60; - Unique customer identifier - &#x60;LOGIN_ID&#x60; - Customer’s login identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getInformationRaw(requestParameters: CustomerManagementApiGetInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerInformation>>;
+    /**
+     * Returns the customer\'s digital banking profile for the given identifier: name and demographics, login identifiers, user status and role, contact methods, postal addresses, and entitled customer relationships. Authentication is required. By default `customerId` in the path is the financial institution customer ID; set the `userIdType` query parameter to `LOGIN_ID` when the path value is the customer\'s login ID instead.
+     * Retrieve customer profile
+     */
+    getInformation(requestParameters: CustomerManagementApiGetInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerInformation>;
+    /**
+     * Creates request options for getInstitutionUser without sending the request
+     * @param {string} institutionUserId Unique user id
+     * @param {'INSTITUTION_USER_ID' | 'HOST_USER_ID' | 'LOGIN_ID' | 'CUSTOMER_ID'} [userIdType] Specifies the format of the identifier provided in the path. Supported values: - &#x60;INSTITUTION_USER_ID&#x60; — ID assigned by the financial institution - &#x60;HOST_USER_ID&#x60; — ID used by the host system - &#x60;LOGIN_ID&#x60; — User\&#39;s login identifier - &#x60;CUSTOMER_ID&#x60; — Unique customer identifier
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getInstitutionUserRequestOpts(requestParameters: CustomerManagementApiGetInstitutionUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Get institution user by ID
+     * @param {string} institutionUserId Unique user id
+     * @param {'INSTITUTION_USER_ID' | 'HOST_USER_ID' | 'LOGIN_ID' | 'CUSTOMER_ID'} [userIdType] Specifies the format of the identifier provided in the path. Supported values: - &#x60;INSTITUTION_USER_ID&#x60; — ID assigned by the financial institution - &#x60;HOST_USER_ID&#x60; — ID used by the host system - &#x60;LOGIN_ID&#x60; — User\&#39;s login identifier - &#x60;CUSTOMER_ID&#x60; — Unique customer identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getInstitutionUserRaw(requestParameters: CustomerManagementApiGetInstitutionUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUser>>;
+    /**
+     * Get institution user by ID
+     */
+    getInstitutionUser(requestParameters: CustomerManagementApiGetInstitutionUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUser>;
+    /**
+     * Creates request options for getUserStatus without sending the request
+     * @param {string} userId Unique identifier of the financial institution\&#39;s customer whose status is being queried.
+     * @param {'INSTITUTION_USER_ID' | 'HOST_USER_ID' | 'LOGIN_ID' | 'CUSTOMER_ID'} userIdType Specifies the format of the &#x60;userId&#x60; provided in the path. Supported values: - &#x60;INSTITUTION_USER_ID&#x60;: ID assigned by the financial institution - &#x60;HOST_USER_ID&#x60;: ID used by the host system - &#x60;LOGIN_ID&#x60;: User’s login identifier - &#x60;CUSTOMER_ID&#x60;: Unique customer identifier **Note**: The userIdType HOST_USER_ID is only applicable for RETAIL users.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getUserStatusRequestOpts(requestParameters: CustomerManagementApiGetUserStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves comprehensive status information for a specified primary user, including account activity indicators such as active, locked, on hold, and registration status. If the user has associated sub-users, their respective status details are also included. Requires OAuth 2.0 Bearer token and transaction ID for authentication and traceability.
+     * @summary Get user status
+     * @param {string} userId Unique identifier of the financial institution\&#39;s customer whose status is being queried.
+     * @param {'INSTITUTION_USER_ID' | 'HOST_USER_ID' | 'LOGIN_ID' | 'CUSTOMER_ID'} userIdType Specifies the format of the &#x60;userId&#x60; provided in the path. Supported values: - &#x60;INSTITUTION_USER_ID&#x60;: ID assigned by the financial institution - &#x60;HOST_USER_ID&#x60;: ID used by the host system - &#x60;LOGIN_ID&#x60;: User’s login identifier - &#x60;CUSTOMER_ID&#x60;: Unique customer identifier **Note**: The userIdType HOST_USER_ID is only applicable for RETAIL users.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    getUserStatusRaw(requestParameters: CustomerManagementApiGetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserStatus2>>;
+    /**
+     * Retrieves comprehensive status information for a specified primary user, including account activity indicators such as active, locked, on hold, and registration status. If the user has associated sub-users, their respective status details are also included. Requires OAuth 2.0 Bearer token and transaction ID for authentication and traceability.
+     * Get user status
+     */
+    getUserStatus(requestParameters: CustomerManagementApiGetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserStatus2>;
+    /**
+     * Creates request options for register without sending the request
+     * @param {string} diFiid The financial institution from which the registration API is called. The scope of the Standard OAuth token will be restricted to this Financial Institution ID.
+     * @param {RegisterCustomerRequest} body Customer to register with DI. The body must be wrapped in a &#x60;FICustomer&#x60; root element containing the customer profile fields.
+     * @param {string} [contentType] Content type of the request payload. Supported values are &#x60;application/json&#x60; and &#x60;application/xml&#x60;.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    registerRequestOpts(requestParameters: CustomerManagementApiRegisterRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Registers a new customer for online banking via third party applications. This API provides the same registration process used in Candescent Digital Banking. **No scope required.**  **Requires V1 OAuth Token**  **Common Use Cases:** - Online banking vendors registering users after digital account opening - Mobile banking vendors with FIs using Candescent Digital Banking - Developers extending Candescent Digital Banking functionality  **Required Personal Data:** | Field | Requirements | |-------|--------------| | First Name | Max 39 characters | | Last Name | Max 39 characters | | SSN | Exactly 9 digits | | Date of Birth | Format: yyyy-mm-dd | | Address | Street, City, State (2 chars for US), Zip, Country | | Phone Number | 10 digits | | Email | Max 64 characters | | Mother\'s Maiden Name | Max 128 characters |  **Username Policy:** - Length: 8-20 characters (configurable: min 6, max 20) - Cannot be only numbers, can be all letters - Allowed special characters: `@$*_-=.!~` - No spaces allowed - Cannot match member number  **Password Policy:** - Length: 6-32 characters (configurable) - Must contain characters from at least 2 of: Letters, Numbers, Special characters - No spaces allowed - Cannot be a substring of the username  **Disclosures:** The API will make calls to the appropriate disclosure records on file for the FI. Registration will not complete without user acceptance of required disclosures.  **Logging:** Performs global logging under RegistrationUser event with channel type TPV_API and user product THIRD_PARTY_REGISTRATION.  **Request/Response Format:** The request body must be wrapped in a `FICustomer` root element. The response is always returned as `application/xml`.
+     * @summary Register customer for online banking
+     * @param {string} diFiid The financial institution from which the registration API is called. The scope of the Standard OAuth token will be restricted to this Financial Institution ID.
+     * @param {RegisterCustomerRequest} body Customer to register with DI. The body must be wrapped in a &#x60;FICustomer&#x60; root element containing the customer profile fields.
+     * @param {string} [contentType] Content type of the request payload. Supported values are &#x60;application/json&#x60; and &#x60;application/xml&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    registerRaw(requestParameters: CustomerManagementApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RegisterCustomerResponse>>;
+    /**
+     * Registers a new customer for online banking via third party applications. This API provides the same registration process used in Candescent Digital Banking. **No scope required.**  **Requires V1 OAuth Token**  **Common Use Cases:** - Online banking vendors registering users after digital account opening - Mobile banking vendors with FIs using Candescent Digital Banking - Developers extending Candescent Digital Banking functionality  **Required Personal Data:** | Field | Requirements | |-------|--------------| | First Name | Max 39 characters | | Last Name | Max 39 characters | | SSN | Exactly 9 digits | | Date of Birth | Format: yyyy-mm-dd | | Address | Street, City, State (2 chars for US), Zip, Country | | Phone Number | 10 digits | | Email | Max 64 characters | | Mother\'s Maiden Name | Max 128 characters |  **Username Policy:** - Length: 8-20 characters (configurable: min 6, max 20) - Cannot be only numbers, can be all letters - Allowed special characters: `@$*_-=.!~` - No spaces allowed - Cannot match member number  **Password Policy:** - Length: 6-32 characters (configurable) - Must contain characters from at least 2 of: Letters, Numbers, Special characters - No spaces allowed - Cannot be a substring of the username  **Disclosures:** The API will make calls to the appropriate disclosure records on file for the FI. Registration will not complete without user acceptance of required disclosures.  **Logging:** Performs global logging under RegistrationUser event with channel type TPV_API and user product THIRD_PARTY_REGISTRATION.  **Request/Response Format:** The request body must be wrapped in a `FICustomer` root element. The response is always returned as `application/xml`.
+     * Register customer for online banking
+     */
+    register(requestParameters: CustomerManagementApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RegisterCustomerResponse>;
+    /**
+     * Creates request options for resetPassword without sending the request
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {ResetPasswordRequest} resetPasswordRequest Information needed for sending reset password request
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    resetPasswordRequestOpts(requestParameters: CustomerManagementApiResetPasswordOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a one-time passcode to a given customer for resetting their password
+     * @summary Send a one-time passcode to a given customer for resetting their password
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {ResetPasswordRequest} resetPasswordRequest Information needed for sending reset password request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    resetPasswordRaw(requestParameters: CustomerManagementApiResetPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Send a one-time passcode to a given customer for resetting their password
+     * Send a one-time passcode to a given customer for resetting their password
+     */
+    resetPassword(requestParameters: CustomerManagementApiResetPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for unlockUser without sending the request
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    unlockUserRequestOpts(requestParameters: CustomerManagementApiUnlockUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unlock the specified user without requiring a password reset
+     * @summary Unlock the specified user
+     * @param {string} customerId Unique identifier of financial institution customer
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    unlockUserRaw(requestParameters: CustomerManagementApiUnlockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unlock the specified user without requiring a password reset
+     * Unlock the specified user
+     */
+    unlockUser(requestParameters: CustomerManagementApiUnlockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateContactInfo without sending the request
+     * @param {string} customerId It can be a customer Id or login Id of the financial intitution customer
+     * @param {ContactInfo} contactInfo Information needed for updating contact info
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    updateContactInfoRequestOpts(requestParameters: CustomerManagementApiUpdateContactInfoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to update contact info
+     * @summary API to update contact info
+     * @param {string} customerId It can be a customer Id or login Id of the financial intitution customer
+     * @param {ContactInfo} contactInfo Information needed for updating contact info
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerManagementApiInterface
+     */
+    updateContactInfoRaw(requestParameters: CustomerManagementApiUpdateContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * API to update contact info
+     * API to update contact info
+     */
+    updateContactInfo(requestParameters: CustomerManagementApiUpdateContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class CustomerManagementApi extends runtime.BaseAPI implements CustomerManagementApiInterface {
+    /**
+     * Creates request options for getContactMethods without sending the request
+     */
+    getContactMethodsRequestOpts(requestParameters: CustomerManagementApiGetContactMethodsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * Fetch the contact methods for a given customer
+     */
+    getContactMethodsRaw(requestParameters: CustomerManagementApiGetContactMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ContactMethodResponse>>;
+    /**
+     * Fetch customer contact methods like SMS, Voice and Email.
+     * Fetch the contact methods for a given customer
+     */
+    getContactMethods(requestParameters: CustomerManagementApiGetContactMethodsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ContactMethodResponse>;
+    /**
+     * Creates request options for getCustomer without sending the request
+     */
+    getCustomerRequestOpts(requestParameters: CustomerManagementApiGetCustomerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves digital banking profile information for a customer. This endpoint provides comprehensive customer data from the Digital Banking system.  **Requires V1 OAuth Token**  **Data Retrieved:** - Contact information (name, phone, email) - User credentials (login ID, member number) - User status (Active, On Hold, Locked, etc.) - Product information (Digital Banking, Mobile, Bill Pay) - Channel login information and status  **Customer ID Types:** Use the `fiCustomerIdType` query parameter to specify the ID type: - `GUID` (default) - Internal system ID - `MEMNUMBER` - Financial institution\'s core system ID - `LOGINID` - Customer\'s digital banking login ID - `HOSTID` - Host system identifier
+     * Get FI customer
+     */
+    getCustomerRaw(requestParameters: CustomerManagementApiGetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FICustomer>>;
+    /**
+     * Retrieves digital banking profile information for a customer. This endpoint provides comprehensive customer data from the Digital Banking system.  **Requires V1 OAuth Token**  **Data Retrieved:** - Contact information (name, phone, email) - User credentials (login ID, member number) - User status (Active, On Hold, Locked, etc.) - Product information (Digital Banking, Mobile, Bill Pay) - Channel login information and status  **Customer ID Types:** Use the `fiCustomerIdType` query parameter to specify the ID type: - `GUID` (default) - Internal system ID - `MEMNUMBER` - Financial institution\'s core system ID - `LOGINID` - Customer\'s digital banking login ID - `HOSTID` - Host system identifier
+     * Get FI customer
+     */
+    getCustomer(requestParameters: CustomerManagementApiGetCustomerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FICustomer>;
+    /**
+     * Creates request options for getInformation without sending the request
+     */
+    getInformationRequestOpts(requestParameters: CustomerManagementApiGetInformationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the customer\'s digital banking profile for the given identifier: name and demographics, login identifiers, user status and role, contact methods, postal addresses, and entitled customer relationships. Authentication is required. By default `customerId` in the path is the financial institution customer ID; set the `userIdType` query parameter to `LOGIN_ID` when the path value is the customer\'s login ID instead.
+     * Retrieve customer profile
+     */
+    getInformationRaw(requestParameters: CustomerManagementApiGetInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerInformation>>;
+    /**
+     * Returns the customer\'s digital banking profile for the given identifier: name and demographics, login identifiers, user status and role, contact methods, postal addresses, and entitled customer relationships. Authentication is required. By default `customerId` in the path is the financial institution customer ID; set the `userIdType` query parameter to `LOGIN_ID` when the path value is the customer\'s login ID instead.
+     * Retrieve customer profile
+     */
+    getInformation(requestParameters: CustomerManagementApiGetInformationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerInformation>;
+    /**
+     * Creates request options for getInstitutionUser without sending the request
+     */
+    getInstitutionUserRequestOpts(requestParameters: CustomerManagementApiGetInstitutionUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get institution user by ID
+     */
+    getInstitutionUserRaw(requestParameters: CustomerManagementApiGetInstitutionUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InstitutionUser>>;
+    /**
+     * Get institution user by ID
+     */
+    getInstitutionUser(requestParameters: CustomerManagementApiGetInstitutionUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InstitutionUser>;
+    /**
+     * Creates request options for getUserStatus without sending the request
+     */
+    getUserStatusRequestOpts(requestParameters: CustomerManagementApiGetUserStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves comprehensive status information for a specified primary user, including account activity indicators such as active, locked, on hold, and registration status. If the user has associated sub-users, their respective status details are also included. Requires OAuth 2.0 Bearer token and transaction ID for authentication and traceability.
+     * Get user status
+     */
+    getUserStatusRaw(requestParameters: CustomerManagementApiGetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserStatus2>>;
+    /**
+     * Retrieves comprehensive status information for a specified primary user, including account activity indicators such as active, locked, on hold, and registration status. If the user has associated sub-users, their respective status details are also included. Requires OAuth 2.0 Bearer token and transaction ID for authentication and traceability.
+     * Get user status
+     */
+    getUserStatus(requestParameters: CustomerManagementApiGetUserStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserStatus2>;
+    /**
+     * Creates request options for register without sending the request
+     */
+    registerRequestOpts(requestParameters: CustomerManagementApiRegisterRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Registers a new customer for online banking via third party applications. This API provides the same registration process used in Candescent Digital Banking. **No scope required.**  **Requires V1 OAuth Token**  **Common Use Cases:** - Online banking vendors registering users after digital account opening - Mobile banking vendors with FIs using Candescent Digital Banking - Developers extending Candescent Digital Banking functionality  **Required Personal Data:** | Field | Requirements | |-------|--------------| | First Name | Max 39 characters | | Last Name | Max 39 characters | | SSN | Exactly 9 digits | | Date of Birth | Format: yyyy-mm-dd | | Address | Street, City, State (2 chars for US), Zip, Country | | Phone Number | 10 digits | | Email | Max 64 characters | | Mother\'s Maiden Name | Max 128 characters |  **Username Policy:** - Length: 8-20 characters (configurable: min 6, max 20) - Cannot be only numbers, can be all letters - Allowed special characters: `@$*_-=.!~` - No spaces allowed - Cannot match member number  **Password Policy:** - Length: 6-32 characters (configurable) - Must contain characters from at least 2 of: Letters, Numbers, Special characters - No spaces allowed - Cannot be a substring of the username  **Disclosures:** The API will make calls to the appropriate disclosure records on file for the FI. Registration will not complete without user acceptance of required disclosures.  **Logging:** Performs global logging under RegistrationUser event with channel type TPV_API and user product THIRD_PARTY_REGISTRATION.  **Request/Response Format:** The request body must be wrapped in a `FICustomer` root element. The response is always returned as `application/xml`.
+     * Register customer for online banking
+     */
+    registerRaw(requestParameters: CustomerManagementApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RegisterCustomerResponse>>;
+    /**
+     * Registers a new customer for online banking via third party applications. This API provides the same registration process used in Candescent Digital Banking. **No scope required.**  **Requires V1 OAuth Token**  **Common Use Cases:** - Online banking vendors registering users after digital account opening - Mobile banking vendors with FIs using Candescent Digital Banking - Developers extending Candescent Digital Banking functionality  **Required Personal Data:** | Field | Requirements | |-------|--------------| | First Name | Max 39 characters | | Last Name | Max 39 characters | | SSN | Exactly 9 digits | | Date of Birth | Format: yyyy-mm-dd | | Address | Street, City, State (2 chars for US), Zip, Country | | Phone Number | 10 digits | | Email | Max 64 characters | | Mother\'s Maiden Name | Max 128 characters |  **Username Policy:** - Length: 8-20 characters (configurable: min 6, max 20) - Cannot be only numbers, can be all letters - Allowed special characters: `@$*_-=.!~` - No spaces allowed - Cannot match member number  **Password Policy:** - Length: 6-32 characters (configurable) - Must contain characters from at least 2 of: Letters, Numbers, Special characters - No spaces allowed - Cannot be a substring of the username  **Disclosures:** The API will make calls to the appropriate disclosure records on file for the FI. Registration will not complete without user acceptance of required disclosures.  **Logging:** Performs global logging under RegistrationUser event with channel type TPV_API and user product THIRD_PARTY_REGISTRATION.  **Request/Response Format:** The request body must be wrapped in a `FICustomer` root element. The response is always returned as `application/xml`.
+     * Register customer for online banking
+     */
+    register(requestParameters: CustomerManagementApiRegisterRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RegisterCustomerResponse>;
+    /**
+     * Creates request options for resetPassword without sending the request
+     */
+    resetPasswordRequestOpts(requestParameters: CustomerManagementApiResetPasswordOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Send a one-time passcode to a given customer for resetting their password
+     * Send a one-time passcode to a given customer for resetting their password
+     */
+    resetPasswordRaw(requestParameters: CustomerManagementApiResetPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Send a one-time passcode to a given customer for resetting their password
+     * Send a one-time passcode to a given customer for resetting their password
+     */
+    resetPassword(requestParameters: CustomerManagementApiResetPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for unlockUser without sending the request
+     */
+    unlockUserRequestOpts(requestParameters: CustomerManagementApiUnlockUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unlock the specified user without requiring a password reset
+     * Unlock the specified user
+     */
+    unlockUserRaw(requestParameters: CustomerManagementApiUnlockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unlock the specified user without requiring a password reset
+     * Unlock the specified user
+     */
+    unlockUser(requestParameters: CustomerManagementApiUnlockUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateContactInfo without sending the request
+     */
+    updateContactInfoRequestOpts(requestParameters: CustomerManagementApiUpdateContactInfoRequest): Promise<runtime.RequestOpts>;
+    /**
+     * API to update contact info
+     * API to update contact info
+     */
+    updateContactInfoRaw(requestParameters: CustomerManagementApiUpdateContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * API to update contact info
+     * API to update contact info
+     */
+    updateContactInfo(requestParameters: CustomerManagementApiUpdateContactInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const GetContactMethodsUserIdTypeEnum: {
+    readonly CUSTOMER_ID: "CUSTOMER_ID";
+    readonly LOGIN_ID: "LOGIN_ID";
+};
+export type GetContactMethodsUserIdTypeEnum = typeof GetContactMethodsUserIdTypeEnum[keyof typeof GetContactMethodsUserIdTypeEnum];
+/**
+ * @export
+ */
+export declare const GetInformationUserIdTypeEnum: {
+    readonly CUSTOMER_ID: "CUSTOMER_ID";
+    readonly LOGIN_ID: "LOGIN_ID";
+};
+export type GetInformationUserIdTypeEnum = typeof GetInformationUserIdTypeEnum[keyof typeof GetInformationUserIdTypeEnum];
+/**
+ * @export
+ */
+export declare const GetInstitutionUserUserIdTypeEnum: {
+    readonly INSTITUTION_USER_ID: "INSTITUTION_USER_ID";
+    readonly HOST_USER_ID: "HOST_USER_ID";
+    readonly LOGIN_ID: "LOGIN_ID";
+    readonly CUSTOMER_ID: "CUSTOMER_ID";
+};
+export type GetInstitutionUserUserIdTypeEnum = typeof GetInstitutionUserUserIdTypeEnum[keyof typeof GetInstitutionUserUserIdTypeEnum];
+/**
+ * @export
+ */
+export declare const GetUserStatusUserIdTypeEnum: {
+    readonly INSTITUTION_USER_ID: "INSTITUTION_USER_ID";
+    readonly HOST_USER_ID: "HOST_USER_ID";
+    readonly LOGIN_ID: "LOGIN_ID";
+    readonly CUSTOMER_ID: "CUSTOMER_ID";
+};
+export type GetUserStatusUserIdTypeEnum = typeof GetUserStatusUserIdTypeEnum[keyof typeof GetUserStatusUserIdTypeEnum];