@sp-api-sdk/finances-api-v0 2.0.1 → 2.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.
Files changed (32) hide show
  1. package/dist/cjs/src/api-model/api/default-api.js +84 -4
  2. package/dist/cjs/src/api-model/models/index.js +7 -2
  3. package/dist/cjs/src/api-model/models/list-transactions-response.js +15 -0
  4. package/dist/cjs/src/api-model/models/related-identifier.js +19 -0
  5. package/dist/cjs/src/api-model/models/selling-partner-metadata.js +15 -0
  6. package/dist/cjs/src/api-model/models/transaction.js +15 -0
  7. package/dist/cjs/src/api-model/models/value-added-service-charge-event.js +15 -0
  8. package/dist/cjs/src/client.js +7 -0
  9. package/dist/es/src/api-model/api/default-api.js +84 -4
  10. package/dist/es/src/api-model/models/index.js +7 -2
  11. package/dist/es/src/api-model/models/list-transactions-response.js +14 -0
  12. package/dist/es/src/api-model/models/related-identifier.js +16 -0
  13. package/dist/es/src/api-model/models/selling-partner-metadata.js +14 -0
  14. package/dist/es/src/api-model/models/transaction.js +14 -0
  15. package/dist/es/src/api-model/models/value-added-service-charge-event.js +14 -0
  16. package/dist/es/src/client.js +7 -0
  17. package/dist/types/src/api-model/api/default-api.d.ts +71 -4
  18. package/dist/types/src/api-model/models/charge-refund-event.d.ts +3 -3
  19. package/dist/types/src/api-model/models/{failed-adhoc-disbursement-event-list.d.ts → failed-adhoc-disbursement-event.d.ts} +9 -9
  20. package/dist/types/src/api-model/models/financial-events.d.ts +8 -8
  21. package/dist/types/src/api-model/models/index.d.ts +7 -2
  22. package/dist/types/src/api-model/models/list-transactions-payload.d.ts +31 -0
  23. package/dist/types/src/api-model/models/list-transactions-response.d.ts +31 -0
  24. package/dist/types/src/api-model/models/related-identifier.d.ts +34 -0
  25. package/dist/types/src/api-model/models/selling-partner-metadata.d.ts +36 -0
  26. package/dist/types/src/api-model/models/transaction.d.ts +51 -0
  27. package/dist/types/src/api-model/models/{value-added-service-charge-event-list.d.ts → value-added-service-charge-event.d.ts} +6 -6
  28. package/package.json +4 -4
  29. /package/dist/cjs/src/api-model/models/{failed-adhoc-disbursement-event-list.js → failed-adhoc-disbursement-event.js} +0 -0
  30. /package/dist/cjs/src/api-model/models/{value-added-service-charge-event-list.js → list-transactions-payload.js} +0 -0
  31. /package/dist/es/src/api-model/models/{failed-adhoc-disbursement-event-list.js → failed-adhoc-disbursement-event.js} +0 -0
  32. /package/dist/es/src/api-model/models/{value-added-service-charge-event-list.js → list-transactions-payload.js} +0 -0
@@ -74,7 +74,7 @@ const DefaultApiAxiosParamCreator = function (configuration) {
74
74
  };
75
75
  },
76
76
  /**
77
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
77
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
78
78
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
79
79
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
80
80
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -201,6 +201,54 @@ const DefaultApiAxiosParamCreator = function (configuration) {
201
201
  options: localVarRequestOptions,
202
202
  };
203
203
  },
204
+ /**
205
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
206
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
207
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
208
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
209
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ */
213
+ listTransactions: async (postedAfter, marketplaceId, postedBefore, nextToken, options = {}) => {
214
+ // verify required parameter 'postedAfter' is not null or undefined
215
+ (0, common_1.assertParamExists)('listTransactions', 'postedAfter', postedAfter);
216
+ // verify required parameter 'marketplaceId' is not null or undefined
217
+ (0, common_1.assertParamExists)('listTransactions', 'marketplaceId', marketplaceId);
218
+ const localVarPath = `/finances/v0/transactions`;
219
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
220
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
221
+ let baseOptions;
222
+ if (configuration) {
223
+ baseOptions = configuration.baseOptions;
224
+ }
225
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
226
+ const localVarHeaderParameter = {};
227
+ const localVarQueryParameter = {};
228
+ if (postedAfter !== undefined) {
229
+ localVarQueryParameter['PostedAfter'] = (postedAfter instanceof Date) ?
230
+ postedAfter.toISOString() :
231
+ postedAfter;
232
+ }
233
+ if (postedBefore !== undefined) {
234
+ localVarQueryParameter['PostedBefore'] = (postedBefore instanceof Date) ?
235
+ postedBefore.toISOString() :
236
+ postedBefore;
237
+ }
238
+ if (marketplaceId !== undefined) {
239
+ localVarQueryParameter['MarketplaceId'] = marketplaceId;
240
+ }
241
+ if (nextToken !== undefined) {
242
+ localVarQueryParameter['NextToken'] = nextToken;
243
+ }
244
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
245
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
246
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
247
+ return {
248
+ url: (0, common_1.toPathString)(localVarUrlObj),
249
+ options: localVarRequestOptions,
250
+ };
251
+ },
204
252
  };
