@sp-api-sdk/finances-api-v0 4.0.6 → 4.2.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 (179) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/api-model/api/finances-api.js +49 -45
  3. package/dist/cjs/api-model/api.js +1 -1
  4. package/dist/cjs/api-model/base.js +1 -1
  5. package/dist/cjs/api-model/common.js +1 -1
  6. package/dist/cjs/api-model/configuration.js +13 -2
  7. package/dist/cjs/api-model/index.js +1 -1
  8. package/dist/cjs/api-model/models/adhoc-disbursement-event.js +1 -1
  9. package/dist/cjs/api-model/models/adjustment-event.js +1 -1
  10. package/dist/cjs/api-model/models/adjustment-item.js +1 -1
  11. package/dist/cjs/api-model/models/affordability-expense-event.js +1 -1
  12. package/dist/cjs/api-model/models/capacity-reservation-billing-event.js +1 -1
  13. package/dist/cjs/api-model/models/charge-component.js +1 -1
  14. package/dist/cjs/api-model/models/charge-instrument.js +1 -1
  15. package/dist/cjs/api-model/models/charge-refund-event.js +1 -1
  16. package/dist/cjs/api-model/models/charge-refund-transaction.js +1 -1
  17. package/dist/cjs/api-model/models/coupon-payment-event.js +1 -1
  18. package/dist/cjs/api-model/models/currency.js +1 -1
  19. package/dist/cjs/api-model/models/debt-recovery-event.js +1 -1
  20. package/dist/cjs/api-model/models/debt-recovery-item.js +1 -1
  21. package/dist/cjs/api-model/models/direct-payment.js +1 -1
  22. package/dist/cjs/api-model/models/ebtrefund-reimbursement-only-event.js +15 -0
  23. package/dist/cjs/api-model/models/failed-adhoc-disbursement-event.js +1 -1
  24. package/dist/cjs/api-model/models/fbaliquidation-event.js +1 -1
  25. package/dist/cjs/api-model/models/fee-component.js +1 -1
  26. package/dist/cjs/api-model/models/financial-event-group.js +1 -1
  27. package/dist/cjs/api-model/models/financial-events.js +1 -1
  28. package/dist/cjs/api-model/models/imaging-services-fee-event.js +1 -1
  29. package/dist/cjs/api-model/models/index.js +1 -0
  30. package/dist/cjs/api-model/models/list-financial-event-groups-payload.js +1 -1
  31. package/dist/cjs/api-model/models/list-financial-event-groups-response.js +1 -1
  32. package/dist/cjs/api-model/models/list-financial-events-payload.js +1 -1
  33. package/dist/cjs/api-model/models/list-financial-events-response.js +1 -1
  34. package/dist/cjs/api-model/models/loan-servicing-event.js +1 -1
  35. package/dist/cjs/api-model/models/model-error.js +1 -1
  36. package/dist/cjs/api-model/models/network-commingling-transaction-event.js +1 -1
  37. package/dist/cjs/api-model/models/pay-with-amazon-event.js +1 -1
  38. package/dist/cjs/api-model/models/product-ads-payment-event.js +1 -1
  39. package/dist/cjs/api-model/models/promotion.js +1 -1
  40. package/dist/cjs/api-model/models/removal-shipment-adjustment-event.js +1 -1
  41. package/dist/cjs/api-model/models/removal-shipment-event.js +1 -1
  42. package/dist/cjs/api-model/models/removal-shipment-item-adjustment.js +1 -1
  43. package/dist/cjs/api-model/models/removal-shipment-item.js +1 -1
  44. package/dist/cjs/api-model/models/rental-transaction-event.js +1 -1
  45. package/dist/cjs/api-model/models/retrocharge-event.js +1 -1
  46. package/dist/cjs/api-model/models/safetreimbursement-event.js +1 -1
  47. package/dist/cjs/api-model/models/safetreimbursement-item.js +1 -1
  48. package/dist/cjs/api-model/models/seller-deal-payment-event.js +1 -1
  49. package/dist/cjs/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  50. package/dist/cjs/api-model/models/service-fee-event.js +1 -1
  51. package/dist/cjs/api-model/models/shipment-event.js +1 -1
  52. package/dist/cjs/api-model/models/shipment-item.js +1 -1
  53. package/dist/cjs/api-model/models/solution-provider-credit-event.js +1 -1
  54. package/dist/cjs/api-model/models/tax-withheld-component.js +1 -1
  55. package/dist/cjs/api-model/models/tax-withholding-event.js +1 -1
  56. package/dist/cjs/api-model/models/tax-withholding-period.js +1 -1
  57. package/dist/cjs/api-model/models/tdsreimbursement-event.js +1 -1
  58. package/dist/cjs/api-model/models/trial-shipment-event.js +1 -1
  59. package/dist/cjs/api-model/models/value-added-service-charge-event.js +1 -1
  60. package/dist/cjs/index.js +0 -1
  61. package/dist/es/api-model/api/finances-api.js +49 -45
  62. package/dist/es/api-model/api.js +1 -1
  63. package/dist/es/api-model/base.js +1 -1
  64. package/dist/es/api-model/common.js +1 -1
  65. package/dist/es/api-model/configuration.js +13 -2
  66. package/dist/es/api-model/index.js +1 -1
  67. package/dist/es/api-model/models/adhoc-disbursement-event.js +1 -1
  68. package/dist/es/api-model/models/adjustment-event.js +1 -1
  69. package/dist/es/api-model/models/adjustment-item.js +1 -1
  70. package/dist/es/api-model/models/affordability-expense-event.js +1 -1
  71. package/dist/es/api-model/models/capacity-reservation-billing-event.js +1 -1
  72. package/dist/es/api-model/models/charge-component.js +1 -1
  73. package/dist/es/api-model/models/charge-instrument.js +1 -1
  74. package/dist/es/api-model/models/charge-refund-event.js +1 -1
  75. package/dist/es/api-model/models/charge-refund-transaction.js +1 -1
  76. package/dist/es/api-model/models/coupon-payment-event.js +1 -1
  77. package/dist/es/api-model/models/currency.js +1 -1
  78. package/dist/es/api-model/models/debt-recovery-event.js +1 -1
  79. package/dist/es/api-model/models/debt-recovery-item.js +1 -1
  80. package/dist/es/api-model/models/direct-payment.js +1 -1
  81. package/dist/es/api-model/models/ebtrefund-reimbursement-only-event.js +14 -0
  82. package/dist/es/api-model/models/failed-adhoc-disbursement-event.js +1 -1
  83. package/dist/es/api-model/models/fbaliquidation-event.js +1 -1
  84. package/dist/es/api-model/models/fee-component.js +1 -1
  85. package/dist/es/api-model/models/financial-event-group.js +1 -1
  86. package/dist/es/api-model/models/financial-events.js +1 -1
  87. package/dist/es/api-model/models/imaging-services-fee-event.js +1 -1
  88. package/dist/es/api-model/models/index.js +1 -0
  89. package/dist/es/api-model/models/list-financial-event-groups-payload.js +1 -1
  90. package/dist/es/api-model/models/list-financial-event-groups-response.js +1 -1
  91. package/dist/es/api-model/models/list-financial-events-payload.js +1 -1
  92. package/dist/es/api-model/models/list-financial-events-response.js +1 -1
  93. package/dist/es/api-model/models/loan-servicing-event.js +1 -1
  94. package/dist/es/api-model/models/model-error.js +1 -1
  95. package/dist/es/api-model/models/network-commingling-transaction-event.js +1 -1
  96. package/dist/es/api-model/models/pay-with-amazon-event.js +1 -1
  97. package/dist/es/api-model/models/product-ads-payment-event.js +1 -1
  98. package/dist/es/api-model/models/promotion.js +1 -1
  99. package/dist/es/api-model/models/removal-shipment-adjustment-event.js +1 -1
  100. package/dist/es/api-model/models/removal-shipment-event.js +1 -1
  101. package/dist/es/api-model/models/removal-shipment-item-adjustment.js +1 -1
  102. package/dist/es/api-model/models/removal-shipment-item.js +1 -1
  103. package/dist/es/api-model/models/rental-transaction-event.js +1 -1
  104. package/dist/es/api-model/models/retrocharge-event.js +1 -1
  105. package/dist/es/api-model/models/safetreimbursement-event.js +1 -1
  106. package/dist/es/api-model/models/safetreimbursement-item.js +1 -1
  107. package/dist/es/api-model/models/seller-deal-payment-event.js +1 -1
  108. package/dist/es/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  109. package/dist/es/api-model/models/service-fee-event.js +1 -1
  110. package/dist/es/api-model/models/shipment-event.js +1 -1
  111. package/dist/es/api-model/models/shipment-item.js +1 -1
  112. package/dist/es/api-model/models/solution-provider-credit-event.js +1 -1
  113. package/dist/es/api-model/models/tax-withheld-component.js +1 -1
  114. package/dist/es/api-model/models/tax-withholding-event.js +1 -1
  115. package/dist/es/api-model/models/tax-withholding-period.js +1 -1
  116. package/dist/es/api-model/models/tdsreimbursement-event.js +1 -1
  117. package/dist/es/api-model/models/trial-shipment-event.js +1 -1
  118. package/dist/es/api-model/models/value-added-service-charge-event.js +1 -1
  119. package/dist/es/index.js +0 -1
  120. package/dist/types/api-model/api/finances-api.d.ts +59 -59
  121. package/dist/types/api-model/api.d.ts +1 -1
  122. package/dist/types/api-model/base.d.ts +1 -1
  123. package/dist/types/api-model/common.d.ts +1 -1
  124. package/dist/types/api-model/configuration.d.ts +25 -1
  125. package/dist/types/api-model/index.d.ts +1 -1
  126. package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +3 -3
  127. package/dist/types/api-model/models/adjustment-event.d.ts +3 -3
  128. package/dist/types/api-model/models/adjustment-item.d.ts +2 -2
  129. package/dist/types/api-model/models/affordability-expense-event.d.ts +4 -4
  130. package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +3 -3
  131. package/dist/types/api-model/models/charge-component.d.ts +2 -2
  132. package/dist/types/api-model/models/charge-instrument.d.ts +1 -1
  133. package/dist/types/api-model/models/charge-refund-event.d.ts +4 -4
  134. package/dist/types/api-model/models/charge-refund-transaction.d.ts +1 -1
  135. package/dist/types/api-model/models/coupon-payment-event.d.ts +2 -2
  136. package/dist/types/api-model/models/currency.d.ts +2 -2
  137. package/dist/types/api-model/models/debt-recovery-event.d.ts +2 -2
  138. package/dist/types/api-model/models/debt-recovery-item.d.ts +3 -3
  139. package/dist/types/api-model/models/direct-payment.d.ts +2 -2
  140. package/dist/types/api-model/models/ebtrefund-reimbursement-only-event.d.ts +26 -0
  141. package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +5 -5
  142. package/dist/types/api-model/models/fbaliquidation-event.d.ts +2 -2
  143. package/dist/types/api-model/models/fee-component.d.ts +1 -1
  144. package/dist/types/api-model/models/financial-event-group.d.ts +5 -5
  145. package/dist/types/api-model/models/financial-events.d.ts +13 -8
  146. package/dist/types/api-model/models/imaging-services-fee-event.d.ts +2 -2
  147. package/dist/types/api-model/models/index.d.ts +1 -0
  148. package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +2 -2
  149. package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +2 -2
  150. package/dist/types/api-model/models/list-financial-events-payload.d.ts +2 -2
  151. package/dist/types/api-model/models/list-financial-events-response.d.ts +2 -2
  152. package/dist/types/api-model/models/loan-servicing-event.d.ts +2 -2
  153. package/dist/types/api-model/models/model-error.d.ts +1 -1
  154. package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +3 -3
  155. package/dist/types/api-model/models/pay-with-amazon-event.d.ts +5 -5
  156. package/dist/types/api-model/models/product-ads-payment-event.d.ts +4 -4
  157. package/dist/types/api-model/models/promotion.d.ts +1 -1
  158. package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +4 -4
  159. package/dist/types/api-model/models/removal-shipment-event.d.ts +5 -5
  160. package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +3 -3
  161. package/dist/types/api-model/models/removal-shipment-item.d.ts +2 -2
  162. package/dist/types/api-model/models/rental-transaction-event.d.ts +4 -4
  163. package/dist/types/api-model/models/retrocharge-event.d.ts +3 -3
  164. package/dist/types/api-model/models/safetreimbursement-event.d.ts +3 -3
  165. package/dist/types/api-model/models/safetreimbursement-item.d.ts +1 -1
  166. package/dist/types/api-model/models/seller-deal-payment-event.d.ts +4 -4
  167. package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +2 -2
  168. package/dist/types/api-model/models/service-fee-event.d.ts +1 -1
  169. package/dist/types/api-model/models/shipment-event.d.ts +2 -2
  170. package/dist/types/api-model/models/shipment-item.d.ts +1 -1
  171. package/dist/types/api-model/models/solution-provider-credit-event.d.ts +2 -2
  172. package/dist/types/api-model/models/tax-withheld-component.d.ts +2 -2
  173. package/dist/types/api-model/models/tax-withholding-event.d.ts +3 -3
  174. package/dist/types/api-model/models/tax-withholding-period.d.ts +4 -4
  175. package/dist/types/api-model/models/tdsreimbursement-event.d.ts +2 -2
  176. package/dist/types/api-model/models/trial-shipment-event.d.ts +2 -2
  177. package/dist/types/api-model/models/value-added-service-charge-event.d.ts +3 -3
  178. package/dist/types/index.d.ts +1 -1
  179. package/package.json +5 -5
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -23,11 +23,11 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
23
23
  export const FinancesApiAxiosParamCreator = function (configuration) {
24
24
  return {
25
25
  /**
26
- * Returns financial event groups for a given date 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).
27
- * @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\'.
28
- * @param {string} [financialEventGroupStartedBefore] A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.
29
- * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted.
30
- * @param {string} [nextToken] A string token returned in the response of your previous request.
26
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
27
+ * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
28
+ * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
29
+ * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
30
+ * @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.
31
31
  * @param {*} [options] Override http request option.
32
32
  * @throws {RequiredError}
33
33
  */
@@ -58,6 +58,7 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
58
58
  if (nextToken !== undefined) {
59
59
  localVarQueryParameter['NextToken'] = nextToken;
60
60
  }
61
+ localVarHeaderParameter['Accept'] = 'application/json';
61
62
  setSearchParams(localVarUrlObj, localVarQueryParameter);
62
63
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
63
64
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -67,11 +68,11 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
67
68
  };
68
69
  },
