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

package/dist/generated/src/apis/BusinessBankingApi.js

@@ -0,0 +1,340 @@
+/* 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 * as runtime from '../runtime.js';
+import { BbRegistrationFromJSON, BbRegistrationToJSON, BusinessDetailsFromJSON, BusinessEntitlementsLimitsFromJSON, BusinessRegistrationConfigFromJSON, UserEntitlementsLimitsFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class BusinessBankingApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createRegistration without sending the request
+     */
+    async createRegistrationRequestOpts(requestParameters) {
+        if (requestParameters['bbRegistration'] == null) {
+            throw new runtime.RequiredError('bbRegistration', 'Required parameter "bbRegistration" was null or undefined when calling createRegistration().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/json';
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-core/v1/business-registrations`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: BbRegistrationToJSON(requestParameters['bbRegistration']),
+        };
+    }
+    /**
+     * Creates a new business banking registration for a financial institution. This endpoint accepts comprehensive business registration details including:  - **Business Information**: Company name and business address - **Primary Business Contact**: Main contact person with name, email, and phone - **Primary Administrator**: Admin user who will manage the business banking account - **Secondary Administrators**: Additional admin users (optional) - **TIN Details**: Tax Identification Numbers with member numbers - **Online Features**: Requested banking features (ACH, Wire Transfer, etc.) - **Additional Services**: Extra services (Positive Pay, Account Reconciliation, etc.)  Upon successful creation, a unique 16-character confirmation number is generated and returned.
+     * Create Business Registration
+     */
+    async createRegistrationRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createRegistrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BbRegistrationFromJSON(jsonValue));
+    }
+    /**
+     * Creates a new business banking registration for a financial institution. This endpoint accepts comprehensive business registration details including:  - **Business Information**: Company name and business address - **Primary Business Contact**: Main contact person with name, email, and phone - **Primary Administrator**: Admin user who will manage the business banking account - **Secondary Administrators**: Additional admin users (optional) - **TIN Details**: Tax Identification Numbers with member numbers - **Online Features**: Requested banking features (ACH, Wire Transfer, etc.) - **Additional Services**: Extra services (Positive Pay, Account Reconciliation, etc.)  Upon successful creation, a unique 16-character confirmation number is generated and returned.
+     * Create Business Registration
+     */
+    async createRegistration(requestParameters, initOverrides) {
+        const response = await this.createRegistrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getBusinessDetails without sending the request
+     */
+    async getBusinessDetailsRequestOpts(requestParameters) {
+        if (requestParameters['searchType'] == null) {
+            throw new runtime.RequiredError('searchType', 'Required parameter "searchType" was null or undefined when calling getBusinessDetails().');
+        }
+        if (requestParameters['searchValue'] == null) {
+            throw new runtime.RequiredError('searchValue', 'Required parameter "searchValue" was null or undefined when calling getBusinessDetails().');
+        }
+        const queryParameters = {};
+        if (requestParameters['searchType'] != null) {
+            queryParameters['searchType'] = requestParameters['searchType'];
+        }
+        if (requestParameters['searchValue'] != null) {
+            queryParameters['searchValue'] = requestParameters['searchValue'];
+        }
+        if (requestParameters['includeTins'] != null) {
+            queryParameters['includeTins'] = requestParameters['includeTins'];
+        }
+        if (requestParameters['includeUsers'] != null) {
+            queryParameters['includeUsers'] = requestParameters['includeUsers'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-core/v1/business-details`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves comprehensive business details for a company or user based on the provided search criteria.  **Search Types:**  - `BUSINESS_ID`: Search by the unique business/company identifier - `LOGIN_ID`: Search by the user\'s login ID  **Response includes:**  - Business name and registration information - Business address details (street, city, state, zip) - Primary contact information - TIN details (optional, when `includeTins=true`) - Customer/user details (optional, when `includeUsers=true`)  **Usage Notes:**  - The `searchType` and `searchValue` parameters are required - Use `BUSINESS_ID` search type when you have the company\'s unique identifier - Use `LOGIN_ID` search type when searching by a user\'s credentials - Set `includeTins=true` to retrieve Tax Identification Number details - Set `includeUsers=true` to retrieve associated user/customer information
+     * Get Business Details
+     */
+    async getBusinessDetailsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getBusinessDetailsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BusinessDetailsFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves comprehensive business details for a company or user based on the provided search criteria.  **Search Types:**  - `BUSINESS_ID`: Search by the unique business/company identifier - `LOGIN_ID`: Search by the user\'s login ID  **Response includes:**  - Business name and registration information - Business address details (street, city, state, zip) - Primary contact information - TIN details (optional, when `includeTins=true`) - Customer/user details (optional, when `includeUsers=true`)  **Usage Notes:**  - The `searchType` and `searchValue` parameters are required - Use `BUSINESS_ID` search type when you have the company\'s unique identifier - Use `LOGIN_ID` search type when searching by a user\'s credentials - Set `includeTins=true` to retrieve Tax Identification Number details - Set `includeUsers=true` to retrieve associated user/customer information
+     * Get Business Details
+     */
+    async getBusinessDetails(requestParameters, initOverrides) {
+        const response = await this.getBusinessDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getBusinessEntitlements without sending the request
+     */
+    async getBusinessEntitlementsRequestOpts(requestParameters) {
+        if (requestParameters['businessId'] == null) {
+            throw new runtime.RequiredError('businessId', 'Required parameter "businessId" was null or undefined when calling getBusinessEntitlements().');
+        }
+        const queryParameters = {};
+        if (requestParameters['businessId'] != null) {
+            queryParameters['businessId'] = requestParameters['businessId'];
+        }
+        if (requestParameters['institutionCustomerId'] != null) {
+            queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
+        }
+        if (requestParameters['featureName'] != null) {
+            queryParameters['featureName'] = requestParameters['featureName'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-entitlements/v1/business-entitlements-limits`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * Get Business Entitlements Limits
+     */
+    async getBusinessEntitlementsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getBusinessEntitlementsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BusinessEntitlementsLimitsFromJSON(jsonValue));
+    }
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * Get Business Entitlements Limits
+     */
+    async getBusinessEntitlements(requestParameters, initOverrides) {
+        const response = await this.getBusinessEntitlementsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getRegistrationByConfirmation without sending the request
+     */
+    async getRegistrationByConfirmationRequestOpts(requestParameters) {
+        if (requestParameters['confirmationNumber'] == null) {
+            throw new runtime.RequiredError('confirmationNumber', 'Required parameter "confirmationNumber" was null or undefined when calling getRegistrationByConfirmation().');
+        }
+        const queryParameters = {};
+        if (requestParameters['confirmationNumber'] != null) {
+            queryParameters['confirmationNumber'] = requestParameters['confirmationNumber'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-core/v1/business-registrations`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a business banking registration using the unique confirmation number. The confirmation number is a 16-character alphanumeric code that was generated when the registration was created.  **Response includes:**  - Business information (name, address) - Primary business contact details - Administrator information - TIN details - Selected online features and services - Registration status and timestamps
+     * Get Business Registration by Confirmation Number
+     */
+    async getRegistrationByConfirmationRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getRegistrationByConfirmationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BbRegistrationFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a business banking registration using the unique confirmation number. The confirmation number is a 16-character alphanumeric code that was generated when the registration was created.  **Response includes:**  - Business information (name, address) - Primary business contact details - Administrator information - TIN details - Selected online features and services - Registration status and timestamps
+     * Get Business Registration by Confirmation Number
+     */
+    async getRegistrationByConfirmation(requestParameters, initOverrides) {
+        const response = await this.getRegistrationByConfirmationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getRegistrationById without sending the request
+     */
+    async getRegistrationByIdRequestOpts(requestParameters) {
+        if (requestParameters['registrationId'] == null) {
+            throw new runtime.RequiredError('registrationId', 'Required parameter "registrationId" was null or undefined when calling getRegistrationById().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-core/v1/business-registrations/{registrationId}`;
+        urlPath = urlPath.replace(`{${"registrationId"}}`, encodeURIComponent(String(requestParameters['registrationId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a business banking registration using the unique registration ID. The registration ID is an alphanumeric code that was generated when the registration was created.  **Response includes:**  - Business information (name, address) - Primary business contact details - Administrator information - TIN details - Selected online features and services - Registration status and timestamps
+     * Get Business Registration by Registration ID
+     */
+    async getRegistrationByIdRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getRegistrationByIdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BbRegistrationFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a business banking registration using the unique registration ID. The registration ID is an alphanumeric code that was generated when the registration was created.  **Response includes:**  - Business information (name, address) - Primary business contact details - Administrator information - TIN details - Selected online features and services - Registration status and timestamps
+     * Get Business Registration by Registration ID
+     */
+    async getRegistrationById(requestParameters, initOverrides) {
+        const response = await this.getRegistrationByIdRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getRegistrationConfig without sending the request
+     */
+    async getRegistrationConfigRequestOpts() {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-core/v1/business-registration-configs`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves the business registration configuration for a specific financial institution. This endpoint provides all settings required to render the business registration form, including:  - **Online Features**: List of available online banking features (ACH, Wire Transfer, Bill Pay, etc.) - **Additional Services**: List of supplementary services (Positive Pay, Account Reconciliation, etc.)  Use this configuration to populate dropdowns and checkboxes in the registration form.
+     * Get Business Registration Configuration
+     */
+    async getRegistrationConfigRaw(initOverrides) {
+        const requestOptions = await this.getRegistrationConfigRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => BusinessRegistrationConfigFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves the business registration configuration for a specific financial institution. This endpoint provides all settings required to render the business registration form, including:  - **Online Features**: List of available online banking features (ACH, Wire Transfer, Bill Pay, etc.) - **Additional Services**: List of supplementary services (Positive Pay, Account Reconciliation, etc.)  Use this configuration to populate dropdowns and checkboxes in the registration form.
+     * Get Business Registration Configuration
+     */
+    async getRegistrationConfig(initOverrides) {
+        const response = await this.getRegistrationConfigRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getUserEntitlements without sending the request
+     */
+    async getUserEntitlementsRequestOpts(requestParameters) {
+        const queryParameters = {};
+        if (requestParameters['loginId'] != null) {
+            queryParameters['loginId'] = requestParameters['loginId'];
+        }
+        if (requestParameters['institutionCustomerId'] != null) {
+            queryParameters['institutionCustomerId'] = requestParameters['institutionCustomerId'];
+        }
+        if (requestParameters['featureName'] != null) {
+            queryParameters['featureName'] = requestParameters['featureName'];
+        }
+        const headerParameters = {};
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/db-bb-entitlements/v1/user-entitlements-limits`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * Get User Entitlements Limits
+     */
+    async getUserEntitlementsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getUserEntitlementsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserEntitlementsLimitsFromJSON(jsonValue));
+    }
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * Get User Entitlements Limits
+     */
+    async getUserEntitlements(requestParameters = {}, initOverrides) {
+        const response = await this.getUserEntitlementsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}