@suin/esa-api/js/client/api/category-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 { BatchMoveOptions } from "../models";
import { BatchMoveResult } from "../models";
/**
 * CategoryApi - axios parameter creator
 * @export
 */
export declare const CategoryApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
     * @summary カテゴリを一括移動する
     * @param {string} teamName チーム名
     * @param {BatchMoveOptions} batchMoveOptions
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    batchMoveCategory: (teamName: string, batchMoveOptions: BatchMoveOptions, options?: any) => Promise<RequestArgs>;
};
/**
 * CategoryApi - functional programming interface
 * @export
 */
export declare const CategoryApiFp: (configuration?: Configuration) => {
    /**
     * 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
     * @summary カテゴリを一括移動する
     * @param {string} teamName チーム名
     * @param {BatchMoveOptions} batchMoveOptions
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    batchMoveCategory(teamName: string, batchMoveOptions: BatchMoveOptions, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchMoveResult>>;
};
/**
 * CategoryApi - factory interface
 * @export
 */
export declare const CategoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
     * @summary カテゴリを一括移動する
     * @param {string} teamName チーム名
     * @param {BatchMoveOptions} batchMoveOptions
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    batchMoveCategory(teamName: string, batchMoveOptions: BatchMoveOptions, options?: any): AxiosPromise<BatchMoveResult>;
};
/**
 * Request parameters for batchMoveCategory operation in CategoryApi.
 * @export
 * @interface CategoryApiBatchMoveCategoryRequest
 */
export interface CategoryApiBatchMoveCategoryRequest {
    /**
     * チーム名
     * @type {string}
     * @memberof CategoryApiBatchMoveCategory
     */
    readonly teamName: string;
    /**
     *
     * @type {BatchMoveOptions}
     * @memberof CategoryApiBatchMoveCategory
     */
    readonly batchMoveOptions: BatchMoveOptions;
}
/**
 * CategoryApi - object-oriented interface
 * @export
 * @class CategoryApi
 * @extends {BaseAPI}
 */
export declare class CategoryApi extends BaseAPI {
    /**
     * 指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
     * @summary カテゴリを一括移動する
     * @param {CategoryApiBatchMoveCategoryRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CategoryApi
     */
    batchMoveCategory(requestParameters: CategoryApiBatchMoveCategoryRequest, options?: any): Promise<import("axios").AxiosResponse<BatchMoveResult, any>>;
}
//# sourceMappingURL=category-api.d.ts.map