peddler 5.0.0 → 5.1.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 (168) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -6
  3. data/lib/peddler/acronyms.rb +1 -0
  4. data/lib/peddler/api.rb +35 -62
  5. data/lib/peddler/apis/amazon_warehousing_and_distribution_2024_05_09.rb +11 -11
  6. data/lib/peddler/apis/aplus_content_2020_11_01.rb +10 -10
  7. data/lib/peddler/apis/application_integrations_2024_04_01.rb +3 -3
  8. data/lib/peddler/apis/application_management_2023_11_30.rb +1 -1
  9. data/lib/peddler/apis/catalog_items_2020_12_01.rb +2 -2
  10. data/lib/peddler/apis/catalog_items_2022_04_01.rb +2 -2
  11. data/lib/peddler/apis/catalog_items_v0.rb +1 -1
  12. data/lib/peddler/apis/data_kiosk_2023_11_15.rb +5 -5
  13. data/lib/peddler/apis/delivery_by_amazon_2022_07_01/error.rb +23 -0
  14. data/lib/peddler/apis/delivery_by_amazon_2022_07_01/error_list.rb +18 -0
  15. data/lib/peddler/apis/delivery_by_amazon_2022_07_01/get_invoice_status_response.rb +26 -0
  16. data/lib/peddler/apis/delivery_by_amazon_2022_07_01/submit_invoice_request.rb +31 -0
  17. data/lib/peddler/apis/delivery_by_amazon_2022_07_01/submit_invoice_response.rb +17 -0
  18. data/lib/peddler/apis/delivery_by_amazon_2022_07_01.rb +59 -0
  19. data/lib/peddler/apis/easy_ship_2022_03_23.rb +5 -5
  20. data/lib/peddler/apis/external_fulfillment_shipments_2024_09_11/shipment.rb +3 -0
  21. data/lib/peddler/apis/fba_inbound_eligibility_v1.rb +1 -1
  22. data/lib/peddler/apis/fba_inventory_v1.rb +1 -1
  23. data/lib/peddler/apis/feeds_2021_06_30.rb +6 -6
  24. data/lib/peddler/apis/finances_2024_06_19/amazon_pay_context.rb +2 -2
  25. data/lib/peddler/apis/finances_2024_06_19/breakdown.rb +3 -4
  26. data/lib/peddler/apis/finances_2024_06_19/context.rb +11 -11
  27. data/lib/peddler/apis/finances_2024_06_19/contexts.rb +1 -1
  28. data/lib/peddler/apis/finances_2024_06_19/deferred_context.rb +1 -1
  29. data/lib/peddler/apis/finances_2024_06_19/error.rb +1 -1
  30. data/lib/peddler/apis/finances_2024_06_19/error_list.rb +1 -1
  31. data/lib/peddler/apis/finances_2024_06_19/item.rb +3 -3
  32. data/lib/peddler/apis/finances_2024_06_19/item_related_identifier.rb +1 -1
  33. data/lib/peddler/apis/finances_2024_06_19/item_related_identifiers.rb +1 -1
  34. data/lib/peddler/apis/finances_2024_06_19/items.rb +1 -1
  35. data/lib/peddler/apis/finances_2024_06_19/marketplace_details.rb +2 -3
  36. data/lib/peddler/apis/finances_2024_06_19/payments_context.rb +5 -5
  37. data/lib/peddler/apis/finances_2024_06_19/product_context.rb +4 -4
  38. data/lib/peddler/apis/finances_2024_06_19/related_identifier.rb +2 -2
  39. data/lib/peddler/apis/finances_2024_06_19/selling_partner_metadata.rb +3 -3
  40. data/lib/peddler/apis/finances_2024_06_19/time_range_context.rb +3 -3
  41. data/lib/peddler/apis/finances_2024_06_19/transaction.rb +8 -10
  42. data/lib/peddler/apis/finances_2024_06_19/transactions.rb +1 -1
  43. data/lib/peddler/apis/finances_2024_06_19/transactions_payload.rb +4 -2
  44. data/lib/peddler/apis/finances_2024_06_19.rb +24 -13
  45. data/lib/peddler/apis/finances_v0/adhoc_disbursement_event.rb +1 -3
  46. data/lib/peddler/apis/finances_v0/adjustment_event.rb +11 -18
  47. data/lib/peddler/apis/finances_v0/adjustment_item.rb +3 -3
  48. data/lib/peddler/apis/finances_v0/affordability_expense_event.rb +6 -7
  49. data/lib/peddler/apis/finances_v0/capacity_reservation_billing_event.rb +1 -1
  50. data/lib/peddler/apis/finances_v0/charge_component.rb +37 -35
  51. data/lib/peddler/apis/finances_v0/charge_refund_event.rb +2 -6
  52. data/lib/peddler/apis/finances_v0/coupon_payment_event.rb +1 -1
  53. data/lib/peddler/apis/finances_v0/debt_recovery_event.rb +1 -5
  54. data/lib/peddler/apis/finances_v0/debt_recovery_item.rb +4 -4
  55. data/lib/peddler/apis/finances_v0/direct_payment.rb +7 -7
  56. data/lib/peddler/apis/finances_v0/ebt_refund_reimbursement_only_event.rb +23 -0
  57. data/lib/peddler/apis/finances_v0/ebt_refund_reimbursement_only_event_list.rb +18 -0
  58. data/lib/peddler/apis/finances_v0/failed_adhoc_disbursement_event.rb +3 -9
  59. data/lib/peddler/apis/finances_v0/failed_adhoc_disbursement_event_list.rb +1 -1
  60. data/lib/peddler/apis/finances_v0/fba_liquidation_event.rb +1 -1
  61. data/lib/peddler/apis/finances_v0/financial_event_group.rb +5 -7
  62. data/lib/peddler/apis/finances_v0/financial_events.rb +4 -1
  63. data/lib/peddler/apis/finances_v0/list_financial_event_groups_payload.rb +1 -1
  64. data/lib/peddler/apis/finances_v0/list_financial_event_groups_response.rb +3 -3
  65. data/lib/peddler/apis/finances_v0/list_financial_events_payload.rb +1 -1
  66. data/lib/peddler/apis/finances_v0/list_financial_events_response.rb +3 -3
  67. data/lib/peddler/apis/finances_v0/loan_servicing_event.rb +3 -3
  68. data/lib/peddler/apis/finances_v0/network_commingling_transaction_event.rb +3 -3
  69. data/lib/peddler/apis/finances_v0/pay_with_amazon_event.rb +5 -5
  70. data/lib/peddler/apis/finances_v0/product_ads_payment_event.rb +4 -4
  71. data/lib/peddler/apis/finances_v0/removal_shipment_adjustment_event.rb +2 -2
  72. data/lib/peddler/apis/finances_v0/removal_shipment_adjustment_event_list.rb +1 -1
  73. data/lib/peddler/apis/finances_v0/removal_shipment_event.rb +2 -2
  74. data/lib/peddler/apis/finances_v0/removal_shipment_item.rb +5 -6
  75. data/lib/peddler/apis/finances_v0/removal_shipment_item_adjustment.rb +8 -9
  76. data/lib/peddler/apis/finances_v0/removal_shipment_item_list.rb +1 -1
  77. data/lib/peddler/apis/finances_v0/rental_transaction_event.rb +17 -16
  78. data/lib/peddler/apis/finances_v0/retrocharge_event.rb +2 -2
  79. data/lib/peddler/apis/finances_v0/retrocharge_event_list.rb +1 -1
  80. data/lib/peddler/apis/finances_v0/safet_reimbursement_event_list.rb +1 -1
  81. data/lib/peddler/apis/finances_v0/safet_reimbursement_item_list.rb +1 -1
  82. data/lib/peddler/apis/finances_v0/seller_deal_payment_event.rb +2 -2
  83. data/lib/peddler/apis/finances_v0/seller_review_enrollment_payment_event.rb +1 -1
  84. data/lib/peddler/apis/finances_v0/solution_provider_credit_event.rb +1 -1
  85. data/lib/peddler/apis/finances_v0/solution_provider_credit_event_list.rb +1 -1
  86. data/lib/peddler/apis/finances_v0/tax_withheld_component.rb +2 -3
  87. data/lib/peddler/apis/finances_v0/tax_withholding_event.rb +1 -1
  88. data/lib/peddler/apis/finances_v0/tax_withholding_event_list.rb +1 -1
  89. data/lib/peddler/apis/finances_v0/tax_withholding_period.rb +1 -1
  90. data/lib/peddler/apis/finances_v0/value_added_service_charge_event.rb +1 -3
  91. data/lib/peddler/apis/finances_v0.rb +60 -47
  92. data/lib/peddler/apis/fulfillment_inbound_2024_03_20/delivery_window_option.rb +2 -1
  93. data/lib/peddler/apis/fulfillment_inbound_2024_03_20/selected_delivery_window.rb +2 -1
  94. data/lib/peddler/apis/fulfillment_inbound_2024_03_20.rb +90 -142
  95. data/lib/peddler/apis/fulfillment_inbound_v0.rb +6 -6
  96. data/lib/peddler/apis/fulfillment_outbound_2020_07_01.rb +14 -17
  97. data/lib/peddler/apis/invoices_2024_06_19.rb +7 -7
  98. data/lib/peddler/apis/listings_items_2020_09_01.rb +3 -3
  99. data/lib/peddler/apis/listings_items_2021_08_01.rb +5 -5
  100. data/lib/peddler/apis/listings_restrictions_2021_08_01.rb +1 -1
  101. data/lib/peddler/apis/merchant_fulfillment_v0.rb +5 -5
  102. data/lib/peddler/apis/messaging_v1.rb +11 -11
  103. data/lib/peddler/apis/notifications_v1.rb +8 -8
  104. data/lib/peddler/apis/orders_v0/buyer_info.rb +0 -3
  105. data/lib/peddler/apis/orders_v0/order_buyer_info.rb +0 -3
  106. data/lib/peddler/apis/orders_v0.rb +12 -15
  107. data/lib/peddler/apis/product_fees_v0.rb +3 -3
  108. data/lib/peddler/apis/product_pricing_2022_05_01.rb +2 -2
  109. data/lib/peddler/apis/product_pricing_v0.rb +6 -6
  110. data/lib/peddler/apis/product_type_definitions_2020_09_01.rb +2 -2
  111. data/lib/peddler/apis/replenishment_2022_11_07/get_selling_partner_metrics_response_metric.rb +66 -22
  112. data/lib/peddler/apis/replenishment_2022_11_07/list_offer_metrics_response_offer.rb +13 -13
  113. data/lib/peddler/apis/replenishment_2022_11_07.rb +3 -3
  114. data/lib/peddler/apis/reports_2021_06_30.rb +9 -9
  115. data/lib/peddler/apis/sales_v1.rb +1 -1
  116. data/lib/peddler/apis/seller_wallet_2024_03_01/bank_account.rb +23 -18
  117. data/lib/peddler/apis/seller_wallet_2024_03_01/payee_contact_information.rb +54 -0
  118. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction.rb +7 -3
  119. data/lib/peddler/apis/seller_wallet_2024_03_01/transaction_initiation_request.rb +3 -3
  120. data/lib/peddler/apis/seller_wallet_2024_03_01.rb +7 -2
  121. data/lib/peddler/apis/sellers_v1.rb +2 -2
  122. data/lib/peddler/apis/services_v1.rb +17 -17
  123. data/lib/peddler/apis/shipment_invoicing_v0.rb +3 -3
  124. data/lib/peddler/apis/shipping_v1.rb +9 -9
  125. data/lib/peddler/apis/shipping_v2.rb +19 -19
  126. data/lib/peddler/apis/solicitations_v1.rb +2 -2
  127. data/lib/peddler/apis/tokens_2021_03_01.rb +1 -1
  128. data/lib/peddler/apis/transfers_2024_06_01.rb +2 -2
  129. data/lib/peddler/apis/uploads_2020_11_01.rb +1 -1
  130. data/lib/peddler/apis/vendor_direct_fulfillment_inventory_v1.rb +1 -1
  131. data/lib/peddler/apis/vendor_direct_fulfillment_orders_2021_12_28.rb +3 -3
  132. data/lib/peddler/apis/vendor_direct_fulfillment_orders_v1.rb +3 -3
  133. data/lib/peddler/apis/vendor_direct_fulfillment_payments_v1.rb +1 -1
  134. data/lib/peddler/apis/vendor_direct_fulfillment_shipping_2021_12_28.rb +11 -11
  135. data/lib/peddler/apis/vendor_direct_fulfillment_shipping_v1.rb +9 -9
  136. data/lib/peddler/apis/vendor_direct_fulfillment_transactions_2021_12_28.rb +1 -1
  137. data/lib/peddler/apis/vendor_direct_fulfillment_transactions_v1.rb +1 -1
  138. data/lib/peddler/apis/vendor_invoices_v1.rb +1 -1
  139. data/lib/peddler/apis/vendor_orders_v1.rb +4 -4
  140. data/lib/peddler/apis/vendor_shipments_v1/package_item_details.rb +16 -0
  141. data/lib/peddler/apis/vendor_shipments_v1/regulation_references.rb +32 -0
  142. data/lib/peddler/apis/vendor_shipments_v1.rb +5 -5
  143. data/lib/peddler/apis/vendor_transaction_status_v1.rb +1 -1
  144. data/lib/peddler/data_kiosk/economics20240315/analytics_economics20240315.rb +5 -0
  145. data/lib/peddler/data_kiosk/economics20240315.json +340 -7
  146. data/lib/peddler/data_kiosk/vendor_analytics20240930/traffic.rb +5 -0
  147. data/lib/peddler/data_kiosk/vendor_analytics20240930.json +12 -0
  148. data/lib/peddler/response.rb +1 -1
  149. data/lib/peddler/version.rb +1 -1
  150. data/lib/peddler.rb +2 -0
  151. data/sig/peddler/api.rbs +13 -23
  152. data/sig/peddler/apis/delivery_by_amazon_2022_07_01.rbs +85 -0
  153. data/sig/peddler/apis/external_fulfillment_shipments_2024_09_11.rbs +8 -7
  154. data/sig/peddler/apis/finances_2024_06_19.rbs +1 -1
  155. data/sig/peddler/apis/finances_v0.rbs +30 -7
  156. data/sig/peddler/apis/fulfillment_inbound_2024_03_20.rbs +45 -45
  157. data/sig/peddler/apis/fulfillment_outbound_2020_07_01.rbs +1 -1
  158. data/sig/peddler/apis/orders_v0.rbs +15 -17
  159. data/sig/peddler/apis/replenishment_2022_11_07.rbs +18 -7
  160. data/sig/peddler/apis/seller_wallet_2024_03_01.rbs +49 -42
  161. data/sig/peddler/apis/vendor_shipments_v1.rbs +30 -41
  162. data/sig/peddler/data_kiosk/economics20240315.rbs +8 -7
  163. data/sig/peddler/data_kiosk/vendor_analytics20240930.rbs +8 -7
  164. data/sig/peddler.rbs +4 -0
  165. metadata +13 -5
  166. data/lib/peddler/apis/seller_wallet_2024_03_01/account_holder_address.rb +0 -36
  167. data/lib/peddler/apis/vendor_shipments_v1/packed_quantity.rb +0 -25
  168. data/lib/peddler/apis/vendor_shipments_v1/purchase_order_item_details.rb +0 -18
