@sp-api-sdk/sales-api-v1 3.0.5 → 3.1.0

package/dist/cjs/api-model/api/sales-api.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetOrderMetricsFirstDayOfWeekEnum = exports.GetOrderMetricsBuyerTypeEnum = exports.GetOrderMetricsGranularityEnum = exports.SalesApi = exports.SalesApiFactory = exports.SalesApiFp = exports.SalesApiAxiosParamCreator = void 0;
+exports.GetOrderMetricsAmazonProgramEnum = exports.GetOrderMetricsFirstDayOfWeekEnum = exports.GetOrderMetricsBuyerTypeEnum = exports.GetOrderMetricsGranularityEnum = exports.SalesApi = exports.SalesApiFactory = exports.SalesApiFp = exports.SalesApiAxiosParamCreator = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -40,10 +40,11 @@ const SalesApiAxiosParamCreator = function (configuration) {
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** `AmazonHaul` returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrderMetrics: async (marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options = {}) => {
+        getOrderMetrics: async (marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options = {}) => {
             // verify required parameter 'marketplaceIds' is not null or undefined
             (0, common_1.assertParamExists)('getOrderMetrics', 'marketplaceIds', marketplaceIds);
             // verify required parameter 'interval' is not null or undefined
@@ -87,6 +88,9 @@ const SalesApiAxiosParamCreator = function (configuration) {
             if (sku !== undefined) {
                 localVarQueryParameter['sku'] = sku;
             }
+            if (amazonProgram !== undefined) {
+                localVarQueryParameter['amazonProgram'] = amazonProgram;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -116,11 +120,12 @@ const SalesApiFp = function (configuration) {
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** `AmazonHaul` returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options);
+        async getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = base_1.operationServerMap['SalesApi.getOrderMetrics']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -142,7 +147,7 @@ const SalesApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getOrderMetrics(requestParameters, options) {
-            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(axios, basePath));
+            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -162,7 +167,7 @@ class SalesApi extends base_1.BaseAPI {
      * @memberof SalesApi
      */
     getOrderMetrics(requestParameters, options) {
-        return (0, exports.SalesApiFp)(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.SalesApiFp)(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.SalesApi = SalesApi;
@@ -192,3 +197,9 @@ exports.GetOrderMetricsFirstDayOfWeekEnum = {
     Monday: 'Monday',
     Sunday: 'Sunday'
 };
+/**
+ * @export
+ */
+exports.GetOrderMetricsAmazonProgramEnum = {
+    AmazonHaul: 'AmazonHaul'
+};

package/dist/es/api-model/api/sales-api.js

@@ -34,10 +34,11 @@ export const SalesApiAxiosParamCreator = function (configuration) {
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** `AmazonHaul` returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getOrderMetrics: async (marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options = {}) => {
+        getOrderMetrics: async (marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options = {}) => {
             // verify required parameter 'marketplaceIds' is not null or undefined
             assertParamExists('getOrderMetrics', 'marketplaceIds', marketplaceIds);
             // verify required parameter 'interval' is not null or undefined
@@ -81,6 +82,9 @@ export const SalesApiAxiosParamCreator = function (configuration) {
             if (sku !== undefined) {
                 localVarQueryParameter['sku'] = sku;
             }
+            if (amazonProgram !== undefined) {
+                localVarQueryParameter['amazonProgram'] = amazonProgram;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -109,11 +113,12 @@ export const SalesApiFp = function (configuration) {
          * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
          * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
          * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+         * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** `AmazonHaul` returns order metrics for the Amazon Haul program only.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, options);
+        async getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderMetrics(marketplaceIds, interval, granularity, granularityTimeZone, buyerType, fulfillmentNetwork, firstDayOfWeek, asin, sku, amazonProgram, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SalesApi.getOrderMetrics']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -134,7 +139,7 @@ export const SalesApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          */
         getOrderMetrics(requestParameters, options) {
-            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(axios, basePath));
+            return localVarFp.getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -153,7 +158,7 @@ export class SalesApi extends BaseAPI {
      * @memberof SalesApi
      */
     getOrderMetrics(requestParameters, options) {
-        return SalesApiFp(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, options).then((request) => request(this.axios, this.basePath));
+        return SalesApiFp(this.configuration).getOrderMetrics(requestParameters.marketplaceIds, requestParameters.interval, requestParameters.granularity, requestParameters.granularityTimeZone, requestParameters.buyerType, requestParameters.fulfillmentNetwork, requestParameters.firstDayOfWeek, requestParameters.asin, requestParameters.sku, requestParameters.amazonProgram, options).then((request) => request(this.axios, this.basePath));
     }
 }
 /**
@@ -182,3 +187,9 @@ export const GetOrderMetricsFirstDayOfWeekEnum = {
     Monday: 'Monday',
     Sunday: 'Sunday'
 };
+/**
+ * @export
+ */
+export const GetOrderMetricsAmazonProgramEnum = {
+    AmazonHaul: 'AmazonHaul'
+};

package/dist/types/api-model/api/sales-api.d.ts

@@ -30,10 +30,11 @@ export declare const SalesApiAxiosParamCreator: (configuration?: Configuration)
      * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
      * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
      * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+     * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** `AmazonHaul` returns order metrics for the Amazon Haul program only.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrderMetrics: (marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getOrderMetrics: (marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, amazonProgram?: GetOrderMetricsAmazonProgramEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * SalesApi - functional programming interface
@@ -51,10 +52,11 @@ export declare const SalesApiFp: (configuration?: Configuration) => {
      * @param {GetOrderMetricsFirstDayOfWeekEnum} [firstDayOfWeek] Specifies the day that the week starts on when granularity&#x3D;Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.
      * @param {string} [asin] Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.
      * @param {string} [sku] Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.
+     * @param {GetOrderMetricsAmazonProgramEnum} [amazonProgram] Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getOrderMetrics(marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderMetricsResponse>>;
+    getOrderMetrics(marketplaceIds: Array<string>, interval: string, granularity: GetOrderMetricsGranularityEnum, granularityTimeZone?: string, buyerType?: GetOrderMetricsBuyerTypeEnum, fulfillmentNetwork?: string, firstDayOfWeek?: GetOrderMetricsFirstDayOfWeekEnum, asin?: string, sku?: string, amazonProgram?: GetOrderMetricsAmazonProgramEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderMetricsResponse>>;
 };
 /**
  * SalesApi - factory interface
@@ -129,6 +131,12 @@ export interface SalesApiGetOrderMetricsRequest {
      * @memberof SalesApiGetOrderMetrics
      */
     readonly sku?: string;
+    /**
+     * Filters the results by the Amazon program that you specify. Do not include this filter if you want the response to include order metrics for all programs. **Example:** &#x60;AmazonHaul&#x60; returns order metrics for the Amazon Haul program only.
+     * @type {'AmazonHaul'}
+     * @memberof SalesApiGetOrderMetrics
+     */
+    readonly amazonProgram?: GetOrderMetricsAmazonProgramEnum;
 }
 /**
  * SalesApi - object-oriented interface
@@ -175,3 +183,10 @@ export declare const GetOrderMetricsFirstDayOfWeekEnum: {
     readonly Sunday: "Sunday";
 };
 export type GetOrderMetricsFirstDayOfWeekEnum = typeof GetOrderMetricsFirstDayOfWeekEnum[keyof typeof GetOrderMetricsFirstDayOfWeekEnum];
+/**
+ * @export
+ */
+export declare const GetOrderMetricsAmazonProgramEnum: {
+    readonly AmazonHaul: "AmazonHaul";
+};
+export type GetOrderMetricsAmazonProgramEnum = typeof GetOrderMetricsAmazonProgramEnum[keyof typeof GetOrderMetricsAmazonProgramEnum];

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/sales-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Sales provides APIs related to sales performance.",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.1.14",
-    "axios": "^1.9.0"
+    "@sp-api-sdk/common": "2.1.15",
+    "axios": "^1.10.0"
   },
   "repository": {
     "type": "git",
@@ -40,5 +40,5 @@
     "sp sdk",
     "sales api"
   ],
-  "gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
+  "gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
 }