@whitebox-co/walmart-marketplace-api
Version:
A fully typed TypeScript, Javascript, and Node.js API library for the Walmart Marketplace API
536 lines • 38.2 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* Feed Management
* Feeds are constructed to handle bulk functions. A feed consists of an HTTP request with an attached file. Once you upload the Feeds, you can use the Feed ID to track the status of the feeds and the status of the item within those Feeds.
*
* 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.FeedsApi = exports.FeedsApiFactory = exports.FeedsApiFp = exports.FeedsApiAxiosParamCreator = exports.PartnerItemIngestionStatusIngestionStatusEnum = exports.PartnerFeedResponseFeedStatusEnum = exports.InlineResponse200ErrorsGatewayErrorCategoryEnum = exports.InlineResponse200ErrorsCategoryEnum = exports.InlineResponse200ErrorsSeverityEnum = exports.InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum = exports.InlineResponse2001IngestionErrorsIngestionErrorTypeEnum = exports.InlineResponse2001FeedStatusEnum = exports.IngestionErrorTypeEnum = exports.GatewayErrorGatewayErrorCategoryEnum = exports.GatewayErrorCategoryEnum = exports.GatewayErrorSeverityEnum = 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 GatewayErrorSeverityEnum;
(function (GatewayErrorSeverityEnum) {
GatewayErrorSeverityEnum["Info"] = "INFO";
GatewayErrorSeverityEnum["Warn"] = "WARN";
GatewayErrorSeverityEnum["Error"] = "ERROR";
})(GatewayErrorSeverityEnum = exports.GatewayErrorSeverityEnum || (exports.GatewayErrorSeverityEnum = {}));
/**
* @export
* @enum {string}
*/
var GatewayErrorCategoryEnum;
(function (GatewayErrorCategoryEnum) {
GatewayErrorCategoryEnum["Application"] = "APPLICATION";
GatewayErrorCategoryEnum["System"] = "SYSTEM";
GatewayErrorCategoryEnum["Request"] = "REQUEST";
GatewayErrorCategoryEnum["Data"] = "DATA";
})(GatewayErrorCategoryEnum = exports.GatewayErrorCategoryEnum || (exports.GatewayErrorCategoryEnum = {}));
/**
* @export
* @enum {string}
*/
var GatewayErrorGatewayErrorCategoryEnum;
(function (GatewayErrorGatewayErrorCategoryEnum) {
GatewayErrorGatewayErrorCategoryEnum["InternalDataError"] = "INTERNAL_DATA_ERROR";
GatewayErrorGatewayErrorCategoryEnum["ExternalDataError"] = "EXTERNAL_DATA_ERROR";
GatewayErrorGatewayErrorCategoryEnum["SystemError"] = "SYSTEM_ERROR";
})(GatewayErrorGatewayErrorCategoryEnum = exports.GatewayErrorGatewayErrorCategoryEnum || (exports.GatewayErrorGatewayErrorCategoryEnum = {}));
/**
* @export
* @enum {string}
*/
var IngestionErrorTypeEnum;
(function (IngestionErrorTypeEnum) {
IngestionErrorTypeEnum["DataError"] = "DATA_ERROR";
IngestionErrorTypeEnum["SystemError"] = "SYSTEM_ERROR";
IngestionErrorTypeEnum["TimeoutError"] = "TIMEOUT_ERROR";
})(IngestionErrorTypeEnum = exports.IngestionErrorTypeEnum || (exports.IngestionErrorTypeEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse2001FeedStatusEnum;
(function (InlineResponse2001FeedStatusEnum) {
InlineResponse2001FeedStatusEnum["Received"] = "RECEIVED";
InlineResponse2001FeedStatusEnum["Inprogress"] = "INPROGRESS";
InlineResponse2001FeedStatusEnum["Processed"] = "PROCESSED";
InlineResponse2001FeedStatusEnum["Error"] = "ERROR";
})(InlineResponse2001FeedStatusEnum = exports.InlineResponse2001FeedStatusEnum || (exports.InlineResponse2001FeedStatusEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse2001IngestionErrorsIngestionErrorTypeEnum;
(function (InlineResponse2001IngestionErrorsIngestionErrorTypeEnum) {
InlineResponse2001IngestionErrorsIngestionErrorTypeEnum["DataError"] = "DATA_ERROR";
InlineResponse2001IngestionErrorsIngestionErrorTypeEnum["SystemError"] = "SYSTEM_ERROR";
InlineResponse2001IngestionErrorsIngestionErrorTypeEnum["TimeoutError"] = "TIMEOUT_ERROR";
})(InlineResponse2001IngestionErrorsIngestionErrorTypeEnum = exports.InlineResponse2001IngestionErrorsIngestionErrorTypeEnum || (exports.InlineResponse2001IngestionErrorsIngestionErrorTypeEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum;
(function (InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum) {
InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum["Inprogress"] = "INPROGRESS";
InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum["Success"] = "SUCCESS";
InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum["DataError"] = "DATA_ERROR";
InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum["SystemError"] = "SYSTEM_ERROR";
InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum["TimeoutError"] = "TIMEOUT_ERROR";
})(InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum = exports.InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum || (exports.InlineResponse2001ItemDetailsItemIngestionStatusIngestionStatusEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse200ErrorsSeverityEnum;
(function (InlineResponse200ErrorsSeverityEnum) {
InlineResponse200ErrorsSeverityEnum["Info"] = "INFO";
InlineResponse200ErrorsSeverityEnum["Warn"] = "WARN";
InlineResponse200ErrorsSeverityEnum["Error"] = "ERROR";
})(InlineResponse200ErrorsSeverityEnum = exports.InlineResponse200ErrorsSeverityEnum || (exports.InlineResponse200ErrorsSeverityEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse200ErrorsCategoryEnum;
(function (InlineResponse200ErrorsCategoryEnum) {
InlineResponse200ErrorsCategoryEnum["Application"] = "APPLICATION";
InlineResponse200ErrorsCategoryEnum["System"] = "SYSTEM";
InlineResponse200ErrorsCategoryEnum["Request"] = "REQUEST";
InlineResponse200ErrorsCategoryEnum["Data"] = "DATA";
})(InlineResponse200ErrorsCategoryEnum = exports.InlineResponse200ErrorsCategoryEnum || (exports.InlineResponse200ErrorsCategoryEnum = {}));
/**
* @export
* @enum {string}
*/
var InlineResponse200ErrorsGatewayErrorCategoryEnum;
(function (InlineResponse200ErrorsGatewayErrorCategoryEnum) {
InlineResponse200ErrorsGatewayErrorCategoryEnum["InternalDataError"] = "INTERNAL_DATA_ERROR";
InlineResponse200ErrorsGatewayErrorCategoryEnum["ExternalDataError"] = "EXTERNAL_DATA_ERROR";
InlineResponse200ErrorsGatewayErrorCategoryEnum["SystemError"] = "SYSTEM_ERROR";
})(InlineResponse200ErrorsGatewayErrorCategoryEnum = exports.InlineResponse200ErrorsGatewayErrorCategoryEnum || (exports.InlineResponse200ErrorsGatewayErrorCategoryEnum = {}));
/**
* @export
* @enum {string}
*/
var PartnerFeedResponseFeedStatusEnum;
(function (PartnerFeedResponseFeedStatusEnum) {
PartnerFeedResponseFeedStatusEnum["Received"] = "RECEIVED";
PartnerFeedResponseFeedStatusEnum["Inprogress"] = "INPROGRESS";
PartnerFeedResponseFeedStatusEnum["Processed"] = "PROCESSED";
PartnerFeedResponseFeedStatusEnum["Error"] = "ERROR";
})(PartnerFeedResponseFeedStatusEnum = exports.PartnerFeedResponseFeedStatusEnum || (exports.PartnerFeedResponseFeedStatusEnum = {}));
/**
* @export
* @enum {string}
*/
var PartnerItemIngestionStatusIngestionStatusEnum;
(function (PartnerItemIngestionStatusIngestionStatusEnum) {
PartnerItemIngestionStatusIngestionStatusEnum["Inprogress"] = "INPROGRESS";
PartnerItemIngestionStatusIngestionStatusEnum["Success"] = "SUCCESS";
PartnerItemIngestionStatusIngestionStatusEnum["DataError"] = "DATA_ERROR";
PartnerItemIngestionStatusIngestionStatusEnum["SystemError"] = "SYSTEM_ERROR";
PartnerItemIngestionStatusIngestionStatusEnum["TimeoutError"] = "TIMEOUT_ERROR";
})(PartnerItemIngestionStatusIngestionStatusEnum = exports.PartnerItemIngestionStatusIngestionStatusEnum || (exports.PartnerItemIngestionStatusIngestionStatusEnum = {}));
/**
* FeedsApi - axios parameter creator
* @export
*/
const FeedsApiAxiosParamCreator = function (configuration) {
return {
/**
* Returns the feed statuses for all the specified Feed IDs.
* @summary All feed statuses
* @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} [feedId] A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789).
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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}
*/
getAllFeedStatuses: async (authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, feedId, offset, limit, wMCONSUMERCHANNELTYPE, options = {}) => {
// verify required parameter 'authorization' is not null or undefined
(0, common_1.assertParamExists)('getAllFeedStatuses', 'authorization', authorization);
// verify required parameter 'wMSECACCESSTOKEN' is not null or undefined
(0, common_1.assertParamExists)('getAllFeedStatuses', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN);
// verify required parameter 'wMQOSCORRELATIONID' is not null or undefined
(0, common_1.assertParamExists)('getAllFeedStatuses', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID);
// verify required parameter 'wMSVCNAME' is not null or undefined
(0, common_1.assertParamExists)('getAllFeedStatuses', 'wMSVCNAME', wMSVCNAME);
const localVarPath = `/v3/feeds`;
// 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 (feedId !== undefined) {
localVarQueryParameter['feedId'] = feedId;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
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);
}
(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,
};
},
/**
* Get Feed Error Report API allows you to download a detailed error report for a submitted feed. Currently the API supports error report download for the following feeds: * FITMENT_ACES * FITMENT_PIES This API returns a zipped .csv file, which contains line item level detailed error messages. For details and a sample, please refer to the guide section link below.
* @summary Get Feed Error Report
* @param {string} feedId Feed Id of the feed
* @param {'FITMENT_ACES' | 'FITMENT_PIES'} feedType Feed type for which Error Report needs to be downloaded
* @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} [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}
*/
getFeedErrorReport: async (feedId, feedType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, wMCONSUMERCHANNELTYPE, options = {}) => {
// verify required parameter 'feedId' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'feedId', feedId);
// verify required parameter 'feedType' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'feedType', feedType);
// verify required parameter 'authorization' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'authorization', authorization);
// verify required parameter 'wMSECACCESSTOKEN' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN);
// verify required parameter 'wMQOSCORRELATIONID' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID);
// verify required parameter 'wMSVCNAME' is not null or undefined
(0, common_1.assertParamExists)('getFeedErrorReport', 'wMSVCNAME', wMSVCNAME);
const localVarPath = `/v3/feeds/{feedId}/errorReport`
.replace(`{${"feedId"}}`, encodeURIComponent(String(feedId)));
// 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 (feedType !== undefined) {
localVarQueryParameter['feedType'] = feedType;
}
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);
}
(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,
};
},
/**
* Returns the feed and item status for a specified Feed ID.
* @summary Feed item status
* @param {string} feedId A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789)
* @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} [includeDetails] Includes details of each entity in the feed.
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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}
*/
getFeedItemStatus: async (feedId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, includeDetails, offset, limit, wMCONSUMERCHANNELTYPE, options = {}) => {
// verify required parameter 'feedId' is not null or undefined
(0, common_1.assertParamExists)('getFeedItemStatus', 'feedId', feedId);
// verify required parameter 'authorization' is not null or undefined
(0, common_1.assertParamExists)('getFeedItemStatus', 'authorization', authorization);
// verify required parameter 'wMSECACCESSTOKEN' is not null or undefined
(0, common_1.assertParamExists)('getFeedItemStatus', 'wMSECACCESSTOKEN', wMSECACCESSTOKEN);
// verify required parameter 'wMQOSCORRELATIONID' is not null or undefined
(0, common_1.assertParamExists)('getFeedItemStatus', 'wMQOSCORRELATIONID', wMQOSCORRELATIONID);
// verify required parameter 'wMSVCNAME' is not null or undefined
(0, common_1.assertParamExists)('getFeedItemStatus', 'wMSVCNAME', wMSVCNAME);
const localVarPath = `/v3/feeds/{feedId}`
.replace(`{${"feedId"}}`, encodeURIComponent(String(feedId)));
// 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 (includeDetails !== undefined) {
localVarQueryParameter['includeDetails'] = includeDetails;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
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);
}
(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.FeedsApiAxiosParamCreator = FeedsApiAxiosParamCreator;
/**
* FeedsApi - functional programming interface
* @export
*/
const FeedsApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.FeedsApiAxiosParamCreator)(configuration);
return {
/**
* Returns the feed statuses for all the specified Feed IDs.
* @summary All feed statuses
* @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} [feedId] A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789).
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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 getAllFeedStatuses(authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, feedId, offset, limit, wMCONSUMERCHANNELTYPE, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllFeedStatuses(authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, feedId, offset, limit, wMCONSUMERCHANNELTYPE, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* Get Feed Error Report API allows you to download a detailed error report for a submitted feed. Currently the API supports error report download for the following feeds: * FITMENT_ACES * FITMENT_PIES This API returns a zipped .csv file, which contains line item level detailed error messages. For details and a sample, please refer to the guide section link below.
* @summary Get Feed Error Report
* @param {string} feedId Feed Id of the feed
* @param {'FITMENT_ACES' | 'FITMENT_PIES'} feedType Feed type for which Error Report needs to be downloaded
* @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} [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 getFeedErrorReport(feedId, feedType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, wMCONSUMERCHANNELTYPE, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getFeedErrorReport(feedId, feedType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, wMCONSUMERCHANNELTYPE, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
/**
* Returns the feed and item status for a specified Feed ID.
* @summary Feed item status
* @param {string} feedId A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789)
* @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} [includeDetails] Includes details of each entity in the feed.
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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 getFeedItemStatus(feedId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, includeDetails, offset, limit, wMCONSUMERCHANNELTYPE, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.getFeedItemStatus(feedId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, includeDetails, offset, limit, wMCONSUMERCHANNELTYPE, options);
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
},
};
};
exports.FeedsApiFp = FeedsApiFp;
/**
* FeedsApi - factory interface
* @export
*/
const FeedsApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.FeedsApiFp)(configuration);
return {
/**
* Returns the feed statuses for all the specified Feed IDs.
* @summary All feed statuses
* @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} [feedId] A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789).
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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}
*/
getAllFeedStatuses(authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, feedId, offset, limit, wMCONSUMERCHANNELTYPE, options) {
return localVarFp.getAllFeedStatuses(authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, feedId, offset, limit, wMCONSUMERCHANNELTYPE, options).then((request) => request(axios, basePath));
},
/**
* Get Feed Error Report API allows you to download a detailed error report for a submitted feed. Currently the API supports error report download for the following feeds: * FITMENT_ACES * FITMENT_PIES This API returns a zipped .csv file, which contains line item level detailed error messages. For details and a sample, please refer to the guide section link below.
* @summary Get Feed Error Report
* @param {string} feedId Feed Id of the feed
* @param {'FITMENT_ACES' | 'FITMENT_PIES'} feedType Feed type for which Error Report needs to be downloaded
* @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} [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}
*/
getFeedErrorReport(feedId, feedType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, wMCONSUMERCHANNELTYPE, options) {
return localVarFp.getFeedErrorReport(feedId, feedType, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, wMCONSUMERCHANNELTYPE, options).then((request) => request(axios, basePath));
},
/**
* Returns the feed and item status for a specified Feed ID.
* @summary Feed item status
* @param {string} feedId A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: \'...3456@789...\' must be entered in the URL as \'...3456%40789)
* @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} [includeDetails] Includes details of each entity in the feed.
* @param {string} [offset] The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
* @param {string} [limit] The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
* @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}
*/
getFeedItemStatus(feedId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, includeDetails, offset, limit, wMCONSUMERCHANNELTYPE, options) {
return localVarFp.getFeedItemStatus(feedId, authorization, wMSECACCESSTOKEN, wMQOSCORRELATIONID, wMSVCNAME, includeDetails, offset, limit, wMCONSUMERCHANNELTYPE, options).then((request) => request(axios, basePath));
},
};
};
exports.FeedsApiFactory = FeedsApiFactory;
/**
* FeedsApi - object-oriented interface
* @export
* @class FeedsApi
* @extends {BaseAPI}
*/
class FeedsApi extends base_1.BaseAPI {
/**
* Returns the feed statuses for all the specified Feed IDs.
* @summary All feed statuses
* @param {FeedsApiGetAllFeedStatusesRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FeedsApi
*/
getAllFeedStatuses(requestParameters, options) {
return (0, exports.FeedsApiFp)(this.configuration).getAllFeedStatuses(requestParameters.authorization, requestParameters.wMSECACCESSTOKEN, requestParameters.wMQOSCORRELATIONID, requestParameters.wMSVCNAME, requestParameters.feedId, requestParameters.offset, requestParameters.limit, requestParameters.wMCONSUMERCHANNELTYPE, options).then((request) => request(this.axios, this.basePath));
}
/**
* Get Feed Error Report API allows you to download a detailed error report for a submitted feed. Currently the API supports error report download for the following feeds: * FITMENT_ACES * FITMENT_PIES This API returns a zipped .csv file, which contains line item level detailed error messages. For details and a sample, please refer to the guide section link below.
* @summary Get Feed Error Report
* @param {FeedsApiGetFeedErrorReportRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FeedsApi
*/
getFeedErrorReport(requestParameters, options) {
return (0, exports.FeedsApiFp)(this.configuration).getFeedErrorReport(requestParameters.feedId, requestParameters.feedType, requestParameters.authorization, requestParameters.wMSECACCESSTOKEN, requestParameters.wMQOSCORRELATIONID, requestParameters.wMSVCNAME, requestParameters.wMCONSUMERCHANNELTYPE, options).then((request) => request(this.axios, this.basePath));
}
/**
* Returns the feed and item status for a specified Feed ID.
* @summary Feed item status
* @param {FeedsApiGetFeedItemStatusRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FeedsApi
*/
getFeedItemStatus(requestParameters, options) {
return (0, exports.FeedsApiFp)(this.configuration).getFeedItemStatus(requestParameters.feedId, requestParameters.authorization, requestParameters.wMSECACCESSTOKEN, requestParameters.wMQOSCORRELATIONID, requestParameters.wMSVCNAME, requestParameters.includeDetails, requestParameters.offset, requestParameters.limit, requestParameters.wMCONSUMERCHANNELTYPE, options).then((request) => request(this.axios, this.basePath));
}
}
exports.FeedsApi = FeedsApi;
//# sourceMappingURL=feeds.js.map