69
70
  /**
70
- * 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`, 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).
71
- * @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\'.
72
- * @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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
73
- * @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](https://developer-docs.amazon.com/sp-api/docs/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.
74
- * @param {string} [nextToken] A string token returned in the response of your previous request.
71
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
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 response is `InvalidInput`.
73
+ * @param {string} [postedAfter] The response includes financial events posted after (or 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 more than two minutes before the time of the request.
74
+ * @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. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
75
+ * @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.
75
76
  * @param {*} [options] Override http request option.
76
77
  * @throws {RequiredError}
77
78
  */
@@ -102,6 +103,7 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
102
103
  if (nextToken !== undefined) {
103
104
  localVarQueryParameter['NextToken'] = nextToken;
104
105
  }
106
+ localVarHeaderParameter['Accept'] = 'application/json';
105
107
  setSearchParams(localVarUrlObj, localVarQueryParameter);
106
108
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
107
109
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -111,12 +113,12 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
111
113
  };
112
114
  },
113
115
  /**
114
- * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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).
116
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
115
117
  * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
116
- * @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\'.
117
- * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
118
- * @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](https://developer-docs.amazon.com/sp-api/docs/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.
119
- * @param {string} [nextToken] A string token returned in the response of your previous request.
118
+ * @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 response is `InvalidInput`.
119
+ * @param {string} [postedAfter] The response includes financial events posted after (or 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 more than two minutes before the time of the request.
120
+ * @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. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
121
+ * @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.
120
122
  * @param {*} [options] Override http request option.
121
123
  * @throws {RequiredError}
122
124
  */
