@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 { BusinessTransferCreationRequest } from "../models"; import { CreateBusinessTransferResponse } from "../models"; import { CreateTransferResponse } from "../models"; import { GetBusinessTransferResponse } from "../models"; import { GetTransferResponse } from "../models"; import { ListBusinessTransfersResponse } from "../models"; import { ListTransfersResponse } from "../models"; import { TransferCreationRequest } from "../models"; /** * TransfersApi - axios parameter creator * @export */ export declare const TransfersApiAxiosParamCreator: (configuration?: Configuration) => { /** * A transfer can be made from an existing business account to a blockchain location. * @summary Create a transfer * @param {BusinessTransferCreationRequest} [businessTransferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessTransfer: (businessTransferCreationRequest?: BusinessTransferCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * A transfer can be made from an existing funded wallet to a blockchain address or another wallet. * @summary Create a transfer * @param {TransferCreationRequest} [transferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransfer: (transferCreationRequest?: TransferCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessTransfer: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransfer: (id: string, returnIdentities?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @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} */ listBusinessTransfers: (from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Searches for transfers involving the provided wallets. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @param {string} [walletId] Unique identifier for the source or destination wallet of transfers, if any. May not be used in conjunction with destinationWalletId or sourceWalletId. Useful for fetching all transfers related to a wallet. * @param {string} [sourceWalletId] Unique identifier for the source wallet of transfers, if any. * @param {string} [destinationWalletId] Unique identifier for the destination wallet of transfers, if any. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @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} */ listTransfers: (walletId?: string, sourceWalletId?: string, destinationWalletId?: string, returnIdentities?: boolean, from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * TransfersApi - functional programming interface * @export */ export declare const TransfersApiFp: (configuration?: Configuration) => { /** * A transfer can be made from an existing business account to a blockchain location. * @summary Create a transfer * @param {BusinessTransferCreationRequest} [businessTransferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessTransfer(businessTransferCreationRequest?: BusinessTransferCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBusinessTransferResponse>>; /** * A transfer can be made from an existing funded wallet to a blockchain address or another wallet. * @summary Create a transfer * @param {TransferCreationRequest} [transferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransfer(transferCreationRequest?: TransferCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTransferResponse>>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessTransfer(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBusinessTransferResponse>>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransfer(id: string, returnIdentities?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTransferResponse>>; /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @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} */ listBusinessTransfers(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBusinessTransfersResponse>>; /** * Searches for transfers involving the provided wallets. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @param {string} [walletId] Unique identifier for the source or destination wallet of transfers, if any. May not be used in conjunction with destinationWalletId or sourceWalletId. Useful for fetching all transfers related to a wallet. * @param {string} [sourceWalletId] Unique identifier for the source wallet of transfers, if any. * @param {string} [destinationWalletId] Unique identifier for the destination wallet of transfers, if any. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @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} */ listTransfers(walletId?: string, sourceWalletId?: string, destinationWalletId?: string, returnIdentities?: boolean, from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransfersResponse>>; }; /** * TransfersApi - factory interface * @export */ export declare const TransfersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * A transfer can be made from an existing business account to a blockchain location. * @summary Create a transfer * @param {BusinessTransferCreationRequest} [businessTransferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBusinessTransfer(businessTransferCreationRequest?: BusinessTransferCreationRequest, options?: any): AxiosPromise<CreateBusinessTransferResponse>; /** * A transfer can be made from an existing funded wallet to a blockchain address or another wallet. * @summary Create a transfer * @param {TransferCreationRequest} [transferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransfer(transferCreationRequest?: TransferCreationRequest, options?: any): AxiosPromise<CreateTransferResponse>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getBusinessTransfer(id: string, options?: any): AxiosPromise<GetBusinessTransferResponse>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransfer(id: string, returnIdentities?: boolean, options?: any): AxiosPromise<GetTransferResponse>; /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @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} */ listBusinessTransfers(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: any): AxiosPromise<ListBusinessTransfersResponse>; /** * Searches for transfers involving the provided wallets. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @param {string} [walletId] Unique identifier for the source or destination wallet of transfers, if any. May not be used in conjunction with destinationWalletId or sourceWalletId. Useful for fetching all transfers related to a wallet. * @param {string} [sourceWalletId] Unique identifier for the source wallet of transfers, if any. * @param {string} [destinationWalletId] Unique identifier for the destination wallet of transfers, if any. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @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} */ listTransfers(walletId?: string, sourceWalletId?: string, destinationWalletId?: string, returnIdentities?: boolean, from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: any): AxiosPromise<ListTransfersResponse>; }; /** * TransfersApi - object-oriented interface * @export * @class TransfersApi * @extends {BaseAPI} */ export declare class TransfersApi extends BaseAPI { /** * A transfer can be made from an existing business account to a blockchain location. * @summary Create a transfer * @param {BusinessTransferCreationRequest} [businessTransferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransfersApi */ createBusinessTransfer(businessTransferCreationRequest?: BusinessTransferCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBusinessTransferResponse, any>>; /** * A transfer can be made from an existing funded wallet to a blockchain address or another wallet. * @summary Create a transfer * @param {TransferCreationRequest} [transferCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransfersApi */ createTransfer(transferCreationRequest?: TransferCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTransferResponse, any>>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransfersApi */ getBusinessTransfer(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBusinessTransferResponse, any>>; /** * * @summary Get a transfer * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TransfersApi */ getTransfer(id: string, returnIdentities?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTransferResponse, any>>; /** * Searches for transfers from your business account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @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 TransfersApi */ listBusinessTransfers(from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBusinessTransfersResponse, any>>; /** * Searches for transfers involving the provided wallets. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. * @summary List all transfers * @param {string} [walletId] Unique identifier for the source or destination wallet of transfers, if any. May not be used in conjunction with destinationWalletId or sourceWalletId. Useful for fetching all transfers related to a wallet. * @param {string} [sourceWalletId] Unique identifier for the source wallet of transfers, if any. * @param {string} [destinationWalletId] Unique identifier for the destination wallet of transfers, if any. * @param {boolean} [returnIdentities] Specify if you would like to see identities in the response. Restricts maximum returned items to 5. By default returnIdentities is false, resulting in the response not returning `data.source.identities`. * @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 TransfersApi */ listTransfers(walletId?: string, sourceWalletId?: string, destinationWalletId?: string, returnIdentities?: boolean, from?: string, to?: string, pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransfersResponse, any>>; }