@sp-api-sdk/replenishment-api-2022-11-07 - npm Package Compare versions

Comparing version 2.1.1 to 2.2.0

dist/cjs/src/api-model/api/offers-api.js

@@ -34,3 +34,3 @@ "use strict";
          * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {GetSellingPartnerMetricsRequest} [body]
+         * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
          * @param {*} [options] Override http request option.
@@ -88,4 +88,4 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {ListOffersRequest} [body]
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
          * @param {*} [options] Override http request option.
@@ -127,3 +127,3 @@ * @throws {RequiredError}
          * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {GetSellingPartnerMetricsRequest} [body]
+         * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
          * @param {*} [options] Override http request option.
@@ -151,4 +151,4 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {ListOffersRequest} [body]
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
          * @param {*} [options] Override http request option.
@@ -192,3 +192,3 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -232,3 +232,3 @@ * @param {*} [options] Override http request option.
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -235,0 +235,0 @@ * @param {*} [options] Override http request option.

dist/cjs/src/api-model/models/aggregation-frequency.js

@@ -18,3 +18,3 @@ "use strict";
 /**
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
  * @export
@@ -21,0 +21,0 @@ * @enum {string}

dist/cjs/src/api-model/models/metric.js

@@ -27,3 +27,6 @@ "use strict";
     NotDeliveredDueToOos: 'NOT_DELIVERED_DUE_TO_OOS',
-    SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE'
+    SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
+    LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
+    SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
+    CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
 };

dist/es/src/api-model/api/offers-api.js

@@ -28,3 +28,3 @@ /* tslint:disable */
          * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {GetSellingPartnerMetricsRequest} [body]
+         * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
          * @param {*} [options] Override http request option.
@@ -82,4 +82,4 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {ListOffersRequest} [body]
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
          * @param {*} [options] Override http request option.
@@ -120,3 +120,3 @@ * @throws {RequiredError}
          * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {GetSellingPartnerMetricsRequest} [body]
+         * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
          * @param {*} [options] Override http request option.
@@ -144,4 +144,4 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-         * @param {ListOffersRequest} [body]
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
          * @param {*} [options] Override http request option.
@@ -184,3 +184,3 @@ * @throws {RequiredError}
         /**
-         * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+         * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
          * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -223,3 +223,3 @@ * @param {*} [options] Override http request option.
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -226,0 +226,0 @@ * @param {*} [options] Override http request option.

dist/es/src/api-model/models/aggregation-frequency.js

@@ -15,3 +15,3 @@ /* tslint:disable */
 /**
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
  * @export
@@ -18,0 +18,0 @@ * @enum {string}

dist/es/src/api-model/models/metric.js

@@ -24,3 +24,6 @@ /* tslint:disable */
     NotDeliveredDueToOos: 'NOT_DELIVERED_DUE_TO_OOS',
-    SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE'
+    SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
+    LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
+    SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
+    CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
 };

dist/types/src/api-model/api/offers-api.d.ts

