@circle-fin/circle-sdk/dist/generated/apis/channels-api.d.ts

Node.js SDK for Circle API

/**
 * 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 { ListChannelsResponse } from "../models";
/**
 * ChannelsApi - axios parameter creator
 * @export
 */
export declare const ChannelsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).
     * @summary List all channels
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChannels: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ChannelsApi - functional programming interface
 * @export
 */
export declare const ChannelsApiFp: (configuration?: Configuration) => {
    /**
     * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).
     * @summary List all channels
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChannels(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChannelsResponse>>;
};
/**
 * ChannelsApi - factory interface
 * @export
 */
export declare const ChannelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).
     * @summary List all channels
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    listChannels(options?: any): AxiosPromise<ListChannelsResponse>;
};
/**
 * ChannelsApi - object-oriented interface
 * @export
 * @class ChannelsApi
 * @extends {BaseAPI}
 */
export declare class ChannelsApi extends BaseAPI {
    /**
     * Retrieve a list of channels with details (e.g. `cardDescriptor`, `achDescriptor`, etc.).
     * @summary List all channels
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ChannelsApi
     */
    listChannels(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChannelsResponse, any>>;
}