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
|
@@ -102,6 +102,11 @@ module WhopSDK
|
|
|
102
102
|
sig { returns(T.nilable(String)) }
|
|
103
103
|
attr_accessor :affiliate_code
|
|
104
104
|
|
|
105
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
106
|
+
# codes. Defaults to true.
|
|
107
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
108
|
+
attr_accessor :allow_promo_codes
|
|
109
|
+
|
|
105
110
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
106
111
|
# defaults.
|
|
107
112
|
sig do
|
|
@@ -183,6 +188,7 @@ module WhopSDK
|
|
|
183
188
|
plan:
|
|
184
189
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::OrHash,
|
|
185
190
|
affiliate_code: T.nilable(String),
|
|
191
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
186
192
|
checkout_styling:
|
|
187
193
|
T.nilable(
|
|
188
194
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling::OrHash
|
|
@@ -204,6 +210,9 @@ module WhopSDK
|
|
|
204
210
|
plan:,
|
|
205
211
|
# An affiliate tracking code to attribute the checkout to a specific affiliate.
|
|
206
212
|
affiliate_code: nil,
|
|
213
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
214
|
+
# codes. Defaults to true.
|
|
215
|
+
allow_promo_codes: nil,
|
|
207
216
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
208
217
|
# defaults.
|
|
209
218
|
checkout_styling: nil,
|
|
@@ -228,6 +237,7 @@ module WhopSDK
|
|
|
228
237
|
plan:
|
|
229
238
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan,
|
|
230
239
|
affiliate_code: T.nilable(String),
|
|
240
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
231
241
|
checkout_styling:
|
|
232
242
|
T.nilable(
|
|
233
243
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling
|
|
@@ -265,6 +275,10 @@ module WhopSDK
|
|
|
265
275
|
sig { returns(WhopSDK::Currency::OrSymbol) }
|
|
266
276
|
attr_accessor :currency
|
|
267
277
|
|
|
278
|
+
# Whether this plan accepts local currency payments via adaptive pricing.
|
|
279
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
280
|
+
attr_accessor :adaptive_pricing_enabled
|
|
281
|
+
|
|
268
282
|
# The application fee amount collected by the platform from this connected
|
|
269
283
|
# account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
|
|
270
284
|
# than the total payment amount. Only valid for connected accounts with a parent
|
|
@@ -421,6 +435,7 @@ module WhopSDK
|
|
|
421
435
|
params(
|
|
422
436
|
company_id: String,
|
|
423
437
|
currency: WhopSDK::Currency::OrSymbol,
|
|
438
|
+
adaptive_pricing_enabled: T.nilable(T::Boolean),
|
|
424
439
|
application_fee_amount: T.nilable(Float),
|
|
425
440
|
billing_period: T.nilable(Integer),
|
|
426
441
|
custom_fields:
|
|
@@ -463,6 +478,8 @@ module WhopSDK
|
|
|
463
478
|
company_id:,
|
|
464
479
|
# The respective currency identifier for the plan.
|
|
465
480
|
currency:,
|
|
481
|
+
# Whether this plan accepts local currency payments via adaptive pricing.
|
|
482
|
+
adaptive_pricing_enabled: nil,
|
|
466
483
|
# The application fee amount collected by the platform from this connected
|
|
467
484
|
# account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
|
|
468
485
|
# than the total payment amount. Only valid for connected accounts with a parent
|
|
@@ -524,6 +541,7 @@ module WhopSDK
|
|
|
524
541
|
{
|
|
525
542
|
company_id: String,
|
|
526
543
|
currency: WhopSDK::Currency::OrSymbol,
|
|
544
|
+
adaptive_pricing_enabled: T.nilable(T::Boolean),
|
|
527
545
|
application_fee_amount: T.nilable(Float),
|
|
528
546
|
billing_period: T.nilable(Integer),
|
|
529
547
|
custom_fields:
|
|
@@ -690,7 +708,7 @@ module WhopSDK
|
|
|
690
708
|
# Whether Whop's platform default payment method enablement settings are included
|
|
691
709
|
# in this configuration. The full list of default payment methods can be found in
|
|
692
710
|
# the documentation at docs.whop.com/payments.
|
|
693
|
-
sig { returns(T::Boolean) }
|
|
711
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
694
712
|
attr_accessor :include_platform_defaults
|
|
695
713
|
|
|
696
714
|
# The explicit payment method configuration for the plan. If not provided, the
|
|
@@ -699,7 +717,7 @@ module WhopSDK
|
|
|
699
717
|
params(
|
|
700
718
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
701
719
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
702
|
-
include_platform_defaults: T::Boolean
|
|
720
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
703
721
|
).returns(T.attached_class)
|
|
704
722
|
end
|
|
705
723
|
def self.new(
|
|
@@ -714,7 +732,7 @@ module WhopSDK
|
|
|
714
732
|
# Whether Whop's platform default payment method enablement settings are included
|
|
715
733
|
# in this configuration. The full list of default payment methods can be found in
|
|
716
734
|
# the documentation at docs.whop.com/payments.
|
|
717
|
-
include_platform_defaults:
|
|
735
|
+
include_platform_defaults: nil
|
|
718
736
|
)
|
|
719
737
|
end
|
|
720
738
|
|
|
@@ -723,7 +741,7 @@ module WhopSDK
|
|
|
723
741
|
{
|
|
724
742
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
725
743
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
726
|
-
include_platform_defaults: T::Boolean
|
|
744
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
727
745
|
}
|
|
728
746
|
)
|
|
729
747
|
end
|
|
@@ -878,6 +896,11 @@ module WhopSDK
|
|
|
878
896
|
)
|
|
879
897
|
end
|
|
880
898
|
|
|
899
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
900
|
+
# panel (e.g. #F4F4F5).
|
|
901
|
+
sig { returns(T.nilable(String)) }
|
|
902
|
+
attr_accessor :background_color
|
|
903
|
+
|
|
881
904
|
# The different border-radius styles available for checkout pages.
|
|
882
905
|
sig { returns(T.nilable(WhopSDK::CheckoutShape::OrSymbol)) }
|
|
883
906
|
attr_accessor :border_style
|
|
@@ -894,12 +917,16 @@ module WhopSDK
|
|
|
894
917
|
# defaults.
|
|
895
918
|
sig do
|
|
896
919
|
params(
|
|
920
|
+
background_color: T.nilable(String),
|
|
897
921
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
898
922
|
button_color: T.nilable(String),
|
|
899
923
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
900
924
|
).returns(T.attached_class)
|
|
901
925
|
end
|
|
902
926
|
def self.new(
|
|
927
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
928
|
+
# panel (e.g. #F4F4F5).
|
|
929
|
+
background_color: nil,
|
|
903
930
|
# The different border-radius styles available for checkout pages.
|
|
904
931
|
border_style: nil,
|
|
905
932
|
# A hex color code for the button color (e.g. #FF5733).
|
|
@@ -912,6 +939,7 @@ module WhopSDK
|
|
|
912
939
|
sig do
|
|
913
940
|
override.returns(
|
|
914
941
|
{
|
|
942
|
+
background_color: T.nilable(String),
|
|
915
943
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
916
944
|
button_color: T.nilable(String),
|
|
917
945
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
@@ -975,7 +1003,7 @@ module WhopSDK
|
|
|
975
1003
|
# Whether Whop's platform default payment method enablement settings are included
|
|
976
1004
|
# in this configuration. The full list of default payment methods can be found in
|
|
977
1005
|
# the documentation at docs.whop.com/payments.
|
|
978
|
-
sig { returns(T::Boolean) }
|
|
1006
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
979
1007
|
attr_accessor :include_platform_defaults
|
|
980
1008
|
|
|
981
1009
|
# The explicit payment method configuration for the checkout session. Only applies
|
|
@@ -984,7 +1012,7 @@ module WhopSDK
|
|
|
984
1012
|
params(
|
|
985
1013
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
986
1014
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
987
|
-
include_platform_defaults: T::Boolean
|
|
1015
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
988
1016
|
).returns(T.attached_class)
|
|
989
1017
|
end
|
|
990
1018
|
def self.new(
|
|
@@ -999,7 +1027,7 @@ module WhopSDK
|
|
|
999
1027
|
# Whether Whop's platform default payment method enablement settings are included
|
|
1000
1028
|
# in this configuration. The full list of default payment methods can be found in
|
|
1001
1029
|
# the documentation at docs.whop.com/payments.
|
|
1002
|
-
include_platform_defaults:
|
|
1030
|
+
include_platform_defaults: nil
|
|
1003
1031
|
)
|
|
1004
1032
|
end
|
|
1005
1033
|
|
|
@@ -1008,7 +1036,7 @@ module WhopSDK
|
|
|
1008
1036
|
{
|
|
1009
1037
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1010
1038
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1011
|
-
include_platform_defaults: T::Boolean
|
|
1039
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
1012
1040
|
}
|
|
1013
1041
|
)
|
|
1014
1042
|
end
|
|
@@ -1035,6 +1063,11 @@ module WhopSDK
|
|
|
1035
1063
|
sig { returns(T.nilable(String)) }
|
|
1036
1064
|
attr_accessor :affiliate_code
|
|
1037
1065
|
|
|
1066
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
1067
|
+
# codes. Defaults to true.
|
|
1068
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
1069
|
+
attr_accessor :allow_promo_codes
|
|
1070
|
+
|
|
1038
1071
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
1039
1072
|
# defaults.
|
|
1040
1073
|
sig do
|
|
@@ -1115,6 +1148,7 @@ module WhopSDK
|
|
|
1115
1148
|
params(
|
|
1116
1149
|
plan_id: String,
|
|
1117
1150
|
affiliate_code: T.nilable(String),
|
|
1151
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
1118
1152
|
checkout_styling:
|
|
1119
1153
|
T.nilable(
|
|
1120
1154
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling::OrHash
|
|
@@ -1137,6 +1171,9 @@ module WhopSDK
|
|
|
1137
1171
|
plan_id:,
|
|
1138
1172
|
# An affiliate tracking code to attribute the checkout to a specific affiliate.
|
|
1139
1173
|
affiliate_code: nil,
|
|
1174
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
1175
|
+
# codes. Defaults to true.
|
|
1176
|
+
allow_promo_codes: nil,
|
|
1140
1177
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
1141
1178
|
# defaults.
|
|
1142
1179
|
checkout_styling: nil,
|
|
@@ -1160,6 +1197,7 @@ module WhopSDK
|
|
|
1160
1197
|
{
|
|
1161
1198
|
plan_id: String,
|
|
1162
1199
|
affiliate_code: T.nilable(String),
|
|
1200
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
1163
1201
|
checkout_styling:
|
|
1164
1202
|
T.nilable(
|
|
1165
1203
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling
|
|
@@ -1189,6 +1227,11 @@ module WhopSDK
|
|
|
1189
1227
|
)
|
|
1190
1228
|
end
|
|
1191
1229
|
|
|
1230
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
1231
|
+
# panel (e.g. #F4F4F5).
|
|
1232
|
+
sig { returns(T.nilable(String)) }
|
|
1233
|
+
attr_accessor :background_color
|
|
1234
|
+
|
|
1192
1235
|
# The different border-radius styles available for checkout pages.
|
|
1193
1236
|
sig { returns(T.nilable(WhopSDK::CheckoutShape::OrSymbol)) }
|
|
1194
1237
|
attr_accessor :border_style
|
|
@@ -1205,12 +1248,16 @@ module WhopSDK
|
|
|
1205
1248
|
# defaults.
|
|
1206
1249
|
sig do
|
|
1207
1250
|
params(
|
|
1251
|
+
background_color: T.nilable(String),
|
|
1208
1252
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
1209
1253
|
button_color: T.nilable(String),
|
|
1210
1254
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
1211
1255
|
).returns(T.attached_class)
|
|
1212
1256
|
end
|
|
1213
1257
|
def self.new(
|
|
1258
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
1259
|
+
# panel (e.g. #F4F4F5).
|
|
1260
|
+
background_color: nil,
|
|
1214
1261
|
# The different border-radius styles available for checkout pages.
|
|
1215
1262
|
border_style: nil,
|
|
1216
1263
|
# A hex color code for the button color (e.g. #FF5733).
|
|
@@ -1223,6 +1270,7 @@ module WhopSDK
|
|
|
1223
1270
|
sig do
|
|
1224
1271
|
override.returns(
|
|
1225
1272
|
{
|
|
1273
|
+
background_color: T.nilable(String),
|
|
1226
1274
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
1227
1275
|
button_color: T.nilable(String),
|
|
1228
1276
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
@@ -1286,7 +1334,7 @@ module WhopSDK
|
|
|
1286
1334
|
# Whether Whop's platform default payment method enablement settings are included
|
|
1287
1335
|
# in this configuration. The full list of default payment methods can be found in
|
|
1288
1336
|
# the documentation at docs.whop.com/payments.
|
|
1289
|
-
sig { returns(T::Boolean) }
|
|
1337
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
1290
1338
|
attr_accessor :include_platform_defaults
|
|
1291
1339
|
|
|
1292
1340
|
# The explicit payment method configuration for the checkout session. Only applies
|
|
@@ -1295,7 +1343,7 @@ module WhopSDK
|
|
|
1295
1343
|
params(
|
|
1296
1344
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1297
1345
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1298
|
-
include_platform_defaults: T::Boolean
|
|
1346
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
1299
1347
|
).returns(T.attached_class)
|
|
1300
1348
|
end
|
|
1301
1349
|
def self.new(
|
|
@@ -1310,7 +1358,7 @@ module WhopSDK
|
|
|
1310
1358
|
# Whether Whop's platform default payment method enablement settings are included
|
|
1311
1359
|
# in this configuration. The full list of default payment methods can be found in
|
|
1312
1360
|
# the documentation at docs.whop.com/payments.
|
|
1313
|
-
include_platform_defaults:
|
|
1361
|
+
include_platform_defaults: nil
|
|
1314
1362
|
)
|
|
1315
1363
|
end
|
|
1316
1364
|
|
|
@@ -1319,7 +1367,7 @@ module WhopSDK
|
|
|
1319
1367
|
{
|
|
1320
1368
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1321
1369
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1322
|
-
include_platform_defaults: T::Boolean
|
|
1370
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
1323
1371
|
}
|
|
1324
1372
|
)
|
|
1325
1373
|
end
|
|
@@ -1345,6 +1393,11 @@ module WhopSDK
|
|
|
1345
1393
|
sig { returns(Symbol) }
|
|
1346
1394
|
attr_accessor :mode
|
|
1347
1395
|
|
|
1396
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
1397
|
+
# codes. Defaults to true.
|
|
1398
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
1399
|
+
attr_accessor :allow_promo_codes
|
|
1400
|
+
|
|
1348
1401
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
1349
1402
|
# defaults.
|
|
1350
1403
|
sig do
|
|
@@ -1407,6 +1460,7 @@ module WhopSDK
|
|
|
1407
1460
|
sig do
|
|
1408
1461
|
params(
|
|
1409
1462
|
company_id: String,
|
|
1463
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
1410
1464
|
checkout_styling:
|
|
1411
1465
|
T.nilable(
|
|
1412
1466
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling::OrHash
|
|
@@ -1426,6 +1480,9 @@ module WhopSDK
|
|
|
1426
1480
|
# The unique identifier of the company to create the checkout configuration for.
|
|
1427
1481
|
# Only required in setup mode.
|
|
1428
1482
|
company_id:,
|
|
1483
|
+
# Whether the checkout should show the promo code input field and accept promo
|
|
1484
|
+
# codes. Defaults to true.
|
|
1485
|
+
allow_promo_codes: nil,
|
|
1429
1486
|
# Checkout styling overrides for this session. Overrides plan and company
|
|
1430
1487
|
# defaults.
|
|
1431
1488
|
checkout_styling: nil,
|
|
@@ -1449,6 +1506,7 @@ module WhopSDK
|
|
|
1449
1506
|
{
|
|
1450
1507
|
company_id: String,
|
|
1451
1508
|
mode: Symbol,
|
|
1509
|
+
allow_promo_codes: T.nilable(T::Boolean),
|
|
1452
1510
|
checkout_styling:
|
|
1453
1511
|
T.nilable(
|
|
1454
1512
|
WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling
|
|
@@ -1476,6 +1534,11 @@ module WhopSDK
|
|
|
1476
1534
|
)
|
|
1477
1535
|
end
|
|
1478
1536
|
|
|
1537
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
1538
|
+
# panel (e.g. #F4F4F5).
|
|
1539
|
+
sig { returns(T.nilable(String)) }
|
|
1540
|
+
attr_accessor :background_color
|
|
1541
|
+
|
|
1479
1542
|
# The different border-radius styles available for checkout pages.
|
|
1480
1543
|
sig { returns(T.nilable(WhopSDK::CheckoutShape::OrSymbol)) }
|
|
1481
1544
|
attr_accessor :border_style
|
|
@@ -1492,12 +1555,16 @@ module WhopSDK
|
|
|
1492
1555
|
# defaults.
|
|
1493
1556
|
sig do
|
|
1494
1557
|
params(
|
|
1558
|
+
background_color: T.nilable(String),
|
|
1495
1559
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
1496
1560
|
button_color: T.nilable(String),
|
|
1497
1561
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
1498
1562
|
).returns(T.attached_class)
|
|
1499
1563
|
end
|
|
1500
1564
|
def self.new(
|
|
1565
|
+
# A hex color code for the checkout page background, applied to the order summary
|
|
1566
|
+
# panel (e.g. #F4F4F5).
|
|
1567
|
+
background_color: nil,
|
|
1501
1568
|
# The different border-radius styles available for checkout pages.
|
|
1502
1569
|
border_style: nil,
|
|
1503
1570
|
# A hex color code for the button color (e.g. #FF5733).
|
|
@@ -1510,6 +1577,7 @@ module WhopSDK
|
|
|
1510
1577
|
sig do
|
|
1511
1578
|
override.returns(
|
|
1512
1579
|
{
|
|
1580
|
+
background_color: T.nilable(String),
|
|
1513
1581
|
border_style: T.nilable(WhopSDK::CheckoutShape::OrSymbol),
|
|
1514
1582
|
button_color: T.nilable(String),
|
|
1515
1583
|
font_family: T.nilable(WhopSDK::CheckoutFont::OrSymbol)
|
|
@@ -1544,7 +1612,7 @@ module WhopSDK
|
|
|
1544
1612
|
# Whether Whop's platform default payment method enablement settings are included
|
|
1545
1613
|
# in this configuration. The full list of default payment methods can be found in
|
|
1546
1614
|
# the documentation at docs.whop.com/payments.
|
|
1547
|
-
sig { returns(T::Boolean) }
|
|
1615
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
1548
1616
|
attr_accessor :include_platform_defaults
|
|
1549
1617
|
|
|
1550
1618
|
# The explicit payment method configuration for the checkout session. Only applies
|
|
@@ -1553,7 +1621,7 @@ module WhopSDK
|
|
|
1553
1621
|
params(
|
|
1554
1622
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1555
1623
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1556
|
-
include_platform_defaults: T::Boolean
|
|
1624
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
1557
1625
|
).returns(T.attached_class)
|
|
1558
1626
|
end
|
|
1559
1627
|
def self.new(
|
|
@@ -1568,7 +1636,7 @@ module WhopSDK
|
|
|
1568
1636
|
# Whether Whop's platform default payment method enablement settings are included
|
|
1569
1637
|
# in this configuration. The full list of default payment methods can be found in
|
|
1570
1638
|
# the documentation at docs.whop.com/payments.
|
|
1571
|
-
include_platform_defaults:
|
|
1639
|
+
include_platform_defaults: nil
|
|
1572
1640
|
)
|
|
1573
1641
|
end
|
|
1574
1642
|
|
|
@@ -1577,7 +1645,7 @@ module WhopSDK
|
|
|
1577
1645
|
{
|
|
1578
1646
|
disabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1579
1647
|
enabled: T::Array[WhopSDK::PaymentMethodTypes::OrSymbol],
|
|
1580
|
-
include_platform_defaults: T::Boolean
|
|
1648
|
+
include_platform_defaults: T.nilable(T::Boolean)
|
|
1581
1649
|
}
|
|
1582
1650
|
)
|
|
1583
1651
|
end
|
|
@@ -19,6 +19,11 @@ module WhopSDK
|
|
|
19
19
|
sig { returns(T.nilable(String)) }
|
|
20
20
|
attr_accessor :affiliate_code
|
|
21
21
|
|
|
22
|
+
# Whether the checkout configuration allows promo codes. When false, the promo
|
|
23
|
+
# code input is hidden and promo codes are rejected.
|
|
24
|
+
sig { returns(T::Boolean) }
|
|
25
|
+
attr_accessor :allow_promo_codes
|
|
26
|
+
|
|
22
27
|
# The ID of the company to use for the checkout configuration
|
|
23
28
|
sig { returns(String) }
|
|
24
29
|
attr_accessor :company_id
|
|
@@ -91,6 +96,7 @@ module WhopSDK
|
|
|
91
96
|
params(
|
|
92
97
|
id: String,
|
|
93
98
|
affiliate_code: T.nilable(String),
|
|
99
|
+
allow_promo_codes: T::Boolean,
|
|
94
100
|
company_id: String,
|
|
95
101
|
currency: T.nilable(WhopSDK::Currency::OrSymbol),
|
|
96
102
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
@@ -112,6 +118,9 @@ module WhopSDK
|
|
|
112
118
|
id:,
|
|
113
119
|
# The affiliate code to use for the checkout configuration
|
|
114
120
|
affiliate_code:,
|
|
121
|
+
# Whether the checkout configuration allows promo codes. When false, the promo
|
|
122
|
+
# code input is hidden and promo codes are rejected.
|
|
123
|
+
allow_promo_codes:,
|
|
115
124
|
# The ID of the company to use for the checkout configuration
|
|
116
125
|
company_id:,
|
|
117
126
|
# The available currencies on the platform
|
|
@@ -139,6 +148,7 @@ module WhopSDK
|
|
|
139
148
|
{
|
|
140
149
|
id: String,
|
|
141
150
|
affiliate_code: T.nilable(String),
|
|
151
|
+
allow_promo_codes: T::Boolean,
|
|
142
152
|
company_id: String,
|
|
143
153
|
currency: T.nilable(WhopSDK::Currency::TaggedSymbol),
|
|
144
154
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
@@ -238,6 +248,11 @@ module WhopSDK
|
|
|
238
248
|
sig { returns(String) }
|
|
239
249
|
attr_accessor :id
|
|
240
250
|
|
|
251
|
+
# Whether the creator has turned on adaptive pricing for this plan. Raw setting —
|
|
252
|
+
# does not check processor compatibility or feature flags.
|
|
253
|
+
sig { returns(T::Boolean) }
|
|
254
|
+
attr_accessor :adaptive_pricing_enabled
|
|
255
|
+
|
|
241
256
|
# The number of days between each recurring charge. Null for one-time plans. For
|
|
242
257
|
# example, 30 for monthly or 365 for annual billing.
|
|
243
258
|
sig { returns(T.nilable(Integer)) }
|
|
@@ -289,6 +304,7 @@ module WhopSDK
|
|
|
289
304
|
sig do
|
|
290
305
|
params(
|
|
291
306
|
id: String,
|
|
307
|
+
adaptive_pricing_enabled: T::Boolean,
|
|
292
308
|
billing_period: T.nilable(Integer),
|
|
293
309
|
currency: WhopSDK::Currency::OrSymbol,
|
|
294
310
|
expiration_days: T.nilable(Integer),
|
|
@@ -303,6 +319,9 @@ module WhopSDK
|
|
|
303
319
|
def self.new(
|
|
304
320
|
# The unique identifier for the plan.
|
|
305
321
|
id:,
|
|
322
|
+
# Whether the creator has turned on adaptive pricing for this plan. Raw setting —
|
|
323
|
+
# does not check processor compatibility or feature flags.
|
|
324
|
+
adaptive_pricing_enabled:,
|
|
306
325
|
# The number of days between each recurring charge. Null for one-time plans. For
|
|
307
326
|
# example, 30 for monthly or 365 for annual billing.
|
|
308
327
|
billing_period:,
|
|
@@ -339,6 +358,7 @@ module WhopSDK
|
|
|
339
358
|
override.returns(
|
|
340
359
|
{
|
|
341
360
|
id: String,
|
|
361
|
+
adaptive_pricing_enabled: T::Boolean,
|
|
342
362
|
billing_period: T.nilable(Integer),
|
|
343
363
|
currency: WhopSDK::Currency::TaggedSymbol,
|
|
344
364
|
expiration_days: T.nilable(Integer),
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class CompanyCreateAPIKeyParams < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
7
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
8
|
+
|
|
9
|
+
OrHash =
|
|
10
|
+
T.type_alias do
|
|
11
|
+
T.any(WhopSDK::CompanyCreateAPIKeyParams, WhopSDK::Internal::AnyHash)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
sig { returns(String) }
|
|
15
|
+
attr_accessor :parent_company_id
|
|
16
|
+
|
|
17
|
+
# The unique identifier of the connected account to create the API key for (e.g.
|
|
18
|
+
# 'biz_xxx').
|
|
19
|
+
sig { returns(String) }
|
|
20
|
+
attr_accessor :child_company_id
|
|
21
|
+
|
|
22
|
+
# A human-readable name for the API key, such as 'Production API Key'.
|
|
23
|
+
sig { returns(T.nilable(String)) }
|
|
24
|
+
attr_accessor :name
|
|
25
|
+
|
|
26
|
+
# Granular permission statements defining which actions this API key can perform.
|
|
27
|
+
# Either permissions or role must be provided.
|
|
28
|
+
sig do
|
|
29
|
+
returns(
|
|
30
|
+
T.nilable(T::Array[WhopSDK::CompanyCreateAPIKeyParams::Permission])
|
|
31
|
+
)
|
|
32
|
+
end
|
|
33
|
+
attr_accessor :permissions
|
|
34
|
+
|
|
35
|
+
# The different system roles that can be assigned.
|
|
36
|
+
sig do
|
|
37
|
+
returns(T.nilable(WhopSDK::CompanyCreateAPIKeyParams::Role::OrSymbol))
|
|
38
|
+
end
|
|
39
|
+
attr_accessor :role
|
|
40
|
+
|
|
41
|
+
sig do
|
|
42
|
+
params(
|
|
43
|
+
parent_company_id: String,
|
|
44
|
+
child_company_id: String,
|
|
45
|
+
name: T.nilable(String),
|
|
46
|
+
permissions:
|
|
47
|
+
T.nilable(
|
|
48
|
+
T::Array[WhopSDK::CompanyCreateAPIKeyParams::Permission::OrHash]
|
|
49
|
+
),
|
|
50
|
+
role: T.nilable(WhopSDK::CompanyCreateAPIKeyParams::Role::OrSymbol),
|
|
51
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
52
|
+
).returns(T.attached_class)
|
|
53
|
+
end
|
|
54
|
+
def self.new(
|
|
55
|
+
parent_company_id:,
|
|
56
|
+
# The unique identifier of the connected account to create the API key for (e.g.
|
|
57
|
+
# 'biz_xxx').
|
|
58
|
+
child_company_id:,
|
|
59
|
+
# A human-readable name for the API key, such as 'Production API Key'.
|
|
60
|
+
name: nil,
|
|
61
|
+
# Granular permission statements defining which actions this API key can perform.
|
|
62
|
+
# Either permissions or role must be provided.
|
|
63
|
+
permissions: nil,
|
|
64
|
+
# The different system roles that can be assigned.
|
|
65
|
+
role: nil,
|
|
66
|
+
request_options: {}
|
|
67
|
+
)
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
sig do
|
|
71
|
+
override.returns(
|
|
72
|
+
{
|
|
73
|
+
parent_company_id: String,
|
|
74
|
+
child_company_id: String,
|
|
75
|
+
name: T.nilable(String),
|
|
76
|
+
permissions:
|
|
77
|
+
T.nilable(
|
|
78
|
+
T::Array[WhopSDK::CompanyCreateAPIKeyParams::Permission]
|
|
79
|
+
),
|
|
80
|
+
role: T.nilable(WhopSDK::CompanyCreateAPIKeyParams::Role::OrSymbol),
|
|
81
|
+
request_options: WhopSDK::RequestOptions
|
|
82
|
+
}
|
|
83
|
+
)
|
|
84
|
+
end
|
|
85
|
+
def to_hash
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
class Permission < WhopSDK::Internal::Type::BaseModel
|
|
89
|
+
OrHash =
|
|
90
|
+
T.type_alias do
|
|
91
|
+
T.any(
|
|
92
|
+
WhopSDK::CompanyCreateAPIKeyParams::Permission,
|
|
93
|
+
WhopSDK::Internal::AnyHash
|
|
94
|
+
)
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# Actions covered by this statement
|
|
98
|
+
sig { returns(T::Array[String]) }
|
|
99
|
+
attr_accessor :actions
|
|
100
|
+
|
|
101
|
+
# Whether the actions are granted or denied
|
|
102
|
+
sig { returns(T::Boolean) }
|
|
103
|
+
attr_accessor :grant
|
|
104
|
+
|
|
105
|
+
# Resource identifiers. Can look like 'biz*xxxx' or 'biz_xxx|pass*_|exp*xxx' or
|
|
106
|
+
# 'biz_xxx|app_xxx' or 'biz_xxx|pass_xxx|exp_xxx' or 'biz_xxx|pass_xxx' or
|
|
107
|
+
# 'biz_xxx|pass*_'
|
|
108
|
+
sig { returns(T::Array[String]) }
|
|
109
|
+
attr_accessor :resources
|
|
110
|
+
|
|
111
|
+
# Input for a single permissions statement
|
|
112
|
+
sig do
|
|
113
|
+
params(
|
|
114
|
+
actions: T::Array[String],
|
|
115
|
+
grant: T::Boolean,
|
|
116
|
+
resources: T::Array[String]
|
|
117
|
+
).returns(T.attached_class)
|
|
118
|
+
end
|
|
119
|
+
def self.new(
|
|
120
|
+
# Actions covered by this statement
|
|
121
|
+
actions:,
|
|
122
|
+
# Whether the actions are granted or denied
|
|
123
|
+
grant:,
|
|
124
|
+
# Resource identifiers. Can look like 'biz*xxxx' or 'biz_xxx|pass*_|exp*xxx' or
|
|
125
|
+
# 'biz_xxx|app_xxx' or 'biz_xxx|pass_xxx|exp_xxx' or 'biz_xxx|pass_xxx' or
|
|
126
|
+
# 'biz_xxx|pass*_'
|
|
127
|
+
resources:
|
|
128
|
+
)
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
sig do
|
|
132
|
+
override.returns(
|
|
133
|
+
{
|
|
134
|
+
actions: T::Array[String],
|
|
135
|
+
grant: T::Boolean,
|
|
136
|
+
resources: T::Array[String]
|
|
137
|
+
}
|
|
138
|
+
)
|
|
139
|
+
end
|
|
140
|
+
def to_hash
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# The different system roles that can be assigned.
|
|
145
|
+
module Role
|
|
146
|
+
extend WhopSDK::Internal::Type::Enum
|
|
147
|
+
|
|
148
|
+
TaggedSymbol =
|
|
149
|
+
T.type_alias do
|
|
150
|
+
T.all(Symbol, WhopSDK::CompanyCreateAPIKeyParams::Role)
|
|
151
|
+
end
|
|
152
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
153
|
+
|
|
154
|
+
OWNER =
|
|
155
|
+
T.let(:owner, WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol)
|
|
156
|
+
ADMIN =
|
|
157
|
+
T.let(:admin, WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol)
|
|
158
|
+
MODERATOR =
|
|
159
|
+
T.let(
|
|
160
|
+
:moderator,
|
|
161
|
+
WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol
|
|
162
|
+
)
|
|
163
|
+
SALES_MANAGER =
|
|
164
|
+
T.let(
|
|
165
|
+
:sales_manager,
|
|
166
|
+
WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol
|
|
167
|
+
)
|
|
168
|
+
ADVERTISER =
|
|
169
|
+
T.let(
|
|
170
|
+
:advertiser,
|
|
171
|
+
WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol
|
|
172
|
+
)
|
|
173
|
+
|
|
174
|
+
sig do
|
|
175
|
+
override.returns(
|
|
176
|
+
T::Array[WhopSDK::CompanyCreateAPIKeyParams::Role::TaggedSymbol]
|
|
177
|
+
)
|
|
178
|
+
end
|
|
179
|
+
def self.values
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
end
|