@suin/esa-api/js/client/api/user-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 { AuthenticatedUser } from "../models";
/**
 * UserApi - axios parameter creator
 * @export
 */
export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 現在のアクセストークンで認証中のユーザーの情報を取得します。
     * @summary 認証中のユーザーを取得する
     * @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthenticatedUser: (include?: "teams", options?: any) => Promise<RequestArgs>;
};
/**
 * UserApi - functional programming interface
 * @export
 */
export declare const UserApiFp: (configuration?: Configuration) => {
    /**
     * 現在のアクセストークンで認証中のユーザーの情報を取得します。
     * @summary 認証中のユーザーを取得する
     * @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthenticatedUser(include?: "teams", options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticatedUser>>;
};
/**
 * UserApi - factory interface
 * @export
 */
export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 現在のアクセストークンで認証中のユーザーの情報を取得します。
     * @summary 認証中のユーザーを取得する
     * @param {'teams'} [include] teams を指定すると所属するチームの配列を含んだレスポンスを返します。
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAuthenticatedUser(include?: "teams", options?: any): AxiosPromise<AuthenticatedUser>;
};
/**
 * Request parameters for getAuthenticatedUser operation in UserApi.
 * @export
 * @interface UserApiGetAuthenticatedUserRequest
 */
export interface UserApiGetAuthenticatedUserRequest {
    /**
     * teams を指定すると所属するチームの配列を含んだレスポンスを返します。
     * @type {'teams'}
     * @memberof UserApiGetAuthenticatedUser
     */
    readonly include?: "teams";
}
/**
 * UserApi - object-oriented interface
 * @export
 * @class UserApi
 * @extends {BaseAPI}
 */
export declare class UserApi extends BaseAPI {
    /**
     * 現在のアクセストークンで認証中のユーザーの情報を取得します。
     * @summary 認証中のユーザーを取得する
     * @param {UserApiGetAuthenticatedUserRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UserApi
     */
    getAuthenticatedUser(requestParameters?: UserApiGetAuthenticatedUserRequest, options?: any): Promise<import("axios").AxiosResponse<AuthenticatedUser, any>>;
}
//# sourceMappingURL=user-api.d.ts.map