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

package/dist/cjs/api-model/api/notifications-api.js

@@ -25,7 +25,6 @@ const common_1 = require("../common");
 const base_1 = require("../base");
 /**
  * NotificationsApi - axios parameter creator
- * @export
  */
 const NotificationsApiAxiosParamCreator = function (configuration) {
     return {
@@ -272,7 +271,6 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
 exports.NotificationsApiAxiosParamCreator = NotificationsApiAxiosParamCreator;
 /**
  * NotificationsApi - functional programming interface
- * @export
  */
 const NotificationsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.NotificationsApiAxiosParamCreator)(configuration);
@@ -381,7 +379,6 @@ const NotificationsApiFp = function (configuration) {
 exports.NotificationsApiFp = NotificationsApiFp;
 /**
  * NotificationsApi - factory interface
- * @export
  */
 const NotificationsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.NotificationsApiFp)(configuration);
@@ -462,9 +459,6 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
 exports.NotificationsApiFactory = NotificationsApiFactory;
 /**
  * NotificationsApi - object-oriented interface
- * @export
- * @class NotificationsApi
- * @extends {BaseAPI}
  */
 class NotificationsApi extends base_1.BaseAPI {
     /**
@@ -472,7 +466,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createDestination(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).createDestination(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -482,7 +475,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createSubscription(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).createSubscription(requestParameters.notificationType, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -492,7 +484,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteDestination(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).deleteDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
@@ -502,7 +493,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteSubscriptionById(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).deleteSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));
@@ -512,7 +502,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getDestination(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).getDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
@@ -521,7 +510,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * 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) {
         return (0, exports.NotificationsApiFp)(this.configuration).getDestinations(options).then((request) => request(this.axios, this.basePath));
@@ -531,7 +519,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscription(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).getSubscription(requestParameters.notificationType, requestParameters.payloadVersion, options).then((request) => request(this.axios, this.basePath));
@@ -541,7 +528,6 @@ class NotificationsApi extends base_1.BaseAPI {
      * @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscriptionById(requestParameters, options) {
         return (0, exports.NotificationsApiFp)(this.configuration).getSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));

package/dist/cjs/api-model/base.js

@@ -19,21 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 const axios_1 = __importDefault(require("axios"));
 exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 class BaseAPI {
     basePath;
     axios;
@@ -49,12 +40,6 @@ class BaseAPI {
 }
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -64,8 +49,4 @@ class RequiredError extends Error {
     }
 }
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/dist/cjs/api-model/common.js

@@ -15,15 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 const base_1 = require("./base");
-/**
- *
- * @export
- */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -31,10 +26,6 @@ const assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
-/**
- *
- * @export
- */
 const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -44,20 +35,12 @@ const setApiKeyToObject = async function (object, keyParamName, configuration) {
     }
 };
 exports.setApiKeyToObject = setApiKeyToObject;
-/**
- *
- * @export
- */
 const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
-/**
- *
- * @export
- */
 const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -67,10 +50,6 @@ const setBearerAuthToObject = async function (object, configuration) {
     }
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
-/**
- *
- * @export
- */
 const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -100,20 +79,12 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
 exports.setSearchParams = setSearchParams;
-/**
- *
- * @export
- */
 const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -124,18 +95,10 @@ const serializeDataIfNeeded = function (value, requestOptions, configuration) {
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
-/**
- *
- * @export
- */
 const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
-/**
- *
- * @export
- */
 const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/cjs/api-model/configuration.js

@@ -18,49 +18,32 @@ class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/cjs/api-model/models/aggregation-time-period.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AggregationTimePeriod = void 0;
 /**
  * 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}
  */
 exports.AggregationTimePeriod = {
     FiveMinutes: 'FiveMinutes',

package/dist/cjs/api-model/models/order-change-type-enum.js

@@ -16,8 +16,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderChangeTypeEnum = void 0;
 /**
  * The supported order change type of ORDER_CHANGE notification.
- * @export
- * @enum {string}
  */
 exports.OrderChangeTypeEnum = {
     OrderStatusChange: 'OrderStatusChange',

package/dist/es/api-model/api/notifications-api.js

@@ -19,7 +19,6 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
 import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
 /**
  * NotificationsApi - axios parameter creator
- * @export
  */
 export const NotificationsApiAxiosParamCreator = function (configuration) {
     return {
@@ -265,7 +264,6 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
 };
 /**
  * NotificationsApi - functional programming interface
- * @export
  */
 export const NotificationsApiFp = function (configuration) {
     const localVarAxiosParamCreator = NotificationsApiAxiosParamCreator(configuration);
@@ -373,7 +371,6 @@ export const NotificationsApiFp = function (configuration) {
 };
 /**
  * NotificationsApi - factory interface
- * @export
  */
 export const NotificationsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = NotificationsApiFp(configuration);
@@ -453,9 +450,6 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
 };
 /**
  * NotificationsApi - object-oriented interface
- * @export
- * @class NotificationsApi
- * @extends {BaseAPI}
  */
 export class NotificationsApi extends BaseAPI {
     /**
@@ -463,7 +457,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiCreateDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createDestination(requestParameters, options) {
         return NotificationsApiFp(this.configuration).createDestination(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -473,7 +466,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     createSubscription(requestParameters, options) {
         return NotificationsApiFp(this.configuration).createSubscription(requestParameters.notificationType, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
@@ -483,7 +475,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteDestination(requestParameters, options) {
         return NotificationsApiFp(this.configuration).deleteDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
@@ -493,7 +484,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     deleteSubscriptionById(requestParameters, options) {
         return NotificationsApiFp(this.configuration).deleteSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));
@@ -503,7 +493,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getDestination(requestParameters, options) {
         return NotificationsApiFp(this.configuration).getDestination(requestParameters.destinationId, options).then((request) => request(this.axios, this.basePath));
@@ -512,7 +501,6 @@ export class NotificationsApi extends BaseAPI {
      * 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) {
         return NotificationsApiFp(this.configuration).getDestinations(options).then((request) => request(this.axios, this.basePath));
@@ -522,7 +510,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscription(requestParameters, options) {
         return NotificationsApiFp(this.configuration).getSubscription(requestParameters.notificationType, requestParameters.payloadVersion, options).then((request) => request(this.axios, this.basePath));
@@ -532,7 +519,6 @@ export class NotificationsApi extends BaseAPI {
      * @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof NotificationsApi
      */
     getSubscriptionById(requestParameters, options) {
         return NotificationsApiFp(this.configuration).getSubscriptionById(requestParameters.subscriptionId, requestParameters.notificationType, options).then((request) => request(this.axios, this.basePath));

package/dist/es/api-model/base.js

@@ -13,21 +13,12 @@
  */
 import globalAxios from 'axios';
 export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
-/**
- *
- * @export
- */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
-/**
- *
- * @export
- * @class BaseAPI
- */
 export class BaseAPI {
     basePath;
     axios;
@@ -42,12 +33,6 @@ export class BaseAPI {
     }
 }
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 export class RequiredError extends Error {
     field;
     constructor(field, msg) {
@@ -56,8 +41,4 @@ export class RequiredError extends Error {
         this.name = "RequiredError";
     }
 }
-/**
- *
- * @export
- */
 export const operationServerMap = {};

package/dist/es/api-model/common.js

@@ -12,25 +12,16 @@
  * Do not edit the class manually.
  */
 import { RequiredError } from "./base";
-/**
- *
- * @export
- */
 export const DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
- * @export
  */
 export const assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
         throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
     }
 };
-/**
- *
- * @export
- */
 export const setApiKeyToObject = async function (object, keyParamName, configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -39,19 +30,11 @@ export const setApiKeyToObject = async function (object, keyParamName, configura
         object[keyParamName] = localVarApiKeyValue;
     }
 };
-/**
- *
- * @export
- */
 export const setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
-/**
- *
- * @export
- */
 export const setBearerAuthToObject = async function (object, configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -60,10 +43,6 @@ export const setBearerAuthToObject = async function (object, configuration) {
         object["Authorization"] = "Bearer " + accessToken;
     }
 };
-/**
- *
- * @export
- */
 export const setOAuthToObject = async function (object, name, scopes, configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -92,19 +71,11 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
         }
     }
 }
-/**
- *
- * @export
- */
 export const setSearchParams = function (url, ...objects) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
     url.search = searchParams.toString();
 };
-/**
- *
- * @export
- */
 export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -114,17 +85,9 @@ export const serializeDataIfNeeded = function (value, requestOptions, configurat
         ? JSON.stringify(value !== undefined ? value : {})
         : (value || "");
 };
-/**
- *
- * @export
- */
 export const toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
-/**
- *
- * @export
- */
 export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return (axios = globalAxios, basePath = BASE_PATH) => {
         const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };

package/dist/es/api-model/configuration.js

@@ -15,49 +15,32 @@ export class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
-     * @memberof Configuration
      */
     apiKey;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     username;
     /**
      * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     password;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     * @memberof Configuration
      */
     accessToken;
     /**
      * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
      */
     basePath;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions;
     /**

package/dist/es/api-model/models/aggregation-time-period.js

@@ -13,8 +13,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 const AggregationTimePeriod = {
     FiveMinutes: 'FiveMinutes',

package/dist/es/api-model/models/order-change-type-enum.js

@@ -13,8 +13,6 @@
  */
 /**
  * The supported order change type of ORDER_CHANGE notification.
- * @export
- * @enum {string}
  */
 export const OrderChangeTypeEnum = {
     OrderStatusChange: 'OrderStatusChange',