@standard-crypto/farcaster-js-warpcast/dist/esm/openapi/generated/apis/direct-casts-api.d.ts

A tool for interacting with the private APIs of the Warpcast client.

/**
 * Warpcast API
 * Private API used by the Warpcast client
 *
 * The version of the OpenAPI document: 1.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from '../configuration.js';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { RequestArgs, BaseAPI } from '../base.js';
import { V2DirectCastConversationDetailsGet200Response } from '../models/index.js';
import { V2DirectCastConversationGet200Response } from '../models/index.js';
import { V2DirectCastConversationListGet200Response } from '../models/index.js';
/**
 * DirectCastsApi - axios parameter creator
 * @export
 */
export declare const DirectCastsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @param {string} conversationId
     * @param {number} [limit] Maximum number of items to return in a single response
     * @param {string} [cursor] Cursor to paginate through results
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationDetailsGet: (conversationId: string, limit?: number, cursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {string} conversationId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationGet: (conversationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} [limit] Maximum number of items to return in a single response
     * @param {string} [cursor] Cursor to paginate through results
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationListGet: (limit?: number, cursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DirectCastsApi - functional programming interface
 * @export
 */
export declare const DirectCastsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @param {string} conversationId
     * @param {number} [limit] Maximum number of items to return in a single response
     * @param {string} [cursor] Cursor to paginate through results
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationDetailsGet(conversationId: string, limit?: number, cursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2DirectCastConversationDetailsGet200Response>>;
    /**
     *
     * @param {string} conversationId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationGet(conversationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2DirectCastConversationGet200Response>>;
    /**
     *
     * @param {number} [limit] Maximum number of items to return in a single response
     * @param {string} [cursor] Cursor to paginate through results
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationListGet(limit?: number, cursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2DirectCastConversationListGet200Response>>;
};
/**
 * DirectCastsApi - factory interface
 * @export
 */
export declare const DirectCastsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationDetailsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationDetailsGet(requestParameters: DirectCastsApiV2DirectCastConversationDetailsGetRequest, options?: AxiosRequestConfig): AxiosPromise<V2DirectCastConversationDetailsGet200Response>;
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationGet(requestParameters: DirectCastsApiV2DirectCastConversationGetRequest, options?: AxiosRequestConfig): AxiosPromise<V2DirectCastConversationGet200Response>;
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationListGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2DirectCastConversationListGet(requestParameters?: DirectCastsApiV2DirectCastConversationListGetRequest, options?: AxiosRequestConfig): AxiosPromise<V2DirectCastConversationListGet200Response>;
};
/**
 * Request parameters for v2DirectCastConversationDetailsGet operation in DirectCastsApi.
 * @export
 * @interface DirectCastsApiV2DirectCastConversationDetailsGetRequest
 */
export interface DirectCastsApiV2DirectCastConversationDetailsGetRequest {
    /**
     *
     * @type {string}
     * @memberof DirectCastsApiV2DirectCastConversationDetailsGet
     */
    readonly conversationId: string;
    /**
     * Maximum number of items to return in a single response
     * @type {number}
     * @memberof DirectCastsApiV2DirectCastConversationDetailsGet
     */
    readonly limit?: number;
    /**
     * Cursor to paginate through results
     * @type {string}
     * @memberof DirectCastsApiV2DirectCastConversationDetailsGet
     */
    readonly cursor?: string;
}
/**
 * Request parameters for v2DirectCastConversationGet operation in DirectCastsApi.
 * @export
 * @interface DirectCastsApiV2DirectCastConversationGetRequest
 */
export interface DirectCastsApiV2DirectCastConversationGetRequest {
    /**
     *
     * @type {string}
     * @memberof DirectCastsApiV2DirectCastConversationGet
     */
    readonly conversationId: string;
}
/**
 * Request parameters for v2DirectCastConversationListGet operation in DirectCastsApi.
 * @export
 * @interface DirectCastsApiV2DirectCastConversationListGetRequest
 */
export interface DirectCastsApiV2DirectCastConversationListGetRequest {
    /**
     * Maximum number of items to return in a single response
     * @type {number}
     * @memberof DirectCastsApiV2DirectCastConversationListGet
     */
    readonly limit?: number;
    /**
     * Cursor to paginate through results
     * @type {string}
     * @memberof DirectCastsApiV2DirectCastConversationListGet
     */
    readonly cursor?: string;
}
/**
 * DirectCastsApi - object-oriented interface
 * @export
 * @class DirectCastsApi
 * @extends {BaseAPI}
 */
export declare class DirectCastsApi extends BaseAPI {
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationDetailsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DirectCastsApi
     */
    v2DirectCastConversationDetailsGet(requestParameters: DirectCastsApiV2DirectCastConversationDetailsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2DirectCastConversationDetailsGet200Response, any>>;
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DirectCastsApi
     */
    v2DirectCastConversationGet(requestParameters: DirectCastsApiV2DirectCastConversationGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2DirectCastConversationGet200Response, any>>;
    /**
     *
     * @param {DirectCastsApiV2DirectCastConversationListGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DirectCastsApi
     */
    v2DirectCastConversationListGet(requestParameters?: DirectCastsApiV2DirectCastConversationListGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2DirectCastConversationListGet200Response, any>>;
}