whop_sdk 0.0.40 → 0.0.41

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.
Files changed (840) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/README.md +3 -3
  4. data/lib/whop_sdk/client.rb +212 -73
  5. data/lib/whop_sdk/internal/transport/base_client.rb +4 -1
  6. data/lib/whop_sdk/internal/type/union.rb +6 -6
  7. data/lib/whop_sdk/models/account.rb +858 -35
  8. data/lib/whop_sdk/models/account_create_params.rb +10 -1
  9. data/lib/whop_sdk/models/account_list_params.rb +61 -12
  10. data/lib/whop_sdk/models/{wallet_balance_params.rb → account_recommend_actions_params.rb} +2 -2
  11. data/lib/whop_sdk/models/account_recommend_actions_response.rb +143 -0
  12. data/lib/whop_sdk/models/account_update_params.rb +377 -11
  13. data/lib/whop_sdk/models/accounts/preference_retrieve_params.rb +22 -0
  14. data/lib/whop_sdk/models/accounts/preference_retrieve_response.rb +129 -0
  15. data/lib/whop_sdk/models/accounts/preference_update_params.rb +142 -0
  16. data/lib/whop_sdk/models/accounts/preference_update_response.rb +129 -0
  17. data/lib/whop_sdk/models/ad.rb +737 -32
  18. data/lib/whop_sdk/models/ad_campaign.rb +537 -181
  19. data/lib/whop_sdk/models/ad_campaign_create_params.rb +194 -0
  20. data/lib/whop_sdk/models/{payout_method_retrieve_params.rb → ad_campaign_delete_params.rb} +2 -2
  21. data/lib/whop_sdk/models/ad_campaign_delete_response.rb +8 -0
  22. data/lib/whop_sdk/models/ad_campaign_list_params.rb +133 -34
  23. data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +26 -1
  24. data/lib/whop_sdk/models/ad_campaign_update_params.rb +99 -6
  25. data/lib/whop_sdk/models/ad_create_params.rb +660 -0
  26. data/lib/whop_sdk/models/ad_delete_params.rb +20 -0
  27. data/lib/whop_sdk/models/ad_delete_response.rb +8 -0
  28. data/lib/whop_sdk/models/ad_group.rb +714 -37
  29. data/lib/whop_sdk/models/ad_group_create_params.rb +346 -0
  30. data/lib/whop_sdk/models/ad_group_list_params.rb +117 -44
  31. data/lib/whop_sdk/models/ad_group_retrieve_params.rb +26 -1
  32. data/lib/whop_sdk/models/ad_group_update_params.rb +253 -3100
  33. data/lib/whop_sdk/models/ad_list_params.rb +114 -74
  34. data/lib/whop_sdk/models/ad_report_retrieve_params.rb +23 -23
  35. data/lib/whop_sdk/models/ad_report_retrieve_response.rb +56 -56
  36. data/lib/whop_sdk/models/ad_retrieve_params.rb +26 -1
  37. data/lib/whop_sdk/models/ad_update_params.rb +650 -0
  38. data/lib/whop_sdk/models/app.rb +81 -1
  39. data/lib/whop_sdk/models/app_build_create_params.rb +2 -2
  40. data/lib/whop_sdk/models/app_create_params.rb +10 -1
  41. data/lib/whop_sdk/models/app_list_response.rb +19 -1
  42. data/lib/whop_sdk/models/app_logs_params.rb +103 -0
  43. data/lib/whop_sdk/models/app_logs_response.rb +157 -0
  44. data/lib/whop_sdk/models/app_update_params.rb +21 -1
  45. data/lib/whop_sdk/models/audience.rb +191 -0
  46. data/lib/whop_sdk/models/audience_create_params.rb +96 -0
  47. data/lib/whop_sdk/models/audience_delete_params.rb +20 -0
  48. data/lib/whop_sdk/models/audience_delete_response.rb +16 -0
  49. data/lib/whop_sdk/models/audience_list_params.rb +46 -0
  50. data/lib/whop_sdk/models/authorized_user_create_params.rb +70 -1
  51. data/lib/whop_sdk/models/bounty_create_params.rb +70 -3
  52. data/lib/whop_sdk/models/bounty_create_response.rb +1 -0
  53. data/lib/whop_sdk/models/bounty_list_params.rb +1 -0
  54. data/lib/whop_sdk/models/bounty_list_response.rb +1 -0
  55. data/lib/whop_sdk/models/bounty_retrieve_response.rb +1 -0
  56. data/lib/whop_sdk/models/card_brands.rb +1 -0
  57. data/lib/whop_sdk/models/card_create_params.rb +88 -0
  58. data/lib/whop_sdk/models/card_create_response.rb +277 -0
  59. data/lib/whop_sdk/models/card_list_params.rb +30 -0
  60. data/lib/whop_sdk/models/card_list_response.rb +287 -0
  61. data/lib/whop_sdk/models/card_retrieve_params.rb +37 -0
  62. data/lib/whop_sdk/models/card_retrieve_response.rb +277 -0
  63. data/lib/whop_sdk/models/card_update_params.rb +181 -0
  64. data/lib/whop_sdk/models/card_update_response.rb +277 -0
  65. data/lib/whop_sdk/models/chat_message_created_webhook_event.rb +151 -0
  66. data/lib/whop_sdk/models/chat_reaction_created_webhook_event.rb +159 -0
  67. data/lib/whop_sdk/models/checkout_configuration.rb +13 -23
  68. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +303 -1046
  69. data/lib/whop_sdk/models/checkout_configuration_create_response.rb +275 -0
  70. data/lib/whop_sdk/models/checkout_configuration_delete_params.rb +20 -0
  71. data/lib/whop_sdk/models/checkout_configuration_list_params.rb +50 -41
  72. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +131 -140
  73. data/lib/whop_sdk/models/checkout_configuration_retrieve_response.rb +275 -0
  74. data/lib/whop_sdk/models/company.rb +2 -2
  75. data/lib/whop_sdk/models/company_list_response.rb +2 -2
  76. data/lib/whop_sdk/models/course.rb +2 -2
  77. data/lib/whop_sdk/models/course_list_response.rb +2 -2
  78. data/lib/whop_sdk/models/deposit_create_params.rb +21 -16
  79. data/lib/whop_sdk/models/deposit_create_response.rb +182 -56
  80. data/lib/whop_sdk/models/deposit_list_params.rb +22 -0
  81. data/lib/whop_sdk/models/deposit_list_response.rb +101 -0
  82. data/lib/whop_sdk/models/dispute.rb +8 -8
  83. data/lib/whop_sdk/models/{conversion_create_params.rb → event_create_params.rb} +294 -32
  84. data/lib/whop_sdk/models/event_create_response.rb +16 -0
  85. data/lib/whop_sdk/models/event_list_params.rb +75 -0
  86. data/lib/whop_sdk/models/event_list_response.rb +242 -0
  87. data/lib/whop_sdk/models/experience.rb +5 -8
  88. data/lib/whop_sdk/models/experience_list_response.rb +2 -5
  89. data/lib/whop_sdk/models/financial_activity_list_params.rb +113 -0
  90. data/lib/whop_sdk/models/financial_activity_list_response.rb +1174 -0
  91. data/lib/whop_sdk/models/forum_post.rb +2 -2
  92. data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
  93. data/lib/whop_sdk/models/granularities.rb +3 -1
  94. data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +4 -4
  95. data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +4 -4
  96. data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +4 -4
  97. data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +4 -4
  98. data/lib/whop_sdk/models/invoice_create_params.rb +34 -2
  99. data/lib/whop_sdk/models/invoice_update_params.rb +17 -1
  100. data/lib/whop_sdk/models/ledger_account_funds_available_webhook_event.rb +578 -0
  101. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +2 -6
  102. data/lib/whop_sdk/models/lesson.rb +6 -6
  103. data/lib/whop_sdk/models/media_asset.rb +224 -0
  104. data/lib/whop_sdk/models/media_generate_params.rb +105 -0
  105. data/lib/whop_sdk/models/media_retrieve_params.rb +20 -0
  106. data/lib/whop_sdk/models/membership.rb +7 -5
  107. data/lib/whop_sdk/models/membership_list_response.rb +7 -5
  108. data/lib/whop_sdk/models/membership_trial_ending_soon_webhook_event.rb +60 -0
  109. data/lib/whop_sdk/models/payment.rb +170 -8
  110. data/lib/whop_sdk/models/payment_create_params.rb +22 -2
  111. data/lib/whop_sdk/models/payment_list_response.rb +82 -8
  112. data/lib/whop_sdk/models/payout_create_params.rb +58 -0
  113. data/lib/whop_sdk/models/payout_create_response.rb +185 -0
  114. data/lib/whop_sdk/models/payout_list_params.rb +70 -0
  115. data/lib/whop_sdk/models/payout_list_response.rb +195 -0
  116. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +20 -3
  117. data/lib/whop_sdk/models/payouts/method_list_params.rb +120 -0
  118. data/lib/whop_sdk/models/payouts/method_list_response.rb +315 -0
  119. data/lib/whop_sdk/models/person_list_params.rb +103 -0
  120. data/lib/whop_sdk/models/person_list_response.rb +167 -0
  121. data/lib/whop_sdk/models/person_retrieve_params.rb +50 -0
  122. data/lib/whop_sdk/models/person_retrieve_response.rb +179 -0
  123. data/lib/whop_sdk/models/plan.rb +276 -241
  124. data/lib/whop_sdk/models/plan_calculate_tax_params.rb +248 -0
  125. data/lib/whop_sdk/models/plan_calculate_tax_response.rb +94 -0
  126. data/lib/whop_sdk/models/plan_create_params.rb +117 -162
  127. data/lib/whop_sdk/models/plan_list_params.rb +54 -47
  128. data/lib/whop_sdk/models/plan_list_response.rb +98 -244
  129. data/lib/whop_sdk/models/plan_update_params.rb +95 -141
  130. data/lib/whop_sdk/models/product.rb +33 -39
  131. data/lib/whop_sdk/models/product_create_params.rb +47 -198
  132. data/lib/whop_sdk/models/product_list_item.rb +13 -13
  133. data/lib/whop_sdk/models/product_list_params.rb +35 -57
  134. data/lib/whop_sdk/models/product_update_params.rb +19 -157
  135. data/lib/whop_sdk/models/referral_referred_users_params.rb +66 -0
  136. data/lib/whop_sdk/models/referral_referred_users_response.rb +127 -0
  137. data/lib/whop_sdk/models/referrals/business_leaderboard_params.rb +45 -0
  138. data/lib/whop_sdk/models/referrals/business_leaderboard_response.rb +284 -0
  139. data/lib/whop_sdk/models/referrals/business_list_params.rb +175 -0
  140. data/lib/whop_sdk/models/referrals/business_list_response.rb +361 -0
  141. data/lib/whop_sdk/models/referrals/business_retrieve_params.rb +22 -0
  142. data/lib/whop_sdk/models/referrals/business_retrieve_response.rb +881 -0
  143. data/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb +131 -0
  144. data/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb +371 -0
  145. data/lib/whop_sdk/models/referrals/partner_create_params.rb +16 -0
  146. data/lib/whop_sdk/models/referrals/partner_create_response.rb +31 -0
  147. data/lib/whop_sdk/models/refund_created_webhook_event.rb +6 -4
  148. data/lib/whop_sdk/models/refund_retrieve_response.rb +6 -4
  149. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +6 -4
  150. data/lib/whop_sdk/models/result_label_keys.rb +10 -0
  151. data/lib/whop_sdk/models/review_list_response.rb +2 -2
  152. data/lib/whop_sdk/models/review_retrieve_response.rb +4 -7
  153. data/lib/whop_sdk/models/setup_intent.rb +10 -1
  154. data/lib/whop_sdk/models/social_account.rb +101 -0
  155. data/lib/whop_sdk/models/social_account_connect_params.rb +74 -0
  156. data/lib/whop_sdk/models/social_account_connect_response.rb +17 -0
  157. data/lib/whop_sdk/models/social_account_create_params.rb +45 -0
  158. data/lib/whop_sdk/models/social_account_delete_params.rb +42 -0
  159. data/lib/whop_sdk/models/social_account_delete_response.rb +8 -0
  160. data/lib/whop_sdk/models/social_account_list_params.rb +152 -0
  161. data/lib/whop_sdk/models/social_account_post.rb +99 -0
  162. data/lib/whop_sdk/models/social_account_posts_params.rb +53 -0
  163. data/lib/whop_sdk/models/social_account_posts_response.rb +39 -0
  164. data/lib/whop_sdk/models/{wallet_list_params.rb → stat_list_params.rb} +2 -2
  165. data/lib/whop_sdk/models/stat_list_response.rb +89 -0
  166. data/lib/whop_sdk/models/stat_retrieve_params.rb +265 -0
  167. data/lib/whop_sdk/models/stat_retrieve_response.rb +88 -0
  168. data/lib/whop_sdk/models/swap_create_params.rb +101 -0
  169. data/lib/whop_sdk/models/swap_create_quote_params.rb +27 -12
  170. data/lib/whop_sdk/models/swap_create_quote_response.rb +39 -13
  171. data/lib/whop_sdk/models/swap_create_response.rb +82 -0
  172. data/lib/whop_sdk/models/swap_list_params.rb +22 -0
  173. data/lib/whop_sdk/models/swap_list_response.rb +77 -0
  174. data/lib/whop_sdk/models/swap_retrieve_params.rb +20 -0
  175. data/lib/whop_sdk/models/swap_retrieve_response.rb +66 -0
  176. data/lib/whop_sdk/models/tax_identifier_type.rb +2 -0
  177. data/lib/whop_sdk/models/transfer_create_params.rb +62 -29
  178. data/lib/whop_sdk/models/transfer_create_response.rb +452 -0
  179. data/lib/whop_sdk/models/transfer_list_params.rb +46 -40
  180. data/lib/whop_sdk/models/transfer_list_response.rb +29 -36
  181. data/lib/whop_sdk/models/transfer_retrieve_response.rb +267 -0
  182. data/lib/whop_sdk/models/unwrap_webhook_event.rb +9 -1
  183. data/lib/whop_sdk/models/user.rb +276 -31
  184. data/lib/whop_sdk/models/user_balance.rb +226 -0
  185. data/lib/whop_sdk/models/user_check_access_response.rb +16 -9
  186. data/lib/whop_sdk/models/user_list_params.rb +15 -15
  187. data/lib/whop_sdk/models/user_retrieve_params.rb +66 -6
  188. data/lib/whop_sdk/models/user_update_me_params.rb +70 -0
  189. data/lib/whop_sdk/models/user_update_params.rb +23 -30
  190. data/lib/whop_sdk/models/verification_create_params.rb +414 -0
  191. data/lib/whop_sdk/models/verification_create_response.rb +400 -0
  192. data/lib/whop_sdk/models/verification_list_params.rb +40 -30
  193. data/lib/whop_sdk/models/verification_list_response.rb +396 -34
  194. data/lib/whop_sdk/models/verification_retrieve_params.rb +4 -4
  195. data/lib/whop_sdk/models/verification_retrieve_response.rb +373 -21
  196. data/lib/whop_sdk/models/verification_update_params.rb +578 -0
  197. data/lib/whop_sdk/models/verification_update_response.rb +400 -0
  198. data/lib/whop_sdk/models/webhook_event.rb +4 -0
  199. data/lib/whop_sdk/models/withdrawal.rb +1 -0
  200. data/lib/whop_sdk/models/withdrawal_create_params.rb +2 -2
  201. data/lib/whop_sdk/models/workforce/bounty_list_params.rb +153 -0
  202. data/lib/whop_sdk/models/workforce/bounty_retrieve_params.rb +22 -0
  203. data/lib/whop_sdk/models/workforce/workforce_bounty.rb +351 -0
  204. data/lib/whop_sdk/models/workforce/workforce_bounty_list_item.rb +347 -0
  205. data/lib/whop_sdk/models.rb +105 -25
  206. data/lib/whop_sdk/resources/access_tokens.rb +0 -1
  207. data/lib/whop_sdk/resources/account_links.rb +0 -1
  208. data/lib/whop_sdk/resources/accounts/preferences.rb +78 -0
  209. data/lib/whop_sdk/resources/accounts.rb +104 -18
  210. data/lib/whop_sdk/resources/ad_campaigns.rb +127 -38
  211. data/lib/whop_sdk/resources/ad_groups.rb +150 -58
  212. data/lib/whop_sdk/resources/ad_reports.rb +10 -11
  213. data/lib/whop_sdk/resources/ads.rb +164 -41
  214. data/lib/whop_sdk/resources/affiliates/overrides.rb +0 -1
  215. data/lib/whop_sdk/resources/affiliates.rb +0 -2
  216. data/lib/whop_sdk/resources/ai_chats.rb +0 -1
  217. data/lib/whop_sdk/resources/app_builds.rb +0 -1
  218. data/lib/whop_sdk/resources/apps.rb +63 -3
  219. data/lib/whop_sdk/resources/audiences.rb +104 -0
  220. data/lib/whop_sdk/resources/authorized_users.rb +3 -2
  221. data/lib/whop_sdk/resources/bounties.rb +9 -2
  222. data/lib/whop_sdk/resources/cards.rb +178 -0
  223. data/lib/whop_sdk/resources/chat_channels.rb +0 -1
  224. data/lib/whop_sdk/resources/checkout_configurations.rb +69 -42
  225. data/lib/whop_sdk/resources/companies.rb +0 -1
  226. data/lib/whop_sdk/resources/company_token_transactions.rb +0 -1
  227. data/lib/whop_sdk/resources/course_chapters.rb +0 -1
  228. data/lib/whop_sdk/resources/course_lesson_interactions.rb +0 -1
  229. data/lib/whop_sdk/resources/course_lessons.rb +0 -1
  230. data/lib/whop_sdk/resources/course_students.rb +0 -1
  231. data/lib/whop_sdk/resources/courses.rb +0 -1
  232. data/lib/whop_sdk/resources/deposits.rb +37 -6
  233. data/lib/whop_sdk/resources/dispute_alerts.rb +0 -1
  234. data/lib/whop_sdk/resources/disputes.rb +0 -1
  235. data/lib/whop_sdk/resources/dm_channels.rb +0 -1
  236. data/lib/whop_sdk/resources/dm_members.rb +0 -1
  237. data/lib/whop_sdk/resources/entries.rb +0 -1
  238. data/lib/whop_sdk/resources/events.rb +121 -0
  239. data/lib/whop_sdk/resources/experiences.rb +0 -1
  240. data/lib/whop_sdk/resources/fee_markups.rb +0 -1
  241. data/lib/whop_sdk/resources/files.rb +0 -1
  242. data/lib/whop_sdk/resources/financial_activity.rb +76 -0
  243. data/lib/whop_sdk/resources/forum_posts.rb +0 -1
  244. data/lib/whop_sdk/resources/forums.rb +0 -1
  245. data/lib/whop_sdk/resources/invoices.rb +0 -1
  246. data/lib/whop_sdk/resources/leads.rb +0 -1
  247. data/lib/whop_sdk/resources/ledger_accounts.rb +0 -1
  248. data/lib/whop_sdk/resources/media.rb +77 -0
  249. data/lib/whop_sdk/resources/members.rb +0 -1
  250. data/lib/whop_sdk/resources/memberships.rb +0 -1
  251. data/lib/whop_sdk/resources/messages.rb +0 -1
  252. data/lib/whop_sdk/resources/notifications.rb +0 -1
  253. data/lib/whop_sdk/resources/payment_methods.rb +0 -1
  254. data/lib/whop_sdk/resources/payments.rb +0 -1
  255. data/lib/whop_sdk/resources/payout_accounts.rb +0 -1
  256. data/lib/whop_sdk/resources/payouts/methods.rb +71 -0
  257. data/lib/whop_sdk/resources/payouts.rb +107 -0
  258. data/lib/whop_sdk/resources/people.rb +99 -0
  259. data/lib/whop_sdk/resources/plans.rb +94 -82
  260. data/lib/whop_sdk/resources/products.rb +48 -97
  261. data/lib/whop_sdk/resources/promo_codes.rb +0 -1
  262. data/lib/whop_sdk/resources/reactions.rb +0 -1
  263. data/lib/whop_sdk/resources/referrals/businesses/earnings.rb +67 -0
  264. data/lib/whop_sdk/resources/referrals/businesses.rb +132 -0
  265. data/lib/whop_sdk/resources/referrals/partners.rb +42 -0
  266. data/lib/whop_sdk/resources/referrals.rb +77 -0
  267. data/lib/whop_sdk/resources/refunds.rb +0 -1
  268. data/lib/whop_sdk/resources/resolution_center_cases.rb +0 -1
  269. data/lib/whop_sdk/resources/reviews.rb +0 -1
  270. data/lib/whop_sdk/resources/setup_intents.rb +0 -1
  271. data/lib/whop_sdk/resources/shipments.rb +0 -1
  272. data/lib/whop_sdk/resources/social_accounts.rb +192 -0
  273. data/lib/whop_sdk/resources/stats.rb +113 -0
  274. data/lib/whop_sdk/resources/support_channels.rb +0 -1
  275. data/lib/whop_sdk/resources/swaps.rb +100 -9
  276. data/lib/whop_sdk/resources/topups.rb +0 -1
  277. data/lib/whop_sdk/resources/transfers.rb +42 -42
  278. data/lib/whop_sdk/resources/users.rb +82 -33
  279. data/lib/whop_sdk/resources/verifications.rb +81 -20
  280. data/lib/whop_sdk/resources/webhooks.rb +1 -2
  281. data/lib/whop_sdk/resources/withdrawals.rb +1 -2
  282. data/lib/whop_sdk/resources/workforce/bounties.rb +97 -0
  283. data/lib/whop_sdk/resources/workforce.rb +25 -0
  284. data/lib/whop_sdk/version.rb +1 -1
  285. data/lib/whop_sdk.rb +120 -28
  286. data/rbi/whop_sdk/client.rbi +200 -70
  287. data/rbi/whop_sdk/models/account.rbi +1404 -36
  288. data/rbi/whop_sdk/models/account_create_params.rbi +13 -0
  289. data/rbi/whop_sdk/models/account_list_params.rbi +104 -18
  290. data/rbi/whop_sdk/models/{wallet_balance_params.rbi → account_recommend_actions_params.rbi} +5 -2
  291. data/rbi/whop_sdk/models/account_recommend_actions_response.rbi +296 -0
  292. data/rbi/whop_sdk/models/account_update_params.rbi +976 -10
  293. data/rbi/whop_sdk/models/accounts/preference_retrieve_params.rbi +40 -0
  294. data/rbi/whop_sdk/models/accounts/preference_retrieve_response.rbi +323 -0
  295. data/rbi/whop_sdk/models/accounts/preference_update_params.rbi +331 -0
  296. data/rbi/whop_sdk/models/accounts/preference_update_response.rbi +323 -0
  297. data/rbi/whop_sdk/models/ad.rbi +876 -36
  298. data/rbi/whop_sdk/models/ad_campaign.rbi +700 -334
  299. data/rbi/whop_sdk/models/ad_campaign_create_params.rbi +428 -0
  300. data/rbi/whop_sdk/models/{payout_method_retrieve_params.rbi → ad_campaign_delete_params.rbi} +2 -2
  301. data/rbi/whop_sdk/models/ad_campaign_delete_response.rbi +8 -0
  302. data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +276 -49
  303. data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +41 -2
  304. data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +207 -8
  305. data/rbi/whop_sdk/models/ad_create_params.rbi +1491 -0
  306. data/rbi/whop_sdk/models/ad_delete_params.rbi +35 -0
  307. data/rbi/whop_sdk/models/ad_delete_response.rbi +7 -0
  308. data/rbi/whop_sdk/models/ad_group.rbi +866 -44
  309. data/rbi/whop_sdk/models/ad_group_create_params.rbi +654 -0
  310. data/rbi/whop_sdk/models/ad_group_list_params.rbi +230 -60
  311. data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +41 -2
  312. data/rbi/whop_sdk/models/ad_group_update_params.rbi +524 -5967
  313. data/rbi/whop_sdk/models/ad_list_params.rbi +219 -103
  314. data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +33 -33
  315. data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +62 -62
  316. data/rbi/whop_sdk/models/ad_retrieve_params.rbi +41 -2
  317. data/rbi/whop_sdk/models/ad_update_params.rbi +1473 -0
  318. data/rbi/whop_sdk/models/app.rbi +111 -0
  319. data/rbi/whop_sdk/models/app_build_create_params.rbi +3 -3
  320. data/rbi/whop_sdk/models/app_create_params.rbi +10 -0
  321. data/rbi/whop_sdk/models/app_list_response.rbi +20 -0
  322. data/rbi/whop_sdk/models/app_logs_params.rbi +154 -0
  323. data/rbi/whop_sdk/models/app_logs_response.rbi +261 -0
  324. data/rbi/whop_sdk/models/app_update_params.rbi +24 -0
  325. data/rbi/whop_sdk/models/audience.rbi +262 -0
  326. data/rbi/whop_sdk/models/audience_create_params.rbi +160 -0
  327. data/rbi/whop_sdk/models/audience_delete_params.rbi +35 -0
  328. data/rbi/whop_sdk/models/audience_delete_response.rbi +26 -0
  329. data/rbi/whop_sdk/models/audience_list_params.rbi +76 -0
  330. data/rbi/whop_sdk/models/authorized_user_create_params.rbi +102 -0
  331. data/rbi/whop_sdk/models/bounty_create_params.rbi +164 -4
  332. data/rbi/whop_sdk/models/bounty_create_response.rbi +5 -0
  333. data/rbi/whop_sdk/models/bounty_list_params.rbi +2 -0
  334. data/rbi/whop_sdk/models/bounty_list_response.rbi +5 -0
  335. data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +5 -0
  336. data/rbi/whop_sdk/models/card_brands.rbi +1 -0
  337. data/rbi/whop_sdk/models/card_create_params.rbi +167 -0
  338. data/rbi/whop_sdk/models/card_create_response.rbi +446 -0
  339. data/rbi/whop_sdk/models/card_list_params.rbi +57 -0
  340. data/rbi/whop_sdk/models/card_list_response.rbi +511 -0
  341. data/rbi/whop_sdk/models/card_retrieve_params.rbi +63 -0
  342. data/rbi/whop_sdk/models/card_retrieve_response.rbi +457 -0
  343. data/rbi/whop_sdk/models/card_update_params.rbi +299 -0
  344. data/rbi/whop_sdk/models/card_update_response.rbi +446 -0
  345. data/rbi/whop_sdk/models/chat_message_created_webhook_event.rbi +319 -0
  346. data/rbi/whop_sdk/models/chat_reaction_created_webhook_event.rbi +335 -0
  347. data/rbi/whop_sdk/models/checkout_configuration.rbi +34 -46
  348. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +404 -1592
  349. data/rbi/whop_sdk/models/checkout_configuration_create_response.rbi +420 -0
  350. data/rbi/whop_sdk/models/checkout_configuration_delete_params.rbi +38 -0
  351. data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +142 -51
  352. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +199 -213
  353. data/rbi/whop_sdk/models/checkout_configuration_retrieve_response.rbi +422 -0
  354. data/rbi/whop_sdk/models/company.rbi +2 -2
  355. data/rbi/whop_sdk/models/company_list_response.rbi +2 -2
  356. data/rbi/whop_sdk/models/course.rbi +2 -2
  357. data/rbi/whop_sdk/models/course_list_response.rbi +2 -2
  358. data/rbi/whop_sdk/models/deposit_create_params.rbi +26 -13
  359. data/rbi/whop_sdk/models/deposit_create_response.rbi +331 -79
  360. data/rbi/whop_sdk/models/deposit_list_params.rbi +40 -0
  361. data/rbi/whop_sdk/models/deposit_list_response.rbi +163 -0
  362. data/rbi/whop_sdk/models/dispute.rbi +8 -8
  363. data/rbi/whop_sdk/models/event_create_params.rbi +891 -0
  364. data/rbi/whop_sdk/models/{conversion_create_response.rbi → event_create_response.rbi} +3 -8
  365. data/rbi/whop_sdk/models/event_list_params.rbi +111 -0
  366. data/rbi/whop_sdk/models/event_list_response.rbi +350 -0
  367. data/rbi/whop_sdk/models/experience.rbi +6 -6
  368. data/rbi/whop_sdk/models/experience_list_response.rbi +2 -2
  369. data/rbi/whop_sdk/models/financial_activity_list_params.rbi +175 -0
  370. data/rbi/whop_sdk/models/financial_activity_list_response.rbi +2066 -0
  371. data/rbi/whop_sdk/models/forum_post.rbi +2 -2
  372. data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
  373. data/rbi/whop_sdk/models/granularities.rbi +3 -1
  374. data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +6 -6
  375. data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +6 -6
  376. data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +6 -6
  377. data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +6 -6
  378. data/rbi/whop_sdk/models/invoice_create_params.rbi +32 -0
  379. data/rbi/whop_sdk/models/invoice_update_params.rbi +16 -0
  380. data/rbi/whop_sdk/models/ledger_account_funds_available_webhook_event.rbi +1001 -0
  381. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +2 -2
  382. data/rbi/whop_sdk/models/lesson.rbi +6 -6
  383. data/rbi/whop_sdk/models/media_asset.rbi +325 -0
  384. data/rbi/whop_sdk/models/media_generate_params.rbi +204 -0
  385. data/rbi/whop_sdk/models/media_retrieve_params.rbi +35 -0
  386. data/rbi/whop_sdk/models/membership.rbi +12 -8
  387. data/rbi/whop_sdk/models/membership_list_response.rbi +12 -8
  388. data/rbi/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbi +85 -0
  389. data/rbi/whop_sdk/models/payment.rbi +226 -10
  390. data/rbi/whop_sdk/models/payment_create_params.rbi +30 -6
  391. data/rbi/whop_sdk/models/payment_list_response.rbi +127 -10
  392. data/rbi/whop_sdk/models/payout_create_params.rbi +83 -0
  393. data/rbi/whop_sdk/models/payout_create_response.rbi +352 -0
  394. data/rbi/whop_sdk/models/payout_list_params.rbi +112 -0
  395. data/rbi/whop_sdk/models/payout_list_response.rbi +353 -0
  396. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +64 -3
  397. data/rbi/whop_sdk/models/payouts/method_list_params.rbi +209 -0
  398. data/rbi/whop_sdk/models/payouts/method_list_response.rbi +554 -0
  399. data/rbi/whop_sdk/models/person_list_params.rbi +160 -0
  400. data/rbi/whop_sdk/models/person_list_response.rbi +282 -0
  401. data/rbi/whop_sdk/models/person_retrieve_params.rbi +76 -0
  402. data/rbi/whop_sdk/models/person_retrieve_response.rbi +349 -0
  403. data/rbi/whop_sdk/models/plan.rbi +318 -343
  404. data/rbi/whop_sdk/models/plan_calculate_tax_params.rbi +795 -0
  405. data/rbi/whop_sdk/models/plan_calculate_tax_response.rbi +170 -0
  406. data/rbi/whop_sdk/models/plan_create_params.rbi +228 -232
  407. data/rbi/whop_sdk/models/plan_list_params.rbi +121 -67
  408. data/rbi/whop_sdk/models/plan_list_response.rbi +122 -417
  409. data/rbi/whop_sdk/models/plan_update_params.rbi +189 -207
  410. data/rbi/whop_sdk/models/product.rbi +42 -48
  411. data/rbi/whop_sdk/models/product_create_params.rbi +68 -284
  412. data/rbi/whop_sdk/models/product_list_item.rbi +18 -18
  413. data/rbi/whop_sdk/models/product_list_params.rbi +75 -78
  414. data/rbi/whop_sdk/models/product_update_params.rbi +28 -217
  415. data/rbi/whop_sdk/models/referral_referred_users_params.rbi +106 -0
  416. data/rbi/whop_sdk/models/referral_referred_users_response.rbi +259 -0
  417. data/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi +120 -0
  418. data/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi +535 -0
  419. data/rbi/whop_sdk/models/referrals/business_list_params.rbi +376 -0
  420. data/rbi/whop_sdk/models/referrals/business_list_response.rbi +701 -0
  421. data/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi +40 -0
  422. data/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi +1846 -0
  423. data/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi +308 -0
  424. data/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi +693 -0
  425. data/rbi/whop_sdk/models/referrals/partner_create_params.rbi +32 -0
  426. data/rbi/whop_sdk/models/referrals/partner_create_response.rbi +48 -0
  427. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +10 -6
  428. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +10 -6
  429. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +10 -6
  430. data/rbi/whop_sdk/models/result_label_keys.rbi +23 -0
  431. data/rbi/whop_sdk/models/review_list_response.rbi +2 -2
  432. data/rbi/whop_sdk/models/review_retrieve_response.rbi +4 -4
  433. data/rbi/whop_sdk/models/setup_intent.rbi +13 -3
  434. data/rbi/whop_sdk/models/social_account.rbi +129 -0
  435. data/rbi/whop_sdk/models/social_account_connect_params.rbi +146 -0
  436. data/rbi/whop_sdk/models/social_account_connect_response.rbi +30 -0
  437. data/rbi/whop_sdk/models/social_account_create_params.rbi +81 -0
  438. data/rbi/whop_sdk/models/social_account_delete_params.rbi +67 -0
  439. data/rbi/whop_sdk/models/social_account_delete_response.rbi +8 -0
  440. data/rbi/whop_sdk/models/social_account_list_params.rbi +308 -0
  441. data/rbi/whop_sdk/models/social_account_post.rbi +261 -0
  442. data/rbi/whop_sdk/models/social_account_posts_params.rbi +82 -0
  443. data/rbi/whop_sdk/models/social_account_posts_response.rbi +83 -0
  444. data/rbi/whop_sdk/models/{wallet_list_params.rbi → stat_list_params.rbi} +2 -2
  445. data/rbi/whop_sdk/models/stat_list_response.rbi +159 -0
  446. data/rbi/whop_sdk/models/stat_retrieve_params.rbi +411 -0
  447. data/rbi/whop_sdk/models/stat_retrieve_response.rbi +198 -0
  448. data/rbi/whop_sdk/models/swap_create_params.rbi +128 -0
  449. data/rbi/whop_sdk/models/swap_create_quote_params.rbi +26 -6
  450. data/rbi/whop_sdk/models/swap_create_quote_response.rbi +26 -0
  451. data/rbi/whop_sdk/models/swap_create_response.rbi +127 -0
  452. data/rbi/whop_sdk/models/swap_list_params.rbi +40 -0
  453. data/rbi/whop_sdk/models/swap_list_response.rbi +137 -0
  454. data/rbi/whop_sdk/models/swap_retrieve_params.rbi +35 -0
  455. data/rbi/whop_sdk/models/swap_retrieve_response.rbi +106 -0
  456. data/rbi/whop_sdk/models/tax_identifier_type.rbi +2 -0
  457. data/rbi/whop_sdk/models/transfer_create_params.rbi +94 -40
  458. data/rbi/whop_sdk/models/transfer_create_response.rbi +767 -0
  459. data/rbi/whop_sdk/models/transfer_list_params.rbi +111 -60
  460. data/rbi/whop_sdk/models/transfer_list_response.rbi +32 -40
  461. data/rbi/whop_sdk/models/transfer_retrieve_response.rbi +416 -0
  462. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +4 -0
  463. data/rbi/whop_sdk/models/user.rbi +427 -45
  464. data/rbi/whop_sdk/models/user_balance.rbi +301 -0
  465. data/rbi/whop_sdk/models/user_check_access_response.rbi +46 -12
  466. data/rbi/whop_sdk/models/user_list_params.rbi +40 -25
  467. data/rbi/whop_sdk/models/user_retrieve_params.rbi +106 -8
  468. data/rbi/whop_sdk/models/user_update_me_params.rbi +120 -0
  469. data/rbi/whop_sdk/models/user_update_params.rbi +46 -45
  470. data/rbi/whop_sdk/models/verification_create_params.rbi +783 -0
  471. data/rbi/whop_sdk/models/verification_create_response.rbi +757 -0
  472. data/rbi/whop_sdk/models/verification_list_params.rbi +88 -34
  473. data/rbi/whop_sdk/models/verification_list_response.rbi +783 -39
  474. data/rbi/whop_sdk/models/verification_retrieve_params.rbi +4 -4
  475. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +722 -30
  476. data/rbi/whop_sdk/models/verification_update_params.rbi +1187 -0
  477. data/rbi/whop_sdk/models/verification_update_response.rbi +757 -0
  478. data/rbi/whop_sdk/models/webhook_event.rbi +14 -0
  479. data/rbi/whop_sdk/models/withdrawal.rbi +5 -0
  480. data/rbi/whop_sdk/models/withdrawal_create_params.rbi +2 -2
  481. data/rbi/whop_sdk/models/workforce/bounty_list_params.rbi +313 -0
  482. data/rbi/whop_sdk/models/workforce/bounty_retrieve_params.rbi +40 -0
  483. data/rbi/whop_sdk/models/workforce/workforce_bounty.rbi +588 -0
  484. data/rbi/whop_sdk/models/workforce/workforce_bounty_list_item.rbi +590 -0
  485. data/rbi/whop_sdk/models.rbi +110 -25
  486. data/rbi/whop_sdk/resources/access_tokens.rbi +0 -1
  487. data/rbi/whop_sdk/resources/account_links.rbi +0 -1
  488. data/rbi/whop_sdk/resources/accounts/preferences.rbi +62 -0
  489. data/rbi/whop_sdk/resources/accounts.rbi +132 -16
  490. data/rbi/whop_sdk/resources/ad_campaigns.rbi +169 -56
  491. data/rbi/whop_sdk/resources/ad_groups.rbi +261 -87
  492. data/rbi/whop_sdk/resources/ad_reports.rbi +20 -21
  493. data/rbi/whop_sdk/resources/ads.rbi +225 -67
  494. data/rbi/whop_sdk/resources/affiliates/overrides.rbi +0 -1
  495. data/rbi/whop_sdk/resources/affiliates.rbi +0 -2
  496. data/rbi/whop_sdk/resources/ai_chats.rbi +0 -1
  497. data/rbi/whop_sdk/resources/app_builds.rbi +1 -2
  498. data/rbi/whop_sdk/resources/apps.rbi +66 -1
  499. data/rbi/whop_sdk/resources/audiences.rbi +82 -0
  500. data/rbi/whop_sdk/resources/authorized_users.rbi +4 -1
  501. data/rbi/whop_sdk/resources/bounties.rbi +23 -3
  502. data/rbi/whop_sdk/resources/cards.rbi +160 -0
  503. data/rbi/whop_sdk/resources/chat_channels.rbi +0 -1
  504. data/rbi/whop_sdk/resources/checkout_configurations.rbi +82 -51
  505. data/rbi/whop_sdk/resources/companies.rbi +0 -1
  506. data/rbi/whop_sdk/resources/company_token_transactions.rbi +0 -1
  507. data/rbi/whop_sdk/resources/course_chapters.rbi +0 -1
  508. data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +0 -1
  509. data/rbi/whop_sdk/resources/course_lessons.rbi +0 -1
  510. data/rbi/whop_sdk/resources/course_students.rbi +0 -1
  511. data/rbi/whop_sdk/resources/courses.rbi +0 -1
  512. data/rbi/whop_sdk/resources/deposits.rbi +28 -6
  513. data/rbi/whop_sdk/resources/dispute_alerts.rbi +0 -1
  514. data/rbi/whop_sdk/resources/disputes.rbi +0 -1
  515. data/rbi/whop_sdk/resources/dm_channels.rbi +0 -1
  516. data/rbi/whop_sdk/resources/dm_members.rbi +0 -1
  517. data/rbi/whop_sdk/resources/entries.rbi +0 -1
  518. data/rbi/whop_sdk/resources/events.rbi +122 -0
  519. data/rbi/whop_sdk/resources/experiences.rbi +0 -1
  520. data/rbi/whop_sdk/resources/fee_markups.rbi +0 -1
  521. data/rbi/whop_sdk/resources/files.rbi +0 -1
  522. data/rbi/whop_sdk/resources/financial_activity.rbi +80 -0
  523. data/rbi/whop_sdk/resources/forum_posts.rbi +0 -1
  524. data/rbi/whop_sdk/resources/forums.rbi +0 -1
  525. data/rbi/whop_sdk/resources/invoices.rbi +0 -1
  526. data/rbi/whop_sdk/resources/leads.rbi +0 -1
  527. data/rbi/whop_sdk/resources/ledger_accounts.rbi +0 -1
  528. data/rbi/whop_sdk/resources/media.rbi +67 -0
  529. data/rbi/whop_sdk/resources/members.rbi +0 -1
  530. data/rbi/whop_sdk/resources/memberships.rbi +0 -1
  531. data/rbi/whop_sdk/resources/messages.rbi +0 -1
  532. data/rbi/whop_sdk/resources/notifications.rbi +0 -1
  533. data/rbi/whop_sdk/resources/payment_methods.rbi +0 -1
  534. data/rbi/whop_sdk/resources/payments.rbi +0 -1
  535. data/rbi/whop_sdk/resources/payout_accounts.rbi +0 -1
  536. data/rbi/whop_sdk/resources/payouts/methods.rbi +76 -0
  537. data/rbi/whop_sdk/resources/payouts.rbi +96 -0
  538. data/rbi/whop_sdk/resources/people.rbi +86 -0
  539. data/rbi/whop_sdk/resources/plans.rbi +114 -124
  540. data/rbi/whop_sdk/resources/products.rbi +65 -152
  541. data/rbi/whop_sdk/resources/promo_codes.rbi +0 -1
  542. data/rbi/whop_sdk/resources/reactions.rbi +0 -1
  543. data/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi +67 -0
  544. data/rbi/whop_sdk/resources/referrals/businesses.rbi +122 -0
  545. data/rbi/whop_sdk/resources/referrals/partners.rbi +31 -0
  546. data/rbi/whop_sdk/resources/referrals.rbi +67 -0
  547. data/rbi/whop_sdk/resources/refunds.rbi +0 -1
  548. data/rbi/whop_sdk/resources/resolution_center_cases.rbi +0 -1
  549. data/rbi/whop_sdk/resources/reviews.rbi +0 -1
  550. data/rbi/whop_sdk/resources/setup_intents.rbi +0 -1
  551. data/rbi/whop_sdk/resources/shipments.rbi +0 -1
  552. data/rbi/whop_sdk/resources/social_accounts.rbi +161 -0
  553. data/rbi/whop_sdk/resources/stats.rbi +143 -0
  554. data/rbi/whop_sdk/resources/support_channels.rbi +0 -1
  555. data/rbi/whop_sdk/resources/swaps.rbi +81 -3
  556. data/rbi/whop_sdk/resources/topups.rbi +0 -1
  557. data/rbi/whop_sdk/resources/transfers.rbi +62 -61
  558. data/rbi/whop_sdk/resources/users.rbi +92 -48
  559. data/rbi/whop_sdk/resources/verifications.rbi +85 -35
  560. data/rbi/whop_sdk/resources/webhooks.rbi +4 -1
  561. data/rbi/whop_sdk/resources/withdrawals.rbi +1 -2
  562. data/rbi/whop_sdk/resources/workforce/bounties.rbi +94 -0
  563. data/rbi/whop_sdk/resources/workforce.rbi +22 -0
  564. data/sig/whop_sdk/client.rbs +24 -5
  565. data/sig/whop_sdk/models/account.rbs +610 -4
  566. data/sig/whop_sdk/models/account_create_params.rbs +7 -1
  567. data/sig/whop_sdk/models/account_list_params.rbs +65 -9
  568. data/sig/whop_sdk/models/{wallet_send_params.rbs → account_recommend_actions_params.rbs} +3 -12
  569. data/sig/whop_sdk/models/account_recommend_actions_response.rbs +129 -0
  570. data/sig/whop_sdk/models/account_update_params.rbs +426 -1
  571. data/sig/whop_sdk/models/accounts/preference_retrieve_params.rbs +25 -0
  572. data/sig/whop_sdk/models/accounts/preference_retrieve_response.rbs +110 -0
  573. data/sig/whop_sdk/models/accounts/preference_update_params.rbs +133 -0
  574. data/sig/whop_sdk/models/accounts/preference_update_response.rbs +110 -0
  575. data/sig/whop_sdk/models/ad.rbs +538 -16
  576. data/sig/whop_sdk/models/ad_campaign.rbs +396 -118
  577. data/sig/whop_sdk/models/ad_campaign_create_params.rbs +179 -0
  578. data/sig/whop_sdk/models/{payout_method_retrieve_params.rbs → ad_campaign_delete_params.rbs} +2 -2
  579. data/sig/whop_sdk/models/ad_campaign_delete_response.rbs +5 -0
  580. data/sig/whop_sdk/models/ad_campaign_list_params.rbs +156 -36
  581. data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +24 -2
  582. data/sig/whop_sdk/models/ad_campaign_update_params.rbs +90 -4
  583. data/sig/whop_sdk/models/ad_create_params.rbs +751 -0
  584. data/sig/whop_sdk/models/ad_delete_params.rbs +20 -0
  585. data/sig/whop_sdk/models/ad_delete_response.rbs +5 -0
  586. data/sig/whop_sdk/models/ad_group.rbs +497 -24
  587. data/sig/whop_sdk/models/ad_group_create_params.rbs +292 -0
  588. data/sig/whop_sdk/models/ad_group_list_params.rbs +146 -44
  589. data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +24 -2
  590. data/sig/whop_sdk/models/ad_group_update_params.rbs +209 -2345
  591. data/sig/whop_sdk/models/ad_list_params.rbs +156 -68
  592. data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +12 -12
  593. data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +36 -36
  594. data/sig/whop_sdk/models/ad_retrieve_params.rbs +24 -2
  595. data/sig/whop_sdk/models/ad_update_params.rbs +742 -0
  596. data/sig/whop_sdk/models/app.rbs +52 -0
  597. data/sig/whop_sdk/models/app_create_params.rbs +6 -1
  598. data/sig/whop_sdk/models/app_list_response.rbs +10 -0
  599. data/sig/whop_sdk/models/app_logs_params.rbs +98 -0
  600. data/sig/whop_sdk/models/app_logs_response.rbs +162 -0
  601. data/sig/whop_sdk/models/app_update_params.rbs +10 -0
  602. data/sig/whop_sdk/models/audience.rbs +145 -0
  603. data/sig/whop_sdk/models/audience_create_params.rbs +88 -0
  604. data/sig/whop_sdk/models/audience_delete_params.rbs +23 -0
  605. data/sig/whop_sdk/models/audience_delete_response.rbs +13 -0
  606. data/sig/whop_sdk/models/audience_list_params.rbs +42 -0
  607. data/sig/whop_sdk/models/authorized_user_create_params.rbs +52 -0
  608. data/sig/whop_sdk/models/bounty_create_params.rbs +56 -1
  609. data/sig/whop_sdk/models/bounty_create_response.rbs +2 -1
  610. data/sig/whop_sdk/models/bounty_list_params.rbs +2 -1
  611. data/sig/whop_sdk/models/bounty_list_response.rbs +2 -1
  612. data/sig/whop_sdk/models/bounty_retrieve_response.rbs +2 -1
  613. data/sig/whop_sdk/models/card_brands.rbs +2 -0
  614. data/sig/whop_sdk/models/card_create_params.rbs +85 -0
  615. data/sig/whop_sdk/models/card_create_response.rbs +200 -0
  616. data/sig/whop_sdk/models/card_list_params.rbs +32 -0
  617. data/sig/whop_sdk/models/card_list_response.rbs +214 -0
  618. data/sig/whop_sdk/models/card_retrieve_params.rbs +36 -0
  619. data/sig/whop_sdk/models/card_retrieve_response.rbs +200 -0
  620. data/sig/whop_sdk/models/card_update_params.rbs +164 -0
  621. data/sig/whop_sdk/models/card_update_response.rbs +200 -0
  622. data/sig/whop_sdk/models/chat_message_created_webhook_event.rbs +149 -0
  623. data/sig/whop_sdk/models/chat_reaction_created_webhook_event.rbs +154 -0
  624. data/sig/whop_sdk/models/checkout_configuration.rbs +0 -5
  625. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +206 -665
  626. data/sig/whop_sdk/models/checkout_configuration_create_response.rbs +196 -0
  627. data/sig/whop_sdk/models/checkout_configuration_delete_params.rbs +20 -0
  628. data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +66 -32
  629. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +87 -71
  630. data/sig/whop_sdk/models/checkout_configuration_retrieve_response.rbs +196 -0
  631. data/sig/whop_sdk/models/deposit_create_params.rbs +7 -5
  632. data/sig/whop_sdk/models/deposit_create_response.rbs +137 -49
  633. data/sig/whop_sdk/models/{wallet_balance_params.rbs → deposit_list_params.rbs} +2 -2
  634. data/sig/whop_sdk/models/deposit_list_response.rbs +87 -0
  635. data/sig/whop_sdk/models/event_create_params.rbs +639 -0
  636. data/sig/whop_sdk/models/{conversion_create_response.rbs → event_create_response.rbs} +2 -2
  637. data/sig/whop_sdk/models/event_list_params.rbs +68 -0
  638. data/sig/whop_sdk/models/event_list_response.rbs +231 -0
  639. data/sig/whop_sdk/models/financial_activity_list_params.rbs +98 -0
  640. data/sig/whop_sdk/models/financial_activity_list_response.rbs +935 -0
  641. data/sig/whop_sdk/models/granularities.rbs +4 -2
  642. data/sig/whop_sdk/models/invoice_create_params.rbs +20 -0
  643. data/sig/whop_sdk/models/invoice_update_params.rbs +10 -0
  644. data/sig/whop_sdk/models/ledger_account_funds_available_webhook_event.rbs +418 -0
  645. data/sig/whop_sdk/models/media_asset.rbs +160 -0
  646. data/sig/whop_sdk/models/media_generate_params.rbs +99 -0
  647. data/sig/whop_sdk/models/media_retrieve_params.rbs +20 -0
  648. data/sig/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbs +45 -0
  649. data/sig/whop_sdk/models/payment.rbs +109 -0
  650. data/sig/whop_sdk/models/payment_create_params.rbs +16 -6
  651. data/sig/whop_sdk/models/payment_list_response.rbs +52 -0
  652. data/sig/whop_sdk/models/payout_create_params.rbs +50 -0
  653. data/sig/whop_sdk/models/payout_create_response.rbs +139 -0
  654. data/sig/whop_sdk/models/payout_list_params.rbs +70 -0
  655. data/sig/whop_sdk/models/payout_list_response.rbs +153 -0
  656. data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +25 -4
  657. data/sig/whop_sdk/models/payouts/method_list_params.rbs +107 -0
  658. data/sig/whop_sdk/models/payouts/method_list_response.rbs +229 -0
  659. data/sig/whop_sdk/models/person_list_params.rbs +97 -0
  660. data/sig/whop_sdk/models/person_list_response.rbs +162 -0
  661. data/sig/whop_sdk/models/person_retrieve_params.rbs +42 -0
  662. data/sig/whop_sdk/models/person_retrieve_response.rbs +175 -0
  663. data/sig/whop_sdk/models/plan.rbs +309 -124
  664. data/sig/whop_sdk/models/plan_calculate_tax_params.rbs +344 -0
  665. data/sig/whop_sdk/models/plan_calculate_tax_response.rbs +67 -0
  666. data/sig/whop_sdk/models/plan_create_params.rbs +126 -106
  667. data/sig/whop_sdk/models/plan_list_params.rbs +93 -54
  668. data/sig/whop_sdk/models/plan_list_response.rbs +73 -145
  669. data/sig/whop_sdk/models/plan_update_params.rbs +102 -90
  670. data/sig/whop_sdk/models/product_create_params.rbs +32 -128
  671. data/sig/whop_sdk/models/product_list_params.rbs +53 -48
  672. data/sig/whop_sdk/models/product_update_params.rbs +15 -93
  673. data/sig/whop_sdk/models/referral_referred_users_params.rbs +63 -0
  674. data/sig/whop_sdk/models/referral_referred_users_response.rbs +140 -0
  675. data/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs +46 -0
  676. data/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs +221 -0
  677. data/sig/whop_sdk/models/referrals/business_list_params.rbs +176 -0
  678. data/sig/whop_sdk/models/referrals/business_list_response.rbs +267 -0
  679. data/sig/whop_sdk/models/referrals/business_retrieve_params.rbs +22 -0
  680. data/sig/whop_sdk/models/referrals/business_retrieve_response.rbs +677 -0
  681. data/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs +139 -0
  682. data/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs +288 -0
  683. data/sig/whop_sdk/models/referrals/partner_create_params.rbs +17 -0
  684. data/sig/whop_sdk/models/referrals/partner_create_response.rbs +21 -0
  685. data/sig/whop_sdk/models/result_label_keys.rbs +20 -0
  686. data/sig/whop_sdk/models/setup_intent.rbs +8 -3
  687. data/sig/whop_sdk/models/social_account.rbs +74 -0
  688. data/sig/whop_sdk/models/social_account_connect_params.rbs +69 -0
  689. data/sig/whop_sdk/models/social_account_connect_response.rbs +13 -0
  690. data/sig/whop_sdk/models/social_account_create_params.rbs +43 -0
  691. data/sig/whop_sdk/models/social_account_delete_params.rbs +36 -0
  692. data/sig/whop_sdk/models/social_account_delete_response.rbs +5 -0
  693. data/sig/whop_sdk/models/social_account_list_params.rbs +152 -0
  694. data/sig/whop_sdk/models/social_account_post.rbs +111 -0
  695. data/sig/whop_sdk/models/social_account_posts_params.rbs +52 -0
  696. data/sig/whop_sdk/models/social_account_posts_response.rbs +37 -0
  697. data/sig/whop_sdk/models/{wallet_list_params.rbs → stat_list_params.rbs} +2 -2
  698. data/sig/whop_sdk/models/stat_list_response.rbs +72 -0
  699. data/sig/whop_sdk/models/stat_retrieve_params.rbs +211 -0
  700. data/sig/whop_sdk/models/stat_retrieve_response.rbs +81 -0
  701. data/sig/whop_sdk/models/swap_create_params.rbs +72 -0
  702. data/sig/whop_sdk/models/swap_create_response.rbs +73 -0
  703. data/sig/whop_sdk/models/swap_list_params.rbs +23 -0
  704. data/sig/whop_sdk/models/swap_list_response.rbs +68 -0
  705. data/sig/whop_sdk/models/swap_retrieve_params.rbs +20 -0
  706. data/sig/whop_sdk/models/swap_retrieve_response.rbs +55 -0
  707. data/sig/whop_sdk/models/tax_identifier_type.rbs +4 -0
  708. data/sig/whop_sdk/models/transfer_create_params.rbs +47 -10
  709. data/sig/whop_sdk/models/transfer_create_response.rbs +366 -0
  710. data/sig/whop_sdk/models/transfer_list_params.rbs +77 -42
  711. data/sig/whop_sdk/models/transfer_list_response.rbs +14 -14
  712. data/sig/whop_sdk/models/{transfer.rbs → transfer_retrieve_response.rbs} +83 -78
  713. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +5 -1
  714. data/sig/whop_sdk/models/user.rbs +203 -16
  715. data/sig/whop_sdk/models/user_balance.rbs +171 -0
  716. data/sig/whop_sdk/models/user_check_access_response.rbs +19 -4
  717. data/sig/whop_sdk/models/user_list_params.rbs +30 -20
  718. data/sig/whop_sdk/models/user_retrieve_params.rbs +59 -4
  719. data/sig/whop_sdk/models/user_update_me_params.rbs +74 -0
  720. data/sig/whop_sdk/models/user_update_params.rbs +42 -24
  721. data/sig/whop_sdk/models/verification_create_params.rbs +364 -0
  722. data/sig/whop_sdk/models/verification_create_response.rbs +333 -0
  723. data/sig/whop_sdk/models/verification_list_params.rbs +40 -20
  724. data/sig/whop_sdk/models/verification_list_response.rbs +337 -20
  725. data/sig/whop_sdk/models/verification_retrieve_params.rbs +7 -4
  726. data/sig/whop_sdk/models/verification_retrieve_response.rbs +312 -14
  727. data/sig/whop_sdk/models/verification_update_params.rbs +570 -0
  728. data/sig/whop_sdk/models/verification_update_response.rbs +333 -0
  729. data/sig/whop_sdk/models/webhook_event.rbs +8 -0
  730. data/sig/whop_sdk/models/withdrawal.rbs +2 -0
  731. data/sig/whop_sdk/models/workforce/bounty_list_params.rbs +149 -0
  732. data/sig/whop_sdk/models/workforce/bounty_retrieve_params.rbs +22 -0
  733. data/sig/whop_sdk/models/workforce/workforce_bounty.rbs +232 -0
  734. data/sig/whop_sdk/models/workforce/workforce_bounty_list_item.rbs +227 -0
  735. data/sig/whop_sdk/models.rbs +105 -25
  736. data/sig/whop_sdk/resources/accounts/preferences.rbs +20 -0
  737. data/sig/whop_sdk/resources/accounts.rbs +33 -3
  738. data/sig/whop_sdk/resources/ad_campaigns.rbs +43 -11
  739. data/sig/whop_sdk/resources/ad_groups.rbs +65 -19
  740. data/sig/whop_sdk/resources/ad_reports.rbs +3 -3
  741. data/sig/whop_sdk/resources/ads.rbs +63 -17
  742. data/sig/whop_sdk/resources/apps.rbs +16 -0
  743. data/sig/whop_sdk/resources/audiences.rbs +28 -0
  744. data/sig/whop_sdk/resources/authorized_users.rbs +1 -0
  745. data/sig/whop_sdk/resources/bounties.rbs +4 -0
  746. data/sig/whop_sdk/resources/cards.rbs +47 -0
  747. data/sig/whop_sdk/resources/checkout_configurations.rbs +21 -11
  748. data/sig/whop_sdk/resources/deposits.rbs +6 -1
  749. data/sig/whop_sdk/resources/events.rbs +40 -0
  750. data/sig/whop_sdk/resources/financial_activity.rbs +22 -0
  751. data/sig/whop_sdk/resources/media.rbs +22 -0
  752. data/sig/whop_sdk/resources/payouts/methods.rbs +23 -0
  753. data/sig/whop_sdk/resources/payouts.rbs +29 -0
  754. data/sig/whop_sdk/resources/people.rbs +28 -0
  755. data/sig/whop_sdk/resources/plans.rbs +37 -29
  756. data/sig/whop_sdk/resources/products.rbs +17 -33
  757. data/sig/whop_sdk/resources/referrals/businesses/earnings.rbs +25 -0
  758. data/sig/whop_sdk/resources/referrals/businesses.rbs +38 -0
  759. data/sig/whop_sdk/resources/referrals/partners.rbs +13 -0
  760. data/sig/whop_sdk/resources/referrals.rbs +21 -0
  761. data/sig/whop_sdk/resources/social_accounts.rbs +52 -0
  762. data/sig/whop_sdk/resources/stats.rbs +39 -0
  763. data/sig/whop_sdk/resources/swaps.rbs +21 -0
  764. data/sig/whop_sdk/resources/transfers.rbs +17 -14
  765. data/sig/whop_sdk/resources/users.rbs +26 -12
  766. data/sig/whop_sdk/resources/verifications.rbs +17 -7
  767. data/sig/whop_sdk/resources/webhooks.rbs +5 -1
  768. data/sig/whop_sdk/resources/workforce/bounties.rbs +30 -0
  769. data/sig/whop_sdk/resources/workforce.rbs +9 -0
  770. metadata +362 -86
  771. data/lib/whop_sdk/models/account_list_response.rb +0 -66
  772. data/lib/whop_sdk/models/account_wallet.rb +0 -46
  773. data/lib/whop_sdk/models/ad_budget_type.rb +0 -16
  774. data/lib/whop_sdk/models/ad_campaign_list_response.rb +0 -83
  775. data/lib/whop_sdk/models/ad_campaign_platform.rb +0 -16
  776. data/lib/whop_sdk/models/ad_campaign_status.rb +0 -20
  777. data/lib/whop_sdk/models/ad_group_list_response.rb +0 -97
  778. data/lib/whop_sdk/models/ad_group_status.rb +0 -20
  779. data/lib/whop_sdk/models/ad_list_response.rb +0 -103
  780. data/lib/whop_sdk/models/conversion_create_response.rb +0 -19
  781. data/lib/whop_sdk/models/external_ad_status.rb +0 -20
  782. data/lib/whop_sdk/models/payout_destination_category.rb +0 -20
  783. data/lib/whop_sdk/models/payout_method_list_params.rb +0 -54
  784. data/lib/whop_sdk/models/payout_method_list_response.rb +0 -140
  785. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +0 -140
  786. data/lib/whop_sdk/models/transfer.rb +0 -299
  787. data/lib/whop_sdk/models/user_list_response.rb +0 -83
  788. data/lib/whop_sdk/models/wallet_balance_response.rb +0 -84
  789. data/lib/whop_sdk/models/wallet_list_response.rb +0 -38
  790. data/lib/whop_sdk/models/wallet_send_params.rb +0 -37
  791. data/lib/whop_sdk/models/wallet_send_response.rb +0 -90
  792. data/lib/whop_sdk/resources/conversions.rb +0 -67
  793. data/lib/whop_sdk/resources/payout_methods.rb +0 -76
  794. data/lib/whop_sdk/resources/wallets.rb +0 -78
  795. data/rbi/whop_sdk/models/account_list_response.rbi +0 -115
  796. data/rbi/whop_sdk/models/account_wallet.rbi +0 -75
  797. data/rbi/whop_sdk/models/ad_budget_type.rbi +0 -20
  798. data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +0 -105
  799. data/rbi/whop_sdk/models/ad_campaign_platform.rbi +0 -22
  800. data/rbi/whop_sdk/models/ad_campaign_status.rbi +0 -27
  801. data/rbi/whop_sdk/models/ad_group_list_response.rbi +0 -138
  802. data/rbi/whop_sdk/models/ad_group_status.rbi +0 -24
  803. data/rbi/whop_sdk/models/ad_list_response.rbi +0 -158
  804. data/rbi/whop_sdk/models/conversion_create_params.rbi +0 -661
  805. data/rbi/whop_sdk/models/external_ad_status.rbi +0 -26
  806. data/rbi/whop_sdk/models/payout_destination_category.rbi +0 -33
  807. data/rbi/whop_sdk/models/payout_method_list_params.rbi +0 -75
  808. data/rbi/whop_sdk/models/payout_method_list_response.rbi +0 -234
  809. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +0 -238
  810. data/rbi/whop_sdk/models/transfer.rbi +0 -407
  811. data/rbi/whop_sdk/models/user_list_response.rbi +0 -124
  812. data/rbi/whop_sdk/models/wallet_balance_response.rbi +0 -145
  813. data/rbi/whop_sdk/models/wallet_list_response.rbi +0 -66
  814. data/rbi/whop_sdk/models/wallet_send_params.rbi +0 -57
  815. data/rbi/whop_sdk/models/wallet_send_response.rbi +0 -146
  816. data/rbi/whop_sdk/resources/conversions.rbi +0 -71
  817. data/rbi/whop_sdk/resources/payout_methods.rbi +0 -66
  818. data/rbi/whop_sdk/resources/wallets.rbi +0 -55
  819. data/sig/whop_sdk/models/account_list_response.rbs +0 -62
  820. data/sig/whop_sdk/models/account_wallet.rbs +0 -42
  821. data/sig/whop_sdk/models/ad_budget_type.rbs +0 -14
  822. data/sig/whop_sdk/models/ad_campaign_list_response.rbs +0 -60
  823. data/sig/whop_sdk/models/ad_campaign_platform.rbs +0 -14
  824. data/sig/whop_sdk/models/ad_campaign_status.rbs +0 -19
  825. data/sig/whop_sdk/models/ad_group_list_response.rbs +0 -70
  826. data/sig/whop_sdk/models/ad_group_status.rbs +0 -19
  827. data/sig/whop_sdk/models/ad_list_response.rbs +0 -75
  828. data/sig/whop_sdk/models/conversion_create_params.rbs +0 -349
  829. data/sig/whop_sdk/models/external_ad_status.rbs +0 -19
  830. data/sig/whop_sdk/models/payout_destination_category.rbs +0 -19
  831. data/sig/whop_sdk/models/payout_method_list_params.rbs +0 -46
  832. data/sig/whop_sdk/models/payout_method_list_response.rbs +0 -97
  833. data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +0 -97
  834. data/sig/whop_sdk/models/user_list_response.rbs +0 -55
  835. data/sig/whop_sdk/models/wallet_balance_response.rbs +0 -87
  836. data/sig/whop_sdk/models/wallet_list_response.rbs +0 -40
  837. data/sig/whop_sdk/models/wallet_send_response.rbs +0 -79
  838. data/sig/whop_sdk/resources/conversions.rbs +0 -25
  839. data/sig/whop_sdk/resources/payout_methods.rbs +0 -21
  840. data/sig/whop_sdk/resources/wallets.rbs +0 -23