@@ -18,9 +18,7 @@ module Peddler
18
18
  # @return [String] The identifier for the transaction.
19
19
  attribute?(:transaction_id, String, from: "TransactionId")
20
20
 
21
- # @return [String] Indicates the type of transaction.
22
- #
23
- # Example: "Disbursed to Amazon Gift Card balance"
21
+ # @return [String] The type of transaction. For example, "Disbursed to Amazon Gift Card balance".
24
22
  attribute?(:transaction_type, String, from: "TransactionType")
25
23
  end
26
24
  end
@@ -19,27 +19,20 @@ module Peddler
19
19
  #
20
20
  # Possible values:
21
21
  #
22
- # * FBAInventoryReimbursement - An FBA inventory reimbursement to a seller's account. This occurs if a seller's
22
+ # * `FBAInventoryReimbursement`: An FBA inventory reimbursement to a seller's account. This occurs if a seller's
23
23
  # inventory is damaged.
24
- #
25
- # * ReserveEvent - A reserve event that is generated at the time of a settlement period closing. This occurs
26
- # when some money from a seller's account is held back.
27
- #
28
- # * PostageBilling - The amount paid by a seller for shipping labels.
29
- #
30
- # * PostageRefund - The reimbursement of shipping labels purchased for orders that were canceled or refunded.
31
- #
32
- # * LostOrDamagedReimbursement - An Amazon Easy Ship reimbursement to a seller's account for a package that we
24
+ # * `ReserveEvent`: A reserve event that is generated at the time a settlement period closes. This occurs when
25
+ # some money from a seller's account is held back.
26
+ # * `PostageBilling`: The amount paid by a seller for shipping labels.
27
+ # * `PostageRefund`: The reimbursement of shipping labels purchased for orders that were canceled or refunded.
28
+ # * `LostOrDamagedReimbursement`: An Amazon Easy Ship reimbursement to a seller's account for a package that we
33
29
  # lost or damaged.