@@ -150,6 +152,7 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
150
152
  if (nextToken !== undefined) {
151
153
  localVarQueryParameter['NextToken'] = nextToken;
152
154
  }
155
+ localVarHeaderParameter['Accept'] = 'application/json';
153
156
  setSearchParams(localVarUrlObj, localVarQueryParameter);
154
157
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
155
158
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -159,10 +162,10 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
159
162
  };
160
163
  },
161
164
  /**
162
- * Returns all financial events for the specified order. 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).
165
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
163
166
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
164
- * @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\'.
165
- * @param {string} [nextToken] A string token returned in the response of your previous request.
167
+ * @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 response is `InvalidInput`.
168
+ * @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.
166
169
  * @param {*} [options] Override http request option.
167
170
  * @throws {RequiredError}
168
171
  */
@@ -186,6 +189,7 @@ export const FinancesApiAxiosParamCreator = function (configuration) {
186
189
  if (nextToken !== undefined) {
187
190
  localVarQueryParameter['NextToken'] = nextToken;
188
191
  }
192
+ localVarHeaderParameter['Accept'] = 'application/json';
189
193
  setSearchParams(localVarUrlObj, localVarQueryParameter);
190
194
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
191
195
  localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
@@ -203,11 +207,11 @@ export const FinancesApiFp = function (configuration) {
203
207
  const localVarAxiosParamCreator = FinancesApiAxiosParamCreator(configuration);
204
208
  return {
205
209
  /**
206
- * Returns financial event groups for a given date 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).
207
- * @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\'.
208
- * @param {string} [financialEventGroupStartedBefore] A date used for selecting financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be later than FinancialEventGroupStartedAfter and no later than two minutes before the request was submitted. If FinancialEventGroupStartedAfter and FinancialEventGroupStartedBefore are more than 180 days apart, no financial event groups are returned.
209
- * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be no later than two minutes before the request was submitted.
210
- * @param {string} [nextToken] A string token returned in the response of your previous request.
210
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
211
+ * @param {number} [maxResultsPerPage] The maximum number of results per page. If the response exceeds the maximum number of transactions or 10 MB, the response is `InvalidInput`.
212
+ * @param {string} [financialEventGroupStartedBefore] A date that selects financial event groups that opened before (but not at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be after `FinancialEventGroupStartedAfter` and more than two minutes before the time of request. If `FinancialEventGroupStartedAfter` and `FinancialEventGroupStartedBefore` are more than 180 days apart, no financial event groups are returned.
213
+ * @param {string} [financialEventGroupStartedAfter] A date that selects financial event groups that opened after (or at) a specified date and time, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. The date-time must be more than two minutes before you submit the request.
214
+ * @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.
211
215
  * @param {*} [options] Override http request option.
212
216
  * @throws {RequiredError}
213
217
  */
@@ -218,11 +222,11 @@ export const FinancesApiFp = function (configuration) {
218
222
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
219
223
  },
220
224
  /**
221
- * 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`, 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
- * @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
- * @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](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
224
- * @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](https://developer-docs.amazon.com/sp-api/docs/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.
225
- * @param {string} [nextToken] A string token returned in the response of your previous request.
225
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
226
+ * @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 response is `InvalidInput`.
227
+ * @param {string} [postedAfter] The response includes financial events posted after (or 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 more than two minutes before the time of the request.
228
+ * @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. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
229
+ * @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.
226
230
  * @param {*} [options] Override http request option.
227
231
  * @throws {RequiredError}
228
232
  */
@@ -233,12 +237,12 @@ export const FinancesApiFp = function (configuration) {
233
237
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
234
238
  },
235
239
  /**
236
- * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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).
240
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
237
241
  * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
238
- * @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\'.
239
- * @param {string} [postedAfter] A date used for selecting financial events posted after (or at) a specified time. The date-time **must** be more than two minutes before the time of the request, in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
240
- * @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](https://developer-docs.amazon.com/sp-api/docs/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.
241
- * @param {string} [nextToken] A string token returned in the response of your previous request.
242
+ * @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 response is `InvalidInput`.
243
+ * @param {string} [postedAfter] The response includes financial events posted after (or 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 more than two minutes before the time of the request.
244
+ * @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. If you include the `PostedBefore` parameter in your request, you must also specify the `PostedAfter` parameter. **Default:** Two minutes before the time of the request.
245
+ * @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.
242
246
  * @param {*} [options] Override http request option.
243
247
  * @throws {RequiredError}
244
248
  */
@@ -249,10 +253,10 @@ export const FinancesApiFp = function (configuration) {
249
253
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
250
254
  },
251
255
  /**
252
- * Returns all financial events for the specified order. 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).
256
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
253
257
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
254
- * @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\'.
255
- * @param {string} [nextToken] A string token returned in the response of your previous request.
258
+ * @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 response is `InvalidInput`.
259
+ * @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.
256
260
  * @param {*} [options] Override http request option.
257
261
  * @throws {RequiredError}
258
262
  */
@@ -271,7 +275,7 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
271
275
  const localVarFp = FinancesApiFp(configuration);
272
276
  return {
273
277
  /**
274
- * Returns financial event groups for a given date 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).
278
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
275
279
  * @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
276
280
  * @param {*} [options] Override http request option.
277
281
  * @throws {RequiredError}
@@ -280,7 +284,7 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
280
284
  return localVarFp.listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(axios, basePath));
281
285
  },
282
286
  /**
283
- * 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`, 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
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
284
288
  * @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
285
289
  * @param {*} [options] Override http request option.
286
290
  * @throws {RequiredError}
@@ -289,7 +293,7 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
289
293
  return localVarFp.listFinancialEvents(requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
290
294
  },
291
295
  /**
292
- * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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).
296
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
293
297
  * @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
294
298
  * @param {*} [options] Override http request option.
295
299
  * @throws {RequiredError}
@@ -298,7 +302,7 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
298
302
  return localVarFp.listFinancialEventsByGroupId(requestParameters.eventGroupId, requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
299
303
  },
300
304
  /**
301
- * Returns all financial events for the specified order. 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).
305
+ * Returns all financial events for the specified order. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
302
306
  * @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
303
307
  * @param {*} [options] Override http request option.
304
308
  * @throws {RequiredError}
@@ -313,7 +317,7 @@ export const FinancesApiFactory = function (configuration, basePath, axios) {
313
317
  */
314
318
  export class FinancesApi extends BaseAPI {
315
319
  /**
316
- * Returns financial event groups for a given date 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).
320
+ * Returns financial event groups for a given date range. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
317
321
  * @param {FinancesApiListFinancialEventGroupsRequest} requestParameters Request parameters.
318
322
  * @param {*} [options] Override http request option.
319
323
  * @throws {RequiredError}
@@ -322,7 +326,7 @@ export class FinancesApi extends BaseAPI {
322
326
  return FinancesApiFp(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
323
327
  }
324
328
  /**
325
- * 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`, 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).
329
+ * Returns financial events for the specified data range. Orders from the last 48 hours might not be included in financial events. **Note:** in `ListFinancialEvents`, deferred events don\'t show up in responses until 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
326
330
  * @param {FinancesApiListFinancialEventsRequest} requestParameters Request parameters.
327
331
  * @param {*} [options] Override http request option.
328
332
  * @throws {RequiredError}
@@ -331,7 +335,7 @@ export class FinancesApi extends BaseAPI {
331
335
  return FinancesApiFp(this.configuration).listFinancialEvents(requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
332
336
  }
333
337
  /**
334
- * Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events. **Note:** This operation will only retrieve group\'s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned. **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).
338
+ * Returns all financial events for the specified financial event group. Orders from the last 48 hours might not be included in financial events. **Note:** This operation only retrieves a group\'s data for the past two years. A request for data spanning more than two years produces an empty response. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
335
339
  * @param {FinancesApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
336
340
  * @param {*} [options] Override http request option.
337
341
  * @throws {RequiredError}
@@ -340,7 +344,7 @@ export class FinancesApi extends BaseAPI {
340
344
  return FinancesApiFp(this.configuration).listFinancialEventsByGroupId(requestParameters.eventGroupId, requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
341
345
  }
342
346
  /**
343
- * Returns all financial events for the specified order. 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 all financial events for the specified order. Orders from the last 48 hours might not be included in 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can 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).
344
348
  * @param {FinancesApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
345
349
  * @param {*} [options] Override http request option.
346
350
  * @throws {RequiredError}
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -1,8 +1,7 @@
1
1
  /* tslint:disable */
2
- /* eslint-disable */
3
2
  /**
4
3
  * 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.
4
+ * The Selling Partner API for Finances provides financial information that is 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
5
  *
7
6
  * The version of the OpenAPI document: v0
8
7
  *
@@ -31,6 +30,17 @@ export class Configuration {
31
30
  * @param scopes oauth2 scope
32
31
  */
33
32
  accessToken;
33
+ /**
34
+ * parameter for aws4 signature security
35
+ * @param {Object} AWS4Signature - AWS4 Signature security
36
+ * @param {string} options.region - aws region
37
+ * @param {string} options.service - name of the service.
38
+ * @param {string} credentials.accessKeyId - aws access key id
39
+ * @param {string} credentials.secretAccessKey - aws access key
40
+ * @param {string} credentials.sessionToken - aws session token
41
+ * @memberof Configuration
42
+ */
43
+ awsv4;
34
44
  /**
35
45
  * override base path
36
46
  */
@@ -56,6 +66,7 @@ export class Configuration {
56
66
  this.username = param.username;
57
67
  this.password = param.password;
58
68
  this.accessToken = param.accessToken;
69
+ this.awsv4 = param.awsv4;
59
70
  this.basePath = param.basePath;
60
71
  this.serverIndex = param.serverIndex;
61
72
  this.baseOptions = {
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Finances
5
+ * The Selling Partner API for Finances provides financial information that is 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 {};
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /**
4
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.
5
+ * The Selling Partner API for Finances provides financial information that is 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
6
  *
7
7
  * The version of the OpenAPI document: v0
8
8
  *