dodopayments 2.34.0 → 2.35.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 (250) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/dodopayments/models/addon_delete_params.rb +20 -0
  5. data/lib/dodopayments/models/addon_list_params.rb +25 -1
  6. data/lib/dodopayments/models/addon_retrieve_params.rb +18 -1
  7. data/lib/dodopayments/models/addon_unarchive_params.rb +20 -0
  8. data/lib/dodopayments/models/addons/translation_delete_params.rb +36 -0
  9. data/lib/dodopayments/models/addons/translation_list_params.rb +35 -0
  10. data/lib/dodopayments/models/addons/translation_update_params.rb +52 -0
  11. data/lib/dodopayments/models/balance_ledger_entry.rb +1 -0
  12. data/lib/dodopayments/models/balance_retrieve_ledger_params.rb +1 -0
  13. data/lib/dodopayments/models/checkout_session_preview_params.rb +17 -1
  14. data/lib/dodopayments/models/create_new_customer.rb +12 -1
  15. data/lib/dodopayments/models/credit_entitlement_list_params.rb +17 -1
  16. data/lib/dodopayments/models/credit_entitlement_retrieve_params.rb +18 -1
  17. data/lib/dodopayments/models/credit_entitlements/credit_entitlement_translation.rb +47 -0
  18. data/lib/dodopayments/models/credit_entitlements/credit_entitlement_translations_list_response.rb +23 -0
  19. data/lib/dodopayments/models/credit_entitlements/translation_delete_params.rb +37 -0
  20. data/lib/dodopayments/models/credit_entitlements/translation_list_params.rb +36 -0
  21. data/lib/dodopayments/models/credit_entitlements/translation_update_params.rb +53 -0
  22. data/lib/dodopayments/models/customer.rb +9 -1
  23. data/lib/dodopayments/models/customer_create_params.rb +14 -1
  24. data/lib/dodopayments/models/customer_update_params.rb +14 -1
  25. data/lib/dodopayments/models/entitlement_list_params.rb +17 -1
  26. data/lib/dodopayments/models/entitlement_retrieve_params.rb +18 -1
  27. data/lib/dodopayments/models/entitlements/entitlement_translation.rb +67 -0
  28. data/lib/dodopayments/models/entitlements/entitlement_translations_list_response.rb +23 -0
  29. data/lib/dodopayments/models/entitlements/translation_delete_params.rb +36 -0
  30. data/lib/dodopayments/models/entitlements/translation_list_params.rb +35 -0
  31. data/lib/dodopayments/models/entitlements/translation_update_params.rb +69 -0
  32. data/lib/dodopayments/models/locale.rb +38 -0
  33. data/lib/dodopayments/models/locale_info.rb +34 -0
  34. data/lib/dodopayments/models/meter_list_params.rb +17 -1
  35. data/lib/dodopayments/models/meter_retrieve_params.rb +18 -1
  36. data/lib/dodopayments/models/meter_update_params.rb +49 -0
  37. data/lib/dodopayments/models/meters/translation_delete_params.rb +36 -0
  38. data/lib/dodopayments/models/meters/translation_list_params.rb +35 -0
  39. data/lib/dodopayments/models/meters/translation_update_params.rb +52 -0
  40. data/lib/dodopayments/models/misc_list_locales_params.rb +14 -0
  41. data/lib/dodopayments/models/misc_list_locales_response.rb +8 -0
  42. data/lib/dodopayments/models/payment.rb +29 -1
  43. data/lib/dodopayments/models/payment_list_response.rb +29 -1
  44. data/lib/dodopayments/models/payment_retrieve_line_items_params.rb +14 -1
  45. data/lib/dodopayments/models/payment_retrieve_line_items_response.rb +10 -1
  46. data/lib/dodopayments/models/payouts/breakup/detail_list_response.rb +3 -1
  47. data/lib/dodopayments/models/payouts/breakup_retrieve_response.rb +2 -1
  48. data/lib/dodopayments/models/product_collection_list_params.rb +17 -1
  49. data/lib/dodopayments/models/product_collection_retrieve_params.rb +18 -1
  50. data/lib/dodopayments/models/product_collections/translation_delete_params.rb +37 -0
  51. data/lib/dodopayments/models/product_collections/translation_list_params.rb +36 -0
  52. data/lib/dodopayments/models/product_collections/translation_update_params.rb +53 -0
  53. data/lib/dodopayments/models/product_list_params.rb +14 -1
  54. data/lib/dodopayments/models/product_retrieve_params.rb +18 -1
  55. data/lib/dodopayments/models/products/translation.rb +50 -0
  56. data/lib/dodopayments/models/products/translation_delete_params.rb +36 -0
  57. data/lib/dodopayments/models/products/translation_list_params.rb +35 -0
  58. data/lib/dodopayments/models/products/translation_update_params.rb +52 -0
  59. data/lib/dodopayments/models/products/translations_list_response.rb +20 -0
  60. data/lib/dodopayments/models/refund_create_params.rb +13 -1
  61. data/lib/dodopayments/models/subscription_list_params.rb +14 -1
  62. data/lib/dodopayments/models/subscription_retrieve_params.rb +18 -1
  63. data/lib/dodopayments/models/three_ds_flow.rb +16 -0
  64. data/lib/dodopayments/models/three_ds_status.rb +21 -0
  65. data/lib/dodopayments/models/update_subscription_plan_req.rb +10 -0
  66. data/lib/dodopayments/models.rb +20 -0
  67. data/lib/dodopayments/resources/addons/translations.rb +110 -0
  68. data/lib/dodopayments/resources/addons.rb +58 -3
  69. data/lib/dodopayments/resources/checkout_sessions.rb +31 -26
  70. data/lib/dodopayments/resources/credit_entitlements/translations.rb +113 -0
  71. data/lib/dodopayments/resources/credit_entitlements.rb +20 -3
  72. data/lib/dodopayments/resources/customers.rb +12 -2
  73. data/lib/dodopayments/resources/entitlements/translations.rb +114 -0
  74. data/lib/dodopayments/resources/entitlements.rb +20 -3
  75. data/lib/dodopayments/resources/meters/translations.rb +110 -0
  76. data/lib/dodopayments/resources/meters.rb +49 -3
  77. data/lib/dodopayments/resources/misc.rb +18 -0
  78. data/lib/dodopayments/resources/payments.rb +10 -2
  79. data/lib/dodopayments/resources/payouts/breakup/details.rb +5 -2
  80. data/lib/dodopayments/resources/payouts/breakup.rb +4 -1
  81. data/lib/dodopayments/resources/product_collections/translations.rb +113 -0
  82. data/lib/dodopayments/resources/product_collections.rb +20 -3
  83. data/lib/dodopayments/resources/products/translations.rb +110 -0
  84. data/lib/dodopayments/resources/products.rb +17 -3
  85. data/lib/dodopayments/resources/refunds.rb +6 -1
  86. data/lib/dodopayments/resources/subscriptions.rb +13 -3
  87. data/lib/dodopayments/version.rb +1 -1
  88. data/lib/dodopayments.rb +39 -0
  89. data/rbi/dodopayments/models/addon_delete_params.rbi +38 -0
  90. data/rbi/dodopayments/models/addon_list_params.rbi +32 -0
  91. data/rbi/dodopayments/models/addon_retrieve_params.rbi +29 -2
  92. data/rbi/dodopayments/models/addon_unarchive_params.rbi +38 -0
  93. data/rbi/dodopayments/models/addons/translation_delete_params.rbi +58 -0
  94. data/rbi/dodopayments/models/addons/translation_list_params.rbi +59 -0
  95. data/rbi/dodopayments/models/addons/translation_update_params.rbi +74 -0
  96. data/rbi/dodopayments/models/balance_ledger_entry.rbi +5 -0
  97. data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi +5 -0
  98. data/rbi/dodopayments/models/checkout_session_preview_params.rbi +29 -5
  99. data/rbi/dodopayments/models/create_new_customer.rbi +17 -3
  100. data/rbi/dodopayments/models/credit_entitlement_list_params.rbi +21 -0
  101. data/rbi/dodopayments/models/credit_entitlement_retrieve_params.rbi +29 -2
  102. data/rbi/dodopayments/models/credit_entitlements/credit_entitlement_translation.rbi +70 -0
  103. data/rbi/dodopayments/models/credit_entitlements/credit_entitlement_translations_list_response.rbi +54 -0
  104. data/rbi/dodopayments/models/credit_entitlements/translation_delete_params.rbi +58 -0
  105. data/rbi/dodopayments/models/credit_entitlements/translation_list_params.rbi +59 -0
  106. data/rbi/dodopayments/models/credit_entitlements/translation_update_params.rbi +74 -0
  107. data/rbi/dodopayments/models/customer.rbi +11 -3
  108. data/rbi/dodopayments/models/customer_create_params.rbi +12 -0
  109. data/rbi/dodopayments/models/customer_update_params.rbi +12 -0
  110. data/rbi/dodopayments/models/entitlement_list_params.rbi +21 -0
  111. data/rbi/dodopayments/models/entitlement_retrieve_params.rbi +29 -2
  112. data/rbi/dodopayments/models/entitlements/entitlement_translation.rbi +87 -0
  113. data/rbi/dodopayments/models/entitlements/entitlement_translations_list_response.rbi +48 -0
  114. data/rbi/dodopayments/models/entitlements/translation_delete_params.rbi +58 -0
  115. data/rbi/dodopayments/models/entitlements/translation_list_params.rbi +59 -0
  116. data/rbi/dodopayments/models/entitlements/translation_update_params.rbi +92 -0
  117. data/rbi/dodopayments/models/locale.rbi +42 -0
  118. data/rbi/dodopayments/models/locale_info.rbi +54 -0
  119. data/rbi/dodopayments/models/meter_list_params.rbi +21 -0
  120. data/rbi/dodopayments/models/meter_retrieve_params.rbi +29 -2
  121. data/rbi/dodopayments/models/meter_update_params.rbi +70 -0
  122. data/rbi/dodopayments/models/meters/translation_delete_params.rbi +58 -0
  123. data/rbi/dodopayments/models/meters/translation_list_params.rbi +59 -0
  124. data/rbi/dodopayments/models/meters/translation_update_params.rbi +74 -0
  125. data/rbi/dodopayments/models/misc_list_locales_params.rbi +32 -0
  126. data/rbi/dodopayments/models/misc_list_locales_response.rbi +11 -0
  127. data/rbi/dodopayments/models/payment.rbi +33 -0
  128. data/rbi/dodopayments/models/payment_list_response.rbi +36 -3
  129. data/rbi/dodopayments/models/payment_retrieve_line_items_params.rbi +21 -2
  130. data/rbi/dodopayments/models/payment_retrieve_line_items_response.rbi +14 -3
  131. data/rbi/dodopayments/models/payouts/breakup/detail_list_response.rbi +6 -2
  132. data/rbi/dodopayments/models/payouts/breakup_retrieve_response.rbi +4 -2
  133. data/rbi/dodopayments/models/product_collection_list_params.rbi +21 -0
  134. data/rbi/dodopayments/models/product_collection_retrieve_params.rbi +29 -2
  135. data/rbi/dodopayments/models/product_collections/translation_delete_params.rbi +58 -0
  136. data/rbi/dodopayments/models/product_collections/translation_list_params.rbi +59 -0
  137. data/rbi/dodopayments/models/product_collections/translation_update_params.rbi +74 -0
  138. data/rbi/dodopayments/models/product_list_params.rbi +21 -0
  139. data/rbi/dodopayments/models/product_retrieve_params.rbi +29 -2
  140. data/rbi/dodopayments/models/products/translation.rbi +70 -0
  141. data/rbi/dodopayments/models/products/translation_delete_params.rbi +58 -0
  142. data/rbi/dodopayments/models/products/translation_list_params.rbi +59 -0
  143. data/rbi/dodopayments/models/products/translation_update_params.rbi +74 -0
  144. data/rbi/dodopayments/models/products/translations_list_response.rbi +37 -0
  145. data/rbi/dodopayments/models/refund_create_params.rbi +10 -0
  146. data/rbi/dodopayments/models/subscription_list_params.rbi +21 -0
  147. data/rbi/dodopayments/models/subscription_retrieve_params.rbi +25 -1
  148. data/rbi/dodopayments/models/three_ds_flow.rbi +23 -0
  149. data/rbi/dodopayments/models/three_ds_status.rbi +31 -0
  150. data/rbi/dodopayments/models/update_subscription_plan_req.rbi +15 -0
  151. data/rbi/dodopayments/models.rbi +20 -0
  152. data/rbi/dodopayments/resources/addons/translations.rbi +77 -0
  153. data/rbi/dodopayments/resources/addons.rbi +48 -0
  154. data/rbi/dodopayments/resources/checkout_sessions.rbi +55 -39
  155. data/rbi/dodopayments/resources/credit_entitlements/translations.rbi +81 -0
  156. data/rbi/dodopayments/resources/credit_entitlements.rbi +19 -0
  157. data/rbi/dodopayments/resources/customers.rbi +10 -0
  158. data/rbi/dodopayments/resources/entitlements/translations.rbi +87 -0
  159. data/rbi/dodopayments/resources/entitlements.rbi +19 -0
  160. data/rbi/dodopayments/resources/meters/translations.rbi +77 -0
  161. data/rbi/dodopayments/resources/meters.rbi +42 -0
  162. data/rbi/dodopayments/resources/misc.rbi +9 -0
  163. data/rbi/dodopayments/resources/payments.rbi +4 -0
  164. data/rbi/dodopayments/resources/payouts/breakup/details.rbi +5 -2
  165. data/rbi/dodopayments/resources/payouts/breakup.rbi +4 -1
  166. data/rbi/dodopayments/resources/product_collections/translations.rbi +77 -0
  167. data/rbi/dodopayments/resources/product_collections.rbi +19 -0
  168. data/rbi/dodopayments/resources/products/translations.rbi +77 -0
  169. data/rbi/dodopayments/resources/products.rbi +19 -0
  170. data/rbi/dodopayments/resources/refunds.rbi +4 -0
  171. data/rbi/dodopayments/resources/subscriptions.rbi +26 -0
  172. data/sig/dodopayments/models/addon_delete_params.rbs +23 -0
  173. data/sig/dodopayments/models/addon_list_params.rbs +18 -1
  174. data/sig/dodopayments/models/addon_retrieve_params.rbs +8 -1
  175. data/sig/dodopayments/models/addon_unarchive_params.rbs +23 -0
  176. data/sig/dodopayments/models/addons/translation_delete_params.rbs +30 -0
  177. data/sig/dodopayments/models/addons/translation_list_params.rbs +32 -0
  178. data/sig/dodopayments/models/addons/translation_update_params.rbs +43 -0
  179. data/sig/dodopayments/models/balance_ledger_entry.rbs +2 -0
  180. data/sig/dodopayments/models/balance_retrieve_ledger_params.rbs +2 -0
  181. data/sig/dodopayments/models/checkout_session_preview_params.rbs +13 -3
  182. data/sig/dodopayments/models/create_new_customer.rbs +8 -3
  183. data/sig/dodopayments/models/credit_entitlement_list_params.rbs +12 -1
  184. data/sig/dodopayments/models/credit_entitlement_retrieve_params.rbs +8 -1
  185. data/sig/dodopayments/models/credit_entitlements/credit_entitlement_translation.rbs +39 -0
  186. data/sig/dodopayments/models/credit_entitlements/credit_entitlement_translations_list_response.rbs +24 -0
  187. data/sig/dodopayments/models/credit_entitlements/translation_delete_params.rbs +30 -0
  188. data/sig/dodopayments/models/credit_entitlements/translation_list_params.rbs +32 -0
  189. data/sig/dodopayments/models/credit_entitlements/translation_update_params.rbs +43 -0
  190. data/sig/dodopayments/models/customer.rbs +8 -3
  191. data/sig/dodopayments/models/customer_create_params.rbs +6 -1
  192. data/sig/dodopayments/models/customer_update_params.rbs +6 -1
  193. data/sig/dodopayments/models/entitlement_list_params.rbs +7 -0
  194. data/sig/dodopayments/models/entitlement_retrieve_params.rbs +8 -1
  195. data/sig/dodopayments/models/entitlements/entitlement_translation.rbs +49 -0
  196. data/sig/dodopayments/models/entitlements/entitlement_translations_list_response.rbs +22 -0
  197. data/sig/dodopayments/models/entitlements/translation_delete_params.rbs +30 -0
  198. data/sig/dodopayments/models/entitlements/translation_list_params.rbs +32 -0
  199. data/sig/dodopayments/models/entitlements/translation_update_params.rbs +53 -0
  200. data/sig/dodopayments/models/locale.rbs +56 -0
  201. data/sig/dodopayments/models/locale_info.rbs +26 -0
  202. data/sig/dodopayments/models/meter_list_params.rbs +12 -1
  203. data/sig/dodopayments/models/meter_retrieve_params.rbs +8 -1
  204. data/sig/dodopayments/models/meter_update_params.rbs +41 -0
  205. data/sig/dodopayments/models/meters/translation_delete_params.rbs +30 -0
  206. data/sig/dodopayments/models/meters/translation_list_params.rbs +32 -0
  207. data/sig/dodopayments/models/meters/translation_update_params.rbs +43 -0
  208. data/sig/dodopayments/models/misc_list_locales_params.rbs +15 -0
  209. data/sig/dodopayments/models/misc_list_locales_response.rbs +7 -0
  210. data/sig/dodopayments/models/payment.rbs +15 -0
  211. data/sig/dodopayments/models/payment_list_response.rbs +18 -3
  212. data/sig/dodopayments/models/payment_retrieve_line_items_params.rbs +10 -1
  213. data/sig/dodopayments/models/payment_retrieve_line_items_response.rbs +8 -3
  214. data/sig/dodopayments/models/product_collection_list_params.rbs +7 -0
  215. data/sig/dodopayments/models/product_collection_retrieve_params.rbs +8 -1
  216. data/sig/dodopayments/models/product_collections/translation_delete_params.rbs +30 -0
  217. data/sig/dodopayments/models/product_collections/translation_list_params.rbs +32 -0
  218. data/sig/dodopayments/models/product_collections/translation_update_params.rbs +43 -0
  219. data/sig/dodopayments/models/product_list_params.rbs +7 -0
  220. data/sig/dodopayments/models/product_retrieve_params.rbs +8 -1
  221. data/sig/dodopayments/models/products/translation.rbs +37 -0
  222. data/sig/dodopayments/models/products/translation_delete_params.rbs +30 -0
  223. data/sig/dodopayments/models/products/translation_list_params.rbs +32 -0
  224. data/sig/dodopayments/models/products/translation_update_params.rbs +43 -0
  225. data/sig/dodopayments/models/products/translations_list_response.rbs +18 -0
  226. data/sig/dodopayments/models/refund_create_params.rbs +5 -0
  227. data/sig/dodopayments/models/subscription_list_params.rbs +7 -0
  228. data/sig/dodopayments/models/subscription_retrieve_params.rbs +7 -1
  229. data/sig/dodopayments/models/three_ds_flow.rbs +14 -0
  230. data/sig/dodopayments/models/three_ds_status.rbs +24 -0
  231. data/sig/dodopayments/models.rbs +20 -0
  232. data/sig/dodopayments/resources/addons/translations.rbs +29 -0
  233. data/sig/dodopayments/resources/addons.rbs +15 -0
  234. data/sig/dodopayments/resources/checkout_sessions.rbs +1 -0
  235. data/sig/dodopayments/resources/credit_entitlements/translations.rbs +29 -0
  236. data/sig/dodopayments/resources/credit_entitlements.rbs +4 -0
  237. data/sig/dodopayments/resources/customers.rbs +2 -0
  238. data/sig/dodopayments/resources/entitlements/translations.rbs +31 -0
  239. data/sig/dodopayments/resources/entitlements.rbs +4 -0
  240. data/sig/dodopayments/resources/meters/translations.rbs +29 -0
  241. data/sig/dodopayments/resources/meters.rbs +12 -0
  242. data/sig/dodopayments/resources/misc.rbs +4 -0
  243. data/sig/dodopayments/resources/payments.rbs +1 -0
  244. data/sig/dodopayments/resources/product_collections/translations.rbs +29 -0
  245. data/sig/dodopayments/resources/product_collections.rbs +4 -0
  246. data/sig/dodopayments/resources/products/translations.rbs +29 -0
  247. data/sig/dodopayments/resources/products.rbs +4 -0
  248. data/sig/dodopayments/resources/refunds.rbs +1 -0
  249. data/sig/dodopayments/resources/subscriptions.rbs +2 -0
  250. metadata +119 -2
