@suin/esa-api/js/client/api/invitation-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 { InvitationList } from "../models";
import { InviteBody } from "../models";
/**
 * InvitationApi - axios parameter creator
 * @export
 */
export declare const InvitationApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待を取り下げる
     * @param {string} teamName チーム名
     * @param {string} code 招待時の識別子を指定します
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    disinvite: (teamName: string, code: string, options?: any) => Promise<RequestArgs>;
    /**
     * 招待中のメンバーの一覧を取得します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待中のメンバー一覧を取得する
     * @param {string} teamName チーム名
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitations: (teamName: string, options?: any) => Promise<RequestArgs>;
    /**
     * 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary Emailで招待する
     * @param {string} teamName チーム名
     * @param {InviteBody} inviteBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    invite: (teamName: string, inviteBody: InviteBody, options?: any) => Promise<RequestArgs>;
};
/**
 * InvitationApi - functional programming interface
 * @export
 */
export declare const InvitationApiFp: (configuration?: Configuration) => {
    /**
     * 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待を取り下げる
     * @param {string} teamName チーム名
     * @param {string} code 招待時の識別子を指定します
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    disinvite(teamName: string, code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * 招待中のメンバーの一覧を取得します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待中のメンバー一覧を取得する
     * @param {string} teamName チーム名
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitations(teamName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvitationList>>;
    /**
     * 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary Emailで招待する
     * @param {string} teamName チーム名
     * @param {InviteBody} inviteBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    invite(teamName: string, inviteBody: InviteBody, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvitationList>>;
};
/**
 * InvitationApi - factory interface
 * @export
 */
export declare const InvitationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待を取り下げる
     * @param {string} teamName チーム名
     * @param {string} code 招待時の識別子を指定します
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    disinvite(teamName: string, code: string, options?: any): AxiosPromise<void>;
    /**
     * 招待中のメンバーの一覧を取得します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待中のメンバー一覧を取得する
     * @param {string} teamName チーム名
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getInvitations(teamName: string, options?: any): AxiosPromise<InvitationList>;
    /**
     * 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary Emailで招待する
     * @param {string} teamName チーム名
     * @param {InviteBody} inviteBody
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    invite(teamName: string, inviteBody: InviteBody, options?: any): AxiosPromise<InvitationList>;
};
/**
 * Request parameters for disinvite operation in InvitationApi.
 * @export
 * @interface InvitationApiDisinviteRequest
 */
export interface InvitationApiDisinviteRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof InvitationApiDisinvite
     */
    readonly teamName: string;
    /**
     * 招待時の識別子を指定します
     * @type {string}
     * @memberof InvitationApiDisinvite
     */
    readonly code: string;
}
/**
 * Request parameters for getInvitations operation in InvitationApi.
 * @export
 * @interface InvitationApiGetInvitationsRequest
 */
export interface InvitationApiGetInvitationsRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof InvitationApiGetInvitations
     */
    readonly teamName: string;
}
/**
 * Request parameters for invite operation in InvitationApi.
 * @export
 * @interface InvitationApiInviteRequest
 */
export interface InvitationApiInviteRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof InvitationApiInvite
     */
    readonly teamName: string;
    /**
     *
     * @type {InviteBody}
     * @memberof InvitationApiInvite
     */
    readonly inviteBody: InviteBody;
}
/**
 * InvitationApi - object-oriented interface
 * @export
 * @class InvitationApi
 * @extends {BaseAPI}
 */
export declare class InvitationApi extends BaseAPI {
    /**
     * 招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。 このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待を取り下げる
     * @param {InvitationApiDisinviteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof InvitationApi
     */
    disinvite(requestParameters: InvitationApiDisinviteRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * 招待中のメンバーの一覧を取得します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary 招待中のメンバー一覧を取得する
     * @param {InvitationApiGetInvitationsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof InvitationApi
     */
    getInvitations(requestParameters: InvitationApiGetInvitationsRequest, options?: any): Promise<import("axios").AxiosResponse<InvitationList, any>>;
    /**
     * 招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。  このAPIは**team**の**owner**だけがご利用可能です。
     * @summary Emailで招待する
     * @param {InvitationApiInviteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof InvitationApi
     */
    invite(requestParameters: InvitationApiInviteRequest, options?: any): Promise<import("axios").AxiosResponse<InvitationList, any>>;
}
//# sourceMappingURL=invitation-api.d.ts.map