@@ -2,277 +2,633 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Models
5
- # @see WhopSDK::Resources::AdCampaigns#retrieve
5
+ # @see WhopSDK::Resources::AdCampaigns#create
6
6
  class AdCampaign < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The unique identifier for this ad campaign.
8
+ # Unique identifier for the ad campaign.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
- # @!attribute budget
14
- # Total budget in dollars.
13
+ # @!attribute added_to_carts
14
+ # Whop pixel-attributed add-to-cart events, last-click.
15
+ #
16
+ # @return [Float]
17
+ required :added_to_carts, Float
18
+
19
+ # @!attribute bid_type
20
+ # The bidding strategy the campaign uses.
21
+ #
22
+ # @return [Symbol, WhopSDK::Models::AdCampaign::BidType, nil]
23
+ required :bid_type, enum: -> { WhopSDK::AdCampaign::BidType }, nil?: true
24
+
25
+ # @!attribute budget_amount
26
+ # The campaign budget in USD. Null when budget is set at the ad group level (ABO).
15
27
  #
16
28
  # @return [Float, nil]
17
- required :budget, Float, nil?: true
29
+ required :budget_amount, Float, nil?: true
30
+
31
+ # @!attribute budget_optimization
32
+ # Which level owns the budget — the campaign (CBO) or each ad group (ABO).
33
+ #
34
+ # @return [Symbol, WhopSDK::Models::AdCampaign::BudgetOptimization, nil]
35
+ required :budget_optimization, enum: -> { WhopSDK::AdCampaign::BudgetOptimization }, nil?: true
18
36
 