@@ -339,13 +339,35 @@ module Dodopayments
339
339
  # @return [Integer, nil]
340
340
  optional :tax, Integer, nil?: true
341
341
 
342
+ # @!attribute three_ds_flow
343
+ # How the cardholder completed the 3DS authentication. The value is null when the
344
+ # processor does not report it.
345
+ #
346
+ # @return [Symbol, Dodopayments::Models::ThreeDSFlow, nil]
347
+ optional :three_ds_flow, enum: -> { Dodopayments::ThreeDSFlow }, nil?: true
348
+
349
+ # @!attribute three_ds_status
350
+ # The result of the 3DS authentication, as the processor reports it. The value is
351
+ # null when the processor reports no 3DS data, for example when the payment did
352
+ # not use 3DS.
353
+ #
354
+ # @return [Symbol, Dodopayments::Models::ThreeDSStatus, nil]
355
+ optional :three_ds_status, enum: -> { Dodopayments::ThreeDSStatus }, nil?: true
356
+
357
+ # @!attribute three_ds_version
358
+ # The 3DS protocol version, for example `2.2.0`. The value is null when the
359
+ # processor does not report it.
360
+ #
361
+ # @return [String, nil]
362
+ optional :three_ds_version, String, nil?: true
363
+
342
364
  # @!attribute updated_at
