@sp-api-sdk/notifications-api-v1 1.11.3 → 1.12.2
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 +41 -41
- 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 +15 -0
- package/dist/cjs/src/api-model/models/aggregation-settings.js +15 -0
- package/dist/cjs/src/api-model/models/aggregation-time-period.js +25 -0
- 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 +15 -0
- package/dist/cjs/src/api-model/models/event-filter.js +15 -0
- 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/index.js +7 -0
- package/dist/cjs/src/api-model/models/marketplace-filter.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/processing-directive.js +15 -0
- 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 +41 -41
- 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 +14 -0
- package/dist/es/src/api-model/models/aggregation-settings.js +14 -0
- package/dist/es/src/api-model/models/aggregation-time-period.js +22 -0
- 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 +14 -0
- package/dist/es/src/api-model/models/event-filter.js +14 -0
- 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/index.js +7 -0
- package/dist/es/src/api-model/models/marketplace-filter.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/processing-directive.js +14 -0
- 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 +61 -61
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +3 -3
- package/dist/types/src/api-model/common.d.ts +8 -8
- 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 +25 -0
- package/dist/types/src/api-model/models/aggregation-settings.d.ts +25 -0
- package/dist/types/src/api-model/models/aggregation-time-period.d.ts +21 -0
- package/dist/types/src/api-model/models/create-destination-request.d.ts +3 -3
- package/dist/types/src/api-model/models/create-destination-response.d.ts +3 -3
- package/dist/types/src/api-model/models/create-subscription-request.d.ts +10 -3
- package/dist/types/src/api-model/models/create-subscription-response.d.ts +3 -3
- 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 +3 -3
- package/dist/types/src/api-model/models/destination-resource.d.ts +3 -3
- package/dist/types/src/api-model/models/destination.d.ts +4 -4
- package/dist/types/src/api-model/models/event-bridge-resource-specification.d.ts +3 -3
- package/dist/types/src/api-model/models/event-bridge-resource.d.ts +4 -4
- package/dist/types/src/api-model/models/event-filter-all-of.d.ts +24 -0
- package/dist/types/src/api-model/models/event-filter.d.ts +20 -0
- package/dist/types/src/api-model/models/get-destination-response.d.ts +3 -3
- package/dist/types/src/api-model/models/get-destinations-response.d.ts +3 -3
- package/dist/types/src/api-model/models/get-subscription-by-id-response.d.ts +3 -3
- package/dist/types/src/api-model/models/get-subscription-response.d.ts +3 -3
- package/dist/types/src/api-model/models/index.d.ts +7 -0
- package/dist/types/src/api-model/models/marketplace-filter.d.ts +24 -0
- package/dist/types/src/api-model/models/model-error.d.ts +4 -4
- package/dist/types/src/api-model/models/processing-directive.d.ts +25 -0
- package/dist/types/src/api-model/models/sqs-resource.d.ts +2 -2
- package/dist/types/src/api-model/models/subscription.d.ts +11 -4
- 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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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
|
*
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { AxiosPromise, AxiosInstance } from 'axios';
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateDestinationRequest } from '../models';
|
|
@@ -26,144 +26,144 @@ import { GetSubscriptionResponse } from '../models';
|
|
|
26
26
|
* NotificationsApi - axios parameter creator
|
|
27
27
|
* @export
|
|
28
28
|
*/
|
|
29
|
-
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration
|
|
29
|
+
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30
30
|
/**
|
|
31
|
-
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see
|
|
31
|
+
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
32
32
|
* @param {CreateDestinationRequest} body
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
34
34
|
* @throws {RequiredError}
|
|
35
35
|
*/
|
|
36
|
-
createDestination: (body: CreateDestinationRequest, options?:
|
|
36
|
+
createDestination: (body: CreateDestinationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
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 | For more information, see
|
|
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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
39
39
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
40
40
|
* @param {CreateSubscriptionRequest} body
|
|
41
41
|
* @param {*} [options] Override http request option.
|
|
42
42
|
* @throws {RequiredError}
|
|
43
43
|
*/
|
|
44
|
-
createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?:
|
|
44
|
+
createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see
|
|
46
|
+
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
47
47
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
49
49
|
* @throws {RequiredError}
|
|
50
50
|
*/
|
|
51
|
-
deleteDestination: (destinationId: string, options?:
|
|
51
|
+
deleteDestination: (destinationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
52
|
/**
|
|
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 API is grantless. For more information, see
|
|
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 API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
54
54
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
55
55
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
|
-
deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?:
|
|
59
|
+
deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see
|
|
61
|
+
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
62
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
66
|
-
getDestination: (destinationId: string, options?:
|
|
66
|
+
getDestination: (destinationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
|
-
* Returns information about all destinations. The getDestinations API is grantless. For more information, see
|
|
68
|
+
* Returns information about all destinations. The getDestinations API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
|
-
getDestinations: (options?:
|
|
72
|
+
getDestinations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
|
-
* Returns information about subscriptions of the specified notification type. 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 | For more information, see
|
|
74
|
+
* Returns information about subscriptions of the specified notification type. 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
75
75
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
*/
|
|
79
|
-
getSubscription: (notificationType: string, options?:
|
|
79
|
+
getSubscription: (notificationType: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
80
|
/**
|
|
81
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see
|
|
81
|
+
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
82
82
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
83
83
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
84
84
|
* @param {*} [options] Override http request option.
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
getSubscriptionById: (subscriptionId: string, notificationType: string, options?:
|
|
87
|
+
getSubscriptionById: (subscriptionId: string, notificationType: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
};
|
|
89
89
|
/**
|
|
90
90
|
* NotificationsApi - functional programming interface
|
|
91
91
|
* @export
|
|
92
92
|
*/
|
|
93
|
-
export declare const NotificationsApiFp: (configuration?: Configuration
|
|
93
|
+
export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
94
94
|
/**
|
|
95
|
-
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see
|
|
95
|
+
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
96
96
|
* @param {CreateDestinationRequest} body
|
|
97
97
|
* @param {*} [options] Override http request option.
|
|
98
98
|
* @throws {RequiredError}
|
|
99
99
|
*/
|
|
100
|
-
createDestination(body: CreateDestinationRequest, options?:
|
|
100
|
+
createDestination(body: CreateDestinationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDestinationResponse>>;
|
|
101
101
|
/**
|
|
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 | For more information, see
|
|
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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
103
103
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
104
104
|
* @param {CreateSubscriptionRequest} body
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
106
|
* @throws {RequiredError}
|
|
107
107
|
*/
|
|
108
|
-
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?:
|
|
108
|
+
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSubscriptionResponse>>;
|
|
109
109
|
/**
|
|
110
|
-
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see
|
|
110
|
+
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
111
111
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
115
|
-
deleteDestination(destinationId: string, options?:
|
|
115
|
+
deleteDestination(destinationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteDestinationResponse>>;
|
|
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 API is grantless. For more information, see
|
|
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 API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
118
118
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
119
119
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
121
121
|
* @throws {RequiredError}
|
|
122
122
|
*/
|
|
123
|
-
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?:
|
|
123
|
+
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSubscriptionByIdResponse>>;
|
|
124
124
|
/**
|
|
125
|
-
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see
|
|
125
|
+
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
126
126
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
127
127
|
* @param {*} [options] Override http request option.
|
|
128
128
|
* @throws {RequiredError}
|
|
129
129
|
*/
|
|
130
|
-
getDestination(destinationId: string, options?:
|
|
130
|
+
getDestination(destinationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationResponse>>;
|
|
131
131
|
/**
|
|
132
|
-
* Returns information about all destinations. The getDestinations API is grantless. For more information, see
|
|
132
|
+
* Returns information about all destinations. The getDestinations API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
135
135
|
*/
|
|
136
|
-
getDestinations(options?:
|
|
136
|
+
getDestinations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationsResponse>>;
|
|
137
137
|
/**
|
|
138
|
-
* Returns information about subscriptions of the specified notification type. 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 | For more information, see
|
|
138
|
+
* Returns information about subscriptions of the specified notification type. 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
139
139
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
141
141
|
* @throws {RequiredError}
|
|
142
142
|
*/
|
|
143
|
-
getSubscription(notificationType: string, options?:
|
|
143
|
+
getSubscription(notificationType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionResponse>>;
|
|
144
144
|
/**
|
|
145
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see
|
|
145
|
+
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
146
146
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
147
147
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
150
150
|
*/
|
|
151
|
-
getSubscriptionById(subscriptionId: string, notificationType: string, options?:
|
|
151
|
+
getSubscriptionById(subscriptionId: string, notificationType: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionByIdResponse>>;
|
|
152
152
|
};
|
|
153
153
|
/**
|
|
154
154
|
* NotificationsApi - factory interface
|
|
155
155
|
* @export
|
|
156
156
|
*/
|
|
157
|
-
export declare const NotificationsApiFactory: (configuration?: Configuration
|
|
157
|
+
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
158
158
|
/**
|
|
159
|
-
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see
|
|
159
|
+
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
160
160
|
* @param {CreateDestinationRequest} body
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
164
164
|
createDestination(body: CreateDestinationRequest, options?: any): AxiosPromise<CreateDestinationResponse>;
|
|
165
165
|
/**
|
|
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 | For more information, see
|
|
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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
167
167
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
168
168
|
* @param {CreateSubscriptionRequest} body
|
|
169
169
|
* @param {*} [options] Override http request option.
|
|
@@ -171,14 +171,14 @@ export declare const NotificationsApiFactory: (configuration?: Configuration | u
|
|
|
171
171
|
*/
|
|
172
172
|
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: any): AxiosPromise<CreateSubscriptionResponse>;
|
|
173
173
|
/**
|
|
174
|
-
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see
|
|
174
|
+
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
175
175
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
176
176
|
* @param {*} [options] Override http request option.
|
|
177
177
|
* @throws {RequiredError}
|
|
178
178
|
*/
|
|
179
179
|
deleteDestination(destinationId: string, options?: any): AxiosPromise<DeleteDestinationResponse>;
|
|
180
180
|
/**
|
|
181
|
-
* 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 API is grantless. For more information, see
|
|
181
|
+
* 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 API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
182
182
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
183
183
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
184
184
|
* @param {*} [options] Override http request option.
|
|
@@ -186,27 +186,27 @@ export declare const NotificationsApiFactory: (configuration?: Configuration | u
|
|
|
186
186
|
*/
|
|
187
187
|
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: any): AxiosPromise<DeleteSubscriptionByIdResponse>;
|
|
188
188
|
/**
|
|
189
|
-
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see
|
|
189
|
+
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
190
190
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
191
191
|
* @param {*} [options] Override http request option.
|
|
192
192
|
* @throws {RequiredError}
|
|
193
193
|
*/
|
|
194
194
|
getDestination(destinationId: string, options?: any): AxiosPromise<GetDestinationResponse>;
|
|
195
195
|
/**
|
|
196
|
-
* Returns information about all destinations. The getDestinations API is grantless. For more information, see
|
|
196
|
+
* Returns information about all destinations. The getDestinations API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
200
200
|
getDestinations(options?: any): AxiosPromise<GetDestinationsResponse>;
|
|
201
201
|
/**
|
|
202
|
-
* Returns information about subscriptions of the specified notification type. 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 | For more information, see
|
|
202
|
+
* Returns information about subscriptions of the specified notification type. 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
203
203
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
207
|
getSubscription(notificationType: string, options?: any): AxiosPromise<GetSubscriptionResponse>;
|
|
208
208
|
/**
|
|
209
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see
|
|
209
|
+
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
210
210
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
211
211
|
* @param {string} notificationType The type of notification. For more information about notification types, see [the Notifications API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
@@ -331,66 +331,66 @@ export interface NotificationsApiGetSubscriptionByIdRequest {
|
|
|
331
331
|
*/
|
|
332
332
|
export declare class NotificationsApi extends BaseAPI {
|
|
333
333
|
/**
|
|
334
|
-
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see
|
|
334
|
+
* Creates a destination resource to receive notifications. The createDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
335
335
|
* @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
|
|
336
336
|
* @param {*} [options] Override http request option.
|
|
337
337
|
* @throws {RequiredError}
|
|
338
338
|
* @memberof NotificationsApi
|
|
339
339
|
*/
|
|
340
|
-
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?:
|
|
340
|
+
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDestinationResponse, any>>;
|
|
341
341
|
/**
|
|
342
|
-
* 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 | For more information, see
|
|
342
|
+
* 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
343
343
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
344
344
|
* @param {*} [options] Override http request option.
|
|
345
345
|
* @throws {RequiredError}
|
|
346
346
|
* @memberof NotificationsApi
|
|
347
347
|
*/
|
|
348
|
-
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?:
|
|
348
|
+
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSubscriptionResponse, any>>;
|
|
349
349
|
/**
|
|
350
|
-
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see
|
|
350
|
+
* Deletes the destination that you specify. The deleteDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
351
351
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
352
352
|
* @param {*} [options] Override http request option.
|
|
353
353
|
* @throws {RequiredError}
|
|
354
354
|
* @memberof NotificationsApi
|
|
355
355
|
*/
|
|
356
|
-
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?:
|
|
356
|
+
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteDestinationResponse, any>>;
|
|
357
357
|
/**
|
|
358
|
-
* 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 API is grantless. For more information, see
|
|
358
|
+
* 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 API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
359
359
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
360
360
|
* @param {*} [options] Override http request option.
|
|
361
361
|
* @throws {RequiredError}
|
|
362
362
|
* @memberof NotificationsApi
|
|
363
363
|
*/
|
|
364
|
-
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?:
|
|
364
|
+
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteSubscriptionByIdResponse, any>>;
|
|
365
365
|
/**
|
|
366
|
-
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see
|
|
366
|
+
* Returns information about the destination that you specify. The getDestination API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
367
367
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|
|
370
370
|
* @memberof NotificationsApi
|
|
371
371
|
*/
|
|
372
|
-
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?:
|
|
372
|
+
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDestinationResponse, any>>;
|
|
373
373
|
/**
|
|
374
|
-
* Returns information about all destinations. The getDestinations API is grantless. For more information, see
|
|
374
|
+
* Returns information about all destinations. The getDestinations API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
375
375
|
* @param {*} [options] Override http request option.
|
|
376
376
|
* @throws {RequiredError}
|
|
377
377
|
* @memberof NotificationsApi
|
|
378
378
|
*/
|
|
379
|
-
getDestinations(options?:
|
|
379
|
+
getDestinations(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDestinationsResponse, any>>;
|
|
380
380
|
/**
|
|
381
|
-
* Returns information about subscriptions of the specified notification type. 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 | For more information, see
|
|
381
|
+
* Returns information about subscriptions of the specified notification type. 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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
382
382
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
383
383
|
* @param {*} [options] Override http request option.
|
|
384
384
|
* @throws {RequiredError}
|
|
385
385
|
* @memberof NotificationsApi
|
|
386
386
|
*/
|
|
387
|
-
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?:
|
|
387
|
+
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubscriptionResponse, any>>;
|
|
388
388
|
/**
|
|
389
|
-
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see
|
|
389
|
+
* Returns information about a subscription for the specified notification type. The getSubscriptionById API is grantless. For more information, see [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations) in the Selling Partner API Developer Guide. **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 see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
390
390
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
391
391
|
* @param {*} [options] Override http request option.
|
|
392
392
|
* @throws {RequiredError}
|
|
393
393
|
* @memberof NotificationsApi
|
|
394
394
|
*/
|
|
395
|
-
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?:
|
|
395
|
+
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSubscriptionByIdResponse, any>>;
|
|
396
396
|
}
|
|
@@ -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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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
|
*
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { Configuration } from "./configuration";
|
|
13
|
-
import { AxiosInstance } from 'axios';
|
|
13
|
+
import { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
|
|
|
29
29
|
*/
|
|
30
30
|
export interface RequestArgs {
|
|
31
31
|
url: string;
|
|
32
|
-
options:
|
|
32
|
+
options: AxiosRequestConfig;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
@@ -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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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 { Configuration } from "./configuration";
|
|
13
13
|
import { RequestArgs } from "./base";
|
|
14
|
-
import { AxiosInstance } from 'axios';
|
|
14
|
+
import { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
17
|
* @export
|
|
@@ -27,22 +27,22 @@ export declare const assertParamExists: (functionName: string, paramName: string
|
|
|
27
27
|
*
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
|
-
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @export
|
|
44
44
|
*/
|
|
45
|
-
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @export
|
|
@@ -52,7 +52,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
|
52
52
|
*
|
|
53
53
|
* @export
|
|
54
54
|
*/
|
|
55
|
-
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
56
|
/**
|
|
57
57
|
*
|
|
58
58
|
* @export
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide)
|
|
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, see 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
|
*
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AggregationSettings } from './aggregation-settings';
|
|
13
|
+
/**
|
|
14
|
+
* Use this filter to select the aggregation time period at which to send notifications (e.g. limit to one notification every five minutes for high frequency notifications).
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AggregationFilter
|
|
17
|
+
*/
|
|
18
|
+
export interface AggregationFilter {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {AggregationSettings}
|
|
22
|
+
* @memberof AggregationFilter
|
|
23
|
+
*/
|
|
24
|
+
'aggregationSettings'?: AggregationSettings;
|
|
25
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AggregationTimePeriod } from './aggregation-time-period';
|
|
13
|
+
/**
|
|
14
|
+
* A container that holds all of the necessary properties to configure the aggregation of notifications.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AggregationSettings
|
|
17
|
+
*/
|
|
18
|
+
export interface AggregationSettings {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {AggregationTimePeriod}
|
|
22
|
+
* @memberof AggregationSettings
|
|
23
|
+
*/
|
|
24
|
+
'aggregationTimePeriod': AggregationTimePeriod;
|
|
25
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
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, see the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide).
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The supported aggregation time periods. For example, if FiveMinutes is the value chosen, and 50 price updates occur for an ASIN within 5 minutes, Amazon will send only two notifications; one for the first event, and then a subsequent notification 5 minutes later with the final end state of the data. The 48 interim events will be dropped.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const AggregationTimePeriod: {
|
|
18
|
+
readonly FiveMinutes: "FiveMinutes";
|
|
19
|
+
readonly TenMinutes: "TenMinutes";
|
|
20
|
+
};
|
|
21
|
+
export declare type AggregationTimePeriod = typeof AggregationTimePeriod[keyof typeof AggregationTimePeriod];
|