34
- #
35
- # * CanceledButPickedUpReimbursement - An Amazon Easy Ship reimbursement to a seller's account. This occurs when
36
- # a package is picked up and the order is subsequently canceled. This value is used only in the India
30
+ # * `CanceledButPickedUpReimbursement`: An Amazon Easy Ship reimbursement to a seller's account. This occurs
31
+ # when a package is picked up and the order is subsequently canceled. This value is used only in the India
37
32
  # marketplace.
38
- #
39
- # * ReimbursementClawback - An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs when
40
- # a prior reimbursement is reversed. This value is used only in the India marketplace.
41
- #
42
- # * SellerRewards - An award credited to a seller's account for their participation in an offer in the Seller
33
+ # * `ReimbursementClawback`: An Amazon Easy Ship reimbursement clawback from a seller's account. This occurs
34
+ # when a prior reimbursement is reversed. This value is used only in the India marketplace.
35
+ # * `SellerRewards`: An award credited to a seller's account for their participation in an offer in the Seller
43
36
  # Rewards program. Applies only to the India marketplace.
44
37
  attribute?(:adjustment_type, String, from: "AdjustmentType")
45
38
 
@@ -15,14 +15,14 @@ module Peddler
15
15
  # @return [String] A unique identifier assigned to products stored in and fulfilled from a fulfillment center.
