@sp-api-sdk/notifications-api-v1 2.0.3 → 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.
- package/README.md +1 -1
- package/dist/cjs/src/api-model/api/notifications-api.js +51 -46
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +1 -1
- package/dist/cjs/src/api-model/index.js +1 -1
- package/dist/cjs/src/api-model/models/aggregation-filter.js +1 -1
- package/dist/cjs/src/api-model/models/aggregation-settings.js +1 -1
- package/dist/cjs/src/api-model/models/aggregation-time-period.js +1 -1
- package/dist/cjs/src/api-model/models/create-destination-request.js +1 -1
- package/dist/cjs/src/api-model/models/create-destination-response.js +1 -1
- package/dist/cjs/src/api-model/models/create-subscription-request.js +1 -1
- package/dist/cjs/src/api-model/models/create-subscription-response.js +1 -1
- package/dist/cjs/src/api-model/models/delete-destination-response.js +1 -1
- package/dist/cjs/src/api-model/models/delete-subscription-by-id-response.js +1 -1
- package/dist/cjs/src/api-model/models/destination-resource-specification.js +1 -1
- package/dist/cjs/src/api-model/models/destination-resource.js +1 -1
- package/dist/cjs/src/api-model/models/destination.js +1 -1
- package/dist/cjs/src/api-model/models/event-bridge-resource-specification.js +1 -1
- package/dist/cjs/src/api-model/models/event-bridge-resource.js +1 -1
- package/dist/cjs/src/api-model/models/event-filter-all-of.js +1 -1
- package/dist/cjs/src/api-model/models/event-filter.js +1 -1
- package/dist/cjs/src/api-model/models/get-destination-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-destinations-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-subscription-by-id-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-subscription-response.js +1 -1
- package/dist/cjs/src/api-model/models/marketplace-filter.js +1 -1
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/order-change-type-enum.js +1 -1
- package/dist/cjs/src/api-model/models/order-change-type-filter.js +1 -1
- package/dist/cjs/src/api-model/models/processing-directive.js +1 -1
- package/dist/cjs/src/api-model/models/sqs-resource.js +1 -1
- package/dist/cjs/src/api-model/models/subscription.js +1 -1
- package/dist/es/src/api-model/api/notifications-api.js +51 -46
- package/dist/es/src/api-model/api.js +1 -1
- package/dist/es/src/api-model/base.js +1 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +1 -1
- package/dist/es/src/api-model/index.js +1 -1
- package/dist/es/src/api-model/models/aggregation-filter.js +1 -1
- package/dist/es/src/api-model/models/aggregation-settings.js +1 -1
- package/dist/es/src/api-model/models/aggregation-time-period.js +1 -1
- package/dist/es/src/api-model/models/create-destination-request.js +1 -1
- package/dist/es/src/api-model/models/create-destination-response.js +1 -1
- package/dist/es/src/api-model/models/create-subscription-request.js +1 -1
- package/dist/es/src/api-model/models/create-subscription-response.js +1 -1
- package/dist/es/src/api-model/models/delete-destination-response.js +1 -1
- package/dist/es/src/api-model/models/delete-subscription-by-id-response.js +1 -1
- package/dist/es/src/api-model/models/destination-resource-specification.js +1 -1
- package/dist/es/src/api-model/models/destination-resource.js +1 -1
- package/dist/es/src/api-model/models/destination.js +1 -1
- package/dist/es/src/api-model/models/event-bridge-resource-specification.js +1 -1
- package/dist/es/src/api-model/models/event-bridge-resource.js +1 -1
- package/dist/es/src/api-model/models/event-filter-all-of.js +1 -1
- package/dist/es/src/api-model/models/event-filter.js +1 -1
- package/dist/es/src/api-model/models/get-destination-response.js +1 -1
- package/dist/es/src/api-model/models/get-destinations-response.js +1 -1
- package/dist/es/src/api-model/models/get-subscription-by-id-response.js +1 -1
- package/dist/es/src/api-model/models/get-subscription-response.js +1 -1
- package/dist/es/src/api-model/models/marketplace-filter.js +1 -1
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/order-change-type-enum.js +1 -1
- package/dist/es/src/api-model/models/order-change-type-filter.js +1 -1
- package/dist/es/src/api-model/models/processing-directive.js +1 -1
- package/dist/es/src/api-model/models/sqs-resource.js +1 -1
- package/dist/es/src/api-model/models/subscription.js +1 -1
- package/dist/types/src/api-model/api/notifications-api.d.ts +64 -55
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +1 -1
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/api-model/configuration.d.ts +1 -1
- package/dist/types/src/api-model/index.d.ts +1 -1
- package/dist/types/src/api-model/models/aggregation-filter.d.ts +2 -2
- package/dist/types/src/api-model/models/aggregation-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/aggregation-time-period.d.ts +1 -1
- package/dist/types/src/api-model/models/create-destination-request.d.ts +2 -2
- package/dist/types/src/api-model/models/create-destination-response.d.ts +1 -1
- package/dist/types/src/api-model/models/create-subscription-request.d.ts +4 -4
- package/dist/types/src/api-model/models/create-subscription-response.d.ts +2 -2
- package/dist/types/src/api-model/models/delete-destination-response.d.ts +2 -2
- package/dist/types/src/api-model/models/delete-subscription-by-id-response.d.ts +2 -2
- package/dist/types/src/api-model/models/destination-resource-specification.d.ts +1 -1
- package/dist/types/src/api-model/models/destination-resource.d.ts +1 -1
- package/dist/types/src/api-model/models/destination.d.ts +2 -2
- package/dist/types/src/api-model/models/event-bridge-resource-specification.d.ts +1 -1
- package/dist/types/src/api-model/models/event-bridge-resource.d.ts +3 -3
- package/dist/types/src/api-model/models/event-filter-all-of.d.ts +2 -2
- package/dist/types/src/api-model/models/event-filter.d.ts +2 -2
- package/dist/types/src/api-model/models/get-destination-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-destinations-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-subscription-by-id-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-subscription-response.d.ts +2 -2
- package/dist/types/src/api-model/models/marketplace-filter.d.ts +3 -3
- package/dist/types/src/api-model/models/model-error.d.ts +3 -3
- package/dist/types/src/api-model/models/order-change-type-enum.d.ts +1 -1
- package/dist/types/src/api-model/models/order-change-type-filter.d.ts +3 -3
- package/dist/types/src/api-model/models/processing-directive.d.ts +2 -2
- package/dist/types/src/api-model/models/sqs-resource.d.ts +1 -1
- package/dist/types/src/api-model/models/subscription.d.ts +2 -2
- package/package.json +5 -5
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -24,7 +24,7 @@ import { BASE_PATH, BaseAPI } from '../base';
|
|
|
24
24
|
export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
27
|
+
* Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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
28
|
* @param {CreateDestinationRequest} body
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
@@ -53,8 +53,8 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
53
53
|
};
|
|
54
54
|
},
|
|
55
55
|
/**
|
|
56
|
-
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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
|
|
57
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
56
|
+
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
57
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
58
58
|
* @param {CreateSubscriptionRequest} body
|
|
59
59
|
* @param {*} [options] Override http request option.
|
|
60
60
|
* @throws {RequiredError}
|
|
@@ -86,7 +86,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
89
|
+
* Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
90
90
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
91
91
|
* @param {*} [options] Override http request option.
|
|
92
92
|
* @throws {RequiredError}
|
|
@@ -114,9 +114,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
114
114
|
};
|
|
115
115
|
},
|
|
116
116
|
/**
|
|
117
|
-
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById
|
|
117
|
+
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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
118
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
119
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
119
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
@@ -146,7 +146,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
};
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Returns information about the destination that you specify. The getDestination
|
|
149
|
+
* Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
150
150
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
152
152
|
* @throws {RequiredError}
|
|
@@ -174,7 +174,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
174
174
|
};
|
|
175
175
|
},
|
|
176
176
|
/**
|
|
177
|
-
* Returns information about all destinations. The getDestinations
|
|
177
|
+
* Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
178
178
|
* @param {*} [options] Override http request option.
|
|
179
179
|
* @throws {RequiredError}
|
|
180
180
|
*/
|
|
@@ -198,12 +198,13 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
};
|
|
199
199
|
},
|
|
200
200
|
/**
|
|
201
|
-
* Returns information about
|
|
202
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
201
|
+
* Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
202
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
203
|
+
* @param {string} [payloadVersion] The version of the payload object to be used in the notification.
|
|
203
204
|
* @param {*} [options] Override http request option.
|
|
204
205
|
* @throws {RequiredError}
|
|
205
206
|
*/
|
|
206
|
-
getSubscription: async (notificationType, options = {}) => {
|
|
207
|
+
getSubscription: async (notificationType, payloadVersion, options = {}) => {
|
|
207
208
|
// verify required parameter 'notificationType' is not null or undefined
|
|
208
209
|
assertParamExists('getSubscription', 'notificationType', notificationType);
|
|
209
210
|
const localVarPath = `/notifications/v1/subscriptions/{notificationType}`
|
|
@@ -217,6 +218,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
217
218
|
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
218
219
|
const localVarHeaderParameter = {};
|
|
219
220
|
const localVarQueryParameter = {};
|
|
221
|
+
if (payloadVersion !== undefined) {
|
|
222
|
+
localVarQueryParameter['payloadVersion'] = payloadVersion;
|
|
223
|
+
}
|
|
220
224
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
221
225
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
222
226
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -226,9 +230,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
|
|
|
226
230
|
};
|
|
227
231
|
},
|
|
228
232
|
/**
|
|
229
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
233
|
+
* Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
230
234
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
231
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
235
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
232
236
|
* @param {*} [options] Override http request option.
|
|
233
237
|
* @throws {RequiredError}
|
|
234
238
|
*/
|
|
@@ -267,7 +271,7 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
267
271
|
const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration);
|
|
268
272
|
return {
|
|
269
273
|
/**
|
|
270
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
274
|
+
* Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
271
275
|
* @param {CreateDestinationRequest} body
|
|
272
276
|
* @param {*} [options] Override http request option.
|
|
273
277
|
* @throws {RequiredError}
|
|
@@ -277,8 +281,8 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
277
281
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
278
282
|
},
|
|
279
283
|
/**
|
|
280
|
-
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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
|
|
281
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
284
|
+
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
285
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
282
286
|
* @param {CreateSubscriptionRequest} body
|
|
283
287
|
* @param {*} [options] Override http request option.
|
|
284
288
|
* @throws {RequiredError}
|
|
@@ -288,7 +292,7 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
288
292
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
289
293
|
},
|
|
290
294
|
/**
|
|
291
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
295
|
+
* Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
292
296
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
293
297
|
* @param {*} [options] Override http request option.
|
|
294
298
|
* @throws {RequiredError}
|
|
@@ -298,9 +302,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
298
302
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
299
303
|
},
|
|
300
304
|
/**
|
|
301
|
-
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById
|
|
305
|
+
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
302
306
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
303
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
307
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
304
308
|
* @param {*} [options] Override http request option.
|
|
305
309
|
* @throws {RequiredError}
|
|
306
310
|
*/
|
|
@@ -309,7 +313,7 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
309
313
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
310
314
|
},
|
|
311
315
|
/**
|
|
312
|
-
* Returns information about the destination that you specify. The getDestination
|
|
316
|
+
* Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
313
317
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
314
318
|
* @param {*} [options] Override http request option.
|
|
315
319
|
* @throws {RequiredError}
|
|
@@ -319,7 +323,7 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
319
323
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
320
324
|
},
|
|
321
325
|
/**
|
|
322
|
-
* Returns information about all destinations. The getDestinations
|
|
326
|
+
* Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
323
327
|
* @param {*} [options] Override http request option.
|
|
324
328
|
* @throws {RequiredError}
|
|
325
329
|
*/
|
|
@@ -328,19 +332,20 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
328
332
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
329
333
|
},
|
|
330
334
|
/**
|
|
331
|
-
* Returns information about
|
|
332
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
335
|
+
* Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
336
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
337
|
+
* @param {string} [payloadVersion] The version of the payload object to be used in the notification.
|
|
333
338
|
* @param {*} [options] Override http request option.
|
|
334
339
|
* @throws {RequiredError}
|
|
335
340
|
*/
|
|
336
|
-
async getSubscription(notificationType, options) {
|
|
337
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscription(notificationType, options);
|
|
341
|
+
async getSubscription(notificationType, payloadVersion, options) {
|
|
342
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscription(notificationType, payloadVersion, options);
|
|
338
343
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
339
344
|
},
|
|
340
345
|
/**
|
|
341
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
346
|
+
* Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
342
347
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
343
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
348
|
+
* @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values).
|
|
344
349
|
* @param {*} [options] Override http request option.
|
|
345
350
|
* @throws {RequiredError}
|
|
346
351
|
*/
|
|
@@ -358,7 +363,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
358
363
|
const localVarFp = NotificationsApiFp(configuration);
|
|
359
364
|
return {
|
|
360
365
|
/**
|
|
361
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
366
|
+
* Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
362
367
|
* @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
|
|
363
368
|
* @param {*} [options] Override http request option.
|
|
364
369
|
* @throws {RequiredError}
|
|
@@ -367,7 +372,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
367
372
|
return localVarFp.createDestination(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
368
373
|
},
|
|
369
374
|
/**
|
|
370
|
-
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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
|
|
375
|
+
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
371
376
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
372
377
|
* @param {*} [options] Override http request option.
|
|
373
378
|
* @throws {RequiredError}
|
|
@@ -376,7 +381,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
376
381
|
return localVarFp.createSubscription(requestParameters.notificationType, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
377
382
|
},
|
|
378
383
|
/**
|
|
379
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
384
|
+
* Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
380
385
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
381
386
|
* @param {*} [options] Override http request option.
|
|
382
387
|
* @throws {RequiredError}
|
|
@@ -385,7 +390,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
385
390
|
return localVarFp.deleteDestination(requestParameters.destinationId, options).then((request) => request(axios, basePath));
|
|
386
391
|
},
|
|
387
392
|
/**
|
|
388
|
-
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById
|
|
393
|
+
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
389
394
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
390
395
|
* @param {*} [options] Override http request option.
|
|
391
396
|
* @throws {RequiredError}
|
|
@@ -394,7 +399,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
394
399
|
return localVarFp.deleteSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(axios, basePath));
|
|
395
400
|
},
|
|
396
401
|
/**
|
|
397
|
-
* Returns information about the destination that you specify. The getDestination
|
|
402
|
+
* Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
398
403
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
399
404
|
* @param {*} [options] Override http request option.
|
|
400
405
|
* @throws {RequiredError}
|
|
@@ -403,7 +408,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
403
408
|
return localVarFp.getDestination(requestParameters.destinationId, options).then((request) => request(axios, basePath));
|
|
404
409
|
},
|
|
405
410
|
/**
|
|
406
|
-
* Returns information about all destinations. The getDestinations
|
|
411
|
+
* Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
407
412
|
* @param {*} [options] Override http request option.
|
|
408
413
|
* @throws {RequiredError}
|
|
409
414
|
*/
|
|
@@ -411,16 +416,16 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
411
416
|
return localVarFp.getDestinations(options).then((request) => request(axios, basePath));
|
|
412
417
|
},
|
|
413
418
|
/**
|
|
414
|
-
* Returns information about
|
|
419
|
+
* Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
415
420
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
416
421
|
* @param {*} [options] Override http request option.
|
|
417
422
|
* @throws {RequiredError}
|
|
418
423
|
*/
|
|
419
424
|
getSubscription(requestParameters, options) {
|
|
420
|
-
return localVarFp.getSubscription(requestParameters.notificationType, options).then((request) => request(axios, basePath));
|
|
425
|
+
return localVarFp.getSubscription(requestParameters.notificationType, requestParameters.payloadVersion, options).then((request) => request(axios, basePath));
|
|
421
426
|
},
|
|
422
427
|
/**
|
|
423
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
428
|
+
* Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
424
429
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
425
430
|
* @param {*} [options] Override http request option.
|
|
426
431
|
* @throws {RequiredError}
|
|
@@ -438,7 +443,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
|
|
|
438
443
|
*/
|
|
439
444
|
export class NotificationsApi extends BaseAPI {
|
|
440
445
|
/**
|
|
441
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
446
|
+
* Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
442
447
|
* @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
|
|
443
448
|
* @param {*} [options] Override http request option.
|
|
444
449
|
* @throws {RequiredError}
|
|
@@ -448,7 +453,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
448
453
|
return NotificationsApiFp(this.configuration).createDestination(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
449
454
|
}
|
|
450
455
|
/**
|
|
451
|
-
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the createDestination operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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
|
|
456
|
+
* Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
452
457
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
453
458
|
* @param {*} [options] Override http request option.
|
|
454
459
|
* @throws {RequiredError}
|
|
@@ -458,7 +463,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
458
463
|
return NotificationsApiFp(this.configuration).createSubscription(requestParameters.notificationType, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
459
464
|
}
|
|
460
465
|
/**
|
|
461
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
466
|
+
* Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
462
467
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
463
468
|
* @param {*} [options] Override http request option.
|
|
464
469
|
* @throws {RequiredError}
|
|
@@ -468,7 +473,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
468
473
|
return NotificationsApiFp(this.configuration).deleteDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
|
|
469
474
|
}
|
|
470
475
|
/**
|
|
471
|
-
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The deleteSubscriptionById
|
|
476
|
+
* Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
472
477
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
473
478
|
* @param {*} [options] Override http request option.
|
|
474
479
|
* @throws {RequiredError}
|
|
@@ -478,7 +483,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
478
483
|
return NotificationsApiFp(this.configuration).deleteSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));
|
|
479
484
|
}
|
|
480
485
|
/**
|
|
481
|
-
* Returns information about the destination that you specify. The getDestination
|
|
486
|
+
* Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
482
487
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
483
488
|
* @param {*} [options] Override http request option.
|
|
484
489
|
* @throws {RequiredError}
|
|
@@ -488,7 +493,7 @@ export class NotificationsApi extends BaseAPI {
|
|
|
488
493
|
return NotificationsApiFp(this.configuration).getDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
|
|
489
494
|
}
|
|
490
495
|
/**
|
|
491
|
-
* Returns information about all destinations. The getDestinations
|
|
496
|
+
* Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
492
497
|
* @param {*} [options] Override http request option.
|
|
493
498
|
* @throws {RequiredError}
|
|
494
499
|
* @memberof NotificationsApi
|
|
@@ -497,17 +502,17 @@ export class NotificationsApi extends BaseAPI {
|
|
|
497
502
|
return NotificationsApiFp(this.configuration).getDestinations(options).then((request) => request(this.axios, this.basePath));
|
|
498
503
|
}
|
|
499
504
|
/**
|
|
500
|
-
* Returns information about
|
|
505
|
+
* Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
501
506
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
502
507
|
* @param {*} [options] Override http request option.
|
|
503
508
|
* @throws {RequiredError}
|
|
504
509
|
* @memberof NotificationsApi
|
|
505
510
|
*/
|
|
506
511
|
getSubscription(requestParameters, options) {
|
|
507
|
-
return NotificationsApiFp(this.configuration).getSubscription(requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));
|
|
512
|
+
return NotificationsApiFp(this.configuration).getSubscription(requestParameters.notificationType, requestParameters.payloadVersion, options).then((request) => request(this.axios, this.basePath));
|
|
508
513
|
}
|
|
509
514
|
/**
|
|
510
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
515
|
+
* Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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 observe higher rate and burst values than those shown here. For more information, refer to [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).
|
|
511
516
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
512
517
|
* @param {*} [options] Override http request option.
|
|
513
518
|
* @throws {RequiredError}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Notifications
|
|
5
|
-
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information,
|
|
5
|
+
* The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner\'s business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v1
|
|
8
8
|
*
|