dodopayments 2.23.0 → 2.25.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 (63) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/dodopayments/models/brand.rb +9 -1
  5. data/lib/dodopayments/models/brand_archive_params.rb +35 -0
  6. data/lib/dodopayments/models/brand_archive_response.rb +57 -0
  7. data/lib/dodopayments/models/brand_list_params.rb +9 -1
  8. data/lib/dodopayments/models/checkout_session_flags.rb +13 -1
  9. data/lib/dodopayments/models/subscription.rb +10 -1
  10. data/lib/dodopayments/models/subscription_list_params.rb +1 -0
  11. data/lib/dodopayments/models/subscription_list_response.rb +10 -1
  12. data/lib/dodopayments/models/subscription_paused_webhook_event.rb +40 -0
  13. data/lib/dodopayments/models/subscription_status.rb +1 -0
  14. data/lib/dodopayments/models/subscription_unpaused_webhook_event.rb +40 -0
  15. data/lib/dodopayments/models/subscription_update_params.rb +10 -1
  16. data/lib/dodopayments/models/unsafe_unwrap_webhook_event.rb +5 -1
  17. data/lib/dodopayments/models/unwrap_webhook_event.rb +5 -1
  18. data/lib/dodopayments/models/webhook_event_type.rb +1 -0
  19. data/lib/dodopayments/models.rb +6 -0
  20. data/lib/dodopayments/resources/brands.rb +35 -2
  21. data/lib/dodopayments/resources/subscriptions.rb +3 -1
  22. data/lib/dodopayments/resources/webhooks.rb +2 -2
  23. data/lib/dodopayments/version.rb +1 -1
  24. data/lib/dodopayments.rb +4 -0
  25. data/rbi/dodopayments/models/brand.rbi +8 -0
  26. data/rbi/dodopayments/models/brand_archive_params.rbi +58 -0
  27. data/rbi/dodopayments/models/brand_archive_response.rbi +80 -0
  28. data/rbi/dodopayments/models/brand_list_params.rbi +22 -5
  29. data/rbi/dodopayments/models/checkout_session_flags.rbi +22 -3
  30. data/rbi/dodopayments/models/subscription.rbi +10 -0
  31. data/rbi/dodopayments/models/subscription_list_params.rbi +5 -0
  32. data/rbi/dodopayments/models/subscription_list_response.rbi +10 -0
  33. data/rbi/dodopayments/models/subscription_paused_webhook_event.rbi +67 -0
  34. data/rbi/dodopayments/models/subscription_status.rbi +1 -0
  35. data/rbi/dodopayments/models/subscription_unpaused_webhook_event.rbi +67 -0
  36. data/rbi/dodopayments/models/subscription_update_params.rbi +10 -0
  37. data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi +2 -0
  38. data/rbi/dodopayments/models/unwrap_webhook_event.rbi +2 -0
  39. data/rbi/dodopayments/models/webhook_event_type.rbi +5 -0
  40. data/rbi/dodopayments/models.rbi +8 -0
  41. data/rbi/dodopayments/resources/brands.rbi +30 -4
  42. data/rbi/dodopayments/resources/subscriptions.rbi +4 -0
  43. data/rbi/dodopayments/resources/webhooks.rbi +4 -0
  44. data/sig/dodopayments/models/brand.rbs +5 -0
  45. data/sig/dodopayments/models/brand_archive_params.rbs +28 -0
  46. data/sig/dodopayments/models/brand_archive_response.rbs +45 -0
  47. data/sig/dodopayments/models/brand_list_params.rbs +14 -3
  48. data/sig/dodopayments/models/checkout_session_flags.rbs +10 -3
  49. data/sig/dodopayments/models/subscription.rbs +5 -0
  50. data/sig/dodopayments/models/subscription_list_params.rbs +8 -1
  51. data/sig/dodopayments/models/subscription_list_response.rbs +5 -0
  52. data/sig/dodopayments/models/subscription_paused_webhook_event.rbs +35 -0
  53. data/sig/dodopayments/models/subscription_status.rbs +2 -1
  54. data/sig/dodopayments/models/subscription_unpaused_webhook_event.rbs +35 -0
  55. data/sig/dodopayments/models/subscription_update_params.rbs +5 -0
  56. data/sig/dodopayments/models/unsafe_unwrap_webhook_event.rbs +2 -0
  57. data/sig/dodopayments/models/unwrap_webhook_event.rbs +2 -0
  58. data/sig/dodopayments/models/webhook_event_type.rbs +2 -0
  59. data/sig/dodopayments/models.rbs +6 -0
  60. data/sig/dodopayments/resources/brands.rbs +7 -0
  61. data/sig/dodopayments/resources/subscriptions.rbs +1 -0
  62. data/sig/dodopayments/resources/webhooks.rbs +4 -0
  63. metadata +14 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cad4c970cd5ba2e91f1b33653e3a27453819b606e7102e86deee762ce4aa2644