16
16
  attribute?(:fn_sku, String, from: "FnSKU")
17
17
 
18
- # @return [Money] The per unit value of the item.
18
+ # @return [Money] The per-unit value of the item.
19
19
  attribute?(:per_unit_amount, Money, from: "PerUnitAmount")
20
20
 
21
21
  # @return [String] A short description of the item.
22
22
  attribute?(:product_description, String, from: "ProductDescription")
23
23
 
24
- # @return [String] Represents the number of units in the seller's inventory when the AdustmentType is
25
- # FBAInventoryReimbursement.
24
+ # @return [String] Represents the number of units in the seller's inventory when the `AdjustmentType` is
25
+ # `FBAInventoryReimbursement`.
26
26
  attribute?(:quantity, String, from: "Quantity")
27
27
 
28
28
  # @return [String] The seller SKU of the item. The seller SKU is qualified by the seller's seller ID, which is
@@ -24,23 +24,22 @@ module Peddler
24
24
  # @return [Money] The amount charged for clicks incurred under the Sponsored Products program.
25
25
  attribute?(:base_expense, Money, from: "BaseExpense")
26
26
 
27
- # @return [String] An encrypted, Amazon-defined marketplace identifier.
27
+ # @return [String] The Amazon-defined marketplace identifier.
28
28
  attribute?(:marketplace_id, String, from: "MarketplaceId")
29
29
 
30
30
  # @return [String] The date and time when the financial event was created.
31
31
  attribute?(:posted_date, String, from: "PostedDate")
32
32
 
33
- # @return [Money] The total amount charged to the seller. TotalExpense = BaseExpense + TaxTypeIGST + TaxTypeCGST
34
- # + TaxTypeSGST.
33
+ # @return [Money] The total amount charged to the seller. `TotalExpense` = `BaseExpense` + `TaxTypeIGST` +
34
+ # `TaxTypeCGST` + `TaxTypeSGST`.
35
35
  attribute?(:total_expense, Money, from: "TotalExpense")
36
36
 
37
- # @return [String] Indicates the type of transaction.
37
+ # @return [String] The type of transaction.
38
38
  #
39
39
  # Possible values:
40
40
  #
41
- # * Charge - For an affordability promotion expense.
42
- #
43
- # * Refund - For an affordability promotion expense reversal.
41
+ # * `Charge`: an affordability promotion expense.
42
+ # * `Refund`: an affordability promotion expense reversal.
44
43
  attribute?(:transaction_type, String, from: "TransactionType")
45
44
  end
46
45
  end
@@ -18,7 +18,7 @@ module Peddler
18
18
  # @return [Money] The amount of the capacity reservation billing event.
19
19
  attribute?(:transaction_amount, Money, from: "TransactionAmount")
20
20
 
21
- # @return [String] Indicates the type of transaction. For example, FBA Inventory Fee
21
+ # @return [String] The transaction type. For example, FBA Inventory Fee.
22
22
  attribute?(:transaction_type, String, from: "TransactionType")
23
23
  end
24
24
  end
@@ -11,73 +11,75 @@ module Peddler
11
11
  #
12
12
  # Possible values:
13
13
  #
14
- # * Principal - The selling price of the order item, equal to the selling price of the item multiplied by the
15
- # quantity ordered.
14
+ # * `Principal`: The selling price of the order item, which is equal to the selling price of the item multiplied
15
+ # by the quantity ordered.
16
16
  #
17
- # * Tax - The tax collected by the seller on the Principal.
17
+ # * `Tax`: The tax on the principal that is collected by the seller.
18
18
  #
19
- # * MarketplaceFacilitatorTax-Principal - The tax withheld on the Principal.
19
+ # * `MarketplaceFacilitatorTax-Principal`: The tax that is withheld on the principal.
20
20
  #
21
- # * MarketplaceFacilitatorTax-Shipping - The tax withheld on the ShippingCharge.
21
+ # * `MarketplaceFacilitatorTax-Shipping`: The tax that is withheld on the `ShippingCharge`.
22
22
  #
23
- # * MarketplaceFacilitatorTax-Giftwrap - The tax withheld on the Giftwrap charge.
23
+ # * `MarketplaceFacilitatorTax-Giftwrap`: The tax that is withheld on the Giftwrap charge.
24
24
  #
