whop_sdk 0.0.39 → 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 (897) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +3 -3
  4. data/lib/whop_sdk/client.rb +227 -72
  5. data/lib/whop_sdk/internal/transport/base_client.rb +5 -0
  6. data/lib/whop_sdk/internal/type/union.rb +6 -6
  7. data/lib/whop_sdk/models/account.rb +967 -0
  8. data/lib/whop_sdk/models/account_create_params.rb +43 -0
  9. data/lib/whop_sdk/models/account_list_params.rb +83 -0
  10. data/lib/whop_sdk/models/account_me_params.rb +14 -0
  11. data/lib/whop_sdk/models/account_recommend_actions_params.rb +20 -0
  12. data/lib/whop_sdk/models/account_recommend_actions_response.rb +143 -0
  13. data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
  14. data/lib/whop_sdk/models/account_social_link.rb +60 -0
  15. data/lib/whop_sdk/models/account_update_params.rb +512 -0
  16. data/lib/whop_sdk/models/accounts/preference_retrieve_params.rb +22 -0
  17. data/lib/whop_sdk/models/accounts/preference_retrieve_response.rb +129 -0
  18. data/lib/whop_sdk/models/accounts/preference_update_params.rb +142 -0
  19. data/lib/whop_sdk/models/accounts/preference_update_response.rb +129 -0
  20. data/lib/whop_sdk/models/ad.rb +808 -0
  21. data/lib/whop_sdk/models/ad_campaign.rb +635 -0
  22. data/lib/whop_sdk/models/ad_campaign_create_params.rb +194 -0
  23. data/lib/whop_sdk/models/{payout_method_retrieve_params.rb → ad_campaign_delete_params.rb} +2 -2
  24. data/lib/whop_sdk/models/ad_campaign_delete_response.rb +8 -0
  25. data/lib/whop_sdk/models/ad_campaign_list_params.rb +120 -36
  26. data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +26 -1
  27. data/lib/whop_sdk/models/ad_campaign_update_params.rb +99 -6
  28. data/lib/whop_sdk/models/ad_create_params.rb +660 -0
  29. data/lib/whop_sdk/models/ad_delete_params.rb +20 -0
  30. data/lib/whop_sdk/models/ad_delete_response.rb +8 -0
  31. data/lib/whop_sdk/models/ad_group.rb +774 -0
  32. data/lib/whop_sdk/models/ad_group_create_params.rb +346 -0
  33. data/lib/whop_sdk/models/ad_group_list_params.rb +114 -44
  34. data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
  35. data/lib/whop_sdk/models/ad_group_retrieve_params.rb +26 -1
  36. data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
  37. data/lib/whop_sdk/models/ad_group_update_params.rb +238 -3109
  38. data/lib/whop_sdk/models/ad_list_params.rb +127 -42
  39. data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
  40. data/lib/whop_sdk/models/ad_report_retrieve_params.rb +53 -23
  41. data/lib/whop_sdk/models/ad_report_retrieve_response.rb +403 -130
  42. data/lib/whop_sdk/models/ad_retrieve_params.rb +26 -1
  43. data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
  44. data/lib/whop_sdk/models/ad_update_params.rb +650 -0
  45. data/lib/whop_sdk/models/app.rb +81 -1
  46. data/lib/whop_sdk/models/app_build_create_params.rb +2 -2
  47. data/lib/whop_sdk/models/app_create_params.rb +10 -1
  48. data/lib/whop_sdk/models/app_list_response.rb +19 -1
  49. data/lib/whop_sdk/models/app_logs_params.rb +103 -0
  50. data/lib/whop_sdk/models/app_logs_response.rb +157 -0
  51. data/lib/whop_sdk/models/app_update_params.rb +21 -1
  52. data/lib/whop_sdk/models/audience.rb +191 -0
  53. data/lib/whop_sdk/models/audience_create_params.rb +96 -0
  54. data/lib/whop_sdk/models/audience_delete_params.rb +20 -0
  55. data/lib/whop_sdk/models/audience_delete_response.rb +16 -0
  56. data/lib/whop_sdk/models/audience_list_params.rb +46 -0
  57. data/lib/whop_sdk/models/authorized_user_create_params.rb +70 -1
  58. data/lib/whop_sdk/models/bounty_create_params.rb +70 -3
  59. data/lib/whop_sdk/models/bounty_create_response.rb +1 -0
  60. data/lib/whop_sdk/models/bounty_list_params.rb +1 -0
  61. data/lib/whop_sdk/models/bounty_list_response.rb +1 -0
  62. data/lib/whop_sdk/models/bounty_retrieve_response.rb +1 -0
  63. data/lib/whop_sdk/models/card_brands.rb +1 -0
  64. data/lib/whop_sdk/models/card_create_params.rb +88 -0
  65. data/lib/whop_sdk/models/card_create_response.rb +277 -0
  66. data/lib/whop_sdk/models/card_list_params.rb +30 -0
  67. data/lib/whop_sdk/models/card_list_response.rb +287 -0
  68. data/lib/whop_sdk/models/card_retrieve_params.rb +37 -0
  69. data/lib/whop_sdk/models/card_retrieve_response.rb +277 -0
  70. data/lib/whop_sdk/models/card_update_params.rb +181 -0
  71. data/lib/whop_sdk/models/card_update_response.rb +277 -0
  72. data/lib/whop_sdk/models/chat_message_created_webhook_event.rb +151 -0
  73. data/lib/whop_sdk/models/chat_reaction_created_webhook_event.rb +159 -0
  74. data/lib/whop_sdk/models/checkout_configuration.rb +35 -24
  75. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +303 -1021
  76. data/lib/whop_sdk/models/checkout_configuration_create_response.rb +275 -0
  77. data/lib/whop_sdk/models/checkout_configuration_delete_params.rb +20 -0
  78. data/lib/whop_sdk/models/checkout_configuration_list_params.rb +50 -41
  79. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +136 -122
  80. data/lib/whop_sdk/models/checkout_configuration_retrieve_response.rb +275 -0
  81. data/lib/whop_sdk/models/company.rb +2 -2
  82. data/lib/whop_sdk/models/company_list_response.rb +2 -2
  83. data/lib/whop_sdk/models/course.rb +2 -2
  84. data/lib/whop_sdk/models/course_list_response.rb +2 -2
  85. data/lib/whop_sdk/models/currency.rb +3 -0
  86. data/lib/whop_sdk/models/deposit_create_params.rb +90 -0
  87. data/lib/whop_sdk/models/deposit_create_response.rb +228 -0
  88. data/lib/whop_sdk/models/deposit_list_params.rb +22 -0
  89. data/lib/whop_sdk/models/deposit_list_response.rb +101 -0
  90. data/lib/whop_sdk/models/dispute.rb +14 -15
  91. data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
  92. data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
  93. data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
  94. data/lib/whop_sdk/models/{conversion_create_params.rb → event_create_params.rb} +294 -32
  95. data/lib/whop_sdk/models/event_create_response.rb +16 -0
  96. data/lib/whop_sdk/models/event_list_params.rb +75 -0
  97. data/lib/whop_sdk/models/event_list_response.rb +242 -0
  98. data/lib/whop_sdk/models/experience.rb +5 -8
  99. data/lib/whop_sdk/models/experience_list_response.rb +2 -5
  100. data/lib/whop_sdk/models/file_create_params.rb +3 -15
  101. data/lib/whop_sdk/models/file_create_response.rb +3 -16
  102. data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
  103. data/lib/whop_sdk/models/file_visibility.rb +17 -0
  104. data/lib/whop_sdk/models/financial_activity_list_params.rb +113 -0
  105. data/lib/whop_sdk/models/financial_activity_list_response.rb +1174 -0
  106. data/lib/whop_sdk/models/forum_post.rb +2 -2
  107. data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
  108. data/lib/whop_sdk/models/granularities.rb +18 -0
  109. data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
  110. data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
  111. data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
  112. data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
  113. data/lib/whop_sdk/models/invoice_create_params.rb +34 -2
  114. data/lib/whop_sdk/models/invoice_update_params.rb +17 -1
  115. data/lib/whop_sdk/models/ledger_account_funds_available_webhook_event.rb +578 -0
  116. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +67 -7
  117. data/lib/whop_sdk/models/lesson.rb +6 -6
  118. data/lib/whop_sdk/models/media_asset.rb +224 -0
  119. data/lib/whop_sdk/models/media_generate_params.rb +105 -0
  120. data/lib/whop_sdk/models/media_retrieve_params.rb +20 -0
  121. data/lib/whop_sdk/models/member_list_response.rb +3 -2
  122. data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
  123. data/lib/whop_sdk/models/membership.rb +26 -3
  124. data/lib/whop_sdk/models/membership_list_response.rb +26 -3
  125. data/lib/whop_sdk/models/membership_trial_ending_soon_webhook_event.rb +60 -0
  126. data/lib/whop_sdk/models/payment.rb +213 -26
  127. data/lib/whop_sdk/models/payment_create_params.rb +22 -2
  128. data/lib/whop_sdk/models/payment_list_params.rb +9 -1
  129. data/lib/whop_sdk/models/payment_list_response.rb +118 -17
  130. data/lib/whop_sdk/models/payout_create_params.rb +58 -0
  131. data/lib/whop_sdk/models/payout_create_response.rb +185 -0
  132. data/lib/whop_sdk/models/payout_list_params.rb +70 -0
  133. data/lib/whop_sdk/models/payout_list_response.rb +195 -0
  134. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +20 -3
  135. data/lib/whop_sdk/models/payouts/method_list_params.rb +120 -0
  136. data/lib/whop_sdk/models/payouts/method_list_response.rb +315 -0
  137. data/lib/whop_sdk/models/person_list_params.rb +103 -0
  138. data/lib/whop_sdk/models/person_list_response.rb +167 -0
  139. data/lib/whop_sdk/models/person_retrieve_params.rb +50 -0
  140. data/lib/whop_sdk/models/person_retrieve_response.rb +179 -0
  141. data/lib/whop_sdk/models/plan.rb +311 -246
  142. data/lib/whop_sdk/models/plan_calculate_tax_params.rb +248 -0
  143. data/lib/whop_sdk/models/plan_calculate_tax_response.rb +94 -0
  144. data/lib/whop_sdk/models/plan_create_params.rb +137 -153
  145. data/lib/whop_sdk/models/plan_list_params.rb +54 -47
  146. data/lib/whop_sdk/models/plan_list_response.rb +105 -221
  147. data/lib/whop_sdk/models/plan_update_params.rb +116 -133
  148. data/lib/whop_sdk/models/product.rb +40 -37
  149. data/lib/whop_sdk/models/product_create_params.rb +48 -189
  150. data/lib/whop_sdk/models/product_list_item.rb +20 -11
  151. data/lib/whop_sdk/models/product_list_params.rb +35 -57
  152. data/lib/whop_sdk/models/product_update_params.rb +20 -148
  153. data/lib/whop_sdk/models/referral_referred_users_params.rb +66 -0
  154. data/lib/whop_sdk/models/referral_referred_users_response.rb +127 -0
  155. data/lib/whop_sdk/models/referrals/business_leaderboard_params.rb +45 -0
  156. data/lib/whop_sdk/models/referrals/business_leaderboard_response.rb +284 -0
  157. data/lib/whop_sdk/models/referrals/business_list_params.rb +175 -0
  158. data/lib/whop_sdk/models/referrals/business_list_response.rb +361 -0
  159. data/lib/whop_sdk/models/referrals/business_retrieve_params.rb +22 -0
  160. data/lib/whop_sdk/models/referrals/business_retrieve_response.rb +881 -0
  161. data/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb +131 -0
  162. data/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb +371 -0
  163. data/lib/whop_sdk/models/referrals/partner_create_params.rb +16 -0
  164. data/lib/whop_sdk/models/referrals/partner_create_response.rb +31 -0
  165. data/lib/whop_sdk/models/refund_created_webhook_event.rb +86 -5
  166. data/lib/whop_sdk/models/refund_retrieve_response.rb +84 -5
  167. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +86 -5
  168. data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
  169. data/lib/whop_sdk/models/result_label_keys.rb +48 -0
  170. data/lib/whop_sdk/models/review_list_response.rb +2 -2
  171. data/lib/whop_sdk/models/review_retrieve_response.rb +4 -7
  172. data/lib/whop_sdk/models/setup_intent.rb +10 -1
  173. data/lib/whop_sdk/models/social_account.rb +101 -0
  174. data/lib/whop_sdk/models/social_account_connect_params.rb +74 -0
  175. data/lib/whop_sdk/models/social_account_connect_response.rb +17 -0
  176. data/lib/whop_sdk/models/social_account_create_params.rb +45 -0
  177. data/lib/whop_sdk/models/social_account_delete_params.rb +42 -0
  178. data/lib/whop_sdk/models/social_account_delete_response.rb +8 -0
  179. data/lib/whop_sdk/models/social_account_list_params.rb +152 -0
  180. data/lib/whop_sdk/models/social_account_post.rb +99 -0
  181. data/lib/whop_sdk/models/social_account_posts_params.rb +53 -0
  182. data/lib/whop_sdk/models/social_account_posts_response.rb +39 -0
  183. data/lib/whop_sdk/models/stat_list_params.rb +14 -0
  184. data/lib/whop_sdk/models/stat_list_response.rb +89 -0
  185. data/lib/whop_sdk/models/stat_retrieve_params.rb +265 -0
  186. data/lib/whop_sdk/models/stat_retrieve_response.rb +88 -0
  187. data/lib/whop_sdk/models/swap_create_params.rb +101 -0
  188. data/lib/whop_sdk/models/swap_create_quote_params.rb +117 -0
  189. data/lib/whop_sdk/models/swap_create_quote_response.rb +130 -0
  190. data/lib/whop_sdk/models/swap_create_response.rb +82 -0
  191. data/lib/whop_sdk/models/swap_list_params.rb +22 -0
  192. data/lib/whop_sdk/models/swap_list_response.rb +77 -0
  193. data/lib/whop_sdk/models/swap_retrieve_params.rb +20 -0
  194. data/lib/whop_sdk/models/swap_retrieve_response.rb +66 -0
  195. data/lib/whop_sdk/models/tax_identifier_type.rb +2 -0
  196. data/lib/whop_sdk/models/transfer_create_params.rb +62 -27
  197. data/lib/whop_sdk/models/transfer_create_response.rb +452 -0
  198. data/lib/whop_sdk/models/transfer_list_params.rb +46 -40
  199. data/lib/whop_sdk/models/transfer_list_response.rb +29 -36
  200. data/lib/whop_sdk/models/transfer_retrieve_response.rb +267 -0
  201. data/lib/whop_sdk/models/unwrap_webhook_event.rb +46 -30
  202. data/lib/whop_sdk/models/user.rb +276 -31
  203. data/lib/whop_sdk/models/user_balance.rb +226 -0
  204. data/lib/whop_sdk/models/user_check_access_response.rb +16 -9
  205. data/lib/whop_sdk/models/user_list_params.rb +15 -15
  206. data/lib/whop_sdk/models/user_retrieve_params.rb +66 -6
  207. data/lib/whop_sdk/models/user_update_me_params.rb +70 -0
  208. data/lib/whop_sdk/models/user_update_params.rb +23 -30
  209. data/lib/whop_sdk/models/verification_create_params.rb +414 -0
  210. data/lib/whop_sdk/models/verification_create_response.rb +400 -0
  211. data/lib/whop_sdk/models/verification_list_params.rb +40 -30
  212. data/lib/whop_sdk/models/verification_list_response.rb +396 -34
  213. data/lib/whop_sdk/models/verification_retrieve_params.rb +4 -4
  214. data/lib/whop_sdk/models/verification_retrieve_response.rb +373 -21
  215. data/lib/whop_sdk/models/verification_update_params.rb +578 -0
  216. data/lib/whop_sdk/models/verification_update_response.rb +400 -0
  217. data/lib/whop_sdk/models/webhook_event.rb +8 -0
  218. data/lib/whop_sdk/models/withdrawal.rb +1 -0
  219. data/lib/whop_sdk/models/withdrawal_create_params.rb +2 -2
  220. data/lib/whop_sdk/models/workforce/bounty_list_params.rb +153 -0
  221. data/lib/whop_sdk/models/workforce/bounty_retrieve_params.rb +22 -0
  222. data/lib/whop_sdk/models/workforce/workforce_bounty.rb +351 -0
  223. data/lib/whop_sdk/models/workforce/workforce_bounty_list_item.rb +347 -0
  224. data/lib/whop_sdk/models.rb +151 -7
  225. data/lib/whop_sdk/resources/access_tokens.rb +0 -1
  226. data/lib/whop_sdk/resources/account_links.rb +0 -1
  227. data/lib/whop_sdk/resources/accounts/preferences.rb +78 -0
  228. data/lib/whop_sdk/resources/accounts.rb +254 -0
  229. data/lib/whop_sdk/resources/ad_campaigns.rb +136 -47
  230. data/lib/whop_sdk/resources/ad_groups.rb +194 -47
  231. data/lib/whop_sdk/resources/ad_reports.rb +14 -9
  232. data/lib/whop_sdk/resources/ads.rb +210 -25
  233. data/lib/whop_sdk/resources/affiliates/overrides.rb +0 -1
  234. data/lib/whop_sdk/resources/affiliates.rb +0 -2
  235. data/lib/whop_sdk/resources/ai_chats.rb +0 -1
  236. data/lib/whop_sdk/resources/app_builds.rb +0 -1
  237. data/lib/whop_sdk/resources/apps.rb +63 -3
  238. data/lib/whop_sdk/resources/audiences.rb +104 -0
  239. data/lib/whop_sdk/resources/authorized_users.rb +3 -2
  240. data/lib/whop_sdk/resources/bounties.rb +9 -2
  241. data/lib/whop_sdk/resources/cards.rb +178 -0
  242. data/lib/whop_sdk/resources/chat_channels.rb +0 -1
  243. data/lib/whop_sdk/resources/checkout_configurations.rb +69 -42
  244. data/lib/whop_sdk/resources/companies.rb +0 -1
  245. data/lib/whop_sdk/resources/company_token_transactions.rb +0 -1
  246. data/lib/whop_sdk/resources/course_chapters.rb +0 -1
  247. data/lib/whop_sdk/resources/course_lesson_interactions.rb +0 -1
  248. data/lib/whop_sdk/resources/course_lessons.rb +0 -1
  249. data/lib/whop_sdk/resources/course_students.rb +0 -1
  250. data/lib/whop_sdk/resources/courses.rb +0 -1
  251. data/lib/whop_sdk/resources/deposits.rb +77 -0
  252. data/lib/whop_sdk/resources/dispute_alerts.rb +0 -1
  253. data/lib/whop_sdk/resources/disputes.rb +0 -1
  254. data/lib/whop_sdk/resources/dm_channels.rb +0 -1
  255. data/lib/whop_sdk/resources/dm_members.rb +0 -1
  256. data/lib/whop_sdk/resources/entries.rb +0 -1
  257. data/lib/whop_sdk/resources/events.rb +121 -0
  258. data/lib/whop_sdk/resources/experiences.rb +0 -1
  259. data/lib/whop_sdk/resources/fee_markups.rb +0 -1
  260. data/lib/whop_sdk/resources/files.rb +1 -2
  261. data/lib/whop_sdk/resources/financial_activity.rb +76 -0
  262. data/lib/whop_sdk/resources/forum_posts.rb +0 -1
  263. data/lib/whop_sdk/resources/forums.rb +0 -1
  264. data/lib/whop_sdk/resources/invoices.rb +0 -1
  265. data/lib/whop_sdk/resources/leads.rb +0 -1
  266. data/lib/whop_sdk/resources/ledger_accounts.rb +0 -1
  267. data/lib/whop_sdk/resources/media.rb +77 -0
  268. data/lib/whop_sdk/resources/members.rb +0 -1
  269. data/lib/whop_sdk/resources/memberships.rb +0 -1
  270. data/lib/whop_sdk/resources/messages.rb +0 -1
  271. data/lib/whop_sdk/resources/notifications.rb +0 -1
  272. data/lib/whop_sdk/resources/payment_methods.rb +0 -1
  273. data/lib/whop_sdk/resources/payments.rb +3 -2
  274. data/lib/whop_sdk/resources/payout_accounts.rb +0 -1
  275. data/lib/whop_sdk/resources/payouts/methods.rb +71 -0
  276. data/lib/whop_sdk/resources/payouts.rb +107 -0
  277. data/lib/whop_sdk/resources/people.rb +99 -0
  278. data/lib/whop_sdk/resources/plans.rb +99 -79
  279. data/lib/whop_sdk/resources/products.rb +48 -93
  280. data/lib/whop_sdk/resources/promo_codes.rb +0 -1
  281. data/lib/whop_sdk/resources/reactions.rb +0 -1
  282. data/lib/whop_sdk/resources/referrals/businesses/earnings.rb +67 -0
  283. data/lib/whop_sdk/resources/referrals/businesses.rb +132 -0
  284. data/lib/whop_sdk/resources/referrals/partners.rb +42 -0
  285. data/lib/whop_sdk/resources/referrals.rb +77 -0
  286. data/lib/whop_sdk/resources/refunds.rb +2 -1
  287. data/lib/whop_sdk/resources/resolution_center_cases.rb +0 -1
  288. data/lib/whop_sdk/resources/reviews.rb +0 -1
  289. data/lib/whop_sdk/resources/setup_intents.rb +0 -1
  290. data/lib/whop_sdk/resources/shipments.rb +0 -1
  291. data/lib/whop_sdk/resources/social_accounts.rb +192 -0
  292. data/lib/whop_sdk/resources/stats.rb +113 -0
  293. data/lib/whop_sdk/resources/support_channels.rb +0 -1
  294. data/lib/whop_sdk/resources/swaps.rb +143 -0
  295. data/lib/whop_sdk/resources/topups.rb +0 -1
  296. data/lib/whop_sdk/resources/transfers.rb +42 -42
  297. data/lib/whop_sdk/resources/users.rb +82 -33
  298. data/lib/whop_sdk/resources/verifications.rb +81 -20
  299. data/lib/whop_sdk/resources/webhooks.rb +1 -2
  300. data/lib/whop_sdk/resources/withdrawals.rb +1 -2
  301. data/lib/whop_sdk/resources/workforce/bounties.rb +97 -0
  302. data/lib/whop_sdk/resources/workforce.rb +25 -0
  303. data/lib/whop_sdk/version.rb +1 -1
  304. data/lib/whop_sdk.rb +148 -21
  305. data/rbi/whop_sdk/client.rbi +211 -69
  306. data/rbi/whop_sdk/models/account.rbi +1532 -0
  307. data/rbi/whop_sdk/models/account_create_params.rbi +72 -0
  308. data/rbi/whop_sdk/models/account_list_params.rbi +145 -0
  309. data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
  310. data/rbi/whop_sdk/models/account_recommend_actions_params.rbi +38 -0
  311. data/rbi/whop_sdk/models/account_recommend_actions_response.rbi +296 -0
  312. data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
  313. data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
  314. data/rbi/whop_sdk/models/account_update_params.rbi +1141 -0
  315. data/rbi/whop_sdk/models/accounts/preference_retrieve_params.rbi +40 -0
  316. data/rbi/whop_sdk/models/accounts/preference_retrieve_response.rbi +323 -0
  317. data/rbi/whop_sdk/models/accounts/preference_update_params.rbi +331 -0
  318. data/rbi/whop_sdk/models/accounts/preference_update_response.rbi +323 -0
  319. data/rbi/whop_sdk/models/ad.rbi +983 -0
  320. data/rbi/whop_sdk/models/ad_campaign.rbi +846 -0
  321. data/rbi/whop_sdk/models/ad_campaign_create_params.rbi +428 -0
  322. data/rbi/whop_sdk/models/{payout_method_retrieve_params.rbi → ad_campaign_delete_params.rbi} +2 -2
  323. data/rbi/whop_sdk/models/ad_campaign_delete_response.rbi +8 -0
  324. data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +248 -56
  325. data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +41 -2
  326. data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +207 -8
  327. data/rbi/whop_sdk/models/ad_create_params.rbi +1491 -0
  328. data/rbi/whop_sdk/models/ad_delete_params.rbi +35 -0
  329. data/rbi/whop_sdk/models/ad_delete_response.rbi +7 -0
  330. data/rbi/whop_sdk/models/ad_group.rbi +948 -0
  331. data/rbi/whop_sdk/models/ad_group_create_params.rbi +654 -0
  332. data/rbi/whop_sdk/models/ad_group_list_params.rbi +217 -67
  333. data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
  334. data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +41 -2
  335. data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
  336. data/rbi/whop_sdk/models/ad_group_update_params.rbi +494 -5988
  337. data/rbi/whop_sdk/models/ad_list_params.rbi +220 -59
  338. data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
  339. data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +89 -33
  340. data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +566 -378
  341. data/rbi/whop_sdk/models/ad_retrieve_params.rbi +41 -2
  342. data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
  343. data/rbi/whop_sdk/models/ad_update_params.rbi +1473 -0
  344. data/rbi/whop_sdk/models/app.rbi +111 -0
  345. data/rbi/whop_sdk/models/app_build_create_params.rbi +3 -3
  346. data/rbi/whop_sdk/models/app_create_params.rbi +10 -0
  347. data/rbi/whop_sdk/models/app_list_response.rbi +20 -0
  348. data/rbi/whop_sdk/models/app_logs_params.rbi +154 -0
  349. data/rbi/whop_sdk/models/app_logs_response.rbi +261 -0
  350. data/rbi/whop_sdk/models/app_update_params.rbi +24 -0
  351. data/rbi/whop_sdk/models/audience.rbi +262 -0
  352. data/rbi/whop_sdk/models/audience_create_params.rbi +160 -0
  353. data/rbi/whop_sdk/models/audience_delete_params.rbi +35 -0
  354. data/rbi/whop_sdk/models/audience_delete_response.rbi +26 -0
  355. data/rbi/whop_sdk/models/audience_list_params.rbi +76 -0
  356. data/rbi/whop_sdk/models/authorized_user_create_params.rbi +102 -0
  357. data/rbi/whop_sdk/models/bounty_create_params.rbi +164 -4
  358. data/rbi/whop_sdk/models/bounty_create_response.rbi +5 -0
  359. data/rbi/whop_sdk/models/bounty_list_params.rbi +2 -0
  360. data/rbi/whop_sdk/models/bounty_list_response.rbi +5 -0
  361. data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +5 -0
  362. data/rbi/whop_sdk/models/card_brands.rbi +1 -0
  363. data/rbi/whop_sdk/models/card_create_params.rbi +167 -0
  364. data/rbi/whop_sdk/models/card_create_response.rbi +446 -0
  365. data/rbi/whop_sdk/models/card_list_params.rbi +57 -0
  366. data/rbi/whop_sdk/models/card_list_response.rbi +511 -0
  367. data/rbi/whop_sdk/models/card_retrieve_params.rbi +63 -0
  368. data/rbi/whop_sdk/models/card_retrieve_response.rbi +457 -0
  369. data/rbi/whop_sdk/models/card_update_params.rbi +299 -0
  370. data/rbi/whop_sdk/models/card_update_response.rbi +446 -0
  371. data/rbi/whop_sdk/models/chat_message_created_webhook_event.rbi +319 -0
  372. data/rbi/whop_sdk/models/chat_reaction_created_webhook_event.rbi +335 -0
  373. data/rbi/whop_sdk/models/checkout_configuration.rbi +84 -44
  374. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +404 -1537
  375. data/rbi/whop_sdk/models/checkout_configuration_create_response.rbi +420 -0
  376. data/rbi/whop_sdk/models/checkout_configuration_delete_params.rbi +38 -0
  377. data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +142 -51
  378. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +202 -161
  379. data/rbi/whop_sdk/models/checkout_configuration_retrieve_response.rbi +422 -0
  380. data/rbi/whop_sdk/models/company.rbi +2 -2
  381. data/rbi/whop_sdk/models/company_list_response.rbi +2 -2
  382. data/rbi/whop_sdk/models/course.rbi +2 -2
  383. data/rbi/whop_sdk/models/course_list_response.rbi +2 -2
  384. data/rbi/whop_sdk/models/currency.rbi +3 -0
  385. data/rbi/whop_sdk/models/deposit_create_params.rbi +165 -0
  386. data/rbi/whop_sdk/models/deposit_create_response.rbi +437 -0
  387. data/rbi/whop_sdk/models/deposit_list_params.rbi +40 -0
  388. data/rbi/whop_sdk/models/deposit_list_response.rbi +163 -0
  389. data/rbi/whop_sdk/models/dispute.rbi +15 -17
  390. data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
  391. data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
  392. data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
  393. data/rbi/whop_sdk/models/event_create_params.rbi +891 -0
  394. data/rbi/whop_sdk/models/{conversion_create_response.rbi → event_create_response.rbi} +3 -8
  395. data/rbi/whop_sdk/models/event_list_params.rbi +111 -0
  396. data/rbi/whop_sdk/models/event_list_response.rbi +350 -0
  397. data/rbi/whop_sdk/models/experience.rbi +6 -6
  398. data/rbi/whop_sdk/models/experience_list_response.rbi +2 -2
  399. data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
  400. data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
  401. data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
  402. data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
  403. data/rbi/whop_sdk/models/financial_activity_list_params.rbi +175 -0
  404. data/rbi/whop_sdk/models/financial_activity_list_response.rbi +2066 -0
  405. data/rbi/whop_sdk/models/forum_post.rbi +2 -2
  406. data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
  407. data/rbi/whop_sdk/models/granularities.rbi +22 -0
  408. data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
  409. data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
  410. data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
  411. data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
  412. data/rbi/whop_sdk/models/invoice_create_params.rbi +32 -0
  413. data/rbi/whop_sdk/models/invoice_update_params.rbi +16 -0
  414. data/rbi/whop_sdk/models/ledger_account_funds_available_webhook_event.rbi +1001 -0
  415. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +111 -5
  416. data/rbi/whop_sdk/models/lesson.rbi +6 -6
  417. data/rbi/whop_sdk/models/media_asset.rbi +325 -0
  418. data/rbi/whop_sdk/models/media_generate_params.rbi +204 -0
  419. data/rbi/whop_sdk/models/media_retrieve_params.rbi +35 -0
  420. data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
  421. data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
  422. data/rbi/whop_sdk/models/membership.rbi +50 -7
  423. data/rbi/whop_sdk/models/membership_list_response.rbi +50 -7
  424. data/rbi/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbi +85 -0
  425. data/rbi/whop_sdk/models/payment.rbi +295 -40
  426. data/rbi/whop_sdk/models/payment_create_params.rbi +30 -6
  427. data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
  428. data/rbi/whop_sdk/models/payment_list_response.rbi +188 -28
  429. data/rbi/whop_sdk/models/payout_create_params.rbi +83 -0
  430. data/rbi/whop_sdk/models/payout_create_response.rbi +352 -0
  431. data/rbi/whop_sdk/models/payout_list_params.rbi +112 -0
  432. data/rbi/whop_sdk/models/payout_list_response.rbi +353 -0
  433. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +64 -3
  434. data/rbi/whop_sdk/models/payouts/method_list_params.rbi +209 -0
  435. data/rbi/whop_sdk/models/payouts/method_list_response.rbi +554 -0
  436. data/rbi/whop_sdk/models/person_list_params.rbi +160 -0
  437. data/rbi/whop_sdk/models/person_list_response.rbi +282 -0
  438. data/rbi/whop_sdk/models/person_retrieve_params.rbi +76 -0
  439. data/rbi/whop_sdk/models/person_retrieve_response.rbi +349 -0
  440. data/rbi/whop_sdk/models/plan.rbi +346 -332
  441. data/rbi/whop_sdk/models/plan_calculate_tax_params.rbi +795 -0
  442. data/rbi/whop_sdk/models/plan_calculate_tax_response.rbi +170 -0
  443. data/rbi/whop_sdk/models/plan_create_params.rbi +267 -217
  444. data/rbi/whop_sdk/models/plan_list_params.rbi +121 -67
  445. data/rbi/whop_sdk/models/plan_list_response.rbi +127 -360
  446. data/rbi/whop_sdk/models/plan_update_params.rbi +228 -192
  447. data/rbi/whop_sdk/models/product.rbi +48 -44
  448. data/rbi/whop_sdk/models/product_create_params.rbi +69 -273
  449. data/rbi/whop_sdk/models/product_list_item.rbi +24 -14
  450. data/rbi/whop_sdk/models/product_list_params.rbi +75 -78
  451. data/rbi/whop_sdk/models/product_update_params.rbi +30 -207
  452. data/rbi/whop_sdk/models/referral_referred_users_params.rbi +106 -0
  453. data/rbi/whop_sdk/models/referral_referred_users_response.rbi +259 -0
  454. data/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi +120 -0
  455. data/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi +535 -0
  456. data/rbi/whop_sdk/models/referrals/business_list_params.rbi +376 -0
  457. data/rbi/whop_sdk/models/referrals/business_list_response.rbi +701 -0
  458. data/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi +40 -0
  459. data/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi +1846 -0
  460. data/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi +308 -0
  461. data/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi +693 -0
  462. data/rbi/whop_sdk/models/referrals/partner_create_params.rbi +32 -0
  463. data/rbi/whop_sdk/models/referrals/partner_create_response.rbi +48 -0
  464. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +163 -5
  465. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +161 -5
  466. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +163 -5
  467. data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
  468. data/rbi/whop_sdk/models/result_label_keys.rbi +87 -0
  469. data/rbi/whop_sdk/models/review_list_response.rbi +2 -2
  470. data/rbi/whop_sdk/models/review_retrieve_response.rbi +4 -4
  471. data/rbi/whop_sdk/models/setup_intent.rbi +13 -3
  472. data/rbi/whop_sdk/models/social_account.rbi +129 -0
  473. data/rbi/whop_sdk/models/social_account_connect_params.rbi +146 -0
  474. data/rbi/whop_sdk/models/social_account_connect_response.rbi +30 -0
  475. data/rbi/whop_sdk/models/social_account_create_params.rbi +81 -0
  476. data/rbi/whop_sdk/models/social_account_delete_params.rbi +67 -0
  477. data/rbi/whop_sdk/models/social_account_delete_response.rbi +8 -0
  478. data/rbi/whop_sdk/models/social_account_list_params.rbi +308 -0
  479. data/rbi/whop_sdk/models/social_account_post.rbi +261 -0
  480. data/rbi/whop_sdk/models/social_account_posts_params.rbi +82 -0
  481. data/rbi/whop_sdk/models/social_account_posts_response.rbi +83 -0
  482. data/rbi/whop_sdk/models/stat_list_params.rbi +27 -0
  483. data/rbi/whop_sdk/models/stat_list_response.rbi +159 -0
  484. data/rbi/whop_sdk/models/stat_retrieve_params.rbi +411 -0
  485. data/rbi/whop_sdk/models/stat_retrieve_response.rbi +198 -0
  486. data/rbi/whop_sdk/models/swap_create_params.rbi +128 -0
  487. data/rbi/whop_sdk/models/swap_create_quote_params.rbi +154 -0
  488. data/rbi/whop_sdk/models/swap_create_quote_response.rbi +174 -0
  489. data/rbi/whop_sdk/models/swap_create_response.rbi +127 -0
  490. data/rbi/whop_sdk/models/swap_list_params.rbi +40 -0
  491. data/rbi/whop_sdk/models/swap_list_response.rbi +137 -0
  492. data/rbi/whop_sdk/models/swap_retrieve_params.rbi +35 -0
  493. data/rbi/whop_sdk/models/swap_retrieve_response.rbi +106 -0
  494. data/rbi/whop_sdk/models/tax_identifier_type.rbi +2 -0
  495. data/rbi/whop_sdk/models/transfer_create_params.rbi +94 -36
  496. data/rbi/whop_sdk/models/transfer_create_response.rbi +767 -0
  497. data/rbi/whop_sdk/models/transfer_list_params.rbi +111 -60
  498. data/rbi/whop_sdk/models/transfer_list_response.rbi +32 -40
  499. data/rbi/whop_sdk/models/transfer_retrieve_response.rbi +416 -0
  500. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +29 -21
  501. data/rbi/whop_sdk/models/user.rbi +427 -45
  502. data/rbi/whop_sdk/models/user_balance.rbi +301 -0
  503. data/rbi/whop_sdk/models/user_check_access_response.rbi +46 -12
  504. data/rbi/whop_sdk/models/user_list_params.rbi +40 -25
  505. data/rbi/whop_sdk/models/user_retrieve_params.rbi +106 -8
  506. data/rbi/whop_sdk/models/user_update_me_params.rbi +120 -0
  507. data/rbi/whop_sdk/models/user_update_params.rbi +46 -45
  508. data/rbi/whop_sdk/models/verification_create_params.rbi +783 -0
  509. data/rbi/whop_sdk/models/verification_create_response.rbi +757 -0
  510. data/rbi/whop_sdk/models/verification_list_params.rbi +88 -34
  511. data/rbi/whop_sdk/models/verification_list_response.rbi +783 -39
  512. data/rbi/whop_sdk/models/verification_retrieve_params.rbi +4 -4
  513. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +722 -30
  514. data/rbi/whop_sdk/models/verification_update_params.rbi +1187 -0
  515. data/rbi/whop_sdk/models/verification_update_response.rbi +757 -0
  516. data/rbi/whop_sdk/models/webhook_event.rbi +25 -0
  517. data/rbi/whop_sdk/models/withdrawal.rbi +5 -0
  518. data/rbi/whop_sdk/models/withdrawal_create_params.rbi +2 -2
  519. data/rbi/whop_sdk/models/workforce/bounty_list_params.rbi +313 -0
  520. data/rbi/whop_sdk/models/workforce/bounty_retrieve_params.rbi +40 -0
  521. data/rbi/whop_sdk/models/workforce/workforce_bounty.rbi +588 -0
  522. data/rbi/whop_sdk/models/workforce/workforce_bounty_list_item.rbi +590 -0
  523. data/rbi/whop_sdk/models.rbi +160 -7
  524. data/rbi/whop_sdk/resources/access_tokens.rbi +0 -1
  525. data/rbi/whop_sdk/resources/account_links.rbi +0 -1
  526. data/rbi/whop_sdk/resources/accounts/preferences.rbi +62 -0
  527. data/rbi/whop_sdk/resources/accounts.rbi +253 -0
  528. data/rbi/whop_sdk/resources/ad_campaigns.rbi +173 -60
  529. data/rbi/whop_sdk/resources/ad_groups.rbi +287 -72
  530. data/rbi/whop_sdk/resources/ad_reports.rbi +29 -19
  531. data/rbi/whop_sdk/resources/ads.rbi +254 -39
  532. data/rbi/whop_sdk/resources/affiliates/overrides.rbi +0 -1
  533. data/rbi/whop_sdk/resources/affiliates.rbi +0 -2
  534. data/rbi/whop_sdk/resources/ai_chats.rbi +0 -1
  535. data/rbi/whop_sdk/resources/app_builds.rbi +1 -2
  536. data/rbi/whop_sdk/resources/apps.rbi +66 -1
  537. data/rbi/whop_sdk/resources/audiences.rbi +82 -0
  538. data/rbi/whop_sdk/resources/authorized_users.rbi +4 -1
  539. data/rbi/whop_sdk/resources/bounties.rbi +23 -3
  540. data/rbi/whop_sdk/resources/cards.rbi +160 -0
  541. data/rbi/whop_sdk/resources/chat_channels.rbi +0 -1
  542. data/rbi/whop_sdk/resources/checkout_configurations.rbi +82 -51
  543. data/rbi/whop_sdk/resources/companies.rbi +0 -1
  544. data/rbi/whop_sdk/resources/company_token_transactions.rbi +0 -1
  545. data/rbi/whop_sdk/resources/course_chapters.rbi +0 -1
  546. data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +0 -1
  547. data/rbi/whop_sdk/resources/course_lessons.rbi +0 -1
  548. data/rbi/whop_sdk/resources/course_students.rbi +0 -1
  549. data/rbi/whop_sdk/resources/courses.rbi +0 -1
  550. data/rbi/whop_sdk/resources/deposits.rbi +63 -0
  551. data/rbi/whop_sdk/resources/dispute_alerts.rbi +0 -1
  552. data/rbi/whop_sdk/resources/disputes.rbi +0 -1
  553. data/rbi/whop_sdk/resources/dm_channels.rbi +0 -1
  554. data/rbi/whop_sdk/resources/dm_members.rbi +0 -1
  555. data/rbi/whop_sdk/resources/entries.rbi +0 -1
  556. data/rbi/whop_sdk/resources/events.rbi +122 -0
  557. data/rbi/whop_sdk/resources/experiences.rbi +0 -1
  558. data/rbi/whop_sdk/resources/fee_markups.rbi +0 -1
  559. data/rbi/whop_sdk/resources/files.rbi +1 -3
  560. data/rbi/whop_sdk/resources/financial_activity.rbi +80 -0
  561. data/rbi/whop_sdk/resources/forum_posts.rbi +0 -1
  562. data/rbi/whop_sdk/resources/forums.rbi +0 -1
  563. data/rbi/whop_sdk/resources/invoices.rbi +0 -1
  564. data/rbi/whop_sdk/resources/leads.rbi +0 -1
  565. data/rbi/whop_sdk/resources/ledger_accounts.rbi +0 -1
  566. data/rbi/whop_sdk/resources/media.rbi +67 -0
  567. data/rbi/whop_sdk/resources/members.rbi +0 -1
  568. data/rbi/whop_sdk/resources/memberships.rbi +0 -1
  569. data/rbi/whop_sdk/resources/messages.rbi +0 -1
  570. data/rbi/whop_sdk/resources/notifications.rbi +0 -1
  571. data/rbi/whop_sdk/resources/payment_methods.rbi +0 -1
  572. data/rbi/whop_sdk/resources/payments.rbi +3 -1
  573. data/rbi/whop_sdk/resources/payout_accounts.rbi +0 -1
  574. data/rbi/whop_sdk/resources/payouts/methods.rbi +76 -0
  575. data/rbi/whop_sdk/resources/payouts.rbi +96 -0
  576. data/rbi/whop_sdk/resources/people.rbi +86 -0
  577. data/rbi/whop_sdk/resources/plans.rbi +120 -112
  578. data/rbi/whop_sdk/resources/products.rbi +67 -144
  579. data/rbi/whop_sdk/resources/promo_codes.rbi +0 -1
  580. data/rbi/whop_sdk/resources/reactions.rbi +0 -1
  581. data/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi +67 -0
  582. data/rbi/whop_sdk/resources/referrals/businesses.rbi +122 -0
  583. data/rbi/whop_sdk/resources/referrals/partners.rbi +31 -0
  584. data/rbi/whop_sdk/resources/referrals.rbi +67 -0
  585. data/rbi/whop_sdk/resources/refunds.rbi +2 -1
  586. data/rbi/whop_sdk/resources/resolution_center_cases.rbi +0 -1
  587. data/rbi/whop_sdk/resources/reviews.rbi +0 -1
  588. data/rbi/whop_sdk/resources/setup_intents.rbi +0 -1
  589. data/rbi/whop_sdk/resources/shipments.rbi +0 -1
  590. data/rbi/whop_sdk/resources/social_accounts.rbi +161 -0
  591. data/rbi/whop_sdk/resources/stats.rbi +143 -0
  592. data/rbi/whop_sdk/resources/support_channels.rbi +0 -1
  593. data/rbi/whop_sdk/resources/swaps.rbi +124 -0
  594. data/rbi/whop_sdk/resources/topups.rbi +0 -1
  595. data/rbi/whop_sdk/resources/transfers.rbi +62 -59
  596. data/rbi/whop_sdk/resources/users.rbi +92 -48
  597. data/rbi/whop_sdk/resources/verifications.rbi +85 -35
  598. data/rbi/whop_sdk/resources/webhooks.rbi +29 -22
  599. data/rbi/whop_sdk/resources/withdrawals.rbi +1 -2
  600. data/rbi/whop_sdk/resources/workforce/bounties.rbi +94 -0
  601. data/rbi/whop_sdk/resources/workforce.rbi +22 -0
  602. data/sig/whop_sdk/client.rbs +31 -4
  603. data/sig/whop_sdk/models/account.rbs +706 -0
  604. data/sig/whop_sdk/models/account_create_params.rbs +38 -0
  605. data/sig/whop_sdk/models/account_list_params.rbs +88 -0
  606. data/sig/whop_sdk/models/account_me_params.rbs +14 -0
  607. data/sig/whop_sdk/models/account_recommend_actions_params.rbs +23 -0
  608. data/sig/whop_sdk/models/account_recommend_actions_response.rbs +129 -0
  609. data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
  610. data/sig/whop_sdk/models/account_social_link.rbs +62 -0
  611. data/sig/whop_sdk/models/account_update_params.rbs +536 -0
  612. data/sig/whop_sdk/models/accounts/preference_retrieve_params.rbs +25 -0
  613. data/sig/whop_sdk/models/accounts/preference_retrieve_response.rbs +110 -0
  614. data/sig/whop_sdk/models/accounts/preference_update_params.rbs +133 -0
  615. data/sig/whop_sdk/models/accounts/preference_update_response.rbs +110 -0
  616. data/sig/whop_sdk/models/ad.rbs +597 -0
  617. data/sig/whop_sdk/models/ad_campaign.rbs +472 -0
  618. data/sig/whop_sdk/models/ad_campaign_create_params.rbs +179 -0
  619. data/sig/whop_sdk/models/{payout_method_retrieve_params.rbs → ad_campaign_delete_params.rbs} +2 -2
  620. data/sig/whop_sdk/models/ad_campaign_delete_response.rbs +5 -0
  621. data/sig/whop_sdk/models/ad_campaign_list_params.rbs +145 -41
  622. data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +24 -2
  623. data/sig/whop_sdk/models/ad_campaign_update_params.rbs +90 -4
  624. data/sig/whop_sdk/models/ad_create_params.rbs +751 -0
  625. data/sig/whop_sdk/models/ad_delete_params.rbs +20 -0
  626. data/sig/whop_sdk/models/ad_delete_response.rbs +5 -0
  627. data/sig/whop_sdk/models/ad_group.rbs +543 -0
  628. data/sig/whop_sdk/models/ad_group_create_params.rbs +292 -0
  629. data/sig/whop_sdk/models/ad_group_list_params.rbs +141 -50
  630. data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
  631. data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +24 -2
  632. data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
  633. data/sig/whop_sdk/models/ad_group_update_params.rbs +200 -2354
  634. data/sig/whop_sdk/models/ad_list_params.rbs +157 -44
  635. data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
  636. data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +38 -16
  637. data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +258 -149
  638. data/sig/whop_sdk/models/ad_retrieve_params.rbs +24 -2
  639. data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
  640. data/sig/whop_sdk/models/ad_update_params.rbs +742 -0
  641. data/sig/whop_sdk/models/app.rbs +52 -0
  642. data/sig/whop_sdk/models/app_create_params.rbs +6 -1
  643. data/sig/whop_sdk/models/app_list_response.rbs +10 -0
  644. data/sig/whop_sdk/models/app_logs_params.rbs +98 -0
  645. data/sig/whop_sdk/models/app_logs_response.rbs +162 -0
  646. data/sig/whop_sdk/models/app_update_params.rbs +10 -0
  647. data/sig/whop_sdk/models/audience.rbs +145 -0
  648. data/sig/whop_sdk/models/audience_create_params.rbs +88 -0
  649. data/sig/whop_sdk/models/audience_delete_params.rbs +23 -0
  650. data/sig/whop_sdk/models/audience_delete_response.rbs +13 -0
  651. data/sig/whop_sdk/models/audience_list_params.rbs +42 -0
  652. data/sig/whop_sdk/models/authorized_user_create_params.rbs +52 -0
  653. data/sig/whop_sdk/models/bounty_create_params.rbs +56 -1
  654. data/sig/whop_sdk/models/bounty_create_response.rbs +2 -1
  655. data/sig/whop_sdk/models/bounty_list_params.rbs +2 -1
  656. data/sig/whop_sdk/models/bounty_list_response.rbs +2 -1
  657. data/sig/whop_sdk/models/bounty_retrieve_response.rbs +2 -1
  658. data/sig/whop_sdk/models/card_brands.rbs +2 -0
  659. data/sig/whop_sdk/models/card_create_params.rbs +85 -0
  660. data/sig/whop_sdk/models/card_create_response.rbs +200 -0
  661. data/sig/whop_sdk/models/card_list_params.rbs +32 -0
  662. data/sig/whop_sdk/models/card_list_response.rbs +214 -0
  663. data/sig/whop_sdk/models/card_retrieve_params.rbs +36 -0
  664. data/sig/whop_sdk/models/card_retrieve_response.rbs +200 -0
  665. data/sig/whop_sdk/models/card_update_params.rbs +164 -0
  666. data/sig/whop_sdk/models/card_update_response.rbs +200 -0
  667. data/sig/whop_sdk/models/chat_message_created_webhook_event.rbs +149 -0
  668. data/sig/whop_sdk/models/chat_reaction_created_webhook_event.rbs +154 -0
  669. data/sig/whop_sdk/models/checkout_configuration.rbs +16 -5
  670. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +206 -649
  671. data/sig/whop_sdk/models/checkout_configuration_create_response.rbs +196 -0
  672. data/sig/whop_sdk/models/checkout_configuration_delete_params.rbs +20 -0
  673. data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +66 -32
  674. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +88 -56
  675. data/sig/whop_sdk/models/checkout_configuration_retrieve_response.rbs +196 -0
  676. data/sig/whop_sdk/models/currency.rbs +6 -0
  677. data/sig/whop_sdk/models/deposit_create_params.rbs +83 -0
  678. data/sig/whop_sdk/models/deposit_create_response.rbs +187 -0
  679. data/sig/whop_sdk/models/deposit_list_params.rbs +23 -0
  680. data/sig/whop_sdk/models/deposit_list_response.rbs +87 -0
  681. data/sig/whop_sdk/models/dispute.rbs +4 -4
  682. data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
  683. data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
  684. data/sig/whop_sdk/models/event_create_params.rbs +639 -0
  685. data/sig/whop_sdk/models/{conversion_create_response.rbs → event_create_response.rbs} +2 -2
  686. data/sig/whop_sdk/models/event_list_params.rbs +68 -0
  687. data/sig/whop_sdk/models/event_list_response.rbs +231 -0
  688. data/sig/whop_sdk/models/file_create_params.rbs +4 -18
  689. data/sig/whop_sdk/models/file_create_response.rbs +4 -15
  690. data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
  691. data/sig/whop_sdk/models/file_visibility.rbs +14 -0
  692. data/sig/whop_sdk/models/financial_activity_list_params.rbs +98 -0
  693. data/sig/whop_sdk/models/financial_activity_list_response.rbs +935 -0
  694. data/sig/whop_sdk/models/granularities.rbs +16 -0
  695. data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
  696. data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
  697. data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
  698. data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
  699. data/sig/whop_sdk/models/invoice_create_params.rbs +20 -0
  700. data/sig/whop_sdk/models/invoice_update_params.rbs +10 -0
  701. data/sig/whop_sdk/models/ledger_account_funds_available_webhook_event.rbs +418 -0
  702. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
  703. data/sig/whop_sdk/models/media_asset.rbs +160 -0
  704. data/sig/whop_sdk/models/media_generate_params.rbs +99 -0
  705. data/sig/whop_sdk/models/media_retrieve_params.rbs +20 -0
  706. data/sig/whop_sdk/models/membership.rbs +19 -6
  707. data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
  708. data/sig/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbs +45 -0
  709. data/sig/whop_sdk/models/payment.rbs +161 -15
  710. data/sig/whop_sdk/models/payment_create_params.rbs +16 -6
  711. data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
  712. data/sig/whop_sdk/models/payment_list_response.rbs +104 -15
  713. data/sig/whop_sdk/models/payout_create_params.rbs +50 -0
  714. data/sig/whop_sdk/models/payout_create_response.rbs +139 -0
  715. data/sig/whop_sdk/models/payout_list_params.rbs +70 -0
  716. data/sig/whop_sdk/models/payout_list_response.rbs +153 -0
  717. data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +25 -4
  718. data/sig/whop_sdk/models/payouts/method_list_params.rbs +107 -0
  719. data/sig/whop_sdk/models/payouts/method_list_response.rbs +229 -0
  720. data/sig/whop_sdk/models/person_list_params.rbs +97 -0
  721. data/sig/whop_sdk/models/person_list_response.rbs +162 -0
  722. data/sig/whop_sdk/models/person_retrieve_params.rbs +42 -0
  723. data/sig/whop_sdk/models/person_retrieve_response.rbs +175 -0
  724. data/sig/whop_sdk/models/plan.rbs +325 -119
  725. data/sig/whop_sdk/models/plan_calculate_tax_params.rbs +344 -0
  726. data/sig/whop_sdk/models/plan_calculate_tax_response.rbs +67 -0
  727. data/sig/whop_sdk/models/plan_create_params.rbs +139 -98
  728. data/sig/whop_sdk/models/plan_list_params.rbs +93 -54
  729. data/sig/whop_sdk/models/plan_list_response.rbs +75 -126
  730. data/sig/whop_sdk/models/plan_update_params.rbs +115 -82
  731. data/sig/whop_sdk/models/product.rbs +5 -0
  732. data/sig/whop_sdk/models/product_create_params.rbs +33 -124
  733. data/sig/whop_sdk/models/product_list_item.rbs +5 -0
  734. data/sig/whop_sdk/models/product_list_params.rbs +53 -48
  735. data/sig/whop_sdk/models/product_update_params.rbs +15 -88
  736. data/sig/whop_sdk/models/referral_referred_users_params.rbs +63 -0
  737. data/sig/whop_sdk/models/referral_referred_users_response.rbs +140 -0
  738. data/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs +46 -0
  739. data/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs +221 -0
  740. data/sig/whop_sdk/models/referrals/business_list_params.rbs +176 -0
  741. data/sig/whop_sdk/models/referrals/business_list_response.rbs +267 -0
  742. data/sig/whop_sdk/models/referrals/business_retrieve_params.rbs +22 -0
  743. data/sig/whop_sdk/models/referrals/business_retrieve_response.rbs +677 -0
  744. data/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs +139 -0
  745. data/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs +288 -0
  746. data/sig/whop_sdk/models/referrals/partner_create_params.rbs +17 -0
  747. data/sig/whop_sdk/models/referrals/partner_create_response.rbs +21 -0
  748. data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
  749. data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
  750. data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
  751. data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
  752. data/sig/whop_sdk/models/result_label_keys.rbs +80 -0
  753. data/sig/whop_sdk/models/setup_intent.rbs +8 -3
  754. data/sig/whop_sdk/models/social_account.rbs +74 -0
  755. data/sig/whop_sdk/models/social_account_connect_params.rbs +69 -0
  756. data/sig/whop_sdk/models/social_account_connect_response.rbs +13 -0
  757. data/sig/whop_sdk/models/social_account_create_params.rbs +43 -0
  758. data/sig/whop_sdk/models/social_account_delete_params.rbs +36 -0
  759. data/sig/whop_sdk/models/social_account_delete_response.rbs +5 -0
  760. data/sig/whop_sdk/models/social_account_list_params.rbs +152 -0
  761. data/sig/whop_sdk/models/social_account_post.rbs +111 -0
  762. data/sig/whop_sdk/models/social_account_posts_params.rbs +52 -0
  763. data/sig/whop_sdk/models/social_account_posts_response.rbs +37 -0
  764. data/sig/whop_sdk/models/stat_list_params.rbs +14 -0
  765. data/sig/whop_sdk/models/stat_list_response.rbs +72 -0
  766. data/sig/whop_sdk/models/stat_retrieve_params.rbs +211 -0
  767. data/sig/whop_sdk/models/stat_retrieve_response.rbs +81 -0
  768. data/sig/whop_sdk/models/swap_create_params.rbs +72 -0
  769. data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
  770. data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
  771. data/sig/whop_sdk/models/swap_create_response.rbs +73 -0
  772. data/sig/whop_sdk/models/swap_list_params.rbs +23 -0
  773. data/sig/whop_sdk/models/swap_list_response.rbs +68 -0
  774. data/sig/whop_sdk/models/swap_retrieve_params.rbs +20 -0
  775. data/sig/whop_sdk/models/swap_retrieve_response.rbs +55 -0
  776. data/sig/whop_sdk/models/tax_identifier_type.rbs +4 -0
  777. data/sig/whop_sdk/models/transfer_create_params.rbs +47 -10
  778. data/sig/whop_sdk/models/transfer_create_response.rbs +366 -0
  779. data/sig/whop_sdk/models/transfer_list_params.rbs +77 -42
  780. data/sig/whop_sdk/models/transfer_list_response.rbs +14 -14
  781. data/sig/whop_sdk/models/{transfer.rbs → transfer_retrieve_response.rbs} +83 -78
  782. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +30 -22
  783. data/sig/whop_sdk/models/user.rbs +203 -16
  784. data/sig/whop_sdk/models/user_balance.rbs +171 -0
  785. data/sig/whop_sdk/models/user_check_access_response.rbs +19 -4
  786. data/sig/whop_sdk/models/user_list_params.rbs +30 -20
  787. data/sig/whop_sdk/models/user_retrieve_params.rbs +59 -4
  788. data/sig/whop_sdk/models/user_update_me_params.rbs +74 -0
  789. data/sig/whop_sdk/models/user_update_params.rbs +42 -24
  790. data/sig/whop_sdk/models/verification_create_params.rbs +364 -0
  791. data/sig/whop_sdk/models/verification_create_response.rbs +333 -0
  792. data/sig/whop_sdk/models/verification_list_params.rbs +40 -20
  793. data/sig/whop_sdk/models/verification_list_response.rbs +337 -20
  794. data/sig/whop_sdk/models/verification_retrieve_params.rbs +7 -4
  795. data/sig/whop_sdk/models/verification_retrieve_response.rbs +312 -14
  796. data/sig/whop_sdk/models/verification_update_params.rbs +570 -0
  797. data/sig/whop_sdk/models/verification_update_response.rbs +333 -0
  798. data/sig/whop_sdk/models/webhook_event.rbs +16 -0
  799. data/sig/whop_sdk/models/withdrawal.rbs +2 -0
  800. data/sig/whop_sdk/models/workforce/bounty_list_params.rbs +149 -0
  801. data/sig/whop_sdk/models/workforce/bounty_retrieve_params.rbs +22 -0
  802. data/sig/whop_sdk/models/workforce/workforce_bounty.rbs +232 -0
  803. data/sig/whop_sdk/models/workforce/workforce_bounty_list_item.rbs +227 -0
  804. data/sig/whop_sdk/models.rbs +151 -7
  805. data/sig/whop_sdk/resources/accounts/preferences.rbs +20 -0
  806. data/sig/whop_sdk/resources/accounts.rbs +76 -0
  807. data/sig/whop_sdk/resources/ad_campaigns.rbs +47 -15
  808. data/sig/whop_sdk/resources/ad_groups.rbs +77 -20
  809. data/sig/whop_sdk/resources/ad_reports.rbs +6 -4
  810. data/sig/whop_sdk/resources/ads.rbs +74 -12
  811. data/sig/whop_sdk/resources/apps.rbs +16 -0
  812. data/sig/whop_sdk/resources/audiences.rbs +28 -0
  813. data/sig/whop_sdk/resources/authorized_users.rbs +1 -0
  814. data/sig/whop_sdk/resources/bounties.rbs +4 -0
  815. data/sig/whop_sdk/resources/cards.rbs +47 -0
  816. data/sig/whop_sdk/resources/checkout_configurations.rbs +21 -11
  817. data/sig/whop_sdk/resources/deposits.rbs +20 -0
  818. data/sig/whop_sdk/resources/events.rbs +40 -0
  819. data/sig/whop_sdk/resources/files.rbs +1 -1
  820. data/sig/whop_sdk/resources/financial_activity.rbs +22 -0
  821. data/sig/whop_sdk/resources/media.rbs +22 -0
  822. data/sig/whop_sdk/resources/payments.rbs +1 -0
  823. data/sig/whop_sdk/resources/payouts/methods.rbs +23 -0
  824. data/sig/whop_sdk/resources/payouts.rbs +29 -0
  825. data/sig/whop_sdk/resources/people.rbs +28 -0
  826. data/sig/whop_sdk/resources/plans.rbs +37 -25
  827. data/sig/whop_sdk/resources/products.rbs +17 -31
  828. data/sig/whop_sdk/resources/referrals/businesses/earnings.rbs +25 -0
  829. data/sig/whop_sdk/resources/referrals/businesses.rbs +38 -0
  830. data/sig/whop_sdk/resources/referrals/partners.rbs +13 -0
  831. data/sig/whop_sdk/resources/referrals.rbs +21 -0
  832. data/sig/whop_sdk/resources/social_accounts.rbs +52 -0
  833. data/sig/whop_sdk/resources/stats.rbs +39 -0
  834. data/sig/whop_sdk/resources/swaps.rbs +41 -0
  835. data/sig/whop_sdk/resources/transfers.rbs +17 -14
  836. data/sig/whop_sdk/resources/users.rbs +26 -12
  837. data/sig/whop_sdk/resources/verifications.rbs +17 -7
  838. data/sig/whop_sdk/resources/webhooks.rbs +30 -22
  839. data/sig/whop_sdk/resources/workforce/bounties.rbs +30 -0
  840. data/sig/whop_sdk/resources/workforce.rbs +9 -0
  841. metadata +446 -65
  842. data/lib/whop_sdk/models/ad_campaign_list_response.rb +0 -126
  843. data/lib/whop_sdk/models/ad_campaign_pause_response.rb +0 -328
  844. data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
  845. data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
  846. data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
  847. data/lib/whop_sdk/models/ad_group_list_response.rb +0 -118
  848. data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
  849. data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
  850. data/lib/whop_sdk/models/ad_list_response.rb +0 -89
  851. data/lib/whop_sdk/models/ad_retrieve_response.rb +0 -133
  852. data/lib/whop_sdk/models/conversion_create_response.rb +0 -19
  853. data/lib/whop_sdk/models/payout_destination_category.rb +0 -20
  854. data/lib/whop_sdk/models/payout_method_list_params.rb +0 -54
  855. data/lib/whop_sdk/models/payout_method_list_response.rb +0 -140
  856. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +0 -140
  857. data/lib/whop_sdk/models/transfer.rb +0 -299
  858. data/lib/whop_sdk/models/user_list_response.rb +0 -83
  859. data/lib/whop_sdk/resources/conversions.rb +0 -67
  860. data/lib/whop_sdk/resources/payout_methods.rb +0 -76
  861. data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +0 -239
  862. data/rbi/whop_sdk/models/ad_campaign_pause_response.rbi +0 -668
  863. data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
  864. data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
  865. data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
  866. data/rbi/whop_sdk/models/ad_group_list_response.rbi +0 -228
  867. data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
  868. data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
  869. data/rbi/whop_sdk/models/ad_list_response.rbi +0 -146
  870. data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
  871. data/rbi/whop_sdk/models/conversion_create_params.rbi +0 -661
  872. data/rbi/whop_sdk/models/payout_destination_category.rbi +0 -33
  873. data/rbi/whop_sdk/models/payout_method_list_params.rbi +0 -75
  874. data/rbi/whop_sdk/models/payout_method_list_response.rbi +0 -234
  875. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +0 -238
  876. data/rbi/whop_sdk/models/transfer.rbi +0 -407
  877. data/rbi/whop_sdk/models/user_list_response.rbi +0 -124
  878. data/rbi/whop_sdk/resources/conversions.rbi +0 -71
  879. data/rbi/whop_sdk/resources/payout_methods.rbi +0 -66
  880. data/sig/whop_sdk/models/ad_campaign_list_response.rbs +0 -98
  881. data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
  882. data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
  883. data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
  884. data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
  885. data/sig/whop_sdk/models/ad_group_list_response.rbs +0 -93
  886. data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
  887. data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
  888. data/sig/whop_sdk/models/ad_list_response.rbs +0 -72
  889. data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
  890. data/sig/whop_sdk/models/conversion_create_params.rbs +0 -349
  891. data/sig/whop_sdk/models/payout_destination_category.rbs +0 -19
  892. data/sig/whop_sdk/models/payout_method_list_params.rbs +0 -46
  893. data/sig/whop_sdk/models/payout_method_list_response.rbs +0 -97
  894. data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +0 -97
  895. data/sig/whop_sdk/models/user_list_response.rbs +0 -55
  896. data/sig/whop_sdk/resources/conversions.rbs +0 -25
  897. data/sig/whop_sdk/resources/payout_methods.rbs +0 -21