19
37
  # @!attribute budget_type
20
- # The budget type for an ad campaign or ad group.
38
+ # Whether the budget is spent per day or over the campaign's lifetime.
39
+ #
40
+ # @return [Symbol, WhopSDK::Models::AdCampaign::BudgetType, nil]
41
+ required :budget_type, enum: -> { WhopSDK::AdCampaign::BudgetType }, nil?: true
42
+
43
+ # @!attribute click_through_rate
44
+ # Clicks divided by impressions, between 0 and 1.
45
+ #
46
+ # @return [Float]
47
+ required :click_through_rate, Float
48
+
49
+ # @!attribute clicks
50
+ # The number of clicks.
51
+ #
52
+ # @return [Float]
53
+ required :clicks, Float
54
+
55
+ # @!attribute completed_registrations
56
+ # Whop pixel-attributed complete-registration events, last-click.
57
+ #
58
+ # @return [Float]
59
+ required :completed_registrations, Float
60
+
61
+ # @!attribute contacts
62
+ # Whop pixel-attributed contact events, last-click.
63
+ #
64
+ # @return [Float]
65
+ required :contacts, Float
66
+
67
+ # @!attribute cost_per_added_to_cart
68
+ # Spend divided by attributed add-to-cart events; null when they are not the goal
69
+ # and none are attributed.
70
+ #
71
+ # @return [Float, nil]
72
+ required :cost_per_added_to_cart, Float, nil?: true
73
+
74
+ # @!attribute cost_per_click
75
+ # Spend divided by clicks; 0 when there are no clicks.
76
+ #
77
+ # @return [Float]
78
+ required :cost_per_click, Float
79
+
80
+ # @!attribute cost_per_completed_registration
81
+ # Spend divided by attributed complete-registration events; null when they are not
82
+ # the goal and none are attributed.
83
+ #
84
+ # @return [Float, nil]
85
+ required :cost_per_completed_registration, Float, nil?: true
86
+
87
+ # @!attribute cost_per_contact
88
+ # Spend divided by attributed contact events; null when contacts are not the goal
89
+ # and none are attributed.
90
+ #
91
+ # @return [Float, nil]
92
+ required :cost_per_contact, Float, nil?: true
93
+
94
+ # @!attribute cost_per_lead
95
+ # Spend divided by attributed leads; null when leads are not a goal and none are
96
+ # attributed.
97
+ #
98
+ # @return [Float, nil]
99
+ required :cost_per_lead, Float, nil?: true
100
+
101
+ # @!attribute cost_per_mille
102
+ # Spend per 1,000 impressions; 0 when there are no impressions.
103
+ #
104
+ # @return [Float]
105
+ required :cost_per_mille, Float
106
+
107
+ # @!attribute cost_per_purchase
108
+ # Spend divided by attributed purchases; null when purchases are not a goal and
109
+ # none are attributed.
21
110
  #