343
365
  # Timestamp when the payment was last updated
344
366
  #
345
367
  # @return [Time, nil]
346
368
  optional :updated_at, Time, nil?: true
347
369
 
348
- # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, includes_usage:, is_multi_subscription:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, service_periods:, settlement_amount:, settlement_currency:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
370
+ # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, includes_usage:, is_multi_subscription:, is_update_payment_method:, metadata:, payment_id:, payment_provider:, refunds:, retry_attempt:, service_periods:, settlement_amount:, settlement_currency:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_holder_name: nil, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, custom_field_responses: nil, discount_id: nil, discounts: nil, error_code: nil, error_message: nil, invoice_id: nil, invoice_url: nil, payment_link: nil, payment_method: nil, payment_method_id: nil, payment_method_type: nil, product_cart: nil, refund_status: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, three_ds_flow: nil, three_ds_status: nil, three_ds_version: nil, updated_at: nil)
349
371
  # Some parameter documentations has been truncated, see
350
372
  # {Dodopayments::Models::Payment} for more details.
351
373
  #
@@ -443,6 +465,12 @@ module Dodopayments
443
465
  #
444
466
  # @param tax [Integer, nil] Amount of tax collected in the currency's smallest unit
445
467
  #
468
+ # @param three_ds_flow [Symbol, Dodopayments::Models::ThreeDSFlow, nil] How the cardholder completed the 3DS authentication. The value is null when the
469
+ #
470
+ # @param three_ds_status [Symbol, Dodopayments::Models::ThreeDSStatus, nil] The result of the 3DS authentication, as the processor reports it. The value is
471
+ #
472
+ # @param three_ds_version [String, nil] The 3DS protocol version, for example `2.2.0`. The value is null when the proces
473
+ #
446
474
  # @param updated_at [Time, nil] Timestamp when the payment was last updated
