@sp-api-sdk/notifications-api-v1 3.0.6 → 3.0.7

package/dist/types/api-model/api/notifications-api.d.ts

@@ -25,7 +25,6 @@ import type { GetSubscriptionByIdResponse } from '../models';
 import type { GetSubscriptionResponse } from '../models';
 /**
  * NotificationsApi - axios parameter creator
- * @export
  */
 export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -90,7 +89,6 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
 };
 /**
  * NotificationsApi - functional programming interface
- * @export
  */
 export declare const NotificationsApiFp: (configuration?: Configuration) => {
     /**
@@ -155,7 +153,6 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
 };
 /**
  * NotificationsApi - factory interface
- * @export
  */
 export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -216,124 +213,79 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
 };
 /**
  * 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 {
     /**
@@ -341,7 +293,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateDestinationResponse, any>>;
     /**
@@ -349,7 +300,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateSubscriptionResponse, any>>;
     /**
@@ -357,7 +307,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteDestinationResponse, any>>;
     /**
@@ -365,7 +314,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteSubscriptionByIdResponse, any>>;
     /**
@@ -373,14 +321,12 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationResponse, any>>;
     /**
      * 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?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationsResponse, any>>;
     /**
@@ -388,7 +334,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionResponse, any>>;
     /**
@@ -396,7 +341,6 @@ export declare class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionByIdResponse, any>>;
 }

package/dist/types/api-model/base.d.ts

@@ -12,42 +12,22 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
-/**
- *
- * @export
- */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
-/**
- *
- * @export
- * @interface RequestArgs
- */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
-/**
- *
- * @export
- * @class BaseAPI
- */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/types/api-model/common.d.ts

@@ -12,54 +12,17 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
-/**
- *
- * @export
- */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-/**
- *
- * @export
- */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-/**
- *
- * @export
- */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-/**
- *
- * @export
- */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-/**
- *
- * @export
- */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-/**
- *
- * @export
- */
 export declare const toPathString: (url: URL) => string;
-/**
- *
- * @export
- */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/api-model/configuration.d.ts

@@ -23,49 +23,32 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**

package/dist/types/api-model/models/aggregation-filter.d.ts

@@ -12,14 +12,7 @@
 import type { AggregationSettings } from './aggregation-settings';
 /**
  * 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;
 }

package/dist/types/api-model/models/aggregation-settings.d.ts

@@ -12,14 +12,7 @@
 import type { AggregationTimePeriod } from './aggregation-time-period';
 /**
  * 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;
 }

package/dist/types/api-model/models/aggregation-time-period.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * 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 const AggregationTimePeriod: {
     readonly FiveMinutes: "FiveMinutes";

package/dist/types/api-model/models/create-destination-request.d.ts

@@ -12,20 +12,11 @@
 import type { DestinationResourceSpecification } from './destination-resource-specification';
 /**
  * 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;
 }

package/dist/types/api-model/models/create-destination-response.d.ts

@@ -12,20 +12,11 @@
 import type { Destination } from './destination';
 /**
  * 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<Error>}
-     * @memberof CreateDestinationResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/create-subscription-request.d.ts

@@ -12,26 +12,15 @@
 import type { ProcessingDirective } from './processing-directive';
 /**
  * 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;
 }

package/dist/types/api-model/models/create-subscription-response.d.ts

@@ -12,20 +12,11 @@
 import type { Subscription } from './subscription';
 /**
  * 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<Error>}
-     * @memberof CreateSubscriptionResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/delete-destination-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * 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<Error>}
-     * @memberof DeleteDestinationResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/delete-subscription-by-id-response.d.ts

@@ -11,14 +11,10 @@
  */
 /**
  * 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<Error>}
-     * @memberof DeleteSubscriptionByIdResponse
      */
     'errors'?: Array<Error>;
 }

package/dist/types/api-model/models/destination-resource-specification.d.ts

@@ -13,20 +13,8 @@ import type { EventBridgeResourceSpecification } from './event-bridge-resource-s
 import type { SqsResource } from './sqs-resource';
 /**
  * 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;
 }

package/dist/types/api-model/models/destination-resource.d.ts

@@ -13,20 +13,8 @@ import type { EventBridgeResource } from './event-bridge-resource';
 import type { SqsResource } from './sqs-resource';
 /**
  * The destination resource types.
- * @export
- * @interface DestinationResource
  */
 export interface DestinationResource {
-    /**
-     *
-     * @type {SqsResource}
-     * @memberof DestinationResource
-     */
     'sqs'?: SqsResource;
-    /**
-     *
-     * @type {EventBridgeResource}
-     * @memberof DestinationResource
-     */
     'eventBridge'?: EventBridgeResource;
 }

package/dist/types/api-model/models/destination.d.ts

@@ -12,26 +12,15 @@
 import type { DestinationResource } from './destination-resource';
 /**
  * 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;
 }

package/dist/types/api-model/models/event-bridge-resource-specification.d.ts

@@ -11,20 +11,14 @@
  */
 /**
  * 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;
 }

package/dist/types/api-model/models/event-bridge-resource.d.ts

@@ -11,26 +11,18 @@
  */
 /**
  * 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;
 }

package/dist/types/api-model/models/event-filter-all-of.d.ts

@@ -9,16 +9,9 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- *
- * @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;
 }

package/dist/types/api-model/models/event-filter.d.ts

@@ -16,6 +16,5 @@ import type { OrderChangeTypeFilter } from './order-change-type-filter';
 /**
  * @type EventFilter
  * 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
  */
 export type EventFilter = AggregationFilter & EventFilterAllOf & MarketplaceFilter & OrderChangeTypeFilter;