25
- # * MarketplaceFacilitatorTax-Other - The tax withheld on other miscellaneous charges.
25
+ # * `MarketplaceFacilitatorTax-Other`: The tax that is withheld on other miscellaneous charges.
26
26
  #
27
- # * Discount - The promotional discount for an order item.
27
+ # * `Discount`: The promotional discount for an order item.
28
28
  #
29
- # * TaxDiscount - The tax amount deducted for promotional rebates.
29
+ # * `TaxDiscount`: The tax that is deducted for promotional rebates.
30
30
  #
31
- # * CODItemCharge - The COD charge for an order item.
31
+ # * `CODItemCharge`: The COD charge for an order item.
32
32
  #
33
- # * CODItemTaxCharge - The tax collected by the seller on a CODItemCharge.
33
+ # * `CODItemTaxCharge`: The tax that is collected by the seller on a `CODItemCharge`.
34
34
  #
35
- # * CODOrderCharge - The COD charge for an order.
35
+ # * `CODOrderCharge`: The COD charge for an order.
36
36
  #
37
- # * CODOrderTaxCharge - The tax collected by the seller on a CODOrderCharge.
37
+ # * `CODOrderTaxCharge`: The tax that is collected by the seller on a `CODOrderCharge`.
38
38
  #
39
- # * CODShippingCharge - Shipping charges for a COD order.
39
+ # * `CODShippingCharge`: Shipping charges for a COD order.
40
40
  #
41
- # * CODShippingTaxCharge - The tax collected by the seller on a CODShippingCharge.
41
+ # * `CODShippingTaxCharge`: The tax that is collected by the seller on a `CODShippingCharge`.
42
42
  #
43
- # * ShippingCharge - The shipping charge.
43
+ # * `ShippingCharge`: The shipping charge.
44
44
  #
45
- # * ShippingTax - The tax collected by the seller on a ShippingCharge.
45
+ # * `ShippingTax`: The tax that is collected by the seller on a `ShippingCharge`.
46
46
  #
47
- # * Goodwill - The amount given to a buyer as a gesture of goodwill or to compensate for pain and suffering in the
48
- # buying experience.
47
+ # * `Goodwill`: The amount of money that is given to a buyer as a gesture of goodwill or to compensate for pain
48
+ # and suffering in the buying experience.
49
49
  #
50
- # * Giftwrap - The gift wrap charge.
50
+ # * `Giftwrap`: The gift wrap charge.
51
51
  #
52
- # * GiftwrapTax - The tax collected by the seller on a Giftwrap charge.
52
+ # * `GiftwrapTax`: The tax that is collected by the seller on a gift wrap charge.
53
53
  #
54
- # * RestockingFee - The charge applied to the buyer when returning a product in certain categories.
54
+ # * `RestockingFee`: The charge that is applied to the buyer when returning a product in certain categories.
55
55
  #
56
- # * ReturnShipping - The amount given to the buyer to compensate for shipping the item back in the event we are at
57
- # fault.
56
+ # * `ReturnShipping`: The amount of money that is given to the buyer to compensate for shipping the item back if
57
+ # we are at fault.
58
58
  #
59
- # * PointsFee - The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon
59
+ # * `PointsFee`: The value of Amazon Points deducted from the refund if the buyer does not have enough Amazon
60
60
  # Points to cover the deduction.
61
61
  #
62
- # * GenericDeduction - A generic bad debt deduction.
62
+ # * `GenericDeduction`: A generic bad debt deduction.
63
63
  #
64
- # * FreeReplacementReturnShipping - The compensation for return shipping when a buyer receives the wrong item,
64
+ # * `FreeReplacementReturnShipping`: The compensation for return shipping when a buyer receives the wrong item,
65
65
  # requests a free replacement, and returns the incorrect item.
66
66
  #
67
- # * PaymentMethodFee - The fee collected for certain payment methods in certain marketplaces.
67
+ # * `PaymentMethodFee`: The fee that is collected for certain payment methods in certain marketplaces.
68
68
  #
69
- # * ExportCharge - The export duty that is charged when an item is shipped to an international destination as part
70
- # of the Amazon Global program.
69
+ # * `ExportCharge`: The export duty that is charged when an item is shipped to an international destination as
70
+ # part of the Amazon Global program.
71
71
  #
72
- # * SAFE-TReimbursement - The SAFE-T claim amount for the item.
72
+ # * `SAFE-TReimbursement`: The SAFE-T claim amount for the item.
73
73
  #
74
- # * TCS-CGST - Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).
74
+ # * `TCS-CGST`: Tax Collected at Source (TCS) for Central Goods and Services Tax (CGST).
75
75
  #
76
- # * TCS-SGST - Tax Collected at Source for State Goods and Services Tax (SGST).
76
+ # * `TCS-SGST`: Tax Collected at Source for State Goods and Services Tax (SGST).
77
77
  #
78
- # * TCS-IGST - Tax Collected at Source for Integrated Goods and Services Tax (IGST).
78
+ # * `TCS-IGST`: Tax Collected at Source for Integrated Goods and Services Tax (IGST).
79
79
  #
80
- # * TCS-UTGST - Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).
80
+ # * `TCS-UTGST`: Tax Collected at Source for Union Territories Goods and Services Tax (UTGST).
81
+ #
82
+ # * `PaidthroughEBT`: The amount of money paid with EBT for any order or shipment items.
81
83
  ChargeComponent = Structure.new do
82
84
  # @return [Money] The amount of the charge.
83
85
  attribute?(:charge_amount, Money, from: "ChargeAmount")
@@ -15,14 +15,10 @@ module Peddler
15
15
  # @return [String] The date and time when the financial event was posted.
16
16
  attribute?(:posted_date, String, from: "PostedDate")
17
17
 
18
- # @return [String] The reason given for a charge refund.
19
- #
20
- # Example: `SubscriptionFeeCorrection`
18
+ # @return [String] The reason given for a charge refund. For example, `SubscriptionFeeCorrection`.
21
19
  attribute?(:reason_code, String, from: "ReasonCode")
