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

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

@@ -0,0 +1,211 @@
+/**
+ * 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 { GetWidgetUrl200Response, User, UsersList } from '../models/index.js';
+export interface MXApiDownloadTransactionLogsRequest {
+    extHost: string;
+    institutionId: string;
+    date: Date;
+    accept: string;
+}
+export interface MXApiGetUserRequest {
+    extHost: string;
+    institutionId: string;
+    userId: string;
+    accept: string;
+    acceptVersion?: string;
+}
+export interface MXApiGetWidgetUrlRequest {
+    extHost: string;
+    institutionId: string;
+    userId: string;
+    accept: string;
+}
+export interface MXApiListUsersRequest {
+    extHost: string;
+    accept: string;
+}
+/**
+ * MXApi - interface
+ *
+ * @export
+ * @interface MXApiInterface
+ */
+export interface MXApiInterface {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {Date} date Date to query (YYYY-MM-DD)
+     * @param {string} accept
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    downloadTransactionLogsRequestOpts(requestParameters: MXApiDownloadTransactionLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * @summary Download transaction logs
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {Date} date Date to query (YYYY-MM-DD)
+     * @param {string} accept
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    downloadTransactionLogsRaw(requestParameters: MXApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download transaction logs
+     */
+    downloadTransactionLogs(requestParameters: MXApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getUser without sending the request
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {string} userId MX user identifier.
+     * @param {string} accept
+     * @param {string} [acceptVersion]
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    getUserRequestOpts(requestParameters: MXApiGetUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * @summary Get MX user by ID
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {string} userId MX user identifier.
+     * @param {string} accept
+     * @param {string} [acceptVersion]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    getUserRaw(requestParameters: MXApiGetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<User>>;
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * Get MX user by ID
+     */
+    getUser(requestParameters: MXApiGetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<User>;
+    /**
+     * Creates request options for getWidgetUrl without sending the request
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {string} userId MX user identifier.
+     * @param {string} accept
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    getWidgetUrlRequestOpts(requestParameters: MXApiGetWidgetUrlRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * @summary Get MX widget URL
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} institutionId Institution identifier in MX.
+     * @param {string} userId MX user identifier.
+     * @param {string} accept
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    getWidgetUrlRaw(requestParameters: MXApiGetWidgetUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWidgetUrl200Response>>;
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * Get MX widget URL
+     */
+    getWidgetUrl(requestParameters: MXApiGetWidgetUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWidgetUrl200Response>;
+    /**
+     * Creates request options for listUsers without sending the request
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} accept
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    listUsersRequestOpts(requestParameters: MXApiListUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * @summary List MX users
+     * @param {string} extHost Upstream host hint for the gateway.
+     * @param {string} accept
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MXApiInterface
+     */
+    listUsersRaw(requestParameters: MXApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsersList>>;
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * List MX users
+     */
+    listUsers(requestParameters: MXApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsersList>;
+}
+/**
+ *
+ */
+export declare class MXApi extends runtime.BaseAPI implements MXApiInterface {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     */
+    downloadTransactionLogsRequestOpts(requestParameters: MXApiDownloadTransactionLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download transaction logs
+     */
+    downloadTransactionLogsRaw(requestParameters: MXApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download transaction logs
+     */
+    downloadTransactionLogs(requestParameters: MXApiDownloadTransactionLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getUser without sending the request
+     */
+    getUserRequestOpts(requestParameters: MXApiGetUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * Get MX user by ID
+     */
+    getUserRaw(requestParameters: MXApiGetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<User>>;
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * Get MX user by ID
+     */
+    getUser(requestParameters: MXApiGetUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<User>;
+    /**
+     * Creates request options for getWidgetUrl without sending the request
+     */
+    getWidgetUrlRequestOpts(requestParameters: MXApiGetWidgetUrlRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * Get MX widget URL
+     */
+    getWidgetUrlRaw(requestParameters: MXApiGetWidgetUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWidgetUrl200Response>>;
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * Get MX widget URL
+     */
+    getWidgetUrl(requestParameters: MXApiGetWidgetUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWidgetUrl200Response>;
+    /**
+     * Creates request options for listUsers without sending the request
+     */
+    listUsersRequestOpts(requestParameters: MXApiListUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * List MX users
+     */
+    listUsersRaw(requestParameters: MXApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsersList>>;
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * List MX users
+     */
+    listUsers(requestParameters: MXApiListUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsersList>;
+}

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

@@ -0,0 +1,252 @@
+/* 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 { GetWidgetUrl200ResponseFromJSON, UserFromJSON, UsersListFromJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class MXApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for downloadTransactionLogs without sending the request
+     */
+    async downloadTransactionLogsRequestOpts(requestParameters) {
+        if (requestParameters['extHost'] == null) {
+            throw new runtime.RequiredError('extHost', 'Required parameter "extHost" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['institutionId'] == null) {
+            throw new runtime.RequiredError('institutionId', 'Required parameter "institutionId" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['date'] == null) {
+            throw new runtime.RequiredError('date', 'Required parameter "date" was null or undefined when calling downloadTransactionLogs().');
+        }
+        if (requestParameters['accept'] == null) {
+            throw new runtime.RequiredError('accept', 'Required parameter "accept" was null or undefined when calling downloadTransactionLogs().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['extHost'] != null) {
+            headerParameters['ext_host'] = String(requestParameters['extHost']);
+        }
+        if (requestParameters['accept'] != null) {
+            headerParameters['Accept'] = String(requestParameters['accept']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/mx/download/{institution_id}/{date}/transactions/created`;
+        urlPath = urlPath.replace(`{${"institution_id"}}`, encodeURIComponent(String(requestParameters['institutionId'])));
+        if (requestParameters['date'] instanceof Date) {
+            urlPath = urlPath.replace(`{${"date"}}`, encodeURIComponent(requestParameters['date'].toISOString().substring(0, 10)));
+        }
+        else {
+            urlPath = urlPath.replace(`{${"date"}}`, encodeURIComponent(String(requestParameters['date'])));
+        }
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download transaction logs
+     */
+    async downloadTransactionLogsRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.downloadTransactionLogsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.BlobApiResponse(response);
+    }
+    /**
+     * Retrieves an Avro log stream of transaction creation events for a specific institution on a given date via MX Logs. A 404 with message \"ClientReportingProfile does not exist\" indicates the institution may not be enabled for MX Logs or the ext_host/credentials are misconfigured.
+     * Download transaction logs
+     */
+    async downloadTransactionLogs(requestParameters, initOverrides) {
+        const response = await this.downloadTransactionLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getUser without sending the request
+     */
+    async getUserRequestOpts(requestParameters) {
+        if (requestParameters['extHost'] == null) {
+            throw new runtime.RequiredError('extHost', 'Required parameter "extHost" was null or undefined when calling getUser().');
+        }
+        if (requestParameters['institutionId'] == null) {
+            throw new runtime.RequiredError('institutionId', 'Required parameter "institutionId" was null or undefined when calling getUser().');
+        }
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUser().');
+        }
+        if (requestParameters['accept'] == null) {
+            throw new runtime.RequiredError('accept', 'Required parameter "accept" was null or undefined when calling getUser().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['extHost'] != null) {
+            headerParameters['ext_host'] = String(requestParameters['extHost']);
+        }
+        if (requestParameters['accept'] != null) {
+            headerParameters['Accept'] = String(requestParameters['accept']);
+        }
+        if (requestParameters['acceptVersion'] != null) {
+            headerParameters['Accept-Version'] = String(requestParameters['acceptVersion']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/mx/{institution_id}/users/{user_id}`;
+        urlPath = urlPath.replace(`{${"institution_id"}}`, encodeURIComponent(String(requestParameters['institutionId'])));
+        urlPath = urlPath.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters['userId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * Get MX user by ID
+     */
+    async getUserRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves an MX user resource for a given institution and user ID. Used for MoneyDesktop/MX SSO integrations and returns the user profile and status.
+     * Get MX user by ID
+     */
+    async getUser(requestParameters, initOverrides) {
+        const response = await this.getUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for getWidgetUrl without sending the request
+     */
+    async getWidgetUrlRequestOpts(requestParameters) {
+        if (requestParameters['extHost'] == null) {
+            throw new runtime.RequiredError('extHost', 'Required parameter "extHost" was null or undefined when calling getWidgetUrl().');
+        }
+        if (requestParameters['institutionId'] == null) {
+            throw new runtime.RequiredError('institutionId', 'Required parameter "institutionId" was null or undefined when calling getWidgetUrl().');
+        }
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getWidgetUrl().');
+        }
+        if (requestParameters['accept'] == null) {
+            throw new runtime.RequiredError('accept', 'Required parameter "accept" was null or undefined when calling getWidgetUrl().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['extHost'] != null) {
+            headerParameters['ext_host'] = String(requestParameters['extHost']);
+        }
+        if (requestParameters['accept'] != null) {
+            headerParameters['Accept'] = String(requestParameters['accept']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/mx/{institution_id}/users/{user_id}/urls/mini_budgets_widget`;
+        urlPath = urlPath.replace(`{${"institution_id"}}`, encodeURIComponent(String(requestParameters['institutionId'])));
+        urlPath = urlPath.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters['userId'])));
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * Get MX widget URL
+     */
+    async getWidgetUrlRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.getWidgetUrlRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetWidgetUrl200ResponseFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a time-limited, single sign-on (SSO) URL to render the MX Mini Budgets widget for a specific user at a given institution. The client exchanges an access token for a short-lived, redirectable URL to embed in a webview or iFrame.
+     * Get MX widget URL
+     */
+    async getWidgetUrl(requestParameters, initOverrides) {
+        const response = await this.getWidgetUrlRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+    /**
+     * Creates request options for listUsers without sending the request
+     */
+    async listUsersRequestOpts(requestParameters) {
+        if (requestParameters['extHost'] == null) {
+            throw new runtime.RequiredError('extHost', 'Required parameter "extHost" was null or undefined when calling listUsers().');
+        }
+        if (requestParameters['accept'] == null) {
+            throw new runtime.RequiredError('accept', 'Required parameter "accept" was null or undefined when calling listUsers().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        if (requestParameters['extHost'] != null) {
+            headerParameters['ext_host'] = String(requestParameters['extHost']);
+        }
+        if (requestParameters['accept'] != null) {
+            headerParameters['Accept'] = String(requestParameters['accept']);
+        }
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        let urlPath = `/mx/users`;
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * List MX users
+     */
+    async listUsersRaw(requestParameters, initOverrides) {
+        const requestOptions = await this.listUsersRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+        return new runtime.JSONApiResponse(response, (jsonValue) => UsersListFromJSON(jsonValue));
+    }
+    /**
+     * Retrieves a paginated list of MX users. Required headers: Accept: application/vnd.mx.api.v1+json, ext_host: {{mx_host}}, Authorization: Bearer {{access_token}}, transactionid.
+     * List MX users
+     */
+    async listUsers(requestParameters, initOverrides) {
+        const response = await this.listUsersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+}