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,265 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Stats#retrieve
|
|
6
|
+
class StatRetrieveParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute metric
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :metric, String
|
|
14
|
+
|
|
15
|
+
# @!attribute from
|
|
16
|
+
# Start of the date range (YYYY-MM-DD).
|
|
17
|
+
#
|
|
18
|
+
# @return [Date]
|
|
19
|
+
required :from, Date
|
|
20
|
+
|
|
21
|
+
# @!attribute to
|
|
22
|
+
# End of the date range (YYYY-MM-DD).
|
|
23
|
+
#
|
|
24
|
+
# @return [Date]
|
|
25
|
+
required :to, Date
|
|
26
|
+
|
|
27
|
+
# @!attribute access_level
|
|
28
|
+
# Filter to a single access level. Pair with breakdown_by=access_level. Available
|
|
29
|
+
# on metrics that list access_level.
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :access_level, String
|
|
33
|
+
|
|
34
|
+
# @!attribute account_id
|
|
35
|
+
# The account this query concerns, for example biz_AbC123.
|
|
36
|
+
#
|
|
37
|
+
# @return [String, nil]
|
|
38
|
+
optional :account_id, String
|
|
39
|
+
|
|
40
|
+
# @!attribute ad_campaign_ids
|
|
41
|
+
# Ad campaign ids (adcamp\_...) to scope the report to; stats are summed across
|
|
42
|
+
# them. Available on metrics that list ad_campaign_ids.
|
|
43
|
+
#
|
|
44
|
+
# @return [Array<String>, nil]
|
|
45
|
+
optional :ad_campaign_ids, WhopSDK::Internal::Type::ArrayOf[String]
|
|
46
|
+
|
|
47
|
+
# @!attribute ad_group_ids
|
|
48
|
+
# Ad group ids (adgrp\_...) to scope the report to; stats are summed across them.
|
|
49
|
+
# Available on metrics that list ad_group_ids.
|
|
50
|
+
#
|
|
51
|
+
# @return [Array<String>, nil]
|
|
52
|
+
optional :ad_group_ids, WhopSDK::Internal::Type::ArrayOf[String]
|
|
53
|
+
|
|
54
|
+
# @!attribute ad_ids
|
|
55
|
+
# Ad ids (ad\_...) to scope the report to; stats are summed across them. Available
|
|
56
|
+
# on metrics that list ad_ids.
|
|
57
|
+
#
|
|
58
|
+
# @return [Array<String>, nil]
|
|
59
|
+
optional :ad_ids, WhopSDK::Internal::Type::ArrayOf[String]
|
|
60
|
+
|
|
61
|
+
# @!attribute breakdown_by
|
|
62
|
+
# Split the metric out by one of its properties — each point gets a breakdown
|
|
63
|
+
# array. For example breakdown_by=currency returns an entry for usd, an entry for
|
|
64
|
+
# eur, and so on.
|
|
65
|
+
#
|
|
66
|
+
# @return [String, nil]
|
|
67
|
+
optional :breakdown_by, String
|
|
68
|
+
|
|
69
|
+
# @!attribute card_network
|
|
70
|
+
# Filter to a single card brand, for example visa. A refinement of
|
|
71
|
+
# payment_method=card. Available on metrics that list card_network.
|
|
72
|
+
#
|
|
73
|
+
# @return [String, nil]
|
|
74
|
+
optional :card_network, String
|
|
75
|
+
|
|
76
|
+
# @!attribute category
|
|
77
|
+
# Filter to a single balance-activity category, for example payments. Pair with
|
|
78
|
+
# breakdown_by=category to split the activity. Available on metrics that list
|
|
79
|
+
# category.
|
|
80
|
+
#
|
|
81
|
+
# @return [String, nil]
|
|
82
|
+
optional :category, String
|
|
83
|
+
|
|
84
|
+
# @!attribute convert_to
|
|
85
|
+
# Display currency for money metrics — every amount is converted into this ISO
|
|
86
|
+
# currency using the exchange rate on each period's date. Defaults to usd. For the
|
|
87
|
+
# ads metrics (ad_spend, ad_report), pass the account's ads reporting currency to
|
|
88
|
+
# match the ad entity endpoints. Ignored when you filter or break down by currency
|
|
89
|
+
# (those report the original transaction currency, unconverted).
|
|
90
|
+
#
|
|
91
|
+
# @return [String, nil]
|
|
92
|
+
optional :convert_to, String
|
|
93
|
+
|
|
94
|
+
# @!attribute currency
|
|
95
|
+
# Filter to transactions made in this original ISO currency, for example eur —
|
|
96
|
+
# reported in that currency, not converted. Pair with breakdown_by=currency to
|
|
97
|
+
# split a metric by currency. Available on metrics that list currency.
|
|
98
|
+
#
|
|
99
|
+
# @return [String, nil]
|
|
100
|
+
optional :currency, String
|
|
101
|
+
|
|
102
|
+
# @!attribute fee_type
|
|
103
|
+
# Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by
|
|
104
|
+
# type. Available on metrics that list fee_type.
|
|
105
|
+
#
|
|
106
|
+
# @return [String, nil]
|
|
107
|
+
optional :fee_type, String
|
|
108
|
+
|
|
109
|
+
# @!attribute interval
|
|
110
|
+
# How wide each point is. Defaults to day. Snapshot metrics are day-only.
|
|
111
|
+
#
|
|
112
|
+
# @return [Symbol, WhopSDK::Models::StatRetrieveParams::Interval, nil]
|
|
113
|
+
optional :interval, enum: -> { WhopSDK::StatRetrieveParams::Interval }
|
|
114
|
+
|
|
115
|
+
# @!attribute most_recent_action
|
|
116
|
+
# Filter to a single most-recent member action. Pair with
|
|
117
|
+
# breakdown_by=most_recent_action. Available on metrics that list
|
|
118
|
+
# most_recent_action.
|
|
119
|
+
#
|
|
120
|
+
# @return [String, nil]
|
|
121
|
+
optional :most_recent_action, String
|
|
122
|
+
|
|
123
|
+
# @!attribute payment_method
|
|
124
|
+
# Filter to a single payment method, for example card or crypto. Available on
|
|
125
|
+
# metrics that list payment_method.
|
|
126
|
+
#
|
|
127
|
+
# @return [String, nil]
|
|
128
|
+
optional :payment_method, String
|
|
129
|
+
|
|
130
|
+
# @!attribute product
|
|
131
|
+
# Filter to a single product (access pass id), for example prod_AbC123. Pair with
|
|
132
|
+
# breakdown_by=product. Available on metrics that list product.
|
|
133
|
+
#
|
|
134
|
+
# @return [String, nil]
|
|
135
|
+
optional :product, String
|
|
136
|
+
|
|
137
|
+
# @!attribute referred_user_id
|
|
138
|
+
# Filter a referral metric to the businesses attributed to one person you
|
|
139
|
+
# referred, for example user_AbC123. Available on metrics that list
|
|
140
|
+
# referred_user_id.
|
|
141
|
+
#
|
|
142
|
+
# @return [String, nil]
|
|
143
|
+
optional :referred_user_id, String
|
|
144
|
+
|
|
145
|
+
# @!attribute segment
|
|
146
|
+
# Filter to a single wallet-balance segment, for example available. Pair with
|
|
147
|
+
# breakdown_by=segment to split the balance. Available on metrics that list
|
|
148
|
+
# segment.
|
|
149
|
+
#
|
|
150
|
+
# @return [String, nil]
|
|
151
|
+
optional :segment, String
|
|
152
|
+
|
|
153
|
+
# @!attribute snapshot_window
|
|
154
|
+
# Trailing window for snapshot metrics. Only accepted by snapshot metrics (each
|
|
155
|
+
# lists its allowed windows in the catalog); defaults to the metric's first
|
|
156
|
+
# supported window. Only 30d today.
|
|
157
|
+
#
|
|
158
|
+
# @return [Symbol, WhopSDK::Models::StatRetrieveParams::SnapshotWindow, nil]
|
|
159
|
+
optional :snapshot_window, enum: -> { WhopSDK::StatRetrieveParams::SnapshotWindow }
|
|
160
|
+
|
|
161
|
+
# @!attribute source
|
|
162
|
+
# Filter to a single GMV source, for example payments. Pair with
|
|
163
|
+
# breakdown_by=source to split by source. Available on metrics that list source.
|
|
164
|
+
#
|
|
165
|
+
# @return [String, nil]
|
|
166
|
+
optional :source, String
|
|
167
|
+
|
|
168
|
+
# @!attribute status
|
|
169
|
+
# Filter to a single membership status. Pair with breakdown_by=status. Available
|
|
170
|
+
# on metrics that list status.
|
|
171
|
+
#
|
|
172
|
+
# @return [String, nil]
|
|
173
|
+
optional :status, String
|
|
174
|
+
|
|
175
|
+
# @!attribute time_zone
|
|
176
|
+
# IANA time zone to bucket the series in, for example America/New_York. Defaults
|
|
177
|
+
# to UTC. Not accepted by snapshot metrics, which are UTC only.
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :time_zone, String
|
|
181
|
+
|
|
182
|
+
# @!method initialize(metric:, from:, to:, access_level: nil, account_id: nil, ad_campaign_ids: nil, ad_group_ids: nil, ad_ids: nil, breakdown_by: nil, card_network: nil, category: nil, convert_to: nil, currency: nil, fee_type: nil, interval: nil, most_recent_action: nil, payment_method: nil, product: nil, referred_user_id: nil, segment: nil, snapshot_window: nil, source: nil, status: nil, time_zone: nil, request_options: {})
|
|
183
|
+
# Some parameter documentations has been truncated, see
|
|
184
|
+
# {WhopSDK::Models::StatRetrieveParams} for more details.
|
|
185
|
+
#
|
|
186
|
+
# @param metric [String]
|
|
187
|
+
#
|
|
188
|
+
# @param from [Date] Start of the date range (YYYY-MM-DD).
|
|
189
|
+
#
|
|
190
|
+
# @param to [Date] End of the date range (YYYY-MM-DD).
|
|
191
|
+
#
|
|
192
|
+
# @param access_level [String] Filter to a single access level. Pair with breakdown_by=access_level. Available
|
|
193
|
+
#
|
|
194
|
+
# @param account_id [String] The account this query concerns, for example biz_AbC123.
|
|
195
|
+
#
|
|
196
|
+
# @param ad_campaign_ids [Array<String>] Ad campaign ids (adcamp\_...) to scope the report to; stats are summed across
|
|
197
|
+
# the
|
|
198
|
+
#
|
|
199
|
+
# @param ad_group_ids [Array<String>] Ad group ids (adgrp\_...) to scope the report to; stats are summed across them.
|
|
200
|
+
# A
|
|
201
|
+
#
|
|
202
|
+
# @param ad_ids [Array<String>] Ad ids (ad\_...) to scope the report to; stats are summed across them. Available
|
|
203
|
+
#
|
|
204
|
+
# @param breakdown_by [String] Split the metric out by one of its properties — each point gets a breakdown arra
|
|
205
|
+
#
|
|
206
|
+
# @param card_network [String] Filter to a single card brand, for example visa. A refinement of payment_method=
|
|
207
|
+
#
|
|
208
|
+
# @param category [String] Filter to a single balance-activity category, for example payments. Pair with br
|
|
209
|
+
#
|
|
210
|
+
# @param convert_to [String] Display currency for money metrics — every amount is converted into this ISO cur
|
|
211
|
+
#
|
|
212
|
+
# @param currency [String] Filter to transactions made in this original ISO currency, for example eur — rep
|
|
213
|
+
#
|
|
214
|
+
# @param fee_type [String] Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by ty
|
|
215
|
+
#
|
|
216
|
+
# @param interval [Symbol, WhopSDK::Models::StatRetrieveParams::Interval] How wide each point is. Defaults to day. Snapshot metrics are day-only.
|
|
217
|
+
#
|
|
218
|
+
# @param most_recent_action [String] Filter to a single most-recent member action. Pair with breakdown_by=most_recent
|
|
219
|
+
#
|
|
220
|
+
# @param payment_method [String] Filter to a single payment method, for example card or crypto. Available on metr
|
|
221
|
+
#
|
|
222
|
+
# @param product [String] Filter to a single product (access pass id), for example prod_AbC123. Pair with
|
|
223
|
+
#
|
|
224
|
+
# @param referred_user_id [String] Filter a referral metric to the businesses attributed to one person you referred
|
|
225
|
+
#
|
|
226
|
+
# @param segment [String] Filter to a single wallet-balance segment, for example available. Pair with brea
|
|
227
|
+
#
|
|
228
|
+
# @param snapshot_window [Symbol, WhopSDK::Models::StatRetrieveParams::SnapshotWindow] Trailing window for snapshot metrics. Only accepted by snapshot metrics (each li
|
|
229
|
+
#
|
|
230
|
+
# @param source [String] Filter to a single GMV source, for example payments. Pair with breakdown_by=sour
|
|
231
|
+
#
|
|
232
|
+
# @param status [String] Filter to a single membership status. Pair with breakdown_by=status. Available o
|
|
233
|
+
#
|
|
234
|
+
# @param time_zone [String] IANA time zone to bucket the series in, for example America/New_York. Defaults t
|
|
235
|
+
#
|
|
236
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
237
|
+
|
|
238
|
+
# How wide each point is. Defaults to day. Snapshot metrics are day-only.
|
|
239
|
+
module Interval
|
|
240
|
+
extend WhopSDK::Internal::Type::Enum
|
|
241
|
+
|
|
242
|
+
HOUR = :hour
|
|
243
|
+
DAY = :day
|
|
244
|
+
WEEK = :week
|
|
245
|
+
MONTH = :month
|
|
246
|
+
YEAR = :year
|
|
247
|
+
|
|
248
|
+
# @!method self.values
|
|
249
|
+
# @return [Array<Symbol>]
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
# Trailing window for snapshot metrics. Only accepted by snapshot metrics (each
|
|
253
|
+
# lists its allowed windows in the catalog); defaults to the metric's first
|
|
254
|
+
# supported window. Only 30d today.
|
|
255
|
+
module SnapshotWindow
|
|
256
|
+
extend WhopSDK::Internal::Type::Enum
|
|
257
|
+
|
|
258
|
+
SNAPSHOT_WINDOW_30D = :"30d"
|
|
259
|
+
|
|
260
|
+
# @!method self.values
|
|
261
|
+
# @return [Array<Symbol>]
|
|
262
|
+
end
|
|
263
|
+
end
|
|
264
|
+
end
|
|
265
|
+
end
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Stats#retrieve
|
|
6
|
+
class StatRetrieveResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute data
|
|
8
|
+
#
|
|
9
|
+
# @return [WhopSDK::Models::StatRetrieveResponse::Data]
|
|
10
|
+
required :data, -> { WhopSDK::Models::StatRetrieveResponse::Data }
|
|
11
|
+
|
|
12
|
+
# @!method initialize(data:)
|
|
13
|
+
# @param data [WhopSDK::Models::StatRetrieveResponse::Data]
|
|
14
|
+
|
|
15
|
+
# @see WhopSDK::Models::StatRetrieveResponse#data
|
|
16
|
+
class Data < WhopSDK::Internal::Type::BaseModel
|
|
17
|
+
# @!attribute points
|
|
18
|
+
# One entry per period, oldest first.
|
|
19
|
+
#
|
|
20
|
+
# @return [Array<WhopSDK::Models::StatRetrieveResponse::Data::Point>]
|
|
21
|
+
required :points,
|
|
22
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::StatRetrieveResponse::Data::Point] }
|
|
23
|
+
|
|
24
|
+
# @!attribute currency
|
|
25
|
+
# ISO currency the values are denominated in. Present for currency-unit metrics:
|
|
26
|
+
# the convert_to currency, or usd.
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :currency, String, nil?: true
|
|
30
|
+
|
|
31
|
+
# @!method initialize(points:, currency: nil)
|
|
32
|
+
# Some parameter documentations has been truncated, see
|
|
33
|
+
# {WhopSDK::Models::StatRetrieveResponse::Data} for more details.
|
|
34
|
+
#
|
|
35
|
+
# @param points [Array<WhopSDK::Models::StatRetrieveResponse::Data::Point>] One entry per period, oldest first.
|
|
36
|
+
#
|
|
37
|
+
# @param currency [String, nil] ISO currency the values are denominated in. Present for currency-unit metrics: t
|
|
38
|
+
|
|
39
|
+
class Point < WhopSDK::Internal::Type::BaseModel
|
|
40
|
+
# @!attribute timestamp
|
|
41
|
+
# Unix timestamp (seconds) of the period start.
|
|
42
|
+
#
|
|
43
|
+
# @return [Integer]
|
|
44
|
+
required :timestamp, Integer
|
|
45
|
+
|
|
46
|
+
# @!attribute value
|
|
47
|
+
# The metric's value for this period, in the metric's unit.
|
|
48
|
+
#
|
|
49
|
+
# @return [Float, nil]
|
|
50
|
+
required :value, Float, nil?: true
|
|
51
|
+
|
|
52
|
+
# @!attribute breakdown
|
|
53
|
+
# Present only when broken down: one entry per property value in this period.
|
|
54
|
+
#
|
|
55
|
+
# @return [Array<WhopSDK::Models::StatRetrieveResponse::Data::Point::Breakdown>, nil]
|
|
56
|
+
optional :breakdown,
|
|
57
|
+
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::StatRetrieveResponse::Data::Point::Breakdown] }
|
|
58
|
+
|
|
59
|
+
# @!method initialize(timestamp:, value:, breakdown: nil)
|
|
60
|
+
# @param timestamp [Integer] Unix timestamp (seconds) of the period start.
|
|
61
|
+
#
|
|
62
|
+
# @param value [Float, nil] The metric's value for this period, in the metric's unit.
|
|
63
|
+
#
|
|
64
|
+
# @param breakdown [Array<WhopSDK::Models::StatRetrieveResponse::Data::Point::Breakdown>] Present only when broken down: one entry per property value in this period.
|
|
65
|
+
|
|
66
|
+
class Breakdown < WhopSDK::Internal::Type::BaseModel
|
|
67
|
+
# @!attribute name
|
|
68
|
+
# The property value, for example usd or visa.
|
|
69
|
+
#
|
|
70
|
+
# @return [String]
|
|
71
|
+
required :name, String
|
|
72
|
+
|
|
73
|
+
# @!attribute value
|
|
74
|
+
# The metric's value for this entry.
|
|
75
|
+
#
|
|
76
|
+
# @return [Float, nil]
|
|
77
|
+
required :value, Float, nil?: true
|
|
78
|
+
|
|
79
|
+
# @!method initialize(name:, value:)
|
|
80
|
+
# @param name [String] The property value, for example usd or visa.
|
|
81
|
+
#
|
|
82
|
+
# @param value [Float, nil] The metric's value for this entry.
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Swaps#create
|
|
6
|
+
class SwapCreateParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute account_id
|
|
11
|
+
# Business or user account ID (biz*\* / user*\*).
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :account_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute amount
|
|
17
|
+
# Source token amount.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :amount, String
|
|
21
|
+
|
|
22
|
+
# @!attribute from_token
|
|
23
|
+
# Source token contract address or ticker symbol, such as "USDT".
|
|
24
|
+
#
|
|
25
|
+
# @return [String]
|
|
26
|
+
required :from_token, String
|
|
27
|
+
|
|
28
|
+
# @!attribute to_token
|
|
29
|
+
# Destination token contract address or ticker symbol, such as "XAUT".
|
|
30
|
+
#
|
|
31
|
+
# @return [String]
|
|
32
|
+
required :to_token, String
|
|
33
|
+
|
|
34
|
+
# @!attribute from_chain
|
|
35
|
+
# Source chain name or chain ID. Defaults to the source token's chain when
|
|
36
|
+
# omitted.
|
|
37
|
+
#
|
|
38
|
+
# @return [String, Integer, nil]
|
|
39
|
+
optional :from_chain, union: -> { WhopSDK::SwapCreateParams::FromChain }, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute slippage_bps
|
|
42
|
+
# Maximum slippage tolerance in basis points.
|
|
43
|
+
#
|
|
44
|
+
# @return [Integer, nil]
|
|
45
|
+
optional :slippage_bps, Integer, nil?: true
|
|
46
|
+
|
|
47
|
+
# @!attribute to_chain
|
|
48
|
+
# Destination chain name or chain ID. Defaults to the destination token's chain
|
|
49
|
+
# when omitted.
|
|
50
|
+
#
|
|
51
|
+
# @return [String, Integer, nil]
|
|
52
|
+
optional :to_chain, union: -> { WhopSDK::SwapCreateParams::ToChain }, nil?: true
|
|
53
|
+
|
|
54
|
+
# @!method initialize(account_id:, amount:, from_token:, to_token:, from_chain: nil, slippage_bps: nil, to_chain: nil, request_options: {})
|
|
55
|
+
# Some parameter documentations has been truncated, see
|
|
56
|
+
# {WhopSDK::Models::SwapCreateParams} for more details.
|
|
57
|
+
#
|
|
58
|
+
# @param account_id [String] Business or user account ID (biz*\* / user*\*).
|
|
59
|
+
#
|
|
60
|
+
# @param amount [String] Source token amount.
|
|
61
|
+
#
|
|
62
|
+
# @param from_token [String] Source token contract address or ticker symbol, such as "USDT".
|
|
63
|
+
#
|
|
64
|
+
# @param to_token [String] Destination token contract address or ticker symbol, such as "XAUT".
|
|
65
|
+
#
|
|
66
|
+
# @param from_chain [String, Integer, nil] Source chain name or chain ID. Defaults to the source token's chain when omitted
|
|
67
|
+
#
|
|
68
|
+
# @param slippage_bps [Integer, nil] Maximum slippage tolerance in basis points.
|
|
69
|
+
#
|
|
70
|
+
# @param to_chain [String, Integer, nil] Destination chain name or chain ID. Defaults to the destination token's chain wh
|
|
71
|
+
#
|
|
72
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
73
|
+
|
|
74
|
+
# Source chain name or chain ID. Defaults to the source token's chain when
|
|
75
|
+
# omitted.
|
|
76
|
+
module FromChain
|
|
77
|
+
extend WhopSDK::Internal::Type::Union
|
|
78
|
+
|
|
79
|
+
variant String
|
|
80
|
+
|
|
81
|
+
variant Integer
|
|
82
|
+
|
|
83
|
+
# @!method self.variants
|
|
84
|
+
# @return [Array(String, Integer)]
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Destination chain name or chain ID. Defaults to the destination token's chain
|
|
88
|
+
# when omitted.
|
|
89
|
+
module ToChain
|
|
90
|
+
extend WhopSDK::Internal::Type::Union
|
|
91
|
+
|
|
92
|
+
variant String
|
|
93
|
+
|
|
94
|
+
variant Integer
|
|
95
|
+
|
|
96
|
+
# @!method self.variants
|
|
97
|
+
# @return [Array(String, Integer)]
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Swaps#create_quote
|
|
6
|
+
class SwapCreateQuoteParams < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include WhopSDK::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute amount
|
|
11
|
+
# Source token amount.
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :amount, String
|
|
15
|
+
|
|
16
|
+
# @!attribute from_token
|
|
17
|
+
# Source token contract address or ticker symbol, such as "USDT".
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :from_token, String
|
|
21
|
+
|
|
22
|
+
# @!attribute to_token
|
|
23
|
+
# Destination token contract address or ticker symbol, such as "XAUT".
|
|
24
|
+
#
|
|
25
|
+
# @return [String]
|
|
26
|
+
required :to_token, String
|
|
27
|
+
|
|
28
|
+
# @!attribute from_address
|
|
29
|
+
# Source wallet address used for the quote.
|
|
30
|
+
#
|
|
31
|
+
# @return [String, nil]
|
|
32
|
+
optional :from_address, String, nil?: true
|
|
33
|
+
|
|
34
|
+
# @!attribute from_chain
|
|
35
|
+
# Source chain name or chain ID. Defaults to the source token's chain when
|
|
36
|
+
# omitted.
|
|
37
|
+
#
|
|
38
|
+
# @return [String, Integer, nil]
|
|
39
|
+
optional :from_chain, union: -> { WhopSDK::SwapCreateQuoteParams::FromChain }, nil?: true
|
|
40
|
+
|
|
41
|
+
# @!attribute metadata
|
|
42
|
+
# Metadata to include with the quote response.
|
|
43
|
+
#
|
|
44
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
45
|
+
optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
46
|
+
|
|
47
|
+
# @!attribute slippage_bps
|
|
48
|
+
# Maximum slippage tolerance in basis points.
|
|
49
|
+
#
|
|
50
|
+
# @return [Integer, nil]
|
|
51
|
+
optional :slippage_bps, Integer, nil?: true
|
|
52
|
+
|
|
53
|
+
# @!attribute to_address
|
|
54
|
+
# Destination wallet address used for the quote.
|
|
55
|
+
#
|
|
56
|
+
# @return [String, nil]
|
|
57
|
+
optional :to_address, String, nil?: true
|
|
58
|
+
|
|
59
|
+
# @!attribute to_chain
|
|
60
|
+
# Destination chain name or chain ID. Defaults to the destination token's chain
|
|
61
|
+
# when omitted.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, Integer, nil]
|
|
64
|
+
optional :to_chain, union: -> { WhopSDK::SwapCreateQuoteParams::ToChain }, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!method initialize(amount:, from_token:, to_token:, from_address: nil, from_chain: nil, metadata: nil, slippage_bps: nil, to_address: nil, to_chain: nil, request_options: {})
|
|
67
|
+
# Some parameter documentations has been truncated, see
|
|
68
|
+
# {WhopSDK::Models::SwapCreateQuoteParams} for more details.
|
|
69
|
+
#
|
|
70
|
+
# @param amount [String] Source token amount.
|
|
71
|
+
#
|
|
72
|
+
# @param from_token [String] Source token contract address or ticker symbol, such as "USDT".
|
|
73
|
+
#
|
|
74
|
+
# @param to_token [String] Destination token contract address or ticker symbol, such as "XAUT".
|
|
75
|
+
#
|
|
76
|
+
# @param from_address [String, nil] Source wallet address used for the quote.
|
|
77
|
+
#
|
|
78
|
+
# @param from_chain [String, Integer, nil] Source chain name or chain ID. Defaults to the source token's chain when omitted
|
|
79
|
+
#
|
|
80
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata to include with the quote response.
|
|
81
|
+
#
|
|
82
|
+
# @param slippage_bps [Integer, nil] Maximum slippage tolerance in basis points.
|
|
83
|
+
#
|
|
84
|
+
# @param to_address [String, nil] Destination wallet address used for the quote.
|
|
85
|
+
#
|
|
86
|
+
# @param to_chain [String, Integer, nil] Destination chain name or chain ID. Defaults to the destination token's chain wh
|
|
87
|
+
#
|
|
88
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
89
|
+
|
|
90
|
+
# Source chain name or chain ID. Defaults to the source token's chain when
|
|
91
|
+
# omitted.
|
|
92
|
+
module FromChain
|
|
93
|
+
extend WhopSDK::Internal::Type::Union
|
|
94
|
+
|
|
95
|
+
variant String
|
|
96
|
+
|
|
97
|
+
variant Integer
|
|
98
|
+
|
|
99
|
+
# @!method self.variants
|
|
100
|
+
# @return [Array(String, Integer)]
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Destination chain name or chain ID. Defaults to the destination token's chain
|
|
104
|
+
# when omitted.
|
|
105
|
+
module ToChain
|
|
106
|
+
extend WhopSDK::Internal::Type::Union
|
|
107
|
+
|
|
108
|
+
variant String
|
|
109
|
+
|
|
110
|
+
variant Integer
|
|
111
|
+
|
|
112
|
+
# @!method self.variants
|
|
113
|
+
# @return [Array(String, Integer)]
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
end
|
|
117
|
+
end
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# @see WhopSDK::Resources::Swaps#create_quote
|
|
6
|
+
class SwapCreateQuoteResponse < WhopSDK::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute amount_in
|
|
8
|
+
# Source token amount used for the quote.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :amount_in, String
|
|
12
|
+
|
|
13
|
+
# @!attribute amount_out
|
|
14
|
+
# Estimated destination token amount.
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :amount_out, String
|
|
18
|
+
|
|
19
|
+
# @!attribute fee_bps
|
|
20
|
+
# Whop fee in basis points.
|
|
21
|
+
#
|
|
22
|
+
# @return [Integer]
|
|
23
|
+
required :fee_bps, Integer
|
|
24
|
+
|
|
25
|
+
# @!attribute from_token
|
|
26
|
+
# Resolved source token details.
|
|
27
|
+
#
|
|
28
|
+
# @return [Hash{Symbol=>Object}]
|
|
29
|
+
required :from_token, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
30
|
+
|
|
31
|
+
# @!attribute metadata
|
|
32
|
+
# Metadata from the request.
|
|
33
|
+
#
|
|
34
|
+
# @return [Hash{Symbol=>Object}]
|
|
35
|
+
required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
36
|
+
|
|
37
|
+
# @!attribute object
|
|
38
|
+
#
|
|
39
|
+
# @return [Symbol, WhopSDK::Models::SwapCreateQuoteResponse::Object]
|
|
40
|
+
required :object, enum: -> { WhopSDK::Models::SwapCreateQuoteResponse::Object }
|
|
41
|
+
|
|
42
|
+
# @!attribute rate
|
|
43
|
+
# Quoted exchange rate.
|
|
44
|
+
#
|
|
45
|
+
# @return [String]
|
|
46
|
+
required :rate, String
|
|
47
|
+
|
|
48
|
+
# @!attribute to_token
|
|
49
|
+
# Resolved destination token details.
|
|
50
|
+
#
|
|
51
|
+
# @return [Hash{Symbol=>Object}]
|
|
52
|
+
required :to_token, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]
|
|
53
|
+
|
|
54
|
+
# @!attribute amount_out_min
|
|
55
|
+
# Minimum destination amount after slippage.
|
|
56
|
+
#
|
|
57
|
+
# @return [String, nil]
|
|
58
|
+
optional :amount_out_min, String
|
|
59
|
+
|
|
60
|
+
# @!attribute bridge_fee
|
|
61
|
+
# Estimated bridge fee for cross-chain swaps.
|
|
62
|
+
#
|
|
63
|
+
# @return [String, nil]
|
|
64
|
+
optional :bridge_fee, String, nil?: true
|
|
65
|
+
|
|
66
|
+
# @!attribute estimated_duration_seconds
|
|
67
|
+
# Estimated time for the swap to complete.
|
|
68
|
+
#
|
|
69
|
+
# @return [Integer, nil]
|
|
70
|
+
optional :estimated_duration_seconds, Integer, nil?: true
|
|
71
|
+
|
|
72
|
+
# @!attribute from_address
|
|
73
|
+
# Source wallet address used for the quote.
|
|
74
|
+
#
|
|
75
|
+
# @return [String, nil]
|
|
76
|
+
optional :from_address, String, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute requires_token_approval
|
|
79
|
+
# Whether the source token needs approval before swapping.
|
|
80
|
+
#
|
|
81
|
+
# @return [Boolean, nil]
|
|
82
|
+
optional :requires_token_approval, WhopSDK::Internal::Type::Boolean, nil?: true
|
|
83
|
+
|
|
84
|
+
# @!attribute to_address
|
|
85
|
+
# Destination wallet address used for the quote.
|
|
86
|
+
#
|
|
87
|
+
# @return [String, nil]
|
|
88
|
+
optional :to_address, String, nil?: true
|
|
89
|
+
|
|
90
|
+
# @!method initialize(amount_in:, amount_out:, fee_bps:, from_token:, metadata:, object:, rate:, to_token:, amount_out_min: nil, bridge_fee: nil, estimated_duration_seconds: nil, from_address: nil, requires_token_approval: nil, to_address: nil)
|
|
91
|
+
# @param amount_in [String] Source token amount used for the quote.
|
|
92
|
+
#
|
|
93
|
+
# @param amount_out [String] Estimated destination token amount.
|
|
94
|
+
#
|
|
95
|
+
# @param fee_bps [Integer] Whop fee in basis points.
|
|
96
|
+
#
|
|
97
|
+
# @param from_token [Hash{Symbol=>Object}] Resolved source token details.
|
|
98
|
+
#
|
|
99
|
+
# @param metadata [Hash{Symbol=>Object}] Metadata from the request.
|
|
100
|
+
#
|
|
101
|
+
# @param object [Symbol, WhopSDK::Models::SwapCreateQuoteResponse::Object]
|
|
102
|
+
#
|
|
103
|
+
# @param rate [String] Quoted exchange rate.
|
|
104
|
+
#
|
|
105
|
+
# @param to_token [Hash{Symbol=>Object}] Resolved destination token details.
|
|
106
|
+
#
|
|
107
|
+
# @param amount_out_min [String] Minimum destination amount after slippage.
|
|
108
|
+
#
|
|
109
|
+
# @param bridge_fee [String, nil] Estimated bridge fee for cross-chain swaps.
|
|
110
|
+
#
|
|
111
|
+
# @param estimated_duration_seconds [Integer, nil] Estimated time for the swap to complete.
|
|
112
|
+
#
|
|
113
|
+
# @param from_address [String, nil] Source wallet address used for the quote.
|
|
114
|
+
#
|
|
115
|
+
# @param requires_token_approval [Boolean, nil] Whether the source token needs approval before swapping.
|
|
116
|
+
#
|
|
117
|
+
# @param to_address [String, nil] Destination wallet address used for the quote.
|
|
118
|
+
|
|
119
|
+
# @see WhopSDK::Models::SwapCreateQuoteResponse#object
|
|
120
|
+
module Object
|
|
121
|
+
extend WhopSDK::Internal::Type::Enum
|
|
122
|
+
|
|
123
|
+
SWAP_QUOTE = :swap_quote
|
|
124
|
+
|
|
125
|
+
# @!method self.values
|
|
126
|
+
# @return [Array<Symbol>]
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
end
|