ch-api-client-typescript2/lib/api/profiles-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 { ChangeEmailCommand } from '../models';
import { ConfirmEmailCommand } from '../models';
import { CreateProfileCommand } from '../models';
import { UpdateProfileCommand } from '../models';
import { UserModel } from '../models';
/**
 * ProfilesApi - axios parameter creator
 * @export
 */
export declare const ProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Sample request:        POST /api/v1/profiles/changeEmail      {          \"email\": \"user@example.com\"      }
     * @summary Change user\'s email on both Identity and Api.
     * @param {ChangeEmailCommand} [changeEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesChangeemailPost: (changeEmailCommand?: ChangeEmailCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Confirm email.
     * @param {ConfirmEmailCommand} [confirmEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesConfirmemailPost: (confirmEmailCommand?: ConfirmEmailCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get Profile.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesGet: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Create a Profile.
     * @param {CreateProfileCommand} [createProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPost: (createProfileCommand?: CreateProfileCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete Profile.
     * @param {string} profileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesProfileIdDelete: (profileId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Update Profile.
     * @param {UpdateProfileCommand} [updateProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPut: (updateProfileCommand?: UpdateProfileCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Sync profile between api db and identity db (Based on identity db)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesSyncPost: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * ProfilesApi - functional programming interface
 * @export
 */
export declare const ProfilesApiFp: (configuration?: Configuration) => {
    /**
     * Sample request:        POST /api/v1/profiles/changeEmail      {          \"email\": \"user@example.com\"      }
     * @summary Change user\'s email on both Identity and Api.
     * @param {ChangeEmailCommand} [changeEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesChangeemailPost(changeEmailCommand?: ChangeEmailCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Confirm email.
     * @param {ConfirmEmailCommand} [confirmEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesConfirmemailPost(confirmEmailCommand?: ConfirmEmailCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Get Profile.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserModel>>;
    /**
     *
     * @summary Create a Profile.
     * @param {CreateProfileCommand} [createProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPost(createProfileCommand?: CreateProfileCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserModel>>;
    /**
     *
     * @summary Delete Profile.
     * @param {string} profileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesProfileIdDelete(profileId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Update Profile.
     * @param {UpdateProfileCommand} [updateProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPut(updateProfileCommand?: UpdateProfileCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserModel>>;
    /**
     *
     * @summary Sync profile between api db and identity db (Based on identity db)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesSyncPost(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
};
/**
 * ProfilesApi - factory interface
 * @export
 */
export declare const ProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Sample request:        POST /api/v1/profiles/changeEmail      {          \"email\": \"user@example.com\"      }
     * @summary Change user\'s email on both Identity and Api.
     * @param {ChangeEmailCommand} [changeEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesChangeemailPost(changeEmailCommand?: ChangeEmailCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Confirm email.
     * @param {ConfirmEmailCommand} [confirmEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesConfirmemailPost(confirmEmailCommand?: ConfirmEmailCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Get Profile.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesGet(options?: any): AxiosPromise<UserModel>;
    /**
     *
     * @summary Create a Profile.
     * @param {CreateProfileCommand} [createProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPost(createProfileCommand?: CreateProfileCommand, options?: any): AxiosPromise<UserModel>;
    /**
     *
     * @summary Delete Profile.
     * @param {string} profileId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesProfileIdDelete(profileId: string, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Update Profile.
     * @param {UpdateProfileCommand} [updateProfileCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesPut(updateProfileCommand?: UpdateProfileCommand, options?: any): AxiosPromise<UserModel>;
    /**
     *
     * @summary Sync profile between api db and identity db (Based on identity db)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2ProfilesSyncPost(options?: any): AxiosPromise<boolean>;
};
/**
 * Request parameters for apiV2ProfilesChangeemailPost operation in ProfilesApi.
 * @export
 * @interface ProfilesApiApiV2ProfilesChangeemailPostRequest
 */
export interface ProfilesApiApiV2ProfilesChangeemailPostRequest {
    /**
     *
     * @type {ChangeEmailCommand}
     * @memberof ProfilesApiApiV2ProfilesChangeemailPost
     */
    readonly changeEmailCommand?: ChangeEmailCommand;
}
/**
 * Request parameters for apiV2ProfilesConfirmemailPost operation in ProfilesApi.
 * @export
 * @interface ProfilesApiApiV2ProfilesConfirmemailPostRequest
 */
export interface ProfilesApiApiV2ProfilesConfirmemailPostRequest {
    /**
     *
     * @type {ConfirmEmailCommand}
     * @memberof ProfilesApiApiV2ProfilesConfirmemailPost
     */
    readonly confirmEmailCommand?: ConfirmEmailCommand;
}
/**
 * Request parameters for apiV2ProfilesPost operation in ProfilesApi.
 * @export
 * @interface ProfilesApiApiV2ProfilesPostRequest
 */
export interface ProfilesApiApiV2ProfilesPostRequest {
    /**
     *
     * @type {CreateProfileCommand}
     * @memberof ProfilesApiApiV2ProfilesPost
     */
    readonly createProfileCommand?: CreateProfileCommand;
}
/**
 * Request parameters for apiV2ProfilesProfileIdDelete operation in ProfilesApi.
 * @export
 * @interface ProfilesApiApiV2ProfilesProfileIdDeleteRequest
 */
export interface ProfilesApiApiV2ProfilesProfileIdDeleteRequest {
    /**
     *
     * @type {string}
     * @memberof ProfilesApiApiV2ProfilesProfileIdDelete
     */
    readonly profileId: string;
}
/**
 * Request parameters for apiV2ProfilesPut operation in ProfilesApi.
 * @export
 * @interface ProfilesApiApiV2ProfilesPutRequest
 */
export interface ProfilesApiApiV2ProfilesPutRequest {
    /**
     *
     * @type {UpdateProfileCommand}
     * @memberof ProfilesApiApiV2ProfilesPut
     */
    readonly updateProfileCommand?: UpdateProfileCommand;
}
/**
 * ProfilesApi - object-oriented interface
 * @export
 * @class ProfilesApi
 * @extends {BaseAPI}
 */
export declare class ProfilesApi extends BaseAPI {
    /**
     * Sample request:        POST /api/v1/profiles/changeEmail      {          \"email\": \"user@example.com\"      }
     * @summary Change user\'s email on both Identity and Api.
     * @param {ProfilesApiApiV2ProfilesChangeemailPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesChangeemailPost(requestParameters?: ProfilesApiApiV2ProfilesChangeemailPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Confirm email.
     * @param {ProfilesApiApiV2ProfilesConfirmemailPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesConfirmemailPost(requestParameters?: ProfilesApiApiV2ProfilesConfirmemailPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Get Profile.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesGet(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserModel, any>>;
    /**
     *
     * @summary Create a Profile.
     * @param {ProfilesApiApiV2ProfilesPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesPost(requestParameters?: ProfilesApiApiV2ProfilesPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserModel, any>>;
    /**
     *
     * @summary Delete Profile.
     * @param {ProfilesApiApiV2ProfilesProfileIdDeleteRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesProfileIdDelete(requestParameters: ProfilesApiApiV2ProfilesProfileIdDeleteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Update Profile.
     * @param {ProfilesApiApiV2ProfilesPutRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesPut(requestParameters?: ProfilesApiApiV2ProfilesPutRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserModel, any>>;
    /**
     *
     * @summary Sync profile between api db and identity db (Based on identity db)
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof ProfilesApi
     */
    apiV2ProfilesSyncPost(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
}
//# sourceMappingURL=profiles-api.d.ts.map