dodopayments 2.1.0 → 2.1.2

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 (198) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/dodopayments/client.rb +1 -1
  5. data/lib/dodopayments/models/addon_retrieve_params.rb +7 -1
  6. data/lib/dodopayments/models/addon_update_images_params.rb +7 -1
  7. data/lib/dodopayments/models/addon_update_params.rb +8 -1
  8. data/lib/dodopayments/models/brand_retrieve_params.rb +7 -1
  9. data/lib/dodopayments/models/brand_update_images_params.rb +7 -1
  10. data/lib/dodopayments/models/brand_update_params.rb +8 -1
  11. data/lib/dodopayments/models/checkout_session_retrieve_params.rb +7 -1
  12. data/lib/dodopayments/models/credit_entitlement_delete_params.rb +7 -1
  13. data/lib/dodopayments/models/credit_entitlement_retrieve_params.rb +7 -1
  14. data/lib/dodopayments/models/credit_entitlement_undelete_params.rb +7 -1
  15. data/lib/dodopayments/models/credit_entitlement_update_params.rb +8 -1
  16. data/lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb +8 -1
  17. data/lib/dodopayments/models/credit_entitlements/balance_list_grants_params.rb +8 -1
  18. data/lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb +8 -1
  19. data/lib/dodopayments/models/credit_entitlements/balance_list_params.rb +8 -1
  20. data/lib/dodopayments/models/credit_entitlements/balance_retrieve_params.rb +7 -1
  21. data/lib/dodopayments/models/customer_list_credit_entitlements_params.rb +7 -1
  22. data/lib/dodopayments/models/customer_retrieve_params.rb +7 -1
  23. data/lib/dodopayments/models/customer_retrieve_payment_methods_params.rb +7 -1
  24. data/lib/dodopayments/models/customer_update_params.rb +8 -1
  25. data/lib/dodopayments/models/customers/customer_portal_create_params.rb +8 -1
  26. data/lib/dodopayments/models/customers/wallet_list_params.rb +7 -1
  27. data/lib/dodopayments/models/customers/wallets/ledger_entry_create_params.rb +8 -1
  28. data/lib/dodopayments/models/customers/wallets/ledger_entry_list_params.rb +8 -1
  29. data/lib/dodopayments/models/discount_delete_params.rb +7 -1
  30. data/lib/dodopayments/models/discount_retrieve_by_code_params.rb +7 -1
  31. data/lib/dodopayments/models/discount_retrieve_params.rb +7 -1
  32. data/lib/dodopayments/models/discount_update_params.rb +8 -1
  33. data/lib/dodopayments/models/dispute_retrieve_params.rb +7 -1
  34. data/lib/dodopayments/models/invoices/payment_retrieve_params.rb +7 -1
  35. data/lib/dodopayments/models/invoices/payment_retrieve_refund_params.rb +7 -1
  36. data/lib/dodopayments/models/license_key_instance_retrieve_params.rb +7 -1
  37. data/lib/dodopayments/models/license_key_instance_update_params.rb +7 -1
  38. data/lib/dodopayments/models/license_key_retrieve_params.rb +7 -1
  39. data/lib/dodopayments/models/license_key_update_params.rb +8 -1
  40. data/lib/dodopayments/models/meter_archive_params.rb +7 -1
  41. data/lib/dodopayments/models/meter_retrieve_params.rb +7 -1
  42. data/lib/dodopayments/models/meter_unarchive_params.rb +7 -1
  43. data/lib/dodopayments/models/payment_retrieve_line_items_params.rb +7 -1
  44. data/lib/dodopayments/models/payment_retrieve_params.rb +7 -1
  45. data/lib/dodopayments/models/product_archive_params.rb +7 -1
  46. data/lib/dodopayments/models/product_retrieve_params.rb +7 -1
  47. data/lib/dodopayments/models/product_unarchive_params.rb +7 -1
  48. data/lib/dodopayments/models/product_update_files_params.rb +7 -1
  49. data/lib/dodopayments/models/product_update_params.rb +8 -1
  50. data/lib/dodopayments/models/products/image_update_params.rb +7 -1
  51. data/lib/dodopayments/models/products/short_link_create_params.rb +8 -1
  52. data/lib/dodopayments/models/refund_retrieve_params.rb +7 -1
  53. data/lib/dodopayments/models/subscription_change_plan_params.rb +7 -1
  54. data/lib/dodopayments/models/subscription_charge_params.rb +8 -1
  55. data/lib/dodopayments/models/subscription_preview_change_plan_params.rb +7 -1
  56. data/lib/dodopayments/models/subscription_retrieve_credit_usage_params.rb +7 -1
  57. data/lib/dodopayments/models/subscription_retrieve_params.rb +7 -1
  58. data/lib/dodopayments/models/subscription_retrieve_usage_history_params.rb +8 -1
  59. data/lib/dodopayments/models/subscription_update_params.rb +8 -1
  60. data/lib/dodopayments/models/subscription_update_payment_method_params.rb +68 -20
  61. data/lib/dodopayments/models/usage_event_retrieve_params.rb +7 -1
  62. data/lib/dodopayments/models/webhook_delete_params.rb +7 -1
  63. data/lib/dodopayments/models/webhook_retrieve_params.rb +7 -1
  64. data/lib/dodopayments/models/webhook_retrieve_secret_params.rb +7 -1
  65. data/lib/dodopayments/models/webhook_update_params.rb +8 -1
  66. data/lib/dodopayments/models/webhooks/header_retrieve_params.rb +7 -1
  67. data/lib/dodopayments/models/webhooks/header_update_params.rb +8 -1
  68. data/lib/dodopayments/resources/subscriptions.rb +3 -7
  69. data/lib/dodopayments/version.rb +1 -1
  70. data/rbi/dodopayments/models/addon_retrieve_params.rbi +11 -5
  71. data/rbi/dodopayments/models/addon_update_images_params.rbi +11 -5
  72. data/rbi/dodopayments/models/addon_update_params.rbi +6 -0
  73. data/rbi/dodopayments/models/brand_retrieve_params.rbi +11 -5
  74. data/rbi/dodopayments/models/brand_update_images_params.rbi +11 -5
  75. data/rbi/dodopayments/models/brand_update_params.rbi +6 -0
  76. data/rbi/dodopayments/models/checkout_session_retrieve_params.rbi +11 -5
  77. data/rbi/dodopayments/models/credit_entitlement_delete_params.rbi +11 -5
  78. data/rbi/dodopayments/models/credit_entitlement_retrieve_params.rbi +11 -5
  79. data/rbi/dodopayments/models/credit_entitlement_undelete_params.rbi +11 -5
  80. data/rbi/dodopayments/models/credit_entitlement_update_params.rbi +6 -0
  81. data/rbi/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rbi +6 -0
  82. data/rbi/dodopayments/models/credit_entitlements/balance_list_grants_params.rbi +6 -0
  83. data/rbi/dodopayments/models/credit_entitlements/balance_list_ledger_params.rbi +6 -0
  84. data/rbi/dodopayments/models/credit_entitlements/balance_list_params.rbi +6 -0
  85. data/rbi/dodopayments/models/credit_entitlements/balance_retrieve_params.rbi +6 -1
  86. data/rbi/dodopayments/models/customer_list_credit_entitlements_params.rbi +11 -5
  87. data/rbi/dodopayments/models/customer_retrieve_params.rbi +11 -5
  88. data/rbi/dodopayments/models/customer_retrieve_payment_methods_params.rbi +11 -5
  89. data/rbi/dodopayments/models/customer_update_params.rbi +6 -0
  90. data/rbi/dodopayments/models/customers/customer_portal_create_params.rbi +6 -0
  91. data/rbi/dodopayments/models/customers/wallet_list_params.rbi +14 -5
  92. data/rbi/dodopayments/models/customers/wallets/ledger_entry_create_params.rbi +6 -0
  93. data/rbi/dodopayments/models/customers/wallets/ledger_entry_list_params.rbi +6 -0
  94. data/rbi/dodopayments/models/discount_delete_params.rbi +11 -5
  95. data/rbi/dodopayments/models/discount_retrieve_by_code_params.rbi +11 -5
  96. data/rbi/dodopayments/models/discount_retrieve_params.rbi +11 -5
  97. data/rbi/dodopayments/models/discount_update_params.rbi +6 -0
  98. data/rbi/dodopayments/models/dispute_retrieve_params.rbi +11 -5
  99. data/rbi/dodopayments/models/invoices/payment_retrieve_params.rbi +14 -5
  100. data/rbi/dodopayments/models/invoices/payment_retrieve_refund_params.rbi +11 -5
  101. data/rbi/dodopayments/models/license_key_instance_retrieve_params.rbi +11 -5
  102. data/rbi/dodopayments/models/license_key_instance_update_params.rbi +10 -2
  103. data/rbi/dodopayments/models/license_key_retrieve_params.rbi +11 -5
  104. data/rbi/dodopayments/models/license_key_update_params.rbi +6 -0
  105. data/rbi/dodopayments/models/meter_archive_params.rbi +11 -5
  106. data/rbi/dodopayments/models/meter_retrieve_params.rbi +11 -5
  107. data/rbi/dodopayments/models/meter_unarchive_params.rbi +11 -5
  108. data/rbi/dodopayments/models/payment_retrieve_line_items_params.rbi +11 -5
  109. data/rbi/dodopayments/models/payment_retrieve_params.rbi +11 -5
  110. data/rbi/dodopayments/models/product_archive_params.rbi +11 -5
  111. data/rbi/dodopayments/models/product_retrieve_params.rbi +11 -5
  112. data/rbi/dodopayments/models/product_unarchive_params.rbi +11 -5
  113. data/rbi/dodopayments/models/product_update_files_params.rbi +10 -2
  114. data/rbi/dodopayments/models/product_update_params.rbi +6 -0
  115. data/rbi/dodopayments/models/products/image_update_params.rbi +6 -1
  116. data/rbi/dodopayments/models/products/short_link_create_params.rbi +6 -0
  117. data/rbi/dodopayments/models/refund_retrieve_params.rbi +11 -5
  118. data/rbi/dodopayments/models/subscription_change_plan_params.rbi +14 -5
  119. data/rbi/dodopayments/models/subscription_charge_params.rbi +6 -0
  120. data/rbi/dodopayments/models/subscription_preview_change_plan_params.rbi +14 -5
  121. data/rbi/dodopayments/models/subscription_retrieve_credit_usage_params.rbi +14 -5
  122. data/rbi/dodopayments/models/subscription_retrieve_params.rbi +14 -5
  123. data/rbi/dodopayments/models/subscription_retrieve_usage_history_params.rbi +6 -0
  124. data/rbi/dodopayments/models/subscription_update_params.rbi +6 -0
  125. data/rbi/dodopayments/models/subscription_update_payment_method_params.rbi +170 -36
  126. data/rbi/dodopayments/models/usage_event_retrieve_params.rbi +11 -5
  127. data/rbi/dodopayments/models/webhook_delete_params.rbi +11 -5
  128. data/rbi/dodopayments/models/webhook_retrieve_params.rbi +11 -5
  129. data/rbi/dodopayments/models/webhook_retrieve_secret_params.rbi +11 -5
  130. data/rbi/dodopayments/models/webhook_update_params.rbi +6 -0
  131. data/rbi/dodopayments/models/webhooks/header_retrieve_params.rbi +14 -5
  132. data/rbi/dodopayments/models/webhooks/header_update_params.rbi +6 -0
  133. data/rbi/dodopayments/resources/subscriptions.rbi +6 -7
  134. data/sig/dodopayments/models/addon_retrieve_params.rbs +11 -3
  135. data/sig/dodopayments/models/addon_update_images_params.rbs +11 -3
  136. data/sig/dodopayments/models/addon_update_params.rbs +5 -0
  137. data/sig/dodopayments/models/brand_retrieve_params.rbs +11 -3
  138. data/sig/dodopayments/models/brand_update_images_params.rbs +11 -3
  139. data/sig/dodopayments/models/brand_update_params.rbs +5 -0
  140. data/sig/dodopayments/models/checkout_session_retrieve_params.rbs +11 -3
  141. data/sig/dodopayments/models/credit_entitlement_delete_params.rbs +11 -3
  142. data/sig/dodopayments/models/credit_entitlement_retrieve_params.rbs +11 -3
  143. data/sig/dodopayments/models/credit_entitlement_undelete_params.rbs +11 -3
  144. data/sig/dodopayments/models/credit_entitlement_update_params.rbs +5 -0
  145. data/sig/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rbs +5 -0
  146. data/sig/dodopayments/models/credit_entitlements/balance_list_grants_params.rbs +5 -0
  147. data/sig/dodopayments/models/credit_entitlements/balance_list_ledger_params.rbs +5 -0
  148. data/sig/dodopayments/models/credit_entitlements/balance_list_params.rbs +10 -1
  149. data/sig/dodopayments/models/credit_entitlements/balance_retrieve_params.rbs +5 -1
  150. data/sig/dodopayments/models/customer_list_credit_entitlements_params.rbs +11 -3
  151. data/sig/dodopayments/models/customer_retrieve_params.rbs +11 -3
  152. data/sig/dodopayments/models/customer_retrieve_payment_methods_params.rbs +11 -3
  153. data/sig/dodopayments/models/customer_update_params.rbs +5 -0
  154. data/sig/dodopayments/models/customers/customer_portal_create_params.rbs +6 -1
  155. data/sig/dodopayments/models/customers/wallet_list_params.rbs +12 -3
  156. data/sig/dodopayments/models/customers/wallets/ledger_entry_create_params.rbs +5 -0
  157. data/sig/dodopayments/models/customers/wallets/ledger_entry_list_params.rbs +5 -0
  158. data/sig/dodopayments/models/discount_delete_params.rbs +11 -3
  159. data/sig/dodopayments/models/discount_retrieve_by_code_params.rbs +11 -3
  160. data/sig/dodopayments/models/discount_retrieve_params.rbs +11 -3
  161. data/sig/dodopayments/models/discount_update_params.rbs +5 -0
  162. data/sig/dodopayments/models/dispute_retrieve_params.rbs +11 -3
  163. data/sig/dodopayments/models/invoices/payment_retrieve_params.rbs +12 -3
  164. data/sig/dodopayments/models/invoices/payment_retrieve_refund_params.rbs +11 -3
  165. data/sig/dodopayments/models/license_key_instance_retrieve_params.rbs +11 -3
  166. data/sig/dodopayments/models/license_key_instance_update_params.rbs +6 -1
  167. data/sig/dodopayments/models/license_key_retrieve_params.rbs +11 -3
  168. data/sig/dodopayments/models/license_key_update_params.rbs +10 -1
  169. data/sig/dodopayments/models/meter_archive_params.rbs +11 -3
  170. data/sig/dodopayments/models/meter_retrieve_params.rbs +11 -3
  171. data/sig/dodopayments/models/meter_unarchive_params.rbs +11 -3
  172. data/sig/dodopayments/models/payment_retrieve_line_items_params.rbs +11 -3
  173. data/sig/dodopayments/models/payment_retrieve_params.rbs +11 -3
  174. data/sig/dodopayments/models/product_archive_params.rbs +11 -3
  175. data/sig/dodopayments/models/product_retrieve_params.rbs +11 -3
  176. data/sig/dodopayments/models/product_unarchive_params.rbs +11 -3
  177. data/sig/dodopayments/models/product_update_files_params.rbs +6 -1
  178. data/sig/dodopayments/models/product_update_params.rbs +5 -0
  179. data/sig/dodopayments/models/products/image_update_params.rbs +5 -1
  180. data/sig/dodopayments/models/products/short_link_create_params.rbs +9 -1
  181. data/sig/dodopayments/models/refund_retrieve_params.rbs +11 -3
  182. data/sig/dodopayments/models/subscription_change_plan_params.rbs +14 -3
  183. data/sig/dodopayments/models/subscription_charge_params.rbs +5 -0
  184. data/sig/dodopayments/models/subscription_preview_change_plan_params.rbs +14 -3
  185. data/sig/dodopayments/models/subscription_retrieve_credit_usage_params.rbs +12 -3
  186. data/sig/dodopayments/models/subscription_retrieve_params.rbs +12 -3
  187. data/sig/dodopayments/models/subscription_retrieve_usage_history_params.rbs +5 -0
  188. data/sig/dodopayments/models/subscription_update_params.rbs +5 -0
  189. data/sig/dodopayments/models/subscription_update_payment_method_params.rbs +77 -18
  190. data/sig/dodopayments/models/usage_event_retrieve_params.rbs +11 -3
  191. data/sig/dodopayments/models/webhook_delete_params.rbs +11 -3
  192. data/sig/dodopayments/models/webhook_retrieve_params.rbs +11 -3
  193. data/sig/dodopayments/models/webhook_retrieve_secret_params.rbs +11 -3
  194. data/sig/dodopayments/models/webhook_update_params.rbs +5 -0
  195. data/sig/dodopayments/models/webhooks/header_retrieve_params.rbs +12 -3
  196. data/sig/dodopayments/models/webhooks/header_update_params.rbs +5 -1
  197. data/sig/dodopayments/resources/subscriptions.rbs +1 -3
  198. metadata +2 -2
