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

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

@@ -0,0 +1,100 @@
+/* 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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 { TokenFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class OAuthV1Api extends runtime.BaseAPI {
+    /**
+     * 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();
+    }
+}
+//# sourceMappingURL=OAuthV1Api.js.map

package/dist/generated/src/apis/OAuthV1Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OAuthV1Api.js","sourceRoot":"","sources":["../../../../generated/src/apis/OAuthV1Api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAKzC,OAAO,EAGH,aAAa,GAEhB,MAAM,oBAAoB,CAAC;AAyD5B;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,OAAO,CAAC,OAAO;IAE3C;;OAEG;IACH,KAAK,CAAC,4BAA4B,CAAC,iBAAqD;QACpF,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,QAAQ,EACR,qFAAqF,CACxF,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,WAAW,EACX,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,gBAAgB,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,gBAAgB,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1C,gBAAgB,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9E,CAAC;QAED,IAAI,iBAAiB,CAAC,eAAe,CAAC,IAAI,IAAI,EAAE,CAAC;YAC7C,gBAAgB,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,CAAC;QACpF,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,mCAAmC,EAAE;SACvD,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,WAAW,CAAQ,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAGD,IAAI,OAAO,GAAG,iBAAiB,CAAC;QAEhC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAAqD,EAAE,aAA0D;QACxI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;QAClF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,iBAAqD,EAAE,aAA0D;QACrI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACnF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;CAEJ"}

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

@@ -0,0 +1,221 @@
+/**
+ * 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
+ *
+ * The version of the OpenAPI document: 1.6.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 { AuthCode, ClientAuth, CreateToken200Response } from '../models/index.js';
+export interface OAuthV2ApiAuthorizeClientRequest {
+    clientId: string;
+}
+export interface OAuthV2ApiCreateTokenRequest {
+    grantType?: CreateTokenGrantTypeEnum;
+    username?: string;
+    password?: string;
+    code?: string;
+    refreshToken?: string;
+}
+export interface OAuthV2ApiGetAuthorizationCodeRequest {
+    scopes: string;
+    requestedScopes: string;
+    clientId: string;
+    username: string;
+    institutionUserId: string;
+    nonce?: string;
+    aud?: string;
+    authTime?: string;
+}
+export interface OAuthV2ApiRevokeTokenRequest {
+    token?: string;
+}
+/**
+ * OAuthV2Api - interface
+ *
+ * @export
+ * @interface OAuthV2ApiInterface
+ */
+export interface OAuthV2ApiInterface {
+    /**
+     * Creates request options for authorizeClient without sending the request
+     * @param {string} clientId Apigee app key for client app.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    authorizeClientRequestOpts(requestParameters: OAuthV2ApiAuthorizeClientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Authorizes a client application to access resources on behalf of a user. Used in the OAuth 2.0 authorization flow to grant permissions.
+     * @summary Authorize Client
+     * @param {string} clientId Apigee app key for client app.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    authorizeClientRaw(requestParameters: OAuthV2ApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientAuth>>;
+    /**
+     * 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
+     */
+    authorizeClient(requestParameters: OAuthV2ApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientAuth>;
+    /**
+     * Creates request options for createToken without sending the request
+     * @param {string} [grantType] Specifies the OAuth 2.0 grant type used to request the access token.
+     * @param {string} [username] The user\\\&#39;s login identifier used for authentication.
+     * @param {string} [password] The password corresponding to the provided username.
+     * @param {string} [code] The authorization code obtained from the authorization server, used to exchange for an access token.
+     * @param {string} [refreshToken] A valid refresh token used to request a new access token without re-authenticating the user.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    createTokenRequestOpts(requestParameters: OAuthV2ApiCreateTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * **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.
+     * @summary Create V2 Access Token
+     * @param {string} [grantType] Specifies the OAuth 2.0 grant type used to request the access token.
+     * @param {string} [username] The user\\\&#39;s login identifier used for authentication.
+     * @param {string} [password] The password corresponding to the provided username.
+     * @param {string} [code] The authorization code obtained from the authorization server, used to exchange for an access token.
+     * @param {string} [refreshToken] A valid refresh token used to request a new access token without re-authenticating the user.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    createTokenRaw(requestParameters: OAuthV2ApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateToken200Response>>;
+    /**
+     * **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
+     */
+    createToken(requestParameters: OAuthV2ApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateToken200Response>;
+    /**
+     * Creates request options for getAuthorizationCode without sending the request
+     * @param {string} scopes Scopes of the access request
+     * @param {string} requestedScopes Scopes of the oidc request
+     * @param {string} clientId Apigee app key for client app.
+     * @param {string} username Unique Identifier for the Institution User being authenticated
+     * @param {string} institutionUserId Unique Identifier for the Institution User being authenticated
+     * @param {string} [nonce] Unique Identifier for the Open Id Connect authorization code request
+     * @param {string} [aud] audience for the Open Id Connect auth code request
+     * @param {string} [authTime] authorization time for the Open Id Connect auth code request
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    getAuthorizationCodeRequestOpts(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Get Authorization Code
+     * @param {string} scopes Scopes of the access request
+     * @param {string} requestedScopes Scopes of the oidc request
+     * @param {string} clientId Apigee app key for client app.
+     * @param {string} username Unique Identifier for the Institution User being authenticated
+     * @param {string} institutionUserId Unique Identifier for the Institution User being authenticated
+     * @param {string} [nonce] Unique Identifier for the Open Id Connect authorization code request
+     * @param {string} [aud] audience for the Open Id Connect auth code request
+     * @param {string} [authTime] authorization time for the Open Id Connect auth code request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    getAuthorizationCodeRaw(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthCode>>;
+    /**
+     * 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
+     */
+    getAuthorizationCode(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthCode>;
+    /**
+     * Creates request options for revokeToken without sending the request
+     * @param {string} [token] The OAuth 2.0 access token to be invalidated. Once revoked, it cannot be used for API access.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    revokeTokenRequestOpts(requestParameters: OAuthV2ApiRevokeTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * @summary Revoke Access Token
+     * @param {string} [token] The OAuth 2.0 access token to be invalidated. Once revoked, it cannot be used for API access.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OAuthV2ApiInterface
+     */
+    revokeTokenRaw(requestParameters: OAuthV2ApiRevokeTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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
+     */
+    revokeToken(requestParameters: OAuthV2ApiRevokeTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class OAuthV2Api extends runtime.BaseAPI implements OAuthV2ApiInterface {
+    /**
+     * Creates request options for authorizeClient without sending the request
+     */
+    authorizeClientRequestOpts(requestParameters: OAuthV2ApiAuthorizeClientRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    authorizeClientRaw(requestParameters: OAuthV2ApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientAuth>>;
+    /**
+     * 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
+     */
+    authorizeClient(requestParameters: OAuthV2ApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientAuth>;
+    /**
+     * Creates request options for createToken without sending the request
+     */
+    createTokenRequestOpts(requestParameters: OAuthV2ApiCreateTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * **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
+     */
+    createTokenRaw(requestParameters: OAuthV2ApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateToken200Response>>;
+    /**
+     * **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
+     */
+    createToken(requestParameters?: OAuthV2ApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateToken200Response>;
+    /**
+     * Creates request options for getAuthorizationCode without sending the request
+     */
+    getAuthorizationCodeRequestOpts(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    getAuthorizationCodeRaw(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuthCode>>;
+    /**
+     * 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
+     */
+    getAuthorizationCode(requestParameters: OAuthV2ApiGetAuthorizationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthCode>;
+    /**
+     * Creates request options for revokeToken without sending the request
+     */
+    revokeTokenRequestOpts(requestParameters: OAuthV2ApiRevokeTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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
+     */
+    revokeTokenRaw(requestParameters: OAuthV2ApiRevokeTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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
+     */
+    revokeToken(requestParameters?: OAuthV2ApiRevokeTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const CreateTokenGrantTypeEnum: {
+    readonly CLIENT_CREDENTIALS: "client_credentials";
+    readonly PASSWORD: "password";
+    readonly AUTHORIZATION_CODE: "authorization_code";
+    readonly REFRESH_TOKEN: "refresh_token";
+};
+export type CreateTokenGrantTypeEnum = typeof CreateTokenGrantTypeEnum[keyof typeof CreateTokenGrantTypeEnum];

package/dist/generated/src/apis/{AuthenticationApi.js → OAuthV2Api.js}

@@ -2,9 +2,9 @@
 /* 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/)**.
+ * 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 | |----------|-------------| | **[Authentication](/api/generated/o-auth-v-2/)** | OAuth token APIs (legacy v1 and current v2) | | **[Customer Management](/api/generated/registration-and-access/)** | Registration and access, profile and status, and contact info | | **[Core Banking](/api/generated/accounts/)** | Accounts, transactions, banking activities, and banking images | | **[Business Banking](/api/generated/registration/)** | Business registration, profile, entitlements, and payments | | **[Money Movement](/api/generated/recipients/)** | Recipients and transfers | | **[Alerts And Notifications](/api/generated/system-alerts/)** | System and institution alerts, templates, institution and user preferences, notification channels, and history and events | | **[Documents And Preferences](/api/generated/institution-disclosures/)** | Institution and user disclosures, and electronic statements | | **[Customer Campaigns](/api/generated/experience-groups/)** | Experience groups, jobs, promotions suite, and audience | | **[MX](/api/generated/users/)** | MX users, data, and widgets |  ## Base URLs  | Environment | Base URL | |-------------|----------| | Sandbox     | `https://api.sandbox.candescent.com` | | Stage       | `https://api.stage.candescent.com` | | Production  | `https://api.candescent.com` |  > **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.stage.candescent.com/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.stage.candescent.com/v1/accounts?loginId=<USER_LOGIN_ID>\' \\   -H \'Authorization: Bearer <YOUR_ACCESS_TOKEN>\' \\   -H \'institutionId: <YOUR_INSTITUTION_ID>\' \\   -H \'transactionid: <YOUR_UNIQUE_UUID>\' ```  > **Tip:** Access tokens expire in ~24 hours. Implement token refresh logic for uninterrupted access.  For detailed authentication flows, see the **[Authentication API Reference](/api/generated/o-auth-v-2/)**.
  *
- * The version of the OpenAPI document: 1.4.0
+ * The version of the OpenAPI document: 1.6.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -12,11 +12,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import { AuthCodeFromJSON, ClientAuthFromJSON, CreateToken200ResponseFromJSON, TokenFromJSON, } from '../models/index.js';
+import { AuthCodeFromJSON, ClientAuthFromJSON, CreateToken200ResponseFromJSON, } from '../models/index.js';
 /**
  *
  */
-export class AuthenticationApi extends runtime.BaseAPI {
+export class OAuthV2Api extends runtime.BaseAPI {
     /**
      * Creates request options for authorizeClient without sending the request
      */
@@ -49,7 +49,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
         if (requestParameters['clientId'] != null) {
             formParams.append('client_id', requestParameters['clientId']);
         }
-        let urlPath = `/auth-code/v1/client-authorization`;
+        let urlPath = `/v1/client-authorization`;
         return {
             path: urlPath,
             method: 'POST',
@@ -60,7 +60,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * Authorize Client
      */
     async authorizeClientRaw(requestParameters, initOverrides) {
         const requestOptions = await this.authorizeClientRequestOpts(requestParameters);
@@ -69,91 +69,12 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * 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
      */
@@ -206,7 +127,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * **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
+     * Create V2 Access Token
      */
     async createTokenRaw(requestParameters, initOverrides) {
         const requestOptions = await this.createTokenRequestOpts(requestParameters);
@@ -215,7 +136,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * **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
+     * Create V2 Access Token
      */
     async createToken(requestParameters = {}, initOverrides) {
         const response = await this.createTokenRaw(requestParameters, initOverrides);
@@ -286,7 +207,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
         if (requestParameters['authTime'] != null) {
             formParams.append('auth_time', requestParameters['authTime']);
         }
-        let urlPath = `/auth-code/v1/auth-code`;
+        let urlPath = `/v1/auth-code`;
         return {
             path: urlPath,
             method: 'POST',
@@ -297,7 +218,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * Get Authorization Code
      */
     async getAuthorizationCodeRaw(requestParameters, initOverrides) {
         const requestOptions = await this.getAuthorizationCodeRequestOpts(requestParameters);
@@ -306,7 +227,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * Get Authorization Code
      */
     async getAuthorizationCode(requestParameters, initOverrides) {
         const response = await this.getAuthorizationCodeRaw(requestParameters, initOverrides);
@@ -352,7 +273,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * Revoke Access Token
      */
     async revokeTokenRaw(requestParameters, initOverrides) {
         const requestOptions = await this.revokeTokenRequestOpts(requestParameters);
@@ -361,7 +282,7 @@ export class AuthenticationApi extends runtime.BaseAPI {
     }
     /**
      * 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
+     * Revoke Access Token
      */
     async revokeToken(requestParameters = {}, initOverrides) {
         await this.revokeTokenRaw(requestParameters, initOverrides);
@@ -376,3 +297,4 @@ export const CreateTokenGrantTypeEnum = {
     AUTHORIZATION_CODE: 'authorization_code',
     REFRESH_TOKEN: 'refresh_token'
 };
+//# sourceMappingURL=OAuthV2Api.js.map

package/dist/generated/src/apis/OAuthV2Api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OAuthV2Api.js","sourceRoot":"","sources":["../../../../generated/src/apis/OAuthV2Api.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAQzC,OAAO,EACH,gBAAgB,EAEhB,kBAAkB,EAElB,8BAA8B,GAMjC,MAAM,oBAAoB,CAAC;AA4J5B;;GAEG;AACH,MAAM,OAAO,UAAW,SAAQ,OAAO,CAAC,OAAO;IAE3C;;OAEG;IACH,KAAK,CAAC,0BAA0B,CAAC,iBAAmD;QAChF,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,UAAU,EACV,qFAAqF,CACxF,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,mCAAmC,EAAE;SACvD,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACzE,CAAC;QAGD,IAAI,OAAO,GAAG,0BAA0B,CAAC;QAEzC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,iBAAmD,EAAE,aAA0D;QACpI,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,iBAAiB,CAAC,CAAC;QAChF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,iBAAmD,EAAE,aAA0D;QACjI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACjF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA+C;QACxE,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,mCAAmC,EAAE;SACvD,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,UAAU,CAAC,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,WAAW,CAAQ,CAAC,CAAC;QAC3E,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACpC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAQ,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,iBAAiB,CAAC,cAAc,CAAC,IAAI,IAAI,EAAE,CAAC;YAC5C,UAAU,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,cAAc,CAAQ,CAAC,CAAC;QACjF,CAAC;QAGD,IAAI,OAAO,GAAG,kBAAkB,CAAC;QAEjC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAA+C,EAAE,aAA0D;QAC5H,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,oBAAkD,EAAE,EAAE,aAA0D;QAC9H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QAC7E,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,+BAA+B,CAAC,iBAAwD;QAC1F,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,QAAQ,EACR,wFAAwF,CAC3F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,IAAI,EAAE,CAAC;YAC/C,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,iBAAiB,EACjB,iGAAiG,CACpG,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,UAAU,EACV,0FAA0F,CAC7F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,UAAU,EACV,0FAA0F,CAC7F,CAAC;QACN,CAAC;QAED,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,MAAM,IAAI,OAAO,CAAC,aAAa,CAC3B,mBAAmB,EACnB,mGAAmG,CACtG,CAAC;QACN,CAAC;QAED,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,mCAAmC,EAAE;SACvD,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YACtC,UAAU,CAAC,MAAM,CAAC,QAAQ,EAAE,iBAAiB,CAAC,QAAQ,CAAQ,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,IAAI,EAAE,CAAC;YAC/C,UAAU,CAAC,MAAM,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,iBAAiB,CAAQ,CAAC,CAAC;QACvF,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACxE,CAAC;QAED,IAAI,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC;YACjD,UAAU,CAAC,MAAM,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,mBAAmB,CAAQ,CAAC,CAAC;QAC5F,CAAC;QAED,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAQ,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;YACnC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,iBAAiB,CAAC,KAAK,CAAQ,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACxC,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,iBAAiB,CAAC,UAAU,CAAQ,CAAC,CAAC;QACzE,CAAC;QAGD,IAAI,OAAO,GAAG,eAAe,CAAC;QAE9B,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,uBAAuB,CAAC,iBAAwD,EAAE,aAA0D;QAC9I,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,+BAA+B,CAAC,iBAAiB,CAAC,CAAC;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,iBAAwD,EAAE,aAA0D;QAC3I,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;QACtF,OAAO,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAAC,iBAA+C;QACxE,MAAM,eAAe,GAAQ,EAAE,CAAC;QAEhC,MAAM,gBAAgB,GAAwB,EAAE,CAAC;QAEjD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC;YACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;YAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBACd,gBAAgB,CAAC,eAAe,CAAC,GAAG,UAAU,WAAW,EAAE,CAAC;YAChE,CAAC;QACL,CAAC;QACD,MAAM,QAAQ,GAAsB;YAChC,EAAE,WAAW,EAAE,mCAAmC,EAAE;SACvD,CAAC;QACF,2CAA2C;QAC3C,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAExD,IAAI,UAAsD,CAAC;QAC3D,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,OAAO,EAAE,CAAC;YACV,UAAU,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,CAAC;aAAM,CAAC;YACJ,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACvC,CAAC;QAED,IAAI,iBAAiB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;YACrC,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAQ,CAAC,CAAC;QAClE,CAAC;QAGD,IAAI,OAAO,GAAG,mBAAmB,CAAC;QAElC,OAAO;YACH,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,QAAQ;YAChB,OAAO,EAAE,gBAAgB;YACzB,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,iBAA+C,EAAE,aAA0D;QAC5H,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QAEnE,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,oBAAkD,EAAE,EAAE,aAA0D;QAC9H,MAAM,IAAI,CAAC,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;IAChE,CAAC;CAEJ;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACpC,kBAAkB,EAAE,oBAAoB;IACxC,QAAQ,EAAE,UAAU;IACpB,kBAAkB,EAAE,oBAAoB;IACxC,aAAa,EAAE,eAAe;CACxB,CAAC"}