@sp-api-sdk/replenishment-api-2022-11-07 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist/cjs/src/api-model/api/offers-api.js +8 -8
  2. package/dist/cjs/src/api-model/models/aggregation-frequency.js +1 -1
  3. package/dist/cjs/src/api-model/models/metric.js +4 -1
  4. package/dist/es/src/api-model/api/offers-api.js +8 -8
  5. package/dist/es/src/api-model/models/aggregation-frequency.js +1 -1
  6. package/dist/es/src/api-model/models/metric.js +4 -1
  7. package/dist/types/src/api-model/api/offers-api.d.ts +10 -10
  8. package/dist/types/src/api-model/models/aggregation-frequency.d.ts +1 -1
  9. package/dist/types/src/api-model/models/error-list.d.ts +1 -1
  10. package/dist/types/src/api-model/models/get-selling-partner-metrics-response-metric.d.ts +30 -6
  11. package/dist/types/src/api-model/models/list-offer-metrics-response-offer.d.ts +23 -11
  12. package/dist/types/src/api-model/models/metric.d.ts +3 -0
  13. package/dist/types/src/api-model/models/time-interval.d.ts +2 -2
  14. package/package.json +4 -4
package/dist/cjs/src/api-model/api/offers-api.js CHANGED
@@ -31,7 +31,7 @@ const OffersApiAxiosParamCreator = function (configuration) {
31
31
  return {
32
32
  /**
33
33
  * 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).
34
- * @param {GetSellingPartnerMetricsRequest} [body]
34
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
37
37
  */
@@ -84,8 +84,8 @@ const OffersApiAxiosParamCreator = function (configuration) {
84
84
  };
85
85
  },
86
86
  /**
87
- * 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).
88
- * @param {ListOffersRequest} [body]
87
+ * 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).
88
+ * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
89
89
  * @param {*} [options] Override http request option.
90
90
  * @throws {RequiredError}
91
91
  */
@@ -122,7 +122,7 @@ const OffersApiFp = function (configuration) {
122
122
  return {
123
123
  /**
124
124
  * 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).
125
- * @param {GetSellingPartnerMetricsRequest} [body]
125
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
126
126
  * @param {*} [options] Override http request option.
127
127
  * @throws {RequiredError}
128
128
  */
@@ -145,8 +145,8 @@ const OffersApiFp = function (configuration) {
145
145
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
146
146
  },
147
147
  /**
148
- * 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).
149
- * @param {ListOffersRequest} [body]
148
+ * 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).
149
+ * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
150
150
  * @param {*} [options] Override http request option.
151
151
  * @throws {RequiredError}
152
152
  */
@@ -185,7 +185,7 @@ const OffersApiFactory = function (configuration, basePath, axios) {
185
185
  return localVarFp.listOfferMetrics(requestParameters.body, options).then((request) => request(axios, basePath));
186
186
  },
187
187
  /**
188
- * 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).
188
+ * 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).
189
189
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
190
190
  * @param {*} [options] Override http request option.
191
191
  * @throws {RequiredError}
@@ -224,7 +224,7 @@ class OffersApi extends base_1.BaseAPI {
224
224
  return (0, exports.OffersApiFp)(this.configuration).listOfferMetrics(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
225
225
  }
226
226
  /**
227
- * 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).
227
+ * 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).
228
228
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
229
229
  * @param {*} [options] Override http request option.
230
230
  * @throws {RequiredError}
package/dist/cjs/src/api-model/models/aggregation-frequency.js CHANGED
@@ -15,7 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.AggregationFrequency = void 0;
17
17
  /**
18
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
18
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
package/dist/cjs/src/api-model/models/metric.js CHANGED
@@ -24,5 +24,8 @@ exports.Metric = {
24
24
  TotalSubscriptionsRevenue: 'TOTAL_SUBSCRIPTIONS_REVENUE',
25
25
  ActiveSubscriptions: 'ACTIVE_SUBSCRIPTIONS',
26
26
  NotDeliveredDueToOos: 'NOT_DELIVERED_DUE_TO_OOS',
27
- SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE'
27
+ SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
28
+ LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
29
+ SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
30
+ CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
28
31
  };
package/dist/es/src/api-model/api/offers-api.js CHANGED
@@ -25,7 +25,7 @@ export const OffersApiAxiosParamCreator = function (configuration) {
25
25
  return {
26
26
  /**
27
27
  * 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).
28
- * @param {GetSellingPartnerMetricsRequest} [body]
28
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
29
29
  * @param {*} [options] Override http request option.
30
30
  * @throws {RequiredError}
31
31
  */
@@ -78,8 +78,8 @@ export const OffersApiAxiosParamCreator = function (configuration) {
78
78
  };
79
79
  },
80
80
  /**
81
- * 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).
82
- * @param {ListOffersRequest} [body]
81
+ * 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).
82
+ * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
83
83
  * @param {*} [options] Override http request option.
84
84
  * @throws {RequiredError}
85
85
  */
@@ -115,7 +115,7 @@ export const OffersApiFp = function (configuration) {
115
115
  return {
116
116
  /**
117
117
  * 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).
118
- * @param {GetSellingPartnerMetricsRequest} [body]
118
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
119
119
  * @param {*} [options] Override http request option.
120
120
  * @throws {RequiredError}
121
121
  */
@@ -138,8 +138,8 @@ export const OffersApiFp = function (configuration) {
138
138
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
139
139
  },
140
140
  /**
141
- * 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).
142
- * @param {ListOffersRequest} [body]
141
+ * 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).
142
+ * @param {ListOffersRequest} [body] The request body for the `listOffers` operation.
143
143
  * @param {*} [options] Override http request option.
144
144
  * @throws {RequiredError}
145
145
  */
@@ -177,7 +177,7 @@ export const OffersApiFactory = function (configuration, basePath, axios) {
177
177
  return localVarFp.listOfferMetrics(requestParameters.body, options).then((request) => request(axios, basePath));
178
178
  },
179
179
  /**
180
- * 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).
180
+ * 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).
181
181
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
182
182
  * @param {*} [options] Override http request option.
183
183
  * @throws {RequiredError}
@@ -215,7 +215,7 @@ export class OffersApi extends BaseAPI {
215
215
  return OffersApiFp(this.configuration).listOfferMetrics(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
216
216
  }
217
217
  /**
218
- * 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).
218
+ * 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).
219
219
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
220
220
  * @param {*} [options] Override http request option.
221
221
  * @throws {RequiredError}
package/dist/es/src/api-model/models/aggregation-frequency.js CHANGED
@@ -12,7 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  /**
15
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
15
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
16
16
  * @export
17
17
  * @enum {string}
18
18
  */
package/dist/es/src/api-model/models/metric.js CHANGED
@@ -21,5 +21,8 @@ export const Metric = {
21
21
  TotalSubscriptionsRevenue: 'TOTAL_SUBSCRIPTIONS_REVENUE',
22
22
  ActiveSubscriptions: 'ACTIVE_SUBSCRIPTIONS',
23
23
  NotDeliveredDueToOos: 'NOT_DELIVERED_DUE_TO_OOS',
24
- SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE'
24
+ SubscriberNonSubscriberAverageRevenue: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE',
25
+ LostRevenueDueToOos: 'LOST_REVENUE_DUE_TO_OOS',
26
+ SubscriberNonSubscriberAverageReorders: 'SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS',
27
+ CouponsRevenuePenetration: 'COUPONS_REVENUE_PENETRATION'
25
28
  };
package/dist/types/src/api-model/api/offers-api.d.ts CHANGED
@@ -26,7 +26,7 @@ import type { ListOffersResponse } from '../models';
26
26
  export declare const OffersApiAxiosParamCreator: (configuration?: Configuration) => {
27
27
  /**
28
28
  * 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).
29
- * @param {GetSellingPartnerMetricsRequest} [body]
29
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the `getSellingPartnerMetrics` operation.
30
30
  * @param {*} [options] Override http request option.
31
31
  * @throws {RequiredError}
32
32
  */
@@ -39,8 +39,8 @@ export declare const OffersApiAxiosParamCreator: (configuration?: Configuration)
39
39
  */
40
40
  listOfferMetrics: (body?: ListOfferMetricsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
41
  /**
42
- * 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).
43
- * @param {ListOffersRequest} [body]
42
+ * 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).
43
+ * @param {ListOffersRequest} [body] The request body for the &#x60;listOffers&#x60; operation.
44
44
  * @param {*} [options] Override http request option.
45
45
  * @throws {RequiredError}
46
46
  */
@@ -53,7 +53,7 @@ export declare const OffersApiAxiosParamCreator: (configuration?: Configuration)
53
53
  export declare const OffersApiFp: (configuration?: Configuration) => {
54
54
  /**
55
55
  * 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).
56
- * @param {GetSellingPartnerMetricsRequest} [body]
56
+ * @param {GetSellingPartnerMetricsRequest} [body] The request body for the &#x60;getSellingPartnerMetrics&#x60; operation.
57
57
  * @param {*} [options] Override http request option.
58
58
  * @throws {RequiredError}
59
59
  */
@@ -66,8 +66,8 @@ export declare const OffersApiFp: (configuration?: Configuration) => {
66
66
  */
67
67
  listOfferMetrics(body?: ListOfferMetricsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListOfferMetricsResponse>>;
68
68
  /**
69
- * 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).
70
- * @param {ListOffersRequest} [body]
69
+ * 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).
70
+ * @param {ListOffersRequest} [body] The request body for the &#x60;listOffers&#x60; operation.
71
71
  * @param {*} [options] Override http request option.
72
72
  * @throws {RequiredError}
73
73
  */
@@ -93,7 +93,7 @@ export declare const OffersApiFactory: (configuration?: Configuration, basePath?
93
93
  */
94
94
  listOfferMetrics(requestParameters?: OffersApiListOfferMetricsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListOfferMetricsResponse>;
95
95
  /**
96
- * 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).
96
+ * 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).
97
97
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
98
98
  * @param {*} [options] Override http request option.
99
99
  * @throws {RequiredError}
@@ -107,7 +107,7 @@ export declare const OffersApiFactory: (configuration?: Configuration, basePath?
107
107
  */
108
108
  export interface OffersApiGetSellingPartnerMetricsRequest {
109
109
  /**
110
- *
110
+ * The request body for the &#x60;getSellingPartnerMetrics&#x60; operation.
111
111
  * @type {GetSellingPartnerMetricsRequest}
112
112
  * @memberof OffersApiGetSellingPartnerMetrics
113
113
  */
@@ -133,7 +133,7 @@ export interface OffersApiListOfferMetricsRequest {
133
133
  */
134
134
  export interface OffersApiListOffersRequest {
135
135
  /**
136
- *
136
+ * The request body for the &#x60;listOffers&#x60; operation.
137
137
  * @type {ListOffersRequest}
138
138
  * @memberof OffersApiListOffers
139
139
  */
@@ -163,7 +163,7 @@ export declare class OffersApi extends BaseAPI {
163
163
  */
164
164
  listOfferMetrics(requestParameters?: OffersApiListOfferMetricsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListOfferMetricsResponse, any>>;
165
165
  /**
166
- * 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).
166
+ * 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).
167
167
  * @param {OffersApiListOffersRequest} requestParameters Request parameters.
168
168
  * @param {*} [options] Override http request option.
169
169
  * @throws {RequiredError}
package/dist/types/src/api-model/models/aggregation-frequency.d.ts CHANGED
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The time period used to group data in the response. Note that this is only valid for the performance time period type.
13
+ * The time period used to group data in the response. Note that this is only valid for the `PERFORMANCE` time period type.
14
14
  * @export
15
15
  * @enum {string}
16
16
  */
package/dist/types/src/api-model/models/error-list.d.ts CHANGED
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface ErrorList {
18
18
  /**
19
- *
19
+ * A list of error responses returned when a request is unsuccessful.
20
20
  * @type {Array<Error>}
21
21
  * @memberof ErrorList
22
22
  */
package/dist/types/src/api-model/models/get-selling-partner-metrics-response-metric.d.ts CHANGED
@@ -17,41 +17,65 @@ import type { TimeInterval } from './time-interval';
17
17
  */
18
18
  export interface GetSellingPartnerMetricsResponseMetric {
19
19
  /**
20
- * 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.
20
+ * 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`.
21
21
  * @type {number}
22
22
  * @memberof GetSellingPartnerMetricsResponseMetric
23
23
  */
24
24
  'notDeliveredDueToOOS'?: number;
25
25
  /**
26
- * The revenue generated from subscriptions over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
26
+ * The revenue generated from subscriptions over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
27
27
  * @type {number}
28
28
  * @memberof GetSellingPartnerMetricsResponseMetric
29
29
  */
30
30
  'totalSubscriptionsRevenue'?: number;
31
31
  /**
32
- * The number of units shipped to the subscribers over a period of time. Applicable for both the PERFORMANCE and FORECAST timePeriodType.
32
+ * The number of units shipped to the subscribers over a period of time. Applicable for both the `PERFORMANCE` and `FORECAST` `timePeriodType`.
33
33
  * @type {number}
34
34
  * @memberof GetSellingPartnerMetricsResponseMetric
35
35
  */
36
36
  'shippedSubscriptionUnits'?: number;
37
37
  /**
38
- * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
38
+ * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
39
39
  * @type {number}
40
40
  * @memberof GetSellingPartnerMetricsResponseMetric
41
41
  */
42
42
  'activeSubscriptions'?: number;
43
43
  /**
44
- * 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.
44
+ * 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`.
45
45
  * @type {number}
46
46
  * @memberof GetSellingPartnerMetricsResponseMetric
47
47
  */
48
48
  'subscriberAverageRevenue'?: number;
49
49
  /**
50
- * 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.
50
+ * 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`.
51
51
  * @type {number}
52
52
  * @memberof GetSellingPartnerMetricsResponseMetric
53
53
  */
54
54
  'nonSubscriberAverageRevenue'?: number;
55
+ /**
56
+ * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
57
+ * @type {number}
58
+ * @memberof GetSellingPartnerMetricsResponseMetric
59
+ */
60
+ 'lostRevenueDueToOOS'?: number;
61
+ /**
62
+ * The average reorders per subscriber of the program over a period of 12 months. Applicable only for the PERFORMANCE timePeriodType.
63
+ * @type {number}
64
+ * @memberof GetSellingPartnerMetricsResponseMetric
65
+ */
66
+ 'subscriberAverageReorders'?: number;
67
+ /**
68
+ * The average reorders per non-subscriber of the program over a period of past 12 months. Applicable only for the PERFORMANCE timePeriodType.
69
+ * @type {number}
70
+ * @memberof GetSellingPartnerMetricsResponseMetric
71
+ */
72
+ 'nonSubscriberAverageReorders'?: number;
73
+ /**
74
+ * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
75
+ * @type {number}
76
+ * @memberof GetSellingPartnerMetricsResponseMetric
77
+ */
78
+ 'couponsRevenuePenetration'?: number;
55
79
  /**
56
80
  *
57
81
  * @type {TimeInterval}
package/dist/types/src/api-model/models/list-offer-metrics-response-offer.d.ts CHANGED
@@ -23,67 +23,79 @@ export interface ListOfferMetricsResponseOffer {
23
23
  */
24
24
  'asin'?: string;
25
25
  /**
26
- * 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.
26
+ * 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`.
27
27
  * @type {number}
28
28
  * @memberof ListOfferMetricsResponseOffer
29
29
  */
30
30
  'notDeliveredDueToOOS'?: number;
31
31
  /**
32
- * The revenue generated from subscriptions over a period of time. Applicable only for the PERFORMANCE timePeriodType.
32
+ * The revenue generated from subscriptions over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
33
33
  * @type {number}
34
34
  * @memberof ListOfferMetricsResponseOffer
35
35
  */
36
36
  'totalSubscriptionsRevenue'?: number;
37
37
  /**
38
- * The number of units shipped to the subscribers over a period of time. Applicable only for the PERFORMANCE timePeriodType.
38
+ * The number of units shipped to the subscribers over a period of time. Applicable only for the `PERFORMANCE` `timePeriodType`.
39
39
  * @type {number}
40
40
  * @memberof ListOfferMetricsResponseOffer
41
41
  */
42
42
  'shippedSubscriptionUnits'?: number;
43
43
  /**
44
- * The number of active subscriptions present at the end of the period. Applicable only for the PERFORMANCE timePeriodType.
44
+ * The number of active subscriptions present at the end of the period. Applicable only for the `PERFORMANCE` `timePeriodType`.
45
45
  * @type {number}
46
46
  * @memberof ListOfferMetricsResponseOffer
47
47
  */
48
48
  'activeSubscriptions'?: number;
49
49
  /**
50
- * The percentage of total program revenue out of total product revenue. Applicable only for the PERFORMANCE timePeriodType.
50
+ * The percentage of total program revenue out of total product revenue. Applicable only for the `PERFORMANCE` `timePeriodType`.
51
51
  * @type {number}
52
52
  * @memberof ListOfferMetricsResponseOffer
53
53
  */
54
54
  'revenuePenetration'?: number;
55
55
  /**
56
- * The forecasted total subscription revenue for the next 30 days. Applicable only for the FORECAST timePeriodType.
56
+ * The revenue that would have been generated had there not been out of stock. Applicable only for the PERFORMANCE timePeriodType.
57
+ * @type {number}
58
+ * @memberof ListOfferMetricsResponseOffer
59
+ */
60
+ 'lostRevenueDueToOOS'?: number;
61
+ /**
62
+ * The percentage of revenue from ASINs with coupons out of total revenue from all ASINs. Applicable only for the PERFORMANCE timePeriodType.
63
+ * @type {number}
64
+ * @memberof ListOfferMetricsResponseOffer
65
+ */
66
+ 'couponsRevenuePenetration'?: number;
67
+ /**
68
+ * The forecasted total subscription revenue for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
57
69
  * @type {number}
58
70
  * @memberof ListOfferMetricsResponseOffer
59
71
  */
60
72
  'next30DayTotalSubscriptionsRevenue'?: number;
61
73
  /**
62
- * The forecasted total subscription revenue for the next 60 days. Applicable only for the FORECAST timePeriodType.
74
+ * The forecasted total subscription revenue for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
63
75
  * @type {number}
64
76
  * @memberof ListOfferMetricsResponseOffer
65
77
  */
66
78
  'next60DayTotalSubscriptionsRevenue'?: number;
67
79
  /**
68
- * The forecasted total subscription revenue for the next 90 days. Applicable only for the FORECAST timePeriodType.
80
+ * The forecasted total subscription revenue for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
69
81
  * @type {number}
70
82
  * @memberof ListOfferMetricsResponseOffer
71
83
  */
72
84
  'next90DayTotalSubscriptionsRevenue'?: number;
73
85
  /**
74
- * The forecasted shipped subscription units for the next 30 days. Applicable only for the FORECAST timePeriodType.
86
+ * The forecasted shipped subscription units for the next 30 days. Applicable only for the `FORECAST` `timePeriodType`.
75
87
  * @type {number}
76
88
  * @memberof ListOfferMetricsResponseOffer
77
89
  */
78
90
  'next30DayShippedSubscriptionUnits'?: number;
79
91
  /**
80
- * The forecasted shipped subscription units for the next 60 days. Applicable only for the FORECAST timePeriodType.
92
+ * The forecasted shipped subscription units for the next 60 days. Applicable only for the `FORECAST` `timePeriodType`.
81
93
  * @type {number}
82
94
  * @memberof ListOfferMetricsResponseOffer
83
95
  */
84
96
  'next60DayShippedSubscriptionUnits'?: number;
85
97
  /**
86
- * The forecasted shipped subscription units for the next 90 days. Applicable only for the FORECAST timePeriodType.
98
+ * The forecasted shipped subscription units for the next 90 days. Applicable only for the `FORECAST` `timePeriodType`.
87
99
  * @type {number}
88
100
  * @memberof ListOfferMetricsResponseOffer
89
101
  */
package/dist/types/src/api-model/models/metric.d.ts CHANGED
@@ -20,5 +20,8 @@ export declare const Metric: {
20
20
  readonly ActiveSubscriptions: "ACTIVE_SUBSCRIPTIONS";
21
21
  readonly NotDeliveredDueToOos: "NOT_DELIVERED_DUE_TO_OOS";
22
22
  readonly SubscriberNonSubscriberAverageRevenue: "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REVENUE";
23
+ readonly LostRevenueDueToOos: "LOST_REVENUE_DUE_TO_OOS";
24
+ readonly SubscriberNonSubscriberAverageReorders: "SUBSCRIBER_NON_SUBSCRIBER_AVERAGE_REORDERS";
25
+ readonly CouponsRevenuePenetration: "COUPONS_REVENUE_PENETRATION";
23
26
  };
24
27
  export type Metric = typeof Metric[keyof typeof Metric];
package/dist/types/src/api-model/models/time-interval.d.ts CHANGED
@@ -16,13 +16,13 @@
16
16
  */
17
17
  export interface TimeInterval {
18
18
  /**
19
- * 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.
19
+ * 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`.
20
20
  * @type {string}
21
21
  * @memberof TimeInterval
22
22
  */
23
23
  'startDate': string;
24
24
  /**
25
- * 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.
25
+ * 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.
26
26
  * @type {string}
27
27
  * @memberof TimeInterval
28
28
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/replenishment-api-2022-11-07",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "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.",
5
- "version": "2.1.0",
5
+ "version": "2.2.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.0.8",
22
- "axios": "^1.7.0"
21
+ "@sp-api-sdk/common": "2.0.9",
22
+ "axios": "^1.7.2"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "replenishment api"
42
42
  ],
43
- "gitHead": "5a245a25a9f1765c825e2178668d4b0f4e44689b"
43
+ "gitHead": "207e9cb4cdd2886752a696cfd7355dfaaf0129cb"
44
44
  }