@@ -8,7 +8,13 @@ module Dodopayments
8
8
  extend Dodopayments::Internal::Type::RequestParameters::Converter
9
9
  include Dodopayments::Internal::Type::RequestParameters
10
10
 
11
- # @!method initialize(request_options: {})
11
+ # @!attribute refund_id
12
+ #
13
+ # @return [String]
14
+ required :refund_id, String
15
+
16
+ # @!method initialize(refund_id:, request_options: {})
17
+ # @param refund_id [String]
12
18
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
13
19
  end
14
20
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,12 +7,18 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute name
11
16
  #
12
17
  # @return [String]
13
18
  required :name, String
14
19
 
15
- # @!method initialize(name:, request_options: {})
20
+ # @!method initialize(id:, name:, request_options: {})
21
+ # @param id [String]
16
22
  # @param name [String]
17
23
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute activations_limit
11
16
  # The updated activation limit for the license key. Use `null` to remove the
12
17
  # limit, or omit this field to leave it unchanged.
@@ -28,10 +33,12 @@ module Dodopayments
28
33
  # @return [Time, nil]
29
34
  optional :expires_at, Time, nil?: true
30
35
 
31
- # @!method initialize(activations_limit: nil, disabled: nil, expires_at: nil, request_options: {})
36
+ # @!method initialize(id:, activations_limit: nil, disabled: nil, expires_at: nil, request_options: {})
32
37
  # Some parameter documentations has been truncated, see