22
- # @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
23
- required :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
111
+ # @return [Float, nil]
112
+ required :cost_per_purchase, Float, nil?: true
113
+
114
+ # @!attribute cost_per_result
115
+ # Spend divided by Whop pixel-attributed results; null when nothing
116
+ # Whop-attributable is being optimized for.
117
+ #
118
+ # @return [Float, nil]
119
+ required :cost_per_result, Float, nil?: true
120
+
121
+ # @!attribute cost_per_schedule
122
+ # Spend divided by attributed schedule events; null when schedules are not the
123
+ # goal and none are attributed.
124
+ #
125
+ # @return [Float, nil]
126
+ required :cost_per_schedule, Float, nil?: true
127
+
128
+ # @!attribute cost_per_submitted_application
129
+ # Spend divided by attributed submit-application events; null when they are not
130
+ # the goal and none are attributed.
131
+ #
132
+ # @return [Float, nil]
133
+ required :cost_per_submitted_application, Float, nil?: true
134
+
135
+ # @!attribute cost_per_viewed_content
136
+ # Spend divided by attributed view-content events; null when they are not the goal
137
+ # and none are attributed.
138
+ #
139
+ # @return [Float, nil]
140
+ required :cost_per_viewed_content, Float, nil?: true
24
141
 
25
142
  # @!attribute created_at
