@sp-api-sdk/finances-api-2024-06-19 4.0.0 → 4.1.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/README.md +3 -4
- package/dist/index.cjs +280 -322
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +421 -482
- package/dist/index.d.ts +421 -482
- package/dist/index.js +254 -283
- package/dist/index.js.map +1 -1
- package/package.json +14 -6
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 Finances
|
|
7
6
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -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 Finances
|
|
105
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
106
|
-
*
|
|
107
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
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/amazon-pay-context.d.ts
|
|
126
115
|
/**
|
|
127
116
|
* The Selling Partner API for Finances
|
|
128
117
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -138,20 +127,21 @@ declare class BaseAPI {
|
|
|
138
127
|
* Additional information related to Amazon Pay.
|
|
139
128
|
*/
|
|
140
129
|
interface AmazonPayContext {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
130
|
+
/**
|
|
131
|
+
* The name of the store that is related to the transaction.
|
|
132
|
+
*/
|
|
133
|
+
'storeName'?: string;
|
|
134
|
+
/**
|
|
135
|
+
* The transaction\'s order type.
|
|
136
|
+
*/
|
|
137
|
+
'orderType'?: string;
|
|
138
|
+
/**
|
|
139
|
+
* Channel details of related transaction.
|
|
140
|
+
*/
|
|
141
|
+
'channel'?: string;
|
|
153
142
|
}
|
|
154
|
-
|
|
143
|
+
//#endregion
|
|
144
|
+
//#region src/api-model/models/currency.d.ts
|
|
155
145
|
/**
|
|
156
146
|
* The Selling Partner API for Finances
|
|
157
147
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -167,43 +157,33 @@ interface AmazonPayContext {
|
|
|
167
157
|
* A currency type and amount.
|
|
168
158
|
*/
|
|
169
159
|
interface Currency {
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
160
|
+
/**
|
|
161
|
+
* The three-digit currency code in ISO 4217 format.
|
|
162
|
+
*/
|
|
163
|
+
'currencyCode'?: string;
|
|
164
|
+
/**
|
|
165
|
+
* A signed decimal number.
|
|
166
|
+
*/
|
|
167
|
+
'currencyAmount'?: number;
|
|
178
168
|
}
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
* The Selling Partner API for Finances
|
|
182
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
183
|
-
*
|
|
184
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
188
|
-
* https://openapi-generator.tech
|
|
189
|
-
* Do not edit the class manually.
|
|
190
|
-
*/
|
|
191
|
-
|
|
169
|
+
//#endregion
|
|
170
|
+
//#region src/api-model/models/breakdown.d.ts
|
|
192
171
|
/**
|
|
193
172
|
* Details about the movement of money in the financial transaction. Breakdowns are further categorized into breakdown types, breakdown amounts, and further breakdowns.
|
|
194
173
|
*/
|
|
195
174
|
interface Breakdown {
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
175
|
+
/**
|
|
176
|
+
* The type of charge.
|
|
177
|
+
*/
|
|
178
|
+
'breakdownType'?: string;
|
|
179
|
+
'breakdownAmount'?: Currency;
|
|
180
|
+
/**
|
|
181
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
182
|
+
*/
|
|
183
|
+
'breakdowns'?: Array<Breakdown>;
|
|
205
184
|
}
|
|
206
|
-
|
|
185
|
+
//#endregion
|
|
186
|
+
//#region src/api-model/models/business-context.d.ts
|
|
207
187
|
/**
|
|
208
188
|
* The Selling Partner API for Finances
|
|
209
189
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -219,16 +199,17 @@ interface Breakdown {
|
|
|
219
199
|
* Information about the line of business associated with a transaction.
|
|
220
200
|
*/
|
|
221
201
|
interface BusinessContext {
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
202
|
+
/**
|
|
203
|
+
* The store name associated with the transaction.
|
|
204
|
+
*/
|
|
205
|
+
'storeName'?: BusinessContextStoreNameEnum;
|
|
226
206
|
}
|
|
227
207
|
declare const BusinessContextStoreNameEnum: {
|
|
228
|
-
|
|
208
|
+
readonly AmazonHaul: "AMAZON_HAUL";
|
|
229
209
|
};
|
|
230
210
|
type BusinessContextStoreNameEnum = typeof BusinessContextStoreNameEnum[keyof typeof BusinessContextStoreNameEnum];
|
|
231
|
-
|
|
211
|
+
//#endregion
|
|
212
|
+
//#region src/api-model/models/context-all-of.d.ts
|
|
232
213
|
/**
|
|
233
214
|
* The Selling Partner API for Finances
|
|
234
215
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -241,9 +222,10 @@ type BusinessContextStoreNameEnum = typeof BusinessContextStoreNameEnum[keyof ty
|
|
|
241
222
|
* Do not edit the class manually.
|
|
242
223
|
*/
|
|
243
224
|
interface ContextAllOf {
|
|
244
|
-
|
|
225
|
+
'contextType': string;
|
|
245
226
|
}
|
|
246
|
-
|
|
227
|
+
//#endregion
|
|
228
|
+
//#region src/api-model/models/deferred-context.d.ts
|
|
247
229
|
/**
|
|
248
230
|
* The Selling Partner API for Finances
|
|
249
231
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -259,16 +241,17 @@ interface ContextAllOf {
|
|
|
259
241
|
* Additional information related to deferred transactions.
|
|
260
242
|
*/
|
|
261
243
|
interface DeferredContext {
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
244
|
+
/**
|
|
245
|
+
* The deferral policy applied to the transaction. **Examples:** `B2B` (invoiced orders), `DD7` (delivery date policy)
|
|
246
|
+
*/
|
|
247
|
+
'deferralReason'?: string;
|
|
248
|
+
/**
|
|
249
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
250
|
+
*/
|
|
251
|
+
'maturityDate'?: string;
|
|
270
252
|
}
|
|
271
|
-
|
|
253
|
+
//#endregion
|
|
254
|
+
//#region src/api-model/models/payments-context.d.ts
|
|
272
255
|
/**
|
|
273
256
|
* The Selling Partner API for Finances
|
|
274
257
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -284,24 +267,25 @@ interface DeferredContext {
|
|
|
284
267
|
* Additional information related to payments-related transactions.
|
|
285
268
|
*/
|
|
286
269
|
interface PaymentsContext {
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
270
|
+
/**
|
|
271
|
+
* The type of payment.
|
|
272
|
+
*/
|
|
273
|
+
'paymentType'?: string;
|
|
274
|
+
/**
|
|
275
|
+
* The method of payment.
|
|
276
|
+
*/
|
|
277
|
+
'paymentMethod'?: string;
|
|
278
|
+
/**
|
|
279
|
+
* The reference number of the payment.
|
|
280
|
+
*/
|
|
281
|
+
'paymentReference'?: string;
|
|
282
|
+
/**
|
|
283
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
284
|
+
*/
|
|
285
|
+
'paymentDate'?: string;
|
|
303
286
|
}
|
|
304
|
-
|
|
287
|
+
//#endregion
|
|
288
|
+
//#region src/api-model/models/product-context.d.ts
|
|
305
289
|
/**
|
|
306
290
|
* The Selling Partner API for Finances
|
|
307
291
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -317,24 +301,25 @@ interface PaymentsContext {
|
|
|
317
301
|
* Additional information related to the product.
|
|
318
302
|
*/
|
|
319
303
|
interface ProductContext {
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
304
|
+
/**
|
|
305
|
+
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
306
|
+
*/
|
|
307
|
+
'asin'?: string;
|
|
308
|
+
/**
|
|
309
|
+
* The Stock Keeping Unit (SKU) of the item.
|
|
310
|
+
*/
|
|
311
|
+
'sku'?: string;
|
|
312
|
+
/**
|
|
313
|
+
* The quantity of the item shipped.
|
|
314
|
+
*/
|
|
315
|
+
'quantityShipped'?: number;
|
|
316
|
+
/**
|
|
317
|
+
* The fulfillment network of the item.
|
|
318
|
+
*/
|
|
319
|
+
'fulfillmentNetwork'?: string;
|
|
336
320
|
}
|
|
337
|
-
|
|
321
|
+
//#endregion
|
|
322
|
+
//#region src/api-model/models/time-range-context.d.ts
|
|
338
323
|
/**
|
|
339
324
|
* The Selling Partner API for Finances
|
|
340
325
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -350,34 +335,24 @@ interface ProductContext {
|
|
|
350
335
|
* Additional information that is related to the time range of the transaction.
|
|
351
336
|
*/
|
|
352
337
|
interface TimeRangeContext {
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
338
|
+
/**
|
|
339
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
340
|
+
*/
|
|
341
|
+
'startTime'?: string;
|
|
342
|
+
/**
|
|
343
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
344
|
+
*/
|
|
345
|
+
'endTime'?: string;
|
|
361
346
|
}
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
* The Selling Partner API for Finances
|
|
365
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
366
|
-
*
|
|
367
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
368
|
-
*
|
|
369
|
-
*
|
|
370
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
371
|
-
* https://openapi-generator.tech
|
|
372
|
-
* Do not edit the class manually.
|
|
373
|
-
*/
|
|
374
|
-
|
|
347
|
+
//#endregion
|
|
348
|
+
//#region src/api-model/models/context.d.ts
|
|
375
349
|
/**
|
|
376
350
|
* @type Context
|
|
377
351
|
* Additional Information about the item.
|
|
378
352
|
*/
|
|
379
353
|
type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredContext & PaymentsContext & ProductContext & TimeRangeContext;
|
|
380
|
-
|
|
354
|
+
//#endregion
|
|
355
|
+
//#region src/api-model/models/error-list.d.ts
|
|
381
356
|
/**
|
|
382
357
|
* The Selling Partner API for Finances
|
|
383
358
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -393,12 +368,13 @@ type Context = AmazonPayContext & BusinessContext & ContextAllOf & DeferredConte
|
|
|
393
368
|
* A list of error responses returned when a request is unsuccessful.
|
|
394
369
|
*/
|
|
395
370
|
interface ErrorList {
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
371
|
+
/**
|
|
372
|
+
* The error responses that are returned when the request is unsuccessful.
|
|
373
|
+
*/
|
|
374
|
+
'errors': Array<Error>;
|
|
400
375
|
}
|
|
401
|
-
|
|
376
|
+
//#endregion
|
|
377
|
+
//#region src/api-model/models/item-related-identifier.d.ts
|
|
402
378
|
/**
|
|
403
379
|
* The Selling Partner API for Finances
|
|
404
380
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -414,58 +390,48 @@ interface ErrorList {
|
|
|
414
390
|
* Related business identifiers of the item.
|
|
415
391
|
*/
|
|
416
392
|
interface ItemRelatedIdentifier {
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
393
|
+
/**
|
|
394
|
+
* Enumerated set of related item identifier names for the item.
|
|
395
|
+
*/
|
|
396
|
+
'itemRelatedIdentifierName'?: ItemRelatedIdentifierItemRelatedIdentifierNameEnum;
|
|
397
|
+
/**
|
|
398
|
+
* Corresponding value to `ItemRelatedIdentifierName`.
|
|
399
|
+
*/
|
|
400
|
+
'itemRelatedIdentifierValue'?: string;
|
|
425
401
|
}
|
|
426
402
|
declare const ItemRelatedIdentifierItemRelatedIdentifierNameEnum: {
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
403
|
+
readonly OrderAdjustmentItemId: "ORDER_ADJUSTMENT_ITEM_ID";
|
|
404
|
+
readonly CouponId: "COUPON_ID";
|
|
405
|
+
readonly RemovalShipmentItemId: "REMOVAL_SHIPMENT_ITEM_ID";
|
|
406
|
+
readonly TransactionId: "TRANSACTION_ID";
|
|
431
407
|
};
|
|
432
408
|
type ItemRelatedIdentifierItemRelatedIdentifierNameEnum = typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum[keyof typeof ItemRelatedIdentifierItemRelatedIdentifierNameEnum];
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
* The Selling Partner API for Finances
|
|
436
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
437
|
-
*
|
|
438
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
439
|
-
*
|
|
440
|
-
*
|
|
441
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
442
|
-
* https://openapi-generator.tech
|
|
443
|
-
* Do not edit the class manually.
|
|
444
|
-
*/
|
|
445
|
-
|
|
409
|
+
//#endregion
|
|
410
|
+
//#region src/api-model/models/item.d.ts
|
|
446
411
|
/**
|
|
447
412
|
* Additional information about the items in a transaction.
|
|
448
413
|
*/
|
|
449
414
|
interface Item {
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
415
|
+
/**
|
|
416
|
+
* A description of the items in a transaction.
|
|
417
|
+
*/
|
|
418
|
+
'description'?: string;
|
|
419
|
+
/**
|
|
420
|
+
* Related business identifiers of the item in the transaction.
|
|
421
|
+
*/
|
|
422
|
+
'relatedIdentifiers'?: Array<ItemRelatedIdentifier>;
|
|
423
|
+
'totalAmount'?: Currency;
|
|
424
|
+
/**
|
|
425
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
426
|
+
*/
|
|
427
|
+
'breakdowns'?: Array<Breakdown>;
|
|
428
|
+
/**
|
|
429
|
+
* A list of additional information about the item.
|
|
430
|
+
*/
|
|
431
|
+
'contexts'?: Array<Context>;
|
|
467
432
|
}
|
|
468
|
-
|
|
433
|
+
//#endregion
|
|
434
|
+
//#region src/api-model/models/marketplace-details.d.ts
|
|
469
435
|
/**
|
|
470
436
|
* The Selling Partner API for Finances
|
|
471
437
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -481,16 +447,17 @@ interface Item {
|
|
|
481
447
|
* Information about the marketplace where the transaction occurred.
|
|
482
448
|
*/
|
|
483
449
|
interface MarketplaceDetails {
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
450
|
+
/**
|
|
451
|
+
* The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
452
|
+
*/
|
|
453
|
+
'marketplaceId'?: string;
|
|
454
|
+
/**
|
|
455
|
+
* The name of the marketplace where the transaction occurred. For example: `Amazon.com`,`Amazon.in`
|
|
456
|
+
*/
|
|
457
|
+
'marketplaceName'?: string;
|
|
492
458
|
}
|
|
493
|
-
|
|
459
|
+
//#endregion
|
|
460
|
+
//#region src/api-model/models/related-identifier.d.ts
|
|
494
461
|
/**
|
|
495
462
|
* The Selling Partner API for Finances
|
|
496
463
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -506,29 +473,30 @@ interface MarketplaceDetails {
|
|
|
506
473
|
* Related business identifier of the transaction.
|
|
507
474
|
*/
|
|
508
475
|
interface RelatedIdentifier {
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
476
|
+
/**
|
|
477
|
+
* An enumerated set of related business identifier names.
|
|
478
|
+
*/
|
|
479
|
+
'relatedIdentifierName'?: RelatedIdentifierRelatedIdentifierNameEnum;
|
|
480
|
+
/**
|
|
481
|
+
* Corresponding value of `RelatedIdentifierName`.
|
|
482
|
+
*/
|
|
483
|
+
'relatedIdentifierValue'?: string;
|
|
517
484
|
}
|
|
518
485
|
declare const RelatedIdentifierRelatedIdentifierNameEnum: {
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
486
|
+
readonly OrderId: "ORDER_ID";
|
|
487
|
+
readonly ShipmentId: "SHIPMENT_ID";
|
|
488
|
+
readonly FinancialEventGroupId: "FINANCIAL_EVENT_GROUP_ID";
|
|
489
|
+
readonly RefundId: "REFUND_ID";
|
|
490
|
+
readonly InvoiceId: "INVOICE_ID";
|
|
491
|
+
readonly DisbursementId: "DISBURSEMENT_ID";
|
|
492
|
+
readonly TransferId: "TRANSFER_ID";
|
|
493
|
+
readonly DeferredTransactionId: "DEFERRED_TRANSACTION_ID";
|
|
494
|
+
readonly ReleaseTransactionId: "RELEASE_TRANSACTION_ID";
|
|
495
|
+
readonly SettlementId: "SETTLEMENT_ID";
|
|
529
496
|
};
|
|
530
497
|
type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];
|
|
531
|
-
|
|
498
|
+
//#endregion
|
|
499
|
+
//#region src/api-model/models/selling-partner-metadata.d.ts
|
|
532
500
|
/**
|
|
533
501
|
* The Selling Partner API for Finances
|
|
534
502
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -544,122 +512,90 @@ type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelate
|
|
|
544
512
|
* Metadata that describes the seller.
|
|
545
513
|
*/
|
|
546
514
|
interface SellingPartnerMetadata {
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
515
|
+
/**
|
|
516
|
+
* A unique seller identifier.
|
|
517
|
+
*/
|
|
518
|
+
'sellingPartnerId'?: string;
|
|
519
|
+
/**
|
|
520
|
+
* The type of account in the transaction.
|
|
521
|
+
*/
|
|
522
|
+
'accountType'?: string;
|
|
523
|
+
/**
|
|
524
|
+
* The identifier of the marketplace where the transaction occurred. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
525
|
+
*/
|
|
526
|
+
'marketplaceId'?: string;
|
|
559
527
|
}
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
* The Selling Partner API for Finances
|
|
563
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
564
|
-
*
|
|
565
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
569
|
-
* https://openapi-generator.tech
|
|
570
|
-
* Do not edit the class manually.
|
|
571
|
-
*/
|
|
572
|
-
|
|
528
|
+
//#endregion
|
|
529
|
+
//#region src/api-model/models/transaction.d.ts
|
|
573
530
|
/**
|
|
574
531
|
* All the information related to a transaction.
|
|
575
532
|
*/
|
|
576
533
|
interface Transaction {
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
534
|
+
'sellingPartnerMetadata'?: SellingPartnerMetadata;
|
|
535
|
+
/**
|
|
536
|
+
* Related business identifiers of the transaction.
|
|
537
|
+
*/
|
|
538
|
+
'relatedIdentifiers'?: Array<RelatedIdentifier>;
|
|
539
|
+
/**
|
|
540
|
+
* The type of transaction. **Possible value:** `Shipment`
|
|
541
|
+
*/
|
|
542
|
+
'transactionType'?: string;
|
|
543
|
+
/**
|
|
544
|
+
* The unique identifier of the transaction.
|
|
545
|
+
*/
|
|
546
|
+
'transactionId'?: string;
|
|
547
|
+
/**
|
|
548
|
+
* The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
549
|
+
*/
|
|
550
|
+
'transactionStatus'?: string;
|
|
551
|
+
/**
|
|
552
|
+
* Describes the reasons for the transaction. **Example:** \'Order Payment\', \'Refund Order\'
|
|
553
|
+
*/
|
|
554
|
+
'description'?: string;
|
|
555
|
+
/**
|
|
556
|
+
* A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
|
|
557
|
+
*/
|
|
558
|
+
'postedDate'?: string;
|
|
559
|
+
'totalAmount'?: Currency;
|
|
560
|
+
'marketplaceDetails'?: MarketplaceDetails;
|
|
561
|
+
/**
|
|
562
|
+
* A list of items in the transaction.
|
|
563
|
+
*/
|
|
564
|
+
'items'?: Array<Item>;
|
|
565
|
+
/**
|
|
566
|
+
* A list of additional information about the item.
|
|
567
|
+
*/
|
|
568
|
+
'contexts'?: Array<Context>;
|
|
569
|
+
/**
|
|
570
|
+
* A list of breakdowns that detail how the total amount is calculated for the transaction.
|
|
571
|
+
*/
|
|
572
|
+
'breakdowns'?: Array<Breakdown>;
|
|
616
573
|
}
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
* The Selling Partner API for Finances
|
|
620
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
621
|
-
*
|
|
622
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
626
|
-
* https://openapi-generator.tech
|
|
627
|
-
* Do not edit the class manually.
|
|
628
|
-
*/
|
|
629
|
-
|
|
574
|
+
//#endregion
|
|
575
|
+
//#region src/api-model/models/transactions-payload.d.ts
|
|
630
576
|
/**
|
|
631
577
|
* The payload for the `listTransactions` operation.
|
|
632
578
|
*/
|
|
633
579
|
interface TransactionsPayload {
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
580
|
+
/**
|
|
581
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
582
|
+
*/
|
|
583
|
+
'nextToken'?: string;
|
|
584
|
+
/**
|
|
585
|
+
* A list of transactions within the specified time period.
|
|
586
|
+
*/
|
|
587
|
+
'transactions'?: Array<Transaction>;
|
|
642
588
|
}
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
* The Selling Partner API for Finances
|
|
646
|
-
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
647
|
-
*
|
|
648
|
-
* The version of the OpenAPI document: 2024-06-19
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
652
|
-
* https://openapi-generator.tech
|
|
653
|
-
* Do not edit the class manually.
|
|
654
|
-
*/
|
|
655
|
-
|
|
589
|
+
//#endregion
|
|
590
|
+
//#region src/api-model/models/list-transactions-response.d.ts
|
|
656
591
|
/**
|
|
657
592
|
* The response schema for the `listTransactions` operation.
|
|
658
593
|
*/
|
|
659
594
|
interface ListTransactionsResponse {
|
|
660
|
-
|
|
595
|
+
'payload'?: TransactionsPayload;
|
|
661
596
|
}
|
|
662
|
-
|
|
597
|
+
//#endregion
|
|
598
|
+
//#region src/api-model/models/model-error.d.ts
|
|
663
599
|
/**
|
|
664
600
|
* The Selling Partner API for Finances
|
|
665
601
|
* The Selling Partner API for Finances provides financial information relevant to a seller\'s business. You can obtain financial events for a given order or date range without having to wait until a statement period closes.
|
|
@@ -675,117 +611,120 @@ interface ListTransactionsResponse {
|
|
|
675
611
|
* An error response returned when the request is unsuccessful.
|
|
676
612
|
*/
|
|
677
613
|
interface ModelError {
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
614
|
+
/**
|
|
615
|
+
* An error code that identifies the type of error that occurred.
|
|
616
|
+
*/
|
|
617
|
+
'code': string;
|
|
618
|
+
/**
|
|
619
|
+
* A message that describes the error condition.
|
|
620
|
+
*/
|
|
621
|
+
'message': string;
|
|
622
|
+
/**
|
|
623
|
+
* Additional details that can help the caller understand or fix the issue.
|
|
624
|
+
*/
|
|
625
|
+
'details'?: string;
|
|
690
626
|
}
|
|
691
|
-
|
|
627
|
+
//#endregion
|
|
628
|
+
//#region src/api-model/api/finances-api.d.ts
|
|
692
629
|
/**
|
|
693
630
|
* FinancesApi - axios parameter creator
|
|
694
631
|
*/
|
|
695
632
|
declare const FinancesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
633
|
+
/**
|
|
634
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 contains the default rate and burst values for this operation. Selling partners 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
635
|
+
* @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
|
|
636
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
637
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
638
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
639
|
+
* @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.
|
|
640
|
+
* @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`.
|
|
641
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
642
|
+
* @param {*} [options] Override http request option.
|
|
643
|
+
* @throws {RequiredError}
|
|
644
|
+
*/
|
|
645
|
+
listTransactions: (postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
709
646
|
};
|
|
710
647
|
/**
|
|
711
648
|
* FinancesApi - functional programming interface
|
|
712
649
|
*/
|
|
713
650
|
declare const FinancesApiFp: (configuration?: Configuration) => {
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
651
|
+
/**
|
|
652
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 contains the default rate and burst values for this operation. Selling partners 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
653
|
+
* @param {string} [postedAfter] The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
|
|
654
|
+
* @param {string} [postedBefore] The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
655
|
+
* @param {string} [marketplaceId] The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
656
|
+
* @param {string} [transactionStatus] The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
657
|
+
* @param {string} [relatedIdentifierName] The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.
|
|
658
|
+
* @param {string} [relatedIdentifierValue] The value of the `relatedIdentifier`.
|
|
659
|
+
* @param {string} [nextToken] The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
660
|
+
* @param {*} [options] Override http request option.
|
|
661
|
+
* @throws {RequiredError}
|
|
662
|
+
*/
|
|
663
|
+
listTransactions(postedAfter?: string, postedBefore?: string, marketplaceId?: string, transactionStatus?: string, relatedIdentifierName?: string, relatedIdentifierValue?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
|
|
727
664
|
};
|
|
728
665
|
/**
|
|
729
666
|
* FinancesApi - factory interface
|
|
730
667
|
*/
|
|
731
668
|
declare const FinancesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
669
|
+
/**
|
|
670
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 contains the default rate and burst values for this operation. Selling partners 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
671
|
+
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
672
|
+
* @param {*} [options] Override http request option.
|
|
673
|
+
* @throws {RequiredError}
|
|
674
|
+
*/
|
|
675
|
+
listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
|
|
739
676
|
};
|
|
740
677
|
/**
|
|
741
678
|
* Request parameters for listTransactions operation in FinancesApi.
|
|
742
679
|
*/
|
|
743
680
|
interface FinancesApiListTransactionsRequest {
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
681
|
+
/**
|
|
682
|
+
* The response includes financial events posted on or after this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be more than two minutes before the time of the request. This field is required if you do not specify a related identifier.
|
|
683
|
+
*/
|
|
684
|
+
readonly postedAfter?: string;
|
|
685
|
+
/**
|
|
686
|
+
* The response includes financial events posted before (but not on) this date. This date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. The date-time must be later than `PostedAfter` and more than two minutes before the request was submitted. If `PostedAfter` and `PostedBefore` are more than 180 days apart, the response is empty. **Default:** Two minutes before the time of the request.
|
|
687
|
+
*/
|
|
688
|
+
readonly postedBefore?: string;
|
|
689
|
+
/**
|
|
690
|
+
* The identifier of the marketplace from which you want to retrieve transactions. The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
691
|
+
*/
|
|
692
|
+
readonly marketplaceId?: string;
|
|
693
|
+
/**
|
|
694
|
+
* The status of the transaction. **Possible values:** * `DEFERRED`: the transaction is currently deferred. * `RELEASED`: the transaction is currently released. * `DEFERRED_RELEASED`: the transaction was deferred in the past, but is now released. The status of a deferred transaction is updated to `DEFERRED_RELEASED` when the transaction is released.
|
|
695
|
+
*/
|
|
696
|
+
readonly transactionStatus?: string;
|
|
697
|
+
/**
|
|
698
|
+
* The name of the `relatedIdentifier`. **Possible values:** * `FINANCIAL_EVENT_GROUP_ID`: the financial event group ID associated with the transaction. * `ORDER_ID`: the order ID associated with the transaction. **Note:** FINANCIAL_EVENT_GROUP_ID and ORDER_ID are the only `relatedIdentifier` with filtering capabilities at the moment. While other `relatedIdentifier` values will be included in the response when available, they cannot be used for filtering purposes.
|
|
699
|
+
*/
|
|
700
|
+
readonly relatedIdentifierName?: string;
|
|
701
|
+
/**
|
|
702
|
+
* The value of the `relatedIdentifier`.
|
|
703
|
+
*/
|
|
704
|
+
readonly relatedIdentifierValue?: string;
|
|
705
|
+
/**
|
|
706
|
+
* The response includes `nextToken` when the number of results exceeds the specified `pageSize` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.
|
|
707
|
+
*/
|
|
708
|
+
readonly nextToken?: string;
|
|
772
709
|
}
|
|
773
710
|
/**
|
|
774
711
|
* FinancesApi - object-oriented interface
|
|
775
712
|
*/
|
|
776
713
|
declare class FinancesApi extends BaseAPI {
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
714
|
+
/**
|
|
715
|
+
* Returns transactions for the given parameters. Financial events might not include orders from the last 48 hours. **Usage plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 10 | 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 contains the default rate and burst values for this operation. Selling partners 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits).
|
|
716
|
+
* @param {FinancesApiListTransactionsRequest} requestParameters Request parameters.
|
|
717
|
+
* @param {*} [options] Override http request option.
|
|
718
|
+
* @throws {RequiredError}
|
|
719
|
+
*/
|
|
720
|
+
listTransactions(requestParameters?: FinancesApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactionsResponse, any, {}>>;
|
|
784
721
|
}
|
|
785
|
-
|
|
722
|
+
//#endregion
|
|
723
|
+
//#region src/client.d.ts
|
|
786
724
|
declare const clientRateLimits: RateLimit[];
|
|
787
725
|
declare class FinancesApiClient extends FinancesApi {
|
|
788
|
-
|
|
726
|
+
constructor(configuration: ClientConfiguration);
|
|
789
727
|
}
|
|
790
|
-
|
|
791
|
-
export {
|
|
728
|
+
//#endregion
|
|
729
|
+
export { AmazonPayContext, Breakdown, BusinessContext, BusinessContextStoreNameEnum, Context, ContextAllOf, Currency, DeferredContext, ErrorList, FinancesApi, FinancesApiAxiosParamCreator, FinancesApiClient, FinancesApiFactory, FinancesApiFp, FinancesApiListTransactionsRequest, Item, ItemRelatedIdentifier, ItemRelatedIdentifierItemRelatedIdentifierNameEnum, ListTransactionsResponse, MarketplaceDetails, ModelError, PaymentsContext, ProductContext, RelatedIdentifier, RelatedIdentifierRelatedIdentifierNameEnum, SellingPartnerMetadata, TimeRangeContext, Transaction, TransactionsPayload, clientRateLimits };
|
|
730
|
+
//# sourceMappingURL=index.d.ts.map
|