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

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

@@ -0,0 +1,378 @@
+/* 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 { AuthCodeFromJSON, ClientAuthFromJSON, CreateToken200ResponseFromJSON, TokenFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class AuthenticationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for authorizeClient without sending the request
+     */
+    async authorizeClientRequestOpts(requestParameters) {
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling authorizeClient().');
+        }
+        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}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['clientId'] != null) {
+            formParams.append('client_id', requestParameters['clientId']);
+        }
+        let urlPath = `/auth-code/v1/client-authorization`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * Authorizes a client application to access resources on behalf of a user. Used in the OAuth 2.0 authorization flow to grant permissions.
+     * Authorize client
+     */
+    async authorizeClientRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.authorizeClientRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientAuthFromJSON(jsonValue));
+    }
+    /**
+     * Authorizes a client application to access resources on behalf of a user. Used in the OAuth 2.0 authorization flow to grant permissions.
+     * Authorize client
+     */
+    async authorizeClient(requestParameters, initOverrides) {
+        const response = await this.authorizeClientRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createLegacyToken without sending the request
+     */
+    async createLegacyTokenRequestOpts(requestParameters) {
+        if (requestParameters['diFiid'] == null) {
+            throw new runtime.RequiredError('diFiid', 'Required parameter "diFiid" was null or undefined when calling createLegacyToken().');
+        }
+        if (requestParameters['grantType'] == null) {
+            throw new runtime.RequiredError('grantType', 'Required parameter "grantType" was null or undefined when calling createLegacyToken().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['userAgent'] != null) {
+            headerParameters['user-agent'] = String(requestParameters['userAgent']);
+        }
+        if (requestParameters['diFiid'] != null) {
+            headerParameters['di_fiid'] = String(requestParameters['diFiid']);
+        }
+        if (requestParameters['offeringId'] != null) {
+            headerParameters['offering_id'] = String(requestParameters['offeringId']);
+        }
+        if (requestParameters['originatingIp'] != null) {
+            headerParameters['originating_ip'] = String(requestParameters['originatingIp']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['grantType'] != null) {
+            formParams.append('grant_type', requestParameters['grantType']);
+        }
+        if (requestParameters['username'] != null) {
+            formParams.append('username', requestParameters['username']);
+        }
+        if (requestParameters['password'] != null) {
+            formParams.append('password', requestParameters['password']);
+        }
+        let urlPath = `/v1/oauth/token`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * **Legacy V1 Token Endpoint** - Use this endpoint for V1 APIs only (Send Event, Destinations, Get FI Customer, Register User).  Allows a registered application to obtain an OAuth 2.0 Bearer Token for accessing legacy Digital Insight APIs.  **Supported Grant Types:** - **password**: Used when the customer\'s digital banking credentials are known. Response includes customer\'s member ID and token scope is restricted to that customer. - **client_credentials**: Used when acting on behalf of a customer without their credentials. Response does not contain customer-specific data.  **Token Expiration:** 30 minutes  **Note:** For most current APIs (Accounts, Alerts, Banking Images, Disclosures, Money Movement, Transactions), use the V2 token endpoint (`POST /oauth2/v1/token`) instead.
+     * Create V1 access token (Legacy)
+     */
+    async createLegacyTokenRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createLegacyTokenRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => TokenFromJSON(jsonValue));
+    }
+    /**
+     * **Legacy V1 Token Endpoint** - Use this endpoint for V1 APIs only (Send Event, Destinations, Get FI Customer, Register User).  Allows a registered application to obtain an OAuth 2.0 Bearer Token for accessing legacy Digital Insight APIs.  **Supported Grant Types:** - **password**: Used when the customer\'s digital banking credentials are known. Response includes customer\'s member ID and token scope is restricted to that customer. - **client_credentials**: Used when acting on behalf of a customer without their credentials. Response does not contain customer-specific data.  **Token Expiration:** 30 minutes  **Note:** For most current APIs (Accounts, Alerts, Banking Images, Disclosures, Money Movement, Transactions), use the V2 token endpoint (`POST /oauth2/v1/token`) instead.
+     * Create V1 access token (Legacy)
+     */
+    async createLegacyToken(requestParameters, initOverrides) {
+        const response = await this.createLegacyTokenRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for createToken without sending the request
+     */
+    async createTokenRequestOpts(requestParameters) {
+        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}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['grantType'] != null) {
+            formParams.append('grant_type', requestParameters['grantType']);
+        }
+        if (requestParameters['username'] != null) {
+            formParams.append('username', requestParameters['username']);
+        }
+        if (requestParameters['password'] != null) {
+            formParams.append('password', requestParameters['password']);
+        }
+        if (requestParameters['code'] != null) {
+            formParams.append('code', requestParameters['code']);
+        }
+        if (requestParameters['refreshToken'] != null) {
+            formParams.append('refresh_token', requestParameters['refreshToken']);
+        }
+        let urlPath = `/oauth2/v1/token`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * **V2 Token Endpoint** - Use this endpoint for most current Candescent APIs (Accounts, Alerts, Banking Images, Disclosures, Money Movement, Transactions).  Issues OAuth 2.0 access tokens for authenticated API access via the Candescent Developer Console.  **Supported Grant Types:** - **client_credentials**: Institution-level access without user context. Subsequent API calls require `hostUserId` or `loginId` as query parameter. - **password**: User-level access with username and password. Returns both access token and refresh token. - **authorization_code**: (Internal use) For OpenID Connect flows. - **refresh_token**: Obtain new access token using a previously issued refresh token.  **Authentication:** Use HTTP Basic Auth with `client_id` as username and `client_secret` as password.  **Note:** For legacy V1 APIs (Send Event, Destinations, Get FI Customer, Register User), use the V1 token endpoint (`POST /v1/oauth/token`) instead.
+     * Create V2 access token
+     */
+    async createTokenRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.createTokenRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateToken200ResponseFromJSON(jsonValue));
+    }
+    /**
+     * **V2 Token Endpoint** - Use this endpoint for most current Candescent APIs (Accounts, Alerts, Banking Images, Disclosures, Money Movement, Transactions).  Issues OAuth 2.0 access tokens for authenticated API access via the Candescent Developer Console.  **Supported Grant Types:** - **client_credentials**: Institution-level access without user context. Subsequent API calls require `hostUserId` or `loginId` as query parameter. - **password**: User-level access with username and password. Returns both access token and refresh token. - **authorization_code**: (Internal use) For OpenID Connect flows. - **refresh_token**: Obtain new access token using a previously issued refresh token.  **Authentication:** Use HTTP Basic Auth with `client_id` as username and `client_secret` as password.  **Note:** For legacy V1 APIs (Send Event, Destinations, Get FI Customer, Register User), use the V1 token endpoint (`POST /v1/oauth/token`) instead.
+     * Create V2 access token
+     */
+    async createToken(requestParameters = {}, initOverrides) {
+        const response = await this.createTokenRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getAuthorizationCode without sending the request
+     */
+    async getAuthorizationCodeRequestOpts(requestParameters) {
+        if (requestParameters['scopes'] == null) {
+            throw new runtime.RequiredError('scopes', 'Required parameter "scopes" was null or undefined when calling getAuthorizationCode().');
+        }
+        if (requestParameters['requestedScopes'] == null) {
+            throw new runtime.RequiredError('requestedScopes', 'Required parameter "requestedScopes" was null or undefined when calling getAuthorizationCode().');
+        }
+        if (requestParameters['clientId'] == null) {
+            throw new runtime.RequiredError('clientId', 'Required parameter "clientId" was null or undefined when calling getAuthorizationCode().');
+        }
+        if (requestParameters['username'] == null) {
+            throw new runtime.RequiredError('username', 'Required parameter "username" was null or undefined when calling getAuthorizationCode().');
+        }
+        if (requestParameters['institutionUserId'] == null) {
+            throw new runtime.RequiredError('institutionUserId', 'Required parameter "institutionUserId" was null or undefined when calling getAuthorizationCode().');
+        }
+        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}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['scopes'] != null) {
+            formParams.append('scopes', requestParameters['scopes']);
+        }
+        if (requestParameters['requestedScopes'] != null) {
+            formParams.append('requested_scopes', requestParameters['requestedScopes']);
+        }
+        if (requestParameters['clientId'] != null) {
+            formParams.append('client_id', requestParameters['clientId']);
+        }
+        if (requestParameters['username'] != null) {
+            formParams.append('username', requestParameters['username']);
+        }
+        if (requestParameters['institutionUserId'] != null) {
+            formParams.append('institution_user_id', requestParameters['institutionUserId']);
+        }
+        if (requestParameters['nonce'] != null) {
+            formParams.append('nonce', requestParameters['nonce']);
+        }
+        if (requestParameters['aud'] != null) {
+            formParams.append('aud', requestParameters['aud']);
+        }
+        if (requestParameters['authTime'] != null) {
+            formParams.append('auth_time', requestParameters['authTime']);
+        }
+        let urlPath = `/auth-code/v1/auth-code`;
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * Generates an authorization code for OAuth 2.0 authorization code flow. The returned code can be exchanged for an access token at the token endpoint.
+     * Get authorization code
+     */
+    async getAuthorizationCodeRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getAuthorizationCodeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => AuthCodeFromJSON(jsonValue));
+    }
+    /**
+     * Generates an authorization code for OAuth 2.0 authorization code flow. The returned code can be exchanged for an access token at the token endpoint.
+     * Get authorization code
+     */
+    async getAuthorizationCode(requestParameters, initOverrides) {
+        const response = await this.getAuthorizationCodeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for revokeToken without sending the request
+     */
+    async revokeTokenRequestOpts(requestParameters) {
+        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}`;
+            }
+        }
+        const consumes = [
+            { contentType: 'application/x-www-form-urlencoded' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+        let formParams;
+        let useForm = false;
+        if (useForm) {
+            formParams = new FormData();
+        }
+        else {
+            formParams = new URLSearchParams();
+        }
+        if (requestParameters['token'] != null) {
+            formParams.append('token', requestParameters['token']);
+        }
+        let urlPath = `/oauth2/v1/revoke`;
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+    /**
+     * Revokes an active OAuth 2.0 access token, rendering it unusable for future API requests.  **Use Cases:** - User logout flows - Token suspected to be compromised - Security incidents requiring immediate token invalidation  **Authentication:** Use HTTP Basic Auth with `client_id` as username and `client_secret` as password.  **Note:** Once revoked, the token cannot be restored. A new token must be obtained via the token endpoint.
+     * Revoke access token
+     */
+    async revokeTokenRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.revokeTokenRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * Revokes an active OAuth 2.0 access token, rendering it unusable for future API requests.  **Use Cases:** - User logout flows - Token suspected to be compromised - Security incidents requiring immediate token invalidation  **Authentication:** Use HTTP Basic Auth with `client_id` as username and `client_secret` as password.  **Note:** Once revoked, the token cannot be restored. A new token must be obtained via the token endpoint.
+     * Revoke access token
+     */
+    async revokeToken(requestParameters = {}, initOverrides) {
+        await this.revokeTokenRaw(requestParameters, initOverrides);
+    }
+}
+/**
+ * @export
+ */
+export const CreateTokenGrantTypeEnum = {
+    CLIENT_CREDENTIALS: 'client_credentials',
+    PASSWORD: 'password',
+    AUTHORIZATION_CODE: 'authorization_code',
+    REFRESH_TOKEN: 'refresh_token'
+};