@suin/esa-api/js/client/api/star-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 { NewStar } from "../models";
import { PaginatedStargazers } from "../models";
/**
 * StarApi - axios parameter creator
 * @export
 */
export declare const StarApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 指定されたコメントにStarをしたユーザ一覧を取得します。
     * @summary コメントのStarを取得する
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCommentStargazers: (teamName: string, commentId: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
    /**
     * 指定された記事にStarをしたユーザ一覧を取得します。
     * @summary 記事のStarを取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPostStargazers: (teamName: string, postNumber: number, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
    /**
     * 指定されたコメントにStarをします。
     * @summary コメントをStarする
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starComment: (teamName: string, commentId: number, newStar: NewStar, options?: any) => Promise<RequestArgs>;
    /**
     * 指定された記事にStarをします。
     * @summary 記事をStarする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starPost: (teamName: string, postNumber: number, newStar: NewStar, options?: any) => Promise<RequestArgs>;
    /**
     * 指定されたコメントへのStarを取り消します。
     * @summary コメントのStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarComment: (teamName: string, commentId: number, options?: any) => Promise<RequestArgs>;
    /**
     * 指定された記事へのStarを取り消します。
     * @summary 記事のStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarPost: (teamName: string, postNumber: number, options?: any) => Promise<RequestArgs>;
};
/**
 * StarApi - functional programming interface
 * @export
 */
export declare const StarApiFp: (configuration?: Configuration) => {
    /**
     * 指定されたコメントにStarをしたユーザ一覧を取得します。
     * @summary コメントのStarを取得する
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCommentStargazers(teamName: string, commentId: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedStargazers>>;
    /**
     * 指定された記事にStarをしたユーザ一覧を取得します。
     * @summary 記事のStarを取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPostStargazers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedStargazers>>;
    /**
     * 指定されたコメントにStarをします。
     * @summary コメントをStarする
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starComment(teamName: string, commentId: number, newStar: NewStar, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 指定された記事にStarをします。
     * @summary 記事をStarする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starPost(teamName: string, postNumber: number, newStar: NewStar, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 指定されたコメントへのStarを取り消します。
     * @summary コメントのStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarComment(teamName: string, commentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 指定された記事へのStarを取り消します。
     * @summary 記事のStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarPost(teamName: string, postNumber: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
 * StarApi - factory interface
 * @export
 */
export declare const StarApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 指定されたコメントにStarをしたユーザ一覧を取得します。
     * @summary コメントのStarを取得する
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCommentStargazers(teamName: string, commentId: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedStargazers>;
    /**
     * 指定された記事にStarをしたユーザ一覧を取得します。
     * @summary 記事のStarを取得する
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {number} [page] ページ番号
     * @param {number} [perPage] 1ページあたりに含まれる要素数
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPostStargazers(teamName: string, postNumber: number, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedStargazers>;
    /**
     * 指定されたコメントにStarをします。
     * @summary コメントをStarする
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starComment(teamName: string, commentId: number, newStar: NewStar, options?: any): AxiosPromise<void>;
    /**
     * 指定された記事にStarをします。
     * @summary 記事をStarする
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {NewStar} newStar
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    starPost(teamName: string, postNumber: number, newStar: NewStar, options?: any): AxiosPromise<void>;
    /**
     * 指定されたコメントへのStarを取り消します。
     * @summary コメントのStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} commentId コメントID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarComment(teamName: string, commentId: number, options?: any): AxiosPromise<void>;
    /**
     * 指定された記事へのStarを取り消します。
     * @summary 記事のStarを取り消す
     * @param {string} teamName チーム名
     * @param {number} postNumber 記事ID
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unstarPost(teamName: string, postNumber: number, options?: any): AxiosPromise<void>;
};
/**
 * Request parameters for getCommentStargazers operation in StarApi.
 * @export
 * @interface StarApiGetCommentStargazersRequest
 */
export interface StarApiGetCommentStargazersRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiGetCommentStargazers
     */
    readonly teamName: string;
    /**
     * コメントID
     * @type {number}
     * @memberof StarApiGetCommentStargazers
     */
    readonly commentId: number;
    /**
     * ページ番号
     * @type {number}
     * @memberof StarApiGetCommentStargazers
     */
    readonly page?: number;
    /**
     * 1ページあたりに含まれる要素数
     * @type {number}
     * @memberof StarApiGetCommentStargazers
     */
    readonly perPage?: number;
}
/**
 * Request parameters for getPostStargazers operation in StarApi.
 * @export
 * @interface StarApiGetPostStargazersRequest
 */
export interface StarApiGetPostStargazersRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiGetPostStargazers
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof StarApiGetPostStargazers
     */
    readonly postNumber: number;
    /**
     * ページ番号
     * @type {number}
     * @memberof StarApiGetPostStargazers
     */
    readonly page?: number;
    /**
     * 1ページあたりに含まれる要素数
     * @type {number}
     * @memberof StarApiGetPostStargazers
     */
    readonly perPage?: number;
}
/**
 * Request parameters for starComment operation in StarApi.
 * @export
 * @interface StarApiStarCommentRequest
 */
export interface StarApiStarCommentRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiStarComment
     */
    readonly teamName: string;
    /**
     * コメントID
     * @type {number}
     * @memberof StarApiStarComment
     */
    readonly commentId: number;
    /**
     *
     * @type {NewStar}
     * @memberof StarApiStarComment
     */
    readonly newStar: NewStar;
}
/**
 * Request parameters for starPost operation in StarApi.
 * @export
 * @interface StarApiStarPostRequest
 */