33
38
  # {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
34
39
  #
40
+ # @param id [String]
41
+ #
35
42
  # @param activations_limit [Integer, nil] The updated activation limit for the license key.
36
43
  #
37
44
  # @param disabled [Boolean, nil] Indicates whether the license key should be disabled.
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute payment_id
11
+ #
12
+ # @return [String]
13
+ required :payment_id, String
14
+
15
+ # @!method initialize(payment_id:, request_options: {})
16
+ # @param payment_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute payment_id
11
+ #
12
+ # @return [String]
13
+ required :payment_id, String
14
+
15
+ # @!method initialize(payment_id:, request_options: {})
16
+ # @param payment_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,12 +7,18 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute file_name
11
16
  #
12
17
  # @return [String]
13
18
  required :file_name, String
14
19
 
15
- # @!method initialize(file_name:, request_options: {})
20
+ # @!method initialize(id:, file_name:, request_options: {})
21
+ # @param id [String]
16
22
  # @param file_name [String]
17
23
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
@@ -7,6 +7,11 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
10
15
  # @!attribute addons
11
16
  # Available Addons for subscription products
12
17
  #
@@ -107,10 +112,12 @@ module Dodopayments
107
112
  # @return [Symbol, Dodopayments::Models::TaxCategory, nil]