205
253
  };
206
254
  exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
@@ -225,7 +273,7 @@ const DefaultApiFp = function (configuration) {
225
273
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
226
274
  },
227
275
  /**
228
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
276
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
229
277
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
230
278
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
231
279
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -263,6 +311,19 @@ const DefaultApiFp = function (configuration) {
263
311
  const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options);
264
312
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
265
313
  },
314
+ /**
315
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
316
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
317
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
318
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
319
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
320
+ * @param {*} [options] Override http request option.
321
+ * @throws {RequiredError}
322
+ */
323
+ async listTransactions(postedAfter, marketplaceId, postedBefore, nextToken, options) {
324
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, marketplaceId, postedBefore, nextToken, options);
325
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
326
+ },
266
327
  };
267
328
  };
268
329
  exports.DefaultApiFp = DefaultApiFp;
@@ -283,7 +344,7 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
283
344
  return localVarFp.listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(axios, basePath));
284
345
  },
285
346
  /**
286
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
287
348
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
288
349
  * @param {*} [options] Override http request option.
289
350
  * @throws {RequiredError}
@@ -309,6 +370,15 @@ const DefaultApiFactory = function (configuration, basePath, axios) {
309
370
  listFinancialEventsByOrderId(requestParameters, options) {
310
371
  return localVarFp.listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(axios, basePath));
311
372
  },
373
+ /**
374
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
375
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
376
+ * @param {*} [options] Override http request option.
377
+ * @throws {RequiredError}
378
+ */
379
+ listTransactions(requestParameters, options) {
380
+ return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.marketplaceId, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
381
+ },
312
382
  };
313
383
  };
314
384
  exports.DefaultApiFactory = DefaultApiFactory;
@@ -330,7 +400,7 @@ class DefaultApi extends base_1.BaseAPI {
330
400
  return (0, exports.DefaultApiFp)(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
331
401
  }
332
402
  /**
333
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
403
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
334
404
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
335
405
  * @param {*} [options] Override http request option.
336
406
  * @throws {RequiredError}
@@ -359,5 +429,15 @@ class DefaultApi extends base_1.BaseAPI {
359
429
  listFinancialEventsByOrderId(requestParameters, options) {
360
430
  return (0, exports.DefaultApiFp)(this.configuration).listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
361
431
  }
432
+ /**
433
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
434
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
435
+ * @param {*} [options] Override http request option.
436
+ * @throws {RequiredError}
437
+ * @memberof DefaultApi
438
+ */
439
+ listTransactions(requestParameters, options) {
440
+ return (0, exports.DefaultApiFp)(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.marketplaceId, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
441
+ }
362
442
  }
363
443
  exports.DefaultApi = DefaultApi;
@@ -29,7 +29,7 @@ __exportStar(require("./debt-recovery-event"), exports);
29
29
  __exportStar(require("./debt-recovery-item"), exports);
30
30
  __exportStar(require("./direct-payment"), exports);
31
31
  __exportStar(require("./fbaliquidation-event"), exports);
32
- __exportStar(require("./failed-adhoc-disbursement-event-list"), exports);
32
+ __exportStar(require("./failed-adhoc-disbursement-event"), exports);
33
33
  __exportStar(require("./fee-component"), exports);
34
34
  __exportStar(require("./financial-event-group"), exports);
35
35
  __exportStar(require("./financial-events"), exports);
@@ -38,12 +38,15 @@ __exportStar(require("./list-financial-event-groups-payload"), exports);
38
38
  __exportStar(require("./list-financial-event-groups-response"), exports);
39
39
  __exportStar(require("./list-financial-events-payload"), exports);
40
40
  __exportStar(require("./list-financial-events-response"), exports);
41
+ __exportStar(require("./list-transactions-payload"), exports);
42
+ __exportStar(require("./list-transactions-response"), exports);
41
43
  __exportStar(require("./loan-servicing-event"), exports);
42
44
  __exportStar(require("./model-error"), exports);
43
45
  __exportStar(require("./network-commingling-transaction-event"), exports);
44
46
  __exportStar(require("./pay-with-amazon-event"), exports);
45
47
  __exportStar(require("./product-ads-payment-event"), exports);
46
48
  __exportStar(require("./promotion"), exports);
49
+ __exportStar(require("./related-identifier"), exports);
47
50
  __exportStar(require("./removal-shipment-adjustment-event"), exports);
48
51
  __exportStar(require("./removal-shipment-event"), exports);
49
52
  __exportStar(require("./removal-shipment-item"), exports);
@@ -54,6 +57,7 @@ __exportStar(require("./safetreimbursement-event"), exports);
54
57
  __exportStar(require("./safetreimbursement-item"), exports);
55
58
  __exportStar(require("./seller-deal-payment-event"), exports);
56
59
  __exportStar(require("./seller-review-enrollment-payment-event"), exports);
60
+ __exportStar(require("./selling-partner-metadata"), exports);
57
61
  __exportStar(require("./service-fee-event"), exports);
58
62
  __exportStar(require("./shipment-event"), exports);
59
63
  __exportStar(require("./shipment-item"), exports);
@@ -62,5 +66,6 @@ __exportStar(require("./tdsreimbursement-event"), exports);
62
66
  __exportStar(require("./tax-withheld-component"), exports);
63
67
  __exportStar(require("./tax-withholding-event"), exports);
64
68
  __exportStar(require("./tax-withholding-period"), exports);
69
+ __exportStar(require("./transaction"), exports);
65
70
  __exportStar(require("./trial-shipment-event"), exports);
66
- __exportStar(require("./value-added-service-charge-event-list"), exports);
71
+ __exportStar(require("./value-added-service-charge-event"), exports);
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.RelatedIdentifierRelatedIdentifierNameEnum = void 0;
17
+ exports.RelatedIdentifierRelatedIdentifierNameEnum = {
18
+ OrderId: 'ORDER_ID'
19
+ };
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Finances
6
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -32,6 +32,13 @@ exports.clientRateLimits = [
32
32
  rate: 0.5,
33
33
  burst: 30,
34
34
  },
35
+ {
36
+ method: 'get',
37
+ // eslint-disable-next-line prefer-regex-literals
38
+ urlRegex: new RegExp('^/finances/v0/transactions$'),
39
+ rate: 0.5,
40
+ burst: 30,
41
+ },
35
42
  ];
