@suin/esa-api
Version:
esa.io APIクライアント
179 lines • 7.56 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 { PaginatedMembers } from "../models";
/**
* MemberApi - axios parameter creator
* @export
*/
export declare const MemberApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember: (teamName: string, screenName: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers: (teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: number, options?: any) => Promise<RequestArgs>;
};
/**
* MemberApi - functional programming interface
* @export
*/
export declare const MemberApiFp: (configuration?: Configuration) => {
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember(teamName: string, screenName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers(teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedMembers>>;
};
/**
* MemberApi - factory interface
* @export
*/
export declare const MemberApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {string} teamName チーム名
* @param {string} screenName 削除するメンバーのscreen_name
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteMember(teamName: string, screenName: string, options?: any): AxiosPromise<void>;
/**
*
* @summary メンバーを取得する
* @param {string} teamName チーム名
* @param {'posts_count' | 'joined' | 'last_accessed'} [sort]
* @param {'asc' | 'desc'} [order] 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @param {number} [page] ページ番号
* @param {number} [perPage] 1ページあたりに含まれる要素数
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getMembers(teamName: string, sort?: "posts_count" | "joined" | "last_accessed", order?: "asc" | "desc", page?: number, perPage?: number, options?: any): AxiosPromise<PaginatedMembers>;
};
/**
* Request parameters for deleteMember operation in MemberApi.
* @export
* @interface MemberApiDeleteMemberRequest
*/
export interface MemberApiDeleteMemberRequest {
/**
* チーム名
* @type {string}
* @memberof MemberApiDeleteMember
*/
readonly teamName: string;
/**
* 削除するメンバーのscreen_name
* @type {string}
* @memberof MemberApiDeleteMember
*/
readonly screenName: string;
}
/**
* Request parameters for getMembers operation in MemberApi.
* @export
* @interface MemberApiGetMembersRequest
*/
export interface MemberApiGetMembersRequest {
/**
* チーム名
* @type {string}
* @memberof MemberApiGetMembers
*/
readonly teamName: string;
/**
*
* @type {'posts_count' | 'joined' | 'last_accessed'}
* @memberof MemberApiGetMembers
*/
readonly sort?: "posts_count" | "joined" | "last_accessed";
/**
* 設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順
* @type {'asc' | 'desc'}
* @memberof MemberApiGetMembers
*/
readonly order?: "asc" | "desc";
/**
* ページ番号
* @type {number}
* @memberof MemberApiGetMembers
*/
readonly page?: number;
/**
* 1ページあたりに含まれる要素数
* @type {number}
* @memberof MemberApiGetMembers
*/
readonly perPage?: number;
}
/**
* MemberApi - object-oriented interface
* @export
* @class MemberApi
* @extends {BaseAPI}
*/
export declare class MemberApi extends BaseAPI {
/**
* 指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
* @summary メンバーを削除する
* @param {MemberApiDeleteMemberRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MemberApi
*/
deleteMember(requestParameters: MemberApiDeleteMemberRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary メンバーを取得する
* @param {MemberApiGetMembersRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MemberApi
*/
getMembers(requestParameters: MemberApiGetMembersRequest, options?: any): Promise<import("axios").AxiosResponse<PaginatedMembers, any>>;
}
//# sourceMappingURL=member-api.d.ts.map