447
475
 
448
476
  # Which processor handled this payment. `stripe` / `adyen` for BYOP routes (the
@@ -203,7 +203,29 @@ module Dodopayments
203
203
  # @return [String, nil]
204
204
  optional :subscription_id, String, nil?: true
205
205
 
206
- # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, includes_usage:, is_multi_subscription:, metadata:, payment_id:, payment_provider:, retry_attempt:, service_periods:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil)
206
+ # @!attribute three_ds_flow
207
+ # How the cardholder completed the 3DS authentication. The value is null when the
208
+ # processor does not report it.
209
+ #
210
+ # @return [Symbol, Dodopayments::Models::ThreeDSFlow, nil]
211
+ optional :three_ds_flow, enum: -> { Dodopayments::ThreeDSFlow }, nil?: true
212
+
213
+ # @!attribute three_ds_status
214
+ # The result of the 3DS authentication, as the processor reports it. The value is
215
+ # null when the processor reports no 3DS data, for example when the payment did
216
+ # not use 3DS.
217
+ #
218
+ # @return [Symbol, Dodopayments::Models::ThreeDSStatus, nil]
219
+ optional :three_ds_status, enum: -> { Dodopayments::ThreeDSStatus }, nil?: true
220
+
221
+ # @!attribute three_ds_version
222
+ # The 3DS protocol version, for example `2.2.0`. The value is null when the
223
+ # processor does not report it.
224
+ #
225
+ # @return [String, nil]
226
+ optional :three_ds_version, String, nil?: true
227
+
228
+ # @!method initialize(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, includes_usage:, is_multi_subscription:, metadata:, payment_id:, payment_provider:, retry_attempt:, service_periods:, subscription_ids:, total_amount:, card_exp_month: nil, card_exp_year: nil, card_last_four: nil, card_network: nil, card_type: nil, charge_type: nil, checkout_session_id: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil, three_ds_flow: nil, three_ds_status: nil, three_ds_version: nil)
207
229
  # Some parameter documentations has been truncated, see
