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,46 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
class AccountWallet < WhopSDK::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The ID of the wallet, which will look like wallet\_******\*******
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute address
|
|
13
|
+
# The on-chain address of the wallet
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :address, String
|
|
17
|
+
|
|
18
|
+
# @!attribute network
|
|
19
|
+
# The blockchain network the wallet lives on
|
|
20
|
+
#
|
|
21
|
+
# @return [Symbol, WhopSDK::Models::AccountWallet::Network]
|
|
22
|
+
required :network, enum: -> { WhopSDK::AccountWallet::Network }
|
|
23
|
+
|
|
24
|
+
# @!method initialize(id:, address:, network:)
|
|
25
|
+
# @param id [String] The ID of the wallet, which will look like wallet\_******\*******
|
|
26
|
+
#
|
|
27
|
+
# @param address [String] The on-chain address of the wallet
|
|
28
|
+
#
|
|
29
|
+
# @param network [Symbol, WhopSDK::Models::AccountWallet::Network] The blockchain network the wallet lives on
|
|
30
|
+
|
|
31
|
+
# The blockchain network the wallet lives on
|
|
32
|
+
#
|
|
33
|
+
# @see WhopSDK::Models::AccountWallet#network
|
|
34
|
+
module Network
|
|
35
|
+
extend WhopSDK::Internal::Type::Enum
|
|
36
|
+
|
|
37
|
+
SOLANA = :solana
|
|
38
|
+
ETHEREUM = :ethereum
|
|
39
|
+
BITCOIN = :bitcoin
|
|
40
|
+
|
|
41
|
+
# @!method self.values
|
|
42
|
+
# @return [Array<Symbol>]
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
module WhopSDK
|
|
4
4
|
module Models
|
|
5
5
|
# @see WhopSDK::Resources::Ads#retrieve
|
|
6
|
-
class
|
|
6
|
+
class Ad < WhopSDK::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
8
|
# The unique identifier for this ad.
|
|
9
9
|
#
|
|
@@ -13,14 +13,14 @@ module WhopSDK
|
|
|
13
13
|
# @!attribute ad_campaign
|
|
14
14
|
# The ad campaign this ad belongs to.
|
|
15
15
|
#
|
|
16
|
-
# @return [WhopSDK::Models::
|
|
17
|
-
required :ad_campaign, -> { WhopSDK::
|
|
16
|
+
# @return [WhopSDK::Models::Ad::AdCampaign]
|
|
17
|
+
required :ad_campaign, -> { WhopSDK::Ad::AdCampaign }
|
|
18
18
|
|
|
19
19
|
# @!attribute ad_group
|
|
20
20
|
# The parent ad group this ad belongs to.
|
|
21
21
|
#
|
|
22
|
-
# @return [WhopSDK::Models::
|
|
23
|
-
required :ad_group, -> { WhopSDK::
|
|
22
|
+
# @return [WhopSDK::Models::Ad::AdGroup]
|
|
23
|
+
required :ad_group, -> { WhopSDK::Ad::AdGroup }
|
|
24
24
|
|
|
25
25
|
# @!attribute created_at
|
|
26
26
|
# When the ad was created.
|
|
@@ -31,14 +31,14 @@ module WhopSDK
|
|
|
31
31
|
# @!attribute platform
|
|
32
32
|
# The external ad platform this ad is running on (e.g., meta, tiktok).
|
|
33
33
|
#
|
|
34
|
-
# @return [Symbol, WhopSDK::Models::
|
|
35
|
-
required :platform, enum: -> { WhopSDK::
|
|
34
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
|
|
35
|
+
required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
|
|
36
36
|
|
|
37
37
|
# @!attribute status
|
|
38
38
|
# Current delivery status of the ad.
|
|
39
39
|
#
|
|
40
|
-
# @return [Symbol, WhopSDK::Models::
|
|
41
|
-
required :status, enum: -> { WhopSDK::
|
|
40
|
+
# @return [Symbol, WhopSDK::Models::ExternalAdStatus]
|
|
41
|
+
required :status, enum: -> { WhopSDK::ExternalAdStatus }
|
|
42
42
|
|
|
43
43
|
# @!attribute title
|
|
44
44
|
# The display title of the ad. Falls back to the creative set caption when unset.
|
|
@@ -57,21 +57,21 @@ module WhopSDK
|
|
|
57
57
|
#
|
|
58
58
|
# @param id [String] The unique identifier for this ad.
|
|
59
59
|
#
|
|
60
|
-
# @param ad_campaign [WhopSDK::Models::
|
|
60
|
+
# @param ad_campaign [WhopSDK::Models::Ad::AdCampaign] The ad campaign this ad belongs to.
|
|
61
61
|
#
|
|
62
|
-
# @param ad_group [WhopSDK::Models::
|
|
62
|
+
# @param ad_group [WhopSDK::Models::Ad::AdGroup] The parent ad group this ad belongs to.
|
|
63
63
|
#
|
|
64
64
|
# @param created_at [Time] When the ad was created.
|
|
65
65
|
#
|
|
66
|
-
# @param platform [Symbol, WhopSDK::Models::
|
|
66
|
+
# @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this ad is running on (e.g., meta, tiktok).
|
|
67
67
|
#
|
|
68
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
68
|
+
# @param status [Symbol, WhopSDK::Models::ExternalAdStatus] Current delivery status of the ad.
|
|
69
69
|
#
|
|
70
70
|
# @param title [String, nil] The display title of the ad. Falls back to the creative set caption when unset.
|
|
71
71
|
#
|
|
72
72
|
# @param updated_at [Time] When the ad was last updated.
|
|
73
73
|
|
|
74
|
-
# @see WhopSDK::Models::
|
|
74
|
+
# @see WhopSDK::Models::Ad#ad_campaign
|
|
75
75
|
class AdCampaign < WhopSDK::Internal::Type::BaseModel
|
|
76
76
|
# @!attribute id
|
|
77
77
|
# The unique identifier for this ad campaign.
|
|
@@ -85,7 +85,7 @@ module WhopSDK
|
|
|
85
85
|
# @param id [String] The unique identifier for this ad campaign.
|
|
86
86
|
end
|
|
87
87
|
|
|
88
|
-
# @see WhopSDK::Models::
|
|
88
|
+
# @see WhopSDK::Models::Ad#ad_group
|
|
89
89
|
class AdGroup < WhopSDK::Internal::Type::BaseModel
|
|
90
90
|
# @!attribute id
|
|
91
91
|
# The unique identifier for this ad group.
|
|
@@ -98,36 +98,6 @@ module WhopSDK
|
|
|
98
98
|
#
|
|
99
99
|
# @param id [String] The unique identifier for this ad group.
|
|
100
100
|
end
|
|
101
|
-
|
|
102
|
-
# The external ad platform this ad is running on (e.g., meta, tiktok).
|
|
103
|
-
#
|
|
104
|
-
# @see WhopSDK::Models::AdRetrieveResponse#platform
|
|
105
|
-
module Platform
|
|
106
|
-
extend WhopSDK::Internal::Type::Enum
|
|
107
|
-
|
|
108
|
-
META = :meta
|
|
109
|
-
TIKTOK = :tiktok
|
|
110
|
-
|
|
111
|
-
# @!method self.values
|
|
112
|
-
# @return [Array<Symbol>]
|
|
113
|
-
end
|
|
114
|
-
|
|
115
|
-
# Current delivery status of the ad.
|
|
116
|
-
#
|
|
117
|
-
# @see WhopSDK::Models::AdRetrieveResponse#status
|
|
118
|
-
module Status
|
|
119
|
-
extend WhopSDK::Internal::Type::Enum
|
|
120
|
-
|
|
121
|
-
ACTIVE = :active
|
|
122
|
-
PAUSED = :paused
|
|
123
|
-
INACTIVE = :inactive
|
|
124
|
-
IN_REVIEW = :in_review
|
|
125
|
-
REJECTED = :rejected
|
|
126
|
-
FLAGGED = :flagged
|
|
127
|
-
|
|
128
|
-
# @!method self.values
|
|
129
|
-
# @return [Array<Symbol>]
|
|
130
|
-
end
|
|
131
101
|
end
|
|
132
102
|
end
|
|
133
103
|
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Models
|
|
5
|
+
# The budget type for an ad campaign or ad group.
|
|
6
|
+
module AdBudgetType
|
|
7
|
+
extend WhopSDK::Internal::Type::Enum
|
|
8
|
+
|
|
9
|
+
DAILY = :daily
|
|
10
|
+
LIFETIME = :lifetime
|
|
11
|
+
|
|
12
|
+
# @!method self.values
|
|
13
|
+
# @return [Array<Symbol>]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module WhopSDK
|
|
4
4
|
module Models
|
|
5
|
-
# @see WhopSDK::Resources::AdCampaigns#
|
|
6
|
-
class
|
|
5
|
+
# @see WhopSDK::Resources::AdCampaigns#retrieve
|
|
6
|
+
class AdCampaign < WhopSDK::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute id
|
|
8
8
|
# The unique identifier for this ad campaign.
|
|
9
9
|
#
|
|
@@ -19,8 +19,8 @@ module WhopSDK
|
|
|
19
19
|
# @!attribute budget_type
|
|
20
20
|
# The budget type for an ad campaign or ad group.
|
|
21
21
|
#
|
|
22
|
-
# @return [Symbol, WhopSDK::Models::
|
|
23
|
-
required :budget_type, enum: -> { WhopSDK::
|
|
22
|
+
# @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
|
|
23
|
+
required :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
|
|
24
24
|
|
|
25
25
|
# @!attribute created_at
|
|
26
26
|
# When the ad campaign was created.
|
|
@@ -31,27 +31,27 @@ module WhopSDK
|
|
|
31
31
|
# @!attribute created_by_user
|
|
32
32
|
# The user who created this ad campaign.
|
|
33
33
|
#
|
|
34
|
-
# @return [WhopSDK::Models::
|
|
35
|
-
required :created_by_user, -> { WhopSDK::
|
|
34
|
+
# @return [WhopSDK::Models::AdCampaign::CreatedByUser]
|
|
35
|
+
required :created_by_user, -> { WhopSDK::AdCampaign::CreatedByUser }
|
|
36
36
|
|
|
37
37
|
# @!attribute meta_config
|
|
38
38
|
# Meta-specific campaign configuration (objective, budget mode, etc.). Null for
|
|
39
39
|
# non-Meta campaigns.
|
|
40
40
|
#
|
|
41
|
-
# @return [WhopSDK::Models::
|
|
42
|
-
required :meta_config, -> { WhopSDK::
|
|
41
|
+
# @return [WhopSDK::Models::AdCampaign::MetaConfig, nil]
|
|
42
|
+
required :meta_config, -> { WhopSDK::AdCampaign::MetaConfig }, nil?: true
|
|
43
43
|
|
|
44
44
|
# @!attribute platform
|
|
45
45
|
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
46
46
|
#
|
|
47
|
-
# @return [Symbol, WhopSDK::Models::
|
|
48
|
-
required :platform, enum: -> { WhopSDK::
|
|
47
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
|
|
48
|
+
required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
|
|
49
49
|
|
|
50
50
|
# @!attribute status
|
|
51
51
|
# Current status of the campaign (active, paused, or inactive).
|
|
52
52
|
#
|
|
53
|
-
# @return [Symbol, WhopSDK::Models::
|
|
54
|
-
required :status, enum: -> { WhopSDK::
|
|
53
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignStatus]
|
|
54
|
+
required :status, enum: -> { WhopSDK::AdCampaignStatus }
|
|
55
55
|
|
|
56
56
|
# @!attribute title
|
|
57
57
|
# The campaign name shown in the Whop dashboard.
|
|
@@ -73,7 +73,7 @@ module WhopSDK
|
|
|
73
73
|
|
|
74
74
|
# @!method initialize(id:, budget:, budget_type:, created_at:, created_by_user:, meta_config:, platform:, status:, title:, total_spend:, updated_at:)
|
|
75
75
|
# Some parameter documentations has been truncated, see
|
|
76
|
-
# {WhopSDK::Models::
|
|
76
|
+
# {WhopSDK::Models::AdCampaign} for more details.
|
|
77
77
|
#
|
|
78
78
|
# An advertising campaign running on an external platform or within Whop.
|
|
79
79
|
#
|
|
@@ -81,17 +81,17 @@ module WhopSDK
|
|
|
81
81
|
#
|
|
82
82
|
# @param budget [Float, nil] Total budget in dollars.
|
|
83
83
|
#
|
|
84
|
-
# @param budget_type [Symbol, WhopSDK::Models::
|
|
84
|
+
# @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
|
|
85
85
|
#
|
|
86
86
|
# @param created_at [Time] When the ad campaign was created.
|
|
87
87
|
#
|
|
88
|
-
# @param created_by_user [WhopSDK::Models::
|
|
88
|
+
# @param created_by_user [WhopSDK::Models::AdCampaign::CreatedByUser] The user who created this ad campaign.
|
|
89
89
|
#
|
|
90
|
-
# @param meta_config [WhopSDK::Models::
|
|
90
|
+
# @param meta_config [WhopSDK::Models::AdCampaign::MetaConfig, nil] Meta-specific campaign configuration (objective, budget mode, etc.). Null for no
|
|
91
91
|
#
|
|
92
|
-
# @param platform [Symbol, WhopSDK::Models::
|
|
92
|
+
# @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
93
93
|
#
|
|
94
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
94
|
+
# @param status [Symbol, WhopSDK::Models::AdCampaignStatus] Current status of the campaign (active, paused, or inactive).
|
|
95
95
|
#
|
|
96
96
|
# @param title [String] The campaign name shown in the Whop dashboard.
|
|
97
97
|
#
|
|
@@ -99,20 +99,7 @@ module WhopSDK
|
|
|
99
99
|
#
|
|
100
100
|
# @param updated_at [Time] When the ad campaign was last updated.
|
|
101
101
|
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
# @see WhopSDK::Models::AdCampaignPauseResponse#budget_type
|
|
105
|
-
module BudgetType
|
|
106
|
-
extend WhopSDK::Internal::Type::Enum
|
|
107
|
-
|
|
108
|
-
DAILY = :daily
|
|
109
|
-
LIFETIME = :lifetime
|
|
110
|
-
|
|
111
|
-
# @!method self.values
|
|
112
|
-
# @return [Array<Symbol>]
|
|
113
|
-
end
|
|
114
|
-
|
|
115
|
-
# @see WhopSDK::Models::AdCampaignPauseResponse#created_by_user
|
|
102
|
+
# @see WhopSDK::Models::AdCampaign#created_by_user
|
|
116
103
|
class CreatedByUser < WhopSDK::Internal::Type::BaseModel
|
|
117
104
|
# @!attribute id
|
|
118
105
|
# The unique identifier for the user.
|
|
@@ -142,7 +129,7 @@ module WhopSDK
|
|
|
142
129
|
# @param username [String] The user's unique username shown on their public profile.
|
|
143
130
|
end
|
|
144
131
|
|
|
145
|
-
# @see WhopSDK::Models::
|
|
132
|
+
# @see WhopSDK::Models::AdCampaign#meta_config
|
|
146
133
|
class MetaConfig < WhopSDK::Internal::Type::BaseModel
|
|
147
134
|
# @!attribute bid_amount
|
|
148
135
|
# Bid cap amount in cents. Only used when bid_strategy is bid_cap.
|
|
@@ -153,10 +140,8 @@ module WhopSDK
|
|
|
153
140
|
# @!attribute bid_strategy
|
|
154
141
|
# The bidding strategy used to optimize spend for this campaign.
|
|
155
142
|
#
|
|
156
|
-
# @return [Symbol, WhopSDK::Models::
|
|
157
|
-
required :bid_strategy,
|
|
158
|
-
enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::BidStrategy },
|
|
159
|
-
nil?: true
|
|
143
|
+
# @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::BidStrategy, nil]
|
|
144
|
+
required :bid_strategy, enum: -> { WhopSDK::AdCampaign::MetaConfig::BidStrategy }, nil?: true
|
|
160
145
|
|
|
161
146
|
# @!attribute budget_optimization
|
|
162
147
|
# Whether campaign budget optimization (CBO) is enabled, allowing the platform to
|
|
@@ -169,10 +154,8 @@ module WhopSDK
|
|
|
169
154
|
# The actual delivery status, accounting for platform overrides (e.g., in_review,
|
|
170
155
|
# rejected).
|
|
171
156
|
#
|
|
172
|
-
# @return [Symbol, WhopSDK::Models::
|
|
173
|
-
required :effective_status,
|
|
174
|
-
enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::EffectiveStatus },
|
|
175
|
-
nil?: true
|
|
157
|
+
# @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::EffectiveStatus, nil]
|
|
158
|
+
required :effective_status, enum: -> { WhopSDK::AdCampaign::MetaConfig::EffectiveStatus }, nil?: true
|
|
176
159
|
|
|
177
160
|
# @!attribute end_time
|
|
178
161
|
# The scheduled end time of the campaign (ISO8601).
|
|
@@ -183,10 +166,8 @@ module WhopSDK
|
|
|
183
166
|
# @!attribute objective
|
|
184
167
|
# The campaign objective that determines how Meta optimizes delivery.
|
|
185
168
|
#
|
|
186
|
-
# @return [Symbol, WhopSDK::Models::
|
|
187
|
-
required :objective,
|
|
188
|
-
enum: -> { WhopSDK::Models::AdCampaignPauseResponse::MetaConfig::Objective },
|
|
189
|
-
nil?: true
|
|
169
|
+
# @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Objective, nil]
|
|
170
|
+
required :objective, enum: -> { WhopSDK::AdCampaign::MetaConfig::Objective }, nil?: true
|
|
190
171
|
|
|
191
172
|
# @!attribute special_categories
|
|
192
173
|
# Special ad categories required by the platform (e.g., housing, employment,
|
|
@@ -204,37 +185,37 @@ module WhopSDK
|
|
|
204
185
|
# @!attribute status
|
|
205
186
|
# The campaign status as set by the advertiser (active or paused).
|
|
206
187
|
#
|
|
207
|
-
# @return [Symbol, WhopSDK::Models::
|
|
208
|
-
required :status, enum: -> { WhopSDK::
|
|
188
|
+
# @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Status, nil]
|
|
189
|
+
required :status, enum: -> { WhopSDK::AdCampaign::MetaConfig::Status }, nil?: true
|
|
209
190
|
|
|
210
191
|
# @!method initialize(bid_amount:, bid_strategy:, budget_optimization:, effective_status:, end_time:, objective:, special_categories:, start_time:, status:)
|
|
211
192
|
# Some parameter documentations has been truncated, see
|
|
212
|
-
# {WhopSDK::Models::
|
|
193
|
+
# {WhopSDK::Models::AdCampaign::MetaConfig} for more details.
|
|
213
194
|
#
|
|
214
195
|
# Meta-specific campaign configuration (objective, budget mode, etc.). Null for
|
|
215
196
|
# non-Meta campaigns.
|
|
216
197
|
#
|
|
217
198
|
# @param bid_amount [Integer, nil] Bid cap amount in cents. Only used when bid_strategy is bid_cap.
|
|
218
199
|
#
|
|
219
|
-
# @param bid_strategy [Symbol, WhopSDK::Models::
|
|
200
|
+
# @param bid_strategy [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::BidStrategy, nil] The bidding strategy used to optimize spend for this campaign.
|
|
220
201
|
#
|
|
221
202
|
# @param budget_optimization [Boolean, nil] Whether campaign budget optimization (CBO) is enabled, allowing the platform to
|
|
222
203
|
#
|
|
223
|
-
# @param effective_status [Symbol, WhopSDK::Models::
|
|
204
|
+
# @param effective_status [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::EffectiveStatus, nil] The actual delivery status, accounting for platform overrides (e.g., in_review,
|
|
224
205
|
#
|
|
225
206
|
# @param end_time [String, nil] The scheduled end time of the campaign (ISO8601).
|
|
226
207
|
#
|
|
227
|
-
# @param objective [Symbol, WhopSDK::Models::
|
|
208
|
+
# @param objective [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Objective, nil] The campaign objective that determines how Meta optimizes delivery.
|
|
228
209
|
#
|
|
229
210
|
# @param special_categories [Array<String>, nil] Special ad categories required by the platform (e.g., housing, employment, credi
|
|
230
211
|
#
|
|
231
212
|
# @param start_time [String, nil] The scheduled start time of the campaign (ISO8601).
|
|
232
213
|
#
|
|
233
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
214
|
+
# @param status [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Status, nil] The campaign status as set by the advertiser (active or paused).
|
|
234
215
|
|
|
235
216
|
# The bidding strategy used to optimize spend for this campaign.
|
|
236
217
|
#
|
|
237
|
-
# @see WhopSDK::Models::
|
|
218
|
+
# @see WhopSDK::Models::AdCampaign::MetaConfig#bid_strategy
|
|
238
219
|
module BidStrategy
|
|
239
220
|
extend WhopSDK::Internal::Type::Enum
|
|
240
221
|
|
|
@@ -249,7 +230,7 @@ module WhopSDK
|
|
|
249
230
|
# The actual delivery status, accounting for platform overrides (e.g., in_review,
|
|
250
231
|
# rejected).
|
|
251
232
|
#
|
|
252
|
-
# @see WhopSDK::Models::
|
|
233
|
+
# @see WhopSDK::Models::AdCampaign::MetaConfig#effective_status
|
|
253
234
|
module EffectiveStatus
|
|
254
235
|
extend WhopSDK::Internal::Type::Enum
|
|
255
236
|
|
|
@@ -266,7 +247,7 @@ module WhopSDK
|
|
|
266
247
|
|
|
267
248
|
# The campaign objective that determines how Meta optimizes delivery.
|
|
268
249
|
#
|
|
269
|
-
# @see WhopSDK::Models::
|
|
250
|
+
# @see WhopSDK::Models::AdCampaign::MetaConfig#objective
|
|
270
251
|
module Objective
|
|
271
252
|
extend WhopSDK::Internal::Type::Enum
|
|
272
253
|
|
|
@@ -282,7 +263,7 @@ module WhopSDK
|
|
|
282
263
|
|
|
283
264
|
# The campaign status as set by the advertiser (active or paused).
|
|
284
265
|
#
|
|
285
|
-
# @see WhopSDK::Models::
|
|
266
|
+
# @see WhopSDK::Models::AdCampaign::MetaConfig#status
|
|
286
267
|
module Status
|
|
287
268
|
extend WhopSDK::Internal::Type::Enum
|
|
288
269
|
|
|
@@ -293,36 +274,6 @@ module WhopSDK
|
|
|
293
274
|
# @return [Array<Symbol>]
|
|
294
275
|
end
|
|
295
276
|
end
|
|
296
|
-
|
|
297
|
-
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
298
|
-
#
|
|
299
|
-
# @see WhopSDK::Models::AdCampaignPauseResponse#platform
|
|
300
|
-
module Platform
|
|
301
|
-
extend WhopSDK::Internal::Type::Enum
|
|
302
|
-
|
|
303
|
-
META = :meta
|
|
304
|
-
TIKTOK = :tiktok
|
|
305
|
-
|
|
306
|
-
# @!method self.values
|
|
307
|
-
# @return [Array<Symbol>]
|
|
308
|
-
end
|
|
309
|
-
|
|
310
|
-
# Current status of the campaign (active, paused, or inactive).
|
|
311
|
-
#
|
|
312
|
-
# @see WhopSDK::Models::AdCampaignPauseResponse#status
|
|
313
|
-
module Status
|
|
314
|
-
extend WhopSDK::Internal::Type::Enum
|
|
315
|
-
|
|
316
|
-
ACTIVE = :active
|
|
317
|
-
PAUSED = :paused
|
|
318
|
-
PAYMENT_FAILED = :payment_failed
|
|
319
|
-
DRAFT = :draft
|
|
320
|
-
IN_REVIEW = :in_review
|
|
321
|
-
FLAGGED = :flagged
|
|
322
|
-
|
|
323
|
-
# @!method self.values
|
|
324
|
-
# @return [Array<Symbol>]
|
|
325
|
-
end
|
|
326
277
|
end
|
|
327
278
|
end
|
|
328
279
|
end
|
|
@@ -7,12 +7,6 @@ module WhopSDK
|
|
|
7
7
|
extend WhopSDK::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include WhopSDK::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute company_id
|
|
11
|
-
# The unique identifier of the company to list ad campaigns for.
|
|
12
|
-
#
|
|
13
|
-
# @return [String]
|
|
14
|
-
required :company_id, String
|
|
15
|
-
|
|
16
10
|
# @!attribute after
|
|
17
11
|
# Returns the elements in the list that come after the specified cursor.
|
|
18
12
|
#
|
|
@@ -25,6 +19,12 @@ module WhopSDK
|
|
|
25
19
|
# @return [String, nil]
|
|
26
20
|
optional :before, String, nil?: true
|
|
27
21
|
|
|
22
|
+
# @!attribute company_id
|
|
23
|
+
# The unique identifier of the company to list ad campaigns for.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :company_id, String, nil?: true
|
|
27
|
+
|
|
28
28
|
# @!attribute created_after
|
|
29
29
|
# Only return ad campaigns created after this timestamp.
|
|
30
30
|
#
|
|
@@ -58,16 +58,16 @@ module WhopSDK
|
|
|
58
58
|
# @!attribute status
|
|
59
59
|
# The status of an ad campaign.
|
|
60
60
|
#
|
|
61
|
-
# @return [Symbol, WhopSDK::Models::
|
|
62
|
-
optional :status, enum: -> { WhopSDK::
|
|
61
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignStatus, nil]
|
|
62
|
+
optional :status, enum: -> { WhopSDK::AdCampaignStatus }, nil?: true
|
|
63
63
|
|
|
64
|
-
# @!method initialize(
|
|
65
|
-
# @param company_id [String] The unique identifier of the company to list ad campaigns for.
|
|
66
|
-
#
|
|
64
|
+
# @!method initialize(after: nil, before: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
|
|
67
65
|
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
68
66
|
#
|
|
69
67
|
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
70
68
|
#
|
|
69
|
+
# @param company_id [String, nil] The unique identifier of the company to list ad campaigns for.
|
|
70
|
+
#
|
|
71
71
|
# @param created_after [Time, nil] Only return ad campaigns created after this timestamp.
|
|
72
72
|
#
|
|
73
73
|
# @param created_before [Time, nil] Only return ad campaigns created before this timestamp.
|
|
@@ -78,24 +78,9 @@ module WhopSDK
|
|
|
78
78
|
#
|
|
79
79
|
# @param query [String, nil] Case-insensitive substring match against the campaign title.
|
|
80
80
|
#
|
|
81
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
81
|
+
# @param status [Symbol, WhopSDK::Models::AdCampaignStatus, nil] The status of an ad campaign.
|
|
82
82
|
#
|
|
83
83
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
|
|
84
|
-
|
|
85
|
-
# The status of an ad campaign.
|
|
86
|
-
module Status
|
|
87
|
-
extend WhopSDK::Internal::Type::Enum
|
|
88
|
-
|
|
89
|
-
ACTIVE = :active
|
|
90
|
-
PAUSED = :paused
|
|
91
|
-
PAYMENT_FAILED = :payment_failed
|
|
92
|
-
DRAFT = :draft
|
|
93
|
-
IN_REVIEW = :in_review
|
|
94
|
-
FLAGGED = :flagged
|
|
95
|
-
|
|
96
|
-
# @!method self.values
|
|
97
|
-
# @return [Array<Symbol>]
|
|
98
|
-
end
|
|
99
84
|
end
|
|
100
85
|
end
|
|
101
86
|
end
|
|
@@ -19,8 +19,8 @@ module WhopSDK
|
|
|
19
19
|
# @!attribute budget_type
|
|
20
20
|
# The budget type for an ad campaign or ad group.
|
|
21
21
|
#
|
|
22
|
-
# @return [Symbol, WhopSDK::Models::
|
|
23
|
-
required :budget_type, enum: -> { WhopSDK::
|
|
22
|
+
# @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
|
|
23
|
+
required :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
|
|
24
24
|
|
|
25
25
|
# @!attribute created_at
|
|
26
26
|
# When the ad campaign was created.
|
|
@@ -31,14 +31,14 @@ module WhopSDK
|
|
|
31
31
|
# @!attribute platform
|
|
32
32
|
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
33
33
|
#
|
|
34
|
-
# @return [Symbol, WhopSDK::Models::
|
|
35
|
-
required :platform, enum: -> { WhopSDK::
|
|
34
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
|
|
35
|
+
required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
|
|
36
36
|
|
|
37
37
|
# @!attribute status
|
|
38
38
|
# Current status of the campaign (active, paused, or inactive).
|
|
39
39
|
#
|
|
40
|
-
# @return [Symbol, WhopSDK::Models::
|
|
41
|
-
required :status, enum: -> { WhopSDK::
|
|
40
|
+
# @return [Symbol, WhopSDK::Models::AdCampaignStatus]
|
|
41
|
+
required :status, enum: -> { WhopSDK::AdCampaignStatus }
|
|
42
42
|
|
|
43
43
|
# @!attribute title
|
|
44
44
|
# The campaign name shown in the Whop dashboard.
|
|
@@ -65,62 +65,19 @@ module WhopSDK
|
|
|
65
65
|
#
|
|
66
66
|
# @param budget [Float, nil] Total budget in dollars.
|
|
67
67
|
#
|
|
68
|
-
# @param budget_type [Symbol, WhopSDK::Models::
|
|
68
|
+
# @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
|
|
69
69
|
#
|
|
70
70
|
# @param created_at [Time] When the ad campaign was created.
|
|
71
71
|
#
|
|
72
|
-
# @param platform [Symbol, WhopSDK::Models::
|
|
72
|
+
# @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
73
73
|
#
|
|
74
|
-
# @param status [Symbol, WhopSDK::Models::
|
|
74
|
+
# @param status [Symbol, WhopSDK::Models::AdCampaignStatus] Current status of the campaign (active, paused, or inactive).
|
|
75
75
|
#
|
|
76
76
|
# @param title [String] The campaign name shown in the Whop dashboard.
|
|
77
77
|
#
|
|
78
78
|
# @param total_spend [Float] Total amount spent in dollars.
|
|
79
79
|
#
|
|
80
80
|
# @param updated_at [Time] When the ad campaign was last updated.
|
|
81
|
-
|
|
82
|
-
# The budget type for an ad campaign or ad group.
|
|
83
|
-
#
|
|
84
|
-
# @see WhopSDK::Models::AdCampaignListResponse#budget_type
|
|
85
|
-
module BudgetType
|
|
86
|
-
extend WhopSDK::Internal::Type::Enum
|
|
87
|
-
|
|
88
|
-
DAILY = :daily
|
|
89
|
-
LIFETIME = :lifetime
|
|
90
|
-
|
|
91
|
-
# @!method self.values
|
|
92
|
-
# @return [Array<Symbol>]
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
# The external ad platform this campaign is running on (e.g., meta, tiktok).
|
|
96
|
-
#
|
|
97
|
-
# @see WhopSDK::Models::AdCampaignListResponse#platform
|
|
98
|
-
module Platform
|
|
99
|
-
extend WhopSDK::Internal::Type::Enum
|
|
100
|
-
|
|
101
|
-
META = :meta
|
|
102
|
-
TIKTOK = :tiktok
|
|
103
|
-
|
|
104
|
-
# @!method self.values
|
|
105
|
-
# @return [Array<Symbol>]
|
|
106
|
-
end
|
|
107
|
-
|
|
108
|
-
# Current status of the campaign (active, paused, or inactive).
|
|
109
|
-
#
|
|
110
|
-
# @see WhopSDK::Models::AdCampaignListResponse#status
|
|
111
|
-
module Status
|
|
112
|
-
extend WhopSDK::Internal::Type::Enum
|
|
113
|
-
|
|
114
|
-
ACTIVE = :active
|
|
115
|
-
PAUSED = :paused
|
|
116
|
-
PAYMENT_FAILED = :payment_failed
|
|
117
|
-
DRAFT = :draft
|
|
118
|
-
IN_REVIEW = :in_review
|
|
119
|
-
FLAGGED = :flagged
|
|
120
|
-
|
|
121
|
-
# @!method self.values
|
|
122
|
-
# @return [Array<Symbol>]
|
|
123
|
-
end
|
|
124
81
|
end
|
|
125
82
|
end
|
|
126
83
|
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
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
|
+
META = :meta
|
|
10
|
+
TIKTOK = :tiktok
|
|
11
|
+
|
|
12
|
+
# @!method self.values
|
|
13
|
+
# @return [Array<Symbol>]
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
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
|
+
ACTIVE = :active
|
|
10
|
+
PAUSED = :paused
|
|
11
|
+
PAYMENT_FAILED = :payment_failed
|
|
12
|
+
DRAFT = :draft
|
|
13
|
+
IN_REVIEW = :in_review
|
|
14
|
+
FLAGGED = :flagged
|
|
15
|
+
|
|
16
|
+
# @!method self.values
|
|
17
|
+
# @return [Array<Symbol>]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|