@circle-fin/circle-sdk

/** * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios"; import { Configuration } from "../configuration"; import { RequestArgs, BaseAPI } from "../base"; import { BusinessGenerateAddressRequest } from "../models"; import { BusinessRecipientAddressCreationRequest } from "../models"; import { CreateBusinessDepositAddressResponse } from "../models"; import { CreateBusinessRecipientAddressResponse } from "../models"; import { GetBusinessDepositAddressResponse } from "../models"; import { ListBusinessRecipientAddressesResponse } from "../models"; /** * AddressesApi - axios parameter creator * @export */ export declare const AddressesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessDepositAddress: (businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a recipient address * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessRecipientAddress: (businessRecipientAddressCreationRequest?: BusinessRecipientAddressCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBusinessRecipientAddress: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary List all deposit addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessDepositAddress: (options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBusinessRecipientAddresses: (from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * AddressesApi - functional programming interface * @export */ export declare const AddressesApiFp: (configuration?: Configuration) => { /** * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessDepositAddress(businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBusinessDepositAddressResponse>>; /** * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a recipient address * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessRecipientAddress(businessRecipientAddressCreationRequest?: BusinessRecipientAddressCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBusinessRecipientAddressResponse>>; /** * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBusinessRecipientAddress(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>; /** * * @summary List all deposit addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessDepositAddress(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBusinessDepositAddressResponse>>; /** * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBusinessRecipientAddresses(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBusinessRecipientAddressesResponse>>; }; /** * AddressesApi - factory interface * @export */ export declare const AddressesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessDepositAddress(businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: any): AxiosPromise<CreateBusinessDepositAddressResponse>; /** * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a recipient address * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessRecipientAddress(businessRecipientAddressCreationRequest?: BusinessRecipientAddressCreationRequest, options?: any): AxiosPromise<CreateBusinessRecipientAddressResponse>; /** * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteBusinessRecipientAddress(id: string, options?: any): AxiosPromise<void>; /** * * @summary List all deposit addresses * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessDepositAddress(options?: any): AxiosPromise<GetBusinessDepositAddressResponse>; /** * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBusinessRecipientAddresses(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: any): AxiosPromise<ListBusinessRecipientAddressesResponse>; }; /** * AddressesApi - object-oriented interface * @export * @class AddressesApi * @extends {BaseAPI} */ export declare class AddressesApi extends BaseAPI { /** * Generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you\'re requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a deposit address * @param {BusinessGenerateAddressRequest} [businessGenerateAddressRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ createBusinessDepositAddress(businessGenerateAddressRequest?: BusinessGenerateAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBusinessDepositAddressResponse, any>>; /** * Stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. Note: Circle Mint Singapore customers must verify all transfer recipients using the UI in the Circle Console, as transfers from unverified addresses will be held in `pending` status. * @summary Create a recipient address * @param {BusinessRecipientAddressCreationRequest} [businessRecipientAddressCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ createBusinessRecipientAddress(businessRecipientAddressCreationRequest?: BusinessRecipientAddressCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBusinessRecipientAddressResponse, any>>; /** * Deletes an external blockchain address. The recipient address must be in an \'active\' or \'pending\' state in order to be deleted successfully. * @summary Delete a recipient address * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ deleteBusinessRecipientAddress(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>; /** * * @summary List all deposit addresses * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ getBusinessDepositAddress(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBusinessDepositAddressResponse, any>>; /** * Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response. * @summary List all recipient addresses * @param {string} [from] Queries items created since the specified date-time (inclusive). * @param {string} [to] Queries items created before the specified date-time (inclusive). * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AddressesApi */ listBusinessRecipientAddresses(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBusinessRecipientAddressesResponse, any>>; }