ch-admin-api-client-typescript/lib/api/dev-supports-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 { SearchIndexType } from '../models';
import { UpdateContentTextOnlyValueDomains } from '../models';
/**
 * DevSupportsApi - axios parameter creator
 * @export
 */
export declare const DevSupportsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Apply database migration (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsApplydatabasemigrationPost: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Collect exchange rates (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsCollectexchangeratesPost: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Generate missing favicons for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingfaviconsPost: (webAppIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Generate missing OG images for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingogimagesPost: (webAppIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Generate sitemap blob items (Auth policies: RequireAdministratorRole)
     * @param {boolean} [overwrite]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratesitemapbatchPost: (overwrite?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete documents from an Azure Search index by document IDs (Auth policies: RequireAdministratorRole)
     * @param {SearchIndexType} [indexName] The search index type to target
     * @param {Array<string>} [documentIds] The document IDs to delete (supports multiple: ?documentIds&#x3D;id1&amp;documentIds&#x3D;id2)
     * @param {boolean} [dryRun] If true, returns the list of document IDs that would be deleted without actually deleting them
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsIndexDocumentsDelete: (indexName?: SearchIndexType, documentIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update contentTextOnly values (Auth policies: RequireAdministratorRole)
     * @param {Array<UpdateContentTextOnlyValueDomains>} [targetDomains]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsUpdatecontenttextonlyvaluesPost: (targetDomains?: Array<UpdateContentTextOnlyValueDomains>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * DevSupportsApi - functional programming interface
 * @export
 */
export declare const DevSupportsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Apply database migration (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsApplydatabasemigrationPost(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @summary Collect exchange rates (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsCollectexchangeratesPost(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Generate missing favicons for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingfaviconsPost(webAppIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @summary Generate missing OG images for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingogimagesPost(webAppIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @summary Generate sitemap blob items (Auth policies: RequireAdministratorRole)
     * @param {boolean} [overwrite]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratesitemapbatchPost(overwrite?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Delete documents from an Azure Search index by document IDs (Auth policies: RequireAdministratorRole)
     * @param {SearchIndexType} [indexName] The search index type to target
     * @param {Array<string>} [documentIds] The document IDs to delete (supports multiple: ?documentIds&#x3D;id1&amp;documentIds&#x3D;id2)
     * @param {boolean} [dryRun] If true, returns the list of document IDs that would be deleted without actually deleting them
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsIndexDocumentsDelete(indexName?: SearchIndexType, documentIds?: Array<string>, dryRun?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Update contentTextOnly values (Auth policies: RequireAdministratorRole)
     * @param {Array<UpdateContentTextOnlyValueDomains>} [targetDomains]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsUpdatecontenttextonlyvaluesPost(targetDomains?: Array<UpdateContentTextOnlyValueDomains>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
 * DevSupportsApi - factory interface
 * @export
 */
export declare const DevSupportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Apply database migration (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsApplydatabasemigrationPost(options?: any): AxiosPromise<string>;
    /**
     *
     * @summary Collect exchange rates (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsCollectexchangeratesPost(options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Generate missing favicons for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingfaviconsPost(webAppIds?: Array<string>, dryRun?: boolean, options?: any): AxiosPromise<string>;
    /**
     *
     * @summary Generate missing OG images for all webapps (Auth policies: RequireAdministratorRole)
     * @param {Array<string>} [webAppIds]
     * @param {boolean} [dryRun]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratemissingogimagesPost(webAppIds?: Array<string>, dryRun?: boolean, options?: any): AxiosPromise<string>;
    /**
     *
     * @summary Generate sitemap blob items (Auth policies: RequireAdministratorRole)
     * @param {boolean} [overwrite]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsGeneratesitemapbatchPost(overwrite?: boolean, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Delete documents from an Azure Search index by document IDs (Auth policies: RequireAdministratorRole)
     * @param {SearchIndexType} [indexName] The search index type to target
     * @param {Array<string>} [documentIds] The document IDs to delete (supports multiple: ?documentIds&#x3D;id1&amp;documentIds&#x3D;id2)
     * @param {boolean} [dryRun] If true, returns the list of document IDs that would be deleted without actually deleting them
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsIndexDocumentsDelete(indexName?: SearchIndexType, documentIds?: Array<string>, dryRun?: boolean, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Update contentTextOnly values (Auth policies: RequireAdministratorRole)
     * @param {Array<UpdateContentTextOnlyValueDomains>} [targetDomains]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV1DevsupportsUpdatecontenttextonlyvaluesPost(targetDomains?: Array<UpdateContentTextOnlyValueDomains>, options?: any): AxiosPromise<string>;
};
/**
 * Request parameters for apiV1DevsupportsGeneratemissingfaviconsPost operation in DevSupportsApi.
 * @export
 * @interface DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPostRequest
 */
export interface DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPostRequest {
    /**
     *
     * @type {Array<string>}
     * @memberof DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPost
     */
    readonly webAppIds?: Array<string>;
    /**
     *
     * @type {boolean}
     * @memberof DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPost
     */
    readonly dryRun?: boolean;
}
/**
 * Request parameters for apiV1DevsupportsGeneratemissingogimagesPost operation in DevSupportsApi.
 * @export
 * @interface DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPostRequest
 */
export interface DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPostRequest {
    /**
     *
     * @type {Array<string>}
     * @memberof DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPost
     */
    readonly webAppIds?: Array<string>;
    /**
     *
     * @type {boolean}
     * @memberof DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPost
     */
    readonly dryRun?: boolean;
}
/**
 * Request parameters for apiV1DevsupportsGeneratesitemapbatchPost operation in DevSupportsApi.
 * @export
 * @interface DevSupportsApiApiV1DevsupportsGeneratesitemapbatchPostRequest
 */
export interface DevSupportsApiApiV1DevsupportsGeneratesitemapbatchPostRequest {
    /**
     *
     * @type {boolean}
     * @memberof DevSupportsApiApiV1DevsupportsGeneratesitemapbatchPost
     */
    readonly overwrite?: boolean;
}
/**
 * Request parameters for apiV1DevsupportsIndexDocumentsDelete operation in DevSupportsApi.
 * @export
 * @interface DevSupportsApiApiV1DevsupportsIndexDocumentsDeleteRequest
 */
export interface DevSupportsApiApiV1DevsupportsIndexDocumentsDeleteRequest {
    /**
     * The search index type to target
     * @type {SearchIndexType}
     * @memberof DevSupportsApiApiV1DevsupportsIndexDocumentsDelete
     */
    readonly indexName?: SearchIndexType;
    /**
     * The document IDs to delete (supports multiple: ?documentIds&#x3D;id1&amp;documentIds&#x3D;id2)
     * @type {Array<string>}
     * @memberof DevSupportsApiApiV1DevsupportsIndexDocumentsDelete
     */
    readonly documentIds?: Array<string>;
    /**
     * If true, returns the list of document IDs that would be deleted without actually deleting them
     * @type {boolean}
     * @memberof DevSupportsApiApiV1DevsupportsIndexDocumentsDelete
     */
    readonly dryRun?: boolean;
}
/**
 * Request parameters for apiV1DevsupportsUpdatecontenttextonlyvaluesPost operation in DevSupportsApi.
 * @export
 * @interface DevSupportsApiApiV1DevsupportsUpdatecontenttextonlyvaluesPostRequest
 */
export interface DevSupportsApiApiV1DevsupportsUpdatecontenttextonlyvaluesPostRequest {
    /**
     *
     * @type {Array<UpdateContentTextOnlyValueDomains>}
     * @memberof DevSupportsApiApiV1DevsupportsUpdatecontenttextonlyvaluesPost
     */
    readonly targetDomains?: Array<UpdateContentTextOnlyValueDomains>;
}
/**
 * DevSupportsApi - object-oriented interface
 * @export
 * @class DevSupportsApi
 * @extends {BaseAPI}
 */
export declare class DevSupportsApi extends BaseAPI {
    /**
     *
     * @summary Apply database migration (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsApplydatabasemigrationPost(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Collect exchange rates (Auth policies: RequireAdministratorRole)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsCollectexchangeratesPost(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Generate missing favicons for all webapps (Auth policies: RequireAdministratorRole)
     * @param {DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsGeneratemissingfaviconsPost(requestParameters?: DevSupportsApiApiV1DevsupportsGeneratemissingfaviconsPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Generate missing OG images for all webapps (Auth policies: RequireAdministratorRole)
     * @param {DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsGeneratemissingogimagesPost(requestParameters?: DevSupportsApiApiV1DevsupportsGeneratemissingogimagesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
    /**
     *
     * @summary Generate sitemap blob items (Auth policies: RequireAdministratorRole)
     * @param {DevSupportsApiApiV1DevsupportsGeneratesitemapbatchPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsGeneratesitemapbatchPost(requestParameters?: DevSupportsApiApiV1DevsupportsGeneratesitemapbatchPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Delete documents from an Azure Search index by document IDs (Auth policies: RequireAdministratorRole)
     * @param {DevSupportsApiApiV1DevsupportsIndexDocumentsDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsIndexDocumentsDelete(requestParameters?: DevSupportsApiApiV1DevsupportsIndexDocumentsDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     *
     * @summary Update contentTextOnly values (Auth policies: RequireAdministratorRole)
     * @param {DevSupportsApiApiV1DevsupportsUpdatecontenttextonlyvaluesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevSupportsApi
     */
    apiV1DevsupportsUpdatecontenttextonlyvaluesPost(requestParameters?: DevSupportsApiApiV1DevsupportsUpdatecontenttextonlyvaluesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}
//# sourceMappingURL=dev-supports-api.d.ts.map