@sp-api-sdk/finances-api-v0 4.0.7 → 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 +4 -4
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,15 +15,15 @@ import type { Currency } from './currency';
15
15
  */
16
16
  export interface ProductAdsPaymentEvent {
17
17
  /**
18
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
18
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
19
  */
20
20
  'postedDate'?: string;
21
21
  /**
22
- * Indicates if the transaction is for a charge or a refund. Possible values: * charge - Charge * refund - Refund
22
+ * Indicates if the transaction is for a charge or a refund. Possible values: * `charge` * `refund`
23
23
  */
24
24
  'transactionType'?: string;
25
25
  /**
26
- * Identifier for the invoice that the transaction appears in.
26
+ * The identifier for the invoice that includes the transaction.
27
27
  */
28
28
  'invoiceId'?: string;
29
29
  'baseValue'?: Currency;
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,7 +15,7 @@ import type { RemovalShipmentItemAdjustment } from './removal-shipment-item-adju
15
15
  */
16
16
  export interface RemovalShipmentAdjustmentEvent {
17
17
  /**
18
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
18
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
19
  */
20
20
  'PostedDate'?: string;
21
21
  /**
@@ -31,11 +31,11 @@ export interface RemovalShipmentAdjustmentEvent {
31
31
  */
32
32
  'OrderId'?: string;
33
33
  /**
34
- * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION.
34
+ * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`.
35
35
  */
36
36
  'TransactionType'?: string;
37
37
  /**
38
- * A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.
38
+ * A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.
39
39
  */
40
40
  'RemovalShipmentItemAdjustmentList'?: Array<RemovalShipmentItemAdjustment>;
41
41
  }
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,11 +15,11 @@ import type { RemovalShipmentItem } from './removal-shipment-item';
15
15
  */
16
16
  export interface RemovalShipmentEvent {
17
17
  /**
18
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
18
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
19
  */
20
20
  'PostedDate'?: string;
21
21
  /**
22
- * The merchant removal orderId.
22
+ * The merchant removal `orderId`.
23
23
  */
24
24
  'MerchantOrderId'?: string;
25
25
  /**
@@ -27,7 +27,7 @@ export interface RemovalShipmentEvent {
27
27
  */
28
28
  'OrderId'?: string;
29
29
  /**
30
- * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION
30
+ * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`
31
31
  */
32
32
  'TransactionType'?: string;
33
33
  /**
@@ -35,7 +35,7 @@ export interface RemovalShipmentEvent {
35
35
  */
36
36
  'StoreName'?: string;
37
37
  /**
38
- * A list of information about removal shipment items.
38
+ * A list of `RemovalShipmentItem`.
39
39
  */
40
40
  'RemovalShipmentItemList'?: Array<RemovalShipmentItem>;
41
41
  }
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -19,7 +19,7 @@ export interface RemovalShipmentItemAdjustment {
19
19
  */
20
20
  'RemovalShipmentItemId'?: string;
21
21
  /**
22
- * 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.
22
+ * The tax collection model that is 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.
23
23
  */
24
24
  'TaxCollectionModel'?: string;
25
25
  /**
@@ -27,7 +27,7 @@ export interface RemovalShipmentItemAdjustment {
27
27
  */
28
28
  'FulfillmentNetworkSKU'?: string;
29
29
  /**
30
- * Adjusted quantity of removal shipmentItemAdjustment items.
30
+ * Adjusted quantity of `RemovalShipmentItemAdjustment` items.
31
31
  */
32
32
  'AdjustedQuantity'?: number;
33
33
  'RevenueAdjustment'?: Currency;
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -19,7 +19,7 @@ export interface RemovalShipmentItem {
19
19
  */
20
20
  'RemovalShipmentItemId'?: string;
21
21
  /**
22
- * 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.
22
+ * The tax collection model that is 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.
23
23
  */
24
24
  'TaxCollectionModel'?: string;
25
25
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -22,15 +22,15 @@ export interface RentalTransactionEvent {
22
22
  */
23
23
  'AmazonOrderId'?: string;
24
24
  /**
25
- * The type of rental event. Possible values: * RentalCustomerPayment-Buyout - Transaction type that represents when the customer wants to buy out a rented item. * RentalCustomerPayment-Extension - Transaction type that represents when the customer wants to extend the rental period. * RentalCustomerRefund-Buyout - Transaction type that represents when the customer requests a refund for the buyout of the rented item. * RentalCustomerRefund-Extension - Transaction type that represents when the customer requests a refund over the extension on the rented item. * RentalHandlingFee - Transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * RentalChargeFailureReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * RentalLostItemReimbursement - Transaction type that represents when Amazon sends money to the seller to compensate for a lost item.
25
+ * The type of rental event. Possible values: * `RentalCustomerPayment-Buyout`: A transaction type that represents when the customer wants to buy out a rented item. * `RentalCustomerPayment-Extension`: A transaction type that represents when the customer wants to extend the rental period. * `RentalCustomerRefund-Buyout`: A transaction type that represents when the customer requests a refund for the buyout of the rented item. * `RentalCustomerRefund-Extension`: A transaction type that represents when the customer requests a refund over the extension on the rented item. * `RentalHandlingFee`: A transaction type that represents the fee that Amazon charges sellers who rent through Amazon. * `RentalChargeFailureReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a failed charge. * `RentalLostItemReimbursement`: A transaction type that represents when Amazon sends money to the seller to compensate for a lost item.
26
26
  */
27
27
  'RentalEventType'?: string;
28
28
  /**
29
- * The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.
29
+ * The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.
30
30
  */
31
31
  'ExtensionLength'?: number;
32
32
  /**
33
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
33
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
34
34
  */
35
35
  'PostedDate'?: string;
36
36
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -16,7 +16,7 @@ import type { TaxWithheldComponent } from './tax-withheld-component';
16
16
  */
17
17
  export interface RetrochargeEvent {
18
18
  /**
19
- * The type of event. Possible values: * Retrocharge * RetrochargeReversal
19
+ * The type of event. Possible values: * `Retrocharge` * `RetrochargeReversal`
20
20
  */
21
21
  'RetrochargeEventType'?: string;
22
22
  /**
@@ -24,7 +24,7 @@ export interface RetrochargeEvent {
24
24
  */
25
25
  'AmazonOrderId'?: string;
26
26
  /**
27
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
27
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
28
28
  */
29
29
  'PostedDate'?: string;
30
30
  'BaseTax'?: Currency;
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -16,7 +16,7 @@ import type { SAFETReimbursementItem } from './safetreimbursement-item';
16
16
  */
17
17
  export interface SAFETReimbursementEvent {
18
18
  /**
19
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
19
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
20
  */
21
21
  'PostedDate'?: string;
22
22
  /**
@@ -29,7 +29,7 @@ export interface SAFETReimbursementEvent {
29
29
  */
30
30
  'ReasonCode'?: string;
31
31
  /**
32
- * A list of SAFETReimbursementItems.
32
+ * A list of `SAFETReimbursementItem`.
33
33
  */
34
34
  'SAFETReimbursementItemList'?: Array<SAFETReimbursementItem>;
35
35
  }
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,7 +15,7 @@ import type { Currency } from './currency';
15
15
  */
16
16
  export interface SellerDealPaymentEvent {
17
17
  /**
18
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
18
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
19
  */
20
20
  'postedDate'?: string;
21
21
  /**
@@ -27,11 +27,11 @@ export interface SellerDealPaymentEvent {
27
27
  */
28
28
  'dealDescription'?: string;
29
29
  /**
30
- * The type of event: SellerDealComplete.
30
+ * The type of event: `SellerDealComplete`.
31
31
  */
32
32
  'eventType'?: string;
33
33
  /**
34
- * The type of fee: RunLightningDealFee.
34
+ * The type of fee: `RunLightningDealFee`.
35
35
  */
36
36
  'feeType'?: string;
37
37
  'feeAmount'?: Currency;
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { FeeComponent } from './fee-component';
17
17
  */
18
18
  export interface SellerReviewEnrollmentPaymentEvent {
19
19
  /**
20
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
20
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
21
21
  */
22
22
  'PostedDate'?: string;
23
23
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -62,7 +62,7 @@ export interface ShipmentEvent {
62
62
  */
63
63
  'DirectPaymentList'?: Array<DirectPayment>;
64
64
  /**
65
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
65
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
66
66
  */
67
67
  'PostedDate'?: string;
68
68
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -48,7 +48,7 @@ export interface SolutionProviderCreditEvent {
48
48
  'ProviderStoreName'?: string;
49
49
  'TransactionAmount'?: Currency;
50
50
  /**
51
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
51
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
52
52
  */
53
53
  'TransactionCreationDate'?: string;
54
54
  }
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,7 +15,7 @@ import type { ChargeComponent } from './charge-component';
15
15
  */
16
16
  export interface TaxWithheldComponent {
17
17
  /**
18
- * 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.
18
+ * 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.
19
19
  */
20
20
  'TaxCollectionModel'?: string;
21
21
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -12,11 +12,11 @@
12
12
  import type { Currency } from './currency';
13
13
  import type { TaxWithholdingPeriod } from './tax-withholding-period';
14
14
  /**
15
- * A TaxWithholding event on seller\'s account.
15
+ * A tax withholding event on a seller\'s account.
16
16
  */
17
17
  export interface TaxWithholdingEvent {
18
18
  /**
19
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
19
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
20
  */
21
21
  'PostedDate'?: string;
22
22
  'BaseAmount'?: Currency;
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -10,15 +10,15 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Period which taxwithholding on seller\'s account is calculated.
13
+ * The period during which tax withholding on a seller\'s account is calculated.
14
14
  */
15
15
  export interface TaxWithholdingPeriod {
16
16
  /**
17
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
17
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
18
18
  */
19
19
  'StartDate'?: string;
20
20
  /**
21
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
22
22
  */
23
23
  'EndDate'?: string;
24
24
  }
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,7 +15,7 @@ import type { Currency } from './currency';
15
15
  */
16
16
  export interface TDSReimbursementEvent {
17
17
  /**
18
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
18
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
19
  */
20
20
  'PostedDate'?: string;
21
21
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -23,7 +23,7 @@ export interface TrialShipmentEvent {
23
23
  */
24
24
  'FinancialEventGroupId'?: string;
25
25
  /**
26
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
26
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
27
27
  */
28
28
  'PostedDate'?: string;
29
29
  /**
@@ -1,6 +1,6 @@
1
1
  /**
2
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.
3
+ * 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.
4
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -15,11 +15,11 @@ import type { Currency } from './currency';
15
15
  */
16
16
  export interface ValueAddedServiceChargeEvent {
17
17
  /**
18
- * Indicates the type of transaction. Example: \'Other Support Service fees\'
18
+ * The transaction type. For example, \'Other Support Service fees\'
19
19
  */
20
20
  'TransactionType'?: string;
21
21
  /**
22
- * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
22
+ * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
23
23
  */
24
24
  'PostedDate'?: string;
25
25
  /**
@@ -1,3 +1,3 @@
1
1
  export * from './client';
2
2
  export * from './api-model/api';
3
- export * from './api-model/models';
3
+ export type * from './api-model/models';
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@sp-api-sdk/finances-api-v0",
3
3
  "author": "Bertrand Marron <bertrand@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": "4.0.7",
4
+ "description": "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.",
5
+ "version": "4.2.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.21",
21
+ "@sp-api-sdk/common": "2.1.23",
22
22
  "axios": "^1.13.2"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "finances api"
42
42
  ],
43
- "gitHead": "3a1ed2407423d0d3b294a0fdc7d9bba38ad2c845"
43
+ "gitHead": "e0c5a47b33852fa93174581932cbd70ac9af2183"
44
44
  }