dodopayments 1.20.0 → 1.47.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 (452) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +45 -0
  3. data/README.md +144 -60
  4. data/SECURITY.md +2 -2
  5. data/lib/dodopayments/client.rb +25 -12
  6. data/lib/dodopayments/errors.rb +23 -1
  7. data/lib/dodopayments/file_part.rb +2 -2
  8. data/lib/dodopayments/internal/cursor_page_pagination.rb +90 -0
  9. data/lib/dodopayments/internal/default_page_number_pagination.rb +2 -2
  10. data/lib/dodopayments/internal/transport/base_client.rb +90 -10
  11. data/lib/dodopayments/internal/transport/pooled_net_requester.rb +17 -1
  12. data/lib/dodopayments/internal/type/array_of.rb +16 -2
  13. data/lib/dodopayments/internal/type/base_model.rb +152 -59
  14. data/lib/dodopayments/internal/type/boolean.rb +15 -1
  15. data/lib/dodopayments/internal/type/converter.rb +86 -33
  16. data/lib/dodopayments/internal/type/enum.rb +30 -6
  17. data/lib/dodopayments/internal/type/file_input.rb +13 -1
  18. data/lib/dodopayments/internal/type/hash_of.rb +16 -2
  19. data/lib/dodopayments/internal/type/request_parameters.rb +6 -12
  20. data/lib/dodopayments/internal/type/union.rb +44 -31
  21. data/lib/dodopayments/internal/type/unknown.rb +15 -1
  22. data/lib/dodopayments/internal/util.rb +136 -12
  23. data/lib/dodopayments/internal.rb +9 -0
  24. data/lib/dodopayments/models/addon_create_params.rb +6 -10
  25. data/lib/dodopayments/models/addon_list_params.rb +4 -4
  26. data/lib/dodopayments/models/addon_response.rb +6 -10
  27. data/lib/dodopayments/models/addon_update_params.rb +6 -10
  28. data/lib/dodopayments/models/attach_addon.rb +21 -0
  29. data/lib/dodopayments/models/billing_address.rb +3 -3
  30. data/lib/dodopayments/models/brand.rb +107 -0
  31. data/lib/dodopayments/models/brand_create_params.rb +44 -0
  32. data/lib/dodopayments/models/{webhook_event_retrieve_params.rb → brand_list_params.rb} +2 -2
  33. data/lib/dodopayments/models/brand_list_response.rb +17 -0
  34. data/lib/dodopayments/models/brand_retrieve_params.rb +14 -0
  35. data/lib/dodopayments/models/brand_update_images_params.rb +14 -0
  36. data/lib/dodopayments/models/brand_update_images_response.rb +25 -0
  37. data/lib/dodopayments/models/brand_update_params.rb +43 -0
  38. data/lib/dodopayments/models/create_new_customer.rb +0 -1
  39. data/lib/dodopayments/models/customer_list_params.rb +13 -5
  40. data/lib/dodopayments/models/customer_request.rb +3 -3
  41. data/lib/dodopayments/models/customers/customer_portal_create_params.rb +2 -2
  42. data/lib/dodopayments/models/discount.rb +15 -4
  43. data/lib/dodopayments/models/discount_create_params.rb +17 -6
  44. data/lib/dodopayments/models/discount_list_params.rb +4 -4
  45. data/lib/dodopayments/models/discount_update_params.rb +16 -5
  46. data/lib/dodopayments/models/dispute.rb +15 -7
  47. data/lib/dodopayments/models/dispute_list_params.rb +44 -16
  48. data/lib/dodopayments/models/dispute_list_response.rb +77 -0
  49. data/lib/dodopayments/models/get_dispute.rb +101 -0
  50. data/lib/dodopayments/models/license_key.rb +3 -3
  51. data/lib/dodopayments/models/license_key_duration.rb +1 -1
  52. data/lib/dodopayments/models/license_key_list_params.rb +23 -11
  53. data/lib/dodopayments/models/license_key_update_params.rb +3 -3
  54. data/lib/dodopayments/models/misc_list_supported_countries_response.rb +1 -1
  55. data/lib/dodopayments/models/new_customer.rb +27 -0
  56. data/lib/dodopayments/models/one_time_product_cart_item.rb +0 -1
  57. data/lib/dodopayments/models/payment.rb +79 -18
  58. data/lib/dodopayments/models/payment_create_params.rb +22 -41
  59. data/lib/dodopayments/models/payment_create_response.rb +16 -6
  60. data/lib/dodopayments/models/payment_list_params.rb +44 -16
  61. data/lib/dodopayments/models/payment_list_response.rb +16 -4
  62. data/lib/dodopayments/models/payment_method_types.rb +31 -0
  63. data/lib/dodopayments/models/payment_retrieve_line_items_params.rb +14 -0
  64. data/lib/dodopayments/models/payment_retrieve_line_items_response.rb +63 -0
  65. data/lib/dodopayments/models/payout_list_params.rb +4 -4
  66. data/lib/dodopayments/models/payout_list_response.rb +7 -3
  67. data/lib/dodopayments/models/price.rb +57 -30
  68. data/lib/dodopayments/models/product.rb +85 -12
  69. data/lib/dodopayments/models/product_create_params.rb +61 -12
  70. data/lib/dodopayments/models/product_list_params.rb +15 -7
  71. data/lib/dodopayments/models/product_list_response.rb +19 -11
  72. data/lib/dodopayments/models/product_update_files_params.rb +20 -0
  73. data/lib/dodopayments/models/product_update_files_response.rb +22 -0
  74. data/lib/dodopayments/models/product_update_params.rb +70 -13
  75. data/lib/dodopayments/models/products/image_update_params.rb +2 -2
  76. data/lib/dodopayments/models/refund.rb +15 -5
  77. data/lib/dodopayments/models/refund_create_params.rb +38 -1
  78. data/lib/dodopayments/models/refund_list_params.rb +26 -13
  79. data/lib/dodopayments/models/subscription.rb +38 -18
  80. data/lib/dodopayments/models/subscription_change_plan_params.rb +19 -3
  81. data/lib/dodopayments/models/subscription_charge_params.rb +38 -2
  82. data/lib/dodopayments/models/subscription_create_params.rb +53 -66
  83. data/lib/dodopayments/models/subscription_create_response.rb +24 -8
  84. data/lib/dodopayments/models/subscription_list_params.rb +37 -14
  85. data/lib/dodopayments/models/subscription_list_response.rb +37 -16
  86. data/lib/dodopayments/models/subscription_status.rb +0 -1
  87. data/lib/dodopayments/models/subscription_update_params.rb +10 -6
  88. data/lib/dodopayments/models/webhook_create_params.rb +86 -0
  89. data/lib/dodopayments/models/webhook_create_response.rb +88 -0
  90. data/lib/dodopayments/models/webhook_delete_params.rb +14 -0
  91. data/lib/dodopayments/models/webhook_event_type.rb +35 -0
  92. data/lib/dodopayments/models/webhook_list_params.rb +30 -0
  93. data/lib/dodopayments/models/webhook_list_response.rb +88 -0
  94. data/lib/dodopayments/models/webhook_payload.rb +161 -0
  95. data/lib/dodopayments/models/webhook_retrieve_params.rb +14 -0
  96. data/lib/dodopayments/models/webhook_retrieve_response.rb +88 -0
  97. data/lib/dodopayments/models/webhook_update_params.rb +69 -0
  98. data/lib/dodopayments/models/webhook_update_response.rb +88 -0
  99. data/lib/dodopayments/models/webhooks/header_retrieve_params.rb +16 -0
  100. data/lib/dodopayments/models/webhooks/header_retrieve_response.rb +31 -0
  101. data/lib/dodopayments/models/webhooks/header_update_params.rb +24 -0
  102. data/lib/dodopayments/models/your_webhook_url_create_params.rb +32 -0
  103. data/lib/dodopayments/models.rb +241 -0
  104. data/lib/dodopayments/request_options.rb +4 -0
  105. data/lib/dodopayments/resources/addons.rb +13 -21
  106. data/lib/dodopayments/resources/brands.rb +119 -0
  107. data/lib/dodopayments/resources/customers/customer_portal.rb +3 -3
  108. data/lib/dodopayments/resources/customers.rb +12 -10
  109. data/lib/dodopayments/resources/discounts.rb +24 -19
  110. data/lib/dodopayments/resources/disputes.rb +12 -12
  111. data/lib/dodopayments/resources/invoices/payments.rb +3 -2
  112. data/lib/dodopayments/resources/license_key_instances.rb +5 -5
  113. data/lib/dodopayments/resources/license_keys.rb +13 -13
  114. data/lib/dodopayments/resources/licenses.rb +4 -4
  115. data/lib/dodopayments/resources/misc.rb +1 -1
  116. data/lib/dodopayments/resources/payments.rb +38 -19
  117. data/lib/dodopayments/resources/payouts.rb +3 -3
  118. data/lib/dodopayments/resources/products/images.rb +2 -2
  119. data/lib/dodopayments/resources/products.rb +58 -24
  120. data/lib/dodopayments/resources/refunds.rb +14 -12
  121. data/lib/dodopayments/resources/subscriptions.rb +44 -29
  122. data/lib/dodopayments/resources/webhook_events.rb +0 -52
  123. data/lib/dodopayments/resources/webhooks/headers.rb +59 -0
  124. data/lib/dodopayments/resources/webhooks.rb +157 -0
  125. data/lib/dodopayments/resources/your_webhook_url.rb +56 -0
  126. data/lib/dodopayments/version.rb +1 -1
  127. data/lib/dodopayments.rb +47 -8
  128. data/rbi/dodopayments/client.rbi +24 -10
  129. data/rbi/dodopayments/errors.rbi +51 -16
  130. data/rbi/dodopayments/file_part.rbi +9 -6
  131. data/rbi/dodopayments/internal/cursor_page_pagination.rbi +25 -0
  132. data/rbi/dodopayments/internal/default_page_number_pagination.rbi +2 -1
  133. data/rbi/dodopayments/internal/transport/base_client.rbi +165 -77
  134. data/rbi/dodopayments/internal/transport/pooled_net_requester.rbi +33 -13
  135. data/rbi/dodopayments/internal/type/array_of.rbi +40 -24
  136. data/rbi/dodopayments/internal/type/base_model.rbi +160 -70
  137. data/rbi/dodopayments/internal/type/base_page.rbi +13 -8
  138. data/rbi/dodopayments/internal/type/boolean.rbi +24 -14
  139. data/rbi/dodopayments/internal/type/converter.rbi +135 -33
  140. data/rbi/dodopayments/internal/type/enum.rbi +29 -13
  141. data/rbi/dodopayments/internal/type/file_input.rbi +13 -4
  142. data/rbi/dodopayments/internal/type/hash_of.rbi +40 -24
  143. data/rbi/dodopayments/internal/type/request_parameters.rbi +14 -4
  144. data/rbi/dodopayments/internal/type/union.rbi +71 -23
  145. data/rbi/dodopayments/internal/type/unknown.rbi +24 -6
  146. data/rbi/dodopayments/internal/util.rbi +274 -89
  147. data/rbi/dodopayments/internal.rbi +7 -0
  148. data/rbi/dodopayments/models/addon_cart_response_item.rbi +16 -4
  149. data/rbi/dodopayments/models/addon_create_params.rbi +33 -24
  150. data/rbi/dodopayments/models/addon_list_params.rbi +29 -17
  151. data/rbi/dodopayments/models/addon_response.rbi +33 -27
  152. data/rbi/dodopayments/models/addon_retrieve_params.rbi +18 -5
  153. data/rbi/dodopayments/models/addon_update_images_params.rbi +18 -5
  154. data/rbi/dodopayments/models/addon_update_images_response.rbi +13 -3
  155. data/rbi/dodopayments/models/addon_update_params.rbi +34 -25
  156. data/rbi/dodopayments/models/attach_addon.rbi +28 -0
  157. data/rbi/dodopayments/models/attach_existing_customer.rbi +13 -3
  158. data/rbi/dodopayments/models/billing_address.rbi +24 -12
  159. data/rbi/dodopayments/models/brand.rbi +132 -0
  160. data/rbi/dodopayments/models/brand_create_params.rbi +68 -0
  161. data/rbi/dodopayments/models/brand_list_params.rbi +29 -0
  162. data/rbi/dodopayments/models/brand_list_response.rbi +34 -0
  163. data/rbi/dodopayments/models/brand_retrieve_params.rbi +32 -0
  164. data/rbi/dodopayments/models/brand_update_images_params.rbi +32 -0
  165. data/rbi/dodopayments/models/brand_update_images_response.rbi +36 -0
  166. data/rbi/dodopayments/models/brand_update_params.rbi +64 -0
  167. data/rbi/dodopayments/models/country_code.rbi +255 -252
  168. data/rbi/dodopayments/models/create_new_customer.rbi +27 -11
  169. data/rbi/dodopayments/models/currency.rbi +149 -148
  170. data/rbi/dodopayments/models/customer.rbi +27 -15
  171. data/rbi/dodopayments/models/customer_create_params.rbi +22 -14
  172. data/rbi/dodopayments/models/customer_limited_details.rbi +21 -4
  173. data/rbi/dodopayments/models/customer_list_params.rbi +43 -17
  174. data/rbi/dodopayments/models/customer_portal_session.rbi +13 -3
  175. data/rbi/dodopayments/models/customer_request.rbi +10 -2
  176. data/rbi/dodopayments/models/customer_retrieve_params.rbi +18 -5
  177. data/rbi/dodopayments/models/customer_update_params.rbi +21 -13
  178. data/rbi/dodopayments/models/customers/customer_portal_create_params.rbi +26 -8
  179. data/rbi/dodopayments/models/discount.rbi +42 -22
  180. data/rbi/dodopayments/models/discount_create_params.rbi +43 -20
  181. data/rbi/dodopayments/models/discount_delete_params.rbi +18 -5
  182. data/rbi/dodopayments/models/discount_list_params.rbi +32 -17
  183. data/rbi/dodopayments/models/discount_retrieve_params.rbi +18 -5
  184. data/rbi/dodopayments/models/discount_type.rbi +7 -4
  185. data/rbi/dodopayments/models/discount_update_params.rbi +43 -20
  186. data/rbi/dodopayments/models/dispute.rbi +41 -23
  187. data/rbi/dodopayments/models/dispute_list_params.rbi +178 -33
  188. data/rbi/dodopayments/models/dispute_list_response.rbi +98 -0
  189. data/rbi/dodopayments/models/dispute_retrieve_params.rbi +18 -5
  190. data/rbi/dodopayments/models/dispute_stage.rbi +11 -6
  191. data/rbi/dodopayments/models/dispute_status.rbi +20 -10
  192. data/rbi/dodopayments/models/get_dispute.rbi +124 -0
  193. data/rbi/dodopayments/models/intent_status.rbi +32 -14
  194. data/rbi/dodopayments/models/invoices/payment_retrieve_params.rbi +18 -5
  195. data/rbi/dodopayments/models/license_activate_params.rbi +21 -6
  196. data/rbi/dodopayments/models/license_deactivate_params.rbi +21 -13
  197. data/rbi/dodopayments/models/license_key.rbi +31 -23
  198. data/rbi/dodopayments/models/license_key_duration.rbi +24 -5
  199. data/rbi/dodopayments/models/license_key_instance.rbi +19 -4
  200. data/rbi/dodopayments/models/license_key_instance_list_params.rbi +23 -14
  201. data/rbi/dodopayments/models/license_key_instance_retrieve_params.rbi +18 -5
  202. data/rbi/dodopayments/models/license_key_instance_update_params.rbi +19 -6
  203. data/rbi/dodopayments/models/license_key_list_params.rbi +91 -26
  204. data/rbi/dodopayments/models/license_key_retrieve_params.rbi +18 -5
  205. data/rbi/dodopayments/models/license_key_status.rbi +10 -6
  206. data/rbi/dodopayments/models/license_key_update_params.rbi +23 -14
  207. data/rbi/dodopayments/models/license_validate_params.rbi +25 -13
  208. data/rbi/dodopayments/models/license_validate_response.rbi +13 -3
  209. data/rbi/dodopayments/models/misc_list_supported_countries_params.rbi +18 -5
  210. data/rbi/dodopayments/models/misc_list_supported_countries_response.rbi +1 -1
  211. data/rbi/dodopayments/models/new_customer.rbi +39 -0
  212. data/rbi/dodopayments/models/one_time_product_cart_item.rbi +23 -4
  213. data/rbi/dodopayments/models/payment.rbi +149 -54
  214. data/rbi/dodopayments/models/payment_create_params.rbi +67 -87
  215. data/rbi/dodopayments/models/payment_create_response.rbi +45 -22
  216. data/rbi/dodopayments/models/payment_list_params.rbi +149 -32
  217. data/rbi/dodopayments/models/payment_list_response.rbi +47 -26
  218. data/rbi/dodopayments/models/payment_method_types.rbi +52 -0
  219. data/rbi/dodopayments/models/payment_retrieve_line_items_params.rbi +32 -0
  220. data/rbi/dodopayments/models/payment_retrieve_line_items_response.rbi +114 -0
  221. data/rbi/dodopayments/models/payment_retrieve_params.rbi +18 -5
  222. data/rbi/dodopayments/models/payout_list_params.rbi +29 -17
  223. data/rbi/dodopayments/models/payout_list_response.rbi +82 -35
  224. data/rbi/dodopayments/models/price.rbi +142 -55
  225. data/rbi/dodopayments/models/product.rbi +177 -38
  226. data/rbi/dodopayments/models/product_create_params.rbi +151 -36
  227. data/rbi/dodopayments/models/product_delete_params.rbi +18 -5
  228. data/rbi/dodopayments/models/product_list_params.rbi +50 -21
  229. data/rbi/dodopayments/models/product_list_response.rbi +57 -42
  230. data/rbi/dodopayments/models/product_retrieve_params.rbi +18 -5
  231. data/rbi/dodopayments/models/product_unarchive_params.rbi +18 -5
  232. data/rbi/dodopayments/models/product_update_files_params.rbi +38 -0
  233. data/rbi/dodopayments/models/product_update_files_response.rbi +29 -0
  234. data/rbi/dodopayments/models/product_update_params.rbi +160 -37
  235. data/rbi/dodopayments/models/products/image_update_params.rbi +20 -8
  236. data/rbi/dodopayments/models/products/image_update_response.rbi +18 -4
  237. data/rbi/dodopayments/models/refund.rbi +39 -21
  238. data/rbi/dodopayments/models/refund_create_params.rbi +87 -11
  239. data/rbi/dodopayments/models/refund_list_params.rbi +86 -29
  240. data/rbi/dodopayments/models/refund_retrieve_params.rbi +18 -5
  241. data/rbi/dodopayments/models/refund_status.rbi +10 -7
  242. data/rbi/dodopayments/models/subscription.rbi +83 -47
  243. data/rbi/dodopayments/models/subscription_change_plan_params.rbi +68 -21
  244. data/rbi/dodopayments/models/subscription_charge_params.rbi +65 -6
  245. data/rbi/dodopayments/models/subscription_charge_response.rbi +13 -3
  246. data/rbi/dodopayments/models/subscription_create_params.rbi +136 -128
  247. data/rbi/dodopayments/models/subscription_create_response.rbi +51 -22
  248. data/rbi/dodopayments/models/subscription_list_params.rbi +125 -29
  249. data/rbi/dodopayments/models/subscription_list_response.rbi +85 -44
  250. data/rbi/dodopayments/models/subscription_retrieve_params.rbi +18 -5
  251. data/rbi/dodopayments/models/subscription_status.rbi +16 -10
  252. data/rbi/dodopayments/models/subscription_update_params.rbi +63 -33
  253. data/rbi/dodopayments/models/tax_category.rbi +11 -7
  254. data/rbi/dodopayments/models/time_interval.rbi +10 -7
  255. data/rbi/dodopayments/models/webhook_create_params.rbi +115 -0
  256. data/rbi/dodopayments/models/webhook_create_response.rbi +112 -0
  257. data/rbi/dodopayments/models/webhook_delete_params.rbi +32 -0
  258. data/rbi/dodopayments/models/webhook_event_type.rbi +102 -0
  259. data/rbi/dodopayments/models/webhook_list_params.rbi +54 -0
  260. data/rbi/dodopayments/models/webhook_list_response.rbi +112 -0
  261. data/rbi/dodopayments/models/webhook_payload.rbi +440 -0
  262. data/rbi/dodopayments/models/webhook_retrieve_params.rbi +32 -0
  263. data/rbi/dodopayments/models/webhook_retrieve_response.rbi +112 -0
  264. data/rbi/dodopayments/models/webhook_update_params.rbi +94 -0
  265. data/rbi/dodopayments/models/webhook_update_response.rbi +112 -0
  266. data/rbi/dodopayments/models/webhooks/header_retrieve_params.rbi +34 -0
  267. data/rbi/dodopayments/models/webhooks/header_retrieve_response.rbi +50 -0
  268. data/rbi/dodopayments/models/webhooks/header_update_params.rbi +48 -0
  269. data/rbi/dodopayments/models/your_webhook_url_create_params.rbi +56 -0
  270. data/rbi/dodopayments/models.rbi +209 -0
  271. data/rbi/dodopayments/request_options.rbi +18 -7
  272. data/rbi/dodopayments/resources/addons.rbi +44 -27
  273. data/rbi/dodopayments/resources/brands.rbi +89 -0
  274. data/rbi/dodopayments/resources/customers/customer_portal.rbi +8 -6
  275. data/rbi/dodopayments/resources/customers.rbi +31 -17
  276. data/rbi/dodopayments/resources/discounts.rbi +54 -22
  277. data/rbi/dodopayments/resources/disputes.rbi +26 -14
  278. data/rbi/dodopayments/resources/invoices/payments.rbi +10 -3
  279. data/rbi/dodopayments/resources/invoices.rbi +2 -1
  280. data/rbi/dodopayments/resources/license_key_instances.rbi +25 -10
  281. data/rbi/dodopayments/resources/license_keys.rbi +29 -15
  282. data/rbi/dodopayments/resources/licenses.rbi +25 -12
  283. data/rbi/dodopayments/resources/misc.rbi +7 -4
  284. data/rbi/dodopayments/resources/payments.rbi +61 -27
  285. data/rbi/dodopayments/resources/payouts.rbi +12 -6
  286. data/rbi/dodopayments/resources/products/images.rbi +10 -4
  287. data/rbi/dodopayments/resources/products.rbi +118 -41
  288. data/rbi/dodopayments/resources/refunds.rbi +35 -15
  289. data/rbi/dodopayments/resources/subscriptions.rbi +98 -50
  290. data/rbi/dodopayments/resources/webhook_events.rbi +2 -34
  291. data/rbi/dodopayments/resources/webhooks/headers.rbi +40 -0
  292. data/rbi/dodopayments/resources/webhooks.rbi +127 -0
  293. data/rbi/dodopayments/resources/your_webhook_url.rbi +51 -0
  294. data/sig/dodopayments/client.rbs +8 -2
  295. data/sig/dodopayments/errors.rbs +9 -0
  296. data/sig/dodopayments/internal/cursor_page_pagination.rbs +15 -0
  297. data/sig/dodopayments/internal/transport/base_client.rbs +17 -2
  298. data/sig/dodopayments/internal/transport/pooled_net_requester.rbs +4 -0
  299. data/sig/dodopayments/internal/type/array_of.rbs +3 -0
  300. data/sig/dodopayments/internal/type/base_model.rbs +13 -5
  301. data/sig/dodopayments/internal/type/base_page.rbs +1 -1
  302. data/sig/dodopayments/internal/type/boolean.rbs +3 -0
  303. data/sig/dodopayments/internal/type/converter.rbs +26 -1
  304. data/sig/dodopayments/internal/type/enum.rbs +3 -0
  305. data/sig/dodopayments/internal/type/file_input.rbs +2 -0
  306. data/sig/dodopayments/internal/type/hash_of.rbs +3 -0
  307. data/sig/dodopayments/internal/type/request_parameters.rbs +5 -1
  308. data/sig/dodopayments/internal/type/union.rbs +5 -2
  309. data/sig/dodopayments/internal/type/unknown.rbs +3 -0
  310. data/sig/dodopayments/internal/util.rbs +27 -0
  311. data/sig/dodopayments/internal.rbs +4 -0
  312. data/sig/dodopayments/models/addon_cart_response_item.rbs +1 -1
  313. data/sig/dodopayments/models/addon_create_params.rbs +8 -1
  314. data/sig/dodopayments/models/addon_list_params.rbs +14 -6
  315. data/sig/dodopayments/models/addon_response.rbs +12 -1
  316. data/sig/dodopayments/models/addon_retrieve_params.rbs +1 -1
  317. data/sig/dodopayments/models/addon_update_images_params.rbs +1 -1
  318. data/sig/dodopayments/models/addon_update_images_response.rbs +1 -1
  319. data/sig/dodopayments/models/addon_update_params.rbs +9 -1
  320. data/sig/dodopayments/models/attach_addon.rbs +15 -0
  321. data/sig/dodopayments/models/attach_existing_customer.rbs +1 -1
  322. data/sig/dodopayments/models/billing_address.rbs +7 -1
  323. data/sig/dodopayments/models/brand.rbs +88 -0
  324. data/sig/dodopayments/models/brand_create_params.rbs +46 -0
  325. data/sig/dodopayments/models/{webhook_event_retrieve_params.rbs → brand_list_params.rbs} +3 -3
  326. data/sig/dodopayments/models/brand_list_response.rbs +13 -0
  327. data/sig/dodopayments/models/brand_retrieve_params.rbs +15 -0
  328. data/sig/dodopayments/models/brand_update_images_params.rbs +15 -0
  329. data/sig/dodopayments/models/brand_update_images_response.rbs +15 -0
  330. data/sig/dodopayments/models/brand_update_params.rbs +41 -0
  331. data/sig/dodopayments/models/create_new_customer.rbs +6 -1
  332. data/sig/dodopayments/models/customer.rbs +8 -1
  333. data/sig/dodopayments/models/customer_create_params.rbs +6 -1
  334. data/sig/dodopayments/models/customer_limited_details.rbs +1 -1
  335. data/sig/dodopayments/models/customer_list_params.rbs +20 -6
  336. data/sig/dodopayments/models/customer_portal_session.rbs +1 -1
  337. data/sig/dodopayments/models/customer_request.rbs +2 -3
  338. data/sig/dodopayments/models/customer_retrieve_params.rbs +1 -1
  339. data/sig/dodopayments/models/customer_update_params.rbs +5 -1
  340. data/sig/dodopayments/models/customers/customer_portal_create_params.rbs +9 -4
  341. data/sig/dodopayments/models/discount.rbs +18 -1
  342. data/sig/dodopayments/models/discount_create_params.rbs +15 -1
  343. data/sig/dodopayments/models/discount_delete_params.rbs +1 -1
  344. data/sig/dodopayments/models/discount_list_params.rbs +14 -6
  345. data/sig/dodopayments/models/discount_retrieve_params.rbs +1 -1
  346. data/sig/dodopayments/models/discount_update_params.rbs +15 -1
  347. data/sig/dodopayments/models/dispute.rbs +17 -3
  348. data/sig/dodopayments/models/dispute_list_params.rbs +84 -22
  349. data/sig/dodopayments/models/dispute_list_response.rbs +55 -0
  350. data/sig/dodopayments/models/dispute_retrieve_params.rbs +1 -1
  351. data/sig/dodopayments/models/get_dispute.rbs +70 -0
  352. data/sig/dodopayments/models/invoices/payment_retrieve_params.rbs +1 -1
  353. data/sig/dodopayments/models/license_activate_params.rbs +5 -1
  354. data/sig/dodopayments/models/license_deactivate_params.rbs +5 -1
  355. data/sig/dodopayments/models/license_key.rbs +14 -1
  356. data/sig/dodopayments/models/license_key_duration.rbs +4 -1
  357. data/sig/dodopayments/models/license_key_instance.rbs +7 -1
  358. data/sig/dodopayments/models/license_key_instance_list_params.rbs +6 -1
  359. data/sig/dodopayments/models/license_key_instance_retrieve_params.rbs +1 -1
  360. data/sig/dodopayments/models/license_key_instance_update_params.rbs +4 -1
  361. data/sig/dodopayments/models/license_key_list_params.rbs +47 -16
  362. data/sig/dodopayments/models/license_key_retrieve_params.rbs +1 -1
  363. data/sig/dodopayments/models/license_key_update_params.rbs +6 -1
  364. data/sig/dodopayments/models/license_validate_params.rbs +5 -1
  365. data/sig/dodopayments/models/license_validate_response.rbs +1 -1
  366. data/sig/dodopayments/models/misc_list_supported_countries_params.rbs +1 -1
  367. data/sig/dodopayments/models/new_customer.rbs +21 -0
  368. data/sig/dodopayments/models/one_time_product_cart_item.rbs +5 -1
  369. data/sig/dodopayments/models/payment.rbs +76 -17
  370. data/sig/dodopayments/models/payment_create_params.rbs +23 -55
  371. data/sig/dodopayments/models/payment_create_response.rbs +21 -7
  372. data/sig/dodopayments/models/payment_list_params.rbs +85 -22
  373. data/sig/dodopayments/models/payment_list_response.rbs +25 -4
  374. data/sig/dodopayments/models/payment_method_types.rbs +48 -0
  375. data/sig/dodopayments/models/payment_retrieve_line_items_params.rbs +15 -0
  376. data/sig/dodopayments/models/payment_retrieve_line_items_response.rbs +67 -0
  377. data/sig/dodopayments/models/payment_retrieve_params.rbs +1 -1
  378. data/sig/dodopayments/models/payout_list_params.rbs +14 -6
  379. data/sig/dodopayments/models/payout_list_response.rbs +17 -1
  380. data/sig/dodopayments/models/price.rbs +53 -13
  381. data/sig/dodopayments/models/product.rbs +80 -4
  382. data/sig/dodopayments/models/product_create_params.rbs +45 -4
  383. data/sig/dodopayments/models/product_delete_params.rbs +1 -1
  384. data/sig/dodopayments/models/product_list_params.rbs +29 -10
  385. data/sig/dodopayments/models/product_list_response.rbs +20 -1
  386. data/sig/dodopayments/models/product_retrieve_params.rbs +1 -1
  387. data/sig/dodopayments/models/product_unarchive_params.rbs +1 -1
  388. data/sig/dodopayments/models/product_update_files_params.rbs +23 -0
  389. data/sig/dodopayments/models/product_update_files_response.rbs +15 -0
  390. data/sig/dodopayments/models/product_update_params.rbs +58 -4
  391. data/sig/dodopayments/models/products/image_update_params.rbs +9 -4
  392. data/sig/dodopayments/models/products/image_update_response.rbs +1 -1
  393. data/sig/dodopayments/models/refund.rbs +15 -1
  394. data/sig/dodopayments/models/refund_create_params.rbs +38 -2
  395. data/sig/dodopayments/models/refund_list_params.rbs +54 -19
  396. data/sig/dodopayments/models/refund_retrieve_params.rbs +1 -1
  397. data/sig/dodopayments/models/subscription.rbs +43 -10
  398. data/sig/dodopayments/models/subscription_change_plan_params.rbs +16 -3
  399. data/sig/dodopayments/models/subscription_charge_params.rbs +27 -2
  400. data/sig/dodopayments/models/subscription_charge_response.rbs +1 -1
  401. data/sig/dodopayments/models/subscription_create_params.rbs +58 -73
  402. data/sig/dodopayments/models/subscription_create_response.rbs +26 -7
  403. data/sig/dodopayments/models/subscription_list_params.rbs +64 -19
  404. data/sig/dodopayments/models/subscription_list_response.rbs +39 -7
  405. data/sig/dodopayments/models/subscription_retrieve_params.rbs +1 -1
  406. data/sig/dodopayments/models/subscription_status.rbs +1 -2
  407. data/sig/dodopayments/models/subscription_update_params.rbs +20 -8
  408. data/sig/dodopayments/models/webhook_create_params.rbs +65 -0
  409. data/sig/dodopayments/models/webhook_create_response.rbs +60 -0
  410. data/sig/dodopayments/models/webhook_delete_params.rbs +15 -0
  411. data/sig/dodopayments/models/webhook_event_type.rbs +54 -0
  412. data/sig/dodopayments/models/webhook_list_params.rbs +28 -0
  413. data/sig/dodopayments/models/webhook_list_response.rbs +60 -0
  414. data/sig/dodopayments/models/webhook_payload.rbs +203 -0
  415. data/sig/dodopayments/models/webhook_retrieve_params.rbs +15 -0
  416. data/sig/dodopayments/models/webhook_retrieve_response.rbs +60 -0
  417. data/sig/dodopayments/models/webhook_update_params.rbs +51 -0
  418. data/sig/dodopayments/models/webhook_update_response.rbs +60 -0
  419. data/sig/dodopayments/models/webhooks/header_retrieve_params.rbs +17 -0
  420. data/sig/dodopayments/models/webhooks/header_retrieve_response.rbs +24 -0
  421. data/sig/dodopayments/models/webhooks/header_update_params.rbs +26 -0
  422. data/sig/dodopayments/models/your_webhook_url_create_params.rbs +42 -0
  423. data/sig/dodopayments/models.rbs +201 -0
  424. data/sig/dodopayments/request_options.rbs +1 -1
  425. data/sig/dodopayments/resources/addons.rbs +6 -6
  426. data/sig/dodopayments/resources/brands.rbs +39 -0
  427. data/sig/dodopayments/resources/customers/customer_portal.rbs +2 -2
  428. data/sig/dodopayments/resources/customers.rbs +7 -6
  429. data/sig/dodopayments/resources/discounts.rbs +8 -6
  430. data/sig/dodopayments/resources/disputes.rbs +9 -9
  431. data/sig/dodopayments/resources/invoices/payments.rbs +1 -1
  432. data/sig/dodopayments/resources/license_key_instances.rbs +3 -3
  433. data/sig/dodopayments/resources/license_keys.rbs +8 -8
  434. data/sig/dodopayments/resources/licenses.rbs +1 -1
  435. data/sig/dodopayments/resources/payments.rbs +17 -11
  436. data/sig/dodopayments/resources/payouts.rbs +2 -2
  437. data/sig/dodopayments/resources/products/images.rbs +1 -1
  438. data/sig/dodopayments/resources/products.rbs +20 -7
  439. data/sig/dodopayments/resources/refunds.rbs +10 -9
  440. data/sig/dodopayments/resources/subscriptions.rbs +21 -14
  441. data/sig/dodopayments/resources/webhook_events.rbs +0 -15
  442. data/sig/dodopayments/resources/webhooks/headers.rbs +20 -0
  443. data/sig/dodopayments/resources/webhooks.rbs +48 -0
  444. data/sig/dodopayments/resources/your_webhook_url.rbs +18 -0
  445. metadata +116 -11
  446. data/lib/dodopayments/models/webhook_event.rb +0 -58
  447. data/lib/dodopayments/models/webhook_event_list_params.rb +0 -66
  448. data/rbi/dodopayments/models/webhook_event.rbi +0 -71
  449. data/rbi/dodopayments/models/webhook_event_list_params.rbi +0 -77
  450. data/rbi/dodopayments/models/webhook_event_retrieve_params.rbi +0 -19
  451. data/sig/dodopayments/models/webhook_event.rbs +0 -46
  452. data/sig/dodopayments/models/webhook_event_list_params.rbs +0 -43
