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
714 lines (643 loc) • 45.7 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 { QrySubsListReq } from '../models';
// @ts-ignore
import type { QueryAvailablePackageResp } from '../models';
// @ts-ignore
import type { QueryOrderedPackageResp } from '../models';
// @ts-ignore
import type { QueryPlanDetailResp } from '../models';
// @ts-ignore
import type { QuerySubscriberDetailResp } from '../models';
// @ts-ignore
import type { QuerySubscriberListResp } from '../models';
// @ts-ignore
import type { QuerySwitchablePlanResp } from '../models';
/**
* SubscriberManagementApi - axios parameter creator
* @export
*/
export const SubscriberManagementApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Query available optional packages and functional products based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Available Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {string} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PackagesAvailableGet: async (subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, offerType?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/packages/available`;
// 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 (prefix !== undefined) {
localVarQueryParameter['prefix'] = prefix;
}
if (serviceNumber !== undefined) {
localVarQueryParameter['serviceNumber'] = serviceNumber;
}
if (catgCode !== undefined) {
localVarQueryParameter['catgCode'] = catgCode;
}
if (offerType !== undefined) {
localVarQueryParameter['offerType'] = offerType;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query ordered optional packages and functional products based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty. If scopes are not provided, only basic information of the product instance is returned.
* @summary Query Ordered Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {string} [scopes] The scope of the query, specifying which data to include.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PackagesOrderedGet: async (subsId?: number, prefix?: string, serviceNumber?: string, offerType?: DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum, scopes?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/packages/ordered`;
// 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 (prefix !== undefined) {
localVarQueryParameter['prefix'] = prefix;
}
if (serviceNumber !== undefined) {
localVarQueryParameter['serviceNumber'] = serviceNumber;
}
if (offerType !== undefined) {
localVarQueryParameter['offerType'] = offerType;
}
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 subscriber plan details based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Plan Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PlansDetailGet: async (subsId?: number, prefix?: string, serviceNumber?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/plans/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 (subsId !== undefined) {
localVarQueryParameter['subsId'] = subsId;
}
if (prefix !== undefined) {
localVarQueryParameter['prefix'] = prefix;
}
if (serviceNumber !== undefined) {
localVarQueryParameter['serviceNumber'] = serviceNumber;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query switchable plan list based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Switchable Plan
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PlansSwitchableGet: async (subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/plans/switchable`;
// 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 (prefix !== undefined) {
localVarQueryParameter['prefix'] = prefix;
}
if (serviceNumber !== undefined) {
localVarQueryParameter['serviceNumber'] = serviceNumber;
}
if (catgCode !== undefined) {
localVarQueryParameter['catgCode'] = catgCode;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [scopes] The scope of the query, specifying which data to include. Possible Value: offerInstList, attrValueList, installationAddrInfo, offerInstSpec
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1SubscribersDetailGet: async (subsId?: number, prefix?: string, serviceNumber?: string, scopes?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/subscribers/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 (subsId !== undefined) {
localVarQueryParameter['subsId'] = subsId;
}
if (prefix !== undefined) {
localVarQueryParameter['prefix'] = prefix;
}
if (serviceNumber !== undefined) {
localVarQueryParameter['serviceNumber'] = serviceNumber;
}
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 subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber List
* @param {QrySubsListReq} [qrySubsListReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1SubscribersListPost: async (qrySubsListReq?: QrySubsListReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/dxp/subscriber-management/v1/subscribers/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(qrySubsListReq, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
}
};
/**
* SubscriberManagementApi - functional programming interface
* @export
*/
export const SubscriberManagementApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = SubscriberManagementApiAxiosParamCreator(configuration)
return {
/**
* Query available optional packages and functional products based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Available Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {string} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1PackagesAvailableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, offerType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryAvailablePackageResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1PackagesAvailableGet(subsId, prefix, serviceNumber, catgCode, offerType, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1PackagesAvailableGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query ordered optional packages and functional products based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty. If scopes are not provided, only basic information of the product instance is returned.
* @summary Query Ordered Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {string} [scopes] The scope of the query, specifying which data to include.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1PackagesOrderedGet(subsId?: number, prefix?: string, serviceNumber?: string, offerType?: DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum, scopes?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryOrderedPackageResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1PackagesOrderedGet(subsId, prefix, serviceNumber, offerType, scopes, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1PackagesOrderedGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query subscriber plan details based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Plan Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1PlansDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryPlanDetailResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1PlansDetailGet(subsId, prefix, serviceNumber, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1PlansDetailGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query switchable plan list based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Switchable Plan
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1PlansSwitchableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySwitchablePlanResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1PlansSwitchableGet(subsId, prefix, serviceNumber, catgCode, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1PlansSwitchableGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [scopes] The scope of the query, specifying which data to include. Possible Value: offerInstList, attrValueList, installationAddrInfo, offerInstSpec
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1SubscribersDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, scopes?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySubscriberDetailResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1SubscribersDetailGet(subsId, prefix, serviceNumber, scopes, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1SubscribersDetailGet']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber List
* @param {QrySubsListReq} [qrySubsListReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq?: QrySubsListReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuerySubscriberListResp>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['SubscriberManagementApi.dxpSubscriberManagementV1SubscribersListPost']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
}
};
/**
* SubscriberManagementApi - factory interface
* @export
*/
export const SubscriberManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
const localVarFp = SubscriberManagementApiFp(configuration)
return {
/**
* Query available optional packages and functional products based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Available Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {string} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PackagesAvailableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, offerType?: string, options?: any): AxiosPromise<QueryAvailablePackageResp> {
return localVarFp.dxpSubscriberManagementV1PackagesAvailableGet(subsId, prefix, serviceNumber, catgCode, offerType, options).then((request) => request(axios, basePath));
},
/**
* Query ordered optional packages and functional products based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty. If scopes are not provided, only basic information of the product instance is returned.
* @summary Query Ordered Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {string} [scopes] The scope of the query, specifying which data to include.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PackagesOrderedGet(subsId?: number, prefix?: string, serviceNumber?: string, offerType?: DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum, scopes?: string, options?: any): AxiosPromise<QueryOrderedPackageResp> {
return localVarFp.dxpSubscriberManagementV1PackagesOrderedGet(subsId, prefix, serviceNumber, offerType, scopes, options).then((request) => request(axios, basePath));
},
/**
* Query subscriber plan details based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Plan Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PlansDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, options?: any): AxiosPromise<QueryPlanDetailResp> {
return localVarFp.dxpSubscriberManagementV1PlansDetailGet(subsId, prefix, serviceNumber, options).then((request) => request(axios, basePath));
},
/**
* Query switchable plan list based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Switchable Plan
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1PlansSwitchableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, options?: any): AxiosPromise<QuerySwitchablePlanResp> {
return localVarFp.dxpSubscriberManagementV1PlansSwitchableGet(subsId, prefix, serviceNumber, catgCode, options).then((request) => request(axios, basePath));
},
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [scopes] The scope of the query, specifying which data to include. Possible Value: offerInstList, attrValueList, installationAddrInfo, offerInstSpec
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1SubscribersDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, scopes?: string, options?: any): AxiosPromise<QuerySubscriberDetailResp> {
return localVarFp.dxpSubscriberManagementV1SubscribersDetailGet(subsId, prefix, serviceNumber, scopes, options).then((request) => request(axios, basePath));
},
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber List
* @param {QrySubsListReq} [qrySubsListReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq?: QrySubsListReq, options?: any): AxiosPromise<QuerySubscriberListResp> {
return localVarFp.dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq, options).then((request) => request(axios, basePath));
},
};
};
/**
* SubscriberManagementApi - interface
* @export
* @interface SubscriberManagementApi
*/
export interface SubscriberManagementApiInterface {
/**
* Query available optional packages and functional products based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Available Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {string} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1PackagesAvailableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, offerType?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryAvailablePackageResp>;
/**
* Query ordered optional packages and functional products based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty. If scopes are not provided, only basic information of the product instance is returned.
* @summary Query Ordered Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {string} [scopes] The scope of the query, specifying which data to include.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1PackagesOrderedGet(subsId?: number, prefix?: string, serviceNumber?: string, offerType?: DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum, scopes?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryOrderedPackageResp>;
/**
* Query subscriber plan details based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Plan Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1PlansDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, options?: RawAxiosRequestConfig): AxiosPromise<QueryPlanDetailResp>;
/**
* Query switchable plan list based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Switchable Plan
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1PlansSwitchableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySwitchablePlanResp>;
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [scopes] The scope of the query, specifying which data to include. Possible Value: offerInstList, attrValueList, installationAddrInfo, offerInstSpec
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1SubscribersDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, scopes?: string, options?: RawAxiosRequestConfig): AxiosPromise<QuerySubscriberDetailResp>;
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber List
* @param {QrySubsListReq} [qrySubsListReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApiInterface
*/
dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq?: QrySubsListReq, options?: RawAxiosRequestConfig): AxiosPromise<QuerySubscriberListResp>;
}
/**
* SubscriberManagementApi - object-oriented interface
* @export
* @class SubscriberManagementApi
* @extends {BaseAPI}
*/
export class SubscriberManagementApi extends BaseAPI implements SubscriberManagementApiInterface {
/**
* Query available optional packages and functional products based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Available Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {string} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1PackagesAvailableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, offerType?: string, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1PackagesAvailableGet(subsId, prefix, serviceNumber, catgCode, offerType, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query ordered optional packages and functional products based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty. If scopes are not provided, only basic information of the product instance is returned.
* @summary Query Ordered Package
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum} [offerType] The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
* @param {string} [scopes] The scope of the query, specifying which data to include.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1PackagesOrderedGet(subsId?: number, prefix?: string, serviceNumber?: string, offerType?: DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum, scopes?: string, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1PackagesOrderedGet(subsId, prefix, serviceNumber, offerType, scopes, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query subscriber plan details based on subscriber ID and service number. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Plan Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1PlansDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1PlansDetailGet(subsId, prefix, serviceNumber, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query switchable plan list based on subscriber ID, service number, and sales catalog. Note: "subsId", "serviceNumber" cannot both be empty.
* @summary Query Switchable Plan
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [catgCode] The code identifying the catalog.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1PlansSwitchableGet(subsId?: number, prefix?: string, serviceNumber?: string, catgCode?: string, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1PlansSwitchableGet(subsId, prefix, serviceNumber, catgCode, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber Detail
* @param {number} [subsId] The unique identifier for the subscriber.
* @param {string} [prefix] The prefix associated with the subscriber\'s service number.
* @param {string} [serviceNumber] The service number associated with the subscriber.
* @param {string} [scopes] The scope of the query, specifying which data to include. Possible Value: offerInstList, attrValueList, installationAddrInfo, offerInstSpec
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1SubscribersDetailGet(subsId?: number, prefix?: string, serviceNumber?: string, scopes?: string, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1SubscribersDetailGet(subsId, prefix, serviceNumber, scopes, options).then((request) => request(this.axios, this.basePath));
}
/**
* Query the subscriber list. Note: "serviceNumber", "custNbr", "acctNbr", "iccid" cannot all be empty.
* @summary Query Subscriber List
* @param {QrySubsListReq} [qrySubsListReq]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SubscriberManagementApi
*/
public dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq?: QrySubsListReq, options?: RawAxiosRequestConfig) {
return SubscriberManagementApiFp(this.configuration).dxpSubscriberManagementV1SubscribersListPost(qrySubsListReq, options).then((request) => request(this.axios, this.basePath));
}
}
/**
* @export
*/
export const DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum = {
_3: '3',
_4: '4'
} as const;
export type DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum = typeof DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum[keyof typeof DxpSubscriberManagementV1PackagesOrderedGetOfferTypeEnum];