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,351 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
module Workforce
|
|
6
|
+
# @see WhopSDK::Resources::Workforce::Bounties#retrieve
|
|
7
|
+
class WorkforceBounty < WhopSDK::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# Bounty ID, prefixed `bnty_`.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute accepted_submissions_count
|
|
15
|
+
# Submissions accepted so far.
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer]
|
|
18
|
+
required :accepted_submissions_count, Integer
|
|
19
|
+
|
|
20
|
+
# @!attribute accepted_submissions_limit
|
|
21
|
+
# Number of submissions that can be accepted (winner slots).
|
|
22
|
+
#
|
|
23
|
+
# @return [Integer]
|
|
24
|
+
required :accepted_submissions_limit, Integer
|
|
25
|
+
|
|
26
|
+
# @!attribute allowed_country_codes
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<String>]
|
|
29
|
+
required :allowed_country_codes, WhopSDK::Internal::Type::ArrayOf[String]
|
|
30
|
+
|
|
31
|
+
# @!attribute budget_amount
|
|
32
|
+
# Total gross budget committed to the bounty: `gross_reward_amount` times
|
|
33
|
+
# `accepted_submissions_limit`.
|
|
34
|
+
#
|
|
35
|
+
# @return [Float]
|
|
36
|
+
required :budget_amount, Float
|
|
37
|
+
|
|
38
|
+
# @!attribute business_goal_type
|
|
39
|
+
# What the poster wants the work to achieve.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::BusinessGoalType, nil]
|
|
42
|
+
required :business_goal_type,
|
|
43
|
+
enum: -> { WhopSDK::Workforce::WorkforceBounty::BusinessGoalType },
|
|
44
|
+
nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute created_at
|
|
47
|
+
# When the bounty was created, as an ISO 8601 timestamp.
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :created_at, String
|
|
51
|
+
|
|
52
|
+
# @!attribute currency
|
|
53
|
+
# Currency for all amounts on the bounty, as a lowercase ISO 4217 code.
|
|
54
|
+
#
|
|
55
|
+
# @return [String]
|
|
56
|
+
required :currency, String
|
|
57
|
+
|
|
58
|
+
# @!attribute description
|
|
59
|
+
# Full task instructions shown to workers.
|
|
60
|
+
#
|
|
61
|
+
# @return [String]
|
|
62
|
+
required :description, String
|
|
63
|
+
|
|
64
|
+
# @!attribute experience_id
|
|
65
|
+
# Experience the bounty is hosted in, prefixed `exp_`. Null for platform-wide
|
|
66
|
+
# bounties; may belong to a different account than the funder.
|
|
67
|
+
#
|
|
68
|
+
# @return [String, nil]
|
|
69
|
+
required :experience_id, String, nil?: true
|
|
70
|
+
|
|
71
|
+
# @!attribute funding_account
|
|
72
|
+
# The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
73
|
+
# personally. May differ from the account hosting `experience_id`.
|
|
74
|
+
#
|
|
75
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBounty::FundingAccount, nil]
|
|
76
|
+
required :funding_account, -> { WhopSDK::Workforce::WorkforceBounty::FundingAccount }, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute gross_paid_out_amount
|
|
79
|
+
# Gross amount paid out from the bounty pool across accepted submissions — worker
|
|
80
|
+
# payouts, platform fees, and affiliate shares together. Tips and reviewer rewards
|
|
81
|
+
# are excluded.
|
|
82
|
+
#
|
|
83
|
+
# @return [Float]
|
|
84
|
+
required :gross_paid_out_amount, Float
|
|
85
|
+
|
|
86
|
+
# @!attribute gross_reward_amount
|
|
87
|
+
# Gross bounty-pool amount allocated per accepted submission, in whole currency
|
|
88
|
+
# units.
|
|
89
|
+
#
|
|
90
|
+
# @return [Float]
|
|
91
|
+
required :gross_reward_amount, Float
|
|
92
|
+
|
|
93
|
+
# @!attribute poster
|
|
94
|
+
# The user who posted the bounty.
|
|
95
|
+
#
|
|
96
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBounty::Poster]
|
|
97
|
+
required :poster, -> { WhopSDK::Workforce::WorkforceBounty::Poster }
|
|
98
|
+
|
|
99
|
+
# @!attribute scheduled_frequency
|
|
100
|
+
# How often the schedule creates a new bounty. Each occurrence is a separate
|
|
101
|
+
# bounty; the original is not republished.
|
|
102
|
+
#
|
|
103
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::ScheduledFrequency, nil]
|
|
104
|
+
required :scheduled_frequency,
|
|
105
|
+
enum: -> { WhopSDK::Workforce::WorkforceBounty::ScheduledFrequency },
|
|
106
|
+
nil?: true
|
|
107
|
+
|
|
108
|
+
# @!attribute scheduled_publish_at
|
|
109
|
+
# When a scheduled bounty will publish, as an ISO 8601 timestamp. Null once
|
|
110
|
+
# published, for bounties that were never scheduled, and for terminally failed
|
|
111
|
+
# drafts parked for manual rescheduling.
|
|
112
|
+
#
|
|
113
|
+
# @return [String, nil]
|
|
114
|
+
required :scheduled_publish_at, String, nil?: true
|
|
115
|
+
|
|
116
|
+
# @!attribute spots_remaining
|
|
117
|
+
# Unfilled winner capacity: `accepted_submissions_limit` minus
|
|
118
|
+
# `accepted_submissions_count`, clamped to zero. Not a signal that the bounty
|
|
119
|
+
# currently accepts new claims.
|
|
120
|
+
#
|
|
121
|
+
# @return [Integer]
|
|
122
|
+
required :spots_remaining, Integer
|
|
123
|
+
|
|
124
|
+
# @!attribute status
|
|
125
|
+
# Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their
|
|
126
|
+
# poster and the account's authorized managers; `open` bounties accept new
|
|
127
|
+
# submissions; `closed` bounties are live but no longer accept new submissions;
|
|
128
|
+
# `completed` bounties paid out every winner slot; `canceled` bounties ended
|
|
129
|
+
# before filling their slots.
|
|
130
|
+
#
|
|
131
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::Status]
|
|
132
|
+
required :status, enum: -> { WhopSDK::Workforce::WorkforceBounty::Status }
|
|
133
|
+
|
|
134
|
+
# @!attribute submissions_closed_at
|
|
135
|
+
# When new submissions were explicitly stopped, as an ISO 8601 timestamp. Null
|
|
136
|
+
# when submissions were never explicitly stopped — including closed or completed
|
|
137
|
+
# bounties that simply filled every winner slot.
|
|
138
|
+
#
|
|
139
|
+
# @return [String, nil]
|
|
140
|
+
required :submissions_closed_at, String, nil?: true
|
|
141
|
+
|
|
142
|
+
# @!attribute title
|
|
143
|
+
# Short name of the task shown to workers.
|
|
144
|
+
#
|
|
145
|
+
# @return [String]
|
|
146
|
+
required :title, String
|
|
147
|
+
|
|
148
|
+
# @!attribute unresolved_submissions_count
|
|
149
|
+
# Submissions still awaiting an outcome: in progress or pending review.
|
|
150
|
+
#
|
|
151
|
+
# @return [Integer]
|
|
152
|
+
required :unresolved_submissions_count, Integer
|
|
153
|
+
|
|
154
|
+
# @!attribute updated_at
|
|
155
|
+
# When the bounty was last updated, as an ISO 8601 timestamp.
|
|
156
|
+
#
|
|
157
|
+
# @return [String]
|
|
158
|
+
required :updated_at, String
|
|
159
|
+
|
|
160
|
+
# @!method initialize(id:, accepted_submissions_count:, accepted_submissions_limit:, allowed_country_codes:, budget_amount:, business_goal_type:, created_at:, currency:, description:, experience_id:, funding_account:, gross_paid_out_amount:, gross_reward_amount:, poster:, scheduled_frequency:, scheduled_publish_at:, spots_remaining:, status:, submissions_closed_at:, title:, unresolved_submissions_count:, updated_at:)
|
|
161
|
+
# Some parameter documentations has been truncated, see
|
|
162
|
+
# {WhopSDK::Models::Workforce::WorkforceBounty} for more details.
|
|
163
|
+
#
|
|
164
|
+
# @param id [String] Bounty ID, prefixed `bnty_`.
|
|
165
|
+
#
|
|
166
|
+
# @param accepted_submissions_count [Integer] Submissions accepted so far.
|
|
167
|
+
#
|
|
168
|
+
# @param accepted_submissions_limit [Integer] Number of submissions that can be accepted (winner slots).
|
|
169
|
+
#
|
|
170
|
+
# @param allowed_country_codes [Array<String>]
|
|
171
|
+
#
|
|
172
|
+
# @param budget_amount [Float] Total gross budget committed to the bounty: `gross_reward_amount` times `accepte
|
|
173
|
+
#
|
|
174
|
+
# @param business_goal_type [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::BusinessGoalType, nil] What the poster wants the work to achieve.
|
|
175
|
+
#
|
|
176
|
+
# @param created_at [String] When the bounty was created, as an ISO 8601 timestamp.
|
|
177
|
+
#
|
|
178
|
+
# @param currency [String] Currency for all amounts on the bounty, as a lowercase ISO 4217 code.
|
|
179
|
+
#
|
|
180
|
+
# @param description [String] Full task instructions shown to workers.
|
|
181
|
+
#
|
|
182
|
+
# @param experience_id [String, nil] Experience the bounty is hosted in, prefixed `exp_`. Null for platform-wide boun
|
|
183
|
+
#
|
|
184
|
+
# @param funding_account [WhopSDK::Models::Workforce::WorkforceBounty::FundingAccount, nil] The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
185
|
+
#
|
|
186
|
+
# @param gross_paid_out_amount [Float] Gross amount paid out from the bounty pool across accepted submissions — worker
|
|
187
|
+
#
|
|
188
|
+
# @param gross_reward_amount [Float] Gross bounty-pool amount allocated per accepted submission, in whole currency un
|
|
189
|
+
#
|
|
190
|
+
# @param poster [WhopSDK::Models::Workforce::WorkforceBounty::Poster] The user who posted the bounty.
|
|
191
|
+
#
|
|
192
|
+
# @param scheduled_frequency [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::ScheduledFrequency, nil] How often the schedule creates a new bounty. Each occurrence is a separate bount
|
|
193
|
+
#
|
|
194
|
+
# @param scheduled_publish_at [String, nil] When a scheduled bounty will publish, as an ISO 8601 timestamp. Null once publis
|
|
195
|
+
#
|
|
196
|
+
# @param spots_remaining [Integer] Unfilled winner capacity: `accepted_submissions_limit` minus `accepted_submissio
|
|
197
|
+
#
|
|
198
|
+
# @param status [Symbol, WhopSDK::Models::Workforce::WorkforceBounty::Status] Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their p
|
|
199
|
+
#
|
|
200
|
+
# @param submissions_closed_at [String, nil] When new submissions were explicitly stopped, as an ISO 8601 timestamp. Null whe
|
|
201
|
+
#
|
|
202
|
+
# @param title [String] Short name of the task shown to workers.
|
|
203
|
+
#
|
|
204
|
+
# @param unresolved_submissions_count [Integer] Submissions still awaiting an outcome: in progress or pending review.
|
|
205
|
+
#
|
|
206
|
+
# @param updated_at [String] When the bounty was last updated, as an ISO 8601 timestamp.
|
|
207
|
+
|
|
208
|
+
# What the poster wants the work to achieve.
|
|
209
|
+
#
|
|
210
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty#business_goal_type
|
|
211
|
+
module BusinessGoalType
|
|
212
|
+
extend WhopSDK::Internal::Type::Enum
|
|
213
|
+
|
|
214
|
+
CLIPPING = :clipping
|
|
215
|
+
POST_ENGAGEMENT = :post_engagement
|
|
216
|
+
OWNED_ACCOUNT_GROWTH = :owned_account_growth
|
|
217
|
+
UGC_CONTENT = :ugc_content
|
|
218
|
+
LOCAL_ACTIVATION = :local_activation
|
|
219
|
+
OTHER = :other
|
|
220
|
+
|
|
221
|
+
# @!method self.values
|
|
222
|
+
# @return [Array<Symbol>]
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty#funding_account
|
|
226
|
+
class FundingAccount < WhopSDK::Internal::Type::BaseModel
|
|
227
|
+
# @!attribute id
|
|
228
|
+
# Account ID, prefixed `biz_`.
|
|
229
|
+
#
|
|
230
|
+
# @return [String]
|
|
231
|
+
required :id, String
|
|
232
|
+
|
|
233
|
+
# @!attribute title
|
|
234
|
+
# Account display name.
|
|
235
|
+
#
|
|
236
|
+
# @return [String]
|
|
237
|
+
required :title, String
|
|
238
|
+
|
|
239
|
+
# @!method initialize(id:, title:)
|
|
240
|
+
# The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
241
|
+
# personally. May differ from the account hosting `experience_id`.
|
|
242
|
+
#
|
|
243
|
+
# @param id [String] Account ID, prefixed `biz_`.
|
|
244
|
+
#
|
|
245
|
+
# @param title [String] Account display name.
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty#poster
|
|
249
|
+
class Poster < WhopSDK::Internal::Type::BaseModel
|
|
250
|
+
# @!attribute id
|
|
251
|
+
# User ID, prefixed `user_`.
|
|
252
|
+
#
|
|
253
|
+
# @return [String]
|
|
254
|
+
required :id, String
|
|
255
|
+
|
|
256
|
+
# @!attribute name
|
|
257
|
+
# Display name.
|
|
258
|
+
#
|
|
259
|
+
# @return [String, nil]
|
|
260
|
+
required :name, String, nil?: true
|
|
261
|
+
|
|
262
|
+
# @!attribute profile_picture
|
|
263
|
+
# Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
264
|
+
# the user set no picture.
|
|
265
|
+
#
|
|
266
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBounty::Poster::ProfilePicture]
|
|
267
|
+
required :profile_picture, -> { WhopSDK::Workforce::WorkforceBounty::Poster::ProfilePicture }
|
|
268
|
+
|
|
269
|
+
# @!attribute username
|
|
270
|
+
# Public username.
|
|
271
|
+
#
|
|
272
|
+
# @return [String]
|
|
273
|
+
required :username, String
|
|
274
|
+
|
|
275
|
+
# @!method initialize(id:, name:, profile_picture:, username:)
|
|
276
|
+
# Some parameter documentations has been truncated, see
|
|
277
|
+
# {WhopSDK::Models::Workforce::WorkforceBounty::Poster} for more details.
|
|
278
|
+
#
|
|
279
|
+
# The user who posted the bounty.
|
|
280
|
+
#
|
|
281
|
+
# @param id [String] User ID, prefixed `user_`.
|
|
282
|
+
#
|
|
283
|
+
# @param name [String, nil] Display name.
|
|
284
|
+
#
|
|
285
|
+
# @param profile_picture [WhopSDK::Models::Workforce::WorkforceBounty::Poster::ProfilePicture] Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
286
|
+
#
|
|
287
|
+
# @param username [String] Public username.
|
|
288
|
+
|
|
289
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty::Poster#profile_picture
|
|
290
|
+
class ProfilePicture < WhopSDK::Internal::Type::BaseModel
|
|
291
|
+
# @!attribute url
|
|
292
|
+
# Avatar image URL. Always present — a generated placeholder when the user set no
|
|
293
|
+
# picture.
|
|
294
|
+
#
|
|
295
|
+
# @return [String]
|
|
296
|
+
required :url, String
|
|
297
|
+
|
|
298
|
+
# @!method initialize(url:)
|
|
299
|
+
# Some parameter documentations has been truncated, see
|
|
300
|
+
# {WhopSDK::Models::Workforce::WorkforceBounty::Poster::ProfilePicture} for more
|
|
301
|
+
# details.
|
|
302
|
+
#
|
|
303
|
+
# Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
304
|
+
# the user set no picture.
|
|
305
|
+
#
|
|
306
|
+
# @param url [String] Avatar image URL. Always present — a generated placeholder when the user set no
|
|
307
|
+
end
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
# How often the schedule creates a new bounty. Each occurrence is a separate
|
|
311
|
+
# bounty; the original is not republished.
|
|
312
|
+
#
|
|
313
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty#scheduled_frequency
|
|
314
|
+
module ScheduledFrequency
|
|
315
|
+
extend WhopSDK::Internal::Type::Enum
|
|
316
|
+
|
|
317
|
+
ONCE = :once
|
|
318
|
+
HOURLY = :hourly
|
|
319
|
+
DAILY = :daily
|
|
320
|
+
WEEKLY = :weekly
|
|
321
|
+
MONTHLY = :monthly
|
|
322
|
+
|
|
323
|
+
# @!method self.values
|
|
324
|
+
# @return [Array<Symbol>]
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their
|
|
328
|
+
# poster and the account's authorized managers; `open` bounties accept new
|
|
329
|
+
# submissions; `closed` bounties are live but no longer accept new submissions;
|
|
330
|
+
# `completed` bounties paid out every winner slot; `canceled` bounties ended
|
|
331
|
+
# before filling their slots.
|
|
332
|
+
#
|
|
333
|
+
# @see WhopSDK::Models::Workforce::WorkforceBounty#status
|
|
334
|
+
module Status
|
|
335
|
+
extend WhopSDK::Internal::Type::Enum
|
|
336
|
+
|
|
337
|
+
SCHEDULED = :scheduled
|
|
338
|
+
OPEN = :open
|
|
339
|
+
CLOSED = :closed
|
|
340
|
+
COMPLETED = :completed
|
|
341
|
+
CANCELED = :canceled
|
|
342
|
+
|
|
343
|
+
# @!method self.values
|
|
344
|
+
# @return [Array<Symbol>]
|
|
345
|
+
end
|
|
346
|
+
end
|
|
347
|
+
end
|
|
348
|
+
|
|
349
|
+
WorkforceBounty = Workforce::WorkforceBounty
|
|
350
|
+
end
|
|
351
|
+
end
|
|
@@ -0,0 +1,347 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
module Workforce
|
|
6
|
+
# @see WhopSDK::Resources::Workforce::Bounties#list
|
|
7
|
+
class WorkforceBountyListItem < WhopSDK::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute id
|
|
9
|
+
# Bounty ID, prefixed `bnty_`.
|
|
10
|
+
#
|
|
11
|
+
# @return [String]
|
|
12
|
+
required :id, String
|
|
13
|
+
|
|
14
|
+
# @!attribute accepted_submissions_count
|
|
15
|
+
# Submissions accepted so far.
|
|
16
|
+
#
|
|
17
|
+
# @return [Integer]
|
|
18
|
+
required :accepted_submissions_count, Integer
|
|
19
|
+
|
|
20
|
+
# @!attribute accepted_submissions_limit
|
|
21
|
+
# Number of submissions that can be accepted (winner slots).
|
|
22
|
+
#
|
|
23
|
+
# @return [Integer]
|
|
24
|
+
required :accepted_submissions_limit, Integer
|
|
25
|
+
|
|
26
|
+
# @!attribute allowed_country_codes
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<String>]
|
|
29
|
+
required :allowed_country_codes, WhopSDK::Internal::Type::ArrayOf[String]
|
|
30
|
+
|
|
31
|
+
# @!attribute budget_amount
|
|
32
|
+
# Total gross budget committed to the bounty: `gross_reward_amount` times
|
|
33
|
+
# `accepted_submissions_limit`.
|
|
34
|
+
#
|
|
35
|
+
# @return [Float]
|
|
36
|
+
required :budget_amount, Float
|
|
37
|
+
|
|
38
|
+
# @!attribute business_goal_type
|
|
39
|
+
# What the poster wants the work to achieve.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::BusinessGoalType, nil]
|
|
42
|
+
required :business_goal_type,
|
|
43
|
+
enum: -> { WhopSDK::Workforce::WorkforceBountyListItem::BusinessGoalType },
|
|
44
|
+
nil?: true
|
|
45
|
+
|
|
46
|
+
# @!attribute created_at
|
|
47
|
+
# When the bounty was created, as an ISO 8601 timestamp.
|
|
48
|
+
#
|
|
49
|
+
# @return [String]
|
|
50
|
+
required :created_at, String
|
|
51
|
+
|
|
52
|
+
# @!attribute currency
|
|
53
|
+
# Currency for all amounts on the bounty, as a lowercase ISO 4217 code.
|
|
54
|
+
#
|
|
55
|
+
# @return [String]
|
|
56
|
+
required :currency, String
|
|
57
|
+
|
|
58
|
+
# @!attribute experience_id
|
|
59
|
+
# Experience the bounty is hosted in, prefixed `exp_`. Null for platform-wide
|
|
60
|
+
# bounties; may belong to a different account than the funder.
|
|
61
|
+
#
|
|
62
|
+
# @return [String, nil]
|
|
63
|
+
required :experience_id, String, nil?: true
|
|
64
|
+
|
|
65
|
+
# @!attribute funding_account
|
|
66
|
+
# The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
67
|
+
# personally. May differ from the account hosting `experience_id`.
|
|
68
|
+
#
|
|
69
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBountyListItem::FundingAccount, nil]
|
|
70
|
+
required :funding_account,
|
|
71
|
+
-> {
|
|
72
|
+
WhopSDK::Workforce::WorkforceBountyListItem::FundingAccount
|
|
73
|
+
},
|
|
74
|
+
nil?: true
|
|
75
|
+
|
|
76
|
+
# @!attribute gross_paid_out_amount
|
|
77
|
+
# Gross amount paid out from the bounty pool across accepted submissions — worker
|
|
78
|
+
# payouts, platform fees, and affiliate shares together. Tips and reviewer rewards
|
|
79
|
+
# are excluded.
|
|
80
|
+
#
|
|
81
|
+
# @return [Float]
|
|
82
|
+
required :gross_paid_out_amount, Float
|
|
83
|
+
|
|
84
|
+
# @!attribute gross_reward_amount
|
|
85
|
+
# Gross bounty-pool amount allocated per accepted submission, in whole currency
|
|
86
|
+
# units.
|
|
87
|
+
#
|
|
88
|
+
# @return [Float]
|
|
89
|
+
required :gross_reward_amount, Float
|
|
90
|
+
|
|
91
|
+
# @!attribute poster
|
|
92
|
+
# The user who posted the bounty.
|
|
93
|
+
#
|
|
94
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster]
|
|
95
|
+
required :poster, -> { WhopSDK::Workforce::WorkforceBountyListItem::Poster }
|
|
96
|
+
|
|
97
|
+
# @!attribute scheduled_frequency
|
|
98
|
+
# How often the schedule creates a new bounty. Each occurrence is a separate
|
|
99
|
+
# bounty; the original is not republished.
|
|
100
|
+
#
|
|
101
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::ScheduledFrequency, nil]
|
|
102
|
+
required :scheduled_frequency,
|
|
103
|
+
enum: -> { WhopSDK::Workforce::WorkforceBountyListItem::ScheduledFrequency },
|
|
104
|
+
nil?: true
|
|
105
|
+
|
|
106
|
+
# @!attribute scheduled_publish_at
|
|
107
|
+
# When a scheduled bounty will publish, as an ISO 8601 timestamp. Null once
|
|
108
|
+
# published, for bounties that were never scheduled, and for terminally failed
|
|
109
|
+
# drafts parked for manual rescheduling.
|
|
110
|
+
#
|
|
111
|
+
# @return [String, nil]
|
|
112
|
+
required :scheduled_publish_at, String, nil?: true
|
|
113
|
+
|
|
114
|
+
# @!attribute spots_remaining
|
|
115
|
+
# Unfilled winner capacity: `accepted_submissions_limit` minus
|
|
116
|
+
# `accepted_submissions_count`, clamped to zero. Not a signal that the bounty
|
|
117
|
+
# currently accepts new claims.
|
|
118
|
+
#
|
|
119
|
+
# @return [Integer]
|
|
120
|
+
required :spots_remaining, Integer
|
|
121
|
+
|
|
122
|
+
# @!attribute status
|
|
123
|
+
# Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their
|
|
124
|
+
# poster and the account's authorized managers; `open` bounties accept new
|
|
125
|
+
# submissions; `closed` bounties are live but no longer accept new submissions;
|
|
126
|
+
# `completed` bounties paid out every winner slot; `canceled` bounties ended
|
|
127
|
+
# before filling their slots.
|
|
128
|
+
#
|
|
129
|
+
# @return [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::Status]
|
|
130
|
+
required :status, enum: -> { WhopSDK::Workforce::WorkforceBountyListItem::Status }
|
|
131
|
+
|
|
132
|
+
# @!attribute submissions_closed_at
|
|
133
|
+
# When new submissions were explicitly stopped, as an ISO 8601 timestamp. Null
|
|
134
|
+
# when submissions were never explicitly stopped — including closed or completed
|
|
135
|
+
# bounties that simply filled every winner slot.
|
|
136
|
+
#
|
|
137
|
+
# @return [String, nil]
|
|
138
|
+
required :submissions_closed_at, String, nil?: true
|
|
139
|
+
|
|
140
|
+
# @!attribute title
|
|
141
|
+
# Short name of the task shown to workers.
|
|
142
|
+
#
|
|
143
|
+
# @return [String]
|
|
144
|
+
required :title, String
|
|
145
|
+
|
|
146
|
+
# @!attribute unresolved_submissions_count
|
|
147
|
+
# Submissions still awaiting an outcome: in progress or pending review.
|
|
148
|
+
#
|
|
149
|
+
# @return [Integer]
|
|
150
|
+
required :unresolved_submissions_count, Integer
|
|
151
|
+
|
|
152
|
+
# @!attribute updated_at
|
|
153
|
+
# When the bounty was last updated, as an ISO 8601 timestamp.
|
|
154
|
+
#
|
|
155
|
+
# @return [String]
|
|
156
|
+
required :updated_at, String
|
|
157
|
+
|
|
158
|
+
# @!method initialize(id:, accepted_submissions_count:, accepted_submissions_limit:, allowed_country_codes:, budget_amount:, business_goal_type:, created_at:, currency:, experience_id:, funding_account:, gross_paid_out_amount:, gross_reward_amount:, poster:, scheduled_frequency:, scheduled_publish_at:, spots_remaining:, status:, submissions_closed_at:, title:, unresolved_submissions_count:, updated_at:)
|
|
159
|
+
# Some parameter documentations has been truncated, see
|
|
160
|
+
# {WhopSDK::Models::Workforce::WorkforceBountyListItem} for more details.
|
|
161
|
+
#
|
|
162
|
+
# @param id [String] Bounty ID, prefixed `bnty_`.
|
|
163
|
+
#
|
|
164
|
+
# @param accepted_submissions_count [Integer] Submissions accepted so far.
|
|
165
|
+
#
|
|
166
|
+
# @param accepted_submissions_limit [Integer] Number of submissions that can be accepted (winner slots).
|
|
167
|
+
#
|
|
168
|
+
# @param allowed_country_codes [Array<String>]
|
|
169
|
+
#
|
|
170
|
+
# @param budget_amount [Float] Total gross budget committed to the bounty: `gross_reward_amount` times `accepte
|
|
171
|
+
#
|
|
172
|
+
# @param business_goal_type [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::BusinessGoalType, nil] What the poster wants the work to achieve.
|
|
173
|
+
#
|
|
174
|
+
# @param created_at [String] When the bounty was created, as an ISO 8601 timestamp.
|
|
175
|
+
#
|
|
176
|
+
# @param currency [String] Currency for all amounts on the bounty, as a lowercase ISO 4217 code.
|
|
177
|
+
#
|
|
178
|
+
# @param experience_id [String, nil] Experience the bounty is hosted in, prefixed `exp_`. Null for platform-wide boun
|
|
179
|
+
#
|
|
180
|
+
# @param funding_account [WhopSDK::Models::Workforce::WorkforceBountyListItem::FundingAccount, nil] The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
181
|
+
#
|
|
182
|
+
# @param gross_paid_out_amount [Float] Gross amount paid out from the bounty pool across accepted submissions — worker
|
|
183
|
+
#
|
|
184
|
+
# @param gross_reward_amount [Float] Gross bounty-pool amount allocated per accepted submission, in whole currency un
|
|
185
|
+
#
|
|
186
|
+
# @param poster [WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster] The user who posted the bounty.
|
|
187
|
+
#
|
|
188
|
+
# @param scheduled_frequency [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::ScheduledFrequency, nil] How often the schedule creates a new bounty. Each occurrence is a separate bount
|
|
189
|
+
#
|
|
190
|
+
# @param scheduled_publish_at [String, nil] When a scheduled bounty will publish, as an ISO 8601 timestamp. Null once publis
|
|
191
|
+
#
|
|
192
|
+
# @param spots_remaining [Integer] Unfilled winner capacity: `accepted_submissions_limit` minus `accepted_submissio
|
|
193
|
+
#
|
|
194
|
+
# @param status [Symbol, WhopSDK::Models::Workforce::WorkforceBountyListItem::Status] Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their p
|
|
195
|
+
#
|
|
196
|
+
# @param submissions_closed_at [String, nil] When new submissions were explicitly stopped, as an ISO 8601 timestamp. Null whe
|
|
197
|
+
#
|
|
198
|
+
# @param title [String] Short name of the task shown to workers.
|
|
199
|
+
#
|
|
200
|
+
# @param unresolved_submissions_count [Integer] Submissions still awaiting an outcome: in progress or pending review.
|
|
201
|
+
#
|
|
202
|
+
# @param updated_at [String] When the bounty was last updated, as an ISO 8601 timestamp.
|
|
203
|
+
|
|
204
|
+
# What the poster wants the work to achieve.
|
|
205
|
+
#
|
|
206
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem#business_goal_type
|
|
207
|
+
module BusinessGoalType
|
|
208
|
+
extend WhopSDK::Internal::Type::Enum
|
|
209
|
+
|
|
210
|
+
CLIPPING = :clipping
|
|
211
|
+
POST_ENGAGEMENT = :post_engagement
|
|
212
|
+
OWNED_ACCOUNT_GROWTH = :owned_account_growth
|
|
213
|
+
UGC_CONTENT = :ugc_content
|
|
214
|
+
LOCAL_ACTIVATION = :local_activation
|
|
215
|
+
OTHER = :other
|
|
216
|
+
|
|
217
|
+
# @!method self.values
|
|
218
|
+
# @return [Array<Symbol>]
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem#funding_account
|
|
222
|
+
class FundingAccount < WhopSDK::Internal::Type::BaseModel
|
|
223
|
+
# @!attribute id
|
|
224
|
+
# Account ID, prefixed `biz_`.
|
|
225
|
+
#
|
|
226
|
+
# @return [String]
|
|
227
|
+
required :id, String
|
|
228
|
+
|
|
229
|
+
# @!attribute title
|
|
230
|
+
# Account display name.
|
|
231
|
+
#
|
|
232
|
+
# @return [String]
|
|
233
|
+
required :title, String
|
|
234
|
+
|
|
235
|
+
# @!method initialize(id:, title:)
|
|
236
|
+
# The account whose balance funds the bounty pool, or `null` when a user funds it
|
|
237
|
+
# personally. May differ from the account hosting `experience_id`.
|
|
238
|
+
#
|
|
239
|
+
# @param id [String] Account ID, prefixed `biz_`.
|
|
240
|
+
#
|
|
241
|
+
# @param title [String] Account display name.
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem#poster
|
|
245
|
+
class Poster < WhopSDK::Internal::Type::BaseModel
|
|
246
|
+
# @!attribute id
|
|
247
|
+
# User ID, prefixed `user_`.
|
|
248
|
+
#
|
|
249
|
+
# @return [String]
|
|
250
|
+
required :id, String
|
|
251
|
+
|
|
252
|
+
# @!attribute name
|
|
253
|
+
# Display name.
|
|
254
|
+
#
|
|
255
|
+
# @return [String, nil]
|
|
256
|
+
required :name, String, nil?: true
|
|
257
|
+
|
|
258
|
+
# @!attribute profile_picture
|
|
259
|
+
# Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
260
|
+
# the user set no picture.
|
|
261
|
+
#
|
|
262
|
+
# @return [WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster::ProfilePicture]
|
|
263
|
+
required :profile_picture, -> { WhopSDK::Workforce::WorkforceBountyListItem::Poster::ProfilePicture }
|
|
264
|
+
|
|
265
|
+
# @!attribute username
|
|
266
|
+
# Public username.
|
|
267
|
+
#
|
|
268
|
+
# @return [String]
|
|
269
|
+
required :username, String
|
|
270
|
+
|
|
271
|
+
# @!method initialize(id:, name:, profile_picture:, username:)
|
|
272
|
+
# Some parameter documentations has been truncated, see
|
|
273
|
+
# {WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster} for more details.
|
|
274
|
+
#
|
|
275
|
+
# The user who posted the bounty.
|
|
276
|
+
#
|
|
277
|
+
# @param id [String] User ID, prefixed `user_`.
|
|
278
|
+
#
|
|
279
|
+
# @param name [String, nil] Display name.
|
|
280
|
+
#
|
|
281
|
+
# @param profile_picture [WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster::ProfilePicture] Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
282
|
+
#
|
|
283
|
+
# @param username [String] Public username.
|
|
284
|
+
|
|
285
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster#profile_picture
|
|
286
|
+
class ProfilePicture < WhopSDK::Internal::Type::BaseModel
|
|
287
|
+
# @!attribute url
|
|
288
|
+
# Avatar image URL. Always present — a generated placeholder when the user set no
|
|
289
|
+
# picture.
|
|
290
|
+
#
|
|
291
|
+
# @return [String]
|
|
292
|
+
required :url, String
|
|
293
|
+
|
|
294
|
+
# @!method initialize(url:)
|
|
295
|
+
# Some parameter documentations has been truncated, see
|
|
296
|
+
# {WhopSDK::Models::Workforce::WorkforceBountyListItem::Poster::ProfilePicture}
|
|
297
|
+
# for more details.
|
|
298
|
+
#
|
|
299
|
+
# Avatar wrapper; its `url` is always present, using a generated placeholder when
|
|
300
|
+
# the user set no picture.
|
|
301
|
+
#
|
|
302
|
+
# @param url [String] Avatar image URL. Always present — a generated placeholder when the user set no
|
|
303
|
+
end
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
# How often the schedule creates a new bounty. Each occurrence is a separate
|
|
307
|
+
# bounty; the original is not republished.
|
|
308
|
+
#
|
|
309
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem#scheduled_frequency
|
|
310
|
+
module ScheduledFrequency
|
|
311
|
+
extend WhopSDK::Internal::Type::Enum
|
|
312
|
+
|
|
313
|
+
ONCE = :once
|
|
314
|
+
HOURLY = :hourly
|
|
315
|
+
DAILY = :daily
|
|
316
|
+
WEEKLY = :weekly
|
|
317
|
+
MONTHLY = :monthly
|
|
318
|
+
|
|
319
|
+
# @!method self.values
|
|
320
|
+
# @return [Array<Symbol>]
|
|
321
|
+
end
|
|
322
|
+
|
|
323
|
+
# Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their
|
|
324
|
+
# poster and the account's authorized managers; `open` bounties accept new
|
|
325
|
+
# submissions; `closed` bounties are live but no longer accept new submissions;
|
|
326
|
+
# `completed` bounties paid out every winner slot; `canceled` bounties ended
|
|
327
|
+
# before filling their slots.
|
|
328
|
+
#
|
|
329
|
+
# @see WhopSDK::Models::Workforce::WorkforceBountyListItem#status
|
|
330
|
+
module Status
|
|
331
|
+
extend WhopSDK::Internal::Type::Enum
|
|
332
|
+
|
|
333
|
+
SCHEDULED = :scheduled
|
|
334
|
+
OPEN = :open
|
|
335
|
+
CLOSED = :closed
|
|
336
|
+
COMPLETED = :completed
|
|
337
|
+
CANCELED = :canceled
|
|
338
|
+
|
|
339
|
+
# @!method self.values
|
|
340
|
+
# @return [Array<Symbol>]
|
|
341
|
+
end
|
|
342
|
+
end
|
|
343
|
+
end
|
|
344
|
+
|
|
345
|
+
WorkforceBountyListItem = Workforce::WorkforceBountyListItem
|
|
346
|
+
end
|
|
347
|
+
end
|