@@ -0,0 +1,101 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ # @see Dodopayments::Resources::Disputes#retrieve
6
+ class GetDispute < Dodopayments::Internal::Type::BaseModel
7
+ # @!attribute amount
8
+ # The amount involved in the dispute, represented as a string to accommodate
9
+ # precision.
10
+ #
11
+ # @return [String]
12
+ required :amount, String
13
+
14
+ # @!attribute business_id
15
+ # The unique identifier of the business involved in the dispute.
16
+ #
17
+ # @return [String]
18
+ required :business_id, String
19
+
20
+ # @!attribute created_at
21
+ # The timestamp of when the dispute was created, in UTC.
22
+ #
23
+ # @return [Time]
24
+ required :created_at, Time
25
+
26
+ # @!attribute currency
27
+ # The currency of the disputed amount, represented as an ISO 4217 currency code.
28
+ #
29
+ # @return [String]
30
+ required :currency, String
31
+
32
+ # @!attribute customer
33
+ # The customer who filed the dispute
34
+ #
35
+ # @return [Dodopayments::Models::CustomerLimitedDetails]
36
+ required :customer, -> { Dodopayments::CustomerLimitedDetails }
37
+
38
+ # @!attribute dispute_id
39
+ # The unique identifier of the dispute.
40
+ #
41
+ # @return [String]
42
+ required :dispute_id, String
43
+
44
+ # @!attribute dispute_stage
45
+ # The current stage of the dispute process.
46
+ #
47
+ # @return [Symbol, Dodopayments::Models::DisputeStage]
48
+ required :dispute_stage, enum: -> { Dodopayments::DisputeStage }
49
+
50
+ # @!attribute dispute_status
51
+ # The current status of the dispute.
52
+ #
53
+ # @return [Symbol, Dodopayments::Models::DisputeStatus]
54
+ required :dispute_status, enum: -> { Dodopayments::DisputeStatus }
55
+
56
+ # @!attribute payment_id
57
+ # The unique identifier of the payment associated with the dispute.
58
+ #
59
+ # @return [String]
60
+ required :payment_id, String
61
+
62
+ # @!attribute reason
63
+ # Reason for the dispute
64
+ #
65
+ # @return [String, nil]
66
+ optional :reason, String, nil?: true
67
+
68
+ # @!attribute remarks
69
+ # Remarks
70
+ #
71
+ # @return [String, nil]
72
+ optional :remarks, String, nil?: true
73
+
74
+ # @!method initialize(amount:, business_id:, created_at:, currency:, customer:, dispute_id:, dispute_stage:, dispute_status:, payment_id:, reason: nil, remarks: nil)
75
+ # Some parameter documentations has been truncated, see
76
+ # {Dodopayments::Models::GetDispute} for more details.
77
+ #
78
+ # @param amount [String] The amount involved in the dispute, represented as a string to accommodate preci
79
+ #
80
+ # @param business_id [String] The unique identifier of the business involved in the dispute.
81
+ #
82
+ # @param created_at [Time] The timestamp of when the dispute was created, in UTC.
83
+ #
84
+ # @param currency [String] The currency of the disputed amount, represented as an ISO 4217 currency code.
85
+ #
86
+ # @param customer [Dodopayments::Models::CustomerLimitedDetails] The customer who filed the dispute
87
+ #
88
+ # @param dispute_id [String] The unique identifier of the dispute.
89
+ #
90
+ # @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage] The current stage of the dispute process.
91
+ #
92
+ # @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus] The current status of the dispute.
93
+ #
94
+ # @param payment_id [String] The unique identifier of the payment associated with the dispute.
95
+ #
96
+ # @param reason [String, nil] Reason for the dispute
97
+ #
98
+ # @param remarks [String, nil] Remarks
99
+ end
100
+ end
101
+ end
@@ -53,9 +53,10 @@ module Dodopayments
53
53
  required :product_id, String
