@sp-api-sdk/finances-api-v0 1.7.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 (165) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +58 -0
  3. package/dist/cjs/index.js +6 -0
  4. package/dist/cjs/src/api-model/api/default-api.js +357 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/adjustment-event.js +15 -0
  11. package/dist/cjs/src/api-model/models/adjustment-item.js +15 -0
  12. package/dist/cjs/src/api-model/models/affordability-expense-event.js +15 -0
  13. package/dist/cjs/src/api-model/models/charge-component.js +15 -0
  14. package/dist/cjs/src/api-model/models/charge-instrument.js +15 -0
  15. package/dist/cjs/src/api-model/models/coupon-payment-event.js +15 -0
  16. package/dist/cjs/src/api-model/models/currency.js +15 -0
  17. package/dist/cjs/src/api-model/models/debt-recovery-event.js +15 -0
  18. package/dist/cjs/src/api-model/models/debt-recovery-item.js +15 -0
  19. package/dist/cjs/src/api-model/models/direct-payment.js +15 -0
  20. package/dist/cjs/src/api-model/models/fbaliquidation-event.js +15 -0
  21. package/dist/cjs/src/api-model/models/fee-component.js +15 -0
  22. package/dist/cjs/src/api-model/models/financial-event-group.js +15 -0
  23. package/dist/cjs/src/api-model/models/financial-events.js +15 -0
  24. package/dist/cjs/src/api-model/models/imaging-services-fee-event.js +15 -0
  25. package/dist/cjs/src/api-model/models/index.js +46 -0
  26. package/dist/cjs/src/api-model/models/list-financial-event-groups-payload.js +15 -0
  27. package/dist/cjs/src/api-model/models/list-financial-event-groups-response.js +15 -0
  28. package/dist/cjs/src/api-model/models/list-financial-events-payload.js +15 -0
  29. package/dist/cjs/src/api-model/models/list-financial-events-response.js +15 -0
  30. package/dist/cjs/src/api-model/models/loan-servicing-event.js +15 -0
  31. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  32. package/dist/cjs/src/api-model/models/network-commingling-transaction-event.js +15 -0
  33. package/dist/cjs/src/api-model/models/pay-with-amazon-event.js +15 -0
  34. package/dist/cjs/src/api-model/models/product-ads-payment-event.js +15 -0
  35. package/dist/cjs/src/api-model/models/promotion.js +15 -0
  36. package/dist/cjs/src/api-model/models/removal-shipment-adjustment-event.js +15 -0
  37. package/dist/cjs/src/api-model/models/removal-shipment-event.js +15 -0
  38. package/dist/cjs/src/api-model/models/removal-shipment-item-adjustment.js +15 -0
  39. package/dist/cjs/src/api-model/models/removal-shipment-item.js +15 -0
  40. package/dist/cjs/src/api-model/models/rental-transaction-event.js +15 -0
  41. package/dist/cjs/src/api-model/models/retrocharge-event.js +15 -0
  42. package/dist/cjs/src/api-model/models/safetreimbursement-event.js +15 -0
  43. package/dist/cjs/src/api-model/models/safetreimbursement-item.js +15 -0
  44. package/dist/cjs/src/api-model/models/seller-deal-payment-event.js +15 -0
  45. package/dist/cjs/src/api-model/models/seller-review-enrollment-payment-event.js +15 -0
  46. package/dist/cjs/src/api-model/models/service-fee-event.js +15 -0
  47. package/dist/cjs/src/api-model/models/shipment-event.js +15 -0
  48. package/dist/cjs/src/api-model/models/shipment-item.js +15 -0
  49. package/dist/cjs/src/api-model/models/solution-provider-credit-event.js +15 -0
  50. package/dist/cjs/src/api-model/models/tax-withheld-component.js +15 -0
  51. package/dist/cjs/src/api-model/models/tax-withholding-event.js +15 -0
  52. package/dist/cjs/src/api-model/models/tax-withholding-period.js +15 -0
  53. package/dist/cjs/src/api-model/models/tdsreimbursement-event.js +15 -0
  54. package/dist/cjs/src/api-model/models/trial-shipment-event.js +15 -0
  55. package/dist/cjs/src/client.js +53 -0
  56. package/dist/cjs/src/error.js +10 -0
  57. package/dist/es/index.js +3 -0
  58. package/dist/es/src/api-model/api/default-api.js +349 -0
  59. package/dist/es/src/api-model/api.js +14 -0
  60. package/dist/es/src/api-model/base.js +56 -0
  61. package/dist/es/src/api-model/common.js +125 -0
  62. package/dist/es/src/api-model/configuration.js +38 -0
  63. package/dist/es/src/api-model/index.js +16 -0
  64. package/dist/es/src/api-model/models/adjustment-event.js +14 -0
  65. package/dist/es/src/api-model/models/adjustment-item.js +14 -0
  66. package/dist/es/src/api-model/models/affordability-expense-event.js +14 -0
  67. package/dist/es/src/api-model/models/charge-component.js +14 -0
  68. package/dist/es/src/api-model/models/charge-instrument.js +14 -0
  69. package/dist/es/src/api-model/models/coupon-payment-event.js +14 -0
  70. package/dist/es/src/api-model/models/currency.js +14 -0
  71. package/dist/es/src/api-model/models/debt-recovery-event.js +14 -0
  72. package/dist/es/src/api-model/models/debt-recovery-item.js +14 -0
  73. package/dist/es/src/api-model/models/direct-payment.js +14 -0
  74. package/dist/es/src/api-model/models/fbaliquidation-event.js +14 -0
  75. package/dist/es/src/api-model/models/fee-component.js +14 -0
  76. package/dist/es/src/api-model/models/financial-event-group.js +14 -0
  77. package/dist/es/src/api-model/models/financial-events.js +14 -0
  78. package/dist/es/src/api-model/models/imaging-services-fee-event.js +14 -0
  79. package/dist/es/src/api-model/models/index.js +43 -0
  80. package/dist/es/src/api-model/models/list-financial-event-groups-payload.js +14 -0
  81. package/dist/es/src/api-model/models/list-financial-event-groups-response.js +14 -0
  82. package/dist/es/src/api-model/models/list-financial-events-payload.js +14 -0
  83. package/dist/es/src/api-model/models/list-financial-events-response.js +14 -0
  84. package/dist/es/src/api-model/models/loan-servicing-event.js +14 -0
  85. package/dist/es/src/api-model/models/model-error.js +14 -0
  86. package/dist/es/src/api-model/models/network-commingling-transaction-event.js +14 -0
  87. package/dist/es/src/api-model/models/pay-with-amazon-event.js +14 -0
  88. package/dist/es/src/api-model/models/product-ads-payment-event.js +14 -0
  89. package/dist/es/src/api-model/models/promotion.js +14 -0
  90. package/dist/es/src/api-model/models/removal-shipment-adjustment-event.js +14 -0
  91. package/dist/es/src/api-model/models/removal-shipment-event.js +14 -0
  92. package/dist/es/src/api-model/models/removal-shipment-item-adjustment.js +14 -0
  93. package/dist/es/src/api-model/models/removal-shipment-item.js +14 -0
  94. package/dist/es/src/api-model/models/rental-transaction-event.js +14 -0
  95. package/dist/es/src/api-model/models/retrocharge-event.js +14 -0
  96. package/dist/es/src/api-model/models/safetreimbursement-event.js +14 -0
  97. package/dist/es/src/api-model/models/safetreimbursement-item.js +14 -0
  98. package/dist/es/src/api-model/models/seller-deal-payment-event.js +14 -0
  99. package/dist/es/src/api-model/models/seller-review-enrollment-payment-event.js +14 -0
  100. package/dist/es/src/api-model/models/service-fee-event.js +14 -0
  101. package/dist/es/src/api-model/models/shipment-event.js +14 -0
  102. package/dist/es/src/api-model/models/shipment-item.js +14 -0
  103. package/dist/es/src/api-model/models/solution-provider-credit-event.js +14 -0
  104. package/dist/es/src/api-model/models/tax-withheld-component.js +14 -0
  105. package/dist/es/src/api-model/models/tax-withholding-event.js +14 -0
  106. package/dist/es/src/api-model/models/tax-withholding-period.js +14 -0
  107. package/dist/es/src/api-model/models/tdsreimbursement-event.js +14 -0
  108. package/dist/es/src/api-model/models/trial-shipment-event.js +14 -0
  109. package/dist/es/src/client.js +49 -0
  110. package/dist/es/src/error.js +6 -0
  111. package/dist/types/index.d.ts +3 -0
  112. package/dist/types/src/api-model/api/default-api.d.ts +300 -0
  113. package/dist/types/src/api-model/api.d.ts +12 -0
  114. package/dist/types/src/api-model/base.d.ts +55 -0
  115. package/dist/types/src/api-model/common.d.ts +65 -0
  116. package/dist/types/src/api-model/configuration.d.ts +83 -0
  117. package/dist/types/src/api-model/index.d.ts +14 -0
  118. package/dist/types/src/api-model/models/adjustment-event.d.ts +44 -0
  119. package/dist/types/src/api-model/models/adjustment-item.d.ts +61 -0
  120. package/dist/types/src/api-model/models/affordability-expense-event.d.ts +73 -0
  121. package/dist/types/src/api-model/models/charge-component.d.ts +31 -0
  122. package/dist/types/src/api-model/models/charge-instrument.d.ts +37 -0
  123. package/dist/types/src/api-model/models/coupon-payment-event.d.ts +69 -0
  124. package/dist/types/src/api-model/models/currency.d.ts +30 -0
  125. package/dist/types/src/api-model/models/debt-recovery-event.d.ts +51 -0
  126. package/dist/types/src/api-model/models/debt-recovery-item.d.ts +43 -0
  127. package/dist/types/src/api-model/models/direct-payment.d.ts +31 -0
  128. package/dist/types/src/api-model/models/fbaliquidation-event.d.ts +43 -0
  129. package/dist/types/src/api-model/models/fee-component.d.ts +31 -0
  130. package/dist/types/src/api-model/models/financial-event-group.d.ts +85 -0
  131. package/dist/types/src/api-model/models/financial-events.d.ts +202 -0
  132. package/dist/types/src/api-model/models/imaging-services-fee-event.d.ts +43 -0
  133. package/dist/types/src/api-model/models/index.d.ts +43 -0
  134. package/dist/types/src/api-model/models/list-financial-event-groups-payload.d.ts +31 -0
  135. package/dist/types/src/api-model/models/list-financial-event-groups-response.d.ts +31 -0
  136. package/dist/types/src/api-model/models/list-financial-events-payload.d.ts +31 -0
  137. package/dist/types/src/api-model/models/list-financial-events-response.d.ts +31 -0
  138. package/dist/types/src/api-model/models/loan-servicing-event.d.ts +31 -0
  139. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  140. package/dist/types/src/api-model/models/network-commingling-transaction-event.d.ts +67 -0
  141. package/dist/types/src/api-model/models/pay-with-amazon-event.d.ts +80 -0
  142. package/dist/types/src/api-model/models/product-ads-payment-event.d.ts +55 -0
  143. package/dist/types/src/api-model/models/promotion.d.ts +37 -0
  144. package/dist/types/src/api-model/models/removal-shipment-adjustment-event.d.ts +55 -0
  145. package/dist/types/src/api-model/models/removal-shipment-event.d.ts +49 -0
  146. package/dist/types/src/api-model/models/removal-shipment-item-adjustment.d.ts +61 -0
  147. package/dist/types/src/api-model/models/removal-shipment-item.d.ts +67 -0
  148. package/dist/types/src/api-model/models/rental-transaction-event.d.ts +82 -0
  149. package/dist/types/src/api-model/models/retrocharge-event.d.ts +62 -0
  150. package/dist/types/src/api-model/models/safetreimbursement-event.d.ts +50 -0
  151. package/dist/types/src/api-model/models/safetreimbursement-item.d.ts +37 -0
  152. package/dist/types/src/api-model/models/seller-deal-payment-event.d.ts +67 -0
  153. package/dist/types/src/api-model/models/seller-review-enrollment-payment-event.d.ts +57 -0
  154. package/dist/types/src/api-model/models/service-fee-event.d.ts +61 -0
  155. package/dist/types/src/api-model/models/shipment-event.d.ts +100 -0
  156. package/dist/types/src/api-model/models/shipment-item.d.ts +101 -0
  157. package/dist/types/src/api-model/models/solution-provider-credit-event.d.ts +79 -0
  158. package/dist/types/src/api-model/models/tax-withheld-component.d.ts +31 -0
  159. package/dist/types/src/api-model/models/tax-withholding-event.d.ts +44 -0
  160. package/dist/types/src/api-model/models/tax-withholding-period.d.ts +30 -0
  161. package/dist/types/src/api-model/models/tdsreimbursement-event.d.ts +37 -0
  162. package/dist/types/src/api-model/models/trial-shipment-event.d.ts +49 -0
  163. package/dist/types/src/client.d.ts +13 -0
  164. package/dist/types/src/error.d.ts +3 -0
  165. package/package.json +53 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2021 Bizon
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # `finances-api-v0`
2
+
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
+ ## Installing
6
+
7
+ ```sh
8
+ yarn add @sp-api-sdk/finances-api-v0
9
+ ```
10
+
11
+ ```sh
12
+ npm install @sp-api-sdk/finances-api-v0
13
+ ```
14
+
15
+ ## Getting Started
16
+
17
+ ```javascript
18
+ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
19
+ import {FinancesApiClient} from '@sp-api-sdk/finances-api-v0'
20
+
21
+ const auth = new SellingPartnerApiAuth({
22
+ clientId: '',
23
+ clientSecret: '',
24
+ refreshToken: '',
25
+ secretAccessKey: '',
26
+ accessKeyId: '',
27
+ region: '',
28
+ role: {
29
+ arn: '',
30
+ }
31
+ })
32
+
33
+ const client = new FinancesApiClient({
34
+ auth,
35
+ region: 'eu' // or 'eu-west-1'
36
+ })
37
+ ```
38
+
39
+ ## Handle Rate Limiting
40
+
41
+ If you want to let the SDK retry after each 429 responses, instanciate the client like this:
42
+
43
+ ```javascript
44
+ const client = new FinancesApiClient({
45
+ auth,
46
+ region: 'eu',
47
+ rateLimiting: {
48
+ retry: true,
49
+ onRetry: (retryInfo) => console.log(retryInfo) // Optional
50
+ }
51
+ })
52
+ ```
53
+
54
+ The SDK gets the rate limits for each routes from the API documentation
55
+
56
+ ## API documentation
57
+
58
+ See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/finances-api/financesV0.md)
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const tslib_1 = require("tslib");
4
+ (0, tslib_1.__exportStar)(require("./src/client"), exports);
5
+ (0, tslib_1.__exportStar)(require("./src/error"), exports);
6
+ (0, tslib_1.__exportStar)(require("./src/api-model/models"), exports);
@@ -0,0 +1,357 @@
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.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
17
+ const tslib_1 = require("tslib");
18
+ const axios_1 = (0, tslib_1.__importDefault)(require("axios"));
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ const common_1 = require("../common");
22
+ // @ts-ignore
23
+ const base_1 = require("../base");
24
+ /**
25
+ * DefaultApi - axios parameter creator
26
+ * @export
27
+ */
28
+ const DefaultApiAxiosParamCreator = function (configuration) {
29
+ return {
30
+ /**
31
+ * Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
32
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
33
+ * @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 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.
34
+ * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.
35
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ listFinancialEventGroups: async (maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options = {}) => {
40
+ const localVarPath = `/finances/v0/financialEventGroups`;
41
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
43
+ let baseOptions;
44
+ if (configuration) {
45
+ baseOptions = configuration.baseOptions;
46
+ }
47
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
48
+ const localVarHeaderParameter = {};
49
+ const localVarQueryParameter = {};
50
+ if (maxResultsPerPage !== undefined) {
51
+ localVarQueryParameter['MaxResultsPerPage'] = maxResultsPerPage;
52
+ }
53
+ if (financialEventGroupStartedBefore !== undefined) {
54
+ localVarQueryParameter['FinancialEventGroupStartedBefore'] = (financialEventGroupStartedBefore instanceof Date) ?
55
+ financialEventGroupStartedBefore.toISOString() :
56
+ financialEventGroupStartedBefore;
57
+ }
58
+ if (financialEventGroupStartedAfter !== undefined) {
59
+ localVarQueryParameter['FinancialEventGroupStartedAfter'] = (financialEventGroupStartedAfter instanceof Date) ?
60
+ financialEventGroupStartedAfter.toISOString() :
61
+ financialEventGroupStartedAfter;
62
+ }
63
+ if (nextToken !== undefined) {
64
+ localVarQueryParameter['NextToken'] = nextToken;
65
+ }
66
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
67
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
68
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
69
+ return {
70
+ url: (0, common_1.toPathString)(localVarUrlObj),
71
+ options: localVarRequestOptions,
72
+ };
73
+ },
74
+ /**
75
+ * Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
76
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
77
+ * @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.
78
+ * @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.
79
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ listFinancialEvents: async (maxResultsPerPage, postedAfter, postedBefore, nextToken, options = {}) => {
84
+ const localVarPath = `/finances/v0/financialEvents`;
85
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
86
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
87
+ let baseOptions;
88
+ if (configuration) {
89
+ baseOptions = configuration.baseOptions;
90
+ }
91
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
92
+ const localVarHeaderParameter = {};
93
+ const localVarQueryParameter = {};
94
+ if (maxResultsPerPage !== undefined) {
95
+ localVarQueryParameter['MaxResultsPerPage'] = maxResultsPerPage;
96
+ }
97
+ if (postedAfter !== undefined) {
98
+ localVarQueryParameter['PostedAfter'] = (postedAfter instanceof Date) ?
99
+ postedAfter.toISOString() :
100
+ postedAfter;
101
+ }
102
+ if (postedBefore !== undefined) {
103
+ localVarQueryParameter['PostedBefore'] = (postedBefore instanceof Date) ?
104
+ postedBefore.toISOString() :
105
+ postedBefore;
106
+ }
107
+ if (nextToken !== undefined) {
108
+ localVarQueryParameter['NextToken'] = nextToken;
109
+ }
110
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
111
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
112
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
113
+ return {
114
+ url: (0, common_1.toPathString)(localVarUrlObj),
115
+ options: localVarRequestOptions,
116
+ };
117
+ },
118
+ /**
119
+ * Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
120
+ * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
121
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
122
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
123
+ * @param {*} [options] Override http request option.
124
+ * @throws {RequiredError}
125
+ */
126
+ listFinancialEventsByGroupId: async (eventGroupId, maxResultsPerPage, nextToken, options = {}) => {
127
+ // verify required parameter 'eventGroupId' is not null or undefined
128
+ (0, common_1.assertParamExists)('listFinancialEventsByGroupId', 'eventGroupId', eventGroupId);
129
+ const localVarPath = `/finances/v0/financialEventGroups/{eventGroupId}/financialEvents`
130
+ .replace(`{${"eventGroupId"}}`, encodeURIComponent(String(eventGroupId)));
131
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
132
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
133
+ let baseOptions;
134
+ if (configuration) {
135
+ baseOptions = configuration.baseOptions;
136
+ }
137
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
138
+ const localVarHeaderParameter = {};
139
+ const localVarQueryParameter = {};
140
+ if (maxResultsPerPage !== undefined) {
141
+ localVarQueryParameter['MaxResultsPerPage'] = maxResultsPerPage;
142
+ }
143
+ if (nextToken !== undefined) {
144
+ localVarQueryParameter['NextToken'] = nextToken;
145
+ }
146
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
147
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
148
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
149
+ return {
150
+ url: (0, common_1.toPathString)(localVarUrlObj),
151
+ options: localVarRequestOptions,
152
+ };
153
+ },
154
+ /**
155
+ * Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
156
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
157
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
158
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ listFinancialEventsByOrderId: async (orderId, maxResultsPerPage, nextToken, options = {}) => {
163
+ // verify required parameter 'orderId' is not null or undefined
164
+ (0, common_1.assertParamExists)('listFinancialEventsByOrderId', 'orderId', orderId);
165
+ const localVarPath = `/finances/v0/orders/{orderId}/financialEvents`
166
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
167
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
168
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
169
+ let baseOptions;
170
+ if (configuration) {
171
+ baseOptions = configuration.baseOptions;
172
+ }
173
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
174
+ const localVarHeaderParameter = {};
175
+ const localVarQueryParameter = {};
176
+ if (maxResultsPerPage !== undefined) {
177
+ localVarQueryParameter['MaxResultsPerPage'] = maxResultsPerPage;
178
+ }
179
+ if (nextToken !== undefined) {
180
+ localVarQueryParameter['NextToken'] = nextToken;
181
+ }
182
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
183
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
184
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
185
+ return {
186
+ url: (0, common_1.toPathString)(localVarUrlObj),
187
+ options: localVarRequestOptions,
188
+ };
189
+ },
190
+ };
191
+ };
192
+ exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
193
+ /**
194
+ * DefaultApi - functional programming interface
195
+ * @export
196
+ */
197
+ const DefaultApiFp = function (configuration) {
198
+ const localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
199
+ return {
200
+ /**
201
+ * Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
202
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
203
+ * @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 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.
204
+ * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.
205
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
206
+ * @param {*} [options] Override http request option.
207
+ * @throws {RequiredError}
208
+ */
209
+ async listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options) {
210
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options);
211
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
212
+ },
213
+ /**
214
+ * Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
215
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
216
+ * @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.
217
+ * @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.
218
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ async listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
223
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options);
224
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
225
+ },
226
+ /**
227
+ * Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
228
+ * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
229
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
230
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
231
+ * @param {*} [options] Override http request option.
232
+ * @throws {RequiredError}
233
+ */
234
+ async listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, nextToken, options) {
235
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, nextToken, options);
236
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
237
+ },
238
+ /**
239
+ * Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
240
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
241
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
242
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ async listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options) {
247
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options);
248
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
249
+ },
250
+ };
251
+ };
252
+ exports.DefaultApiFp = DefaultApiFp;
253
+ /**
254
+ * DefaultApi - factory interface
255
+ * @export
256
+ */
257
+ const DefaultApiFactory = function (configuration, basePath, axios) {
258
+ const localVarFp = (0, exports.DefaultApiFp)(configuration);
259
+ return {
260
+ /**
261
+ * Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
262
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
263
+ * @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 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.
264
+ * @param {string} [financialEventGroupStartedAfter] A date used for selecting financial event groups that opened after (or at) a specified date and time, in ISO 8601 format. The date-time must be no later than two minutes before the request was submitted.
265
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options) {
270
+ return localVarFp.listFinancialEventGroups(maxResultsPerPage, financialEventGroupStartedBefore, financialEventGroupStartedAfter, nextToken, options).then((request) => request(axios, basePath));
271
+ },
272
+ /**
273
+ * Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
274
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
275
+ * @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.
276
+ * @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.
277
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
278
+ * @param {*} [options] Override http request option.
279
+ * @throws {RequiredError}
280
+ */
281
+ listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options) {
282
+ return localVarFp.listFinancialEvents(maxResultsPerPage, postedAfter, postedBefore, nextToken, options).then((request) => request(axios, basePath));
283
+ },
284
+ /**
285
+ * Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
286
+ * @param {string} eventGroupId The identifier of the financial event group to which the events belong.
287
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
288
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
289
+ * @param {*} [options] Override http request option.
290
+ * @throws {RequiredError}
291
+ */
292
+ listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, nextToken, options) {
293
+ return localVarFp.listFinancialEventsByGroupId(eventGroupId, maxResultsPerPage, nextToken, options).then((request) => request(axios, basePath));
294
+ },
295
+ /**
296
+ * Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
297
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
298
+ * @param {number} [maxResultsPerPage] The maximum number of results to return per page.
299
+ * @param {string} [nextToken] A string token returned in the response of your previous request.
300
+ * @param {*} [options] Override http request option.
301
+ * @throws {RequiredError}
302
+ */
303
+ listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options) {
304
+ return localVarFp.listFinancialEventsByOrderId(orderId, maxResultsPerPage, nextToken, options).then((request) => request(axios, basePath));
305
+ },
306
+ };
307
+ };
308
+ exports.DefaultApiFactory = DefaultApiFactory;
309
+ /**
310
+ * DefaultApi - object-oriented interface
311
+ * @export
312
+ * @class DefaultApi
313
+ * @extends {BaseAPI}
314
+ */
315
+ class DefaultApi extends base_1.BaseAPI {
316
+ /**
317
+ * Returns financial event groups for a given date range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
318
+ * @param {DefaultApiListFinancialEventGroupsRequest} requestParameters Request parameters.
319
+ * @param {*} [options] Override http request option.
320
+ * @throws {RequiredError}
321
+ * @memberof DefaultApi
322
+ */
323
+ listFinancialEventGroups(requestParameters = {}, options) {
324
+ return (0, exports.DefaultApiFp)(this.configuration).listFinancialEventGroups(requestParameters.maxResultsPerPage, requestParameters.financialEventGroupStartedBefore, requestParameters.financialEventGroupStartedAfter, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
325
+ }
326
+ /**
327
+ * Returns financial events for the specified data range. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
328
+ * @param {DefaultApiListFinancialEventsRequest} requestParameters Request parameters.
329
+ * @param {*} [options] Override http request option.
330
+ * @throws {RequiredError}
331
+ * @memberof DefaultApi
332
+ */
333
+ listFinancialEvents(requestParameters = {}, options) {
334
+ return (0, exports.DefaultApiFp)(this.configuration).listFinancialEvents(requestParameters.maxResultsPerPage, requestParameters.postedAfter, requestParameters.postedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
335
+ }
336
+ /**
337
+ * Returns all financial events for the specified financial event group. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
338
+ * @param {DefaultApiListFinancialEventsByGroupIdRequest} requestParameters Request parameters.
339
+ * @param {*} [options] Override http request option.
340
+ * @throws {RequiredError}
341
+ * @memberof DefaultApi
342
+ */
343
+ listFinancialEventsByGroupId(requestParameters, options) {
344
+ return (0, exports.DefaultApiFp)(this.configuration).listFinancialEventsByGroupId(requestParameters.eventGroupId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
345
+ }
346
+ /**
347
+ * Returns all financial events for the specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
348
+ * @param {DefaultApiListFinancialEventsByOrderIdRequest} requestParameters Request parameters.
349
+ * @param {*} [options] Override http request option.
350
+ * @throws {RequiredError}
351
+ * @memberof DefaultApi
352
+ */
353
+ listFinancialEventsByOrderId(requestParameters, options) {
354
+ return (0, exports.DefaultApiFp)(this.configuration).listFinancialEventsByOrderId(requestParameters.orderId, requestParameters.maxResultsPerPage, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
355
+ }
356
+ }
357
+ exports.DefaultApi = DefaultApi;
@@ -0,0 +1,17 @@
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
+ const tslib_1 = require("tslib");
17
+ (0, tslib_1.__exportStar)(require("./api/default-api"), exports);