@@ -2,50 +2,118 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Resources
5
- # Ad campaigns
5
+ # An Ad Campaign is the top-level container for paid ads on an ad network. It sets
6
+ # the platform, objective, and budget strategy shared by its
7
+ # [ad groups](/api-reference/beta/ad-groups/ad-group) and ads.
8
+ #
9
+ # Use the Ad Campaigns API to create campaigns, list campaigns for an account,
10
+ # retrieve or update campaign settings, and pause or resume campaign delivery.
6
11
  class AdCampaigns
7
- # Retrieves a single ad campaign by its unique identifier.
12
+ # Some parameter documentations has been truncated, see
13
+ # {WhopSDK::Models::AdCampaignCreateParams} for more details.
14
+ #
15
+ # Creates an ad campaign for an account.
16
+ #
17
+ # @overload create(objective:, platform:, title:, account_id: nil, bid_type: nil, budget_amount: nil, budget_optimization: nil, budget_type: nil, desired_cost_per_result: nil, ends_at: nil, special_ad_categories: nil, starts_at: nil, request_options: {})
18
+ #
19
+ # @param objective [Symbol, WhopSDK::Models::AdCampaignCreateParams::Objective] The goal the campaign optimizes toward.
20
+ #
21
+ # @param platform [Symbol, WhopSDK::Models::AdCampaignCreateParams::Platform] The ad network the campaign runs on.
22
+ #
23
+ # @param title [String] The title of the campaign.
24
+ #
25
+ # @param account_id [String] The account to create the campaign under. Defaults to the account-scoped key's o
8
26
  #
