whop_sdk 2.5.0 → 2.6.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 +253 -1
- data/lib/whop_sdk/accounts/client.rb +66 -1
- data/lib/whop_sdk/accounts/types/list_accounts_request.rb +2 -0
- data/lib/whop_sdk/accounts/types/search_accounts_request.rb +23 -0
- data/lib/whop_sdk/accounts/types/search_accounts_request_direction.rb +14 -0
- data/lib/whop_sdk/accounts/types/search_accounts_request_order.rb +13 -0
- data/lib/whop_sdk/accounts/types/search_accounts_response.rb +13 -0
- data/lib/whop_sdk/accounts/types/search_accounts_response_page_info.rb +17 -0
- data/lib/whop_sdk/accounts/types/update_accounts_request.rb +2 -0
- data/lib/whop_sdk/api_keys/types/create_api_keys_request_api_version_date.rb +4 -0
- data/lib/whop_sdk/api_keys/types/update_api_keys_request_api_version_date.rb +4 -0
- data/lib/whop_sdk/client.rb +1 -6
- data/lib/whop_sdk/deposits/client.rb +3 -1
- data/lib/whop_sdk/deposits/types/create_deposits_request.rb +2 -0
- data/lib/whop_sdk/deposits/types/create_deposits_response_methods.rb +2 -0
- data/lib/whop_sdk/deposits/types/create_deposits_response_methods_card.rb +14 -0
- data/lib/whop_sdk/disputes/client.rb +39 -0
- data/lib/whop_sdk/disputes/types/accept_disputes_request.rb +11 -0
- data/lib/whop_sdk/external_accounts/types/connect_external_accounts_request_platform.rb +1 -0
- data/lib/whop_sdk/financial_activity/types/list_financial_activity_request_line_types_item.rb +2 -0
- data/lib/whop_sdk/financial_reports/types/retrieve_financial_reports_request_line_types_item.rb +2 -0
- data/lib/whop_sdk/financial_reports/types/retrieve_financial_reports_response_rows_item_line_category.rb +2 -0
- data/lib/whop_sdk/identity_profiles/client.rb +3 -0
- data/lib/whop_sdk/internal/http/raw_client.rb +1 -1
- data/lib/whop_sdk/partners/businesses/client.rb +57 -10
- data/lib/whop_sdk/partners/businesses/earnings/client.rb +2 -1
- data/lib/whop_sdk/partners/businesses/types/list_businesses_request_advance_status.rb +1 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_request.rb +15 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response.rb +45 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_account.rb +26 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_blueprint_partner.rb +20 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_blueprint_partner_profile_picture.rb +14 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_earnings_usd.rb +17 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_first_tier_partner.rb +21 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_first_tier_partner_profile_picture.rb +14 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_my_partner_tier.rb +17 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_object.rb +15 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_owner.rb +22 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_owner_profile_picture.rb +14 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_payout_percentages.rb +22 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_pending_owner_invites_item.rb +15 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_second_tier_partner.rb +21 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_second_tier_partner_profile_picture.rb +14 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_status.rb +16 -0
- data/lib/whop_sdk/partners/businesses/types/resend_invite_businesses_response_volume_usd.rb +19 -0
- data/lib/whop_sdk/partners/businesses/types/retrieve_businesses_response.rb +2 -0
- data/lib/whop_sdk/partners/businesses/types/retrieve_businesses_response_pending_owner_invites_item.rb +15 -0
- data/lib/whop_sdk/partners/businesses/types/update_businesses_request.rb +2 -2
- data/lib/whop_sdk/partners/client.rb +38 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response.rb +13 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_object.rb +13 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_streams_item.rb +19 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_streams_item_fee.rb +18 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_streams_item_fee_regions_item.rb +15 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_streams_item_income_stream.rb +20 -0
- data/lib/whop_sdk/partners/types/fee_options_partners_response_streams_item_unadjustable_reason.rb +16 -0
- data/lib/whop_sdk/payment_method_domains/client.rb +11 -5
- data/lib/whop_sdk/payments/types/refund_payments_request.rb +2 -0
- data/lib/whop_sdk/payouts/client.rb +7 -5
- data/lib/whop_sdk/payouts/types/cancel_payouts_response.rb +2 -0
- data/lib/whop_sdk/payouts/types/create_payouts_response.rb +2 -0
- data/lib/whop_sdk/payouts/types/list_payouts_response_data_item.rb +2 -0
- data/lib/whop_sdk/payouts/types/post_payout_created_payload_data.rb +2 -0
- data/lib/whop_sdk/payouts/types/post_payout_reversed_payload_data.rb +2 -0
- data/lib/whop_sdk/payouts/types/post_payout_updated_payload_data.rb +2 -0
- data/lib/whop_sdk/payouts/types/retrieve_payouts_response.rb +2 -0
- data/lib/whop_sdk/setup_intents/types/create_setup_intents_request.rb +2 -0
- data/lib/whop_sdk/social_accounts/types/connect_social_accounts_request_platform.rb +1 -0
- data/lib/whop_sdk/stats/client.rb +2 -0
- data/lib/whop_sdk/stats/reports/client.rb +4 -2
- data/lib/whop_sdk/stats/reports/types/platform_trends_reports_request.rb +2 -0
- data/lib/whop_sdk/stats/reports/types/platform_trends_reports_request_breakdown_by.rb +1 -0
- data/lib/whop_sdk/stats/reports/types/platform_trends_reports_response_data_reports_item_rows_item.rb +2 -0
- data/lib/whop_sdk/stats/reports/types/platform_trends_reports_response_data_reports_item_rows_item_product_category.rb +15 -0
- data/lib/whop_sdk/stats/time_series/client.rb +2 -0
- data/lib/whop_sdk/stats/time_series/types/retrieve_time_series_request.rb +2 -0
- data/lib/whop_sdk/stats/types/retrieve_stats_request.rb +2 -0
- data/lib/whop_sdk/support_channels/client.rb +2 -0
- data/lib/whop_sdk/support_channels/types/list_support_channels_request.rb +2 -0
- data/lib/whop_sdk/team_members/client.rb +10 -1
- data/lib/whop_sdk/team_members/types/list_team_members_request.rb +8 -0
- data/lib/whop_sdk/transfers/client.rb +2 -2
- data/lib/whop_sdk/transfers/types/create_transfers_request_body_balance.rb +2 -2
- data/lib/whop_sdk/types/account.rb +6 -2
- data/lib/whop_sdk/types/account_required_action_action.rb +1 -0
- data/lib/whop_sdk/types/account_search_result.rb +15 -0
- data/lib/whop_sdk/types/api_key_api_version_date.rb +4 -0
- data/lib/whop_sdk/types/dispute.rb +2 -0
- data/lib/whop_sdk/types/ledger_activity_line_type.rb +2 -0
- data/lib/whop_sdk/types/partner_advance.rb +4 -4
- data/lib/whop_sdk/types/partner_advance_status.rb +1 -0
- data/lib/whop_sdk/types/payment_method_list_item_us_bank_account_payment_method_us_bank_account.rb +3 -3
- data/lib/whop_sdk/types/payment_method_us_bank_account_payment_method_us_bank_account.rb +3 -3
- data/lib/whop_sdk/types/permission_action.rb +2 -0
- data/lib/whop_sdk/types/refund.rb +2 -0
- data/lib/whop_sdk/types/refund_legacy.rb +2 -0
- data/lib/whop_sdk/types/refund_list_item.rb +2 -0
- data/lib/whop_sdk/types/team_member.rb +4 -0
- data/lib/whop_sdk/types/user_fees.rb +17 -0
- data/lib/whop_sdk/types/webhook_event.rb +3 -0
- data/lib/whop_sdk/types/webhook_events_item.rb +3 -0
- data/lib/whop_sdk/types/webhook_list_item_events_item.rb +3 -0
- data/lib/whop_sdk/types/webhook_testable_events_item.rb +3 -0
- data/lib/whop_sdk/users/client.rb +5 -0
- data/lib/whop_sdk/users/fees/client.rb +59 -0
- data/lib/whop_sdk/users/fees/types/retrieve_fees_request.rb +13 -0
- data/lib/whop_sdk/verifications/client.rb +12 -5
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business.rb +2 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_owners_item.rb +38 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_owners_item_address.rb +22 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_owners_item_document_type.rb +16 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_owners_item_documents.rb +30 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/create_verifications_request_body_individual_document_type.rb +4 -4
- data/lib/whop_sdk/verifications/types/create_verifications_response.rb +2 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response_owners_item.rb +23 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response_owners_item_required_documents_item.rb +15 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response_owners_item_required_documents_item_status.rb +14 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/create_verifications_response_owners_item_status.rb +19 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item.rb +2 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item_owners_item.rb +23 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item_owners_item_required_documents_item.rb +15 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item_owners_item_required_documents_item_status.rb +14 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/list_verifications_response_data_item_owners_item_status.rb +19 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response.rb +2 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response_owners_item.rb +23 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response_owners_item_required_documents_item.rb +15 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response_owners_item_required_documents_item_status.rb +14 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/retrieve_verifications_response_owners_item_status.rb +19 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address.rb +10 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_documents.rb +18 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_owners_item.rb +43 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_owners_item_address.rb +22 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_owners_item_document_type.rb +16 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_owners_item_documents.rb +30 -0
- data/lib/whop_sdk/verifications/types/update_verifications_request_body_business_address_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response.rb +2 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response_owners_item.rb +23 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response_owners_item_required_documents_item.rb +15 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response_owners_item_required_documents_item_status.rb +14 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response_owners_item_roles_item.rb +16 -0
- data/lib/whop_sdk/verifications/types/update_verifications_response_owners_item_status.rb +19 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk/webhooks/types/create_webhooks_request_events_item.rb +3 -0
- data/lib/whop_sdk/webhooks/types/update_webhooks_request_events_item.rb +3 -0
- data/lib/whop_sdk.rb +69 -3
- data/reference.md +500 -130
- metadata +71 -5
- data/lib/whop_sdk/topups/client.rb +0 -64
- data/lib/whop_sdk/topups/types/create_topups_request.rb +0 -17
- data/lib/whop_sdk/types/topup.rb +0 -23
data/reference.md
CHANGED
|
@@ -325,6 +325,14 @@ client.accounts.list
|
|
|
325
325
|
<dl>
|
|
326
326
|
<dd>
|
|
327
327
|
|
|
328
|
+
**owner_id:** `String` — Return only accounts owned by this user (`user_...`), the account's `owner`. Cannot be combined with `parent_account_id`.
|
|
329
|
+
|
|
330
|
+
</dd>
|
|
331
|
+
</dl>
|
|
332
|
+
|
|
333
|
+
<dl>
|
|
334
|
+
<dd>
|
|
335
|
+
|
|
328
336
|
**request_options:** `Whop_sdk::Accounts::RequestOptions`
|
|
329
337
|
|
|
330
338
|
</dd>
|
|
@@ -529,6 +537,116 @@ client.accounts.me
|
|
|
529
537
|
</dl>
|
|
530
538
|
|
|
531
539
|
|
|
540
|
+
</dd>
|
|
541
|
+
</dl>
|
|
542
|
+
</details>
|
|
543
|
+
|
|
544
|
+
<details><summary><code>client.accounts.<a href="/lib/whop_sdk/accounts/client.rb">search</a>() -> Whop_sdk::Accounts::Types::SearchAccountsResponse</code></summary>
|
|
545
|
+
<dl>
|
|
546
|
+
<dd>
|
|
547
|
+
|
|
548
|
+
#### 📝 Description
|
|
549
|
+
|
|
550
|
+
<dl>
|
|
551
|
+
<dd>
|
|
552
|
+
|
|
553
|
+
<dl>
|
|
554
|
+
<dd>
|
|
555
|
+
|
|
556
|
+
Finds accounts by name among the accounts the credential can list. Support searches cover every company and return only the 50 best matches.
|
|
557
|
+
</dd>
|
|
558
|
+
</dl>
|
|
559
|
+
</dd>
|
|
560
|
+
</dl>
|
|
561
|
+
|
|
562
|
+
#### 🔌 Usage
|
|
563
|
+
|
|
564
|
+
<dl>
|
|
565
|
+
<dd>
|
|
566
|
+
|
|
567
|
+
<dl>
|
|
568
|
+
<dd>
|
|
569
|
+
|
|
570
|
+
```ruby
|
|
571
|
+
client.accounts.search(query: "query")
|
|
572
|
+
```
|
|
573
|
+
</dd>
|
|
574
|
+
</dl>
|
|
575
|
+
</dd>
|
|
576
|
+
</dl>
|
|
577
|
+
|
|
578
|
+
#### ⚙️ Parameters
|
|
579
|
+
|
|
580
|
+
<dl>
|
|
581
|
+
<dd>
|
|
582
|
+
|
|
583
|
+
<dl>
|
|
584
|
+
<dd>
|
|
585
|
+
|
|
586
|
+
**first:** `Integer` — Number of results to return from the start of the range.
|
|
587
|
+
|
|
588
|
+
</dd>
|
|
589
|
+
</dl>
|
|
590
|
+
|
|
591
|
+
<dl>
|
|
592
|
+
<dd>
|
|
593
|
+
|
|
594
|
+
**after:** `String` — Return results after this cursor. Use `page_info.end_cursor` from the previous response to fetch the next page.
|
|
595
|
+
|
|
596
|
+
</dd>
|
|
597
|
+
</dl>
|
|
598
|
+
|
|
599
|
+
<dl>
|
|
600
|
+
<dd>
|
|
601
|
+
|
|
602
|
+
**last:** `Integer` — Number of results to return from the end of the range.
|
|
603
|
+
|
|
604
|
+
</dd>
|
|
605
|
+
</dl>
|
|
606
|
+
|
|
607
|
+
<dl>
|
|
608
|
+
<dd>
|
|
609
|
+
|
|
610
|
+
**before:** `String` — Return results before this cursor. Use `page_info.start_cursor` from the previous response to fetch the previous page.
|
|
611
|
+
|
|
612
|
+
</dd>
|
|
613
|
+
</dl>
|
|
614
|
+
|
|
615
|
+
<dl>
|
|
616
|
+
<dd>
|
|
617
|
+
|
|
618
|
+
**query:** `String` — The account name to search for.
|
|
619
|
+
|
|
620
|
+
</dd>
|
|
621
|
+
</dl>
|
|
622
|
+
|
|
623
|
+
<dl>
|
|
624
|
+
<dd>
|
|
625
|
+
|
|
626
|
+
**order:** `Whop_sdk::Accounts::Types::SearchAccountsRequestOrder` — Sort field. Without it, support searches return the best match first and other searches return the newest account first.
|
|
627
|
+
|
|
628
|
+
</dd>
|
|
629
|
+
</dl>
|
|
630
|
+
|
|
631
|
+
<dl>
|
|
632
|
+
<dd>
|
|
633
|
+
|
|
634
|
+
**direction:** `Whop_sdk::Accounts::Types::SearchAccountsRequestDirection` — Sort direction.
|
|
635
|
+
|
|
636
|
+
</dd>
|
|
637
|
+
</dl>
|
|
638
|
+
|
|
639
|
+
<dl>
|
|
640
|
+
<dd>
|
|
641
|
+
|
|
642
|
+
**request_options:** `Whop_sdk::Accounts::RequestOptions`
|
|
643
|
+
|
|
644
|
+
</dd>
|
|
645
|
+
</dl>
|
|
646
|
+
</dd>
|
|
647
|
+
</dl>
|
|
648
|
+
|
|
649
|
+
|
|
532
650
|
</dd>
|
|
533
651
|
</dl>
|
|
534
652
|
</details>
|
|
@@ -1067,6 +1185,14 @@ client.accounts.update(id: "id")
|
|
|
1067
1185
|
<dl>
|
|
1068
1186
|
<dd>
|
|
1069
1187
|
|
|
1188
|
+
**whop_partner_enabled:** `Internal::Types::Boolean` — Set to `true` to turn on Whop Partner mode for the account, so its team can refer businesses and the account is paid partner commission on their sales. Recorded once; `false` is rejected.
|
|
1189
|
+
|
|
1190
|
+
</dd>
|
|
1191
|
+
</dl>
|
|
1192
|
+
|
|
1193
|
+
<dl>
|
|
1194
|
+
<dd>
|
|
1195
|
+
|
|
1070
1196
|
**industry_type:** `Object`
|
|
1071
1197
|
|
|
1072
1198
|
</dd>
|
|
@@ -1414,7 +1540,7 @@ client.accounts.suspend(id: "id")
|
|
|
1414
1540
|
<dl>
|
|
1415
1541
|
<dd>
|
|
1416
1542
|
|
|
1417
|
-
Transfers ownership of the account to another user, identified by user ID or email address. If the recipient already holds the owner role, ownership moves immediately; otherwise they get an invite and ownership moves when they accept.
|
|
1543
|
+
Transfers ownership of the account to another user, identified by user ID or email address. If the recipient already holds the owner role, ownership moves immediately; otherwise they get an invite and ownership moves when they accept. The Whop CLI and MCP can hand off a business their user owns as a partner (`as_partner: true`) with the `partner:handoff` scope; other OAuth apps cannot transfer ownership.
|
|
1418
1544
|
</dd>
|
|
1419
1545
|
</dl>
|
|
1420
1546
|
</dd>
|
|
@@ -1566,7 +1692,7 @@ client.ad_campaigns.list
|
|
|
1566
1692
|
<dl>
|
|
1567
1693
|
<dd>
|
|
1568
1694
|
|
|
1569
|
-
**order:** `Whop_sdk::AdCampaigns::Types::ListAdCampaignsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.
|
|
1695
|
+
**order:** `Whop_sdk::AdCampaigns::Types::ListAdCampaignsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports, and link_clicks by the same Whop pixel page views.
|
|
1570
1696
|
|
|
1571
1697
|
</dd>
|
|
1572
1698
|
</dl>
|
|
@@ -3088,7 +3214,7 @@ client.ad_groups.list(ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"])
|
|
|
3088
3214
|
<dl>
|
|
3089
3215
|
<dd>
|
|
3090
3216
|
|
|
3091
|
-
**order:** `Whop_sdk::AdGroups::Types::ListAdGroupsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.
|
|
3217
|
+
**order:** `Whop_sdk::AdGroups::Types::ListAdGroupsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports, and link_clicks by the same Whop pixel page views.
|
|
3092
3218
|
|
|
3093
3219
|
</dd>
|
|
3094
3220
|
</dl>
|
|
@@ -4839,7 +4965,7 @@ client.ads.list(
|
|
|
4839
4965
|
<dl>
|
|
4840
4966
|
<dd>
|
|
4841
4967
|
|
|
4842
|
-
**order:** `Whop_sdk::Ads::Types::ListAdsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports.
|
|
4968
|
+
**order:** `Whop_sdk::Ads::Types::ListAdsRequestOrder` — The field to sort by. Defaults to created_at. Stat columns (spend, impressions, …) rank over the stats_from/stats_to window across the whole list, not just the current page. results, cost_per_result and return_on_ad_spend rank by the same Whop pixel-attributed values the response reports, and link_clicks by the same Whop pixel page views.
|
|
4843
4969
|
|
|
4844
4970
|
</dd>
|
|
4845
4971
|
</dl>
|
|
@@ -14664,7 +14790,7 @@ client.courses.update(id: "cors_xxxxxxxxxxxxx")
|
|
|
14664
14790
|
<dl>
|
|
14665
14791
|
<dd>
|
|
14666
14792
|
|
|
14667
|
-
Returns the deposit methods for an account or user, including crypto addresses, bank transfer instructions, and, for a business, a hosted deposit page. Bitcoin deposits are converted to USDT on Plasma in the destination's wallet. Business destinations require no authentication.
|
|
14793
|
+
Returns the deposit methods for an account or user, including crypto addresses, bank transfer instructions, and, for a business, a hosted deposit page. Bitcoin deposits are converted to USDT on Plasma in the destination's wallet. Business destinations require no authentication. Pass `payment_method_id` to also charge a business's saved payment method for `amount` in USD and add it to the business's balance; that requires authentication with the `payment:charge` scope. The charge has no fees or taxes and does not count as revenue.
|
|
14668
14794
|
</dd>
|
|
14669
14795
|
</dl>
|
|
14670
14796
|
</dd>
|
|
@@ -14694,7 +14820,7 @@ client.deposits.create(destination: "biz_xxxxxxxxxxxxxx")
|
|
|
14694
14820
|
<dl>
|
|
14695
14821
|
<dd>
|
|
14696
14822
|
|
|
14697
|
-
**amount:** `Integer` — Amount to prefill on hosted deposit page. Crypto deposits require a $10 minimum.
|
|
14823
|
+
**amount:** `Integer` — Amount to prefill on hosted deposit page. Crypto deposits require a $10 minimum. With `payment_method_id`, the amount in USD to charge, and required.
|
|
14698
14824
|
|
|
14699
14825
|
</dd>
|
|
14700
14826
|
</dl>
|
|
@@ -14710,6 +14836,14 @@ client.deposits.create(destination: "biz_xxxxxxxxxxxxxx")
|
|
|
14710
14836
|
<dl>
|
|
14711
14837
|
<dd>
|
|
14712
14838
|
|
|
14839
|
+
**payment_method_id:** `String` — A saved payment method of the business to charge for `amount`, prefixed `payt_`. Save one with Create setup intent and `owner_id` set to the account. Only for a `biz_` destination, and requires authentication with the `payment:charge` scope. A declined charge fails the request with 400.
|
|
14840
|
+
|
|
14841
|
+
</dd>
|
|
14842
|
+
</dl>
|
|
14843
|
+
|
|
14844
|
+
<dl>
|
|
14845
|
+
<dd>
|
|
14846
|
+
|
|
14713
14847
|
**request_options:** `Whop_sdk::Deposits::RequestOptions`
|
|
14714
14848
|
|
|
14715
14849
|
</dd>
|
|
@@ -15300,6 +15434,68 @@ client.disputes.update(id: "id")
|
|
|
15300
15434
|
</dl>
|
|
15301
15435
|
|
|
15302
15436
|
|
|
15437
|
+
</dd>
|
|
15438
|
+
</dl>
|
|
15439
|
+
</details>
|
|
15440
|
+
|
|
15441
|
+
<details><summary><code>client.disputes.<a href="/lib/whop_sdk/disputes/client.rb">accept</a>(id:) -> Whop_sdk::Types::Dispute</code></summary>
|
|
15442
|
+
<dl>
|
|
15443
|
+
<dd>
|
|
15444
|
+
|
|
15445
|
+
#### 📝 Description
|
|
15446
|
+
|
|
15447
|
+
<dl>
|
|
15448
|
+
<dd>
|
|
15449
|
+
|
|
15450
|
+
<dl>
|
|
15451
|
+
<dd>
|
|
15452
|
+
|
|
15453
|
+
Accepts a chargeback, conceding it to the customer instead of contesting it. The payment processor closes the dispute as `lost`. This is final — the dispute cannot be contested afterwards. Only a dispute whose `acceptable` is true can be accepted.
|
|
15454
|
+
</dd>
|
|
15455
|
+
</dl>
|
|
15456
|
+
</dd>
|
|
15457
|
+
</dl>
|
|
15458
|
+
|
|
15459
|
+
#### 🔌 Usage
|
|
15460
|
+
|
|
15461
|
+
<dl>
|
|
15462
|
+
<dd>
|
|
15463
|
+
|
|
15464
|
+
<dl>
|
|
15465
|
+
<dd>
|
|
15466
|
+
|
|
15467
|
+
```ruby
|
|
15468
|
+
client.disputes.accept(id: "id")
|
|
15469
|
+
```
|
|
15470
|
+
</dd>
|
|
15471
|
+
</dl>
|
|
15472
|
+
</dd>
|
|
15473
|
+
</dl>
|
|
15474
|
+
|
|
15475
|
+
#### ⚙️ Parameters
|
|
15476
|
+
|
|
15477
|
+
<dl>
|
|
15478
|
+
<dd>
|
|
15479
|
+
|
|
15480
|
+
<dl>
|
|
15481
|
+
<dd>
|
|
15482
|
+
|
|
15483
|
+
**id:** `String` — The dispute ID (`dspt_` tag).
|
|
15484
|
+
|
|
15485
|
+
</dd>
|
|
15486
|
+
</dl>
|
|
15487
|
+
|
|
15488
|
+
<dl>
|
|
15489
|
+
<dd>
|
|
15490
|
+
|
|
15491
|
+
**request_options:** `Whop_sdk::Disputes::RequestOptions`
|
|
15492
|
+
|
|
15493
|
+
</dd>
|
|
15494
|
+
</dl>
|
|
15495
|
+
</dd>
|
|
15496
|
+
</dl>
|
|
15497
|
+
|
|
15498
|
+
|
|
15303
15499
|
</dd>
|
|
15304
15500
|
</dl>
|
|
15305
15501
|
</details>
|
|
@@ -19748,7 +19944,7 @@ client.external_accounts.connect(
|
|
|
19748
19944
|
<dl>
|
|
19749
19945
|
<dd>
|
|
19750
19946
|
|
|
19751
|
-
**platform:** `Whop_sdk::ExternalAccounts::Types::ConnectExternalAccountsRequestPlatform` — The platform to connect the external account on. Use `meta_business` to connect Meta Business assets, which is how Facebook Pages and Instagram accounts are connected — there is no separate `instagram` value. Use `tiktok` for TikTok accounts, `snapchat` for Snapchat Public Profiles, `linkedin` to connect the authenticated user’s LinkedIn profile,
|
|
19947
|
+
**platform:** `Whop_sdk::ExternalAccounts::Types::ConnectExternalAccountsRequestPlatform` — The platform to connect the external account on. Use `meta_business` to connect Meta Business assets, which is how Facebook Pages and Instagram accounts are connected — there is no separate `instagram` value. Use `tiktok` for TikTok accounts, `snapchat` for Snapchat Public Profiles, `linkedin` to connect the authenticated user’s LinkedIn profile, `youtube` to connect their YouTube channel, or `x` to connect their X profile.
|
|
19752
19948
|
|
|
19753
19949
|
</dd>
|
|
19754
19950
|
</dl>
|
|
@@ -19764,7 +19960,7 @@ client.external_accounts.connect(
|
|
|
19764
19960
|
<dl>
|
|
19765
19961
|
<dd>
|
|
19766
19962
|
|
|
19767
|
-
**scopes:** `Internal::Types::Array[Whop_sdk::ExternalAccounts::Types::ConnectExternalAccountsRequestScopesItem]` — The connection purpose. For `meta_business` and `snapchat`, `advertise` is required and connects company advertising assets. For `linkedin` and `
|
|
19963
|
+
**scopes:** `Internal::Types::Array[Whop_sdk::ExternalAccounts::Types::ConnectExternalAccountsRequestScopesItem]` — The connection purpose. For `meta_business` and `snapchat`, `advertise` is required and connects company advertising assets. For `linkedin`, `youtube`, and `x`, omit scopes to connect the authenticated user’s profile; advertising is not supported. For `tiktok`, omit scopes to connect the authenticated user’s profile, or pass `advertise` to connect company advertising assets. Profile connections still request the platform permissions needed to read the profile.
|
|
19768
19964
|
|
|
19769
19965
|
</dd>
|
|
19770
19966
|
</dl>
|
|
@@ -21941,6 +22137,9 @@ client.identity_profiles.retrieve_identity_profile(id: "idpf_xxxxxxxxxxxxx")
|
|
|
21941
22137
|
<dd>
|
|
21942
22138
|
|
|
21943
22139
|
Unlinks an identity profile from the account or user that owns `ledger_account_id`. Requires `identity:write` on that account or user.
|
|
22140
|
+
|
|
22141
|
+
Required permissions:
|
|
22142
|
+
- `identity:write`
|
|
21944
22143
|
</dd>
|
|
21945
22144
|
</dl>
|
|
21946
22145
|
</dd>
|
|
@@ -26267,6 +26466,60 @@ client.partners.create
|
|
|
26267
26466
|
</dl>
|
|
26268
26467
|
|
|
26269
26468
|
|
|
26469
|
+
</dd>
|
|
26470
|
+
</dl>
|
|
26471
|
+
</details>
|
|
26472
|
+
|
|
26473
|
+
<details><summary><code>client.partners.<a href="/lib/whop_sdk/partners/client.rb">fee_options</a>() -> Whop_sdk::Partners::Types::FeeOptionsPartnersResponse</code></summary>
|
|
26474
|
+
<dl>
|
|
26475
|
+
<dd>
|
|
26476
|
+
|
|
26477
|
+
#### 📝 Description
|
|
26478
|
+
|
|
26479
|
+
<dl>
|
|
26480
|
+
<dd>
|
|
26481
|
+
|
|
26482
|
+
<dl>
|
|
26483
|
+
<dd>
|
|
26484
|
+
|
|
26485
|
+
Lists, per income stream, the fee a business the caller refers would be charged, how low the caller may price it, and the commission the caller earns on that stream. Answers for a referral that does not exist yet, so a referral flow can price the deal before the business is created. Requires `partner:fees:update`, since the floors a partner may price down to are only for a credential that can set them.
|
|
26486
|
+
</dd>
|
|
26487
|
+
</dl>
|
|
26488
|
+
</dd>
|
|
26489
|
+
</dl>
|
|
26490
|
+
|
|
26491
|
+
#### 🔌 Usage
|
|
26492
|
+
|
|
26493
|
+
<dl>
|
|
26494
|
+
<dd>
|
|
26495
|
+
|
|
26496
|
+
<dl>
|
|
26497
|
+
<dd>
|
|
26498
|
+
|
|
26499
|
+
```ruby
|
|
26500
|
+
client.partners.fee_options
|
|
26501
|
+
```
|
|
26502
|
+
</dd>
|
|
26503
|
+
</dl>
|
|
26504
|
+
</dd>
|
|
26505
|
+
</dl>
|
|
26506
|
+
|
|
26507
|
+
#### ⚙️ Parameters
|
|
26508
|
+
|
|
26509
|
+
<dl>
|
|
26510
|
+
<dd>
|
|
26511
|
+
|
|
26512
|
+
<dl>
|
|
26513
|
+
<dd>
|
|
26514
|
+
|
|
26515
|
+
**request_options:** `Whop_sdk::Partners::RequestOptions`
|
|
26516
|
+
|
|
26517
|
+
</dd>
|
|
26518
|
+
</dl>
|
|
26519
|
+
</dd>
|
|
26520
|
+
</dl>
|
|
26521
|
+
|
|
26522
|
+
|
|
26270
26523
|
</dd>
|
|
26271
26524
|
</dl>
|
|
26272
26525
|
</details>
|
|
@@ -26558,7 +26811,7 @@ client.partners.retrieve(id: "me")
|
|
|
26558
26811
|
<dl>
|
|
26559
26812
|
<dd>
|
|
26560
26813
|
|
|
26561
|
-
Lists the payment method domains registered for your account and its connected accounts.
|
|
26814
|
+
Lists the payment method domains registered for your account and its connected accounts. Deprecated: list domains with `GET /domains` and the `apple_pay` filter instead.
|
|
26562
26815
|
</dd>
|
|
26563
26816
|
</dl>
|
|
26564
26817
|
</dd>
|
|
@@ -26708,7 +26961,7 @@ client.payment_method_domains.list
|
|
|
26708
26961
|
<dl>
|
|
26709
26962
|
<dd>
|
|
26710
26963
|
|
|
26711
|
-
Registers a hostname with the wallet provider and attempts verification inline. Returns `verified` when the provider fetched the domain-association file (for Apple Pay, `/.well-known/apple-developer-merchantid-domain-association`), or `pending` when it could not: host the file, then retry with `POST /payment_method_domains/:id/verify`.
|
|
26964
|
+
Registers a hostname with the wallet provider and attempts verification inline. Returns `verified` when the provider fetched the domain-association file (for Apple Pay, `/.well-known/apple-developer-merchantid-domain-association`), or `pending` when it could not: host the file, then retry with `POST /payment_method_domains/:id/verify`. Deprecated: add Apple Pay with `POST /domains` and `apple_pay: {}` instead.
|
|
26712
26965
|
</dd>
|
|
26713
26966
|
</dl>
|
|
26714
26967
|
</dd>
|
|
@@ -26778,7 +27031,7 @@ client.payment_method_domains.create(hostname: "pending.shinetime.com")
|
|
|
26778
27031
|
<dl>
|
|
26779
27032
|
<dd>
|
|
26780
27033
|
|
|
26781
|
-
Retrieves a payment method domain to check its verification status.
|
|
27034
|
+
Retrieves a payment method domain to check its verification status. Deprecated: retrieve the domain with `GET /domains/{id}` instead, using the same ID.
|
|
26782
27035
|
</dd>
|
|
26783
27036
|
</dl>
|
|
26784
27037
|
</dd>
|
|
@@ -26840,7 +27093,7 @@ client.payment_method_domains.retrieve(id: "id")
|
|
|
26840
27093
|
<dl>
|
|
26841
27094
|
<dd>
|
|
26842
27095
|
|
|
26843
|
-
Unregisters a payment method domain so its wallet payment methods stop rendering there.
|
|
27096
|
+
Unregisters a payment method domain so its wallet payment methods stop rendering there. Deprecated: remove Apple Pay with `PATCH /domains/{id}` and `apple_pay: null` instead. `DELETE /domains/{id}` removes the whole domain, including any website on it.
|
|
26844
27097
|
</dd>
|
|
26845
27098
|
</dl>
|
|
26846
27099
|
</dd>
|
|
@@ -26902,7 +27155,7 @@ client.payment_method_domains.delete(id: "id")
|
|
|
26902
27155
|
<dl>
|
|
26903
27156
|
<dd>
|
|
26904
27157
|
|
|
26905
|
-
Re-attempts provider verification of a pending domain once the association file is hosted. Fails with a `bad_request` explaining what to fix; verifying an already `verified` domain is a no-op.
|
|
27158
|
+
Re-attempts provider verification of a pending domain once the association file is hosted. Fails with a `bad_request` explaining what to fix; verifying an already `verified` domain is a no-op. Deprecated: check the domain with `POST /domains/{id}/check` instead.
|
|
26906
27159
|
</dd>
|
|
26907
27160
|
</dl>
|
|
26908
27161
|
</dd>
|
|
@@ -28952,6 +29205,14 @@ client.payments.refund(id: "id")
|
|
|
28952
29205
|
<dl>
|
|
28953
29206
|
<dd>
|
|
28954
29207
|
|
|
29208
|
+
**metadata:** `Internal::Types::Hash[String, String]` — Your own key-value data to attach to the refund, returned on it and on its `refund.created` and `refund.updated` webhooks. At most 50 keys; keys up to 100 characters and values up to 500.
|
|
29209
|
+
|
|
29210
|
+
</dd>
|
|
29211
|
+
</dl>
|
|
29212
|
+
|
|
29213
|
+
<dl>
|
|
29214
|
+
<dd>
|
|
29215
|
+
|
|
28955
29216
|
**partial_amount:** `Integer` — The amount to refund, stated in this payment's `currency` like every other amount on it. When the buyer was billed in a different currency, it is converted at the payment's own exchange rate before the refund is issued. An amount that covers everything still refundable refunds the rest of the payment — omit it to refund the rest without having to work out what that is.
|
|
28956
29217
|
|
|
28957
29218
|
</dd>
|
|
@@ -29971,7 +30232,7 @@ client.payouts.create_quote(
|
|
|
29971
30232
|
<dl>
|
|
29972
30233
|
<dd>
|
|
29973
30234
|
|
|
29974
|
-
Retrieves a payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a
|
|
30235
|
+
Retrieves a payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a payout carries as `payout_request_id`. Authentication is optional: anyone with the ID can view tracking details, including notes, trace code, exchange rate, and payout request ID, while accounting fields require `payout:withdrawal:read` on the account or user that owns the payout. A supplied invalid credential returns 401.
|
|
29975
30236
|
</dd>
|
|
29976
30237
|
</dl>
|
|
29977
30238
|
</dd>
|
|
@@ -30049,7 +30310,7 @@ client.payouts.retrieve(id: "id")
|
|
|
30049
30310
|
<dl>
|
|
30050
30311
|
<dd>
|
|
30051
30312
|
|
|
30052
|
-
Cancels a payout
|
|
30313
|
+
Cancels a payout before it is sent to the payout provider, or asks the provider to stop one already sent. While the payout is `in_review`, or `processing` with nothing sent yet (see `cancelable`), it is canceled and the funds, fees included, return to the balance. Once sent, the response is 202 with a `cancellation` object, and the payout reads `canceled` only if the provider confirms it stopped. A `requested` payout returns 409 until it reaches review, a payout the provider can no longer stop returns 409 with error type `not_cancelable`, and canceling an already-canceled payout returns it unchanged.
|
|
30053
30314
|
</dd>
|
|
30054
30315
|
</dl>
|
|
30055
30316
|
</dd>
|
|
@@ -35149,6 +35410,14 @@ client.setup_intents.create(account_id: "biz_xxxxxxxxxxxxxx")
|
|
|
35149
35410
|
<dl>
|
|
35150
35411
|
<dd>
|
|
35151
35412
|
|
|
35413
|
+
**owner_id:** `String` — Who the saved payment method belongs to. Pass `account_id` to save it on the account itself, which needs `payment:charge` on the account. Pass your own user ID, prefixed `user_`, to save it on the authenticated user. Omit it to save it on the buyer: the caller when it is the buyer, otherwise the user the confirmation token names. Not available with `payment_method_id`, which keeps its current owner, or with `purpose`.
|
|
35414
|
+
|
|
35415
|
+
</dd>
|
|
35416
|
+
</dl>
|
|
35417
|
+
|
|
35418
|
+
<dl>
|
|
35419
|
+
<dd>
|
|
35420
|
+
|
|
35152
35421
|
**payment_method_id:** `String` — An existing payment method to re-verify and save, prefixed `payt_`. Provide this or `confirmation_token`, not both. Not available to a buyer credential.
|
|
35153
35422
|
|
|
35154
35423
|
</dd>
|
|
@@ -36023,7 +36292,7 @@ client.social_accounts.connect(
|
|
|
36023
36292
|
<dl>
|
|
36024
36293
|
<dd>
|
|
36025
36294
|
|
|
36026
|
-
**platform:** `Whop_sdk::SocialAccounts::Types::ConnectSocialAccountsRequestPlatform` — The platform to connect the external account on. Use `meta_business` to connect Meta Business assets, which is how Facebook Pages and Instagram accounts are connected — there is no separate `instagram` value. Use `tiktok` for TikTok accounts, `snapchat` for Snapchat Public Profiles, `linkedin` to connect the authenticated user’s LinkedIn profile,
|
|
36295
|
+
**platform:** `Whop_sdk::SocialAccounts::Types::ConnectSocialAccountsRequestPlatform` — The platform to connect the external account on. Use `meta_business` to connect Meta Business assets, which is how Facebook Pages and Instagram accounts are connected — there is no separate `instagram` value. Use `tiktok` for TikTok accounts, `snapchat` for Snapchat Public Profiles, `linkedin` to connect the authenticated user’s LinkedIn profile, `youtube` to connect their YouTube channel, or `x` to connect their X profile.
|
|
36027
36296
|
|
|
36028
36297
|
</dd>
|
|
36029
36298
|
</dl>
|
|
@@ -36039,7 +36308,7 @@ client.social_accounts.connect(
|
|
|
36039
36308
|
<dl>
|
|
36040
36309
|
<dd>
|
|
36041
36310
|
|
|
36042
|
-
**scopes:** `Internal::Types::Array[Whop_sdk::SocialAccounts::Types::ConnectSocialAccountsRequestScopesItem]` — The connection purpose. For `meta_business` and `snapchat`, `advertise` is required and connects company advertising assets. For `linkedin` and `
|
|
36311
|
+
**scopes:** `Internal::Types::Array[Whop_sdk::SocialAccounts::Types::ConnectSocialAccountsRequestScopesItem]` — The connection purpose. For `meta_business` and `snapchat`, `advertise` is required and connects company advertising assets. For `linkedin`, `youtube`, and `x`, omit scopes to connect the authenticated user’s profile; advertising is not supported. For `tiktok`, omit scopes to connect the authenticated user’s profile, or pass `advertise` to connect company advertising assets. Profile connections still request the platform permissions needed to read the profile.
|
|
36043
36312
|
|
|
36044
36313
|
</dd>
|
|
36045
36314
|
</dl>
|
|
@@ -37025,6 +37294,14 @@ client.stats.retrieve(
|
|
|
37025
37294
|
<dl>
|
|
37026
37295
|
<dd>
|
|
37027
37296
|
|
|
37297
|
+
**product_category:** `String` — Filter to one product category, for example `algo_trading_course`. Pair with `breakdown_by=product_category` to split by product category. Available on metrics that list `product_category`.
|
|
37298
|
+
|
|
37299
|
+
</dd>
|
|
37300
|
+
</dl>
|
|
37301
|
+
|
|
37302
|
+
<dl>
|
|
37303
|
+
<dd>
|
|
37304
|
+
|
|
37028
37305
|
**issuer:** `String` — Filter to one card-issuing bank, named as the processor reports it, for example JPMORGAN CHASE BANK N A, or unknown for payments with no reported bank. Available on metrics that list issuer.
|
|
37029
37306
|
|
|
37030
37307
|
</dd>
|
|
@@ -37415,6 +37692,14 @@ client.support_channels.list(
|
|
|
37415
37692
|
<dl>
|
|
37416
37693
|
<dd>
|
|
37417
37694
|
|
|
37695
|
+
**customer_user_ids:** `String` — Only return support channels opened by any of these customers. Maximum 100 IDs per request.
|
|
37696
|
+
|
|
37697
|
+
</dd>
|
|
37698
|
+
</dl>
|
|
37699
|
+
|
|
37700
|
+
<dl>
|
|
37701
|
+
<dd>
|
|
37702
|
+
|
|
37418
37703
|
**participated:** `Internal::Types::Boolean` — Set to true to only return channels the authenticated user has joined as a participant. Requires a user.
|
|
37419
37704
|
|
|
37420
37705
|
</dd>
|
|
@@ -38037,7 +38322,7 @@ client.swaps.retrieve(id: "id")
|
|
|
38037
38322
|
<dl>
|
|
38038
38323
|
<dd>
|
|
38039
38324
|
|
|
38040
|
-
Lists an account's team members, including pending invites. A user credential with `company:basic:read` may list only its own joined membership by passing its own `user_id` and `status=joined`. Listing `role=workforce` is also allowed with the `bounty:create` scope.
|
|
38325
|
+
Lists an account's team members, including pending invites. A user credential with `company:basic:read` may list only its own joined membership by passing its own `user_id` and `status=joined`. Listing `role=workforce` is also allowed with the `bounty:create` scope. Members with the view-only Partner role are listed after all other members.
|
|
38041
38326
|
</dd>
|
|
38042
38327
|
</dl>
|
|
38043
38328
|
</dd>
|
|
@@ -38099,6 +38384,38 @@ client.team_members.list(account_id: "account_id")
|
|
|
38099
38384
|
<dl>
|
|
38100
38385
|
<dd>
|
|
38101
38386
|
|
|
38387
|
+
**query:** `String` — Only return members whose name or username contains this text, and invites whose email contains it.
|
|
38388
|
+
|
|
38389
|
+
</dd>
|
|
38390
|
+
</dl>
|
|
38391
|
+
|
|
38392
|
+
<dl>
|
|
38393
|
+
<dd>
|
|
38394
|
+
|
|
38395
|
+
**reports_to_id:** `String` — Only return the direct reports of this team member, prefixed `ausr_`. Pass the account ID, prefixed `biz_`, for the members who report to the business directly. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last.
|
|
38396
|
+
|
|
38397
|
+
</dd>
|
|
38398
|
+
</dl>
|
|
38399
|
+
|
|
38400
|
+
<dl>
|
|
38401
|
+
<dd>
|
|
38402
|
+
|
|
38403
|
+
**direct_reports_min:** `Integer` — Only return members with at least this many direct reports. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last.
|
|
38404
|
+
|
|
38405
|
+
</dd>
|
|
38406
|
+
</dl>
|
|
38407
|
+
|
|
38408
|
+
<dl>
|
|
38409
|
+
<dd>
|
|
38410
|
+
|
|
38411
|
+
**direct_reports_max:** `Integer` — Only return members with at most this many direct reports; `0` returns the people who manage no one. Pending invites are excluded, and the list pages in `created_at` order without moving Partner-role members last.
|
|
38412
|
+
|
|
38413
|
+
</dd>
|
|
38414
|
+
</dl>
|
|
38415
|
+
|
|
38416
|
+
<dl>
|
|
38417
|
+
<dd>
|
|
38418
|
+
|
|
38102
38419
|
**created_before:** `String` — Only return members added before this ISO 8601 timestamp.
|
|
38103
38420
|
|
|
38104
38421
|
</dd>
|
|
@@ -38115,7 +38432,7 @@ client.team_members.list(account_id: "account_id")
|
|
|
38115
38432
|
<dl>
|
|
38116
38433
|
<dd>
|
|
38117
38434
|
|
|
38118
|
-
**order:** `Whop_sdk::TeamMembers::Types::ListTeamMembersRequestOrder` — Field used to sort members.
|
|
38435
|
+
**order:** `Whop_sdk::TeamMembers::Types::ListTeamMembersRequestOrder` — Field used to sort members. Members with the view-only Partner role are listed after all other members whichever way the list is sorted.
|
|
38119
38436
|
|
|
38120
38437
|
</dd>
|
|
38121
38438
|
</dl>
|
|
@@ -38454,101 +38771,6 @@ client.team_members.update(id: "id")
|
|
|
38454
38771
|
</dl>
|
|
38455
38772
|
|
|
38456
38773
|
|
|
38457
|
-
</dd>
|
|
38458
|
-
</dl>
|
|
38459
|
-
</details>
|
|
38460
|
-
|
|
38461
|
-
## Topups
|
|
38462
|
-
<details><summary><code>client.topups.<a href="/lib/whop_sdk/topups/client.rb">create</a>(request) -> Whop_sdk::Types::Topup</code></summary>
|
|
38463
|
-
<dl>
|
|
38464
|
-
<dd>
|
|
38465
|
-
|
|
38466
|
-
#### 📝 Description
|
|
38467
|
-
|
|
38468
|
-
<dl>
|
|
38469
|
-
<dd>
|
|
38470
|
-
|
|
38471
|
-
<dl>
|
|
38472
|
-
<dd>
|
|
38473
|
-
|
|
38474
|
-
Add funds to an account's platform balance by charging a stored payment method. Top-ups have no fees or taxes and do not count as revenue.
|
|
38475
|
-
|
|
38476
|
-
Required permissions:
|
|
38477
|
-
- `payment:charge`
|
|
38478
|
-
</dd>
|
|
38479
|
-
</dl>
|
|
38480
|
-
</dd>
|
|
38481
|
-
</dl>
|
|
38482
|
-
|
|
38483
|
-
#### 🔌 Usage
|
|
38484
|
-
|
|
38485
|
-
<dl>
|
|
38486
|
-
<dd>
|
|
38487
|
-
|
|
38488
|
-
<dl>
|
|
38489
|
-
<dd>
|
|
38490
|
-
|
|
38491
|
-
```ruby
|
|
38492
|
-
client.topups.create(
|
|
38493
|
-
account_id: "biz_xxxxxxxxxxxxxx",
|
|
38494
|
-
amount: 6.9,
|
|
38495
|
-
currency: "usd",
|
|
38496
|
-
payment_method_id: "pmt_xxxxxxxxxxxxxx"
|
|
38497
|
-
)
|
|
38498
|
-
```
|
|
38499
|
-
</dd>
|
|
38500
|
-
</dl>
|
|
38501
|
-
</dd>
|
|
38502
|
-
</dl>
|
|
38503
|
-
|
|
38504
|
-
#### ⚙️ Parameters
|
|
38505
|
-
|
|
38506
|
-
<dl>
|
|
38507
|
-
<dd>
|
|
38508
|
-
|
|
38509
|
-
<dl>
|
|
38510
|
-
<dd>
|
|
38511
|
-
|
|
38512
|
-
**account_id:** `String` — The unique identifier of the company to add funds to, starting with 'biz_'.
|
|
38513
|
-
|
|
38514
|
-
</dd>
|
|
38515
|
-
</dl>
|
|
38516
|
-
|
|
38517
|
-
<dl>
|
|
38518
|
-
<dd>
|
|
38519
|
-
|
|
38520
|
-
**amount:** `Integer` — The amount to add to the balance in the specified currency. For example, 50.00 for $50.00 USD.
|
|
38521
|
-
|
|
38522
|
-
</dd>
|
|
38523
|
-
</dl>
|
|
38524
|
-
|
|
38525
|
-
<dl>
|
|
38526
|
-
<dd>
|
|
38527
|
-
|
|
38528
|
-
**currency:** `Whop_sdk::Types::Currencies` — The currency for the top-up amount, such as 'usd'.
|
|
38529
|
-
|
|
38530
|
-
</dd>
|
|
38531
|
-
</dl>
|
|
38532
|
-
|
|
38533
|
-
<dl>
|
|
38534
|
-
<dd>
|
|
38535
|
-
|
|
38536
|
-
**payment_method_id:** `String` — The unique identifier of the stored payment method to charge for the top-up.
|
|
38537
|
-
|
|
38538
|
-
</dd>
|
|
38539
|
-
</dl>
|
|
38540
|
-
|
|
38541
|
-
<dl>
|
|
38542
|
-
<dd>
|
|
38543
|
-
|
|
38544
|
-
**request_options:** `Whop_sdk::Topups::RequestOptions`
|
|
38545
|
-
|
|
38546
|
-
</dd>
|
|
38547
|
-
</dl>
|
|
38548
|
-
</dd>
|
|
38549
|
-
</dl>
|
|
38550
|
-
|
|
38551
|
-
|
|
38552
38774
|
</dd>
|
|
38553
38775
|
</dl>
|
|
38554
38776
|
</details>
|
|
@@ -38749,7 +38971,7 @@ client.trades.create(
|
|
|
38749
38971
|
<dl>
|
|
38750
38972
|
<dd>
|
|
38751
38973
|
|
|
38752
|
-
**instrument_type:** `Whop_sdk::Trades::Types::CreateTradesRequestInstrumentType` — `perpetual` or `spot`. Required for an order.
|
|
38974
|
+
**instrument_type:** `Whop_sdk::Trades::Types::CreateTradesRequestInstrumentType` — `perpetual` or `spot`. Required for an order. A spot order first switches the trading account to Hyperliquid's unified account mode, where spot and perpetuals share one USDC balance.
|
|
38753
38975
|
|
|
38754
38976
|
</dd>
|
|
38755
38977
|
</dl>
|
|
@@ -39066,7 +39288,7 @@ client.transfers.list
|
|
|
39066
39288
|
<dl>
|
|
39067
39289
|
<dd>
|
|
39068
39290
|
|
|
39069
|
-
Moves money between Whop balances
|
|
39291
|
+
Moves money between Whop balances or funds a claim link anyone with the URL can redeem. The `type` you send decides which object comes back.
|
|
39070
39292
|
</dd>
|
|
39071
39293
|
</dl>
|
|
39072
39294
|
</dd>
|
|
@@ -41041,7 +41263,7 @@ client.verifications.list
|
|
|
41041
41263
|
<dl>
|
|
41042
41264
|
<dd>
|
|
41043
41265
|
|
|
41044
|
-
Starts a hosted verification session for an account or user, or returns the active session when one already exists; any fields you send prefill it. To skip the hosted session, send `documents` to verify the person from files in this request, `share_token` to reuse a verification another Sumsub account completed, or `verification_id` to reuse one the signed-in user completed on Whop. For a business, `documents`
|
|
41266
|
+
Starts a hosted verification session for an account or user, or returns the active session when one already exists; any fields you send prefill it. To skip the hosted session, send `documents` to verify the person from files in this request, `share_token` to reuse a verification another Sumsub account completed, or `verification_id` to reuse one the signed-in user completed on Whop. For a business, `documents` and `owners` add company formation documents and owners to the verification, and once everything is in this call sends the business for review — call it again after Update Verification to send it. Until then it stays `pending` and the hosted session collects anything left out. Once the account has an `approved` verification, every mode except `verification_id` is rejected — unlink it first to start a new one.
|
|
41045
41267
|
</dd>
|
|
41046
41268
|
</dl>
|
|
41047
41269
|
</dd>
|
|
@@ -41181,7 +41403,7 @@ client.verifications.retrieve(id: "id")
|
|
|
41181
41403
|
<dl>
|
|
41182
41404
|
<dd>
|
|
41183
41405
|
|
|
41184
|
-
Updates editable profile details or submits answers for items returned in `requested_information`. Once a verification is `approved` its profile details are locked and can no longer be edited.
|
|
41406
|
+
Updates editable profile details or submits answers for items returned in `requested_information`. On a business verification still collecting details, company details, `documents`, and `owners` also go to the verification provider; call Create Verification again to send the business for review once everything is in. Under review, `registration_number`, `incorporation_date`, `place_of_incorporation`, and `documents` are refused. While the review waits on owners, owners can still be added, changed, or removed with `remove`; otherwise only an owner's missing documents can still be sent. Once a verification is `approved` its profile details are locked and can no longer be edited.
|
|
41185
41407
|
</dd>
|
|
41186
41408
|
</dl>
|
|
41187
41409
|
</dd>
|
|
@@ -45416,7 +45638,7 @@ client.partners.businesses.list
|
|
|
45416
45638
|
<dl>
|
|
45417
45639
|
<dd>
|
|
45418
45640
|
|
|
45419
|
-
Retrieves a single referred business and its referral terms.
|
|
45641
|
+
Retrieves a single referred business and its referral terms. The original referrer or a caller with company:basic:read on the business credited for the referral can read it.
|
|
45420
45642
|
</dd>
|
|
45421
45643
|
</dl>
|
|
45422
45644
|
</dd>
|
|
@@ -45478,7 +45700,7 @@ client.partners.businesses.retrieve(id: "id")
|
|
|
45478
45700
|
<dl>
|
|
45479
45701
|
<dd>
|
|
45480
45702
|
|
|
45481
|
-
Save annual projections for a business referred by the authenticated partner.
|
|
45703
|
+
Save annual payment projections for a business referred by the authenticated partner. Unaccepted projections can be replaced with updated annual card and BNPL payment volume. To qualify, payment volume over the last 30 days must reach 5% of the annual payment projection. Ads are excluded from CPA; ordinary ad commissions continue. Pass withdraw_projections: true without projection amounts to remove unaccepted projections. Accepted projections are immutable. Public API access requires a partner OAuth token; business API keys are not supported.
|
|
45482
45704
|
</dd>
|
|
45483
45705
|
</dl>
|
|
45484
45706
|
</dd>
|
|
@@ -45493,11 +45715,7 @@ Save annual projections for a business referred by the authenticated partner. Pr
|
|
|
45493
45715
|
<dd>
|
|
45494
45716
|
|
|
45495
45717
|
```ruby
|
|
45496
|
-
client.partners.businesses.update(
|
|
45497
|
-
id: "id",
|
|
45498
|
-
annual_ads_usd: "120000",
|
|
45499
|
-
annual_processing_usd: "1200000"
|
|
45500
|
-
)
|
|
45718
|
+
client.partners.businesses.update(id: "id")
|
|
45501
45719
|
```
|
|
45502
45720
|
</dd>
|
|
45503
45721
|
</dl>
|
|
@@ -45520,7 +45738,7 @@ client.partners.businesses.update(
|
|
|
45520
45738
|
<dl>
|
|
45521
45739
|
<dd>
|
|
45522
45740
|
|
|
45523
|
-
**
|
|
45741
|
+
**annual_processing_usd:** `String` — Annual projected card and BNPL processing combined, in USD.
|
|
45524
45742
|
|
|
45525
45743
|
</dd>
|
|
45526
45744
|
</dl>
|
|
@@ -45528,7 +45746,7 @@ client.partners.businesses.update(
|
|
|
45528
45746
|
<dl>
|
|
45529
45747
|
<dd>
|
|
45530
45748
|
|
|
45531
|
-
**
|
|
45749
|
+
**withdraw_projections:** `Internal::Types::Boolean` — Remove unaccepted projections and invalidate the offer. The original CPA term is retained if projections are later added again.
|
|
45532
45750
|
|
|
45533
45751
|
</dd>
|
|
45534
45752
|
</dl>
|
|
@@ -45578,7 +45796,7 @@ Accept the authenticated partner's CPA offer with the reviewed terms and signed
|
|
|
45578
45796
|
client.partners.businesses.accept_commission_advance(
|
|
45579
45797
|
id: "id",
|
|
45580
45798
|
acknowledgments: %w[commission_replacement clawback term],
|
|
45581
|
-
expected_amount_usd: "
|
|
45799
|
+
expected_amount_usd: "1079.99",
|
|
45582
45800
|
offer_token: "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
|
|
45583
45801
|
terms_version: "2026-01-01"
|
|
45584
45802
|
)
|
|
@@ -45644,6 +45862,79 @@ client.partners.businesses.accept_commission_advance(
|
|
|
45644
45862
|
</dl>
|
|
45645
45863
|
|
|
45646
45864
|
|
|
45865
|
+
</dd>
|
|
45866
|
+
</dl>
|
|
45867
|
+
</details>
|
|
45868
|
+
|
|
45869
|
+
<details><summary><code>client.partners.businesses.<a href="/lib/whop_sdk/partners/businesses/client.rb">resend_invite</a>(id:, request) -> Whop_sdk::Partners::Businesses::Types::ResendInviteBusinessesResponse</code></summary>
|
|
45870
|
+
<dl>
|
|
45871
|
+
<dd>
|
|
45872
|
+
|
|
45873
|
+
#### 📝 Description
|
|
45874
|
+
|
|
45875
|
+
<dl>
|
|
45876
|
+
<dd>
|
|
45877
|
+
|
|
45878
|
+
<dl>
|
|
45879
|
+
<dd>
|
|
45880
|
+
|
|
45881
|
+
Re-emails an outstanding invite to claim ownership of a referred business. Find the invite in the business's `pending_owner_invites`. Only the first-tier partner can resend, from a whop.com session or the Whop CLI or MCP with `partner:handoff`. Rate limited to one resend per invite every five minutes.
|
|
45882
|
+
</dd>
|
|
45883
|
+
</dl>
|
|
45884
|
+
</dd>
|
|
45885
|
+
</dl>
|
|
45886
|
+
|
|
45887
|
+
#### 🔌 Usage
|
|
45888
|
+
|
|
45889
|
+
<dl>
|
|
45890
|
+
<dd>
|
|
45891
|
+
|
|
45892
|
+
<dl>
|
|
45893
|
+
<dd>
|
|
45894
|
+
|
|
45895
|
+
```ruby
|
|
45896
|
+
client.partners.businesses.resend_invite(
|
|
45897
|
+
id: "id",
|
|
45898
|
+
invite_id: "ausri_xxxxxxxxxxxxxx"
|
|
45899
|
+
)
|
|
45900
|
+
```
|
|
45901
|
+
</dd>
|
|
45902
|
+
</dl>
|
|
45903
|
+
</dd>
|
|
45904
|
+
</dl>
|
|
45905
|
+
|
|
45906
|
+
#### ⚙️ Parameters
|
|
45907
|
+
|
|
45908
|
+
<dl>
|
|
45909
|
+
<dd>
|
|
45910
|
+
|
|
45911
|
+
<dl>
|
|
45912
|
+
<dd>
|
|
45913
|
+
|
|
45914
|
+
**id:** `String` — The partner business ID (a coma_ identifier).
|
|
45915
|
+
|
|
45916
|
+
</dd>
|
|
45917
|
+
</dl>
|
|
45918
|
+
|
|
45919
|
+
<dl>
|
|
45920
|
+
<dd>
|
|
45921
|
+
|
|
45922
|
+
**invite_id:** `String` — The outstanding invite to resend (an ausri_ identifier from `pending_owner_invites`).
|
|
45923
|
+
|
|
45924
|
+
</dd>
|
|
45925
|
+
</dl>
|
|
45926
|
+
|
|
45927
|
+
<dl>
|
|
45928
|
+
<dd>
|
|
45929
|
+
|
|
45930
|
+
**request_options:** `Whop_sdk::Partners::Businesses::RequestOptions`
|
|
45931
|
+
|
|
45932
|
+
</dd>
|
|
45933
|
+
</dl>
|
|
45934
|
+
</dd>
|
|
45935
|
+
</dl>
|
|
45936
|
+
|
|
45937
|
+
|
|
45647
45938
|
</dd>
|
|
45648
45939
|
</dl>
|
|
45649
45940
|
</details>
|
|
@@ -45661,7 +45952,7 @@ client.partners.businesses.accept_commission_advance(
|
|
|
45661
45952
|
<dl>
|
|
45662
45953
|
<dd>
|
|
45663
45954
|
|
|
45664
|
-
Lists the earnings Whop pays out for one referred business's activity, most recent first.
|
|
45955
|
+
Lists the earnings Whop pays out for one referred business's activity, most recent first. The original referrer or a caller with company:basic:read on the business credited for the referral can read them.
|
|
45665
45956
|
</dd>
|
|
45666
45957
|
</dl>
|
|
45667
45958
|
</dd>
|
|
@@ -46804,7 +47095,7 @@ client.stats.reports.list
|
|
|
46804
47095
|
<dl>
|
|
46805
47096
|
<dd>
|
|
46806
47097
|
|
|
46807
|
-
Retrieves payments across all of Whop for up to four windows at once, optionally broken down by business type, industry type, account country or customer country. The report covers the whole platform, so it takes no `account_id` and any authenticated caller can read it.
|
|
47098
|
+
Retrieves payments across all of Whop for up to four windows at once, optionally broken down by business type, industry type, product category, account country or customer country. The report covers the whole platform, so it takes no `account_id` and any authenticated caller can read it.
|
|
46808
47099
|
</dd>
|
|
46809
47100
|
</dl>
|
|
46810
47101
|
</dd>
|
|
@@ -46906,6 +47197,14 @@ client.stats.reports.platform_trends
|
|
|
46906
47197
|
<dl>
|
|
46907
47198
|
<dd>
|
|
46908
47199
|
|
|
47200
|
+
**product_category:** `String` — Only counts payments for products in these comma-separated product categories, such as `algo_trading_course`.
|
|
47201
|
+
|
|
47202
|
+
</dd>
|
|
47203
|
+
</dl>
|
|
47204
|
+
|
|
47205
|
+
<dl>
|
|
47206
|
+
<dd>
|
|
47207
|
+
|
|
46909
47208
|
**account_country:** `String` — Only counts payments to accounts located in these comma-separated countries, as ISO 3166-1 alpha-2 codes such as `US`.
|
|
46910
47209
|
|
|
46911
47210
|
</dd>
|
|
@@ -47350,6 +47649,14 @@ client.stats.time_series.retrieve(
|
|
|
47350
47649
|
<dl>
|
|
47351
47650
|
<dd>
|
|
47352
47651
|
|
|
47652
|
+
**product_category:** `String` — Filter to one product category, for example `algo_trading_course`. Pair with `breakdown_by=product_category` to split by product category. Available on metrics that list `product_category`.
|
|
47653
|
+
|
|
47654
|
+
</dd>
|
|
47655
|
+
</dl>
|
|
47656
|
+
|
|
47657
|
+
<dl>
|
|
47658
|
+
<dd>
|
|
47659
|
+
|
|
47353
47660
|
**issuer:** `String` — Filter to one card-issuing bank, named as the processor reports it, for example JPMORGAN CHASE BANK N A, or unknown for payments with no reported bank. Available on metrics that list issuer.
|
|
47354
47661
|
|
|
47355
47662
|
</dd>
|
|
@@ -48383,6 +48690,69 @@ client.users.preferences.update
|
|
|
48383
48690
|
</dl>
|
|
48384
48691
|
|
|
48385
48692
|
|
|
48693
|
+
</dd>
|
|
48694
|
+
</dl>
|
|
48695
|
+
</details>
|
|
48696
|
+
|
|
48697
|
+
## Users Fees
|
|
48698
|
+
<details><summary><code>client.users.fees.<a href="/lib/whop_sdk/users/fees/client.rb">retrieve</a>(user_id:) -> Whop_sdk::Types::UserFees</code></summary>
|
|
48699
|
+
<dl>
|
|
48700
|
+
<dd>
|
|
48701
|
+
|
|
48702
|
+
#### 📝 Description
|
|
48703
|
+
|
|
48704
|
+
<dl>
|
|
48705
|
+
<dd>
|
|
48706
|
+
|
|
48707
|
+
<dl>
|
|
48708
|
+
<dd>
|
|
48709
|
+
|
|
48710
|
+
Retrieves the fees charged when the user moves money with their personal balance: withdrawals, transfers, bank deposits, and funding cards from pending balance. Each fee has the same shape as in Retrieve Account Fees. You can only retrieve your own fees, and they are read-only.
|
|
48711
|
+
</dd>
|
|
48712
|
+
</dl>
|
|
48713
|
+
</dd>
|
|
48714
|
+
</dl>
|
|
48715
|
+
|
|
48716
|
+
#### 🔌 Usage
|
|
48717
|
+
|
|
48718
|
+
<dl>
|
|
48719
|
+
<dd>
|
|
48720
|
+
|
|
48721
|
+
<dl>
|
|
48722
|
+
<dd>
|
|
48723
|
+
|
|
48724
|
+
```ruby
|
|
48725
|
+
client.users.fees.retrieve(user_id: "user_id")
|
|
48726
|
+
```
|
|
48727
|
+
</dd>
|
|
48728
|
+
</dl>
|
|
48729
|
+
</dd>
|
|
48730
|
+
</dl>
|
|
48731
|
+
|
|
48732
|
+
#### ⚙️ Parameters
|
|
48733
|
+
|
|
48734
|
+
<dl>
|
|
48735
|
+
<dd>
|
|
48736
|
+
|
|
48737
|
+
<dl>
|
|
48738
|
+
<dd>
|
|
48739
|
+
|
|
48740
|
+
**user_id:** `String` — `me`, or the authenticated user's own `user_` tag or username.
|
|
48741
|
+
|
|
48742
|
+
</dd>
|
|
48743
|
+
</dl>
|
|
48744
|
+
|
|
48745
|
+
<dl>
|
|
48746
|
+
<dd>
|
|
48747
|
+
|
|
48748
|
+
**request_options:** `Whop_sdk::Users::Fees::RequestOptions`
|
|
48749
|
+
|
|
48750
|
+
</dd>
|
|
48751
|
+
</dl>
|
|
48752
|
+
</dd>
|
|
48753
|
+
</dl>
|
|
48754
|
+
|
|
48755
|
+
|
|
48386
48756
|
</dd>
|
|
48387
48757
|
</dl>
|
|
48388
48758
|
</details>
|