208
230
  # {Dodopayments::Models::PaymentListResponse} for more details.
209
231
  #
@@ -266,6 +288,12 @@ module Dodopayments
266
288
  # @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
267
289
  #
268
290
  # @param subscription_id [String, nil]
291
+ #
292
+ # @param three_ds_flow [Symbol, Dodopayments::Models::ThreeDSFlow, nil] How the cardholder completed the 3DS authentication. The value is null when the
293
+ #
294
+ # @param three_ds_status [Symbol, Dodopayments::Models::ThreeDSStatus, nil] The result of the 3DS authentication, as the processor reports it. The value is
295
+ #
296
+ # @param three_ds_version [String, nil] The 3DS protocol version, for example `2.2.0`. The value is null when the proces
269
297
 
270
298
  # Which processor handled this payment. `stripe` / `adyen` for BYOP routes (the
271
299
  # merchant's own payment connector); `dodo` for everything Dodo processed itself.
@@ -12,8 +12,21 @@ module Dodopayments
12
12
  # @return [String]
13
13
  required :payment_id, String
14
14
 
15
- # @!method initialize(payment_id:, request_options: {})
15
+ # @!attribute currency
16
+ # The currency of the amounts. It must be the currency that the customer paid in.
17
+ # Without it, the amounts are in the settlement currency.
18
+ #
19
+ # @return [Symbol, Dodopayments::Models::Currency, nil]
20
+ optional :currency, enum: -> { Dodopayments::Currency }
21
+
22
+ # @!method initialize(payment_id:, currency: nil, request_options: {})
23
+ # Some parameter documentations has been truncated, see
24
+ # {Dodopayments::Models::PaymentRetrieveLineItemsParams} for more details.
25
+ #
16
26
  # @param payment_id [String]
