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,774 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::AdGroups#create
|
|
6
|
+
class AdGroup < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# Unique identifier for the ad group.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String
|
|
12
|
+
|
|
13
|
+
# @!attribute ad_campaign
|
|
14
|
+
# The ad campaign this ad group belongs to, an object with an id.
|
|
15
|
+
#
|
|
16
|
+
# @return [WhopSDK::Models::AdGroup::AdCampaign]
|
|
17
|
+
required :ad_campaign, -> { WhopSDK::AdGroup::AdCampaign }
|
|
18
|
+
|
|
19
|
+
# @!attribute added_to_carts
|
|
20
|
+
# Whop pixel-attributed add-to-cart events, last-click.
|
|
21
|
+
#
|
|
22
|
+
# @return [Float]
|
|
23
|
+
required :added_to_carts, Float
|
|
24
|
+
|
|
25
|
+
# @!attribute audiences
|
|
26
|
+
# Saved-audience targeting: { include, exclude } arrays of audience IDs.
|
|
27
|
+
#
|
|
28
|
+
# @return [Object]
|
|
29
|
+
required :audiences, WhopSDK::Internal::Type::Unknown
|
|
30
|
+
|
|
31
|
+
# @!attribute bid_type
|
|
32
|
+
# Bid strategy.
|
|
33
|
+
#
|
|
34
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::BidType, nil]
|
|
35
|
+
required :bid_type, enum: -> { WhopSDK::AdGroup::BidType }, nil?: true
|
|
36
|
+
|
|
37
|
+
# @!attribute budget_amount
|
|
38
|
+
# Ad-set budget; null when the campaign owns budget (CBO).
|
|
39
|
+
#
|
|
40
|
+
# @return [Float, nil]
|
|
41
|
+
required :budget_amount, Float, nil?: true
|
|
42
|
+
|
|
43
|
+
# @!attribute budget_type
|
|
44
|
+
# Whether the budget is daily or lifetime.
|
|
45
|
+
#
|
|
46
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::BudgetType, nil]
|
|
47
|
+
required :budget_type, enum: -> { WhopSDK::AdGroup::BudgetType }, nil?: true
|
|
48
|
+
|
|
49
|
+
# @!attribute click_through_rate
|
|
50
|
+
# Clicks divided by impressions, between 0 and 1.
|
|
51
|
+
#
|
|
52
|
+
# @return [Float]
|
|
53
|
+
required :click_through_rate, Float
|
|
54
|
+
|
|
55
|
+
# @!attribute clicks
|
|
56
|
+
# The number of clicks.
|
|
57
|
+
#
|
|
58
|
+
# @return [Float]
|
|
59
|
+
required :clicks, Float
|
|
60
|
+
|
|
61
|
+
# @!attribute completed_registrations
|
|
62
|
+
# Whop pixel-attributed complete-registration events, last-click.
|
|
63
|
+
#
|
|
64
|
+
# @return [Float]
|
|
65
|
+
required :completed_registrations, Float
|
|
66
|
+
|
|
67
|
+
# @!attribute contacts
|
|
68
|
+
# Whop pixel-attributed contact events, last-click.
|
|
69
|
+
#
|
|
70
|
+
# @return [Float]
|
|
71
|
+
required :contacts, Float
|
|
72
|
+
|
|
73
|
+
# @!attribute conversion_event
|
|
74
|
+
# The pixel event optimized for. A standard event, or any custom pixel event name.
|
|
75
|
+
#
|
|
76
|
+
# @return [Symbol, String, WhopSDK::Models::AdGroup::ConversionEvent, nil]
|
|
77
|
+
required :conversion_event, union: -> { WhopSDK::AdGroup::ConversionEvent }, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!attribute conversion_location
|
|
80
|
+
# Where results happen: website, profile (IG/FB), messaging (DM), on_ad
|
|
81
|
+
# (engagement), or the lead destinations (instant_forms,
|
|
82
|
+
# instant_forms_and_messenger, website_and_instant_forms).
|
|
83
|
+
#
|
|
84
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::ConversionLocation, nil]
|
|
85
|
+
required :conversion_location, enum: -> { WhopSDK::AdGroup::ConversionLocation }, nil?: true
|
|
86
|
+
|
|
87
|
+
# @!attribute cost_per_added_to_cart
|
|
88
|
+
# Spend divided by attributed add-to-cart events; null when they are not the goal
|
|
89
|
+
# and none are attributed.
|
|
90
|
+
#
|
|
91
|
+
# @return [Float, nil]
|
|
92
|
+
required :cost_per_added_to_cart, Float, nil?: true
|
|
93
|
+
|
|
94
|
+
# @!attribute cost_per_click
|
|
95
|
+
# Spend divided by clicks; 0 when there are no clicks.
|
|
96
|
+
#
|
|
97
|
+
# @return [Float]
|
|
98
|
+
required :cost_per_click, Float
|
|
99
|
+
|
|
100
|
+
# @!attribute cost_per_completed_registration
|
|
101
|
+
# Spend divided by attributed complete-registration events; null when they are not
|
|
102
|
+
# the goal and none are attributed.
|
|
103
|
+
#
|
|
104
|
+
# @return [Float, nil]
|
|
105
|
+
required :cost_per_completed_registration, Float, nil?: true
|
|
106
|
+
|
|
107
|
+
# @!attribute cost_per_contact
|
|
108
|
+
# Spend divided by attributed contact events; null when contacts are not the goal
|
|
109
|
+
# and none are attributed.
|
|
110
|
+
#
|
|
111
|
+
# @return [Float, nil]
|
|
112
|
+
required :cost_per_contact, Float, nil?: true
|
|
113
|
+
|
|
114
|
+
# @!attribute cost_per_lead
|
|
115
|
+
# Spend divided by attributed leads; null when leads are not a goal and none are
|
|
116
|
+
# attributed.
|
|
117
|
+
#
|
|
118
|
+
# @return [Float, nil]
|
|
119
|
+
required :cost_per_lead, Float, nil?: true
|
|
120
|
+
|
|
121
|
+
# @!attribute cost_per_mille
|
|
122
|
+
# Spend per 1,000 impressions; 0 when there are no impressions.
|
|
123
|
+
#
|
|
124
|
+
# @return [Float]
|
|
125
|
+
required :cost_per_mille, Float
|
|
126
|
+
|
|
127
|
+
# @!attribute cost_per_purchase
|
|
128
|
+
# Spend divided by attributed purchases; null when purchases are not a goal and
|
|
129
|
+
# none are attributed.
|
|
130
|
+
#
|
|
131
|
+
# @return [Float, nil]
|
|
132
|
+
required :cost_per_purchase, Float, nil?: true
|
|
133
|
+
|
|
134
|
+
# @!attribute cost_per_result
|
|
135
|
+
# Spend divided by Whop pixel-attributed results; null when nothing
|
|
136
|
+
# Whop-attributable is being optimized for.
|
|
137
|
+
#
|
|
138
|
+
# @return [Float, nil]
|
|
139
|
+
required :cost_per_result, Float, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute cost_per_schedule
|
|
142
|
+
# Spend divided by attributed schedule events; null when schedules are not the
|
|
143
|
+
# goal and none are attributed.
|
|
144
|
+
#
|
|
145
|
+
# @return [Float, nil]
|
|
146
|
+
required :cost_per_schedule, Float, nil?: true
|
|
147
|
+
|
|
148
|
+
# @!attribute cost_per_submitted_application
|
|
149
|
+
# Spend divided by attributed submit-application events; null when they are not
|
|
150
|
+
# the goal and none are attributed.
|
|
151
|
+
#
|
|
152
|
+
# @return [Float, nil]
|
|
153
|
+
required :cost_per_submitted_application, Float, nil?: true
|
|
154
|
+
|
|
155
|
+
# @!attribute cost_per_viewed_content
|
|
156
|
+
# Spend divided by attributed view-content events; null when they are not the goal
|
|
157
|
+
# and none are attributed.
|
|
158
|
+
#
|
|
159
|
+
# @return [Float, nil]
|
|
160
|
+
required :cost_per_viewed_content, Float, nil?: true
|
|
161
|
+
|
|
162
|
+
# @!attribute created_at
|
|
163
|
+
# When the ad group was created, ISO 8601.
|
|
164
|
+
#
|
|
165
|
+
# @return [String]
|
|
166
|
+
required :created_at, String
|
|
167
|
+
|
|
168
|
+
# @!attribute custom_conversions
|
|
169
|
+
# Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
|
|
170
|
+
# across all custom event names.
|
|
171
|
+
#
|
|
172
|
+
# @return [Float]
|
|
173
|
+
required :custom_conversions, Float
|
|
174
|
+
|
|
175
|
+
# @!attribute custom_event_counts
|
|
176
|
+
# Whop pixel-attributed custom conversions broken out by merchant-defined event
|
|
177
|
+
# name, last-click, as a { event_name => count } map over the stats window. Empty
|
|
178
|
+
# when no named custom events are attributed. Custom events fired without a name
|
|
179
|
+
# are counted in custom_conversions but omitted here, so these values sum to at
|
|
180
|
+
# most custom_conversions.
|
|
181
|
+
#
|
|
182
|
+
# @return [Object]
|
|
183
|
+
required :custom_event_counts, WhopSDK::Internal::Type::Unknown
|
|
184
|
+
|
|
185
|
+
# @!attribute delivery_status
|
|
186
|
+
# The current delivery state, mirroring the Delivery column in the ads dashboard.
|
|
187
|
+
# When several states apply at once, the highest-precedence one is returned.
|
|
188
|
+
#
|
|
189
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::DeliveryStatus]
|
|
190
|
+
required :delivery_status, enum: -> { WhopSDK::AdGroup::DeliveryStatus }
|
|
191
|
+
|
|
192
|
+
# @!attribute demographics
|
|
193
|
+
# Demographic targeting: automatic (Advantage+), age range, gender.
|
|
194
|
+
#
|
|
195
|
+
# @return [Object]
|
|
196
|
+
required :demographics, WhopSDK::Internal::Type::Unknown
|
|
197
|
+
|
|
198
|
+
# @!attribute desired_cost_per_result
|
|
199
|
+
# Target/cap cost for average_target / maximum_target.
|
|
200
|
+
#
|
|
201
|
+
# @return [Float, nil]
|
|
202
|
+
required :desired_cost_per_result, Float, nil?: true
|
|
203
|
+
|
|
204
|
+
# @!attribute devices
|
|
205
|
+
# Device targeting: platforms and operating systems.
|
|
206
|
+
#
|
|
207
|
+
# @return [Object]
|
|
208
|
+
required :devices, WhopSDK::Internal::Type::Unknown
|
|
209
|
+
|
|
210
|
+
# @!attribute dynamic_creative
|
|
211
|
+
# Whether ads within this ad group have their creatives and copy dynamically AB
|
|
212
|
+
# tested.
|
|
213
|
+
#
|
|
214
|
+
# @return [Boolean]
|
|
215
|
+
required :dynamic_creative, WhopSDK::Internal::Type::Boolean
|
|
216
|
+
|
|
217
|
+
# @!attribute ends_at
|
|
218
|
+
# Schedule end, ISO 8601.
|
|
219
|
+
#
|
|
220
|
+
# @return [String, nil]
|
|
221
|
+
required :ends_at, String, nil?: true
|
|
222
|
+
|
|
223
|
+
# @!attribute frequency
|
|
224
|
+
# Platform-reported impressions divided by reach.
|
|
225
|
+
#
|
|
226
|
+
# @return [Float, nil]
|
|
227
|
+
required :frequency, Float, nil?: true
|
|
228
|
+
|
|
229
|
+
# @!attribute frequency_cap
|
|
230
|
+
# Impression cap; only valid for reach optimization.
|
|
231
|
+
#
|
|
232
|
+
# @return [Object, nil]
|
|
233
|
+
required :frequency_cap, WhopSDK::Internal::Type::Unknown, nil?: true
|
|
234
|
+
|
|
235
|
+
# @!attribute impressions
|
|
236
|
+
# The number of impressions.
|
|
237
|
+
#
|
|
238
|
+
# @return [Float]
|
|
239
|
+
required :impressions, Float
|
|
240
|
+
|
|
241
|
+
# @!attribute issues
|
|
242
|
+
#
|
|
243
|
+
# @return [Array<WhopSDK::Models::AdGroup::Issue>]
|
|
244
|
+
required :issues, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdGroup::Issue] }
|
|
245
|
+
|
|
246
|
+
# @!attribute languages
|
|
247
|
+
#
|
|
248
|
+
# @return [Array<String>]
|
|
249
|
+
required :languages, WhopSDK::Internal::Type::ArrayOf[String]
|
|
250
|
+
|
|
251
|
+
# @!attribute leads
|
|
252
|
+
# Whop pixel-attributed leads, last-click.
|
|
253
|
+
#
|
|
254
|
+
# @return [Float]
|
|
255
|
+
required :leads, Float
|
|
256
|
+
|
|
257
|
+
# @!attribute message_apps
|
|
258
|
+
#
|
|
259
|
+
# @return [Array<String>]
|
|
260
|
+
required :message_apps, WhopSDK::Internal::Type::ArrayOf[String]
|
|
261
|
+
|
|
262
|
+
# @!attribute minimum_daily_spend
|
|
263
|
+
# Daily spend floor within the budget.
|
|
264
|
+
#
|
|
265
|
+
# @return [Float, nil]
|
|
266
|
+
required :minimum_daily_spend, Float, nil?: true
|
|
267
|
+
|
|
268
|
+
# @!attribute optimization_goal
|
|
269
|
+
# What the ad group optimizes for.
|
|
270
|
+
#
|
|
271
|
+
# @return [String, nil]
|
|
272
|
+
required :optimization_goal, String, nil?: true
|
|
273
|
+
|
|
274
|
+
# @!attribute placements
|
|
275
|
+
#
|
|
276
|
+
# @return [Array<Object>]
|
|
277
|
+
required :placements, WhopSDK::Internal::Type::ArrayOf[WhopSDK::Internal::Type::Unknown]
|
|
278
|
+
|
|
279
|
+
# @!attribute purchase_value
|
|
280
|
+
# USD value of pixel-attributed purchases.
|
|
281
|
+
#
|
|
282
|
+
# @return [Float]
|
|
283
|
+
required :purchase_value, Float
|
|
284
|
+
|
|
285
|
+
# @!attribute purchases
|
|
286
|
+
# Whop pixel-attributed purchases, last-click.
|
|
287
|
+
#
|
|
288
|
+
# @return [Float]
|
|
289
|
+
required :purchases, Float
|
|
290
|
+
|
|
291
|
+
# @!attribute reach
|
|
292
|
+
# The number of unique people who saw this.
|
|
293
|
+
#
|
|
294
|
+
# @return [Float]
|
|
295
|
+
required :reach, Float
|
|
296
|
+
|
|
297
|
+
# @!attribute regions
|
|
298
|
+
# Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g.
|
|
299
|
+
# US-CA), cities, zips.
|
|
300
|
+
#
|
|
301
|
+
# @return [Object]
|
|
302
|
+
required :regions, WhopSDK::Internal::Type::Unknown
|
|
303
|
+
|
|
304
|
+
# @!attribute result_event
|
|
305
|
+
# The Whop pixel conversion event whose attributed count represents results — the
|
|
306
|
+
# optimization goal, or the highest-volume attributed event for campaigns that
|
|
307
|
+
# budget per ad group. Null when the goal isn't a Whop-attributed event.
|
|
308
|
+
#
|
|
309
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::ResultEvent, nil]
|
|
310
|
+
required :result_event, enum: -> { WhopSDK::AdGroup::ResultEvent }, nil?: true
|
|
311
|
+
|
|
312
|
+
# @!attribute result_event_name
|
|
313
|
+
# The merchant-defined event name when result_event is custom; null for the
|
|
314
|
+
# standard events.
|
|
315
|
+
#
|
|
316
|
+
# @return [String, nil]
|
|
317
|
+
required :result_event_name, String, nil?: true
|
|
318
|
+
|
|
319
|
+
# @!attribute results
|
|
320
|
+
# The Whop pixel-attributed count behind result_event. When a campaign's ad groups
|
|
321
|
+
# optimize different goals there is no single result_event (it is null), and this
|
|
322
|
+
# is instead the sum of each ad group's own attributed results. Null when nothing
|
|
323
|
+
# Whop-attributable is being optimized for.
|
|
324
|
+
#
|
|
325
|
+
# @return [Float, nil]
|
|
326
|
+
required :results, Float, nil?: true
|
|
327
|
+
|
|
328
|
+
# @!attribute return_on_ad_spend
|
|
329
|
+
# Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when
|
|
330
|
+
# there is no spend.
|
|
331
|
+
#
|
|
332
|
+
# @return [Float]
|
|
333
|
+
required :return_on_ad_spend, Float
|
|
334
|
+
|
|
335
|
+
# @!attribute schedules
|
|
336
|
+
# Whop pixel-attributed schedule events, last-click.
|
|
337
|
+
#
|
|
338
|
+
# @return [Float]
|
|
339
|
+
required :schedules, Float
|
|
340
|
+
|
|
341
|
+
# @!attribute spend
|
|
342
|
+
# The amount charged, in spend_currency.
|
|
343
|
+
#
|
|
344
|
+
# @return [Float]
|
|
345
|
+
required :spend, Float
|
|
346
|
+
|
|
347
|
+
# @!attribute spend_currency
|
|
348
|
+
# The ISO 4217 currency code of all monetary metrics.
|
|
349
|
+
#
|
|
350
|
+
# @return [String, nil]
|
|
351
|
+
required :spend_currency, String, nil?: true
|
|
352
|
+
|
|
353
|
+
# @!attribute starts_at
|
|
354
|
+
# Schedule start, ISO 8601.
|
|
355
|
+
#
|
|
356
|
+
# @return [String, nil]
|
|
357
|
+
required :starts_at, String, nil?: true
|
|
358
|
+
|
|
359
|
+
# @!attribute status
|
|
360
|
+
# Delivery status of the ad group.
|
|
361
|
+
#
|
|
362
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::Status]
|
|
363
|
+
required :status, enum: -> { WhopSDK::AdGroup::Status }
|
|
364
|
+
|
|
365
|
+
# @!attribute submitted_applications
|
|
366
|
+
# Whop pixel-attributed submit-application events, last-click.
|
|
367
|
+
#
|
|
368
|
+
# @return [Float]
|
|
369
|
+
required :submitted_applications, Float
|
|
370
|
+
|
|
371
|
+
# @!attribute title
|
|
372
|
+
# The display title of the ad group.
|
|
373
|
+
#
|
|
374
|
+
# @return [String, nil]
|
|
375
|
+
required :title, String, nil?: true
|
|
376
|
+
|
|
377
|
+
# @!attribute unique_click_through_rate
|
|
378
|
+
# Unique clicks divided by impressions, between 0 and 1.
|
|
379
|
+
#
|
|
380
|
+
# @return [Float, nil]
|
|
381
|
+
required :unique_click_through_rate, Float, nil?: true
|
|
382
|
+
|
|
383
|
+
# @!attribute unique_clicks
|
|
384
|
+
# The number of unique clicks.
|
|
385
|
+
#
|
|
386
|
+
# @return [Float]
|
|
387
|
+
required :unique_clicks, Float
|
|
388
|
+
|
|
389
|
+
# @!attribute updated_at
|
|
390
|
+
# When the ad group was last updated, ISO 8601.
|
|
391
|
+
#
|
|
392
|
+
# @return [String]
|
|
393
|
+
required :updated_at, String
|
|
394
|
+
|
|
395
|
+
# @!attribute viewed_contents
|
|
396
|
+
# Whop pixel-attributed view-content events, last-click.
|
|
397
|
+
#
|
|
398
|
+
# @return [Float]
|
|
399
|
+
required :viewed_contents, Float
|
|
400
|
+
|
|
401
|
+
# @!method initialize(id:, ad_campaign:, added_to_carts:, audiences:, bid_type:, budget_amount:, budget_type:, click_through_rate:, clicks:, completed_registrations:, contacts:, conversion_event:, conversion_location:, cost_per_added_to_cart:, cost_per_click:, cost_per_completed_registration:, cost_per_contact:, cost_per_lead:, cost_per_mille:, cost_per_purchase:, cost_per_result:, cost_per_schedule:, cost_per_submitted_application:, cost_per_viewed_content:, created_at:, custom_conversions:, custom_event_counts:, delivery_status:, demographics:, desired_cost_per_result:, devices:, dynamic_creative:, ends_at:, frequency:, frequency_cap:, impressions:, issues:, languages:, leads:, message_apps:, minimum_daily_spend:, optimization_goal:, placements:, purchase_value:, purchases:, reach:, regions:, result_event:, result_event_name:, results:, return_on_ad_spend:, schedules:, spend:, spend_currency:, starts_at:, status:, submitted_applications:, title:, unique_click_through_rate:, unique_clicks:, updated_at:, viewed_contents:)
|
|
402
|
+
# Some parameter documentations has been truncated, see {WhopSDK::Models::AdGroup}
|
|
403
|
+
# for more details.
|
|
404
|
+
#
|
|
405
|
+
# @param id [String] Unique identifier for the ad group.
|
|
406
|
+
#
|
|
407
|
+
# @param ad_campaign [WhopSDK::Models::AdGroup::AdCampaign] The ad campaign this ad group belongs to, an object with an id.
|
|
408
|
+
#
|
|
409
|
+
# @param added_to_carts [Float] Whop pixel-attributed add-to-cart events, last-click.
|
|
410
|
+
#
|
|
411
|
+
# @param audiences [Object] Saved-audience targeting: { include, exclude } arrays of audience IDs.
|
|
412
|
+
#
|
|
413
|
+
# @param bid_type [Symbol, WhopSDK::Models::AdGroup::BidType, nil] Bid strategy.
|
|
414
|
+
#
|
|
415
|
+
# @param budget_amount [Float, nil] Ad-set budget; null when the campaign owns budget (CBO).
|
|
416
|
+
#
|
|
417
|
+
# @param budget_type [Symbol, WhopSDK::Models::AdGroup::BudgetType, nil] Whether the budget is daily or lifetime.
|
|
418
|
+
#
|
|
419
|
+
# @param click_through_rate [Float] Clicks divided by impressions, between 0 and 1.
|
|
420
|
+
#
|
|
421
|
+
# @param clicks [Float] The number of clicks.
|
|
422
|
+
#
|
|
423
|
+
# @param completed_registrations [Float] Whop pixel-attributed complete-registration events, last-click.
|
|
424
|
+
#
|
|
425
|
+
# @param contacts [Float] Whop pixel-attributed contact events, last-click.
|
|
426
|
+
#
|
|
427
|
+
# @param conversion_event [Symbol, String, WhopSDK::Models::AdGroup::ConversionEvent, nil] The pixel event optimized for. A standard event, or any custom pixel event name.
|
|
428
|
+
#
|
|
429
|
+
# @param conversion_location [Symbol, WhopSDK::Models::AdGroup::ConversionLocation, nil] Where results happen: website, profile (IG/FB), messaging (DM), on_ad (engagemen
|
|
430
|
+
#
|
|
431
|
+
# @param cost_per_added_to_cart [Float, nil] Spend divided by attributed add-to-cart events; null when they are not the goal
|
|
432
|
+
#
|
|
433
|
+
# @param cost_per_click [Float] Spend divided by clicks; 0 when there are no clicks.
|
|
434
|
+
#
|
|
435
|
+
# @param cost_per_completed_registration [Float, nil] Spend divided by attributed complete-registration events; null when they are not
|
|
436
|
+
#
|
|
437
|
+
# @param cost_per_contact [Float, nil] Spend divided by attributed contact events; null when contacts are not the goal
|
|
438
|
+
#
|
|
439
|
+
# @param cost_per_lead [Float, nil] Spend divided by attributed leads; null when leads are not a goal and none are a
|
|
440
|
+
#
|
|
441
|
+
# @param cost_per_mille [Float] Spend per 1,000 impressions; 0 when there are no impressions.
|
|
442
|
+
#
|
|
443
|
+
# @param cost_per_purchase [Float, nil] Spend divided by attributed purchases; null when purchases are not a goal and no
|
|
444
|
+
#
|
|
445
|
+
# @param cost_per_result [Float, nil] Spend divided by Whop pixel-attributed results; null when nothing Whop-attributa
|
|
446
|
+
#
|
|
447
|
+
# @param cost_per_schedule [Float, nil] Spend divided by attributed schedule events; null when schedules are not the goa
|
|
448
|
+
#
|
|
449
|
+
# @param cost_per_submitted_application [Float, nil] Spend divided by attributed submit-application events; null when they are not th
|
|
450
|
+
#
|
|
451
|
+
# @param cost_per_viewed_content [Float, nil] Spend divided by attributed view-content events; null when they are not the goal
|
|
452
|
+
#
|
|
453
|
+
# @param created_at [String] When the ad group was created, ISO 8601.
|
|
454
|
+
#
|
|
455
|
+
# @param custom_conversions [Float] Whop pixel-attributed custom (merchant-defined) conversion events, last-click, a
|
|
456
|
+
#
|
|
457
|
+
# @param custom_event_counts [Object] Whop pixel-attributed custom conversions broken out by merchant-defined event na
|
|
458
|
+
#
|
|
459
|
+
# @param delivery_status [Symbol, WhopSDK::Models::AdGroup::DeliveryStatus] The current delivery state, mirroring the Delivery column in the ads dashboard.
|
|
460
|
+
#
|
|
461
|
+
# @param demographics [Object] Demographic targeting: automatic (Advantage+), age range, gender.
|
|
462
|
+
#
|
|
463
|
+
# @param desired_cost_per_result [Float, nil] Target/cap cost for average_target / maximum_target.
|
|
464
|
+
#
|
|
465
|
+
# @param devices [Object] Device targeting: platforms and operating systems.
|
|
466
|
+
#
|
|
467
|
+
# @param dynamic_creative [Boolean] Whether ads within this ad group have their creatives and copy dynamically AB te
|
|
468
|
+
#
|
|
469
|
+
# @param ends_at [String, nil] Schedule end, ISO 8601.
|
|
470
|
+
#
|
|
471
|
+
# @param frequency [Float, nil] Platform-reported impressions divided by reach.
|
|
472
|
+
#
|
|
473
|
+
# @param frequency_cap [Object, nil] Impression cap; only valid for reach optimization.
|
|
474
|
+
#
|
|
475
|
+
# @param impressions [Float] The number of impressions.
|
|
476
|
+
#
|
|
477
|
+
# @param issues [Array<WhopSDK::Models::AdGroup::Issue>]
|
|
478
|
+
#
|
|
479
|
+
# @param languages [Array<String>]
|
|
480
|
+
#
|
|
481
|
+
# @param leads [Float] Whop pixel-attributed leads, last-click.
|
|
482
|
+
#
|
|
483
|
+
# @param message_apps [Array<String>]
|
|
484
|
+
#
|
|
485
|
+
# @param minimum_daily_spend [Float, nil] Daily spend floor within the budget.
|
|
486
|
+
#
|
|
487
|
+
# @param optimization_goal [String, nil] What the ad group optimizes for.
|
|
488
|
+
#
|
|
489
|
+
# @param placements [Array<Object>]
|
|
490
|
+
#
|
|
491
|
+
# @param purchase_value [Float] USD value of pixel-attributed purchases.
|
|
492
|
+
#
|
|
493
|
+
# @param purchases [Float] Whop pixel-attributed purchases, last-click.
|
|
494
|
+
#
|
|
495
|
+
# @param reach [Float] The number of unique people who saw this.
|
|
496
|
+
#
|
|
497
|
+
# @param regions [Object] Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. US-CA
|
|
498
|
+
#
|
|
499
|
+
# @param result_event [Symbol, WhopSDK::Models::AdGroup::ResultEvent, nil] The Whop pixel conversion event whose attributed count represents results — the
|
|
500
|
+
#
|
|
501
|
+
# @param result_event_name [String, nil] The merchant-defined event name when result_event is custom; null for the standa
|
|
502
|
+
#
|
|
503
|
+
# @param results [Float, nil] The Whop pixel-attributed count behind result_event. When a campaign's ad groups
|
|
504
|
+
#
|
|
505
|
+
# @param return_on_ad_spend [Float] Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when
|
|
506
|
+
#
|
|
507
|
+
# @param schedules [Float] Whop pixel-attributed schedule events, last-click.
|
|
508
|
+
#
|
|
509
|
+
# @param spend [Float] The amount charged, in spend_currency.
|
|
510
|
+
#
|
|
511
|
+
# @param spend_currency [String, nil] The ISO 4217 currency code of all monetary metrics.
|
|
512
|
+
#
|
|
513
|
+
# @param starts_at [String, nil] Schedule start, ISO 8601.
|
|
514
|
+
#
|
|
515
|
+
# @param status [Symbol, WhopSDK::Models::AdGroup::Status] Delivery status of the ad group.
|
|
516
|
+
#
|
|
517
|
+
# @param submitted_applications [Float] Whop pixel-attributed submit-application events, last-click.
|
|
518
|
+
#
|
|
519
|
+
# @param title [String, nil] The display title of the ad group.
|
|
520
|
+
#
|
|
521
|
+
# @param unique_click_through_rate [Float, nil] Unique clicks divided by impressions, between 0 and 1.
|
|
522
|
+
#
|
|
523
|
+
# @param unique_clicks [Float] The number of unique clicks.
|
|
524
|
+
#
|
|
525
|
+
# @param updated_at [String] When the ad group was last updated, ISO 8601.
|
|
526
|
+
#
|
|
527
|
+
# @param viewed_contents [Float] Whop pixel-attributed view-content events, last-click.
|
|
528
|
+
|
|
529
|
+
# @see WhopSDK::Models::AdGroup#ad_campaign
|
|
530
|
+
class AdCampaign < WhopSDK::Internal::Type::BaseModel
|
|
531
|
+
# @!attribute id
|
|
532
|
+
# The referenced entity's id.
|
|
533
|
+
#
|
|
534
|
+
# @return [String]
|
|
535
|
+
required :id, String
|
|
536
|
+
|
|
537
|
+
# @!method initialize(id:)
|
|
538
|
+
# The ad campaign this ad group belongs to, an object with an id.
|
|
539
|
+
#
|
|
540
|
+
# @param id [String] The referenced entity's id.
|
|
541
|
+
end
|
|
542
|
+
|
|
543
|
+
# Bid strategy.
|
|
544
|
+
#
|
|
545
|
+
# @see WhopSDK::Models::AdGroup#bid_type
|
|
546
|
+
module BidType
|
|
547
|
+
extend WhopSDK::Internal::Type::Enum
|
|
548
|
+
|
|
549
|
+
MINIMUM_COST = :minimum_cost
|
|
550
|
+
AVERAGE_TARGET = :average_target
|
|
551
|
+
MAXIMUM_TARGET = :maximum_target
|
|
552
|
+
|
|
553
|
+
# @!method self.values
|
|
554
|
+
# @return [Array<Symbol>]
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
# Whether the budget is daily or lifetime.
|
|
558
|
+
#
|
|
559
|
+
# @see WhopSDK::Models::AdGroup#budget_type
|
|
560
|
+
module BudgetType
|
|
561
|
+
extend WhopSDK::Internal::Type::Enum
|
|
562
|
+
|
|
563
|
+
DAILY = :daily
|
|
564
|
+
LIFETIME = :lifetime
|
|
565
|
+
|
|
566
|
+
# @!method self.values
|
|
567
|
+
# @return [Array<Symbol>]
|
|
568
|
+
end
|
|
569
|
+
|
|
570
|
+
# The pixel event optimized for. A standard event, or any custom pixel event name.
|
|
571
|
+
#
|
|
572
|
+
# @see WhopSDK::Models::AdGroup#conversion_event
|
|
573
|
+
module ConversionEvent
|
|
574
|
+
extend WhopSDK::Internal::Type::Union
|
|
575
|
+
|
|
576
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::PURCHASE }
|
|
577
|
+
|
|
578
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::ADD_TO_CART }
|
|
579
|
+
|
|
580
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::INITIATED_CHECKOUT }
|
|
581
|
+
|
|
582
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::ADD_PAYMENT_INFO }
|
|
583
|
+
|
|
584
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::COMPLETE_REGISTRATION }
|
|
585
|
+
|
|
586
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::LEAD }
|
|
587
|
+
|
|
588
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::CONTENT_VIEW }
|
|
589
|
+
|
|
590
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::SEARCH }
|
|
591
|
+
|
|
592
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::CONTACT }
|
|
593
|
+
|
|
594
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::CUSTOMIZE_PRODUCT }
|
|
595
|
+
|
|
596
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::DONATE }
|
|
597
|
+
|
|
598
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::FIND_LOCATION }
|
|
599
|
+
|
|
600
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::SCHEDULE }
|
|
601
|
+
|
|
602
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::START_TRIAL }
|
|
603
|
+
|
|
604
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::SUBMIT_APPLICATION }
|
|
605
|
+
|
|
606
|
+
variant const: -> { WhopSDK::Models::AdGroup::ConversionEvent::SUBSCRIBE }
|
|
607
|
+
|
|
608
|
+
variant String
|
|
609
|
+
|
|
610
|
+
# @!method self.variants
|
|
611
|
+
# @return [Array(Symbol, String)]
|
|
612
|
+
|
|
613
|
+
define_sorbet_constant!(:Variants) do
|
|
614
|
+
T.type_alias { T.any(WhopSDK::AdGroup::ConversionEvent::TaggedSymbol, String) }
|
|
615
|
+
end
|
|
616
|
+
|
|
617
|
+
# @!group
|
|
618
|
+
|
|
619
|
+
PURCHASE = :purchase
|
|
620
|
+
ADD_TO_CART = :add_to_cart
|
|
621
|
+
INITIATED_CHECKOUT = :initiated_checkout
|
|
622
|
+
ADD_PAYMENT_INFO = :add_payment_info
|
|
623
|
+
COMPLETE_REGISTRATION = :complete_registration
|
|
624
|
+
LEAD = :lead
|
|
625
|
+
CONTENT_VIEW = :content_view
|
|
626
|
+
SEARCH = :search
|
|
627
|
+
CONTACT = :contact
|
|
628
|
+
CUSTOMIZE_PRODUCT = :customize_product
|
|
629
|
+
DONATE = :donate
|
|
630
|
+
FIND_LOCATION = :find_location
|
|
631
|
+
SCHEDULE = :schedule
|
|
632
|
+
START_TRIAL = :start_trial
|
|
633
|
+
SUBMIT_APPLICATION = :submit_application
|
|
634
|
+
SUBSCRIBE = :subscribe
|
|
635
|
+
|
|
636
|
+
# @!endgroup
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
# Where results happen: website, profile (IG/FB), messaging (DM), on_ad
|
|
640
|
+
# (engagement), or the lead destinations (instant_forms,
|
|
641
|
+
# instant_forms_and_messenger, website_and_instant_forms).
|
|
642
|
+
#
|
|
643
|
+
# @see WhopSDK::Models::AdGroup#conversion_location
|
|
644
|
+
module ConversionLocation
|
|
645
|
+
extend WhopSDK::Internal::Type::Enum
|
|
646
|
+
|
|
647
|
+
WEBSITE = :website
|
|
648
|
+
PROFILE = :profile
|
|
649
|
+
MESSAGING = :messaging
|
|
650
|
+
ON_AD = :on_ad
|
|
651
|
+
INSTANT_FORMS = :instant_forms
|
|
652
|
+
INSTANT_FORMS_AND_MESSENGER = :instant_forms_and_messenger
|
|
653
|
+
WEBSITE_AND_INSTANT_FORMS = :website_and_instant_forms
|
|
654
|
+
|
|
655
|
+
# @!method self.values
|
|
656
|
+
# @return [Array<Symbol>]
|
|
657
|
+
end
|
|
658
|
+
|
|
659
|
+
# The current delivery state, mirroring the Delivery column in the ads dashboard.
|
|
660
|
+
# When several states apply at once, the highest-precedence one is returned.
|
|
661
|
+
#
|
|
662
|
+
# @see WhopSDK::Models::AdGroup#delivery_status
|
|
663
|
+
module DeliveryStatus
|
|
664
|
+
extend WhopSDK::Internal::Type::Enum
|
|
665
|
+
|
|
666
|
+
ALL_ADS_REJECTED = :all_ads_rejected
|
|
667
|
+
REJECTED = :rejected
|
|
668
|
+
DRAFT = :draft
|
|
669
|
+
NO_ADS = :no_ads
|
|
670
|
+
CAMPAIGN_PAUSED = :campaign_paused
|
|
671
|
+
PAUSED = :paused
|
|
672
|
+
PROCESSING = :processing
|
|
673
|
+
ISSUES = :issues
|
|
674
|
+
SCHEDULED = :scheduled
|
|
675
|
+
COMPLETED = :completed
|
|
676
|
+
ADS_OFF = :ads_off
|
|
677
|
+
LEARNING_LIMITED = :learning_limited
|
|
678
|
+
LEARNING = :learning
|
|
679
|
+
ACTIVE = :active
|
|
680
|
+
|
|
681
|
+
# @!method self.values
|
|
682
|
+
# @return [Array<Symbol>]
|
|
683
|
+
end
|
|
684
|
+
|
|
685
|
+
class Issue < WhopSDK::Internal::Type::BaseModel
|
|
686
|
+
# @!attribute id
|
|
687
|
+
# Unique identifier for the issue.
|
|
688
|
+
#
|
|
689
|
+
# @return [String]
|
|
690
|
+
required :id, String
|
|
691
|
+
|
|
692
|
+
# @!attribute message
|
|
693
|
+
# A description of what the issue is and how it can be resolved.
|
|
694
|
+
#
|
|
695
|
+
# @return [String]
|
|
696
|
+
required :message, String
|
|
697
|
+
|
|
698
|
+
# @!attribute resource_id
|
|
699
|
+
# The ID of the campaign, ad group, or ad the issue is attached to.
|
|
700
|
+
#
|
|
701
|
+
# @return [String, nil]
|
|
702
|
+
required :resource_id, String, nil?: true
|
|
703
|
+
|
|
704
|
+
# @!attribute resource_type
|
|
705
|
+
# The type of resource the issue is attached to.
|
|
706
|
+
#
|
|
707
|
+
# @return [Symbol, WhopSDK::Models::AdGroup::Issue::ResourceType]
|
|
708
|
+
required :resource_type, enum: -> { WhopSDK::AdGroup::Issue::ResourceType }
|
|
709
|
+
|
|
710
|
+
# @!method initialize(id:, message:, resource_id:, resource_type:)
|
|
711
|
+
# Open issues affecting this ad group and its descendant ads. Empty when there are
|
|
712
|
+
# none.
|
|
713
|
+
#
|
|
714
|
+
# @param id [String] Unique identifier for the issue.
|
|
715
|
+
#
|
|
716
|
+
# @param message [String] A description of what the issue is and how it can be resolved.
|
|
717
|
+
#
|
|
718
|
+
# @param resource_id [String, nil] The ID of the campaign, ad group, or ad the issue is attached to.
|
|
719
|
+
#
|
|
720
|
+
# @param resource_type [Symbol, WhopSDK::Models::AdGroup::Issue::ResourceType] The type of resource the issue is attached to.
|
|
721
|
+
|
|
722
|
+
# The type of resource the issue is attached to.
|
|
723
|
+
#
|
|
724
|
+
# @see WhopSDK::Models::AdGroup::Issue#resource_type
|
|
725
|
+
module ResourceType
|
|
726
|
+
extend WhopSDK::Internal::Type::Enum
|
|
727
|
+
|
|
728
|
+
AD_CAMPAIGN = :ad_campaign
|
|
729
|
+
AD_GROUP = :ad_group
|
|
730
|
+
AD = :ad
|
|
731
|
+
|
|
732
|
+
# @!method self.values
|
|
733
|
+
# @return [Array<Symbol>]
|
|
734
|
+
end
|
|
735
|
+
end
|
|
736
|
+
|
|
737
|
+
# The Whop pixel conversion event whose attributed count represents results — the
|
|
738
|
+
# optimization goal, or the highest-volume attributed event for campaigns that
|
|
739
|
+
# budget per ad group. Null when the goal isn't a Whop-attributed event.
|
|
740
|
+
#
|
|
741
|
+
# @see WhopSDK::Models::AdGroup#result_event
|
|
742
|
+
module ResultEvent
|
|
743
|
+
extend WhopSDK::Internal::Type::Enum
|
|
744
|
+
|
|
745
|
+
PURCHASE = :purchase
|
|
746
|
+
LEAD = :lead
|
|
747
|
+
SCHEDULE = :schedule
|
|
748
|
+
SUBMIT_APPLICATION = :submit_application
|
|
749
|
+
CONTACT = :contact
|
|
750
|
+
COMPLETE_REGISTRATION = :complete_registration
|
|
751
|
+
VIEW_CONTENT = :view_content
|
|
752
|
+
ADD_TO_CART = :add_to_cart
|
|
753
|
+
CUSTOM = :custom
|
|
754
|
+
|
|
755
|
+
# @!method self.values
|
|
756
|
+
# @return [Array<Symbol>]
|
|
757
|
+
end
|
|
758
|
+
|
|
759
|
+
# Delivery status of the ad group.
|
|
760
|
+
#
|
|
761
|
+
# @see WhopSDK::Models::AdGroup#status
|
|
762
|
+
module Status
|
|
763
|
+
extend WhopSDK::Internal::Type::Enum
|
|
764
|
+
|
|
765
|
+
ACTIVE = :active
|
|
766
|
+
PAUSED = :paused
|
|
767
|
+
REJECTED = :rejected
|
|
768
|
+
|
|
769
|
+
# @!method self.values
|
|
770
|
+
# @return [Array<Symbol>]
|
|
771
|
+
end
|
|
772
|
+
end
|
|
773
|
+
end
|
|
774
|
+
end
|