ch-api-client-typescript2/lib/api/secure-containers-api.d.ts

Openapi generated typescript-axios client for CloudHospital

/**
 * CloudHospital Api
 * CloudHospital application with Swagger, Swashbuckle, and API versioning.
 *
 * The version of the OpenAPI document: 2
 * 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 { SecureContainerModel } from '../models';
import { SecureContainersModel } from '../models';
import { SecureFilesUploadedModel } from '../models';
import { UpdateSecureContainerCommand } from '../models';
/**
 * SecureContainersApi - axios parameter creator
 * @export
 */
export declare const SecureContainersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete secure file
     * @param {string} containerId
     * @param {string} fileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesFileIdDelete: (containerId: string, fileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Upload files into secure file container
     * @param {string} containerId
     * @param {Array<File>} [files]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesPost: (containerId: string, files?: Array<File>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get secure file container
     * @param {string} containerId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdGet: (containerId: string, languageCode?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update secure file container
     * @param {string} containerId
     * @param {UpdateSecureContainerCommand} [updateSecureContainerCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdPut: (containerId: string, updateSecureContainerCommand?: UpdateSecureContainerCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get secure file containers
     * @param {string} [hospitalId]
     * @param {string} [languageCode]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersGet: (hospitalId?: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SecureContainersApi - functional programming interface
 * @export
 */
export declare const SecureContainersApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete secure file
     * @param {string} containerId
     * @param {string} fileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesFileIdDelete(containerId: string, fileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Upload files into secure file container
     * @param {string} containerId
     * @param {Array<File>} [files]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesPost(containerId: string, files?: Array<File>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecureFilesUploadedModel>>;
    /**
     *
     * @summary Get secure file container
     * @param {string} containerId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdGet(containerId: string, languageCode?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecureContainerModel>>;
    /**
     *
     * @summary Update secure file container
     * @param {string} containerId
     * @param {UpdateSecureContainerCommand} [updateSecureContainerCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdPut(containerId: string, updateSecureContainerCommand?: UpdateSecureContainerCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecureContainerModel>>;
    /**
     *
     * @summary Get secure file containers
     * @param {string} [hospitalId]
     * @param {string} [languageCode]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersGet(hospitalId?: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SecureContainersModel>>;
};
/**
 * SecureContainersApi - factory interface
 * @export
 */
export declare const SecureContainersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Delete secure file
     * @param {string} containerId
     * @param {string} fileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesFileIdDelete(containerId: string, fileId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Upload files into secure file container
     * @param {string} containerId
     * @param {Array<File>} [files]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdFilesPost(containerId: string, files?: Array<File>, options?: any): AxiosPromise<SecureFilesUploadedModel>;
    /**
     *
     * @summary Get secure file container
     * @param {string} containerId
     * @param {string} [languageCode]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdGet(containerId: string, languageCode?: string, options?: any): AxiosPromise<SecureContainerModel>;
    /**
     *
     * @summary Update secure file container
     * @param {string} containerId
     * @param {UpdateSecureContainerCommand} [updateSecureContainerCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersContainerIdPut(containerId: string, updateSecureContainerCommand?: UpdateSecureContainerCommand, options?: any): AxiosPromise<SecureContainerModel>;
    /**
     *
     * @summary Get secure file containers
     * @param {string} [hospitalId]
     * @param {string} [languageCode]
     * @param {number} [page]
     * @param {number} [limit]
     * @param {Date} [lastRetrieved]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SecurecontainersGet(hospitalId?: string, languageCode?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: any): AxiosPromise<SecureContainersModel>;
};
/**
 * Request parameters for apiV2SecurecontainersContainerIdFilesFileIdDelete operation in SecureContainersApi.
 * @export
 * @interface SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDeleteRequest
 */
export interface SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDelete
     */
    readonly containerId: string;
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDelete
     */
    readonly fileId: string;
}
/**
 * Request parameters for apiV2SecurecontainersContainerIdFilesPost operation in SecureContainersApi.
 * @export
 * @interface SecureContainersApiApiV2SecurecontainersContainerIdFilesPostRequest
 */
export interface SecureContainersApiApiV2SecurecontainersContainerIdFilesPostRequest {
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdFilesPost
     */
    readonly containerId: string;
    /**
     *
     * @type {Array<File>}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdFilesPost
     */
    readonly files?: Array<File>;
}
/**
 * Request parameters for apiV2SecurecontainersContainerIdGet operation in SecureContainersApi.
 * @export
 * @interface SecureContainersApiApiV2SecurecontainersContainerIdGetRequest
 */
export interface SecureContainersApiApiV2SecurecontainersContainerIdGetRequest {
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdGet
     */
    readonly containerId: string;
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdGet
     */
    readonly languageCode?: string;
}
/**
 * Request parameters for apiV2SecurecontainersContainerIdPut operation in SecureContainersApi.
 * @export
 * @interface SecureContainersApiApiV2SecurecontainersContainerIdPutRequest
 */
export interface SecureContainersApiApiV2SecurecontainersContainerIdPutRequest {
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdPut
     */
    readonly containerId: string;
    /**
     *
     * @type {UpdateSecureContainerCommand}
     * @memberof SecureContainersApiApiV2SecurecontainersContainerIdPut
     */
    readonly updateSecureContainerCommand?: UpdateSecureContainerCommand;
}
/**
 * Request parameters for apiV2SecurecontainersGet operation in SecureContainersApi.
 * @export
 * @interface SecureContainersApiApiV2SecurecontainersGetRequest
 */
export interface SecureContainersApiApiV2SecurecontainersGetRequest {
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersGet
     */
    readonly hospitalId?: string;
    /**
     *
     * @type {string}
     * @memberof SecureContainersApiApiV2SecurecontainersGet
     */
    readonly languageCode?: string;
    /**
     *
     * @type {number}
     * @memberof SecureContainersApiApiV2SecurecontainersGet
     */
    readonly page?: number;
    /**
     *
     * @type {number}
     * @memberof SecureContainersApiApiV2SecurecontainersGet
     */
    readonly limit?: number;
    /**
     *
     * @type {Date}
     * @memberof SecureContainersApiApiV2SecurecontainersGet
     */
    readonly lastRetrieved?: Date;
}
/**
 * SecureContainersApi - object-oriented interface
 * @export
 * @class SecureContainersApi
 * @extends {BaseAPI}
 */
export declare class SecureContainersApi extends BaseAPI {
    /**
     *
     * @summary Delete secure file
     * @param {SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureContainersApi
     */
    apiV2SecurecontainersContainerIdFilesFileIdDelete(requestParameters: SecureContainersApiApiV2SecurecontainersContainerIdFilesFileIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Upload files into secure file container
     * @param {SecureContainersApiApiV2SecurecontainersContainerIdFilesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureContainersApi
     */
    apiV2SecurecontainersContainerIdFilesPost(requestParameters: SecureContainersApiApiV2SecurecontainersContainerIdFilesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecureFilesUploadedModel, any>>;
    /**
     *
     * @summary Get secure file container
     * @param {SecureContainersApiApiV2SecurecontainersContainerIdGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureContainersApi
     */
    apiV2SecurecontainersContainerIdGet(requestParameters: SecureContainersApiApiV2SecurecontainersContainerIdGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecureContainerModel, any>>;
    /**
     *
     * @summary Update secure file container
     * @param {SecureContainersApiApiV2SecurecontainersContainerIdPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureContainersApi
     */
    apiV2SecurecontainersContainerIdPut(requestParameters: SecureContainersApiApiV2SecurecontainersContainerIdPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecureContainerModel, any>>;
    /**
     *
     * @summary Get secure file containers
     * @param {SecureContainersApiApiV2SecurecontainersGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SecureContainersApi
     */
    apiV2SecurecontainersGet(requestParameters?: SecureContainersApiApiV2SecurecontainersGetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SecureContainersModel, any>>;
}
//# sourceMappingURL=secure-containers-api.d.ts.map