whalecloud-dxp-api-react-native/src/apis/package-advantage-api.ts

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

/* 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 { ActivatePackageAdvantageReq } from '../models';
// @ts-ignore
import type { ActivatePackageAdvantageResp } from '../models';
// @ts-ignore
import type { DeactivatePackageAdvantageReq } from '../models';
// @ts-ignore
import type { DeactivatePackageAdvantageResp } from '../models';
// @ts-ignore
import type { DxpProjPackageAdvantageV1AdvantagesGet200Response } from '../models';
/**
 * PackageAdvantageApi - axios parameter creator
 * @export
 */
export const PackageAdvantageApiAxiosParamCreator = function (configuration?: Configuration) {
    return {
        /**
         * Activate package advantage.  Note: "subsId","serviceNumber" cannot both be empty.
         * @summary Activate Package Advantage
         * @param {ActivatePackageAdvantageReq} [activatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1ActivatePost: async (activatePackageAdvantageReq?: ActivatePackageAdvantageReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/dxp/proj/package-advantage/v1/activate`;
            // 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(activatePackageAdvantageReq, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Query the list of package advantages based on customer number.
         * @summary Query Package Advantage List
         * @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1AdvantagesGet: async (custNbr: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            // verify required parameter 'custNbr' is not null or undefined
            assertParamExists('dxpProjPackageAdvantageV1AdvantagesGet', 'custNbr', custNbr)
            const localVarPath = `/dxp/proj/package-advantage/v1/advantages`;
            // 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 (custNbr !== undefined) {
                localVarQueryParameter['custNbr'] = custNbr;
            }


    
            setSearchParams(localVarUrlObj, localVarQueryParameter);
            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
        /**
         * Deactivate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
         * @summary Deactivate Package Advantage
         * @param {DeactivatePackageAdvantageReq} [deactivatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1DeactivatePost: async (deactivatePackageAdvantageReq?: DeactivatePackageAdvantageReq, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
            const localVarPath = `/dxp/proj/package-advantage/v1/deactivate`;
            // 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(deactivatePackageAdvantageReq, localVarRequestOptions, configuration)

            return {
                url: toPathString(localVarUrlObj),
                options: localVarRequestOptions,
            };
        },
    }
};

/**
 * PackageAdvantageApi - functional programming interface
 * @export
 */
export const PackageAdvantageApiFp = function(configuration?: Configuration) {
    const localVarAxiosParamCreator = PackageAdvantageApiAxiosParamCreator(configuration)
    return {
        /**
         * Activate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
         * @summary Activate Package Advantage
         * @param {ActivatePackageAdvantageReq} [activatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq?: ActivatePackageAdvantageReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivatePackageAdvantageResp>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['PackageAdvantageApi.dxpProjPackageAdvantageV1ActivatePost']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         * Query the list of package advantages based on customer number.
         * @summary Query Package Advantage List
         * @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async dxpProjPackageAdvantageV1AdvantagesGet(custNbr: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DxpProjPackageAdvantageV1AdvantagesGet200Response>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProjPackageAdvantageV1AdvantagesGet(custNbr, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['PackageAdvantageApi.dxpProjPackageAdvantageV1AdvantagesGet']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
        /**
         * Deactivate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
         * @summary Deactivate Package Advantage
         * @param {DeactivatePackageAdvantageReq} [deactivatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq?: DeactivatePackageAdvantageReq, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeactivatePackageAdvantageResp>> {
            const localVarAxiosArgs = await localVarAxiosParamCreator.dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq, options);
            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
            const localVarOperationServerBasePath = operationServerMap['PackageAdvantageApi.dxpProjPackageAdvantageV1DeactivatePost']?.[localVarOperationServerIndex]?.url;
            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
        },
    }
};

/**
 * PackageAdvantageApi - factory interface
 * @export
 */
export const PackageAdvantageApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
    const localVarFp = PackageAdvantageApiFp(configuration)
    return {
        /**
         * Activate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
         * @summary Activate Package Advantage
         * @param {ActivatePackageAdvantageReq} [activatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq?: ActivatePackageAdvantageReq, options?: any): AxiosPromise<ActivatePackageAdvantageResp> {
            return localVarFp.dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq, options).then((request) => request(axios, basePath));
        },
        /**
         * Query the list of package advantages based on customer number.
         * @summary Query Package Advantage List
         * @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1AdvantagesGet(custNbr: string, options?: any): AxiosPromise<DxpProjPackageAdvantageV1AdvantagesGet200Response> {
            return localVarFp.dxpProjPackageAdvantageV1AdvantagesGet(custNbr, options).then((request) => request(axios, basePath));
        },
        /**
         * Deactivate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
         * @summary Deactivate Package Advantage
         * @param {DeactivatePackageAdvantageReq} [deactivatePackageAdvantageReq] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq?: DeactivatePackageAdvantageReq, options?: any): AxiosPromise<DeactivatePackageAdvantageResp> {
            return localVarFp.dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq, options).then((request) => request(axios, basePath));
        },
    };
};

/**
 * PackageAdvantageApi - interface
 * @export
 * @interface PackageAdvantageApi
 */
export interface PackageAdvantageApiInterface {
    /**
     * Activate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
     * @summary Activate Package Advantage
     * @param {ActivatePackageAdvantageReq} [activatePackageAdvantageReq] 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApiInterface
     */
    dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq?: ActivatePackageAdvantageReq, options?: RawAxiosRequestConfig): AxiosPromise<ActivatePackageAdvantageResp>;

    /**
     * Query the list of package advantages based on customer number.
     * @summary Query Package Advantage List
     * @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApiInterface
     */
    dxpProjPackageAdvantageV1AdvantagesGet(custNbr: string, options?: RawAxiosRequestConfig): AxiosPromise<DxpProjPackageAdvantageV1AdvantagesGet200Response>;

    /**
     * Deactivate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
     * @summary Deactivate Package Advantage
     * @param {DeactivatePackageAdvantageReq} [deactivatePackageAdvantageReq] 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApiInterface
     */
    dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq?: DeactivatePackageAdvantageReq, options?: RawAxiosRequestConfig): AxiosPromise<DeactivatePackageAdvantageResp>;

}

/**
 * PackageAdvantageApi - object-oriented interface
 * @export
 * @class PackageAdvantageApi
 * @extends {BaseAPI}
 */
export class PackageAdvantageApi extends BaseAPI implements PackageAdvantageApiInterface {
    /**
     * Activate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
     * @summary Activate Package Advantage
     * @param {ActivatePackageAdvantageReq} [activatePackageAdvantageReq] 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApi
     */
    public dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq?: ActivatePackageAdvantageReq, options?: RawAxiosRequestConfig) {
        return PackageAdvantageApiFp(this.configuration).dxpProjPackageAdvantageV1ActivatePost(activatePackageAdvantageReq, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Query the list of package advantages based on customer number.
     * @summary Query Package Advantage List
     * @param {string} custNbr The unique customer code, used for uniquely identifying the customer in business operations.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApi
     */
    public dxpProjPackageAdvantageV1AdvantagesGet(custNbr: string, options?: RawAxiosRequestConfig) {
        return PackageAdvantageApiFp(this.configuration).dxpProjPackageAdvantageV1AdvantagesGet(custNbr, options).then((request) => request(this.axios, this.basePath));
    }

    /**
     * Deactivate package advantage.  Note: &quot;subsId&quot;,&quot;serviceNumber&quot; cannot both be empty.
     * @summary Deactivate Package Advantage
     * @param {DeactivatePackageAdvantageReq} [deactivatePackageAdvantageReq] 
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof PackageAdvantageApi
     */
    public dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq?: DeactivatePackageAdvantageReq, options?: RawAxiosRequestConfig) {
        return PackageAdvantageApiFp(this.configuration).dxpProjPackageAdvantageV1DeactivatePost(deactivatePackageAdvantageReq, options).then((request) => request(this.axios, this.basePath));
    }
}