ch-admin-api-client-typescript/lib/api/article-categories-api.d.ts

Openapi generated typescript-axios client for CloudHospital admin

/**
 * CloudHospital Admin Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 1
 * Contact: developer@icloudhospital.com
 *
 * 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, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { ArticleCategoryModel } from '../models';
import { ArticleType } from '../models';
import { ArticlesCategoriesModel } from '../models';
import { CreateArticleCategoryCommand } from '../models';
import { TranslateArticleCategoryCommand } from '../models';
import { UpdateArticleCategoryCommand } from '../models';
/**
 * ArticleCategoriesApi - axios parameter creator
 * @export
 */
export declare const ArticleCategoriesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdDelete: (articleCategoryId: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get article category (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdGet: (articleCategoryId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {UpdateArticleCategoryCommand} [updateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdPut: (articleCategoryId: string, updateArticleCategoryCommand?: UpdateArticleCategoryCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reactivate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdReactivatePut: (articleCategoryId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Translate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {TranslateArticleCategoryCommand} [translateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdTranslatePost: (articleCategoryId: string, translateArticleCategoryCommand?: TranslateArticleCategoryCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get article categories (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {string} [id]
     * @param {string} [parentArticleCategoryId]
     * @param {ArticleType} [articleType]
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesGet: (languageCode?: string, id?: string, parentArticleCategoryId?: string, articleType?: ArticleType, name?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create articleCategory (Auth policies: RequireContentManagerRole)
     * @param {CreateArticleCategoryCommand} [createArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesPost: (createArticleCategoryCommand?: CreateArticleCategoryCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ArticleCategoriesApi - functional programming interface
 * @export
 */
export declare const ArticleCategoriesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdDelete(articleCategoryId: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get article category (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdGet(articleCategoryId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleCategoryModel>>;
    /**
     *
     * @summary Update articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {UpdateArticleCategoryCommand} [updateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdPut(articleCategoryId: string, updateArticleCategoryCommand?: UpdateArticleCategoryCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleCategoryModel>>;
    /**
     *
     * @summary Reactivate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdReactivatePut(articleCategoryId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Translate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {TranslateArticleCategoryCommand} [translateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdTranslatePost(articleCategoryId: string, translateArticleCategoryCommand?: TranslateArticleCategoryCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get article categories (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {string} [id]
     * @param {string} [parentArticleCategoryId]
     * @param {ArticleType} [articleType]
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesGet(languageCode?: string, id?: string, parentArticleCategoryId?: string, articleType?: ArticleType, name?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticlesCategoriesModel>>;
    /**
     *
     * @summary Create articleCategory (Auth policies: RequireContentManagerRole)
     * @param {CreateArticleCategoryCommand} [createArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesPost(createArticleCategoryCommand?: CreateArticleCategoryCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ArticleCategoryModel>>;
};
/**
 * ArticleCategoriesApi - factory interface
 * @export
 */
export declare const ArticleCategoriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdDelete(articleCategoryId: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get article category (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdGet(articleCategoryId: string, languageCode?: string, options?: any): AxiosPromise<ArticleCategoryModel>;
    /**
     *
     * @summary Update articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {UpdateArticleCategoryCommand} [updateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdPut(articleCategoryId: string, updateArticleCategoryCommand?: UpdateArticleCategoryCommand, options?: any): AxiosPromise<ArticleCategoryModel>;
    /**
     *
     * @summary Reactivate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdReactivatePut(articleCategoryId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Translate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {string} articleCategoryId
     * @param {TranslateArticleCategoryCommand} [translateArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesArticleCategoryIdTranslatePost(articleCategoryId: string, translateArticleCategoryCommand?: TranslateArticleCategoryCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get article categories (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {string} [id]
     * @param {string} [parentArticleCategoryId]
     * @param {ArticleType} [articleType]
     * @param {string} [name]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesGet(languageCode?: string, id?: string, parentArticleCategoryId?: string, articleType?: ArticleType, name?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<ArticlesCategoriesModel>;
    /**
     *
     * @summary Create articleCategory (Auth policies: RequireContentManagerRole)
     * @param {CreateArticleCategoryCommand} [createArticleCategoryCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1ArticlecategoriesPost(createArticleCategoryCommand?: CreateArticleCategoryCommand, options?: any): AxiosPromise<ArticleCategoryModel>;
};
/**
 * Request parameters for apiV1ArticlecategoriesArticleCategoryIdDelete operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDeleteRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDelete
     */
    readonly articleCategoryId: string;
    /**
     *
     * @type {boolean}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDelete
     */
    readonly isPermanent?: boolean;
}
/**
 * Request parameters for apiV1ArticlecategoriesArticleCategoryIdGet operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGetRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGet
     */
    readonly articleCategoryId: string;
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV1ArticlecategoriesArticleCategoryIdPut operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPutRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPut
     */
    readonly articleCategoryId: string;
    /**
     *
     * @type {UpdateArticleCategoryCommand}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPut
     */
    readonly updateArticleCategoryCommand?: UpdateArticleCategoryCommand;
}
/**
 * Request parameters for apiV1ArticlecategoriesArticleCategoryIdReactivatePut operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdReactivatePutRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdReactivatePutRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdReactivatePut
     */
    readonly articleCategoryId: string;
}
/**
 * Request parameters for apiV1ArticlecategoriesArticleCategoryIdTranslatePost operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePostRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePostRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePost
     */
    readonly articleCategoryId: string;
    /**
     *
     * @type {TranslateArticleCategoryCommand}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePost
     */
    readonly translateArticleCategoryCommand?: TranslateArticleCategoryCommand;
}
/**
 * Request parameters for apiV1ArticlecategoriesGet operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesGetRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesGetRequest {
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly parentArticleCategoryId?: string;
    /**
     *
     * @type {ArticleType}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly articleType?: ArticleType;
    /**
     *
     * @type {string}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly name?: string;
    /**
     *
     * @type {boolean}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {number}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV1ArticlecategoriesPost operation in ArticleCategoriesApi.
 * @export
 * @interface ArticleCategoriesApiApiV1ArticlecategoriesPostRequest
 */
export interface ArticleCategoriesApiApiV1ArticlecategoriesPostRequest {
    /**
     *
     * @type {CreateArticleCategoryCommand}
     * @memberof ArticleCategoriesApiApiV1ArticlecategoriesPost
     */
    readonly createArticleCategoryCommand?: CreateArticleCategoryCommand;
}
/**
 * ArticleCategoriesApi - object-oriented interface
 * @export
 * @class ArticleCategoriesApi
 * @extends {BaseAPI}
 */
export declare class ArticleCategoriesApi extends BaseAPI {
    /**
     *
     * @summary Delete articleCategory (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesArticleCategoryIdDelete(requestParameters: ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get article category (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesArticleCategoryIdGet(requestParameters: ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleCategoryModel, any>>;
    /**
     *
     * @summary Update articleCategory (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesArticleCategoryIdPut(requestParameters: ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleCategoryModel, any>>;
    /**
     *
     * @summary Reactivate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdReactivatePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesArticleCategoryIdReactivatePut(requestParameters: ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdReactivatePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Translate articleCategory (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesArticleCategoryIdTranslatePost(requestParameters: ArticleCategoriesApiApiV1ArticlecategoriesArticleCategoryIdTranslatePostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get article categories (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesGet(requestParameters?: ArticleCategoriesApiApiV1ArticlecategoriesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticlesCategoriesModel, any>>;
    /**
     *
     * @summary Create articleCategory (Auth policies: RequireContentManagerRole)
     * @param {ArticleCategoriesApiApiV1ArticlecategoriesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ArticleCategoriesApi
     */
    apiV1ArticlecategoriesPost(requestParameters?: ArticleCategoriesApiApiV1ArticlecategoriesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ArticleCategoryModel, any>>;
}
//# sourceMappingURL=article-categories-api.d.ts.map