26
- # When the ad campaign was created.
143
+ # When the campaign was created, as an ISO 8601 timestamp.
27
144
  #
28
- # @return [Time]
29
- required :created_at, Time
145
+ # @return [String]
146
+ required :created_at, String
147
+
148
+ # @!attribute custom_conversions
149
+ # Whop pixel-attributed custom (merchant-defined) conversion events, last-click,
150
+ # across all custom event names.
151
+ #
152
+ # @return [Float]
153
+ required :custom_conversions, Float
154
+
155
+ # @!attribute custom_event_counts
156
+ # Whop pixel-attributed custom conversions broken out by merchant-defined event
157
+ # name, last-click, as a { event_name => count } map over the stats window. Empty
158
+ # when no named custom events are attributed. Custom events fired without a name
159
+ # are counted in custom_conversions but omitted here, so these values sum to at
160
+ # most custom_conversions.
161
+ #
162
+ # @return [Object]
163
+ required :custom_event_counts, WhopSDK::Internal::Type::Unknown
164
+
165
+ # @!attribute delivery_status
166
+ # The current delivery state, mirroring the Delivery column in the ads dashboard.
167
+ # When several states apply at once, the highest-precedence one is returned.
168
+ #
169
+ # @return [Symbol, WhopSDK::Models::AdCampaign::DeliveryStatus]
170
+ required :delivery_status, enum: -> { WhopSDK::AdCampaign::DeliveryStatus }
171
+
172
+ # @!attribute frequency
173
+ # Platform-reported impressions divided by reach.
174
+ #
175
+ # @return [Float, nil]
176
+ required :frequency, Float, nil?: true
177
+
178
+ # @!attribute impressions
179
+ # The number of impressions.
180
+ #
181
+ # @return [Float]
182
+ required :impressions, Float
30
183
 
