import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import * as components from "../models/components/index.js"; import * as operations from "../models/operations/index.js"; export declare class Accounts extends ClientSDK { /** * You can create **business** or **individual** accounts for your users (i.e., customers, merchants) by passing the required * information to Moov. Requirements differ per account type and requested [capabilities](https://docs.moov.io/guides/accounts/capabilities/requirements/). * * If you're requesting the `wallet`, `send-funds`, `collect-funds`, or `card-issuing` capabilities, you'll need to: * + Send Moov the user [platform terms of service agreement](https://docs.moov.io/guides/accounts/requirements/platform-agreement/) acceptance. * This can be done upon account creation, or by [patching](https://docs.moov.io/api/moov-accounts/accounts/patch/) the account using the `termsOfService` field. * If you're creating a business account with the business type `llc`, `partnership`, or `privateCorporation`, you'll need to: * + Provide [business representatives](https://docs.moov.io/api/moov-accounts/representatives/) after creating the account. * + [Patch](https://docs.moov.io/api/moov-accounts/accounts/patch/) the account to indicate that business representative ownership information is complete. * * Visit our documentation to read more about [creating accounts](https://docs.moov.io/guides/accounts/create-accounts/) and [verification requirements](https://docs.moov.io/guides/accounts/requirements/identity-verification/). * Note that the `mode` field (for production or sandbox) is only required when creating a _facilitator_ account. All non-facilitator account requests will ignore the mode field and be set to the calling facilitator's mode. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need * to specify the `/accounts.write` scope. */ create(request: components.CreateAccount, options?: RequestOptions): Promise; /** * List or search accounts to which the caller is connected. * * All supported query parameters are optional. If none are provided the response will include all connected accounts. * Pagination is supported via the `skip` and `count` query parameters. Searching by name and email will overlap and * return results based on relevance. Accounts with AccountType `guest` will not be included in the response. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need * to specify the `/accounts.read` scope. */ list(request: operations.ListAccountsRequest, options?: RequestOptions): Promise; /** * Retrieves details for the account with the specified ID. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need * to specify the `/accounts/{accountID}/profile.read` scope. */ get(request: operations.GetAccountRequest, options?: RequestOptions): Promise; /** * When **can** profile data be updated: * + For unverified accounts, all profile data can be edited. * + During the verification process, missing or incomplete profile data can be edited. * + Verified accounts can only add missing profile data. * * When **can't** profile data be updated: * + Verified accounts cannot change any existing profile data. * * If you need to update information in a locked state, please contact Moov support. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need * to specify the `/accounts/{accountID}/profile.write` scope. */ update(request: operations.UpdateAccountRequest, options?: RequestOptions): Promise; /** * This will sever the connection between you and the account specified and it will no longer be listed as * active in the list of accounts. This also means you'll only have read-only access to the account going * forward for reporting purposes. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) * you'll need to specify the `/accounts/{accountID}/profile.disconnect` scope. */ disconnect(request: operations.DisconnectAccountRequest, options?: RequestOptions): Promise; /** * List or search accounts to which the caller is connected. * * All supported query parameters are optional. If none are provided the response will include all connected accounts. * Pagination is supported via the `skip` and `count` query parameters. Searching by name and email will overlap and * return results based on relevance. Accounts with AccountType `guest` will not be included in the response. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need * to specify the `/accounts.read` scope. */ listConnected(request: operations.ListConnectedAccountsForAccountRequest, options?: RequestOptions): Promise; /** * Shares access scopes from the account specified to the caller, establishing a connection * between the two accounts with the specified permissions. */ connect(request: operations.ConnectAccountRequest, options?: RequestOptions): Promise; /** * Retrieve the specified countries of operation for an account. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) * you'll need to specify the `/accounts/{accountID}/profile.read` scope. */ getCountries(request: operations.GetAccountCountriesRequest, options?: RequestOptions): Promise; /** * Assign the countries of operation for an account. * * This endpoint will always overwrite the previously assigned values. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) * you'll need to specify the `/accounts/{accountID}/profile.write` scope. */ assignCountries(request: operations.AssignAccountCountriesRequest, options?: RequestOptions): Promise; /** * Retrieve a merchant account's processing agreement. * * To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) * you'll need to specify the `/accounts/{accountID}/profile.read` scope. */ getMerchantProcessingAgreement(request: operations.GetMerchantProcessingAgreementRequest, options?: RequestOptions): Promise; /** * Generates a non-expiring token that can then be used to accept Moov's terms of service. * * This token can only be generated via API. Any Moov account requesting the collect funds, send funds, wallet, * or card issuing capabilities must accept Moov's terms of service, then have the generated terms of service * token patched to the account. Read more in our [documentation](https://docs.moov.io/guides/accounts/requirements/platform-agreement/). */ getTermsOfServiceToken(request: operations.GetTermsOfServiceTokenRequest, options?: RequestOptions): Promise; } //# sourceMappingURL=accounts.d.ts.map