whalecloud-dxp-api-react-native
Version:
This section explains how to use the SDK and illustrates it with an example: - This chapter is essential to learn - For specific business development, see [Bussiness Scenario](https://www.digchan.info/en-US/dxp/user-sso/sign-up) - The Business Scenario pr
912 lines (813 loc) • 73.2 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* DXP API
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document:
*
*
* 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, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
// @ts-ignore
import type { AcquireOtpResp } from '../models';
// @ts-ignore
import type { DxpResponseFinal } from '../models';
// @ts-ignore
import type { ModifyUserAvatarResp } from '../models';
// @ts-ignore
import type { OtpLoginReq } from '../models';
// @ts-ignore
import type { PasswordRulesResp } from '../models';
// @ts-ignore
import type { PrivacyResp } from '../models';
// @ts-ignore
import type { PwdLoginReq } from '../models';
// @ts-ignore
import type { QueryUserProfileResp } from '../models';
// @ts-ignore
import type { RegistrationReq } from '../models';
// @ts-ignore
import type { ResetUserPasswordWithReferenceIdReq } from '../models';
// @ts-ignore
import type { ReusableUserLoginResp } from '../models';
// @ts-ignore
import type { TermsResp } from '../models';
// @ts-ignore
import type { UserExistingResp } from '../models';
// @ts-ignore
import type { UserForMod } from '../models';
// @ts-ignore
import type { VerifyOtpForResetUserPasswordReq } from '../models';
// @ts-ignore
import type { VerifyOtpForResetUserPasswordResp } from '../models';
/**
* UserManagementApi - axios parameter creator
* @export
*/
export const UserManagementApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Query Password Rules
* @summary Query Password Rules
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1CommonPwdRulesGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/common/pwd-rules`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Obtain OTP for login if the user chooses to log in with OTP.
* @summary Acquire an OTP for Login
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginOtpGet: async (loginAcct: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'loginAcct' is not null or undefined
assertParamExists('dxpUserManagementV1LoginOtpGet', 'loginAcct', loginAcct)
const localVarPath = `/dxp/user-management/v1/login/otp`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
if (loginAcct !== undefined) {
localVarQueryParameter['loginAcct'] = loginAcct;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Log in with OTP.
* @summary User Login via OTP
* @param {OtpLoginReq} [otpLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginOtpLoginPost: async (otpLoginReq?: OtpLoginReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/login/otp-login`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(otpLoginReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Log in with a password.
* @summary User Login via Password
* @param {PwdLoginReq} [pwdLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginPwdLoginPost: async (pwdLoginReq?: PwdLoginReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/login/pwd-login`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(pwdLoginReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* User Logout. Required header codes: * Token - Access token.
* @summary User Logout
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LogoutPost: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/logout`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Obtain OTP for password reset.
* @summary Acquire an OTP for Password Reset
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1PasswordResetOtpGet: async (loginAcct: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'loginAcct' is not null or undefined
assertParamExists('dxpUserManagementV1PasswordResetOtpGet', 'loginAcct', loginAcct)
const localVarPath = `/dxp/user-management/v1/password-reset/otp`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
if (loginAcct !== undefined) {
localVarQueryParameter['loginAcct'] = loginAcct;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Verify OTP fro Reset user password.
* @summary Verify OTP for Reset User Password
* @param {VerifyOtpForResetUserPasswordReq} [verifyOtpForResetUserPasswordReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1PasswordResetOtpPost: async (verifyOtpForResetUserPasswordReq?: VerifyOtpForResetUserPasswordReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/password-reset/otp`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(verifyOtpForResetUserPasswordReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Reset user password after verifying identity with OTP.
* @summary Reset User Password with Reference ID
* @param {string} referenceId Temporary token.
* @param {ResetUserPasswordWithReferenceIdReq} [resetUserPasswordWithReferenceIdReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1PasswordResetReferenceIdPost: async (referenceId: string, resetUserPasswordWithReferenceIdReq?: ResetUserPasswordWithReferenceIdReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'referenceId' is not null or undefined
assertParamExists('dxpUserManagementV1PasswordResetReferenceIdPost', 'referenceId', referenceId)
const localVarPath = `/dxp/user-management/v1/password-reset/{referenceId}`
.replace(`{${"referenceId"}}`, encodeURIComponent(String(referenceId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(resetUserPasswordWithReferenceIdReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Obtain OTP for user registration.
* @summary Acquire an OTP for Registration
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1RegistrationOtpGet: async (loginAcct: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'loginAcct' is not null or undefined
assertParamExists('dxpUserManagementV1RegistrationOtpGet', 'loginAcct', loginAcct)
const localVarPath = `/dxp/user-management/v1/registration/otp`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
if (loginAcct !== undefined) {
localVarQueryParameter['loginAcct'] = loginAcct;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Register a user.
* @summary User Registration
* @param {RegistrationReq} [registrationReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1RegistrationPost: async (registrationReq?: RegistrationReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/registration`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(registrationReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query privacy agreement for user registration.
* @summary Query Privacy for User Registration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1RegistrationPrivacyGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/registration/privacy`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query user registration terms.
* @summary Query Terms for User Registration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1RegistrationTermsGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/registration/terms`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Check if a user is already registered.
* @summary Check User Existence
* @param {string} loginAcct User login identifier.
* @param {DxpUserManagementV1RegistrationUserExistingGetLoginAcctTypeEnum} [loginAcctType] Type of user login identifier. Possible values are: / MOBILE/ EMAIL/ ID
* @param {string} [identificationType] The type of identification document.
* @param {string} [nationality] Nationality.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1RegistrationUserExistingGet: async (loginAcct: string, loginAcctType?: DxpUserManagementV1RegistrationUserExistingGetLoginAcctTypeEnum, identificationType?: string, nationality?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'loginAcct' is not null or undefined
assertParamExists('dxpUserManagementV1RegistrationUserExistingGet', 'loginAcct', loginAcct)
const localVarPath = `/dxp/user-management/v1/registration/user-existing`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
if (loginAcctType !== undefined) {
localVarQueryParameter['loginAcctType'] = loginAcctType;
}
if (loginAcct !== undefined) {
localVarQueryParameter['loginAcct'] = loginAcct;
}
if (identificationType !== undefined) {
localVarQueryParameter['identificationType'] = identificationType;
}
if (nationality !== undefined) {
localVarQueryParameter['nationality'] = nationality;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* To enable users to update their avatar. Required header codes: * Token - Access token.
* @summary Modify User Avatar
* @param {File} file MultipartFile data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1UserAvatarPut: async (file: File, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'file' is not null or undefined
assertParamExists('dxpUserManagementV1UserAvatarPut', 'file', file)
const localVarPath = `/dxp/user-management/v1/user/avatar`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
if (file !== undefined) {
localVarFormParams.append('file', file as any);
}
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = localVarFormParams;
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Retrieve Current User Information Based on Access Token. Required header codes: * Token - Access token.
* @summary Query Current User Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1UserProfileGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/user/profile`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Modify User Profile. Required header codes: * Token - Access token.
* @summary Modify User Profile
* @param {UserForMod} [userForMod]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1UserProfilePatch: async (userForMod?: UserForMod, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/user-management/v1/user/profile`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(userForMod, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* UserManagementApi - functional programming interface
* @export
*/
export const UserManagementApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = UserManagementApiAxiosParamCreator(configuration)
return {
/**
* Query Password Rules
* @summary Query Password Rules
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1CommonPwdRulesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PasswordRulesResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1CommonPwdRulesGet(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1CommonPwdRulesGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Obtain OTP for login if the user chooses to log in with OTP.
* @summary Acquire an OTP for Login
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1LoginOtpGet(loginAcct: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AcquireOtpResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1LoginOtpGet(loginAcct, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1LoginOtpGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Log in with OTP.
* @summary User Login via OTP
* @param {OtpLoginReq} [otpLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1LoginOtpLoginPost(otpLoginReq?: OtpLoginReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReusableUserLoginResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1LoginOtpLoginPost(otpLoginReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1LoginOtpLoginPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Log in with a password.
* @summary User Login via Password
* @param {PwdLoginReq} [pwdLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1LoginPwdLoginPost(pwdLoginReq?: PwdLoginReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReusableUserLoginResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1LoginPwdLoginPost(pwdLoginReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1LoginPwdLoginPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* User Logout. Required header codes: * Token - Access token.
* @summary User Logout
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1LogoutPost(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DxpResponseFinal>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1LogoutPost(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1LogoutPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Obtain OTP for password reset.
* @summary Acquire an OTP for Password Reset
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1PasswordResetOtpGet(loginAcct: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AcquireOtpResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1PasswordResetOtpGet(loginAcct, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1PasswordResetOtpGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Verify OTP fro Reset user password.
* @summary Verify OTP for Reset User Password
* @param {VerifyOtpForResetUserPasswordReq} [verifyOtpForResetUserPasswordReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1PasswordResetOtpPost(verifyOtpForResetUserPasswordReq?: VerifyOtpForResetUserPasswordReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyOtpForResetUserPasswordResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1PasswordResetOtpPost(verifyOtpForResetUserPasswordReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1PasswordResetOtpPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Reset user password after verifying identity with OTP.
* @summary Reset User Password with Reference ID
* @param {string} referenceId Temporary token.
* @param {ResetUserPasswordWithReferenceIdReq} [resetUserPasswordWithReferenceIdReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1PasswordResetReferenceIdPost(referenceId: string, resetUserPasswordWithReferenceIdReq?: ResetUserPasswordWithReferenceIdReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DxpResponseFinal>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1PasswordResetReferenceIdPost(referenceId, resetUserPasswordWithReferenceIdReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1PasswordResetReferenceIdPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Obtain OTP for user registration.
* @summary Acquire an OTP for Registration
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1RegistrationOtpGet(loginAcct: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AcquireOtpResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1RegistrationOtpGet(loginAcct, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1RegistrationOtpGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Register a user.
* @summary User Registration
* @param {RegistrationReq} [registrationReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1RegistrationPost(registrationReq?: RegistrationReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReusableUserLoginResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1RegistrationPost(registrationReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1RegistrationPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query privacy agreement for user registration.
* @summary Query Privacy for User Registration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1RegistrationPrivacyGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrivacyResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1RegistrationPrivacyGet(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1RegistrationPrivacyGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query user registration terms.
* @summary Query Terms for User Registration
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1RegistrationTermsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TermsResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1RegistrationTermsGet(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1RegistrationTermsGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Check if a user is already registered.
* @summary Check User Existence
* @param {string} loginAcct User login identifier.
* @param {DxpUserManagementV1RegistrationUserExistingGetLoginAcctTypeEnum} [loginAcctType] Type of user login identifier. Possible values are: / MOBILE/ EMAIL/ ID
* @param {string} [identificationType] The type of identification document.
* @param {string} [nationality] Nationality.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1RegistrationUserExistingGet(loginAcct: string, loginAcctType?: DxpUserManagementV1RegistrationUserExistingGetLoginAcctTypeEnum, identificationType?: string, nationality?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserExistingResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1RegistrationUserExistingGet(loginAcct, loginAcctType, identificationType, nationality, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1RegistrationUserExistingGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* To enable users to update their avatar. Required header codes: * Token - Access token.
* @summary Modify User Avatar
* @param {File} file MultipartFile data.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1UserAvatarPut(file: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModifyUserAvatarResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1UserAvatarPut(file, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1UserAvatarPut']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Retrieve Current User Information Based on Access Token. Required header codes: * Token - Access token.
* @summary Query Current User Profile
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1UserProfileGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryUserProfileResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1UserProfileGet(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1UserProfileGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Modify User Profile. Required header codes: * Token - Access token.
* @summary Modify User Profile
* @param {UserForMod} [userForMod]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpUserManagementV1UserProfilePatch(userForMod?: UserForMod, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DxpResponseFinal>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpUserManagementV1UserProfilePatch(userForMod, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['UserManagementApi.dxpUserManagementV1UserProfilePatch']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* UserManagementApi - factory interface
* @export
*/
export const UserManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = UserManagementApiFp(configuration)
return {
/**
* Query Password Rules
* @summary Query Password Rules
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1CommonPwdRulesGet(options?: any): AxiosPromise<PasswordRulesResp> {
return localVarFp.dxpUserManagementV1CommonPwdRulesGet(options).then((request) => request(axios, basePath));
},
/**
* Obtain OTP for login if the user chooses to log in with OTP.
* @summary Acquire an OTP for Login
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginOtpGet(loginAcct: string, options?: any): AxiosPromise<AcquireOtpResp> {
return localVarFp.dxpUserManagementV1LoginOtpGet(loginAcct, options).then((request) => request(axios, basePath));
},
/**
* Log in with OTP.
* @summary User Login via OTP
* @param {OtpLoginReq} [otpLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginOtpLoginPost(otpLoginReq?: OtpLoginReq, options?: any): AxiosPromise<ReusableUserLoginResp> {
return localVarFp.dxpUserManagementV1LoginOtpLoginPost(otpLoginReq, options).then((request) => request(axios, basePath));
},
/**
* Log in with a password.
* @summary User Login via Password
* @param {PwdLoginReq} [pwdLoginReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LoginPwdLoginPost(pwdLoginReq?: PwdLoginReq, options?: any): AxiosPromise<ReusableUserLoginResp> {
return localVarFp.dxpUserManagementV1LoginPwdLoginPost(pwdLoginReq, options).then((request) => request(axios, basePath));
},
/**
* User Logout. Required header codes: * Token - Access token.
* @summary User Logout
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1LogoutPost(options?: any): AxiosPromise<DxpResponseFinal> {
return localVarFp.dxpUserManagementV1LogoutPost(options).then((request) => request(axios, basePath));
},
/**
* Obtain OTP for password reset.
* @summary Acquire an OTP for Password Reset
* @param {string} loginAcct User login identifier.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpUserManagementV1PasswordResetOtpGet(loginAcct: string, options?: any): AxiosPromise<AcquireOtpResp> {
return localVarFp.dxpUserManagementV1PasswordResetOtpGet(loginAcct, options).then((request) => request(axios, basePath));
},
/**
* Verify OTP fro Reset user password.
* @summary Verify OTP for Reset User Password
* @param {VerifyOtpForResetUserPasswordReq} [verifyOtpForResetUserPa