9
- # Required permissions:
27
+ # @param bid_type [Symbol, WhopSDK::Models::AdCampaignCreateParams::BidType] CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maxi
10
28
  #
11
- # - `ad_campaign:basic:read`
29
+ # @param budget_amount [Float] The campaign budget, in USD. Required for CBO (budget_optimization: ad_campaign)
12
30
  #
13
- # @overload retrieve(id, request_options: {})
31
+ # @param budget_optimization [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetOptimization] Which level owns the budget — the campaign (CBO) or each ad group (ABO). Default
14
32
  #
15
- # @param id [String] The unique identifier of the ad campaign.
33
+ # @param budget_type [Symbol, WhopSDK::Models::AdCampaignCreateParams::BudgetType] Whether the budget is spent per day or over the campaign's lifetime. Defaults to
34
+ #
35
+ # @param desired_cost_per_result [Float] Target/cap cost per result in USD for average_target / maximum_target bidding. C
36
+ #
37
+ # @param ends_at [String] Campaign schedule end (ISO 8601). CBO only.
38
+ #
39
+ # @param special_ad_categories [Array<Symbol, WhopSDK::Models::AdCampaignCreateParams::SpecialAdCategory>] Regulated categories the campaign falls under. Ads in these categories are subje
40
+ #
41
+ # @param starts_at [String] Campaign schedule start (ISO 8601). CBO only.
16
42
  #