108
113
  optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
109
114
 
110
- # @!method initialize(addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
115
+ # @!method initialize(id:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
111
116
  # Some parameter documentations has been truncated, see
112
117
  # {Dodopayments::Models::ProductUpdateParams} for more details.
113
118
  #
119
+ # @param id [String]
120
+ #
114
121
  # @param addons [Array<String>, nil] Available Addons for subscription products
115
122
  #
116
123
  # @param brand_id [String, nil]
@@ -8,12 +8,18 @@ module Dodopayments
8
8
  extend Dodopayments::Internal::Type::RequestParameters::Converter
9
9
  include Dodopayments::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
11
16
  # @!attribute force_update
12
17
  #
13
18
  # @return [Boolean, nil]
14
19
  optional :force_update, Dodopayments::Internal::Type::Boolean
15
20
 
16
- # @!method initialize(force_update: nil, request_options: {})
21
+ # @!method initialize(id:, force_update: nil, request_options: {})
22
+ # @param id [String]
17
23
  # @param force_update [Boolean]
18
24
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
19
25
  end
@@ -8,6 +8,11 @@ module Dodopayments
8
8
  extend Dodopayments::Internal::Type::RequestParameters::Converter
9
9
  include Dodopayments::Internal::Type::RequestParameters
10
10
 
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
11
16
  # @!attribute slug