36
43
  class FinancesApiClient extends api_model_1.DefaultApi {
37
44
  constructor(configuration) {
@@ -68,7 +68,7 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
68
68
  };
69
69
  },
70
70
  /**
71
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
71
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
72
72
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
73
73
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
74
74
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -195,6 +195,54 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
195
195
  options: localVarRequestOptions,
196
196
  };
197
197
  },
198
+ /**
199
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
200
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
201
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
202
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
203
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ */
207
+ listTransactions: async (postedAfter, marketplaceId, postedBefore, nextToken, options = {}) => {
208
+ // verify required parameter 'postedAfter' is not null or undefined
209
+ assertParamExists('listTransactions', 'postedAfter', postedAfter);
210
+ // verify required parameter 'marketplaceId' is not null or undefined
211
+ assertParamExists('listTransactions', 'marketplaceId', marketplaceId);
212
+ const localVarPath = `/finances/v0/transactions`;
213
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
214
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
215
+ let baseOptions;
216
+ if (configuration) {
217
+ baseOptions = configuration.baseOptions;
218
+ }
219
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
220
+ const localVarHeaderParameter = {};
221
+ const localVarQueryParameter = {};
222
+ if (postedAfter !== undefined) {
223
+ localVarQueryParameter['PostedAfter'] = (postedAfter instanceof Date) ?
224
+ postedAfter.toISOString() :
225
+ postedAfter;
226
+ }
227
+ if (postedBefore !== undefined) {
228
+ localVarQueryParameter['PostedBefore'] = (postedBefore instanceof Date) ?
229
+ postedBefore.toISOString() :
230
+ postedBefore;
231
+ }
232
+ if (marketplaceId !== undefined) {
233
+ localVarQueryParameter['MarketplaceId'] = marketplaceId;
234
+ }
235
+ if (nextToken !== undefined) {
236
+ localVarQueryParameter['NextToken'] = nextToken;
237
+ }
238
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
239
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
240
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
241
+ return {
242
+ url: toPathString(localVarUrlObj),
243
+ options: localVarRequestOptions,
244
+ };
245
+ },
198
246
  };
199
247
  };
200
248
  /**
@@ -218,7 +266,7 @@ export const DefaultApiFp = function (configuration) {
218
266
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
219
267
  },
220
268
  /**
221
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
269
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
222
270
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \'InvalidInput\'.
223
271
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
224
272
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -256,6 +304,19 @@ export const DefaultApiFp = function (configuration) {
256
304
  const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options);
257
305
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
258
306
  },
307
+ /**
308
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
309
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
310
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
311
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
312
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ */
316
+ async listTransactions(postedAfter, marketplaceId, postedBefore, nextToken, options) {
317
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTransactions(postedAfter, marketplaceId, postedBefore, nextToken, options);
318
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
319
+ },
259
320
  };
260
321
  };