17
43
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
18
44
  #
19
- # @return [WhopSDK::Models::AdCampaignRetrieveResponse]
45
+ # @return [WhopSDK::Models::AdCampaign]
46
+ #
47
+ # @see WhopSDK::Models::AdCampaignCreateParams
48
+ def create(params)
49
+ parsed, options = WhopSDK::AdCampaignCreateParams.dump_request(params)
50
+ @client.request(
51
+ method: :post,
52
+ path: "ad_campaigns",
53
+ body: parsed,
54
+ model: WhopSDK::AdCampaign,
55
+ options: options
56
+ )
57
+ end
58
+
59
+ # Retrieves a single ad campaign with stats over the requested window.
60
+ #
61
+ # @overload retrieve(id, stats_from: nil, stats_to: nil, time_zone: nil, request_options: {})
62
+ #
63
+ # @param id [String] The ad campaign ID.
64
+ #
65
+ # @param stats_from [String] Start of the stats window.
66
+ #
67
+ # @param stats_to [String] End of the stats window.
68
+ #
69
+ # @param time_zone [String] IANA timezone the stats window is interpreted in. Defaults to UTC.
70
+ #
71
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
72
+ #
73
+ # @return [WhopSDK::Models::AdCampaign]
20
74
  #
21
75
  # @see WhopSDK::Models::AdCampaignRetrieveParams