22
20
 
23
- # @return [String] A description of the Reason Code.
24
- #
25
- # Example: `SubscriptionFeeCorrection`
21
+ # @return [String] A description of the Reason Code. For example, `SubscriptionFeeCorrection`.
26
22
  attribute?(:reason_code_description, String, from: "ReasonCodeDescription")
27
23
  end
28
24
  end
@@ -30,7 +30,7 @@ module Peddler
30
30
  # @return [String] The description provided by the seller when they created the coupon.
31
31
  attribute?(:seller_coupon_description, String, from: "SellerCouponDescription")
32
32
 
33
- # @return [Money] The FeeComponent value plus the ChargeComponent value.
33
+ # @return [Money] The `FeeComponent` value plus the `ChargeComponent` value.
34
34
  attribute?(:total_amount, Money, from: "TotalAmount")
35
35
  end
36
36
  end
@@ -19,11 +19,7 @@ module Peddler
19
19
  #
20
20
  # Possible values:
21
21
  #
22
- # * DebtPayment
23
- #
24
- # * DebtPaymentFailure
25
- #
26
- # * DebtAdjustment
22
+ # * `DebtPayment` * `DebtPaymentFailure` * `DebtAdjustment`
27
23
  attribute?(:debt_recovery_type, String, from: "DebtRecoveryType")
28
24
 
29
25
  # @return [Money] The amount returned for overpayment.
@@ -9,12 +9,12 @@ module Peddler
9
9
  class FinancesV0
10
10
  # An item of a debt payment or debt adjustment.
11
11
  DebtRecoveryItem = Structure.new do
12
- # @return [String] The beginning date and time of the financial event group that contains the debt. In [ISO
13
- # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
12
+ # @return [String] The start date and time of the financial event group that contains the debt. In [ISO
13
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
14
14
  attribute?(:group_begin_date, String, from: "GroupBeginDate")
15
15
 
16
- # @return [String] The ending date and time of the financial event group that contains the debt. In [ISO
17
- # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
16
+ # @return [String] The end date and time of the financial event group that contains the debt. In [ISO
17
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
18
18
  attribute?(:group_end_date, String, from: "GroupEndDate")
19
19
 
20
20
  # @return [Money] The original debt amount.
@@ -16,21 +16,21 @@ module Peddler
16
16
  #
17
17
  # Possible values:
18
18
  #
19
- # * StoredValueCardRevenue - The amount that is deducted from the seller's account because the seller received
19
+ # * `StoredValueCardRevenue` - The amount that is deducted from the seller's account because the seller received
20
20
  # money through a stored value card.
21
21
  #
22
- # * StoredValueCardRefund - The amount that Amazon returns to the seller if the order that is bought using a
23
- # stored value card is refunded.
22
+ # * `StoredValueCardRefund` - The amount that Amazon returns to the seller if the order that is purchased using
23
+ # a stored value card is refunded.
24
24
  #
25
- # * PrivateLabelCreditCardRevenue - The amount that is deducted from the seller's account because the seller
25
+ # * `PrivateLabelCreditCardRevenue` - The amount that is deducted from the seller's account because the seller
26
26
  # received money through a private label credit card offered by Amazon.
27
27
  #
28
- # * PrivateLabelCreditCardRefund - The amount that Amazon returns to the seller if the order that is bought
28
+ # * `PrivateLabelCreditCardRefund` - The amount that Amazon returns to the seller if the order that is purchased
29
29
  # using a private label credit card offered by Amazon is refunded.
30
30
  #
31
- # * CollectOnDeliveryRevenue - The COD amount that the seller collected directly from the buyer.
31
+ # * `CollectOnDeliveryRevenue` - The COD amount that the seller collected directly from the buyer.
32
32
  #
33
- # * CollectOnDeliveryRefund - The amount that Amazon refunds to the buyer if an order paid for by COD is
33
+ # * `CollectOnDeliveryRefund` - The amount that Amazon refunds to the buyer if an order paid for by COD is
34
34
  # refunded.
35
35
  attribute?(:direct_payment_type, String, from: "DirectPaymentType")
36
36
  end
@@ -0,0 +1,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Do not edit.
4
+
5
+ require "structure"
6
+
7
+ module Peddler
8
+ module APIs
9
+ class FinancesV0
10
+ # An EBT refund reimbursement event.
11
+ EBTRefundReimbursementOnlyEvent = Structure.new do
12
+ # @return [Money] The amount reimbursed during this event.
13
+ attribute?(:amount, Money, from: "Amount")
14
+
15
+ # @return [String] The identifier of an order.
16
+ attribute?(:order_id, String, from: "OrderId")
17
+
18
+ # @return [String] The date and time when the financial event was posted.
19
+ attribute?(:posted_date, String, from: "PostedDate")
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ # This file is generated. Edit template if necessary.
4
+
5
+ module Peddler
6
+ module APIs
7
+ class FinancesV0
8
+ # A list of EBT refund reimbursement events.
9
+ class EBTRefundReimbursementOnlyEventList < Array
10
+ class << self
11
+ def parse(array)
12
+ new(array.map { |item| EBTRefundReimbursementOnlyEvent.parse(item) })
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -12,22 +12,16 @@ module Peddler
12
12
  # @return [String] The disbursement identifier.
13
13
  attribute?(:disbursement_id, String, from: "DisbursementId")
14
14
 
15
- # @return [String] The type of fund transfer.
16
- #
17
- # Example "Refund"
15
+ # @return [String] The type of fund transfer. For example, `Refund`.
18
16
  attribute?(:funds_transfers_type, String, from: "FundsTransfersType")
19
17
 
