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

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

@@ -0,0 +1,277 @@
+/**
+ * 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 { AuthCode, ClientAuth, CreateToken200Response, Token } from '../models/index.js';
+export interface AuthenticationApiAuthorizeClientRequest {
+    clientId: string;
+}
+export interface AuthenticationApiCreateLegacyTokenRequest {
+    diFiid: string;
+    grantType: string;
+    userAgent?: string;
+    offeringId?: string;
+    originatingIp?: string;
+    username?: string;
+    password?: string;
+}
+export interface AuthenticationApiCreateTokenRequest {
+    grantType?: CreateTokenGrantTypeEnum;
+    username?: string;
+    password?: string;
+    code?: string;
+    refreshToken?: string;
+}
+export interface AuthenticationApiGetAuthorizationCodeRequest {
+    scopes: string;
+    requestedScopes: string;
+    clientId: string;
+    username: string;
+    institutionUserId: string;
+    nonce?: string;
+    aud?: string;
+    authTime?: string;
+}
+export interface AuthenticationApiRevokeTokenRequest {
+    token?: string;
+}
+/**
+ * AuthenticationApi - interface
+ *
+ * @export
+ * @interface AuthenticationApiInterface
+ */
+export interface AuthenticationApiInterface {
+    /**
+     * Creates request options for authorizeClient without sending the request
+     * @param {string} clientId Apigee app key for client app.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    authorizeClientRequestOpts(requestParameters: AuthenticationApiAuthorizeClientRequest): 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 AuthenticationApiInterface
+     */
+    authorizeClientRaw(requestParameters: AuthenticationApiAuthorizeClientRequest, 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: AuthenticationApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientAuth>;
+    /**
+     * Creates request options for createLegacyToken without sending the request
+     * @param {string} diFiid The financial institution for which the authentication token is being requested. The scope of the OAuth2.0 token will be restricted to this Financial Institution.
+     * @param {string} grantType The OAuth grant type, defaults to &#x60;password&#x60; grant type, with &#x60;client_credentials&#x60; also being supported. A grant type of &#x60;password&#x60; should be used when the customer\\\&#39;s digital banking credentials are known.   A grant type of &#x60;client_credentials&#x60; should be used when the request is either non-customer specific or the customer\\\&#39;\\\&#39;s digital banking credentials are not available.\\\&#39;
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [offeringId] Uniquely identifies the name of the client app making the request. When not provided this is derived based on a property held against the application within Apigee
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** this should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [username] The customer\\\&#39;s digital banking login id.  **Note:** This parameter is mandatory when the &#x60;password&#x60; grant type is specified
+     * @param {string} [password] The customer\\\&#39;s digital banking password.  **Note:** This parameter is mandatory when the &#x60;password&#x60; grant type is specified
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    createLegacyTokenRequestOpts(requestParameters: AuthenticationApiCreateLegacyTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * **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.
+     * @summary Create V1 access token (Legacy)
+     * @param {string} diFiid The financial institution for which the authentication token is being requested. The scope of the OAuth2.0 token will be restricted to this Financial Institution.
+     * @param {string} grantType The OAuth grant type, defaults to &#x60;password&#x60; grant type, with &#x60;client_credentials&#x60; also being supported. A grant type of &#x60;password&#x60; should be used when the customer\\\&#39;s digital banking credentials are known.   A grant type of &#x60;client_credentials&#x60; should be used when the request is either non-customer specific or the customer\\\&#39;\\\&#39;s digital banking credentials are not available.\\\&#39;
+     * @param {string} [userAgent] Identifies the application and the platform making the request. The expected format is &#x60;{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]&#x60; e.g. iPhone/1.0/abc12345;Nokia3110
+     * @param {string} [offeringId] Uniquely identifies the name of the client app making the request. When not provided this is derived based on a property held against the application within Apigee
+     * @param {string} [originatingIp] The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. **Note:** this should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
+     * @param {string} [username] The customer\\\&#39;s digital banking login id.  **Note:** This parameter is mandatory when the &#x60;password&#x60; grant type is specified
+     * @param {string} [password] The customer\\\&#39;s digital banking password.  **Note:** This parameter is mandatory when the &#x60;password&#x60; grant type is specified
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AuthenticationApiInterface
+     */
+    createLegacyTokenRaw(requestParameters: AuthenticationApiCreateLegacyTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Token>>;
+    /**
+     * **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)
+     */
+    createLegacyToken(requestParameters: AuthenticationApiCreateLegacyTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Token>;
+    /**
+     * 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 AuthenticationApiInterface
+     */
+    createTokenRequestOpts(requestParameters: AuthenticationApiCreateTokenRequest): 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 AuthenticationApiInterface
+     */
+    createTokenRaw(requestParameters: AuthenticationApiCreateTokenRequest, 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: AuthenticationApiCreateTokenRequest, 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 AuthenticationApiInterface
+     */
+    getAuthorizationCodeRequestOpts(requestParameters: AuthenticationApiGetAuthorizationCodeRequest): 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 AuthenticationApiInterface
+     */
+    getAuthorizationCodeRaw(requestParameters: AuthenticationApiGetAuthorizationCodeRequest, 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: AuthenticationApiGetAuthorizationCodeRequest, 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 AuthenticationApiInterface
+     */
+    revokeTokenRequestOpts(requestParameters: AuthenticationApiRevokeTokenRequest): 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 AuthenticationApiInterface
+     */
+    revokeTokenRaw(requestParameters: AuthenticationApiRevokeTokenRequest, 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: AuthenticationApiRevokeTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ *
+ */
+export declare class AuthenticationApi extends runtime.BaseAPI implements AuthenticationApiInterface {
+    /**
+     * Creates request options for authorizeClient without sending the request
+     */
+    authorizeClientRequestOpts(requestParameters: AuthenticationApiAuthorizeClientRequest): 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: AuthenticationApiAuthorizeClientRequest, 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: AuthenticationApiAuthorizeClientRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientAuth>;
+    /**
+     * Creates request options for createLegacyToken without sending the request
+     */
+    createLegacyTokenRequestOpts(requestParameters: AuthenticationApiCreateLegacyTokenRequest): Promise<runtime.RequestOpts>;
+    /**
+     * **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)
+     */
+    createLegacyTokenRaw(requestParameters: AuthenticationApiCreateLegacyTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Token>>;
+    /**
+     * **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)
+     */
+    createLegacyToken(requestParameters: AuthenticationApiCreateLegacyTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Token>;
+    /**
+     * Creates request options for createToken without sending the request
+     */
+    createTokenRequestOpts(requestParameters: AuthenticationApiCreateTokenRequest): 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: AuthenticationApiCreateTokenRequest, 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?: AuthenticationApiCreateTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateToken200Response>;
+    /**
+     * Creates request options for getAuthorizationCode without sending the request
+     */
+    getAuthorizationCodeRequestOpts(requestParameters: AuthenticationApiGetAuthorizationCodeRequest): 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: AuthenticationApiGetAuthorizationCodeRequest, 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: AuthenticationApiGetAuthorizationCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuthCode>;
+    /**
+     * Creates request options for revokeToken without sending the request
+     */
+    revokeTokenRequestOpts(requestParameters: AuthenticationApiRevokeTokenRequest): 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: AuthenticationApiRevokeTokenRequest, 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?: AuthenticationApiRevokeTokenRequest, 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];