@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
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ChargeComponent } from './charge-component';
13
+ /**
14
+ * Information about the taxes withheld.
15
+ * @export
16
+ * @interface TaxWithheldComponent
17
+ */
18
+ export interface TaxWithheldComponent {
19
+ /**
20
+ * The tax collection model applied to the item. Possible values: * MarketplaceFacilitator - Tax is withheld and remitted to the taxing authority by Amazon on behalf of the seller. * Standard - Tax is paid to the seller and not remitted to the taxing authority by Amazon.
21
+ * @type {string}
22
+ * @memberof TaxWithheldComponent
23
+ */
24
+ TaxCollectionModel?: string;
25
+ /**
26
+ * A list of charge information on the seller\'s account.
27
+ * @type {Array<ChargeComponent>}
28
+ * @memberof TaxWithheldComponent
29
+ */
30
+ TaxesWithheld?: Array<ChargeComponent>;
31
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Currency } from './currency';
13
+ import { TaxWithholdingPeriod } from './tax-withholding-period';
14
+ /**
15
+ * A TaxWithholding event on seller\'s account.
16
+ * @export
17
+ * @interface TaxWithholdingEvent
18
+ */
19
+ export interface TaxWithholdingEvent {
20
+ /**
21
+ *
22
+ * @type {string}
23
+ * @memberof TaxWithholdingEvent
24
+ */
25
+ PostedDate?: string;
26
+ /**
27
+ *
28
+ * @type {Currency}
29
+ * @memberof TaxWithholdingEvent
30
+ */
31
+ BaseAmount?: Currency;
32
+ /**
33
+ *
34
+ * @type {Currency}
35
+ * @memberof TaxWithholdingEvent
36
+ */
37
+ WithheldAmount?: Currency;
38
+ /**
39
+ *
40
+ * @type {TaxWithholdingPeriod}
41
+ * @memberof TaxWithholdingEvent
42
+ */
43
+ TaxWithholdingPeriod?: TaxWithholdingPeriod;
44
+ }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Period which taxwithholding on seller\'s account is calculated.
14
+ * @export
15
+ * @interface TaxWithholdingPeriod
16
+ */
17
+ export interface TaxWithholdingPeriod {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof TaxWithholdingPeriod
22
+ */
23
+ StartDate?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof TaxWithholdingPeriod
28
+ */
29
+ EndDate?: string;
30
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { Currency } from './currency';
13
+ /**
14
+ * A tax deduction at source (TDS) claim reimbursement event on the seller\'s account.
15
+ * @export
16
+ * @interface TDSReimbursementEvent
17
+ */
18
+ export interface TDSReimbursementEvent {
19
+ /**
20
+ *
21
+ * @type {string}
22
+ * @memberof TDSReimbursementEvent
23
+ */
24
+ PostedDate?: string;
25
+ /**
26
+ * A tax deduction at source (TDS) claim identifier.
27
+ * @type {string}
28
+ * @memberof TDSReimbursementEvent
29
+ */
30
+ TdsOrderId?: string;
31
+ /**
32
+ *
33
+ * @type {Currency}
34
+ * @memberof TDSReimbursementEvent
35
+ */
36
+ ReimbursedAmount?: Currency;
37
+ }
@@ -0,0 +1,49 @@
1
+ /**
2
+ * Selling Partner API for Finances
3
+ * The Selling Partner API for Finances helps you obtain financial information relevant to a seller\'s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { FeeComponent } from './fee-component';
13
+ /**
14
+ * An event related to a trial shipment.
15
+ * @export
16
+ * @interface TrialShipmentEvent
17
+ */
18
+ export interface TrialShipmentEvent {
19
+ /**
20
+ * An Amazon-defined identifier for an order.
21
+ * @type {string}
22
+ * @memberof TrialShipmentEvent
23
+ */
24
+ AmazonOrderId?: string;
25
+ /**
26
+ * The identifier of the financial event group.
27
+ * @type {string}
28
+ * @memberof TrialShipmentEvent
29
+ */
30
+ FinancialEventGroupId?: string;
31
+ /**
32
+ *
33
+ * @type {string}
34
+ * @memberof TrialShipmentEvent
35
+ */
36
+ PostedDate?: string;
37
+ /**
38
+ * The seller SKU of the item. The seller SKU is qualified by the seller\'s seller ID, which is included with every call to the Selling Partner API.
39
+ * @type {string}
40
+ * @memberof TrialShipmentEvent
41
+ */
42
+ SKU?: string;
43
+ /**
44
+ * A list of fee component information.
45
+ * @type {Array<FeeComponent>}
46
+ * @memberof TrialShipmentEvent
47
+ */
48
+ FeeList?: Array<FeeComponent>;
49
+ }
@@ -0,0 +1,13 @@
1
+ import { onRetry } from '@sp-api-sdk/common';
2
+ import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
3
+ import { DefaultApi } from './api-model';
4
+ export declare const RATE_LIMITS: RateLimit[];
5
+ export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
6
+ rateLimiting?: {
7
+ retry: boolean;
8
+ onRetry?: onRetry;
9
+ };
10
+ }
11
+ export declare class FinancesApiClient extends DefaultApi {
12
+ constructor(parameters: ClientParameters);
13
+ }
@@ -0,0 +1,3 @@
1
+ export declare class FinancesApiError extends Error {
2
+ constructor(message: string);
3
+ }
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@sp-api-sdk/finances-api-v0",
3
+ "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
+ "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
5
+ "version": "1.7.0",
6
+ "main": "dist/cjs/index.js",
7
+ "module": "dist/es/index.js",
8
+ "types": "dist/types/index.d.ts",
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "directories": {
14
+ "lib": "dist"
15
+ },
16
+ "files": [
17
+ "dist/**/*.js",
18
+ "dist/**/*.d.ts"
19
+ ],
20
+ "scripts": {
21
+ "build:cjs": "tsc -p tsconfig.json",
22
+ "build:es": "tsc -p tsconfig.es.json",
23
+ "build": "yarn build:cjs && yarn build:es",
24
+ "clean": "rimraf dist",
25
+ "lint": "xo --cwd=../../ $PWD",
26
+ "test": "NODE_ENV='test' yarn jest"
27
+ },
28
+ "dependencies": {
29
+ "@sp-api-sdk/auth": "^1.9.1",
30
+ "@sp-api-sdk/common": "^1.7.2",
31
+ "axios": "^0.21.1"
32
+ },
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/bizon/selling-partner-api-sdk.git",
36
+ "directory": "clients/finances-api-v0"
37
+ },
38
+ "bugs": {
39
+ "url": "https://github.com/bizon/selling-partner-api-sdk/issues"
40
+ },
41
+ "homepage": "https://github.com/bizon/selling-partner-api-sdk/tree/master/clients/finances-api-v0",
42
+ "keywords": [
43
+ "amazon",
44
+ "bizon",
45
+ "marketplace web services",
46
+ "mws",
47
+ "selling partner api",
48
+ "sp api",
49
+ "sp sdk",
50
+ "finances api"
51
+ ],
52
+ "gitHead": "dc4286920dc77e99d6ad71f71bcb78ae22b9ab06"
53
+ }