261
322
  /**
@@ -275,7 +336,7 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
275
336
  return localVarFp.listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(axios, basePath));
276
337
  },
277
338
  /**
278
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
339
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
279
340
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
280
341
  * @param {*} [options] Override http request option.
281
342
  * @throws {RequiredError}
@@ -301,6 +362,15 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
301
362
  listFinancialEventsByOrderId(requestParameters, options) {
302
363
  return localVarFp.listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(axios, basePath));
303
364
  },
365
+ /**
366
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
367
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
368
+ * @param {*} [options] Override http request option.
369
+ * @throws {RequiredError}
370
+ */
371
+ listTransactions(requestParameters, options) {
372
+ return localVarFp.listTransactions(requestParameters.postedAfter, requestParameters.marketplaceId, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
373
+ },
304
374
  };
305
375
  };
306
376
  /**
@@ -321,7 +391,7 @@ export class DefaultApi extends BaseAPI {
321
391
  return DefaultApiFp(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
322
392
  }
323
393
  /**
324
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
394
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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
395
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
326
396
  * @param {*} [options] Override http request option.
327
397
  * @throws {RequiredError}
@@ -350,4 +420,14 @@ export class DefaultApi extends BaseAPI {
350
420
  listFinancialEventsByOrderId(requestParameters, options) {
351
421
  return DefaultApiFp(this.configuration).listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
352
422
  }
423
+ /**
424
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
425
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ * @memberof DefaultApi
429
+ */
430
+ listTransactions(requestParameters, options) {
431
+ return DefaultApiFp(this.configuration).listTransactions(requestParameters.postedAfter, requestParameters.marketplaceId, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
432
+ }
353
433
  }
@@ -13,7 +13,7 @@ export * from './debt-recovery-event';
13
13
  export * from './debt-recovery-item';
14
14
  export * from './direct-payment';
15
15
  export * from './fbaliquidation-event';
16
- export * from './failed-adhoc-disbursement-event-list';
16
+ export * from './failed-adhoc-disbursement-event';
17
17
  export * from './fee-component';
18
18
  export * from './financial-event-group';
19
19
  export * from './financial-events';
@@ -22,12 +22,15 @@ export * from './list-financial-event-groups-payload';
22
22
  export * from './list-financial-event-groups-response';
23
23
  export * from './list-financial-events-payload';
24
24
  export * from './list-financial-events-response';
25
+ export * from './list-transactions-payload';
26
+ export * from './list-transactions-response';
25
27
  export * from './loan-servicing-event';
26
28
  export * from './model-error';
27
29
  export * from './network-commingling-transaction-event';
28
30
  export * from './pay-with-amazon-event';
29
31
  export * from './product-ads-payment-event';
30
32
  export * from './promotion';
33
+ export * from './related-identifier';
31
34
  export * from './removal-shipment-adjustment-event';
32
35
  export * from './removal-shipment-event';
33
36
  export * from './removal-shipment-item';
@@ -38,6 +41,7 @@ export * from './safetreimbursement-event';
38
41
  export * from './safetreimbursement-item';
39
42
  export * from './seller-deal-payment-event';
40
43
  export * from './seller-review-enrollment-payment-event';
44
+ export * from './selling-partner-metadata';
41
45
  export * from './service-fee-event';
42
46
  export * from './shipment-event';
43
47
  export * from './shipment-item';
@@ -46,5 +50,6 @@ export * from './tdsreimbursement-event';
46
50
  export * from './tax-withheld-component';
47
51
  export * from './tax-withholding-event';
48
52
  export * from './tax-withholding-period';
53
+ export * from './transaction';
49
54
  export * from './trial-shipment-event';
50
- export * from './value-added-service-charge-event-list';
55
+ export * from './value-added-service-charge-event';
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,16 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const RelatedIdentifierRelatedIdentifierNameEnum = {
15
+ OrderId: 'ORDER_ID'
16
+ };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -29,6 +29,13 @@ export const clientRateLimits = [
29
29
  rate: 0.5,
30
30
  burst: 30,
31
31
  },
32
+ {
33
+ method: 'get',
34
+ // eslint-disable-next-line prefer-regex-literals
35
+ urlRegex: new RegExp('^/finances/v0/transactions$'),
36
+ rate: 0.5,
37
+ burst: 30,
38
+ },
32
39
  ];
