/** * Selling Partner API for Notifications * 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). * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * A filter used to select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications). * @export * @interface AggregationFilter */ export interface AggregationFilter { /** * * @type {AggregationSettings} * @memberof AggregationFilter */ aggregationSettings?: AggregationSettings; } /** * A container that holds all of the necessary properties to configure the aggregation of notifications. * @export * @interface AggregationSettings */ export interface AggregationSettings { /** * * @type {AggregationTimePeriod} * @memberof AggregationSettings */ aggregationTimePeriod: AggregationTimePeriod | 'FiveMinutes' | 'TenMinutes'; } /** * 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. * @export * @enum {string} */ export declare enum AggregationTimePeriod { FiveMinutes = "FiveMinutes", TenMinutes = "TenMinutes" } /** * The request schema for the `createDestination` operation. * @export * @interface CreateDestinationRequest */ export interface CreateDestinationRequest { /** * * @type {DestinationResourceSpecification} * @memberof CreateDestinationRequest */ resourceSpecification: DestinationResourceSpecification; /** * A developer-defined name to help identify this destination. * @type {string} * @memberof CreateDestinationRequest */ name: string; } /** * The response schema for the createDestination operation. * @export * @interface CreateDestinationResponse */ export interface CreateDestinationResponse { /** * * @type {Destination} * @memberof CreateDestinationResponse */ payload?: Destination; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateDestinationResponse */ errors?: Array; } /** * The request schema for the `createSubscription` operation. * @export * @interface CreateSubscriptionRequest */ export interface CreateSubscriptionRequest { /** * The version of the payload object to be used in the notification. * @type {string} * @memberof CreateSubscriptionRequest */ payloadVersion: string; /** * The identifier for the destination where notifications will be delivered. * @type {string} * @memberof CreateSubscriptionRequest */ destinationId: string; /** * * @type {ProcessingDirective} * @memberof CreateSubscriptionRequest */ processingDirective?: ProcessingDirective; } /** * The response schema for the `createSubscription` operation. * @export * @interface CreateSubscriptionResponse */ export interface CreateSubscriptionResponse { /** * * @type {Subscription} * @memberof CreateSubscriptionResponse */ payload?: Subscription; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateSubscriptionResponse */ errors?: Array; } /** * The response schema for the `deleteDestination` operation. * @export * @interface DeleteDestinationResponse */ export interface DeleteDestinationResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof DeleteDestinationResponse */ errors?: Array; } /** * The response schema for the `deleteSubscriptionById` operation. * @export * @interface DeleteSubscriptionByIdResponse */ export interface DeleteSubscriptionByIdResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof DeleteSubscriptionByIdResponse */ errors?: Array; } /** * Information about the destination created when you call the `createDestination` operation. * @export * @interface Destination */ export interface Destination { /** * The developer-defined name for this destination. * @type {string} * @memberof Destination */ name: string; /** * The destination identifier generated when you created the destination. * @type {string} * @memberof Destination */ destinationId: string; /** * * @type {DestinationResource} * @memberof Destination */ resource: DestinationResource; } /** * The destination resource types. * @export * @interface DestinationResource */ export interface DestinationResource { /** * * @type {SqsResource} * @memberof DestinationResource */ sqs?: SqsResource; /** * * @type {EventBridgeResource} * @memberof DestinationResource */ eventBridge?: EventBridgeResource; } /** * The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination. * @export * @interface DestinationResourceSpecification */ export interface DestinationResourceSpecification { /** * * @type {SqsResource} * @memberof DestinationResourceSpecification */ sqs?: SqsResource; /** * * @type {EventBridgeResourceSpecification} * @memberof DestinationResourceSpecification */ eventBridge?: EventBridgeResourceSpecification; } /** * The Amazon EventBridge destination. * @export * @interface EventBridgeResource */ export interface EventBridgeResource { /** * The name of the partner event source associated with the destination. * @type {string} * @memberof EventBridgeResource */ name: string; /** * 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). * @type {string} * @memberof EventBridgeResource */ region: string; /** * The identifier for the AWS account that is responsible for charges related to receiving notifications. * @type {string} * @memberof EventBridgeResource */ accountId: string; } /** * The information required to create an Amazon EventBridge destination. * @export * @interface EventBridgeResourceSpecification */ export interface EventBridgeResourceSpecification { /** * The AWS region in which you will be receiving the notifications. * @type {string} * @memberof EventBridgeResourceSpecification */ region: string; /** * The identifier for the AWS account that is responsible for charges related to receiving notifications. * @type {string} * @memberof EventBridgeResourceSpecification */ accountId: string; } /** * 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. * @export * @interface EventFilter */ export interface EventFilter { /** * * @type {AggregationSettings} * @memberof EventFilter */ aggregationSettings?: AggregationSettings; /** * A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. * @type {Array} * @memberof EventFilter */ marketplaceIds?: Array; /** * A list of order change types to subscribe to (for example: `BuyerRequestedChange`). To receive notifications of all change types, do not provide this list. * @type {Array} * @memberof EventFilter */ orderChangeTypes?: Array<(OrderChangeTypeEnum | 'OrderStatusChange' | 'BuyerRequestedChange')>; /** * 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. * @type {string} * @memberof EventFilter */ eventFilterType: EventFilterEventFilterTypeEnum | 'ANY_OFFER_CHANGED' | 'ORDER_CHANGE'; } /** * @export * @enum {string} */ export declare enum EventFilterEventFilterTypeEnum { AnyOfferChanged = "ANY_OFFER_CHANGED", OrderChange = "ORDER_CHANGE" } /** * * @export * @interface EventFilterAllOf */ export interface EventFilterAllOf { /** * 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. * @type {string} * @memberof EventFilterAllOf */ eventFilterType: EventFilterAllOfEventFilterTypeEnum | 'ANY_OFFER_CHANGED' | 'ORDER_CHANGE'; } /** * @export * @enum {string} */ export declare enum EventFilterAllOfEventFilterTypeEnum { AnyOfferChanged = "ANY_OFFER_CHANGED", OrderChange = "ORDER_CHANGE" } /** * The response schema for the `getDestination` operation. * @export * @interface GetDestinationResponse */ export interface GetDestinationResponse { /** * * @type {Destination} * @memberof GetDestinationResponse */ payload?: Destination; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetDestinationResponse */ errors?: Array; } /** * The response schema for the `getDestinations` operation. * @export * @interface GetDestinationsResponse */ export interface GetDestinationsResponse { /** * A list of destinations. * @type {Array} * @memberof GetDestinationsResponse */ payload?: Array; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetDestinationsResponse */ errors?: Array; } /** * The response schema for the `getSubscriptionById` operation. * @export * @interface GetSubscriptionByIdResponse */ export interface GetSubscriptionByIdResponse { /** * * @type {Subscription} * @memberof GetSubscriptionByIdResponse */ payload?: Subscription; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSubscriptionByIdResponse */ errors?: Array; } /** * The response schema for the `getSubscription` operation. * @export * @interface GetSubscriptionResponse */ export interface GetSubscriptionResponse { /** * * @type {Subscription} * @memberof GetSubscriptionResponse */ payload?: Subscription; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetSubscriptionResponse */ errors?: Array; } /** * An event filter to customize your subscription to send notifications for only the specified `marketplaceId`s. * @export * @interface MarketplaceFilter */ export interface MarketplaceFilter { /** * A list of marketplace identifiers to subscribe to (for example: ATVPDKIKX0DER). To receive notifications in every marketplace, do not provide this list. * @type {Array} * @memberof MarketplaceFilter */ marketplaceIds?: Array; } /** * An error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The supported order change type of ORDER_CHANGE notification. * @export * @enum {string} */ export declare enum OrderChangeTypeEnum { OrderStatusChange = "OrderStatusChange", BuyerRequestedChange = "BuyerRequestedChange" } /** * An event filter to customize your subscription to send notifications for only the specified `orderChangeType`. * @export * @interface OrderChangeTypeFilter */ export interface OrderChangeTypeFilter { /** * A list of order change types to subscribe to (for example: `BuyerRequestedChange`). To receive notifications of all change types, do not provide this list. * @type {Array} * @memberof OrderChangeTypeFilter */ orderChangeTypes?: Array<(OrderChangeTypeEnum | 'OrderStatusChange' | 'BuyerRequestedChange')>; } /** * 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. * @export * @interface ProcessingDirective */ export interface ProcessingDirective { /** * * @type {EventFilter} * @memberof ProcessingDirective */ eventFilter?: EventFilter; } /** * The information required to create an Amazon Simple Queue Service (Amazon SQS) queue destination. * @export * @interface SqsResource */ export interface SqsResource { /** * The Amazon Resource Name (ARN) associated with the SQS queue. * @type {string} * @memberof SqsResource */ arn: string; } /** * Information about the subscription. * @export * @interface Subscription */ export interface Subscription { /** * The subscription identifier generated when the subscription is created. * @type {string} * @memberof Subscription */ subscriptionId: string; /** * The version of the payload object to be used in the notification. * @type {string} * @memberof Subscription */ payloadVersion: string; /** * The identifier for the destination where notifications will be delivered. * @type {string} * @memberof Subscription */ destinationId: string; /** * * @type {ProcessingDirective} * @memberof Subscription */ processingDirective?: ProcessingDirective; } /** * NotificationsApi - axios parameter creator * @export */ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateDestinationRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDestination: (body: CreateDestinationRequest, options?: any) => Promise; /** * Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {CreateSubscriptionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?: any) => Promise; /** * Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier for the destination that you want to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination: (destinationId: string, options?: any) => Promise; /** * Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to delete. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?: any) => Promise; /** * Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier generated when you created the destination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination: (destinationId: string, options?: any) => Promise; /** * Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations: (options?: any) => Promise; /** * Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {string} [payloadVersion] The version of the payload object to be used in the notification. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription: (notificationType: string, payloadVersion?: string, options?: any) => Promise; /** * Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to get. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionById: (subscriptionId: string, notificationType: string, options?: any) => Promise; }; /** * NotificationsApi - functional programming interface * @export */ export declare const NotificationsApiFp: (configuration?: Configuration) => { /** * Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateDestinationRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDestination(body: CreateDestinationRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {CreateSubscriptionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier for the destination that you want to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination(destinationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to delete. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier generated when you created the destination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination(destinationId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {string} [payloadVersion] The version of the payload object to be used in the notification. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(notificationType: string, payloadVersion?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to get. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionById(subscriptionId: string, notificationType: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotificationsApi - factory interface * @export */ export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {CreateDestinationRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDestination(body: CreateDestinationRequest, options?: any): AxiosPromise; /** * Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {CreateSubscriptionRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: any): AxiosPromise; /** * Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier for the destination that you want to delete. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteDestination(destinationId: string, options?: any): AxiosPromise; /** * Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to delete. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: any): AxiosPromise; /** * Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} destinationId The identifier generated when you created the destination. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestination(destinationId: string, options?: any): AxiosPromise; /** * Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDestinations(options?: any): AxiosPromise; /** * Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {string} [payloadVersion] The version of the payload object to be used in the notification. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(notificationType: string, payloadVersion?: string, options?: any): AxiosPromise; /** * Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} subscriptionId The identifier for the subscription that you want to get. * @param {string} notificationType The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscriptionById(subscriptionId: string, notificationType: string, options?: any): AxiosPromise; }; /** * Request parameters for createDestination operation in NotificationsApi. * @export * @interface NotificationsApiCreateDestinationRequest */ export interface NotificationsApiCreateDestinationRequest { /** * * @type {CreateDestinationRequest} * @memberof NotificationsApiCreateDestination */ readonly body: CreateDestinationRequest; } /** * Request parameters for createSubscription operation in NotificationsApi. * @export * @interface NotificationsApiCreateSubscriptionRequest */ export interface NotificationsApiCreateSubscriptionRequest { /** * The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @type {string} * @memberof NotificationsApiCreateSubscription */ readonly notificationType: string; /** * * @type {CreateSubscriptionRequest} * @memberof NotificationsApiCreateSubscription */ readonly body: CreateSubscriptionRequest; } /** * Request parameters for deleteDestination operation in NotificationsApi. * @export * @interface NotificationsApiDeleteDestinationRequest */ export interface NotificationsApiDeleteDestinationRequest { /** * The identifier for the destination that you want to delete. * @type {string} * @memberof NotificationsApiDeleteDestination */ readonly destinationId: string; } /** * Request parameters for deleteSubscriptionById operation in NotificationsApi. * @export * @interface NotificationsApiDeleteSubscriptionByIdRequest */ export interface NotificationsApiDeleteSubscriptionByIdRequest { /** * The identifier for the subscription that you want to delete. * @type {string} * @memberof NotificationsApiDeleteSubscriptionById */ readonly subscriptionId: string; /** * The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @type {string} * @memberof NotificationsApiDeleteSubscriptionById */ readonly notificationType: string; } /** * Request parameters for getDestination operation in NotificationsApi. * @export * @interface NotificationsApiGetDestinationRequest */ export interface NotificationsApiGetDestinationRequest { /** * The identifier generated when you created the destination. * @type {string} * @memberof NotificationsApiGetDestination */ readonly destinationId: string; } /** * Request parameters for getSubscription operation in NotificationsApi. * @export * @interface NotificationsApiGetSubscriptionRequest */ export interface NotificationsApiGetSubscriptionRequest { /** * The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @type {string} * @memberof NotificationsApiGetSubscription */ readonly notificationType: string; /** * The version of the payload object to be used in the notification. * @type {string} * @memberof NotificationsApiGetSubscription */ readonly payloadVersion?: string; } /** * Request parameters for getSubscriptionById operation in NotificationsApi. * @export * @interface NotificationsApiGetSubscriptionByIdRequest */ export interface NotificationsApiGetSubscriptionByIdRequest { /** * The identifier for the subscription that you want to get. * @type {string} * @memberof NotificationsApiGetSubscriptionById */ readonly subscriptionId: string; /** * The type of notification. For more information about notification types, refer to [Notification Type Values](https://developer-docs.amazon.com/sp-api/docs/notification-type-values). * @type {string} * @memberof NotificationsApiGetSubscriptionById */ readonly notificationType: string; } /** * NotificationsApi - object-oriented interface * @export * @class NotificationsApi * @extends {BaseAPI} */ export declare class NotificationsApi extends BaseAPI { /** * Creates a destination resource to receive notifications. The `createDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: any): Promise>; /** * Creates a subscription for the specified notification type to be delivered to the specified destination. Before you can subscribe, you must first create the destination by calling the `createDestination` operation. In cases where the specified notification type supports multiple payload versions, you can utilize this API to subscribe to a different payload version if you already have an existing subscription for a different payload version. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: any): Promise>; /** * Deletes the destination that you specify. The `deleteDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: any): Promise>; /** * Deletes the subscription indicated by the subscription identifier and notification type that you specify. The subscription identifier can be for any subscription associated with your application. After you successfully call this operation, notifications will stop being sent for the associated subscription. The `deleteSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: any): Promise>; /** * Returns information about the destination that you specify. The `getDestination` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: any): Promise>; /** * Returns information about all destinations. The `getDestinations` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ getDestinations(options?: any): Promise>; /** * Returns information about subscription of the specified notification type and payload version. `payloadVersion` is an optional parameter. When `payloadVersion` is not provided, it will return latest payload version subscription\'s information. You can use this API to get subscription information when you do not have a subscription identifier. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: any): Promise>; /** * Returns information about a subscription for the specified notification type. The `getSubscriptionById` operation is grantless. For more information, refer to [Grantless operations](https://developer-docs.amazon.com/sp-api/docs/grantless-operations). **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: any): Promise>; }