@@ -29,3 +29,3 @@ /**
      * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {GetSellingPartnerMetricsRequest} [body]
+     * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
      * @param {*} [options] Override http request option.
@@ -43,4 +43,4 @@ * @throws {RequiredError}
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {ListOffersRequest} [body]
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
      * @param {*} [options] Override http request option.
@@ -58,3 +58,3 @@ * @throws {RequiredError}
      * Returns aggregated replenishment program metrics for a selling partner.   **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {GetSellingPartnerMetricsRequest} [body]
+     * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
      * @param {*} [options] Override http request option.
@@ -72,4 +72,4 @@ * @throws {RequiredError}
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
-     * @param {ListOffersRequest} [body]
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
      * @param {*} [options] Override http request option.
@@ -100,3 +100,3 @@ * @throws {RequiredError}
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -115,3 +115,3 @@ * @param {*} [options] Override http request option.
     /**
-     *
+     * The request body for the `getSellingPartnerMetrics` operation.
      * @type {GetSellingPartnerMetricsRequest}
@@ -142,3 +142,3 @@ * @memberof OffersApiGetSellingPartnerMetrics
     /**
-     *
+     * The request body for the `listOffers` operation.
      * @type {ListOffersRequest}
@@ -173,3 +173,3 @@ * @memberof OffersApiListOffers
     /**
-     * Returns the details of a selling partner\'s replenishment program offers. Note that this operation only supports sellers at this time.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
+     * Returns the details of a selling partner\'s replenishment program offers.  **Usage Plan:**  | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 1 |  The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
      * @param {OffersApiListOffersRequest} requestParameters Request parameters.
@@ -176,0 +176,0 @@ * @param {*} [options] Override http request option.

dist/types/src/api-model/models/aggregation-frequency.d.ts

@@ -13,3 +13,3 @@ /**
 /**
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
  * @export
@@ -16,0 +16,0 @@ * @enum {string}

dist/types/src/api-model/models/error-list.d.ts

@@ -19,3 +19,3 @@ /**
     /**
-     *
+     * A list of error responses returned when a request is unsuccessful.
      * @type {Array<Error>}
@@ -22,0 +22,0 @@ * @memberof ErrorList

dist/types/src/api-model/models/get-selling-partner-metrics-response-metric.d.ts

@@ -20,3 +20,3 @@ /**
     /**
-     * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the PERFORMANCE timePeriodType.
+     * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -27,3 +27,3 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
-     * The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
+     * The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
      * @type {number}
@@ -34,3 +34,3 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
-     * The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
+     * The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
      * @type {number}
@@ -41,3 +41,3 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
-     * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
+     * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -48,3 +48,3 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
-     * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the PERFORMANCE timePeriodType.
+     * The average revenue per subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -55,3 +55,3 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
-     * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the PERFORMANCE timePeriodType.
+     * The average revenue per non-subscriber of the program over a period of past 12 months for sellers and 6 months for vendors. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -62,2 +62,26 @@ * @memberof GetSellingPartnerMetricsResponseMetric
     /**
+     * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
+     * @type {number}
+     * @memberof GetSellingPartnerMetricsResponseMetric
+     */
+    'lostRevenueDueToOOS'?: number;
+    /**
+     * The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType.
+     * @type {number}
+     * @memberof GetSellingPartnerMetricsResponseMetric
+     */
+    'subscriberAverageReorders'?: number;
+    /**
+     * The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType.
+     * @type {number}
+     * @memberof GetSellingPartnerMetricsResponseMetric
+     */
+    'nonSubscriberAverageReorders'?: number;
+    /**
+     * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
+     * @type {number}
+     * @memberof GetSellingPartnerMetricsResponseMetric
+     */
+    'couponsRevenuePenetration'?: number;
+    /**
      *
@@ -64,0 +88,0 @@ * @type {TimeInterval}

dist/types/src/api-model/models/list-offer-metrics-response-offer.d.ts

@@ -26,3 +26,3 @@ /**
     /**
-     * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the PERFORMANCE timePeriodType.
+     * The percentage of items that were not shipped out of the total shipped units over a period of time due to being out of stock. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -33,3 +33,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType.
+     * The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -40,3 +40,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType.
+     * The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -47,3 +47,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
+     * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -54,3 +54,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The percentage of total program revenue out of total product revenue. Applicable only for the PERFORMANCE timePeriodType.
+     * The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`.
      * @type {number}
@@ -61,9 +61,21 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType.
+     * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
      * @type {number}
      * @memberof ListOfferMetricsResponseOffer
      */
