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
|
@@ -20,13 +20,7 @@ module WhopSDK
|
|
|
20
20
|
attr_accessor :budget
|
|
21
21
|
|
|
22
22
|
# The budget type for an ad campaign or ad group.
|
|
23
|
-
sig
|
|
24
|
-
returns(
|
|
25
|
-
T.nilable(
|
|
26
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::TaggedSymbol
|
|
27
|
-
)
|
|
28
|
-
)
|
|
29
|
-
end
|
|
23
|
+
sig { returns(T.nilable(WhopSDK::AdBudgetType::TaggedSymbol)) }
|
|
30
24
|
attr_accessor :budget_type
|
|
31
25
|
|
|
32
26
|
# When the ad campaign was created.
|
|
@@ -34,15 +28,11 @@ module WhopSDK
|
|
|
34
28
|
attr_accessor :created_at
|
|
35
29
|
|
|
36
30
|
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
37
|
-
sig
|
|
38
|
-
returns(WhopSDK::Models::AdCampaignListResponse::Platform::TaggedSymbol)
|
|
39
|
-
end
|
|
31
|
+
sig { returns(WhopSDK::AdCampaignPlatform::TaggedSymbol) }
|
|
40
32
|
attr_accessor :platform
|
|
41
33
|
|
|
42
34
|
# Current status of the campaign (active, paused, or inactive).
|
|
43
|
-
sig
|
|
44
|
-
returns(WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol)
|
|
45
|
-
end
|
|
35
|
+
sig { returns(WhopSDK::AdCampaignStatus::TaggedSymbol) }
|
|
46
36
|
attr_accessor :status
|
|
47
37
|
|
|
48
38
|
# The campaign name shown in the Whop dashboard.
|
|
@@ -62,13 +52,10 @@ module WhopSDK
|
|
|
62
52
|
params(
|
|
63
53
|
id: String,
|
|
64
54
|
budget: T.nilable(Float),
|
|
65
|
-
budget_type:
|
|
66
|
-
T.nilable(
|
|
67
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::OrSymbol
|
|
68
|
-
),
|
|
55
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::OrSymbol),
|
|
69
56
|
created_at: Time,
|
|
70
|
-
platform: WhopSDK::
|
|
71
|
-
status: WhopSDK::
|
|
57
|
+
platform: WhopSDK::AdCampaignPlatform::OrSymbol,
|
|
58
|
+
status: WhopSDK::AdCampaignStatus::OrSymbol,
|
|
72
59
|
title: String,
|
|
73
60
|
total_spend: Float,
|
|
74
61
|
updated_at: Time
|
|
@@ -101,15 +88,10 @@ module WhopSDK
|
|
|
101
88
|
{
|
|
102
89
|
id: String,
|
|
103
90
|
budget: T.nilable(Float),
|
|
104
|
-
budget_type:
|
|
105
|
-
T.nilable(
|
|
106
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::TaggedSymbol
|
|
107
|
-
),
|
|
91
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::TaggedSymbol),
|
|
108
92
|
created_at: Time,
|
|
109
|
-
platform:
|
|
110
|
-
|
|
111
|
-
status:
|
|
112
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol,
|
|
93
|
+
platform: WhopSDK::AdCampaignPlatform::TaggedSymbol,
|
|
94
|
+
status: WhopSDK::AdCampaignStatus::TaggedSymbol,
|
|
113
95
|
title: String,
|
|
114
96
|
total_spend: Float,
|
|
115
97
|
updated_at: Time
|
|
@@ -118,122 +100,6 @@ module WhopSDK
|
|
|
118
100
|
end
|
|
119
101
|
def to_hash
|
|
120
102
|
end
|
|
121
|
-
|
|
122
|
-
# The budget type for an ad campaign or ad group.
|
|
123
|
-
module BudgetType
|
|
124
|
-
extend WhopSDK::Internal::Type::Enum
|
|
125
|
-
|
|
126
|
-
TaggedSymbol =
|
|
127
|
-
T.type_alias do
|
|
128
|
-
T.all(Symbol, WhopSDK::Models::AdCampaignListResponse::BudgetType)
|
|
129
|
-
end
|
|
130
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
131
|
-
|
|
132
|
-
DAILY =
|
|
133
|
-
T.let(
|
|
134
|
-
:daily,
|
|
135
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::TaggedSymbol
|
|
136
|
-
)
|
|
137
|
-
LIFETIME =
|
|
138
|
-
T.let(
|
|
139
|
-
:lifetime,
|
|
140
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::TaggedSymbol
|
|
141
|
-
)
|
|
142
|
-
|
|
143
|
-
sig do
|
|
144
|
-
override.returns(
|
|
145
|
-
T::Array[
|
|
146
|
-
WhopSDK::Models::AdCampaignListResponse::BudgetType::TaggedSymbol
|
|
147
|
-
]
|
|
148
|
-
)
|
|
149
|
-
end
|
|
150
|
-
def self.values
|
|
151
|
-
end
|
|
152
|
-
end
|
|
153
|
-
|
|
154
|
-
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
155
|
-
module Platform
|
|
156
|
-
extend WhopSDK::Internal::Type::Enum
|
|
157
|
-
|
|
158
|
-
TaggedSymbol =
|
|
159
|
-
T.type_alias do
|
|
160
|
-
T.all(Symbol, WhopSDK::Models::AdCampaignListResponse::Platform)
|
|
161
|
-
end
|
|
162
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
163
|
-
|
|
164
|
-
META =
|
|
165
|
-
T.let(
|
|
166
|
-
:meta,
|
|
167
|
-
WhopSDK::Models::AdCampaignListResponse::Platform::TaggedSymbol
|
|
168
|
-
)
|
|
169
|
-
TIKTOK =
|
|
170
|
-
T.let(
|
|
171
|
-
:tiktok,
|
|
172
|
-
WhopSDK::Models::AdCampaignListResponse::Platform::TaggedSymbol
|
|
173
|
-
)
|
|
174
|
-
|
|
175
|
-
sig do
|
|
176
|
-
override.returns(
|
|
177
|
-
T::Array[
|
|
178
|
-
WhopSDK::Models::AdCampaignListResponse::Platform::TaggedSymbol
|
|
179
|
-
]
|
|
180
|
-
)
|
|
181
|
-
end
|
|
182
|
-
def self.values
|
|
183
|
-
end
|
|
184
|
-
end
|
|
185
|
-
|
|
186
|
-
# Current status of the campaign (active, paused, or inactive).
|
|
187
|
-
module Status
|
|
188
|
-
extend WhopSDK::Internal::Type::Enum
|
|
189
|
-
|
|
190
|
-
TaggedSymbol =
|
|
191
|
-
T.type_alias do
|
|
192
|
-
T.all(Symbol, WhopSDK::Models::AdCampaignListResponse::Status)
|
|
193
|
-
end
|
|
194
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
195
|
-
|
|
196
|
-
ACTIVE =
|
|
197
|
-
T.let(
|
|
198
|
-
:active,
|
|
199
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
200
|
-
)
|
|
201
|
-
PAUSED =
|
|
202
|
-
T.let(
|
|
203
|
-
:paused,
|
|
204
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
205
|
-
)
|
|
206
|
-
PAYMENT_FAILED =
|
|
207
|
-
T.let(
|
|
208
|
-
:payment_failed,
|
|
209
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
210
|
-
)
|
|
211
|
-
DRAFT =
|
|
212
|
-
T.let(
|
|
213
|
-
:draft,
|
|
214
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
215
|
-
)
|
|
216
|
-
IN_REVIEW =
|
|
217
|
-
T.let(
|
|
218
|
-
:in_review,
|
|
219
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
220
|
-
)
|
|
221
|
-
FLAGGED =
|
|
222
|
-
T.let(
|
|
223
|
-
:flagged,
|
|
224
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
225
|
-
)
|
|
226
|
-
|
|
227
|
-
sig do
|
|
228
|
-
override.returns(
|
|
229
|
-
T::Array[
|
|
230
|
-
WhopSDK::Models::AdCampaignListResponse::Status::TaggedSymbol
|
|
231
|
-
]
|
|
232
|
-
)
|
|
233
|
-
end
|
|
234
|
-
def self.values
|
|
235
|
-
end
|
|
236
|
-
end
|
|
237
103
|
end
|
|
238
104
|
end
|
|
239
105
|
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The platforms where an ad campaign can run.
|
|
6
|
+
module AdCampaignPlatform
|
|
7
|
+
extend WhopSDK::Internal::Type::Enum
|
|
8
|
+
|
|
9
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::AdCampaignPlatform) }
|
|
10
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
11
|
+
|
|
12
|
+
META = T.let(:meta, WhopSDK::AdCampaignPlatform::TaggedSymbol)
|
|
13
|
+
TIKTOK = T.let(:tiktok, WhopSDK::AdCampaignPlatform::TaggedSymbol)
|
|
14
|
+
|
|
15
|
+
sig do
|
|
16
|
+
override.returns(T::Array[WhopSDK::AdCampaignPlatform::TaggedSymbol])
|
|
17
|
+
end
|
|
18
|
+
def self.values
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The status of an ad campaign.
|
|
6
|
+
module AdCampaignStatus
|
|
7
|
+
extend WhopSDK::Internal::Type::Enum
|
|
8
|
+
|
|
9
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, WhopSDK::AdCampaignStatus) }
|
|
10
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
11
|
+
|
|
12
|
+
ACTIVE = T.let(:active, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
13
|
+
PAUSED = T.let(:paused, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
14
|
+
PAYMENT_FAILED =
|
|
15
|
+
T.let(:payment_failed, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
16
|
+
DRAFT = T.let(:draft, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
17
|
+
IN_REVIEW = T.let(:in_review, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
18
|
+
FLAGGED = T.let(:flagged, WhopSDK::AdCampaignStatus::TaggedSymbol)
|
|
19
|
+
|
|
20
|
+
sig do
|
|
21
|
+
override.returns(T::Array[WhopSDK::AdCampaignStatus::TaggedSymbol])
|
|
22
|
+
end
|
|
23
|
+
def self.values
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class AdGroup < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias { T.any(WhopSDK::AdGroup, WhopSDK::Internal::AnyHash) }
|
|
8
|
+
|
|
9
|
+
# The unique identifier for this ad group.
|
|
10
|
+
sig { returns(String) }
|
|
11
|
+
attr_accessor :id
|
|
12
|
+
|
|
13
|
+
# The ad campaign this ad group belongs to.
|
|
14
|
+
sig { returns(WhopSDK::AdGroup::AdCampaign) }
|
|
15
|
+
attr_reader :ad_campaign
|
|
16
|
+
|
|
17
|
+
sig { params(ad_campaign: WhopSDK::AdGroup::AdCampaign::OrHash).void }
|
|
18
|
+
attr_writer :ad_campaign
|
|
19
|
+
|
|
20
|
+
# Budget amount in dollars.
|
|
21
|
+
sig { returns(T.nilable(Float)) }
|
|
22
|
+
attr_accessor :budget
|
|
23
|
+
|
|
24
|
+
# The budget type for an ad campaign or ad group.
|
|
25
|
+
sig { returns(T.nilable(WhopSDK::AdBudgetType::TaggedSymbol)) }
|
|
26
|
+
attr_accessor :budget_type
|
|
27
|
+
|
|
28
|
+
# When the ad group was created.
|
|
29
|
+
sig { returns(Time) }
|
|
30
|
+
attr_accessor :created_at
|
|
31
|
+
|
|
32
|
+
# The external ad platform this ad group is running on (e.g., meta, tiktok).
|
|
33
|
+
sig { returns(WhopSDK::AdCampaignPlatform::TaggedSymbol) }
|
|
34
|
+
attr_accessor :platform
|
|
35
|
+
|
|
36
|
+
# Current operational status of the ad group.
|
|
37
|
+
sig { returns(WhopSDK::AdGroupStatus::TaggedSymbol) }
|
|
38
|
+
attr_accessor :status
|
|
39
|
+
|
|
40
|
+
# Human-readable name shown on the external platform.
|
|
41
|
+
sig { returns(T.nilable(String)) }
|
|
42
|
+
attr_accessor :title
|
|
43
|
+
|
|
44
|
+
# When the ad group was last updated.
|
|
45
|
+
sig { returns(Time) }
|
|
46
|
+
attr_accessor :updated_at
|
|
47
|
+
|
|
48
|
+
# An ad group (ad set) belonging to an ad campaign.
|
|
49
|
+
sig do
|
|
50
|
+
params(
|
|
51
|
+
id: String,
|
|
52
|
+
ad_campaign: WhopSDK::AdGroup::AdCampaign::OrHash,
|
|
53
|
+
budget: T.nilable(Float),
|
|
54
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::OrSymbol),
|
|
55
|
+
created_at: Time,
|
|
56
|
+
platform: WhopSDK::AdCampaignPlatform::OrSymbol,
|
|
57
|
+
status: WhopSDK::AdGroupStatus::OrSymbol,
|
|
58
|
+
title: T.nilable(String),
|
|
59
|
+
updated_at: Time
|
|
60
|
+
).returns(T.attached_class)
|
|
61
|
+
end
|
|
62
|
+
def self.new(
|
|
63
|
+
# The unique identifier for this ad group.
|
|
64
|
+
id:,
|
|
65
|
+
# The ad campaign this ad group belongs to.
|
|
66
|
+
ad_campaign:,
|
|
67
|
+
# Budget amount in dollars.
|
|
68
|
+
budget:,
|
|
69
|
+
# The budget type for an ad campaign or ad group.
|
|
70
|
+
budget_type:,
|
|
71
|
+
# When the ad group was created.
|
|
72
|
+
created_at:,
|
|
73
|
+
# The external ad platform this ad group is running on (e.g., meta, tiktok).
|
|
74
|
+
platform:,
|
|
75
|
+
# Current operational status of the ad group.
|
|
76
|
+
status:,
|
|
77
|
+
# Human-readable name shown on the external platform.
|
|
78
|
+
title:,
|
|
79
|
+
# When the ad group was last updated.
|
|
80
|
+
updated_at:
|
|
81
|
+
)
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
sig do
|
|
85
|
+
override.returns(
|
|
86
|
+
{
|
|
87
|
+
id: String,
|
|
88
|
+
ad_campaign: WhopSDK::AdGroup::AdCampaign,
|
|
89
|
+
budget: T.nilable(Float),
|
|
90
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::TaggedSymbol),
|
|
91
|
+
created_at: Time,
|
|
92
|
+
platform: WhopSDK::AdCampaignPlatform::TaggedSymbol,
|
|
93
|
+
status: WhopSDK::AdGroupStatus::TaggedSymbol,
|
|
94
|
+
title: T.nilable(String),
|
|
95
|
+
updated_at: Time
|
|
96
|
+
}
|
|
97
|
+
)
|
|
98
|
+
end
|
|
99
|
+
def to_hash
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
class AdCampaign < WhopSDK::Internal::Type::BaseModel
|
|
103
|
+
OrHash =
|
|
104
|
+
T.type_alias do
|
|
105
|
+
T.any(WhopSDK::AdGroup::AdCampaign, WhopSDK::Internal::AnyHash)
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# The unique identifier for this ad campaign.
|
|
109
|
+
sig { returns(String) }
|
|
110
|
+
attr_accessor :id
|
|
111
|
+
|
|
112
|
+
# The ad campaign this ad group belongs to.
|
|
113
|
+
sig { params(id: String).returns(T.attached_class) }
|
|
114
|
+
def self.new(
|
|
115
|
+
# The unique identifier for this ad campaign.
|
|
116
|
+
id:
|
|
117
|
+
)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
sig { override.returns({ id: String }) }
|
|
121
|
+
def to_hash
|
|
122
|
+
end
|
|
123
|
+
end
|
|
124
|
+
end
|
|
125
|
+
end
|
|
126
|
+
end
|
|
@@ -39,6 +39,11 @@ module WhopSDK
|
|
|
39
39
|
sig { returns(T.nilable(Integer)) }
|
|
40
40
|
attr_accessor :first
|
|
41
41
|
|
|
42
|
+
# When false, excludes paused ad groups so pagination matches the dashboard's
|
|
43
|
+
# hide-paused toggle.
|
|
44
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
45
|
+
attr_accessor :include_paused
|
|
46
|
+
|
|
42
47
|
# Returns the last _n_ elements from the list.
|
|
43
48
|
sig { returns(T.nilable(Integer)) }
|
|
44
49
|
attr_accessor :last
|
|
@@ -48,7 +53,7 @@ module WhopSDK
|
|
|
48
53
|
attr_accessor :query
|
|
49
54
|
|
|
50
55
|
# The status of an external ad group.
|
|
51
|
-
sig { returns(T.nilable(WhopSDK::
|
|
56
|
+
sig { returns(T.nilable(WhopSDK::AdGroupStatus::OrSymbol)) }
|
|
52
57
|
attr_accessor :status
|
|
53
58
|
|
|
54
59
|
sig do
|
|
@@ -60,9 +65,10 @@ module WhopSDK
|
|
|
60
65
|
created_after: T.nilable(Time),
|
|
61
66
|
created_before: T.nilable(Time),
|
|
62
67
|
first: T.nilable(Integer),
|
|
68
|
+
include_paused: T.nilable(T::Boolean),
|
|
63
69
|
last: T.nilable(Integer),
|
|
64
70
|
query: T.nilable(String),
|
|
65
|
-
status: T.nilable(WhopSDK::
|
|
71
|
+
status: T.nilable(WhopSDK::AdGroupStatus::OrSymbol),
|
|
66
72
|
request_options: WhopSDK::RequestOptions::OrHash
|
|
67
73
|
).returns(T.attached_class)
|
|
68
74
|
end
|
|
@@ -81,6 +87,9 @@ module WhopSDK
|
|
|
81
87
|
created_before: nil,
|
|
82
88
|
# Returns the first _n_ elements from the list.
|
|
83
89
|
first: nil,
|
|
90
|
+
# When false, excludes paused ad groups so pagination matches the dashboard's
|
|
91
|
+
# hide-paused toggle.
|
|
92
|
+
include_paused: nil,
|
|
84
93
|
# Returns the last _n_ elements from the list.
|
|
85
94
|
last: nil,
|
|
86
95
|
# Case-insensitive substring match against the ad group name.
|
|
@@ -101,45 +110,16 @@ module WhopSDK
|
|
|
101
110
|
created_after: T.nilable(Time),
|
|
102
111
|
created_before: T.nilable(Time),
|
|
103
112
|
first: T.nilable(Integer),
|
|
113
|
+
include_paused: T.nilable(T::Boolean),
|
|
104
114
|
last: T.nilable(Integer),
|
|
105
115
|
query: T.nilable(String),
|
|
106
|
-
status: T.nilable(WhopSDK::
|
|
116
|
+
status: T.nilable(WhopSDK::AdGroupStatus::OrSymbol),
|
|
107
117
|
request_options: WhopSDK::RequestOptions
|
|
108
118
|
}
|
|
109
119
|
)
|
|
110
120
|
end
|
|
111
121
|
def to_hash
|
|
112
122
|
end
|
|
113
|
-
|
|
114
|
-
# The status of an external ad group.
|
|
115
|
-
module Status
|
|
116
|
-
extend WhopSDK::Internal::Type::Enum
|
|
117
|
-
|
|
118
|
-
TaggedSymbol =
|
|
119
|
-
T.type_alias { T.all(Symbol, WhopSDK::AdGroupListParams::Status) }
|
|
120
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
121
|
-
|
|
122
|
-
ACTIVE =
|
|
123
|
-
T.let(:active, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
124
|
-
PAUSED =
|
|
125
|
-
T.let(:paused, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
126
|
-
INACTIVE =
|
|
127
|
-
T.let(:inactive, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
128
|
-
IN_REVIEW =
|
|
129
|
-
T.let(:in_review, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
130
|
-
REJECTED =
|
|
131
|
-
T.let(:rejected, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
132
|
-
FLAGGED =
|
|
133
|
-
T.let(:flagged, WhopSDK::AdGroupListParams::Status::TaggedSymbol)
|
|
134
|
-
|
|
135
|
-
sig do
|
|
136
|
-
override.returns(
|
|
137
|
-
T::Array[WhopSDK::AdGroupListParams::Status::TaggedSymbol]
|
|
138
|
-
)
|
|
139
|
-
end
|
|
140
|
-
def self.values
|
|
141
|
-
end
|
|
142
|
-
end
|
|
143
123
|
end
|
|
144
124
|
end
|
|
145
125
|
end
|
|
@@ -15,18 +15,23 @@ module WhopSDK
|
|
|
15
15
|
sig { returns(String) }
|
|
16
16
|
attr_accessor :id
|
|
17
17
|
|
|
18
|
+
# The ad campaign this ad group belongs to.
|
|
19
|
+
sig { returns(WhopSDK::Models::AdGroupListResponse::AdCampaign) }
|
|
20
|
+
attr_reader :ad_campaign
|
|
21
|
+
|
|
22
|
+
sig do
|
|
23
|
+
params(
|
|
24
|
+
ad_campaign: WhopSDK::Models::AdGroupListResponse::AdCampaign::OrHash
|
|
25
|
+
).void
|
|
26
|
+
end
|
|
27
|
+
attr_writer :ad_campaign
|
|
28
|
+
|
|
18
29
|
# Budget amount in dollars.
|
|
19
30
|
sig { returns(T.nilable(Float)) }
|
|
20
31
|
attr_accessor :budget
|
|
21
32
|
|
|
22
33
|
# The budget type for an ad campaign or ad group.
|
|
23
|
-
sig
|
|
24
|
-
returns(
|
|
25
|
-
T.nilable(
|
|
26
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::TaggedSymbol
|
|
27
|
-
)
|
|
28
|
-
)
|
|
29
|
-
end
|
|
34
|
+
sig { returns(T.nilable(WhopSDK::AdBudgetType::TaggedSymbol)) }
|
|
30
35
|
attr_accessor :budget_type
|
|
31
36
|
|
|
32
37
|
# When the ad group was created.
|
|
@@ -34,15 +39,11 @@ module WhopSDK
|
|
|
34
39
|
attr_accessor :created_at
|
|
35
40
|
|
|
36
41
|
# The external ad platform this ad group is running on (e.g., meta, tiktok).
|
|
37
|
-
sig
|
|
38
|
-
returns(WhopSDK::Models::AdGroupListResponse::Platform::TaggedSymbol)
|
|
39
|
-
end
|
|
42
|
+
sig { returns(WhopSDK::AdCampaignPlatform::TaggedSymbol) }
|
|
40
43
|
attr_accessor :platform
|
|
41
44
|
|
|
42
45
|
# Current operational status of the ad group.
|
|
43
|
-
sig
|
|
44
|
-
returns(WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol)
|
|
45
|
-
end
|
|
46
|
+
sig { returns(WhopSDK::AdGroupStatus::TaggedSymbol) }
|
|
46
47
|
attr_accessor :status
|
|
47
48
|
|
|
48
49
|
# Human-readable name shown on the external platform.
|
|
@@ -57,14 +58,12 @@ module WhopSDK
|
|
|
57
58
|
sig do
|
|
58
59
|
params(
|
|
59
60
|
id: String,
|
|
61
|
+
ad_campaign: WhopSDK::Models::AdGroupListResponse::AdCampaign::OrHash,
|
|
60
62
|
budget: T.nilable(Float),
|
|
61
|
-
budget_type:
|
|
62
|
-
T.nilable(
|
|
63
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::OrSymbol
|
|
64
|
-
),
|
|
63
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::OrSymbol),
|
|
65
64
|
created_at: Time,
|
|
66
|
-
platform: WhopSDK::
|
|
67
|
-
status: WhopSDK::
|
|
65
|
+
platform: WhopSDK::AdCampaignPlatform::OrSymbol,
|
|
66
|
+
status: WhopSDK::AdGroupStatus::OrSymbol,
|
|
68
67
|
title: T.nilable(String),
|
|
69
68
|
updated_at: Time
|
|
70
69
|
).returns(T.attached_class)
|
|
@@ -72,6 +71,8 @@ module WhopSDK
|
|
|
72
71
|
def self.new(
|
|
73
72
|
# The unique identifier for this ad group.
|
|
74
73
|
id:,
|
|
74
|
+
# The ad campaign this ad group belongs to.
|
|
75
|
+
ad_campaign:,
|
|
75
76
|
# Budget amount in dollars.
|
|
76
77
|
budget:,
|
|
77
78
|
# The budget type for an ad campaign or ad group.
|
|
@@ -93,15 +94,12 @@ module WhopSDK
|
|
|
93
94
|
override.returns(
|
|
94
95
|
{
|
|
95
96
|
id: String,
|
|
97
|
+
ad_campaign: WhopSDK::Models::AdGroupListResponse::AdCampaign,
|
|
96
98
|
budget: T.nilable(Float),
|
|
97
|
-
budget_type:
|
|
98
|
-
T.nilable(
|
|
99
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::TaggedSymbol
|
|
100
|
-
),
|
|
99
|
+
budget_type: T.nilable(WhopSDK::AdBudgetType::TaggedSymbol),
|
|
101
100
|
created_at: Time,
|
|
102
|
-
platform:
|
|
103
|
-
|
|
104
|
-
status: WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol,
|
|
101
|
+
platform: WhopSDK::AdCampaignPlatform::TaggedSymbol,
|
|
102
|
+
status: WhopSDK::AdGroupStatus::TaggedSymbol,
|
|
105
103
|
title: T.nilable(String),
|
|
106
104
|
updated_at: Time
|
|
107
105
|
}
|
|
@@ -110,117 +108,29 @@ module WhopSDK
|
|
|
110
108
|
def to_hash
|
|
111
109
|
end
|
|
112
110
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
extend WhopSDK::Internal::Type::Enum
|
|
116
|
-
|
|
117
|
-
TaggedSymbol =
|
|
118
|
-
T.type_alias do
|
|
119
|
-
T.all(Symbol, WhopSDK::Models::AdGroupListResponse::BudgetType)
|
|
120
|
-
end
|
|
121
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
122
|
-
|
|
123
|
-
DAILY =
|
|
124
|
-
T.let(
|
|
125
|
-
:daily,
|
|
126
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::TaggedSymbol
|
|
127
|
-
)
|
|
128
|
-
LIFETIME =
|
|
129
|
-
T.let(
|
|
130
|
-
:lifetime,
|
|
131
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::TaggedSymbol
|
|
132
|
-
)
|
|
133
|
-
|
|
134
|
-
sig do
|
|
135
|
-
override.returns(
|
|
136
|
-
T::Array[
|
|
137
|
-
WhopSDK::Models::AdGroupListResponse::BudgetType::TaggedSymbol
|
|
138
|
-
]
|
|
139
|
-
)
|
|
140
|
-
end
|
|
141
|
-
def self.values
|
|
142
|
-
end
|
|
143
|
-
end
|
|
144
|
-
|
|
145
|
-
# The external ad platform this ad group is running on (e.g., meta, tiktok).
|
|
146
|
-
module Platform
|
|
147
|
-
extend WhopSDK::Internal::Type::Enum
|
|
148
|
-
|
|
149
|
-
TaggedSymbol =
|
|
111
|
+
class AdCampaign < WhopSDK::Internal::Type::BaseModel
|
|
112
|
+
OrHash =
|
|
150
113
|
T.type_alias do
|
|
151
|
-
T.
|
|
114
|
+
T.any(
|
|
115
|
+
WhopSDK::Models::AdGroupListResponse::AdCampaign,
|
|
116
|
+
WhopSDK::Internal::AnyHash
|
|
117
|
+
)
|
|
152
118
|
end
|
|
153
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
154
119
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
WhopSDK::Models::AdGroupListResponse::Platform::TaggedSymbol
|
|
159
|
-
)
|
|
160
|
-
TIKTOK =
|
|
161
|
-
T.let(
|
|
162
|
-
:tiktok,
|
|
163
|
-
WhopSDK::Models::AdGroupListResponse::Platform::TaggedSymbol
|
|
164
|
-
)
|
|
120
|
+
# The unique identifier for this ad campaign.
|
|
121
|
+
sig { returns(String) }
|
|
122
|
+
attr_accessor :id
|
|
165
123
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
end
|
|
173
|
-
def self.values
|
|
124
|
+
# The ad campaign this ad group belongs to.
|
|
125
|
+
sig { params(id: String).returns(T.attached_class) }
|
|
126
|
+
def self.new(
|
|
127
|
+
# The unique identifier for this ad campaign.
|
|
128
|
+
id:
|
|
129
|
+
)
|
|
174
130
|
end
|
|
175
|
-
end
|
|
176
|
-
|
|
177
|
-
# Current operational status of the ad group.
|
|
178
|
-
module Status
|
|
179
|
-
extend WhopSDK::Internal::Type::Enum
|
|
180
131
|
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
T.all(Symbol, WhopSDK::Models::AdGroupListResponse::Status)
|
|
184
|
-
end
|
|
185
|
-
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
186
|
-
|
|
187
|
-
ACTIVE =
|
|
188
|
-
T.let(
|
|
189
|
-
:active,
|
|
190
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
191
|
-
)
|
|
192
|
-
PAUSED =
|
|
193
|
-
T.let(
|
|
194
|
-
:paused,
|
|
195
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
196
|
-
)
|
|
197
|
-
INACTIVE =
|
|
198
|
-
T.let(
|
|
199
|
-
:inactive,
|
|
200
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
201
|
-
)
|
|
202
|
-
IN_REVIEW =
|
|
203
|
-
T.let(
|
|
204
|
-
:in_review,
|
|
205
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
206
|
-
)
|
|
207
|
-
REJECTED =
|
|
208
|
-
T.let(
|
|
209
|
-
:rejected,
|
|
210
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
211
|
-
)
|
|
212
|
-
FLAGGED =
|
|
213
|
-
T.let(
|
|
214
|
-
:flagged,
|
|
215
|
-
WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol
|
|
216
|
-
)
|
|
217
|
-
|
|
218
|
-
sig do
|
|
219
|
-
override.returns(
|
|
220
|
-
T::Array[WhopSDK::Models::AdGroupListResponse::Status::TaggedSymbol]
|
|
221
|
-
)
|
|
222
|
-
end
|
|
223
|
-
def self.values
|
|
132
|
+
sig { override.returns({ id: String }) }
|
|
133
|
+
def to_hash
|
|
224
134
|
end
|
|
225
135
|
end
|
|
226
136
|
end
|