22
76
  def retrieve(id, params = {})
77
+ parsed, options = WhopSDK::AdCampaignRetrieveParams.dump_request(params)
78
+ query = WhopSDK::Internal::Util.encode_query_params(parsed)
23
79
  @client.request(
24
80
  method: :get,
25
81
  path: ["ad_campaigns/%1$s", id],
26
- model: WhopSDK::Models::AdCampaignRetrieveResponse,
27
- options: params[:request_options]
82
+ query: query,
83
+ model: WhopSDK::AdCampaign,
84
+ options: options
28
85
  )
29
86
  end
30
87
 
31
88
  # Some parameter documentations has been truncated, see
32
89
  # {WhopSDK::Models::AdCampaignUpdateParams} for more details.
33
90
  #
34
- # Updates an ad campaign synchronously.
91
+ # Updates an ad campaign's editable fields (title, budget, schedule, bid strategy,
92
+ # and — before launch — budget optimization), and launches a draft campaign by
93
+ # setting status to active. Objective, budget type, special ad categories and
94
+ # desired cost per result are fixed at creation and cannot be changed.
95
+ #
96
+ # @overload update(id, bid_type: nil, budget_amount: nil, budget_optimization: nil, ends_at: nil, starts_at: nil, status: nil, title: nil, request_options: {})
97
+ #
98
+ # @param id [String] The ad campaign ID.
35
99
  #
