@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.
Files changed (101) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/src/api-model/api/notifications-api.js +51 -46
  3. package/dist/cjs/src/api-model/api.js +1 -1
  4. package/dist/cjs/src/api-model/base.js +1 -1
  5. package/dist/cjs/src/api-model/common.js +1 -1
  6. package/dist/cjs/src/api-model/configuration.js +1 -1
  7. package/dist/cjs/src/api-model/index.js +1 -1
  8. package/dist/cjs/src/api-model/models/aggregation-filter.js +1 -1
  9. package/dist/cjs/src/api-model/models/aggregation-settings.js +1 -1
  10. package/dist/cjs/src/api-model/models/aggregation-time-period.js +1 -1
  11. package/dist/cjs/src/api-model/models/create-destination-request.js +1 -1
  12. package/dist/cjs/src/api-model/models/create-destination-response.js +1 -1
  13. package/dist/cjs/src/api-model/models/create-subscription-request.js +1 -1
  14. package/dist/cjs/src/api-model/models/create-subscription-response.js +1 -1
  15. package/dist/cjs/src/api-model/models/delete-destination-response.js +1 -1
  16. package/dist/cjs/src/api-model/models/delete-subscription-by-id-response.js +1 -1
  17. package/dist/cjs/src/api-model/models/destination-resource-specification.js +1 -1
  18. package/dist/cjs/src/api-model/models/destination-resource.js +1 -1
  19. package/dist/cjs/src/api-model/models/destination.js +1 -1
  20. package/dist/cjs/src/api-model/models/event-bridge-resource-specification.js +1 -1
  21. package/dist/cjs/src/api-model/models/event-bridge-resource.js +1 -1
  22. package/dist/cjs/src/api-model/models/event-filter-all-of.js +1 -1
  23. package/dist/cjs/src/api-model/models/event-filter.js +1 -1
  24. package/dist/cjs/src/api-model/models/get-destination-response.js +1 -1
  25. package/dist/cjs/src/api-model/models/get-destinations-response.js +1 -1
  26. package/dist/cjs/src/api-model/models/get-subscription-by-id-response.js +1 -1
  27. package/dist/cjs/src/api-model/models/get-subscription-response.js +1 -1
  28. package/dist/cjs/src/api-model/models/marketplace-filter.js +1 -1
  29. package/dist/cjs/src/api-model/models/model-error.js +1 -1
  30. package/dist/cjs/src/api-model/models/order-change-type-enum.js +1 -1
  31. package/dist/cjs/src/api-model/models/order-change-type-filter.js +1 -1
  32. package/dist/cjs/src/api-model/models/processing-directive.js +1 -1
  33. package/dist/cjs/src/api-model/models/sqs-resource.js +1 -1
  34. package/dist/cjs/src/api-model/models/subscription.js +1 -1
  35. package/dist/es/src/api-model/api/notifications-api.js +51 -46
  36. package/dist/es/src/api-model/api.js +1 -1
  37. package/dist/es/src/api-model/base.js +1 -1
  38. package/dist/es/src/api-model/common.js +1 -1
  39. package/dist/es/src/api-model/configuration.js +1 -1
  40. package/dist/es/src/api-model/index.js +1 -1
  41. package/dist/es/src/api-model/models/aggregation-filter.js +1 -1
  42. package/dist/es/src/api-model/models/aggregation-settings.js +1 -1
  43. package/dist/es/src/api-model/models/aggregation-time-period.js +1 -1
  44. package/dist/es/src/api-model/models/create-destination-request.js +1 -1
  45. package/dist/es/src/api-model/models/create-destination-response.js +1 -1
  46. package/dist/es/src/api-model/models/create-subscription-request.js +1 -1
  47. package/dist/es/src/api-model/models/create-subscription-response.js +1 -1
  48. package/dist/es/src/api-model/models/delete-destination-response.js +1 -1
  49. package/dist/es/src/api-model/models/delete-subscription-by-id-response.js +1 -1
  50. package/dist/es/src/api-model/models/destination-resource-specification.js +1 -1
  51. package/dist/es/src/api-model/models/destination-resource.js +1 -1
  52. package/dist/es/src/api-model/models/destination.js +1 -1
  53. package/dist/es/src/api-model/models/event-bridge-resource-specification.js +1 -1
  54. package/dist/es/src/api-model/models/event-bridge-resource.js +1 -1
  55. package/dist/es/src/api-model/models/event-filter-all-of.js +1 -1
  56. package/dist/es/src/api-model/models/event-filter.js +1 -1
  57. package/dist/es/src/api-model/models/get-destination-response.js +1 -1
  58. package/dist/es/src/api-model/models/get-destinations-response.js +1 -1
  59. package/dist/es/src/api-model/models/get-subscription-by-id-response.js +1 -1
  60. package/dist/es/src/api-model/models/get-subscription-response.js +1 -1
  61. package/dist/es/src/api-model/models/marketplace-filter.js +1 -1
  62. package/dist/es/src/api-model/models/model-error.js +1 -1
  63. package/dist/es/src/api-model/models/order-change-type-enum.js +1 -1
  64. package/dist/es/src/api-model/models/order-change-type-filter.js +1 -1
  65. package/dist/es/src/api-model/models/processing-directive.js +1 -1
  66. package/dist/es/src/api-model/models/sqs-resource.js +1 -1
  67. package/dist/es/src/api-model/models/subscription.js +1 -1
  68. package/dist/types/src/api-model/api/notifications-api.d.ts +64 -55
  69. package/dist/types/src/api-model/api.d.ts +1 -1
  70. package/dist/types/src/api-model/base.d.ts +1 -1
  71. package/dist/types/src/api-model/common.d.ts +1 -1
  72. package/dist/types/src/api-model/configuration.d.ts +1 -1
  73. package/dist/types/src/api-model/index.d.ts +1 -1
  74. package/dist/types/src/api-model/models/aggregation-filter.d.ts +2 -2
  75. package/dist/types/src/api-model/models/aggregation-settings.d.ts +1 -1
  76. package/dist/types/src/api-model/models/aggregation-time-period.d.ts +1 -1
  77. package/dist/types/src/api-model/models/create-destination-request.d.ts +2 -2
  78. package/dist/types/src/api-model/models/create-destination-response.d.ts +1 -1
  79. package/dist/types/src/api-model/models/create-subscription-request.d.ts +4 -4
  80. package/dist/types/src/api-model/models/create-subscription-response.d.ts +2 -2
  81. package/dist/types/src/api-model/models/delete-destination-response.d.ts +2 -2
  82. package/dist/types/src/api-model/models/delete-subscription-by-id-response.d.ts +2 -2
  83. package/dist/types/src/api-model/models/destination-resource-specification.d.ts +1 -1
  84. package/dist/types/src/api-model/models/destination-resource.d.ts +1 -1
  85. package/dist/types/src/api-model/models/destination.d.ts +2 -2
  86. package/dist/types/src/api-model/models/event-bridge-resource-specification.d.ts +1 -1
  87. package/dist/types/src/api-model/models/event-bridge-resource.d.ts +3 -3
  88. package/dist/types/src/api-model/models/event-filter-all-of.d.ts +2 -2
  89. package/dist/types/src/api-model/models/event-filter.d.ts +2 -2
  90. package/dist/types/src/api-model/models/get-destination-response.d.ts +2 -2
  91. package/dist/types/src/api-model/models/get-destinations-response.d.ts +2 -2
  92. package/dist/types/src/api-model/models/get-subscription-by-id-response.d.ts +2 -2
  93. package/dist/types/src/api-model/models/get-subscription-response.d.ts +2 -2
  94. package/dist/types/src/api-model/models/marketplace-filter.d.ts +3 -3
  95. package/dist/types/src/api-model/models/model-error.d.ts +3 -3
  96. package/dist/types/src/api-model/models/order-change-type-enum.d.ts +1 -1
  97. package/dist/types/src/api-model/models/order-change-type-filter.d.ts +3 -3
  98. package/dist/types/src/api-model/models/processing-directive.d.ts +2 -2
  99. package/dist/types/src/api-model/models/sqs-resource.d.ts +1 -1
  100. package/dist/types/src/api-model/models/subscription.d.ts +2 -2
  101. 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, 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, 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, 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 { ProcessingDirective } from './processing-directive';
