ch-admin-api-client-typescript/lib/api/benefits-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 { BenefitDomainName } from '../models';
import { BenefitModel } from '../models';
import { BenefitProvider } from '../models';
import { BenefitStatus } from '../models';
import { BenefitsModel } from '../models';
import { CreateBenefitCommand } from '../models';
import { TranslateBenefitCommand } from '../models';
import { UpdateBenefitCommand } from '../models';
/**
 * BenefitsApi - axios parameter creator
 * @export
 */
export declare const BenefitsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdDelete: (benefitId: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdGet: (benefitId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {UpdateBenefitCommand} [updateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdPut: (benefitId: string, updateBenefitCommand?: UpdateBenefitCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reactivate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdReactivatePut: (benefitId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Translate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {TranslateBenefitCommand} [translateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdTranslatePost: (benefitId: string, translateBenefitCommand?: TranslateBenefitCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get benefits (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {BenefitProvider} [provider]
     * @param {boolean} [forPartnerHospital]
     * @param {boolean} [forNonPartnerHospital]
     * @param {BenefitStatus} [status]
     * @param {string} [name]
     * @param {string} [excludedCountryId]
     * @param {BenefitDomainName} [domain]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsGet: (languageCode?: string, showHidden?: boolean, id?: string, provider?: BenefitProvider, forPartnerHospital?: boolean, forNonPartnerHospital?: boolean, status?: BenefitStatus, name?: string, excludedCountryId?: string, domain?: BenefitDomainName, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create benefit (Auth policies: RequireContentManagerRole)
     * @param {CreateBenefitCommand} [createBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsPost: (createBenefitCommand?: CreateBenefitCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * BenefitsApi - functional programming interface
 * @export
 */
export declare const BenefitsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdDelete(benefitId: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdGet(benefitId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenefitModel>>;
    /**
     *
     * @summary Update benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {UpdateBenefitCommand} [updateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdPut(benefitId: string, updateBenefitCommand?: UpdateBenefitCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenefitModel>>;
    /**
     *
     * @summary Reactivate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdReactivatePut(benefitId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Translate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {TranslateBenefitCommand} [translateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdTranslatePost(benefitId: string, translateBenefitCommand?: TranslateBenefitCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Get benefits (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {BenefitProvider} [provider]
     * @param {boolean} [forPartnerHospital]
     * @param {boolean} [forNonPartnerHospital]
     * @param {BenefitStatus} [status]
     * @param {string} [name]
     * @param {string} [excludedCountryId]
     * @param {BenefitDomainName} [domain]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsGet(languageCode?: string, showHidden?: boolean, id?: string, provider?: BenefitProvider, forPartnerHospital?: boolean, forNonPartnerHospital?: boolean, status?: BenefitStatus, name?: string, excludedCountryId?: string, domain?: BenefitDomainName, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenefitsModel>>;
    /**
     *
     * @summary Create benefit (Auth policies: RequireContentManagerRole)
     * @param {CreateBenefitCommand} [createBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsPost(createBenefitCommand?: CreateBenefitCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BenefitModel>>;
};
/**
 * BenefitsApi - factory interface
 * @export
 */
export declare const BenefitsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdDelete(benefitId: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdGet(benefitId: string, languageCode?: string, options?: any): AxiosPromise<BenefitModel>;
    /**
     *
     * @summary Update benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {UpdateBenefitCommand} [updateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdPut(benefitId: string, updateBenefitCommand?: UpdateBenefitCommand, options?: any): AxiosPromise<BenefitModel>;
    /**
     *
     * @summary Reactivate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdReactivatePut(benefitId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Translate benefit (Auth policies: RequireContentManagerRole)
     * @param {string} benefitId
     * @param {TranslateBenefitCommand} [translateBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsBenefitIdTranslatePost(benefitId: string, translateBenefitCommand?: TranslateBenefitCommand, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Get benefits (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {BenefitProvider} [provider]
     * @param {boolean} [forPartnerHospital]
     * @param {boolean} [forNonPartnerHospital]
     * @param {BenefitStatus} [status]
     * @param {string} [name]
     * @param {string} [excludedCountryId]
     * @param {BenefitDomainName} [domain]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsGet(languageCode?: string, showHidden?: boolean, id?: string, provider?: BenefitProvider, forPartnerHospital?: boolean, forNonPartnerHospital?: boolean, status?: BenefitStatus, name?: string, excludedCountryId?: string, domain?: BenefitDomainName, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<BenefitsModel>;
    /**
     *
     * @summary Create benefit (Auth policies: RequireContentManagerRole)
     * @param {CreateBenefitCommand} [createBenefitCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BenefitsPost(createBenefitCommand?: CreateBenefitCommand, options?: any): AxiosPromise<BenefitModel>;
};
/**
 * Request parameters for apiV1BenefitsBenefitIdDelete operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsBenefitIdDeleteRequest
 */
export interface BenefitsApiApiV1BenefitsBenefitIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdDelete
     */
    readonly benefitId: string;
    /**
     *
     * @type {boolean}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdDelete
     */
    readonly isPermanent?: boolean;
}
/**
 * Request parameters for apiV1BenefitsBenefitIdGet operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsBenefitIdGetRequest
 */
export interface BenefitsApiApiV1BenefitsBenefitIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdGet
     */
    readonly benefitId: string;
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV1BenefitsBenefitIdPut operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsBenefitIdPutRequest
 */
export interface BenefitsApiApiV1BenefitsBenefitIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdPut
     */
    readonly benefitId: string;
    /**
     *
     * @type {UpdateBenefitCommand}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdPut
     */
    readonly updateBenefitCommand?: UpdateBenefitCommand;
}
/**
 * Request parameters for apiV1BenefitsBenefitIdReactivatePut operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsBenefitIdReactivatePutRequest
 */
export interface BenefitsApiApiV1BenefitsBenefitIdReactivatePutRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdReactivatePut
     */
    readonly benefitId: string;
}
/**
 * Request parameters for apiV1BenefitsBenefitIdTranslatePost operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsBenefitIdTranslatePostRequest
 */
export interface BenefitsApiApiV1BenefitsBenefitIdTranslatePostRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdTranslatePost
     */
    readonly benefitId: string;
    /**
     *
     * @type {TranslateBenefitCommand}
     * @memberof BenefitsApiApiV1BenefitsBenefitIdTranslatePost
     */
    readonly translateBenefitCommand?: TranslateBenefitCommand;
}
/**
 * Request parameters for apiV1BenefitsGet operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsGetRequest
 */
export interface BenefitsApiApiV1BenefitsGetRequest {
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly id?: string;
    /**
     *
     * @type {BenefitProvider}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly provider?: BenefitProvider;
    /**
     *
     * @type {boolean}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly forPartnerHospital?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly forNonPartnerHospital?: boolean;
    /**
     *
     * @type {BenefitStatus}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly status?: BenefitStatus;
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly name?: string;
    /**
     *
     * @type {string}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly excludedCountryId?: string;
    /**
     *
     * @type {BenefitDomainName}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly domain?: BenefitDomainName;
    /**
     *
     * @type {number}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof BenefitsApiApiV1BenefitsGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV1BenefitsPost operation in BenefitsApi.
 * @export
 * @interface BenefitsApiApiV1BenefitsPostRequest
 */
export interface BenefitsApiApiV1BenefitsPostRequest {
    /**
     *
     * @type {CreateBenefitCommand}
     * @memberof BenefitsApiApiV1BenefitsPost
     */
    readonly createBenefitCommand?: CreateBenefitCommand;
}
/**
 * BenefitsApi - object-oriented interface
 * @export
 * @class BenefitsApi
 * @extends {BaseAPI}
 */
export declare class BenefitsApi extends BaseAPI {
    /**
     *
     * @summary Delete benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsBenefitIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsBenefitIdDelete(requestParameters: BenefitsApiApiV1BenefitsBenefitIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsBenefitIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsBenefitIdGet(requestParameters: BenefitsApiApiV1BenefitsBenefitIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BenefitModel, any>>;
    /**
     *
     * @summary Update benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsBenefitIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsBenefitIdPut(requestParameters: BenefitsApiApiV1BenefitsBenefitIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BenefitModel, any>>;
    /**
     *
     * @summary Reactivate benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsBenefitIdReactivatePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsBenefitIdReactivatePut(requestParameters: BenefitsApiApiV1BenefitsBenefitIdReactivatePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Translate benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsBenefitIdTranslatePostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsBenefitIdTranslatePost(requestParameters: BenefitsApiApiV1BenefitsBenefitIdTranslatePostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Get benefits (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsGet(requestParameters?: BenefitsApiApiV1BenefitsGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BenefitsModel, any>>;
    /**
     *
     * @summary Create benefit (Auth policies: RequireContentManagerRole)
     * @param {BenefitsApiApiV1BenefitsPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BenefitsApi
     */
    apiV1BenefitsPost(requestParameters?: BenefitsApiApiV1BenefitsPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BenefitModel, any>>;
}
//# sourceMappingURL=benefits-api.d.ts.map