31
- # @!attribute created_by_user
32
- # The user who created this ad campaign.
184
+ # @!attribute issues
33
185
  #
34
- # @return [WhopSDK::Models::AdCampaign::CreatedByUser]
35
- required :created_by_user, -> { WhopSDK::AdCampaign::CreatedByUser }
186
+ # @return [Array<WhopSDK::Models::AdCampaign::Issue>]
187
+ required :issues, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AdCampaign::Issue] }
36
188
 
37
- # @!attribute meta_config
38
- # Meta-specific campaign configuration (objective, budget mode, etc.). Null for
39
- # non-Meta campaigns.
189
+ # @!attribute leads
190
+ # Whop pixel-attributed leads, last-click.
40
191
  #
41
- # @return [WhopSDK::Models::AdCampaign::MetaConfig, nil]
42
- required :meta_config, -> { WhopSDK::AdCampaign::MetaConfig }, nil?: true
192
+ # @return [Float]
193
+ required :leads, Float
194
+
195
+ # @!attribute objective
196
+ # The goal the campaign optimizes toward.
197
+ #
198
+ # @return [Symbol, WhopSDK::Models::AdCampaign::Objective, nil]
199
+ required :objective, enum: -> { WhopSDK::AdCampaign::Objective }, nil?: true
200
+
201
+ # @!attribute optimization_goal
202
+ # The specific event the campaign optimizes for. If the campaign is CBO, then all
203
+ # ad groups will have the same optimization goal, which will be returned here.
204
+ #
205
+ # @return [String, nil]
206
+ required :optimization_goal, String, nil?: true
43
207
 
44
208
  # @!attribute platform
45
- # The external ad platform this campaign is running on (e.g., meta, tiktok).
209
+ # The ad network the campaign runs on.
210
+ #
211
+ # @return [Symbol, WhopSDK::Models::AdCampaign::Platform]
212
+ required :platform, enum: -> { WhopSDK::AdCampaign::Platform }
213
+
214
+ # @!attribute purchase_value
215
+ # USD value of pixel-attributed purchases.
216
+ #
217
+ # @return [Float]
218
+ required :purchase_value, Float
219
+
220
+ # @!attribute purchases
221
+ # Whop pixel-attributed purchases, last-click.
222
+ #
223
+ # @return [Float]
224
+ required :purchases, Float
225
+
226
+ # @!attribute reach
227
+ # The number of unique people who saw this.
46
228
  #
