whop_sdk 0.0.39 → 0.0.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +7 -0
- data/README.md +1 -1
- data/lib/whop_sdk/client.rb +18 -2
- data/lib/whop_sdk/internal/transport/base_client.rb +2 -0
- data/lib/whop_sdk/internal/type/union.rb +6 -6
- data/lib/whop_sdk/models/account.rb +144 -0
- data/lib/whop_sdk/models/account_create_params.rb +34 -0
- data/lib/whop_sdk/models/account_list_params.rb +34 -0
- data/lib/whop_sdk/models/account_list_response.rb +66 -0
- data/lib/whop_sdk/models/account_me_params.rb +14 -0
- data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
- data/lib/whop_sdk/models/account_social_link.rb +60 -0
- data/lib/whop_sdk/models/account_update_params.rb +146 -0
- data/lib/whop_sdk/models/account_wallet.rb +46 -0
- data/lib/whop_sdk/models/{ad_retrieve_response.rb → ad.rb} +15 -45
- data/lib/whop_sdk/models/ad_budget_type.rb +16 -0
- data/lib/whop_sdk/models/{ad_campaign_pause_response.rb → ad_campaign.rb} +37 -86
- data/lib/whop_sdk/models/ad_campaign_list_params.rb +12 -27
- data/lib/whop_sdk/models/ad_campaign_list_response.rb +9 -52
- data/lib/whop_sdk/models/ad_campaign_platform.rb +16 -0
- data/lib/whop_sdk/models/ad_campaign_status.rb +20 -0
- data/lib/whop_sdk/models/ad_group.rb +97 -0
- data/lib/whop_sdk/models/ad_group_list_params.rb +16 -19
- data/lib/whop_sdk/models/ad_group_list_response.rb +30 -51
- data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_status.rb +20 -0
- data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_group_update_params.rb +8 -32
- data/lib/whop_sdk/models/ad_list_params.rb +57 -12
- data/lib/whop_sdk/models/ad_list_response.rb +45 -31
- data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
- data/lib/whop_sdk/models/ad_report_retrieve_params.rb +45 -15
- data/lib/whop_sdk/models/ad_report_retrieve_response.rb +378 -105
- data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
- data/lib/whop_sdk/models/checkout_configuration.rb +22 -1
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +26 -1
- data/lib/whop_sdk/models/checkout_configuration_list_response.rb +24 -1
- data/lib/whop_sdk/models/currency.rb +3 -0
- data/lib/whop_sdk/models/deposit_create_params.rb +85 -0
- data/lib/whop_sdk/models/deposit_create_response.rb +102 -0
- data/lib/whop_sdk/models/dispute.rb +6 -7
- data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
- data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
- data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
- data/lib/whop_sdk/models/external_ad_status.rb +20 -0
- data/lib/whop_sdk/models/file_create_params.rb +3 -15
- data/lib/whop_sdk/models/file_create_response.rb +3 -16
- data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
- data/lib/whop_sdk/models/file_visibility.rb +17 -0
- data/lib/whop_sdk/models/granularities.rb +16 -0
- data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
- data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
- data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +65 -1
- data/lib/whop_sdk/models/member_list_response.rb +3 -2
- data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
- data/lib/whop_sdk/models/membership.rb +23 -2
- data/lib/whop_sdk/models/membership_list_response.rb +23 -2
- data/lib/whop_sdk/models/payment.rb +47 -22
- data/lib/whop_sdk/models/payment_list_params.rb +9 -1
- data/lib/whop_sdk/models/payment_list_response.rb +40 -13
- data/lib/whop_sdk/models/plan.rb +31 -1
- data/lib/whop_sdk/models/plan_create_params.rb +30 -1
- data/lib/whop_sdk/models/plan_list_response.rb +31 -1
- data/lib/whop_sdk/models/plan_update_params.rb +30 -1
- data/lib/whop_sdk/models/product.rb +10 -1
- data/lib/whop_sdk/models/product_create_params.rb +11 -1
- data/lib/whop_sdk/models/product_list_item.rb +10 -1
- data/lib/whop_sdk/models/product_update_params.rb +11 -1
- data/lib/whop_sdk/models/refund_created_webhook_event.rb +84 -5
- data/lib/whop_sdk/models/refund_retrieve_response.rb +82 -5
- data/lib/whop_sdk/models/refund_updated_webhook_event.rb +84 -5
- data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
- data/lib/whop_sdk/models/result_label_keys.rb +38 -0
- data/lib/whop_sdk/models/swap_create_quote_params.rb +102 -0
- data/lib/whop_sdk/models/swap_create_quote_response.rb +104 -0
- data/lib/whop_sdk/models/transfer_create_params.rb +3 -1
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +41 -33
- data/lib/whop_sdk/models/wallet_balance_params.rb +20 -0
- data/lib/whop_sdk/models/wallet_balance_response.rb +84 -0
- data/lib/whop_sdk/models/wallet_list_params.rb +14 -0
- data/lib/whop_sdk/models/wallet_list_response.rb +38 -0
- data/lib/whop_sdk/models/wallet_send_params.rb +37 -0
- data/lib/whop_sdk/models/wallet_send_response.rb +90 -0
- data/lib/whop_sdk/models/webhook_event.rb +4 -0
- data/lib/whop_sdk/models.rb +64 -0
- data/lib/whop_sdk/resources/accounts.rb +168 -0
- data/lib/whop_sdk/resources/ad_campaigns.rb +13 -13
- data/lib/whop_sdk/resources/ad_groups.rb +63 -8
- data/lib/whop_sdk/resources/ad_reports.rb +14 -8
- data/lib/whop_sdk/resources/ads.rb +66 -4
- data/lib/whop_sdk/resources/deposits.rb +46 -0
- data/lib/whop_sdk/resources/files.rb +1 -1
- data/lib/whop_sdk/resources/payments.rb +3 -1
- data/lib/whop_sdk/resources/plans.rb +10 -2
- data/lib/whop_sdk/resources/products.rb +6 -2
- data/lib/whop_sdk/resources/refunds.rb +2 -0
- data/lib/whop_sdk/resources/swaps.rb +52 -0
- data/lib/whop_sdk/resources/wallets.rb +78 -0
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +42 -7
- data/rbi/whop_sdk/client.rbi +14 -2
- data/rbi/whop_sdk/models/account.rbi +164 -0
- data/rbi/whop_sdk/models/account_create_params.rbi +59 -0
- data/rbi/whop_sdk/models/account_list_params.rbi +59 -0
- data/rbi/whop_sdk/models/account_list_response.rbi +115 -0
- data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
- data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
- data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
- data/rbi/whop_sdk/models/account_update_params.rbi +175 -0
- data/rbi/whop_sdk/models/account_wallet.rbi +75 -0
- data/rbi/whop_sdk/models/ad.rbi +143 -0
- data/rbi/whop_sdk/models/ad_budget_type.rbi +20 -0
- data/rbi/whop_sdk/models/{ad_campaign_pause_response.rbi → ad_campaign.rbi} +57 -245
- data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +11 -46
- data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +9 -143
- data/rbi/whop_sdk/models/ad_campaign_platform.rbi +22 -0
- data/rbi/whop_sdk/models/ad_campaign_status.rbi +27 -0
- data/rbi/whop_sdk/models/ad_group.rbi +126 -0
- data/rbi/whop_sdk/models/ad_group_list_params.rbi +13 -33
- data/rbi/whop_sdk/models/ad_group_list_response.rbi +41 -131
- data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_status.rbi +24 -0
- data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_group_update_params.rbi +16 -67
- data/rbi/whop_sdk/models/ad_list_params.rbi +59 -14
- data/rbi/whop_sdk/models/ad_list_response.rbi +74 -62
- data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
- data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +75 -19
- data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +537 -349
- data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
- data/rbi/whop_sdk/models/checkout_configuration.rbi +52 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +56 -1
- data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +55 -0
- data/rbi/whop_sdk/models/currency.rbi +3 -0
- data/rbi/whop_sdk/models/deposit_create_params.rbi +152 -0
- data/rbi/whop_sdk/models/deposit_create_response.rbi +185 -0
- data/rbi/whop_sdk/models/dispute.rbi +7 -9
- data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
- data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
- data/rbi/whop_sdk/models/external_ad_status.rbi +26 -0
- data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
- data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
- data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
- data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
- data/rbi/whop_sdk/models/granularities.rbi +20 -0
- data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
- data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +109 -3
- data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
- data/rbi/whop_sdk/models/membership.rbi +44 -5
- data/rbi/whop_sdk/models/membership_list_response.rbi +44 -5
- data/rbi/whop_sdk/models/payment.rbi +75 -36
- data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
- data/rbi/whop_sdk/models/payment_list_response.rbi +67 -24
- data/rbi/whop_sdk/models/plan.rbi +39 -0
- data/rbi/whop_sdk/models/plan_create_params.rbi +54 -0
- data/rbi/whop_sdk/models/plan_list_response.rbi +62 -0
- data/rbi/whop_sdk/models/plan_update_params.rbi +54 -0
- data/rbi/whop_sdk/models/product.rbi +10 -0
- data/rbi/whop_sdk/models/product_create_params.rbi +12 -0
- data/rbi/whop_sdk/models/product_list_item.rbi +10 -0
- data/rbi/whop_sdk/models/product_update_params.rbi +12 -0
- data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +159 -5
- data/rbi/whop_sdk/models/refund_retrieve_response.rbi +157 -5
- data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +159 -5
- data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
- data/rbi/whop_sdk/models/result_label_keys.rbi +64 -0
- data/rbi/whop_sdk/models/swap_create_quote_params.rbi +134 -0
- data/rbi/whop_sdk/models/swap_create_quote_response.rbi +148 -0
- data/rbi/whop_sdk/models/transfer_create_params.rbi +6 -2
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +25 -21
- data/rbi/whop_sdk/models/wallet_balance_params.rbi +35 -0
- data/rbi/whop_sdk/models/wallet_balance_response.rbi +145 -0
- data/rbi/whop_sdk/models/wallet_list_params.rbi +27 -0
- data/rbi/whop_sdk/models/wallet_list_response.rbi +66 -0
- data/rbi/whop_sdk/models/wallet_send_params.rbi +57 -0
- data/rbi/whop_sdk/models/wallet_send_response.rbi +146 -0
- data/rbi/whop_sdk/models/webhook_event.rbi +11 -0
- data/rbi/whop_sdk/models.rbi +68 -0
- data/rbi/whop_sdk/resources/accounts.rbi +137 -0
- data/rbi/whop_sdk/resources/ad_campaigns.rbi +8 -8
- data/rbi/whop_sdk/resources/ad_groups.rbi +47 -6
- data/rbi/whop_sdk/resources/ad_reports.rbi +23 -12
- data/rbi/whop_sdk/resources/ads.rbi +59 -2
- data/rbi/whop_sdk/resources/deposits.rbi +41 -0
- data/rbi/whop_sdk/resources/files.rbi +1 -2
- data/rbi/whop_sdk/resources/payments.rbi +3 -0
- data/rbi/whop_sdk/resources/plans.rbi +18 -0
- data/rbi/whop_sdk/resources/products.rbi +10 -0
- data/rbi/whop_sdk/resources/refunds.rbi +2 -0
- data/rbi/whop_sdk/resources/swaps.rbi +46 -0
- data/rbi/whop_sdk/resources/transfers.rbi +3 -1
- data/rbi/whop_sdk/resources/wallets.rbi +55 -0
- data/rbi/whop_sdk/resources/webhooks.rbi +25 -21
- data/sig/whop_sdk/client.rbs +8 -0
- data/sig/whop_sdk/models/account.rbs +100 -0
- data/sig/whop_sdk/models/account_create_params.rbs +32 -0
- data/sig/whop_sdk/models/account_list_params.rbs +32 -0
- data/sig/whop_sdk/models/account_list_response.rbs +62 -0
- data/sig/whop_sdk/models/account_me_params.rbs +14 -0
- data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
- data/sig/whop_sdk/models/account_social_link.rbs +62 -0
- data/sig/whop_sdk/models/account_update_params.rbs +111 -0
- data/sig/whop_sdk/models/account_wallet.rbs +42 -0
- data/sig/whop_sdk/models/ad.rbs +75 -0
- data/sig/whop_sdk/models/ad_budget_type.rbs +14 -0
- data/sig/whop_sdk/models/ad_campaign.rbs +194 -0
- data/sig/whop_sdk/models/ad_campaign_list_params.rbs +9 -25
- data/sig/whop_sdk/models/ad_campaign_list_response.rbs +12 -50
- data/sig/whop_sdk/models/ad_campaign_platform.rbs +14 -0
- data/sig/whop_sdk/models/ad_campaign_status.rbs +19 -0
- data/sig/whop_sdk/models/ad_group.rbs +70 -0
- data/sig/whop_sdk/models/ad_group_list_params.rbs +9 -20
- data/sig/whop_sdk/models/ad_group_list_response.rbs +22 -45
- data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_status.rbs +19 -0
- data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_group_update_params.rbs +18 -36
- data/sig/whop_sdk/models/ad_list_params.rbs +39 -14
- data/sig/whop_sdk/models/ad_list_response.rbs +28 -25
- data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
- data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +26 -4
- data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +240 -131
- data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
- data/sig/whop_sdk/models/checkout_configuration.rbs +16 -0
- data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +18 -2
- data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +16 -0
- data/sig/whop_sdk/models/currency.rbs +6 -0
- data/sig/whop_sdk/models/deposit_create_params.rbs +81 -0
- data/sig/whop_sdk/models/deposit_create_response.rbs +99 -0
- data/sig/whop_sdk/models/dispute.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
- data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
- data/sig/whop_sdk/models/external_ad_status.rbs +19 -0
- data/sig/whop_sdk/models/file_create_params.rbs +4 -18
- data/sig/whop_sdk/models/file_create_response.rbs +4 -15
- data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
- data/sig/whop_sdk/models/file_visibility.rbs +14 -0
- data/sig/whop_sdk/models/granularities.rbs +14 -0
- data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
- data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
- data/sig/whop_sdk/models/membership.rbs +19 -6
- data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
- data/sig/whop_sdk/models/payment.rbs +52 -15
- data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
- data/sig/whop_sdk/models/payment_list_response.rbs +52 -15
- data/sig/whop_sdk/models/plan.rbs +21 -0
- data/sig/whop_sdk/models/plan_create_params.rbs +21 -0
- data/sig/whop_sdk/models/plan_list_response.rbs +21 -0
- data/sig/whop_sdk/models/plan_update_params.rbs +21 -0
- data/sig/whop_sdk/models/product.rbs +5 -0
- data/sig/whop_sdk/models/product_create_params.rbs +5 -0
- data/sig/whop_sdk/models/product_list_item.rbs +5 -0
- data/sig/whop_sdk/models/product_update_params.rbs +5 -0
- data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
- data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
- data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
- data/sig/whop_sdk/models/result_label_keys.rbs +60 -0
- data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
- data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +26 -22
- data/sig/whop_sdk/models/wallet_balance_params.rbs +23 -0
- data/sig/whop_sdk/models/wallet_balance_response.rbs +87 -0
- data/sig/whop_sdk/models/wallet_list_params.rbs +14 -0
- data/sig/whop_sdk/models/wallet_list_response.rbs +40 -0
- data/sig/whop_sdk/models/wallet_send_params.rbs +32 -0
- data/sig/whop_sdk/models/wallet_send_response.rbs +79 -0
- data/sig/whop_sdk/models/webhook_event.rbs +8 -0
- data/sig/whop_sdk/models.rbs +64 -0
- data/sig/whop_sdk/resources/accounts.rbs +46 -0
- data/sig/whop_sdk/resources/ad_campaigns.rbs +6 -6
- data/sig/whop_sdk/resources/ad_groups.rbs +16 -5
- data/sig/whop_sdk/resources/ad_reports.rbs +3 -1
- data/sig/whop_sdk/resources/ads.rbs +18 -2
- data/sig/whop_sdk/resources/deposits.rbs +15 -0
- data/sig/whop_sdk/resources/files.rbs +1 -1
- data/sig/whop_sdk/resources/payments.rbs +1 -0
- data/sig/whop_sdk/resources/plans.rbs +4 -0
- data/sig/whop_sdk/resources/products.rbs +2 -0
- data/sig/whop_sdk/resources/swaps.rbs +20 -0
- data/sig/whop_sdk/resources/wallets.rbs +23 -0
- data/sig/whop_sdk/resources/webhooks.rbs +26 -22
- metadata +128 -23
- data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
- data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
- data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
- data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
- data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
- data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
- data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
- data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
- data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
- data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
- data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
- data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
- data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Accounts
|
|
6
|
+
# Creates an account. User tokens create business accounts; business account API
|
|
7
|
+
# keys create connected accounts.
|
|
8
|
+
sig do
|
|
9
|
+
params(
|
|
10
|
+
email: String,
|
|
11
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
12
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
13
|
+
).returns(WhopSDK::Account)
|
|
14
|
+
end
|
|
15
|
+
def create(
|
|
16
|
+
# The email address of the account owner. Required for business account API key
|
|
17
|
+
# requests.
|
|
18
|
+
email: nil,
|
|
19
|
+
# Arbitrary key/value metadata to store on the account.
|
|
20
|
+
metadata: nil,
|
|
21
|
+
request_options: {}
|
|
22
|
+
)
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
# Retrieves a single account visible to the credential, including its crypto
|
|
26
|
+
# wallet.
|
|
27
|
+
sig do
|
|
28
|
+
params(
|
|
29
|
+
account_id: String,
|
|
30
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
31
|
+
).returns(WhopSDK::Account)
|
|
32
|
+
end
|
|
33
|
+
def retrieve(
|
|
34
|
+
# The ID of the account, which will look like biz\_******\*******
|
|
35
|
+
account_id,
|
|
36
|
+
request_options: {}
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Updates an account. User tokens can update business accounts; business account
|
|
41
|
+
# API keys can update connected accounts.
|
|
42
|
+
sig do
|
|
43
|
+
params(
|
|
44
|
+
account_id: String,
|
|
45
|
+
affiliate_application_required: T::Boolean,
|
|
46
|
+
affiliate_instructions: T.nilable(String),
|
|
47
|
+
banner_image: T.nilable(T::Hash[Symbol, T.anything]),
|
|
48
|
+
business_type: T.nilable(String),
|
|
49
|
+
description: T.nilable(String),
|
|
50
|
+
featured_affiliate_product_id: T.nilable(String),
|
|
51
|
+
industry_group: T.nilable(String),
|
|
52
|
+
industry_type: T.nilable(String),
|
|
53
|
+
logo: T.nilable(T::Hash[Symbol, T.anything]),
|
|
54
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
55
|
+
route: T.nilable(String),
|
|
56
|
+
send_customer_emails: T::Boolean,
|
|
57
|
+
social_links: T::Array[T::Hash[Symbol, T.anything]],
|
|
58
|
+
target_audience: T.nilable(String),
|
|
59
|
+
title: T.nilable(String),
|
|
60
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
61
|
+
).returns(WhopSDK::Account)
|
|
62
|
+
end
|
|
63
|
+
def update(
|
|
64
|
+
# The ID of the account, which will look like biz\_******\*******
|
|
65
|
+
account_id,
|
|
66
|
+
# Whether prospective affiliates must submit an application before promoting this
|
|
67
|
+
# account.
|
|
68
|
+
affiliate_application_required: nil,
|
|
69
|
+
# Guidelines shown to affiliates promoting this account.
|
|
70
|
+
affiliate_instructions: nil,
|
|
71
|
+
# Attachment input for the account banner image.
|
|
72
|
+
banner_image: nil,
|
|
73
|
+
# The high-level business category for the account.
|
|
74
|
+
business_type: nil,
|
|
75
|
+
# A promotional description for the account.
|
|
76
|
+
description: nil,
|
|
77
|
+
# The ID of the product to feature for affiliates. Pass null to clear.
|
|
78
|
+
featured_affiliate_product_id: nil,
|
|
79
|
+
# The industry group the account belongs to.
|
|
80
|
+
industry_group: nil,
|
|
81
|
+
# The specific industry vertical the account operates in.
|
|
82
|
+
industry_type: nil,
|
|
83
|
+
# Attachment input for the account logo.
|
|
84
|
+
logo: nil,
|
|
85
|
+
# Arbitrary key/value metadata to store on the account.
|
|
86
|
+
metadata: nil,
|
|
87
|
+
# The unique URL slug for the account.
|
|
88
|
+
route: nil,
|
|
89
|
+
# Whether Whop sends transactional emails to customers on behalf of this account.
|
|
90
|
+
send_customer_emails: nil,
|
|
91
|
+
# The full list of social links to display for the account.
|
|
92
|
+
social_links: nil,
|
|
93
|
+
# The target audience for this account.
|
|
94
|
+
target_audience: nil,
|
|
95
|
+
# The display name of the account.
|
|
96
|
+
title: nil,
|
|
97
|
+
request_options: {}
|
|
98
|
+
)
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Lists accounts visible to the credential. User tokens return the user's business
|
|
102
|
+
# accounts; business account API keys return the requesting business account and
|
|
103
|
+
# its connected accounts.
|
|
104
|
+
sig do
|
|
105
|
+
params(
|
|
106
|
+
page: Integer,
|
|
107
|
+
per: Integer,
|
|
108
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
109
|
+
).returns(WhopSDK::Models::AccountListResponse)
|
|
110
|
+
end
|
|
111
|
+
def list(
|
|
112
|
+
# The page number to retrieve
|
|
113
|
+
page: nil,
|
|
114
|
+
# The number of resources to return per page. There is a limit of 50 results per
|
|
115
|
+
# page.
|
|
116
|
+
per: nil,
|
|
117
|
+
request_options: {}
|
|
118
|
+
)
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
# Retrieves the business account associated with the current business account API
|
|
122
|
+
# key.
|
|
123
|
+
sig do
|
|
124
|
+
params(request_options: WhopSDK::RequestOptions::OrHash).returns(
|
|
125
|
+
WhopSDK::Account
|
|
126
|
+
)
|
|
127
|
+
end
|
|
128
|
+
def me(request_options: {})
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
# @api private
|
|
132
|
+
sig { params(client: WhopSDK::Client).returns(T.attached_class) }
|
|
133
|
+
def self.new(client:)
|
|
134
|
+
end
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
end
|
|
@@ -13,7 +13,7 @@ module WhopSDK
|
|
|
13
13
|
params(
|
|
14
14
|
id: String,
|
|
15
15
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
16
|
-
).returns(WhopSDK::
|
|
16
|
+
).returns(WhopSDK::AdCampaign)
|
|
17
17
|
end
|
|
18
18
|
def retrieve(
|
|
19
19
|
# The unique identifier of the ad campaign.
|
|
@@ -32,7 +32,7 @@ module WhopSDK
|
|
|
32
32
|
id: String,
|
|
33
33
|
budget: T.nilable(Float),
|
|
34
34
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
35
|
-
).returns(WhopSDK::
|
|
35
|
+
).returns(WhopSDK::AdCampaign)
|
|
36
36
|
end
|
|
37
37
|
def update(
|
|
38
38
|
# The unique identifier of the ad campaign to update.
|
|
@@ -52,27 +52,27 @@ module WhopSDK
|
|
|
52
52
|
# - `ad_campaign:basic:read`
|
|
53
53
|
sig do
|
|
54
54
|
params(
|
|
55
|
-
company_id: String,
|
|
56
55
|
after: T.nilable(String),
|
|
57
56
|
before: T.nilable(String),
|
|
57
|
+
company_id: T.nilable(String),
|
|
58
58
|
created_after: T.nilable(Time),
|
|
59
59
|
created_before: T.nilable(Time),
|
|
60
60
|
first: T.nilable(Integer),
|
|
61
61
|
last: T.nilable(Integer),
|
|
62
62
|
query: T.nilable(String),
|
|
63
|
-
status: T.nilable(WhopSDK::
|
|
63
|
+
status: T.nilable(WhopSDK::AdCampaignStatus::OrSymbol),
|
|
64
64
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
65
65
|
).returns(
|
|
66
66
|
WhopSDK::Internal::CursorPage[WhopSDK::Models::AdCampaignListResponse]
|
|
67
67
|
)
|
|
68
68
|
end
|
|
69
69
|
def list(
|
|
70
|
-
# The unique identifier of the company to list ad campaigns for.
|
|
71
|
-
company_id:,
|
|
72
70
|
# Returns the elements in the list that come after the specified cursor.
|
|
73
71
|
after: nil,
|
|
74
72
|
# Returns the elements in the list that come before the specified cursor.
|
|
75
73
|
before: nil,
|
|
74
|
+
# The unique identifier of the company to list ad campaigns for.
|
|
75
|
+
company_id: nil,
|
|
76
76
|
# Only return ad campaigns created after this timestamp.
|
|
77
77
|
created_after: nil,
|
|
78
78
|
# Only return ad campaigns created before this timestamp.
|
|
@@ -98,7 +98,7 @@ module WhopSDK
|
|
|
98
98
|
params(
|
|
99
99
|
id: String,
|
|
100
100
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
101
|
-
).returns(WhopSDK::
|
|
101
|
+
).returns(WhopSDK::AdCampaign)
|
|
102
102
|
end
|
|
103
103
|
def pause(
|
|
104
104
|
# The unique identifier of the ad campaign to pause.
|
|
@@ -116,7 +116,7 @@ module WhopSDK
|
|
|
116
116
|
params(
|
|
117
117
|
id: String,
|
|
118
118
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
119
|
-
).returns(WhopSDK::
|
|
119
|
+
).returns(WhopSDK::AdCampaign)
|
|
120
120
|
end
|
|
121
121
|
def unpause(
|
|
122
122
|
# The unique identifier of the ad campaign to unpause.
|
|
@@ -13,7 +13,7 @@ module WhopSDK
|
|
|
13
13
|
params(
|
|
14
14
|
id: String,
|
|
15
15
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
16
|
-
).returns(WhopSDK::
|
|
16
|
+
).returns(WhopSDK::AdGroup)
|
|
17
17
|
end
|
|
18
18
|
def retrieve(
|
|
19
19
|
# The unique identifier of the ad group.
|
|
@@ -32,16 +32,15 @@ module WhopSDK
|
|
|
32
32
|
params(
|
|
33
33
|
id: String,
|
|
34
34
|
budget: T.nilable(Float),
|
|
35
|
-
budget_type:
|
|
36
|
-
T.nilable(WhopSDK::AdGroupUpdateParams::BudgetType::OrSymbol),
|
|
35
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::OrSymbol),
|
|
37
36
|
config: T.nilable(WhopSDK::AdGroupUpdateParams::Config::OrHash),
|
|
38
37
|
daily_budget: T.nilable(Float),
|
|
39
38
|
name: T.nilable(String),
|
|
40
39
|
platform_config:
|
|
41
40
|
T.nilable(WhopSDK::AdGroupUpdateParams::PlatformConfig::OrHash),
|
|
42
|
-
status: T.nilable(WhopSDK::
|
|
41
|
+
status: T.nilable(WhopSDK::AdGroupStatus::OrSymbol),
|
|
43
42
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
44
|
-
).returns(WhopSDK::
|
|
43
|
+
).returns(WhopSDK::AdGroup)
|
|
45
44
|
end
|
|
46
45
|
def update(
|
|
47
46
|
# The unique identifier of the ad group to update.
|
|
@@ -79,9 +78,10 @@ module WhopSDK
|
|
|
79
78
|
created_after: T.nilable(Time),
|
|
80
79
|
created_before: T.nilable(Time),
|
|
81
80
|
first: T.nilable(Integer),
|
|
81
|
+
include_paused: T.nilable(T::Boolean),
|
|
82
82
|
last: T.nilable(Integer),
|
|
83
83
|
query: T.nilable(String),
|
|
84
|
-
status: T.nilable(WhopSDK::
|
|
84
|
+
status: T.nilable(WhopSDK::AdGroupStatus::OrSymbol),
|
|
85
85
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
86
86
|
).returns(
|
|
87
87
|
WhopSDK::Internal::CursorPage[WhopSDK::Models::AdGroupListResponse]
|
|
@@ -102,6 +102,9 @@ module WhopSDK
|
|
|
102
102
|
created_before: nil,
|
|
103
103
|
# Returns the first _n_ elements from the list.
|
|
104
104
|
first: nil,
|
|
105
|
+
# When false, excludes paused ad groups so pagination matches the dashboard's
|
|
106
|
+
# hide-paused toggle.
|
|
107
|
+
include_paused: nil,
|
|
105
108
|
# Returns the last _n_ elements from the list.
|
|
106
109
|
last: nil,
|
|
107
110
|
# Case-insensitive substring match against the ad group name.
|
|
@@ -130,6 +133,44 @@ module WhopSDK
|
|
|
130
133
|
)
|
|
131
134
|
end
|
|
132
135
|
|
|
136
|
+
# Pauses an ad group.
|
|
137
|
+
#
|
|
138
|
+
# Required permissions:
|
|
139
|
+
#
|
|
140
|
+
# - `ad_campaign:update`
|
|
141
|
+
# - `ad_campaign:basic:read`
|
|
142
|
+
sig do
|
|
143
|
+
params(
|
|
144
|
+
id: String,
|
|
145
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
146
|
+
).returns(WhopSDK::AdGroup)
|
|
147
|
+
end
|
|
148
|
+
def pause(
|
|
149
|
+
# The unique identifier of the ad group to pause.
|
|
150
|
+
id,
|
|
151
|
+
request_options: {}
|
|
152
|
+
)
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
# Resumes a paused ad group.
|
|
156
|
+
#
|
|
157
|
+
# Required permissions:
|
|
158
|
+
#
|
|
159
|
+
# - `ad_campaign:update`
|
|
160
|
+
# - `ad_campaign:basic:read`
|
|
161
|
+
sig do
|
|
162
|
+
params(
|
|
163
|
+
id: String,
|
|
164
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
165
|
+
).returns(WhopSDK::AdGroup)
|
|
166
|
+
end
|
|
167
|
+
def unpause(
|
|
168
|
+
# The unique identifier of the ad group to unpause.
|
|
169
|
+
id,
|
|
170
|
+
request_options: {}
|
|
171
|
+
)
|
|
172
|
+
end
|
|
173
|
+
|
|
133
174
|
# @api private
|
|
134
175
|
sig { params(client: WhopSDK::Client).returns(T.attached_class) }
|
|
135
176
|
def self.new(client:)
|
|
@@ -4,9 +4,11 @@ module WhopSDK
|
|
|
4
4
|
module Resources
|
|
5
5
|
# Ad reports
|
|
6
6
|
class AdReports
|
|
7
|
-
# Performance report for
|
|
8
|
-
#
|
|
9
|
-
# or `
|
|
7
|
+
# Performance report for a company, ad campaign, ad group, or ad. Always returns
|
|
8
|
+
# aggregate `summary` totals. Set `granularity` (`daily`/`hourly`) to additionally
|
|
9
|
+
# get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to
|
|
10
|
+
# additionally get per-entity rows inside the requested scope. Exactly one of
|
|
11
|
+
# `companyId`, `adCampaignId`, `adGroupId`, or `adId` must be provided.
|
|
10
12
|
#
|
|
11
13
|
# Required permissions:
|
|
12
14
|
#
|
|
@@ -18,8 +20,11 @@ module WhopSDK
|
|
|
18
20
|
ad_campaign_id: T.nilable(String),
|
|
19
21
|
ad_group_id: T.nilable(String),
|
|
20
22
|
ad_id: T.nilable(String),
|
|
23
|
+
breakdown:
|
|
24
|
+
T.nilable(WhopSDK::AdReportRetrieveParams::Breakdown::OrSymbol),
|
|
25
|
+
company_id: T.nilable(String),
|
|
21
26
|
currency: T.nilable(String),
|
|
22
|
-
|
|
27
|
+
granularity: T.nilable(WhopSDK::Granularities::OrSymbol),
|
|
23
28
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
24
29
|
).returns(WhopSDK::Models::AdReportRetrieveResponse)
|
|
25
30
|
end
|
|
@@ -28,20 +33,26 @@ module WhopSDK
|
|
|
28
33
|
from:,
|
|
29
34
|
# Inclusive end of the reporting window.
|
|
30
35
|
to:,
|
|
31
|
-
# The unique identifier of an ad campaign. Mutually exclusive with `
|
|
32
|
-
# `adId`.
|
|
36
|
+
# The unique identifier of an ad campaign. Mutually exclusive with `companyId`,
|
|
37
|
+
# `adGroupId`, and `adId`.
|
|
33
38
|
ad_campaign_id: nil,
|
|
34
|
-
# The unique identifier of an ad group. Mutually exclusive with `
|
|
35
|
-
# `adId`.
|
|
39
|
+
# The unique identifier of an ad group. Mutually exclusive with `companyId`,
|
|
40
|
+
# `adCampaignId`, and `adId`.
|
|
36
41
|
ad_group_id: nil,
|
|
37
|
-
# The unique identifier of an ad. Mutually exclusive with `
|
|
38
|
-
# `adGroupId`.
|
|
42
|
+
# The unique identifier of an ad. Mutually exclusive with `companyId`,
|
|
43
|
+
# `adCampaignId`, and `adGroupId`.
|
|
39
44
|
ad_id: nil,
|
|
45
|
+
# Entity level to group an ad report by.
|
|
46
|
+
breakdown: nil,
|
|
47
|
+
# The unique identifier of a company. Mutually exclusive with `adCampaignId`,
|
|
48
|
+
# `adGroupId`, and `adId`. Use with `breakdown` to fan out across every campaign,
|
|
49
|
+
# ad group, or ad in the company without paging.
|
|
50
|
+
company_id: nil,
|
|
40
51
|
# ISO 4217 currency code to report `spend` in. Defaults to the company's ads
|
|
41
52
|
# reporting currency.
|
|
42
53
|
currency: nil,
|
|
43
|
-
#
|
|
44
|
-
|
|
54
|
+
# Bucket size for external ad stat rows.
|
|
55
|
+
granularity: nil,
|
|
45
56
|
request_options: {}
|
|
46
57
|
)
|
|
47
58
|
end
|
|
@@ -13,7 +13,7 @@ module WhopSDK
|
|
|
13
13
|
params(
|
|
14
14
|
id: String,
|
|
15
15
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
16
|
-
).returns(WhopSDK::
|
|
16
|
+
).returns(WhopSDK::Ad)
|
|
17
17
|
end
|
|
18
18
|
def retrieve(
|
|
19
19
|
# The unique identifier of the ad.
|
|
@@ -37,8 +37,14 @@ module WhopSDK
|
|
|
37
37
|
created_after: T.nilable(Time),
|
|
38
38
|
created_before: T.nilable(Time),
|
|
39
39
|
first: T.nilable(Integer),
|
|
40
|
+
include_paused: T.nilable(T::Boolean),
|
|
40
41
|
last: T.nilable(Integer),
|
|
41
|
-
|
|
42
|
+
order_by: T.nilable(WhopSDK::AdListParams::OrderBy::OrSymbol),
|
|
43
|
+
order_direction: T.nilable(WhopSDK::Direction::OrSymbol),
|
|
44
|
+
query: T.nilable(String),
|
|
45
|
+
stats_from: T.nilable(Time),
|
|
46
|
+
stats_to: T.nilable(Time),
|
|
47
|
+
status: T.nilable(WhopSDK::ExternalAdStatus::OrSymbol),
|
|
42
48
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
43
49
|
).returns(
|
|
44
50
|
WhopSDK::Internal::CursorPage[WhopSDK::Models::AdListResponse]
|
|
@@ -64,14 +70,65 @@ module WhopSDK
|
|
|
64
70
|
created_before: nil,
|
|
65
71
|
# Returns the first _n_ elements from the list.
|
|
66
72
|
first: nil,
|
|
73
|
+
# When false, excludes paused ads so pagination matches the dashboard's
|
|
74
|
+
# hide-paused toggle.
|
|
75
|
+
include_paused: nil,
|
|
67
76
|
# Returns the last _n_ elements from the list.
|
|
68
77
|
last: nil,
|
|
78
|
+
# Columns that the listAds query can sort by.
|
|
79
|
+
order_by: nil,
|
|
80
|
+
# The direction of the sort.
|
|
81
|
+
order_direction: nil,
|
|
82
|
+
# Case-insensitive substring match against the ad title or tag.
|
|
83
|
+
query: nil,
|
|
84
|
+
# Start of the stats date range used when order_by is a stats column.
|
|
85
|
+
stats_from: nil,
|
|
86
|
+
# End of the stats date range used when order_by is a stats column.
|
|
87
|
+
stats_to: nil,
|
|
69
88
|
# The status of an external ad.
|
|
70
89
|
status: nil,
|
|
71
90
|
request_options: {}
|
|
72
91
|
)
|
|
73
92
|
end
|
|
74
93
|
|
|
94
|
+
# Pauses an ad.
|
|
95
|
+
#
|
|
96
|
+
# Required permissions:
|
|
97
|
+
#
|
|
98
|
+
# - `ad_campaign:update`
|
|
99
|
+
# - `ad_campaign:basic:read`
|
|
100
|
+
sig do
|
|
101
|
+
params(
|
|
102
|
+
id: String,
|
|
103
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
104
|
+
).returns(WhopSDK::Ad)
|
|
105
|
+
end
|
|
106
|
+
def pause(
|
|
107
|
+
# The unique identifier of the ad to pause.
|
|
108
|
+
id,
|
|
109
|
+
request_options: {}
|
|
110
|
+
)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Resumes a paused ad.
|
|
114
|
+
#
|
|
115
|
+
# Required permissions:
|
|
116
|
+
#
|
|
117
|
+
# - `ad_campaign:update`
|
|
118
|
+
# - `ad_campaign:basic:read`
|
|
119
|
+
sig do
|
|
120
|
+
params(
|
|
121
|
+
id: String,
|
|
122
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
123
|
+
).returns(WhopSDK::Ad)
|
|
124
|
+
end
|
|
125
|
+
def unpause(
|
|
126
|
+
# The unique identifier of the ad to unpause.
|
|
127
|
+
id,
|
|
128
|
+
request_options: {}
|
|
129
|
+
)
|
|
130
|
+
end
|
|
131
|
+
|
|
75
132
|
# @api private
|
|
76
133
|
sig { params(client: WhopSDK::Client).returns(T.attached_class) }
|
|
77
134
|
def self.new(client:)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Deposits
|
|
6
|
+
# Resolves a deposit destination and returns the on-chain addresses that can fund
|
|
7
|
+
# it.
|
|
8
|
+
sig do
|
|
9
|
+
params(
|
|
10
|
+
amount: Float,
|
|
11
|
+
destination:
|
|
12
|
+
T.any(
|
|
13
|
+
String,
|
|
14
|
+
WhopSDK::DepositCreateParams::Destination::UnionMember1::OrHash
|
|
15
|
+
),
|
|
16
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
17
|
+
network: T.nilable(String),
|
|
18
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
19
|
+
).returns(WhopSDK::Models::DepositCreateResponse)
|
|
20
|
+
end
|
|
21
|
+
def create(
|
|
22
|
+
# Amount to deposit.
|
|
23
|
+
amount:,
|
|
24
|
+
# Destination account ID or wallet address. Object form is supported for
|
|
25
|
+
# compatibility.
|
|
26
|
+
destination:,
|
|
27
|
+
# Arbitrary metadata echoed in the response.
|
|
28
|
+
metadata: nil,
|
|
29
|
+
# Optional destination network override.
|
|
30
|
+
network: nil,
|
|
31
|
+
request_options: {}
|
|
32
|
+
)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# @api private
|
|
36
|
+
sig { params(client: WhopSDK::Client).returns(T.attached_class) }
|
|
37
|
+
def self.new(client:)
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
@@ -9,8 +9,7 @@ module WhopSDK
|
|
|
9
9
|
sig do
|
|
10
10
|
params(
|
|
11
11
|
filename: String,
|
|
12
|
-
visibility:
|
|
13
|
-
T.nilable(WhopSDK::FileCreateParams::Visibility::OrSymbol),
|
|
12
|
+
visibility: T.nilable(WhopSDK::FileVisibility::OrSymbol),
|
|
14
13
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
15
14
|
).returns(WhopSDK::Models::FileCreateResponse)
|
|
16
15
|
end
|
|
@@ -85,6 +85,7 @@ module WhopSDK
|
|
|
85
85
|
before: T.nilable(String),
|
|
86
86
|
billing_reasons:
|
|
87
87
|
T.nilable(T::Array[WhopSDK::BillingReasons::OrSymbol]),
|
|
88
|
+
checkout_configuration_ids: T.nilable(T::Array[String]),
|
|
88
89
|
company_id: T.nilable(String),
|
|
89
90
|
created_after: T.nilable(Time),
|
|
90
91
|
created_before: T.nilable(Time),
|
|
@@ -114,6 +115,8 @@ module WhopSDK
|
|
|
114
115
|
before: nil,
|
|
115
116
|
# Filter payments by their billing reason.
|
|
116
117
|
billing_reasons: nil,
|
|
118
|
+
# Only return payments from these checkout configurations.
|
|
119
|
+
checkout_configuration_ids: nil,
|
|
117
120
|
# The unique identifier of the company to list payments for.
|
|
118
121
|
company_id: nil,
|
|
119
122
|
# Only return payments created after this timestamp.
|
|
@@ -29,6 +29,7 @@ module WhopSDK
|
|
|
29
29
|
initial_price: T.nilable(Float),
|
|
30
30
|
internal_notes: T.nilable(String),
|
|
31
31
|
legacy_payment_method_controls: T.nilable(T::Boolean),
|
|
32
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
32
33
|
override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
|
|
33
34
|
payment_method_configuration:
|
|
34
35
|
T.nilable(
|
|
@@ -39,6 +40,8 @@ module WhopSDK
|
|
|
39
40
|
renewal_price: T.nilable(Float),
|
|
40
41
|
split_pay_required_payments: T.nilable(Integer),
|
|
41
42
|
stock: T.nilable(Integer),
|
|
43
|
+
three_ds_level:
|
|
44
|
+
T.nilable(WhopSDK::PlanCreateParams::ThreeDSLevel::OrSymbol),
|
|
42
45
|
title: T.nilable(String),
|
|
43
46
|
trial_period_days: T.nilable(Integer),
|
|
44
47
|
unlimited_stock: T.nilable(T::Boolean),
|
|
@@ -78,6 +81,10 @@ module WhopSDK
|
|
|
78
81
|
internal_notes: nil,
|
|
79
82
|
# Whether this plan uses legacy payment method controls.
|
|
80
83
|
legacy_payment_method_controls: nil,
|
|
84
|
+
# Custom key-value pairs to store on the plan. Included in webhook payloads for
|
|
85
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
86
|
+
# value.
|
|
87
|
+
metadata: nil,
|
|
81
88
|
# Whether or not the tax is included in a plan's price (or if it hasn't been set
|
|
82
89
|
# up)
|
|
83
90
|
override_tax_type: nil,
|
|
@@ -96,6 +103,8 @@ module WhopSDK
|
|
|
96
103
|
# The maximum number of units available for purchase. Ignored when unlimited_stock
|
|
97
104
|
# is true.
|
|
98
105
|
stock: nil,
|
|
106
|
+
# The 3D Secure behavior for a plan.
|
|
107
|
+
three_ds_level: nil,
|
|
99
108
|
# The display name of the plan shown to customers on the product page.
|
|
100
109
|
title: nil,
|
|
101
110
|
# The number of free trial days before the first charge on a recurring plan.
|
|
@@ -151,6 +160,7 @@ module WhopSDK
|
|
|
151
160
|
initial_price: T.nilable(Float),
|
|
152
161
|
internal_notes: T.nilable(String),
|
|
153
162
|
legacy_payment_method_controls: T.nilable(T::Boolean),
|
|
163
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
154
164
|
offer_cancel_discount: T.nilable(T::Boolean),
|
|
155
165
|
override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
|
|
156
166
|
payment_method_configuration:
|
|
@@ -161,6 +171,8 @@ module WhopSDK
|
|
|
161
171
|
stock: T.nilable(Integer),
|
|
162
172
|
strike_through_initial_price: T.nilable(Float),
|
|
163
173
|
strike_through_renewal_price: T.nilable(Float),
|
|
174
|
+
three_ds_level:
|
|
175
|
+
T.nilable(WhopSDK::PlanUpdateParams::ThreeDSLevel::OrSymbol),
|
|
164
176
|
title: T.nilable(String),
|
|
165
177
|
trial_period_days: T.nilable(Integer),
|
|
166
178
|
unlimited_stock: T.nilable(T::Boolean),
|
|
@@ -197,6 +209,10 @@ module WhopSDK
|
|
|
197
209
|
internal_notes: nil,
|
|
198
210
|
# Whether this plan uses legacy payment method controls.
|
|
199
211
|
legacy_payment_method_controls: nil,
|
|
212
|
+
# Custom key-value pairs to store on the plan. Included in webhook payloads for
|
|
213
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
214
|
+
# value.
|
|
215
|
+
metadata: nil,
|
|
200
216
|
# Whether to offer a retention discount when a customer attempts to cancel.
|
|
201
217
|
offer_cancel_discount: nil,
|
|
202
218
|
# Whether or not the tax is included in a plan's price (or if it hasn't been set
|
|
@@ -217,6 +233,8 @@ module WhopSDK
|
|
|
217
233
|
# A comparison price displayed with a strikethrough for the renewal price.
|
|
218
234
|
# Provided in the plan's currency (e.g., 19.99 for $19.99).
|
|
219
235
|
strike_through_renewal_price: nil,
|
|
236
|
+
# The 3D Secure behavior for a plan.
|
|
237
|
+
three_ds_level: nil,
|
|
220
238
|
# The display name of the plan shown to customers on the product page.
|
|
221
239
|
title: nil,
|
|
222
240
|
# The number of free trial days before the first charge on a recurring plan.
|
|
@@ -28,6 +28,7 @@ module WhopSDK
|
|
|
28
28
|
member_affiliate_percentage: T.nilable(Float),
|
|
29
29
|
member_affiliate_status:
|
|
30
30
|
T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
|
|
31
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
31
32
|
plan_options:
|
|
32
33
|
T.nilable(WhopSDK::ProductCreateParams::PlanOptions::OrHash),
|
|
33
34
|
product_tax_code_id: T.nilable(String),
|
|
@@ -70,6 +71,10 @@ module WhopSDK
|
|
|
70
71
|
member_affiliate_percentage: nil,
|
|
71
72
|
# The different statuses of the global affiliate program for a product.
|
|
72
73
|
member_affiliate_status: nil,
|
|
74
|
+
# Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
75
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
76
|
+
# value.
|
|
77
|
+
metadata: nil,
|
|
73
78
|
# Configuration for an automatically generated plan to attach to this product.
|
|
74
79
|
plan_options: nil,
|
|
75
80
|
# The unique identifier of the tax classification code to apply to this product.
|
|
@@ -130,6 +135,7 @@ module WhopSDK
|
|
|
130
135
|
member_affiliate_percentage: T.nilable(Float),
|
|
131
136
|
member_affiliate_status:
|
|
132
137
|
T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
|
|
138
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
|
133
139
|
product_tax_code_id: T.nilable(String),
|
|
134
140
|
redirect_purchase_url: T.nilable(String),
|
|
135
141
|
route: T.nilable(String),
|
|
@@ -171,6 +177,10 @@ module WhopSDK
|
|
|
171
177
|
member_affiliate_percentage: nil,
|
|
172
178
|
# The different statuses of the global affiliate program for a product.
|
|
173
179
|
member_affiliate_status: nil,
|
|
180
|
+
# Custom key-value pairs to store on the product. Included in webhook payloads for
|
|
181
|
+
# payment and membership events. Max 50 keys, 500 chars per key, 5000 chars per
|
|
182
|
+
# value.
|
|
183
|
+
metadata: nil,
|
|
174
184
|
# The unique identifier of the tax classification code to apply to this product.
|
|
175
185
|
product_tax_code_id: nil,
|
|
176
186
|
# A URL to redirect the customer to after completing a purchase.
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Swaps
|
|
6
|
+
# Returns a stateless swap price preview. No funds move and nothing is persisted.
|
|
7
|
+
sig do
|
|
8
|
+
params(
|
|
9
|
+
amount: String,
|
|
10
|
+
from_token: String,
|
|
11
|
+
to_token: String,
|
|
12
|
+
from_address: T.nilable(String),
|
|
13
|
+
from_chain:
|
|
14
|
+
T.nilable(WhopSDK::SwapCreateQuoteParams::FromChain::Variants),
|
|
15
|
+
metadata: T::Hash[Symbol, T.anything],
|
|
16
|
+
slippage_bps: T.nilable(Integer),
|
|
17
|
+
to_address: T.nilable(String),
|
|
18
|
+
to_chain:
|
|
19
|
+
T.nilable(WhopSDK::SwapCreateQuoteParams::ToChain::Variants),
|
|
20
|
+
request_options: WhopSDK::RequestOptions::OrHash
|
|
21
|
+
).returns(WhopSDK::Models::SwapCreateQuoteResponse)
|
|
22
|
+
end
|
|
23
|
+
def create_quote(
|
|
24
|
+
# Input token amount.
|
|
25
|
+
amount:,
|
|
26
|
+
# Source token contract address.
|
|
27
|
+
from_token:,
|
|
28
|
+
# Destination token contract address.
|
|
29
|
+
to_token:,
|
|
30
|
+
from_address: nil,
|
|
31
|
+
from_chain: nil,
|
|
32
|
+
metadata: nil,
|
|
33
|
+
slippage_bps: nil,
|
|
34
|
+
to_address: nil,
|
|
35
|
+
to_chain: nil,
|
|
36
|
+
request_options: {}
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# @api private
|
|
41
|
+
sig { params(client: WhopSDK::Client).returns(T.attached_class) }
|
|
42
|
+
def self.new(client:)
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|