54
54
 
55
55
  # @!attribute status
56
+ # The current status of the license key (e.g., active, inactive, expired).
56
57
  #
57
58
  # @return [Symbol, Dodopayments::Models::LicenseKeyStatus]
58
- required :status, enum: -> { Dodopayments::Models::LicenseKeyStatus }
59
+ required :status, enum: -> { Dodopayments::LicenseKeyStatus }
59
60
 
60
61
  # @!attribute activations_limit
61
62
  # The maximum number of activations allowed for this license key.
@@ -96,14 +97,13 @@ module Dodopayments
96
97
  #
97
98
  # @param product_id [String] The unique identifier of the product associated with the license key.
98
99
  #
99
- # @param status [Symbol, Dodopayments::Models::LicenseKeyStatus]
100
+ # @param status [Symbol, Dodopayments::Models::LicenseKeyStatus] The current status of the license key (e.g., active, inactive, expired).
100
101
  #
101
102
  # @param activations_limit [Integer, nil] The maximum number of activations allowed for this license key.
102
103
  #
103
104
  # @param expires_at [Time, nil] The timestamp indicating when the license key expires, in UTC.
104
105
  #
105
106
  # @param subscription_id [String, nil] The unique identifier of the subscription associated with the license key, if an
106
- # ...
107
107
  end
