ch-admin-api-client-typescript/lib/api/platform-interpretation-languages-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 { CreatePlatformInterpretationLanguageCommand } from '../models';
import { PlatformInterpretationLanguageModel } from '../models';
import { PlatformInterpretationLanguagesModel } from '../models';
import { UpdatePlatformInterpretationLanguageCommand } from '../models';
/**
 * PlatformInterpretationLanguagesApi - axios parameter creator
 * @export
 */
export declare const PlatformInterpretationLanguagesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Get platform interpretation languages (Auth policies: RequireManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesGet: (languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeDelete: (languageCode: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeGet: (languageCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {UpdatePlatformInterpretationLanguageCommand} [updatePlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodePut: (languageCode: string, updatePlatformInterpretationLanguageCommand?: UpdatePlatformInterpretationLanguageCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reactivate platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut: (languageCode: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create platform interpretation language (Auth policies: RequireManagerRole)
     * @param {CreatePlatformInterpretationLanguageCommand} [createPlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesPost: (createPlatformInterpretationLanguageCommand?: CreatePlatformInterpretationLanguageCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * PlatformInterpretationLanguagesApi - functional programming interface
 * @export
 */
export declare const PlatformInterpretationLanguagesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Get platform interpretation languages (Auth policies: RequireManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesGet(languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlatformInterpretationLanguagesModel>>;
    /**
     *
     * @summary Delete platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeDelete(languageCode: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeGet(languageCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlatformInterpretationLanguageModel>>;
    /**
     *
     * @summary Update platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {UpdatePlatformInterpretationLanguageCommand} [updatePlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodePut(languageCode: string, updatePlatformInterpretationLanguageCommand?: UpdatePlatformInterpretationLanguageCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Reactivate platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut(languageCode: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Create platform interpretation language (Auth policies: RequireManagerRole)
     * @param {CreatePlatformInterpretationLanguageCommand} [createPlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesPost(createPlatformInterpretationLanguageCommand?: CreatePlatformInterpretationLanguageCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlatformInterpretationLanguageModel>>;
};
/**
 * PlatformInterpretationLanguagesApi - factory interface
 * @export
 */
export declare const PlatformInterpretationLanguagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Get platform interpretation languages (Auth policies: RequireManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesGet(languageCode?: string, showHidden?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<PlatformInterpretationLanguagesModel>;
    /**
     *
     * @summary Delete platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeDelete(languageCode: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeGet(languageCode: string, options?: any): AxiosPromise<PlatformInterpretationLanguageModel>;
    /**
     *
     * @summary Update platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {UpdatePlatformInterpretationLanguageCommand} [updatePlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodePut(languageCode: string, updatePlatformInterpretationLanguageCommand?: UpdatePlatformInterpretationLanguageCommand, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Reactivate platform interpretation language (Auth policies: RequireManagerRole)
     * @param {string} languageCode
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut(languageCode: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Create platform interpretation language (Auth policies: RequireManagerRole)
     * @param {CreatePlatformInterpretationLanguageCommand} [createPlatformInterpretationLanguageCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1PlatforminterpretationlanguagesPost(createPlatformInterpretationLanguageCommand?: CreatePlatformInterpretationLanguageCommand, options?: any): AxiosPromise<PlatformInterpretationLanguageModel>;
};
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesGet operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGetRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGetRequest {
    /**
     *
     * @type {string}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {number}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesLanguageCodeDelete operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDeleteRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDelete
     */
    readonly languageCode: string;
    /**
     *
     * @type {boolean}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDelete
     */
    readonly isPermanent?: boolean;
}
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesLanguageCodeGet operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeGetRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeGetRequest {
    /**
     *
     * @type {string}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeGet
     */
    readonly languageCode: string;
}
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesLanguageCodePut operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePutRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePutRequest {
    /**
     *
     * @type {string}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePut
     */
    readonly languageCode: string;
    /**
     *
     * @type {UpdatePlatformInterpretationLanguageCommand}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePut
     */
    readonly updatePlatformInterpretationLanguageCommand?: UpdatePlatformInterpretationLanguageCommand;
}
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeReactivatePutRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeReactivatePutRequest {
    /**
     *
     * @type {string}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut
     */
    readonly languageCode: string;
}
/**
 * Request parameters for apiV1PlatforminterpretationlanguagesPost operation in PlatformInterpretationLanguagesApi.
 * @export
 * @interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesPostRequest
 */
export interface PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesPostRequest {
    /**
     *
     * @type {CreatePlatformInterpretationLanguageCommand}
     * @memberof PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesPost
     */
    readonly createPlatformInterpretationLanguageCommand?: CreatePlatformInterpretationLanguageCommand;
}
/**
 * PlatformInterpretationLanguagesApi - object-oriented interface
 * @export
 * @class PlatformInterpretationLanguagesApi
 * @extends {BaseAPI}
 */
export declare class PlatformInterpretationLanguagesApi extends BaseAPI {
    /**
     *
     * @summary Get platform interpretation languages (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesGet(requestParameters?: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlatformInterpretationLanguagesModel, any>>;
    /**
     *
     * @summary Delete platform interpretation language (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeDelete(requestParameters: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get platform interpretation language (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeGet(requestParameters: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlatformInterpretationLanguageModel, any>>;
    /**
     *
     * @summary Update platform interpretation language (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesLanguageCodePut(requestParameters: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Reactivate platform interpretation language (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeReactivatePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesLanguageCodeReactivatePut(requestParameters: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesLanguageCodeReactivatePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Create platform interpretation language (Auth policies: RequireManagerRole)
     * @param {PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PlatformInterpretationLanguagesApi
     */
    apiV1PlatforminterpretationlanguagesPost(requestParameters?: PlatformInterpretationLanguagesApiApiV1PlatforminterpretationlanguagesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PlatformInterpretationLanguageModel, any>>;
}
//# sourceMappingURL=platform-interpretation-languages-api.d.ts.map