12
17
  # Slug for the short link.
13
18
  #
@@ -20,10 +25,12 @@ module Dodopayments
20
25
  # @return [Hash{Symbol=>String}, nil]
21
26
  optional :static_checkout_params, Dodopayments::Internal::Type::HashOf[String], nil?: true
22
27
 
23
- # @!method initialize(slug:, static_checkout_params: nil, request_options: {})
28
+ # @!method initialize(id:, slug:, static_checkout_params: nil, request_options: {})
24
29
  # Some parameter documentations has been truncated, see
25
30
  # {Dodopayments::Models::Products::ShortLinkCreateParams} for more details.
26
31
  #
32
+ # @param id [String]
33
+ #
27
34
  # @param slug [String] Slug for the short link.
28
35
  #
29
36
  # @param static_checkout_params [Hash{Symbol=>String}, nil] Static Checkout URL parameters to apply to the resulting
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute refund_id
11
+ #
12
+ # @return [String]
13
+ required :refund_id, String
14
+
15
+ # @!method initialize(refund_id:, request_options: {})
16
+ # @param refund_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
15
+ # @!method initialize(subscription_id:, request_options: {})
16
+ # @param subscription_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
10
15
  # @!attribute product_price
11
16
  # The product price. Represented in the lowest denomination of the currency (e.g.,
