UNPKG

mx-platform-node

Version:

A Node library for the MX Platform API.

2,454 lines (2,451 loc) 945 kB
/* tslint:disable */ /* eslint-disable */ /** * MX Platform API * The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. * * The version of the OpenAPI document: 0.1.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 type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base'; /** * * @export * @interface AccountCreateRequest */ export interface AccountCreateRequest { /** * * @type {string} * @memberof AccountCreateRequest */ 'account_subtype'?: string; /** * * @type {string} * @memberof AccountCreateRequest */ 'account_type': string; /** * * @type {number} * @memberof AccountCreateRequest */ 'apr'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'apy'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'available_balance'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'balance'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'cash_surrender_value'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'credit_limit'?: number; /** * * @type {string} * @memberof AccountCreateRequest */ 'currency_code'?: string; /** * * @type {number} * @memberof AccountCreateRequest */ 'death_benefit'?: number; /** * * @type {number} * @memberof AccountCreateRequest */ 'interest_rate'?: number; /** * * @type {boolean} * @memberof AccountCreateRequest */ 'is_business'?: boolean; /** * * @type {boolean} * @memberof AccountCreateRequest */ 'is_closed'?: boolean; /** * * @type {boolean} * @memberof AccountCreateRequest */ 'is_hidden'?: boolean; /** * * @type {number} * @memberof AccountCreateRequest */ 'loan_amount'?: number; /** * * @type {string} * @memberof AccountCreateRequest */ 'metadata'?: string; /** * * @type {string} * @memberof AccountCreateRequest */ 'name': string; /** * * @type {string} * @memberof AccountCreateRequest */ 'nickname'?: string; /** * * @type {number} * @memberof AccountCreateRequest */ 'original_balance'?: number; /** * * @type {string} * @memberof AccountCreateRequest */ 'property_type'?: string; /** * * @type {boolean} * @memberof AccountCreateRequest */ 'skip_webhook'?: boolean; } /** * * @export * @interface AccountCreateRequestBody */ export interface AccountCreateRequestBody { /** * * @type {AccountCreateRequest} * @memberof AccountCreateRequestBody */ 'account'?: AccountCreateRequest; } /** * * @export * @interface AccountNumberResponse */ export interface AccountNumberResponse { /** * * @type {string} * @memberof AccountNumberResponse */ 'account_guid'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'account_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'guid'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'loan_guarantor'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'loan_reference_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'institution_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'member_guid'?: string | null; /** * * @type {boolean} * @memberof AccountNumberResponse */ 'passed_validation'?: boolean | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'routing_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'sequence_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'transit_number'?: string | null; /** * * @type {string} * @memberof AccountNumberResponse */ 'user_guid'?: string | null; } /** * * @export * @interface AccountNumbersResponseBody */ export interface AccountNumbersResponseBody { /** * * @type {Array<AccountNumberResponse>} * @memberof AccountNumbersResponseBody */ 'account_numbers'?: Array<AccountNumberResponse>; /** * * @type {PaginationResponse} * @memberof AccountNumbersResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface AccountOwnerResponse */ export interface AccountOwnerResponse { /** * * @type {string} * @memberof AccountOwnerResponse */ 'account_guid'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'address'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'city'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'country'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'email'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'first_name'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'guid'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'last_name'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'member_guid'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'owner_name'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'phone'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'postal_code'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'state'?: string | null; /** * * @type {string} * @memberof AccountOwnerResponse */ 'user_guid'?: string | null; } /** * * @export * @interface AccountOwnersResponseBody */ export interface AccountOwnersResponseBody { /** * * @type {Array<AccountOwnerResponse>} * @memberof AccountOwnersResponseBody */ 'account_owners'?: Array<AccountOwnerResponse>; /** * * @type {PaginationResponse} * @memberof AccountOwnersResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface AccountResponse */ export interface AccountResponse { /** * * @type {string} * @memberof AccountResponse */ 'account_number'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'account_number_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'account_ownership'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'annuity_policy_to_date'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'annuity_provider'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'annuity_term_year'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'apr'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'apr_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'apy'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'apy_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'available_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'available_balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'available_credit'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'available_credit_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'calculated_apr'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'cash_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'cash_balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'cash_surrender_value'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'cash_surrender_value_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'created_at'?: string; /** * * @type {number} * @memberof AccountResponse */ 'credit_limit'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'credit_limit_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'currency_code'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'currency_code_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'day_payment_is_due'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'day_payment_is_due_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'death_benefit'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'death_benefit_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'federal_insurance_status'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_account_number'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_account_subtype'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_account_type'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_apr'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_apy'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_available_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_cash_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_cash_surrender_value'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_credit_limit'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_currency_code'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_day_payment_is_due'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_death_benefit'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_holdings_value'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_interest_rate'?: number | null; /** * * @type {boolean} * @memberof AccountResponse */ 'feed_is_closed'?: boolean | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_last_payment'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_last_payment_at'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_loan_amount'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_matures_on'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_minimum_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_minimum_payment'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_name'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_nickname'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_original_balance'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_payment_due_at'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_payoff_balance'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_routing_number'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'feed_started_on'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_statement_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'feed_total_account_value'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'guid'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'holdings_value'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'holdings_value_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'id'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'imported_at'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'institution_code'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'institution_guid'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'insured_name'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'interest_rate'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'interest_rate_set_by'?: number | null; /** * * @type {boolean} * @memberof AccountResponse */ 'is_closed'?: boolean | null; /** * * @type {number} * @memberof AccountResponse */ 'is_closed_set_by'?: number | null; /** * * @type {boolean} * @memberof AccountResponse */ 'is_hidden'?: boolean | null; /** * * @type {boolean} * @memberof AccountResponse */ 'is_manual'?: boolean | null; /** * * @type {number} * @memberof AccountResponse */ 'last_payment'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'last_payment_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'last_payment_at'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'last_payment_at_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'loan_amount'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'loan_amount_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'margin_balance'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'matures_on'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'matures_on_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'member_guid'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'member_id'?: string | null; /** * * @type {boolean} * @memberof AccountResponse */ 'member_is_managed_by_user'?: boolean | null; /** * * @type {string} * @memberof AccountResponse */ 'metadata'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'minimum_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'minimum_balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'minimum_payment'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'minimum_payment_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'name'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'name_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'nickname'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'nickname_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'original_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'original_balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'pay_out_amount'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'payment_due_at'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'payment_due_at_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'payoff_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'payoff_balance_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'premium_amount'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'property_type'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'routing_number'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'started_on'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'started_on_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'statement_balance'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'statement_balance_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'subtype'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'subtype_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'today_ugl_amount'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'today_ugl_percentage'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'total_account_value'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'total_account_value_set_by'?: number | null; /** * * @type {number} * @memberof AccountResponse */ 'total_account_value_ugl'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'type'?: string | null; /** * * @type {number} * @memberof AccountResponse */ 'type_set_by'?: number | null; /** * * @type {string} * @memberof AccountResponse */ 'updated_at'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'user_guid'?: string | null; /** * * @type {string} * @memberof AccountResponse */ 'user_id'?: string | null; } /** * * @export * @interface AccountResponseBody */ export interface AccountResponseBody { /** * * @type {AccountResponse} * @memberof AccountResponseBody */ 'account'?: AccountResponse; } /** * * @export * @interface AccountUpdateRequest */ export interface AccountUpdateRequest { /** * * @type {string} * @memberof AccountUpdateRequest */ 'account_subtype'?: string; /** * * @type {string} * @memberof AccountUpdateRequest */ 'account_type'?: string; /** * * @type {number} * @memberof AccountUpdateRequest */ 'apr'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'apy'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'available_balance'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'balance'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'cash_surrender_value'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'credit_limit'?: number; /** * * @type {string} * @memberof AccountUpdateRequest */ 'currency_code'?: string; /** * * @type {number} * @memberof AccountUpdateRequest */ 'death_benefit'?: number; /** * * @type {number} * @memberof AccountUpdateRequest */ 'interest_rate'?: number; /** * * @type {boolean} * @memberof AccountUpdateRequest */ 'is_business'?: boolean; /** * * @type {boolean} * @memberof AccountUpdateRequest */ 'is_closed'?: boolean; /** * * @type {boolean} * @memberof AccountUpdateRequest */ 'is_hidden'?: boolean; /** * * @type {number} * @memberof AccountUpdateRequest */ 'loan_amount'?: number; /** * * @type {string} * @memberof AccountUpdateRequest */ 'metadata'?: string; /** * * @type {string} * @memberof AccountUpdateRequest */ 'name'?: string; /** * * @type {string} * @memberof AccountUpdateRequest */ 'nickname'?: string; /** * * @type {number} * @memberof AccountUpdateRequest */ 'original_balance'?: number; /** * * @type {string} * @memberof AccountUpdateRequest */ 'property_type'?: string; /** * * @type {boolean} * @memberof AccountUpdateRequest */ 'skip_webhook'?: boolean; } /** * * @export * @interface AccountUpdateRequestBody */ export interface AccountUpdateRequestBody { /** * * @type {AccountUpdateRequest} * @memberof AccountUpdateRequestBody */ 'account'?: AccountUpdateRequest; } /** * * @export * @interface AccountsResponseBody */ export interface AccountsResponseBody { /** * * @type {Array<AccountResponse>} * @memberof AccountsResponseBody */ 'accounts'?: Array<AccountResponse>; /** * * @type {PaginationResponse} * @memberof AccountsResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface AuthorizationCodeRequest */ export interface AuthorizationCodeRequest { /** * * @type {string} * @memberof AuthorizationCodeRequest */ 'scope'?: string | null; } /** * * @export * @interface AuthorizationCodeRequestBody */ export interface AuthorizationCodeRequestBody { /** * * @type {AuthorizationCodeRequest} * @memberof AuthorizationCodeRequestBody */ 'authorization_code'?: AuthorizationCodeRequest; } /** * * @export * @interface AuthorizationCodeResponse */ export interface AuthorizationCodeResponse { /** * * @type {string} * @memberof AuthorizationCodeResponse */ 'code'?: string | null; } /** * * @export * @interface AuthorizationCodeResponseBody */ export interface AuthorizationCodeResponseBody { /** * * @type {Array<AuthorizationCodeResponse>} * @memberof AuthorizationCodeResponseBody */ 'authorization_code'?: Array<AuthorizationCodeResponse>; } /** * * @export * @interface BudgetCreateRequest */ export interface BudgetCreateRequest { /** * Unique identifier of the category. * @type {string} * @memberof BudgetCreateRequest */ 'category_guid': string; /** * Unique identifier of the parent budget. This is only required when creating a budget on a sub-category. * @type {string} * @memberof BudgetCreateRequest */ 'parent_guid': string; /** * Amount of the budget. * @type {number} * @memberof BudgetCreateRequest */ 'amount'?: number; /** * Additional information a partner can store on the budget. * @type {string} * @memberof BudgetCreateRequest */ 'metadata'?: string; /** * When set to true, this parameter will prevent a webhook from being triggered by the request. * @type {boolean} * @memberof BudgetCreateRequest */ 'skip_webhook'?: boolean; } /** * * @export * @interface BudgetCreateRequestBody */ export interface BudgetCreateRequestBody { /** * * @type {BudgetCreateRequest} * @memberof BudgetCreateRequestBody */ 'budget'?: BudgetCreateRequest; } /** * * @export * @interface BudgetResponse */ export interface BudgetResponse { /** * A goal amount set by the user for a category\'s transaction total during a month. * @type {number} * @memberof BudgetResponse */ 'amount'?: number; /** * Unique identifier for the budget category. Defined by MX. * @type {string} * @memberof BudgetResponse */ 'category_guid'?: string; /** * Date and time the budget was created, represented in ISO 8601 format with timestamp. * @type {string} * @memberof BudgetResponse */ 'created_at'?: string; /** * Unique identifier for the budget. Defined by MX. * @type {string} * @memberof BudgetResponse */ 'guid'?: string; /** * If the budget has been exceeded, this field will be true. Otherwise, this field will be false. * @type {boolean} * @memberof BudgetResponse */ 'is_exceeded'?: boolean; /** * If the budget is off track, this field will be true. Otherwise, this field will be false. * @type {boolean} * @memberof BudgetResponse */ 'is_off_track'?: boolean; /** * Additional information a partner can store on the budget. * @type {string} * @memberof BudgetResponse */ 'metadata'?: string | null; /** * The name of the budget that is visible to the user (ie \"Food\", \"Bills\", \"Entertainment\", etc). * @type {string} * @memberof BudgetResponse */ 'name'?: string | null; /** * The percentage amount of off track spending. (Deprecated). * @type {number} * @memberof BudgetResponse */ 'off_track_percentage'?: number | null; /** * Unique identifier for the parent budget. Defined by MX. * @type {string} * @memberof BudgetResponse */ 'parent_guid'?: string | null; /** * The percentage of a budget that has been spent during the current calendar month Calculated as the transaction total divided by the amount and then multiplied by 100.A value of zero will be returned when `amount` is zero. * @type {number} * @memberof BudgetResponse */ 'percent_spent'?: number | null; /** * The projected amount of spending for the budget. * @type {number} * @memberof BudgetResponse */ 'projected_spending'?: number; /** * The revision number of this budget record. * @type {number} * @memberof BudgetResponse */ 'revision'?: number; /** * The cumulative amount of all transactions under the budget. * @type {any} * @memberof BudgetResponse */ 'transaction_total'?: any; /** * Date and time the budget was updated, represented in ISO 8601 format with timestamp. * @type {any} * @memberof BudgetResponse */ 'updated_at'?: any; /** * Unique identifier for the user. Defined by MX. * @type {any} * @memberof BudgetResponse */ 'user_guid'?: any; } /** * * @export * @interface BudgetResponseBody */ export interface BudgetResponseBody { /** * * @type {BudgetResponse} * @memberof BudgetResponseBody */ 'budget'?: BudgetResponse; } /** * * @export * @interface BudgetUpdateRequest */ export interface BudgetUpdateRequest { /** * Amount of the budget. * @type {number} * @memberof BudgetUpdateRequest */ 'amount'?: number; /** * Additional information a partner can store on the budget. * @type {string} * @memberof BudgetUpdateRequest */ 'metadata'?: string; /** * When set to true, this parameter will prevent a webhook from being triggered by the request. * @type {boolean} * @memberof BudgetUpdateRequest */ 'skip_webhook'?: boolean; } /** * * @export * @interface BudgetUpdateRequestBody */ export interface BudgetUpdateRequestBody { /** * * @type {BudgetUpdateRequest} * @memberof BudgetUpdateRequestBody */ 'budget'?: BudgetUpdateRequest; } /** * * @export * @interface CategoriesResponseBody */ export interface CategoriesResponseBody { /** * * @type {Array<CategoryResponse>} * @memberof CategoriesResponseBody */ 'categories'?: Array<CategoryResponse>; /** * * @type {PaginationResponse} * @memberof CategoriesResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface CategoryCreateRequest */ export interface CategoryCreateRequest { /** * * @type {string} * @memberof CategoryCreateRequest */ 'metadata'?: string; /** * * @type {string} * @memberof CategoryCreateRequest */ 'name': string; /** * * @type {string} * @memberof CategoryCreateRequest */ 'parent_guid'?: string; } /** * * @export * @interface CategoryCreateRequestBody */ export interface CategoryCreateRequestBody { /** * * @type {CategoryCreateRequest} * @memberof CategoryCreateRequestBody */ 'category'?: CategoryCreateRequest; } /** * * @export * @interface CategoryResponse */ export interface CategoryResponse { /** * * @type {string} * @memberof CategoryResponse */ 'created_at'?: string | null; /** * * @type {string} * @memberof CategoryResponse */ 'guid'?: string | null; /** * * @type {boolean} * @memberof CategoryResponse */ 'is_default'?: boolean | null; /** * * @type {boolean} * @memberof CategoryResponse */ 'is_income'?: boolean | null; /** * * @type {string} * @memberof CategoryResponse */ 'metadata'?: string | null; /** * * @type {string} * @memberof CategoryResponse */ 'name'?: string | null; /** * * @type {string} * @memberof CategoryResponse */ 'parent_guid'?: string | null; /** * * @type {string} * @memberof CategoryResponse */ 'updated_at'?: string | null; } /** * * @export * @interface CategoryResponseBody */ export interface CategoryResponseBody { /** * * @type {CategoryResponse} * @memberof CategoryResponseBody */ 'category'?: CategoryResponse; } /** * * @export * @interface CategoryUpdateRequest */ export interface CategoryUpdateRequest { /** * * @type {string} * @memberof CategoryUpdateRequest */ 'metadata'?: string; /** * * @type {string} * @memberof CategoryUpdateRequest */ 'name'?: string; } /** * * @export * @interface CategoryUpdateRequestBody */ export interface CategoryUpdateRequestBody { /** * * @type {CategoryUpdateRequest} * @memberof CategoryUpdateRequestBody */ 'category'?: CategoryUpdateRequest; } /** * * @export * @interface ChallengeResponse */ export interface ChallengeResponse { /** * * @type {string} * @memberof ChallengeResponse */ 'field_name'?: string | null; /** * * @type {string} * @memberof ChallengeResponse */ 'guid'?: string | null; /** * * @type {string} * @memberof ChallengeResponse */ 'image_data'?: string | null; /** * * @type {Array<ImageOptionResponse>} * @memberof ChallengeResponse */ 'image_options'?: Array<ImageOptionResponse>; /** * * @type {string} * @memberof ChallengeResponse */ 'label'?: string | null; /** * * @type {Array<OptionResponse>} * @memberof ChallengeResponse */ 'options'?: Array<OptionResponse>; /** * * @type {string} * @memberof ChallengeResponse */ 'type'?: string | null; } /** * * @export * @interface ChallengesResponseBody */ export interface ChallengesResponseBody { /** * * @type {Array<ChallengeResponse>} * @memberof ChallengesResponseBody */ 'challenges'?: Array<ChallengeResponse>; /** * * @type {PaginationResponse} * @memberof ChallengesResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface ConnectWidgetRequest */ export interface ConnectWidgetRequest { /** * * @type {string} * @memberof ConnectWidgetRequest */ 'client_redirect_url'?: string; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'color_scheme'?: string; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'current_institution_code'?: string; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'current_member_guid'?: string; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'disable_background_agg'?: boolean; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'disable_institution_search'?: boolean; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'include_identity'?: boolean; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'include_transactions'?: boolean; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'is_mobile_webview'?: boolean; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'mode'?: string; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'oauth_referral_source'?: string; /** * * @type {number} * @memberof ConnectWidgetRequest */ 'ui_message_version'?: number; /** * * @type {string} * @memberof ConnectWidgetRequest */ 'ui_message_webview_url_scheme'?: string; /** * * @type {boolean} * @memberof ConnectWidgetRequest */ 'update_credentials'?: boolean; } /** * * @export * @interface ConnectWidgetRequestBody */ export interface ConnectWidgetRequestBody { /** * * @type {ConnectWidgetRequest} * @memberof ConnectWidgetRequestBody */ 'config'?: ConnectWidgetRequest; } /** * * @export * @interface ConnectWidgetResponse */ export interface ConnectWidgetResponse { /** * * @type {string} * @memberof ConnectWidgetResponse */ 'connect_widget_url'?: string | null; /** * * @type {string} * @memberof ConnectWidgetResponse */ 'guid'?: string | null; } /** * * @export * @interface ConnectWidgetResponseBody */ export interface ConnectWidgetResponseBody { /** * * @type {ConnectWidgetResponse} * @memberof ConnectWidgetResponseBody */ 'user'?: ConnectWidgetResponse; } /** * * @export * @interface CredentialRequest */ export interface CredentialRequest { /** * * @type {string} * @memberof CredentialRequest */ 'guid'?: string; /** * * @type {string} * @memberof CredentialRequest */ 'value'?: string; } /** * * @export * @interface CredentialResponse */ export interface CredentialResponse { /** * * @type {number} * @memberof CredentialResponse */ 'display_order'?: number | null; /** * * @type {string} * @memberof CredentialResponse */ 'field_name'?: string | null; /** * * @type {string} * @memberof CredentialResponse */ 'field_type'?: string | null; /** * * @type {string} * @memberof CredentialResponse */ 'guid'?: string | null; /** * * @type {string} * @memberof CredentialResponse */ 'label'?: string | null; /** * * @type {string} * @memberof CredentialResponse */ 'type'?: string | null; } /** * * @export * @interface CredentialsResponseBody */ export interface CredentialsResponseBody { /** * * @type {Array<CredentialResponse>} * @memberof CredentialsResponseBody */ 'credentials'?: Array<CredentialResponse>; /** * * @type {PaginationResponse} * @memberof CredentialsResponseBody */ 'pagination'?: PaginationResponse; } /** * * @export * @interface CreditCardProduct */ export interface CreditCardProduct { /** * * @type {number} * @memberof CreditCardProduct */ 'annual_fee'?: number; /** * * @type {number} * @memberof CreditCardProduct */ 'duration_of_introductory_rate_on_balance_transfer'?: number; /** * * @type {number} * @memberof CreditCardProduct */ 'duration_of_introductory_rate_on_purchases'?: number; /** * * @type {string} * @memberof CreditCardProduct */ 'guid'?: string; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_cashback_rewards'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_other_rewards'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_travel_rewards'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_zero_introductory_annual_fee'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_zero_percent_introductory_rate'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'has_zero_percent_introductory_rate_on_balance_transfer'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'is_accepting_applicants'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'is_active_credit_card_product'?: boolean; /** * * @type {boolean} * @memberof CreditCardProduct */ 'is_small_business_card'?: boolean; /** * * @type {string} * @memberof CreditCardProduct */ 'name'?: string; } /** * * @export * @interface CreditCardProductResponse */ export interface CreditCardProductResponse { /** * * @type {CreditCardProduct} * @memberof CreditCardProductResponse */ 'credit_card_product'?: CreditCardProduct; } /** * * @export * @interface EnhanceTransactionResponse */ export interface EnhanceTransactionResponse { /** * * @type {number} * @memberof EnhanceTransactionResponse */ 'amount'?: number | null; /** * * @type {number} * @memberof EnhanceTransactionResponse */ 'categorized_by'?: number | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'category'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'category_guid'?: string | null; /** * * @type {number} * @memberof EnhanceTransactionResponse */ 'described_by'?: number | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'description'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'extended_transaction_type'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'id'?: string | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_bill_pay'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_direct_deposit'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_expense'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_fee'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_income'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_international'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_overdraft_fee'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_payroll_advance'?: boolean | null; /** * * @type {boolean} * @memberof EnhanceTransactionResponse */ 'is_subscription'?: boolean | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'memo'?: string | null; /** * * @type {number} * @memberof EnhanceTransactionResponse */ 'merchant_category_code'?: number | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'merchant_guid'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'merchant_location_guid'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'original_description'?: string | null; /** * * @type {string} * @memberof EnhanceTransactionResponse */ 'type'?: string | null; } /** * * @export * @interface EnhanceTransactionsRequest */ export interface EnhanceTransactionsRequest { /** * * @type {number} * @memberof EnhanceTransactionsRequest */ 'amount'?: number; /** * * @type {string} * @memberof EnhanceTransactionsRequest */ 'description': string; /** * * @type {string} * @memberof EnhanceTransactionsRequest */ 'extended_transaction_type'?: string; /** * * @type {string} * @memberof EnhanceTransactionsRequest */ 'id': string; /** * * @type {string} * @memberof EnhanceTransactionsRequest */ 'memo'?: string; /** * * @type {number} * @memberof EnhanceTransactionsRequest */ 'merchant_category_code'?: number; /** * * @type {string} * @memberof EnhanceTransactionsRequest */ 'type'?: string; } /** * * @export * @interface EnhanceTransactionsRequestBody */ export interface EnhanceTransactionsRequestBody { /** * * @type {Array<EnhanceTransactionsRequest>} * @memberof EnhanceTransactionsRequestBody */ 'transactions'?: Array<EnhanceTransactionsRequest>; } /** * * @export * @interface EnhanceTransactionsResponseBody */ export interface EnhanceTransactionsResponseBody { /** * * @type {Array<EnhanceTransactionResponse>} * @memberof EnhanceTransactionsResponseBody */ 'transactions'?: Array<EnhanceTransactionResponse>; } /** * * @export * @interface GoalRequest */ export interface GoalRequest { /** * Unique identifier of the account for the goal. * @type {string} * @memberof GoalRequest */ 'account_guid': string; /** * Amount of the goal. * @type {number} * @memberof GoalRequest */ 'amount': number; /** * The goal type. * @type {string} * @memberof GoalRequest */ 'goal_type_name': string; /** * The category of the goal. * @type {string} * @memberof GoalRequest */ 'meta_type_name': string; /** * The name of the goal. * @type {string} * @memberof GoalRequest */ 'name': string; /** * Date and time the goal was completed. * @type {string} * @memberof GoalRequest */ 'completed_at'?: string; /** * Determines if the goal has been spent. * @type {boolean} * @memberof GoalRequest */ 'has_been_spent'?: boolean; /** * Determines if the goal is complete. * @type {boolean} * @memberof GoalRequest */ 'is_complete'?: boolean; /** * Additional information a partner can store on the goal. * @type {string} * @memberof GoalRequest */ 'metadata'?: string; /** * The priority of the goal in relation to multiple goals. * @type {number} * @memberof GoalRequest */ 'position'?: number; /** * Date and time the goal is to complete. Intended for users to set their own goal completion dates. * @type {string} * @memberof GoalRequest */ 'targeted_to_complete_at'?: string; } /** * * @export * @interface GoalRequestBody */ export interface GoalRequestBody { /** * * @type {GoalRequest} * @memberof GoalRequestBody */ 'goal'?: GoalRequest; } /** * * @export * @interface GoalResponse */ export interface GoalResponse { /** * Unique identifier of the account for the goal. * @type {string} * @memberof GoalResponse */ 'account_guid'?: string; /** * Amount of the goal. * @type {number} * @memberof GoalResponse */ 'amount'?: number; /** * Date and time the goal was completed. * @type {string} * @memberof GoalResponse */ 'completed_at'?: string; /** * The current amount of the goal. * @type {number} * @memberof GoalResponse */ 'current_amount'?: number; /** * The goal type. * @type {string} * @memberof GoalResponse */ 'goal_type_name'?: string; /** * Unique identifier for the goal. Defined by MX. * @type {string} * @memberof GoalResponse */ 'guid'?: string; /** * Determines if the go