@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 { CardCreationRequest } from "../models"; import { CardUpdate } from "../models"; import { CreateCardResponse } from "../models"; import { GetCardResponse } from "../models"; import { ListCardsResponse } from "../models"; import { UpdateCardResponse } from "../models"; /** * CardsApi - axios parameter creator * @export */ export declare const CardsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Create a card * @param {CardCreationRequest} [cardCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCard: (cardCreationRequest?: CardCreationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Get a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCard: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary List all cards * @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} */ listCards: (pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * * @summary Update a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {CardUpdate} [cardUpdate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCard: (id: string, cardUpdate?: CardUpdate, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * CardsApi - functional programming interface * @export */ export declare const CardsApiFp: (configuration?: Configuration) => { /** * * @summary Create a card * @param {CardCreationRequest} [cardCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCard(cardCreationRequest?: CardCreationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCardResponse>>; /** * * @summary Get a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCard(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCardResponse>>; /** * * @summary List all cards * @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} */ listCards(pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCardsResponse>>; /** * * @summary Update a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {CardUpdate} [cardUpdate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCard(id: string, cardUpdate?: CardUpdate, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCardResponse>>; }; /** * CardsApi - factory interface * @export */ export declare const CardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Create a card * @param {CardCreationRequest} [cardCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCard(cardCreationRequest?: CardCreationRequest, options?: any): AxiosPromise<CreateCardResponse>; /** * * @summary Get a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCard(id: string, options?: any): AxiosPromise<GetCardResponse>; /** * * @summary List all cards * @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} */ listCards(pageBefore?: string, pageAfter?: string, pageSize?: number, options?: any): AxiosPromise<ListCardsResponse>; /** * * @summary Update a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {CardUpdate} [cardUpdate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCard(id: string, cardUpdate?: CardUpdate, options?: any): AxiosPromise<UpdateCardResponse>; }; /** * CardsApi - object-oriented interface * @export * @class CardsApi * @extends {BaseAPI} */ export declare class CardsApi extends BaseAPI { /** * * @summary Create a card * @param {CardCreationRequest} [cardCreationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardsApi */ createCard(cardCreationRequest?: CardCreationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCardResponse, any>>; /** * * @summary Get a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardsApi */ getCard(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCardResponse, any>>; /** * * @summary List all cards * @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 CardsApi */ listCards(pageBefore?: string, pageAfter?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCardsResponse, any>>; /** * * @summary Update a card * @param {string} id Universally unique identifier (UUID v4) of a resource. * @param {CardUpdate} [cardUpdate] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardsApi */ updateCard(id: string, cardUpdate?: CardUpdate, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCardResponse, any>>; }