dodopayments 1.16.1 → 1.18.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +34 -0
- data/README.md +58 -49
- data/lib/dodopayments/client.rb +4 -4
- data/lib/dodopayments/internal/default_page_number_pagination.rb +1 -1
- data/lib/dodopayments/internal/transport/base_client.rb +4 -4
- data/lib/dodopayments/internal/transport/pooled_net_requester.rb +1 -5
- data/lib/dodopayments/internal/type/array_of.rb +11 -0
- data/lib/dodopayments/internal/type/base_model.rb +32 -12
- data/lib/dodopayments/internal/type/base_page.rb +9 -1
- data/lib/dodopayments/internal/type/boolean.rb +4 -0
- data/lib/dodopayments/internal/type/enum.rb +9 -5
- data/lib/dodopayments/internal/type/hash_of.rb +11 -0
- data/lib/dodopayments/internal/type/io_like.rb +4 -0
- data/lib/dodopayments/internal/type/request_parameters.rb +1 -2
- data/lib/dodopayments/internal/type/union.rb +10 -1
- data/lib/dodopayments/internal/type/unknown.rb +4 -0
- data/lib/dodopayments/internal.rb +0 -1
- data/lib/dodopayments/models/attach_existing_customer.rb +2 -6
- data/lib/dodopayments/models/billing_address.rb +6 -10
- data/lib/dodopayments/models/country_code.rb +2 -5
- data/lib/dodopayments/models/create_new_customer.rb +6 -14
- data/lib/dodopayments/models/customer.rb +7 -11
- data/lib/dodopayments/models/customer_create_params.rb +6 -11
- data/lib/dodopayments/models/customer_limited_details.rb +4 -8
- data/lib/dodopayments/models/customer_list_params.rb +5 -10
- data/lib/dodopayments/models/customer_portal_session.rb +2 -6
- data/lib/dodopayments/models/customer_request.rb +2 -3
- data/lib/dodopayments/models/customer_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/customer_update_params.rb +5 -10
- data/lib/dodopayments/models/customers/customer_portal_create_params.rb +4 -9
- data/lib/dodopayments/models/discount.rb +12 -31
- data/lib/dodopayments/models/discount_create_params.rb +10 -27
- data/lib/dodopayments/models/discount_delete_params.rb +3 -8
- data/lib/dodopayments/models/discount_list_params.rb +5 -10
- data/lib/dodopayments/models/discount_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/discount_type.rb +2 -5
- data/lib/dodopayments/models/discount_update_params.rb +10 -27
- data/lib/dodopayments/models/dispute.rb +9 -25
- data/lib/dodopayments/models/dispute_list_params.rb +10 -27
- data/lib/dodopayments/models/dispute_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/dispute_stage.rb +2 -5
- data/lib/dodopayments/models/dispute_status.rb +2 -5
- data/lib/dodopayments/models/intent_status.rb +2 -5
- data/lib/dodopayments/models/invoices/payment_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/license_activate_params.rb +5 -10
- data/lib/dodopayments/models/license_deactivate_params.rb +5 -10
- data/lib/dodopayments/models/license_key.rb +13 -33
- data/lib/dodopayments/models/license_key_duration.rb +3 -7
- data/lib/dodopayments/models/license_key_instance.rb +6 -10
- data/lib/dodopayments/models/license_key_instance_list_params.rb +6 -11
- data/lib/dodopayments/models/license_key_instance_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/license_key_instance_update_params.rb +4 -9
- data/lib/dodopayments/models/license_key_list_params.rb +8 -13
- data/lib/dodopayments/models/license_key_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/license_key_status.rb +2 -5
- data/lib/dodopayments/models/license_key_update_params.rb +6 -11
- data/lib/dodopayments/models/license_validate_params.rb +5 -10
- data/lib/dodopayments/models/license_validate_response.rb +2 -6
- data/lib/dodopayments/models/misc_list_supported_countries_params.rb +3 -8
- data/lib/dodopayments/models/one_time_product_cart_item.rb +4 -8
- data/lib/dodopayments/models/payment.rb +193 -58
- data/lib/dodopayments/models/payment_create_params.rb +20 -55
- data/lib/dodopayments/models/payment_create_response.rb +9 -25
- data/lib/dodopayments/models/payment_list_params.rb +10 -27
- data/lib/dodopayments/models/payment_list_response.rb +13 -34
- data/lib/dodopayments/models/payment_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/payout_list_params.rb +5 -10
- data/lib/dodopayments/models/payout_list_response.rb +20 -49
- data/lib/dodopayments/models/price.rb +29 -79
- data/lib/dodopayments/models/product.rb +18 -44
- data/lib/dodopayments/models/product_create_params.rb +14 -36
- data/lib/dodopayments/models/product_delete_params.rb +3 -8
- data/lib/dodopayments/models/product_list_params.rb +8 -17
- data/lib/dodopayments/models/product_list_response.rb +18 -45
- data/lib/dodopayments/models/product_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/product_unarchive_params.rb +3 -8
- data/lib/dodopayments/models/product_update_params.rb +15 -38
- data/lib/dodopayments/models/products/image_update_params.rb +4 -9
- data/lib/dodopayments/models/products/image_update_response.rb +3 -7
- data/lib/dodopayments/models/refund.rb +11 -18
- data/lib/dodopayments/models/refund_create_params.rb +5 -10
- data/lib/dodopayments/models/refund_list_params.rb +9 -25
- data/lib/dodopayments/models/refund_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/refund_status.rb +2 -5
- data/lib/dodopayments/models/subscription.rb +33 -55
- data/lib/dodopayments/models/subscription_change_plan_params.rb +44 -0
- data/lib/dodopayments/models/subscription_charge_params.rb +4 -9
- data/lib/dodopayments/models/subscription_charge_response.rb +2 -6
- data/lib/dodopayments/models/subscription_create_params.rb +26 -68
- data/lib/dodopayments/models/subscription_create_response.rb +8 -23
- data/lib/dodopayments/models/subscription_list_params.rb +9 -25
- data/lib/dodopayments/models/subscription_retrieve_params.rb +3 -8
- data/lib/dodopayments/models/subscription_status.rb +2 -5
- data/lib/dodopayments/models/subscription_update_params.rb +7 -12
- data/lib/dodopayments/models/time_interval.rb +2 -5
- data/lib/dodopayments/models/webhook_event.rb +9 -25
- data/lib/dodopayments/models/webhook_event_list_params.rb +9 -25
- data/lib/dodopayments/models/webhook_event_retrieve_params.rb +3 -8
- data/lib/dodopayments/request_options.rb +3 -4
- data/lib/dodopayments/resources/subscriptions.rb +22 -0
- data/lib/dodopayments/version.rb +1 -1
- data/lib/dodopayments.rb +1 -9
- data/rbi/lib/dodopayments/client.rbi +4 -4
- data/rbi/lib/dodopayments/internal/type/array_of.rbi +3 -0
- data/rbi/lib/dodopayments/internal/type/base_model.rbi +7 -1
- data/rbi/lib/dodopayments/internal/type/base_page.rbi +2 -0
- data/rbi/lib/dodopayments/internal/type/enum.rbi +3 -6
- data/rbi/lib/dodopayments/internal/type/hash_of.rbi +3 -0
- data/rbi/lib/dodopayments/internal/type/union.rbi +3 -0
- data/rbi/lib/dodopayments/internal.rbi +0 -1
- data/rbi/lib/dodopayments/models/country_code.rbi +1 -1
- data/rbi/lib/dodopayments/models/discount_type.rbi +1 -1
- data/rbi/lib/dodopayments/models/dispute_stage.rbi +1 -1
- data/rbi/lib/dodopayments/models/dispute_status.rbi +1 -1
- data/rbi/lib/dodopayments/models/intent_status.rbi +1 -1
- data/rbi/lib/dodopayments/models/license_key_status.rbi +1 -1
- data/rbi/lib/dodopayments/models/payment.rbi +172 -1
- data/rbi/lib/dodopayments/models/payment_create_params.rbi +2 -4
- data/rbi/lib/dodopayments/models/payment_list_response.rbi +1 -2
- data/rbi/lib/dodopayments/models/payout_list_response.rbi +2 -4
- data/rbi/lib/dodopayments/models/price.rbi +2 -4
- data/rbi/lib/dodopayments/models/product.rbi +1 -2
- data/rbi/lib/dodopayments/models/product_create_params.rbi +1 -2
- data/rbi/lib/dodopayments/models/product_list_response.rbi +2 -4
- data/rbi/lib/dodopayments/models/product_update_params.rbi +1 -2
- data/rbi/lib/dodopayments/models/refund.rbi +1 -1
- data/rbi/lib/dodopayments/models/refund_status.rbi +1 -1
- data/rbi/lib/dodopayments/models/subscription.rbi +10 -3
- data/rbi/lib/dodopayments/models/subscription_change_plan_params.rbi +65 -0
- data/rbi/lib/dodopayments/models/subscription_create_params.rbi +2 -10
- data/rbi/lib/dodopayments/models/subscription_status.rbi +1 -1
- data/rbi/lib/dodopayments/models/time_interval.rbi +1 -1
- data/rbi/lib/dodopayments/resources/subscriptions.rbi +20 -0
- data/sig/dodopayments/internal/type/array_of.rbs +2 -0
- data/sig/dodopayments/internal/type/base_model.rbs +4 -0
- data/sig/dodopayments/internal/type/enum.rbs +2 -2
- data/sig/dodopayments/internal/type/hash_of.rbs +2 -0
- data/sig/dodopayments/internal/type/union.rbs +2 -0
- data/sig/dodopayments/models/payment.rbs +307 -0
- data/sig/dodopayments/models/subscription.rbs +4 -0
- data/sig/dodopayments/models/subscription_change_plan_params.rbs +41 -0
- data/sig/dodopayments/resources/subscriptions.rbs +8 -0
- metadata +5 -2
@@ -5,8 +5,7 @@ module Dodopayments
|
|
5
5
|
module Products
|
6
6
|
# @see Dodopayments::Resources::Products::Images#update
|
7
7
|
class ImageUpdateParams < Dodopayments::Internal::Type::BaseModel
|
8
|
-
|
9
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
8
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
10
9
|
include Dodopayments::Internal::Type::RequestParameters
|
11
10
|
|
12
11
|
# @!attribute force_update
|
@@ -14,13 +13,9 @@ module Dodopayments
|
|
14
13
|
# @return [Boolean, nil]
|
15
14
|
optional :force_update, Dodopayments::Internal::Type::Boolean, nil?: true
|
16
15
|
|
17
|
-
# @!
|
18
|
-
#
|
19
|
-
#
|
20
|
-
# #
|
21
|
-
# def initialize(force_update: nil, request_options: {}, **) = super
|
22
|
-
|
23
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
16
|
+
# @!method initialize(force_update: nil, request_options: {})
|
17
|
+
# @param force_update [Boolean, nil]
|
18
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
24
19
|
end
|
25
20
|
end
|
26
21
|
end
|
@@ -15,13 +15,9 @@ module Dodopayments
|
|
15
15
|
# @return [String, nil]
|
16
16
|
optional :image_id, String, nil?: true
|
17
17
|
|
18
|
-
# @!
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# #
|
22
|
-
# def initialize(url:, image_id: nil, **) = super
|
23
|
-
|
24
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
18
|
+
# @!method initialize(url:, image_id: nil)
|
19
|
+
# @param url [String]
|
20
|
+
# @param image_id [String, nil]
|
25
21
|
end
|
26
22
|
end
|
27
23
|
end
|
@@ -50,19 +50,15 @@ module Dodopayments
|
|
50
50
|
# @return [String, nil]
|
51
51
|
optional :reason, String, nil?: true
|
52
52
|
|
53
|
-
# @!
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
# #
|
63
|
-
# def initialize(business_id:, created_at:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil, **) = super
|
64
|
-
|
65
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
53
|
+
# @!method initialize(business_id:, created_at:, payment_id:, refund_id:, status:, amount: nil, currency: nil, reason: nil)
|
54
|
+
# @param business_id [String]
|
55
|
+
# @param created_at [Time]
|
56
|
+
# @param payment_id [String]
|
57
|
+
# @param refund_id [String]
|
58
|
+
# @param status [Symbol, Dodopayments::Models::RefundStatus]
|
59
|
+
# @param amount [Integer, nil]
|
60
|
+
# @param currency [Symbol, Dodopayments::Models::Refund::Currency, nil]
|
61
|
+
# @param reason [String, nil]
|
66
62
|
|
67
63
|
# @see Dodopayments::Models::Refund#currency
|
68
64
|
module Currency
|
@@ -214,11 +210,8 @@ module Dodopayments
|
|
214
210
|
ZAR = :ZAR
|
215
211
|
ZMW = :ZMW
|
216
212
|
|
217
|
-
|
218
|
-
|
219
|
-
# @!parse
|
220
|
-
# # @return [Array<Symbol>]
|
221
|
-
# def self.values; end
|
213
|
+
# @!method self.values
|
214
|
+
# @return [Array<Symbol>]
|
222
215
|
end
|
223
216
|
end
|
224
217
|
end
|
@@ -4,8 +4,7 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Refunds#create
|
6
6
|
class RefundCreateParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute payment_id
|
@@ -20,14 +19,10 @@ module Dodopayments
|
|
20
19
|
# @return [String, nil]
|
21
20
|
optional :reason, String, nil?: true
|
22
21
|
|
23
|
-
# @!
|
24
|
-
#
|
25
|
-
#
|
26
|
-
#
|
27
|
-
# #
|
28
|
-
# def initialize(payment_id:, reason: nil, request_options: {}, **) = super
|
29
|
-
|
30
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
22
|
+
# @!method initialize(payment_id:, reason: nil, request_options: {})
|
23
|
+
# @param payment_id [String]
|
24
|
+
# @param reason [String, nil]
|
25
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
31
26
|
end
|
32
27
|
end
|
33
28
|
end
|
@@ -4,8 +4,7 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Refunds#list
|
6
6
|
class RefundListParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute created_at_gte
|
@@ -44,29 +43,14 @@ module Dodopayments
|
|
44
43
|
# @return [Symbol, Dodopayments::Models::RefundStatus, nil]
|
45
44
|
optional :status, enum: -> { Dodopayments::Models::RefundStatus }, nil?: true
|
46
45
|
|
47
|
-
# @!
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
# #
|
56
|
-
# def initialize(
|
57
|
-
# created_at_gte: nil,
|
58
|
-
# created_at_lte: nil,
|
59
|
-
# customer_id: nil,
|
60
|
-
# page_number: nil,
|
61
|
-
# page_size: nil,
|
62
|
-
# status: nil,
|
63
|
-
# request_options: {},
|
64
|
-
# **
|
65
|
-
# )
|
66
|
-
# super
|
67
|
-
# end
|
68
|
-
|
69
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
46
|
+
# @!method initialize(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
|
47
|
+
# @param created_at_gte [Time, nil]
|
48
|
+
# @param created_at_lte [Time, nil]
|
49
|
+
# @param customer_id [String, nil]
|
50
|
+
# @param page_number [Integer, nil]
|
51
|
+
# @param page_size [Integer, nil]
|
52
|
+
# @param status [Symbol, Dodopayments::Models::RefundStatus, nil]
|
53
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
70
54
|
end
|
71
55
|
end
|
72
56
|
end
|
@@ -4,16 +4,11 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Refunds#retrieve
|
6
6
|
class RefundRetrieveParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|
@@ -31,7 +31,8 @@ module Dodopayments
|
|
31
31
|
required :metadata, Dodopayments::Internal::Type::HashOf[String]
|
32
32
|
|
33
33
|
# @!attribute next_billing_date
|
34
|
-
# Timestamp of the next scheduled billing
|
34
|
+
# Timestamp of the next scheduled billing. Indicates the end of current billing
|
35
|
+
# period
|
35
36
|
#
|
36
37
|
# @return [Time]
|
37
38
|
required :next_billing_date, Time
|
@@ -47,6 +48,12 @@ module Dodopayments
|
|
47
48
|
# @return [Symbol, Dodopayments::Models::TimeInterval]
|
48
49
|
required :payment_frequency_interval, enum: -> { Dodopayments::Models::TimeInterval }
|
49
50
|
|
51
|
+
# @!attribute previous_billing_date
|
52
|
+
# Timestamp of the last payment. Indicates the start of current billing period
|
53
|
+
#
|
54
|
+
# @return [Time]
|
55
|
+
required :previous_billing_date, Time
|
56
|
+
|
50
57
|
# @!attribute product_id
|
51
58
|
# Identifier of the product associated with this subscription
|
52
59
|
#
|
@@ -112,55 +119,29 @@ module Dodopayments
|
|
112
119
|
# @return [String, nil]
|
113
120
|
optional :discount_id, String, nil?: true
|
114
121
|
|
115
|
-
# @!
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# def initialize(
|
139
|
-
# billing:,
|
140
|
-
# created_at:,
|
141
|
-
# currency:,
|
142
|
-
# customer:,
|
143
|
-
# metadata:,
|
144
|
-
# next_billing_date:,
|
145
|
-
# payment_frequency_count:,
|
146
|
-
# payment_frequency_interval:,
|
147
|
-
# product_id:,
|
148
|
-
# quantity:,
|
149
|
-
# recurring_pre_tax_amount:,
|
150
|
-
# status:,
|
151
|
-
# subscription_id:,
|
152
|
-
# subscription_period_count:,
|
153
|
-
# subscription_period_interval:,
|
154
|
-
# tax_inclusive:,
|
155
|
-
# trial_period_days:,
|
156
|
-
# cancelled_at: nil,
|
157
|
-
# discount_id: nil,
|
158
|
-
# **
|
159
|
-
# )
|
160
|
-
# super
|
161
|
-
# end
|
162
|
-
|
163
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
122
|
+
# @!method initialize(billing:, created_at:, currency:, customer:, metadata:, next_billing_date:, 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, discount_id: nil)
|
123
|
+
# Response struct representing subscription details
|
124
|
+
#
|
125
|
+
# @param billing [Dodopayments::Models::BillingAddress]
|
126
|
+
# @param created_at [Time]
|
127
|
+
# @param currency [Symbol, Dodopayments::Models::Subscription::Currency]
|
128
|
+
# @param customer [Dodopayments::Models::CustomerLimitedDetails]
|
129
|
+
# @param metadata [Hash{Symbol=>String}]
|
130
|
+
# @param next_billing_date [Time]
|
131
|
+
# @param payment_frequency_count [Integer]
|
132
|
+
# @param payment_frequency_interval [Symbol, Dodopayments::Models::TimeInterval]
|
133
|
+
# @param previous_billing_date [Time]
|
134
|
+
# @param product_id [String]
|
135
|
+
# @param quantity [Integer]
|
136
|
+
# @param recurring_pre_tax_amount [Integer]
|
137
|
+
# @param status [Symbol, Dodopayments::Models::SubscriptionStatus]
|
138
|
+
# @param subscription_id [String]
|
139
|
+
# @param subscription_period_count [Integer]
|
140
|
+
# @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval]
|
141
|
+
# @param tax_inclusive [Boolean]
|
142
|
+
# @param trial_period_days [Integer]
|
143
|
+
# @param cancelled_at [Time, nil]
|
144
|
+
# @param discount_id [String, nil]
|
164
145
|
|
165
146
|
# @see Dodopayments::Models::Subscription#currency
|
166
147
|
module Currency
|
@@ -312,11 +293,8 @@ module Dodopayments
|
|
312
293
|
ZAR = :ZAR
|
313
294
|
ZMW = :ZMW
|
314
295
|
|
315
|
-
|
316
|
-
|
317
|
-
# @!parse
|
318
|
-
# # @return [Array<Symbol>]
|
319
|
-
# def self.values; end
|
296
|
+
# @!method self.values
|
297
|
+
# @return [Array<Symbol>]
|
320
298
|
end
|
321
299
|
end
|
322
300
|
end
|
@@ -0,0 +1,44 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Dodopayments
|
4
|
+
module Models
|
5
|
+
# @see Dodopayments::Resources::Subscriptions#change_plan
|
6
|
+
class SubscriptionChangePlanParams < Dodopayments::Internal::Type::BaseModel
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
8
|
+
include Dodopayments::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# @!attribute product_id
|
11
|
+
# Unique identifier of the product to subscribe to
|
12
|
+
#
|
13
|
+
# @return [String]
|
14
|
+
required :product_id, String
|
15
|
+
|
16
|
+
# @!attribute proration_billing_mode
|
17
|
+
#
|
18
|
+
# @return [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
|
19
|
+
required :proration_billing_mode,
|
20
|
+
enum: -> { Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode }
|
21
|
+
|
22
|
+
# @!attribute quantity
|
23
|
+
# Number of units to subscribe for. Must be at least 1.
|
24
|
+
#
|
25
|
+
# @return [Integer]
|
26
|
+
required :quantity, Integer
|
27
|
+
|
28
|
+
# @!method initialize(product_id:, proration_billing_mode:, quantity:, request_options: {})
|
29
|
+
# @param product_id [String]
|
30
|
+
# @param proration_billing_mode [Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode]
|
31
|
+
# @param quantity [Integer]
|
32
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
33
|
+
|
34
|
+
module ProrationBillingMode
|
35
|
+
extend Dodopayments::Internal::Type::Enum
|
36
|
+
|
37
|
+
PRORATED_IMMEDIATELY = :prorated_immediately
|
38
|
+
|
39
|
+
# @!method self.values
|
40
|
+
# @return [Array<Symbol>]
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
@@ -4,8 +4,7 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Subscriptions#charge
|
6
6
|
class SubscriptionChargeParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute product_price
|
@@ -15,13 +14,9 @@ module Dodopayments
|
|
15
14
|
# @return [Integer]
|
16
15
|
required :product_price, Integer
|
17
16
|
|
18
|
-
# @!
|
19
|
-
#
|
20
|
-
#
|
21
|
-
# #
|
22
|
-
# def initialize(product_price:, request_options: {}, **) = super
|
23
|
-
|
24
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
17
|
+
# @!method initialize(product_price:, request_options: {})
|
18
|
+
# @param product_price [Integer]
|
19
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
25
20
|
end
|
26
21
|
end
|
27
22
|
end
|
@@ -9,12 +9,8 @@ module Dodopayments
|
|
9
9
|
# @return [String]
|
10
10
|
required :payment_id, String
|
11
11
|
|
12
|
-
# @!
|
13
|
-
#
|
14
|
-
# #
|
15
|
-
# def initialize(payment_id:, **) = super
|
16
|
-
|
17
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
12
|
+
# @!method initialize(payment_id:)
|
13
|
+
# @param payment_id [String]
|
18
14
|
end
|
19
15
|
end
|
20
16
|
end
|
@@ -4,8 +4,7 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Subscriptions#create
|
6
6
|
class SubscriptionCreateParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute billing
|
@@ -56,15 +55,11 @@ module Dodopayments
|
|
56
55
|
# @return [String, nil]
|
57
56
|
optional :discount_code, String, nil?: true
|
58
57
|
|
59
|
-
# @!attribute
|
58
|
+
# @!attribute metadata
|
60
59
|
#
|
61
60
|
# @return [Hash{Symbol=>String}, nil]
|
62
61
|
optional :metadata, Dodopayments::Internal::Type::HashOf[String]
|
63
62
|
|
64
|
-
# @!parse
|
65
|
-
# # @return [Hash{Symbol=>String}]
|
66
|
-
# attr_writer :metadata
|
67
|
-
|
68
63
|
# @!attribute on_demand
|
69
64
|
#
|
70
65
|
# @return [Dodopayments::Models::SubscriptionCreateParams::OnDemand, nil]
|
@@ -82,16 +77,12 @@ module Dodopayments
|
|
82
77
|
# @return [String, nil]
|
83
78
|
optional :return_url, String, nil?: true
|
84
79
|
|
85
|
-
# @!attribute
|
80
|
+
# @!attribute show_saved_payment_methods
|
86
81
|
# Display saved payment methods of a returning customer False by default
|
87
82
|
#
|
88
83
|
# @return [Boolean, nil]
|
89
84
|
optional :show_saved_payment_methods, Dodopayments::Internal::Type::Boolean
|
90
85
|
|
91
|
-
# @!parse
|
92
|
-
# # @return [Boolean]
|
93
|
-
# attr_writer :show_saved_payment_methods
|
94
|
-
|
95
86
|
# @!attribute tax_id
|
96
87
|
# Tax ID in case the payment is B2B. If tax id validation fails the payment
|
97
88
|
# creation will fail
|
@@ -106,45 +97,22 @@ module Dodopayments
|
|
106
97
|
# @return [Integer, nil]
|
107
98
|
optional :trial_period_days, Integer, nil?: true
|
108
99
|
|
109
|
-
# @!
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
# #
|
126
|
-
# def initialize(
|
127
|
-
# billing:,
|
128
|
-
# customer:,
|
129
|
-
# product_id:,
|
130
|
-
# quantity:,
|
131
|
-
# allowed_payment_method_types: nil,
|
132
|
-
# billing_currency: nil,
|
133
|
-
# discount_code: nil,
|
134
|
-
# metadata: nil,
|
135
|
-
# on_demand: nil,
|
136
|
-
# payment_link: nil,
|
137
|
-
# return_url: nil,
|
138
|
-
# show_saved_payment_methods: nil,
|
139
|
-
# tax_id: nil,
|
140
|
-
# trial_period_days: nil,
|
141
|
-
# request_options: {},
|
142
|
-
# **
|
143
|
-
# )
|
144
|
-
# super
|
145
|
-
# end
|
146
|
-
|
147
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
100
|
+
# @!method initialize(billing:, customer:, product_id:, quantity:, allowed_payment_method_types: nil, billing_currency: nil, discount_code: nil, metadata: nil, on_demand: nil, payment_link: nil, return_url: nil, show_saved_payment_methods: nil, tax_id: nil, trial_period_days: nil, request_options: {})
|
101
|
+
# @param billing [Dodopayments::Models::BillingAddress]
|
102
|
+
# @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::CreateNewCustomer]
|
103
|
+
# @param product_id [String]
|
104
|
+
# @param quantity [Integer]
|
105
|
+
# @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::SubscriptionCreateParams::AllowedPaymentMethodType>, nil]
|
106
|
+
# @param billing_currency [Symbol, Dodopayments::Models::SubscriptionCreateParams::BillingCurrency, nil]
|
107
|
+
# @param discount_code [String, nil]
|
108
|
+
# @param metadata [Hash{Symbol=>String}]
|
109
|
+
# @param on_demand [Dodopayments::Models::SubscriptionCreateParams::OnDemand, nil]
|
110
|
+
# @param payment_link [Boolean, nil]
|
111
|
+
# @param return_url [String, nil]
|
112
|
+
# @param show_saved_payment_methods [Boolean]
|
113
|
+
# @param tax_id [String, nil]
|
114
|
+
# @param trial_period_days [Integer, nil]
|
115
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
148
116
|
|
149
117
|
module AllowedPaymentMethodType
|
150
118
|
extend Dodopayments::Internal::Type::Enum
|
@@ -168,11 +136,8 @@ module Dodopayments
|
|
168
136
|
AMAZON_PAY = :amazon_pay
|
169
137
|
AFTERPAY_CLEARPAY = :afterpay_clearpay
|
170
138
|
|
171
|
-
|
172
|
-
|
173
|
-
# @!parse
|
174
|
-
# # @return [Array<Symbol>]
|
175
|
-
# def self.values; end
|
139
|
+
# @!method self.values
|
140
|
+
# @return [Array<Symbol>]
|
176
141
|
end
|
177
142
|
|
178
143
|
module BillingCurrency
|
@@ -324,11 +289,8 @@ module Dodopayments
|
|
324
289
|
ZAR = :ZAR
|
325
290
|
ZMW = :ZMW
|
326
291
|
|
327
|
-
|
328
|
-
|
329
|
-
# @!parse
|
330
|
-
# # @return [Array<Symbol>]
|
331
|
-
# def self.values; end
|
292
|
+
# @!method self.values
|
293
|
+
# @return [Array<Symbol>]
|
332
294
|
end
|
333
295
|
|
334
296
|
class OnDemand < Dodopayments::Internal::Type::BaseModel
|
@@ -347,13 +309,9 @@ module Dodopayments
|
|
347
309
|
# @return [Integer, nil]
|
348
310
|
optional :product_price, Integer, nil?: true
|
349
311
|
|
350
|
-
# @!
|
351
|
-
#
|
352
|
-
#
|
353
|
-
# #
|
354
|
-
# def initialize(mandate_only:, product_price: nil, **) = super
|
355
|
-
|
356
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
312
|
+
# @!method initialize(mandate_only:, product_price: nil)
|
313
|
+
# @param mandate_only [Boolean]
|
314
|
+
# @param product_price [Integer, nil]
|
357
315
|
end
|
358
316
|
end
|
359
317
|
end
|
@@ -46,29 +46,14 @@ module Dodopayments
|
|
46
46
|
# @return [String, nil]
|
47
47
|
optional :payment_link, String, nil?: true
|
48
48
|
|
49
|
-
# @!
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# #
|
58
|
-
# def initialize(
|
59
|
-
# customer:,
|
60
|
-
# metadata:,
|
61
|
-
# recurring_pre_tax_amount:,
|
62
|
-
# subscription_id:,
|
63
|
-
# client_secret: nil,
|
64
|
-
# discount_id: nil,
|
65
|
-
# payment_link: nil,
|
66
|
-
# **
|
67
|
-
# )
|
68
|
-
# super
|
69
|
-
# end
|
70
|
-
|
71
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
49
|
+
# @!method initialize(customer:, metadata:, recurring_pre_tax_amount:, subscription_id:, client_secret: nil, discount_id: nil, payment_link: nil)
|
50
|
+
# @param customer [Dodopayments::Models::CustomerLimitedDetails]
|
51
|
+
# @param metadata [Hash{Symbol=>String}]
|
52
|
+
# @param recurring_pre_tax_amount [Integer]
|
53
|
+
# @param subscription_id [String]
|
54
|
+
# @param client_secret [String, nil]
|
55
|
+
# @param discount_id [String, nil]
|
56
|
+
# @param payment_link [String, nil]
|
72
57
|
end
|
73
58
|
end
|
74
59
|
end
|
@@ -4,8 +4,7 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Subscriptions#list
|
6
6
|
class SubscriptionListParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
10
|
# @!attribute created_at_gte
|
@@ -44,29 +43,14 @@ module Dodopayments
|
|
44
43
|
# @return [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
|
45
44
|
optional :status, enum: -> { Dodopayments::Models::SubscriptionStatus }, nil?: true
|
46
45
|
|
47
|
-
# @!
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
# #
|
56
|
-
# def initialize(
|
57
|
-
# created_at_gte: nil,
|
58
|
-
# created_at_lte: nil,
|
59
|
-
# customer_id: nil,
|
60
|
-
# page_number: nil,
|
61
|
-
# page_size: nil,
|
62
|
-
# status: nil,
|
63
|
-
# request_options: {},
|
64
|
-
# **
|
65
|
-
# )
|
66
|
-
# super
|
67
|
-
# end
|
68
|
-
|
69
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
46
|
+
# @!method initialize(created_at_gte: nil, created_at_lte: nil, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
|
47
|
+
# @param created_at_gte [Time, nil]
|
48
|
+
# @param created_at_lte [Time, nil]
|
49
|
+
# @param customer_id [String, nil]
|
50
|
+
# @param page_number [Integer, nil]
|
51
|
+
# @param page_size [Integer, nil]
|
52
|
+
# @param status [Symbol, Dodopayments::Models::SubscriptionStatus, nil]
|
53
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
70
54
|
end
|
71
55
|
end
|
72
56
|
end
|
@@ -4,16 +4,11 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @see Dodopayments::Resources::Subscriptions#retrieve
|
6
6
|
class SubscriptionRetrieveParams < Dodopayments::Internal::Type::BaseModel
|
7
|
-
|
8
|
-
# extend Dodopayments::Internal::Type::RequestParameters::Converter
|
7
|
+
extend Dodopayments::Internal::Type::RequestParameters::Converter
|
9
8
|
include Dodopayments::Internal::Type::RequestParameters
|
10
9
|
|
11
|
-
# @!
|
12
|
-
#
|
13
|
-
# #
|
14
|
-
# def initialize(request_options: {}, **) = super
|
15
|
-
|
16
|
-
# def initialize: (Hash | Dodopayments::Internal::Type::BaseModel) -> void
|
10
|
+
# @!method initialize(request_options: {})
|
11
|
+
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
17
12
|
end
|
18
13
|
end
|
19
14
|
end
|