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
|
@@ -0,0 +1,660 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Ads#create
|
|
6
|
+
class AdCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute ad_group
|
|
11
|
+
# An inline ad group to create (same shape as POST /ad_groups, including
|
|
12
|
+
# ad_campaign_id). Creates the ad group and the ad together. Provide this OR
|
|
13
|
+
# ad_group_id.
|
|
14
|
+
#
|
|
15
|
+
# @return [Object, nil]
|
|
16
|
+
optional :ad_group, WhopSDK::Internal::Type::Unknown
|
|
17
|
+
|
|
18
|
+
# @!attribute ad_group_id
|
|
19
|
+
# The existing ad group to create the ad in. Provide this OR ad_group, not both.
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :ad_group_id, String
|
|
23
|
+
|
|
24
|
+
# @!attribute call_to_action
|
|
25
|
+
# The call-to-action button shown on the ad.
|
|
26
|
+
#
|
|
27
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::CallToAction, nil]
|
|
28
|
+
optional :call_to_action, enum: -> { WhopSDK::AdCreateParams::CallToAction }
|
|
29
|
+
|
|
30
|
+
# @!attribute creatives
|
|
31
|
+
# The ad's creative assets. Each entry is an uploaded file id with an optional
|
|
32
|
+
# format; omit format for the original asset.
|
|
33
|
+
#
|
|
34
|
+
# @return [Array<WhopSDK::Models::AdCreateParams::Creative>, nil]
|
|
35
|
+
optional :creatives, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::Creative] }
|
|
36
|
+
|
|
37
|
+
# @!attribute descriptions
|
|
38
|
+
# The description variants shown on the ad.
|
|
39
|
+
#
|
|
40
|
+
# @return [Array<String>, nil]
|
|
41
|
+
optional :descriptions, WhopSDK::Internal::Type::ArrayOf[String]
|
|
42
|
+
|
|
43
|
+
# @!attribute headlines
|
|
44
|
+
# The headline variants shown on the ad.
|
|
45
|
+
#
|
|
46
|
+
# @return [Array<String>, nil]
|
|
47
|
+
optional :headlines, WhopSDK::Internal::Type::ArrayOf[String]
|
|
48
|
+
|
|
49
|
+
# @!attribute lead_form
|
|
50
|
+
# Instant lead form for the ad. Only allowed when the ad group's
|
|
51
|
+
# conversion_location is an instant-form destination (instant_forms,
|
|
52
|
+
# instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with
|
|
53
|
+
# lead_form_id.
|
|
54
|
+
#
|
|
55
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm, nil]
|
|
56
|
+
optional :lead_form, -> { WhopSDK::AdCreateParams::LeadForm }
|
|
57
|
+
|
|
58
|
+
# @!attribute lead_form_id
|
|
59
|
+
# Use an existing Meta instant form instead of creating one — the form's Meta id,
|
|
60
|
+
# from a form already on the ad's Facebook page. Only allowed when the ad group's
|
|
61
|
+
# conversion_location is an instant-form destination. Mutually exclusive with
|
|
62
|
+
# lead_form.
|
|
63
|
+
#
|
|
64
|
+
# @return [String, nil]
|
|
65
|
+
optional :lead_form_id, String
|
|
66
|
+
|
|
67
|
+
# @!attribute messaging_config
|
|
68
|
+
# Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt
|
|
69
|
+
# (keyword).
|
|
70
|
+
#
|
|
71
|
+
# @return [WhopSDK::Models::AdCreateParams::MessagingConfig, nil]
|
|
72
|
+
optional :messaging_config, -> { WhopSDK::AdCreateParams::MessagingConfig }
|
|
73
|
+
|
|
74
|
+
# @!attribute multi_advertiser_ads
|
|
75
|
+
# Whether the ad can appear alongside other advertisers' ads in the same unit.
|
|
76
|
+
# Defaults to true.
|
|
77
|
+
#
|
|
78
|
+
# @return [Boolean, nil]
|
|
79
|
+
optional :multi_advertiser_ads, WhopSDK::Internal::Type::Boolean
|
|
80
|
+
|
|
81
|
+
# @!attribute post_id
|
|
82
|
+
# Promote an existing post instead of uploading creatives — a Facebook post or
|
|
83
|
+
# Instagram media id. Mutually exclusive with creatives. Pair with post_source.
|
|
84
|
+
#
|
|
85
|
+
# @return [String, nil]
|
|
86
|
+
optional :post_id, String
|
|
87
|
+
|
|
88
|
+
# @!attribute post_source
|
|
89
|
+
# Which network post_id refers to — facebook (a page post) or instagram (a media
|
|
90
|
+
# id). Authoritative; when omitted the source is inferred from the id shape.
|
|
91
|
+
#
|
|
92
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::PostSource, nil]
|
|
93
|
+
optional :post_source, enum: -> { WhopSDK::AdCreateParams::PostSource }
|
|
94
|
+
|
|
95
|
+
# @!attribute primary_texts
|
|
96
|
+
# The primary text variants shown in the ad body.
|
|
97
|
+
#
|
|
98
|
+
# @return [Array<String>, nil]
|
|
99
|
+
optional :primary_texts, WhopSDK::Internal::Type::ArrayOf[String]
|
|
100
|
+
|
|
101
|
+
# @!attribute social_accounts
|
|
102
|
+
# The social accounts (Facebook page, Instagram profile) the ad runs under.
|
|
103
|
+
#
|
|
104
|
+
# @return [Array<WhopSDK::Models::AdCreateParams::SocialAccount>, nil]
|
|
105
|
+
optional :social_accounts, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::SocialAccount] }
|
|
106
|
+
|
|
107
|
+
# @!attribute title
|
|
108
|
+
# The display name of the ad.
|
|
109
|
+
#
|
|
110
|
+
# @return [String, nil]
|
|
111
|
+
optional :title, String
|
|
112
|
+
|
|
113
|
+
# @!attribute url
|
|
114
|
+
# The URL the ad links to.
|
|
115
|
+
#
|
|
116
|
+
# @return [String, nil]
|
|
117
|
+
optional :url, String
|
|
118
|
+
|
|
119
|
+
# @!attribute url_parameters
|
|
120
|
+
# Query parameters appended to the destination URL, as a string-to-string map.
|
|
121
|
+
#
|
|
122
|
+
# @return [Object, nil]
|
|
123
|
+
optional :url_parameters, WhopSDK::Internal::Type::Unknown
|
|
124
|
+
|
|
125
|
+
# @!method initialize(ad_group: nil, ad_group_id: nil, call_to_action: nil, creatives: nil, descriptions: nil, headlines: nil, lead_form: nil, lead_form_id: nil, messaging_config: nil, multi_advertiser_ads: nil, post_id: nil, post_source: nil, primary_texts: nil, social_accounts: nil, title: nil, url: nil, url_parameters: nil, request_options: {})
|
|
126
|
+
# Some parameter documentations has been truncated, see
|
|
127
|
+
# {WhopSDK::Models::AdCreateParams} for more details.
|
|
128
|
+
#
|
|
129
|
+
# @param ad_group [Object] An inline ad group to create (same shape as POST /ad_groups, including ad_campai
|
|
130
|
+
#
|
|
131
|
+
# @param ad_group_id [String] The existing ad group to create the ad in. Provide this OR ad_group, not both.
|
|
132
|
+
#
|
|
133
|
+
# @param call_to_action [Symbol, WhopSDK::Models::AdCreateParams::CallToAction] The call-to-action button shown on the ad.
|
|
134
|
+
#
|
|
135
|
+
# @param creatives [Array<WhopSDK::Models::AdCreateParams::Creative>] The ad's creative assets. Each entry is an uploaded file id with an optional for
|
|
136
|
+
#
|
|
137
|
+
# @param descriptions [Array<String>] The description variants shown on the ad.
|
|
138
|
+
#
|
|
139
|
+
# @param headlines [Array<String>] The headline variants shown on the ad.
|
|
140
|
+
#
|
|
141
|
+
# @param lead_form [WhopSDK::Models::AdCreateParams::LeadForm] Instant lead form for the ad. Only allowed when the ad group's conversion_locati
|
|
142
|
+
#
|
|
143
|
+
# @param lead_form_id [String] Use an existing Meta instant form instead of creating one — the form's Meta id,
|
|
144
|
+
#
|
|
145
|
+
# @param messaging_config [WhopSDK::Models::AdCreateParams::MessagingConfig] Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt
|
|
146
|
+
#
|
|
147
|
+
# @param multi_advertiser_ads [Boolean] Whether the ad can appear alongside other advertisers' ads in the same unit. Def
|
|
148
|
+
#
|
|
149
|
+
# @param post_id [String] Promote an existing post instead of uploading creatives — a Facebook post or Ins
|
|
150
|
+
#
|
|
151
|
+
# @param post_source [Symbol, WhopSDK::Models::AdCreateParams::PostSource] Which network post_id refers to — facebook (a page post) or instagram (a media i
|
|
152
|
+
#
|
|
153
|
+
# @param primary_texts [Array<String>] The primary text variants shown in the ad body.
|
|
154
|
+
#
|
|
155
|
+
# @param social_accounts [Array<WhopSDK::Models::AdCreateParams::SocialAccount>] The social accounts (Facebook page, Instagram profile) the ad runs under.
|
|
156
|
+
#
|
|
157
|
+
# @param title [String] The display name of the ad.
|
|
158
|
+
#
|
|
159
|
+
# @param url [String] The URL the ad links to.
|
|
160
|
+
#
|
|
161
|
+
# @param url_parameters [Object] Query parameters appended to the destination URL, as a string-to-string map.
|
|
162
|
+
#
|
|
163
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
164
|
+
|
|
165
|
+
# The call-to-action button shown on the ad.
|
|
166
|
+
module CallToAction
|
|
167
|
+
extend WhopSDK::Internal::Type::Enum
|
|
168
|
+
|
|
169
|
+
APPLY_NOW = :apply_now
|
|
170
|
+
BOOK_NOW = :book_now
|
|
171
|
+
CALL_NOW = :call_now
|
|
172
|
+
CONTACT_US = :contact_us
|
|
173
|
+
DOWNLOAD = :download
|
|
174
|
+
GET_DIRECTIONS = :get_directions
|
|
175
|
+
GET_OFFER = :get_offer
|
|
176
|
+
GET_QUOTE = :get_quote
|
|
177
|
+
LEARN_MORE = :learn_more
|
|
178
|
+
LISTEN_NOW = :listen_now
|
|
179
|
+
MESSAGE_PAGE = :message_page
|
|
180
|
+
NO_BUTTON = :no_button
|
|
181
|
+
OPEN_LINK = :open_link
|
|
182
|
+
ORDER_NOW = :order_now
|
|
183
|
+
REQUEST_TIME = :request_time
|
|
184
|
+
SEE_DETAILS = :see_details
|
|
185
|
+
SEE_MENU = :see_menu
|
|
186
|
+
SEND_UPDATES = :send_updates
|
|
187
|
+
SHOP_NOW = :shop_now
|
|
188
|
+
SIGN_UP = :sign_up
|
|
189
|
+
SUBSCRIBE = :subscribe
|
|
190
|
+
WATCH_MORE = :watch_more
|
|
191
|
+
|
|
192
|
+
# @!method self.values
|
|
193
|
+
# @return [Array<Symbol>]
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
class Creative < WhopSDK::Internal::Type::BaseModel
|
|
197
|
+
# @!attribute id
|
|
198
|
+
#
|
|
199
|
+
# @return [String, nil]
|
|
200
|
+
optional :id, String
|
|
201
|
+
|
|
202
|
+
# @!attribute crop
|
|
203
|
+
# The saved crop window for this creative, in source image pixels. Omit it for the
|
|
204
|
+
# original asset or for a format that has not been cropped.
|
|
205
|
+
#
|
|
206
|
+
# @return [WhopSDK::Models::AdCreateParams::Creative::Crop, nil]
|
|
207
|
+
optional :crop, -> { WhopSDK::AdCreateParams::Creative::Crop }
|
|
208
|
+
|
|
209
|
+
# @!attribute format_
|
|
210
|
+
#
|
|
211
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::Creative::Format, nil]
|
|
212
|
+
optional :format_, enum: -> { WhopSDK::AdCreateParams::Creative::Format }, api_name: :format
|
|
213
|
+
|
|
214
|
+
# @!method initialize(id: nil, crop: nil, format_: nil)
|
|
215
|
+
# Some parameter documentations has been truncated, see
|
|
216
|
+
# {WhopSDK::Models::AdCreateParams::Creative} for more details.
|
|
217
|
+
#
|
|
218
|
+
# @param id [String]
|
|
219
|
+
#
|
|
220
|
+
# @param crop [WhopSDK::Models::AdCreateParams::Creative::Crop] The saved crop window for this creative, in source image pixels. Omit it for the
|
|
221
|
+
#
|
|
222
|
+
# @param format_ [Symbol, WhopSDK::Models::AdCreateParams::Creative::Format]
|
|
223
|
+
|
|
224
|
+
# @see WhopSDK::Models::AdCreateParams::Creative#crop
|
|
225
|
+
class Crop < WhopSDK::Internal::Type::BaseModel
|
|
226
|
+
# @!attribute height
|
|
227
|
+
#
|
|
228
|
+
# @return [Float, nil]
|
|
229
|
+
optional :height, Float
|
|
230
|
+
|
|
231
|
+
# @!attribute width
|
|
232
|
+
#
|
|
233
|
+
# @return [Float, nil]
|
|
234
|
+
optional :width, Float
|
|
235
|
+
|
|
236
|
+
# @!attribute x
|
|
237
|
+
#
|
|
238
|
+
# @return [Float, nil]
|
|
239
|
+
optional :x, Float
|
|
240
|
+
|
|
241
|
+
# @!attribute y_
|
|
242
|
+
#
|
|
243
|
+
# @return [Float, nil]
|
|
244
|
+
optional :y_, Float, api_name: :y
|
|
245
|
+
|
|
246
|
+
# @!method initialize(height: nil, width: nil, x: nil, y_: nil)
|
|
247
|
+
# The saved crop window for this creative, in source image pixels. Omit it for the
|
|
248
|
+
# original asset or for a format that has not been cropped.
|
|
249
|
+
#
|
|
250
|
+
# @param height [Float]
|
|
251
|
+
# @param width [Float]
|
|
252
|
+
# @param x [Float]
|
|
253
|
+
# @param y_ [Float]
|
|
254
|
+
end
|
|
255
|
+
|
|
256
|
+
# @see WhopSDK::Models::AdCreateParams::Creative#format_
|
|
257
|
+
module Format
|
|
258
|
+
extend WhopSDK::Internal::Type::Enum
|
|
259
|
+
|
|
260
|
+
SQUARE = :square
|
|
261
|
+
VERTICAL = :vertical
|
|
262
|
+
HORIZONTAL = :horizontal
|
|
263
|
+
|
|
264
|
+
# @!method self.values
|
|
265
|
+
# @return [Array<Symbol>]
|
|
266
|
+
end
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
class LeadForm < WhopSDK::Internal::Type::BaseModel
|
|
270
|
+
# @!attribute completion
|
|
271
|
+
# Optional completion screen shown after submission; url sets the follow-up
|
|
272
|
+
# website button.
|
|
273
|
+
#
|
|
274
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm::Completion, nil]
|
|
275
|
+
optional :completion, -> { WhopSDK::AdCreateParams::LeadForm::Completion }
|
|
276
|
+
|
|
277
|
+
# @!attribute disclaimer
|
|
278
|
+
# Optional custom consent disclaimer with checkboxes.
|
|
279
|
+
#
|
|
280
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer, nil]
|
|
281
|
+
optional :disclaimer, -> { WhopSDK::AdCreateParams::LeadForm::Disclaimer }
|
|
282
|
+
|
|
283
|
+
# @!attribute form_type
|
|
284
|
+
# more_volume (default) is quickest to submit; higher_intent adds a confirmation
|
|
285
|
+
# step.
|
|
286
|
+
#
|
|
287
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::FormType, nil]
|
|
288
|
+
optional :form_type, enum: -> { WhopSDK::AdCreateParams::LeadForm::FormType }
|
|
289
|
+
|
|
290
|
+
# @!attribute intro
|
|
291
|
+
# Optional intro screen shown before the questions.
|
|
292
|
+
#
|
|
293
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm::Intro, nil]
|
|
294
|
+
optional :intro, -> { WhopSDK::AdCreateParams::LeadForm::Intro }
|
|
295
|
+
|
|
296
|
+
# @!attribute name
|
|
297
|
+
# Internal name for the form. Auto-generated if omitted.
|
|
298
|
+
#
|
|
299
|
+
# @return [String, nil]
|
|
300
|
+
optional :name, String
|
|
301
|
+
|
|
302
|
+
# @!attribute phone_verification
|
|
303
|
+
# Require SMS verification of the phone number (higher_intent forms).
|
|
304
|
+
#
|
|
305
|
+
# @return [Boolean, nil]
|
|
306
|
+
optional :phone_verification, WhopSDK::Internal::Type::Boolean
|
|
307
|
+
|
|
308
|
+
# @!attribute privacy_policy
|
|
309
|
+
# Your privacy policy. url is required by Meta.
|
|
310
|
+
#
|
|
311
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm::PrivacyPolicy, nil]
|
|
312
|
+
optional :privacy_policy, -> { WhopSDK::AdCreateParams::LeadForm::PrivacyPolicy }
|
|
313
|
+
|
|
314
|
+
# @!attribute questions
|
|
315
|
+
# The questions on the form. Standard prefill types need only a type; a custom
|
|
316
|
+
# question needs a label and a format (plus options for multiple_choice). Options
|
|
317
|
+
# carry an optional key and answer-routing logic.
|
|
318
|
+
#
|
|
319
|
+
# @return [Array<WhopSDK::Models::AdCreateParams::LeadForm::Question>, nil]
|
|
320
|
+
optional :questions, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::LeadForm::Question] }
|
|
321
|
+
|
|
322
|
+
# @!method initialize(completion: nil, disclaimer: nil, form_type: nil, intro: nil, name: nil, phone_verification: nil, privacy_policy: nil, questions: nil)
|
|
323
|
+
# Some parameter documentations has been truncated, see
|
|
324
|
+
# {WhopSDK::Models::AdCreateParams::LeadForm} for more details.
|
|
325
|
+
#
|
|
326
|
+
# Instant lead form for the ad. Only allowed when the ad group's
|
|
327
|
+
# conversion_location is an instant-form destination (instant_forms,
|
|
328
|
+
# instant_forms_and_messenger, website_and_instant_forms). Mutually exclusive with
|
|
329
|
+
# lead_form_id.
|
|
330
|
+
#
|
|
331
|
+
# @param completion [WhopSDK::Models::AdCreateParams::LeadForm::Completion] Optional completion screen shown after submission; url sets the follow-up websit
|
|
332
|
+
#
|
|
333
|
+
# @param disclaimer [WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer] Optional custom consent disclaimer with checkboxes.
|
|
334
|
+
#
|
|
335
|
+
# @param form_type [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::FormType] more_volume (default) is quickest to submit; higher_intent adds a confirmation s
|
|
336
|
+
#
|
|
337
|
+
# @param intro [WhopSDK::Models::AdCreateParams::LeadForm::Intro] Optional intro screen shown before the questions.
|
|
338
|
+
#
|
|
339
|
+
# @param name [String] Internal name for the form. Auto-generated if omitted.
|
|
340
|
+
#
|
|
341
|
+
# @param phone_verification [Boolean] Require SMS verification of the phone number (higher_intent forms).
|
|
342
|
+
#
|
|
343
|
+
# @param privacy_policy [WhopSDK::Models::AdCreateParams::LeadForm::PrivacyPolicy] Your privacy policy. url is required by Meta.
|
|
344
|
+
#
|
|
345
|
+
# @param questions [Array<WhopSDK::Models::AdCreateParams::LeadForm::Question>] The questions on the form. Standard prefill types need only a type; a custom que
|
|
346
|
+
|
|
347
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm#completion
|
|
348
|
+
class Completion < WhopSDK::Internal::Type::BaseModel
|
|
349
|
+
# @!attribute button_text
|
|
350
|
+
#
|
|
351
|
+
# @return [String, nil]
|
|
352
|
+
optional :button_text, String
|
|
353
|
+
|
|
354
|
+
# @!attribute description
|
|
355
|
+
#
|
|
356
|
+
# @return [String, nil]
|
|
357
|
+
optional :description, String
|
|
358
|
+
|
|
359
|
+
# @!attribute headline
|
|
360
|
+
#
|
|
361
|
+
# @return [String, nil]
|
|
362
|
+
optional :headline, String
|
|
363
|
+
|
|
364
|
+
# @!attribute url
|
|
365
|
+
#
|
|
366
|
+
# @return [String, nil]
|
|
367
|
+
optional :url, String
|
|
368
|
+
|
|
369
|
+
# @!method initialize(button_text: nil, description: nil, headline: nil, url: nil)
|
|
370
|
+
# Optional completion screen shown after submission; url sets the follow-up
|
|
371
|
+
# website button.
|
|
372
|
+
#
|
|
373
|
+
# @param button_text [String]
|
|
374
|
+
# @param description [String]
|
|
375
|
+
# @param headline [String]
|
|
376
|
+
# @param url [String]
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm#disclaimer
|
|
380
|
+
class Disclaimer < WhopSDK::Internal::Type::BaseModel
|
|
381
|
+
# @!attribute body
|
|
382
|
+
#
|
|
383
|
+
# @return [String, nil]
|
|
384
|
+
optional :body, String
|
|
385
|
+
|
|
386
|
+
# @!attribute checkboxes
|
|
387
|
+
#
|
|
388
|
+
# @return [Array<WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer::Checkbox>, nil]
|
|
389
|
+
optional :checkboxes,
|
|
390
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::LeadForm::Disclaimer::Checkbox] }
|
|
391
|
+
|
|
392
|
+
# @!attribute title
|
|
393
|
+
#
|
|
394
|
+
# @return [String, nil]
|
|
395
|
+
optional :title, String
|
|
396
|
+
|
|
397
|
+
# @!method initialize(body: nil, checkboxes: nil, title: nil)
|
|
398
|
+
# Optional custom consent disclaimer with checkboxes.
|
|
399
|
+
#
|
|
400
|
+
# @param body [String]
|
|
401
|
+
# @param checkboxes [Array<WhopSDK::Models::AdCreateParams::LeadForm::Disclaimer::Checkbox>]
|
|
402
|
+
# @param title [String]
|
|
403
|
+
|
|
404
|
+
class Checkbox < WhopSDK::Internal::Type::BaseModel
|
|
405
|
+
# @!attribute checked_by_default
|
|
406
|
+
#
|
|
407
|
+
# @return [Boolean, nil]
|
|
408
|
+
optional :checked_by_default, WhopSDK::Internal::Type::Boolean
|
|
409
|
+
|
|
410
|
+
# @!attribute key
|
|
411
|
+
#
|
|
412
|
+
# @return [String, nil]
|
|
413
|
+
optional :key, String
|
|
414
|
+
|
|
415
|
+
# @!attribute required
|
|
416
|
+
#
|
|
417
|
+
# @return [Boolean, nil]
|
|
418
|
+
optional :required, WhopSDK::Internal::Type::Boolean
|
|
419
|
+
|
|
420
|
+
# @!attribute text
|
|
421
|
+
#
|
|
422
|
+
# @return [String, nil]
|
|
423
|
+
optional :text, String
|
|
424
|
+
|
|
425
|
+
# @!method initialize(checked_by_default: nil, key: nil, required: nil, text: nil)
|
|
426
|
+
# @param checked_by_default [Boolean]
|
|
427
|
+
# @param key [String]
|
|
428
|
+
# @param required [Boolean]
|
|
429
|
+
# @param text [String]
|
|
430
|
+
end
|
|
431
|
+
end
|
|
432
|
+
|
|
433
|
+
# more_volume (default) is quickest to submit; higher_intent adds a confirmation
|
|
434
|
+
# step.
|
|
435
|
+
#
|
|
436
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm#form_type
|
|
437
|
+
module FormType
|
|
438
|
+
extend WhopSDK::Internal::Type::Enum
|
|
439
|
+
|
|
440
|
+
MORE_VOLUME = :more_volume
|
|
441
|
+
HIGHER_INTENT = :higher_intent
|
|
442
|
+
|
|
443
|
+
# @!method self.values
|
|
444
|
+
# @return [Array<Symbol>]
|
|
445
|
+
end
|
|
446
|
+
|
|
447
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm#intro
|
|
448
|
+
class Intro < WhopSDK::Internal::Type::BaseModel
|
|
449
|
+
# @!attribute description
|
|
450
|
+
#
|
|
451
|
+
# @return [String, nil]
|
|
452
|
+
optional :description, String
|
|
453
|
+
|
|
454
|
+
# @!attribute headline
|
|
455
|
+
#
|
|
456
|
+
# @return [String, nil]
|
|
457
|
+
optional :headline, String
|
|
458
|
+
|
|
459
|
+
# @!method initialize(description: nil, headline: nil)
|
|
460
|
+
# Optional intro screen shown before the questions.
|
|
461
|
+
#
|
|
462
|
+
# @param description [String]
|
|
463
|
+
# @param headline [String]
|
|
464
|
+
end
|
|
465
|
+
|
|
466
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm#privacy_policy
|
|
467
|
+
class PrivacyPolicy < WhopSDK::Internal::Type::BaseModel
|
|
468
|
+
# @!attribute link_text
|
|
469
|
+
#
|
|
470
|
+
# @return [String, nil]
|
|
471
|
+
optional :link_text, String
|
|
472
|
+
|
|
473
|
+
# @!attribute url
|
|
474
|
+
#
|
|
475
|
+
# @return [String, nil]
|
|
476
|
+
optional :url, String
|
|
477
|
+
|
|
478
|
+
# @!method initialize(link_text: nil, url: nil)
|
|
479
|
+
# Your privacy policy. url is required by Meta.
|
|
480
|
+
#
|
|
481
|
+
# @param link_text [String]
|
|
482
|
+
# @param url [String]
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
class Question < WhopSDK::Internal::Type::BaseModel
|
|
486
|
+
# @!attribute format_
|
|
487
|
+
#
|
|
488
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Format, nil]
|
|
489
|
+
optional :format_,
|
|
490
|
+
enum: -> {
|
|
491
|
+
WhopSDK::AdCreateParams::LeadForm::Question::Format
|
|
492
|
+
},
|
|
493
|
+
api_name: :format
|
|
494
|
+
|
|
495
|
+
# @!attribute label
|
|
496
|
+
#
|
|
497
|
+
# @return [String, nil]
|
|
498
|
+
optional :label, String
|
|
499
|
+
|
|
500
|
+
# @!attribute options
|
|
501
|
+
#
|
|
502
|
+
# @return [Array<WhopSDK::Models::AdCreateParams::LeadForm::Question::Option>, nil]
|
|
503
|
+
optional :options,
|
|
504
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCreateParams::LeadForm::Question::Option] }
|
|
505
|
+
|
|
506
|
+
# @!attribute type
|
|
507
|
+
#
|
|
508
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Type, nil]
|
|
509
|
+
optional :type, enum: -> { WhopSDK::AdCreateParams::LeadForm::Question::Type }
|
|
510
|
+
|
|
511
|
+
# @!method initialize(format_: nil, label: nil, options: nil, type: nil)
|
|
512
|
+
# @param format_ [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Format]
|
|
513
|
+
# @param label [String]
|
|
514
|
+
# @param options [Array<WhopSDK::Models::AdCreateParams::LeadForm::Question::Option>]
|
|
515
|
+
# @param type [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Type]
|
|
516
|
+
|
|
517
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm::Question#format_
|
|
518
|
+
module Format
|
|
519
|
+
extend WhopSDK::Internal::Type::Enum
|
|
520
|
+
|
|
521
|
+
SHORT_ANSWER = :short_answer
|
|
522
|
+
MULTIPLE_CHOICE = :multiple_choice
|
|
523
|
+
APPOINTMENT = :appointment
|
|
524
|
+
|
|
525
|
+
# @!method self.values
|
|
526
|
+
# @return [Array<Symbol>]
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
class Option < WhopSDK::Internal::Type::BaseModel
|
|
530
|
+
# @!attribute key
|
|
531
|
+
#
|
|
532
|
+
# @return [String, nil]
|
|
533
|
+
optional :key, String
|
|
534
|
+
|
|
535
|
+
# @!attribute logic
|
|
536
|
+
#
|
|
537
|
+
# @return [WhopSDK::Models::AdCreateParams::LeadForm::Question::Option::Logic, nil]
|
|
538
|
+
optional :logic, -> { WhopSDK::AdCreateParams::LeadForm::Question::Option::Logic }
|
|
539
|
+
|
|
540
|
+
# @!attribute value
|
|
541
|
+
#
|
|
542
|
+
# @return [String, nil]
|
|
543
|
+
optional :value, String
|
|
544
|
+
|
|
545
|
+
# @!method initialize(key: nil, logic: nil, value: nil)
|
|
546
|
+
# @param key [String]
|
|
547
|
+
# @param logic [WhopSDK::Models::AdCreateParams::LeadForm::Question::Option::Logic]
|
|
548
|
+
# @param value [String]
|
|
549
|
+
|
|
550
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm::Question::Option#logic
|
|
551
|
+
class Logic < WhopSDK::Internal::Type::BaseModel
|
|
552
|
+
# @!attribute action
|
|
553
|
+
#
|
|
554
|
+
# @return [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Option::Logic::Action, nil]
|
|
555
|
+
optional :action, enum: -> { WhopSDK::AdCreateParams::LeadForm::Question::Option::Logic::Action }
|
|
556
|
+
|
|
557
|
+
# @!attribute target_end_page_index
|
|
558
|
+
#
|
|
559
|
+
# @return [Integer, nil]
|
|
560
|
+
optional :target_end_page_index, Integer
|
|
561
|
+
|
|
562
|
+
# @!attribute target_question_index
|
|
563
|
+
#
|
|
564
|
+
# @return [Integer, nil]
|
|
565
|
+
optional :target_question_index, Integer
|
|
566
|
+
|
|
567
|
+
# @!method initialize(action: nil, target_end_page_index: nil, target_question_index: nil)
|
|
568
|
+
# @param action [Symbol, WhopSDK::Models::AdCreateParams::LeadForm::Question::Option::Logic::Action]
|
|
569
|
+
# @param target_end_page_index [Integer]
|
|
570
|
+
# @param target_question_index [Integer]
|
|
571
|
+
|
|
572
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm::Question::Option::Logic#action
|
|
573
|
+
module Action
|
|
574
|
+
extend WhopSDK::Internal::Type::Enum
|
|
575
|
+
|
|
576
|
+
GO_TO_QUESTION = :go_to_question
|
|
577
|
+
SUBMIT_FORM = :submit_form
|
|
578
|
+
CLOSE_FORM = :close_form
|
|
579
|
+
|
|
580
|
+
# @!method self.values
|
|
581
|
+
# @return [Array<Symbol>]
|
|
582
|
+
end
|
|
583
|
+
end
|
|
584
|
+
end
|
|
585
|
+
|
|
586
|
+
# @see WhopSDK::Models::AdCreateParams::LeadForm::Question#type
|
|
587
|
+
module Type
|
|
588
|
+
extend WhopSDK::Internal::Type::Enum
|
|
589
|
+
|
|
590
|
+
EMAIL = :email
|
|
591
|
+
PHONE = :phone
|
|
592
|
+
FULL_NAME = :full_name
|
|
593
|
+
FIRST_NAME = :first_name
|
|
594
|
+
LAST_NAME = :last_name
|
|
595
|
+
CITY = :city
|
|
596
|
+
STATE = :state
|
|
597
|
+
ZIP = :zip
|
|
598
|
+
COUNTRY = :country
|
|
599
|
+
STREET_ADDRESS = :street_address
|
|
600
|
+
JOB_TITLE = :job_title
|
|
601
|
+
COMPANY_NAME = :company_name
|
|
602
|
+
WORK_EMAIL = :work_email
|
|
603
|
+
WORK_PHONE_NUMBER = :work_phone_number
|
|
604
|
+
DOB = :dob
|
|
605
|
+
GENDER = :gender
|
|
606
|
+
MARITAL_STATUS = :marital_status
|
|
607
|
+
RELATIONSHIP_STATUS = :relationship_status
|
|
608
|
+
MILITARY_STATUS = :military_status
|
|
609
|
+
DATE_TIME = :date_time
|
|
610
|
+
CUSTOM = :custom
|
|
611
|
+
|
|
612
|
+
# @!method self.values
|
|
613
|
+
# @return [Array<Symbol>]
|
|
614
|
+
end
|
|
615
|
+
end
|
|
616
|
+
end
|
|
617
|
+
|
|
618
|
+
class MessagingConfig < WhopSDK::Internal::Type::BaseModel
|
|
619
|
+
# @!attribute keyword
|
|
620
|
+
#
|
|
621
|
+
# @return [String, nil]
|
|
622
|
+
optional :keyword, String
|
|
623
|
+
|
|
624
|
+
# @!attribute message
|
|
625
|
+
#
|
|
626
|
+
# @return [String, nil]
|
|
627
|
+
optional :message, String
|
|
628
|
+
|
|
629
|
+
# @!method initialize(keyword: nil, message: nil)
|
|
630
|
+
# Click-to-message welcome copy: the greeting (message) and the ice-breaker prompt
|
|
631
|
+
# (keyword).
|
|
632
|
+
#
|
|
633
|
+
# @param keyword [String]
|
|
634
|
+
# @param message [String]
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
# Which network post_id refers to — facebook (a page post) or instagram (a media
|
|
638
|
+
# id). Authoritative; when omitted the source is inferred from the id shape.
|
|
639
|
+
module PostSource
|
|
640
|
+
extend WhopSDK::Internal::Type::Enum
|
|
641
|
+
|
|
642
|
+
FACEBOOK = :facebook
|
|
643
|
+
INSTAGRAM = :instagram
|
|
644
|
+
|
|
645
|
+
# @!method self.values
|
|
646
|
+
# @return [Array<Symbol>]
|
|
647
|
+
end
|
|
648
|
+
|
|
649
|
+
class SocialAccount < WhopSDK::Internal::Type::BaseModel
|
|
650
|
+
# @!attribute id
|
|
651
|
+
#
|
|
652
|
+
# @return [String, nil]
|
|
653
|
+
optional :id, String
|
|
654
|
+
|
|
655
|
+
# @!method initialize(id: nil)
|
|
656
|
+
# @param id [String]
|
|
657
|
+
end
|
|
658
|
+
end
|
|
659
|
+
end
|
|
660
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Ads#delete
|
|
6
|
+
class AdDeleteParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(id:, request_options: {})
|
|
16
|
+
# @param id [String]
|
|
17
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|