@suin/esa-api/js/client/api/watch-api.d.ts

esa.io APIクライアント

/**
 * esa API v1
 * チームのナレッジ共有サービス[esa.io](https://esa.io/)のAPI v1の仕様書
 *
 * The version of the OpenAPI document: 1.0.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 { AxiosPromise, AxiosInstance } from "axios";
import { Configuration } from "../configuration";
import { RequestArgs, BaseAPI } from "../base";
import { PaginatedWatchers } from "../models";
/**
 * WatchApi - axios parameter creator
 * @export
 */
export declare const WatchApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 指定された記事にWatchをしたユーザ一覧を取得します。
     * @summary Watchしたユーザー一覧を取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getWatchers: (teamName: string, postNumber: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
    /**
     * 指定された記事へのWatchを取り消します。
     * @summary 記事のWatchを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unwachPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
    /**
     * 指定された記事にWatchをします。
     * @summary 記事をWatchする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    watchPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
};
/**
 * WatchApi - functional programming interface
 * @export
 */
export declare const WatchApiFp: (configuration?: Configuration) => {
    /**
     * 指定された記事にWatchをしたユーザ一覧を取得します。
     * @summary Watchしたユーザー一覧を取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getWatchers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedWatchers>>;
    /**
     * 指定された記事へのWatchを取り消します。
     * @summary 記事のWatchを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unwachPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 指定された記事にWatchをします。
     * @summary 記事をWatchする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    watchPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * WatchApi - factory interface
 * @export
 */
export declare const WatchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 指定された記事にWatchをしたユーザ一覧を取得します。
     * @summary Watchしたユーザー一覧を取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getWatchers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedWatchers>;
    /**
     * 指定された記事へのWatchを取り消します。
     * @summary 記事のWatchを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unwachPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
    /**
     * 指定された記事にWatchをします。
     * @summary 記事をWatchする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    watchPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
};
/**
 * Request parameters for getWatchers operation in WatchApi.
 * @export
 * @interface WatchApiGetWatchersRequest
 */
export interface WatchApiGetWatchersRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof WatchApiGetWatchers
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof WatchApiGetWatchers
     */
    readonly postNumber: number;
    /**
     * ページ番号
     * @type {number}
     * @memberof WatchApiGetWatchers
     */
    readonly page?: number;
    /**
     * 1ページあたりに含まれる要素数
     * @type {number}
     * @memberof WatchApiGetWatchers
     */
    readonly perPage?: number;
}
/**
 * Request parameters for unwachPost operation in WatchApi.
 * @export
 * @interface WatchApiUnwachPostRequest
 */
export interface WatchApiUnwachPostRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof WatchApiUnwachPost
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof WatchApiUnwachPost
     */
    readonly postNumber: number;
}
/**
 * Request parameters for watchPost operation in WatchApi.
 * @export
 * @interface WatchApiWatchPostRequest
 */
export interface WatchApiWatchPostRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof WatchApiWatchPost
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof WatchApiWatchPost
     */
    readonly postNumber: number;
}
/**
 * WatchApi - object-oriented interface
 * @export
 * @class WatchApi
 * @extends {BaseAPI}
 */
export declare class WatchApi extends BaseAPI {
    /**
     * 指定された記事にWatchをしたユーザ一覧を取得します。
     * @summary Watchしたユーザー一覧を取得する
     * @param {WatchApiGetWatchersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof WatchApi
     */
    getWatchers(requestParameters: WatchApiGetWatchersRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedWatchers, any>>;
    /**
     * 指定された記事へのWatchを取り消します。
     * @summary 記事のWatchを取り消す
     * @param {WatchApiUnwachPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof WatchApi
     */
    unwachPost(requestParameters: WatchApiUnwachPostRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 指定された記事にWatchをします。
     * @summary 記事をWatchする
     * @param {WatchApiWatchPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof WatchApi
     */
    watchPost(requestParameters: WatchApiWatchPostRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
}
//# sourceMappingURL=watch-api.d.ts.map