+    'lostRevenueDueToOOS'?: number;
+    /**
+     * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
+     * @type {number}
+     * @memberof ListOfferMetricsResponseOffer
+     */
+    'couponsRevenuePenetration'?: number;
+    /**
+     * The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
+     * @type {number}
+     * @memberof ListOfferMetricsResponseOffer
+     */
     'next30DayTotalSubscriptionsRevenue'?: number;
     /**
-     * The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType.
+     * The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
      * @type {number}
@@ -74,3 +86,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType.
+     * The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
      * @type {number}
@@ -81,3 +93,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType.
+     * The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
      * @type {number}
@@ -88,3 +100,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType.
+     * The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
      * @type {number}
@@ -95,3 +107,3 @@ * @memberof ListOfferMetricsResponseOffer
     /**
-     * The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType.
+     * The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
      * @type {number}
@@ -98,0 +110,0 @@ * @memberof ListOfferMetricsResponseOffer

dist/types/src/api-model/models/metric.d.ts

@@ -23,3 +23,6 @@ /**
     readonly SubscriberNonSubscriberAverageRevenue: "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE";
+    readonly LostRevenueDueToOos: "LOST_REVENUE_DUE_TO_OOS";
+    readonly SubscriberNonSubscriberAverageReorders: "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS";
+    readonly CouponsRevenuePenetration: "COUPONS_REVENUE_PENETRATION";
 };
 export type Metric = typeof Metric[keyof typeof Metric];

dist/types/src/api-model/models/time-interval.d.ts

@@ -19,3 +19,3 @@ /**
     /**
-     * When this object is used as a request parameter, the specified startDate is adjusted based on the aggregation frequency.  * For WEEK the metric is computed from the first day of the week (that is, Sunday based on ISO 8601) that contains the startDate. * For MONTH the metric is computed from the first day of the month that contains the startDate. * For QUARTER the metric is computed from the first day of the quarter that contains the startDate. * For YEAR the metric is computed from the first day of the year that contains the startDate.
+     * When this object is used as a request parameter, the specified `startDate` is adjusted based on the aggregation frequency.  * For `WEEK` the metric is computed from the first day of the week (Sunday, based on ISO 8601) that contains the `startDate`. * For `MONTH` the metric is computed from the first day of the month that contains the `startDate`. * For `QUARTER` the metric is computed from the first day of the quarter that contains the `startDate`. * For `YEAR` the metric is computed from the first day of the year that contains the `startDate`.
      * @type {string}
@@ -26,3 +26,3 @@ * @memberof TimeInterval
     /**
-     * When this object is used as a request parameter, the specified endDate is adjusted based on the aggregation frequency.  * For WEEK the metric is computed up to the last day of the week (that is, Sunday based on ISO 8601) that contains the endDate. * For MONTH, the metric is computed up to the last day that contains the endDate. * For QUARTER the metric is computed up to the last day of the quarter that contains the endDate. * For YEAR the metric is computed up to the last day of the year that contains the endDate.  Note: The end date may be adjusted to a lower value based on the data available in our system.
+     * When this object is used as a request parameter, the specified `endDate` is adjusted based on the aggregation frequency.  * For `WEEK` the metric is computed up to the last day of the week (Sunday, based on ISO 8601) that contains the `endDate`. * For `MONTH`, the metric is computed up to the last day that contains the `endDate`. * For `QUARTER` the metric is computed up to the last day of the quarter that contains the `endDate`. * For `YEAR` the metric is computed up to the last day of the year that contains the `endDate`.  Note: The end date may be adjusted to a lower value based on the data available in our system.
      * @type {string}
@@ -29,0 +29,0 @@ * @memberof TimeInterval

package.json

@@ -5,3 +5,3 @@ {
   "description": "The Selling Partner API for Replenishment (Replenishment API) provides programmatic access to replenishment program metrics and offers. These programs provide recurring delivery of any replenishable item at a frequency chosen by the customer. The Replenishment API is available worldwide wherever Amazon Subscribe & Save is available or is supported. The API is available to vendors and FBA selling partners.",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "main": "dist/cjs/index.js",
@@ -44,3 +44,3 @@ "module": "dist/es/index.js",
   ],
-  "gitHead": "cce8c720364baf071322463e8e3ed29c322cc93a"
+  "gitHead": "207e9cb4cdd2886752a696cfd7355dfaaf0129cb"
 }

No alert changes

Improved metrics

Total package byte prevSize

223882

increased by1.19%

Lines of code

4577

increased by0.99%

No dependency changes