36
- # Required permissions:
100
+ # @param bid_type [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BidType] CBO bid strategy: minimum_cost (lowest cost), average_target (cost cap), or maxi
37
101
  #
38
- # - `ad_campaign:update`
102
+ # @param budget_amount [Float] The campaign budget, in the account's currency. Interpreted as daily or lifetime
39
103
  #
40
- # @overload update(id, budget: nil, request_options: {})
104
+ # @param budget_optimization [Symbol, WhopSDK::Models::AdCampaignUpdateParams::BudgetOptimization] Which level owns the budget the campaign (CBO) or each ad group (ABO). Only ch
41
105
  #
42
- # @param id [String] The unique identifier of the ad campaign to update.
106
+ # @param ends_at [String] Campaign schedule end (ISO 8601). CBO only.
43
107
  #
44
- # @param budget [Float, nil] The campaign budget in dollars. The interpretation (daily or lifetime) follows t
108
+ # @param starts_at [String] Campaign schedule start (ISO 8601). CBO only.
109
+ #
110
+ # @param status [Symbol, WhopSDK::Models::AdCampaignUpdateParams::Status] Set to active to launch a draft campaign (moderates and pushes it live). Live-ca
111
+ #
112
+ # @param title [String] The name of the campaign.
45
113
  #
46
114
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
47
115
  #
