@suin/esa-api
Version:
esa.io APIクライアント
106 lines • 3.59 kB
TypeScript
/**
* 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 { PaginatedTags } from "../models";
/**
* TagApi - axios parameter creator
* @export
*/
export declare const TagApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary タグ一覧をタグ付けされた記事数の降順で取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags: (teamName: string, page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
};
/**
* TagApi - functional programming interface
* @export
*/
export declare const TagApiFp: (configuration?: Configuration) => {
/**
*
* @summary タグ一覧をタグ付けされた記事数の降順で取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags(teamName: string, page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTags>>;
};
/**
* TagApi - factory interface
* @export
*/
export declare const TagApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary タグ一覧をタグ付けされた記事数の降順で取得する
* @param {string} teamName チーム名
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTags(teamName: string, page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedTags>;
};
/**
* Request parameters for getTags operation in TagApi.
* @export
* @interface TagApiGetTagsRequest
*/
export interface TagApiGetTagsRequest {
/**
* チーム名
* @type {string}
* @memberof TagApiGetTags
*/
readonly teamName: string;
/**
* ページ番号
* @type {number}
* @memberof TagApiGetTags
*/
readonly page?: number;
/**
* 1ページあたりに含まれる要素数
* @type {number}
* @memberof TagApiGetTags
*/
readonly perPage?: number;
}
/**
* TagApi - object-oriented interface
* @export
* @class TagApi
* @extends {BaseAPI}
*/
export declare class TagApi extends BaseAPI {
/**
*
* @summary タグ一覧をタグ付けされた記事数の降順で取得する
* @param {TagApiGetTagsRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TagApi
*/
getTags(requestParameters: TagApiGetTagsRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedTags, any>>;
}
//# sourceMappingURL=tag-api.d.ts.map