108
108
  end
109
109
  end
@@ -11,7 +11,7 @@ module Dodopayments
11
11
  # @!attribute interval
12
12
  #
13
13
  # @return [Symbol, Dodopayments::Models::TimeInterval]
14
- required :interval, enum: -> { Dodopayments::Models::TimeInterval }
14
+ required :interval, enum: -> { Dodopayments::TimeInterval }
15
15
 
16
16
  # @!method initialize(count:, interval:)
17
17
  # @param count [Integer]
@@ -11,44 +11,56 @@ module Dodopayments
11
11
  # Filter by customer ID
12
12
  #
13
13
  # @return [String, nil]
14
- optional :customer_id, String, nil?: true
14
+ optional :customer_id, String
15
15
 
16
16
  # @!attribute page_number
17
17
  # Page number default is 0
18
18
  #
19
19
  # @return [Integer, nil]
20
- optional :page_number, Integer, nil?: true
20
+ optional :page_number, Integer
21
21
 
22
22
  # @!attribute page_size
23
23
  # Page size default is 10 max is 100
24
24
  #
25
25
  # @return [Integer, nil]
26
- optional :page_size, Integer, nil?: true
26
+ optional :page_size, Integer
27
27
 
28
28
  # @!attribute product_id
29
29
  # Filter by product ID
