@sp-api-sdk/notifications-api-v1 2.2.2 → 2.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/api-model/api/notifications-api.js +24 -8
- package/dist/cjs/src/api-model/base.js +7 -2
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +8 -0
- package/dist/es/src/api-model/api/notifications-api.js +25 -9
- package/dist/es/src/api-model/base.js +6 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +8 -0
- package/dist/types/src/api-model/api/notifications-api.d.ts +44 -44
- package/dist/types/src/api-model/base.d.ts +14 -2
- package/dist/types/src/api-model/configuration.d.ts +8 -0
- package/dist/types/src/api-model/models/aggregation-filter.d.ts +1 -1
- package/dist/types/src/api-model/models/aggregation-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/create-destination-request.d.ts +1 -1
- package/dist/types/src/api-model/models/create-destination-response.d.ts +1 -1
- package/dist/types/src/api-model/models/create-subscription-request.d.ts +1 -1
- package/dist/types/src/api-model/models/create-subscription-response.d.ts +1 -1
- package/dist/types/src/api-model/models/destination-resource-specification.d.ts +2 -2
- package/dist/types/src/api-model/models/destination-resource.d.ts +2 -2
- package/dist/types/src/api-model/models/destination.d.ts +1 -1
- package/dist/types/src/api-model/models/event-filter.d.ts +4 -4
- package/dist/types/src/api-model/models/get-destination-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-destinations-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-subscription-by-id-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-subscription-response.d.ts +1 -1
- package/dist/types/src/api-model/models/order-change-type-filter.d.ts +1 -1
- package/dist/types/src/api-model/models/processing-directive.d.ts +1 -1
- package/dist/types/src/api-model/models/subscription.d.ts +1 -1
- package/package.json +4 -4
|
@@ -285,7 +285,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
285
285
|
*/
|
|
286
286
|
async createDestination(body, options) {
|
|
287
287
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDestination(body, options);
|
|
288
|
-
|
|
288
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
289
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.createDestination']?.[localVarOperationServerIndex]?.url;
|
|
290
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
289
291
|
},
|
|
290
292
|
/**
|
|
291
293
|
* 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).
|
|
@@ -296,7 +298,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
296
298
|
*/
|
|
297
299
|
async createSubscription(notificationType, body, options) {
|
|
298
300
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(notificationType, body, options);
|
|
299
|
-
|
|
301
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
302
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.createSubscription']?.[localVarOperationServerIndex]?.url;
|
|
303
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
300
304
|
},
|
|
301
305
|
/**
|
|
302
306
|
* 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).
|
|
@@ -306,7 +310,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
306
310
|
*/
|
|
307
311
|
async deleteDestination(destinationId, options) {
|
|
308
312
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDestination(destinationId, options);
|
|
309
|
-
|
|
313
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
314
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.deleteDestination']?.[localVarOperationServerIndex]?.url;
|
|
315
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
310
316
|
},
|
|
311
317
|
/**
|
|
312
318
|
* 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).
|
|
@@ -317,7 +323,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
317
323
|
*/
|
|
318
324
|
async deleteSubscriptionById(subscriptionId, notificationType, options) {
|
|
319
325
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscriptionById(subscriptionId, notificationType, options);
|
|
320
|
-
|
|
326
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
327
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.deleteSubscriptionById']?.[localVarOperationServerIndex]?.url;
|
|
328
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
321
329
|
},
|
|
322
330
|
/**
|
|
323
331
|
* 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).
|
|
@@ -327,7 +335,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
327
335
|
*/
|
|
328
336
|
async getDestination(destinationId, options) {
|
|
329
337
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDestination(destinationId, options);
|
|
330
|
-
|
|
338
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
339
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.getDestination']?.[localVarOperationServerIndex]?.url;
|
|
340
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
331
341
|
},
|
|
332
342
|
/**
|
|
333
343
|
* 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).
|
|
@@ -336,7 +346,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
336
346
|
*/
|
|
337
347
|
async getDestinations(options) {
|
|
338
348
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDestinations(options);
|
|
339
|
-
|
|
349
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
350
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.getDestinations']?.[localVarOperationServerIndex]?.url;
|
|
351
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
340
352
|
},
|
|
341
353
|
/**
|
|
342
354
|
* 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).
|
|
@@ -347,7 +359,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
347
359
|
*/
|
|
348
360
|
async getSubscription(notificationType, payloadVersion, options) {
|
|
349
361
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscription(notificationType, payloadVersion, options);
|
|
350
|
-
|
|
362
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
363
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.getSubscription']?.[localVarOperationServerIndex]?.url;
|
|
364
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
351
365
|
},
|
|
352
366
|
/**
|
|
353
367
|
* 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).
|
|
@@ -358,7 +372,9 @@ const NotificationsApiFp = function (configuration) {
|
|
|
358
372
|
*/
|
|
359
373
|
async getSubscriptionById(subscriptionId, notificationType, options) {
|
|
360
374
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscriptionById(subscriptionId, notificationType, options);
|
|
361
|
-
|
|
375
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
376
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['NotificationsApi.getSubscriptionById']?.[localVarOperationServerIndex]?.url;
|
|
377
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
362
378
|
},
|
|
363
379
|
};
|
|
364
380
|
};
|
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
19
|
+
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
22
22
|
/**
|
|
@@ -43,7 +43,7 @@ class BaseAPI {
|
|
|
43
43
|
this.axios = axios;
|
|
44
44
|
if (configuration) {
|
|
45
45
|
this.configuration = configuration;
|
|
46
|
-
this.basePath = configuration.basePath
|
|
46
|
+
this.basePath = configuration.basePath ?? basePath;
|
|
47
47
|
}
|
|
48
48
|
}
|
|
49
49
|
}
|
|
@@ -64,3 +64,8 @@ class RequiredError extends Error {
|
|
|
64
64
|
}
|
|
65
65
|
}
|
|
66
66
|
exports.RequiredError = RequiredError;
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
exports.operationServerMap = {};
|
|
@@ -138,7 +138,7 @@ exports.toPathString = toPathString;
|
|
|
138
138
|
*/
|
|
139
139
|
const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
140
140
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
141
|
-
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath
|
|
141
|
+
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
142
142
|
return axios.request(axiosRequestArgs);
|
|
143
143
|
};
|
|
144
144
|
};
|
|
@@ -49,6 +49,13 @@ class Configuration {
|
|
|
49
49
|
* @memberof Configuration
|
|
50
50
|
*/
|
|
51
51
|
basePath;
|
|
52
|
+
/**
|
|
53
|
+
* override server index
|
|
54
|
+
*
|
|
55
|
+
* @type {number}
|
|
56
|
+
* @memberof Configuration
|
|
57
|
+
*/
|
|
58
|
+
serverIndex;
|
|
52
59
|
/**
|
|
53
60
|
* base options for axios calls
|
|
54
61
|
*
|
|
@@ -70,6 +77,7 @@ class Configuration {
|
|
|
70
77
|
this.password = param.password;
|
|
71
78
|
this.accessToken = param.accessToken;
|
|
72
79
|
this.basePath = param.basePath;
|
|
80
|
+
this.serverIndex = param.serverIndex;
|
|
73
81
|
this.baseOptions = param.baseOptions;
|
|
74
82
|
this.formDataCtor = param.formDataCtor;
|
|
75
83
|
}
|
|
@@ -16,7 +16,7 @@ import globalAxios from 'axios';
|
|
|
16
16
|
// @ts-ignore
|
|
17
17
|
import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
18
18
|
// @ts-ignore
|
|
19
|
-
import { BASE_PATH, BaseAPI } from '../base';
|
|
19
|
+
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
21
|
* NotificationsApi - axios parameter creator
|
|
22
22
|
* @export
|
|
@@ -278,7 +278,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
278
278
|
*/
|
|
279
279
|
async createDestination(body, options) {
|
|
280
280
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createDestination(body, options);
|
|
281
|
-
|
|
281
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
282
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.createDestination']?.[localVarOperationServerIndex]?.url;
|
|
283
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
282
284
|
},
|
|
283
285
|
/**
|
|
284
286
|
* 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).
|
|
@@ -289,7 +291,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
289
291
|
*/
|
|
290
292
|
async createSubscription(notificationType, body, options) {
|
|
291
293
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createSubscription(notificationType, body, options);
|
|
292
|
-
|
|
294
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
295
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.createSubscription']?.[localVarOperationServerIndex]?.url;
|
|
296
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
293
297
|
},
|
|
294
298
|
/**
|
|
295
299
|
* 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).
|
|
@@ -299,7 +303,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
299
303
|
*/
|
|
300
304
|
async deleteDestination(destinationId, options) {
|
|
301
305
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteDestination(destinationId, options);
|
|
302
|
-
|
|
306
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
307
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.deleteDestination']?.[localVarOperationServerIndex]?.url;
|
|
308
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
303
309
|
},
|
|
304
310
|
/**
|
|
305
311
|
* 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).
|
|
@@ -310,7 +316,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
310
316
|
*/
|
|
311
317
|
async deleteSubscriptionById(subscriptionId, notificationType, options) {
|
|
312
318
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSubscriptionById(subscriptionId, notificationType, options);
|
|
313
|
-
|
|
319
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
320
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.deleteSubscriptionById']?.[localVarOperationServerIndex]?.url;
|
|
321
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
314
322
|
},
|
|
315
323
|
/**
|
|
316
324
|
* 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).
|
|
@@ -320,7 +328,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
320
328
|
*/
|
|
321
329
|
async getDestination(destinationId, options) {
|
|
322
330
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDestination(destinationId, options);
|
|
323
|
-
|
|
331
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
332
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getDestination']?.[localVarOperationServerIndex]?.url;
|
|
333
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
324
334
|
},
|
|
325
335
|
/**
|
|
326
336
|
* 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).
|
|
@@ -329,7 +339,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
329
339
|
*/
|
|
330
340
|
async getDestinations(options) {
|
|
331
341
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getDestinations(options);
|
|
332
|
-
|
|
342
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
343
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getDestinations']?.[localVarOperationServerIndex]?.url;
|
|
344
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
333
345
|
},
|
|
334
346
|
/**
|
|
335
347
|
* 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).
|
|
@@ -340,7 +352,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
340
352
|
*/
|
|
341
353
|
async getSubscription(notificationType, payloadVersion, options) {
|
|
342
354
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscription(notificationType, payloadVersion, options);
|
|
343
|
-
|
|
355
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
356
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getSubscription']?.[localVarOperationServerIndex]?.url;
|
|
357
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
344
358
|
},
|
|
345
359
|
/**
|
|
346
360
|
* 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).
|
|
@@ -351,7 +365,9 @@ export const NotificationsApiFp = function (configuration) {
|
|
|
351
365
|
*/
|
|
352
366
|
async getSubscriptionById(subscriptionId, notificationType, options) {
|
|
353
367
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getSubscriptionById(subscriptionId, notificationType, options);
|
|
354
|
-
|
|
368
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
369
|
+
const localVarOperationServerBasePath = operationServerMap['NotificationsApi.getSubscriptionById']?.[localVarOperationServerIndex]?.url;
|
|
370
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
355
371
|
},
|
|
356
372
|
};
|
|
357
373
|
};
|
|
@@ -37,7 +37,7 @@ export class BaseAPI {
|
|
|
37
37
|
this.axios = axios;
|
|
38
38
|
if (configuration) {
|
|
39
39
|
this.configuration = configuration;
|
|
40
|
-
this.basePath = configuration.basePath
|
|
40
|
+
this.basePath = configuration.basePath ?? basePath;
|
|
41
41
|
}
|
|
42
42
|
}
|
|
43
43
|
}
|
|
@@ -56,3 +56,8 @@ export class RequiredError extends Error {
|
|
|
56
56
|
this.name = "RequiredError";
|
|
57
57
|
}
|
|
58
58
|
}
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @export
|
|
62
|
+
*/
|
|
63
|
+
export const operationServerMap = {};
|
|
@@ -127,7 +127,7 @@ export const toPathString = function (url) {
|
|
|
127
127
|
*/
|
|
128
128
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
129
129
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
130
|
-
const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath
|
|
130
|
+
const axiosRequestArgs = { ...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url };
|
|
131
131
|
return axios.request(axiosRequestArgs);
|
|
132
132
|
};
|
|
133
133
|
};
|
|
@@ -46,6 +46,13 @@ export class Configuration {
|
|
|
46
46
|
* @memberof Configuration
|
|
47
47
|
*/
|
|
48
48
|
basePath;
|
|
49
|
+
/**
|
|
50
|
+
* override server index
|
|
51
|
+
*
|
|
52
|
+
* @type {number}
|
|
53
|
+
* @memberof Configuration
|
|
54
|
+
*/
|
|
55
|
+
serverIndex;
|
|
49
56
|
/**
|
|
50
57
|
* base options for axios calls
|
|
51
58
|
*
|
|
@@ -67,6 +74,7 @@ export class Configuration {
|
|
|
67
74
|
this.password = param.password;
|
|
68
75
|
this.accessToken = param.accessToken;
|
|
69
76
|
this.basePath = param.basePath;
|
|
77
|
+
this.serverIndex = param.serverIndex;
|
|
70
78
|
this.baseOptions = param.baseOptions;
|
|
71
79
|
this.formDataCtor = param.formDataCtor;
|
|
72
80
|
}
|
|
@@ -10,19 +10,19 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
|
-
import type { AxiosPromise, AxiosInstance,
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
16
|
-
import { CreateDestinationRequest } from '../models';
|
|
17
|
-
import { CreateDestinationResponse } from '../models';
|
|
18
|
-
import { CreateSubscriptionRequest } from '../models';
|
|
19
|
-
import { CreateSubscriptionResponse } from '../models';
|
|
20
|
-
import { DeleteDestinationResponse } from '../models';
|
|
21
|
-
import { DeleteSubscriptionByIdResponse } from '../models';
|
|
22
|
-
import { GetDestinationResponse } from '../models';
|
|
23
|
-
import { GetDestinationsResponse } from '../models';
|
|
24
|
-
import { GetSubscriptionByIdResponse } from '../models';
|
|
25
|
-
import { GetSubscriptionResponse } from '../models';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { CreateDestinationRequest } from '../models';
|
|
17
|
+
import type { CreateDestinationResponse } from '../models';
|
|
18
|
+
import type { CreateSubscriptionRequest } from '../models';
|
|
19
|
+
import type { CreateSubscriptionResponse } from '../models';
|
|
20
|
+
import type { DeleteDestinationResponse } from '../models';
|
|
21
|
+
import type { DeleteSubscriptionByIdResponse } from '../models';
|
|
22
|
+
import type { GetDestinationResponse } from '../models';
|
|
23
|
+
import type { GetDestinationsResponse } from '../models';
|
|
24
|
+
import type { GetSubscriptionByIdResponse } from '../models';
|
|
25
|
+
import type { GetSubscriptionResponse } from '../models';
|
|
26
26
|
/**
|
|
27
27
|
* NotificationsApi - axios parameter creator
|
|
28
28
|
* @export
|
|
@@ -34,7 +34,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
34
34
|
* @param {*} [options] Override http request option.
|
|
35
35
|
* @throws {RequiredError}
|
|
36
36
|
*/
|
|
37
|
-
createDestination: (body: CreateDestinationRequest, options?:
|
|
37
|
+
createDestination: (body: CreateDestinationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
38
|
/**
|
|
39
39
|
* 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).
|
|
40
40
|
* @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).
|
|
@@ -42,14 +42,14 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
|
-
createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?:
|
|
45
|
+
createSubscription: (notificationType: string, body: CreateSubscriptionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
47
|
* 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).
|
|
48
48
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
49
49
|
* @param {*} [options] Override http request option.
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
|
-
deleteDestination: (destinationId: string, options?:
|
|
52
|
+
deleteDestination: (destinationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
54
|
* 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).
|
|
55
55
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
@@ -57,20 +57,20 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
57
57
|
* @param {*} [options] Override http request option.
|
|
58
58
|
* @throws {RequiredError}
|
|
59
59
|
*/
|
|
60
|
-
deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?:
|
|
60
|
+
deleteSubscriptionById: (subscriptionId: string, notificationType: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
61
|
/**
|
|
62
62
|
* 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).
|
|
63
63
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
|
-
getDestination: (destinationId: string, options?:
|
|
67
|
+
getDestination: (destinationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
69
|
* 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).
|
|
70
70
|
* @param {*} [options] Override http request option.
|
|
71
71
|
* @throws {RequiredError}
|
|
72
72
|
*/
|
|
73
|
-
getDestinations: (options?:
|
|
73
|
+
getDestinations: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
74
|
/**
|
|
75
75
|
* 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).
|
|
76
76
|
* @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).
|
|
@@ -78,7 +78,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
78
78
|
* @param {*} [options] Override http request option.
|
|
79
79
|
* @throws {RequiredError}
|
|
80
80
|
*/
|
|
81
|
-
getSubscription: (notificationType: string, payloadVersion?: string, options?:
|
|
81
|
+
getSubscription: (notificationType: string, payloadVersion?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
82
82
|
/**
|
|
83
83
|
* 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).
|
|
84
84
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
@@ -86,7 +86,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
|
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
87
87
|
* @throws {RequiredError}
|
|
88
88
|
*/
|
|
89
|
-
getSubscriptionById: (subscriptionId: string, notificationType: string, options?:
|
|
89
|
+
getSubscriptionById: (subscriptionId: string, notificationType: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
90
90
|
};
|
|
91
91
|
/**
|
|
92
92
|
* NotificationsApi - functional programming interface
|
|
@@ -99,7 +99,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
100
100
|
* @throws {RequiredError}
|
|
101
101
|
*/
|
|
102
|
-
createDestination(body: CreateDestinationRequest, options?:
|
|
102
|
+
createDestination(body: CreateDestinationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDestinationResponse>>;
|
|
103
103
|
/**
|
|
104
104
|
* 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).
|
|
105
105
|
* @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).
|
|
@@ -107,14 +107,14 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
108
108
|
* @throws {RequiredError}
|
|
109
109
|
*/
|
|
110
|
-
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?:
|
|
110
|
+
createSubscription(notificationType: string, body: CreateSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSubscriptionResponse>>;
|
|
111
111
|
/**
|
|
112
112
|
* 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).
|
|
113
113
|
* @param {string} destinationId The identifier for the destination that you want to delete.
|
|
114
114
|
* @param {*} [options] Override http request option.
|
|
115
115
|
* @throws {RequiredError}
|
|
116
116
|
*/
|
|
117
|
-
deleteDestination(destinationId: string, options?:
|
|
117
|
+
deleteDestination(destinationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteDestinationResponse>>;
|
|
118
118
|
/**
|
|
119
119
|
* 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).
|
|
120
120
|
* @param {string} subscriptionId The identifier for the subscription that you want to delete.
|
|
@@ -122,20 +122,20 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
125
|
-
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?:
|
|
125
|
+
deleteSubscriptionById(subscriptionId: string, notificationType: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSubscriptionByIdResponse>>;
|
|
126
126
|
/**
|
|
127
127
|
* 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).
|
|
128
128
|
* @param {string} destinationId The identifier generated when you created the destination.
|
|
129
129
|
* @param {*} [options] Override http request option.
|
|
130
130
|
* @throws {RequiredError}
|
|
131
131
|
*/
|
|
132
|
-
getDestination(destinationId: string, options?:
|
|
132
|
+
getDestination(destinationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationResponse>>;
|
|
133
133
|
/**
|
|
134
134
|
* 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).
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
|
-
getDestinations(options?:
|
|
138
|
+
getDestinations(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDestinationsResponse>>;
|
|
139
139
|
/**
|
|
140
140
|
* 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).
|
|
141
141
|
* @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).
|
|
@@ -143,7 +143,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getSubscription(notificationType: string, payloadVersion?: string, options?:
|
|
146
|
+
getSubscription(notificationType: string, payloadVersion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionResponse>>;
|
|
147
147
|
/**
|
|
148
148
|
* 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).
|
|
149
149
|
* @param {string} subscriptionId The identifier for the subscription that you want to get.
|
|
@@ -151,7 +151,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
|
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
152
152
|
* @throws {RequiredError}
|
|
153
153
|
*/
|
|
154
|
-
getSubscriptionById(subscriptionId: string, notificationType: string, options?:
|
|
154
|
+
getSubscriptionById(subscriptionId: string, notificationType: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSubscriptionByIdResponse>>;
|
|
155
155
|
};
|
|
156
156
|
/**
|
|
157
157
|
* NotificationsApi - factory interface
|
|
@@ -164,55 +164,55 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
|
|
|
164
164
|
* @param {*} [options] Override http request option.
|
|
165
165
|
* @throws {RequiredError}
|
|
166
166
|
*/
|
|
167
|
-
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?:
|
|
167
|
+
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateDestinationResponse>;
|
|
168
168
|
/**
|
|
169
169
|
* 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).
|
|
170
170
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
171
171
|
* @param {*} [options] Override http request option.
|
|
172
172
|
* @throws {RequiredError}
|
|
173
173
|
*/
|
|
174
|
-
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?:
|
|
174
|
+
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateSubscriptionResponse>;
|
|
175
175
|
/**
|
|
176
176
|
* 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).
|
|
177
177
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
178
178
|
* @param {*} [options] Override http request option.
|
|
179
179
|
* @throws {RequiredError}
|
|
180
180
|
*/
|
|
181
|
-
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?:
|
|
181
|
+
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteDestinationResponse>;
|
|
182
182
|
/**
|
|
183
183
|
* 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).
|
|
184
184
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
185
185
|
* @param {*} [options] Override http request option.
|
|
186
186
|
* @throws {RequiredError}
|
|
187
187
|
*/
|
|
188
|
-
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?:
|
|
188
|
+
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteSubscriptionByIdResponse>;
|
|
189
189
|
/**
|
|
190
190
|
* 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).
|
|
191
191
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
195
|
-
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?:
|
|
195
|
+
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDestinationResponse>;
|
|
196
196
|
/**
|
|
197
197
|
* 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).
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
201
|
-
getDestinations(options?:
|
|
201
|
+
getDestinations(options?: RawAxiosRequestConfig): AxiosPromise<GetDestinationsResponse>;
|
|
202
202
|
/**
|
|
203
203
|
* 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).
|
|
204
204
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
206
206
|
* @throws {RequiredError}
|
|
207
207
|
*/
|
|
208
|
-
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?:
|
|
208
|
+
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSubscriptionResponse>;
|
|
209
209
|
/**
|
|
210
210
|
* 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).
|
|
211
211
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
213
213
|
* @throws {RequiredError}
|
|
214
214
|
*/
|
|
215
|
-
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?:
|
|
215
|
+
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSubscriptionByIdResponse>;
|
|
216
216
|
};
|
|
217
217
|
/**
|
|
218
218
|
* Request parameters for createDestination operation in NotificationsApi.
|
|
@@ -343,7 +343,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
343
343
|
* @throws {RequiredError}
|
|
344
344
|
* @memberof NotificationsApi
|
|
345
345
|
*/
|
|
346
|
-
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?:
|
|
346
|
+
createDestination(requestParameters: NotificationsApiCreateDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateDestinationResponse, any>>;
|
|
347
347
|
/**
|
|
348
348
|
* 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).
|
|
349
349
|
* @param {NotificationsApiCreateSubscriptionRequest} requestParameters Request parameters.
|
|
@@ -351,7 +351,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
351
351
|
* @throws {RequiredError}
|
|
352
352
|
* @memberof NotificationsApi
|
|
353
353
|
*/
|
|
354
|
-
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?:
|
|
354
|
+
createSubscription(requestParameters: NotificationsApiCreateSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateSubscriptionResponse, any>>;
|
|
355
355
|
/**
|
|
356
356
|
* 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).
|
|
357
357
|
* @param {NotificationsApiDeleteDestinationRequest} requestParameters Request parameters.
|
|
@@ -359,7 +359,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
359
359
|
* @throws {RequiredError}
|
|
360
360
|
* @memberof NotificationsApi
|
|
361
361
|
*/
|
|
362
|
-
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?:
|
|
362
|
+
deleteDestination(requestParameters: NotificationsApiDeleteDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteDestinationResponse, any>>;
|
|
363
363
|
/**
|
|
364
364
|
* 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).
|
|
365
365
|
* @param {NotificationsApiDeleteSubscriptionByIdRequest} requestParameters Request parameters.
|
|
@@ -367,7 +367,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
367
367
|
* @throws {RequiredError}
|
|
368
368
|
* @memberof NotificationsApi
|
|
369
369
|
*/
|
|
370
|
-
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?:
|
|
370
|
+
deleteSubscriptionById(requestParameters: NotificationsApiDeleteSubscriptionByIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<DeleteSubscriptionByIdResponse, any>>;
|
|
371
371
|
/**
|
|
372
372
|
* 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).
|
|
373
373
|
* @param {NotificationsApiGetDestinationRequest} requestParameters Request parameters.
|
|
@@ -375,14 +375,14 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
375
375
|
* @throws {RequiredError}
|
|
376
376
|
* @memberof NotificationsApi
|
|
377
377
|
*/
|
|
378
|
-
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?:
|
|
378
|
+
getDestination(requestParameters: NotificationsApiGetDestinationRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationResponse, any>>;
|
|
379
379
|
/**
|
|
380
380
|
* 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).
|
|
381
381
|
* @param {*} [options] Override http request option.
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
* @memberof NotificationsApi
|
|
384
384
|
*/
|
|
385
|
-
getDestinations(options?:
|
|
385
|
+
getDestinations(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetDestinationsResponse, any>>;
|
|
386
386
|
/**
|
|
387
387
|
* 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).
|
|
388
388
|
* @param {NotificationsApiGetSubscriptionRequest} requestParameters Request parameters.
|
|
@@ -390,7 +390,7 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
390
390
|
* @throws {RequiredError}
|
|
391
391
|
* @memberof NotificationsApi
|
|
392
392
|
*/
|
|
393
|
-
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?:
|
|
393
|
+
getSubscription(requestParameters: NotificationsApiGetSubscriptionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionResponse, any>>;
|
|
394
394
|
/**
|
|
395
395
|
* 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).
|
|
396
396
|
* @param {NotificationsApiGetSubscriptionByIdRequest} requestParameters Request parameters.
|
|
@@ -398,5 +398,5 @@ export declare class NotificationsApi extends BaseAPI {
|
|
|
398
398
|
* @throws {RequiredError}
|
|
399
399
|
* @memberof NotificationsApi
|
|
400
400
|
*/
|
|
401
|
-
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?:
|
|
401
|
+
getSubscriptionById(requestParameters: NotificationsApiGetSubscriptionByIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetSubscriptionByIdResponse, any>>;
|
|
402
402
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
|
-
import type { AxiosInstance,
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
|
|
|
29
29
|
*/
|
|
30
30
|
export interface RequestArgs {
|
|
31
31
|
url: string;
|
|
32
|
-
options:
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
@@ -52,3 +52,15 @@ export declare class RequiredError extends Error {
|
|
|
52
52
|
field: string;
|
|
53
53
|
constructor(field: string, msg?: string);
|
|
54
54
|
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
|
@@ -15,6 +15,7 @@ export interface ConfigurationParameters {
|
|
|
15
15
|
password?: string;
|
|
16
16
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
17
|
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
18
19
|
baseOptions?: any;
|
|
19
20
|
formDataCtor?: new () => any;
|
|
20
21
|
}
|
|
@@ -53,6 +54,13 @@ export declare class Configuration {
|
|
|
53
54
|
* @memberof Configuration
|
|
54
55
|
*/
|
|
55
56
|
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
56
64
|
/**
|
|
57
65
|
* base options for axios calls
|
|
58
66
|
*
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { AggregationSettings } from './aggregation-settings';
|
|
12
|
+
import type { AggregationSettings } from './aggregation-settings';
|
|
13
13
|
/**
|
|
14
14
|
* 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).
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { AggregationTimePeriod } from './aggregation-time-period';
|
|
12
|
+
import type { AggregationTimePeriod } from './aggregation-time-period';
|
|
13
13
|
/**
|
|
14
14
|
* A container that holds all of the necessary properties to configure the aggregation of notifications.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { DestinationResourceSpecification } from './destination-resource-specification';
|
|
12
|
+
import type { DestinationResourceSpecification } from './destination-resource-specification';
|
|
13
13
|
/**
|
|
14
14
|
* The request schema for the `createDestination` operation.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { ProcessingDirective } from './processing-directive';
|
|
12
|
+
import type { ProcessingDirective } from './processing-directive';
|
|
13
13
|
/**
|
|
14
14
|
* The request schema for the `createSubscription` operation.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Subscription } from './subscription';
|
|
12
|
+
import type { Subscription } from './subscription';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the `createSubscription` operation.
|
|
15
15
|
* @export
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { EventBridgeResourceSpecification } from './event-bridge-resource-specification';
|
|
13
|
-
import { SqsResource } from './sqs-resource';
|
|
12
|
+
import type { EventBridgeResourceSpecification } from './event-bridge-resource-specification';
|
|
13
|
+
import type { SqsResource } from './sqs-resource';
|
|
14
14
|
/**
|
|
15
15
|
* The information required to create a destination resource. Applications should use one resource type (sqs or eventBridge) per destination.
|
|
16
16
|
* @export
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { EventBridgeResource } from './event-bridge-resource';
|
|
13
|
-
import { SqsResource } from './sqs-resource';
|
|
12
|
+
import type { EventBridgeResource } from './event-bridge-resource';
|
|
13
|
+
import type { SqsResource } from './sqs-resource';
|
|
14
14
|
/**
|
|
15
15
|
* The destination resource types.
|
|
16
16
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { DestinationResource } from './destination-resource';
|
|
12
|
+
import type { DestinationResource } from './destination-resource';
|
|
13
13
|
/**
|
|
14
14
|
* Information about the destination created when you call the `createDestination` operation.
|
|
15
15
|
* @export
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { AggregationFilter } from './aggregation-filter';
|
|
13
|
-
import { EventFilterAllOf } from './event-filter-all-of';
|
|
14
|
-
import { MarketplaceFilter } from './marketplace-filter';
|
|
15
|
-
import { OrderChangeTypeFilter } from './order-change-type-filter';
|
|
12
|
+
import type { AggregationFilter } from './aggregation-filter';
|
|
13
|
+
import type { EventFilterAllOf } from './event-filter-all-of';
|
|
14
|
+
import type { MarketplaceFilter } from './marketplace-filter';
|
|
15
|
+
import type { OrderChangeTypeFilter } from './order-change-type-filter';
|
|
16
16
|
/**
|
|
17
17
|
* @type EventFilter
|
|
18
18
|
* A `notificationType` specific filter. This object contains all of the currently available filters and properties that you can use to define a `notificationType` specific filter.
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Subscription } from './subscription';
|
|
12
|
+
import type { Subscription } from './subscription';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the `getSubscriptionById` operation.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Subscription } from './subscription';
|
|
12
|
+
import type { Subscription } from './subscription';
|
|
13
13
|
/**
|
|
14
14
|
* The response schema for the `getSubscription` operation.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { OrderChangeTypeEnum } from './order-change-type-enum';
|
|
12
|
+
import type { OrderChangeTypeEnum } from './order-change-type-enum';
|
|
13
13
|
/**
|
|
14
14
|
* An event filter to customize your subscription to send notifications for only the specified `orderChangeType`.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { EventFilter } from './event-filter';
|
|
12
|
+
import type { EventFilter } from './event-filter';
|
|
13
13
|
/**
|
|
14
14
|
* Additional information passed to the subscription to control the processing of notifications. For example, you can use an `eventFilter` to customize your subscription to send notifications for only the specified `marketplaceId`s, or select the aggregation time period at which to send notifications (for example: limit to one notification every five minutes for high frequency notifications). The specific features available vary depending on the `notificationType`. This feature is currently only supported by the `ANY_OFFER_CHANGED` and `ORDER_CHANGE` `notificationType`s.
|
|
15
15
|
* @export
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { ProcessingDirective } from './processing-directive';
|
|
12
|
+
import type { ProcessingDirective } from './processing-directive';
|
|
13
13
|
/**
|
|
14
14
|
* Information about the subscription.
|
|
15
15
|
* @export
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/notifications-api-v1",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Notifications lets you subscribe to notifications that are relevant to a selling partner's business. Using this API you can create a destination to receive notifications, subscribe to notifications, delete notification subscriptions, and more. For more information, refer to the Notifications Use Case Guide.",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.3.1",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.0.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.0.9",
|
|
22
|
+
"axios": "^1.7.2"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"notifications api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "cce8c720364baf071322463e8e3ed29c322cc93a"
|
|
44
44
|
}
|