ch-admin-api-client-typescript/lib/api/badges-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 { BadgeModel } from '../models';
import { BadgesModel } from '../models';
import { CreateBadgeCommand } from '../models';
import { UpdateBadgeCommand } from '../models';
/**
 * BadgesApi - axios parameter creator
 * @export
 */
export declare const BadgesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdDelete: (badgeId: string, isPermanent?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Remove excluded country from badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdDelete: (badgeId: string, countryId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Add excluded country to badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdPost: (badgeId: string, countryId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdGet: (badgeId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {UpdateBadgeCommand} [updateBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdPut: (badgeId: string, updateBadgeCommand?: UpdateBadgeCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Reactivate badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdReactivatePut: (badgeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get badges (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {string} [badgeCategoryId]
     * @param {string} [name]
     * @param {boolean} [displayAreaHospital]
     * @param {boolean} [displayAreaDoctor]
     * @param {boolean} [displayAreaDeal]
     * @param {boolean} [published]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesGet: (languageCode?: string, showHidden?: boolean, id?: string, badgeCategoryId?: string, name?: string, displayAreaHospital?: boolean, displayAreaDoctor?: boolean, displayAreaDeal?: boolean, published?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create badge (Auth policies: RequireContentManagerRole)
     * @param {CreateBadgeCommand} [createBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesPost: (createBadgeCommand?: CreateBadgeCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * BadgesApi - functional programming interface
 * @export
 */
export declare const BadgesApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdDelete(badgeId: string, isPermanent?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Remove excluded country from badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdDelete(badgeId: string, countryId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Add excluded country to badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdPost(badgeId: string, countryId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdGet(badgeId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BadgeModel>>;
    /**
     *
     * @summary Update badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {UpdateBadgeCommand} [updateBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdPut(badgeId: string, updateBadgeCommand?: UpdateBadgeCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BadgeModel>>;
    /**
     *
     * @summary Reactivate badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdReactivatePut(badgeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get badges (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {string} [badgeCategoryId]
     * @param {string} [name]
     * @param {boolean} [displayAreaHospital]
     * @param {boolean} [displayAreaDoctor]
     * @param {boolean} [displayAreaDeal]
     * @param {boolean} [published]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesGet(languageCode?: string, showHidden?: boolean, id?: string, badgeCategoryId?: string, name?: string, displayAreaHospital?: boolean, displayAreaDoctor?: boolean, displayAreaDeal?: boolean, published?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BadgesModel>>;
    /**
     *
     * @summary Create badge (Auth policies: RequireContentManagerRole)
     * @param {CreateBadgeCommand} [createBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesPost(createBadgeCommand?: CreateBadgeCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BadgeModel>>;
};
/**
 * BadgesApi - factory interface
 * @export
 */
export declare const BadgesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {boolean} [isPermanent]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdDelete(badgeId: string, isPermanent?: boolean, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Remove excluded country from badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdDelete(badgeId: string, countryId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Add excluded country to badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} countryId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdPost(badgeId: string, countryId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdGet(badgeId: string, languageCode?: string, options?: any): AxiosPromise<BadgeModel>;
    /**
     *
     * @summary Update badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {UpdateBadgeCommand} [updateBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdPut(badgeId: string, updateBadgeCommand?: UpdateBadgeCommand, options?: any): AxiosPromise<BadgeModel>;
    /**
     *
     * @summary Reactivate badge (Auth policies: RequireContentManagerRole)
     * @param {string} badgeId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesBadgeIdReactivatePut(badgeId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get badges (Auth policies: RequireContentManagerRole)
     * @param {string} [languageCode]
     * @param {boolean} [showHidden]
     * @param {string} [id]
     * @param {string} [badgeCategoryId]
     * @param {string} [name]
     * @param {boolean} [displayAreaHospital]
     * @param {boolean} [displayAreaDoctor]
     * @param {boolean} [displayAreaDeal]
     * @param {boolean} [published]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesGet(languageCode?: string, showHidden?: boolean, id?: string, badgeCategoryId?: string, name?: string, displayAreaHospital?: boolean, displayAreaDoctor?: boolean, displayAreaDeal?: boolean, published?: boolean, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<BadgesModel>;
    /**
     *
     * @summary Create badge (Auth policies: RequireContentManagerRole)
     * @param {CreateBadgeCommand} [createBadgeCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1BadgesPost(createBadgeCommand?: CreateBadgeCommand, options?: any): AxiosPromise<BadgeModel>;
};
/**
 * Request parameters for apiV1BadgesBadgeIdDelete operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdDeleteRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdDelete
     */
    readonly badgeId: string;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesBadgeIdDelete
     */
    readonly isPermanent?: boolean;
}
/**
 * Request parameters for apiV1BadgesBadgeIdExcludedcountriesCountryIdDelete operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDeleteRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDelete
     */
    readonly badgeId: string;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDelete
     */
    readonly countryId: string;
}
/**
 * Request parameters for apiV1BadgesBadgeIdExcludedcountriesCountryIdPost operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPostRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPostRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPost
     */
    readonly badgeId: string;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPost
     */
    readonly countryId: string;
}
/**
 * Request parameters for apiV1BadgesBadgeIdGet operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdGetRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdGet
     */
    readonly badgeId: string;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV1BadgesBadgeIdPut operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdPutRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdPut
     */
    readonly badgeId: string;
    /**
     *
     * @type {UpdateBadgeCommand}
     * @memberof BadgesApiApiV1BadgesBadgeIdPut
     */
    readonly updateBadgeCommand?: UpdateBadgeCommand;
}
/**
 * Request parameters for apiV1BadgesBadgeIdReactivatePut operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesBadgeIdReactivatePutRequest
 */
export interface BadgesApiApiV1BadgesBadgeIdReactivatePutRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesBadgeIdReactivatePut
     */
    readonly badgeId: string;
}
/**
 * Request parameters for apiV1BadgesGet operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesGetRequest
 */
export interface BadgesApiApiV1BadgesGetRequest {
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly showHidden?: boolean;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly id?: string;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly badgeCategoryId?: string;
    /**
     *
     * @type {string}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly name?: string;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly displayAreaHospital?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly displayAreaDoctor?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly displayAreaDeal?: boolean;
    /**
     *
     * @type {boolean}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly published?: boolean;
    /**
     *
     * @type {number}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof BadgesApiApiV1BadgesGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * Request parameters for apiV1BadgesPost operation in BadgesApi.
 * @export
 * @interface BadgesApiApiV1BadgesPostRequest
 */
export interface BadgesApiApiV1BadgesPostRequest {
    /**
     *
     * @type {CreateBadgeCommand}
     * @memberof BadgesApiApiV1BadgesPost
     */
    readonly createBadgeCommand?: CreateBadgeCommand;
}
/**
 * BadgesApi - object-oriented interface
 * @export
 * @class BadgesApi
 * @extends {BaseAPI}
 */
export declare class BadgesApi extends BaseAPI {
    /**
     *
     * @summary Delete badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdDelete(requestParameters: BadgesApiApiV1BadgesBadgeIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Remove excluded country from badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdDelete(requestParameters: BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Add excluded country to badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdExcludedcountriesCountryIdPost(requestParameters: BadgesApiApiV1BadgesBadgeIdExcludedcountriesCountryIdPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdGet(requestParameters: BadgesApiApiV1BadgesBadgeIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BadgeModel, any>>;
    /**
     *
     * @summary Update badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdPut(requestParameters: BadgesApiApiV1BadgesBadgeIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BadgeModel, any>>;
    /**
     *
     * @summary Reactivate badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesBadgeIdReactivatePutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesBadgeIdReactivatePut(requestParameters: BadgesApiApiV1BadgesBadgeIdReactivatePutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get badges (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesGet(requestParameters?: BadgesApiApiV1BadgesGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BadgesModel, any>>;
    /**
     *
     * @summary Create badge (Auth policies: RequireContentManagerRole)
     * @param {BadgesApiApiV1BadgesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof BadgesApi
     */
    apiV1BadgesPost(requestParameters?: BadgesApiApiV1BadgesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BadgeModel, any>>;
}
//# sourceMappingURL=badges-api.d.ts.map