12
17
  # cents for USD). For example, to charge $1.00, pass `100`.
@@ -51,10 +56,12 @@ module Dodopayments
51
56
  # @return [String, nil]
52
57
  optional :product_description, String, nil?: true
53
58
 
54
- # @!method initialize(product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
59
+ # @!method initialize(subscription_id:, product_price:, adaptive_currency_fees_inclusive: nil, customer_balance_config: nil, metadata: nil, product_currency: nil, product_description: nil, request_options: {})
55
60
  # Some parameter documentations has been truncated, see
56
61
  # {Dodopayments::Models::SubscriptionChargeParams} for more details.
57
62
  #
63
+ # @param subscription_id [String]
64
+ #
58
65
  # @param product_price [Integer] The product price. Represented in the lowest denomination of the currency (e.g.,
59
66
  #
60
67
  # @param adaptive_currency_fees_inclusive [Boolean, nil] Whether adaptive currency fees should be included in the product_price (true) or
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
15
+ # @!method initialize(subscription_id:, request_options: {})
16
+ # @param subscription_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
15
+ # @!method initialize(subscription_id:, request_options: {})
16
+ # @param subscription_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
15
+ # @!method initialize(subscription_id:, request_options: {})
16
+ # @param subscription_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,6 +7,11 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
10
15
  # @!attribute end_date
11
16
  # Filter by end date (inclusive)
12
17
  #
@@ -37,7 +42,9 @@ module Dodopayments
37
42
  # @return [Time, nil]
38
43
  optional :start_date, Time, nil?: true
39
44
 
40
- # @!method initialize(end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {})
45
+ # @!method initialize(subscription_id:, end_date: nil, meter_id: nil, page_number: nil, page_size: nil, start_date: nil, request_options: {})
46
+ # @param subscription_id [String]
47
+ #
41
48
  # @param end_date [Time, nil] Filter by end date (inclusive)
42
49
  #
43
50
  # @param meter_id [String, nil] Filter by specific meter ID
@@ -7,6 +7,11 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute subscription_id
11
+ #
12
+ # @return [String]
13
+ required :subscription_id, String
14
+
10
15
  # @!attribute billing
11
16
  #
12
17
  # @return [Dodopayments::Models::BillingAddress, nil]
@@ -58,7 +63,9 @@ module Dodopayments
58
63
  # @return [String, nil]
59
64
  optional :tax_id, String, nil?: true
60
65
 