27
+ #
28
+ # @param currency [Symbol, Dodopayments::Models::Currency] The currency of the amounts. It must be the currency that the customer paid in.
29
+ #
17
30
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
18
31
  end
19
32
  end
@@ -15,9 +15,18 @@ module Dodopayments
15
15
  required :items,
16
16
  -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item] }
17
17
 
18
- # @!method initialize(currency:, items:)
18
+ # @!attribute partial_refund_allowed
19
+ # False when the payment method does not allow a partial refund of this payment.
20
+ #
21
+ # @return [Boolean]
22
+ required :partial_refund_allowed, Dodopayments::Internal::Type::Boolean
23
+
24
+ # @!method initialize(currency:, items:, partial_refund_allowed:)
19
25
  # @param currency [Symbol, Dodopayments::Models::Currency]
26
+ #
20
27
  # @param items [Array<Dodopayments::Models::PaymentRetrieveLineItemsResponse::Item>]
28
+ #
29
+ # @param partial_refund_allowed [Boolean] False when the payment method does not allow a partial refund of this payment.
21
30
 
22
31
  class Item < Dodopayments::Internal::Type::BaseModel
23
32
  # @!attribute amount
@@ -42,7 +42,9 @@ module Dodopayments
42
42
  # Amount in the payout's currency, in that currency's smallest unit (cents for
43
43
  # USD, yen for JPY, fils for KWD). The entry is converted at the rate the payout
44
44
  # settled at. These amounts sum to the value of the entries, which can be less
45
- # than the payout: the grouped breakup reports the difference as `unattributed`.
45
+ # than the payout: the grouped breakup reports the difference as `unattributed`. A
46
+ # settlement batch payout shows the native amount of a row in the payout's
47
+ # currency, and 0 for a row in a different currency.
46
48
  #
47
49
  # @return [Integer]
48
50
  required :payout_currency_amount, Integer
@@ -7,7 +7,8 @@ module Dodopayments
7
7
  # @!attribute event_type
8
8
  # The type of balance ledger event (e.g., "payment", "refund", "dispute",
9
9
  # "payment_fees"), or `unattributed` for the payout amount the entries do not
10
- # account for.
10
+ # account for. A settlement batch payout shows `carried_over` for its opening
11
+ # balance and the entries dated before that row.
11
12
  #
12
13
  # @return [String]
13
14
  required :event_type, String
@@ -19,6 +19,17 @@ module Dodopayments
19
19
  # @return [String, nil]
20
20
  optional :brand_id, String
21
21
 
22
+ # @!attribute locale
23
+ # Shows the translated name, description and unit of the catalog entities in this
24
+ # locale. The value must be a code from `GET /locales`, for example `fr`. A field
25
+ # with no translation, an unknown code, or no code shows the base text.
26
+ #
27
+ # Do not send a text from a localized response back in a create or update request.
28
+ # The base text then changes to the translated text.
29
+ #
30
+ # @return [String, nil]
31
+ optional :locale, String
32
+
22
33
  # @!attribute page_number
23
34
  # Page number default is 0
24
35
  #
@@ -31,11 +42,16 @@ module Dodopayments
31
42
  # @return [Integer, nil]
32
43
  optional :page_size, Integer
33
44
 
34
- # @!method initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, request_options: {})
45
+ # @!method initialize(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, request_options: {})
46
+ # Some parameter documentations has been truncated, see
47
+ # {Dodopayments::Models::ProductCollectionListParams} for more details.
48
+ #
35
49
  # @param archived [Boolean] List archived collections
36
50
  #
37
51
  # @param brand_id [String] Filter by Brand id
38
52
  #
53
+ # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
54
+ #
39
55
  # @param page_number [Integer] Page number default is 0
40
56
  #
41
57
  # @param page_size [Integer] Page size default is 10 max is 100
@@ -12,8 +12,25 @@ module Dodopayments
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute locale
16
+ # Shows the translated name, description and unit of the catalog entities in this
17
+ # locale. The value must be a code from `GET /locales`, for example `fr`. A field
18
+ # with no translation, an unknown code, or no code shows the base text.
19
+ #
20
+ # Do not send a text from a localized response back in a create or update request.
21
+ # The base text then changes to the translated text.
22
+ #
23
+ # @return [String, nil]
24
+ optional :locale, String
25
+
26
+ # @!method initialize(id:, locale: nil, request_options: {})
27
+ # Some parameter documentations has been truncated, see
28
+ # {Dodopayments::Models::ProductCollectionRetrieveParams} for more details.
29
+ #
16
30
  # @param id [String]
31
+ #
32
+ # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
33
+ #
17
34
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
18
35
  end
19
36
  end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module ProductCollections
