@sp-api-sdk/finances-api-v0 2.6.2 → 2.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 (170) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/api-model/api/default-api.js +45 -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 +1 -1
  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/failed-adhoc-disbursement-event.js +1 -1
  23. package/dist/cjs/api-model/models/fbaliquidation-event.js +1 -1
  24. package/dist/cjs/api-model/models/fee-component.js +1 -1
  25. package/dist/cjs/api-model/models/financial-event-group.js +1 -1
  26. package/dist/cjs/api-model/models/financial-events.js +1 -1
  27. package/dist/cjs/api-model/models/imaging-services-fee-event.js +1 -1
  28. package/dist/cjs/api-model/models/list-financial-event-groups-payload.js +1 -1
  29. package/dist/cjs/api-model/models/list-financial-event-groups-response.js +1 -1
  30. package/dist/cjs/api-model/models/list-financial-events-payload.js +1 -1
  31. package/dist/cjs/api-model/models/list-financial-events-response.js +1 -1
  32. package/dist/cjs/api-model/models/loan-servicing-event.js +1 -1
  33. package/dist/cjs/api-model/models/model-error.js +1 -1
  34. package/dist/cjs/api-model/models/network-commingling-transaction-event.js +1 -1
  35. package/dist/cjs/api-model/models/pay-with-amazon-event.js +1 -1
  36. package/dist/cjs/api-model/models/product-ads-payment-event.js +1 -1
  37. package/dist/cjs/api-model/models/promotion.js +1 -1
  38. package/dist/cjs/api-model/models/removal-shipment-adjustment-event.js +1 -1
  39. package/dist/cjs/api-model/models/removal-shipment-event.js +1 -1
  40. package/dist/cjs/api-model/models/removal-shipment-item-adjustment.js +1 -1
  41. package/dist/cjs/api-model/models/removal-shipment-item.js +1 -1
  42. package/dist/cjs/api-model/models/rental-transaction-event.js +1 -1
  43. package/dist/cjs/api-model/models/retrocharge-event.js +1 -1
  44. package/dist/cjs/api-model/models/safetreimbursement-event.js +1 -1
  45. package/dist/cjs/api-model/models/safetreimbursement-item.js +1 -1
  46. package/dist/cjs/api-model/models/seller-deal-payment-event.js +1 -1
  47. package/dist/cjs/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  48. package/dist/cjs/api-model/models/service-fee-event.js +1 -1
  49. package/dist/cjs/api-model/models/shipment-event.js +1 -1
  50. package/dist/cjs/api-model/models/shipment-item.js +1 -1
  51. package/dist/cjs/api-model/models/solution-provider-credit-event.js +1 -1
  52. package/dist/cjs/api-model/models/tax-withheld-component.js +1 -1
  53. package/dist/cjs/api-model/models/tax-withholding-event.js +1 -1
  54. package/dist/cjs/api-model/models/tax-withholding-period.js +1 -1
  55. package/dist/cjs/api-model/models/tdsreimbursement-event.js +1 -1
  56. package/dist/cjs/api-model/models/trial-shipment-event.js +1 -1
  57. package/dist/cjs/api-model/models/value-added-service-charge-event.js +1 -1
  58. package/dist/es/api-model/api/default-api.js +45 -45
  59. package/dist/es/api-model/api.js +1 -1
  60. package/dist/es/api-model/base.js +1 -1
  61. package/dist/es/api-model/common.js +1 -1
  62. package/dist/es/api-model/configuration.js +1 -1
  63. package/dist/es/api-model/index.js +1 -1
  64. package/dist/es/api-model/models/adhoc-disbursement-event.js +1 -1
  65. package/dist/es/api-model/models/adjustment-event.js +1 -1
  66. package/dist/es/api-model/models/adjustment-item.js +1 -1
  67. package/dist/es/api-model/models/affordability-expense-event.js +1 -1
  68. package/dist/es/api-model/models/capacity-reservation-billing-event.js +1 -1
  69. package/dist/es/api-model/models/charge-component.js +1 -1
  70. package/dist/es/api-model/models/charge-instrument.js +1 -1
  71. package/dist/es/api-model/models/charge-refund-event.js +1 -1
  72. package/dist/es/api-model/models/charge-refund-transaction.js +1 -1
  73. package/dist/es/api-model/models/coupon-payment-event.js +1 -1
  74. package/dist/es/api-model/models/currency.js +1 -1
  75. package/dist/es/api-model/models/debt-recovery-event.js +1 -1
  76. package/dist/es/api-model/models/debt-recovery-item.js +1 -1
  77. package/dist/es/api-model/models/direct-payment.js +1 -1
  78. package/dist/es/api-model/models/failed-adhoc-disbursement-event.js +1 -1
  79. package/dist/es/api-model/models/fbaliquidation-event.js +1 -1
  80. package/dist/es/api-model/models/fee-component.js +1 -1
  81. package/dist/es/api-model/models/financial-event-group.js +1 -1
  82. package/dist/es/api-model/models/financial-events.js +1 -1
  83. package/dist/es/api-model/models/imaging-services-fee-event.js +1 -1
  84. package/dist/es/api-model/models/list-financial-event-groups-payload.js +1 -1
  85. package/dist/es/api-model/models/list-financial-event-groups-response.js +1 -1
  86. package/dist/es/api-model/models/list-financial-events-payload.js +1 -1
  87. package/dist/es/api-model/models/list-financial-events-response.js +1 -1
  88. package/dist/es/api-model/models/loan-servicing-event.js +1 -1
  89. package/dist/es/api-model/models/model-error.js +1 -1
  90. package/dist/es/api-model/models/network-commingling-transaction-event.js +1 -1
  91. package/dist/es/api-model/models/pay-with-amazon-event.js +1 -1
  92. package/dist/es/api-model/models/product-ads-payment-event.js +1 -1
  93. package/dist/es/api-model/models/promotion.js +1 -1
  94. package/dist/es/api-model/models/removal-shipment-adjustment-event.js +1 -1
  95. package/dist/es/api-model/models/removal-shipment-event.js +1 -1
  96. package/dist/es/api-model/models/removal-shipment-item-adjustment.js +1 -1
  97. package/dist/es/api-model/models/removal-shipment-item.js +1 -1
  98. package/dist/es/api-model/models/rental-transaction-event.js +1 -1
  99. package/dist/es/api-model/models/retrocharge-event.js +1 -1
  100. package/dist/es/api-model/models/safetreimbursement-event.js +1 -1
  101. package/dist/es/api-model/models/safetreimbursement-item.js +1 -1
  102. package/dist/es/api-model/models/seller-deal-payment-event.js +1 -1
  103. package/dist/es/api-model/models/seller-review-enrollment-payment-event.js +1 -1
  104. package/dist/es/api-model/models/service-fee-event.js +1 -1
  105. package/dist/es/api-model/models/shipment-event.js +1 -1
  106. package/dist/es/api-model/models/shipment-item.js +1 -1
  107. package/dist/es/api-model/models/solution-provider-credit-event.js +1 -1
  108. package/dist/es/api-model/models/tax-withheld-component.js +1 -1
  109. package/dist/es/api-model/models/tax-withholding-event.js +1 -1
  110. package/dist/es/api-model/models/tax-withholding-period.js +1 -1
  111. package/dist/es/api-model/models/tdsreimbursement-event.js +1 -1
  112. package/dist/es/api-model/models/trial-shipment-event.js +1 -1
  113. package/dist/es/api-model/models/value-added-service-charge-event.js +1 -1
  114. package/dist/types/api-model/api/default-api.d.ts +59 -59
  115. package/dist/types/api-model/api.d.ts +1 -1
  116. package/dist/types/api-model/base.d.ts +1 -1
  117. package/dist/types/api-model/common.d.ts +1 -1
  118. package/dist/types/api-model/configuration.d.ts +1 -1
  119. package/dist/types/api-model/index.d.ts +1 -1
  120. package/dist/types/api-model/models/adhoc-disbursement-event.d.ts +3 -3
  121. package/dist/types/api-model/models/adjustment-event.d.ts +3 -3
  122. package/dist/types/api-model/models/adjustment-item.d.ts +8 -2
  123. package/dist/types/api-model/models/affordability-expense-event.d.ts +4 -4
  124. package/dist/types/api-model/models/capacity-reservation-billing-event.d.ts +3 -3
  125. package/dist/types/api-model/models/charge-component.d.ts +2 -2
  126. package/dist/types/api-model/models/charge-instrument.d.ts +1 -1
  127. package/dist/types/api-model/models/charge-refund-event.d.ts +4 -4
  128. package/dist/types/api-model/models/charge-refund-transaction.d.ts +1 -1
  129. package/dist/types/api-model/models/coupon-payment-event.d.ts +2 -2
  130. package/dist/types/api-model/models/currency.d.ts +2 -2
  131. package/dist/types/api-model/models/debt-recovery-event.d.ts +2 -2
  132. package/dist/types/api-model/models/debt-recovery-item.d.ts +3 -3
  133. package/dist/types/api-model/models/direct-payment.d.ts +2 -2
  134. package/dist/types/api-model/models/failed-adhoc-disbursement-event.d.ts +5 -5
  135. package/dist/types/api-model/models/fbaliquidation-event.d.ts +2 -2
  136. package/dist/types/api-model/models/fee-component.d.ts +1 -1
  137. package/dist/types/api-model/models/financial-event-group.d.ts +5 -5
  138. package/dist/types/api-model/models/financial-events.d.ts +8 -8
  139. package/dist/types/api-model/models/imaging-services-fee-event.d.ts +2 -2
  140. package/dist/types/api-model/models/list-financial-event-groups-payload.d.ts +2 -2
  141. package/dist/types/api-model/models/list-financial-event-groups-response.d.ts +2 -2
  142. package/dist/types/api-model/models/list-financial-events-payload.d.ts +2 -2
  143. package/dist/types/api-model/models/list-financial-events-response.d.ts +2 -2
  144. package/dist/types/api-model/models/loan-servicing-event.d.ts +2 -2
  145. package/dist/types/api-model/models/model-error.d.ts +1 -1
  146. package/dist/types/api-model/models/network-commingling-transaction-event.d.ts +3 -3
  147. package/dist/types/api-model/models/pay-with-amazon-event.d.ts +5 -5
  148. package/dist/types/api-model/models/product-ads-payment-event.d.ts +4 -4
  149. package/dist/types/api-model/models/promotion.d.ts +1 -1
  150. package/dist/types/api-model/models/removal-shipment-adjustment-event.d.ts +4 -4
  151. package/dist/types/api-model/models/removal-shipment-event.d.ts +5 -5
  152. package/dist/types/api-model/models/removal-shipment-item-adjustment.d.ts +3 -3
  153. package/dist/types/api-model/models/removal-shipment-item.d.ts +2 -2
  154. package/dist/types/api-model/models/rental-transaction-event.d.ts +4 -4
  155. package/dist/types/api-model/models/retrocharge-event.d.ts +3 -3
  156. package/dist/types/api-model/models/safetreimbursement-event.d.ts +3 -3
  157. package/dist/types/api-model/models/safetreimbursement-item.d.ts +1 -1
  158. package/dist/types/api-model/models/seller-deal-payment-event.d.ts +4 -4
  159. package/dist/types/api-model/models/seller-review-enrollment-payment-event.d.ts +2 -2
  160. package/dist/types/api-model/models/service-fee-event.d.ts +1 -1
  161. package/dist/types/api-model/models/shipment-event.d.ts +2 -2
  162. package/dist/types/api-model/models/shipment-item.d.ts +1 -1
  163. package/dist/types/api-model/models/solution-provider-credit-event.d.ts +2 -2
  164. package/dist/types/api-model/models/tax-withheld-component.d.ts +2 -2
  165. package/dist/types/api-model/models/tax-withholding-event.d.ts +3 -3
  166. package/dist/types/api-model/models/tax-withholding-period.d.ts +4 -4
  167. package/dist/types/api-model/models/tdsreimbursement-event.d.ts +2 -2
  168. package/dist/types/api-model/models/trial-shipment-event.d.ts +2 -2
  169. package/dist/types/api-model/models/value-added-service-charge-event.d.ts +3 -3
  170. 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 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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { RemovalShipmentItemAdjustment } from './removal-shipment-item-adju