30
30
  #
31
31
  # @return [String, nil]
32
- optional :product_id, String, nil?: true
32
+ optional :product_id, String
33
33
 
34
34
  # @!attribute status
35
35
  # Filter by license key status
36
36
  #
37
- # @return [Symbol, Dodopayments::Models::LicenseKeyStatus, nil]
38
- optional :status, enum: -> { Dodopayments::Models::LicenseKeyStatus }, nil?: true
37
+ # @return [Symbol, Dodopayments::Models::LicenseKeyListParams::Status, nil]
38
+ optional :status, enum: -> { Dodopayments::LicenseKeyListParams::Status }
39
39
 
40
40
  # @!method initialize(customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
41
- # @param customer_id [String, nil] Filter by customer ID
41
+ # @param customer_id [String] Filter by customer ID
42
42
  #
43
- # @param page_number [Integer, nil] Page number default is 0
43
+ # @param page_number [Integer] Page number default is 0
44
44
  #
45
- # @param page_size [Integer, nil] Page size default is 10 max is 100
45
+ # @param page_size [Integer] Page size default is 10 max is 100
46
46
  #
47
- # @param product_id [String, nil] Filter by product ID
47
+ # @param product_id [String] Filter by product ID
48
48
  #
49
- # @param status [Symbol, Dodopayments::Models::LicenseKeyStatus, nil] Filter by license key status
49
+ # @param status [Symbol, Dodopayments::Models::LicenseKeyListParams::Status] Filter by license key status
50
50
  #
