@sp-api-sdk/application-integrations-api-2024-04-01 4.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -4
- package/dist/index.cjs +417 -427
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +262 -265
- package/dist/index.d.ts +262 -265
- package/dist/index.js +392 -389
- package/dist/index.js.map +1 -1
- package/package.json +7 -4
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { ClientConfiguration, RateLimit } from
|
|
2
|
-
import
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common";
|
|
2
|
+
import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios";
|
|
3
|
+
//#region src/api-model/configuration.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* The Selling Partner API for third party application integrations.
|
|
7
6
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -14,115 +13,105 @@ import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise } from 'axios';
|
|
|
14
13
|
* Do not edit the class manually.
|
|
15
14
|
*/
|
|
16
15
|
interface AWSv4Configuration {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
options?: {
|
|
17
|
+
region?: string;
|
|
18
|
+
service?: string;
|
|
19
|
+
};
|
|
20
|
+
credentials?: {
|
|
21
|
+
accessKeyId?: string;
|
|
22
|
+
secretAccessKey?: string;
|
|
23
|
+
sessionToken?: string;
|
|
24
|
+
};
|
|
26
25
|
}
|
|
27
26
|
interface ConfigurationParameters {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
27
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
28
|
+
username?: string;
|
|
29
|
+
password?: string;
|
|
30
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
31
|
+
awsv4?: AWSv4Configuration;
|
|
32
|
+
basePath?: string;
|
|
33
|
+
serverIndex?: number;
|
|
34
|
+
baseOptions?: any;
|
|
35
|
+
formDataCtor?: new () => any;
|
|
37
36
|
}
|
|
38
37
|
declare class Configuration {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
38
|
+
/**
|
|
39
|
+
* parameter for apiKey security
|
|
40
|
+
* @param name security name
|
|
41
|
+
*/
|
|
42
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
43
|
+
/**
|
|
44
|
+
* parameter for basic security
|
|
45
|
+
*/
|
|
46
|
+
username?: string;
|
|
47
|
+
/**
|
|
48
|
+
* parameter for basic security
|
|
49
|
+
*/
|
|
50
|
+
password?: string;
|
|
51
|
+
/**
|
|
52
|
+
* parameter for oauth2 security
|
|
53
|
+
* @param name security name
|
|
54
|
+
* @param scopes oauth2 scope
|
|
55
|
+
*/
|
|
56
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
57
|
+
/**
|
|
58
|
+
* parameter for aws4 signature security
|
|
59
|
+
* @param {Object} AWS4Signature - AWS4 Signature security
|
|
60
|
+
* @param {string} options.region - aws region
|
|
61
|
+
* @param {string} options.service - name of the service.
|
|
62
|
+
* @param {string} credentials.accessKeyId - aws access key id
|
|
63
|
+
* @param {string} credentials.secretAccessKey - aws access key
|
|
64
|
+
* @param {string} credentials.sessionToken - aws session token
|
|
65
|
+
* @memberof Configuration
|
|
66
|
+
*/
|
|
67
|
+
awsv4?: AWSv4Configuration;
|
|
68
|
+
/**
|
|
69
|
+
* override base path
|
|
70
|
+
*/
|
|
71
|
+
basePath?: string;
|
|
72
|
+
/**
|
|
73
|
+
* override server index
|
|
74
|
+
*/
|
|
75
|
+
serverIndex?: number;
|
|
76
|
+
/**
|
|
77
|
+
* base options for axios calls
|
|
78
|
+
*/
|
|
79
|
+
baseOptions?: any;
|
|
80
|
+
/**
|
|
81
|
+
* The FormData constructor that will be used to create multipart form data
|
|
82
|
+
* requests. You can inject this here so that execution environments that
|
|
83
|
+
* do not support the FormData class can still run the generated client.
|
|
84
|
+
*
|
|
85
|
+
* @type {new () => FormData}
|
|
86
|
+
*/
|
|
87
|
+
formDataCtor?: new () => any;
|
|
88
|
+
constructor(param?: ConfigurationParameters);
|
|
89
|
+
/**
|
|
90
|
+
* Check if the given MIME is a JSON MIME.
|
|
91
|
+
* JSON MIME examples:
|
|
92
|
+
* application/json
|
|
93
|
+
* application/json; charset=UTF8
|
|
94
|
+
* APPLICATION/JSON
|
|
95
|
+
* application/vnd.company+json
|
|
96
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
97
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
98
|
+
*/
|
|
99
|
+
isJsonMime(mime: string): boolean;
|
|
101
100
|
}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* The Selling Partner API for third party application integrations.
|
|
105
|
-
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2024-04-01
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
111
|
-
* https://openapi-generator.tech
|
|
112
|
-
* Do not edit the class manually.
|
|
113
|
-
*/
|
|
114
|
-
|
|
101
|
+
//#endregion
|
|
102
|
+
//#region src/api-model/base.d.ts
|
|
115
103
|
interface RequestArgs {
|
|
116
|
-
|
|
117
|
-
|
|
104
|
+
url: string;
|
|
105
|
+
options: RawAxiosRequestConfig;
|
|
118
106
|
}
|
|
119
107
|
declare class BaseAPI {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
108
|
+
protected basePath: string;
|
|
109
|
+
protected axios: AxiosInstance;
|
|
110
|
+
protected configuration: Configuration | undefined;
|
|
111
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
124
112
|
}
|
|
125
|
-
|
|
113
|
+
//#endregion
|
|
114
|
+
//#region src/api-model/models/create-notification-request.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* The Selling Partner API for third party application integrations.
|
|
128
117
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -138,22 +127,23 @@ declare class BaseAPI {
|
|
|
138
127
|
* The request for the `createNotification` operation.
|
|
139
128
|
*/
|
|
140
129
|
interface CreateNotificationRequest {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The unique identifier of the notification template you used to onboard your application.
|
|
132
|
+
*/
|
|
133
|
+
'templateId': string;
|
|
134
|
+
/**
|
|
135
|
+
* The dynamic parameters required by the notification templated specified by `templateId`.
|
|
136
|
+
*/
|
|
137
|
+
'notificationParameters': {
|
|
138
|
+
[key: string]: object;
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* An encrypted marketplace identifier for the posted notification.
|
|
142
|
+
*/
|
|
143
|
+
'marketplaceId'?: string;
|
|
155
144
|
}
|
|
156
|
-
|
|
145
|
+
//#endregion
|
|
146
|
+
//#region src/api-model/models/create-notification-response.d.ts
|
|
157
147
|
/**
|
|
158
148
|
* The Selling Partner API for third party application integrations.
|
|
159
149
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -169,12 +159,13 @@ interface CreateNotificationRequest {
|
|
|
169
159
|
* The response for the `createNotification` operation.
|
|
170
160
|
*/
|
|
171
161
|
interface CreateNotificationResponse {
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
162
|
+
/**
|
|
163
|
+
* The unique identifier assigned to each notification.
|
|
164
|
+
*/
|
|
165
|
+
'notificationId'?: string;
|
|
176
166
|
}
|
|
177
|
-
|
|
167
|
+
//#endregion
|
|
168
|
+
//#region src/api-model/models/delete-notifications-request.d.ts
|
|
178
169
|
/**
|
|
179
170
|
* The Selling Partner API for third party application integrations.
|
|
180
171
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -190,21 +181,22 @@ interface CreateNotificationResponse {
|
|
|
190
181
|
* The request for the `deleteNotifications` operation.
|
|
191
182
|
*/
|
|
192
183
|
interface DeleteNotificationsRequest {
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
184
|
+
/**
|
|
185
|
+
* The unique identifier of the notification template you used to onboard your application.
|
|
186
|
+
*/
|
|
187
|
+
'templateId': string;
|
|
188
|
+
/**
|
|
189
|
+
* The unique identifier that maps each notification status to a reason code.
|
|
190
|
+
*/
|
|
191
|
+
'deletionReason': DeleteNotificationsRequestDeletionReasonEnum;
|
|
201
192
|
}
|
|
202
193
|
declare const DeleteNotificationsRequestDeletionReasonEnum: {
|
|
203
|
-
|
|
204
|
-
|
|
194
|
+
readonly IncorrectContent: "INCORRECT_CONTENT";
|
|
195
|
+
readonly IncorrectRecipient: "INCORRECT_RECIPIENT";
|
|
205
196
|
};
|
|
206
197
|
type DeleteNotificationsRequestDeletionReasonEnum = typeof DeleteNotificationsRequestDeletionReasonEnum[keyof typeof DeleteNotificationsRequestDeletionReasonEnum];
|
|
207
|
-
|
|
198
|
+
//#endregion
|
|
199
|
+
//#region src/api-model/models/error-list.d.ts
|
|
208
200
|
/**
|
|
209
201
|
* The Selling Partner API for third party application integrations.
|
|
210
202
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -220,12 +212,13 @@ type DeleteNotificationsRequestDeletionReasonEnum = typeof DeleteNotificationsRe
|
|
|
220
212
|
* A list of error responses returned when a request is unsuccessful.
|
|
221
213
|
*/
|
|
222
214
|
interface ErrorList {
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
215
|
+
/**
|
|
216
|
+
* Error response returned when the request is unsuccessful.
|
|
217
|
+
*/
|
|
218
|
+
'errors': Array<Error>;
|
|
227
219
|
}
|
|
228
|
-
|
|
220
|
+
//#endregion
|
|
221
|
+
//#region src/api-model/models/model-error.d.ts
|
|
229
222
|
/**
|
|
230
223
|
* The Selling Partner API for third party application integrations.
|
|
231
224
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -241,20 +234,21 @@ interface ErrorList {
|
|
|
241
234
|
* Error response returned when the request is unsuccessful.
|
|
242
235
|
*/
|
|
243
236
|
interface ModelError {
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
237
|
+
/**
|
|
238
|
+
* An error code that identifies the type of error that occurred.
|
|
239
|
+
*/
|
|
240
|
+
'code': string;
|
|
241
|
+
/**
|
|
242
|
+
* A message that describes the error condition.
|
|
243
|
+
*/
|
|
244
|
+
'message': string;
|
|
245
|
+
/**
|
|
246
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
247
|
+
*/
|
|
248
|
+
'details'?: string;
|
|
256
249
|
}
|
|
257
|
-
|
|
250
|
+
//#endregion
|
|
251
|
+
//#region src/api-model/models/record-action-feedback-request.d.ts
|
|
258
252
|
/**
|
|
259
253
|
* The Selling Partner API for third party application integrations.
|
|
260
254
|
* With the AppIntegrations API v2024-04-01, you can send notifications to Amazon Selling Partners and display the notifications in Seller Central.
|
|
@@ -270,157 +264,160 @@ interface ModelError {
|
|
|
270
264
|
* The request for the `recordActionFeedback` operation.
|
|
271
265
|
*/
|
|
272
266
|
interface RecordActionFeedbackRequest {
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
267
|
+
/**
|
|
268
|
+
* The unique identifier for each notification status.
|
|
269
|
+
*/
|
|
270
|
+
'feedbackActionCode': RecordActionFeedbackRequestFeedbackActionCodeEnum;
|
|
277
271
|
}
|
|
278
272
|
declare const RecordActionFeedbackRequestFeedbackActionCodeEnum: {
|
|
279
|
-
|
|
273
|
+
readonly SellerActionCompleted: "SELLER_ACTION_COMPLETED";
|
|
280
274
|
};
|
|
281
275
|
type RecordActionFeedbackRequestFeedbackActionCodeEnum = typeof RecordActionFeedbackRequestFeedbackActionCodeEnum[keyof typeof RecordActionFeedbackRequestFeedbackActionCodeEnum];
|
|
282
|
-
|
|
276
|
+
//#endregion
|
|
277
|
+
//#region src/api-model/api/application-integrations-api.d.ts
|
|
283
278
|
/**
|
|
284
279
|
* ApplicationIntegrationsApi - axios parameter creator
|
|
285
280
|
*/
|
|
286
281
|
declare const ApplicationIntegrationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
282
|
+
/**
|
|
283
|
+
* Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
284
|
+
* @param {CreateNotificationRequest} body The request body for the `createNotification` operation.
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
createNotification: (body: CreateNotificationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
289
|
+
/**
|
|
290
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
291
|
+
* @param {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation.
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
deleteNotifications: (body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
296
|
+
/**
|
|
297
|
+
* Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
298
|
+
* @param {string} notificationId A `notificationId` uniquely identifies a notification.
|
|
299
|
+
* @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation.
|
|
300
|
+
* @param {*} [options] Override http request option.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
*/
|
|
303
|
+
recordActionFeedback: (notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
309
304
|
};
|
|
310
305
|
/**
|
|
311
306
|
* ApplicationIntegrationsApi - functional programming interface
|
|
312
307
|
*/
|
|
313
308
|
declare const ApplicationIntegrationsApiFp: (configuration?: Configuration) => {
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
309
|
+
/**
|
|
310
|
+
* Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
311
|
+
* @param {CreateNotificationRequest} body The request body for the `createNotification` operation.
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
createNotification(body: CreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNotificationResponse>>;
|
|
316
|
+
/**
|
|
317
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
318
|
+
* @param {DeleteNotificationsRequest} body The request body for the `deleteNotifications` operation.
|
|
319
|
+
* @param {*} [options] Override http request option.
|
|
320
|
+
* @throws {RequiredError}
|
|
321
|
+
*/
|
|
322
|
+
deleteNotifications(body: DeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
323
|
+
/**
|
|
324
|
+
* Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
325
|
+
* @param {string} notificationId A `notificationId` uniquely identifies a notification.
|
|
326
|
+
* @param {RecordActionFeedbackRequest} body The request body for the `recordActionFeedback` operation.
|
|
327
|
+
* @param {*} [options] Override http request option.
|
|
328
|
+
* @throws {RequiredError}
|
|
329
|
+
*/
|
|
330
|
+
recordActionFeedback(notificationId: string, body: RecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
336
331
|
};
|
|
337
332
|
/**
|
|
338
333
|
* ApplicationIntegrationsApi - factory interface
|
|
339
334
|
*/
|
|
340
335
|
declare const ApplicationIntegrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
336
|
+
/**
|
|
337
|
+
* Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
338
|
+
* @param {ApplicationIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
|
|
339
|
+
* @param {*} [options] Override http request option.
|
|
340
|
+
* @throws {RequiredError}
|
|
341
|
+
*/
|
|
342
|
+
createNotification(requestParameters: ApplicationIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateNotificationResponse>;
|
|
343
|
+
/**
|
|
344
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
345
|
+
* @param {ApplicationIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
|
|
346
|
+
* @param {*} [options] Override http request option.
|
|
347
|
+
* @throws {RequiredError}
|
|
348
|
+
*/
|
|
349
|
+
deleteNotifications(requestParameters: ApplicationIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
350
|
+
/**
|
|
351
|
+
* Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
352
|
+
* @param {ApplicationIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
*/
|
|
356
|
+
recordActionFeedback(requestParameters: ApplicationIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
362
357
|
};
|
|
363
358
|
/**
|
|
364
359
|
* Request parameters for createNotification operation in ApplicationIntegrationsApi.
|
|
365
360
|
*/
|
|
366
361
|
interface ApplicationIntegrationsApiCreateNotificationRequest {
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
362
|
+
/**
|
|
363
|
+
* The request body for the `createNotification` operation.
|
|
364
|
+
*/
|
|
365
|
+
readonly body: CreateNotificationRequest;
|
|
371
366
|
}
|
|
372
367
|
/**
|
|
373
368
|
* Request parameters for deleteNotifications operation in ApplicationIntegrationsApi.
|
|
374
369
|
*/
|
|
375
370
|
interface ApplicationIntegrationsApiDeleteNotificationsRequest {
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
371
|
+
/**
|
|
372
|
+
* The request body for the `deleteNotifications` operation.
|
|
373
|
+
*/
|
|
374
|
+
readonly body: DeleteNotificationsRequest;
|
|
380
375
|
}
|
|
381
376
|
/**
|
|
382
377
|
* Request parameters for recordActionFeedback operation in ApplicationIntegrationsApi.
|
|
383
378
|
*/
|
|
384
379
|
interface ApplicationIntegrationsApiRecordActionFeedbackRequest {
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
380
|
+
/**
|
|
381
|
+
* A `notificationId` uniquely identifies a notification.
|
|
382
|
+
*/
|
|
383
|
+
readonly notificationId: string;
|
|
384
|
+
/**
|
|
385
|
+
* The request body for the `recordActionFeedback` operation.
|
|
386
|
+
*/
|
|
387
|
+
readonly body: RecordActionFeedbackRequest;
|
|
393
388
|
}
|
|
394
389
|
/**
|
|
395
390
|
* ApplicationIntegrationsApi - object-oriented interface
|
|
396
391
|
*/
|
|
397
392
|
declare class ApplicationIntegrationsApi extends BaseAPI {
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
393
|
+
/**
|
|
394
|
+
* Create a notification for sellers in Seller Central. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
395
|
+
* @param {ApplicationIntegrationsApiCreateNotificationRequest} requestParameters Request parameters.
|
|
396
|
+
* @param {*} [options] Override http request option.
|
|
397
|
+
* @throws {RequiredError}
|
|
398
|
+
*/
|
|
399
|
+
createNotification(requestParameters: ApplicationIntegrationsApiCreateNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateNotificationResponse, any, {}>>;
|
|
400
|
+
/**
|
|
401
|
+
* Remove your application\'s notifications from the Appstore notifications dashboard. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
402
|
+
* @param {ApplicationIntegrationsApiDeleteNotificationsRequest} requestParameters Request parameters.
|
|
403
|
+
* @param {*} [options] Override http request option.
|
|
404
|
+
* @throws {RequiredError}
|
|
405
|
+
*/
|
|
406
|
+
deleteNotifications(requestParameters: ApplicationIntegrationsApiDeleteNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
407
|
+
/**
|
|
408
|
+
* Records the seller\'s response to a notification. **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 preceding table indicates the default rate and burst values for this operation. Sellers whose business demands require higher throughput may have 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).
|
|
409
|
+
* @param {ApplicationIntegrationsApiRecordActionFeedbackRequest} requestParameters Request parameters.
|
|
410
|
+
* @param {*} [options] Override http request option.
|
|
411
|
+
* @throws {RequiredError}
|
|
412
|
+
*/
|
|
413
|
+
recordActionFeedback(requestParameters: ApplicationIntegrationsApiRecordActionFeedbackRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
419
414
|
}
|
|
420
|
-
|
|
415
|
+
//#endregion
|
|
416
|
+
//#region src/client.d.ts
|
|
421
417
|
declare const clientRateLimits: RateLimit[];
|
|
422
418
|
declare class ApplicationIntegrationsApiClient extends ApplicationIntegrationsApi {
|
|
423
|
-
|
|
419
|
+
constructor(configuration: ClientConfiguration);
|
|
424
420
|
}
|
|
425
|
-
|
|
426
|
-
export { ApplicationIntegrationsApi, ApplicationIntegrationsApiAxiosParamCreator, ApplicationIntegrationsApiClient,
|
|
421
|
+
//#endregion
|
|
422
|
+
export { ApplicationIntegrationsApi, ApplicationIntegrationsApiAxiosParamCreator, ApplicationIntegrationsApiClient, ApplicationIntegrationsApiCreateNotificationRequest, ApplicationIntegrationsApiDeleteNotificationsRequest, ApplicationIntegrationsApiFactory, ApplicationIntegrationsApiFp, ApplicationIntegrationsApiRecordActionFeedbackRequest, CreateNotificationRequest, CreateNotificationResponse, DeleteNotificationsRequest, DeleteNotificationsRequestDeletionReasonEnum, ErrorList, ModelError, RecordActionFeedbackRequest, RecordActionFeedbackRequestFeedbackActionCodeEnum, clientRateLimits };
|
|
423
|
+
//# sourceMappingURL=index.d.ts.map
|