17
17
  */
18
18
  export interface RemovalShipmentAdjustmentEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof RemovalShipmentAdjustmentEvent
23
23
  */
@@ -41,13 +41,13 @@ export interface RemovalShipmentAdjustmentEvent {
41
41
  */
42
42
  'OrderId'?: string;
43
43
  /**
44
- * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`.
44
+ * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION.
45
45
  * @type {string}
46
46
  * @memberof RemovalShipmentAdjustmentEvent
47
47
  */
48
48
  'TransactionType'?: string;
49
49
  /**
50
- * A comma-delimited list of `RemovalShipmentItemAdjustment` details for FBA inventory.
50
+ * A comma-delimited list of Removal shipmentItemAdjustment details for FBA inventory.
51
51
  * @type {Array<RemovalShipmentItemAdjustment>}
52
52
  * @memberof RemovalShipmentAdjustmentEvent
53
53
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,13 +17,13 @@ import type { RemovalShipmentItem } from './removal-shipment-item';
17
17
  */
18
18
  export interface RemovalShipmentEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof RemovalShipmentEvent
23
23
  */
24
24
  'PostedDate'?: string;
25
25
  /**
26
- * The merchant removal `orderId`.
26
+ * The merchant removal orderId.
27
27
  * @type {string}
28
28
  * @memberof RemovalShipmentEvent
29
29
  */
@@ -35,7 +35,7 @@ export interface RemovalShipmentEvent {
35
35
  */
36
36
  'OrderId'?: string;
37
37
  /**
38
- * The type of removal order. Possible values: * `WHOLESALE_LIQUIDATION`
38
+ * The type of removal order. Possible values: * WHOLESALE_LIQUIDATION
39
39
  * @type {string}
40
40
  * @memberof RemovalShipmentEvent
41
41
  */
@@ -47,7 +47,7 @@ export interface RemovalShipmentEvent {
47
47
  */
48
48
  'StoreName'?: string;
49
49
  /**
50
- * A list of `RemovalShipmentItem`.
50
+ * A list of information about removal shipment items.
51
51
  * @type {Array<RemovalShipmentItem>}
52
52
  * @memberof RemovalShipmentEvent
53
53
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -23,7 +23,7 @@ export interface RemovalShipmentItemAdjustment {
23
23
  */
24
24
  'RemovalShipmentItemId'?: string;
25
25
  /**
26
- * 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.
26
+ * 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.
27
27
  * @type {string}
28
28
  * @memberof RemovalShipmentItemAdjustment
29
29
  */
@@ -35,7 +35,7 @@ export interface RemovalShipmentItemAdjustment {
35
35
  */
36
36
  'FulfillmentNetworkSKU'?: string;
37
37
  /**
38
- * Adjusted quantity of `RemovalShipmentItemAdjustment` items.
38
+ * Adjusted quantity of removal shipmentItemAdjustment items.
39
39
  * @type {number}
40
40
  * @memberof RemovalShipmentItemAdjustment
41
41
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -23,7 +23,7 @@ export interface RemovalShipmentItem {
23
23
  */
24
24
  'RemovalShipmentItemId'?: string;
25
25
  /**
26
- * 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.
26
+ * 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.
27
27
  * @type {string}
28
28
  * @memberof RemovalShipmentItem
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -26,19 +26,19 @@ export interface RentalTransactionEvent {
26
26
  */
27
27
  'AmazonOrderId'?: string;
28
28
  /**
29
- * 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.
29
+ * 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.
30
30
  * @type {string}
31
31
  * @memberof RentalTransactionEvent
32
32
  */
33
33
  'RentalEventType'?: string;
34
34
  /**
35
- * The number of days that the buyer extended an already rented item. This value is only returned for `RentalCustomerPayment-Extension` and `RentalCustomerRefund-Extension` events.
35
+ * The number of days that the buyer extended an already rented item. This value is only returned for RentalCustomerPayment-Extension and RentalCustomerRefund-Extension events.
36
36
  * @type {number}
37
37
  * @memberof RentalTransactionEvent
38
38
  */
39
39
  'ExtensionLength'?: number;
40
40
  /**
41
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
41
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
42
42
  * @type {string}
43
43
  * @memberof RentalTransactionEvent
44
44
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -18,7 +18,7 @@ import type { TaxWithheldComponent } from './tax-withheld-component';
18
18
  */
19
19
  export interface RetrochargeEvent {
20
20
  /**
21
- * The type of event. Possible values: * `Retrocharge` * `RetrochargeReversal`
21
+ * The type of event. Possible values: * Retrocharge * RetrochargeReversal
22
22
  * @type {string}
23
23
  * @memberof RetrochargeEvent
24
24
  */
@@ -30,7 +30,7 @@ export interface RetrochargeEvent {
30
30
  */
31
31
  'AmazonOrderId'?: string;
32
32
  /**
33
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
33
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
34
34
  * @type {string}
35
35
  * @memberof RetrochargeEvent
36
36
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -18,7 +18,7 @@ import type { SAFETReimbursementItem } from './safetreimbursement-item';
18
18
  */
19
19
  export interface SAFETReimbursementEvent {
20
20
  /**
21
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
21
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
22
22
  * @type {string}
23
23
  * @memberof SAFETReimbursementEvent
24
24
  */
@@ -42,7 +42,7 @@ export interface SAFETReimbursementEvent {
42
42
  */
43
43
  'ReasonCode'?: string;
44
44
  /**
45
- * A list of `SAFETReimbursementItem`.
45
+ * A list of SAFETReimbursementItems.
46
46
  * @type {Array<SAFETReimbursementItem>}
47
47
  * @memberof SAFETReimbursementEvent
48
48
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
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 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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface SellerDealPaymentEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof SellerDealPaymentEvent
23
23
  */
@@ -35,13 +35,13 @@ export interface SellerDealPaymentEvent {
35
35
  */
36
36
  'dealDescription'?: string;
37
37
  /**
38
- * The type of event: `SellerDealComplete`.
38
+ * The type of event: SellerDealComplete.
39
39
  * @type {string}
40
40
  * @memberof SellerDealPaymentEvent
41
41
  */
42
42
  'eventType'?: string;
43
43
  /**
44
- * The type of fee: `RunLightningDealFee`.
44
+ * The type of fee: RunLightningDealFee.
45
45
  * @type {string}
46
46
  * @memberof SellerDealPaymentEvent
47
47
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -19,7 +19,7 @@ import type { FeeComponent } from './fee-component';
19
19
  */
20
20
  export interface SellerReviewEnrollmentPaymentEvent {
21
21
  /**
22
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
22
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
23
23
  * @type {string}
24
24
  * @memberof SellerReviewEnrollmentPaymentEvent
25
25
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
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 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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -86,7 +86,7 @@ export interface ShipmentEvent {
86
86
  */
87
87
  'DirectPaymentList'?: Array<DirectPayment>;
88
88
  /**
89
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
89
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
90
90
  * @type {string}
91
91
  * @memberof ShipmentEvent
92
92
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
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 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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -71,7 +71,7 @@ export interface SolutionProviderCreditEvent {
71
71
  */
72
72
  'TransactionAmount'?: Currency;
73
73
  /**
74
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
74
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
75
75
  * @type {string}
76
76
  * @memberof SolutionProviderCreditEvent
77
77
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { ChargeComponent } from './charge-component';
17
17
  */
18
18
  export interface TaxWithheldComponent {
19
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.
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
21
  * @type {string}
22
22
  * @memberof TaxWithheldComponent
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -12,13 +12,13 @@
12
12
  import type { Currency } from './currency';
13
13
  import type { TaxWithholdingPeriod } from './tax-withholding-period';
14
14
  /**
15
- * A tax withholding event on a seller\'s account.
15
+ * A TaxWithholding event on seller\'s account.
16
16
  * @export
17
17
  * @interface TaxWithholdingEvent
18
18
  */
19
19
  export interface TaxWithholdingEvent {
20
20
  /**
21
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
21
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
22
22
  * @type {string}
23
23
  * @memberof TaxWithholdingEvent
24
24
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * The period during which tax withholding on a seller\'s account is calculated.
13
+ * Period which taxwithholding on seller\'s account is calculated.
14
14
  * @export
15
15
  * @interface TaxWithholdingPeriod
16
16
  */
17
17
  export interface TaxWithholdingPeriod {
18
18
  /**
19
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
19
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
20
20
  * @type {string}
21
21
  * @memberof TaxWithholdingPeriod
22
22
  */
23
23
  'StartDate'?: string;
24
24
  /**
25
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
25
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
26
26
  * @type {string}
27
27
  * @memberof TaxWithholdingPeriod
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,7 +17,7 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface TDSReimbursementEvent {
19
19
  /**
20
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
20
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
21
21
  * @type {string}
22
22
  * @memberof TDSReimbursementEvent
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -29,7 +29,7 @@ export interface TrialShipmentEvent {
29
29
  */
30
30
  'FinancialEventGroupId'?: string;
31
31
  /**
32
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
32
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
33
33
  * @type {string}
34
34
  * @memberof TrialShipmentEvent
35
35
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Finances
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.
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
4
  *
5
5
  * The version of the OpenAPI document: v0
6
6
  *
@@ -17,13 +17,13 @@ import type { Currency } from './currency';
17
17
  */
18
18
  export interface ValueAddedServiceChargeEvent {
19
19
  /**
20
- * The transaction type. For example, \'Other Support Service fees\'
20
+ * Indicates the type of transaction. Example: \'Other Support Service fees\'
21
21
  * @type {string}
22
22
  * @memberof ValueAddedServiceChargeEvent
23
23
  */
24
24
  'TransactionType'?: string;
25
25
  /**
26
- * A date in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
26
+ * Fields with a schema type of date are in ISO 8601 date time format (for example GroupBeginDate).
27
27
  * @type {string}
28
28
  * @memberof ValueAddedServiceChargeEvent
29
29
  */
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 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": "2.6.2",
4
+ "description": "The Selling Partner API for Finances helps you obtain financial information relevant to a seller's business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.",
5
+ "version": "2.7.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.2",
21
+ "@sp-api-sdk/common": "2.1.3",
22
22
  "axios": "^1.7.7"
23
23
  },
24
24
  "repository": {
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "finances api"
42
42
  ],
43
- "gitHead": "cde6991012a79a8483a72ecb1c71d92087f390a6"
43
+ "gitHead": "197cba539b751c24eb5cfc1dccf6fa4b1d8d4116"
44
44
  }