4
- data.tar.gz: 565ee66cb3f01d6f407a53961de128f62da49b82adb3cbddc62b346948a5cef9
3
+ metadata.gz: 6044c5e4d1ea9b8f78276bedf6e3218cb525ae8163a52089a05261e227cfd4c6
4
+ data.tar.gz: db3411ebc0c7020505e250983d0d7eb65061c6f84341aca6230101142ccce20a
5
5
  SHA512:
6
- metadata.gz: f40e2157114f0f727cd01e2efcca91b1f26e18825d97658ef0cb1d3b207eaec1b5c13cce89b6d0aea4e5cd31abd8010d37a67c1b080b690b5e6ec05935b3484b
7
- data.tar.gz: b02a1a361412eeb20958ba7f620a718897161a63de622350c5ff54bac4d3bc66c911594321ef247ab11dc2f192394a8a0648f68a7b7397ce460ee7fd4154ba85
6
+ metadata.gz: b98146146080c8330a6990c0109609b568bf3f8b5181f995d65a89a5417eb841dc09294c50f3cfaabb1c4be743a725d44eacd8f072bb82949178d4d6e94df18d
7
+ data.tar.gz: 13bbf24a4ed0f809f279588f79f3f422c2c18cdb7bb28717164e5f088c42ffe032da03178c164a73f4179671a83bd7c10a379bfaddb402a03dd89453d16583a4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## [2.25.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.24.0...v2.25.0) (2026-08-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** add brand archive endpoint ([ccc5fc9](https://github.com/dodopayments/dodopayments-ruby/commit/ccc5fc9c61410ac28010e98cc241ab8eb471cb72))
9
+ * **api:** add brand archive endpoint ([90fc52d](https://github.com/dodopayments/dodopayments-ruby/commit/90fc52df5e05849e2dfdd5b307ea2ff34edb050e))
10
+
11
+ ## [2.24.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.23.0...v2.24.0) (2026-08-13)
12
+
13
+
14
+ ### Features
15
+
16
+ * **api:** add subscription pause/unpause ([40d887a](https://github.com/dodopayments/dodopayments-ruby/commit/40d887abc1f80fca0fffedbd7c9966ef89ec4051))
17
+ * **api:** add subscription pause/unpause ([40280ad](https://github.com/dodopayments/dodopayments-ruby/commit/40280ad39a2abb9297ff48468da7f2bea721d622))
18
+
3
19
  ## [2.23.0](https://github.com/dodopayments/dodopayments-ruby/compare/v2.22.0...v2.23.0) (2026-08-05)
4
20
 
5
21
 
data/README.md CHANGED
@@ -23,7 +23,7 @@ To use this gem, install via Bundler by adding the following to your application
23
23
  <!-- x-release-please-start-version -->
24
24
 
25
25
  ```ruby
26
- gem "dodopayments", "~> 2.23.0"
26
+ gem "dodopayments", "~> 2.25.0"
27
27
  ```
28
28
 
29
29
  <!-- x-release-please-end -->
@@ -34,6 +34,12 @@ module Dodopayments
34
34
  # @return [Symbol, Dodopayments::Models::Brand::VerificationStatus]
35
35
  required :verification_status, enum: -> { Dodopayments::Brand::VerificationStatus }
36
36
 
37
+ # @!attribute archived_at
38
+ # Time the brand was archived. Null for an active brand.
39
+ #
40
+ # @return [Time, nil]
41
+ optional :archived_at, Time, nil?: true
42
+
37
43
  # @!attribute description
38
44
  #
39
45
  # @return [String, nil]
@@ -65,7 +71,7 @@ module Dodopayments
65
71
  # @return [String, nil]
66
72
  optional :url, String, nil?: true
67
73
 
68
- # @!method initialize(brand_id:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil)
74
+ # @!method initialize(brand_id:, business_id:, enabled:, statement_descriptor:, verification_enabled:, verification_status:, archived_at: nil, description: nil, image: nil, name: nil, reason_for_hold: nil, support_email: nil, url: nil)
69
75
  # @param brand_id [String]
70
76
  #
71
77
  # @param business_id [String]
@@ -78,6 +84,8 @@ module Dodopayments
78
84
  #
79
85
  # @param verification_status [Symbol, Dodopayments::Models::Brand::VerificationStatus]
80
86
  #
87
+ # @param archived_at [Time, nil] Time the brand was archived. Null for an active brand.
88
+ #
81
89
  # @param description [String, nil]
82
90
  #
83
91
  # @param image [String, nil]
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ # @see Dodopayments::Resources::Brands#archive
6
+ class BrandArchiveParams < Dodopayments::Internal::Type::BaseModel
7
+ extend Dodopayments::Internal::Type::RequestParameters::Converter
8
+ include Dodopayments::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!attribute move_products_to
16
+ # Brand that takes over the products and the live subscriptions of the brand you
17
+ # archive. It must be a brand of the same business, and it must not be archived.
18
+ # The primary brand (its brand id is the business id) is a valid target. Omit this
19
+ # field only when the brand holds no products and no live subscriptions.
20
+ #
21
+ # @return [String, nil]
22
+ optional :move_products_to, String, nil?: true
23
+
24
+ # @!method initialize(id:, move_products_to: nil, request_options: {})
25
+ # Some parameter documentations has been truncated, see
26
+ # {Dodopayments::Models::BrandArchiveParams} for more details.
27
+ #
28
+ # @param id [String]
29
+ #
30
+ # @param move_products_to [String, nil] Brand that takes over the products and the live subscriptions of the
31
+ #
32
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ # @see Dodopayments::Resources::Brands#archive
6
+ class BrandArchiveResponse < Dodopayments::Internal::Type::BaseModel
7
+ # @!attribute archived_at
8
+ # Time the brand was archived.
9
+ #
10
+ # @return [Time]
11
+ required :archived_at, Time
12
+
13
+ # @!attribute brand_id
14
+ # The archived brand.
15
+ #
16
+ # @return [String]
17
+ required :brand_id, String
18
+
19
+ # @!attribute collections_moved
20
+ # Count of product collections moved to the target brand.
21
+ #
22
+ # @return [Integer]
23
+ required :collections_moved, Integer
24
+
25
+ # @!attribute products_moved
26
+ # Count of products moved to the target brand.
27
+ #
28
+ # @return [Integer]
29
+ required :products_moved, Integer
30
+
31
+ # @!attribute subscriptions_moved
32
+ # Count of live subscriptions moved to the target brand.
33
+ #
34
+ # @return [Integer]
35
+ required :subscriptions_moved, Integer
36
+
37
+ # @!attribute moved_to_brand_id
38
+ # Brand that received the moved records. Null when no target was given.
39
+ #
40
+ # @return [String, nil]
41
+ optional :moved_to_brand_id, String, nil?: true
42
+
43
+ # @!method initialize(archived_at:, brand_id:, collections_moved:, products_moved:, subscriptions_moved:, moved_to_brand_id: nil)
44
+ # @param archived_at [Time] Time the brand was archived.
45
+ #
46
+ # @param brand_id [String] The archived brand.
47
+ #
48
+ # @param collections_moved [Integer] Count of product collections moved to the target brand.
49
+ #
50
+ # @param products_moved [Integer] Count of products moved to the target brand.
51
+ #
52
+ # @param subscriptions_moved [Integer] Count of live subscriptions moved to the target brand.
53
+ #
54
+ # @param moved_to_brand_id [String, nil] Brand that received the moved records. Null when no target was given.
55
+ end
56
+ end
57
+ end
@@ -7,7 +7,15 @@ 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 include_archived
11
+ # Set to true to also list archived brands. Default false.
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :include_archived, Dodopayments::Internal::Type::Boolean
15
+
16
+ # @!method initialize(include_archived: nil, request_options: {})
17
+ # @param include_archived [Boolean] Set to true to also list archived brands. Default false.
18
+ #
11
19
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
12
20
  end
13
21
  end
@@ -122,7 +122,17 @@ module Dodopayments
122
122
  # @return [Boolean, nil]
123
123
  optional :require_phone_number, Dodopayments::Internal::Type::Boolean
124
124
 
125
- # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_editing_addons: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil)
125
+ # @!attribute single_page
126
+ # If true, the session uses the single-page checkout flow: the page initializes
127
+ # the payment at load time and confirms it in place, with no separate payment
128
+ # page.
129
+ #
130
+ # Default is false
131
+ #
132
+ # @return [Boolean, nil]
133
+ optional :single_page, Dodopayments::Internal::Type::Boolean
134
+
135
+ # @!method initialize(allow_currency_selection: nil, allow_customer_editing_business_name: nil, allow_customer_editing_city: nil, allow_customer_editing_country: nil, allow_customer_editing_email: nil, allow_customer_editing_name: nil, allow_customer_editing_state: nil, allow_customer_editing_street: nil, allow_customer_editing_tax_id: nil, allow_customer_editing_zipcode: nil, allow_discount_code: nil, allow_editing_addons: nil, allow_phone_number_collection: nil, allow_tax_id: nil, always_create_new_customer: nil, redirect_immediately: nil, require_phone_number: nil, single_page: nil)
126
136
  # Some parameter documentations has been truncated, see
127
137
  # {Dodopayments::Models::CheckoutSessionFlags} for more details.
128
138
  #
@@ -159,6 +169,8 @@ module Dodopayments
159
169
  # @param redirect_immediately [Boolean] If true, redirects the customer immediately after payment completion
160
170
  #
161
171
  # @param require_phone_number [Boolean] If true, the customer must provide a phone number to complete checkout.
172
+ #
173
+ # @param single_page [Boolean] If true, the session uses the single-page checkout flow: the page
162
174
  end
163
175
  end
164
176
  end
@@ -217,6 +217,13 @@ module Dodopayments
217
217
  # @return [Time, nil]
218
218
  optional :expires_at, Time, nil?: true
219
219
 
220
+ # @!attribute paused_at
221
+ # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
222
+ # due to an unresolved pause settlement). `null` otherwise.
223
+ #
224
+ # @return [Time, nil]
225
+ optional :paused_at, Time, nil?: true
226
+
220
227
  # @!attribute payment_method_id
221
228
  # Saved payment method id used for recurring charges
222
229
  #
@@ -243,7 +250,7 @@ module Dodopayments
243
250
  # @return [Integer, nil]
244
251
  optional :trial_amount, Integer, nil?: true
245
252
 
246
- # @!method initialize(addons:, billing:, brand_id:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, metadata:, meter_credit_entitlement_cart:, meters:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancellation_comment: nil, cancellation_feedback: nil, cancelled_at: nil, custom_field_responses: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, discounts: nil, expires_at: nil, payment_method_id: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
253
+ # @!method initialize(addons:, billing:, brand_id:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, metadata:, meter_credit_entitlement_cart:, meters:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancellation_comment: nil, cancellation_feedback: nil, cancelled_at: nil, custom_field_responses: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, discounts: nil, expires_at: nil, paused_at: nil, payment_method_id: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
247
254
  # Some parameter documentations has been truncated, see
248
255
  # {Dodopayments::Models::Subscription} for more details.
249
256
  #
@@ -317,6 +324,8 @@ module Dodopayments
317
324
  #
318
325
  # @param expires_at [Time, nil] Timestamp when the subscription will expire
319
326
  #
327
+ # @param paused_at [Time, nil] Timestamp when the subscription was paused, if it currently is (or is
328
+ #
320
329
  # @param payment_method_id [String, nil] Saved payment method id used for recurring charges
321
330
  #
322
331
  # @param scheduled_change [Dodopayments::Models::ScheduledPlanChange, nil] Scheduled plan change details, if any
@@ -92,6 +92,7 @@ module Dodopayments
92
92
  PENDING = :pending
93
93
  ACTIVE = :active
94
94
  ON_HOLD = :on_hold
95
+ PAUSED = :paused
95
96
  CANCELLED = :cancelled
96
97
  FAILED = :failed
97
98
  EXPIRED = :expired
@@ -158,6 +158,13 @@ module Dodopayments
158
158
  # @return [String, nil]
159
159
  optional :discount_id, String, nil?: true
160
160
 
161
+ # @!attribute paused_at
162
+ # Timestamp when the subscription was paused, if it currently is (or is `OnHold`
163
+ # due to an unresolved pause settlement). `null` otherwise.
164
+ #
165
+ # @return [Time, nil]
166
+ optional :paused_at, Time, nil?: true
167
+
161
168
  # @!attribute payment_method_id
162
169
  # Saved payment method id used for recurring charges
163
170
  #
@@ -190,7 +197,7 @@ module Dodopayments
190
197
  # @return [Integer, nil]
191
198
  optional :trial_amount, Integer, nil?: true
192
199
 
193
- # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
200
+ # @!method initialize(billing:, cancel_at_next_billing_date:, created_at:, currency:, customer:, discounts:, metadata:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, customer_business_name: nil, discount_cycles_remaining: nil, discount_id: nil, paused_at: nil, payment_method_id: nil, product_name: nil, scheduled_change: nil, tax_id: nil, trial_amount: nil)
194
201
  # Some parameter documentations has been truncated, see
195
202
  # {Dodopayments::Models::SubscriptionListResponse} for more details.
196
203
  #
@@ -246,6 +253,8 @@ module Dodopayments
246
253
  #
247
254
  # @param discount_id [String, nil] DEPRECATED: Use discounts instead.
248
255
  #
256
+ # @param paused_at [Time, nil] Timestamp when the subscription was paused, if it currently is (or is
257
+ #
249
258
  # @param payment_method_id [String, nil] Saved payment method id used for recurring charges
250
259
  #
251
260
  # @param product_name [String, nil] Name of the product associated with this subscription
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ class SubscriptionPausedWebhookEvent < Dodopayments::Internal::Type::BaseModel
6
+ # @!attribute business_id
7
+ # The business identifier
8
+ #
9
+ # @return [String]
10
+ required :business_id, String
11
+
12
+ # @!attribute data
13
+ # Response struct representing subscription details
14
+ #
15
+ # @return [Dodopayments::Models::Subscription]
16
+ required :data, -> { Dodopayments::Subscription }
17
+
18
+ # @!attribute timestamp
19
+ # The timestamp of when the event occurred
20
+ #
21
+ # @return [Time]
22
+ required :timestamp, Time
23
+
24
+ # @!attribute type
25
+ # The event type
26
+ #
27
+ # @return [Symbol, :"subscription.paused"]
28
+ required :type, const: :"subscription.paused"
29
+
30
+ # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.paused")
31
+ # @param business_id [String] The business identifier
32
+ #
33
+ # @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
34
+ #
35
+ # @param timestamp [Time] The timestamp of when the event occurred
36
+ #
37
+ # @param type [Symbol, :"subscription.paused"] The event type
38
+ end
39
+ end
40
+ end
@@ -8,6 +8,7 @@ module Dodopayments
8
8
  PENDING = :pending
9
9
  ACTIVE = :active
10
10
  ON_HOLD = :on_hold
11
+ PAUSED = :paused
11
12
  CANCELLED = :cancelled
12
13
  FAILED = :failed
13
14
  EXPIRED = :expired
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Dodopayments
4
+ module Models
5
+ class SubscriptionUnpausedWebhookEvent < Dodopayments::Internal::Type::BaseModel
6
+ # @!attribute business_id
7
+ # The business identifier
8
+ #
9
+ # @return [String]
10
+ required :business_id, String
11
+
12
+ # @!attribute data
13
+ # Response struct representing subscription details
14
+ #
15
+ # @return [Dodopayments::Models::Subscription]
16
+ required :data, -> { Dodopayments::Subscription }
17
+
18
+ # @!attribute timestamp
19
+ # The timestamp of when the event occurred
20
+ #
21
+ # @return [Time]
22
+ required :timestamp, Time
23
+
24
+ # @!attribute type
25
+ # The event type
26
+ #
27
+ # @return [Symbol, :"subscription.unpaused"]
28
+ required :type, const: :"subscription.unpaused"
29
+
30
+ # @!method initialize(business_id:, data:, timestamp:, type: :"subscription.unpaused")
31
+ # @param business_id [String] The business identifier
32
+ #
33
+ # @param data [Dodopayments::Models::Subscription] Response struct representing subscription details
34
+ #
35
+ # @param timestamp [Time] The timestamp of when the event occurred
36
+ #
37
+ # @param type [Symbol, :"subscription.unpaused"] The event type
38
+ end
39
+ end
40
+ end
@@ -84,6 +84,13 @@ module Dodopayments
84
84
  # @return [Time, nil]
85
85
  optional :next_billing_date, Time, nil?: true
86
86
 
87
+ # @!attribute pause
88
+ # `Some(true)` pauses an active subscription; `Some(false)` unpauses a `Paused`
89
+ # (or abandoned `OnHold`) subscription. Exclusive of every other field.
90
+ #
91
+ # @return [Boolean, nil]
92
+ optional :pause, Dodopayments::Internal::Type::Boolean, nil?: true
93
+
87
94
  # @!attribute status
88
95
  #
89
96
  # @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
@@ -111,7 +118,7 @@ module Dodopayments
111
118
  # @return [String, nil]
112
119
  optional :tax_id, String, nil?: true
113
120
 
114
- # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
121
+ # @!method initialize(subscription_id:, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, pause: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
115
122
  # Some parameter documentations has been truncated, see
116
123
  # {Dodopayments::Models::SubscriptionUpdateParams} for more details.
117
124
  #
@@ -139,6 +146,8 @@ module Dodopayments
139
146
  #
140
147
  # @param next_billing_date [Time, nil]
141
148
  #
149
+ # @param pause [Boolean, nil] `Some(true)` pauses an active subscription; `Some(false)` unpauses a
150
+ #
142
151
  # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
143
152
  #
144
153
  # @param subscription_period_count [Integer, nil] New number of `subscription_period_interval` units the subscription
@@ -89,17 +89,21 @@ module Dodopayments
89
89
 
90
90
  variant :"subscription.on_hold", -> { Dodopayments::SubscriptionOnHoldWebhookEvent }
91
91
 
92
+ variant :"subscription.paused", -> { Dodopayments::SubscriptionPausedWebhookEvent }
93
+
92
94
  variant :"subscription.plan_changed", -> { Dodopayments::SubscriptionPlanChangedWebhookEvent }
93
95
 
94
96
  variant :"subscription.renewed", -> { Dodopayments::SubscriptionRenewedWebhookEvent }
95
97
 
98
+ variant :"subscription.unpaused", -> { Dodopayments::SubscriptionUnpausedWebhookEvent }
99
+
96
100
  variant :"subscription.update_payment_method",
97
101
  -> { Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent }
98
102
 
99
103
  variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
100
104
 
101
105
  # @!method self.variants
102
- # @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
106
+ # @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
103
107
  end
104
108
  end
105
109
  end
@@ -89,17 +89,21 @@ module Dodopayments
89
89
 
90
90
  variant :"subscription.on_hold", -> { Dodopayments::SubscriptionOnHoldWebhookEvent }
91
91
 
92
+ variant :"subscription.paused", -> { Dodopayments::SubscriptionPausedWebhookEvent }
93
+
92
94
  variant :"subscription.plan_changed", -> { Dodopayments::SubscriptionPlanChangedWebhookEvent }
93
95
 
94
96
  variant :"subscription.renewed", -> { Dodopayments::SubscriptionRenewedWebhookEvent }
95
97
 
98
+ variant :"subscription.unpaused", -> { Dodopayments::SubscriptionUnpausedWebhookEvent }
99
+
96
100
  variant :"subscription.update_payment_method",
97
101
  -> { Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent }
98
102
 
99
103
  variant :"subscription.updated", -> { Dodopayments::SubscriptionUpdatedWebhookEvent }
100
104
 
101
105
  # @!method self.variants
102
- # @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
106
+ # @return [Array(Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent)]
103
107
  end
104
108
  end
105
109
  end
@@ -23,6 +23,7 @@ module Dodopayments
23
23
  SUBSCRIPTION_RENEWED = :"subscription.renewed"
24
24
  SUBSCRIPTION_ON_HOLD = :"subscription.on_hold"
25
25
  SUBSCRIPTION_PAUSED = :"subscription.paused"
26
+ SUBSCRIPTION_UNPAUSED = :"subscription.unpaused"
26
27
  SUBSCRIPTION_CANCELLED = :"subscription.cancelled"
27
28
  SUBSCRIPTION_FAILED = :"subscription.failed"
28
29
  SUBSCRIPTION_EXPIRED = :"subscription.expired"
@@ -75,6 +75,8 @@ module Dodopayments
75
75
 
76
76
  Brand = Dodopayments::Models::Brand
77
77
 
78
+ BrandArchiveParams = Dodopayments::Models::BrandArchiveParams
79
+
78
80
  BrandCreateParams = Dodopayments::Models::BrandCreateParams
79
81
 
80
82
  BrandListParams = Dodopayments::Models::BrandListParams
@@ -468,6 +470,8 @@ module Dodopayments
468
470
 
469
471
  SubscriptionOnHoldWebhookEvent = Dodopayments::Models::SubscriptionOnHoldWebhookEvent
470
472
 
473
+ SubscriptionPausedWebhookEvent = Dodopayments::Models::SubscriptionPausedWebhookEvent
474
+
471
475
  SubscriptionPlanChangedWebhookEvent = Dodopayments::Models::SubscriptionPlanChangedWebhookEvent
472
476
 
473
477
  SubscriptionPreviewChangePlanParams = Dodopayments::Models::SubscriptionPreviewChangePlanParams
@@ -482,6 +486,8 @@ module Dodopayments
482
486
 
483
487
  SubscriptionStatus = Dodopayments::Models::SubscriptionStatus
484
488
 
489
+ SubscriptionUnpausedWebhookEvent = Dodopayments::Models::SubscriptionUnpausedWebhookEvent
490
+
485
491
  SubscriptionUpdatedWebhookEvent = Dodopayments::Models::SubscriptionUpdatedWebhookEvent
486
492
 
487
493
  SubscriptionUpdateParams = Dodopayments::Models::SubscriptionUpdateParams
@@ -78,7 +78,9 @@ module Dodopayments
78
78
  )
79
79
  end
80
80
 
81
- # @overload list(request_options: {})
81
+ # @overload list(include_archived: nil, request_options: {})
82
+ #
83
+ # @param include_archived [Boolean] Set to true to also list archived brands. Default false.
82
84
  #
83
85
  # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
84
86
  #
@@ -86,11 +88,42 @@ module Dodopayments
86
88
  #
87
89
  # @see Dodopayments::Models::BrandListParams
88
90
  def list(params = {})
91
+ parsed, options = Dodopayments::BrandListParams.dump_request(params)
92
+ query = Dodopayments::Internal::Util.encode_query_params(parsed)
89
93
  @client.request(
90
94
  method: :get,
91
95
  path: "brands",
96
+ query: query,
92
97
  model: Dodopayments::Models::BrandListResponse,
93
- options: params[:request_options]
98
+ options: options
99
+ )
100
+ end
101
+
102
+ # Some parameter documentations has been truncated, see
103
+ # {Dodopayments::Models::BrandArchiveParams} for more details.
104
+ #
105
+ # Archive a brand. Its products, live subscriptions, and product collections move
106
+ # to the `move_products_to` brand. Archive is permanent.
107
+ #
108
+ # @overload archive(id, move_products_to: nil, request_options: {})
109
+ #
110
+ # @param id [String] Brand Id
111
+ #
112
+ # @param move_products_to [String, nil] Brand that takes over the products and the live subscriptions of the
113
+ #
114
+ # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
115
+ #
116
+ # @return [Dodopayments::Models::BrandArchiveResponse]
117
+ #
118
+ # @see Dodopayments::Models::BrandArchiveParams
119
+ def archive(id, params = {})
120
+ parsed, options = Dodopayments::BrandArchiveParams.dump_request(params)
121
+ @client.request(
122
+ method: :post,
123
+ path: ["brands/%1$s/archive", id],
124
+ body: parsed,
125
+ model: Dodopayments::Models::BrandArchiveResponse,
126
+ options: options
94
127
  )
95
128
  end
96
129
 
@@ -95,7 +95,7 @@ module Dodopayments
95
95
  # Some parameter documentations has been truncated, see
96
96
  # {Dodopayments::Models::SubscriptionUpdateParams} for more details.
97
97
  #
98
- # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
98
+ # @overload update(subscription_id, billing: nil, cancel_at_next_billing_date: nil, cancel_reason: nil, cancellation_comment: nil, cancellation_feedback: nil, credit_entitlement_cart: nil, customer_business_name: nil, customer_name: nil, disable_on_demand: nil, metadata: nil, next_billing_date: nil, pause: nil, status: nil, subscription_period_count: nil, subscription_period_interval: nil, tax_id: nil, request_options: {})
99
99
  #
100
100
  # @param subscription_id [String] Subscription Id
101
101
  #
@@ -121,6 +121,8 @@ module Dodopayments
121
121
  #
122
122
  # @param next_billing_date [Time, nil]
123
123
  #
124
+ # @param pause [Boolean, nil] `Some(true)` pauses an active subscription; `Some(false)` unpauses a
125
+ #
124
126
  # @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
125
127
  #
126
128
  # @param subscription_period_count [Integer, nil] New number of `subscription_period_interval` units the subscription
@@ -170,7 +170,7 @@ module Dodopayments
170
170
 
171
171
  # @param payload [String] The raw webhook payload as a string
172
172
  #
173
- # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
173
+ # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
174
174
  def unsafe_unwrap(payload)
175
175
  parsed = JSON.parse(payload, symbolize_names: true)
176
176
  Dodopayments::Internal::Type::Converter.coerce(Dodopayments::Models::UnsafeUnwrapWebhookEvent, parsed)
@@ -182,7 +182,7 @@ module Dodopayments
182
182
  #
183
183
  # @param key [String, nil] The webhook signing key
184
184
  #
185
- # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
185
+ # @return [Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent, Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent, Dodopayments::Models::CreditAddedWebhookEvent, Dodopayments::Models::CreditBalanceLowWebhookEvent, Dodopayments::Models::CreditDeductedWebhookEvent, Dodopayments::Models::CreditExpiredWebhookEvent, Dodopayments::Models::CreditManualAdjustmentWebhookEvent, Dodopayments::Models::CreditOverageChargedWebhookEvent, Dodopayments::Models::CreditOverageResetWebhookEvent, Dodopayments::Models::CreditRolledOverWebhookEvent, Dodopayments::Models::CreditRolloverForfeitedWebhookEvent, Dodopayments::Models::DisputeAcceptedWebhookEvent, Dodopayments::Models::DisputeCancelledWebhookEvent, Dodopayments::Models::DisputeChallengedWebhookEvent, Dodopayments::Models::DisputeExpiredWebhookEvent, Dodopayments::Models::DisputeLostWebhookEvent, Dodopayments::Models::DisputeOpenedWebhookEvent, Dodopayments::Models::DisputeWonWebhookEvent, Dodopayments::Models::DunningRecoveredWebhookEvent, Dodopayments::Models::DunningStartedWebhookEvent, Dodopayments::Models::EntitlementGrantCreatedWebhookEvent, Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent, Dodopayments::Models::EntitlementGrantFailedWebhookEvent, Dodopayments::Models::EntitlementGrantRevokedWebhookEvent, Dodopayments::Models::LicenseKeyCreatedWebhookEvent, Dodopayments::Models::PaymentCancelledWebhookEvent, Dodopayments::Models::PaymentFailedWebhookEvent, Dodopayments::Models::PaymentProcessingWebhookEvent, Dodopayments::Models::PaymentSucceededWebhookEvent, Dodopayments::Models::PayoutCreatedWebhookEvent, Dodopayments::Models::PayoutFailedWebhookEvent, Dodopayments::Models::PayoutInProgressWebhookEvent, Dodopayments::Models::PayoutOnHoldWebhookEvent, Dodopayments::Models::PayoutSuccessWebhookEvent, Dodopayments::Models::RefundFailedWebhookEvent, Dodopayments::Models::RefundSucceededWebhookEvent, Dodopayments::Models::SubscriptionActiveWebhookEvent, Dodopayments::Models::SubscriptionCancelledWebhookEvent, Dodopayments::Models::SubscriptionExpiredWebhookEvent, Dodopayments::Models::SubscriptionFailedWebhookEvent, Dodopayments::Models::SubscriptionOnHoldWebhookEvent, Dodopayments::Models::SubscriptionPausedWebhookEvent, Dodopayments::Models::SubscriptionPlanChangedWebhookEvent, Dodopayments::Models::SubscriptionRenewedWebhookEvent, Dodopayments::Models::SubscriptionUnpausedWebhookEvent, Dodopayments::Models::SubscriptionUpdatePaymentMethodWebhookEvent, Dodopayments::Models::SubscriptionUpdatedWebhookEvent]
186
186
  def unwrap(payload, headers:, key: @client.webhook_key)
187
187
  if key.nil?
188
188
  raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_key or passed in as an argument")
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Dodopayments
4
- VERSION = "2.23.0"
4
+ VERSION = "2.25.0"
5
5
  end