51
51
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
52
+
53
+ # Filter by license key status
54
+ module Status
55
+ extend Dodopayments::Internal::Type::Enum
56
+
57
+ ACTIVE = :active
58
+ EXPIRED = :expired
59
+ DISABLED = :disabled
60
+
61
+ # @!method self.values
62
+ # @return [Array<Symbol>]
63
+ end
52
64
  end
53
65
  end
54
66
  end
@@ -32,11 +32,11 @@ module Dodopayments
32
32
  # Some parameter documentations has been truncated, see
33
33
  # {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
34
34
  #
35
- # @param activations_limit [Integer, nil] The updated activation limit for the license key. ...
35
+ # @param activations_limit [Integer, nil] The updated activation limit for the license key.
36
36
  #
37
- # @param disabled [Boolean, nil] Indicates whether the license key should be disabled. ...
37
+ # @param disabled [Boolean, nil] Indicates whether the license key should be disabled.
38
38
  #
39
- # @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC. ...
39
+ # @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC.
40
40
  #
41
41
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
42
42
  end
@@ -4,6 +4,6 @@ module Dodopayments
4
4
  module Models
5
5
  # @type [Dodopayments::Internal::Type::Converter]
6
6
  MiscListSupportedCountriesResponse =
7
- Dodopayments::Internal::Type::ArrayOf[enum: -> { Dodopayments::Models::CountryCode }]
7
+ Dodopayments::Internal::Type::ArrayOf[enum: -> { Dodopayments::CountryCode }]
8
8
  end
9
9
  end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ class NewCustomer < Dodopayments::Internal::Type::BaseModel
6
+ # @!attribute email
7
+ #
8
+ # @return [String]
9
+ required :email, String
10
+
11
+ # @!attribute name
12
+ #
13
+ # @return [String]
14
+ required :name, String
15
+
16
+ # @!attribute phone_number
17
+ #
18
+ # @return [String, nil]
19
+ optional :phone_number, String, nil?: true
20
+
21
+ # @!method initialize(email:, name:, phone_number: nil)
22
+ # @param email [String]
23
+ # @param name [String]
24
+ # @param phone_number [String, nil]
25
+ end
26
+ end
27
+ end
@@ -30,7 +30,6 @@ module Dodopayments
30
30
  # @param quantity [Integer]
31
31
  #
32
32
  # @param amount [Integer, nil] Amount the customer pays if pay_what_you_want is enabled. If disabled then amoun
33
- # ...
34
33
  end
35
34
  end
36
35
  end
@@ -5,9 +5,16 @@ module Dodopayments
5
5
  # @see Dodopayments::Resources::Payments#retrieve
6
6
  class Payment < Dodopayments::Internal::Type::BaseModel
7
7
  # @!attribute billing
8
+ # Billing address details for payments
8
9
  #
9
10
  # @return [Dodopayments::Models::BillingAddress]
10
- required :billing, -> { Dodopayments::Models::BillingAddress }
11
+ required :billing, -> { Dodopayments::BillingAddress }
12
+
13
+ # @!attribute brand_id
14
+ # brand id this payment belongs to
15
+ #
16
+ # @return [String]
17
+ required :brand_id, String
11
18
 
12
19
  # @!attribute business_id
13
20
  # Identifier of the business associated with the payment
@@ -22,22 +29,31 @@ module Dodopayments
22
29
  required :created_at, Time
23
30
 
24
31
  # @!attribute currency
32
+ # Currency used for the payment
25
33
  #
26
34
  # @return [Symbol, Dodopayments::Models::Currency]
27
- required :currency, enum: -> { Dodopayments::Models::Currency }
35
+ required :currency, enum: -> { Dodopayments::Currency }
28
36
 
29
37
  # @!attribute customer
38
+ # Details about the customer who made the payment
30
39
  #
31
40
  # @return [Dodopayments::Models::CustomerLimitedDetails]