20
- # @return [String] The type of payment for disbursement.
21
- #
22
- # Example `CREDIT_CARD`
18
+ # @return [String] The type of payment for disbursement. For example, `CREDIT_CARD`.
23
19
  attribute?(:payment_disbursement_type, String, from: "PaymentDisbursementType")
24
20
 
25
21
  # @return [String] The date and time when the financial event was posted.
26
22
  attribute?(:posted_date, String, from: "PostedDate")
27
23
 
28
- # @return [String] The status of the failed `AdhocDisbursement`.
29
- #
30
- # Example `HARD_DECLINED`
24
+ # @return [String] The status of the failed `AdhocDisbursement`. For example, `HARD_DECLINED`.
31
25
  attribute?(:status, String, from: "Status")
32
26
 
33
27
  # @return [Money] The amount of the Adhoc Disbursement.
@@ -5,7 +5,7 @@
5
5
  module Peddler
6
6
  module APIs
7
7
  class FinancesV0
8
- # A list of `FailedAdhocDisbursementEvent`s.
8
+ # A list of `FailedAdhocDisbursementEvent`.
9
9
  class FailedAdhocDisbursementEventList < Array
10
10
  class << self
11
11
  def parse(array)
@@ -14,7 +14,7 @@ module Peddler
14
14
  attribute?(:liquidation_fee_amount, Money, from: "LiquidationFeeAmount")
15
15
 
16
16
  # @return [Money] The amount paid by the liquidator for the seller's inventory. The seller receives this amount
17
- # minus LiquidationFeeAmount.
17
+ # minus `LiquidationFeeAmount`.
18
18
  attribute?(:liquidation_proceeds_amount, Money, from: "LiquidationProceedsAmount")
19
19
 
20
20
  # @return [String] The identifier for the original removal order.
@@ -12,25 +12,25 @@ module Peddler
12
12
  # @return [String] The account tail of the payment instrument.
13
13
  attribute?(:account_tail, String, from: "AccountTail")
14
14
 
15
- # @return [Money] The balance at the beginning of the settlement period.
15
+ # @return [Money] The balance at the start of the settlement period.
16
16
  attribute?(:beginning_balance, Money, from: "BeginningBalance")
17
17
 
18
18
  # @return [Money] The total amount in the currency of the marketplace in which the funds were disbursed.
19
19
  attribute?(:converted_total, Money, from: "ConvertedTotal")
20
20
 
21
21
  # @return [String] The date and time at which the financial event group is closed. In [ISO
22
- # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
22
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
23
23
  attribute?(:financial_event_group_end, String, from: "FinancialEventGroupEnd")
24
24
 
25
25
  # @return [String] A unique identifier for the financial event group.
26
26
  attribute?(:financial_event_group_id, String, from: "FinancialEventGroupId")
27
27
 
28
28
  # @return [String] The date and time at which the financial event group is opened. In [ISO
29
- # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
29
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
30
30
  attribute?(:financial_event_group_start, String, from: "FinancialEventGroupStart")
31
31
 
32
32
  # @return [String] The date and time when the disbursement or charge was initiated. Only present for closed
33
- # settlements. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
33
+ # settlements. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
34
34
  attribute?(:fund_transfer_date, String, from: "FundTransferDate")
35
35
 
36
36
  # @return [String] The status of the fund transfer.
@@ -46,9 +46,7 @@ module Peddler
46
46
  #
47
47
  # Possible values:
48
48
  #
49
- # * Open
50
- #
51
- # * Closed
49
+ # * `Open` * `Closed`
52
50
  attribute?(:processing_status, String, from: "ProcessingStatus")
53
51
 
54
52
  # @return [String] The trace identifier used by sellers to look up transactions externally.
@@ -7,7 +7,7 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class FinancesV0
10
- # Contains all information related to a financial event.
10
+ # All the information that is related to a financial event.
11
11
  FinancialEvents = Structure.new do
12
12
  # @return [Array<AdhocDisbursementEvent>]
13
13
  attribute?(:adhoc_disbursement_event_list, [AdhocDisbursementEvent], from: "AdhocDisbursementEventList")
@@ -36,6 +36,9 @@ module Peddler
36
36
  # @return [Array<DebtRecoveryEvent>]
37
37
  attribute?(:debt_recovery_event_list, [DebtRecoveryEvent], from: "DebtRecoveryEventList")
38
38
 
39
+ # @return [Array<EBTRefundReimbursementOnlyEvent>] A list of EBT refund reimbursement events.
40
+ attribute?(:ebt_refund_reimbursement_only_event_list, [EBTRefundReimbursementOnlyEvent], from: "EBTRefundReimbursementOnlyEventList")
41
+
39
42
  # @return [Array<FBALiquidationEvent>]
40
43
  attribute?(:fba_liquidation_event_list, [FBALiquidationEvent], from: "FBALiquidationEventList")
41
44
 
@@ -7,7 +7,7 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class FinancesV0
10
- # The payload for the listFinancialEventGroups operation.
10
+ # The payload for the `listFinancialEventGroups` operation.
11
11
  ListFinancialEventGroupsPayload = Structure.new do
12
12
  # @return [Array<FinancialEventGroup>]
13
13
  attribute?(:financial_event_group_list, [FinancialEventGroup], from: "FinancialEventGroupList")
@@ -7,12 +7,12 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class FinancesV0
10
- # The response schema for the listFinancialEventGroups operation.
10
+ # The response schema for the `listFinancialEventGroups` operation.
11
11
  ListFinancialEventGroupsResponse = Structure.new do
12
- # @return [Array<Error>] One or more unexpected errors occurred during the listFinancialEventGroups operation.
12
+ # @return [Array<Error>] One or more unexpected errors occurred during the `listFinancialEventGroups` operation.
13
13
  attribute?(:errors, [Error])
14
14
 