6
+ # @see Dodopayments::Resources::ProductCollections::Translations#delete
7
+ class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # A locale that the checkout and the customer portal can show.
18
+ #
19
+ # The codes are a copy of the checkout locales. `GET /locales` lists them.
20
+ #
21
+ # @return [Symbol, Dodopayments::Models::Locale]
22
+ required :locale, enum: -> { Dodopayments::Locale }
23
+
24
+ # @!method initialize(id:, locale:, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Dodopayments::Models::ProductCollections::TranslationDeleteParams} for more
27
+ # details.
28
+ #
29
+ # @param id [String]
30
+ #
31
+ # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
32
+ #
33
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module ProductCollections
6
+ # @see Dodopayments::Resources::ProductCollections::Translations#list
7
+ class TranslationListParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
18
+ # the response has all the locales.
19
+ #
20
+ # @return [Array<String>, nil]
21
+ optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
22
+
23
+ # @!method initialize(id:, locale: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Dodopayments::Models::ProductCollections::TranslationListParams} for more
26
+ # details.
27
+ #
28
+ # @param id [String]
29
+ #
30
+ # @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
31
+ #
32
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module ProductCollections
6
+ # @see Dodopayments::Resources::ProductCollections::Translations#update
7
+ class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # A locale that the checkout and the customer portal can show.
18
+ #
19
+ # The codes are a copy of the checkout locales. `GET /locales` lists them.
20
+ #
21
+ # @return [Symbol, Dodopayments::Models::Locale]
22
+ required :locale, enum: -> { Dodopayments::Locale }
23
+
24
+ # @!attribute description
25
+ # The translated description.
26
+ #
27
+ # @return [String, nil]
28
+ optional :description, String, nil?: true
29
+
30
+ # @!attribute name
31
+ # The translated name.
32
+ #
33
+ # @return [String, nil]
34
+ optional :name, String, nil?: true
35
+
36
+ # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
37
+ # Some parameter documentations has been truncated, see
38
+ # {Dodopayments::Models::ProductCollections::TranslationUpdateParams} for more
39
+ # details.
40
+ #
41
+ # @param id [String]
42
+ #
43
+ # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
44
+ #
45
+ # @param description [String, nil] The translated description.
46
+ #
47
+ # @param name [String, nil] The translated name.
48
+ #
49
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
50
+ end
51
+ end
52
+ end
53
+ end
@@ -19,6 +19,17 @@ module Dodopayments
19
19
  # @return [String, nil]
20
20
  optional :brand_id, String
21
21
 
22
+ # @!attribute locale
23
+ # Shows the translated name, description and unit of the catalog entities in this
24
+ # locale. The value must be a code from `GET /locales`, for example `fr`. A field
25
+ # with no translation, an unknown code, or no code shows the base text.
26
+ #
27
+ # Do not send a text from a localized response back in a create or update request.
28
+ # The base text then changes to the translated text.
29
+ #
30
+ # @return [String, nil]
31
+ optional :locale, String
32
+
22
33
  # @!attribute page_number
23
34
  # Page number default is 0
24
35
  #
@@ -41,7 +52,7 @@ module Dodopayments
41
52
  # @return [Boolean, nil]
42
53
  optional :recurring, Dodopayments::Internal::Type::Boolean
43
54
 
44
- # @!method initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
55
+ # @!method initialize(archived: nil, brand_id: nil, locale: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {})
45
56
  # Some parameter documentations has been truncated, see
46
57
  # {Dodopayments::Models::ProductListParams} for more details.
47
58
  #
@@ -49,6 +60,8 @@ module Dodopayments
49
60
  #
50
61
  # @param brand_id [String] filter by Brand id
51
62
  #
63
+ # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
64
+ #
52
65
  # @param page_number [Integer] Page number default is 0
53
66
  #
54
67
  # @param page_size [Integer] Page size default is 10 max is 100
@@ -12,8 +12,25 @@ module Dodopayments
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute locale
16
+ # Shows the translated name, description and unit of the catalog entities in this
17
+ # locale. The value must be a code from `GET /locales`, for example `fr`. A field
18
+ # with no translation, an unknown code, or no code shows the base text.
19
+ #
20
+ # Do not send a text from a localized response back in a create or update request.
21
+ # The base text then changes to the translated text.
22
+ #
23
+ # @return [String, nil]
24
+ optional :locale, String
25
+
26
+ # @!method initialize(id:, locale: nil, request_options: {})
27
+ # Some parameter documentations has been truncated, see
28
+ # {Dodopayments::Models::ProductRetrieveParams} for more details.
29
+ #
16
30
  # @param id [String]
31
+ #
32
+ # @param locale [String] Shows the translated name, description and unit of the catalog entities in this
33
+ #
17
34
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
18
35
  end
19
36
  end
