whop_sdk 2.4.0 → 2.5.0
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/.fern/metadata.json +3 -3
- data/.fern/replay.lock +313 -1
- data/lib/whop_sdk/access_tokens/client.rb +2 -3
- data/lib/whop_sdk/account_links/client.rb +2 -2
- data/lib/whop_sdk/accounts/client.rb +8 -19
- data/lib/whop_sdk/accounts/fees/client.rb +5 -6
- data/lib/whop_sdk/accounts/financing_applications/client.rb +18 -24
- data/lib/whop_sdk/accounts/financing_applications/types/update_financing_applications_request_answers_item_money.rb +1 -0
- data/lib/whop_sdk/accounts/preferences/client.rb +1 -0
- data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response.rb +2 -0
- data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response_feedback_options_item.rb +17 -0
- data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response_feedback_options_item_category.rb +21 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_request.rb +2 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_request_feedback_options_item.rb +17 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_request_feedback_options_item_category.rb +21 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_response.rb +2 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_response_feedback_options_item.rb +17 -0
- data/lib/whop_sdk/accounts/preferences/types/update_preferences_response_feedback_options_item_category.rb +21 -0
- data/lib/whop_sdk/accounts/types/form_company_accounts_request.rb +0 -6
- data/lib/whop_sdk/accounts/types/post_account_financing_disabled_payload.rb +25 -0
- data/lib/whop_sdk/{partners/types/referred_users_partners_request_user_id.rb → accounts/types/post_account_financing_disabled_payload_api_version.rb} +3 -3
- data/lib/whop_sdk/accounts/types/post_account_financing_disabled_payload_type.rb +13 -0
- data/lib/whop_sdk/accounts/types/transfer_ownership_accounts_request.rb +2 -0
- data/lib/whop_sdk/accounts/types/update_accounts_request.rb +2 -6
- data/lib/whop_sdk/ad_campaigns/client.rb +4 -4
- data/lib/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_delivery_status.rb +1 -0
- data/lib/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_delivery_status.rb +1 -0
- data/lib/whop_sdk/ad_conversion_value_rules/client.rb +11 -9
- data/lib/whop_sdk/ad_groups/client.rb +7 -11
- data/lib/whop_sdk/ads/client.rb +1 -2
- data/lib/whop_sdk/affiliates/client.rb +5 -5
- data/lib/whop_sdk/api_keys/client.rb +2 -2
- data/lib/whop_sdk/api_keys/types/create_api_keys_request_api_version_date.rb +2 -0
- data/lib/whop_sdk/api_keys/types/update_api_keys_request_api_version_date.rb +2 -0
- data/lib/whop_sdk/app_builds/client.rb +2 -2
- data/lib/whop_sdk/app_builds/types/create_app_builds_request_attachment.rb +2 -1
- data/lib/whop_sdk/apps/client.rb +2 -4
- data/lib/whop_sdk/audiences/client.rb +5 -5
- data/lib/whop_sdk/authorized_users/client.rb +3 -4
- data/lib/whop_sdk/bounty_submissions/client.rb +7 -10
- data/lib/whop_sdk/bounty_submissions/types/submit_bounty_submissions_request_deliverable.rb +3 -1
- data/lib/whop_sdk/card_transactions/client.rb +5 -6
- data/lib/whop_sdk/cards/client.rb +4 -4
- data/lib/whop_sdk/cashback_rules/client.rb +16 -20
- data/lib/whop_sdk/chat_channels/client.rb +2 -2
- data/lib/whop_sdk/checkout_configurations/client.rb +2 -1
- data/lib/whop_sdk/claim_links/client.rb +8 -8
- data/lib/whop_sdk/client.rb +1 -1
- data/lib/whop_sdk/company_token_transactions/client.rb +3 -4
- data/lib/whop_sdk/confirmation_tokens/client.rb +3 -3
- data/lib/whop_sdk/course_lesson_interactions/client.rb +2 -1
- data/lib/whop_sdk/courses/client.rb +4 -2
- data/lib/whop_sdk/deposits/client.rb +3 -2
- data/lib/whop_sdk/disputes/client.rb +5 -12
- data/lib/whop_sdk/dm_channels/client.rb +5 -6
- data/lib/whop_sdk/domains/client.rb +4 -0
- data/lib/whop_sdk/domains/types/create_domains_request.rb +4 -0
- data/lib/whop_sdk/domains/types/create_domains_request_apple_pay.rb +13 -0
- data/lib/whop_sdk/domains/types/create_domains_request_pixel.rb +12 -0
- data/lib/whop_sdk/domains/types/list_domains_request.rb +4 -0
- data/lib/whop_sdk/domains/types/list_domains_request_apple_pay.rb +17 -0
- data/lib/whop_sdk/domains/types/list_domains_request_order.rb +2 -0
- data/lib/whop_sdk/domains/types/list_domains_request_pixel.rb +17 -0
- data/lib/whop_sdk/domains/types/update_domains_request.rb +4 -0
- data/lib/whop_sdk/domains/types/update_domains_request_apple_pay.rb +13 -0
- data/lib/whop_sdk/domains/types/update_domains_request_pixel.rb +12 -0
- data/lib/whop_sdk/economic_intelligence/client.rb +6 -8
- data/lib/whop_sdk/events/client.rb +12 -16
- data/lib/whop_sdk/experiences/client.rb +15 -9
- data/lib/whop_sdk/experiments/client.rb +16 -29
- data/lib/whop_sdk/exports/client.rb +1 -1
- data/lib/whop_sdk/external_accounts/client.rb +3 -5
- data/lib/whop_sdk/fee_markups/client.rb +5 -6
- data/lib/whop_sdk/feedback_submissions/client.rb +0 -1
- data/lib/whop_sdk/files/client.rb +2 -2
- data/lib/whop_sdk/financial_reports/breakdown/client.rb +3 -1
- data/lib/whop_sdk/forum_posts/client.rb +1 -1
- data/lib/whop_sdk/forums/client.rb +1 -1
- data/lib/whop_sdk/identity_profiles/client.rb +4 -4
- data/lib/whop_sdk/internal/http/raw_client.rb +1 -1
- data/lib/whop_sdk/invoices/client.rb +1 -1
- data/lib/whop_sdk/leads/client.rb +3 -3
- data/lib/whop_sdk/members/client.rb +21 -1
- data/lib/whop_sdk/members/logs/client.rb +1 -1
- data/lib/whop_sdk/members/notes/client.rb +121 -0
- data/lib/whop_sdk/members/notes/types/create_notes_request.rb +15 -0
- data/lib/whop_sdk/members/notes/types/list_notes_request.rb +21 -0
- data/lib/whop_sdk/members/notes/types/list_notes_response.rb +15 -0
- data/lib/whop_sdk/members/notes/types/list_notes_response_page_info.rb +19 -0
- data/lib/whop_sdk/members/types/list_members_request.rb +10 -0
- data/lib/whop_sdk/members/types/list_members_request_membership_status.rb +14 -0
- data/lib/whop_sdk/members/types/list_members_request_most_recent_actions_item.rb +25 -0
- data/lib/whop_sdk/members/types/list_members_request_order.rb +1 -0
- data/lib/whop_sdk/memberships/client.rb +30 -28
- data/lib/whop_sdk/memberships/types/cancel_memberships_request.rb +2 -0
- data/lib/whop_sdk/memberships/types/list_memberships_request.rb +10 -0
- data/lib/whop_sdk/memberships/types/list_memberships_request_status.rb +4 -0
- data/lib/whop_sdk/memberships/types/list_memberships_request_statuses_item.rb +24 -0
- data/lib/whop_sdk/messages/client.rb +5 -7
- data/lib/whop_sdk/notifications/client.rb +6 -9
- data/lib/whop_sdk/partner_referral_requests/client.rb +3 -3
- data/lib/whop_sdk/partners/businesses/client.rb +99 -0
- data/lib/whop_sdk/partners/businesses/earnings/types/list_earnings_request_income_source_item.rb +1 -0
- data/lib/whop_sdk/partners/businesses/earnings/types/list_earnings_response_data_item_income_source.rb +1 -0
- data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_request.rb +21 -0
- data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_request_acknowledgments_item.rb +17 -0
- data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_response.rb +15 -0
- data/lib/whop_sdk/partners/businesses/types/list_businesses_request.rb +2 -0
- data/lib/whop_sdk/partners/businesses/types/list_businesses_request_advance_status.rb +22 -0
- data/lib/whop_sdk/partners/businesses/types/list_businesses_response_data_item.rb +2 -0
- data/lib/whop_sdk/partners/businesses/types/retrieve_businesses_response.rb +2 -0
- data/lib/whop_sdk/partners/businesses/types/update_businesses_request.rb +17 -0
- data/lib/whop_sdk/partners/businesses/types/update_businesses_response.rb +15 -0
- data/lib/whop_sdk/partners/client.rb +6 -11
- data/lib/whop_sdk/partners/types/referred_users_partners_request.rb +0 -2
- data/lib/whop_sdk/payment_method_domains/client.rb +4 -5
- data/lib/whop_sdk/payment_methods/client.rb +4 -5
- data/lib/whop_sdk/payment_quotes/client.rb +8 -10
- data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request.rb +2 -2
- data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request_line_items_item.rb +13 -0
- data/lib/whop_sdk/payment_rules/client.rb +19 -8
- data/lib/whop_sdk/payments/client.rb +26 -24
- data/lib/whop_sdk/payments/direct/client.rb +5 -6
- data/lib/whop_sdk/payments/direct/types/create_direct_request.rb +2 -2
- data/lib/whop_sdk/payments/direct/types/create_direct_request_line_items_item.rb +15 -0
- data/lib/whop_sdk/payments/types/create_payments_request.rb +2 -2
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item.rb +13 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan.rb +46 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_currency.rb +102 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_override_tax_type.rb +15 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_plan_type.rb +14 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product.rb +34 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product_global_affiliate_status.rb +14 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product_visibility.rb +16 -0
- data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_visibility.rb +16 -0
- data/lib/whop_sdk/payments/types/resume_payments_request.rb +2 -0
- data/lib/whop_sdk/payout_methods/client.rb +1 -1
- data/lib/whop_sdk/payouts/client.rb +15 -12
- data/lib/whop_sdk/payouts/methods/client.rb +2 -2
- data/lib/whop_sdk/payouts/methods/types/create_methods_request.rb +2 -0
- data/lib/whop_sdk/payouts/methods/types/list_methods_response_limits_standard_error_code.rb +1 -1
- data/lib/whop_sdk/payouts/paypal_link_sessions/client.rb +67 -0
- data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_request.rb +21 -0
- data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_response.rb +15 -0
- data/lib/whop_sdk/payouts/supported_methods/client.rb +2 -1
- data/lib/whop_sdk/payouts/supported_methods/types/list_supported_methods_response_data_item.rb +2 -0
- data/lib/whop_sdk/people/client.rb +3 -5
- data/lib/whop_sdk/plans/client.rb +1 -1
- data/lib/whop_sdk/products/client.rb +2 -2
- data/lib/whop_sdk/promo_codes/client.rb +1 -1
- data/lib/whop_sdk/refunds/client.rb +1 -2
- data/lib/whop_sdk/reviews/client.rb +59 -19
- data/lib/whop_sdk/reviews/types/delete_reviews_request.rb +11 -0
- data/lib/whop_sdk/reviews/types/delete_reviews_response.rb +13 -0
- data/lib/whop_sdk/reviews/types/list_reviews_request.rb +14 -8
- data/lib/whop_sdk/reviews/types/list_reviews_request_direction.rb +14 -0
- data/lib/whop_sdk/reviews/types/list_reviews_request_order.rb +14 -0
- data/lib/whop_sdk/reviews/types/list_reviews_response.rb +1 -2
- data/lib/whop_sdk/reviews/types/list_reviews_response_page_info.rb +17 -0
- data/lib/whop_sdk/setup_intents/client.rb +8 -10
- data/lib/whop_sdk/setup_intents/direct/client.rb +6 -7
- data/lib/whop_sdk/shipments/client.rb +2 -2
- data/lib/whop_sdk/stats/client.rb +2 -3
- data/lib/whop_sdk/stats/reports/client.rb +6 -10
- data/lib/whop_sdk/stats/time_series/client.rb +3 -8
- data/lib/whop_sdk/support_channels/client.rb +12 -4
- data/lib/whop_sdk/support_channels/types/list_support_channels_request.rb +8 -0
- data/lib/whop_sdk/swaps/client.rb +6 -6
- data/lib/whop_sdk/team_members/client.rb +7 -10
- data/lib/whop_sdk/topups/client.rb +2 -2
- data/lib/whop_sdk/trades/client.rb +6 -8
- data/lib/whop_sdk/trades/types/create_trades_request.rb +21 -1
- data/lib/whop_sdk/trades/types/create_trades_request_instrument_type.rb +14 -0
- data/lib/whop_sdk/trades/types/create_trades_request_order_type.rb +14 -0
- data/lib/whop_sdk/trades/types/create_trades_request_side.rb +14 -0
- data/lib/whop_sdk/trades/types/create_trades_request_type.rb +3 -1
- data/lib/whop_sdk/trades/types/list_trades_request_type.rb +3 -1
- data/lib/whop_sdk/transfers/client.rb +6 -3
- data/lib/whop_sdk/types/account.rb +2 -2
- data/lib/whop_sdk/types/account_level.rb +19 -0
- data/lib/whop_sdk/types/account_payment_controls_restricted_payment_methods_item.rb +39 -0
- data/lib/whop_sdk/types/account_preferences.rb +2 -0
- data/lib/whop_sdk/types/ad_campaign_delivery_status.rb +1 -0
- data/lib/whop_sdk/types/api_key_api_version_date.rb +2 -0
- data/lib/whop_sdk/types/cancel_options.rb +1 -0
- data/lib/whop_sdk/types/dispute_evidence_document.rb +12 -0
- data/lib/whop_sdk/types/domain.rb +6 -0
- data/lib/whop_sdk/types/domain_apple_pay.rb +9 -0
- data/lib/whop_sdk/types/domain_apple_pay_state.rb +14 -0
- data/lib/whop_sdk/types/domain_issue.rb +2 -0
- data/lib/whop_sdk/types/domain_issue_capability.rb +2 -0
- data/lib/whop_sdk/types/domain_issue_code.rb +6 -2
- data/lib/whop_sdk/types/domain_list_item.rb +6 -0
- data/lib/whop_sdk/types/domain_pixel.rb +9 -0
- data/lib/whop_sdk/types/domain_pixel_state.rb +13 -0
- data/lib/whop_sdk/types/domain_stats.rb +9 -0
- data/lib/whop_sdk/types/domain_website.rb +1 -1
- data/lib/whop_sdk/types/domain_website_app.rb +11 -0
- data/lib/whop_sdk/types/feedback_option.rb +13 -0
- data/lib/whop_sdk/types/feedback_option_category.rb +17 -0
- data/lib/whop_sdk/types/file.rb +12 -0
- data/lib/whop_sdk/types/financing_access_change.rb +19 -0
- data/lib/whop_sdk/types/financing_access_change_disabled_payment_methods_item.rb +33 -0
- data/lib/whop_sdk/types/financing_access_change_object.rb +11 -0
- data/lib/whop_sdk/types/financing_access_change_provider.rb +15 -0
- data/lib/whop_sdk/types/financing_access_change_reason.rb +11 -0
- data/lib/whop_sdk/types/member.rb +10 -0
- data/lib/whop_sdk/types/member_most_recent_action.rb +23 -0
- data/lib/whop_sdk/types/member_note.rb +19 -0
- data/lib/whop_sdk/types/membership.rb +24 -0
- data/lib/whop_sdk/types/membership_cancel_option.rb +18 -0
- data/lib/whop_sdk/types/membership_collection_method.rb +12 -0
- data/lib/whop_sdk/types/membership_feedback_option.rb +9 -0
- data/lib/whop_sdk/types/membership_legacy.rb +2 -0
- data/lib/whop_sdk/types/membership_legacy_feedback_option.rb +11 -0
- data/lib/whop_sdk/types/membership_list_item.rb +2 -0
- data/lib/whop_sdk/types/membership_list_item_feedback_option.rb +11 -0
- data/lib/whop_sdk/types/membership_most_recent_action.rb +21 -0
- data/lib/whop_sdk/types/membership_product.rb +13 -0
- data/lib/whop_sdk/types/owner_level.rb +17 -0
- data/lib/whop_sdk/types/owner_level_points.rb +13 -0
- data/lib/whop_sdk/types/partner_advance.rb +41 -0
- data/lib/whop_sdk/types/partner_advance_status.rb +17 -0
- data/lib/whop_sdk/types/payment.rb +2 -0
- data/lib/whop_sdk/types/payment_input.rb +1 -4
- data/lib/whop_sdk/types/payment_input_plan.rb +2 -0
- data/lib/whop_sdk/types/payment_method_types.rb +3 -0
- data/lib/whop_sdk/types/payment_rule_condition_value.rb +2 -2
- data/lib/whop_sdk/types/permission_action.rb +3 -0
- data/lib/whop_sdk/types/review.rb +2 -3
- data/lib/whop_sdk/types/{review_company.rb → review_account.rb} +1 -2
- data/lib/whop_sdk/types/{review_attachments_item.rb → review_attachment.rb} +1 -2
- data/lib/whop_sdk/types/review_list_item.rb +3 -4
- data/lib/whop_sdk/types/review_list_item_status.rb +11 -0
- data/lib/whop_sdk/types/review_product.rb +0 -1
- data/lib/whop_sdk/types/review_user.rb +0 -1
- data/lib/whop_sdk/types/support_channel.rb +8 -0
- data/lib/whop_sdk/types/support_channel_last_message.rb +23 -0
- data/lib/whop_sdk/types/{review_list_item_attachments_item.rb → support_channel_last_message_attachments_item.rb} +1 -5
- data/lib/whop_sdk/types/support_channel_last_message_gifs_item.rb +10 -0
- data/lib/whop_sdk/types/support_channel_last_message_poll.rb +10 -0
- data/lib/whop_sdk/types/support_channel_last_message_poll_options_item.rb +10 -0
- data/lib/whop_sdk/types/support_channel_list_item.rb +8 -0
- data/lib/whop_sdk/types/support_channel_list_item_last_message.rb +23 -0
- data/lib/whop_sdk/types/support_channel_list_item_last_message_attachments_item.rb +12 -0
- data/lib/whop_sdk/types/support_channel_list_item_last_message_gifs_item.rb +10 -0
- data/lib/whop_sdk/types/support_channel_list_item_last_message_poll.rb +10 -0
- data/lib/whop_sdk/types/support_channel_list_item_last_message_poll_options_item.rb +10 -0
- data/lib/whop_sdk/types/trade.rb +17 -1
- data/lib/whop_sdk/types/trade_failure_code.rb +1 -0
- data/lib/whop_sdk/types/trade_instrument_type.rb +12 -0
- data/lib/whop_sdk/types/trade_order_type.rb +12 -0
- data/lib/whop_sdk/types/trade_side.rb +12 -0
- data/lib/whop_sdk/types/trade_status_detail.rb +0 -3
- data/lib/whop_sdk/types/trade_type.rb +3 -1
- data/lib/whop_sdk/types/user.rb +7 -1
- data/lib/whop_sdk/types/user_social_link.rb +15 -0
- data/lib/whop_sdk/types/user_social_link_website.rb +18 -0
- data/lib/whop_sdk/types/webhook_event.rb +1 -0
- data/lib/whop_sdk/types/webhook_events_item.rb +1 -0
- data/lib/whop_sdk/types/webhook_list_item_events_item.rb +1 -0
- data/lib/whop_sdk/types/webhook_testable_events_item.rb +1 -0
- data/lib/whop_sdk/users/client.rb +13 -18
- data/lib/whop_sdk/users/oauth_grants/client.rb +9 -11
- data/lib/whop_sdk/users/passkeys/client.rb +3 -3
- data/lib/whop_sdk/users/preferences/client.rb +1 -2
- data/lib/whop_sdk/users/preferences/notifications/client.rb +4 -13
- data/lib/whop_sdk/users/preferences/notifications/topics/client.rb +2 -2
- data/lib/whop_sdk/users/preferences/notifications/types/set_notifications_request_preferences_item_scope.rb +3 -1
- data/lib/whop_sdk/variants/client.rb +10 -9
- data/lib/whop_sdk/verifications/client.rb +7 -9
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business.rb +6 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_documents.rb +18 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response.rb +2 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item.rb +2 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response.rb +2 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response.rb +2 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk/waitlist_entries/client.rb +14 -14
- data/lib/whop_sdk/webhooks/client.rb +11 -12
- data/lib/whop_sdk/webhooks/types/create_webhooks_request_events_item.rb +1 -0
- data/lib/whop_sdk/webhooks/types/update_webhooks_request_events_item.rb +1 -0
- data/lib/whop_sdk.rb +99 -9
- data/reference.md +1431 -573
- metadata +99 -9
- data/lib/whop_sdk/types/payment_input_line_items_item.rb +0 -11
- data/lib/whop_sdk/types/review_list_item_user.rb +0 -14
- data/lib/whop_sdk/types/user_staff_access.rb +0 -15
|
@@ -14,11 +14,9 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Creates a future-dated card cashback rule funded by the authenticated
|
|
18
|
-
#
|
|
19
|
-
#
|
|
20
|
-
# Optionally limit the rule to one direct connected account. The funding account is derived from the credential
|
|
21
|
-
# and cannot be supplied. Creation does not transfer funds. Supports Idempotency-Key for safe retries.
|
|
17
|
+
# Creates a future-dated card cashback rule for your direct connected accounts, funded by the authenticated
|
|
18
|
+
# platform account. Creating a rule does not transfer funds; pay cashback out with `POST /cashback_rules/payout`.
|
|
19
|
+
# Requires `payout:transfer_funds`. Supports `Idempotency-Key` for safe retries.
|
|
22
20
|
#
|
|
23
21
|
# @param request_options [Hash]
|
|
24
22
|
# @param params [Whop_sdk::CashbackRules::Types::CreateCashbackRulesRequest]
|
|
@@ -58,9 +56,8 @@ module Whop_sdk
|
|
|
58
56
|
end
|
|
59
57
|
end
|
|
60
58
|
|
|
61
|
-
# Lists
|
|
62
|
-
# discarded rules. Requires
|
|
63
|
-
# caller-supplied funding-account filter.
|
|
59
|
+
# Lists the cashback rules funded by the authenticated platform account, including scheduled, expired, and
|
|
60
|
+
# discarded rules. Requires an account-scoped credential with `payout:transfer:read`.
|
|
64
61
|
#
|
|
65
62
|
# @param request_options [Hash]
|
|
66
63
|
# @param params [Hash]
|
|
@@ -119,14 +116,13 @@ module Whop_sdk
|
|
|
119
116
|
end
|
|
120
117
|
end
|
|
121
118
|
|
|
122
|
-
#
|
|
123
|
-
# accounts.
|
|
124
|
-
#
|
|
125
|
-
#
|
|
126
|
-
#
|
|
127
|
-
# `
|
|
128
|
-
# transaction
|
|
129
|
-
# Idempotency-Key, and overlapping requests cannot pay the same card transaction twice.
|
|
119
|
+
# Pays out cashback on demand from the authenticated platform's available USD balance to its direct connected
|
|
120
|
+
# accounts. Covers completed, unpaid card transactions created before the request, each under its latest matching
|
|
121
|
+
# rule, which must be funded by the authenticated platform. Filters combine, and an empty body includes every
|
|
122
|
+
# eligible transaction. Payouts process in the background and amounts are calculated then, so the response
|
|
123
|
+
# confirms queuing, not payment. If a payout fails for insufficient funds, add USD to the platform's balance.
|
|
124
|
+
# Requires `payout:transfer_funds`. Supports `Idempotency-Key`, and overlapping requests cannot pay the same card
|
|
125
|
+
# transaction twice.
|
|
130
126
|
#
|
|
131
127
|
# @param request_options [Hash]
|
|
132
128
|
# @param params [Whop_sdk::CashbackRules::Types::PayoutCashbackRulesRequest]
|
|
@@ -163,10 +159,10 @@ module Whop_sdk
|
|
|
163
159
|
end
|
|
164
160
|
end
|
|
165
161
|
|
|
166
|
-
# Updates a cashback rule funded by the authenticated platform
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
#
|
|
162
|
+
# Updates the merchant filters, description, or expiration of a cashback rule funded by the authenticated platform
|
|
163
|
+
# account; its start, rate, and accounts can't change. Omitted fields stay unchanged. Scheduled, active, and
|
|
164
|
+
# expired rules can be updated, but discarded rules can't. Updating a rule does not transfer funds. Requires
|
|
165
|
+
# `payout:transfer_funds`.
|
|
170
166
|
#
|
|
171
167
|
# @param request_options [Hash]
|
|
172
168
|
# @param params [Whop_sdk::CashbackRules::Types::UpdateCashbackRulesRequest]
|
|
@@ -14,7 +14,7 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
#
|
|
17
|
+
# Lists the chat channels in an account.
|
|
18
18
|
#
|
|
19
19
|
# Required permissions:
|
|
20
20
|
# - `chat:read`
|
|
@@ -121,7 +121,7 @@ module Whop_sdk
|
|
|
121
121
|
end
|
|
122
122
|
end
|
|
123
123
|
|
|
124
|
-
#
|
|
124
|
+
# Updates a chat channel's moderation settings, such as who can post, banned words, and media restrictions.
|
|
125
125
|
#
|
|
126
126
|
# Required permissions:
|
|
127
127
|
# - `chat:moderate`
|
|
@@ -77,7 +77,8 @@ module Whop_sdk
|
|
|
77
77
|
end
|
|
78
78
|
end
|
|
79
79
|
|
|
80
|
-
# Creates a reusable checkout configuration for an existing or inline variant.
|
|
80
|
+
# Creates a reusable checkout configuration for an existing or inline variant. Send customers to its
|
|
81
|
+
# `purchase_url` to check out.
|
|
81
82
|
#
|
|
82
83
|
# @param request_options [Hash]
|
|
83
84
|
# @param params [Whop_sdk::CheckoutConfigurations::Types::CreateCheckoutConfigurationsRequest]
|
|
@@ -14,11 +14,11 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Retrieves a funded claim link
|
|
18
|
-
#
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
17
|
+
# Retrieves a funded claim link by ID or by its public claim code. By ID, the caller needs
|
|
18
|
+
# `airdrop_link:basic:read` on the funding account, or must own the funding personal account; `code` and
|
|
19
|
+
# `claim_url` are `null` without `airdrop_link:manage` on the funding account or `payout:withdraw_funds` on the
|
|
20
|
+
# personal account. A claim code previews the sender, amount, expiry, and claim availability without
|
|
21
|
+
# authentication. Treat codes as secrets: anyone holding one can claim after signing in.
|
|
22
22
|
#
|
|
23
23
|
# @param request_options [Hash]
|
|
24
24
|
# @param params [Hash]
|
|
@@ -56,9 +56,9 @@ module Whop_sdk
|
|
|
56
56
|
end
|
|
57
57
|
|
|
58
58
|
# Claims a funded link into the authenticated user's personal balance and returns the updated link. Requires a
|
|
59
|
-
# signed-in user and the public claim code;
|
|
60
|
-
# claim a link once. Reuse the same Idempotency-Key when retrying the same request. On-chain claims
|
|
61
|
-
#
|
|
59
|
+
# signed-in user and the public claim code; account API keys cannot claim on a recipient's behalf. Each user can
|
|
60
|
+
# claim a link once. Reuse the same `Idempotency-Key` when retrying the same request. On-chain claims may take
|
|
61
|
+
# several minutes to complete.
|
|
62
62
|
#
|
|
63
63
|
# @param request_options [Hash]
|
|
64
64
|
# @param params [Hash]
|
data/lib/whop_sdk/client.rb
CHANGED
|
@@ -10,7 +10,7 @@ module Whop_sdk
|
|
|
10
10
|
# @param max_retries [Integer]
|
|
11
11
|
#
|
|
12
12
|
# @return [void]
|
|
13
|
-
def initialize(token:, base_url: nil, environment: Whop_sdk::Environment::PRODUCTION, api_version_date: "2026-10-
|
|
13
|
+
def initialize(token:, base_url: nil, environment: Whop_sdk::Environment::PRODUCTION, api_version_date: "2026-10-13-1", idempotency_key: nil, max_retries: 2)
|
|
14
14
|
@base_url = base_url
|
|
15
15
|
@environment = environment
|
|
16
16
|
|
|
@@ -14,8 +14,7 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
#
|
|
18
|
-
# optional filtering by user and transaction type.
|
|
17
|
+
# Lists an account's token transactions, newest first.
|
|
19
18
|
#
|
|
20
19
|
# Required permissions:
|
|
21
20
|
# - `company_token_transaction:read`
|
|
@@ -86,7 +85,7 @@ module Whop_sdk
|
|
|
86
85
|
end
|
|
87
86
|
end
|
|
88
87
|
|
|
89
|
-
#
|
|
88
|
+
# Creates a token transaction that adds, subtracts, or transfers tokens for a member of an account.
|
|
90
89
|
#
|
|
91
90
|
# Required permissions:
|
|
92
91
|
# - `company_token_transaction:create`
|
|
@@ -128,7 +127,7 @@ module Whop_sdk
|
|
|
128
127
|
end
|
|
129
128
|
end
|
|
130
129
|
|
|
131
|
-
# Retrieves
|
|
130
|
+
# Retrieves a token transaction.
|
|
132
131
|
#
|
|
133
132
|
# Required permissions:
|
|
134
133
|
# - `company_token_transaction:read`
|
|
@@ -14,9 +14,9 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Retrieves a token's payment method and billing details
|
|
18
|
-
#
|
|
19
|
-
#
|
|
17
|
+
# Retrieves a confirmation token's payment method and billing details, never the underlying payment credential, to
|
|
18
|
+
# display what the buyer chose or check that the token is still usable. Requires no authentication and is
|
|
19
|
+
# rate-limited.
|
|
20
20
|
#
|
|
21
21
|
# @param request_options [Hash]
|
|
22
22
|
# @param params [Hash]
|
|
@@ -14,7 +14,8 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Returns a paginated list of lesson interactions
|
|
17
|
+
# Returns a paginated list of lesson interactions for a lesson or course. Callers without admin access to the
|
|
18
|
+
# course's experience see only their own interactions.
|
|
18
19
|
#
|
|
19
20
|
# Required permissions:
|
|
20
21
|
# - `courses:read`
|
|
@@ -14,7 +14,8 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Returns a paginated list of courses
|
|
17
|
+
# Returns a paginated list of the courses in an experience or an account. `hidden` courses are included only for
|
|
18
|
+
# callers with `courses:update`.
|
|
18
19
|
#
|
|
19
20
|
# Required permissions:
|
|
20
21
|
# - `courses:read`
|
|
@@ -124,7 +125,8 @@ module Whop_sdk
|
|
|
124
125
|
end
|
|
125
126
|
end
|
|
126
127
|
|
|
127
|
-
# Retrieves the details of an existing course.
|
|
128
|
+
# Retrieves the details of an existing course. A `hidden` course is returned only to callers with
|
|
129
|
+
# `courses:update`.
|
|
128
130
|
#
|
|
129
131
|
# Required permissions:
|
|
130
132
|
# - `courses:read`
|
|
@@ -14,8 +14,9 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
#
|
|
18
|
-
#
|
|
17
|
+
# Returns the deposit methods for an account or user, including crypto addresses, bank transfer instructions, and,
|
|
18
|
+
# for a business, a hosted deposit page. Bitcoin deposits are converted to USDT on Plasma in the destination's
|
|
19
|
+
# wallet. Business destinations require no authentication.
|
|
19
20
|
#
|
|
20
21
|
# @param request_options [Hash]
|
|
21
22
|
# @param params [Whop_sdk::Deposits::Types::CreateDepositsRequest]
|
|
@@ -172,9 +172,8 @@ module Whop_sdk
|
|
|
172
172
|
end
|
|
173
173
|
end
|
|
174
174
|
|
|
175
|
-
# Edits a dispute's evidence
|
|
176
|
-
#
|
|
177
|
-
# description.
|
|
175
|
+
# Edits a dispute's evidence while it is still editable. When the evidence is ready, send it to the payment
|
|
176
|
+
# processor with `POST /disputes/:id/submit`.
|
|
178
177
|
#
|
|
179
178
|
# @param request_options [Hash]
|
|
180
179
|
# @param params [Whop_sdk::Disputes::Types::UpdateDisputesRequest]
|
|
@@ -253,15 +252,9 @@ module Whop_sdk
|
|
|
253
252
|
end
|
|
254
253
|
end
|
|
255
254
|
|
|
256
|
-
#
|
|
257
|
-
#
|
|
258
|
-
#
|
|
259
|
-
# multipart file parts to upload and attach in one call. Send every document the packet should carry — up to 10,
|
|
260
|
-
# 10MB each and 25MB in total; an empty list removes them all. Accepted content types: application/pdf,
|
|
261
|
-
# application/json, image/jpeg, image/png, image/webp — any other type is rejected. Policy documents
|
|
262
|
-
# (`return_policy`, `shipping_policy`, `cancellation_policy`, `terms_of_service`) default from the account's own
|
|
263
|
-
# documents; uploading one here replaces the account copy for this dispute, and a `cancellation_policy` or
|
|
264
|
-
# `return_policy` upload also takes precedence over the matching fixed evidence slot.
|
|
255
|
+
# Replaces the full set of uploaded evidence documents on a dispute, beyond the four fixed evidence slots. Prefer
|
|
256
|
+
# `PATCH /disputes/:id` with `evidence.documents`, which does the same replace alongside every other evidence
|
|
257
|
+
# field in one call.
|
|
265
258
|
#
|
|
266
259
|
# @param request_options [Hash]
|
|
267
260
|
# @param params [Whop_sdk::Disputes::Types::UploadEvidenceDisputesRequest]
|
|
@@ -14,7 +14,7 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
#
|
|
17
|
+
# Lists the authenticated user's DM channels, most recently active first.
|
|
18
18
|
#
|
|
19
19
|
# Required permissions:
|
|
20
20
|
# - `dms:read`
|
|
@@ -78,8 +78,8 @@ module Whop_sdk
|
|
|
78
78
|
end
|
|
79
79
|
end
|
|
80
80
|
|
|
81
|
-
#
|
|
82
|
-
#
|
|
81
|
+
# Creates a DM channel between two or more users, optionally scoped to an account. Returns the existing channel if
|
|
82
|
+
# one already exists.
|
|
83
83
|
#
|
|
84
84
|
# Required permissions:
|
|
85
85
|
# - `dms:channel:manage`
|
|
@@ -160,7 +160,7 @@ module Whop_sdk
|
|
|
160
160
|
end
|
|
161
161
|
end
|
|
162
162
|
|
|
163
|
-
# Permanently
|
|
163
|
+
# Permanently deletes a DM channel and all of its messages. Only a channel admin can delete it.
|
|
164
164
|
#
|
|
165
165
|
# Required permissions (one of):
|
|
166
166
|
# - `dms:channel:manage`
|
|
@@ -201,8 +201,7 @@ module Whop_sdk
|
|
|
201
201
|
end
|
|
202
202
|
end
|
|
203
203
|
|
|
204
|
-
#
|
|
205
|
-
# perform this action.
|
|
204
|
+
# Updates a DM channel's settings, such as its display name. Only a channel admin can update it.
|
|
206
205
|
#
|
|
207
206
|
# Required permissions (one of):
|
|
208
207
|
# - `dms:channel:manage`
|
|
@@ -42,6 +42,8 @@ module Whop_sdk
|
|
|
42
42
|
# @option params [Whop_sdk::Domains::Types::ListDomainsRequestRegistration, nil] :registration
|
|
43
43
|
# @option params [Whop_sdk::Domains::Types::ListDomainsRequestPlatform, nil] :platform
|
|
44
44
|
# @option params [Whop_sdk::Domains::Types::ListDomainsRequestWebsite, nil] :website
|
|
45
|
+
# @option params [Whop_sdk::Domains::Types::ListDomainsRequestApplePay, nil] :apple_pay
|
|
46
|
+
# @option params [Whop_sdk::Domains::Types::ListDomainsRequestPixel, nil] :pixel
|
|
45
47
|
#
|
|
46
48
|
# @example
|
|
47
49
|
# client.domains.list(tlds: ["com"])
|
|
@@ -66,6 +68,8 @@ module Whop_sdk
|
|
|
66
68
|
query_params["registration"] = params[:registration] if params.key?(:registration)
|
|
67
69
|
query_params["platform"] = params[:platform] if params.key?(:platform)
|
|
68
70
|
query_params["website"] = params[:website] if params.key?(:website)
|
|
71
|
+
query_params["apple_pay"] = params[:apple_pay] if params.key?(:apple_pay)
|
|
72
|
+
query_params["pixel"] = params[:pixel] if params.key?(:pixel)
|
|
69
73
|
|
|
70
74
|
Whop_sdk::Internal::CursorItemIterator.new(
|
|
71
75
|
cursor_field: :end_cursor,
|
|
@@ -6,10 +6,14 @@ module Whop_sdk
|
|
|
6
6
|
class CreateDomainsRequest < Internal::Types::Model
|
|
7
7
|
field :account_id, -> { String }, optional: true, nullable: false
|
|
8
8
|
|
|
9
|
+
field :apple_pay, -> { Whop_sdk::Domains::Types::CreateDomainsRequestApplePay }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :domain, -> { String }, optional: false, nullable: false
|
|
10
12
|
|
|
11
13
|
field :metadata, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
12
14
|
|
|
15
|
+
field :pixel, -> { Whop_sdk::Domains::Types::CreateDomainsRequestPixel }, optional: true, nullable: false
|
|
16
|
+
|
|
13
17
|
field :registration, -> { Whop_sdk::Domains::Types::CreateDomainsRequestRegistration }, optional: true, nullable: false
|
|
14
18
|
|
|
15
19
|
field :verification, -> { Whop_sdk::Domains::Types::CreateDomainsRequestVerification }, optional: true, nullable: false
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
# Accept Apple Pay at checkout on the domain. It needs no other capability. Whop registers the domain with Apple:
|
|
7
|
+
# it stays `pending` until Apple answers, then turns `ready`, or `action_required` when Apple couldn't fetch the
|
|
8
|
+
# domain association file. Serve the file, then check the domain to register it again. Pass `null` to turn Apple
|
|
9
|
+
# Pay off: Whop removes the domain from Apple, and the domain stays, like releasing any other capability.
|
|
10
|
+
class CreateDomainsRequestApplePay < Internal::Types::Model; end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
# Track page views on the domain with the Whop pixel. It needs no other capability: it stays `pending` until the
|
|
7
|
+
# pixel records a page view, and turns `action_required` if it goes 7 days without one. Pass `null` to stop
|
|
8
|
+
# tracking.
|
|
9
|
+
class CreateDomainsRequestPixel < Internal::Types::Model; end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -35,6 +35,10 @@ module Whop_sdk
|
|
|
35
35
|
field :platform, -> { Whop_sdk::Domains::Types::ListDomainsRequestPlatform }, optional: true, nullable: false
|
|
36
36
|
|
|
37
37
|
field :website, -> { Whop_sdk::Domains::Types::ListDomainsRequestWebsite }, optional: true, nullable: false
|
|
38
|
+
|
|
39
|
+
field :apple_pay, -> { Whop_sdk::Domains::Types::ListDomainsRequestApplePay }, optional: true, nullable: false
|
|
40
|
+
|
|
41
|
+
field :pixel, -> { Whop_sdk::Domains::Types::ListDomainsRequestPixel }, optional: true, nullable: false
|
|
38
42
|
end
|
|
39
43
|
end
|
|
40
44
|
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
module ListDomainsRequestApplePay
|
|
7
|
+
extend Whop_sdk::Internal::Types::Enum
|
|
8
|
+
|
|
9
|
+
PENDING = "pending"
|
|
10
|
+
READY = "ready"
|
|
11
|
+
ACTION_REQUIRED = "action_required"
|
|
12
|
+
RELEASING = "releasing"
|
|
13
|
+
ANY = "any"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
module ListDomainsRequestPixel
|
|
7
|
+
extend Whop_sdk::Internal::Types::Enum
|
|
8
|
+
|
|
9
|
+
PENDING = "pending"
|
|
10
|
+
READY = "ready"
|
|
11
|
+
ACTION_REQUIRED = "action_required"
|
|
12
|
+
RELEASING = "releasing"
|
|
13
|
+
ANY = "any"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -6,8 +6,12 @@ module Whop_sdk
|
|
|
6
6
|
class UpdateDomainsRequest < Internal::Types::Model
|
|
7
7
|
field :id, -> { String }, optional: false, nullable: false
|
|
8
8
|
|
|
9
|
+
field :apple_pay, -> { Whop_sdk::Domains::Types::UpdateDomainsRequestApplePay }, optional: true, nullable: false
|
|
10
|
+
|
|
9
11
|
field :metadata, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
10
12
|
|
|
13
|
+
field :pixel, -> { Whop_sdk::Domains::Types::UpdateDomainsRequestPixel }, optional: true, nullable: false
|
|
14
|
+
|
|
11
15
|
field :registration, -> { Whop_sdk::Domains::Types::UpdateDomainsRequestRegistration }, optional: true, nullable: false
|
|
12
16
|
|
|
13
17
|
field :verification, -> { Whop_sdk::Domains::Types::UpdateDomainsRequestVerification }, optional: true, nullable: false
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
# Accept Apple Pay at checkout on the domain. It needs no other capability. Whop registers the domain with Apple:
|
|
7
|
+
# it stays `pending` until Apple answers, then turns `ready`, or `action_required` when Apple couldn't fetch the
|
|
8
|
+
# domain association file. Serve the file, then check the domain to register it again. Pass `null` to turn Apple
|
|
9
|
+
# Pay off: Whop removes the domain from Apple, and the domain stays, like releasing any other capability.
|
|
10
|
+
class UpdateDomainsRequestApplePay < Internal::Types::Model; end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Whop_sdk
|
|
4
|
+
module Domains
|
|
5
|
+
module Types
|
|
6
|
+
# Track page views on the domain with the Whop pixel. It needs no other capability: it stays `pending` until the
|
|
7
|
+
# pixel records a page view, and turns `action_required` if it goes 7 days without one. Pass `null` to stop
|
|
8
|
+
# tracking.
|
|
9
|
+
class UpdateDomainsRequestPixel < Internal::Types::Model; end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -14,14 +14,12 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Lists an account's recommendations and generation requests, newest first by default.
|
|
18
|
-
# company:update permission, listing queues generation
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
# Intelligence turns off. New recommendations are offered only while it is on. Visitor countries, page views, ad
|
|
24
|
-
# impressions and clicks, and payment volume for a time range come from `GET /stats/time_series/{metric}`.
|
|
17
|
+
# Lists an account's recommendations and generation requests, newest first by default. When no recommendations are
|
|
18
|
+
# ready or in progress and you have `company:update` permission, listing queues generation, with a ten-minute
|
|
19
|
+
# cooldown after an unsuccessful request; unsuccessful requests are not listed. An account's executed
|
|
20
|
+
# recommendations and runs stay listed after Economic Intelligence turns off, but new recommendations are offered
|
|
21
|
+
# only while it is on. For visitor countries, page views, ad impressions and clicks, or payment volume over a time
|
|
22
|
+
# range, use `GET /stats/time_series/:metric`.
|
|
25
23
|
#
|
|
26
24
|
# @param request_options [Hash]
|
|
27
25
|
# @param params [Hash]
|
|
@@ -14,9 +14,9 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Lists identity-linked events, most recent first by default. Pass identifier for one person's journey, or omit
|
|
18
|
-
# to list
|
|
19
|
-
#
|
|
17
|
+
# Lists identity-linked events, most recent first by default. Pass `identifier` for one person's journey, or omit
|
|
18
|
+
# it to list an account's events within a time range. Events have the same shape as the `POST /events` intake:
|
|
19
|
+
# attribution in `context`, identity in `user`.
|
|
20
20
|
#
|
|
21
21
|
# @param request_options [Hash]
|
|
22
22
|
# @param params [Hash]
|
|
@@ -101,7 +101,9 @@ module Whop_sdk
|
|
|
101
101
|
end
|
|
102
102
|
end
|
|
103
103
|
|
|
104
|
-
# Tracks a conversion or engagement event for an account
|
|
104
|
+
# Tracks a conversion or engagement event for an account, such as a lead or a sign-up, so it can be attributed to
|
|
105
|
+
# the ads and links that drove it. Send server-side events with an API key that has `event:create`; the browser
|
|
106
|
+
# pixel calls this without authentication.
|
|
105
107
|
#
|
|
106
108
|
# @param request_options [Hash]
|
|
107
109
|
# @param params [Whop_sdk::Events::Types::CreateEventsRequest]
|
|
@@ -141,11 +143,9 @@ module Whop_sdk
|
|
|
141
143
|
end
|
|
142
144
|
end
|
|
143
145
|
|
|
144
|
-
# Returns a fully anonymized feed of recent
|
|
145
|
-
#
|
|
146
|
-
#
|
|
147
|
-
# amount, a coarse location under `user`, and a timestamp coarsened to the start of the minute; missing fields are
|
|
148
|
-
# omitted, not nulled. The payload is identical for every caller; no auth is required.
|
|
146
|
+
# Returns a fully anonymized feed of recent money movement across Whop, most recent first, such as purchases, card
|
|
147
|
+
# spend, and transfers between accounts. Each item carries only its `type`, a USD amount, a coarse location, and a
|
|
148
|
+
# timestamp coarsened to the minute. The payload is identical for every caller and requires no authentication.
|
|
149
149
|
#
|
|
150
150
|
# @param request_options [Hash]
|
|
151
151
|
# @param params [Hash]
|
|
@@ -200,13 +200,9 @@ module Whop_sdk
|
|
|
200
200
|
end
|
|
201
201
|
end
|
|
202
202
|
|
|
203
|
-
# Checks whether the Whop pixel is installed for an account
|
|
204
|
-
# an
|
|
205
|
-
#
|
|
206
|
-
# confirmation page. If the requested page hasn't sent any events lately, it is fetched and read for the pixel and
|
|
207
|
-
# conversion events wired on it. `installed` is only true when the pixel was actually seen — in the account's
|
|
208
|
-
# events or in the page. `affiliate_tracking_detected` reports an affiliate tracking SDK found on the page.
|
|
209
|
-
# Supported platforms: Everflow.
|
|
203
|
+
# Checks whether the Whop pixel is installed for an account, or on one page when you pass a `url`. Use it before
|
|
204
|
+
# launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their
|
|
205
|
+
# install is live.
|
|
210
206
|
#
|
|
211
207
|
# @param request_options [Hash]
|
|
212
208
|
# @param params [Whop_sdk::Events::Types::ValidatePixelEventsRequest]
|
|
@@ -14,7 +14,7 @@ module Whop_sdk
|
|
|
14
14
|
@environment = environment
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
#
|
|
17
|
+
# Lists the experiences in an account, optionally filtered to those attached to one product or powered by one app.
|
|
18
18
|
#
|
|
19
19
|
# @param request_options [Hash]
|
|
20
20
|
# @param params [Hash]
|
|
@@ -87,6 +87,9 @@ module Whop_sdk
|
|
|
87
87
|
end
|
|
88
88
|
end
|
|
89
89
|
|
|
90
|
+
# Creates an experience for an account, powered by an app such as courses, forums, or chat. Attach it to a product
|
|
91
|
+
# with `POST /experiences/:id/attach` to give that product's customers access.
|
|
92
|
+
#
|
|
90
93
|
# Required permissions:
|
|
91
94
|
# - `experience:create`
|
|
92
95
|
#
|
|
@@ -165,6 +168,9 @@ module Whop_sdk
|
|
|
165
168
|
end
|
|
166
169
|
end
|
|
167
170
|
|
|
171
|
+
# Deletes an experience and detaches it from every product, removing customer access to it. Returns `true` on
|
|
172
|
+
# success.
|
|
173
|
+
#
|
|
168
174
|
# Required permissions:
|
|
169
175
|
# - `experience:delete`
|
|
170
176
|
#
|
|
@@ -203,6 +209,9 @@ module Whop_sdk
|
|
|
203
209
|
end
|
|
204
210
|
end
|
|
205
211
|
|
|
212
|
+
# Updates an experience's name, logo, visibility, or notification setting, or moves it to another section or
|
|
213
|
+
# position.
|
|
214
|
+
#
|
|
206
215
|
# Required permissions:
|
|
207
216
|
# - `experience:update`
|
|
208
217
|
#
|
|
@@ -246,7 +255,7 @@ module Whop_sdk
|
|
|
246
255
|
end
|
|
247
256
|
end
|
|
248
257
|
|
|
249
|
-
#
|
|
258
|
+
# Attaches an experience to a product, giving the product's customers access to it.
|
|
250
259
|
#
|
|
251
260
|
# Required permissions:
|
|
252
261
|
# - `experience:attach`
|
|
@@ -294,7 +303,7 @@ module Whop_sdk
|
|
|
294
303
|
end
|
|
295
304
|
end
|
|
296
305
|
|
|
297
|
-
#
|
|
306
|
+
# Detaches an experience from a product, removing customer access to it through that product.
|
|
298
307
|
#
|
|
299
308
|
# Required permissions:
|
|
300
309
|
# - `experience:detach`
|
|
@@ -342,12 +351,9 @@ module Whop_sdk
|
|
|
342
351
|
end
|
|
343
352
|
end
|
|
344
353
|
|
|
345
|
-
# Duplicates an
|
|
346
|
-
#
|
|
347
|
-
#
|
|
348
|
-
# experience, e.g. who can post, who can comment, etc.
|
|
349
|
-
# No content, e.g. posts, messages, lessons from within the original experience will be copied.
|
|
350
|
-
#
|
|
354
|
+
# Duplicates an experience and attaches the copy to the same products as the original. Forum and chat copies keep
|
|
355
|
+
# the original's settings, such as who can post or comment. No content, such as posts, messages, or lessons, is
|
|
356
|
+
# copied.
|
|
351
357
|
#
|
|
352
358
|
# Required permissions:
|
|
353
359
|
# - `experience:create`
|