47
- # @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
48
- required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
229
+ # @return [Float]
230
+ required :reach, Float
231
+
232
+ # @!attribute result_event
233
+ # The Whop pixel conversion event whose attributed count represents results — the
234
+ # optimization goal, or the highest-volume attributed event for campaigns that
235
+ # budget per ad group. Null when the goal isn't a Whop-attributed event.
236
+ #
237
+ # @return [Symbol, WhopSDK::Models::AdCampaign::ResultEvent, nil]
238
+ required :result_event, enum: -> { WhopSDK::AdCampaign::ResultEvent }, nil?: true
239
+
240
+ # @!attribute result_event_name
241
+ # The merchant-defined event name when result_event is custom; null for the
242
+ # standard events.
243
+ #
244
+ # @return [String, nil]
245
+ required :result_event_name, String, nil?: true
246
+
247
+ # @!attribute results
248
+ # The Whop pixel-attributed count behind result_event. When a campaign's ad groups
249
+ # optimize different goals there is no single result_event (it is null), and this
250
+ # is instead the sum of each ad group's own attributed results. Null when nothing
251
+ # Whop-attributable is being optimized for.
252
+ #
253
+ # @return [Float, nil]
254
+ required :results, Float, nil?: true
255
+
256
+ # @!attribute return_on_ad_spend
257
+ # Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when
258
+ # there is no spend.
259
+ #
260
+ # @return [Float]
261
+ required :return_on_ad_spend, Float
262
+
263
+ # @!attribute schedules
264
+ # Whop pixel-attributed schedule events, last-click.
265
+ #
266
+ # @return [Float]
267
+ required :schedules, Float
268
+
269
+ # @!attribute special_ad_categories
270
+ #
271
+ # @return [Array<Symbol, WhopSDK::Models::AdCampaign::SpecialAdCategory>]
272
+ required :special_ad_categories,
273
+ -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdCampaign::SpecialAdCategory] }
274
+
275
+ # @!attribute spend
276
+ # The amount charged, in spend_currency.
277
+ #
278
+ # @return [Float]
279
+ required :spend, Float
280
+
281
+ # @!attribute spend_currency
282
+ # The ISO 4217 currency code of all monetary metrics.
283
+ #
284
+ # @return [String, nil]
285
+ required :spend_currency, String, nil?: true
49
286
 
50
287
  # @!attribute status
51
- # Current status of the campaign (active, paused, or inactive).
288
+ # The lifecycle status of the ad campaign.
52
289
  #
53
- # @return [Symbol, WhopSDK::Models::AdCampaignStatus]
54
- required :status, enum: -> { WhopSDK::AdCampaignStatus }
290
+ # @return [Symbol, WhopSDK::Models::AdCampaign::Status]
291
+ required :status, enum: -> { WhopSDK::AdCampaign::Status }
292
+
293
+ # @!attribute submitted_applications
294
+ # Whop pixel-attributed submit-application events, last-click.
295
+ #
296
+ # @return [Float]
297
+ required :submitted_applications, Float
55
298
 
56
299
  # @!attribute title
57
- # The campaign name shown in the Whop dashboard.
300
+ # The title of the ad campaign.
58
301
  #
59
302
  # @return [String]
60
303
  required :title, String
61
304
 
62
- # @!attribute total_spend
63
- # Total amount spent in dollars.
305
+ # @!attribute unique_click_through_rate
306
+ # Unique clicks divided by impressions, between 0 and 1.
307
+ #
308
+ # @return [Float, nil]
309
+ required :unique_click_through_rate, Float, nil?: true
310
+
311
+ # @!attribute unique_clicks
312
+ # The number of unique clicks.
64
313
  #
65
314
  # @return [Float]
66
- required :total_spend, Float
315
+ required :unique_clicks, Float
67
316
 
68
317
  # @!attribute updated_at
69
- # When the ad campaign was last updated.
318
+ # When the campaign was last updated, as an ISO 8601 timestamp.
70
319
  #
71
- # @return [Time]
72
- required :updated_at, Time
320
+ # @return [String]
321
+ required :updated_at, String
322
+
323
+ # @!attribute viewed_contents
324
+ # Whop pixel-attributed view-content events, last-click.
325
+ #
326
+ # @return [Float]
327
+ required :viewed_contents, Float
73
328
 
74
- # @!method initialize(id:, budget:, budget_type:, created_at:, created_by_user:, meta_config:, platform:, status:, title:, total_spend:, updated_at:)
329
+ # @!method initialize(id:, added_to_carts:, bid_type:, budget_amount:, budget_optimization:, budget_type:, click_through_rate:, clicks:, completed_registrations:, contacts:, cost_per_added_to_cart:, cost_per_click:, cost_per_completed_registration:, cost_per_contact:, cost_per_lead:, cost_per_mille:, cost_per_purchase:, cost_per_result:, cost_per_schedule:, cost_per_submitted_application:, cost_per_viewed_content:, created_at:, custom_conversions:, custom_event_counts:, delivery_status:, frequency:, impressions:, issues:, leads:, objective:, optimization_goal:, platform:, purchase_value:, purchases:, reach:, result_event:, result_event_name:, results:, return_on_ad_spend:, schedules:, special_ad_categories:, spend:, spend_currency:, status:, submitted_applications:, title:, unique_click_through_rate:, unique_clicks:, updated_at:, viewed_contents:)
75
330
  # Some parameter documentations has been truncated, see
76
331
  # {WhopSDK::Models::AdCampaign} for more details.
77
332
  #
78
- # An advertising campaign running on an external platform or within Whop.
333
+ # @param id [String] Unique identifier for the ad campaign.
79
334
  #
80
- # @param id [String] The unique identifier for this ad campaign.
335
+ # @param added_to_carts [Float] Whop pixel-attributed add-to-cart events, last-click.
81
336
  #
82
- # @param budget [Float, nil] Total budget in dollars.
337
+ # @param bid_type [Symbol, WhopSDK::Models::AdCampaign::BidType, nil] The bidding strategy the campaign uses.
83
338
  #
84
- # @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
339
+ # @param budget_amount [Float, nil] The campaign budget in USD. Null when budget is set at the ad group level (ABO).
85
340
  #
86
- # @param created_at [Time] When the ad campaign was created.
341
+ # @param budget_optimization [Symbol, WhopSDK::Models::AdCampaign::BudgetOptimization, nil] Which level owns the budget — the campaign (CBO) or each ad group (ABO).
87
342
  #
88
- # @param created_by_user [WhopSDK::Models::AdCampaign::CreatedByUser] The user who created this ad campaign.
343
+ # @param budget_type [Symbol, WhopSDK::Models::AdCampaign::BudgetType, nil] Whether the budget is spent per day or over the campaign's lifetime.
89
344
  #
90
- # @param meta_config [WhopSDK::Models::AdCampaign::MetaConfig, nil] Meta-specific campaign configuration (objective, budget mode, etc.). Null for no
345
+ # @param click_through_rate [Float] Clicks divided by impressions, between 0 and 1.
91
346
  #
92
- # @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this campaign is running on (e.g., meta, tiktok).
347
+ # @param clicks [Float] The number of clicks.
93
348
  #
94
- # @param status [Symbol, WhopSDK::Models::AdCampaignStatus] Current status of the campaign (active, paused, or inactive).
349
+ # @param completed_registrations [Float] Whop pixel-attributed complete-registration events, last-click.
95
350
  #
96
- # @param title [String] The campaign name shown in the Whop dashboard.
351
+ # @param contacts [Float] Whop pixel-attributed contact events, last-click.
97
352
  #
98
- # @param total_spend [Float] Total amount spent in dollars.
353
+ # @param cost_per_added_to_cart [Float, nil] Spend divided by attributed add-to-cart events; null when they are not the goal
99
354
  #
100
- # @param updated_at [Time] When the ad campaign was last updated.
101
-
102
- # @see WhopSDK::Models::AdCampaign#created_by_user
103
- class CreatedByUser < WhopSDK::Internal::Type::BaseModel
104
- # @!attribute id
105
- # The unique identifier for the user.
106
- #
107
- # @return [String]
108
- required :id, String
355
+ # @param cost_per_click [Float] Spend divided by clicks; 0 when there are no clicks.
356
+ #
357
+ # @param cost_per_completed_registration [Float, nil] Spend divided by attributed complete-registration events; null when they are not
358
+ #
359
+ # @param cost_per_contact [Float, nil] Spend divided by attributed contact events; null when contacts are not the goal
360
+ #
361
+ # @param cost_per_lead [Float, nil] Spend divided by attributed leads; null when leads are not a goal and none are a
362
+ #
363
+ # @param cost_per_mille [Float] Spend per 1,000 impressions; 0 when there are no impressions.
364
+ #
365
+ # @param cost_per_purchase [Float, nil] Spend divided by attributed purchases; null when purchases are not a goal and no
366
+ #
367
+ # @param cost_per_result [Float, nil] Spend divided by Whop pixel-attributed results; null when nothing Whop-attributa
368
+ #
369
+ # @param cost_per_schedule [Float, nil] Spend divided by attributed schedule events; null when schedules are not the goa
370
+ #
371
+ # @param cost_per_submitted_application [Float, nil] Spend divided by attributed submit-application events; null when they are not th
372
+ #
373
+ # @param cost_per_viewed_content [Float, nil] Spend divided by attributed view-content events; null when they are not the goal
374
+ #
375
+ # @param created_at [String] When the campaign was created, as an ISO 8601 timestamp.
376
+ #
377
+ # @param custom_conversions [Float] Whop pixel-attributed custom (merchant-defined) conversion events, last-click, a
378
+ #
379
+ # @param custom_event_counts [Object] Whop pixel-attributed custom conversions broken out by merchant-defined event na
380
+ #
381
+ # @param delivery_status [Symbol, WhopSDK::Models::AdCampaign::DeliveryStatus] The current delivery state, mirroring the Delivery column in the ads dashboard.
382
+ #
383
+ # @param frequency [Float, nil] Platform-reported impressions divided by reach.
384
+ #
385
+ # @param impressions [Float] The number of impressions.
386
+ #
387
+ # @param issues [Array<WhopSDK::Models::AdCampaign::Issue>]
388
+ #
389
+ # @param leads [Float] Whop pixel-attributed leads, last-click.
390
+ #
391
+ # @param objective [Symbol, WhopSDK::Models::AdCampaign::Objective, nil] The goal the campaign optimizes toward.
392
+ #
393
+ # @param optimization_goal [String, nil] The specific event the campaign optimizes for. If the campaign is CBO, then all
394
+ #
395
+ # @param platform [Symbol, WhopSDK::Models::AdCampaign::Platform] The ad network the campaign runs on.
396
+ #
397
+ # @param purchase_value [Float] USD value of pixel-attributed purchases.
398
+ #
399
+ # @param purchases [Float] Whop pixel-attributed purchases, last-click.
400
+ #
401
+ # @param reach [Float] The number of unique people who saw this.
402
+ #
403
+ # @param result_event [Symbol, WhopSDK::Models::AdCampaign::ResultEvent, nil] The Whop pixel conversion event whose attributed count represents results — the
404
+ #
405
+ # @param result_event_name [String, nil] The merchant-defined event name when result_event is custom; null for the standa
406
+ #
407
+ # @param results [Float, nil] The Whop pixel-attributed count behind result_event. When a campaign's ad groups
408
+ #
409
+ # @param return_on_ad_spend [Float] Purchase value divided by spend, both in USD (a currency-neutral ratio); 0 when
410
+ #
411
+ # @param schedules [Float] Whop pixel-attributed schedule events, last-click.
412
+ #
413
+ # @param special_ad_categories [Array<Symbol, WhopSDK::Models::AdCampaign::SpecialAdCategory>]
414
+ #
415
+ # @param spend [Float] The amount charged, in spend_currency.
416
+ #
417
+ # @param spend_currency [String, nil] The ISO 4217 currency code of all monetary metrics.
418
+ #
419
+ # @param status [Symbol, WhopSDK::Models::AdCampaign::Status] The lifecycle status of the ad campaign.
420
+ #
421
+ # @param submitted_applications [Float] Whop pixel-attributed submit-application events, last-click.
422
+ #
423
+ # @param title [String] The title of the ad campaign.
424
+ #
425
+ # @param unique_click_through_rate [Float, nil] Unique clicks divided by impressions, between 0 and 1.
426
+ #
427
+ # @param unique_clicks [Float] The number of unique clicks.
428
+ #
429
+ # @param updated_at [String] When the campaign was last updated, as an ISO 8601 timestamp.
430
+ #
431
+ # @param viewed_contents [Float] Whop pixel-attributed view-content events, last-click.
109
432
 
110
- # @!attribute name
111
- # The user's display name shown on their public profile.
112
- #
113
- # @return [String, nil]
114
- required :name, String, nil?: true
433
+ # The bidding strategy the campaign uses.
434
+ #
435
+ # @see WhopSDK::Models::AdCampaign#bid_type
436
+ module BidType
437
+ extend WhopSDK::Internal::Type::Enum
115
438
 
116
- # @!attribute username
117
- # The user's unique username shown on their public profile.
118
- #
119
- # @return [String]
120
- required :username, String
439
+ MINIMUM_COST = :minimum_cost
440
+ AVERAGE_TARGET = :average_target
441
+ MAXIMUM_TARGET = :maximum_target
121
442
 
122
- # @!method initialize(id:, name:, username:)
123
- # The user who created this ad campaign.
124
- #
125
- # @param id [String] The unique identifier for the user.
126
- #
127
- # @param name [String, nil] The user's display name shown on their public profile.
128
- #
129
- # @param username [String] The user's unique username shown on their public profile.
443
+ # @!method self.values
444
+ # @return [Array<Symbol>]
130
445
  end
