whop_sdk 0.0.39 → 0.0.41
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 +11 -0
- data/README.md +3 -3
- data/lib/whop_sdk/client.rb +227 -72
- data/lib/whop_sdk/internal/transport/base_client.rb +5 -0
- data/lib/whop_sdk/internal/type/union.rb +6 -6
- data/lib/whop_sdk/models/account.rb +967 -0
- data/lib/whop_sdk/models/account_create_params.rb +43 -0
- data/lib/whop_sdk/models/account_list_params.rb +83 -0
- data/lib/whop_sdk/models/account_me_params.rb +14 -0
- data/lib/whop_sdk/models/account_recommend_actions_params.rb +20 -0
- data/lib/whop_sdk/models/account_recommend_actions_response.rb +143 -0
- data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/account_social_link.rb +60 -0
- data/lib/whop_sdk/models/account_update_params.rb +512 -0
- data/lib/whop_sdk/models/accounts/preference_retrieve_params.rb +22 -0
- data/lib/whop_sdk/models/accounts/preference_retrieve_response.rb +129 -0
- data/lib/whop_sdk/models/accounts/preference_update_params.rb +142 -0
- data/lib/whop_sdk/models/accounts/preference_update_response.rb +129 -0
- data/lib/whop_sdk/models/ad.rb +808 -0
- data/lib/whop_sdk/models/ad_campaign.rb +635 -0
- data/lib/whop_sdk/models/ad_campaign_create_params.rb +194 -0
- data/lib/whop_sdk/models/{payout_method_retrieve_params.rb → ad_campaign_delete_params.rb} +2 -2
- data/lib/whop_sdk/models/ad_campaign_delete_response.rb +8 -0
- data/lib/whop_sdk/models/ad_campaign_list_params.rb +120 -36
- data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +26 -1
- data/lib/whop_sdk/models/ad_campaign_update_params.rb +99 -6
- data/lib/whop_sdk/models/ad_create_params.rb +660 -0
- data/lib/whop_sdk/models/ad_delete_params.rb +20 -0
- data/lib/whop_sdk/models/ad_delete_response.rb +8 -0
- data/lib/whop_sdk/models/ad_group.rb +774 -0
- data/lib/whop_sdk/models/ad_group_create_params.rb +346 -0
- data/lib/whop_sdk/models/ad_group_list_params.rb +114 -44
- data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_retrieve_params.rb +26 -1
- data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_update_params.rb +238 -3109
- data/lib/whop_sdk/models/ad_list_params.rb +127 -42
- data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_report_retrieve_params.rb +53 -23
- data/lib/whop_sdk/models/ad_report_retrieve_response.rb +403 -130
- data/lib/whop_sdk/models/ad_retrieve_params.rb +26 -1
- data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_update_params.rb +650 -0
- data/lib/whop_sdk/models/app.rb +81 -1
- data/lib/whop_sdk/models/app_build_create_params.rb +2 -2
- data/lib/whop_sdk/models/app_create_params.rb +10 -1
- data/lib/whop_sdk/models/app_list_response.rb +19 -1
- data/lib/whop_sdk/models/app_logs_params.rb +103 -0
- data/lib/whop_sdk/models/app_logs_response.rb +157 -0
- data/lib/whop_sdk/models/app_update_params.rb +21 -1
- data/lib/whop_sdk/models/audience.rb +191 -0
- data/lib/whop_sdk/models/audience_create_params.rb +96 -0
- data/lib/whop_sdk/models/audience_delete_params.rb +20 -0
- data/lib/whop_sdk/models/audience_delete_response.rb +16 -0
- data/lib/whop_sdk/models/audience_list_params.rb +46 -0
- data/lib/whop_sdk/models/authorized_user_create_params.rb +70 -1
- data/lib/whop_sdk/models/bounty_create_params.rb +70 -3
- data/lib/whop_sdk/models/bounty_create_response.rb +1 -0
- data/lib/whop_sdk/models/bounty_list_params.rb +1 -0
- data/lib/whop_sdk/models/bounty_list_response.rb +1 -0
- data/lib/whop_sdk/models/bounty_retrieve_response.rb +1 -0
- data/lib/whop_sdk/models/card_brands.rb +1 -0
- data/lib/whop_sdk/models/card_create_params.rb +88 -0
- data/lib/whop_sdk/models/card_create_response.rb +277 -0
- data/lib/whop_sdk/models/card_list_params.rb +30 -0
- data/lib/whop_sdk/models/card_list_response.rb +287 -0
- data/lib/whop_sdk/models/card_retrieve_params.rb +37 -0
- data/lib/whop_sdk/models/card_retrieve_response.rb +277 -0
- data/lib/whop_sdk/models/card_update_params.rb +181 -0
- data/lib/whop_sdk/models/card_update_response.rb +277 -0
- data/lib/whop_sdk/models/chat_message_created_webhook_event.rb +151 -0
- data/lib/whop_sdk/models/chat_reaction_created_webhook_event.rb +159 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +35 -24
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +303 -1021
- data/lib/whop_sdk/models/checkout_configuration_create_response.rb +275 -0
- data/lib/whop_sdk/models/checkout_configuration_delete_params.rb +20 -0
- data/lib/whop_sdk/models/checkout_configuration_list_params.rb +50 -41
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +136 -122
- data/lib/whop_sdk/models/checkout_configuration_retrieve_response.rb +275 -0
- data/lib/whop_sdk/models/company.rb +2 -2
- data/lib/whop_sdk/models/company_list_response.rb +2 -2
- data/lib/whop_sdk/models/course.rb +2 -2
- data/lib/whop_sdk/models/course_list_response.rb +2 -2
- data/lib/whop_sdk/models/currency.rb +3 -0
- data/lib/whop_sdk/models/deposit_create_params.rb +90 -0
- data/lib/whop_sdk/models/deposit_create_response.rb +228 -0
- data/lib/whop_sdk/models/deposit_list_params.rb +22 -0
- data/lib/whop_sdk/models/deposit_list_response.rb +101 -0
- data/lib/whop_sdk/models/dispute.rb +14 -15
- data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
- data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
- data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
- data/lib/whop_sdk/models/{conversion_create_params.rb → event_create_params.rb} +294 -32
- data/lib/whop_sdk/models/event_create_response.rb +16 -0
- data/lib/whop_sdk/models/event_list_params.rb +75 -0
- data/lib/whop_sdk/models/event_list_response.rb +242 -0
- data/lib/whop_sdk/models/experience.rb +5 -8
- data/lib/whop_sdk/models/experience_list_response.rb +2 -5
- data/lib/whop_sdk/models/file_create_params.rb +3 -15
- data/lib/whop_sdk/models/file_create_response.rb +3 -16
- data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
- data/lib/whop_sdk/models/file_visibility.rb +17 -0
- data/lib/whop_sdk/models/financial_activity_list_params.rb +113 -0
- data/lib/whop_sdk/models/financial_activity_list_response.rb +1174 -0
- data/lib/whop_sdk/models/forum_post.rb +2 -2
- data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
- data/lib/whop_sdk/models/granularities.rb +18 -0
- data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
- data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/invoice_create_params.rb +34 -2
- data/lib/whop_sdk/models/invoice_update_params.rb +17 -1
- data/lib/whop_sdk/models/ledger_account_funds_available_webhook_event.rb +578 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +67 -7
- data/lib/whop_sdk/models/lesson.rb +6 -6
- data/lib/whop_sdk/models/media_asset.rb +224 -0
- data/lib/whop_sdk/models/media_generate_params.rb +105 -0
- data/lib/whop_sdk/models/media_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/member_list_response.rb +3 -2
- data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
- data/lib/whop_sdk/models/membership.rb +26 -3
- data/lib/whop_sdk/models/membership_list_response.rb +26 -3
- data/lib/whop_sdk/models/membership_trial_ending_soon_webhook_event.rb +60 -0
- data/lib/whop_sdk/models/payment.rb +213 -26
- data/lib/whop_sdk/models/payment_create_params.rb +22 -2
- data/lib/whop_sdk/models/payment_list_params.rb +9 -1
- data/lib/whop_sdk/models/payment_list_response.rb +118 -17
- data/lib/whop_sdk/models/payout_create_params.rb +58 -0
- data/lib/whop_sdk/models/payout_create_response.rb +185 -0
- data/lib/whop_sdk/models/payout_list_params.rb +70 -0
- data/lib/whop_sdk/models/payout_list_response.rb +195 -0
- data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +20 -3
- data/lib/whop_sdk/models/payouts/method_list_params.rb +120 -0
- data/lib/whop_sdk/models/payouts/method_list_response.rb +315 -0
- data/lib/whop_sdk/models/person_list_params.rb +103 -0
- data/lib/whop_sdk/models/person_list_response.rb +167 -0
- data/lib/whop_sdk/models/person_retrieve_params.rb +50 -0
- data/lib/whop_sdk/models/person_retrieve_response.rb +179 -0
- data/lib/whop_sdk/models/plan.rb +311 -246
- data/lib/whop_sdk/models/plan_calculate_tax_params.rb +248 -0
- data/lib/whop_sdk/models/plan_calculate_tax_response.rb +94 -0
- data/lib/whop_sdk/models/plan_create_params.rb +137 -153
- data/lib/whop_sdk/models/plan_list_params.rb +54 -47
- data/lib/whop_sdk/models/plan_list_response.rb +105 -221
- data/lib/whop_sdk/models/plan_update_params.rb +116 -133
- data/lib/whop_sdk/models/product.rb +40 -37
- data/lib/whop_sdk/models/product_create_params.rb +48 -189
- data/lib/whop_sdk/models/product_list_item.rb +20 -11
- data/lib/whop_sdk/models/product_list_params.rb +35 -57
- data/lib/whop_sdk/models/product_update_params.rb +20 -148
- data/lib/whop_sdk/models/referral_referred_users_params.rb +66 -0
- data/lib/whop_sdk/models/referral_referred_users_response.rb +127 -0
- data/lib/whop_sdk/models/referrals/business_leaderboard_params.rb +45 -0
- data/lib/whop_sdk/models/referrals/business_leaderboard_response.rb +284 -0
- data/lib/whop_sdk/models/referrals/business_list_params.rb +175 -0
- data/lib/whop_sdk/models/referrals/business_list_response.rb +361 -0
- data/lib/whop_sdk/models/referrals/business_retrieve_params.rb +22 -0
- data/lib/whop_sdk/models/referrals/business_retrieve_response.rb +881 -0
- data/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb +131 -0
- data/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb +371 -0
- data/lib/whop_sdk/models/referrals/partner_create_params.rb +16 -0
- data/lib/whop_sdk/models/referrals/partner_create_response.rb +31 -0
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +86 -5
- data/lib/whop_sdk/models/refund_retrieve_response.rb +84 -5
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +86 -5
- data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
- data/lib/whop_sdk/models/result_label_keys.rb +48 -0
- data/lib/whop_sdk/models/review_list_response.rb +2 -2
- data/lib/whop_sdk/models/review_retrieve_response.rb +4 -7
- data/lib/whop_sdk/models/setup_intent.rb +10 -1
- data/lib/whop_sdk/models/social_account.rb +101 -0
- data/lib/whop_sdk/models/social_account_connect_params.rb +74 -0
- data/lib/whop_sdk/models/social_account_connect_response.rb +17 -0
- data/lib/whop_sdk/models/social_account_create_params.rb +45 -0
- data/lib/whop_sdk/models/social_account_delete_params.rb +42 -0
- data/lib/whop_sdk/models/social_account_delete_response.rb +8 -0
- data/lib/whop_sdk/models/social_account_list_params.rb +152 -0
- data/lib/whop_sdk/models/social_account_post.rb +99 -0
- data/lib/whop_sdk/models/social_account_posts_params.rb +53 -0
- data/lib/whop_sdk/models/social_account_posts_response.rb +39 -0
- data/lib/whop_sdk/models/stat_list_params.rb +14 -0
- data/lib/whop_sdk/models/stat_list_response.rb +89 -0
- data/lib/whop_sdk/models/stat_retrieve_params.rb +265 -0
- data/lib/whop_sdk/models/stat_retrieve_response.rb +88 -0
- data/lib/whop_sdk/models/swap_create_params.rb +101 -0
- data/lib/whop_sdk/models/swap_create_quote_params.rb +117 -0
- data/lib/whop_sdk/models/swap_create_quote_response.rb +130 -0
- data/lib/whop_sdk/models/swap_create_response.rb +82 -0
- data/lib/whop_sdk/models/swap_list_params.rb +22 -0
- data/lib/whop_sdk/models/swap_list_response.rb +77 -0
- data/lib/whop_sdk/models/swap_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/swap_retrieve_response.rb +66 -0
- data/lib/whop_sdk/models/tax_identifier_type.rb +2 -0
- data/lib/whop_sdk/models/transfer_create_params.rb +62 -27
- data/lib/whop_sdk/models/transfer_create_response.rb +452 -0
- data/lib/whop_sdk/models/transfer_list_params.rb +46 -40
- data/lib/whop_sdk/models/transfer_list_response.rb +29 -36
- data/lib/whop_sdk/models/transfer_retrieve_response.rb +267 -0
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +46 -30
- data/lib/whop_sdk/models/user.rb +276 -31
- data/lib/whop_sdk/models/user_balance.rb +226 -0
- data/lib/whop_sdk/models/user_check_access_response.rb +16 -9
- data/lib/whop_sdk/models/user_list_params.rb +15 -15
- data/lib/whop_sdk/models/user_retrieve_params.rb +66 -6
- data/lib/whop_sdk/models/user_update_me_params.rb +70 -0
- data/lib/whop_sdk/models/user_update_params.rb +23 -30
- data/lib/whop_sdk/models/verification_create_params.rb +414 -0
- data/lib/whop_sdk/models/verification_create_response.rb +400 -0
- data/lib/whop_sdk/models/verification_list_params.rb +40 -30
- data/lib/whop_sdk/models/verification_list_response.rb +396 -34
- data/lib/whop_sdk/models/verification_retrieve_params.rb +4 -4
- data/lib/whop_sdk/models/verification_retrieve_response.rb +373 -21
- data/lib/whop_sdk/models/verification_update_params.rb +578 -0
- data/lib/whop_sdk/models/verification_update_response.rb +400 -0
- data/lib/whop_sdk/models/webhook_event.rb +8 -0
- data/lib/whop_sdk/models/withdrawal.rb +1 -0
- data/lib/whop_sdk/models/withdrawal_create_params.rb +2 -2
- data/lib/whop_sdk/models/workforce/bounty_list_params.rb +153 -0
- data/lib/whop_sdk/models/workforce/bounty_retrieve_params.rb +22 -0
- data/lib/whop_sdk/models/workforce/workforce_bounty.rb +351 -0
- data/lib/whop_sdk/models/workforce/workforce_bounty_list_item.rb +347 -0
- data/lib/whop_sdk/models.rb +151 -7
- data/lib/whop_sdk/resources/access_tokens.rb +0 -1
- data/lib/whop_sdk/resources/account_links.rb +0 -1
- data/lib/whop_sdk/resources/accounts/preferences.rb +78 -0
- data/lib/whop_sdk/resources/accounts.rb +254 -0
- data/lib/whop_sdk/resources/ad_campaigns.rb +136 -47
- data/lib/whop_sdk/resources/ad_groups.rb +194 -47
- data/lib/whop_sdk/resources/ad_reports.rb +14 -9
- data/lib/whop_sdk/resources/ads.rb +210 -25
- data/lib/whop_sdk/resources/affiliates/overrides.rb +0 -1
- data/lib/whop_sdk/resources/affiliates.rb +0 -2
- data/lib/whop_sdk/resources/ai_chats.rb +0 -1
- data/lib/whop_sdk/resources/app_builds.rb +0 -1
- data/lib/whop_sdk/resources/apps.rb +63 -3
- data/lib/whop_sdk/resources/audiences.rb +104 -0
- data/lib/whop_sdk/resources/authorized_users.rb +3 -2
- data/lib/whop_sdk/resources/bounties.rb +9 -2
- data/lib/whop_sdk/resources/cards.rb +178 -0
- data/lib/whop_sdk/resources/chat_channels.rb +0 -1
- data/lib/whop_sdk/resources/checkout_configurations.rb +69 -42
- data/lib/whop_sdk/resources/companies.rb +0 -1
- data/lib/whop_sdk/resources/company_token_transactions.rb +0 -1
- data/lib/whop_sdk/resources/course_chapters.rb +0 -1
- data/lib/whop_sdk/resources/course_lesson_interactions.rb +0 -1
- data/lib/whop_sdk/resources/course_lessons.rb +0 -1
- data/lib/whop_sdk/resources/course_students.rb +0 -1
- data/lib/whop_sdk/resources/courses.rb +0 -1
- data/lib/whop_sdk/resources/deposits.rb +77 -0
- data/lib/whop_sdk/resources/dispute_alerts.rb +0 -1
- data/lib/whop_sdk/resources/disputes.rb +0 -1
- data/lib/whop_sdk/resources/dm_channels.rb +0 -1
- data/lib/whop_sdk/resources/dm_members.rb +0 -1
- data/lib/whop_sdk/resources/entries.rb +0 -1
- data/lib/whop_sdk/resources/events.rb +121 -0
- data/lib/whop_sdk/resources/experiences.rb +0 -1
- data/lib/whop_sdk/resources/fee_markups.rb +0 -1
- data/lib/whop_sdk/resources/files.rb +1 -2
- data/lib/whop_sdk/resources/financial_activity.rb +76 -0
- data/lib/whop_sdk/resources/forum_posts.rb +0 -1
- data/lib/whop_sdk/resources/forums.rb +0 -1
- data/lib/whop_sdk/resources/invoices.rb +0 -1
- data/lib/whop_sdk/resources/leads.rb +0 -1
- data/lib/whop_sdk/resources/ledger_accounts.rb +0 -1
- data/lib/whop_sdk/resources/media.rb +77 -0
- data/lib/whop_sdk/resources/members.rb +0 -1
- data/lib/whop_sdk/resources/memberships.rb +0 -1
- data/lib/whop_sdk/resources/messages.rb +0 -1
- data/lib/whop_sdk/resources/notifications.rb +0 -1
- data/lib/whop_sdk/resources/payment_methods.rb +0 -1
- data/lib/whop_sdk/resources/payments.rb +3 -2
- data/lib/whop_sdk/resources/payout_accounts.rb +0 -1
- data/lib/whop_sdk/resources/payouts/methods.rb +71 -0
- data/lib/whop_sdk/resources/payouts.rb +107 -0
- data/lib/whop_sdk/resources/people.rb +99 -0
- data/lib/whop_sdk/resources/plans.rb +99 -79
- data/lib/whop_sdk/resources/products.rb +48 -93
- data/lib/whop_sdk/resources/promo_codes.rb +0 -1
- data/lib/whop_sdk/resources/reactions.rb +0 -1
- data/lib/whop_sdk/resources/referrals/businesses/earnings.rb +67 -0
- data/lib/whop_sdk/resources/referrals/businesses.rb +132 -0
- data/lib/whop_sdk/resources/referrals/partners.rb +42 -0
- data/lib/whop_sdk/resources/referrals.rb +77 -0
- data/lib/whop_sdk/resources/refunds.rb +2 -1
- data/lib/whop_sdk/resources/resolution_center_cases.rb +0 -1
- data/lib/whop_sdk/resources/reviews.rb +0 -1
- data/lib/whop_sdk/resources/setup_intents.rb +0 -1
- data/lib/whop_sdk/resources/shipments.rb +0 -1
- data/lib/whop_sdk/resources/social_accounts.rb +192 -0
- data/lib/whop_sdk/resources/stats.rb +113 -0
- data/lib/whop_sdk/resources/support_channels.rb +0 -1
- data/lib/whop_sdk/resources/swaps.rb +143 -0
- data/lib/whop_sdk/resources/topups.rb +0 -1
- data/lib/whop_sdk/resources/transfers.rb +42 -42
- data/lib/whop_sdk/resources/users.rb +82 -33
- data/lib/whop_sdk/resources/verifications.rb +81 -20
- data/lib/whop_sdk/resources/webhooks.rb +1 -2
- data/lib/whop_sdk/resources/withdrawals.rb +1 -2
- data/lib/whop_sdk/resources/workforce/bounties.rb +97 -0
- data/lib/whop_sdk/resources/workforce.rb +25 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +148 -21
- data/rbi/whop_sdk/client.rbi +211 -69
- data/rbi/whop_sdk/models/account.rbi +1532 -0
- data/rbi/whop_sdk/models/account_create_params.rbi +72 -0
- data/rbi/whop_sdk/models/account_list_params.rbi +145 -0
- data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
- data/rbi/whop_sdk/models/account_recommend_actions_params.rbi +38 -0
- data/rbi/whop_sdk/models/account_recommend_actions_response.rbi +296 -0
- data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
- data/rbi/whop_sdk/models/account_update_params.rbi +1141 -0
- data/rbi/whop_sdk/models/accounts/preference_retrieve_params.rbi +40 -0
- data/rbi/whop_sdk/models/accounts/preference_retrieve_response.rbi +323 -0
- data/rbi/whop_sdk/models/accounts/preference_update_params.rbi +331 -0
- data/rbi/whop_sdk/models/accounts/preference_update_response.rbi +323 -0
- data/rbi/whop_sdk/models/ad.rbi +983 -0
- data/rbi/whop_sdk/models/ad_campaign.rbi +846 -0
- data/rbi/whop_sdk/models/ad_campaign_create_params.rbi +428 -0
- data/rbi/whop_sdk/models/{payout_method_retrieve_params.rbi → ad_campaign_delete_params.rbi} +2 -2
- data/rbi/whop_sdk/models/ad_campaign_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +248 -56
- data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +41 -2
- data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +207 -8
- data/rbi/whop_sdk/models/ad_create_params.rbi +1491 -0
- data/rbi/whop_sdk/models/ad_delete_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_delete_response.rbi +7 -0
- data/rbi/whop_sdk/models/ad_group.rbi +948 -0
- data/rbi/whop_sdk/models/ad_group_create_params.rbi +654 -0
- data/rbi/whop_sdk/models/ad_group_list_params.rbi +217 -67
- data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +41 -2
- data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_update_params.rbi +494 -5988
- data/rbi/whop_sdk/models/ad_list_params.rbi +220 -59
- data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +89 -33
- data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +566 -378
- data/rbi/whop_sdk/models/ad_retrieve_params.rbi +41 -2
- data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_update_params.rbi +1473 -0
- data/rbi/whop_sdk/models/app.rbi +111 -0
- data/rbi/whop_sdk/models/app_build_create_params.rbi +3 -3
- data/rbi/whop_sdk/models/app_create_params.rbi +10 -0
- data/rbi/whop_sdk/models/app_list_response.rbi +20 -0
- data/rbi/whop_sdk/models/app_logs_params.rbi +154 -0
- data/rbi/whop_sdk/models/app_logs_response.rbi +261 -0
- data/rbi/whop_sdk/models/app_update_params.rbi +24 -0
- data/rbi/whop_sdk/models/audience.rbi +262 -0
- data/rbi/whop_sdk/models/audience_create_params.rbi +160 -0
- data/rbi/whop_sdk/models/audience_delete_params.rbi +35 -0
- data/rbi/whop_sdk/models/audience_delete_response.rbi +26 -0
- data/rbi/whop_sdk/models/audience_list_params.rbi +76 -0
- data/rbi/whop_sdk/models/authorized_user_create_params.rbi +102 -0
- data/rbi/whop_sdk/models/bounty_create_params.rbi +164 -4
- data/rbi/whop_sdk/models/bounty_create_response.rbi +5 -0
- data/rbi/whop_sdk/models/bounty_list_params.rbi +2 -0
- data/rbi/whop_sdk/models/bounty_list_response.rbi +5 -0
- data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +5 -0
- data/rbi/whop_sdk/models/card_brands.rbi +1 -0
- data/rbi/whop_sdk/models/card_create_params.rbi +167 -0
- data/rbi/whop_sdk/models/card_create_response.rbi +446 -0
- data/rbi/whop_sdk/models/card_list_params.rbi +57 -0
- data/rbi/whop_sdk/models/card_list_response.rbi +511 -0
- data/rbi/whop_sdk/models/card_retrieve_params.rbi +63 -0
- data/rbi/whop_sdk/models/card_retrieve_response.rbi +457 -0
- data/rbi/whop_sdk/models/card_update_params.rbi +299 -0
- data/rbi/whop_sdk/models/card_update_response.rbi +446 -0
- data/rbi/whop_sdk/models/chat_message_created_webhook_event.rbi +319 -0
- data/rbi/whop_sdk/models/chat_reaction_created_webhook_event.rbi +335 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +84 -44
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +404 -1537
- data/rbi/whop_sdk/models/checkout_configuration_create_response.rbi +420 -0
- data/rbi/whop_sdk/models/checkout_configuration_delete_params.rbi +38 -0
- data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +142 -51
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +202 -161
- data/rbi/whop_sdk/models/checkout_configuration_retrieve_response.rbi +422 -0
- data/rbi/whop_sdk/models/company.rbi +2 -2
- data/rbi/whop_sdk/models/company_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/course.rbi +2 -2
- data/rbi/whop_sdk/models/course_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/currency.rbi +3 -0
- data/rbi/whop_sdk/models/deposit_create_params.rbi +165 -0
- data/rbi/whop_sdk/models/deposit_create_response.rbi +437 -0
- data/rbi/whop_sdk/models/deposit_list_params.rbi +40 -0
- data/rbi/whop_sdk/models/deposit_list_response.rbi +163 -0
- data/rbi/whop_sdk/models/dispute.rbi +15 -17
- data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
- data/rbi/whop_sdk/models/event_create_params.rbi +891 -0
- data/rbi/whop_sdk/models/{conversion_create_response.rbi → event_create_response.rbi} +3 -8
- data/rbi/whop_sdk/models/event_list_params.rbi +111 -0
- data/rbi/whop_sdk/models/event_list_response.rbi +350 -0
- data/rbi/whop_sdk/models/experience.rbi +6 -6
- data/rbi/whop_sdk/models/experience_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
- data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
- data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
- data/rbi/whop_sdk/models/financial_activity_list_params.rbi +175 -0
- data/rbi/whop_sdk/models/financial_activity_list_response.rbi +2066 -0
- data/rbi/whop_sdk/models/forum_post.rbi +2 -2
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/granularities.rbi +22 -0
- data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/invoice_create_params.rbi +32 -0
- data/rbi/whop_sdk/models/invoice_update_params.rbi +16 -0
- data/rbi/whop_sdk/models/ledger_account_funds_available_webhook_event.rbi +1001 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +111 -5
- data/rbi/whop_sdk/models/lesson.rbi +6 -6
- data/rbi/whop_sdk/models/media_asset.rbi +325 -0
- data/rbi/whop_sdk/models/media_generate_params.rbi +204 -0
- data/rbi/whop_sdk/models/media_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
- data/rbi/whop_sdk/models/membership.rbi +50 -7
- data/rbi/whop_sdk/models/membership_list_response.rbi +50 -7
- data/rbi/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbi +85 -0
- data/rbi/whop_sdk/models/payment.rbi +295 -40
- data/rbi/whop_sdk/models/payment_create_params.rbi +30 -6
- data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +188 -28
- data/rbi/whop_sdk/models/payout_create_params.rbi +83 -0
- data/rbi/whop_sdk/models/payout_create_response.rbi +352 -0
- data/rbi/whop_sdk/models/payout_list_params.rbi +112 -0
- data/rbi/whop_sdk/models/payout_list_response.rbi +353 -0
- data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +64 -3
- data/rbi/whop_sdk/models/payouts/method_list_params.rbi +209 -0
- data/rbi/whop_sdk/models/payouts/method_list_response.rbi +554 -0
- data/rbi/whop_sdk/models/person_list_params.rbi +160 -0
- data/rbi/whop_sdk/models/person_list_response.rbi +282 -0
- data/rbi/whop_sdk/models/person_retrieve_params.rbi +76 -0
- data/rbi/whop_sdk/models/person_retrieve_response.rbi +349 -0
- data/rbi/whop_sdk/models/plan.rbi +346 -332
- data/rbi/whop_sdk/models/plan_calculate_tax_params.rbi +795 -0
- data/rbi/whop_sdk/models/plan_calculate_tax_response.rbi +170 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +267 -217
- data/rbi/whop_sdk/models/plan_list_params.rbi +121 -67
- data/rbi/whop_sdk/models/plan_list_response.rbi +127 -360
- data/rbi/whop_sdk/models/plan_update_params.rbi +228 -192
- data/rbi/whop_sdk/models/product.rbi +48 -44
- data/rbi/whop_sdk/models/product_create_params.rbi +69 -273
- data/rbi/whop_sdk/models/product_list_item.rbi +24 -14
- data/rbi/whop_sdk/models/product_list_params.rbi +75 -78
- data/rbi/whop_sdk/models/product_update_params.rbi +30 -207
- data/rbi/whop_sdk/models/referral_referred_users_params.rbi +106 -0
- data/rbi/whop_sdk/models/referral_referred_users_response.rbi +259 -0
- data/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi +120 -0
- data/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi +535 -0
- data/rbi/whop_sdk/models/referrals/business_list_params.rbi +376 -0
- data/rbi/whop_sdk/models/referrals/business_list_response.rbi +701 -0
- data/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi +40 -0
- data/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi +1846 -0
- data/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi +308 -0
- data/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi +693 -0
- data/rbi/whop_sdk/models/referrals/partner_create_params.rbi +32 -0
- data/rbi/whop_sdk/models/referrals/partner_create_response.rbi +48 -0
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +163 -5
- data/rbi/whop_sdk/models/refund_retrieve_response.rbi +161 -5
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +163 -5
- data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
- data/rbi/whop_sdk/models/result_label_keys.rbi +87 -0
- data/rbi/whop_sdk/models/review_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/review_retrieve_response.rbi +4 -4
- data/rbi/whop_sdk/models/setup_intent.rbi +13 -3
- data/rbi/whop_sdk/models/social_account.rbi +129 -0
- data/rbi/whop_sdk/models/social_account_connect_params.rbi +146 -0
- data/rbi/whop_sdk/models/social_account_connect_response.rbi +30 -0
- data/rbi/whop_sdk/models/social_account_create_params.rbi +81 -0
- data/rbi/whop_sdk/models/social_account_delete_params.rbi +67 -0
- data/rbi/whop_sdk/models/social_account_delete_response.rbi +8 -0
- data/rbi/whop_sdk/models/social_account_list_params.rbi +308 -0
- data/rbi/whop_sdk/models/social_account_post.rbi +261 -0
- data/rbi/whop_sdk/models/social_account_posts_params.rbi +82 -0
- data/rbi/whop_sdk/models/social_account_posts_response.rbi +83 -0
- data/rbi/whop_sdk/models/stat_list_params.rbi +27 -0
- data/rbi/whop_sdk/models/stat_list_response.rbi +159 -0
- data/rbi/whop_sdk/models/stat_retrieve_params.rbi +411 -0
- data/rbi/whop_sdk/models/stat_retrieve_response.rbi +198 -0
- data/rbi/whop_sdk/models/swap_create_params.rbi +128 -0
- data/rbi/whop_sdk/models/swap_create_quote_params.rbi +154 -0
- data/rbi/whop_sdk/models/swap_create_quote_response.rbi +174 -0
- data/rbi/whop_sdk/models/swap_create_response.rbi +127 -0
- data/rbi/whop_sdk/models/swap_list_params.rbi +40 -0
- data/rbi/whop_sdk/models/swap_list_response.rbi +137 -0
- data/rbi/whop_sdk/models/swap_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/swap_retrieve_response.rbi +106 -0
- data/rbi/whop_sdk/models/tax_identifier_type.rbi +2 -0
- data/rbi/whop_sdk/models/transfer_create_params.rbi +94 -36
- data/rbi/whop_sdk/models/transfer_create_response.rbi +767 -0
- data/rbi/whop_sdk/models/transfer_list_params.rbi +111 -60
- data/rbi/whop_sdk/models/transfer_list_response.rbi +32 -40
- data/rbi/whop_sdk/models/transfer_retrieve_response.rbi +416 -0
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +29 -21
- data/rbi/whop_sdk/models/user.rbi +427 -45
- data/rbi/whop_sdk/models/user_balance.rbi +301 -0
- data/rbi/whop_sdk/models/user_check_access_response.rbi +46 -12
- data/rbi/whop_sdk/models/user_list_params.rbi +40 -25
- data/rbi/whop_sdk/models/user_retrieve_params.rbi +106 -8
- data/rbi/whop_sdk/models/user_update_me_params.rbi +120 -0
- data/rbi/whop_sdk/models/user_update_params.rbi +46 -45
- data/rbi/whop_sdk/models/verification_create_params.rbi +783 -0
- data/rbi/whop_sdk/models/verification_create_response.rbi +757 -0
- data/rbi/whop_sdk/models/verification_list_params.rbi +88 -34
- data/rbi/whop_sdk/models/verification_list_response.rbi +783 -39
- data/rbi/whop_sdk/models/verification_retrieve_params.rbi +4 -4
- data/rbi/whop_sdk/models/verification_retrieve_response.rbi +722 -30
- data/rbi/whop_sdk/models/verification_update_params.rbi +1187 -0
- data/rbi/whop_sdk/models/verification_update_response.rbi +757 -0
- data/rbi/whop_sdk/models/webhook_event.rbi +25 -0
- data/rbi/whop_sdk/models/withdrawal.rbi +5 -0
- data/rbi/whop_sdk/models/withdrawal_create_params.rbi +2 -2
- data/rbi/whop_sdk/models/workforce/bounty_list_params.rbi +313 -0
- data/rbi/whop_sdk/models/workforce/bounty_retrieve_params.rbi +40 -0
- data/rbi/whop_sdk/models/workforce/workforce_bounty.rbi +588 -0
- data/rbi/whop_sdk/models/workforce/workforce_bounty_list_item.rbi +590 -0
- data/rbi/whop_sdk/models.rbi +160 -7
- data/rbi/whop_sdk/resources/access_tokens.rbi +0 -1
- data/rbi/whop_sdk/resources/account_links.rbi +0 -1
- data/rbi/whop_sdk/resources/accounts/preferences.rbi +62 -0
- data/rbi/whop_sdk/resources/accounts.rbi +253 -0
- data/rbi/whop_sdk/resources/ad_campaigns.rbi +173 -60
- data/rbi/whop_sdk/resources/ad_groups.rbi +287 -72
- data/rbi/whop_sdk/resources/ad_reports.rbi +29 -19
- data/rbi/whop_sdk/resources/ads.rbi +254 -39
- data/rbi/whop_sdk/resources/affiliates/overrides.rbi +0 -1
- data/rbi/whop_sdk/resources/affiliates.rbi +0 -2
- data/rbi/whop_sdk/resources/ai_chats.rbi +0 -1
- data/rbi/whop_sdk/resources/app_builds.rbi +1 -2
- data/rbi/whop_sdk/resources/apps.rbi +66 -1
- data/rbi/whop_sdk/resources/audiences.rbi +82 -0
- data/rbi/whop_sdk/resources/authorized_users.rbi +4 -1
- data/rbi/whop_sdk/resources/bounties.rbi +23 -3
- data/rbi/whop_sdk/resources/cards.rbi +160 -0
- data/rbi/whop_sdk/resources/chat_channels.rbi +0 -1
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +82 -51
- data/rbi/whop_sdk/resources/companies.rbi +0 -1
- data/rbi/whop_sdk/resources/company_token_transactions.rbi +0 -1
- data/rbi/whop_sdk/resources/course_chapters.rbi +0 -1
- data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +0 -1
- data/rbi/whop_sdk/resources/course_lessons.rbi +0 -1
- data/rbi/whop_sdk/resources/course_students.rbi +0 -1
- data/rbi/whop_sdk/resources/courses.rbi +0 -1
- data/rbi/whop_sdk/resources/deposits.rbi +63 -0
- data/rbi/whop_sdk/resources/dispute_alerts.rbi +0 -1
- data/rbi/whop_sdk/resources/disputes.rbi +0 -1
- data/rbi/whop_sdk/resources/dm_channels.rbi +0 -1
- data/rbi/whop_sdk/resources/dm_members.rbi +0 -1
- data/rbi/whop_sdk/resources/entries.rbi +0 -1
- data/rbi/whop_sdk/resources/events.rbi +122 -0
- data/rbi/whop_sdk/resources/experiences.rbi +0 -1
- data/rbi/whop_sdk/resources/fee_markups.rbi +0 -1
- data/rbi/whop_sdk/resources/files.rbi +1 -3
- data/rbi/whop_sdk/resources/financial_activity.rbi +80 -0
- data/rbi/whop_sdk/resources/forum_posts.rbi +0 -1
- data/rbi/whop_sdk/resources/forums.rbi +0 -1
- data/rbi/whop_sdk/resources/invoices.rbi +0 -1
- data/rbi/whop_sdk/resources/leads.rbi +0 -1
- data/rbi/whop_sdk/resources/ledger_accounts.rbi +0 -1
- data/rbi/whop_sdk/resources/media.rbi +67 -0
- data/rbi/whop_sdk/resources/members.rbi +0 -1
- data/rbi/whop_sdk/resources/memberships.rbi +0 -1
- data/rbi/whop_sdk/resources/messages.rbi +0 -1
- data/rbi/whop_sdk/resources/notifications.rbi +0 -1
- data/rbi/whop_sdk/resources/payment_methods.rbi +0 -1
- data/rbi/whop_sdk/resources/payments.rbi +3 -1
- data/rbi/whop_sdk/resources/payout_accounts.rbi +0 -1
- data/rbi/whop_sdk/resources/payouts/methods.rbi +76 -0
- data/rbi/whop_sdk/resources/payouts.rbi +96 -0
- data/rbi/whop_sdk/resources/people.rbi +86 -0
- data/rbi/whop_sdk/resources/plans.rbi +120 -112
- data/rbi/whop_sdk/resources/products.rbi +67 -144
- data/rbi/whop_sdk/resources/promo_codes.rbi +0 -1
- data/rbi/whop_sdk/resources/reactions.rbi +0 -1
- data/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi +67 -0
- data/rbi/whop_sdk/resources/referrals/businesses.rbi +122 -0
- data/rbi/whop_sdk/resources/referrals/partners.rbi +31 -0
- data/rbi/whop_sdk/resources/referrals.rbi +67 -0
- data/rbi/whop_sdk/resources/refunds.rbi +2 -1
- data/rbi/whop_sdk/resources/resolution_center_cases.rbi +0 -1
- data/rbi/whop_sdk/resources/reviews.rbi +0 -1
- data/rbi/whop_sdk/resources/setup_intents.rbi +0 -1
- data/rbi/whop_sdk/resources/shipments.rbi +0 -1
- data/rbi/whop_sdk/resources/social_accounts.rbi +161 -0
- data/rbi/whop_sdk/resources/stats.rbi +143 -0
- data/rbi/whop_sdk/resources/support_channels.rbi +0 -1
- data/rbi/whop_sdk/resources/swaps.rbi +124 -0
- data/rbi/whop_sdk/resources/topups.rbi +0 -1
- data/rbi/whop_sdk/resources/transfers.rbi +62 -59
- data/rbi/whop_sdk/resources/users.rbi +92 -48
- data/rbi/whop_sdk/resources/verifications.rbi +85 -35
- data/rbi/whop_sdk/resources/webhooks.rbi +29 -22
- data/rbi/whop_sdk/resources/withdrawals.rbi +1 -2
- data/rbi/whop_sdk/resources/workforce/bounties.rbi +94 -0
- data/rbi/whop_sdk/resources/workforce.rbi +22 -0
- data/sig/whop_sdk/client.rbs +31 -4
- data/sig/whop_sdk/models/account.rbs +706 -0
- data/sig/whop_sdk/models/account_create_params.rbs +38 -0
- data/sig/whop_sdk/models/account_list_params.rbs +88 -0
- data/sig/whop_sdk/models/account_me_params.rbs +14 -0
- data/sig/whop_sdk/models/account_recommend_actions_params.rbs +23 -0
- data/sig/whop_sdk/models/account_recommend_actions_response.rbs +129 -0
- data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
- data/sig/whop_sdk/models/account_social_link.rbs +62 -0
- data/sig/whop_sdk/models/account_update_params.rbs +536 -0
- data/sig/whop_sdk/models/accounts/preference_retrieve_params.rbs +25 -0
- data/sig/whop_sdk/models/accounts/preference_retrieve_response.rbs +110 -0
- data/sig/whop_sdk/models/accounts/preference_update_params.rbs +133 -0
- data/sig/whop_sdk/models/accounts/preference_update_response.rbs +110 -0
- data/sig/whop_sdk/models/ad.rbs +597 -0
- data/sig/whop_sdk/models/ad_campaign.rbs +472 -0
- data/sig/whop_sdk/models/ad_campaign_create_params.rbs +179 -0
- data/sig/whop_sdk/models/{payout_method_retrieve_params.rbs → ad_campaign_delete_params.rbs} +2 -2
- data/sig/whop_sdk/models/ad_campaign_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/ad_campaign_list_params.rbs +145 -41
- data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +24 -2
- data/sig/whop_sdk/models/ad_campaign_update_params.rbs +90 -4
- data/sig/whop_sdk/models/ad_create_params.rbs +751 -0
- data/sig/whop_sdk/models/ad_delete_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/ad_group.rbs +543 -0
- data/sig/whop_sdk/models/ad_group_create_params.rbs +292 -0
- data/sig/whop_sdk/models/ad_group_list_params.rbs +141 -50
- data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +24 -2
- data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_update_params.rbs +200 -2354
- data/sig/whop_sdk/models/ad_list_params.rbs +157 -44
- data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +38 -16
- data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +258 -149
- data/sig/whop_sdk/models/ad_retrieve_params.rbs +24 -2
- data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_update_params.rbs +742 -0
- data/sig/whop_sdk/models/app.rbs +52 -0
- data/sig/whop_sdk/models/app_create_params.rbs +6 -1
- data/sig/whop_sdk/models/app_list_response.rbs +10 -0
- data/sig/whop_sdk/models/app_logs_params.rbs +98 -0
- data/sig/whop_sdk/models/app_logs_response.rbs +162 -0
- data/sig/whop_sdk/models/app_update_params.rbs +10 -0
- data/sig/whop_sdk/models/audience.rbs +145 -0
- data/sig/whop_sdk/models/audience_create_params.rbs +88 -0
- data/sig/whop_sdk/models/audience_delete_params.rbs +23 -0
- data/sig/whop_sdk/models/audience_delete_response.rbs +13 -0
- data/sig/whop_sdk/models/audience_list_params.rbs +42 -0
- data/sig/whop_sdk/models/authorized_user_create_params.rbs +52 -0
- data/sig/whop_sdk/models/bounty_create_params.rbs +56 -1
- data/sig/whop_sdk/models/bounty_create_response.rbs +2 -1
- data/sig/whop_sdk/models/bounty_list_params.rbs +2 -1
- data/sig/whop_sdk/models/bounty_list_response.rbs +2 -1
- data/sig/whop_sdk/models/bounty_retrieve_response.rbs +2 -1
- data/sig/whop_sdk/models/card_brands.rbs +2 -0
- data/sig/whop_sdk/models/card_create_params.rbs +85 -0
- data/sig/whop_sdk/models/card_create_response.rbs +200 -0
- data/sig/whop_sdk/models/card_list_params.rbs +32 -0
- data/sig/whop_sdk/models/card_list_response.rbs +214 -0
- data/sig/whop_sdk/models/card_retrieve_params.rbs +36 -0
- data/sig/whop_sdk/models/card_retrieve_response.rbs +200 -0
- data/sig/whop_sdk/models/card_update_params.rbs +164 -0
- data/sig/whop_sdk/models/card_update_response.rbs +200 -0
- data/sig/whop_sdk/models/chat_message_created_webhook_event.rbs +149 -0
- data/sig/whop_sdk/models/chat_reaction_created_webhook_event.rbs +154 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +16 -5
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +206 -649
- data/sig/whop_sdk/models/checkout_configuration_create_response.rbs +196 -0
- data/sig/whop_sdk/models/checkout_configuration_delete_params.rbs +20 -0
- data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +66 -32
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +88 -56
- data/sig/whop_sdk/models/checkout_configuration_retrieve_response.rbs +196 -0
- data/sig/whop_sdk/models/currency.rbs +6 -0
- data/sig/whop_sdk/models/deposit_create_params.rbs +83 -0
- data/sig/whop_sdk/models/deposit_create_response.rbs +187 -0
- data/sig/whop_sdk/models/deposit_list_params.rbs +23 -0
- data/sig/whop_sdk/models/deposit_list_response.rbs +87 -0
- data/sig/whop_sdk/models/dispute.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
- data/sig/whop_sdk/models/event_create_params.rbs +639 -0
- data/sig/whop_sdk/models/{conversion_create_response.rbs → event_create_response.rbs} +2 -2
- data/sig/whop_sdk/models/event_list_params.rbs +68 -0
- data/sig/whop_sdk/models/event_list_response.rbs +231 -0
- data/sig/whop_sdk/models/file_create_params.rbs +4 -18
- data/sig/whop_sdk/models/file_create_response.rbs +4 -15
- data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
- data/sig/whop_sdk/models/file_visibility.rbs +14 -0
- data/sig/whop_sdk/models/financial_activity_list_params.rbs +98 -0
- data/sig/whop_sdk/models/financial_activity_list_response.rbs +935 -0
- data/sig/whop_sdk/models/granularities.rbs +16 -0
- data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/invoice_create_params.rbs +20 -0
- data/sig/whop_sdk/models/invoice_update_params.rbs +10 -0
- data/sig/whop_sdk/models/ledger_account_funds_available_webhook_event.rbs +418 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
- data/sig/whop_sdk/models/media_asset.rbs +160 -0
- data/sig/whop_sdk/models/media_generate_params.rbs +99 -0
- data/sig/whop_sdk/models/media_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/membership.rbs +19 -6
- data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
- data/sig/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbs +45 -0
- data/sig/whop_sdk/models/payment.rbs +161 -15
- data/sig/whop_sdk/models/payment_create_params.rbs +16 -6
- data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +104 -15
- data/sig/whop_sdk/models/payout_create_params.rbs +50 -0
- data/sig/whop_sdk/models/payout_create_response.rbs +139 -0
- data/sig/whop_sdk/models/payout_list_params.rbs +70 -0
- data/sig/whop_sdk/models/payout_list_response.rbs +153 -0
- data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +25 -4
- data/sig/whop_sdk/models/payouts/method_list_params.rbs +107 -0
- data/sig/whop_sdk/models/payouts/method_list_response.rbs +229 -0
- data/sig/whop_sdk/models/person_list_params.rbs +97 -0
- data/sig/whop_sdk/models/person_list_response.rbs +162 -0
- data/sig/whop_sdk/models/person_retrieve_params.rbs +42 -0
- data/sig/whop_sdk/models/person_retrieve_response.rbs +175 -0
- data/sig/whop_sdk/models/plan.rbs +325 -119
- data/sig/whop_sdk/models/plan_calculate_tax_params.rbs +344 -0
- data/sig/whop_sdk/models/plan_calculate_tax_response.rbs +67 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +139 -98
- data/sig/whop_sdk/models/plan_list_params.rbs +93 -54
- data/sig/whop_sdk/models/plan_list_response.rbs +75 -126
- data/sig/whop_sdk/models/plan_update_params.rbs +115 -82
- data/sig/whop_sdk/models/product.rbs +5 -0
- data/sig/whop_sdk/models/product_create_params.rbs +33 -124
- data/sig/whop_sdk/models/product_list_item.rbs +5 -0
- data/sig/whop_sdk/models/product_list_params.rbs +53 -48
- data/sig/whop_sdk/models/product_update_params.rbs +15 -88
- data/sig/whop_sdk/models/referral_referred_users_params.rbs +63 -0
- data/sig/whop_sdk/models/referral_referred_users_response.rbs +140 -0
- data/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs +46 -0
- data/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs +221 -0
- data/sig/whop_sdk/models/referrals/business_list_params.rbs +176 -0
- data/sig/whop_sdk/models/referrals/business_list_response.rbs +267 -0
- data/sig/whop_sdk/models/referrals/business_retrieve_params.rbs +22 -0
- data/sig/whop_sdk/models/referrals/business_retrieve_response.rbs +677 -0
- data/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs +139 -0
- data/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs +288 -0
- data/sig/whop_sdk/models/referrals/partner_create_params.rbs +17 -0
- data/sig/whop_sdk/models/referrals/partner_create_response.rbs +21 -0
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
- data/sig/whop_sdk/models/result_label_keys.rbs +80 -0
- data/sig/whop_sdk/models/setup_intent.rbs +8 -3
- data/sig/whop_sdk/models/social_account.rbs +74 -0
- data/sig/whop_sdk/models/social_account_connect_params.rbs +69 -0
- data/sig/whop_sdk/models/social_account_connect_response.rbs +13 -0
- data/sig/whop_sdk/models/social_account_create_params.rbs +43 -0
- data/sig/whop_sdk/models/social_account_delete_params.rbs +36 -0
- data/sig/whop_sdk/models/social_account_delete_response.rbs +5 -0
- data/sig/whop_sdk/models/social_account_list_params.rbs +152 -0
- data/sig/whop_sdk/models/social_account_post.rbs +111 -0
- data/sig/whop_sdk/models/social_account_posts_params.rbs +52 -0
- data/sig/whop_sdk/models/social_account_posts_response.rbs +37 -0
- data/sig/whop_sdk/models/stat_list_params.rbs +14 -0
- data/sig/whop_sdk/models/stat_list_response.rbs +72 -0
- data/sig/whop_sdk/models/stat_retrieve_params.rbs +211 -0
- data/sig/whop_sdk/models/stat_retrieve_response.rbs +81 -0
- data/sig/whop_sdk/models/swap_create_params.rbs +72 -0
- data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
- data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
- data/sig/whop_sdk/models/swap_create_response.rbs +73 -0
- data/sig/whop_sdk/models/swap_list_params.rbs +23 -0
- data/sig/whop_sdk/models/swap_list_response.rbs +68 -0
- data/sig/whop_sdk/models/swap_retrieve_params.rbs +20 -0
- data/sig/whop_sdk/models/swap_retrieve_response.rbs +55 -0
- data/sig/whop_sdk/models/tax_identifier_type.rbs +4 -0
- data/sig/whop_sdk/models/transfer_create_params.rbs +47 -10
- data/sig/whop_sdk/models/transfer_create_response.rbs +366 -0
- data/sig/whop_sdk/models/transfer_list_params.rbs +77 -42
- data/sig/whop_sdk/models/transfer_list_response.rbs +14 -14
- data/sig/whop_sdk/models/{transfer.rbs → transfer_retrieve_response.rbs} +83 -78
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +30 -22
- data/sig/whop_sdk/models/user.rbs +203 -16
- data/sig/whop_sdk/models/user_balance.rbs +171 -0
- data/sig/whop_sdk/models/user_check_access_response.rbs +19 -4
- data/sig/whop_sdk/models/user_list_params.rbs +30 -20
- data/sig/whop_sdk/models/user_retrieve_params.rbs +59 -4
- data/sig/whop_sdk/models/user_update_me_params.rbs +74 -0
- data/sig/whop_sdk/models/user_update_params.rbs +42 -24
- data/sig/whop_sdk/models/verification_create_params.rbs +364 -0
- data/sig/whop_sdk/models/verification_create_response.rbs +333 -0
- data/sig/whop_sdk/models/verification_list_params.rbs +40 -20
- data/sig/whop_sdk/models/verification_list_response.rbs +337 -20
- data/sig/whop_sdk/models/verification_retrieve_params.rbs +7 -4
- data/sig/whop_sdk/models/verification_retrieve_response.rbs +312 -14
- data/sig/whop_sdk/models/verification_update_params.rbs +570 -0
- data/sig/whop_sdk/models/verification_update_response.rbs +333 -0
- data/sig/whop_sdk/models/webhook_event.rbs +16 -0
- data/sig/whop_sdk/models/withdrawal.rbs +2 -0
- data/sig/whop_sdk/models/workforce/bounty_list_params.rbs +149 -0
- data/sig/whop_sdk/models/workforce/bounty_retrieve_params.rbs +22 -0
- data/sig/whop_sdk/models/workforce/workforce_bounty.rbs +232 -0
- data/sig/whop_sdk/models/workforce/workforce_bounty_list_item.rbs +227 -0
- data/sig/whop_sdk/models.rbs +151 -7
- data/sig/whop_sdk/resources/accounts/preferences.rbs +20 -0
- data/sig/whop_sdk/resources/accounts.rbs +76 -0
- data/sig/whop_sdk/resources/ad_campaigns.rbs +47 -15
- data/sig/whop_sdk/resources/ad_groups.rbs +77 -20
- data/sig/whop_sdk/resources/ad_reports.rbs +6 -4
- data/sig/whop_sdk/resources/ads.rbs +74 -12
- data/sig/whop_sdk/resources/apps.rbs +16 -0
- data/sig/whop_sdk/resources/audiences.rbs +28 -0
- data/sig/whop_sdk/resources/authorized_users.rbs +1 -0
- data/sig/whop_sdk/resources/bounties.rbs +4 -0
- data/sig/whop_sdk/resources/cards.rbs +47 -0
- data/sig/whop_sdk/resources/checkout_configurations.rbs +21 -11
- data/sig/whop_sdk/resources/deposits.rbs +20 -0
- data/sig/whop_sdk/resources/events.rbs +40 -0
- data/sig/whop_sdk/resources/files.rbs +1 -1
- data/sig/whop_sdk/resources/financial_activity.rbs +22 -0
- data/sig/whop_sdk/resources/media.rbs +22 -0
- data/sig/whop_sdk/resources/payments.rbs +1 -0
- data/sig/whop_sdk/resources/payouts/methods.rbs +23 -0
- data/sig/whop_sdk/resources/payouts.rbs +29 -0
- data/sig/whop_sdk/resources/people.rbs +28 -0
- data/sig/whop_sdk/resources/plans.rbs +37 -25
- data/sig/whop_sdk/resources/products.rbs +17 -31
- data/sig/whop_sdk/resources/referrals/businesses/earnings.rbs +25 -0
- data/sig/whop_sdk/resources/referrals/businesses.rbs +38 -0
- data/sig/whop_sdk/resources/referrals/partners.rbs +13 -0
- data/sig/whop_sdk/resources/referrals.rbs +21 -0
- data/sig/whop_sdk/resources/social_accounts.rbs +52 -0
- data/sig/whop_sdk/resources/stats.rbs +39 -0
- data/sig/whop_sdk/resources/swaps.rbs +41 -0
- data/sig/whop_sdk/resources/transfers.rbs +17 -14
- data/sig/whop_sdk/resources/users.rbs +26 -12
- data/sig/whop_sdk/resources/verifications.rbs +17 -7
- data/sig/whop_sdk/resources/webhooks.rbs +30 -22
- data/sig/whop_sdk/resources/workforce/bounties.rbs +30 -0
- data/sig/whop_sdk/resources/workforce.rbs +9 -0
- metadata +446 -65
- data/lib/whop_sdk/models/ad_campaign_list_response.rb +0 -126
- data/lib/whop_sdk/models/ad_campaign_pause_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
- data/lib/whop_sdk/models/ad_group_list_response.rb +0 -118
- data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
- data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
- data/lib/whop_sdk/models/ad_list_response.rb +0 -89
- data/lib/whop_sdk/models/ad_retrieve_response.rb +0 -133
- data/lib/whop_sdk/models/conversion_create_response.rb +0 -19
- data/lib/whop_sdk/models/payout_destination_category.rb +0 -20
- data/lib/whop_sdk/models/payout_method_list_params.rb +0 -54
- data/lib/whop_sdk/models/payout_method_list_response.rb +0 -140
- data/lib/whop_sdk/models/payout_method_retrieve_response.rb +0 -140
- data/lib/whop_sdk/models/transfer.rb +0 -299
- data/lib/whop_sdk/models/user_list_response.rb +0 -83
- data/lib/whop_sdk/resources/conversions.rb +0 -67
- data/lib/whop_sdk/resources/payout_methods.rb +0 -76
- data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +0 -239
- data/rbi/whop_sdk/models/ad_campaign_pause_response.rbi +0 -668
- data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
- data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
- data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
- data/rbi/whop_sdk/models/ad_group_list_response.rbi +0 -228
- data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
- data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
- data/rbi/whop_sdk/models/ad_list_response.rbi +0 -146
- data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
- data/rbi/whop_sdk/models/conversion_create_params.rbi +0 -661
- data/rbi/whop_sdk/models/payout_destination_category.rbi +0 -33
- data/rbi/whop_sdk/models/payout_method_list_params.rbi +0 -75
- data/rbi/whop_sdk/models/payout_method_list_response.rbi +0 -234
- data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +0 -238
- data/rbi/whop_sdk/models/transfer.rbi +0 -407
- data/rbi/whop_sdk/models/user_list_response.rbi +0 -124
- data/rbi/whop_sdk/resources/conversions.rbi +0 -71
- data/rbi/whop_sdk/resources/payout_methods.rbi +0 -66
- data/sig/whop_sdk/models/ad_campaign_list_response.rbs +0 -98
- data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_group_list_response.rbs +0 -93
- data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_list_response.rbs +0 -72
- data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
- data/sig/whop_sdk/models/conversion_create_params.rbs +0 -349
- data/sig/whop_sdk/models/payout_destination_category.rbs +0 -19
- data/sig/whop_sdk/models/payout_method_list_params.rbs +0 -46
- data/sig/whop_sdk/models/payout_method_list_response.rbs +0 -97
- data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +0 -97
- data/sig/whop_sdk/models/user_list_response.rbs +0 -55
- data/sig/whop_sdk/resources/conversions.rbs +0 -25
- data/sig/whop_sdk/resources/payout_methods.rbs +0 -21
data/lib/whop_sdk/models/plan.rb
CHANGED
|
@@ -4,420 +4,485 @@ module WhopSDK
|
|
|
4
4
|
module Models
|
|
5
5
|
class Plan < WhopSDK::Internal::Type::BaseModel
|
|
6
6
|
# @!attribute id
|
|
7
|
-
#
|
|
7
|
+
# Plan ID, prefixed `plan_`.
|
|
8
8
|
#
|
|
9
9
|
# @return [String]
|
|
10
10
|
required :id, String
|
|
11
11
|
|
|
12
|
+
# @!attribute account
|
|
13
|
+
# Account that sells this plan; `null` for standalone invoice plans.
|
|
14
|
+
#
|
|
15
|
+
# @return [Object, nil]
|
|
16
|
+
required :account, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
17
|
+
|
|
12
18
|
# @!attribute adaptive_pricing_enabled
|
|
13
|
-
# Whether
|
|
14
|
-
# does not check processor compatibility or feature flags.
|
|
19
|
+
# Whether this plan accepts local currency payments via adaptive pricing.
|
|
15
20
|
#
|
|
16
21
|
# @return [Boolean]
|
|
17
22
|
required :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean
|
|
18
23
|
|
|
19
24
|
# @!attribute billing_period
|
|
20
|
-
#
|
|
21
|
-
#
|
|
25
|
+
# Recurring billing interval in days, such as 30 for monthly or 365 for annual.
|
|
26
|
+
# `null` for one-time plans.
|
|
22
27
|
#
|
|
23
|
-
# @return [
|
|
24
|
-
required :billing_period,
|
|
28
|
+
# @return [Float, nil]
|
|
29
|
+
required :billing_period, Float, nil?: true
|
|
25
30
|
|
|
26
31
|
# @!attribute collect_tax
|
|
27
|
-
# Whether tax is collected on purchases of this plan
|
|
28
|
-
# configuration.
|
|
32
|
+
# Whether tax is collected on purchases of this plan.
|
|
29
33
|
#
|
|
30
34
|
# @return [Boolean]
|
|
31
35
|
required :collect_tax, WhopSDK::Internal::Type::Boolean
|
|
32
36
|
|
|
33
|
-
# @!attribute company
|
|
34
|
-
# The company that sells this plan. Null for standalone invoice plans not linked
|
|
35
|
-
# to a company.
|
|
36
|
-
#
|
|
37
|
-
# @return [WhopSDK::Models::Plan::Company, nil]
|
|
38
|
-
required :company, -> { WhopSDK::Plan::Company }, nil?: true
|
|
39
|
-
|
|
40
37
|
# @!attribute created_at
|
|
41
|
-
#
|
|
38
|
+
# When the plan was created, as an ISO 8601 timestamp.
|
|
42
39
|
#
|
|
43
|
-
# @return [
|
|
44
|
-
required :created_at,
|
|
40
|
+
# @return [String]
|
|
41
|
+
required :created_at, String
|
|
45
42
|
|
|
46
43
|
# @!attribute currency
|
|
47
|
-
#
|
|
48
|
-
# amounts on the plan are denominated in this currency.
|
|
44
|
+
# Three-letter ISO currency code for this plan's prices.
|
|
49
45
|
#
|
|
50
|
-
# @return [Symbol, WhopSDK::Models::Currency]
|
|
51
|
-
required :currency, enum: -> { WhopSDK::Currency }
|
|
46
|
+
# @return [Symbol, WhopSDK::Models::Plan::Currency]
|
|
47
|
+
required :currency, enum: -> { WhopSDK::Plan::Currency }
|
|
52
48
|
|
|
53
49
|
# @!attribute custom_fields
|
|
54
|
-
# Custom input fields displayed on the checkout form that collect additional
|
|
55
|
-
# information from the buyer.
|
|
56
50
|
#
|
|
57
51
|
# @return [Array<WhopSDK::Models::Plan::CustomField>]
|
|
58
52
|
required :custom_fields, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Plan::CustomField] }
|
|
59
53
|
|
|
60
54
|
# @!attribute description
|
|
61
|
-
#
|
|
62
|
-
# Null if no description is set.
|
|
55
|
+
# Customer-visible plan description.
|
|
63
56
|
#
|
|
64
57
|
# @return [String, nil]
|
|
65
58
|
required :description, String, nil?: true
|
|
66
59
|
|
|
67
60
|
# @!attribute expiration_days
|
|
68
|
-
#
|
|
69
|
-
# For example, 365 for a one-year access pass.
|
|
61
|
+
# Access duration in days for expiration-based plans.
|
|
70
62
|
#
|
|
71
|
-
# @return [
|
|
72
|
-
required :expiration_days,
|
|
63
|
+
# @return [Float, nil]
|
|
64
|
+
required :expiration_days, Float, nil?: true
|
|
73
65
|
|
|
74
66
|
# @!attribute initial_price
|
|
75
|
-
#
|
|
76
|
-
# For one-time plans, this is the full price. For renewal plans, this is charged
|
|
77
|
-
# on top of the first renewal_price.
|
|
67
|
+
# Initial purchase price in plan currency.
|
|
78
68
|
#
|
|
79
69
|
# @return [Float]
|
|
80
70
|
required :initial_price, Float
|
|
81
71
|
|
|
82
72
|
# @!attribute internal_notes
|
|
83
|
-
# Private notes visible only to
|
|
84
|
-
# customers. Null if no notes have been added.
|
|
73
|
+
# Private notes visible only to authorized team members.
|
|
85
74
|
#
|
|
86
75
|
# @return [String, nil]
|
|
87
76
|
required :internal_notes, String, nil?: true
|
|
88
77
|
|
|
89
78
|
# @!attribute invoice
|
|
90
|
-
#
|
|
91
|
-
# specific invoice.
|
|
79
|
+
# Invoice this plan was generated for; `null` unless created for an invoice.
|
|
92
80
|
#
|
|
93
|
-
# @return [
|
|
94
|
-
required :invoice,
|
|
81
|
+
# @return [Object, nil]
|
|
82
|
+
required :invoice, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
95
83
|
|
|
96
84
|
# @!attribute member_count
|
|
97
|
-
#
|
|
98
|
-
# Only visible to authorized team members.
|
|
85
|
+
# Active memberships through this plan, when visible to the requester.
|
|
99
86
|
#
|
|
100
|
-
# @return [
|
|
101
|
-
required :member_count,
|
|
87
|
+
# @return [Float, nil]
|
|
88
|
+
required :member_count, Float, nil?: true
|
|
89
|
+
|
|
90
|
+
# @!attribute metadata
|
|
91
|
+
# Custom key-value pairs stored on the plan.
|
|
92
|
+
#
|
|
93
|
+
# @return [Object, nil]
|
|
94
|
+
required :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
102
95
|
|
|
103
96
|
# @!attribute payment_method_configuration
|
|
104
|
-
#
|
|
105
|
-
#
|
|
97
|
+
# Payment method configuration (`enabled`, `disabled`,
|
|
98
|
+
# `include_platform_defaults`); `null` when plan uses default settings.
|
|
106
99
|
#
|
|
107
|
-
# @return [
|
|
108
|
-
required :payment_method_configuration,
|
|
100
|
+
# @return [Object, nil]
|
|
101
|
+
required :payment_method_configuration, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
109
102
|
|
|
110
103
|
# @!attribute plan_type
|
|
111
|
-
#
|
|
112
|
-
#
|
|
104
|
+
# Billing model for this plan: `renewal` (recurring) or `one_time` (single
|
|
105
|
+
# payment).
|
|
113
106
|
#
|
|
114
|
-
# @return [Symbol, WhopSDK::Models::PlanType]
|
|
115
|
-
required :plan_type, enum: -> { WhopSDK::PlanType }
|
|
107
|
+
# @return [Symbol, WhopSDK::Models::Plan::PlanType]
|
|
108
|
+
required :plan_type, enum: -> { WhopSDK::Plan::PlanType }
|
|
116
109
|
|
|
117
110
|
# @!attribute product
|
|
118
|
-
#
|
|
119
|
-
# linked to a product.
|
|
111
|
+
# Product this plan belongs to; `null` for standalone plans.
|
|
120
112
|
#
|
|
121
|
-
# @return [
|
|
122
|
-
required :product,
|
|
113
|
+
# @return [Object, nil]
|
|
114
|
+
required :product, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
123
115
|
|
|
124
116
|
# @!attribute purchase_url
|
|
125
|
-
#
|
|
126
|
-
# product page.
|
|
117
|
+
# URL where customers can purchase this plan directly.
|
|
127
118
|
#
|
|
128
119
|
# @return [String]
|
|
129
120
|
required :purchase_url, String
|
|
130
121
|
|
|
131
122
|
# @!attribute release_method
|
|
132
|
-
#
|
|
133
|
-
# 'waitlist' for waitlist-based access.
|
|
123
|
+
# Sales method for this plan, such as `buy_now` or `waitlist`.
|
|
134
124
|
#
|
|
135
|
-
# @return [Symbol, WhopSDK::Models::ReleaseMethod]
|
|
136
|
-
required :release_method, enum: -> { WhopSDK::ReleaseMethod }
|
|
125
|
+
# @return [Symbol, WhopSDK::Models::Plan::ReleaseMethod]
|
|
126
|
+
required :release_method, enum: -> { WhopSDK::Plan::ReleaseMethod }
|
|
137
127
|
|
|
138
128
|
# @!attribute renewal_price
|
|
139
|
-
#
|
|
140
|
-
# (e.g., 9.99 for $9.99/period). Zero for one-time plans.
|
|
129
|
+
# Recurring price charged every billing period.
|
|
141
130
|
#
|
|
142
131
|
# @return [Float]
|
|
143
132
|
required :renewal_price, Float
|
|
144
133
|
|
|
145
134
|
# @!attribute split_pay_required_payments
|
|
146
|
-
#
|
|
147
|
-
# pauses. Null if split pay is not configured. Must be greater than 1.
|
|
135
|
+
# Installment payments required before the subscription pauses.
|
|
148
136
|
#
|
|
149
|
-
# @return [
|
|
150
|
-
required :split_pay_required_payments,
|
|
137
|
+
# @return [Float, nil]
|
|
138
|
+
required :split_pay_required_payments, Float, nil?: true
|
|
151
139
|
|
|
152
140
|
# @!attribute stock
|
|
153
|
-
#
|
|
154
|
-
# members. Null if the requester lacks permission.
|
|
141
|
+
# Units available for purchase, when visible to the requester.
|
|
155
142
|
#
|
|
156
|
-
# @return [
|
|
157
|
-
required :stock,
|
|
143
|
+
# @return [Float, nil]
|
|
144
|
+
required :stock, Float, nil?: true
|
|
158
145
|
|
|
159
146
|
# @!attribute tax_type
|
|
160
|
-
# How tax is handled for this plan
|
|
161
|
-
#
|
|
147
|
+
# How tax is handled for this plan.
|
|
148
|
+
#
|
|
149
|
+
# @return [Symbol, WhopSDK::Models::Plan::TaxType]
|
|
150
|
+
required :tax_type, enum: -> { WhopSDK::Plan::TaxType }
|
|
151
|
+
|
|
152
|
+
# @!attribute three_ds_level
|
|
153
|
+
# 3D Secure behavior for this plan; `null` inherits account default.
|
|
162
154
|
#
|
|
163
|
-
# @return [Symbol, WhopSDK::Models::
|
|
164
|
-
required :
|
|
155
|
+
# @return [Symbol, WhopSDK::Models::Plan::ThreeDSLevel, nil]
|
|
156
|
+
required :three_ds_level, enum: -> { WhopSDK::Plan::ThreeDSLevel }, nil?: true
|
|
165
157
|
|
|
166
158
|
# @!attribute title
|
|
167
|
-
#
|
|
168
|
-
# checkout. Maximum 30 characters. Null if no title has been set.
|
|
159
|
+
# Plan display name shown to customers.
|
|
169
160
|
#
|
|
170
161
|
# @return [String, nil]
|
|
171
162
|
required :title, String, nil?: true
|
|
172
163
|
|
|
173
164
|
# @!attribute trial_period_days
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
# plan.
|
|
165
|
+
# Free trial days before the first renewal charge. `null` if no trial is
|
|
166
|
+
# configured or the user has already used a trial for this plan.
|
|
177
167
|
#
|
|
178
|
-
# @return [
|
|
179
|
-
required :trial_period_days,
|
|
168
|
+
# @return [Float, nil]
|
|
169
|
+
required :trial_period_days, Float, nil?: true
|
|
180
170
|
|
|
181
171
|
# @!attribute unlimited_stock
|
|
182
|
-
#
|
|
183
|
-
# purchases are limited by the stock field.
|
|
172
|
+
# Whether the plan has unlimited stock.
|
|
184
173
|
#
|
|
185
174
|
# @return [Boolean]
|
|
186
175
|
required :unlimited_stock, WhopSDK::Internal::Type::Boolean
|
|
187
176
|
|
|
188
177
|
# @!attribute updated_at
|
|
189
|
-
#
|
|
178
|
+
# When the plan was last updated, as an ISO 8601 timestamp.
|
|
190
179
|
#
|
|
191
|
-
# @return [
|
|
192
|
-
required :updated_at,
|
|
180
|
+
# @return [String]
|
|
181
|
+
required :updated_at, String
|
|
193
182
|
|
|
194
183
|
# @!attribute visibility
|
|
195
|
-
#
|
|
196
|
-
# plan is only accessible via direct link.
|
|
184
|
+
# Whether the plan is visible to customers or hidden from public view.
|
|
197
185
|
#
|
|
198
|
-
# @return [Symbol, WhopSDK::Models::Visibility]
|
|
199
|
-
required :visibility, enum: -> { WhopSDK::Visibility }
|
|
186
|
+
# @return [Symbol, WhopSDK::Models::Plan::Visibility]
|
|
187
|
+
required :visibility, enum: -> { WhopSDK::Plan::Visibility }
|
|
200
188
|
|
|
201
|
-
# @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, collect_tax:,
|
|
189
|
+
# @!method initialize(id:, account:, adaptive_pricing_enabled:, billing_period:, collect_tax:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, metadata:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, split_pay_required_payments:, stock:, tax_type:, three_ds_level:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
|
|
202
190
|
# Some parameter documentations has been truncated, see {WhopSDK::Models::Plan}
|
|
203
191
|
# for more details.
|
|
204
192
|
#
|
|
205
|
-
#
|
|
206
|
-
# belong to a product, where they represent different pricing options such as
|
|
207
|
-
# one-time payments, recurring subscriptions, or free trials.
|
|
208
|
-
#
|
|
209
|
-
# @param id [String] The unique identifier for the plan.
|
|
210
|
-
#
|
|
211
|
-
# @param adaptive_pricing_enabled [Boolean] Whether the creator has turned on adaptive pricing for this plan. Raw setting —
|
|
212
|
-
#
|
|
213
|
-
# @param billing_period [Integer, nil] The number of days between each recurring charge. Null for one-time plans. For e
|
|
214
|
-
#
|
|
215
|
-
# @param collect_tax [Boolean] Whether tax is collected on purchases of this plan, based on the company's tax c
|
|
216
|
-
#
|
|
217
|
-
# @param company [WhopSDK::Models::Plan::Company, nil] The company that sells this plan. Null for standalone invoice plans not linked t
|
|
218
|
-
#
|
|
219
|
-
# @param created_at [Time] The datetime the plan was created.
|
|
220
|
-
#
|
|
221
|
-
# @param currency [Symbol, WhopSDK::Models::Currency] The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary
|
|
222
|
-
#
|
|
223
|
-
# @param custom_fields [Array<WhopSDK::Models::Plan::CustomField>] Custom input fields displayed on the checkout form that collect additional infor
|
|
193
|
+
# @param id [String] Plan ID, prefixed `plan_`.
|
|
224
194
|
#
|
|
225
|
-
# @param
|
|
195
|
+
# @param account [Object, nil] Account that sells this plan; `null` for standalone invoice plans.
|
|
226
196
|
#
|
|
227
|
-
# @param
|
|
197
|
+
# @param adaptive_pricing_enabled [Boolean] Whether this plan accepts local currency payments via adaptive pricing.
|
|
228
198
|
#
|
|
229
|
-
# @param
|
|
199
|
+
# @param billing_period [Float, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual. `n
|
|
230
200
|
#
|
|
231
|
-
# @param
|
|
201
|
+
# @param collect_tax [Boolean] Whether tax is collected on purchases of this plan.
|
|
232
202
|
#
|
|
233
|
-
# @param
|
|
203
|
+
# @param created_at [String] When the plan was created, as an ISO 8601 timestamp.
|
|
234
204
|
#
|
|
235
|
-
# @param
|
|
205
|
+
# @param currency [Symbol, WhopSDK::Models::Plan::Currency] Three-letter ISO currency code for this plan's prices.
|
|
236
206
|
#
|
|
237
|
-
# @param
|
|
207
|
+
# @param custom_fields [Array<WhopSDK::Models::Plan::CustomField>]
|
|
238
208
|
#
|
|
239
|
-
# @param
|
|
209
|
+
# @param description [String, nil] Customer-visible plan description.
|
|
240
210
|
#
|
|
241
|
-
# @param
|
|
211
|
+
# @param expiration_days [Float, nil] Access duration in days for expiration-based plans.
|
|
242
212
|
#
|
|
243
|
-
# @param
|
|
213
|
+
# @param initial_price [Float] Initial purchase price in plan currency.
|
|
244
214
|
#
|
|
245
|
-
# @param
|
|
215
|
+
# @param internal_notes [String, nil] Private notes visible only to authorized team members.
|
|
246
216
|
#
|
|
247
|
-
# @param
|
|
217
|
+
# @param invoice [Object, nil] Invoice this plan was generated for; `null` unless created for an invoice.
|
|
248
218
|
#
|
|
249
|
-
# @param
|
|
219
|
+
# @param member_count [Float, nil] Active memberships through this plan, when visible to the requester.
|
|
250
220
|
#
|
|
251
|
-
# @param
|
|
221
|
+
# @param metadata [Object, nil] Custom key-value pairs stored on the plan.
|
|
252
222
|
#
|
|
253
|
-
# @param
|
|
223
|
+
# @param payment_method_configuration [Object, nil] Payment method configuration (`enabled`, `disabled`, `include_platform_defaults`
|
|
254
224
|
#
|
|
255
|
-
# @param
|
|
225
|
+
# @param plan_type [Symbol, WhopSDK::Models::Plan::PlanType] Billing model for this plan: `renewal` (recurring) or `one_time` (single payment
|
|
256
226
|
#
|
|
257
|
-
# @param
|
|
258
|
-
#
|
|
259
|
-
# @param
|
|
260
|
-
#
|
|
261
|
-
# @param
|
|
262
|
-
#
|
|
263
|
-
# @param
|
|
264
|
-
|
|
265
|
-
#
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
227
|
+
# @param product [Object, nil] Product this plan belongs to; `null` for standalone plans.
|
|
228
|
+
#
|
|
229
|
+
# @param purchase_url [String] URL where customers can purchase this plan directly.
|
|
230
|
+
#
|
|
231
|
+
# @param release_method [Symbol, WhopSDK::Models::Plan::ReleaseMethod] Sales method for this plan, such as `buy_now` or `waitlist`.
|
|
232
|
+
#
|
|
233
|
+
# @param renewal_price [Float] Recurring price charged every billing period.
|
|
234
|
+
#
|
|
235
|
+
# @param split_pay_required_payments [Float, nil] Installment payments required before the subscription pauses.
|
|
236
|
+
#
|
|
237
|
+
# @param stock [Float, nil] Units available for purchase, when visible to the requester.
|
|
238
|
+
#
|
|
239
|
+
# @param tax_type [Symbol, WhopSDK::Models::Plan::TaxType] How tax is handled for this plan.
|
|
240
|
+
#
|
|
241
|
+
# @param three_ds_level [Symbol, WhopSDK::Models::Plan::ThreeDSLevel, nil] 3D Secure behavior for this plan; `null` inherits account default.
|
|
242
|
+
#
|
|
243
|
+
# @param title [String, nil] Plan display name shown to customers.
|
|
244
|
+
#
|
|
245
|
+
# @param trial_period_days [Float, nil] Free trial days before the first renewal charge. `null` if no trial is configure
|
|
246
|
+
#
|
|
247
|
+
# @param unlimited_stock [Boolean] Whether the plan has unlimited stock.
|
|
248
|
+
#
|
|
249
|
+
# @param updated_at [String] When the plan was last updated, as an ISO 8601 timestamp.
|
|
250
|
+
#
|
|
251
|
+
# @param visibility [Symbol, WhopSDK::Models::Plan::Visibility] Whether the plan is visible to customers or hidden from public view.
|
|
252
|
+
|
|
253
|
+
# Three-letter ISO currency code for this plan's prices.
|
|
254
|
+
#
|
|
255
|
+
# @see WhopSDK::Models::Plan#currency
|
|
256
|
+
module Currency
|
|
257
|
+
extend WhopSDK::Internal::Type::Enum
|
|
258
|
+
|
|
259
|
+
USD = :usd
|
|
260
|
+
SGD = :sgd
|
|
261
|
+
INR = :inr
|
|
262
|
+
AUD = :aud
|
|
263
|
+
BRL = :brl
|
|
264
|
+
CAD = :cad
|
|
265
|
+
DKK = :dkk
|
|
266
|
+
EUR = :eur
|
|
267
|
+
NOK = :nok
|
|
268
|
+
GBP = :gbp
|
|
269
|
+
SEK = :sek
|
|
270
|
+
CHF = :chf
|
|
271
|
+
HKD = :hkd
|
|
272
|
+
HUF = :huf
|
|
273
|
+
JPY = :jpy
|
|
274
|
+
MXN = :mxn
|
|
275
|
+
MYR = :myr
|
|
276
|
+
PLN = :pln
|
|
277
|
+
CZK = :czk
|
|
278
|
+
NZD = :nzd
|
|
279
|
+
AED = :aed
|
|
280
|
+
ETH = :eth
|
|
281
|
+
APE = :ape
|
|
282
|
+
COP = :cop
|
|
283
|
+
RON = :ron
|
|
284
|
+
THB = :thb
|
|
285
|
+
BGN = :bgn
|
|
286
|
+
IDR = :idr
|
|
287
|
+
DOP = :dop
|
|
288
|
+
PHP = :php
|
|
289
|
+
TRY = :try
|
|
290
|
+
KRW = :krw
|
|
291
|
+
TWD = :twd
|
|
292
|
+
VND = :vnd
|
|
293
|
+
PKR = :pkr
|
|
294
|
+
CLP = :clp
|
|
295
|
+
UYU = :uyu
|
|
296
|
+
ARS = :ars
|
|
297
|
+
ZAR = :zar
|
|
298
|
+
DZD = :dzd
|
|
299
|
+
TND = :tnd
|
|
300
|
+
MAD = :mad
|
|
301
|
+
KES = :kes
|
|
302
|
+
KWD = :kwd
|
|
303
|
+
JOD = :jod
|
|
304
|
+
ALL = :all
|
|
305
|
+
XCD = :xcd
|
|
306
|
+
AMD = :amd
|
|
307
|
+
BSD = :bsd
|
|
308
|
+
BHD = :bhd
|
|
309
|
+
BOB = :bob
|
|
310
|
+
BAM = :bam
|
|
311
|
+
KHR = :khr
|
|
312
|
+
CRC = :crc
|
|
313
|
+
XOF = :xof
|
|
314
|
+
EGP = :egp
|
|
315
|
+
ETB = :etb
|
|
316
|
+
GMD = :gmd
|
|
317
|
+
GHS = :ghs
|
|
318
|
+
GTQ = :gtq
|
|
319
|
+
GYD = :gyd
|
|
320
|
+
ILS = :ils
|
|
321
|
+
JMD = :jmd
|
|
322
|
+
MOP = :mop
|
|
323
|
+
MGA = :mga
|
|
324
|
+
MUR = :mur
|
|
325
|
+
MDL = :mdl
|
|
326
|
+
MNT = :mnt
|
|
327
|
+
NAD = :nad
|
|
328
|
+
NGN = :ngn
|
|
329
|
+
MKD = :mkd
|
|
330
|
+
OMR = :omr
|
|
331
|
+
PYG = :pyg
|
|
332
|
+
PEN = :pen
|
|
333
|
+
QAR = :qar
|
|
334
|
+
RWF = :rwf
|
|
335
|
+
SAR = :sar
|
|
336
|
+
RSD = :rsd
|
|
337
|
+
LKR = :lkr
|
|
338
|
+
TZS = :tzs
|
|
339
|
+
TTD = :ttd
|
|
340
|
+
UZS = :uzs
|
|
341
|
+
RUB = :rub
|
|
342
|
+
BTC = :btc
|
|
343
|
+
CNY = :cny
|
|
344
|
+
USDT = :usdt
|
|
345
|
+
KZT = :kzt
|
|
346
|
+
AWG = :awg
|
|
347
|
+
WHOP_USD = :whop_usd
|
|
348
|
+
XAU = :xau
|
|
349
|
+
|
|
350
|
+
# @!method self.values
|
|
351
|
+
# @return [Array<Symbol>]
|
|
286
352
|
end
|
|
287
353
|
|
|
288
354
|
class CustomField < WhopSDK::Internal::Type::BaseModel
|
|
289
355
|
# @!attribute id
|
|
290
|
-
#
|
|
356
|
+
# Custom field ID.
|
|
291
357
|
#
|
|
292
358
|
# @return [String]
|
|
293
359
|
required :id, String
|
|
294
360
|
|
|
295
361
|
# @!attribute field_type
|
|
296
|
-
#
|
|
362
|
+
# Custom field input type.
|
|
297
363
|
#
|
|
298
|
-
# @return [Symbol,
|
|
299
|
-
required :field_type,
|
|
364
|
+
# @return [Symbol, WhopSDK::Models::Plan::CustomField::FieldType]
|
|
365
|
+
required :field_type, enum: -> { WhopSDK::Plan::CustomField::FieldType }
|
|
300
366
|
|
|
301
367
|
# @!attribute name
|
|
302
|
-
#
|
|
368
|
+
# Field label shown to customer at checkout.
|
|
303
369
|
#
|
|
304
370
|
# @return [String]
|
|
305
371
|
required :name, String
|
|
306
372
|
|
|
307
373
|
# @!attribute order
|
|
308
|
-
#
|
|
374
|
+
# Field position on checkout form.
|
|
309
375
|
#
|
|
310
|
-
# @return [
|
|
311
|
-
required :order,
|
|
376
|
+
# @return [Float]
|
|
377
|
+
required :order, Float
|
|
312
378
|
|
|
313
379
|
# @!attribute placeholder
|
|
314
|
-
#
|
|
380
|
+
# Placeholder text shown in empty field.
|
|
315
381
|
#
|
|
316
382
|
# @return [String, nil]
|
|
317
383
|
required :placeholder, String, nil?: true
|
|
318
384
|
|
|
319
385
|
# @!attribute required
|
|
320
|
-
# Whether
|
|
386
|
+
# Whether the customer must complete this field to check out.
|
|
321
387
|
#
|
|
322
388
|
# @return [Boolean]
|
|
323
389
|
required :required, WhopSDK::Internal::Type::Boolean
|
|
324
390
|
|
|
325
|
-
# @!method initialize(id:, name:, order:, placeholder:, required
|
|
326
|
-
#
|
|
391
|
+
# @!method initialize(id:, field_type:, name:, order:, placeholder:, required:)
|
|
392
|
+
# Custom input fields collected on the checkout form.
|
|
327
393
|
#
|
|
328
|
-
# @param id [String]
|
|
394
|
+
# @param id [String] Custom field ID.
|
|
329
395
|
#
|
|
330
|
-
# @param
|
|
396
|
+
# @param field_type [Symbol, WhopSDK::Models::Plan::CustomField::FieldType] Custom field input type.
|
|
331
397
|
#
|
|
332
|
-
# @param
|
|
398
|
+
# @param name [String] Field label shown to customer at checkout.
|
|
333
399
|
#
|
|
334
|
-
# @param
|
|
400
|
+
# @param order [Float] Field position on checkout form.
|
|
335
401
|
#
|
|
336
|
-
# @param
|
|
402
|
+
# @param placeholder [String, nil] Placeholder text shown in empty field.
|
|
337
403
|
#
|
|
338
|
-
# @param
|
|
339
|
-
end
|
|
404
|
+
# @param required [Boolean] Whether the customer must complete this field to check out.
|
|
340
405
|
|
|
341
|
-
|
|
342
|
-
class Invoice < WhopSDK::Internal::Type::BaseModel
|
|
343
|
-
# @!attribute id
|
|
344
|
-
# The unique identifier for the invoice.
|
|
406
|
+
# Custom field input type.
|
|
345
407
|
#
|
|
346
|
-
#
|
|
347
|
-
|
|
408
|
+
# @see WhopSDK::Models::Plan::CustomField#field_type
|
|
409
|
+
module FieldType
|
|
410
|
+
extend WhopSDK::Internal::Type::Enum
|
|
348
411
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
412
|
+
TEXT = :text
|
|
413
|
+
|
|
414
|
+
# @!method self.values
|
|
415
|
+
# @return [Array<Symbol>]
|
|
416
|
+
end
|
|
354
417
|
end
|
|
355
418
|
|
|
356
|
-
#
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
363
|
-
required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
364
|
-
|
|
365
|
-
# @!attribute enabled
|
|
366
|
-
# An array of payment method identifiers that are explicitly enabled. This means
|
|
367
|
-
# these payment methods will be shown on checkout. Example use case is to only
|
|
368
|
-
# enable a specific payment method like cashapp, or extending the platform
|
|
369
|
-
# defaults with additional methods.
|
|
370
|
-
#
|
|
371
|
-
# @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
|
|
372
|
-
required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
|
|
419
|
+
# Billing model for this plan: `renewal` (recurring) or `one_time` (single
|
|
420
|
+
# payment).
|
|
421
|
+
#
|
|
422
|
+
# @see WhopSDK::Models::Plan#plan_type
|
|
423
|
+
module PlanType
|
|
424
|
+
extend WhopSDK::Internal::Type::Enum
|
|
373
425
|
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
# in this configuration. The full list of default payment methods can be found in
|
|
377
|
-
# the documentation at docs.whop.com/payments.
|
|
378
|
-
#
|
|
379
|
-
# @return [Boolean]
|
|
380
|
-
required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
|
|
426
|
+
RENEWAL = :renewal
|
|
427
|
+
ONE_TIME = :one_time
|
|
381
428
|
|
|
382
|
-
# @!method
|
|
383
|
-
#
|
|
384
|
-
# {WhopSDK::Models::Plan::PaymentMethodConfiguration} for more details.
|
|
385
|
-
#
|
|
386
|
-
# The explicit payment method configuration specifying which payment methods are
|
|
387
|
-
# enabled or disabled for this plan. Null if the plan uses default settings.
|
|
388
|
-
#
|
|
389
|
-
# @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
|
|
390
|
-
#
|
|
391
|
-
# @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
|
|
392
|
-
#
|
|
393
|
-
# @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
|
|
429
|
+
# @!method self.values
|
|
430
|
+
# @return [Array<Symbol>]
|
|
394
431
|
end
|
|
395
432
|
|
|
396
|
-
#
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
# @return [String]
|
|
402
|
-
required :id, String
|
|
433
|
+
# Sales method for this plan, such as `buy_now` or `waitlist`.
|
|
434
|
+
#
|
|
435
|
+
# @see WhopSDK::Models::Plan#release_method
|
|
436
|
+
module ReleaseMethod
|
|
437
|
+
extend WhopSDK::Internal::Type::Enum
|
|
403
438
|
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
# search results.
|
|
407
|
-
#
|
|
408
|
-
# @return [String]
|
|
409
|
-
required :title, String
|
|
439
|
+
BUY_NOW = :buy_now
|
|
440
|
+
WAITLIST = :waitlist
|
|
410
441
|
|
|
411
|
-
# @!method
|
|
412
|
-
#
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
442
|
+
# @!method self.values
|
|
443
|
+
# @return [Array<Symbol>]
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
# How tax is handled for this plan.
|
|
447
|
+
#
|
|
448
|
+
# @see WhopSDK::Models::Plan#tax_type
|
|
449
|
+
module TaxType
|
|
450
|
+
extend WhopSDK::Internal::Type::Enum
|
|
451
|
+
|
|
452
|
+
INCLUSIVE = :inclusive
|
|
453
|
+
EXCLUSIVE = :exclusive
|
|
454
|
+
UNSPECIFIED = :unspecified
|
|
455
|
+
|
|
456
|
+
# @!method self.values
|
|
457
|
+
# @return [Array<Symbol>]
|
|
458
|
+
end
|
|
459
|
+
|
|
460
|
+
# 3D Secure behavior for this plan; `null` inherits account default.
|
|
461
|
+
#
|
|
462
|
+
# @see WhopSDK::Models::Plan#three_ds_level
|
|
463
|
+
module ThreeDSLevel
|
|
464
|
+
extend WhopSDK::Internal::Type::Enum
|
|
465
|
+
|
|
466
|
+
MANDATE_CHALLENGE = :mandate_challenge
|
|
467
|
+
FRICTIONLESS = :frictionless
|
|
468
|
+
|
|
469
|
+
# @!method self.values
|
|
470
|
+
# @return [Array<Symbol>]
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
# Whether the plan is visible to customers or hidden from public view.
|
|
474
|
+
#
|
|
475
|
+
# @see WhopSDK::Models::Plan#visibility
|
|
476
|
+
module Visibility
|
|
477
|
+
extend WhopSDK::Internal::Type::Enum
|
|
478
|
+
|
|
479
|
+
VISIBLE = :visible
|
|
480
|
+
HIDDEN = :hidden
|
|
481
|
+
ARCHIVED = :archived
|
|
482
|
+
QUICK_LINK = :quick_link
|
|
483
|
+
|
|
484
|
+
# @!method self.values
|
|
485
|
+
# @return [Array<Symbol>]
|
|
421
486
|
end
|
|
422
487
|
end
|
|
423
488
|
end
|