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

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

@@ -0,0 +1,308 @@
+/**
+ * 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 { BbRegistration, BusinessDetails, BusinessEntitlementsLimits, BusinessRegistrationConfig, UserEntitlementsLimits } from '../models/index.js';
+export interface BusinessBankingApiCreateRegistrationRequest {
+    bbRegistration: Omit<BbRegistration, 'approvedDate' | 'businessId' | 'completedDate' | 'confirmationNumber' | 'createdUser' | 'declinedDate' | 'id' | 'institutionId' | 'message' | 'registrationDate'>;
+}
+export interface BusinessBankingApiGetBusinessDetailsRequest {
+    searchType: string;
+    searchValue: string;
+    includeTins?: boolean;
+    includeUsers?: boolean;
+}
+export interface BusinessBankingApiGetBusinessEntitlementsRequest {
+    businessId: string;
+    institutionCustomerId?: string;
+    featureName?: string;
+}
+export interface BusinessBankingApiGetRegistrationByConfirmationRequest {
+    confirmationNumber: string;
+}
+export interface BusinessBankingApiGetRegistrationByIdRequest {
+    registrationId: string;
+}
+export interface BusinessBankingApiGetUserEntitlementsRequest {
+    loginId?: string;
+    institutionCustomerId?: string;
+    featureName?: string;
+}
+/**
+ * BusinessBankingApi - interface
+ *
+ * @export
+ * @interface BusinessBankingApiInterface
+ */
+export interface BusinessBankingApiInterface {
+    /**
+     * Creates request options for createRegistration without sending the request
+     * @param {BbRegistration} bbRegistration Business registration request payload containing all registration details.  **Required fields:**  - &#x60;businessName&#x60;: Name of the business (max 100 characters) - &#x60;contact&#x60;: Primary business contact object with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and nested &#x60;address&#x60; object - &#x60;tins&#x60;: Array with at least one TIN object containing &#x60;tinNumber&#x60; (9 digits), &#x60;tinName&#x60;, &#x60;memberNumber&#x60; (optional) and &#x60;hostPassword&#x60; - &#x60;users&#x60;: Array of administrator users with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and &#x60;userType&#x60; (PRIMARY_ADMIN)  **Optional fields:**  - &#x60;users&#x60;: Array of administrator users with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and &#x60;userType&#x60; (SECONDARY_ADMIN) - &#x60;onlineFeatures&#x60;: Array of online banking feature names (e.g., [\&quot;ACH\&quot;, \&quot;Wire Transfer\&quot;, \&quot;Bill Pay\&quot;]) - &#x60;additionalServices&#x60;: Array of additional service names (e.g., [\&quot;Positive Pay\&quot;, \&quot;Account Reconciliation\&quot;])
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    createRegistrationRequestOpts(requestParameters: BusinessBankingApiCreateRegistrationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Create Business Registration
+     * @param {BbRegistration} bbRegistration Business registration request payload containing all registration details.  **Required fields:**  - &#x60;businessName&#x60;: Name of the business (max 100 characters) - &#x60;contact&#x60;: Primary business contact object with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and nested &#x60;address&#x60; object - &#x60;tins&#x60;: Array with at least one TIN object containing &#x60;tinNumber&#x60; (9 digits), &#x60;tinName&#x60;, &#x60;memberNumber&#x60; (optional) and &#x60;hostPassword&#x60; - &#x60;users&#x60;: Array of administrator users with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and &#x60;userType&#x60; (PRIMARY_ADMIN)  **Optional fields:**  - &#x60;users&#x60;: Array of administrator users with &#x60;firstName&#x60;, &#x60;lastName&#x60;, &#x60;email&#x60;, &#x60;phoneNumber&#x60;, and &#x60;userType&#x60; (SECONDARY_ADMIN) - &#x60;onlineFeatures&#x60;: Array of online banking feature names (e.g., [\&quot;ACH\&quot;, \&quot;Wire Transfer\&quot;, \&quot;Bill Pay\&quot;]) - &#x60;additionalServices&#x60;: Array of additional service names (e.g., [\&quot;Positive Pay\&quot;, \&quot;Account Reconciliation\&quot;])
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    createRegistrationRaw(requestParameters: BusinessBankingApiCreateRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<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
+     */
+    createRegistration(requestParameters: BusinessBankingApiCreateRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getBusinessDetails without sending the request
+     * @param {string} searchType Specifies the type of search to perform. Determines how the searchValue parameter is interpreted.  - **BUSINESS_ID**: Search using the unique business/company identifier assigned during registration - **LOGIN_ID**: Search using the user\&#39;s login credentials (username)
+     * @param {string} searchValue The value to search for, based on the specified searchType.  - When searchType is **BUSINESS_ID**: Provide the unique company/business identifier (e.g., \&quot;1234567890\&quot;) - When searchType is **LOGIN_ID**: Provide the user\&#39;s login ID (e.g., \&quot;johnsmith123\&quot;)
+     * @param {boolean} [includeTins] Flag to include Tax Identification Number (TIN) details in the response. When set to true, the response will include TIN information for each business location.
+     * @param {boolean} [includeUsers] Flag to include additional customer/user details in the response. When set to true, the response will include information about users associated with the business.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getBusinessDetailsRequestOpts(requestParameters: BusinessBankingApiGetBusinessDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary Get Business Details
+     * @param {string} searchType Specifies the type of search to perform. Determines how the searchValue parameter is interpreted.  - **BUSINESS_ID**: Search using the unique business/company identifier assigned during registration - **LOGIN_ID**: Search using the user\&#39;s login credentials (username)
+     * @param {string} searchValue The value to search for, based on the specified searchType.  - When searchType is **BUSINESS_ID**: Provide the unique company/business identifier (e.g., \&quot;1234567890\&quot;) - When searchType is **LOGIN_ID**: Provide the user\&#39;s login ID (e.g., \&quot;johnsmith123\&quot;)
+     * @param {boolean} [includeTins] Flag to include Tax Identification Number (TIN) details in the response. When set to true, the response will include TIN information for each business location.
+     * @param {boolean} [includeUsers] Flag to include additional customer/user details in the response. When set to true, the response will include information about users associated with the business.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getBusinessDetailsRaw(requestParameters: BusinessBankingApiGetBusinessDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessDetails>>;
+    /**
+     * 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
+     */
+    getBusinessDetails(requestParameters: BusinessBankingApiGetBusinessDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessDetails>;
+    /**
+     * Creates request options for getBusinessEntitlements without sending the request
+     * @param {string} businessId ID of the business
+     * @param {string} [institutionCustomerId] Location Identifier
+     * @param {string} [featureName] Feature Name
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getBusinessEntitlementsRequestOpts(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * @summary Get Business Entitlements Limits
+     * @param {string} businessId ID of the business
+     * @param {string} [institutionCustomerId] Location Identifier
+     * @param {string} [featureName] Feature Name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getBusinessEntitlementsRaw(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessEntitlementsLimits>>;
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * Get Business Entitlements Limits
+     */
+    getBusinessEntitlements(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessEntitlementsLimits>;
+    /**
+     * Creates request options for getRegistrationByConfirmation without sending the request
+     * @param {string} confirmationNumber The unique 16-character alphanumeric confirmation number generated during registration creation.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationByConfirmationRequestOpts(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary Get Business Registration by Confirmation Number
+     * @param {string} confirmationNumber The unique 16-character alphanumeric confirmation number generated during registration creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationByConfirmationRaw(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BbRegistration>>;
+    /**
+     * 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
+     */
+    getRegistrationByConfirmation(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getRegistrationById without sending the request
+     * @param {string} registrationId The unique alphanumeric registrationId generated during registration creation.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationByIdRequestOpts(requestParameters: BusinessBankingApiGetRegistrationByIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     * @summary Get Business Registration by Registration ID
+     * @param {string} registrationId The unique alphanumeric registrationId generated during registration creation.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationByIdRaw(requestParameters: BusinessBankingApiGetRegistrationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BbRegistration>>;
+    /**
+     * 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
+     */
+    getRegistrationById(requestParameters: BusinessBankingApiGetRegistrationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getRegistrationConfig without sending the request
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationConfigRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Get Business Registration Configuration
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getRegistrationConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessRegistrationConfig>>;
+    /**
+     * 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
+     */
+    getRegistrationConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessRegistrationConfig>;
+    /**
+     * Creates request options for getUserEntitlements without sending the request
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] Location Identifier (Product Guid)
+     * @param {string} [featureName] Feature Name
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getUserEntitlementsRequestOpts(requestParameters: BusinessBankingApiGetUserEntitlementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * @summary Get User Entitlements Limits
+     * @param {string} [loginId] Login identifier for the user associated with the financial institution. This parameter is **required** when the access token was issued using the &#x60;client_credentials&#x60; grant type; otherwise, it is optional. Cannot be used with &#x60;hostUserId&#x60; query parameter.
+     * @param {string} [institutionCustomerId] Location Identifier (Product Guid)
+     * @param {string} [featureName] Feature Name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusinessBankingApiInterface
+     */
+    getUserEntitlementsRaw(requestParameters: BusinessBankingApiGetUserEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserEntitlementsLimits>>;
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * Get User Entitlements Limits
+     */
+    getUserEntitlements(requestParameters: BusinessBankingApiGetUserEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserEntitlementsLimits>;
+}
+/**
+ *
+ */
+export declare class BusinessBankingApi extends runtime.BaseAPI implements BusinessBankingApiInterface {
+    /**
+     * Creates request options for createRegistration without sending the request
+     */
+    createRegistrationRequestOpts(requestParameters: BusinessBankingApiCreateRegistrationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    createRegistrationRaw(requestParameters: BusinessBankingApiCreateRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<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
+     */
+    createRegistration(requestParameters: BusinessBankingApiCreateRegistrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getBusinessDetails without sending the request
+     */
+    getBusinessDetailsRequestOpts(requestParameters: BusinessBankingApiGetBusinessDetailsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getBusinessDetailsRaw(requestParameters: BusinessBankingApiGetBusinessDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessDetails>>;
+    /**
+     * 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
+     */
+    getBusinessDetails(requestParameters: BusinessBankingApiGetBusinessDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessDetails>;
+    /**
+     * Creates request options for getBusinessEntitlements without sending the request
+     */
+    getBusinessEntitlementsRequestOpts(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * Get Business Entitlements Limits
+     */
+    getBusinessEntitlementsRaw(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessEntitlementsLimits>>;
+    /**
+     * Get all the business entitlements for given institutionId and businessId
+     * Get Business Entitlements Limits
+     */
+    getBusinessEntitlements(requestParameters: BusinessBankingApiGetBusinessEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessEntitlementsLimits>;
+    /**
+     * Creates request options for getRegistrationByConfirmation without sending the request
+     */
+    getRegistrationByConfirmationRequestOpts(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getRegistrationByConfirmationRaw(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BbRegistration>>;
+    /**
+     * 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
+     */
+    getRegistrationByConfirmation(requestParameters: BusinessBankingApiGetRegistrationByConfirmationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getRegistrationById without sending the request
+     */
+    getRegistrationByIdRequestOpts(requestParameters: BusinessBankingApiGetRegistrationByIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getRegistrationByIdRaw(requestParameters: BusinessBankingApiGetRegistrationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BbRegistration>>;
+    /**
+     * 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
+     */
+    getRegistrationById(requestParameters: BusinessBankingApiGetRegistrationByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BbRegistration>;
+    /**
+     * Creates request options for getRegistrationConfig without sending the request
+     */
+    getRegistrationConfigRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getRegistrationConfigRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BusinessRegistrationConfig>>;
+    /**
+     * 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
+     */
+    getRegistrationConfig(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BusinessRegistrationConfig>;
+    /**
+     * Creates request options for getUserEntitlements without sending the request
+     */
+    getUserEntitlementsRequestOpts(requestParameters: BusinessBankingApiGetUserEntitlementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * Get User Entitlements Limits
+     */
+    getUserEntitlementsRaw(requestParameters: BusinessBankingApiGetUserEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserEntitlementsLimits>>;
+    /**
+     * Get all the user entitlements for given institutionId and loginId
+     * Get User Entitlements Limits
+     */
+    getUserEntitlements(requestParameters?: BusinessBankingApiGetUserEntitlementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserEntitlementsLimits>;
+}