48
- # @return [WhopSDK::Models::AdCampaignUpdateResponse]
116
+ # @return [WhopSDK::Models::AdCampaign]
49
117
  #
50
118
  # @see WhopSDK::Models::AdCampaignUpdateParams
51
119
  def update(id, params = {})
@@ -54,44 +122,52 @@ module WhopSDK
54
122
  method: :patch,
55
123
  path: ["ad_campaigns/%1$s", id],
56
124
  body: parsed,
57
- model: WhopSDK::Models::AdCampaignUpdateResponse,
125
+ model: WhopSDK::AdCampaign,
58
126
  options: options
59
127
  )
60
128
  end
61
129
 
62
- # Returns a paginated list of ad campaigns for a company, with optional filtering
63
- # by status, and creation date.
130
+ # Some parameter documentations has been truncated, see
131
+ # {WhopSDK::Models::AdCampaignListParams} for more details.
132
+ #
133
+ # Lists the ad campaigns for an account, with stats over the requested window.
134
+ #
135
+ # @overload list(account_id: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, stats_from: nil, stats_to: nil, status: nil, time_zone: nil, request_options: {})
136
+ #
137
+ # @param account_id [String] The account the campaigns belong to. Defaults to the account-scoped key's own ac
64
138
  #
65
- # Required permissions:
139
+ # @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
66
140
  #
67
- # - `ad_campaign:basic:read`
141
+ # @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
68
142
  #
69
- # @overload list(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
143
+ # @param created_after [String] Only return campaigns created after this timestamp.
70
144
  #
71
- # @param company_id [String] The unique identifier of the company to list ad campaigns for.
145
+ # @param created_before [String] Only return campaigns created before this timestamp.
72
146
  #
73
- # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
147
+ # @param direction [Symbol, WhopSDK::Models::AdCampaignListParams::Direction] The sort direction. Defaults to desc.
74
148
  #
75
- # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
149
+ # @param first [Integer] The number of campaigns to return.
76
150
  #
77
- # @param created_after [Time, nil] Only return ad campaigns created after this timestamp.
151
+ # @param last [Integer] The number of campaigns to return from the end of the range.
78
152
  #
79
- # @param created_before [Time, nil] Only return ad campaigns created before this timestamp.
153
+ # @param order [Symbol, WhopSDK::Models::AdCampaignListParams::Order] The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
80
154
  #
81
- # @param first [Integer, nil] Returns the first _n_ elements from the list.
155
+ # @param query [String] Filter campaigns by a title or ID substring.
82
156
  #
83
- # @param last [Integer, nil] Returns the last _n_ elements from the list.
157
+ # @param stats_from [String] Start of the stats window. Defaults to all-time.
84
158
  #
85
- # @param query [String, nil] Case-insensitive substring match against the campaign title.
159
+ # @param stats_to [String] End of the stats window. Defaults to now.
86
160
  #
87
- # @param status [Symbol, WhopSDK::Models::AdCampaignListParams::Status, nil] The status of an ad campaign.
161
+ # @param status [Symbol, WhopSDK::Models::AdCampaignListParams::Status] Only return campaigns with this status.
162
+ #
163
+ # @param time_zone [String] IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare s
88
164
  #
89
165
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
90
166
  #
91
- # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AdCampaignListResponse>]
167
+ # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AdCampaign>]
92
168
  #
93
169
  # @see WhopSDK::Models::AdCampaignListParams
94
- def list(params)
170
+ def list(params = {})
95
171
  parsed, options = WhopSDK::AdCampaignListParams.dump_request(params)
96
172
  query = WhopSDK::Internal::Util.encode_query_params(parsed)
97
173
  @client.request(
@@ -99,55 +175,68 @@ module WhopSDK
99
175
  path: "ad_campaigns",
100
176
  query: query,
101
177
  page: WhopSDK::Internal::CursorPage,
102
- model: WhopSDK::Models::AdCampaignListResponse,
178
+ model: WhopSDK::AdCampaign,
103
179
  options: options
104
180
  )
105
181
  end
106
182
 
107
- # Pauses an ad campaign, optionally until a specific date.
183
+ # Deletes an ad campaign and archives it on the ad platform (cascades to ad groups
184
+ # and ads). Returns true on success.
185
+ #
186
+ # @overload delete(id, request_options: {})
108
187
  #
109
- # Required permissions:
188
+ # @param id [String] The ad campaign ID.
189
+ #
190
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
110
191
  #
111
- # - `ad_campaign:update`
192
+ # @return [Boolean]
193
+ #
194
+ # @see WhopSDK::Models::AdCampaignDeleteParams
195
+ def delete(id, params = {})
196
+ @client.request(
197
+ method: :delete,
198
+ path: ["ad_campaigns/%1$s", id],
199
+ model: WhopSDK::Internal::Type::Boolean,
200
+ options: params[:request_options]
201
+ )
202
+ end
203
+
204
+ # Pauses an active ad campaign.
112
205
  #
113
206
  # @overload pause(id, request_options: {})
114
207
  #
115
- # @param id [String] The unique identifier of the ad campaign to pause.
208
+ # @param id [String] The ad campaign ID.
116
209
  #
117
210
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
118
211
  #
119
- # @return [WhopSDK::Models::AdCampaignPauseResponse]
212
+ # @return [WhopSDK::Models::AdCampaign]
120
213
  #
121
214
  # @see WhopSDK::Models::AdCampaignPauseParams
122
215
  def pause(id, params = {})
123
216
  @client.request(
124
217
  method: :post,
125
218
  path: ["ad_campaigns/%1$s/pause", id],
126
- model: WhopSDK::Models::AdCampaignPauseResponse,
219
+ model: WhopSDK::AdCampaign,
127
220
  options: params[:request_options]
128
221
  )
129
222
  end
130
223
 
131
224
  # Resumes a paused ad campaign.
132
225
  #
133
- # Required permissions:
134
- #
135
- # - `ad_campaign:update`
136
- #
137
226
  # @overload unpause(id, request_options: {})
138
227
  #
139
- # @param id [String] The unique identifier of the ad campaign to unpause.
228
+ # @param id [String] The ad campaign ID.
140
229
  #
141
230
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
142
231
  #
143
- # @return [WhopSDK::Models::AdCampaignUnpauseResponse]
232
+ # @return [WhopSDK::Models::AdCampaign]
144
233
  #
145
234
  # @see WhopSDK::Models::AdCampaignUnpauseParams
146
235
  def unpause(id, params = {})
147
236
  @client.request(
148
237
  method: :post,
149
238
  path: ["ad_campaigns/%1$s/unpause", id],
150
- model: WhopSDK::Models::AdCampaignUnpauseResponse,
239
+ model: WhopSDK::AdCampaign,
151
240
  options: params[:request_options]
152
241
  )
153
242
  end
@@ -2,60 +2,163 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Resources
5
- # Ad groups
5
+ # An Ad Group sits inside an
6
+ # [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls
7
+ # delivery for [ads](/api-reference/beta/ads/ad). It sets the audience,
8
+ # placements, schedule, budget, and optimization goal for its ads.
9
+ #
10
+ # Use the Ad Groups API to create ad groups in campaigns, list or retrieve
11
+ # targeting and delivery settings, update budgets or targeting, delete groups that
12
+ # should stop running, and pause or resume delivery.
6
13
  class AdGroups
7
- # Retrieves a single ad group by its unique identifier.
14
+ # Some parameter documentations has been truncated, see
15
+ # {WhopSDK::Models::AdGroupCreateParams} for more details.
8
16
  #
9
- # Required permissions:
17
+ # Creates an ad group (ad set) in a campaign.
10
18
  #
11
- # - `ad_campaign:basic:read`
19
+ # @overload create(ad_campaign_id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, dynamic_creative: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {})
12
20
  #
13
- # @overload retrieve(id, request_options: {})
21
+ # @param ad_campaign_id [String] The ad campaign to create the ad group in.
14
22
  #
15
- # @param id [String] The unique identifier of the ad group.
23
+ # @param audiences [Object] Saved-audience targeting: { include, exclude } arrays of audience IDs. Incompati
24
+ #
25
+ # @param bid_type [Symbol, WhopSDK::Models::AdGroupCreateParams::BidType] Bid strategy.
26
+ #
27
+ # @param budget_amount [Float] Ad-set budget in dollars (ABO only; omit under CBO).
28
+ #
29
+ # @param budget_type [Symbol, WhopSDK::Models::AdGroupCreateParams::BudgetType] Whether the budget is daily or lifetime.
30
+ #
31
+ # @param conversion_event [Symbol, String, WhopSDK::Models::AdGroupCreateParams::ConversionEvent, nil] The pixel event optimized for. A standard event, or any custom pixel event name.
32
+ #
33
+ # @param conversion_location [Symbol, WhopSDK::Models::AdGroupCreateParams::ConversionLocation] Where results happen: website (conversions), profile (IG/FB engagement), messagi
34
+ #
35
+ # @param demographics [Object] Demographic targeting: { automatic, minimum_age, maximum_age, gender }.
36
+ #
37
+ # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target.
38
+ #
39
+ # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }.
40
+ #
41
+ # @param dynamic_creative [Boolean] Run Meta dynamic (Advantage+) creative for this ad set. Set at creation; immutab
42
+ #
43
+ # @param ends_at [String] Schedule end, ISO 8601.
44
+ #
45
+ # @param frequency_cap [Object] { maximum_impressions, per_days } — only valid for reach optimization.
46
+ #
47
+ # @param languages [Array<String>] Languages to target as ISO 639 codes (e.g. en, es). Empty/omitted = all language
48
+ #
49
+ # @param message_apps [Array<Symbol, WhopSDK::Models::AdGroupCreateParams::MessageApp>] Required when conversion_location is messaging: which apps to message on. Combin
50
+ #
51
+ # @param minimum_daily_spend [Float] Daily spend floor within the budget.
52
+ #
53
+ # @param optimization_goal [String] What the ad group optimizes for (e.g. conversions, link_clicks, reach).
54
+ #
55
+ # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to
56
+ #
57
+ # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr
58
+ #
59
+ # @param starts_at [String] Schedule start, ISO 8601.
60
+ #
61
+ # @param status [Symbol, WhopSDK::Models::AdGroupCreateParams::Status] Initial status (default: active).
62
+ #
63
+ # @param title [String] The display name of the ad group.
16
64
  #
