whop_sdk 0.0.37 → 0.0.39
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 +61 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +76 -10
- data/lib/whop_sdk/helpers/verify_user_token.rb +166 -34
- data/lib/whop_sdk/models/ad_campaign_list_params.rb +101 -0
- data/lib/whop_sdk/models/ad_campaign_list_response.rb +126 -0
- data/lib/whop_sdk/models/ad_campaign_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_campaign_pause_response.rb +328 -0
- data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +328 -0
- data/lib/whop_sdk/models/ad_campaign_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +328 -0
- data/lib/whop_sdk/models/ad_campaign_update_params.rb +33 -0
- data/lib/whop_sdk/models/ad_campaign_update_response.rb +328 -0
- data/lib/whop_sdk/models/ad_group_delete_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_delete_response.rb +8 -0
- data/lib/whop_sdk/models/ad_group_list_params.rb +109 -0
- data/lib/whop_sdk/models/ad_group_list_response.rb +118 -0
- data/lib/whop_sdk/models/ad_group_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_retrieve_response.rb +140 -0
- data/lib/whop_sdk/models/ad_group_update_params.rb +3207 -0
- data/lib/whop_sdk/models/ad_group_update_response.rb +140 -0
- data/lib/whop_sdk/models/ad_list_params.rb +115 -0
- data/lib/whop_sdk/models/ad_list_response.rb +89 -0
- data/lib/whop_sdk/models/ad_report_retrieve_params.rb +77 -0
- data/lib/whop_sdk/models/ad_report_retrieve_response.rb +312 -0
- data/lib/whop_sdk/models/ad_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/ad_retrieve_response.rb +133 -0
- data/lib/whop_sdk/models/authorized_user_roles.rb +1 -0
- data/lib/whop_sdk/models/bounty_create_params.rb +105 -0
- data/lib/whop_sdk/models/bounty_create_response.rb +126 -0
- data/lib/whop_sdk/models/bounty_list_params.rb +85 -0
- data/lib/whop_sdk/models/bounty_list_response.rb +126 -0
- data/lib/whop_sdk/models/bounty_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/bounty_retrieve_response.rb +126 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +20 -2
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +97 -23
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +20 -2
- data/lib/whop_sdk/models/company_create_api_key_params.rb +109 -0
- data/lib/whop_sdk/models/company_create_api_key_response.rb +35 -0
- data/lib/whop_sdk/models/conversion_create_params.rb +462 -0
- data/lib/whop_sdk/models/conversion_create_response.rb +19 -0
- data/lib/whop_sdk/models/currency.rb +1 -0
- data/lib/whop_sdk/models/file_create_params.rb +22 -1
- data/lib/whop_sdk/models/file_create_response.rb +26 -3
- data/lib/whop_sdk/models/file_retrieve_response.rb +26 -3
- data/lib/whop_sdk/models/forum_post_list_params.rb +9 -1
- data/lib/whop_sdk/models/forum_update_params.rb +10 -1
- data/lib/whop_sdk/models/invoice_create_params.rb +36 -18
- data/lib/whop_sdk/models/invoice_update_params.rb +29 -7
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +2 -2
- data/lib/whop_sdk/models/membership.rb +11 -1
- data/lib/whop_sdk/models/membership_list_response.rb +11 -1
- data/lib/whop_sdk/models/payment.rb +47 -2
- data/lib/whop_sdk/models/payment_list_response.rb +29 -2
- data/lib/whop_sdk/models/payment_method_types.rb +16 -0
- data/lib/whop_sdk/models/payment_refund_params.rb +4 -3
- data/lib/whop_sdk/models/payout_account_retrieve_response.rb +2 -2
- data/lib/whop_sdk/models/payout_account_status_updated_webhook_event.rb +2 -2
- data/lib/whop_sdk/models/plan.rb +12 -3
- data/lib/whop_sdk/models/plan_create_params.rb +26 -6
- data/lib/whop_sdk/models/plan_list_response.rb +12 -3
- data/lib/whop_sdk/models/plan_update_params.rb +26 -6
- data/lib/whop_sdk/models/support_channel_list_params.rb +31 -9
- data/lib/whop_sdk/models/user_retrieve_params.rb +14 -1
- data/lib/whop_sdk/models/{user_update_profile_params.rb → user_update_params.rb} +24 -7
- data/lib/whop_sdk/models/verification_list_response.rb +2 -2
- data/lib/whop_sdk/models/verification_retrieve_response.rb +2 -2
- data/lib/whop_sdk/models/verification_status.rb +1 -0
- data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +2 -2
- data/lib/whop_sdk/models.rb +35 -1
- data/lib/whop_sdk/resources/ad_campaigns.rb +163 -0
- data/lib/whop_sdk/resources/ad_groups.rb +151 -0
- data/lib/whop_sdk/resources/ad_reports.rb +59 -0
- data/lib/whop_sdk/resources/ads.rb +88 -0
- data/lib/whop_sdk/resources/bounties.rb +124 -0
- data/lib/whop_sdk/resources/companies.rb +34 -0
- data/lib/whop_sdk/resources/conversions.rb +67 -0
- data/lib/whop_sdk/resources/files.rb +3 -1
- data/lib/whop_sdk/resources/forum_posts.rb +3 -1
- data/lib/whop_sdk/resources/forums.rb +3 -1
- data/lib/whop_sdk/resources/invoices.rb +9 -2
- data/lib/whop_sdk/resources/payments.rb +1 -1
- data/lib/whop_sdk/resources/plans.rb +6 -2
- data/lib/whop_sdk/resources/support_channels.rb +6 -4
- data/lib/whop_sdk/resources/users.rb +49 -37
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +41 -1
- data/rbi/whop_sdk/client.rbi +24 -0
- data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +142 -0
- data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +239 -0
- data/rbi/whop_sdk/models/ad_campaign_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_campaign_pause_response.rbi +668 -0
- data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +679 -0
- data/rbi/whop_sdk/models/ad_campaign_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +675 -0
- data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +51 -0
- data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +670 -0
- data/rbi/whop_sdk/models/ad_group_delete_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/ad_group_list_params.rbi +145 -0
- data/rbi/whop_sdk/models/ad_group_list_response.rbi +228 -0
- data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +277 -0
- data/rbi/whop_sdk/models/ad_group_update_params.rbi +6133 -0
- data/rbi/whop_sdk/models/ad_group_update_response.rbi +274 -0
- data/rbi/whop_sdk/models/ad_list_params.rbi +146 -0
- data/rbi/whop_sdk/models/ad_list_response.rbi +146 -0
- data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +99 -0
- data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +629 -0
- data/rbi/whop_sdk/models/ad_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_retrieve_response.rbi +245 -0
- data/rbi/whop_sdk/models/authorized_user_roles.rbi +2 -0
- data/rbi/whop_sdk/models/bounty_create_params.rbi +129 -0
- data/rbi/whop_sdk/models/bounty_create_response.rbi +196 -0
- data/rbi/whop_sdk/models/bounty_list_params.rbi +115 -0
- data/rbi/whop_sdk/models/bounty_list_response.rbi +189 -0
- data/rbi/whop_sdk/models/bounty_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +199 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +20 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +84 -16
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +20 -0
- data/rbi/whop_sdk/models/company_create_api_key_params.rbi +184 -0
- data/rbi/whop_sdk/models/company_create_api_key_response.rbi +51 -0
- data/rbi/whop_sdk/models/conversion_create_params.rbi +661 -0
- data/rbi/whop_sdk/models/conversion_create_response.rbi +31 -0
- data/rbi/whop_sdk/models/currency.rbi +1 -0
- data/rbi/whop_sdk/models/file_create_params.rbi +41 -1
- data/rbi/whop_sdk/models/file_create_response.rbi +52 -5
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +53 -5
- data/rbi/whop_sdk/models/forum_post_list_params.rbi +8 -0
- data/rbi/whop_sdk/models/forum_update_params.rbi +10 -0
- data/rbi/whop_sdk/models/invoice_create_params.rbi +46 -26
- data/rbi/whop_sdk/models/invoice_update_params.rbi +28 -6
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +2 -2
- data/rbi/whop_sdk/models/membership.rbi +12 -0
- data/rbi/whop_sdk/models/membership_list_response.rbi +12 -0
- data/rbi/whop_sdk/models/payment.rbi +57 -3
- data/rbi/whop_sdk/models/payment_list_response.rbi +37 -3
- data/rbi/whop_sdk/models/payment_method_types.rbi +31 -0
- data/rbi/whop_sdk/models/payment_refund_params.rbi +6 -4
- data/rbi/whop_sdk/models/payout_account_retrieve_response.rbi +2 -2
- data/rbi/whop_sdk/models/payout_account_status_updated_webhook_event.rbi +2 -2
- data/rbi/whop_sdk/models/plan.rbi +12 -2
- data/rbi/whop_sdk/models/plan_create_params.rbi +22 -4
- data/rbi/whop_sdk/models/plan_list_response.rbi +12 -2
- data/rbi/whop_sdk/models/plan_update_params.rbi +22 -4
- data/rbi/whop_sdk/models/support_channel_list_params.rbi +50 -8
- data/rbi/whop_sdk/models/user_retrieve_params.rbi +18 -2
- data/rbi/whop_sdk/models/{user_update_profile_params.rbi → user_update_params.rbi} +25 -9
- data/rbi/whop_sdk/models/verification_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/verification_retrieve_response.rbi +2 -2
- data/rbi/whop_sdk/models/verification_status.rbi +2 -0
- data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +2 -2
- data/rbi/whop_sdk/models.rbi +35 -1
- data/rbi/whop_sdk/resources/ad_campaigns.rbi +134 -0
- data/rbi/whop_sdk/resources/ad_groups.rbi +139 -0
- data/rbi/whop_sdk/resources/ad_reports.rbi +55 -0
- data/rbi/whop_sdk/resources/ads.rbi +81 -0
- data/rbi/whop_sdk/resources/bounties.rbi +116 -0
- data/rbi/whop_sdk/resources/companies.rbi +32 -0
- data/rbi/whop_sdk/resources/conversions.rbi +71 -0
- data/rbi/whop_sdk/resources/files.rbi +5 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +3 -0
- data/rbi/whop_sdk/resources/forums.rbi +4 -0
- data/rbi/whop_sdk/resources/invoices.rbi +10 -1
- data/rbi/whop_sdk/resources/payments.rbi +3 -2
- data/rbi/whop_sdk/resources/plans.rbi +6 -0
- data/rbi/whop_sdk/resources/support_channels.rbi +8 -3
- data/rbi/whop_sdk/resources/users.rbi +42 -29
- data/sig/whop_sdk/client.rbs +12 -0
- data/sig/whop_sdk/models/ad_campaign_list_params.rbs +82 -0
- data/sig/whop_sdk/models/ad_campaign_list_response.rbs +98 -0
- data/sig/whop_sdk/models/ad_campaign_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +232 -0
- data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +232 -0
- data/sig/whop_sdk/models/ad_campaign_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +232 -0
- data/sig/whop_sdk/models/ad_campaign_update_params.rbs +28 -0
- data/sig/whop_sdk/models/ad_campaign_update_response.rbs +232 -0
- data/sig/whop_sdk/models/ad_group_delete_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/ad_group_list_params.rbs +87 -0
- data/sig/whop_sdk/models/ad_group_list_response.rbs +93 -0
- data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +108 -0
- data/sig/whop_sdk/models/ad_group_update_params.rbs +2439 -0
- data/sig/whop_sdk/models/ad_group_update_response.rbs +108 -0
- data/sig/whop_sdk/models/ad_list_params.rbs +87 -0
- data/sig/whop_sdk/models/ad_list_response.rbs +72 -0
- data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +56 -0
- data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +278 -0
- data/sig/whop_sdk/models/ad_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_retrieve_response.rbs +102 -0
- data/sig/whop_sdk/models/authorized_user_roles.rbs +2 -0
- data/sig/whop_sdk/models/bounty_create_params.rbs +71 -0
- data/sig/whop_sdk/models/bounty_create_response.rbs +93 -0
- data/sig/whop_sdk/models/bounty_list_params.rbs +67 -0
- data/sig/whop_sdk/models/bounty_list_response.rbs +93 -0
- data/sig/whop_sdk/models/bounty_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/bounty_retrieve_response.rbs +93 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +10 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +51 -16
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +10 -0
- data/sig/whop_sdk/models/company_create_api_key_params.rbs +83 -0
- data/sig/whop_sdk/models/company_create_api_key_response.rbs +18 -0
- data/sig/whop_sdk/models/conversion_create_params.rbs +349 -0
- data/sig/whop_sdk/models/conversion_create_response.rbs +13 -0
- data/sig/whop_sdk/models/currency.rbs +2 -0
- data/sig/whop_sdk/models/file_create_params.rbs +20 -1
- data/sig/whop_sdk/models/file_create_response.rbs +19 -3
- data/sig/whop_sdk/models/file_retrieve_response.rbs +19 -3
- data/sig/whop_sdk/models/forum_post_list_params.rbs +5 -0
- data/sig/whop_sdk/models/forum_update_params.rbs +5 -0
- data/sig/whop_sdk/models/invoice_create_params.rbs +24 -14
- data/sig/whop_sdk/models/invoice_update_params.rbs +15 -5
- data/sig/whop_sdk/models/membership.rbs +5 -0
- data/sig/whop_sdk/models/membership_list_response.rbs +5 -0
- data/sig/whop_sdk/models/payment.rbs +25 -3
- data/sig/whop_sdk/models/payment_list_response.rbs +15 -3
- data/sig/whop_sdk/models/payment_method_types.rbs +32 -0
- data/sig/whop_sdk/models/plan.rbs +5 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +14 -4
- data/sig/whop_sdk/models/plan_list_response.rbs +5 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +14 -4
- data/sig/whop_sdk/models/support_channel_list_params.rbs +23 -6
- data/sig/whop_sdk/models/user_retrieve_params.rbs +10 -2
- data/sig/whop_sdk/models/{user_update_profile_params.rbs → user_update_params.rbs} +16 -6
- data/sig/whop_sdk/models/verification_status.rbs +2 -0
- data/sig/whop_sdk/models.rbs +35 -1
- data/sig/whop_sdk/resources/ad_campaigns.rbs +41 -0
- data/sig/whop_sdk/resources/ad_groups.rbs +40 -0
- data/sig/whop_sdk/resources/ad_reports.rbs +18 -0
- data/sig/whop_sdk/resources/ads.rbs +26 -0
- data/sig/whop_sdk/resources/bounties.rbs +37 -0
- data/sig/whop_sdk/resources/companies.rbs +9 -0
- data/sig/whop_sdk/resources/conversions.rbs +25 -0
- data/sig/whop_sdk/resources/files.rbs +1 -0
- data/sig/whop_sdk/resources/forum_posts.rbs +1 -0
- data/sig/whop_sdk/resources/forums.rbs +1 -0
- data/sig/whop_sdk/resources/invoices.rbs +2 -0
- data/sig/whop_sdk/resources/plans.rbs +2 -0
- data/sig/whop_sdk/resources/support_channels.rbs +2 -1
- data/sig/whop_sdk/resources/users.rbs +11 -8
- metadata +125 -5
|
@@ -745,7 +745,7 @@ module WhopSDK
|
|
|
745
745
|
)
|
|
746
746
|
end
|
|
747
747
|
|
|
748
|
-
# The
|
|
748
|
+
# The numeric id of the verification record.
|
|
749
749
|
sig { returns(String) }
|
|
750
750
|
attr_accessor :id
|
|
751
751
|
|
|
@@ -775,7 +775,7 @@ module WhopSDK
|
|
|
775
775
|
).returns(T.attached_class)
|
|
776
776
|
end
|
|
777
777
|
def self.new(
|
|
778
|
-
# The
|
|
778
|
+
# The numeric id of the verification record.
|
|
779
779
|
id:,
|
|
780
780
|
# An error code for a verification attempt.
|
|
781
781
|
last_error_code:,
|
|
@@ -30,6 +30,12 @@ module WhopSDK
|
|
|
30
30
|
sig { returns(T.nilable(String)) }
|
|
31
31
|
attr_accessor :cancellation_reason
|
|
32
32
|
|
|
33
|
+
# The ID of the checkout session/configuration that produced this membership, if
|
|
34
|
+
# any. Use this to map memberships back to the checkout configuration that created
|
|
35
|
+
# them.
|
|
36
|
+
sig { returns(T.nilable(String)) }
|
|
37
|
+
attr_accessor :checkout_configuration_id
|
|
38
|
+
|
|
33
39
|
# The company this membership belongs to.
|
|
34
40
|
sig { returns(WhopSDK::Membership::Company) }
|
|
35
41
|
attr_reader :company
|
|
@@ -146,6 +152,7 @@ module WhopSDK
|
|
|
146
152
|
cancel_option: T.nilable(WhopSDK::CancelOptions::OrSymbol),
|
|
147
153
|
canceled_at: T.nilable(Time),
|
|
148
154
|
cancellation_reason: T.nilable(String),
|
|
155
|
+
checkout_configuration_id: T.nilable(String),
|
|
149
156
|
company: WhopSDK::Membership::Company::OrHash,
|
|
150
157
|
created_at: Time,
|
|
151
158
|
currency: T.nilable(WhopSDK::Currency::OrSymbol),
|
|
@@ -182,6 +189,10 @@ module WhopSDK
|
|
|
182
189
|
# Free-text explanation provided by the customer when canceling. Null if the
|
|
183
190
|
# customer did not provide a reason.
|
|
184
191
|
cancellation_reason:,
|
|
192
|
+
# The ID of the checkout session/configuration that produced this membership, if
|
|
193
|
+
# any. Use this to map memberships back to the checkout configuration that created
|
|
194
|
+
# them.
|
|
195
|
+
checkout_configuration_id:,
|
|
185
196
|
# The company this membership belongs to.
|
|
186
197
|
company:,
|
|
187
198
|
# The datetime the membership was created.
|
|
@@ -240,6 +251,7 @@ module WhopSDK
|
|
|
240
251
|
cancel_option: T.nilable(WhopSDK::CancelOptions::TaggedSymbol),
|
|
241
252
|
canceled_at: T.nilable(Time),
|
|
242
253
|
cancellation_reason: T.nilable(String),
|
|
254
|
+
checkout_configuration_id: T.nilable(String),
|
|
243
255
|
company: WhopSDK::Membership::Company,
|
|
244
256
|
created_at: Time,
|
|
245
257
|
currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
|
|
@@ -35,6 +35,12 @@ module WhopSDK
|
|
|
35
35
|
sig { returns(T.nilable(String)) }
|
|
36
36
|
attr_accessor :cancellation_reason
|
|
37
37
|
|
|
38
|
+
# The ID of the checkout session/configuration that produced this membership, if
|
|
39
|
+
# any. Use this to map memberships back to the checkout configuration that created
|
|
40
|
+
# them.
|
|
41
|
+
sig { returns(T.nilable(String)) }
|
|
42
|
+
attr_accessor :checkout_configuration_id
|
|
43
|
+
|
|
38
44
|
# The company this membership belongs to.
|
|
39
45
|
sig { returns(WhopSDK::Models::MembershipListResponse::Company) }
|
|
40
46
|
attr_reader :company
|
|
@@ -170,6 +176,7 @@ module WhopSDK
|
|
|
170
176
|
cancel_option: T.nilable(WhopSDK::CancelOptions::OrSymbol),
|
|
171
177
|
canceled_at: T.nilable(Time),
|
|
172
178
|
cancellation_reason: T.nilable(String),
|
|
179
|
+
checkout_configuration_id: T.nilable(String),
|
|
173
180
|
company: WhopSDK::Models::MembershipListResponse::Company::OrHash,
|
|
174
181
|
created_at: Time,
|
|
175
182
|
currency: T.nilable(WhopSDK::Currency::OrSymbol),
|
|
@@ -208,6 +215,10 @@ module WhopSDK
|
|
|
208
215
|
# Free-text explanation provided by the customer when canceling. Null if the
|
|
209
216
|
# customer did not provide a reason.
|
|
210
217
|
cancellation_reason:,
|
|
218
|
+
# The ID of the checkout session/configuration that produced this membership, if
|
|
219
|
+
# any. Use this to map memberships back to the checkout configuration that created
|
|
220
|
+
# them.
|
|
221
|
+
checkout_configuration_id:,
|
|
211
222
|
# The company this membership belongs to.
|
|
212
223
|
company:,
|
|
213
224
|
# The datetime the membership was created.
|
|
@@ -263,6 +274,7 @@ module WhopSDK
|
|
|
263
274
|
cancel_option: T.nilable(WhopSDK::CancelOptions::TaggedSymbol),
|
|
264
275
|
canceled_at: T.nilable(Time),
|
|
265
276
|
cancellation_reason: T.nilable(String),
|
|
277
|
+
checkout_configuration_id: T.nilable(String),
|
|
266
278
|
company: WhopSDK::Models::MembershipListResponse::Company,
|
|
267
279
|
created_at: Time,
|
|
268
280
|
currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
|
|
@@ -53,6 +53,11 @@ module WhopSDK
|
|
|
53
53
|
sig { returns(T.nilable(String)) }
|
|
54
54
|
attr_accessor :card_last4
|
|
55
55
|
|
|
56
|
+
# The ID of the checkout session/configuration that produced this payment, if any.
|
|
57
|
+
# Use this to map payments back to the checkout configuration that created them.
|
|
58
|
+
sig { returns(T.nilable(String)) }
|
|
59
|
+
attr_accessor :checkout_configuration_id
|
|
60
|
+
|
|
56
61
|
# The company for the payment.
|
|
57
62
|
sig { returns(T.nilable(WhopSDK::Payment::Company)) }
|
|
58
63
|
attr_reader :company
|
|
@@ -193,6 +198,22 @@ module WhopSDK
|
|
|
193
198
|
sig { returns(T::Boolean) }
|
|
194
199
|
attr_accessor :retryable
|
|
195
200
|
|
|
201
|
+
# The payment amount in the creator's settlement currency (what the creator priced
|
|
202
|
+
# in). Equal to final_amount for single-currency payments.
|
|
203
|
+
sig { returns(Float) }
|
|
204
|
+
attr_accessor :settlement_amount
|
|
205
|
+
|
|
206
|
+
# The currency in which the creator receives payouts and fees are charged (e.g.,
|
|
207
|
+
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
208
|
+
# currency.
|
|
209
|
+
sig { returns(String) }
|
|
210
|
+
attr_accessor :settlement_currency
|
|
211
|
+
|
|
212
|
+
# The locked exchange rate used to convert from the buyer's payment currency to
|
|
213
|
+
# the creator's settlement currency. Null for single-currency payments.
|
|
214
|
+
sig { returns(T.nilable(Float)) }
|
|
215
|
+
attr_accessor :settlement_exchange_rate
|
|
216
|
+
|
|
196
217
|
# The status of a receipt
|
|
197
218
|
sig { returns(T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol)) }
|
|
198
219
|
attr_accessor :status
|
|
@@ -254,6 +275,7 @@ module WhopSDK
|
|
|
254
275
|
billing_reason: T.nilable(WhopSDK::BillingReasons::OrSymbol),
|
|
255
276
|
card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
|
|
256
277
|
card_last4: T.nilable(String),
|
|
278
|
+
checkout_configuration_id: T.nilable(String),
|
|
257
279
|
company: T.nilable(WhopSDK::Payment::Company::OrHash),
|
|
258
280
|
created_at: Time,
|
|
259
281
|
currency: T.nilable(WhopSDK::Currency::OrSymbol),
|
|
@@ -281,6 +303,9 @@ module WhopSDK
|
|
|
281
303
|
resolutions:
|
|
282
304
|
T.nilable(T::Array[WhopSDK::Payment::Resolution::OrHash]),
|
|
283
305
|
retryable: T::Boolean,
|
|
306
|
+
settlement_amount: Float,
|
|
307
|
+
settlement_currency: String,
|
|
308
|
+
settlement_exchange_rate: T.nilable(Float),
|
|
284
309
|
status: T.nilable(WhopSDK::ReceiptStatus::OrSymbol),
|
|
285
310
|
substatus: WhopSDK::FriendlyReceiptStatus::OrSymbol,
|
|
286
311
|
subtotal: T.nilable(Float),
|
|
@@ -312,6 +337,9 @@ module WhopSDK
|
|
|
312
337
|
# The last four digits of the card used to make this payment. Null if the payment
|
|
313
338
|
# was not made with a card.
|
|
314
339
|
card_last4:,
|
|
340
|
+
# The ID of the checkout session/configuration that produced this payment, if any.
|
|
341
|
+
# Use this to map payments back to the checkout configuration that created them.
|
|
342
|
+
checkout_configuration_id:,
|
|
315
343
|
# The company for the payment.
|
|
316
344
|
company:,
|
|
317
345
|
# The datetime the payment was created.
|
|
@@ -373,6 +401,16 @@ module WhopSDK
|
|
|
373
401
|
# retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
|
|
374
402
|
# otherwise false. Used to decide if Whop can attempt the charge again.
|
|
375
403
|
retryable:,
|
|
404
|
+
# The payment amount in the creator's settlement currency (what the creator priced
|
|
405
|
+
# in). Equal to final_amount for single-currency payments.
|
|
406
|
+
settlement_amount:,
|
|
407
|
+
# The currency in which the creator receives payouts and fees are charged (e.g.,
|
|
408
|
+
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
409
|
+
# currency.
|
|
410
|
+
settlement_currency:,
|
|
411
|
+
# The locked exchange rate used to convert from the buyer's payment currency to
|
|
412
|
+
# the creator's settlement currency. Null for single-currency payments.
|
|
413
|
+
settlement_exchange_rate:,
|
|
376
414
|
# The status of a receipt
|
|
377
415
|
status:,
|
|
378
416
|
# The friendly status of the payment.
|
|
@@ -411,6 +449,7 @@ module WhopSDK
|
|
|
411
449
|
billing_reason: T.nilable(WhopSDK::BillingReasons::TaggedSymbol),
|
|
412
450
|
card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
|
|
413
451
|
card_last4: T.nilable(String),
|
|
452
|
+
checkout_configuration_id: T.nilable(String),
|
|
414
453
|
company: T.nilable(WhopSDK::Payment::Company),
|
|
415
454
|
created_at: Time,
|
|
416
455
|
currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
|
|
@@ -438,6 +477,9 @@ module WhopSDK
|
|
|
438
477
|
refunded_at: T.nilable(Time),
|
|
439
478
|
resolutions: T.nilable(T::Array[WhopSDK::Payment::Resolution]),
|
|
440
479
|
retryable: T::Boolean,
|
|
480
|
+
settlement_amount: Float,
|
|
481
|
+
settlement_currency: String,
|
|
482
|
+
settlement_exchange_rate: T.nilable(Float),
|
|
441
483
|
status: T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol),
|
|
442
484
|
substatus: WhopSDK::FriendlyReceiptStatus::TaggedSymbol,
|
|
443
485
|
subtotal: T.nilable(Float),
|
|
@@ -1191,15 +1233,27 @@ module WhopSDK
|
|
|
1191
1233
|
sig { returns(String) }
|
|
1192
1234
|
attr_accessor :id
|
|
1193
1235
|
|
|
1236
|
+
# A personal description or notes section for the business.
|
|
1237
|
+
sig { returns(T.nilable(String)) }
|
|
1238
|
+
attr_accessor :internal_notes
|
|
1239
|
+
|
|
1194
1240
|
# The plan attached to this payment.
|
|
1195
|
-
sig
|
|
1241
|
+
sig do
|
|
1242
|
+
params(id: String, internal_notes: T.nilable(String)).returns(
|
|
1243
|
+
T.attached_class
|
|
1244
|
+
)
|
|
1245
|
+
end
|
|
1196
1246
|
def self.new(
|
|
1197
1247
|
# The unique identifier for the plan.
|
|
1198
|
-
id
|
|
1248
|
+
id:,
|
|
1249
|
+
# A personal description or notes section for the business.
|
|
1250
|
+
internal_notes:
|
|
1199
1251
|
)
|
|
1200
1252
|
end
|
|
1201
1253
|
|
|
1202
|
-
sig
|
|
1254
|
+
sig do
|
|
1255
|
+
override.returns({ id: String, internal_notes: T.nilable(String) })
|
|
1256
|
+
end
|
|
1203
1257
|
def to_hash
|
|
1204
1258
|
end
|
|
1205
1259
|
end
|
|
@@ -68,6 +68,11 @@ module WhopSDK
|
|
|
68
68
|
sig { returns(T.nilable(String)) }
|
|
69
69
|
attr_accessor :card_last4
|
|
70
70
|
|
|
71
|
+
# The ID of the checkout session/configuration that produced this payment, if any.
|
|
72
|
+
# Use this to map payments back to the checkout configuration that created them.
|
|
73
|
+
sig { returns(T.nilable(String)) }
|
|
74
|
+
attr_accessor :checkout_configuration_id
|
|
75
|
+
|
|
71
76
|
# The company for the payment.
|
|
72
77
|
sig { returns(T.nilable(WhopSDK::Models::PaymentListResponse::Company)) }
|
|
73
78
|
attr_reader :company
|
|
@@ -221,6 +226,12 @@ module WhopSDK
|
|
|
221
226
|
sig { returns(T::Boolean) }
|
|
222
227
|
attr_accessor :retryable
|
|
223
228
|
|
|
229
|
+
# The currency in which the creator receives payouts and fees are charged (e.g.,
|
|
230
|
+
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
231
|
+
# currency.
|
|
232
|
+
sig { returns(String) }
|
|
233
|
+
attr_accessor :settlement_currency
|
|
234
|
+
|
|
224
235
|
# The status of a receipt
|
|
225
236
|
sig { returns(T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol)) }
|
|
226
237
|
attr_accessor :status
|
|
@@ -288,6 +299,7 @@ module WhopSDK
|
|
|
288
299
|
billing_reason: T.nilable(WhopSDK::BillingReasons::OrSymbol),
|
|
289
300
|
card_brand: T.nilable(WhopSDK::CardBrands::OrSymbol),
|
|
290
301
|
card_last4: T.nilable(String),
|
|
302
|
+
checkout_configuration_id: T.nilable(String),
|
|
291
303
|
company:
|
|
292
304
|
T.nilable(WhopSDK::Models::PaymentListResponse::Company::OrHash),
|
|
293
305
|
created_at: Time,
|
|
@@ -317,6 +329,7 @@ module WhopSDK
|
|
|
317
329
|
refunded_amount: T.nilable(Float),
|
|
318
330
|
refunded_at: T.nilable(Time),
|
|
319
331
|
retryable: T::Boolean,
|
|
332
|
+
settlement_currency: String,
|
|
320
333
|
status: T.nilable(WhopSDK::ReceiptStatus::OrSymbol),
|
|
321
334
|
substatus: WhopSDK::FriendlyReceiptStatus::OrSymbol,
|
|
322
335
|
subtotal: T.nilable(Float),
|
|
@@ -347,6 +360,9 @@ module WhopSDK
|
|
|
347
360
|
# The last four digits of the card used to make this payment. Null if the payment
|
|
348
361
|
# was not made with a card.
|
|
349
362
|
card_last4:,
|
|
363
|
+
# The ID of the checkout session/configuration that produced this payment, if any.
|
|
364
|
+
# Use this to map payments back to the checkout configuration that created them.
|
|
365
|
+
checkout_configuration_id:,
|
|
350
366
|
# The company for the payment.
|
|
351
367
|
company:,
|
|
352
368
|
# The datetime the payment was created.
|
|
@@ -395,6 +411,10 @@ module WhopSDK
|
|
|
395
411
|
# retry-eligible states (`active`, `trialing`, `completed`, or `past_due`);
|
|
396
412
|
# otherwise false. Used to decide if Whop can attempt the charge again.
|
|
397
413
|
retryable:,
|
|
414
|
+
# The currency in which the creator receives payouts and fees are charged (e.g.,
|
|
415
|
+
# 'usd', 'eur'). For multi-currency payments this differs from the payment
|
|
416
|
+
# currency.
|
|
417
|
+
settlement_currency:,
|
|
398
418
|
# The status of a receipt
|
|
399
419
|
status:,
|
|
400
420
|
# The friendly status of the payment.
|
|
@@ -433,6 +453,7 @@ module WhopSDK
|
|
|
433
453
|
billing_reason: T.nilable(WhopSDK::BillingReasons::TaggedSymbol),
|
|
434
454
|
card_brand: T.nilable(WhopSDK::CardBrands::TaggedSymbol),
|
|
435
455
|
card_last4: T.nilable(String),
|
|
456
|
+
checkout_configuration_id: T.nilable(String),
|
|
436
457
|
company: T.nilable(WhopSDK::Models::PaymentListResponse::Company),
|
|
437
458
|
created_at: Time,
|
|
438
459
|
currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
|
|
@@ -458,6 +479,7 @@ module WhopSDK
|
|
|
458
479
|
refunded_amount: T.nilable(Float),
|
|
459
480
|
refunded_at: T.nilable(Time),
|
|
460
481
|
retryable: T::Boolean,
|
|
482
|
+
settlement_currency: String,
|
|
461
483
|
status: T.nilable(WhopSDK::ReceiptStatus::TaggedSymbol),
|
|
462
484
|
substatus: WhopSDK::FriendlyReceiptStatus::TaggedSymbol,
|
|
463
485
|
subtotal: T.nilable(Float),
|
|
@@ -907,15 +929,27 @@ module WhopSDK
|
|
|
907
929
|
sig { returns(String) }
|
|
908
930
|
attr_accessor :id
|
|
909
931
|
|
|
932
|
+
# A personal description or notes section for the business.
|
|
933
|
+
sig { returns(T.nilable(String)) }
|
|
934
|
+
attr_accessor :internal_notes
|
|
935
|
+
|
|
910
936
|
# The plan attached to this payment.
|
|
911
|
-
sig
|
|
937
|
+
sig do
|
|
938
|
+
params(id: String, internal_notes: T.nilable(String)).returns(
|
|
939
|
+
T.attached_class
|
|
940
|
+
)
|
|
941
|
+
end
|
|
912
942
|
def self.new(
|
|
913
943
|
# The unique identifier for the plan.
|
|
914
|
-
id
|
|
944
|
+
id:,
|
|
945
|
+
# A personal description or notes section for the business.
|
|
946
|
+
internal_notes:
|
|
915
947
|
)
|
|
916
948
|
end
|
|
917
949
|
|
|
918
|
-
sig
|
|
950
|
+
sig do
|
|
951
|
+
override.returns({ id: String, internal_notes: T.nilable(String) })
|
|
952
|
+
end
|
|
919
953
|
def to_hash
|
|
920
954
|
end
|
|
921
955
|
end
|
|
@@ -18,6 +18,8 @@ module WhopSDK
|
|
|
18
18
|
AMAZON_PAY = T.let(:amazon_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
19
19
|
APPLE = T.let(:apple, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
20
20
|
APPLE_PAY = T.let(:apple_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
21
|
+
AU_BANK_TRANSFER =
|
|
22
|
+
T.let(:au_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
21
23
|
AU_BECS_DEBIT =
|
|
22
24
|
T.let(:au_becs_debit, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
23
25
|
BACS_DEBIT = T.let(:bacs_debit, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -28,9 +30,24 @@ module WhopSDK
|
|
|
28
30
|
BIZUM = T.let(:bizum, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
29
31
|
BLIK = T.let(:blik, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
30
32
|
BOLETO = T.let(:boleto, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
33
|
+
BRE_B = T.let(:bre_b, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
34
|
+
CA_BANK_TRANSFER =
|
|
35
|
+
T.let(:ca_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
31
36
|
CAPCHASE_PAY =
|
|
32
37
|
T.let(:capchase_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
33
38
|
CARD = T.let(:card, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
39
|
+
CARD_INSTALLMENTS_THREE =
|
|
40
|
+
T.let(
|
|
41
|
+
:card_installments_three,
|
|
42
|
+
WhopSDK::PaymentMethodTypes::TaggedSymbol
|
|
43
|
+
)
|
|
44
|
+
CARD_INSTALLMENTS_SIX =
|
|
45
|
+
T.let(:card_installments_six, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
46
|
+
CARD_INSTALLMENTS_TWELVE =
|
|
47
|
+
T.let(
|
|
48
|
+
:card_installments_twelve,
|
|
49
|
+
WhopSDK::PaymentMethodTypes::TaggedSymbol
|
|
50
|
+
)
|
|
34
51
|
CASHAPP = T.let(:cashapp, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
35
52
|
CLARITYPAY = T.let(:claritypay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
36
53
|
COINBASE = T.let(:coinbase, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -44,6 +61,8 @@ module WhopSDK
|
|
|
44
61
|
EU_BANK_TRANSFER =
|
|
45
62
|
T.let(:eu_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
46
63
|
FPX = T.let(:fpx, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
64
|
+
GB_BANK_TRANSFER =
|
|
65
|
+
T.let(:gb_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
47
66
|
GIROPAY = T.let(:giropay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
48
67
|
GOOGLE_PAY = T.let(:google_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
49
68
|
GOPAY = T.let(:gopay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -54,12 +73,16 @@ module WhopSDK
|
|
|
54
73
|
INTERAC = T.let(:interac, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
55
74
|
KAKAO_PAY = T.let(:kakao_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
56
75
|
KLARNA = T.let(:klarna, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
76
|
+
KLARNA_PAY_NOW =
|
|
77
|
+
T.let(:klarna_pay_now, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
57
78
|
KONBINI = T.let(:konbini, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
58
79
|
KR_CARD = T.let(:kr_card, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
59
80
|
KR_MARKET = T.let(:kr_market, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
60
81
|
KRIYA = T.let(:kriya, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
82
|
+
KUESKI = T.let(:kueski, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
61
83
|
LINK = T.let(:link, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
62
84
|
MB_WAY = T.let(:mb_way, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
85
|
+
M_PESA = T.let(:m_pesa, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
63
86
|
MERCADO_PAGO =
|
|
64
87
|
T.let(:mercado_pago, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
65
88
|
MOBILEPAY = T.let(:mobilepay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -79,6 +102,8 @@ module WhopSDK
|
|
|
79
102
|
T.let(:nz_bank_account, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
80
103
|
OXXO = T.let(:oxxo, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
81
104
|
P24 = T.let(:p24, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
105
|
+
PAGO_EFECTIVO =
|
|
106
|
+
T.let(:pago_efectivo, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
82
107
|
PSE = T.let(:pse, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
83
108
|
PAY_BY_BANK =
|
|
84
109
|
T.let(:pay_by_bank, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -99,8 +124,10 @@ module WhopSDK
|
|
|
99
124
|
T.let(:samsung_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
100
125
|
SATISPAY = T.let(:satispay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
101
126
|
SCALAPAY = T.let(:scalapay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
127
|
+
SENCILLITO = T.let(:sencillito, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
102
128
|
SEPA_DEBIT = T.let(:sepa_debit, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
103
129
|
SEQURA = T.let(:sequra, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
130
|
+
SERVIPAG = T.let(:servipag, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
104
131
|
SEZZLE = T.let(:sezzle, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
105
132
|
SHOP_PAY = T.let(:shop_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
106
133
|
SHOPEEPAY = T.let(:shopeepay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -116,9 +143,13 @@ module WhopSDK
|
|
|
116
143
|
UPI = T.let(:upi, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
117
144
|
US_BANK_ACCOUNT =
|
|
118
145
|
T.let(:us_bank_account, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
146
|
+
US_BANK_TRANSFER =
|
|
147
|
+
T.let(:us_bank_transfer, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
119
148
|
VENMO = T.let(:venmo, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
120
149
|
VIPPS = T.let(:vipps, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
150
|
+
WEBPAY = T.let(:webpay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
121
151
|
WECHAT_PAY = T.let(:wechat_pay, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
152
|
+
YAPE = T.let(:yape, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
122
153
|
ZIP = T.let(:zip, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
123
154
|
COINFLOW = T.let(:coinflow, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
124
155
|
UNKNOWN = T.let(:unknown, WhopSDK::PaymentMethodTypes::TaggedSymbol)
|
|
@@ -14,8 +14,9 @@ module WhopSDK
|
|
|
14
14
|
sig { returns(String) }
|
|
15
15
|
attr_accessor :id
|
|
16
16
|
|
|
17
|
-
# The amount to refund
|
|
18
|
-
#
|
|
17
|
+
# The amount to refund. For multi-currency payments, this is in the charge
|
|
18
|
+
# currency (what the buyer paid). For single-currency, this is in the payment
|
|
19
|
+
# currency. If omitted, the full payment amount is refunded.
|
|
19
20
|
sig { returns(T.nilable(Float)) }
|
|
20
21
|
attr_accessor :partial_amount
|
|
21
22
|
|
|
@@ -28,8 +29,9 @@ module WhopSDK
|
|
|
28
29
|
end
|
|
29
30
|
def self.new(
|
|
30
31
|
id:,
|
|
31
|
-
# The amount to refund
|
|
32
|
-
#
|
|
32
|
+
# The amount to refund. For multi-currency payments, this is in the charge
|
|
33
|
+
# currency (what the buyer paid). For single-currency, this is in the payment
|
|
34
|
+
# currency. If omitted, the full payment amount is refunded.
|
|
33
35
|
partial_amount: nil,
|
|
34
36
|
request_options: {}
|
|
35
37
|
)
|
|
@@ -311,7 +311,7 @@ module WhopSDK
|
|
|
311
311
|
)
|
|
312
312
|
end
|
|
313
313
|
|
|
314
|
-
# The
|
|
314
|
+
# The numeric id of the verification record.
|
|
315
315
|
sig { returns(String) }
|
|
316
316
|
attr_accessor :id
|
|
317
317
|
|
|
@@ -339,7 +339,7 @@ module WhopSDK
|
|
|
339
339
|
).returns(T.attached_class)
|
|
340
340
|
end
|
|
341
341
|
def self.new(
|
|
342
|
-
# The
|
|
342
|
+
# The numeric id of the verification record.
|
|
343
343
|
id:,
|
|
344
344
|
# An error code for a verification attempt.
|
|
345
345
|
last_error_code:,
|
|
@@ -397,7 +397,7 @@ module WhopSDK
|
|
|
397
397
|
)
|
|
398
398
|
end
|
|
399
399
|
|
|
400
|
-
# The
|
|
400
|
+
# The numeric id of the verification record.
|
|
401
401
|
sig { returns(String) }
|
|
402
402
|
attr_accessor :id
|
|
403
403
|
|
|
@@ -427,7 +427,7 @@ module WhopSDK
|
|
|
427
427
|
).returns(T.attached_class)
|
|
428
428
|
end
|
|
429
429
|
def self.new(
|
|
430
|
-
# The
|
|
430
|
+
# The numeric id of the verification record.
|
|
431
431
|
id:,
|
|
432
432
|
# An error code for a verification attempt.
|
|
433
433
|
last_error_code:,
|
|
@@ -9,6 +9,11 @@ module WhopSDK
|
|
|
9
9
|
sig { returns(String) }
|
|
10
10
|
attr_accessor :id
|
|
11
11
|
|
|
12
|
+
# Whether the creator has turned on adaptive pricing for this plan. Raw setting —
|
|
13
|
+
# does not check processor compatibility or feature flags.
|
|
14
|
+
sig { returns(T::Boolean) }
|
|
15
|
+
attr_accessor :adaptive_pricing_enabled
|
|
16
|
+
|
|
12
17
|
# The number of days between each recurring charge. Null for one-time plans. For
|
|
13
18
|
# example, 30 for monthly or 365 for annual billing.
|
|
14
19
|
sig { returns(T.nilable(Integer)) }
|
|
@@ -41,7 +46,7 @@ module WhopSDK
|
|
|
41
46
|
sig { returns(T::Array[WhopSDK::Plan::CustomField]) }
|
|
42
47
|
attr_accessor :custom_fields
|
|
43
48
|
|
|
44
|
-
# A text description of the plan visible to customers. Maximum
|
|
49
|
+
# A text description of the plan visible to customers. Maximum 1000 characters.
|
|
45
50
|
# Null if no description is set.
|
|
46
51
|
sig { returns(T.nilable(String)) }
|
|
47
52
|
attr_accessor :description
|
|
@@ -162,6 +167,7 @@ module WhopSDK
|
|
|
162
167
|
sig do
|
|
163
168
|
params(
|
|
164
169
|
id: String,
|
|
170
|
+
adaptive_pricing_enabled: T::Boolean,
|
|
165
171
|
billing_period: T.nilable(Integer),
|
|
166
172
|
collect_tax: T::Boolean,
|
|
167
173
|
company: T.nilable(WhopSDK::Plan::Company::OrHash),
|
|
@@ -194,6 +200,9 @@ module WhopSDK
|
|
|
194
200
|
def self.new(
|
|
195
201
|
# The unique identifier for the plan.
|
|
196
202
|
id:,
|
|
203
|
+
# Whether the creator has turned on adaptive pricing for this plan. Raw setting —
|
|
204
|
+
# does not check processor compatibility or feature flags.
|
|
205
|
+
adaptive_pricing_enabled:,
|
|
197
206
|
# The number of days between each recurring charge. Null for one-time plans. For
|
|
198
207
|
# example, 30 for monthly or 365 for annual billing.
|
|
199
208
|
billing_period:,
|
|
@@ -211,7 +220,7 @@ module WhopSDK
|
|
|
211
220
|
# Custom input fields displayed on the checkout form that collect additional
|
|
212
221
|
# information from the buyer.
|
|
213
222
|
custom_fields:,
|
|
214
|
-
# A text description of the plan visible to customers. Maximum
|
|
223
|
+
# A text description of the plan visible to customers. Maximum 1000 characters.
|
|
215
224
|
# Null if no description is set.
|
|
216
225
|
description:,
|
|
217
226
|
# The number of days until the membership expires (for expiration-based plans).
|
|
@@ -279,6 +288,7 @@ module WhopSDK
|
|
|
279
288
|
override.returns(
|
|
280
289
|
{
|
|
281
290
|
id: String,
|
|
291
|
+
adaptive_pricing_enabled: T::Boolean,
|
|
282
292
|
billing_period: T.nilable(Integer),
|
|
283
293
|
collect_tax: T::Boolean,
|
|
284
294
|
company: T.nilable(WhopSDK::Plan::Company),
|
|
@@ -19,6 +19,10 @@ module WhopSDK
|
|
|
19
19
|
sig { returns(String) }
|
|
20
20
|
attr_accessor :product_id
|
|
21
21
|
|
|
22
|
+
# Whether this plan accepts local currency payments via adaptive pricing.
|
|
23
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
24
|
+
attr_accessor :adaptive_pricing_enabled
|
|
25
|
+
|
|
22
26
|
# The number of days between recurring charges. For example, 30 for monthly or 365
|
|
23
27
|
# for yearly.
|
|
24
28
|
sig { returns(T.nilable(Integer)) }
|
|
@@ -146,6 +150,7 @@ module WhopSDK
|
|
|
146
150
|
params(
|
|
147
151
|
company_id: String,
|
|
148
152
|
product_id: String,
|
|
153
|
+
adaptive_pricing_enabled: T.nilable(T::Boolean),
|
|
149
154
|
billing_period: T.nilable(Integer),
|
|
150
155
|
checkout_styling:
|
|
151
156
|
T.nilable(WhopSDK::PlanCreateParams::CheckoutStyling::OrHash),
|
|
@@ -180,6 +185,8 @@ module WhopSDK
|
|
|
180
185
|
company_id:,
|
|
181
186
|
# The unique identifier of the product to attach this plan to.
|
|
182
187
|
product_id:,
|
|
188
|
+
# Whether this plan accepts local currency payments via adaptive pricing.
|
|
189
|
+
adaptive_pricing_enabled: nil,
|
|
183
190
|
# The number of days between recurring charges. For example, 30 for monthly or 365
|
|
184
191
|
# for yearly.
|
|
185
192
|
billing_period: nil,
|
|
@@ -241,6 +248,7 @@ module WhopSDK
|
|
|
241
248
|
{
|
|
242
249
|
company_id: String,
|
|
243
250
|
product_id: String,
|
|
251
|
+
adaptive_pricing_enabled: T.nilable(T::Boolean),
|
|
244
252
|
billing_period: T.nilable(Integer),
|
|
245
253
|
checkout_styling:
|
|
246
254
|
T.nilable(WhopSDK::PlanCreateParams::CheckoutStyling),
|
|
@@ -281,6 +289,11 @@ module WhopSDK
|
|
|
281
289
|
)
|
|
282
290
|
end
|
|
283
291
|
|
|
292
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
293
|
+
# panel (e.g. #F4F4F5).
|
|
294
|
+
sig { returns(T.nilable(String)) }
|
|
295
|
+
attr_accessor :background_color
|
|
296
|
+
|
|
284
297
|
# The different border-radius styles available for checkout pages.
|
|
285
298
|
sig { returns(T.nilable(WhopSDK::CheckoutShape::OrSymbol)) }
|
|
286
299
|
attr_accessor :border_style
|
|
@@ -297,12 +310,16 @@ module WhopSDK
|
|
|
297
310
|
# default.
|
|
298
311
|
sig do
|
|
299
312
|
params(
|
|
313
|
+
background_color: T.nilable(String),
|
|
300
314
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
301
315
|
button_color: T.nilable(String),
|
|
302
316
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
303
317
|
).returns(T.attached_class)
|
|
304
318
|
end
|
|
305
319
|
def self.new(
|
|
320
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
321
|
+
# panel (e.g. #F4F4F5).
|
|
322
|
+
background_color: nil,
|
|
306
323
|
# The different border-radius styles available for checkout pages.
|
|
307
324
|
border_style: nil,
|
|
308
325
|
# A hex color code for the button color (e.g. #FF5733).
|
|
@@ -315,6 +332,7 @@ module WhopSDK
|
|
|
315
332
|
sig do
|
|
316
333
|
override.returns(
|
|
317
334
|
{
|
|
335
|
+
background_color: T.nilable(String),
|
|
318
336
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
319
337
|
button_color: T.nilable(String),
|
|
320
338
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
@@ -447,7 +465,7 @@ module WhopSDK
|
|
|
447
465
|
# Whether Whop's platform default payment method enablement settings are included
|
|
448
466
|
# in this configuration. The full list of default payment methods can be found in
|
|
449
467
|
# the documentation at docs.whop.com/payments.
|
|
450
|
-
sig { returns(T::Boolean) }
|
|
468
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
451
469
|
attr_accessor :include_platform_defaults
|
|
452
470
|
|
|
453
471
|
# Explicit payment method configuration for the plan. When not provided, the
|
|
@@ -456,7 +474,7 @@ module WhopSDK
|
|
|
456
474
|
params(
|
|
457
475
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
458
476
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
459
|
-
include_platform_defaults: T::Boolean
|
|
477
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
460
478
|
).returns(T.attached_class)
|
|
461
479
|
end
|
|
462
480
|
def self.new(
|
|
@@ -471,7 +489,7 @@ module WhopSDK
|
|
|
471
489
|
# Whether Whop's platform default payment method enablement settings are included
|
|
472
490
|
# in this configuration. The full list of default payment methods can be found in
|
|
473
491
|
# the documentation at docs.whop.com/payments.
|
|
474
|
-
include_platform_defaults:
|
|
492
|
+
include_platform_defaults: nil
|
|
475
493
|
)
|
|
476
494
|
end
|
|
477
495
|
|
|
@@ -480,7 +498,7 @@ module WhopSDK
|
|
|
480
498
|
{
|
|
481
499
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
482
500
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
483
|
-
include_platform_defaults: T::Boolean
|
|
501
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
484
502
|
}
|
|
485
503
|
)
|
|
486
504
|
end
|