33
40
  export class FinancesApiClient extends DefaultApi {
34
41
  constructor(configuration) {
@@ -14,6 +14,7 @@ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { ListFinancialEventGroupsResponse } from '../models';
16
16
  import { ListFinancialEventsResponse } from '../models';
17
+ import { ListTransactionsResponse } from '../models';
17
18
  /**
18
19
  * DefaultApi - axios parameter creator
19
20
  * @export
@@ -30,7 +31,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
30
31
  */
31
32
  listFinancialEventGroups: (maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
33
  /**
33
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
34
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
34
35
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \&#39;InvalidInput\&#39;.
35
36
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
36
37
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -59,6 +60,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
59
60
  * @throws {RequiredError}
60
61
  */
61
62
  listFinancialEventsByOrderId: (orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ /**
64
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
65
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
66
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
67
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
68
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ listTransactions: (postedAfter: string, marketplaceId: string, postedBefore?: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
73
  };
63
74
  /**
64
75
  * DefaultApi - functional programming interface
@@ -76,7 +87,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
76
87
  */
77
88
  listFinancialEventGroups(maxResultsPerPage?: number, financialEventGroupStartedBefore?: string, financialEventGroupStartedAfter?: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventGroupsResponse>>;
78
89
  /**
79
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
90
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
80
91
  * @param {number} [maxResultsPerPage] The maximum number of results to return per page. If the response exceeds the maximum number of transactions or 10 MB, the API responds with \&#39;InvalidInput\&#39;.
81
92
  * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
82
93
  * @param {string} [postedBefore] A date used for selecting financial events posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no financial events are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
@@ -105,6 +116,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
105
116
  * @throws {RequiredError}
106
117
  */
107
118
  listFinancialEventsByOrderId(orderId: string, maxResultsPerPage?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFinancialEventsResponse>>;
119
+ /**
120
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
121
+ * @param {string} postedAfter A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
122
+ * @param {string} marketplaceId A string token used to select Marketplace ID.
123
+ * @param {string} [postedBefore] A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
124
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ listTransactions(postedAfter: string, marketplaceId: string, postedBefore?: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactionsResponse>>;
108
129
  };
109
130
  /**
110
131
  * DefaultApi - factory interface
@@ -119,7 +140,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
119
140
  */
120
141
  listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: AxiosRequestConfig): AxiosPromise<ListFinancialEventGroupsResponse>;
121
142
  /**
122
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
143
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
123
144
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
124
145
  * @param {*} [options] Override http request option.
125
146
  * @throws {RequiredError}
@@ -139,6 +160,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
139
160
  * @throws {RequiredError}
140
161
  */
141
162
  listFinancialEventsByOrderId(requestParameters: DefaultApiListFinancialEventsByOrderIdRequest, options?: AxiosRequestConfig): AxiosPromise<ListFinancialEventsResponse>;
163
+ /**
164
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
165
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ listTransactions(requestParameters: DefaultApiListTransactionsRequest, options?: AxiosRequestConfig): AxiosPromise<ListTransactionsResponse>;
142
170
  };
143
171
  /**
144
172
  * Request parameters for listFinancialEventGroups operation in DefaultApi.
@@ -264,6 +292,37 @@ export interface DefaultApiListFinancialEventsByOrderIdRequest {
264
292
  */
265
293
  readonly nextToken?: string;
266
294
  }
295
+ /**
296
+ * Request parameters for listTransactions operation in DefaultApi.
297
+ * @export
298
+ * @interface DefaultApiListTransactionsRequest
299
+ */
300
+ export interface DefaultApiListTransactionsRequest {
301
+ /**
302
+ * A date used for selecting transactions posted after (or at) a specified time. The date-time must be no later than two minutes before the request was submitted, in ISO 8601 date time format.
303
+ * @type {string}
304
+ * @memberof DefaultApiListTransactions
305
+ */
306
+ readonly postedAfter: string;
307
+ /**
308
+ * A string token used to select Marketplace ID.
309
+ * @type {string}
310
+ * @memberof DefaultApiListTransactions
311
+ */
312
+ readonly marketplaceId: string;
313
+ /**
314
+ * A date used for selecting transactions posted before (but not at) a specified time. The date-time must be later than PostedAfter and no later than two minutes before the request was submitted, in ISO 8601 date time format. If PostedAfter and PostedBefore are more than 180 days apart, no transactions are returned. You must specify the PostedAfter parameter if you specify the PostedBefore parameter. Default: Now minus two minutes.
315
+ * @type {string}
316
+ * @memberof DefaultApiListTransactions
317
+ */
318
+ readonly postedBefore?: string;
319
+ /**
320
+ * A string token returned in the response of your previous request.
321
+ * @type {string}
322
+ * @memberof DefaultApiListTransactions
323
+ */
324
+ readonly nextToken?: string;
325
+ }
267
326
  /**
268
327
  * DefaultApi - object-oriented interface
269
328
  * @export
@@ -280,7 +339,7 @@ export declare class DefaultApi extends BaseAPI {
280
339
  */
281
340
  listFinancialEventGroups(requestParameters?: DefaultApiListFinancialEventGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventGroupsResponse, any>>;
282
341
  /**
283
- * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
342
+ * Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events. *note in ListFinancialEvents that deferred events don’t show up in responses until in they are released. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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
343
  * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
285
344
  * @param {*} [options] Override http request option.
286
345
  * @throws {RequiredError}
@@ -303,4 +362,12 @@ export declare class DefaultApi extends BaseAPI {
303
362
  * @memberof DefaultApi
304
363
  */
305
364
  listFinancialEventsByOrderId(requestParameters: DefaultApiListFinancialEventsByOrderIdRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFinancialEventsResponse, any>>;
365
+ /**
366
+ * Returns transactions for the given parameters. It may take up to 48 hours for transactions to appear in your transaction events. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 see higher rate and burst values than those shown here. For more information, see [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).
367
+ * @param {DefaultApiListTransactionsRequest} requestParameters Request parameters.
368
+ * @param {*} [options] Override http request option.
369
+ * @throws {RequiredError}
370
+ * @memberof DefaultApi
371
+ */
372
+ listTransactions(requestParameters: DefaultApiListTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactionsResponse, any>>;
306
373
  }
@@ -35,9 +35,9 @@ export interface ChargeRefundEvent {
35
35
  */
36
36
  'ReasonCodeDescription'?: string;
37
37
  /**
38
- *
39
- * @type {ChargeRefundTransaction}
38
+ * A list of ChargeRefund Transactions
39
+ * @type {Array<ChargeRefundTransaction>}
40
40
  * @memberof ChargeRefundEvent
41
41
  */
42
- 'ChargeRefundTransactions'?: ChargeRefundTransaction;
42
+ 'ChargeRefundTransactions'?: Array<ChargeRefundTransaction>;
43
43
  }
@@ -13,49 +13,49 @@ import { Currency } from './currency';
13
13
  /**
14
14
  * Failed ad hoc disbursement event list.
15
15
  * @export
16
- * @interface FailedAdhocDisbursementEventList
16
+ * @interface FailedAdhocDisbursementEvent
17
17
  */
18
- export interface FailedAdhocDisbursementEventList {
18
+ export interface FailedAdhocDisbursementEvent {
19
19
  /**
20
20
  * The type of fund transfer. Example \"Refund\"
21
21
  * @type {string}
22
- * @memberof FailedAdhocDisbursementEventList
22
+ * @memberof FailedAdhocDisbursementEvent
23
23
  */
24
24
  'FundsTransfersType'?: string;
25
25
  /**
26
26
  * The transfer identifier.
27
27
  * @type {string}
28
- * @memberof FailedAdhocDisbursementEventList
28
+ * @memberof FailedAdhocDisbursementEvent
29
29
  */
30
30
  'TransferId'?: string;
31
31
  /**
32
32
  * The disbursement identifier.
33
33
  * @type {string}
34
- * @memberof FailedAdhocDisbursementEventList
34
+ * @memberof FailedAdhocDisbursementEvent
35
35
  */
36
36
  'DisbursementId'?: string;
37
37
  /**
38
38
  * The type of payment for disbursement. Example `CREDIT_CARD`
39
39
  * @type {string}
40
- * @memberof FailedAdhocDisbursementEventList
40
+ * @memberof FailedAdhocDisbursementEvent
41
41
  */
42
42
  'PaymentDisbursementType'?: string;
43
43
  /**
44
44
  * The status of the failed `AdhocDisbursement`. Example `HARD_DECLINED`
45
45
  * @type {string}
46
- * @memberof FailedAdhocDisbursementEventList
46
+ * @memberof FailedAdhocDisbursementEvent
47
47
  */
48
48
  'Status'?: string;
49
49
  /**
50
50
  *
51
51
  * @type {Currency}
52
- * @memberof FailedAdhocDisbursementEventList
52
+ * @memberof FailedAdhocDisbursementEvent
53
53
  */
54
54
  'TransferAmount'?: Currency;
55
55
  /**
56
56
  *
57
57
  * @type {string}
58
- * @memberof FailedAdhocDisbursementEventList
58
+ * @memberof FailedAdhocDisbursementEvent
59
59
  */
60
60
  'PostedDate'?: string;
61
61
  }
@@ -17,7 +17,7 @@ import { ChargeRefundEvent } from './charge-refund-event';
17
17
  import { CouponPaymentEvent } from './coupon-payment-event';
18
18
  import { DebtRecoveryEvent } from './debt-recovery-event';
19
19
  import { FBALiquidationEvent } from './fbaliquidation-event';
20
- import { FailedAdhocDisbursementEventList } from './failed-adhoc-disbursement-event-list';
20
+ import { FailedAdhocDisbursementEvent } from './failed-adhoc-disbursement-event';
21
21
  import { ImagingServicesFeeEvent } from './imaging-services-fee-event';
22
22
  import { LoanServicingEvent } from './loan-servicing-event';
23
23
  import { NetworkComminglingTransactionEvent } from './network-commingling-transaction-event';
@@ -36,7 +36,7 @@ import { SolutionProviderCreditEvent } from './solution-provider-credit-event';
36
36
  import { TDSReimbursementEvent } from './tdsreimbursement-event';
37
37
  import { TaxWithholdingEvent } from './tax-withholding-event';
38
38
  import { TrialShipmentEvent } from './trial-shipment-event';
39
- import { ValueAddedServiceChargeEventList } from './value-added-service-charge-event-list';
39
+ import { ValueAddedServiceChargeEvent } from './value-added-service-charge-event';
40
40
  /**
41
41
  * Contains all information related to a financial event.
42
42
  * @export
@@ -224,17 +224,17 @@ export interface FinancialEvents {
224
224
  */
225
225
  'ChargeRefundEventList'?: Array<ChargeRefundEvent>;
226
226
  /**
227
- *
228
- * @type {FailedAdhocDisbursementEventList}
227
+ * A list of FailedAdhocDisbursementEvents.
228
+ * @type {Array<FailedAdhocDisbursementEvent>}
229
229
  * @memberof FinancialEvents
230
230
  */
231
- 'FailedAdhocDisbursementEventList'?: FailedAdhocDisbursementEventList;
231
+ 'FailedAdhocDisbursementEventList'?: Array<FailedAdhocDisbursementEvent>;
232
232
  /**
233
- *
234
- * @type {ValueAddedServiceChargeEventList}
233
+ * A list of ValueAddedServiceCharge events.
234
+ * @type {Array<ValueAddedServiceChargeEvent>}
235
235
  * @memberof FinancialEvents
236
236
  */
237
- 'ValueAddedServiceChargeEventList'?: ValueAddedServiceChargeEventList;
237
+ 'ValueAddedServiceChargeEventList'?: Array<ValueAddedServiceChargeEvent>;
238
238
  /**
239
239
  * A list of `CapacityReservationBillingEvent` events.
240
240
  * @type {Array<CapacityReservationBillingEvent>}
@@ -13,7 +13,7 @@ export * from './debt-recovery-event';
13
13
  export * from './debt-recovery-item';
14
14
  export * from './direct-payment';
15
15
  export * from './fbaliquidation-event';
16
- export * from './failed-adhoc-disbursement-event-list';
16
+ export * from './failed-adhoc-disbursement-event';
17
17
  export * from './fee-component';
18
18
  export * from './financial-event-group';
19
19
  export * from './financial-events';
@@ -22,12 +22,15 @@ export * from './list-financial-event-groups-payload';
22
22
  export * from './list-financial-event-groups-response';
23
23
  export * from './list-financial-events-payload';
24
24
  export * from './list-financial-events-response';
25
+ export * from './list-transactions-payload';
26
+ export * from './list-transactions-response';
25
27
  export * from './loan-servicing-event';
26
28
  export * from './model-error';
27
29
  export * from './network-commingling-transaction-event';
28
30
  export * from './pay-with-amazon-event';
29
31
  export * from './product-ads-payment-event';
30
32
  export * from './promotion';
33
+ export * from './related-identifier';
31
34
  export * from './removal-shipment-adjustment-event';
32
35
  export * from './removal-shipment-event';
33
36
  export * from './removal-shipment-item';
@@ -38,6 +41,7 @@ export * from './safetreimbursement-event';
38
41
  export * from './safetreimbursement-item';
39
42
  export * from './seller-deal-payment-event';
40
43
  export * from './seller-review-enrollment-payment-event';
44
+ export * from './selling-partner-metadata';
41
45
  export * from './service-fee-event';
42
46
  export * from './shipment-event';
43
47
  export * from './shipment-item';
@@ -46,5 +50,6 @@ export * from './tdsreimbursement-event';
46
50
  export * from './tax-withheld-component';
47
51
  export * from './tax-withholding-event';
48
52
  export * from './tax-withholding-period';
53
+ export * from './transaction';
49
54
  export * from './trial-shipment-event';
50
- export * from './value-added-service-charge-event-list';
55
+ export * from './value-added-service-charge-event';
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Transaction } from './transaction';
13
+ /**
14
+ * The payload for the listTransactions operation.
15
+ * @export
16
+ * @interface ListTransactionsPayload
17
+ */
18
+ export interface ListTransactionsPayload {
19
+ /**
20
+ * When present and not empty, pass this string token in the next request to return the next response page.
21
+ * @type {string}
22
+ * @memberof ListTransactionsPayload
23
+ */
24
+ 'NextToken'?: string;
25
+ /**
26
+ * Contains transactions within a given time period.
27
+ * @type {Array<Transaction>}
28
+ * @memberof ListTransactionsPayload
29
+ */
30
+ 'Transactions'?: Array<Transaction>;
31
+ }
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ListTransactionsPayload } from './list-transactions-payload';
13
+ /**
14
+ * The response schema for the listTransactions operation.
15
+ * @export
16
+ * @interface ListTransactionsResponse
17
+ */
18
+ export interface ListTransactionsResponse {
19
+ /**
20
+ *
21
+ * @type {ListTransactionsPayload}
22
+ * @memberof ListTransactionsResponse
23
+ */
24
+ 'payload'?: ListTransactionsPayload;
25
+ /**
26
+ * A list of error responses returned when a request is unsuccessful.
27
+ * @type {Array<Error>}
28
+ * @memberof ListTransactionsResponse
29
+ */
30
+ 'errors'?: Array<Error>;
31
+ }
@@ -0,0 +1,34 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Related business identifier of the transaction.
14
+ * @export
15
+ * @interface RelatedIdentifier
16
+ */
17
+ export interface RelatedIdentifier {
18
+ /**
19
+ * Enumerated set of related business identifier names.
20
+ * @type {string}
21
+ * @memberof RelatedIdentifier
22
+ */
23
+ 'RelatedIdentifierName'?: RelatedIdentifierRelatedIdentifierNameEnum;
24
+ /**
25
+ * Corresponding value of RelatedIdentifierName
26
+ * @type {string}
27
+ * @memberof RelatedIdentifier
28
+ */
29
+ 'RelatedIdentifierValue'?: string;
30
+ }
31
+ export declare const RelatedIdentifierRelatedIdentifierNameEnum: {
32
+ readonly OrderId: "ORDER_ID";
33
+ };
34
+ export type RelatedIdentifierRelatedIdentifierNameEnum = typeof RelatedIdentifierRelatedIdentifierNameEnum[keyof typeof RelatedIdentifierRelatedIdentifierNameEnum];
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Metadata describing the seller.
14
+ * @export
15
+ * @interface SellingPartnerMetadata
16
+ */
17
+ export interface SellingPartnerMetadata {
18
+ /**
19
+ * Unique seller identifier.
20
+ * @type {string}
21
+ * @memberof SellingPartnerMetadata
22
+ */
23
+ 'SellingPartnerId'?: string;
24
+ /**
25
+ * Account type of transaction.
26
+ * @type {string}
27
+ * @memberof SellingPartnerMetadata
28
+ */
29
+ 'AccountType'?: string;
30
+ /**
31
+ * Marketplace identifier of transaction.
32
+ * @type {string}
33
+ * @memberof SellingPartnerMetadata
34
+ */
35
+ 'MarketplaceId'?: string;
36
+ }
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Currency } from './currency';
13
+ import { RelatedIdentifier } from './related-identifier';
14
+ import { SellingPartnerMetadata } from './selling-partner-metadata';
15
+ /**
16
+ * Contains all information related to the transaction.
17
+ * @export
18
+ * @interface Transaction
19
+ */
20
+ export interface Transaction {
21
+ /**
22
+ *
23
+ * @type {SellingPartnerMetadata}
24
+ * @memberof Transaction
25
+ */
26
+ 'SellingPartnerMetadata'?: SellingPartnerMetadata;
27
+ /**
28
+ * Related business identifiers of the transaction.
29
+ * @type {Array<RelatedIdentifier>}
30
+ * @memberof Transaction
31
+ */
32
+ 'RelatedIdentifiers'?: Array<RelatedIdentifier>;
33
+ /**
34
+ * The type of transaction. Possible values: * Shipment
35
+ * @type {string}
36
+ * @memberof Transaction
37
+ */
38
+ 'TransactionType'?: string;
39
+ /**
40
+ *
41
+ * @type {string}
42
+ * @memberof Transaction
43
+ */
44
+ 'PostedDate'?: string;
45
+ /**
46
+ *
47
+ * @type {Currency}
48
+ * @memberof Transaction
49
+ */
50
+ 'TotalAmount'?: Currency;
51
+ }
@@ -13,31 +13,31 @@ import { Currency } from './currency';
13
13
  /**
14
14
  * An event related to a value added service charge.
15
15
  * @export
16
- * @interface ValueAddedServiceChargeEventList
16
+ * @interface ValueAddedServiceChargeEvent
17
17
  */
18
- export interface ValueAddedServiceChargeEventList {
18
+ export interface ValueAddedServiceChargeEvent {
19
19
  /**
20
20
  * Indicates the type of transaction. Example: \'Other Support Service fees\'
21
21
  * @type {string}
22
- * @memberof ValueAddedServiceChargeEventList
22
+ * @memberof ValueAddedServiceChargeEvent
23
23
  */
24
24
  'TransactionType'?: string;
25
25
  /**
26
26
  *
27
27
  * @type {string}
28
- * @memberof ValueAddedServiceChargeEventList
28
+ * @memberof ValueAddedServiceChargeEvent
29
29
  */
30
30
  'PostedDate'?: string;
31
31
  /**
32
32
  * A short description of the service charge event.
33
33
  * @type {string}
34
- * @memberof ValueAddedServiceChargeEventList
34
+ * @memberof ValueAddedServiceChargeEvent
35
35
  */
36
36
  'Description'?: string;
37
37
  /**
38
38
  *
39
39
  * @type {Currency}
40
- * @memberof ValueAddedServiceChargeEventList
40
+ * @memberof ValueAddedServiceChargeEvent
41
41
  */
42
42
  'TransactionAmount'?: Currency;
43
43
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/finances-api-v0",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
5
- "version": "2.0.1",
5
+ "version": "2.1.0",
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.1",
22
- "axios": "^1.6.0"
21
+ "@sp-api-sdk/common": "2.0.2",
22
+ "axios": "^1.6.1"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "finances api"
42
42
  ],
43
- "gitHead": "9bb159a54b588ec3184def8b5f2ae9b91cdfbcf5"
43
+ "gitHead": "23d420d10e931be7657141e989fccdc9dafe2a9c"
44
44
  }