131
446
 
132
- # @see WhopSDK::Models::AdCampaign#meta_config
133
- class MetaConfig < WhopSDK::Internal::Type::BaseModel
134
- # @!attribute bid_amount
135
- # Bid cap amount in cents. Only used when bid_strategy is bid_cap.
136
- #
137
- # @return [Integer, nil]
138
- required :bid_amount, Integer, nil?: true
447
+ # Which level owns the budget — the campaign (CBO) or each ad group (ABO).
448
+ #
449
+ # @see WhopSDK::Models::AdCampaign#budget_optimization
450
+ module BudgetOptimization
451
+ extend WhopSDK::Internal::Type::Enum
139
452
 
140
- # @!attribute bid_strategy
141
- # The bidding strategy used to optimize spend for this campaign.
142
- #
143
- # @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::BidStrategy, nil]
144
- required :bid_strategy, enum: -> { WhopSDK::AdCampaign::MetaConfig::BidStrategy }, nil?: true
453
+ AD_CAMPAIGN = :ad_campaign
454
+ AD_GROUP = :ad_group
145
455
 
146
- # @!attribute budget_optimization
147
- # Whether campaign budget optimization (CBO) is enabled, allowing the platform to
148
- # distribute budget across ad groups.
149
- #
150
- # @return [Boolean, nil]
151
- required :budget_optimization, WhopSDK::Internal::Type::Boolean, nil?: true
456
+ # @!method self.values
457
+ # @return [Array<Symbol>]
458
+ end
152
459
 
153
- # @!attribute effective_status
154
- # The actual delivery status, accounting for platform overrides (e.g., in_review,
155
- # rejected).
156
- #
157
- # @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::EffectiveStatus, nil]
158
- required :effective_status, enum: -> { WhopSDK::AdCampaign::MetaConfig::EffectiveStatus }, nil?: true
460
+ # Whether the budget is spent per day or over the campaign's lifetime.
461
+ #
462
+ # @see WhopSDK::Models::AdCampaign#budget_type
463
+ module BudgetType
464
+ extend WhopSDK::Internal::Type::Enum
159
465
 
160
- # @!attribute end_time
161
- # The scheduled end time of the campaign (ISO8601).
162
- #
163
- # @return [String, nil]
164
- required :end_time, String, nil?: true
466
+ DAILY = :daily
467
+ LIFETIME = :lifetime
468
+
469
+ # @!method self.values
470
+ # @return [Array<Symbol>]
471
+ end
472
+
473
+ # The current delivery state, mirroring the Delivery column in the ads dashboard.
474
+ # When several states apply at once, the highest-precedence one is returned.
475
+ #
476
+ # @see WhopSDK::Models::AdCampaign#delivery_status
477
+ module DeliveryStatus
478
+ extend WhopSDK::Internal::Type::Enum
479
+
480
+ PAYMENT_FAILED = :payment_failed
481
+ ALL_ADS_REJECTED = :all_ads_rejected
482
+ DRAFT = :draft
483
+ NO_AD_GROUPS = :no_ad_groups
484
+ NO_ADS = :no_ads
485
+ PAUSED = :paused
486
+ PROCESSING = :processing
487
+ ISSUES = :issues
488
+ SCHEDULED = :scheduled
489
+ COMPLETED = :completed
490
+ AD_GROUPS_OFF = :ad_groups_off
491
+ ACTIVE = :active
492
+
493
+ # @!method self.values
494
+ # @return [Array<Symbol>]
495
+ end
165
496
 
166
- # @!attribute objective
167
- # The campaign objective that determines how Meta optimizes delivery.
497
+ class Issue < WhopSDK::Internal::Type::BaseModel
498
+ # @!attribute id
499
+ # Unique identifier for the issue.
168
500
  #
169
- # @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Objective, nil]
170
- required :objective, enum: -> { WhopSDK::AdCampaign::MetaConfig::Objective }, nil?: true
501
+ # @return [String]
502
+ required :id, String
171
503
 
172
- # @!attribute special_categories
173
- # Special ad categories required by the platform (e.g., housing, employment,
174
- # credit).
504
+ # @!attribute message
505
+ # A description of what the issue is and how it can be resolved.
175
506
  #
176
- # @return [Array<String>, nil]
177
- required :special_categories, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
507
+ # @return [String]
508
+ required :message, String
178
509
 
179
- # @!attribute start_time
180
- # The scheduled start time of the campaign (ISO8601).
510
+ # @!attribute resource_id
511
+ # The ID of the campaign, ad group, or ad the issue is attached to.
181
512
  #
182
513
  # @return [String, nil]
183
- required :start_time, String, nil?: true
514
+ required :resource_id, String, nil?: true
184
515
 
185
- # @!attribute status
186
- # The campaign status as set by the advertiser (active or paused).
516
+ # @!attribute resource_type
517
+ # The type of resource the issue is attached to.
187
518
  #
188
- # @return [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Status, nil]
189
- required :status, enum: -> { WhopSDK::AdCampaign::MetaConfig::Status }, nil?: true
519
+ # @return [Symbol, WhopSDK::Models::AdCampaign::Issue::ResourceType]
520
+ required :resource_type, enum: -> { WhopSDK::AdCampaign::Issue::ResourceType }
190
521
 
191
- # @!method initialize(bid_amount:, bid_strategy:, budget_optimization:, effective_status:, end_time:, objective:, special_categories:, start_time:, status:)
192
- # Some parameter documentations has been truncated, see
193
- # {WhopSDK::Models::AdCampaign::MetaConfig} for more details.
194
- #
195
- # Meta-specific campaign configuration (objective, budget mode, etc.). Null for
196
- # non-Meta campaigns.
197
- #
198
- # @param bid_amount [Integer, nil] Bid cap amount in cents. Only used when bid_strategy is bid_cap.
199
- #
200
- # @param bid_strategy [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::BidStrategy, nil] The bidding strategy used to optimize spend for this campaign.
201
- #
202
- # @param budget_optimization [Boolean, nil] Whether campaign budget optimization (CBO) is enabled, allowing the platform to
203
- #
204
- # @param effective_status [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::EffectiveStatus, nil] The actual delivery status, accounting for platform overrides (e.g., in_review,
522
+ # @!method initialize(id:, message:, resource_id:, resource_type:)
523
+ # Open issues affecting the campaign and its descendant ad groups and ads.
205
524
  #
206
- # @param end_time [String, nil] The scheduled end time of the campaign (ISO8601).
525
+ # @param id [String] Unique identifier for the issue.
207
526
  #
208
- # @param objective [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Objective, nil] The campaign objective that determines how Meta optimizes delivery.
527
+ # @param message [String] A description of what the issue is and how it can be resolved.
209
528
  #
210
- # @param special_categories [Array<String>, nil] Special ad categories required by the platform (e.g., housing, employment, credi
529
+ # @param resource_id [String, nil] The ID of the campaign, ad group, or ad the issue is attached to.
211
530
  #
212
- # @param start_time [String, nil] The scheduled start time of the campaign (ISO8601).
213
- #
214
- # @param status [Symbol, WhopSDK::Models::AdCampaign::MetaConfig::Status, nil] The campaign status as set by the advertiser (active or paused).
531
+ # @param resource_type [Symbol, WhopSDK::Models::AdCampaign::Issue::ResourceType] The type of resource the issue is attached to.
215
532
 
216
- # The bidding strategy used to optimize spend for this campaign.
533
+ # The type of resource the issue is attached to.
217
534
  #
218
- # @see WhopSDK::Models::AdCampaign::MetaConfig#bid_strategy
219
- module BidStrategy
535
+ # @see WhopSDK::Models::AdCampaign::Issue#resource_type
536
+ module ResourceType
220
537
  extend WhopSDK::Internal::Type::Enum
221
538
 
222
- LOWEST_COST = :lowest_cost
223
- BID_CAP = :bid_cap
224
- COST_CAP = :cost_cap
539
+ AD_CAMPAIGN = :ad_campaign
540
+ AD_GROUP = :ad_group
541
+ AD = :ad
225
542
 
226
543
  # @!method self.values
227
544
  # @return [Array<Symbol>]
228
545
  end
546
+ end
229
547
 
230
- # The actual delivery status, accounting for platform overrides (e.g., in_review,
231
- # rejected).
232
- #
233
- # @see WhopSDK::Models::AdCampaign::MetaConfig#effective_status
234
- module EffectiveStatus
235
- extend WhopSDK::Internal::Type::Enum
548
+ # The goal the campaign optimizes toward.
549
+ #
550
+ # @see WhopSDK::Models::AdCampaign#objective
551
+ module Objective
552
+ extend WhopSDK::Internal::Type::Enum
553
+
554
+ AWARENESS = :awareness
555
+ TRAFFIC = :traffic
556
+ ENGAGEMENT = :engagement
557
+ LEADS = :leads
558
+ SALES = :sales
559
+
560
+ # @!method self.values
561
+ # @return [Array<Symbol>]
562
+ end
236
563
 
237
- ACTIVE = :active
238
- PAUSED = :paused
239
- DELETED = :deleted
240
- IN_REVIEW = :in_review
241
- REJECTED = :rejected
242
- WITH_ISSUES = :with_issues
564
+ # The ad network the campaign runs on.
565
+ #
566
+ # @see WhopSDK::Models::AdCampaign#platform
567
+ module Platform
568
+ extend WhopSDK::Internal::Type::Enum
243
569
 
244
- # @!method self.values
245
- # @return [Array<Symbol>]
246
- end
570
+ META = :meta
247
571
 
248
- # The campaign objective that determines how Meta optimizes delivery.
249
- #
250
- # @see WhopSDK::Models::AdCampaign::MetaConfig#objective
251
- module Objective
252
- extend WhopSDK::Internal::Type::Enum
572
+ # @!method self.values
573
+ # @return [Array<Symbol>]
574
+ end
253
575
 
254
- AWARENESS = :awareness
255
- TRAFFIC = :traffic
256
- ENGAGEMENT = :engagement
257
- LEADS = :leads
258
- SALES = :sales
576
+ # The Whop pixel conversion event whose attributed count represents results — the
577
+ # optimization goal, or the highest-volume attributed event for campaigns that
578
+ # budget per ad group. Null when the goal isn't a Whop-attributed event.
579
+ #
580
+ # @see WhopSDK::Models::AdCampaign#result_event
581
+ module ResultEvent
582
+ extend WhopSDK::Internal::Type::Enum
583
+
584
+ PURCHASE = :purchase
585
+ LEAD = :lead
586
+ SCHEDULE = :schedule
587
+ SUBMIT_APPLICATION = :submit_application
588
+ CONTACT = :contact
589
+ COMPLETE_REGISTRATION = :complete_registration
590
+ VIEW_CONTENT = :view_content
591
+ ADD_TO_CART = :add_to_cart
592
+ CUSTOM = :custom
593
+
594
+ # @!method self.values
595
+ # @return [Array<Symbol>]
596
+ end
259
597
 
260
- # @!method self.values
261
- # @return [Array<Symbol>]
262
- end
598
+ # Regulated categories the campaign is declared under. Ads in these categories are
599
+ # subject to extra targeting restrictions. Empty when none apply.
600
+ module SpecialAdCategory
601
+ extend WhopSDK::Internal::Type::Enum
263
602
 
264
- # The campaign status as set by the advertiser (active or paused).
265
- #
266
- # @see WhopSDK::Models::AdCampaign::MetaConfig#status
267
- module Status
268
- extend WhopSDK::Internal::Type::Enum
603
+ HOUSING = :housing
604
+ EMPLOYMENT = :employment
605
+ FINANCIAL_PRODUCTS = :financial_products
606
+ POLITICS = :politics
269
607
 
270
- ACTIVE = :active
271
- PAUSED = :paused
608
+ # @!method self.values
609
+ # @return [Array<Symbol>]
610
+ end
272
611
 
273
- # @!method self.values
274
- # @return [Array<Symbol>]
275
- end
612
+ # The lifecycle status of the ad campaign.
613
+ #
614
+ # @see WhopSDK::Models::AdCampaign#status
615
+ module Status
616
+ extend WhopSDK::Internal::Type::Enum
617
+
618
+ ACTIVE = :active
619
+ PAUSED = :paused
620
+ INACTIVE = :inactive
621
+ STALE = :stale
622
+ PENDING_REFUND = :pending_refund
623
+ PAYMENT_FAILED = :payment_failed
624
+ DRAFT = :draft
625
+ IN_REVIEW = :in_review
626
+ FLAGGED = :flagged
627
+ IMPORTING = :importing
628
+ IMPORTED = :imported
629
+
630
+ # @!method self.values
631
+ # @return [Array<Symbol>]
276
632
  end
277
633
  end
278
634
  end