61
- # @!method initialize(billing: nil, cancel_at_next_billing_date: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
66
+ # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, credit_entitlement_cart: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, tax_id: nil, request_options: {})
67
+ # @param subscription_id [String]
68
+ #
62
69
  # @param billing [Dodopayments::Models::BillingAddress, nil]
63
70
  #
64
71
  # @param cancel_at_next_billing_date [Boolean, nil] When set, the subscription will remain active until the end of billing period
@@ -7,34 +7,82 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute type
10
+ # @!attribute subscription_id
11
11
  #
12
- # @return [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Type]
13
- required :type, enum: -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Type }
12
+ # @return [String]
13
+ required :subscription_id, String
14
14
 
15
- # @!attribute return_url
15
+ # @!attribute body
16
16
  #
17
- # @return [String, nil]
18
- optional :return_url, String, nil?: true
17
+ # @return [Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing]
18
+ required :body, union: -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Body }
19
19
 
20
- # @!attribute payment_method_id
21
- #
22
- # @return [String]
23
- required :payment_method_id, String
24
-
25
- # @!method initialize(type:, payment_method_id:, return_url: nil, request_options: {})
26
- # @param type [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Type]
27
- # @param payment_method_id [String]
28
- # @param return_url [String, nil]
20
+ # @!method initialize(subscription_id:, body:, request_options: {})
21
+ # @param subscription_id [String]
22
+ # @param body [Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing]
29
23
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
30
24
 
31
- module Type
32
- extend Dodopayments::Internal::Type::Enum
25
+ module Body
26
+ extend Dodopayments::Internal::Type::Union
27
+
28
+ variant -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::New }
29
+
30
+ variant -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::Existing }
31
+
32
+ class New < Dodopayments::Internal::Type::BaseModel
33
+ # @!attribute type
34
+ #
35
+ # @return [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New::Type]
36
+ required :type, enum: -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::New::Type }
37
+
38
+ # @!attribute return_url
39
+ #
40
+ # @return [String, nil]
41
+ optional :return_url, String, nil?: true
42
+
43
+ # @!method initialize(type:, return_url: nil)
44
+ # @param type [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New::Type]
45
+ # @param return_url [String, nil]
46
+
47
+ # @see Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New#type
48
+ module Type
49
+ extend Dodopayments::Internal::Type::Enum
50
+
51
+ NEW = :new
52
+
53
+ # @!method self.values
54
+ # @return [Array<Symbol>]
55
+ end
56
+ end
57
+
58
+ class Existing < Dodopayments::Internal::Type::BaseModel
59
+ # @!attribute payment_method_id
60
+ #
61
+ # @return [String]
62
+ required :payment_method_id, String
63
+
64
+ # @!attribute type
65
+ #
66
+ # @return [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing::Type]
67
+ required :type, enum: -> { Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::Existing::Type }
68
+
69
+ # @!method initialize(payment_method_id:, type:)
70
+ # @param payment_method_id [String]
71
+ # @param type [Symbol, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing::Type]
72
+
73
+ # @see Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing#type
74
+ module Type
75
+ extend Dodopayments::Internal::Type::Enum
76
+
77
+ EXISTING = :existing
33
78
 
34
- EXISTING = :existing
79
+ # @!method self.values
80
+ # @return [Array<Symbol>]
81
+ end
82
+ end
35
83
 
36
- # @!method self.values
37
- # @return [Array<Symbol>]
84
+ # @!method self.variants
85
+ # @return [Array(Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::New, Dodopayments::Models::SubscriptionUpdatePaymentMethodParams::Body::Existing)]
38
86
  end
39
87
  end
40
88
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute event_id
11
+ #
12
+ # @return [String]
13
+ required :event_id, String
14
+
15
+ # @!method initialize(event_id:, request_options: {})
16
+ # @param event_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute webhook_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_id, String
14
+
15
+ # @!method initialize(webhook_id:, request_options: {})
16
+ # @param webhook_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute webhook_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_id, String
14
+
15
+ # @!method initialize(webhook_id:, request_options: {})
16
+ # @param webhook_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -7,7 +7,13 @@ module Dodopayments
7
7
  extend Dodopayments::Internal::Type::RequestParameters::Converter
8
8
  include Dodopayments::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute webhook_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_id, String
14
+
15
+ # @!method initialize(webhook_id:, request_options: {})
16
+ # @param webhook_id [String]
11
17
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end