UNPKG

@whitebox-co/walmart-marketplace-api

Version:

A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API

710 lines 58.3 kB
"use strict"; /* tslint:disable */ /* eslint-disable */ /** * On-request Report Management * The On-request Reports API allows you to request reports immediately about your items for faster retrieval. You can request the report, check status on the report availability, and then download the report URL when report is ready. You can also get a list of all reports requested. * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); exports.OnRequestReportApi = exports.OnRequestReportApiFactory = exports.OnRequestReportApiFp = exports.OnRequestReportApiAxiosParamCreator = exports.RowFilterRowFilterTypeEnum = exports.RowFilterTypeEnum = exports.RequestStatusResponseReportTypeEnum = exports.RequestStatusResponseRequestStatusEnum = exports.RangeFilter1RowFilterTypeEnum = exports.RangeFilterRowFilterTypeEnum = exports.InlineResponse200RequestsReportTypeEnum = exports.InlineResponse200RequestsRequestStatusEnum = exports.InlineResponse2003ReportTypeEnum = exports.InlineResponse2003RequestStatusEnum = exports.InlineResponse2002ReportTypeEnum = exports.InlineResponse2002RequestStatusEnum = exports.InlineResponse2001ReportTypeEnum = exports.InlineResponse2001RequestStatusEnum = exports.GenerateReportResponseReportTypeEnum = exports.GenerateReportResponseRequestStatusEnum = exports.EnumFilter1TypeEnum = exports.EnumFilterTypeEnum = exports.DownloadReportResponseReportTypeEnum = exports.DownloadReportResponseRequestStatusEnum = void 0; const axios_1 = __importDefault(require("axios")); // Some imports not used depending on template conditions // @ts-ignore const common_1 = require("./common"); // @ts-ignore const base_1 = require("./base"); /** * @export * @enum {string} */ var DownloadReportResponseRequestStatusEnum; (function (DownloadReportResponseRequestStatusEnum) { DownloadReportResponseRequestStatusEnum["Received"] = "RECEIVED"; DownloadReportResponseRequestStatusEnum["Inprogress"] = "INPROGRESS"; DownloadReportResponseRequestStatusEnum["Ready"] = "READY"; DownloadReportResponseRequestStatusEnum["Error"] = "ERROR"; })(DownloadReportResponseRequestStatusEnum = exports.DownloadReportResponseRequestStatusEnum || (exports.DownloadReportResponseRequestStatusEnum = {})); /** * @export * @enum {string} */ var DownloadReportResponseReportTypeEnum; (function (DownloadReportResponseReportTypeEnum) { DownloadReportResponseReportTypeEnum["Item"] = "ITEM"; DownloadReportResponseReportTypeEnum["Inventory"] = "INVENTORY"; DownloadReportResponseReportTypeEnum["Cancellation"] = "CANCELLATION"; DownloadReportResponseReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; DownloadReportResponseReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; DownloadReportResponseReportTypeEnum["Promo"] = "PROMO"; DownloadReportResponseReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; DownloadReportResponseReportTypeEnum["Cpa"] = "CPA"; DownloadReportResponseReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; DownloadReportResponseReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(DownloadReportResponseReportTypeEnum = exports.DownloadReportResponseReportTypeEnum || (exports.DownloadReportResponseReportTypeEnum = {})); /** * @export * @enum {string} */ var EnumFilterTypeEnum; (function (EnumFilterTypeEnum) { EnumFilterTypeEnum["RangeFilter"] = "rangeFilter"; EnumFilterTypeEnum["EnumFilter"] = "enumFilter"; })(EnumFilterTypeEnum = exports.EnumFilterTypeEnum || (exports.EnumFilterTypeEnum = {})); /** * @export * @enum {string} */ var EnumFilter1TypeEnum; (function (EnumFilter1TypeEnum) { EnumFilter1TypeEnum["RangeFilter"] = "rangeFilter"; EnumFilter1TypeEnum["EnumFilter"] = "enumFilter"; })(EnumFilter1TypeEnum = exports.EnumFilter1TypeEnum || (exports.EnumFilter1TypeEnum = {})); /** * @export * @enum {string} */ var GenerateReportResponseRequestStatusEnum; (function (GenerateReportResponseRequestStatusEnum) { GenerateReportResponseRequestStatusEnum["Received"] = "RECEIVED"; GenerateReportResponseRequestStatusEnum["Inprogress"] = "INPROGRESS"; GenerateReportResponseRequestStatusEnum["Ready"] = "READY"; GenerateReportResponseRequestStatusEnum["Error"] = "ERROR"; })(GenerateReportResponseRequestStatusEnum = exports.GenerateReportResponseRequestStatusEnum || (exports.GenerateReportResponseRequestStatusEnum = {})); /** * @export * @enum {string} */ var GenerateReportResponseReportTypeEnum; (function (GenerateReportResponseReportTypeEnum) { GenerateReportResponseReportTypeEnum["Item"] = "ITEM"; GenerateReportResponseReportTypeEnum["Inventory"] = "INVENTORY"; GenerateReportResponseReportTypeEnum["Cancellation"] = "CANCELLATION"; GenerateReportResponseReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; GenerateReportResponseReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; GenerateReportResponseReportTypeEnum["Promo"] = "PROMO"; GenerateReportResponseReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; GenerateReportResponseReportTypeEnum["Cpa"] = "CPA"; GenerateReportResponseReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; GenerateReportResponseReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(GenerateReportResponseReportTypeEnum = exports.GenerateReportResponseReportTypeEnum || (exports.GenerateReportResponseReportTypeEnum = {})); /** * @export * @enum {string} */ var InlineResponse2001RequestStatusEnum; (function (InlineResponse2001RequestStatusEnum) { InlineResponse2001RequestStatusEnum["Received"] = "RECEIVED"; InlineResponse2001RequestStatusEnum["Inprogress"] = "INPROGRESS"; InlineResponse2001RequestStatusEnum["Ready"] = "READY"; InlineResponse2001RequestStatusEnum["Error"] = "ERROR"; })(InlineResponse2001RequestStatusEnum = exports.InlineResponse2001RequestStatusEnum || (exports.InlineResponse2001RequestStatusEnum = {})); /** * @export * @enum {string} */ var InlineResponse2001ReportTypeEnum; (function (InlineResponse2001ReportTypeEnum) { InlineResponse2001ReportTypeEnum["Item"] = "ITEM"; InlineResponse2001ReportTypeEnum["Inventory"] = "INVENTORY"; InlineResponse2001ReportTypeEnum["Cancellation"] = "CANCELLATION"; InlineResponse2001ReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; InlineResponse2001ReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; InlineResponse2001ReportTypeEnum["Promo"] = "PROMO"; InlineResponse2001ReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; InlineResponse2001ReportTypeEnum["Cpa"] = "CPA"; InlineResponse2001ReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; InlineResponse2001ReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(InlineResponse2001ReportTypeEnum = exports.InlineResponse2001ReportTypeEnum || (exports.InlineResponse2001ReportTypeEnum = {})); /** * @export * @enum {string} */ var InlineResponse2002RequestStatusEnum; (function (InlineResponse2002RequestStatusEnum) { InlineResponse2002RequestStatusEnum["Received"] = "RECEIVED"; InlineResponse2002RequestStatusEnum["Inprogress"] = "INPROGRESS"; InlineResponse2002RequestStatusEnum["Ready"] = "READY"; InlineResponse2002RequestStatusEnum["Error"] = "ERROR"; })(InlineResponse2002RequestStatusEnum = exports.InlineResponse2002RequestStatusEnum || (exports.InlineResponse2002RequestStatusEnum = {})); /** * @export * @enum {string} */ var InlineResponse2002ReportTypeEnum; (function (InlineResponse2002ReportTypeEnum) { InlineResponse2002ReportTypeEnum["Item"] = "ITEM"; InlineResponse2002ReportTypeEnum["Inventory"] = "INVENTORY"; InlineResponse2002ReportTypeEnum["Cancellation"] = "CANCELLATION"; InlineResponse2002ReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; InlineResponse2002ReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; InlineResponse2002ReportTypeEnum["Promo"] = "PROMO"; InlineResponse2002ReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; InlineResponse2002ReportTypeEnum["Cpa"] = "CPA"; InlineResponse2002ReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; InlineResponse2002ReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(InlineResponse2002ReportTypeEnum = exports.InlineResponse2002ReportTypeEnum || (exports.InlineResponse2002ReportTypeEnum = {})); /** * @export * @enum {string} */ var InlineResponse2003RequestStatusEnum; (function (InlineResponse2003RequestStatusEnum) { InlineResponse2003RequestStatusEnum["Received"] = "RECEIVED"; InlineResponse2003RequestStatusEnum["Inprogress"] = "INPROGRESS"; InlineResponse2003RequestStatusEnum["Ready"] = "READY"; InlineResponse2003RequestStatusEnum["Error"] = "ERROR"; })(InlineResponse2003RequestStatusEnum = exports.InlineResponse2003RequestStatusEnum || (exports.InlineResponse2003RequestStatusEnum = {})); /** * @export * @enum {string} */ var InlineResponse2003ReportTypeEnum; (function (InlineResponse2003ReportTypeEnum) { InlineResponse2003ReportTypeEnum["Item"] = "ITEM"; InlineResponse2003ReportTypeEnum["Inventory"] = "INVENTORY"; InlineResponse2003ReportTypeEnum["Cancellation"] = "CANCELLATION"; InlineResponse2003ReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; InlineResponse2003ReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; InlineResponse2003ReportTypeEnum["Promo"] = "PROMO"; InlineResponse2003ReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; InlineResponse2003ReportTypeEnum["Cpa"] = "CPA"; InlineResponse2003ReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; InlineResponse2003ReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(InlineResponse2003ReportTypeEnum = exports.InlineResponse2003ReportTypeEnum || (exports.InlineResponse2003ReportTypeEnum = {})); /** * @export * @enum {string} */ var InlineResponse200RequestsRequestStatusEnum; (function (InlineResponse200RequestsRequestStatusEnum) { InlineResponse200RequestsRequestStatusEnum["Received"] = "RECEIVED"; InlineResponse200RequestsRequestStatusEnum["Inprogress"] = "INPROGRESS"; InlineResponse200RequestsRequestStatusEnum["Ready"] = "READY"; InlineResponse200RequestsRequestStatusEnum["Error"] = "ERROR"; })(InlineResponse200RequestsRequestStatusEnum = exports.InlineResponse200RequestsRequestStatusEnum || (exports.InlineResponse200RequestsRequestStatusEnum = {})); /** * @export * @enum {string} */ var InlineResponse200RequestsReportTypeEnum; (function (InlineResponse200RequestsReportTypeEnum) { InlineResponse200RequestsReportTypeEnum["Item"] = "ITEM"; InlineResponse200RequestsReportTypeEnum["Inventory"] = "INVENTORY"; InlineResponse200RequestsReportTypeEnum["Cancellation"] = "CANCELLATION"; InlineResponse200RequestsReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; InlineResponse200RequestsReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; InlineResponse200RequestsReportTypeEnum["Promo"] = "PROMO"; InlineResponse200RequestsReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; InlineResponse200RequestsReportTypeEnum["Cpa"] = "CPA"; InlineResponse200RequestsReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; InlineResponse200RequestsReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(InlineResponse200RequestsReportTypeEnum = exports.InlineResponse200RequestsReportTypeEnum || (exports.InlineResponse200RequestsReportTypeEnum = {})); /** * @export * @enum {string} */ var RangeFilterRowFilterTypeEnum; (function (RangeFilterRowFilterTypeEnum) { RangeFilterRowFilterTypeEnum["RangeFilter"] = "rangeFilter"; RangeFilterRowFilterTypeEnum["EnumFilter"] = "enumFilter"; })(RangeFilterRowFilterTypeEnum = exports.RangeFilterRowFilterTypeEnum || (exports.RangeFilterRowFilterTypeEnum = {})); /** * @export * @enum {string} */ var RangeFilter1RowFilterTypeEnum; (function (RangeFilter1RowFilterTypeEnum) { RangeFilter1RowFilterTypeEnum["RangeFilter"] = "rangeFilter"; RangeFilter1RowFilterTypeEnum["EnumFilter"] = "enumFilter"; })(RangeFilter1RowFilterTypeEnum = exports.RangeFilter1RowFilterTypeEnum || (exports.RangeFilter1RowFilterTypeEnum = {})); /** * @export * @enum {string} */ var RequestStatusResponseRequestStatusEnum; (function (RequestStatusResponseRequestStatusEnum) { RequestStatusResponseRequestStatusEnum["Received"] = "RECEIVED"; RequestStatusResponseRequestStatusEnum["Inprogress"] = "INPROGRESS"; RequestStatusResponseRequestStatusEnum["Ready"] = "READY"; RequestStatusResponseRequestStatusEnum["Error"] = "ERROR"; })(RequestStatusResponseRequestStatusEnum = exports.RequestStatusResponseRequestStatusEnum || (exports.RequestStatusResponseRequestStatusEnum = {})); /** * @export * @enum {string} */ var RequestStatusResponseReportTypeEnum; (function (RequestStatusResponseReportTypeEnum) { RequestStatusResponseReportTypeEnum["Item"] = "ITEM"; RequestStatusResponseReportTypeEnum["Inventory"] = "INVENTORY"; RequestStatusResponseReportTypeEnum["Cancellation"] = "CANCELLATION"; RequestStatusResponseReportTypeEnum["DeliveryDefect"] = "DELIVERY_DEFECT"; RequestStatusResponseReportTypeEnum["ItemPerformance"] = "ITEM_PERFORMANCE"; RequestStatusResponseReportTypeEnum["Promo"] = "PROMO"; RequestStatusResponseReportTypeEnum["ReturnOverrides"] = "RETURN_OVERRIDES"; RequestStatusResponseReportTypeEnum["Cpa"] = "CPA"; RequestStatusResponseReportTypeEnum["ShippingConfiguration"] = "SHIPPING_CONFIGURATION"; RequestStatusResponseReportTypeEnum["ShippingProgram"] = "SHIPPING_PROGRAM"; })(RequestStatusResponseReportTypeEnum = exports.RequestStatusResponseReportTypeEnum || (exports.RequestStatusResponseReportTypeEnum = {})); /** * @export * @enum {string} */ var RowFilterTypeEnum; (function (RowFilterTypeEnum) { RowFilterTypeEnum["RangeFilter"] = "rangeFilter"; RowFilterTypeEnum["EnumFilter"] = "enumFilter"; })(RowFilterTypeEnum = exports.RowFilterTypeEnum || (exports.RowFilterTypeEnum = {})); /** * @export * @enum {string} */ var RowFilterRowFilterTypeEnum; (function (RowFilterRowFilterTypeEnum) { RowFilterRowFilterTypeEnum["RangeFilter"] = "rangeFilter"; RowFilterRowFilterTypeEnum["EnumFilter"] = "enumFilter"; })(RowFilterRowFilterTypeEnum = exports.RowFilterRowFilterTypeEnum || (exports.RowFilterRowFilterTypeEnum = {})); /** * OnRequestReportApi - axios parameter creator * @export */ const OnRequestReportApiAxiosParamCreator = function (configuration) { return { /** * Fetches URL to download a generated report. * @summary Download Report URL * @param {string} requestId Automated ID generated by system that uniquely identifies the report request. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadReport: async (requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options = {}) => { // verify required parameter 'requestId' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'requestId', requestId); // verify required parameter 'authorization' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'authorization', authorization); // verify required parameter 'wMSECACCESSTOKEN' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN); // verify required parameter 'wMQOSCORRELATIONID' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID); // verify required parameter 'wMSVCNAME' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'wMSVCNAME', wMSVCNAME); // verify required parameter 'accept' is not null or undefined (0, common_1.assertParamExists)('downloadReport', 'accept', accept); const localVarPath = `/v3/reports/downloadReport`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication basicScheme required // http basic authentication required (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration); if (requestId !== undefined) { localVarQueryParameter['requestId'] = requestId; } if (authorization !== undefined && authorization !== null) { localVarHeaderParameter['Authorization'] = String(authorization); } if (wMSECACCESSTOKEN !== undefined && wMSECACCESSTOKEN !== null) { localVarHeaderParameter['WM_SEC.ACCESS_TOKEN'] = String(wMSECACCESSTOKEN); } if (wMCONSUMERCHANNELTYPE !== undefined && wMCONSUMERCHANNELTYPE !== null) { localVarHeaderParameter['WM_CONSUMER.CHANNEL.TYPE'] = String(wMCONSUMERCHANNELTYPE); } if (wMQOSCORRELATIONID !== undefined && wMQOSCORRELATIONID !== null) { localVarHeaderParameter['WM_QOS.CORRELATION_ID'] = String(wMQOSCORRELATIONID); } if (wMSVCNAME !== undefined && wMSVCNAME !== null) { localVarHeaderParameter['WM_SVC.NAME'] = String(wMSVCNAME); } if (accept !== undefined && accept !== null) { localVarHeaderParameter['Accept'] = String(accept); } (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: (0, common_1.toPathString)(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Creates a new request for report by specifying the reportType and reportVersion. * @summary Create Report Request * @param {'ITEM' | 'INVENTORY' | 'CANCELLATION' | 'DELIVERY_DEFECT' | 'ITEM_PERFORMANCE' | 'PROMO' | 'RETURN_OVERRIDES' | 'CPA' | 'SHIPPING_CONFIGURATION' | 'SHIPPING_PROGRAM' | 'FITMENT_MISSING_ATTR' | 'FITMENT_ACES_COVERAGE'} reportType Specifies the report type for the request. For example, reportType=ITEM creates an Item Report. * @param {string} reportVersion Version of report for which the request is created. Supported versions for each report type are currently \'reportVersion=v1\' for the following reportType(s): INVENTORY, CANCELLATION, DELIVERY_DEFECT, ITEM_PERFORMANCE, PROMO, RETURN_OVERRIDES, CPA, SHIPPING_CONFIGURATION, SHIPPING_PROGRAM, FITMENT_MISSING_ATTR, FITMENT_ACES_COVERAGE and \'reportVersion=v1\', \'reportVersion=v2\', \'reportVersion=v3\', \'reportVersion=v4\' for the following reportType(s): ITEM. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} contentType Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateReport: async (reportType, reportVersion, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, contentType, wMCONSUMERCHANNELTYPE, inlineObject, options = {}) => { // verify required parameter 'reportType' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'reportType', reportType); // verify required parameter 'reportVersion' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'reportVersion', reportVersion); // verify required parameter 'authorization' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'authorization', authorization); // verify required parameter 'wMSECACCESSTOKEN' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN); // verify required parameter 'wMQOSCORRELATIONID' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID); // verify required parameter 'wMSVCNAME' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'wMSVCNAME', wMSVCNAME); // verify required parameter 'accept' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'accept', accept); // verify required parameter 'contentType' is not null or undefined (0, common_1.assertParamExists)('generateReport', 'contentType', contentType); const localVarPath = `/v3/reports/reportRequests`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication basicScheme required // http basic authentication required (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration); if (reportType !== undefined) { localVarQueryParameter['reportType'] = reportType; } if (reportVersion !== undefined) { localVarQueryParameter['reportVersion'] = reportVersion; } if (authorization !== undefined && authorization !== null) { localVarHeaderParameter['Authorization'] = String(authorization); } if (wMSECACCESSTOKEN !== undefined && wMSECACCESSTOKEN !== null) { localVarHeaderParameter['WM_SEC.ACCESS_TOKEN'] = String(wMSECACCESSTOKEN); } if (wMCONSUMERCHANNELTYPE !== undefined && wMCONSUMERCHANNELTYPE !== null) { localVarHeaderParameter['WM_CONSUMER.CHANNEL.TYPE'] = String(wMCONSUMERCHANNELTYPE); } if (wMQOSCORRELATIONID !== undefined && wMQOSCORRELATIONID !== null) { localVarHeaderParameter['WM_QOS.CORRELATION_ID'] = String(wMQOSCORRELATIONID); } if (wMSVCNAME !== undefined && wMSVCNAME !== null) { localVarHeaderParameter['WM_SVC.NAME'] = String(wMSVCNAME); } if (accept !== undefined && accept !== null) { localVarHeaderParameter['Accept'] = String(accept); } if (contentType !== undefined && contentType !== null) { localVarHeaderParameter['Content-Type'] = String(contentType); } localVarHeaderParameter['Content-Type'] = 'application/json'; (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(inlineObject, localVarRequestOptions, configuration); return { url: (0, common_1.toPathString)(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Fetches a list of all report requests for specified search criteria by using query parameters. You can fetch details of report requests created in the last 30 days only. * @summary Get All Report Requests * @param {'ITEM' | 'INVENTORY' | 'CANCELLATION' | 'DELIVERY_DEFECT' | 'ITEM_PERFORMANCE' | 'PROMO' | 'RETURN_OVERRIDES' | 'CPA' | 'SHIPPING_CONFIGURATION' | 'SHIPPING_PROGRAM' | 'FITMENT_MISSING_ATTR' | 'FITMENT_ACES_COVERAGE'} reportType Type of report for which the request is created. Example, ITEM for Item Report. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [reportVersion] Version of report for which the request is created. Example, v1. * @param {'RECEIVED' | 'INPROGRESS' | 'READY' | 'ERROR'} [requestStatus] Status of report request. Possible values are RECEIVED, INPROGRESS, READY, ERROR. * @param {string} [requestSubmissionStartDate] Report request submittal start date for range of reports requested, in format: YYYY-MM-DDTHH:mm:ssZ * @param {string} [requestSubmissionEndDate] Report request submittal end date for range of reports requested, in format YYYY-MM-DDTHH:mm:ssZ * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRequestsStatus: async (reportType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, reportVersion, requestStatus, requestSubmissionStartDate, requestSubmissionEndDate, wMCONSUMERCHANNELTYPE, options = {}) => { // verify required parameter 'reportType' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'reportType', reportType); // verify required parameter 'authorization' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'authorization', authorization); // verify required parameter 'wMSECACCESSTOKEN' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN); // verify required parameter 'wMQOSCORRELATIONID' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID); // verify required parameter 'wMSVCNAME' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'wMSVCNAME', wMSVCNAME); // verify required parameter 'accept' is not null or undefined (0, common_1.assertParamExists)('getRequestsStatus', 'accept', accept); const localVarPath = `/v3/reports/reportRequests`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication basicScheme required // http basic authentication required (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration); if (reportType !== undefined) { localVarQueryParameter['reportType'] = reportType; } if (reportVersion !== undefined) { localVarQueryParameter['reportVersion'] = reportVersion; } if (requestStatus !== undefined) { localVarQueryParameter['requestStatus'] = requestStatus; } if (requestSubmissionStartDate !== undefined) { localVarQueryParameter['requestSubmissionStartDate'] = requestSubmissionStartDate; } if (requestSubmissionEndDate !== undefined) { localVarQueryParameter['requestSubmissionEndDate'] = requestSubmissionEndDate; } if (authorization !== undefined && authorization !== null) { localVarHeaderParameter['Authorization'] = String(authorization); } if (wMSECACCESSTOKEN !== undefined && wMSECACCESSTOKEN !== null) { localVarHeaderParameter['WM_SEC.ACCESS_TOKEN'] = String(wMSECACCESSTOKEN); } if (wMCONSUMERCHANNELTYPE !== undefined && wMCONSUMERCHANNELTYPE !== null) { localVarHeaderParameter['WM_CONSUMER.CHANNEL.TYPE'] = String(wMCONSUMERCHANNELTYPE); } if (wMQOSCORRELATIONID !== undefined && wMQOSCORRELATIONID !== null) { localVarHeaderParameter['WM_QOS.CORRELATION_ID'] = String(wMQOSCORRELATIONID); } if (wMSVCNAME !== undefined && wMSVCNAME !== null) { localVarHeaderParameter['WM_SVC.NAME'] = String(wMSVCNAME); } if (accept !== undefined && accept !== null) { localVarHeaderParameter['Accept'] = String(accept); } (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: (0, common_1.toPathString)(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Fetches status and other details of a report request by providing a requestID. You can fetch details of report request created in the last 30 days only. * @summary Report Request Status * @param {string} requestId Automated ID generated by system that uniquely identifies the report request. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSingleRequestStatus: async (requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options = {}) => { // verify required parameter 'requestId' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'requestId', requestId); // verify required parameter 'authorization' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'authorization', authorization); // verify required parameter 'wMSECACCESSTOKEN' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN); // verify required parameter 'wMQOSCORRELATIONID' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID); // verify required parameter 'wMSVCNAME' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'wMSVCNAME', wMSVCNAME); // verify required parameter 'accept' is not null or undefined (0, common_1.assertParamExists)('getSingleRequestStatus', 'accept', accept); const localVarPath = `/v3/reports/reportRequests/{requestId}` .replace(`{${"requestId"}}`, encodeURIComponent(String(requestId))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication basicScheme required // http basic authentication required (0, common_1.setBasicAuthToObject)(localVarRequestOptions, configuration); if (authorization !== undefined && authorization !== null) { localVarHeaderParameter['Authorization'] = String(authorization); } if (wMSECACCESSTOKEN !== undefined && wMSECACCESSTOKEN !== null) { localVarHeaderParameter['WM_SEC.ACCESS_TOKEN'] = String(wMSECACCESSTOKEN); } if (wMCONSUMERCHANNELTYPE !== undefined && wMCONSUMERCHANNELTYPE !== null) { localVarHeaderParameter['WM_CONSUMER.CHANNEL.TYPE'] = String(wMCONSUMERCHANNELTYPE); } if (wMQOSCORRELATIONID !== undefined && wMQOSCORRELATIONID !== null) { localVarHeaderParameter['WM_QOS.CORRELATION_ID'] = String(wMQOSCORRELATIONID); } if (wMSVCNAME !== undefined && wMSVCNAME !== null) { localVarHeaderParameter['WM_SVC.NAME'] = String(wMSVCNAME); } if (accept !== undefined && accept !== null) { localVarHeaderParameter['Accept'] = String(accept); } (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: (0, common_1.toPathString)(localVarUrlObj), options: localVarRequestOptions, }; }, }; }; exports.OnRequestReportApiAxiosParamCreator = OnRequestReportApiAxiosParamCreator; /** * OnRequestReportApi - functional programming interface * @export */ const OnRequestReportApiFp = function (configuration) { const localVarAxiosParamCreator = (0, exports.OnRequestReportApiAxiosParamCreator)(configuration); return { /** * Fetches URL to download a generated report. * @summary Download Report URL * @param {string} requestId Automated ID generated by system that uniquely identifies the report request. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ async downloadReport(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.downloadReport(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options); return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); }, /** * Creates a new request for report by specifying the reportType and reportVersion. * @summary Create Report Request * @param {'ITEM' | 'INVENTORY' | 'CANCELLATION' | 'DELIVERY_DEFECT' | 'ITEM_PERFORMANCE' | 'PROMO' | 'RETURN_OVERRIDES' | 'CPA' | 'SHIPPING_CONFIGURATION' | 'SHIPPING_PROGRAM' | 'FITMENT_MISSING_ATTR' | 'FITMENT_ACES_COVERAGE'} reportType Specifies the report type for the request. For example, reportType=ITEM creates an Item Report. * @param {string} reportVersion Version of report for which the request is created. Supported versions for each report type are currently \'reportVersion=v1\' for the following reportType(s): INVENTORY, CANCELLATION, DELIVERY_DEFECT, ITEM_PERFORMANCE, PROMO, RETURN_OVERRIDES, CPA, SHIPPING_CONFIGURATION, SHIPPING_PROGRAM, FITMENT_MISSING_ATTR, FITMENT_ACES_COVERAGE and \'reportVersion=v1\', \'reportVersion=v2\', \'reportVersion=v3\', \'reportVersion=v4\' for the following reportType(s): ITEM. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} contentType Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async generateReport(reportType, reportVersion, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, contentType, wMCONSUMERCHANNELTYPE, inlineObject, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.generateReport(reportType, reportVersion, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, contentType, wMCONSUMERCHANNELTYPE, inlineObject, options); return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); }, /** * Fetches a list of all report requests for specified search criteria by using query parameters. You can fetch details of report requests created in the last 30 days only. * @summary Get All Report Requests * @param {'ITEM' | 'INVENTORY' | 'CANCELLATION' | 'DELIVERY_DEFECT' | 'ITEM_PERFORMANCE' | 'PROMO' | 'RETURN_OVERRIDES' | 'CPA' | 'SHIPPING_CONFIGURATION' | 'SHIPPING_PROGRAM' | 'FITMENT_MISSING_ATTR' | 'FITMENT_ACES_COVERAGE'} reportType Type of report for which the request is created. Example, ITEM for Item Report. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [reportVersion] Version of report for which the request is created. Example, v1. * @param {'RECEIVED' | 'INPROGRESS' | 'READY' | 'ERROR'} [requestStatus] Status of report request. Possible values are RECEIVED, INPROGRESS, READY, ERROR. * @param {string} [requestSubmissionStartDate] Report request submittal start date for range of reports requested, in format: YYYY-MM-DDTHH:mm:ssZ * @param {string} [requestSubmissionEndDate] Report request submittal end date for range of reports requested, in format YYYY-MM-DDTHH:mm:ssZ * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getRequestsStatus(reportType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, reportVersion, requestStatus, requestSubmissionStartDate, requestSubmissionEndDate, wMCONSUMERCHANNELTYPE, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.getRequestsStatus(reportType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, reportVersion, requestStatus, requestSubmissionStartDate, requestSubmissionEndDate, wMCONSUMERCHANNELTYPE, options); return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); }, /** * Fetches status and other details of a report request by providing a requestID. You can fetch details of report request created in the last 30 days only. * @summary Report Request Status * @param {string} requestId Automated ID generated by system that uniquely identifies the report request. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getSingleRequestStatus(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.getSingleRequestStatus(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options); return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration); }, }; }; exports.OnRequestReportApiFp = OnRequestReportApiFp; /** * OnRequestReportApi - factory interface * @export */ const OnRequestReportApiFactory = function (configuration, basePath, axios) { const localVarFp = (0, exports.OnRequestReportApiFp)(configuration); return { /** * Fetches URL to download a generated report. * @summary Download Report URL * @param {string} requestId Automated ID generated by system that uniquely identifies the report request. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadReport(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options) { return localVarFp.downloadReport(requestId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, wMCONSUMERCHANNELTYPE, options).then((request) => request(axios, basePath)); }, /** * Creates a new request for report by specifying the reportType and reportVersion. * @summary Create Report Request * @param {'ITEM' | 'INVENTORY' | 'CANCELLATION' | 'DELIVERY_DEFECT' | 'ITEM_PERFORMANCE' | 'PROMO' | 'RETURN_OVERRIDES' | 'CPA' | 'SHIPPING_CONFIGURATION' | 'SHIPPING_PROGRAM' | 'FITMENT_MISSING_ATTR' | 'FITMENT_ACES_COVERAGE'} reportType Specifies the report type for the request. For example, reportType=ITEM creates an Item Report. * @param {string} reportVersion Version of report for which the request is created. Supported versions for each report type are currently \'reportVersion=v1\' for the following reportType(s): INVENTORY, CANCELLATION, DELIVERY_DEFECT, ITEM_PERFORMANCE, PROMO, RETURN_OVERRIDES, CPA, SHIPPING_CONFIGURATION, SHIPPING_PROGRAM, FITMENT_MISSING_ATTR, FITMENT_ACES_COVERAGE and \'reportVersion=v1\', \'reportVersion=v2\', \'reportVersion=v3\', \'reportVersion=v4\' for the following reportType(s): ITEM. * @param {string} authorization Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps. * @param {string} wMSECACCESSTOKEN The access token retrieved in the Token API call * @param {string} wMQOSCORRELATIONID A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID * @param {string} wMSVCNAME Walmart Service Name * @param {string} accept Only supported Media Type : application/json * @param {string} contentType Only supported Media Type : application/json * @param {string} [wMCONSUMERCHANNELTYPE] A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding * @param {InlineObject} [inlineObject] * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateReport(reportType, reportVersion, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, accept, con