export interface StarApiStarPostRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiStarPost
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof StarApiStarPost
     */
    readonly postNumber: number;
    /**
     *
     * @type {NewStar}
     * @memberof StarApiStarPost
     */
    readonly newStar: NewStar;
}
/**
 * Request parameters for unstarComment operation in StarApi.
 * @export
 * @interface StarApiUnstarCommentRequest
 */
export interface StarApiUnstarCommentRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiUnstarComment
     */
    readonly teamName: string;
    /**
     * コメントID
     * @type {number}
     * @memberof StarApiUnstarComment
     */
    readonly commentId: number;
}
/**
 * Request parameters for unstarPost operation in StarApi.
 * @export
 * @interface StarApiUnstarPostRequest
 */
export interface StarApiUnstarPostRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof StarApiUnstarPost
     */
    readonly teamName: string;
    /**
     * 記事ID
     * @type {number}
     * @memberof StarApiUnstarPost
     */
    readonly postNumber: number;
}
/**
 * StarApi - object-oriented interface
 * @export
 * @class StarApi
 * @extends {BaseAPI}
 */
export declare class StarApi extends BaseAPI {
    /**
     * 指定されたコメントにStarをしたユーザ一覧を取得します。
     * @summary コメントのStarを取得する
     * @param {StarApiGetCommentStargazersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    getCommentStargazers(requestParameters: StarApiGetCommentStargazersRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedStargazers, any>>;
    /**
     * 指定された記事にStarをしたユーザ一覧を取得します。
     * @summary 記事のStarを取得する
     * @param {StarApiGetPostStargazersRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    getPostStargazers(requestParameters: StarApiGetPostStargazersRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedStargazers, any>>;
    /**
     * 指定されたコメントにStarをします。
     * @summary コメントをStarする
     * @param {StarApiStarCommentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    starComment(requestParameters: StarApiStarCommentRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 指定された記事にStarをします。
     * @summary 記事をStarする
     * @param {StarApiStarPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    starPost(requestParameters: StarApiStarPostRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 指定されたコメントへのStarを取り消します。
     * @summary コメントのStarを取り消す
     * @param {StarApiUnstarCommentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    unstarComment(requestParameters: StarApiUnstarCommentRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 指定された記事へのStarを取り消します。
     * @summary 記事のStarを取り消す
     * @param {StarApiUnstarPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof StarApi
     */
    unstarPost(requestParameters: StarApiUnstarPostRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
}
//# sourceMappingURL=star-api.d.ts.map