@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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import globalAxios from 'axios';
|
|
14
15
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
16
|
import { CreateDestinationRequest } from '../models';
|
|
16
17
|
import { CreateDestinationResponse } from '../models';
|
|
@@ -28,59 +29,60 @@ import { GetSubscriptionResponse } from '../models';
|
|
|
28
29
|
*/
|
|
29
30
|
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
31
|
/**
|
|
31
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
32
|
+
* 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).
|
|
32
33
|
* @param {CreateDestinationRequest} body
|
|
33
34
|
* @param {*} [options] Override http request option.
|
|
34
35
|
* @throws {RequiredError}
|
|
35
36
|
*/
|
|
36
37
|
createDestination: (body: CreateDestinationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
38
|
/**
|
|
38
|
-
* 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
|
|
39
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
39
|
+
* 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).
|
|
40
|
+
* @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).
|
|
40
41
|
* @param {CreateSubscriptionRequest} body
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
42
43
|
* @throws {RequiredError}
|
|
43
44
|
*/
|
|
44
45
|
createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
46
|
/**
|
|
46
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
47
|
+
* 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).
|
|
47
48
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
48
49
|
* @param {*} [options] Override http request option.
|
|
49
50
|
* @throws {RequiredError}
|
|
50
51
|
*/
|
|
51
52
|
deleteDestination: (destinationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
53
|
/**
|
|
53
|
-
* 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
|
|
54
|
+
* 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).
|
|
54
55
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
55
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
56
|
+
* @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).
|
|
56
57
|
* @param {*} [options] Override http request option.
|
|
57
58
|
* @throws {RequiredError}
|
|
58
59
|
*/
|
|
59
60
|
deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
61
|
/**
|
|
61
|
-
* Returns information about the destination that you specify. The getDestination
|
|
62
|
+
* 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).
|
|
62
63
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
63
64
|
* @param {*} [options] Override http request option.
|
|
64
65
|
* @throws {RequiredError}
|
|
65
66
|
*/
|
|
66
67
|
getDestination: (destinationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
68
|
/**
|
|
68
|
-
* Returns information about all destinations. The getDestinations
|
|
69
|
+
* 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).
|
|
69
70
|
* @param {*} [options] Override http request option.
|
|
70
71
|
* @throws {RequiredError}
|
|
71
72
|
*/
|
|
72
73
|
getDestinations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
74
|
/**
|
|
74
|
-
* Returns information about
|
|
75
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
75
|
+
* 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).
|
|
76
|
+
* @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).
|
|
77
|
+
* @param {string} [payloadVersion] The version of the payload object to be used in the notification.
|
|
76
78
|
* @param {*} [options] Override http request option.
|
|
77
79
|
* @throws {RequiredError}
|
|
78
80
|
*/
|
|
79
|
-
getSubscription: (notificationType: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
|
+
getSubscription: (notificationType: string, payloadVersion?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
82
|
/**
|
|
81
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
83
|
+
* 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).
|
|
82
84
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
83
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
85
|
+
* @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).
|
|
84
86
|
* @param {*} [options] Override http request option.
|
|
85
87
|
* @throws {RequiredError}
|
|
86
88
|
*/
|
|
@@ -92,59 +94,60 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
92
94
|
*/
|
|
93
95
|
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
94
96
|
/**
|
|
95
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
97
|
+
* 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).
|
|
96
98
|
* @param {CreateDestinationRequest} body
|
|
97
99
|
* @param {*} [options] Override http request option.
|
|
98
100
|
* @throws {RequiredError}
|
|
99
101
|
*/
|
|
100
102
|
createDestination(body: CreateDestinationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDestinationResponse>>;
|
|
101
103
|
/**
|
|
102
|
-
* 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
|
|
103
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
104
|
+
* 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).
|
|
105
|
+
* @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).
|
|
104
106
|
* @param {CreateSubscriptionRequest} body
|
|
105
107
|
* @param {*} [options] Override http request option.
|
|
106
108
|
* @throws {RequiredError}
|
|
107
109
|
*/
|
|
108
110
|
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSubscriptionResponse>>;
|
|
109
111
|
/**
|
|
110
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
112
|
+
* 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).
|
|
111
113
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
112
114
|
* @param {*} [options] Override http request option.
|
|
113
115
|
* @throws {RequiredError}
|
|
114
116
|
*/
|
|
115
117
|
deleteDestination(destinationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteDestinationResponse>>;
|
|
116
118
|
/**
|
|
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
|
|
119
|
+
* 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
120
|
* @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,
|
|
121
|
+
* @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
122
|
* @param {*} [options] Override http request option.
|
|
121
123
|
* @throws {RequiredError}
|
|
122
124
|
*/
|
|
123
125
|
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSubscriptionByIdResponse>>;
|
|
124
126
|
/**
|
|
125
|
-
* Returns information about the destination that you specify. The getDestination
|
|
127
|
+
* 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).
|
|
126
128
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
127
129
|
* @param {*} [options] Override http request option.
|
|
128
130
|
* @throws {RequiredError}
|
|
129
131
|
*/
|
|
130
132
|
getDestination(destinationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationResponse>>;
|
|
131
133
|
/**
|
|
132
|
-
* Returns information about all destinations. The getDestinations
|
|
134
|
+
* 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).
|
|
133
135
|
* @param {*} [options] Override http request option.
|
|
134
136
|
* @throws {RequiredError}
|
|
135
137
|
*/
|
|
136
138
|
getDestinations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationsResponse>>;
|
|
137
139
|
/**
|
|
138
|
-
* Returns information about
|
|
139
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
140
|
+
* 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).
|
|
141
|
+
* @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).
|
|
142
|
+
* @param {string} [payloadVersion] The version of the payload object to be used in the notification.
|
|
140
143
|
* @param {*} [options] Override http request option.
|
|
141
144
|
* @throws {RequiredError}
|
|
142
145
|
*/
|
|
143
|
-
getSubscription(notificationType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionResponse>>;
|
|
146
|
+
getSubscription(notificationType: string, payloadVersion?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionResponse>>;
|
|
144
147
|
/**
|
|
145
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
148
|
+
* 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).
|
|
146
149
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
147
|
-
* @param {string} notificationType The type of notification. For more information about notification types,
|
|
150
|
+
* @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).
|
|
148
151
|
* @param {*} [options] Override http request option.
|
|
149
152
|
* @throws {RequiredError}
|
|
150
153
|
*/
|
|
@@ -156,55 +159,55 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
156
159
|
*/
|
|
157
160
|
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
158
161
|
/**
|
|
159
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
162
|
+
* 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).
|
|
160
163
|
* @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
|
|
161
164
|
* @param {*} [options] Override http request option.
|
|
162
165
|
* @throws {RequiredError}
|
|
163
166
|
*/
|
|
164
167
|
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateDestinationResponse>;
|
|
165
168
|
/**
|
|
166
|
-
* 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
|
|
169
|
+
* 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).
|
|
167
170
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
168
171
|
* @param {*} [options] Override http request option.
|
|
169
172
|
* @throws {RequiredError}
|
|
170
173
|
*/
|
|
171
174
|
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: AxiosRequestConfig): AxiosPromise<CreateSubscriptionResponse>;
|
|
172
175
|
/**
|
|
173
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
176
|
+
* 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).
|
|
174
177
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
175
178
|
* @param {*} [options] Override http request option.
|
|
176
179
|
* @throws {RequiredError}
|
|
177
180
|
*/
|
|
178
181
|
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteDestinationResponse>;
|
|
179
182
|
/**
|
|
180
|
-
* 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
|
|
183
|
+
* 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).
|
|
181
184
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
182
185
|
* @param {*} [options] Override http request option.
|
|
183
186
|
* @throws {RequiredError}
|
|
184
187
|
*/
|
|
185
188
|
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: AxiosRequestConfig): AxiosPromise<DeleteSubscriptionByIdResponse>;
|
|
186
189
|
/**
|
|
187
|
-
* Returns information about the destination that you specify. The getDestination
|
|
190
|
+
* 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).
|
|
188
191
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
189
192
|
* @param {*} [options] Override http request option.
|
|
190
193
|
* @throws {RequiredError}
|
|
191
194
|
*/
|
|
192
195
|
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: AxiosRequestConfig): AxiosPromise<GetDestinationResponse>;
|
|
193
196
|
/**
|
|
194
|
-
* Returns information about all destinations. The getDestinations
|
|
197
|
+
* 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).
|
|
195
198
|
* @param {*} [options] Override http request option.
|
|
196
199
|
* @throws {RequiredError}
|
|
197
200
|
*/
|
|
198
201
|
getDestinations(options?: AxiosRequestConfig): AxiosPromise<GetDestinationsResponse>;
|
|
199
202
|
/**
|
|
200
|
-
* Returns information about
|
|
203
|
+
* 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).
|
|
201
204
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
202
205
|
* @param {*} [options] Override http request option.
|
|
203
206
|
* @throws {RequiredError}
|
|
204
207
|
*/
|
|
205
208
|
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GetSubscriptionResponse>;
|
|
206
209
|
/**
|
|
207
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
210
|
+
* 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).
|
|
208
211
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
209
212
|
* @param {*} [options] Override http request option.
|
|
210
213
|
* @throws {RequiredError}
|
|
@@ -231,7 +234,7 @@ export interface NotificationsApiCreateDestinationRequest {
|
|
|
231
234
|
*/
|
|
232
235
|
export interface NotificationsApiCreateSubscriptionRequest {
|
|
233
236
|
/**
|
|
234
|
-
* The type of notification. For more information about notification types,
|
|
237
|
+
* 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).
|
|
235
238
|
* @type {string}
|
|
236
239
|
* @memberof NotificationsApiCreateSubscription
|
|
237
240
|
*/
|
|
@@ -269,7 +272,7 @@ export interface NotificationsApiDeleteSubscriptionByIdRequest {
|
|
|
269
272
|
*/
|
|
270
273
|
readonly subscriptionId: string;
|
|
271
274
|
/**
|
|
272
|
-
* The type of notification. For more information about notification types,
|
|
275
|
+
* 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).
|
|
273
276
|
* @type {string}
|
|
274
277
|
* @memberof NotificationsApiDeleteSubscriptionById
|
|
275
278
|
*/
|
|
@@ -295,11 +298,17 @@ export interface NotificationsApiGetDestinationRequest {
|
|
|
295
298
|
*/
|
|
296
299
|
export interface NotificationsApiGetSubscriptionRequest {
|
|
297
300
|
/**
|
|
298
|
-
* The type of notification. For more information about notification types,
|
|
301
|
+
* 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).
|
|
299
302
|
* @type {string}
|
|
300
303
|
* @memberof NotificationsApiGetSubscription
|
|
301
304
|
*/
|
|
302
305
|
readonly notificationType: string;
|
|
306
|
+
/**
|
|
307
|
+
* The version of the payload object to be used in the notification.
|
|
308
|
+
* @type {string}
|
|
309
|
+
* @memberof NotificationsApiGetSubscription
|
|
310
|
+
*/
|
|
311
|
+
readonly payloadVersion?: string;
|
|
303
312
|
}
|
|
304
313
|
/**
|
|
305
314
|
* Request parameters for getSubscriptionById operation in NotificationsApi.
|
|
@@ -314,7 +323,7 @@ export interface NotificationsApiGetSubscriptionByIdRequest {
|
|
|
314
323
|
*/
|
|
315
324
|
readonly subscriptionId: string;
|
|
316
325
|
/**
|
|
317
|
-
* The type of notification. For more information about notification types,
|
|
326
|
+
* 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).
|
|
318
327
|
* @type {string}
|
|
319
328
|
* @memberof NotificationsApiGetSubscriptionById
|
|
320
329
|
*/
|
|
@@ -328,66 +337,66 @@ export interface NotificationsApiGetSubscriptionByIdRequest {
|
|
|
328
337
|
*/
|
|
329
338
|
export declare class NotificationsApi extends BaseAPI {
|
|
330
339
|
/**
|
|
331
|
-
* Creates a destination resource to receive notifications. The createDestination
|
|
340
|
+
* 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).
|
|
332
341
|
* @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
|
|
333
342
|
* @param {*} [options] Override http request option.
|
|
334
343
|
* @throws {RequiredError}
|
|
335
344
|
* @memberof NotificationsApi
|
|
336
345
|
*/
|
|
337
|
-
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: AxiosRequestConfig): Promise<
|
|
346
|
+
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateDestinationResponse, any>>;
|
|
338
347
|
/**
|
|
339
|
-
* 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
|
|
348
|
+
* 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).
|
|
340
349
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
341
350
|
* @param {*} [options] Override http request option.
|
|
342
351
|
* @throws {RequiredError}
|
|
343
352
|
* @memberof NotificationsApi
|
|
344
353
|
*/
|
|
345
|
-
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: AxiosRequestConfig): Promise<
|
|
354
|
+
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateSubscriptionResponse, any>>;
|
|
346
355
|
/**
|
|
347
|
-
* Deletes the destination that you specify. The deleteDestination
|
|
356
|
+
* 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).
|
|
348
357
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
349
358
|
* @param {*} [options] Override http request option.
|
|
350
359
|
* @throws {RequiredError}
|
|
351
360
|
* @memberof NotificationsApi
|
|
352
361
|
*/
|
|
353
|
-
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: AxiosRequestConfig): Promise<
|
|
362
|
+
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteDestinationResponse, any>>;
|
|
354
363
|
/**
|
|
355
|
-
* 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
|
|
364
|
+
* 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).
|
|
356
365
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
357
366
|
* @param {*} [options] Override http request option.
|
|
358
367
|
* @throws {RequiredError}
|
|
359
368
|
* @memberof NotificationsApi
|
|
360
369
|
*/
|
|
361
|
-
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<
|
|
370
|
+
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteSubscriptionByIdResponse, any>>;
|
|
362
371
|
/**
|
|
363
|
-
* Returns information about the destination that you specify. The getDestination
|
|
372
|
+
* 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).
|
|
364
373
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
365
374
|
* @param {*} [options] Override http request option.
|
|
366
375
|
* @throws {RequiredError}
|
|
367
376
|
* @memberof NotificationsApi
|
|
368
377
|
*/
|
|
369
|
-
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: AxiosRequestConfig): Promise<
|
|
378
|
+
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationResponse, any>>;
|
|
370
379
|
/**
|
|
371
|
-
* Returns information about all destinations. The getDestinations
|
|
380
|
+
* 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).
|
|
372
381
|
* @param {*} [options] Override http request option.
|
|
373
382
|
* @throws {RequiredError}
|
|
374
383
|
* @memberof NotificationsApi
|
|
375
384
|
*/
|
|
376
|
-
getDestinations(options?: AxiosRequestConfig): Promise<
|
|
385
|
+
getDestinations(options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationsResponse, any>>;
|
|
377
386
|
/**
|
|
378
|
-
* Returns information about
|
|
387
|
+
* 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).
|
|
379
388
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
380
389
|
* @param {*} [options] Override http request option.
|
|
381
390
|
* @throws {RequiredError}
|
|
382
391
|
* @memberof NotificationsApi
|
|
383
392
|
*/
|
|
384
|
-
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: AxiosRequestConfig): Promise<
|
|
393
|
+
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionResponse, any>>;
|
|
385
394
|
/**
|
|
386
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById
|
|
395
|
+
* 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).
|
|
387
396
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
388
397
|
* @param {*} [options] Override http request option.
|
|
389
398
|
* @throws {RequiredError}
|
|
390
399
|
* @memberof NotificationsApi
|
|
391
400
|
*/
|
|
392
|
-
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<
|
|
401
|
+
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionByIdResponse, any>>;
|
|
393
402
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { AggregationSettings } from './aggregation-settings';
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* A filter used to select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications).
|
|
15
15
|
* @export
|
|
16
16
|
* @interface AggregationFilter
|
|
17
17
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Notifications
|
|
3
|
-
* 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,
|
|
3
|
+
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v1
|
|
6
6
|
*
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { DestinationResourceSpecification } from './destination-resource-specification';
|
|
13
13
|
/**
|
|
14
|
-
* The request schema for the createDestination operation.
|
|
14
|
+
* The request schema for the `createDestination` operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface CreateDestinationRequest
|
|
17
17
|
*/
|