15
- # @return [ListFinancialEventGroupsPayload] The payload for the listFinancialEventGroups operation.
15
+ # @return [ListFinancialEventGroupsPayload] The payload for the `listFinancialEventGroups` operation.
16
16
  attribute?(:payload, ListFinancialEventGroupsPayload)
17
17
  end
18
18
  end
@@ -7,7 +7,7 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class FinancesV0
10
- # The payload for the listFinancialEvents operation.
10
+ # The payload for the `listFinancialEvents` operation.
11
11
  ListFinancialEventsPayload = Structure.new do
12
12
  # @return [FinancialEvents]
13
13
  attribute?(:financial_events, FinancialEvents, from: "FinancialEvents")
@@ -7,12 +7,12 @@ require "structure"
7
7
  module Peddler
8
8
  module APIs
9
9
  class FinancesV0
10
- # The response schema for the listFinancialEvents operation.
10
+ # The response schema for the `listFinancialEvents` operation.
11
11
  ListFinancialEventsResponse = Structure.new do
12
- # @return [Array<Error>] One or more unexpected errors occurred during the listFinancialEvents operation.
12
+ # @return [Array<Error>] One or more unexpected errors occurred during the `listFinancialEvents` operation.
13
13
  attribute?(:errors, [Error])
14
14
 
15
- # @return [ListFinancialEventsPayload] The payload for the listFinancialEvents operation.
15
+ # @return [ListFinancialEventsPayload] The payload for the `listFinancialEvents` operation.
16
16
  attribute?(:payload, ListFinancialEventsPayload)
17
17
  end
18
18
  end
@@ -16,11 +16,11 @@ module Peddler
16
16
  #
17
17
  # Possible values:
18
18
  #
19
- # * LoanAdvance
19
+ # * `LoanAdvance`
20
20
  #
21
- # * LoanPayment
21
+ # * `LoanPayment`
22
22
  #
23
- # * LoanRefund
23
+ # * `LoanRefund`
24
24
  attribute?(:source_business_event_type, String, from: "SourceBusinessEventType")
25
25
  end
26
26
  end
@@ -27,16 +27,16 @@ module Peddler
27
27
  # @return [Money] The tax on the network item swap paid by the seller.
28
28
  attribute?(:tax_amount, Money, from: "TaxAmount")
29
29
 
30
- # @return [Money] The price of the swapped item minus TaxAmount.
30
+ # @return [Money] The price of the swapped item minus `TaxAmount`.
31
31
  attribute?(:tax_exclusive_amount, Money, from: "TaxExclusiveAmount")
32
32
 
33
33
  # @return [String] The type of network item swap.
34
34
  #
35
35
  # Possible values:
36
36
  #
37
- # * NetCo - A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.
37
+ # * `NetCo`: A Fulfillment by Amazon inventory pooling transaction. Available only in the India marketplace.
38
38
  #
39
- # * ComminglingVAT - A commingling VAT transaction. Available only in the UK, Spain, France, Germany, and Italy
39
+ # * `ComminglingVAT`: A commingling VAT transaction. Available only in the Spain, UK, France, Germany, and Italy
40
40
  # marketplaces.
41
41
  attribute?(:transaction_type, String, from: "TransactionType")
42
42
  end
@@ -25,16 +25,16 @@ module Peddler
25
25
  #
26
26
  # Possible values:
27
27
  #
28
- # * AFN - Amazon Fulfillment Network (Fulfillment by Amazon)
28
+ # * `AFN`: Amazon Fulfillment Network (Fulfillment by Amazon)
29
29
  #
30
- # * MFN - Merchant Fulfillment Network (self-fulfilled)
30
+ # * `MFN`: Merchant Fulfillment Network (self-fulfilled)
31
31
  attribute?(:fulfillment_channel, String, from: "FulfillmentChannel")
32
32
 
33
33
  # @return [String] The type of payment.
34
34
  #
35
35
  # Possible values:
36
36
  #
37
- # * Sales
37
+ # * `Sales`
38
38
  attribute?(:payment_amount_type, String, from: "PaymentAmountType")
39
39
 
40
40
  # @return [String] The sales channel for the transaction.
@@ -43,11 +43,11 @@ module Peddler
43
43
  # @return [String] An order identifier that is specified by the seller.
44
44
  attribute?(:seller_order_id, String, from: "SellerOrderId")
45
45
 
46
- # @return [String] The store name where the event occurred.
46
+ # @return [String] The name of the store where the event occurred.
47
47
  attribute?(:store_name, String, from: "StoreName")
48
48
 
49
49
  # @return [String] The date and time when the payment transaction is posted. In [ISO
50
- # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date time format.
50
+ # 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.
51
51
  attribute?(:transaction_posted_date, String, from: "TransactionPostedDate")
52
52
  end
53
53
  end
@@ -12,7 +12,7 @@ module Peddler
12
12
  # @return [Money] Base amount of the transaction, before tax.
13
13
  attribute?(:base_value, Money, from: "baseValue")
14
14
 
15
- # @return [String] Identifier for the invoice that the transaction appears in.
15
+ # @return [String] The identifier for the invoice that includes the transaction.
16
16
  attribute?(:invoice_id, String, from: "invoiceId")
17
17
 
18
18
  # @return [String] The date and time when the financial event was posted.
@@ -25,12 +25,12 @@ module Peddler
25
25
  #
26
26
  # Possible values:
27
27
  #
28
- # * charge - Charge
28
+ # * `charge`
29
29
  #
30
- # * refund - Refund
30
+ # * `refund`
31
31
  attribute?(:transaction_type, String, from: "transactionType")
32
32
 
33
- # @return [Money] The total amount of the transaction. Equal to baseValue + taxValue.
33
+ # @return [Money] The total amount of the transaction. Equal to `baseValue` + `taxValue`.
34
34
  attribute?(:transaction_value, Money, from: "transactionValue")
35
35
  end
36
36
  end