32
- required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
41
+ required :customer, -> { Dodopayments::CustomerLimitedDetails }
42
+
43
+ # @!attribute digital_products_delivered
44
+ # brand id this payment belongs to
45
+ #
46
+ # @return [Boolean]
47
+ required :digital_products_delivered, Dodopayments::Internal::Type::Boolean
33
48
 
34
49
  # @!attribute disputes
35
50
  # List of disputes associated with this payment
36
51
  #
37
52
  # @return [Array<Dodopayments::Models::Dispute>]
38
- required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::Dispute] }
53
+ required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Dispute] }
39
54
 
40
55
  # @!attribute metadata
56
+ # Additional custom data associated with the payment
41
57
  #
42
58
  # @return [Hash{Symbol=>String}]
43
59
  required :metadata, Dodopayments::Internal::Type::HashOf[String]
@@ -52,7 +68,7 @@ module Dodopayments
52
68
  # List of refunds issued for this payment
53
69
  #
54
70
  # @return [Array<Dodopayments::Models::Refund>]
55
- required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::Refund] }
71
+ required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Refund] }
56
72
 
57
73
  # @!attribute settlement_amount
58
74
  # The amount that will be credited to your Dodo balance after currency conversion
@@ -63,9 +79,12 @@ module Dodopayments
63
79
  required :settlement_amount, Integer
64
80
 
65
81
  # @!attribute settlement_currency
82
+ # The currency in which the settlement_amount will be credited to your Dodo
83
+ # balance. This may differ from the customer's payment currency in adaptive
84
+ # pricing scenarios.
66
85
  #
67
86
  # @return [Symbol, Dodopayments::Models::Currency]
68
- required :settlement_currency, enum: -> { Dodopayments::Models::Currency }
87
+ required :settlement_currency, enum: -> { Dodopayments::Currency }
69
88
 
70
89
  # @!attribute total_amount
71
90
  # Total amount charged to the customer including tax, in smallest currency unit
@@ -74,12 +93,42 @@ module Dodopayments
74
93
  # @return [Integer]
75
94
  required :total_amount, Integer
76
95
 
96
+ # @!attribute card_issuing_country
97
+ # ISO2 country code of the card
98
+ #
99
+ # @return [Symbol, Dodopayments::Models::CountryCode, nil]
100
+ optional :card_issuing_country, enum: -> { Dodopayments::CountryCode }, nil?: true
101
+
102
+ # @!attribute card_last_four
103
+ # The last four digits of the card
104
+ #
105
+ # @return [String, nil]
106
+ optional :card_last_four, String, nil?: true
107
+
108
+ # @!attribute card_network
109
+ # Card network like VISA, MASTERCARD etc.
110
+ #
111
+ # @return [String, nil]
112
+ optional :card_network, String, nil?: true
113
+
114
+ # @!attribute card_type
115
+ # The type of card DEBIT or CREDIT
116
+ #
117
+ # @return [String, nil]
118
+ optional :card_type, String, nil?: true
119
+
77
120
  # @!attribute discount_id
78
121
  # The discount id if discount is applied
79
122
  #
80
123
  # @return [String, nil]
81
124
  optional :discount_id, String, nil?: true
82
125
 
126
+ # @!attribute error_code
127
+ # An error code if the payment failed
128
+ #
129
+ # @return [String, nil]
130
+ optional :error_code, String, nil?: true
131
+
83
132
  # @!attribute error_message
84
133
  # An error message if the payment failed
85
134
  #
@@ -109,7 +158,7 @@ module Dodopayments
109
158
  #
110
159
  # @return [Array<Dodopayments::Models::Payment::ProductCart>, nil]
111
160
  optional :product_cart,
112
- -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::Payment::ProductCart] },
161
+ -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Payment::ProductCart] },
113
162
  nil?: true
114
163
 
115
164
  # @!attribute settlement_tax
@@ -121,9 +170,10 @@ module Dodopayments
121
170
  optional :settlement_tax, Integer, nil?: true
122
171
 
123
172
  # @!attribute status
173
+ # Current status of the payment intent
124
174
  #
125
175
  # @return [Symbol, Dodopayments::Models::IntentStatus, nil]
126
- optional :status, enum: -> { Dodopayments::Models::IntentStatus }, nil?: true
176
+ optional :status, enum: -> { Dodopayments::IntentStatus }, nil?: true
127
177
 
128
178
  # @!attribute subscription_id
129
179
  # Identifier of the subscription if payment is part of a subscription
@@ -143,38 +193,50 @@ module Dodopayments
143
193
  # @return [Time, nil]
144
194
  optional :updated_at, Time, nil?: true
145
195
 
146
- # @!method initialize(billing:, business_id:, created_at:, currency:, customer:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, discount_id: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
196
+ # @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, discount_id: nil, error_code: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
147
197
  # Some parameter documentations has been truncated, see
148
198
  # {Dodopayments::Models::Payment} for more details.
149
199
  #
150
- # @param billing [Dodopayments::Models::BillingAddress]
200
+ # @param billing [Dodopayments::Models::BillingAddress] Billing address details for payments
201
+ #
202
+ # @param brand_id [String] brand id this payment belongs to
151
203
  #
152
204
  # @param business_id [String] Identifier of the business associated with the payment
153
205
  #
154
206
  # @param created_at [Time] Timestamp when the payment was created
155
207
  #
156
- # @param currency [Symbol, Dodopayments::Models::Currency]
208
+ # @param currency [Symbol, Dodopayments::Models::Currency] Currency used for the payment
157
209
  #
158
- # @param customer [Dodopayments::Models::CustomerLimitedDetails]
210
+ # @param customer [Dodopayments::Models::CustomerLimitedDetails] Details about the customer who made the payment
211
+ #
212
+ # @param digital_products_delivered [Boolean] brand id this payment belongs to
159
213
  #
160
214
  # @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
161
215
  #
162
- # @param metadata [Hash{Symbol=>String}]
216
+ # @param metadata [Hash{Symbol=>String}] Additional custom data associated with the payment
163
217
  #
164
218
  # @param payment_id [String] Unique identifier for the payment
165
219
  #
166
220
  # @param refunds [Array<Dodopayments::Models::Refund>] List of refunds issued for this payment
167
221
  #
168
222
  # @param settlement_amount [Integer] The amount that will be credited to your Dodo balance after currency conversion
169
- # ...
170
223
  #
171
- # @param settlement_currency [Symbol, Dodopayments::Models::Currency]
224
+ # @param settlement_currency [Symbol, Dodopayments::Models::Currency] The currency in which the settlement_amount will be credited to your Dodo balanc
172
225
  #
173
226
  # @param total_amount [Integer] Total amount charged to the customer including tax, in smallest currency unit (e
174
- # ...
227
+ #
228
+ # @param card_issuing_country [Symbol, Dodopayments::Models::CountryCode, nil] ISO2 country code of the card
229
+ #
230
+ # @param card_last_four [String, nil] The last four digits of the card
231
+ #
232
+ # @param card_network [String, nil] Card network like VISA, MASTERCARD etc.
233
+ #
234
+ # @param card_type [String, nil] The type of card DEBIT or CREDIT
175
235
  #
176
236
  # @param discount_id [String, nil] The discount id if discount is applied
177
237
  #
238
+ # @param error_code [String, nil] An error code if the payment failed
239
+ #
178
240
  # @param error_message [String, nil] An error message if the payment failed
179
241
  #
180
242
  # @param payment_link [String, nil] Checkout URL
@@ -186,9 +248,8 @@ module Dodopayments
186
248
  # @param product_cart [Array<Dodopayments::Models::Payment::ProductCart>, nil] List of products purchased in a one-time payment
187
249
  #
188
250
  # @param settlement_tax [Integer, nil] This represents the portion of settlement_amount that corresponds to taxes colle
189
- # ...
190
251
  #
191
- # @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
252
+ # @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Current status of the payment intent
192
253
  #
193
254
  # @param subscription_id [String, nil] Identifier of the subscription if payment is part of a subscription
