/** * The Association for Cube Commons * The CubeCommons API caters to each and every whim of the Frontend, i.e. it receives, bundles, packages and formats data exactly as the Frontend needs it. * * The version of the OpenAPI document: 0.9.95 * Contact: tech@cubecommons.ca * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { CreateUserRequest } from '../models'; import { CreateUserResponse } from '../models'; import { EmailAndPasswordJWTRequest } from '../models'; import { EmailForPasswordResetProcess } from '../models'; import { JWTResponse } from '../models'; import { LoginResponse } from '../models'; import { SendContactUsEmail } from '../models'; import { UpdateEmailRequest } from '../models'; import { UpdatePasswordRequest } from '../models'; /** * IdentityApi - axios parameter creator * @export */ export declare const IdentityApiAxiosParamCreator: (configuration?: Configuration) => { /** * Acquire a JWT as an anonymous user. * @summary Acquire a JWT as an anonymous user. * @param {object} body Anonymous JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ anonymousJWT: (body: object, options?: AxiosRequestConfig) => Promise; /** * send an email when the contact us form is filled out. * @summary send an email when the contact us form is filled out. * @param {SendContactUsEmail} sendContactUsEmail Send an email when the contact us form is filled out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactUs: (sendContactUsEmail: SendContactUsEmail, options?: AxiosRequestConfig) => Promise; /** * Trigger forgot password flow. * @summary Trigger forgot password flow. * @param {EmailForPasswordResetProcess} emailForPasswordResetProcess Email to trigger reset process * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword: (emailForPasswordResetProcess: EmailForPasswordResetProcess, options?: AxiosRequestConfig) => Promise; /** * Log user in with username and password. * @summary Login with email and password * @param {EmailAndPasswordJWTRequest} emailAndPasswordJWTRequest Logged-in JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ login: (emailAndPasswordJWTRequest: EmailAndPasswordJWTRequest, options?: AxiosRequestConfig) => Promise; /** * resend the email verification if previous one lapsed. * @summary resend the email verification if previous one lapsed. * @param {object} body resend email verification request * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendEmailVerification: (body: object, options?: AxiosRequestConfig) => Promise; /** * Update user email. * @summary Update user email. * @param {UpdateEmailRequest} updateEmailRequest Update Email * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail: (updateEmailRequest: UpdateEmailRequest, options?: AxiosRequestConfig) => Promise; /** * Update user password. * @summary Update user password. * @param {UpdatePasswordRequest} updatePasswordRequest Update Password * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePassword: (updatePasswordRequest: UpdatePasswordRequest, options?: AxiosRequestConfig) => Promise; /** * Creates a new user. * @summary Create a new user * @param {CreateUserRequest} createUserRequest Creating a new user * @param {*} [options] Override http request option. * @throws {RequiredError} */ user: (createUserRequest: CreateUserRequest, options?: AxiosRequestConfig) => Promise; /** * Verify user email. * @summary Verify user email. * @param {string} token token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmail: (token: string, options?: AxiosRequestConfig) => Promise; }; /** * IdentityApi - functional programming interface * @export */ export declare const IdentityApiFp: (configuration?: Configuration) => { /** * Acquire a JWT as an anonymous user. * @summary Acquire a JWT as an anonymous user. * @param {object} body Anonymous JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ anonymousJWT(body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * send an email when the contact us form is filled out. * @summary send an email when the contact us form is filled out. * @param {SendContactUsEmail} sendContactUsEmail Send an email when the contact us form is filled out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactUs(sendContactUsEmail: SendContactUsEmail, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Trigger forgot password flow. * @summary Trigger forgot password flow. * @param {EmailForPasswordResetProcess} emailForPasswordResetProcess Email to trigger reset process * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword(emailForPasswordResetProcess: EmailForPasswordResetProcess, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Log user in with username and password. * @summary Login with email and password * @param {EmailAndPasswordJWTRequest} emailAndPasswordJWTRequest Logged-in JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(emailAndPasswordJWTRequest: EmailAndPasswordJWTRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * resend the email verification if previous one lapsed. * @summary resend the email verification if previous one lapsed. * @param {object} body resend email verification request * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendEmailVerification(body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update user email. * @summary Update user email. * @param {UpdateEmailRequest} updateEmailRequest Update Email * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail(updateEmailRequest: UpdateEmailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update user password. * @summary Update user password. * @param {UpdatePasswordRequest} updatePasswordRequest Update Password * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePassword(updatePasswordRequest: UpdatePasswordRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new user. * @summary Create a new user * @param {CreateUserRequest} createUserRequest Creating a new user * @param {*} [options] Override http request option. * @throws {RequiredError} */ user(createUserRequest: CreateUserRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verify user email. * @summary Verify user email. * @param {string} token token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmail(token: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * IdentityApi - factory interface * @export */ export declare const IdentityApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Acquire a JWT as an anonymous user. * @summary Acquire a JWT as an anonymous user. * @param {object} body Anonymous JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ anonymousJWT(body: object, options?: any): AxiosPromise; /** * send an email when the contact us form is filled out. * @summary send an email when the contact us form is filled out. * @param {SendContactUsEmail} sendContactUsEmail Send an email when the contact us form is filled out. * @param {*} [options] Override http request option. * @throws {RequiredError} */ contactUs(sendContactUsEmail: SendContactUsEmail, options?: any): AxiosPromise; /** * Trigger forgot password flow. * @summary Trigger forgot password flow. * @param {EmailForPasswordResetProcess} emailForPasswordResetProcess Email to trigger reset process * @param {*} [options] Override http request option. * @throws {RequiredError} */ forgotPassword(emailForPasswordResetProcess: EmailForPasswordResetProcess, options?: any): AxiosPromise; /** * Log user in with username and password. * @summary Login with email and password * @param {EmailAndPasswordJWTRequest} emailAndPasswordJWTRequest Logged-in JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(emailAndPasswordJWTRequest: EmailAndPasswordJWTRequest, options?: any): AxiosPromise; /** * resend the email verification if previous one lapsed. * @summary resend the email verification if previous one lapsed. * @param {object} body resend email verification request * @param {*} [options] Override http request option. * @throws {RequiredError} */ resendEmailVerification(body: object, options?: any): AxiosPromise; /** * Update user email. * @summary Update user email. * @param {UpdateEmailRequest} updateEmailRequest Update Email * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEmail(updateEmailRequest: UpdateEmailRequest, options?: any): AxiosPromise; /** * Update user password. * @summary Update user password. * @param {UpdatePasswordRequest} updatePasswordRequest Update Password * @param {*} [options] Override http request option. * @throws {RequiredError} */ updatePassword(updatePasswordRequest: UpdatePasswordRequest, options?: any): AxiosPromise; /** * Creates a new user. * @summary Create a new user * @param {CreateUserRequest} createUserRequest Creating a new user * @param {*} [options] Override http request option. * @throws {RequiredError} */ user(createUserRequest: CreateUserRequest, options?: any): AxiosPromise; /** * Verify user email. * @summary Verify user email. * @param {string} token token * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmail(token: string, options?: any): AxiosPromise; }; /** * IdentityApi - interface * @export * @interface IdentityApi */ export interface IdentityApiInterface { /** * Acquire a JWT as an anonymous user. * @summary Acquire a JWT as an anonymous user. * @param {object} body Anonymous JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ anonymousJWT(body: object, options?: AxiosRequestConfig): AxiosPromise; /** * send an email when the contact us form is filled out. * @summary send an email when the contact us form is filled out. * @param {SendContactUsEmail} sendContactUsEmail Send an email when the contact us form is filled out. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ contactUs(sendContactUsEmail: SendContactUsEmail, options?: AxiosRequestConfig): AxiosPromise; /** * Trigger forgot password flow. * @summary Trigger forgot password flow. * @param {EmailForPasswordResetProcess} emailForPasswordResetProcess Email to trigger reset process * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ forgotPassword(emailForPasswordResetProcess: EmailForPasswordResetProcess, options?: AxiosRequestConfig): AxiosPromise; /** * Log user in with username and password. * @summary Login with email and password * @param {EmailAndPasswordJWTRequest} emailAndPasswordJWTRequest Logged-in JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ login(emailAndPasswordJWTRequest: EmailAndPasswordJWTRequest, options?: AxiosRequestConfig): AxiosPromise; /** * resend the email verification if previous one lapsed. * @summary resend the email verification if previous one lapsed. * @param {object} body resend email verification request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ resendEmailVerification(body: object, options?: AxiosRequestConfig): AxiosPromise; /** * Update user email. * @summary Update user email. * @param {UpdateEmailRequest} updateEmailRequest Update Email * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ updateEmail(updateEmailRequest: UpdateEmailRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Update user password. * @summary Update user password. * @param {UpdatePasswordRequest} updatePasswordRequest Update Password * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ updatePassword(updatePasswordRequest: UpdatePasswordRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Creates a new user. * @summary Create a new user * @param {CreateUserRequest} createUserRequest Creating a new user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ user(createUserRequest: CreateUserRequest, options?: AxiosRequestConfig): AxiosPromise; /** * Verify user email. * @summary Verify user email. * @param {string} token token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApiInterface */ verifyEmail(token: string, options?: AxiosRequestConfig): AxiosPromise; } /** * IdentityApi - object-oriented interface * @export * @class IdentityApi * @extends {BaseAPI} */ export declare class IdentityApi extends BaseAPI implements IdentityApiInterface { /** * Acquire a JWT as an anonymous user. * @summary Acquire a JWT as an anonymous user. * @param {object} body Anonymous JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ anonymousJWT(body: object, options?: AxiosRequestConfig): Promise>; /** * send an email when the contact us form is filled out. * @summary send an email when the contact us form is filled out. * @param {SendContactUsEmail} sendContactUsEmail Send an email when the contact us form is filled out. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ contactUs(sendContactUsEmail: SendContactUsEmail, options?: AxiosRequestConfig): Promise>; /** * Trigger forgot password flow. * @summary Trigger forgot password flow. * @param {EmailForPasswordResetProcess} emailForPasswordResetProcess Email to trigger reset process * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ forgotPassword(emailForPasswordResetProcess: EmailForPasswordResetProcess, options?: AxiosRequestConfig): Promise>; /** * Log user in with username and password. * @summary Login with email and password * @param {EmailAndPasswordJWTRequest} emailAndPasswordJWTRequest Logged-in JWT request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ login(emailAndPasswordJWTRequest: EmailAndPasswordJWTRequest, options?: AxiosRequestConfig): Promise>; /** * resend the email verification if previous one lapsed. * @summary resend the email verification if previous one lapsed. * @param {object} body resend email verification request * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ resendEmailVerification(body: object, options?: AxiosRequestConfig): Promise>; /** * Update user email. * @summary Update user email. * @param {UpdateEmailRequest} updateEmailRequest Update Email * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ updateEmail(updateEmailRequest: UpdateEmailRequest, options?: AxiosRequestConfig): Promise>; /** * Update user password. * @summary Update user password. * @param {UpdatePasswordRequest} updatePasswordRequest Update Password * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ updatePassword(updatePasswordRequest: UpdatePasswordRequest, options?: AxiosRequestConfig): Promise>; /** * Creates a new user. * @summary Create a new user * @param {CreateUserRequest} createUserRequest Creating a new user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ user(createUserRequest: CreateUserRequest, options?: AxiosRequestConfig): Promise>; /** * Verify user email. * @summary Verify user email. * @param {string} token token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof IdentityApi */ verifyEmail(token: string, options?: AxiosRequestConfig): Promise>; }