ch-api-client-typescript2/lib/api/signup-verifications-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 { ConfirmSignupIdentityEmailCommand } from '../models';
import { ConfirmSignupPhoneNumberCommand } from '../models';
import { SendSignupVerificationEmailCommand } from '../models';
import { SendSignupVerificationSmsCommand } from '../models';
/**
 * SignupVerificationsApi - axios parameter creator
 * @export
 */
export declare const SignupVerificationsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Confirm sign-up email verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupIdentityEmailCommand} [confirmSignupIdentityEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmidentityemailPost: (xCloudhospitalPlatform?: string, confirmSignupIdentityEmailCommand?: ConfirmSignupIdentityEmailCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Confirm sign-up phone number verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupPhoneNumberCommand} [confirmSignupPhoneNumberCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmphonenumberPost: (xCloudhospitalPlatform?: string, confirmSignupPhoneNumberCommand?: ConfirmSignupPhoneNumberCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Send a sign-up verification email via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationEmailCommand} [sendSignupVerificationEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationemailPost: (xCloudhospitalPlatform?: string, sendSignupVerificationEmailCommand?: SendSignupVerificationEmailCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Send a sign-up verification SMS via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationSmsCommand} [sendSignupVerificationSmsCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationsmsPost: (xCloudhospitalPlatform?: string, sendSignupVerificationSmsCommand?: SendSignupVerificationSmsCommand, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * SignupVerificationsApi - functional programming interface
 * @export
 */
export declare const SignupVerificationsApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Confirm sign-up email verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupIdentityEmailCommand} [confirmSignupIdentityEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmidentityemailPost(xCloudhospitalPlatform?: string, confirmSignupIdentityEmailCommand?: ConfirmSignupIdentityEmailCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Confirm sign-up phone number verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupPhoneNumberCommand} [confirmSignupPhoneNumberCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmphonenumberPost(xCloudhospitalPlatform?: string, confirmSignupPhoneNumberCommand?: ConfirmSignupPhoneNumberCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Send a sign-up verification email via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationEmailCommand} [sendSignupVerificationEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationemailPost(xCloudhospitalPlatform?: string, sendSignupVerificationEmailCommand?: SendSignupVerificationEmailCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
    /**
     *
     * @summary Send a sign-up verification SMS via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationSmsCommand} [sendSignupVerificationSmsCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationsmsPost(xCloudhospitalPlatform?: string, sendSignupVerificationSmsCommand?: SendSignupVerificationSmsCommand, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
};
/**
 * SignupVerificationsApi - factory interface
 * @export
 */
export declare const SignupVerificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Confirm sign-up email verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupIdentityEmailCommand} [confirmSignupIdentityEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmidentityemailPost(xCloudhospitalPlatform?: string, confirmSignupIdentityEmailCommand?: ConfirmSignupIdentityEmailCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Confirm sign-up phone number verification via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {ConfirmSignupPhoneNumberCommand} [confirmSignupPhoneNumberCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsConfirmphonenumberPost(xCloudhospitalPlatform?: string, confirmSignupPhoneNumberCommand?: ConfirmSignupPhoneNumberCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Send a sign-up verification email via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationEmailCommand} [sendSignupVerificationEmailCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationemailPost(xCloudhospitalPlatform?: string, sendSignupVerificationEmailCommand?: SendSignupVerificationEmailCommand, options?: any): AxiosPromise<boolean>;
    /**
     *
     * @summary Send a sign-up verification SMS via IdentityAdmin.
     * @param {string} [xCloudhospitalPlatform]
     * @param {SendSignupVerificationSmsCommand} [sendSignupVerificationSmsCommand]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    apiV2SignupVerificationsSendverificationsmsPost(xCloudhospitalPlatform?: string, sendSignupVerificationSmsCommand?: SendSignupVerificationSmsCommand, options?: any): AxiosPromise<boolean>;
};
/**
 * Request parameters for apiV2SignupVerificationsConfirmidentityemailPost operation in SignupVerificationsApi.
 * @export
 * @interface SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPostRequest
 */
export interface SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPostRequest {
    /**
     *
     * @type {string}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPost
     */
    readonly xCloudhospitalPlatform?: string;
    /**
     *
     * @type {ConfirmSignupIdentityEmailCommand}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPost
     */
    readonly confirmSignupIdentityEmailCommand?: ConfirmSignupIdentityEmailCommand;
}
/**
 * Request parameters for apiV2SignupVerificationsConfirmphonenumberPost operation in SignupVerificationsApi.
 * @export
 * @interface SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPostRequest
 */
export interface SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPostRequest {
    /**
     *
     * @type {string}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPost
     */
    readonly xCloudhospitalPlatform?: string;
    /**
     *
     * @type {ConfirmSignupPhoneNumberCommand}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPost
     */
    readonly confirmSignupPhoneNumberCommand?: ConfirmSignupPhoneNumberCommand;
}
/**
 * Request parameters for apiV2SignupVerificationsSendverificationemailPost operation in SignupVerificationsApi.
 * @export
 * @interface SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPostRequest
 */
export interface SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPostRequest {
    /**
     *
     * @type {string}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPost
     */
    readonly xCloudhospitalPlatform?: string;
    /**
     *
     * @type {SendSignupVerificationEmailCommand}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPost
     */
    readonly sendSignupVerificationEmailCommand?: SendSignupVerificationEmailCommand;
}
/**
 * Request parameters for apiV2SignupVerificationsSendverificationsmsPost operation in SignupVerificationsApi.
 * @export
 * @interface SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPostRequest
 */
export interface SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPostRequest {
    /**
     *
     * @type {string}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPost
     */
    readonly xCloudhospitalPlatform?: string;
    /**
     *
     * @type {SendSignupVerificationSmsCommand}
     * @memberof SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPost
     */
    readonly sendSignupVerificationSmsCommand?: SendSignupVerificationSmsCommand;
}
/**
 * SignupVerificationsApi - object-oriented interface
 * @export
 * @class SignupVerificationsApi
 * @extends {BaseAPI}
 */
export declare class SignupVerificationsApi extends BaseAPI {
    /**
     *
     * @summary Confirm sign-up email verification via IdentityAdmin.
     * @param {SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignupVerificationsApi
     */
    apiV2SignupVerificationsConfirmidentityemailPost(requestParameters?: SignupVerificationsApiApiV2SignupVerificationsConfirmidentityemailPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Confirm sign-up phone number verification via IdentityAdmin.
     * @param {SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignupVerificationsApi
     */
    apiV2SignupVerificationsConfirmphonenumberPost(requestParameters?: SignupVerificationsApiApiV2SignupVerificationsConfirmphonenumberPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Send a sign-up verification email via IdentityAdmin.
     * @param {SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignupVerificationsApi
     */
    apiV2SignupVerificationsSendverificationemailPost(requestParameters?: SignupVerificationsApiApiV2SignupVerificationsSendverificationemailPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
    /**
     *
     * @summary Send a sign-up verification SMS via IdentityAdmin.
     * @param {SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPostRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SignupVerificationsApi
     */
    apiV2SignupVerificationsSendverificationsmsPost(requestParameters?: SignupVerificationsApiApiV2SignupVerificationsSendverificationsmsPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
}
//# sourceMappingURL=signup-verifications-api.d.ts.map