194
255
  #
@@ -8,21 +8,25 @@ module Dodopayments
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
10
  # @!attribute billing
11
+ # Billing address details for the payment
11
12
  #
12
13
  # @return [Dodopayments::Models::BillingAddress]
13
- required :billing, -> { Dodopayments::Models::BillingAddress }
14
+ required :billing, -> { Dodopayments::BillingAddress }
14
15
 
15
16
  # @!attribute customer
17
+ # Customer information for the payment
16
18
  #
17
- # @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
18
- required :customer, union: -> { Dodopayments::Models::CustomerRequest }
19
+ # @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer]
20
+ required :customer, union: -> { Dodopayments::CustomerRequest }
19
21
 
20
22
  # @!attribute product_cart
21
23
  # List of products in the cart. Must contain at least 1 and at most 100 items.
22
24
  #
23
25
  # @return [Array<Dodopayments::Models::OneTimeProductCartItem>]
24
26
  required :product_cart,
25
- -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::OneTimeProductCartItem] }
27
+ -> {
28
+ Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem]
29
+ }
26
30
 
27
31
  # @!attribute allowed_payment_method_types
28
32
  # List of payment methods allowed during checkout.
@@ -32,15 +36,17 @@ module Dodopayments
32
36
  # Availability still depends on other factors (e.g., customer location, merchant
33
37
  # settings).
34
38
  #
35
- # @return [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil]
39
+ # @return [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil]
36
40
  optional :allowed_payment_method_types,
37
- -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType] },
41
+ -> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::PaymentMethodTypes] },
38
42
  nil?: true
39
43
 
40
44
  # @!attribute billing_currency
45
+ # Fix the currency in which the end customer is billed. If Dodo Payments cannot
46
+ # support that currency for this transaction, it will not proceed
41
47
  #
42
48
  # @return [Symbol, Dodopayments::Models::Currency, nil]
43
- optional :billing_currency, enum: -> { Dodopayments::Models::Currency }, nil?: true
49
+ optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true
44
50
 
45
51
  # @!attribute discount_code
46
52
  # Discount Code to apply to the transaction
@@ -49,6 +55,8 @@ module Dodopayments
49
55
  optional :discount_code, String, nil?: true
50
56
 
51
57
  # @!attribute metadata
58
+ # Additional metadata associated with the payment. Defaults to empty if not
59
+ # provided.
52
60
  #
53
61
  # @return [Hash{Symbol=>String}, nil]
54
62
  optional :metadata, Dodopayments::Internal::Type::HashOf[String]
@@ -83,56 +91,29 @@ module Dodopayments
83
91
  # Some parameter documentations has been truncated, see
84
92
  # {Dodopayments::Models::PaymentCreateParams} for more details.
85
93
  #
86
- # @param billing [Dodopayments::Models::BillingAddress]
94
+ # @param billing [Dodopayments::Models::BillingAddress] Billing address details for the payment
87
95
  #
88
- # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
96
+ # @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer] Customer information for the payment
89
97
  #
90
98
  # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>] List of products in the cart. Must contain at least 1 and at most 100 items.
91
99
  #
92
- # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentCreateParams::AllowedPaymentMethodType>, nil] List of payment methods allowed during checkout. ...
100
+ # @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] List of payment methods allowed during checkout.
93
101
  #
94
- # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
102
+ # @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] Fix the currency in which the end customer is billed.
95
103
  #
96
104
  # @param discount_code [String, nil] Discount Code to apply to the transaction
97
105
  #
98
- # @param metadata [Hash{Symbol=>String}]
106
+ # @param metadata [Hash{Symbol=>String}] Additional metadata associated with the payment.
99
107
  #
100
108
  # @param payment_link [Boolean, nil] Whether to generate a payment link. Defaults to false if not specified.
101
109
  #
102
- # @param return_url [String, nil] Optional URL to redirect the customer after payment. ...
110
+ # @param return_url [String, nil] Optional URL to redirect the customer after payment.
103
111
  #
104
- # @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer ...
112
+ # @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer
105
113
  #
106
114
  # @param tax_id [String, nil] Tax ID in case the payment is B2B. If tax id validation fails the payment creati
107
- # ...
108
115
  #
109
116
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
110
-
111
- module AllowedPaymentMethodType
112
- extend Dodopayments::Internal::Type::Enum
113
-
114
- CREDIT = :credit
115
- DEBIT = :debit
116
- UPI_COLLECT = :upi_collect
117
- UPI_INTENT = :upi_intent
118
- APPLE_PAY = :apple_pay
119
- CASHAPP = :cashapp
120
- GOOGLE_PAY = :google_pay
121
- MULTIBANCO = :multibanco
122
- BANCONTACT_CARD = :bancontact_card
123
- EPS = :eps
124
- IDEAL = :ideal
125
- PRZELEWY24 = :przelewy24
126
- AFFIRM = :affirm
127
- KLARNA = :klarna
128
- SEPA = :sepa
129
- ACH = :ach
130
- AMAZON_PAY = :amazon_pay
131
- AFTERPAY_CLEARPAY = :afterpay_clearpay
132
-
133
- # @!method self.values
134
- # @return [Array<Symbol>]
135
- end
136
117
  end
137
118
  end
138
119
  end
@@ -12,11 +12,13 @@ module Dodopayments
12
12
  required :client_secret, String
13
13
 
14
14
  # @!attribute customer
15
+ # Limited details about the customer making the payment
15
16
  #
16
17
  # @return [Dodopayments::Models::CustomerLimitedDetails]
17
- required :customer, -> { Dodopayments::Models::CustomerLimitedDetails }
18
+ required :customer, -> { Dodopayments::CustomerLimitedDetails }
18
19
 
19
20
  # @!attribute metadata
21
+ # Additional metadata associated with the payment
20
22
  #
21
23
  # @return [Hash{Symbol=>String}]
22
24
  required :metadata, Dodopayments::Internal::Type::HashOf[String]
@@ -39,6 +41,12 @@ module Dodopayments
39
41
  # @return [String, nil]
40
42
  optional :discount_id, String, nil?: true
41
43
 
44
+ # @!attribute expires_on
45
+ # Expiry timestamp of the payment link
46
+ #
47
+ # @return [Time, nil]
48
+ optional :expires_on, Time, nil?: true
49
+
42
50
  # @!attribute payment_link
43
51
  # Optional URL to a hosted payment page
44
52
  #
@@ -50,18 +58,18 @@ module Dodopayments
50
58
  #
51
59
  # @return [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
52
60
  optional :product_cart,
53
- -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::OneTimeProductCartItem] },
61
+ -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem] },
54
62
  nil?: true
55
63
 
56
- # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, payment_link: nil, product_cart: nil)
64
+ # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, expires_on: nil, payment_link: nil, product_cart: nil)
57
65
  # Some parameter documentations has been truncated, see
58
66
  # {Dodopayments::Models::PaymentCreateResponse} for more details.
59
67
  #
60
- # @param client_secret [String] Client secret used to load Dodo checkout SDK ...
68
+ # @param client_secret [String] Client secret used to load Dodo checkout SDK
61
69
  #
62
- # @param customer [Dodopayments::Models::CustomerLimitedDetails]
70
+ # @param customer [Dodopayments::Models::CustomerLimitedDetails] Limited details about the customer making the payment
63
71
  #
64
- # @param metadata [Hash{Symbol=>String}]
72
+ # @param metadata [Hash{Symbol=>String}] Additional metadata associated with the payment
65
73
  #
66
74
  # @param payment_id [String] Unique identifier for the payment
67
75
  #
@@ -69,6 +77,8 @@ module Dodopayments
69
77
  #
70
78
  # @param discount_id [String, nil] The discount id if discount is applied
71
79
  #
80
+ # @param expires_on [Time, nil] Expiry timestamp of the payment link
81
+ #
72
82
  # @param payment_link [String, nil] Optional URL to a hosted payment page
73
83
  #
74
84
  # @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] Optional list of products included in the payment