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
877 lines (793 loc) • 52.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 { DxpProductOrderingV1OrdersListPostRequest } from '../models';
// @ts-ignore
import type { GenerateContractResp } from '../models';
// @ts-ignore
import type { OrderReasonResponse } from '../models';
// @ts-ignore
import type { OrderStatesResponse } from '../models';
// @ts-ignore
import type { PurchasePackageCalcFeeReq } from '../models';
// @ts-ignore
import type { PurchasePackageCalcFeeResp } from '../models';
// @ts-ignore
import type { PurchasePackageReq } from '../models';
// @ts-ignore
import type { PurchasePackageResp } from '../models';
// @ts-ignore
import type { QueryOrderDetailResp } from '../models';
// @ts-ignore
import type { QueryOrderListResp } from '../models';
// @ts-ignore
import type { QueryRenewAgreementResp } from '../models';
// @ts-ignore
import type { RenewAgreementCalcFeeReq } from '../models';
// @ts-ignore
import type { RenewAgreementCalcFeeResp } from '../models';
// @ts-ignore
import type { RenewAgreementReq } from '../models';
// @ts-ignore
import type { RenewAgreementResp } from '../models';
/**
* ProductOrderingApi - axios parameter creator
* @export
*/
export const ProductOrderingApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Query Order Reasons
* @param {string} businessEvent Business event.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersBusinessEventReasonsGet: async (businessEvent: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'businessEvent' is not null or undefined
assertParamExists('dxpProductOrderingV1OrdersBusinessEventReasonsGet', 'businessEvent', businessEvent)
const localVarPath = `/dxp/product-ordering/v1/orders/{businessEvent}/reasons`
.replace(`{${"businessEvent"}}`, encodeURIComponent(String(businessEvent)));
// 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 order details based on order number. Note: If scopes are not provided, only basic order information is returned.
* @summary Query Order Detail
* @param {string} [orderNbr] Order Number, unique identifier for the order.
* @param {string} [scopes] The scope or context in which the query is being executed. Possible Value:offerSpecification, feeList, paymentList
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersDetailGet: async (orderNbr?: string, scopes?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/orders/detail`;
// 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 (orderNbr !== undefined) {
localVarQueryParameter['orderNbr'] = orderNbr;
}
if (scopes !== undefined) {
localVarQueryParameter['scopes'] = scopes;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query the order list. Note: Not all query conditions can be empty.
* @summary Query Order List
* @param {DxpProductOrderingV1OrdersListPostRequest} [dxpProductOrderingV1OrdersListPostRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersListPost: async (dxpProductOrderingV1OrdersListPostRequest?: DxpProductOrderingV1OrdersListPostRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/orders/list`;
// 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(dxpProductOrderingV1OrdersListPostRequest, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
*
* @summary Query Order States
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersStatesGet: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/orders/states`;
// 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,
};
},
/**
* Calculate renewal fee. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement Calculate Fee
* @param {RenewAgreementCalcFeeReq} [renewAgreementCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementCalcFeePost: async (renewAgreementCalcFeeReq?: RenewAgreementCalcFeeReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/renew-agreement/calc-fee`;
// 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(renewAgreementCalcFeeReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Generate renewal contract. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Generate Contract Of Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementGenerateContractPost: async (renewAgreementReq?: RenewAgreementReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/renew-agreement/generate-contract`;
// 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(renewAgreementReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Renew agreement. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementPost: async (renewAgreementReq?: RenewAgreementReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/renew-agreement`;
// 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(renewAgreementReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query the list of renewal promotions based on subscriber ID, customer number, and main plan number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Renew Agreement Promotions
* @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
* @param {string} mainOfferNbr The current main offer number.
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementPromotionsGet: async (custNbr: string, mainOfferNbr: string, subsId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'custNbr' is not null or undefined
assertParamExists('dxpProductOrderingV1RenewAgreementPromotionsGet', 'custNbr', custNbr)
// verify required parameter 'mainOfferNbr' is not null or undefined
assertParamExists('dxpProductOrderingV1RenewAgreementPromotionsGet', 'mainOfferNbr', mainOfferNbr)
const localVarPath = `/dxp/product-ordering/v1/renew-agreement/promotions`;
// 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 (subsId !== undefined) {
localVarQueryParameter['subsId'] = subsId;
}
if (custNbr !== undefined) {
localVarQueryParameter['custNbr'] = custNbr;
}
if (mainOfferNbr !== undefined) {
localVarQueryParameter['mainOfferNbr'] = mainOfferNbr;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Calculate fee for purchasing optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package Calculate Fee
* @param {PurchasePackageCalcFeeReq} [purchasePackageCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1SetVasCalcFeePost: async (purchasePackageCalcFeeReq?: PurchasePackageCalcFeeReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/set-vas/calc-fee`;
// 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(purchasePackageCalcFeeReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Purchase optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package
* @param {PurchasePackageReq} [purchasePackageReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1SetVasPost: async (purchasePackageReq?: PurchasePackageReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/product-ordering/v1/set-vas`;
// 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(purchasePackageReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* ProductOrderingApi - functional programming interface
* @export
*/
export const ProductOrderingApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = ProductOrderingApiAxiosParamCreator(configuration)
return {
/**
*
* @summary Query Order Reasons
* @param {string} businessEvent Business event.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderReasonResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1OrdersBusinessEventReasonsGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query order details based on order number. Note: If scopes are not provided, only basic order information is returned.
* @summary Query Order Detail
* @param {string} [orderNbr] Order Number, unique identifier for the order.
* @param {string} [scopes] The scope or context in which the query is being executed. Possible Value:offerSpecification, feeList, paymentList
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1OrdersDetailGet(orderNbr?: string, scopes?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryOrderDetailResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1OrdersDetailGet(orderNbr, scopes, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1OrdersDetailGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query the order list. Note: Not all query conditions can be empty.
* @summary Query Order List
* @param {DxpProductOrderingV1OrdersListPostRequest} [dxpProductOrderingV1OrdersListPostRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest?: DxpProductOrderingV1OrdersListPostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryOrderListResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1OrdersListPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
*
* @summary Query Order States
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1OrdersStatesGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatesResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1OrdersStatesGet(options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1OrdersStatesGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Calculate renewal fee. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement Calculate Fee
* @param {RenewAgreementCalcFeeReq} [renewAgreementCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq?: RenewAgreementCalcFeeReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RenewAgreementCalcFeeResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1RenewAgreementCalcFeePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Generate renewal contract. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Generate Contract Of Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateContractResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1RenewAgreementGenerateContractPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Renew agreement. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1RenewAgreementPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RenewAgreementResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1RenewAgreementPost(renewAgreementReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1RenewAgreementPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query the list of renewal promotions based on subscriber ID, customer number, and main plan number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Renew Agreement Promotions
* @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
* @param {string} mainOfferNbr The current main offer number.
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1RenewAgreementPromotionsGet(custNbr: string, mainOfferNbr: string, subsId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryRenewAgreementResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1RenewAgreementPromotionsGet(custNbr, mainOfferNbr, subsId, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1RenewAgreementPromotionsGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Calculate fee for purchasing optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package Calculate Fee
* @param {PurchasePackageCalcFeeReq} [purchasePackageCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1SetVasCalcFeePost(purchasePackageCalcFeeReq?: PurchasePackageCalcFeeReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchasePackageCalcFeeResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1SetVasCalcFeePost(purchasePackageCalcFeeReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1SetVasCalcFeePost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Purchase optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package
* @param {PurchasePackageReq} [purchasePackageReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpProductOrderingV1SetVasPost(purchasePackageReq?: PurchasePackageReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchasePackageResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProductOrderingV1SetVasPost(purchasePackageReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['ProductOrderingApi.dxpProductOrderingV1SetVasPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* ProductOrderingApi - factory interface
* @export
*/
export const ProductOrderingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = ProductOrderingApiFp(configuration)
return {
/**
*
* @summary Query Order Reasons
* @param {string} businessEvent Business event.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent: string, options?: any): AxiosPromise<OrderReasonResponse> {
return localVarFp.dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent, options).then((request) => request(axios, basePath));
},
/**
* Query order details based on order number. Note: If scopes are not provided, only basic order information is returned.
* @summary Query Order Detail
* @param {string} [orderNbr] Order Number, unique identifier for the order.
* @param {string} [scopes] The scope or context in which the query is being executed. Possible Value:offerSpecification, feeList, paymentList
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersDetailGet(orderNbr?: string, scopes?: string, options?: any): AxiosPromise<QueryOrderDetailResp> {
return localVarFp.dxpProductOrderingV1OrdersDetailGet(orderNbr, scopes, options).then((request) => request(axios, basePath));
},
/**
* Query the order list. Note: Not all query conditions can be empty.
* @summary Query Order List
* @param {DxpProductOrderingV1OrdersListPostRequest} [dxpProductOrderingV1OrdersListPostRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest?: DxpProductOrderingV1OrdersListPostRequest, options?: any): AxiosPromise<QueryOrderListResp> {
return localVarFp.dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest, options).then((request) => request(axios, basePath));
},
/**
*
* @summary Query Order States
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1OrdersStatesGet(options?: any): AxiosPromise<OrderStatesResponse> {
return localVarFp.dxpProductOrderingV1OrdersStatesGet(options).then((request) => request(axios, basePath));
},
/**
* Calculate renewal fee. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement Calculate Fee
* @param {RenewAgreementCalcFeeReq} [renewAgreementCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq?: RenewAgreementCalcFeeReq, options?: any): AxiosPromise<RenewAgreementCalcFeeResp> {
return localVarFp.dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq, options).then((request) => request(axios, basePath));
},
/**
* Generate renewal contract. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Generate Contract Of Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq?: RenewAgreementReq, options?: any): AxiosPromise<GenerateContractResp> {
return localVarFp.dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq, options).then((request) => request(axios, basePath));
},
/**
* Renew agreement. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementPost(renewAgreementReq?: RenewAgreementReq, options?: any): AxiosPromise<RenewAgreementResp> {
return localVarFp.dxpProductOrderingV1RenewAgreementPost(renewAgreementReq, options).then((request) => request(axios, basePath));
},
/**
* Query the list of renewal promotions based on subscriber ID, customer number, and main plan number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Renew Agreement Promotions
* @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
* @param {string} mainOfferNbr The current main offer number.
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1RenewAgreementPromotionsGet(custNbr: string, mainOfferNbr: string, subsId?: number, options?: any): AxiosPromise<QueryRenewAgreementResp> {
return localVarFp.dxpProductOrderingV1RenewAgreementPromotionsGet(custNbr, mainOfferNbr, subsId, options).then((request) => request(axios, basePath));
},
/**
* Calculate fee for purchasing optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package Calculate Fee
* @param {PurchasePackageCalcFeeReq} [purchasePackageCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1SetVasCalcFeePost(purchasePackageCalcFeeReq?: PurchasePackageCalcFeeReq, options?: any): AxiosPromise<PurchasePackageCalcFeeResp> {
return localVarFp.dxpProductOrderingV1SetVasCalcFeePost(purchasePackageCalcFeeReq, options).then((request) => request(axios, basePath));
},
/**
* Purchase optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package
* @param {PurchasePackageReq} [purchasePackageReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpProductOrderingV1SetVasPost(purchasePackageReq?: PurchasePackageReq, options?: any): AxiosPromise<PurchasePackageResp> {
return localVarFp.dxpProductOrderingV1SetVasPost(purchasePackageReq, options).then((request) => request(axios, basePath));
},
};
};
/**
* ProductOrderingApi - interface
* @export
* @interface ProductOrderingApi
*/
export interface ProductOrderingApiInterface {
/**
*
* @summary Query Order Reasons
* @param {string} businessEvent Business event.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent: string, options?: RawAxiosRequestConfig): AxiosPromise<OrderReasonResponse>;
/**
* Query order details based on order number. Note: If scopes are not provided, only basic order information is returned.
* @summary Query Order Detail
* @param {string} [orderNbr] Order Number, unique identifier for the order.
* @param {string} [scopes] The scope or context in which the query is being executed. Possible Value:offerSpecification, feeList, paymentList
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1OrdersDetailGet(orderNbr?: string, scopes?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryOrderDetailResp>;
/**
* Query the order list. Note: Not all query conditions can be empty.
* @summary Query Order List
* @param {DxpProductOrderingV1OrdersListPostRequest} [dxpProductOrderingV1OrdersListPostRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest?: DxpProductOrderingV1OrdersListPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<QueryOrderListResp>;
/**
*
* @summary Query Order States
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1OrdersStatesGet(options?: RawAxiosRequestConfig): AxiosPromise<OrderStatesResponse>;
/**
* Calculate renewal fee. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement Calculate Fee
* @param {RenewAgreementCalcFeeReq} [renewAgreementCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq?: RenewAgreementCalcFeeReq, options?: RawAxiosRequestConfig): AxiosPromise<RenewAgreementCalcFeeResp>;
/**
* Generate renewal contract. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Generate Contract Of Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig): AxiosPromise<GenerateContractResp>;
/**
* Renew agreement. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1RenewAgreementPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig): AxiosPromise<RenewAgreementResp>;
/**
* Query the list of renewal promotions based on subscriber ID, customer number, and main plan number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Renew Agreement Promotions
* @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
* @param {string} mainOfferNbr The current main offer number.
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1RenewAgreementPromotionsGet(custNbr: string, mainOfferNbr: string, subsId?: number, options?: RawAxiosRequestConfig): AxiosPromise<QueryRenewAgreementResp>;
/**
* Calculate fee for purchasing optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package Calculate Fee
* @param {PurchasePackageCalcFeeReq} [purchasePackageCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1SetVasCalcFeePost(purchasePackageCalcFeeReq?: PurchasePackageCalcFeeReq, options?: RawAxiosRequestConfig): AxiosPromise<PurchasePackageCalcFeeResp>;
/**
* Purchase optional packages/functional products. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Purchase Package
* @param {PurchasePackageReq} [purchasePackageReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApiInterface
*/
dxpProductOrderingV1SetVasPost(purchasePackageReq?: PurchasePackageReq, options?: RawAxiosRequestConfig): AxiosPromise<PurchasePackageResp>;
}
/**
* ProductOrderingApi - object-oriented interface
* @export
* @class ProductOrderingApi
* @extends {BaseAPI}
*/
export class ProductOrderingApi extends BaseAPI implements ProductOrderingApiInterface {
/**
*
* @summary Query Order Reasons
* @param {string} businessEvent Business event.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent: string, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1OrdersBusinessEventReasonsGet(businessEvent, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query order details based on order number. Note: If scopes are not provided, only basic order information is returned.
* @summary Query Order Detail
* @param {string} [orderNbr] Order Number, unique identifier for the order.
* @param {string} [scopes] The scope or context in which the query is being executed. Possible Value:offerSpecification, feeList, paymentList
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1OrdersDetailGet(orderNbr?: string, scopes?: string, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1OrdersDetailGet(orderNbr, scopes, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query the order list. Note: Not all query conditions can be empty.
* @summary Query Order List
* @param {DxpProductOrderingV1OrdersListPostRequest} [dxpProductOrderingV1OrdersListPostRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest?: DxpProductOrderingV1OrdersListPostRequest, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1OrdersListPost(dxpProductOrderingV1OrdersListPostRequest, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Query Order States
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1OrdersStatesGet(options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1OrdersStatesGet(options).then((request) => request(this.axios, this.basePath));
}
/**
* Calculate renewal fee. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement Calculate Fee
* @param {RenewAgreementCalcFeeReq} [renewAgreementCalcFeeReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq?: RenewAgreementCalcFeeReq, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1RenewAgreementCalcFeePost(renewAgreementCalcFeeReq, options).then((request) => request(this.axios, this.basePath));
}
/**
* Generate renewal contract. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Generate Contract Of Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1RenewAgreementGenerateContractPost(renewAgreementReq, options).then((request) => request(this.axios, this.basePath));
}
/**
* Renew agreement. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Renew Agreement
* @param {RenewAgreementReq} [renewAgreementReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ProductOrderingApi
*/
public dxpProductOrderingV1RenewAgreementPost(renewAgreementReq?: RenewAgreementReq, options?: RawAxiosRequestConfig) {
return ProductOrderingApiFp(this.configuration).dxpProductOrderingV1RenewAgreementPost(renewAgreementReq, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query the list of renewal promotions based on subscriber ID, customer number, and main plan number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Renew Agreement Promoti