@@ -0,0 +1,50 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module Products
6
+ # @see Dodopayments::Resources::Products::Translations#update
7
+ class Translation < Dodopayments::Internal::Type::BaseModel
8
+ # @!attribute locale
9
+ # The locale of the translation.
10
+ #
11
+ # @return [Symbol, Dodopayments::Models::Locale]
12
+ required :locale, enum: -> { Dodopayments::Locale }
13
+
14
+ # @!attribute updated_at
15
+ # The time of the last change.
16
+ #
17
+ # @return [Time]
18
+ required :updated_at, Time
19
+
20
+ # @!attribute description
21
+ # The translated description. `null` shows that the description has no
22
+ # translation.
23
+ #
24
+ # @return [String, nil]
25
+ optional :description, String, nil?: true
26
+
27
+ # @!attribute name
28
+ # The translated name. `null` shows that the name has no translation.
29
+ #
30
+ # @return [String, nil]
31
+ optional :name, String, nil?: true
32
+
33
+ # @!method initialize(locale:, updated_at:, description: nil, name: nil)
34
+ # Some parameter documentations has been truncated, see
35
+ # {Dodopayments::Models::Products::Translation} for more details.
36
+ #
37
+ # The translation of a product, an add-on, a product collection or a meter in one
38
+ # locale.
39
+ #
40
+ # @param locale [Symbol, Dodopayments::Models::Locale] The locale of the translation.
41
+ #
42
+ # @param updated_at [Time] The time of the last change.
43
+ #
44
+ # @param description [String, nil] The translated description. `null` shows that the description has no translation
45
+ #
46
+ # @param name [String, nil] The translated name. `null` shows that the name has no translation.
47
+ end
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module Products
6
+ # @see Dodopayments::Resources::Products::Translations#delete
7
+ class TranslationDeleteParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # A locale that the checkout and the customer portal can show.
18
+ #
19
+ # The codes are a copy of the checkout locales. `GET /locales` lists them.
20
+ #
21
+ # @return [Symbol, Dodopayments::Models::Locale]
22
+ required :locale, enum: -> { Dodopayments::Locale }
23
+
24
+ # @!method initialize(id:, locale:, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Dodopayments::Models::Products::TranslationDeleteParams} for more details.
27
+ #
28
+ # @param id [String]
29
+ #
30
+ # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
31
+ #
32
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module Products
6
+ # @see Dodopayments::Resources::Products::Translations#list
7
+ class TranslationListParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # Returns only these locales, for example `?locale=fr&locale=de`. With no value,
18
+ # the response has all the locales.
19
+ #
20
+ # @return [Array<String>, nil]
21
+ optional :locale, Dodopayments::Internal::Type::ArrayOf[String]
22
+
23
+ # @!method initialize(id:, locale: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Dodopayments::Models::Products::TranslationListParams} for more details.
26
+ #
27
+ # @param id [String]
28
+ #
29
+ # @param locale [Array<String>] Returns only these locales, for example `?locale=fr&locale=de`. With no value, t
30
+ #
31
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,52 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module Products
6
+ # @see Dodopayments::Resources::Products::Translations#update
7
+ class TranslationUpdateParams < Dodopayments::Internal::Type::BaseModel
8
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
9
+ include Dodopayments::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!attribute locale
17
+ # A locale that the checkout and the customer portal can show.
18
+ #
19
+ # The codes are a copy of the checkout locales. `GET /locales` lists them.
20
+ #
21
+ # @return [Symbol, Dodopayments::Models::Locale]
22
+ required :locale, enum: -> { Dodopayments::Locale }
23
+
24
+ # @!attribute description
25
+ # The translated description.
26
+ #
27
+ # @return [String, nil]
28
+ optional :description, String, nil?: true
29
+
30
+ # @!attribute name
31
+ # The translated name.
32
+ #
33
+ # @return [String, nil]
34
+ optional :name, String, nil?: true
35
+
36
+ # @!method initialize(id:, locale:, description: nil, name: nil, request_options: {})
37
+ # Some parameter documentations has been truncated, see
38
+ # {Dodopayments::Models::Products::TranslationUpdateParams} for more details.
39
+ #
40
+ # @param id [String]
41
+ #
42
+ # @param locale [Symbol, Dodopayments::Models::Locale] A locale that the checkout and the customer portal can show.
43
+ #
44
+ # @param description [String, nil] The translated description.
45
+ #
46
+ # @param name [String, nil] The translated name.
47
+ #
48
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
49
+ end
50
+ end
51
+ end
52
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ module Products
6
+ # @see Dodopayments::Resources::Products::Translations#list
7
+ class TranslationsListResponse < Dodopayments::Internal::Type::BaseModel
8
+ # @!attribute items
9
+ #
10
+ # @return [Array<Dodopayments::Models::Products::Translation>]
11
+ required :items, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Products::Translation] }
12
+
13
+ # @!method initialize(items:)
14
+ # The translations of a product, an add-on, a product collection or a meter.
15
+ #
16
+ # @param items [Array<Dodopayments::Models::Products::Translation>]
17
+ end
18
+ end
19
+ end
20
+ end
@@ -13,6 +13,13 @@ module Dodopayments
13
13
  # @return [String]
14
14
  required :payment_id, String
15
15
 
16
+ # @!attribute currency
17
+ # The currency of every `items[].amount`. It must be the currency the customer
18
+ # paid in. Without it, the amounts are in the settlement currency.
19
+ #
20
+ # @return [Symbol, Dodopayments::Models::Currency, nil]
21
+ optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
22
+
16
23
  # @!attribute items
17
24
  # Partially Refund an Individual Item
18
25
  #
@@ -33,9 +40,14 @@ module Dodopayments
33
40
  # @return [String, nil]
34
41
  optional :reason, String, nil?: true
35
42
 
36
- # @!method initialize(payment_id:, items: nil, metadata: nil, reason: nil, request_options: {})
43
+ # @!method initialize(payment_id:, currency: nil, items: nil, metadata: nil, reason: nil, request_options: {})
44
+ # Some parameter documentations has been truncated, see
45
+ # {Dodopayments::Models::RefundCreateParams} for more details.
46
+ #
37
47
  # @param payment_id [String] The unique identifier of the payment to be refunded.
38
48
  #
49
+ # @param currency [Symbol, Dodopayments::Models::Currency, nil] The currency of every `items[].amount`. It must be the currency the customer pai
50
+ #
39
51
  # @param items [Array<Dodopayments::Models::RefundCreateParams::Item>, nil] Partially Refund an Individual Item
40
52
  #
41
53
  # @param metadata [Hash{Symbol=>String, Float, Boolean}] Additional metadata associated with the refund.