13
13
  /**
14
- * The request schema for the createSubscription operation.
14
+ * The request schema for the `createSubscription` operation.
15
15
  * @export
16
16
  * @interface CreateSubscriptionRequest
17
17
  */
@@ -21,13 +21,13 @@ export interface CreateSubscriptionRequest {
21
21
  * @type {string}
22
22
  * @memberof CreateSubscriptionRequest
23
23
  */
24
- 'payloadVersion'?: string;
24
+ 'payloadVersion': string;
25
25
  /**
26
26
  * The identifier for the destination where notifications will be delivered.
27
27
  * @type {string}
28
28
  * @memberof CreateSubscriptionRequest
29
29
  */
30
- 'destinationId'?: string;
30
+ 'destinationId': string;
31
31
  /**
32
32
  *
33
33
  * @type {ProcessingDirective}
@@ -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, 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 { Subscription } from './subscription';
13
13
  /**
14
- * The response schema for the createSubscription operation.
14
+ * The response schema for the `createSubscription` operation.
15
15
  * @export
16
16
  * @interface CreateSubscriptionResponse
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, 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, 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
  *
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The response schema for the deleteDestination operation.
13
+ * The response schema for the `deleteDestination` operation.
14
14
  * @export
15
15
  * @interface DeleteDestinationResponse
16
16
  */
@@ -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, 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
  *
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The response schema for the deleteSubscriptionById operation.
13
+ * The response schema for the `deleteSubscriptionById` operation.
14
14
  * @export
15
15
  * @interface DeleteSubscriptionByIdResponse
16
16
  */
@@ -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, 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, 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, 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, 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, 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 { DestinationResource } from './destination-resource';
13
13
  /**
14
- * Represents a destination created when you call the createDestination operation.
14
+ * Information about the destination created when you call the `createDestination` operation.
15
15
  * @export
16
16
  * @interface Destination
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, 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, 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, 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, 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
  *
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Represents an Amazon EventBridge destination.
13
+ * The Amazon EventBridge destination.
14
14
  * @export
15
15
  * @interface EventBridgeResource
16
16
  */
@@ -22,7 +22,7 @@ export interface EventBridgeResource {
22
22
  */
23
23
  'name': string;
24
24
  /**
25
- * The AWS region in which you receive the notifications. For AWS regions that are supported in Amazon EventBridge, see https://docs.aws.amazon.com/general/latest/gr/ev.html.
25
+ * The AWS region in which you receive the notifications. For AWS regions that are supported in Amazon EventBridge, refer to [Amazon EventBridge endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/ev.html).
26
26
  * @type {string}
27
27
  * @memberof EventBridgeResource
28
28
  */
@@ -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, 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
  *
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface EventFilterAllOf {
18
18
  /**
19
- * An eventFilterType value that is supported by the specific notificationType. This is used by the subscription service to determine the type of event filter. Refer to the section of the [Notifications Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/notifications-api-v1-use-case-guide) that describes the specific notificationType to determine if an eventFilterType is supported.
19
+ * An `eventFilterType` value that is supported by the specific `notificationType`. This is used by the subscription service to determine the type of event filter. Refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values) to determine if an `eventFilterType` is supported.
20
20
  * @type {string}
21
21
  * @memberof EventFilterAllOf
22
22
  */
@@ -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, 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
  *
@@ -15,7 +15,7 @@ import { MarketplaceFilter } from './marketplace-filter';
15
15
  import { OrderChangeTypeFilter } from './order-change-type-filter';
16
16
  /**
17
17
  * @type EventFilter
18
- * A notificationType specific filter. This object contains all of the currently available filters and properties that you can use to define a notificationType specific filter.
18
+ * A `notificationType` specific filter. This object contains all of the currently available filters and properties that you can use to define a `notificationType` specific filter.
19
19
  * @export
20
20
  */
21
21
  export type EventFilter = AggregationFilter & EventFilterAllOf & MarketplaceFilter & OrderChangeTypeFilter;
@@ -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, 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 { Destination } from './destination';
13
13
  /**
14
- * The response schema for the getDestination operation.
14
+ * The response schema for the `getDestination` operation.
15
15
  * @export
16
16
  * @interface GetDestinationResponse
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, 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, 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 { Destination } from './destination';
13
13
  /**
14
- * The response schema for the getDestinations operation.
14
+ * The response schema for the `getDestinations` operation.
15
15
  * @export
16
16
  * @interface GetDestinationsResponse
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, 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, 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 { Subscription } from './subscription';
13
13
  /**
14
- * The response schema for the getSubscriptionById operation.
14
+ * The response schema for the `getSubscriptionById` operation.
15
15
  * @export
16
16
  * @interface GetSubscriptionByIdResponse
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, 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, 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 { Subscription } from './subscription';
13
13
  /**
14
- * The response schema for the getSubscription operation.
14
+ * The response schema for the `getSubscription` operation.
15
15
  * @export
16
16
  * @interface GetSubscriptionResponse
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, 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, 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
  *
@@ -10,13 +10,13 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Use this event filter to customize your subscription to send notifications for only the specified marketplaceId\'s.
13
+ * An event filter to customize your subscription to send notifications for only the specified `marketplaceId`s.
14
14
  * @export
15
15
  * @interface MarketplaceFilter
16
16
  */
17
17
  export interface MarketplaceFilter {
18
18
  /**
19
- * A list of marketplace identifiers to subscribe to (e.g. ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.
19
+ * A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list.
20
20
  * @type {Array<string>}
21
21
  * @memberof MarketplaceFilter
22
22
  */
@@ -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, 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
  *
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Error response returned when the request is unsuccessful.
13
+ * An error response returned when the request is unsuccessful.
14
14
  * @export
15
15
  * @interface ModelError
16
16
  */
@@ -22,7 +22,7 @@ export interface ModelError {
22
22
  */
23
23
  'code': string;
24
24
  /**
25
- * A message that describes the error condition in a human-readable form.
25
+ * A message that describes the error condition.
26
26
  * @type {string}
27
27
  * @memberof ModelError
28
28
  */
@@ -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, 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, 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, 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,13 +11,13 @@
11
11
  */
12
12
  import { OrderChangeTypeEnum } from './order-change-type-enum';
13
13
  /**
14
- * Use this event filter to customize your subscription to send notifications for only the specified orderChangeType.
14
+ * An event filter to customize your subscription to send notifications for only the specified `orderChangeType`.
15
15
  * @export
16
16
  * @interface OrderChangeTypeFilter
17
17
  */
18
18
  export interface OrderChangeTypeFilter {
19
19
  /**
20
- * A list of order change types to subscribe to (e.g. BuyerRequestedChange). To receive notifications of all change types, do not provide this list.
20
+ * A list of order change types to subscribe to (for example: `BuyerRequestedChange`). To receive notifications of all change types, do not provide this list.
21
21
  * @type {Array<OrderChangeTypeEnum>}
22
22
  * @memberof OrderChangeTypeFilter
23
23
  */
@@ -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, 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 { EventFilter } from './event-filter';
13
13
  /**
14
- * Additional information passed to the subscription to control the processing of notifications. For example, you can use an `eventFilter` to customize your subscription to send notifications for only the specified marketplaceId\'s, or select the aggregation time period at which to send notifications (e.g. limit to one notification every five minutes for high frequency notifications). The specific features available vary depending on the notificationType. This feature is currently only supported by the `ANY_OFFER_CHANGED` and `ORDER_CHANGE` notificationTypes.
14
+ * Additional information passed to the subscription to control the processing of notifications. For example, you can use an `eventFilter` to customize your subscription to send notifications for only the specified `marketplaceId`s, or select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications). The specific features available vary depending on the `notificationType`. This feature is currently only supported by the `ANY_OFFER_CHANGED` and `ORDER_CHANGE` `notificationType`s.
15
15
  * @export
16
16
  * @interface ProcessingDirective
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, 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, 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, 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, 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 { ProcessingDirective } from './processing-directive';
13
13
  /**
14
- * Represents a subscription to receive notifications.
14
+ * Information about the subscription.
15
15
  * @export
16
16
  * @interface Subscription
17
17
  */
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@sp-api-sdk/notifications-api-v1",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
- "description": "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.",
5
- "version": "2.0.3",
4
+ "description": "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.",
5
+ "version": "2.2.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.0.3",
22
- "axios": "^1.6.2"
21
+ "@sp-api-sdk/common": "2.0.5",
22
+ "axios": "^1.6.7"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "notifications api"
42
42
  ],
43
- "gitHead": "c81279baeb662780ae3cb42fb60fa11670fed191"
43
+ "gitHead": "014aad96509aba433e07461efbe936a6062cc66a"
44
44
  }