17
65
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
18
66
  #
19
- # @return [WhopSDK::Models::AdGroupRetrieveResponse]
67
+ # @return [WhopSDK::Models::AdGroup]
68
+ #
69
+ # @see WhopSDK::Models::AdGroupCreateParams
70
+ def create(params)
71
+ parsed, options = WhopSDK::AdGroupCreateParams.dump_request(params)
72
+ @client.request(
73
+ method: :post,
74
+ path: "ad_groups",
75
+ body: parsed,
76
+ model: WhopSDK::AdGroup,
77
+ options: options
78
+ )
79
+ end
80
+
81
+ # Retrieves a single ad group.
82
+ #
83
+ # @overload retrieve(id, stats_from: nil, stats_to: nil, time_zone: nil, request_options: {})
84
+ #
85
+ # @param id [String] The ad group ID.
86
+ #
87
+ # @param stats_from [String] Start of the stats window.
88
+ #
89
+ # @param stats_to [String] End of the stats window.
90
+ #
91
+ # @param time_zone [String] IANA timezone the stats window is interpreted in. Defaults to UTC.
92
+ #
93
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
94
+ #
95
+ # @return [WhopSDK::Models::AdGroup]
20
96
  #
21
97
  # @see WhopSDK::Models::AdGroupRetrieveParams
22
98
  def retrieve(id, params = {})
99
+ parsed, options = WhopSDK::AdGroupRetrieveParams.dump_request(params)
100
+ query = WhopSDK::Internal::Util.encode_query_params(parsed)
23
101
  @client.request(
24
102
  method: :get,
25
103
  path: ["ad_groups/%1$s", id],
26
- model: WhopSDK::Models::AdGroupRetrieveResponse,
27
- options: params[:request_options]
104
+ query: query,
105
+ model: WhopSDK::AdGroup,
106
+ options: options
28
107
  )
29
108
  end
30
109
 
31
- # Updates an existing ad group.
110
+ # Some parameter documentations has been truncated, see
111
+ # {WhopSDK::Models::AdGroupUpdateParams} for more details.
32
112
  #
33
- # Required permissions:
113
+ # Updates an ad group's editable fields. Only the keys you send are changed.
34
114
  #
35
- # - `ad_campaign:update`
36
- # - `ad_campaign:basic:read`
115
+ # @overload update(id, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {})
37
116
  #
38
- # @overload update(id, budget: nil, budget_type: nil, config: nil, daily_budget: nil, name: nil, platform_config: nil, status: nil, request_options: {})
117
+ # @param id [String] The ad group ID.
39
118
  #
40
- # @param id [String] The unique identifier of the ad group to update.
119
+ # @param audiences [Object] Saved-audience targeting: { include, exclude } arrays of audience IDs. Incompati
41
120
  #
42
- # @param budget [Float, nil] Budget amount in dollars.
121
+ # @param bid_type [Symbol, WhopSDK::Models::AdGroupUpdateParams::BidType] Bid strategy.
43
122
  #
44
- # @param budget_type [Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType, nil] The budget type for an ad campaign or ad group.
123
+ # @param budget_amount [Float] Ad-set budget in dollars (ABO only; omit under CBO).
45
124
  #
46
- # @param config [WhopSDK::Models::AdGroupUpdateParams::Config, nil] Unified ad group configuration (bidding, optimization, targeting).
125
+ # @param budget_type [Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType] Whether the budget is daily or lifetime.
47
126
  #
48
- # @param daily_budget [Float, nil] Daily budget in dollars.
127
+ # @param conversion_event [Symbol, String, WhopSDK::Models::AdGroupUpdateParams::ConversionEvent, nil] The pixel event optimized for. A standard event, or any custom pixel event name.
49
128
  #
50
- # @param name [String, nil] Human-readable ad group name.
129
+ # @param conversion_location [Symbol, WhopSDK::Models::AdGroupUpdateParams::ConversionLocation] Where results happen: website (conversions), profile (IG/FB engagement), messagi
51
130
  #
52
- # @param platform_config [WhopSDK::Models::AdGroupUpdateParams::PlatformConfig, nil] Platform-specific ad group configuration.
131
+ # @param demographics [Object] Demographic targeting: { automatic, minimum_age, maximum_age, gender }.
53
132
  #
54
- # @param status [Symbol, WhopSDK::Models::AdGroupUpdateParams::Status, nil] The status of an external ad group.
133
+ # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target.
134
+ #
135
+ # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }.
136
+ #
137
+ # @param ends_at [String] Schedule end, ISO 8601.
138
+ #
139
+ # @param frequency_cap [Object] { maximum_impressions, per_days } — only valid for reach optimization.
140
+ #
141
+ # @param languages [Array<String>] Languages to target as ISO 639 codes (e.g. en, es). Empty/omitted = all language
142
+ #
143
+ # @param message_apps [Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::MessageApp>] Required when conversion_location is messaging: which apps to message on. Combin
144
+ #
145
+ # @param minimum_daily_spend [Float] Daily spend floor within the budget.
146
+ #
147
+ # @param optimization_goal [String] What the ad group optimizes for (e.g. conversions, link_clicks, reach).
148
+ #
149
+ # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to
150
+ #
151
+ # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr
152
+ #
153
+ # @param starts_at [String] Schedule start, ISO 8601.
154
+ #
155
+ # @param status [Symbol, WhopSDK::Models::AdGroupUpdateParams::Status] Initial status (default: active).
156
+ #
157
+ # @param title [String] The display name of the ad group.
55
158
  #
56
159
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
57
160
  #
58
- # @return [WhopSDK::Models::AdGroupUpdateResponse]
161
+ # @return [WhopSDK::Models::AdGroup]
59
162
  #
60
163
  # @see WhopSDK::Models::AdGroupUpdateParams
61
164
  def update(id, params = {})
@@ -64,43 +167,51 @@ module WhopSDK
64
167
  method: :patch,
65
168
  path: ["ad_groups/%1$s", id],
66
169
  body: parsed,
67
- model: WhopSDK::Models::AdGroupUpdateResponse,
170
+ model: WhopSDK::AdGroup,
68
171
  options: options
69
172
  )
70
173
  end
71
174
 
72
- # Returns a paginated list of ad groups scoped by campaign or company, with
73
- # optional filtering by status and creation date.
175
+ # Some parameter documentations has been truncated, see
176
+ # {WhopSDK::Models::AdGroupListParams} for more details.
177
+ #
178
+ # Lists ad groups for the account, newest first.
179
+ #
180
+ # @overload list(account_id: nil, ad_campaign_id: nil, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, stats_from: nil, stats_to: nil, status: nil, time_zone: nil, request_options: {})
181
+ #
182
+ # @param account_id [String] Account whose ad groups to list. Defaults to the authenticated account.
74
183
  #
75
- # Required permissions:
184
+ # @param ad_campaign_id [String] Filter to ad groups in this campaign.
76
185
  #
77
- # - `ad_campaign:basic:read`
186
+ # @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
78
187
  #
79
- # @overload list(after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, query: nil, status: nil, request_options: {})
188
+ # @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
80
189
  #
81
- # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
190
+ # @param created_after [String] Only return ad groups created after this timestamp.
82
191
  #
83
- # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
192
+ # @param created_before [String] Only return ad groups created before this timestamp.
84
193
  #
85
- # @param campaign_id [String, nil] Filter by campaign. Provide exactly one of campaign_id or company_id.
194
+ # @param direction [Symbol, WhopSDK::Models::AdGroupListParams::Direction] The sort direction. Defaults to desc.
86
195
  #
87
- # @param company_id [String, nil] Filter by company. Provide exactly one of campaign_id or company_id.
196
+ # @param first [Integer] The number of ad groups to return.
88
197
  #
89
- # @param created_after [Time, nil] Only return ad groups created after this timestamp.
198
+ # @param last [Integer] The number of ad groups to return from the end of the range.
90
199
  #
91
- # @param created_before [Time, nil] Only return ad groups created before this timestamp.
200
+ # @param order [Symbol, WhopSDK::Models::AdGroupListParams::Order] The field to sort by. Defaults to created_at. Stat columns (spend, impressions,
92
201
  #
93
- # @param first [Integer, nil] Returns the first _n_ elements from the list.
202
+ # @param query [String] Filter ad groups by a title or ID substring.
94
203
  #
95
- # @param last [Integer, nil] Returns the last _n_ elements from the list.
204
+ # @param stats_from [String] Start of the stats window. Defaults to all-time.
96
205
  #
97
- # @param query [String, nil] Case-insensitive substring match against the ad group name.
206
+ # @param stats_to [String] End of the stats window. Defaults to now.
98
207
  #
99
- # @param status [Symbol, WhopSDK::Models::AdGroupListParams::Status, nil] The status of an external ad group.
208
+ # @param status [String] Filter to a status (active, paused, in_review, rejected).
209
+ #
210
+ # @param time_zone [String] IANA timezone (e.g. America/New_York) the stats window is interpreted in. Bare s
100
211
  #
101
212
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
102
213
  #
103
- # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AdGroupListResponse>]
214
+ # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::AdGroup>]
104
215
  #
105
216
  # @see WhopSDK::Models::AdGroupListParams
106
217
  def list(params = {})
@@ -111,20 +222,16 @@ module WhopSDK
111
222
  path: "ad_groups",
112
223
  query: query,
113
224
  page: WhopSDK::Internal::CursorPage,
114
- model: WhopSDK::Models::AdGroupListResponse,
225
+ model: WhopSDK::AdGroup,
115
226
  options: options
116
227
  )
117
228
  end
118
229
 
119
- # Soft-deletes an ad group.
120
- #
121
- # Required permissions:
122
- #
123
- # - `ad_campaign:update`
230
+ # Deletes an ad group. Returns true on success.
124
231
  #
125
232
  # @overload delete(id, request_options: {})
126
233
  #
127
- # @param id [String] The unique identifier of the ad group to delete.
234
+ # @param id [String] The ad group ID.
128
235
  #
129
236
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
130
237
  #
@@ -140,6 +247,46 @@ module WhopSDK
140
247
  )
141
248
  end
142
249
 
250
+ # Pauses delivery of an ad group.
251
+ #
252
+ # @overload pause(id, request_options: {})
253
+ #
254
+ # @param id [String] The ad group ID.
255
+ #
256
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
257
+ #
258
+ # @return [WhopSDK::Models::AdGroup]
259
+ #
260
+ # @see WhopSDK::Models::AdGroupPauseParams
261
+ def pause(id, params = {})
262
+ @client.request(
263
+ method: :post,
264
+ path: ["ad_groups/%1$s/pause", id],
265
+ model: WhopSDK::AdGroup,
266
+ options: params[:request_options]
267
+ )
268
+ end
269
+
270
+ # Resumes delivery of a paused ad group.
271
+ #
272
+ # @overload unpause(id, request_options: {})
273
+ #
274
+ # @param id [String] The ad group ID.
275
+ #
276
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
277
+ #
278
+ # @return [WhopSDK::Models::AdGroup]
279
+ #
280
+ # @see WhopSDK::Models::AdGroupUnpauseParams
281
+ def unpause(id, params = {})
282
+ @client.request(
283
+ method: :post,
284
+ path: ["ad_groups/%1$s/unpause", id],
285
+ model: WhopSDK::AdGroup,
286
+ options: params[:request_options]
287
+ )
288
+ end
289
+
143
290
  # @api private
144
291
  #
145
292
  # @param client [WhopSDK::Client]