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
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -45,32 +45,70 @@ module WhopSDK
|
|
|
45
45
|
|
|
46
46
|
AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
|
|
47
47
|
|
|
48
|
+
Account = WhopSDK::Models::Account
|
|
49
|
+
|
|
50
|
+
AccountCreateParams = WhopSDK::Models::AccountCreateParams
|
|
51
|
+
|
|
48
52
|
AccountLinkCreateParams = WhopSDK::Models::AccountLinkCreateParams
|
|
49
53
|
|
|
54
|
+
AccountListParams = WhopSDK::Models::AccountListParams
|
|
55
|
+
|
|
56
|
+
AccountMeParams = WhopSDK::Models::AccountMeParams
|
|
57
|
+
|
|
58
|
+
AccountRetrieveParams = WhopSDK::Models::AccountRetrieveParams
|
|
59
|
+
|
|
60
|
+
AccountSocialLink = WhopSDK::Models::AccountSocialLink
|
|
61
|
+
|
|
62
|
+
AccountUpdateParams = WhopSDK::Models::AccountUpdateParams
|
|
63
|
+
|
|
64
|
+
AccountWallet = WhopSDK::Models::AccountWallet
|
|
65
|
+
|
|
66
|
+
Ad = WhopSDK::Models::Ad
|
|
67
|
+
|
|
68
|
+
AdBudgetType = WhopSDK::Models::AdBudgetType
|
|
69
|
+
|
|
70
|
+
AdCampaign = WhopSDK::Models::AdCampaign
|
|
71
|
+
|
|
50
72
|
AdCampaignListParams = WhopSDK::Models::AdCampaignListParams
|
|
51
73
|
|
|
52
74
|
AdCampaignPauseParams = WhopSDK::Models::AdCampaignPauseParams
|
|
53
75
|
|
|
76
|
+
AdCampaignPlatform = WhopSDK::Models::AdCampaignPlatform
|
|
77
|
+
|
|
54
78
|
AdCampaignRetrieveParams = WhopSDK::Models::AdCampaignRetrieveParams
|
|
55
79
|
|
|
80
|
+
AdCampaignStatus = WhopSDK::Models::AdCampaignStatus
|
|
81
|
+
|
|
56
82
|
AdCampaignUnpauseParams = WhopSDK::Models::AdCampaignUnpauseParams
|
|
57
83
|
|
|
58
84
|
AdCampaignUpdateParams = WhopSDK::Models::AdCampaignUpdateParams
|
|
59
85
|
|
|
86
|
+
AdGroup = WhopSDK::Models::AdGroup
|
|
87
|
+
|
|
60
88
|
AdGroupDeleteParams = WhopSDK::Models::AdGroupDeleteParams
|
|
61
89
|
|
|
62
90
|
AdGroupListParams = WhopSDK::Models::AdGroupListParams
|
|
63
91
|
|
|
92
|
+
AdGroupPauseParams = WhopSDK::Models::AdGroupPauseParams
|
|
93
|
+
|
|
64
94
|
AdGroupRetrieveParams = WhopSDK::Models::AdGroupRetrieveParams
|
|
65
95
|
|
|
96
|
+
AdGroupStatus = WhopSDK::Models::AdGroupStatus
|
|
97
|
+
|
|
98
|
+
AdGroupUnpauseParams = WhopSDK::Models::AdGroupUnpauseParams
|
|
99
|
+
|
|
66
100
|
AdGroupUpdateParams = WhopSDK::Models::AdGroupUpdateParams
|
|
67
101
|
|
|
68
102
|
AdListParams = WhopSDK::Models::AdListParams
|
|
69
103
|
|
|
104
|
+
AdPauseParams = WhopSDK::Models::AdPauseParams
|
|
105
|
+
|
|
70
106
|
AdReportRetrieveParams = WhopSDK::Models::AdReportRetrieveParams
|
|
71
107
|
|
|
72
108
|
AdRetrieveParams = WhopSDK::Models::AdRetrieveParams
|
|
73
109
|
|
|
110
|
+
AdUnpauseParams = WhopSDK::Models::AdUnpauseParams
|
|
111
|
+
|
|
74
112
|
Affiliate = WhopSDK::Models::Affiliate
|
|
75
113
|
|
|
76
114
|
AffiliateArchiveParams = WhopSDK::Models::AffiliateArchiveParams
|
|
@@ -264,6 +302,8 @@ module WhopSDK
|
|
|
264
302
|
|
|
265
303
|
CustomCta = WhopSDK::Models::CustomCta
|
|
266
304
|
|
|
305
|
+
DepositCreateParams = WhopSDK::Models::DepositCreateParams
|
|
306
|
+
|
|
267
307
|
Direction = WhopSDK::Models::Direction
|
|
268
308
|
|
|
269
309
|
Dispute = WhopSDK::Models::Dispute
|
|
@@ -362,6 +402,8 @@ module WhopSDK
|
|
|
362
402
|
|
|
363
403
|
ExperienceUpdateParams = WhopSDK::Models::ExperienceUpdateParams
|
|
364
404
|
|
|
405
|
+
ExternalAdStatus = WhopSDK::Models::ExternalAdStatus
|
|
406
|
+
|
|
365
407
|
FeeMarkupCreateParams = WhopSDK::Models::FeeMarkupCreateParams
|
|
366
408
|
|
|
367
409
|
FeeMarkupDeleteParams = WhopSDK::Models::FeeMarkupDeleteParams
|
|
@@ -374,6 +416,8 @@ module WhopSDK
|
|
|
374
416
|
|
|
375
417
|
FileRetrieveParams = WhopSDK::Models::FileRetrieveParams
|
|
376
418
|
|
|
419
|
+
FileVisibility = WhopSDK::Models::FileVisibility
|
|
420
|
+
|
|
377
421
|
Forum = WhopSDK::Models::Forum
|
|
378
422
|
|
|
379
423
|
ForumListParams = WhopSDK::Models::ForumListParams
|
|
@@ -398,6 +442,16 @@ module WhopSDK
|
|
|
398
442
|
|
|
399
443
|
GlobalAffiliateStatus = WhopSDK::Models::GlobalAffiliateStatus
|
|
400
444
|
|
|
445
|
+
Granularities = WhopSDK::Models::Granularities
|
|
446
|
+
|
|
447
|
+
IdentityProfileApprovedWebhookEvent = WhopSDK::Models::IdentityProfileApprovedWebhookEvent
|
|
448
|
+
|
|
449
|
+
IdentityProfileNeedsActionWebhookEvent = WhopSDK::Models::IdentityProfileNeedsActionWebhookEvent
|
|
450
|
+
|
|
451
|
+
IdentityProfileRejectedWebhookEvent = WhopSDK::Models::IdentityProfileRejectedWebhookEvent
|
|
452
|
+
|
|
453
|
+
IdentityProfileUpdatedWebhookEvent = WhopSDK::Models::IdentityProfileUpdatedWebhookEvent
|
|
454
|
+
|
|
401
455
|
Invoice = WhopSDK::Models::Invoice
|
|
402
456
|
|
|
403
457
|
InvoiceCreatedWebhookEvent = WhopSDK::Models::InvoiceCreatedWebhookEvent
|
|
@@ -643,6 +697,8 @@ module WhopSDK
|
|
|
643
697
|
|
|
644
698
|
ResolutionCenterCaseUpdatedWebhookEvent = WhopSDK::Models::ResolutionCenterCaseUpdatedWebhookEvent
|
|
645
699
|
|
|
700
|
+
ResultLabelKeys = WhopSDK::Models::ResultLabelKeys
|
|
701
|
+
|
|
646
702
|
ReviewListParams = WhopSDK::Models::ReviewListParams
|
|
647
703
|
|
|
648
704
|
ReviewRetrieveParams = WhopSDK::Models::ReviewRetrieveParams
|
|
@@ -689,6 +745,8 @@ module WhopSDK
|
|
|
689
745
|
|
|
690
746
|
SupportChannelRetrieveParams = WhopSDK::Models::SupportChannelRetrieveParams
|
|
691
747
|
|
|
748
|
+
SwapCreateQuoteParams = WhopSDK::Models::SwapCreateQuoteParams
|
|
749
|
+
|
|
692
750
|
TaxIdentifierType = WhopSDK::Models::TaxIdentifierType
|
|
693
751
|
|
|
694
752
|
TaxType = WhopSDK::Models::TaxType
|
|
@@ -731,6 +789,12 @@ module WhopSDK
|
|
|
731
789
|
|
|
732
790
|
VisibilityFilter = WhopSDK::Models::VisibilityFilter
|
|
733
791
|
|
|
792
|
+
WalletBalanceParams = WhopSDK::Models::WalletBalanceParams
|
|
793
|
+
|
|
794
|
+
WalletListParams = WhopSDK::Models::WalletListParams
|
|
795
|
+
|
|
796
|
+
WalletSendParams = WhopSDK::Models::WalletSendParams
|
|
797
|
+
|
|
734
798
|
Webhook = WhopSDK::Models::Webhook
|
|
735
799
|
|
|
736
800
|
WebhookCreateParams = WhopSDK::Models::WebhookCreateParams
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Accounts
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::AccountCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Creates an account. User tokens create business accounts; business account API
|
|
10
|
+
# keys create connected accounts.
|
|
11
|
+
#
|
|
12
|
+
# @overload create(email: nil, metadata: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param email [String] The email address of the account owner. Required for business account API key re
|
|
15
|
+
#
|
|
16
|
+
# @param metadata [Hash{Symbol=>Object}] Arbitrary key/value metadata to store on the account.
|
|
17
|
+
#
|
|
18
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
19
|
+
#
|
|
20
|
+
# @return [WhopSDK::Models::Account]
|
|
21
|
+
#
|
|
22
|
+
# @see WhopSDK::Models::AccountCreateParams
|
|
23
|
+
def create(params = {})
|
|
24
|
+
parsed, options = WhopSDK::AccountCreateParams.dump_request(params)
|
|
25
|
+
@client.request(
|
|
26
|
+
method: :post,
|
|
27
|
+
path: "accounts",
|
|
28
|
+
body: parsed,
|
|
29
|
+
model: WhopSDK::Account,
|
|
30
|
+
options: options
|
|
31
|
+
)
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Retrieves a single account visible to the credential, including its crypto
|
|
35
|
+
# wallet.
|
|
36
|
+
#
|
|
37
|
+
# @overload retrieve(account_id, request_options: {})
|
|
38
|
+
#
|
|
39
|
+
# @param account_id [String] The ID of the account, which will look like biz\_******\*******
|
|
40
|
+
#
|
|
41
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
42
|
+
#
|
|
43
|
+
# @return [WhopSDK::Models::Account]
|
|
44
|
+
#
|
|
45
|
+
# @see WhopSDK::Models::AccountRetrieveParams
|
|
46
|
+
def retrieve(account_id, params = {})
|
|
47
|
+
@client.request(
|
|
48
|
+
method: :get,
|
|
49
|
+
path: ["accounts/%1$s", account_id],
|
|
50
|
+
model: WhopSDK::Account,
|
|
51
|
+
options: params[:request_options]
|
|
52
|
+
)
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Some parameter documentations has been truncated, see
|
|
56
|
+
# {WhopSDK::Models::AccountUpdateParams} for more details.
|
|
57
|
+
#
|
|
58
|
+
# Updates an account. User tokens can update business accounts; business account
|
|
59
|
+
# API keys can update connected accounts.
|
|
60
|
+
#
|
|
61
|
+
# @overload update(account_id, affiliate_application_required: nil, affiliate_instructions: nil, banner_image: nil, business_type: nil, description: nil, featured_affiliate_product_id: nil, industry_group: nil, industry_type: nil, logo: nil, metadata: nil, route: nil, send_customer_emails: nil, social_links: nil, target_audience: nil, title: nil, request_options: {})
|
|
62
|
+
#
|
|
63
|
+
# @param account_id [String] The ID of the account, which will look like biz\_******\*******
|
|
64
|
+
#
|
|
65
|
+
# @param affiliate_application_required [Boolean] Whether prospective affiliates must submit an application before promoting this
|
|
66
|
+
#
|
|
67
|
+
# @param affiliate_instructions [String, nil] Guidelines shown to affiliates promoting this account.
|
|
68
|
+
#
|
|
69
|
+
# @param banner_image [Hash{Symbol=>Object}, nil] Attachment input for the account banner image.
|
|
70
|
+
#
|
|
71
|
+
# @param business_type [String, nil] The high-level business category for the account.
|
|
72
|
+
#
|
|
73
|
+
# @param description [String, nil] A promotional description for the account.
|
|
74
|
+
#
|
|
75
|
+
# @param featured_affiliate_product_id [String, nil] The ID of the product to feature for affiliates. Pass null to clear.
|
|
76
|
+
#
|
|
77
|
+
# @param industry_group [String, nil] The industry group the account belongs to.
|
|
78
|
+
#
|
|
79
|
+
# @param industry_type [String, nil] The specific industry vertical the account operates in.
|
|
80
|
+
#
|
|
81
|
+
# @param logo [Hash{Symbol=>Object}, nil] Attachment input for the account logo.
|
|
82
|
+
#
|
|
83
|
+
# @param metadata [Hash{Symbol=>Object}] Arbitrary key/value metadata to store on the account.
|
|
84
|
+
#
|
|
85
|
+
# @param route [String, nil] The unique URL slug for the account.
|
|
86
|
+
#
|
|
87
|
+
# @param send_customer_emails [Boolean] Whether Whop sends transactional emails to customers on behalf of this account.
|
|
88
|
+
#
|
|
89
|
+
# @param social_links [Array<Hash{Symbol=>Object}>] The full list of social links to display for the account.
|
|
90
|
+
#
|
|
91
|
+
# @param target_audience [String, nil] The target audience for this account.
|
|
92
|
+
#
|
|
93
|
+
# @param title [String, nil] The display name of the account.
|
|
94
|
+
#
|
|
95
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
96
|
+
#
|
|
97
|
+
# @return [WhopSDK::Models::Account]
|
|
98
|
+
#
|
|
99
|
+
# @see WhopSDK::Models::AccountUpdateParams
|
|
100
|
+
def update(account_id, params = {})
|
|
101
|
+
parsed, options = WhopSDK::AccountUpdateParams.dump_request(params)
|
|
102
|
+
@client.request(
|
|
103
|
+
method: :patch,
|
|
104
|
+
path: ["accounts/%1$s", account_id],
|
|
105
|
+
body: parsed,
|
|
106
|
+
model: WhopSDK::Account,
|
|
107
|
+
options: options
|
|
108
|
+
)
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Some parameter documentations has been truncated, see
|
|
112
|
+
# {WhopSDK::Models::AccountListParams} for more details.
|
|
113
|
+
#
|
|
114
|
+
# Lists accounts visible to the credential. User tokens return the user's business
|
|
115
|
+
# accounts; business account API keys return the requesting business account and
|
|
116
|
+
# its connected accounts.
|
|
117
|
+
#
|
|
118
|
+
# @overload list(page: nil, per: nil, request_options: {})
|
|
119
|
+
#
|
|
120
|
+
# @param page [Integer] The page number to retrieve
|
|
121
|
+
#
|
|
122
|
+
# @param per [Integer] The number of resources to return per page. There is a limit of 50 results per p
|
|
123
|
+
#
|
|
124
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
125
|
+
#
|
|
126
|
+
# @return [WhopSDK::Models::AccountListResponse]
|
|
127
|
+
#
|
|
128
|
+
# @see WhopSDK::Models::AccountListParams
|
|
129
|
+
def list(params = {})
|
|
130
|
+
parsed, options = WhopSDK::AccountListParams.dump_request(params)
|
|
131
|
+
query = WhopSDK::Internal::Util.encode_query_params(parsed)
|
|
132
|
+
@client.request(
|
|
133
|
+
method: :get,
|
|
134
|
+
path: "accounts",
|
|
135
|
+
query: query,
|
|
136
|
+
model: WhopSDK::Models::AccountListResponse,
|
|
137
|
+
options: options
|
|
138
|
+
)
|
|
139
|
+
end
|
|
140
|
+
|
|
141
|
+
# Retrieves the business account associated with the current business account API
|
|
142
|
+
# key.
|
|
143
|
+
#
|
|
144
|
+
# @overload me(request_options: {})
|
|
145
|
+
#
|
|
146
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
147
|
+
#
|
|
148
|
+
# @return [WhopSDK::Models::Account]
|
|
149
|
+
#
|
|
150
|
+
# @see WhopSDK::Models::AccountMeParams
|
|
151
|
+
def me(params = {})
|
|
152
|
+
@client.request(
|
|
153
|
+
method: :get,
|
|
154
|
+
path: "accounts/me",
|
|
155
|
+
model: WhopSDK::Account,
|
|
156
|
+
options: params[:request_options]
|
|
157
|
+
)
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
# @api private
|
|
161
|
+
#
|
|
162
|
+
# @param client [WhopSDK::Client]
|
|
163
|
+
def initialize(client:)
|
|
164
|
+
@client = client
|
|
165
|
+
end
|
|
166
|
+
end
|
|
167
|
+
end
|
|
168
|
+
end
|
|
@@ -16,14 +16,14 @@ module WhopSDK
|
|
|
16
16
|
#
|
|
17
17
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
18
18
|
#
|
|
19
|
-
# @return [WhopSDK::Models::
|
|
19
|
+
# @return [WhopSDK::Models::AdCampaign]
|
|
20
20
|
#
|
|
21
21
|
# @see WhopSDK::Models::AdCampaignRetrieveParams
|
|
22
22
|
def retrieve(id, params = {})
|
|
23
23
|
@client.request(
|
|
24
24
|
method: :get,
|
|
25
25
|
path: ["ad_campaigns/%1$s", id],
|
|
26
|
-
model: WhopSDK::
|
|
26
|
+
model: WhopSDK::AdCampaign,
|
|
27
27
|
options: params[:request_options]
|
|
28
28
|
)
|
|
29
29
|
end
|
|
@@ -45,7 +45,7 @@ module WhopSDK
|
|
|
45
45
|
#
|
|
46
46
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
47
47
|
#
|
|
48
|
-
# @return [WhopSDK::Models::
|
|
48
|
+
# @return [WhopSDK::Models::AdCampaign]
|
|
49
49
|
#
|
|
50
50
|
# @see WhopSDK::Models::AdCampaignUpdateParams
|
|
51
51
|
def update(id, params = {})
|
|
@@ -54,7 +54,7 @@ module WhopSDK
|
|
|
54
54
|
method: :patch,
|
|
55
55
|
path: ["ad_campaigns/%1$s", id],
|
|
56
56
|
body: parsed,
|
|
57
|
-
model: WhopSDK::
|
|
57
|
+
model: WhopSDK::AdCampaign,
|
|
58
58
|
options: options
|
|
59
59
|
)
|
|
60
60
|
end
|
|
@@ -66,14 +66,14 @@ module WhopSDK
|
|
|
66
66
|
#
|
|
67
67
|
# - `ad_campaign:basic:read`
|
|
68
68
|
#
|
|
69
|
-
# @overload list(
|
|
70
|
-
#
|
|
71
|
-
# @param company_id [String] The unique identifier of the company to list ad campaigns for.
|
|
69
|
+
# @overload list(after: nil, before: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
|
|
72
70
|
#
|
|
73
71
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
74
72
|
#
|
|
75
73
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
76
74
|
#
|
|
75
|
+
# @param company_id [String, nil] The unique identifier of the company to list ad campaigns for.
|
|
76
|
+
#
|
|
77
77
|
# @param created_after [Time, nil] Only return ad campaigns created after this timestamp.
|
|
78
78
|
#
|
|
79
79
|
# @param created_before [Time, nil] Only return ad campaigns created before this timestamp.
|
|
@@ -84,14 +84,14 @@ module WhopSDK
|
|
|
84
84
|
#
|
|
85
85
|
# @param query [String, nil] Case-insensitive substring match against the campaign title.
|
|
86
86
|
#
|
|
87
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
87
|
+
# @param status [Symbol, WhopSDK::Models::AdCampaignStatus, nil] The status of an ad campaign.
|
|
88
88
|
#
|
|
89
89
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
90
90
|
#
|
|
91
91
|
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AdCampaignListResponse>]
|
|
92
92
|
#
|
|
93
93
|
# @see WhopSDK::Models::AdCampaignListParams
|
|
94
|
-
def list(params)
|
|
94
|
+
def list(params = {})
|
|
95
95
|
parsed, options = WhopSDK::AdCampaignListParams.dump_request(params)
|
|
96
96
|
query = WhopSDK::Internal::Util.encode_query_params(parsed)
|
|
97
97
|
@client.request(
|
|
@@ -116,14 +116,14 @@ module WhopSDK
|
|
|
116
116
|
#
|
|
117
117
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
118
118
|
#
|
|
119
|
-
# @return [WhopSDK::Models::
|
|
119
|
+
# @return [WhopSDK::Models::AdCampaign]
|
|
120
120
|
#
|
|
121
121
|
# @see WhopSDK::Models::AdCampaignPauseParams
|
|
122
122
|
def pause(id, params = {})
|
|
123
123
|
@client.request(
|
|
124
124
|
method: :post,
|
|
125
125
|
path: ["ad_campaigns/%1$s/pause", id],
|
|
126
|
-
model: WhopSDK::
|
|
126
|
+
model: WhopSDK::AdCampaign,
|
|
127
127
|
options: params[:request_options]
|
|
128
128
|
)
|
|
129
129
|
end
|
|
@@ -140,14 +140,14 @@ module WhopSDK
|
|
|
140
140
|
#
|
|
141
141
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
142
142
|
#
|
|
143
|
-
# @return [WhopSDK::Models::
|
|
143
|
+
# @return [WhopSDK::Models::AdCampaign]
|
|
144
144
|
#
|
|
145
145
|
# @see WhopSDK::Models::AdCampaignUnpauseParams
|
|
146
146
|
def unpause(id, params = {})
|
|
147
147
|
@client.request(
|
|
148
148
|
method: :post,
|
|
149
149
|
path: ["ad_campaigns/%1$s/unpause", id],
|
|
150
|
-
model: WhopSDK::
|
|
150
|
+
model: WhopSDK::AdCampaign,
|
|
151
151
|
options: params[:request_options]
|
|
152
152
|
)
|
|
153
153
|
end
|
|
@@ -16,14 +16,14 @@ module WhopSDK
|
|
|
16
16
|
#
|
|
17
17
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
18
18
|
#
|
|
19
|
-
# @return [WhopSDK::Models::
|
|
19
|
+
# @return [WhopSDK::Models::AdGroup]
|
|
20
20
|
#
|
|
21
21
|
# @see WhopSDK::Models::AdGroupRetrieveParams
|
|
22
22
|
def retrieve(id, params = {})
|
|
23
23
|
@client.request(
|
|
24
24
|
method: :get,
|
|
25
25
|
path: ["ad_groups/%1$s", id],
|
|
26
|
-
model: WhopSDK::
|
|
26
|
+
model: WhopSDK::AdGroup,
|
|
27
27
|
options: params[:request_options]
|
|
28
28
|
)
|
|
29
29
|
end
|
|
@@ -41,7 +41,7 @@ module WhopSDK
|
|
|
41
41
|
#
|
|
42
42
|
# @param budget [Float, nil] Budget amount in dollars.
|
|
43
43
|
#
|
|
44
|
-
# @param budget_type [Symbol, WhopSDK::Models::
|
|
44
|
+
# @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
|
|
45
45
|
#
|
|
46
46
|
# @param config [WhopSDK::Models::AdGroupUpdateParams::Config, nil] Unified ad group configuration (bidding, optimization, targeting).
|
|
47
47
|
#
|
|
@@ -51,11 +51,11 @@ module WhopSDK
|
|
|
51
51
|
#
|
|
52
52
|
# @param platform_config [WhopSDK::Models::AdGroupUpdateParams::PlatformConfig, nil] Platform-specific ad group configuration.
|
|
53
53
|
#
|
|
54
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
54
|
+
# @param status [Symbol, WhopSDK::Models::AdGroupStatus, nil] The status of an external ad group.
|
|
55
55
|
#
|
|
56
56
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
57
57
|
#
|
|
58
|
-
# @return [WhopSDK::Models::
|
|
58
|
+
# @return [WhopSDK::Models::AdGroup]
|
|
59
59
|
#
|
|
60
60
|
# @see WhopSDK::Models::AdGroupUpdateParams
|
|
61
61
|
def update(id, params = {})
|
|
@@ -64,11 +64,14 @@ module WhopSDK
|
|
|
64
64
|
method: :patch,
|
|
65
65
|
path: ["ad_groups/%1$s", id],
|
|
66
66
|
body: parsed,
|
|
67
|
-
model: WhopSDK::
|
|
67
|
+
model: WhopSDK::AdGroup,
|
|
68
68
|
options: options
|
|
69
69
|
)
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
# Some parameter documentations has been truncated, see
|
|
73
|
+
# {WhopSDK::Models::AdGroupListParams} for more details.
|
|
74
|
+
#
|
|
72
75
|
# Returns a paginated list of ad groups scoped by campaign or company, with
|
|
73
76
|
# optional filtering by status and creation date.
|
|
74
77
|
#
|
|
@@ -76,7 +79,7 @@ module WhopSDK
|
|
|
76
79
|
#
|
|
77
80
|
# - `ad_campaign:basic:read`
|
|
78
81
|
#
|
|
79
|
-
# @overload list(after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
|
|
82
|
+
# @overload list(after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, include_paused: nil, last: nil, query: nil, status: nil, request_options: {})
|
|
80
83
|
#
|
|
81
84
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
82
85
|
#
|
|
@@ -92,11 +95,13 @@ module WhopSDK
|
|
|
92
95
|
#
|
|
93
96
|
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
94
97
|
#
|
|
98
|
+
# @param include_paused [Boolean, nil] When false, excludes paused ad groups so pagination matches the dashboard's hide
|
|
99
|
+
#
|
|
95
100
|
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
96
101
|
#
|
|
97
102
|
# @param query [String, nil] Case-insensitive substring match against the ad group name.
|
|
98
103
|
#
|
|
99
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
104
|
+
# @param status [Symbol, WhopSDK::Models::AdGroupStatus, nil] The status of an external ad group.
|
|
100
105
|
#
|
|
101
106
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
102
107
|
#
|
|
@@ -140,6 +145,56 @@ module WhopSDK
|
|
|
140
145
|
)
|
|
141
146
|
end
|
|
142
147
|
|
|
148
|
+
# Pauses an ad group.
|
|
149
|
+
#
|
|
150
|
+
# Required permissions:
|
|
151
|
+
#
|
|
152
|
+
# - `ad_campaign:update`
|
|
153
|
+
# - `ad_campaign:basic:read`
|
|
154
|
+
#
|
|
155
|
+
# @overload pause(id, request_options: {})
|
|
156
|
+
#
|
|
157
|
+
# @param id [String] The unique identifier of the ad group to pause.
|
|
158
|
+
#
|
|
159
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
160
|
+
#
|
|
161
|
+
# @return [WhopSDK::Models::AdGroup]
|
|
162
|
+
#
|
|
163
|
+
# @see WhopSDK::Models::AdGroupPauseParams
|
|
164
|
+
def pause(id, params = {})
|
|
165
|
+
@client.request(
|
|
166
|
+
method: :post,
|
|
167
|
+
path: ["ad_groups/%1$s/pause", id],
|
|
168
|
+
model: WhopSDK::AdGroup,
|
|
169
|
+
options: params[:request_options]
|
|
170
|
+
)
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# Resumes a paused ad group.
|
|
174
|
+
#
|
|
175
|
+
# Required permissions:
|
|
176
|
+
#
|
|
177
|
+
# - `ad_campaign:update`
|
|
178
|
+
# - `ad_campaign:basic:read`
|
|
179
|
+
#
|
|
180
|
+
# @overload unpause(id, request_options: {})
|
|
181
|
+
#
|
|
182
|
+
# @param id [String] The unique identifier of the ad group to unpause.
|
|
183
|
+
#
|
|
184
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
185
|
+
#
|
|
186
|
+
# @return [WhopSDK::Models::AdGroup]
|
|
187
|
+
#
|
|
188
|
+
# @see WhopSDK::Models::AdGroupUnpauseParams
|
|
189
|
+
def unpause(id, params = {})
|
|
190
|
+
@client.request(
|
|
191
|
+
method: :post,
|
|
192
|
+
path: ["ad_groups/%1$s/unpause", id],
|
|
193
|
+
model: WhopSDK::AdGroup,
|
|
194
|
+
options: params[:request_options]
|
|
195
|
+
)
|
|
196
|
+
end
|
|
197
|
+
|
|
143
198
|
# @api private
|
|
144
199
|
#
|
|
145
200
|
# @param client [WhopSDK::Client]
|
|
@@ -7,29 +7,35 @@ module WhopSDK
|
|
|
7
7
|
# Some parameter documentations has been truncated, see
|
|
8
8
|
# {WhopSDK::Models::AdReportRetrieveParams} for more details.
|
|
9
9
|
#
|
|
10
|
-
# Performance report for
|
|
11
|
-
#
|
|
12
|
-
# or `
|
|
10
|
+
# Performance report for a company, ad campaign, ad group, or ad. Always returns
|
|
11
|
+
# aggregate `summary` totals. Set `granularity` (`daily`/`hourly`) to additionally
|
|
12
|
+
# get a time series, or set `breakdown` (`campaign`/`ad_group`/`ad`) to
|
|
13
|
+
# additionally get per-entity rows inside the requested scope. Exactly one of
|
|
14
|
+
# `companyId`, `adCampaignId`, `adGroupId`, or `adId` must be provided.
|
|
13
15
|
#
|
|
14
16
|
# Required permissions:
|
|
15
17
|
#
|
|
16
18
|
# - `ad_campaign:stats:read`
|
|
17
19
|
#
|
|
18
|
-
# @overload retrieve(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, currency: nil,
|
|
20
|
+
# @overload retrieve(from:, to:, ad_campaign_id: nil, ad_group_id: nil, ad_id: nil, breakdown: nil, company_id: nil, currency: nil, granularity: nil, request_options: {})
|
|
19
21
|
#
|
|
20
22
|
# @param from [Time] Inclusive start of the reporting window.
|
|
21
23
|
#
|
|
22
24
|
# @param to [Time] Inclusive end of the reporting window.
|
|
23
25
|
#
|
|
24
|
-
# @param ad_campaign_id [String, nil] The unique identifier of an ad campaign. Mutually exclusive with `
|
|
26
|
+
# @param ad_campaign_id [String, nil] The unique identifier of an ad campaign. Mutually exclusive with `companyId`, `a
|
|
25
27
|
#
|
|
26
|
-
# @param ad_group_id [String, nil] The unique identifier of an ad group. Mutually exclusive with `
|
|
28
|
+
# @param ad_group_id [String, nil] The unique identifier of an ad group. Mutually exclusive with `companyId`, `adCa
|
|
27
29
|
#
|
|
28
|
-
# @param ad_id [String, nil] The unique identifier of an ad. Mutually exclusive with `
|
|
30
|
+
# @param ad_id [String, nil] The unique identifier of an ad. Mutually exclusive with `companyId`, `adCampaign
|
|
31
|
+
#
|
|
32
|
+
# @param breakdown [Symbol, WhopSDK::Models::AdReportRetrieveParams::Breakdown, nil] Entity level to group an ad report by.
|
|
33
|
+
#
|
|
34
|
+
# @param company_id [String, nil] The unique identifier of a company. Mutually exclusive with `adCampaignId`, `adG
|
|
29
35
|
#
|
|
30
36
|
# @param currency [String, nil] ISO 4217 currency code to report `spend` in. Defaults to the company's ads repor
|
|
31
37
|
#
|
|
32
|
-
# @param
|
|
38
|
+
# @param granularity [Symbol, WhopSDK::Models::Granularities, nil] Bucket size for external ad stat rows.
|
|
33
39
|
#
|
|
34
40
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
35
41
|
#
|