@amazon-sp-api-release/amazon-sp-api-sdk-js 1.1.0 → 1.2.0

package/src/pricing_v2022_05_01/model/CompetitiveSummaryResponseBody.js

@@ -29,7 +29,7 @@ export class CompetitiveSummaryResponseBody {
    * @alias module:pricing_v2022_05_01/model/CompetitiveSummaryResponseBody
    * @class
    * @param asin {String} The ASIN of the item.
-   * @param marketplaceId {String} A marketplace identifier. Specifies the marketplace for which data is returned.
+   * @param marketplaceId {String} The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
    */
   constructor (asin, marketplaceId) {
     this.asin = asin
@@ -75,7 +75,7 @@ export class CompetitiveSummaryResponseBody {
 CompetitiveSummaryResponseBody.prototype.asin = undefined
 
 /**
- * A marketplace identifier. Specifies the marketplace for which data is returned.
+ * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  * @member {String} marketplaceId
  */
 CompetitiveSummaryResponseBody.prototype.marketplaceId = undefined

package/src/pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequest.js

@@ -32,7 +32,7 @@ export class FeaturedOfferExpectedPriceRequest {
    * @implements module:pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequestParams
    * @param uri {String} The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`.
    * @param method {module:pricing_v2022_05_01/model/HttpMethod}
-   * @param marketplaceId {String} A marketplace identifier. Specifies the marketplace for which data is returned.
+   * @param marketplaceId {String} The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
    * @param sku {String} The seller SKU of the item.
    */
   constructor (uri, method, marketplaceId, sku) {
@@ -103,7 +103,7 @@ FeaturedOfferExpectedPriceRequest.prototype.body = undefined
 FeaturedOfferExpectedPriceRequest.prototype.headers = undefined
 
 /**
- * A marketplace identifier. Specifies the marketplace for which data is returned.
+ * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  * @member {String} marketplaceId
  */
 FeaturedOfferExpectedPriceRequest.prototype.marketplaceId = undefined
@@ -145,7 +145,7 @@ BatchRequest.prototype.headers = undefined
 
 // Implement FeaturedOfferExpectedPriceRequestParams interface:
 /**
- * A marketplace identifier. Specifies the marketplace for which data is returned.
+ * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  * @member {String} marketplaceId
  */
 FeaturedOfferExpectedPriceRequestParams.prototype.marketplaceId = undefined

package/src/pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequestParams.js

@@ -25,7 +25,7 @@ export class FeaturedOfferExpectedPriceRequestParams {
    * The parameters for an individual request.
    * @alias module:pricing_v2022_05_01/model/FeaturedOfferExpectedPriceRequestParams
    * @class
-   * @param marketplaceId {String} A marketplace identifier. Specifies the marketplace for which data is returned.
+   * @param marketplaceId {String} The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
    * @param sku {String} The seller SKU of the item.
    */
   constructor (marketplaceId, sku) {
@@ -63,7 +63,7 @@ export class FeaturedOfferExpectedPriceRequestParams {
 }
 
 /**
- * A marketplace identifier. Specifies the marketplace for which data is returned.
+ * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  * @member {String} marketplaceId
  */
 FeaturedOfferExpectedPriceRequestParams.prototype.marketplaceId = undefined

package/src/pricing_v2022_05_01/model/FeaturedOfferSegment.js

@@ -78,7 +78,13 @@ FeaturedOfferSegment.CustomerMembershipEnum = {
      * value: "NON_PRIME"
      * @const
      */
-  NON_PRIME: 'NON_PRIME'
+  NON_PRIME: 'NON_PRIME',
+
+  /**
+     * value: "DEFAULT"
+     * @const
+     */
+  DEFAULT: 'DEFAULT'
 }
 
 /**

package/src/pricing_v2022_05_01/model/LowestPricedOffersInput.js

@@ -74,10 +74,10 @@ LowestPricedOffersInput.prototype.itemCondition = undefined
 LowestPricedOffersInput.OfferTypeEnum = {
 
   /**
-     * value: "CONSUMER"
+     * value: "Consumer"
      * @const
      */
-  CONSUMER: 'CONSUMER'
+  Consumer: 'Consumer'
 }
 
 /**

package/src/pricing_v2022_05_01/model/OfferIdentifier.js

@@ -25,7 +25,7 @@ export class OfferIdentifier {
    * Identifies an offer from a particular seller for a specified ASIN.
    * @alias module:pricing_v2022_05_01/model/OfferIdentifier
    * @class
-   * @param marketplaceId {String} A marketplace identifier. Specifies the marketplace for which data is returned.
+   * @param marketplaceId {String} The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
    * @param asin {String} The ASIN of the item.
    */
   constructor (marketplaceId, asin) {
@@ -65,7 +65,7 @@ export class OfferIdentifier {
 }
 
 /**
- * A marketplace identifier. Specifies the marketplace for which data is returned.
+ * The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
  * @member {String} marketplaceId
  */
 OfferIdentifier.prototype.marketplaceId = undefined

package/src/pricing_v2022_05_01/model/ReferencePrice.js

@@ -25,7 +25,7 @@ export class ReferencePrice {
    * The reference price for the specified ASIN `marketplaceId` combination.
    * @alias module:pricing_v2022_05_01/model/ReferencePrice
    * @class
-   * @param name {String} The name of the reference price, such as `CompetitivePriceThreshold` and `WasPrice`. For reference price definitions, refer to the [Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+   * @param name {String} Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, see the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
    * @param price {module:pricing_v2022_05_01/model/MoneyType}
    */
   constructor (name, price) {
@@ -62,7 +62,7 @@ export class ReferencePrice {
 }
 
 /**
- * The name of the reference price, such as `CompetitivePriceThreshold` and `WasPrice`. For reference price definitions, refer to the [Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
+ * Reference price type (e.g., `CompetitivePriceThreshold`, `WasPrice`, `CompetitivePrice`). For definitions, see the [Product Pricing API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
  * @member {String} name
  */
 ReferencePrice.prototype.name = undefined

package/src/productfees_v0/ApiClient.js

@@ -13,6 +13,7 @@
 
 import superagent from 'superagent'
 import querystring from 'querystring'
+import { readFileSync } from 'node:fs'
 import { URL } from 'node:url'
 import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
 import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
@@ -214,13 +215,16 @@ export class ApiClient {
     this.authentications = {
     }
 
+    const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
+    const version = pkg.version ? pkg.version : 'undefined'
+
     /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array<String>}
          * @default {}
          */
     this.defaultHeaders = {
-      'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+      'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
     }
 
     /**

package/src/producttypedefinitions_v2020_09_01/ApiClient.js

@@ -13,6 +13,7 @@
 
 import superagent from 'superagent'
 import querystring from 'querystring'
+import { readFileSync } from 'node:fs'
 import { URL } from 'node:url'
 import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
 import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
@@ -214,13 +215,16 @@ export class ApiClient {
     this.authentications = {
     }
 
+    const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
+    const version = pkg.version ? pkg.version : 'undefined'
+
     /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array<String>}
          * @default {}
          */
     this.defaultHeaders = {
-      'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+      'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
     }
 
     /**

package/src/replenishment_v2022_11_07/ApiClient.js

@@ -13,6 +13,7 @@
 
 import superagent from 'superagent'
 import querystring from 'querystring'
+import { readFileSync } from 'node:fs'
 import { URL } from 'node:url'
 import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
 import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
@@ -214,13 +215,16 @@ export class ApiClient {
     this.authentications = {
     }
 
+    const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
+    const version = pkg.version ? pkg.version : 'undefined'
+
     /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array<String>}
          * @default {}
          */
     this.defaultHeaders = {
-      'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+      'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
     }
 
     /**

package/src/reports_v2021_06_30/ApiClient.js

@@ -13,6 +13,7 @@
 
 import superagent from 'superagent'
 import querystring from 'querystring'
+import { readFileSync } from 'node:fs'
 import { URL } from 'node:url'
 import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
 import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
@@ -214,13 +215,16 @@ export class ApiClient {
     this.authentications = {
     }
 
+    const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
+    const version = pkg.version ? pkg.version : 'undefined'
+
     /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array<String>}
          * @default {}
          */
     this.defaultHeaders = {
-      'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+      'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
     }
 
     /**

package/src/sales_v1/ApiClient.js

@@ -13,6 +13,7 @@
 
 import superagent from 'superagent'
 import querystring from 'querystring'
+import { readFileSync } from 'node:fs'
 import { URL } from 'node:url'
 import { RateLimitConfiguration } from '../../helper/RateLimitConfiguration.mjs'
 import { SuperagentRateLimiter } from '../../helper/SuperagentRateLimiter.mjs'
@@ -214,13 +215,16 @@ export class ApiClient {
     this.authentications = {
     }
 
+    const pkg = JSON.parse(readFileSync(new URL('../../package.json', import.meta.url)))
+    const version = pkg.version ? pkg.version : 'undefined'
+
     /**
          * The default HTTP headers to be included for all API calls.
          * @type {Array<String>}
          * @default {}
          */
     this.defaultHeaders = {
-      'User-Agent': 'amazon-selling-partner-api-sdk/1.0.0/JavaScript'
+      'User-Agent': `amazon-selling-partner-api-sdk/${version}/JavaScript`
     }
 
     /**

package/src/sales_v1/api/SalesApi.js

@@ -73,6 +73,7 @@ export class SalesApi {
      * @param {module:sales_v1/model/String} opts.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. (default to 'Monday')
      * @param {String} opts.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} opts.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 {module:sales_v1/model/String} opts.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.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:sales_v1/model/GetOrderMetricsResponse} and HTTP response
      */
   getOrderMetricsWithHttpInfo (marketplaceIds, interval, granularity, opts) {
@@ -105,7 +106,8 @@ export class SalesApi {
       fulfillmentNetwork: opts.fulfillmentNetwork,
       firstDayOfWeek: opts.firstDayOfWeek,
       asin: opts.asin,
-      sku: opts.sku
+      sku: opts.sku,
+      amazonProgram: opts.amazonProgram
     }
     const headerParams = {
     }
@@ -135,6 +137,7 @@ export class SalesApi {
      * @param {module:sales_v1/model/String} opts.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. (default to 'Monday')
      * @param {String} opts.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} opts.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 {module:sales_v1/model/String} opts.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.
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:sales_v1/model/GetOrderMetricsResponse}
      */
   getOrderMetrics (marketplaceIds, interval, granularity, opts) {