whop_sdk 0.0.39 → 0.0.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (313) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +18 -2
  5. data/lib/whop_sdk/internal/transport/base_client.rb +2 -0
  6. data/lib/whop_sdk/internal/type/union.rb +6 -6
  7. data/lib/whop_sdk/models/account.rb +144 -0
  8. data/lib/whop_sdk/models/account_create_params.rb +34 -0
  9. data/lib/whop_sdk/models/account_list_params.rb +34 -0
  10. data/lib/whop_sdk/models/account_list_response.rb +66 -0
  11. data/lib/whop_sdk/models/account_me_params.rb +14 -0
  12. data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
  13. data/lib/whop_sdk/models/account_social_link.rb +60 -0
  14. data/lib/whop_sdk/models/account_update_params.rb +146 -0
  15. data/lib/whop_sdk/models/account_wallet.rb +46 -0
  16. data/lib/whop_sdk/models/{ad_retrieve_response.rb → ad.rb} +15 -45
  17. data/lib/whop_sdk/models/ad_budget_type.rb +16 -0
  18. data/lib/whop_sdk/models/{ad_campaign_pause_response.rb → ad_campaign.rb} +37 -86
  19. data/lib/whop_sdk/models/ad_campaign_list_params.rb +12 -27
  20. data/lib/whop_sdk/models/ad_campaign_list_response.rb +9 -52
  21. data/lib/whop_sdk/models/ad_campaign_platform.rb +16 -0
  22. data/lib/whop_sdk/models/ad_campaign_status.rb +20 -0
  23. data/lib/whop_sdk/models/ad_group.rb +97 -0
  24. data/lib/whop_sdk/models/ad_group_list_params.rb +16 -19
  25. data/lib/whop_sdk/models/ad_group_list_response.rb +30 -51
  26. data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
  27. data/lib/whop_sdk/models/ad_group_status.rb +20 -0
  28. data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
  29. data/lib/whop_sdk/models/ad_group_update_params.rb +8 -32
  30. data/lib/whop_sdk/models/ad_list_params.rb +57 -12
  31. data/lib/whop_sdk/models/ad_list_response.rb +45 -31
  32. data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
  33. data/lib/whop_sdk/models/ad_report_retrieve_params.rb +45 -15
  34. data/lib/whop_sdk/models/ad_report_retrieve_response.rb +378 -105
  35. data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
  36. data/lib/whop_sdk/models/checkout_configuration.rb +22 -1
  37. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +26 -1
  38. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +24 -1
  39. data/lib/whop_sdk/models/currency.rb +3 -0
  40. data/lib/whop_sdk/models/deposit_create_params.rb +85 -0
  41. data/lib/whop_sdk/models/deposit_create_response.rb +102 -0
  42. data/lib/whop_sdk/models/dispute.rb +6 -7
  43. data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
  44. data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
  45. data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
  46. data/lib/whop_sdk/models/external_ad_status.rb +20 -0
  47. data/lib/whop_sdk/models/file_create_params.rb +3 -15
  48. data/lib/whop_sdk/models/file_create_response.rb +3 -16
  49. data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
  50. data/lib/whop_sdk/models/file_visibility.rb +17 -0
  51. data/lib/whop_sdk/models/granularities.rb +16 -0
  52. data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
  53. data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
  54. data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
  55. data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
  56. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +65 -1
  57. data/lib/whop_sdk/models/member_list_response.rb +3 -2
  58. data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
  59. data/lib/whop_sdk/models/membership.rb +23 -2
  60. data/lib/whop_sdk/models/membership_list_response.rb +23 -2
  61. data/lib/whop_sdk/models/payment.rb +47 -22
  62. data/lib/whop_sdk/models/payment_list_params.rb +9 -1
  63. data/lib/whop_sdk/models/payment_list_response.rb +40 -13
  64. data/lib/whop_sdk/models/plan.rb +31 -1
  65. data/lib/whop_sdk/models/plan_create_params.rb +30 -1
  66. data/lib/whop_sdk/models/plan_list_response.rb +31 -1
  67. data/lib/whop_sdk/models/plan_update_params.rb +30 -1
  68. data/lib/whop_sdk/models/product.rb +10 -1
  69. data/lib/whop_sdk/models/product_create_params.rb +11 -1
  70. data/lib/whop_sdk/models/product_list_item.rb +10 -1
  71. data/lib/whop_sdk/models/product_update_params.rb +11 -1
  72. data/lib/whop_sdk/models/refund_created_webhook_event.rb +84 -5
  73. data/lib/whop_sdk/models/refund_retrieve_response.rb +82 -5
  74. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +84 -5
  75. data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
  76. data/lib/whop_sdk/models/result_label_keys.rb +38 -0
  77. data/lib/whop_sdk/models/swap_create_quote_params.rb +102 -0
  78. data/lib/whop_sdk/models/swap_create_quote_response.rb +104 -0
  79. data/lib/whop_sdk/models/transfer_create_params.rb +3 -1
  80. data/lib/whop_sdk/models/unwrap_webhook_event.rb +41 -33
  81. data/lib/whop_sdk/models/wallet_balance_params.rb +20 -0
  82. data/lib/whop_sdk/models/wallet_balance_response.rb +84 -0
  83. data/lib/whop_sdk/models/wallet_list_params.rb +14 -0
  84. data/lib/whop_sdk/models/wallet_list_response.rb +38 -0
  85. data/lib/whop_sdk/models/wallet_send_params.rb +37 -0
  86. data/lib/whop_sdk/models/wallet_send_response.rb +90 -0
  87. data/lib/whop_sdk/models/webhook_event.rb +4 -0
  88. data/lib/whop_sdk/models.rb +64 -0
  89. data/lib/whop_sdk/resources/accounts.rb +168 -0
  90. data/lib/whop_sdk/resources/ad_campaigns.rb +13 -13
  91. data/lib/whop_sdk/resources/ad_groups.rb +63 -8
  92. data/lib/whop_sdk/resources/ad_reports.rb +14 -8
  93. data/lib/whop_sdk/resources/ads.rb +66 -4
  94. data/lib/whop_sdk/resources/deposits.rb +46 -0
  95. data/lib/whop_sdk/resources/files.rb +1 -1
  96. data/lib/whop_sdk/resources/payments.rb +3 -1
  97. data/lib/whop_sdk/resources/plans.rb +10 -2
  98. data/lib/whop_sdk/resources/products.rb +6 -2
  99. data/lib/whop_sdk/resources/refunds.rb +2 -0
  100. data/lib/whop_sdk/resources/swaps.rb +52 -0
  101. data/lib/whop_sdk/resources/wallets.rb +78 -0
  102. data/lib/whop_sdk/resources/webhooks.rb +1 -1
  103. data/lib/whop_sdk/version.rb +1 -1
  104. data/lib/whop_sdk.rb +42 -7
  105. data/rbi/whop_sdk/client.rbi +14 -2
  106. data/rbi/whop_sdk/models/account.rbi +164 -0
  107. data/rbi/whop_sdk/models/account_create_params.rbi +59 -0
  108. data/rbi/whop_sdk/models/account_list_params.rbi +59 -0
  109. data/rbi/whop_sdk/models/account_list_response.rbi +115 -0
  110. data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
  111. data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
  112. data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
  113. data/rbi/whop_sdk/models/account_update_params.rbi +175 -0
  114. data/rbi/whop_sdk/models/account_wallet.rbi +75 -0
  115. data/rbi/whop_sdk/models/ad.rbi +143 -0
  116. data/rbi/whop_sdk/models/ad_budget_type.rbi +20 -0
  117. data/rbi/whop_sdk/models/{ad_campaign_pause_response.rbi → ad_campaign.rbi} +57 -245
  118. data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +11 -46
  119. data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +9 -143
  120. data/rbi/whop_sdk/models/ad_campaign_platform.rbi +22 -0
  121. data/rbi/whop_sdk/models/ad_campaign_status.rbi +27 -0
  122. data/rbi/whop_sdk/models/ad_group.rbi +126 -0
  123. data/rbi/whop_sdk/models/ad_group_list_params.rbi +13 -33
  124. data/rbi/whop_sdk/models/ad_group_list_response.rbi +41 -131
  125. data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
  126. data/rbi/whop_sdk/models/ad_group_status.rbi +24 -0
  127. data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
  128. data/rbi/whop_sdk/models/ad_group_update_params.rbi +16 -67
  129. data/rbi/whop_sdk/models/ad_list_params.rbi +59 -14
  130. data/rbi/whop_sdk/models/ad_list_response.rbi +74 -62
  131. data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
  132. data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +75 -19
  133. data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +537 -349
  134. data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
  135. data/rbi/whop_sdk/models/checkout_configuration.rbi +52 -0
  136. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +56 -1
  137. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +55 -0
  138. data/rbi/whop_sdk/models/currency.rbi +3 -0
  139. data/rbi/whop_sdk/models/deposit_create_params.rbi +152 -0
  140. data/rbi/whop_sdk/models/deposit_create_response.rbi +185 -0
  141. data/rbi/whop_sdk/models/dispute.rbi +7 -9
  142. data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
  143. data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
  144. data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
  145. data/rbi/whop_sdk/models/external_ad_status.rbi +26 -0
  146. data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
  147. data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
  148. data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
  149. data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
  150. data/rbi/whop_sdk/models/granularities.rbi +20 -0
  151. data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
  152. data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
  153. data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
  154. data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
  155. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +109 -3
  156. data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
  157. data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
  158. data/rbi/whop_sdk/models/membership.rbi +44 -5
  159. data/rbi/whop_sdk/models/membership_list_response.rbi +44 -5
  160. data/rbi/whop_sdk/models/payment.rbi +75 -36
  161. data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
  162. data/rbi/whop_sdk/models/payment_list_response.rbi +67 -24
  163. data/rbi/whop_sdk/models/plan.rbi +39 -0
  164. data/rbi/whop_sdk/models/plan_create_params.rbi +54 -0
  165. data/rbi/whop_sdk/models/plan_list_response.rbi +62 -0
  166. data/rbi/whop_sdk/models/plan_update_params.rbi +54 -0
  167. data/rbi/whop_sdk/models/product.rbi +10 -0
  168. data/rbi/whop_sdk/models/product_create_params.rbi +12 -0
  169. data/rbi/whop_sdk/models/product_list_item.rbi +10 -0
  170. data/rbi/whop_sdk/models/product_update_params.rbi +12 -0
  171. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +159 -5
  172. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +157 -5
  173. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +159 -5
  174. data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
  175. data/rbi/whop_sdk/models/result_label_keys.rbi +64 -0
  176. data/rbi/whop_sdk/models/swap_create_quote_params.rbi +134 -0
  177. data/rbi/whop_sdk/models/swap_create_quote_response.rbi +148 -0
  178. data/rbi/whop_sdk/models/transfer_create_params.rbi +6 -2
  179. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +25 -21
  180. data/rbi/whop_sdk/models/wallet_balance_params.rbi +35 -0
  181. data/rbi/whop_sdk/models/wallet_balance_response.rbi +145 -0
  182. data/rbi/whop_sdk/models/wallet_list_params.rbi +27 -0
  183. data/rbi/whop_sdk/models/wallet_list_response.rbi +66 -0
  184. data/rbi/whop_sdk/models/wallet_send_params.rbi +57 -0
  185. data/rbi/whop_sdk/models/wallet_send_response.rbi +146 -0
  186. data/rbi/whop_sdk/models/webhook_event.rbi +11 -0
  187. data/rbi/whop_sdk/models.rbi +68 -0
  188. data/rbi/whop_sdk/resources/accounts.rbi +137 -0
  189. data/rbi/whop_sdk/resources/ad_campaigns.rbi +8 -8
  190. data/rbi/whop_sdk/resources/ad_groups.rbi +47 -6
  191. data/rbi/whop_sdk/resources/ad_reports.rbi +23 -12
  192. data/rbi/whop_sdk/resources/ads.rbi +59 -2
  193. data/rbi/whop_sdk/resources/deposits.rbi +41 -0
  194. data/rbi/whop_sdk/resources/files.rbi +1 -2
  195. data/rbi/whop_sdk/resources/payments.rbi +3 -0
  196. data/rbi/whop_sdk/resources/plans.rbi +18 -0
  197. data/rbi/whop_sdk/resources/products.rbi +10 -0
  198. data/rbi/whop_sdk/resources/refunds.rbi +2 -0
  199. data/rbi/whop_sdk/resources/swaps.rbi +46 -0
  200. data/rbi/whop_sdk/resources/transfers.rbi +3 -1
  201. data/rbi/whop_sdk/resources/wallets.rbi +55 -0
  202. data/rbi/whop_sdk/resources/webhooks.rbi +25 -21
  203. data/sig/whop_sdk/client.rbs +8 -0
  204. data/sig/whop_sdk/models/account.rbs +100 -0
  205. data/sig/whop_sdk/models/account_create_params.rbs +32 -0
  206. data/sig/whop_sdk/models/account_list_params.rbs +32 -0
  207. data/sig/whop_sdk/models/account_list_response.rbs +62 -0
  208. data/sig/whop_sdk/models/account_me_params.rbs +14 -0
  209. data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
  210. data/sig/whop_sdk/models/account_social_link.rbs +62 -0
  211. data/sig/whop_sdk/models/account_update_params.rbs +111 -0
  212. data/sig/whop_sdk/models/account_wallet.rbs +42 -0
  213. data/sig/whop_sdk/models/ad.rbs +75 -0
  214. data/sig/whop_sdk/models/ad_budget_type.rbs +14 -0
  215. data/sig/whop_sdk/models/ad_campaign.rbs +194 -0
  216. data/sig/whop_sdk/models/ad_campaign_list_params.rbs +9 -25
  217. data/sig/whop_sdk/models/ad_campaign_list_response.rbs +12 -50
  218. data/sig/whop_sdk/models/ad_campaign_platform.rbs +14 -0
  219. data/sig/whop_sdk/models/ad_campaign_status.rbs +19 -0
  220. data/sig/whop_sdk/models/ad_group.rbs +70 -0
  221. data/sig/whop_sdk/models/ad_group_list_params.rbs +9 -20
  222. data/sig/whop_sdk/models/ad_group_list_response.rbs +22 -45
  223. data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
  224. data/sig/whop_sdk/models/ad_group_status.rbs +19 -0
  225. data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
  226. data/sig/whop_sdk/models/ad_group_update_params.rbs +18 -36
  227. data/sig/whop_sdk/models/ad_list_params.rbs +39 -14
  228. data/sig/whop_sdk/models/ad_list_response.rbs +28 -25
  229. data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
  230. data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +26 -4
  231. data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +240 -131
  232. data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
  233. data/sig/whop_sdk/models/checkout_configuration.rbs +16 -0
  234. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +18 -2
  235. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +16 -0
  236. data/sig/whop_sdk/models/currency.rbs +6 -0
  237. data/sig/whop_sdk/models/deposit_create_params.rbs +81 -0
  238. data/sig/whop_sdk/models/deposit_create_response.rbs +99 -0
  239. data/sig/whop_sdk/models/dispute.rbs +4 -4
  240. data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
  241. data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
  242. data/sig/whop_sdk/models/external_ad_status.rbs +19 -0
  243. data/sig/whop_sdk/models/file_create_params.rbs +4 -18
  244. data/sig/whop_sdk/models/file_create_response.rbs +4 -15
  245. data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
  246. data/sig/whop_sdk/models/file_visibility.rbs +14 -0
  247. data/sig/whop_sdk/models/granularities.rbs +14 -0
  248. data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
  249. data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
  250. data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
  251. data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
  252. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
  253. data/sig/whop_sdk/models/membership.rbs +19 -6
  254. data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
  255. data/sig/whop_sdk/models/payment.rbs +52 -15
  256. data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
  257. data/sig/whop_sdk/models/payment_list_response.rbs +52 -15
  258. data/sig/whop_sdk/models/plan.rbs +21 -0
  259. data/sig/whop_sdk/models/plan_create_params.rbs +21 -0
  260. data/sig/whop_sdk/models/plan_list_response.rbs +21 -0
  261. data/sig/whop_sdk/models/plan_update_params.rbs +21 -0
  262. data/sig/whop_sdk/models/product.rbs +5 -0
  263. data/sig/whop_sdk/models/product_create_params.rbs +5 -0
  264. data/sig/whop_sdk/models/product_list_item.rbs +5 -0
  265. data/sig/whop_sdk/models/product_update_params.rbs +5 -0
  266. data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
  267. data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
  268. data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
  269. data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
  270. data/sig/whop_sdk/models/result_label_keys.rbs +60 -0
  271. data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
  272. data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
  273. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +26 -22
  274. data/sig/whop_sdk/models/wallet_balance_params.rbs +23 -0
  275. data/sig/whop_sdk/models/wallet_balance_response.rbs +87 -0
  276. data/sig/whop_sdk/models/wallet_list_params.rbs +14 -0
  277. data/sig/whop_sdk/models/wallet_list_response.rbs +40 -0
  278. data/sig/whop_sdk/models/wallet_send_params.rbs +32 -0
  279. data/sig/whop_sdk/models/wallet_send_response.rbs +79 -0
  280. data/sig/whop_sdk/models/webhook_event.rbs +8 -0
  281. data/sig/whop_sdk/models.rbs +64 -0
  282. data/sig/whop_sdk/resources/accounts.rbs +46 -0
  283. data/sig/whop_sdk/resources/ad_campaigns.rbs +6 -6
  284. data/sig/whop_sdk/resources/ad_groups.rbs +16 -5
  285. data/sig/whop_sdk/resources/ad_reports.rbs +3 -1
  286. data/sig/whop_sdk/resources/ads.rbs +18 -2
  287. data/sig/whop_sdk/resources/deposits.rbs +15 -0
  288. data/sig/whop_sdk/resources/files.rbs +1 -1
  289. data/sig/whop_sdk/resources/payments.rbs +1 -0
  290. data/sig/whop_sdk/resources/plans.rbs +4 -0
  291. data/sig/whop_sdk/resources/products.rbs +2 -0
  292. data/sig/whop_sdk/resources/swaps.rbs +20 -0
  293. data/sig/whop_sdk/resources/wallets.rbs +23 -0
  294. data/sig/whop_sdk/resources/webhooks.rbs +26 -22
  295. metadata +128 -23
  296. data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
  297. data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
  298. data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
  299. data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
  300. data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
  301. data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
  302. data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
  303. data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
  304. data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
  305. data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
  306. data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
  307. data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
  308. data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
  309. data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
  310. data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
  311. data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
  312. data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
  313. data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
@@ -0,0 +1,97 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::AdGroups#retrieve
6
+ class AdGroup < WhopSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The unique identifier for this ad group.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute ad_campaign
14
+ # The ad campaign this ad group belongs to.
15
+ #
16
+ # @return [WhopSDK::Models::AdGroup::AdCampaign]
17
+ required :ad_campaign, -> { WhopSDK::AdGroup::AdCampaign }
18
+
19
+ # @!attribute budget
20
+ # Budget amount in dollars.
21
+ #
22
+ # @return [Float, nil]
23
+ required :budget, Float, nil?: true
24
+
25
+ # @!attribute budget_type
26
+ # The budget type for an ad campaign or ad group.
27
+ #
28
+ # @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
29
+ required :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
30
+
31
+ # @!attribute created_at
32
+ # When the ad group was created.
33
+ #
34
+ # @return [Time]
35
+ required :created_at, Time
36
+
37
+ # @!attribute platform
38
+ # The external ad platform this ad group is running on (e.g., meta, tiktok).
39
+ #
40
+ # @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
41
+ required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
42
+
43
+ # @!attribute status
44
+ # Current operational status of the ad group.
45
+ #
46
+ # @return [Symbol, WhopSDK::Models::AdGroupStatus]
47
+ required :status, enum: -> { WhopSDK::AdGroupStatus }
48
+
49
+ # @!attribute title
50
+ # Human-readable name shown on the external platform.
51
+ #
52
+ # @return [String, nil]
53
+ required :title, String, nil?: true
54
+
55
+ # @!attribute updated_at
56
+ # When the ad group was last updated.
57
+ #
58
+ # @return [Time]
59
+ required :updated_at, Time
60
+
61
+ # @!method initialize(id:, ad_campaign:, budget:, budget_type:, created_at:, platform:, status:, title:, updated_at:)
62
+ # An ad group (ad set) belonging to an ad campaign.
63
+ #
64
+ # @param id [String] The unique identifier for this ad group.
65
+ #
66
+ # @param ad_campaign [WhopSDK::Models::AdGroup::AdCampaign] The ad campaign this ad group belongs to.
67
+ #
68
+ # @param budget [Float, nil] Budget amount in dollars.
69
+ #
70
+ # @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
71
+ #
72
+ # @param created_at [Time] When the ad group was created.
73
+ #
74
+ # @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this ad group is running on (e.g., meta, tiktok).
75
+ #
76
+ # @param status [Symbol, WhopSDK::Models::AdGroupStatus] Current operational status of the ad group.
77
+ #
78
+ # @param title [String, nil] Human-readable name shown on the external platform.
79
+ #
80
+ # @param updated_at [Time] When the ad group was last updated.
81
+
82
+ # @see WhopSDK::Models::AdGroup#ad_campaign
83
+ class AdCampaign < WhopSDK::Internal::Type::BaseModel
84
+ # @!attribute id
85
+ # The unique identifier for this ad campaign.
86
+ #
87
+ # @return [String]
88
+ required :id, String
89
+
90
+ # @!method initialize(id:)
91
+ # The ad campaign this ad group belongs to.
92
+ #
93
+ # @param id [String] The unique identifier for this ad campaign.
94
+ end
95
+ end
96
+ end
97
+ end
@@ -49,6 +49,13 @@ module WhopSDK
49
49
  # @return [Integer, nil]
50
50
  optional :first, Integer, nil?: true
51
51
 
52
+ # @!attribute include_paused
53
+ # When false, excludes paused ad groups so pagination matches the dashboard's
54
+ # hide-paused toggle.
55
+ #
56
+ # @return [Boolean, nil]
57
+ optional :include_paused, WhopSDK::Internal::Type::Boolean, nil?: true
58
+
52
59
  # @!attribute last
53
60
  # Returns the last _n_ elements from the list.
54
61
  #
@@ -64,10 +71,13 @@ module WhopSDK
64
71
  # @!attribute status
65
72
  # The status of an external ad group.
66
73
  #
67
- # @return [Symbol, WhopSDK::Models::AdGroupListParams::Status, nil]
68
- optional :status, enum: -> { WhopSDK::AdGroupListParams::Status }, nil?: true
74
+ # @return [Symbol, WhopSDK::Models::AdGroupStatus, nil]
75
+ optional :status, enum: -> { WhopSDK::AdGroupStatus }, nil?: true
69
76
 
70
- # @!method initialize(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: {})
77
+ # @!method initialize(after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, include_paused: nil, last: nil, query: nil, status: nil, request_options: {})
78
+ # Some parameter documentations has been truncated, see
79
+ # {WhopSDK::Models::AdGroupListParams} for more details.
80
+ #
71
81
  # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
72
82
  #
73
83
  # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
@@ -82,28 +92,15 @@ module WhopSDK
82
92
  #
83
93
  # @param first [Integer, nil] Returns the first _n_ elements from the list.
84
94
  #
95
+ # @param include_paused [Boolean, nil] When false, excludes paused ad groups so pagination matches the dashboard's hide
96
+ #
85
97
  # @param last [Integer, nil] Returns the last _n_ elements from the list.
86
98
  #
87
99
  # @param query [String, nil] Case-insensitive substring match against the ad group name.
88
100
  #
89
- # @param status [Symbol, WhopSDK::Models::AdGroupListParams::Status, nil] The status of an external ad group.
101
+ # @param status [Symbol, WhopSDK::Models::AdGroupStatus, nil] The status of an external ad group.
90
102
  #
91
103
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
92
-
93
- # The status of an external ad group.
94
- module Status
95
- extend WhopSDK::Internal::Type::Enum
96
-
97
- ACTIVE = :active
98
- PAUSED = :paused
99
- INACTIVE = :inactive
100
- IN_REVIEW = :in_review
101
- REJECTED = :rejected
102
- FLAGGED = :flagged
103
-
104
- # @!method self.values
105
- # @return [Array<Symbol>]
106
- end
107
104
  end
108
105
  end
109
106
  end
@@ -10,6 +10,12 @@ module WhopSDK
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute ad_campaign
14
+ # The ad campaign this ad group belongs to.
15
+ #
16
+ # @return [WhopSDK::Models::AdGroupListResponse::AdCampaign]
17
+ required :ad_campaign, -> { WhopSDK::Models::AdGroupListResponse::AdCampaign }
18
+
13
19
  # @!attribute budget
14
20
  # Budget amount in dollars.
15
21
  #
@@ -19,8 +25,8 @@ module WhopSDK
19
25
  # @!attribute budget_type
20
26
  # The budget type for an ad campaign or ad group.
21
27
  #
22
- # @return [Symbol, WhopSDK::Models::AdGroupListResponse::BudgetType, nil]
23
- required :budget_type, enum: -> { WhopSDK::Models::AdGroupListResponse::BudgetType }, nil?: true
28
+ # @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
29
+ required :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
24
30
 
25
31
  # @!attribute created_at
26
32
  # When the ad group was created.
@@ -31,14 +37,14 @@ module WhopSDK
31
37
  # @!attribute platform
32
38
  # The external ad platform this ad group is running on (e.g., meta, tiktok).
33
39
  #
34
- # @return [Symbol, WhopSDK::Models::AdGroupListResponse::Platform]
35
- required :platform, enum: -> { WhopSDK::Models::AdGroupListResponse::Platform }
40
+ # @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
41
+ required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
36
42
 
37
43
  # @!attribute status
38
44
  # Current operational status of the ad group.
39
45
  #
40
- # @return [Symbol, WhopSDK::Models::AdGroupListResponse::Status]
41
- required :status, enum: -> { WhopSDK::Models::AdGroupListResponse::Status }
46
+ # @return [Symbol, WhopSDK::Models::AdGroupStatus]
47
+ required :status, enum: -> { WhopSDK::AdGroupStatus }
42
48
 
43
49
  # @!attribute title
44
50
  # Human-readable name shown on the external platform.
@@ -52,66 +58,39 @@ module WhopSDK
52
58
  # @return [Time]
53
59
  required :updated_at, Time
54
60
 
55
- # @!method initialize(id:, budget:, budget_type:, created_at:, platform:, status:, title:, updated_at:)
61
+ # @!method initialize(id:, ad_campaign:, budget:, budget_type:, created_at:, platform:, status:, title:, updated_at:)
56
62
  # An ad group (ad set) belonging to an ad campaign.
57
63
  #
58
64
  # @param id [String] The unique identifier for this ad group.
59
65
  #
66
+ # @param ad_campaign [WhopSDK::Models::AdGroupListResponse::AdCampaign] The ad campaign this ad group belongs to.
67
+ #
60
68
  # @param budget [Float, nil] Budget amount in dollars.
61
69
  #
62
- # @param budget_type [Symbol, WhopSDK::Models::AdGroupListResponse::BudgetType, nil] The budget type for an ad campaign or ad group.
70
+ # @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
63
71
  #
64
72
  # @param created_at [Time] When the ad group was created.
65
73
  #
66
- # @param platform [Symbol, WhopSDK::Models::AdGroupListResponse::Platform] The external ad platform this ad group is running on (e.g., meta, tiktok).
74
+ # @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this ad group is running on (e.g., meta, tiktok).
67
75
  #
68
- # @param status [Symbol, WhopSDK::Models::AdGroupListResponse::Status] Current operational status of the ad group.
76
+ # @param status [Symbol, WhopSDK::Models::AdGroupStatus] Current operational status of the ad group.
69
77
  #
70
78
  # @param title [String, nil] Human-readable name shown on the external platform.
71
79
  #
72
80
  # @param updated_at [Time] When the ad group was last updated.
73
81
 
74
- # The budget type for an ad campaign or ad group.
75
- #
76
- # @see WhopSDK::Models::AdGroupListResponse#budget_type
77
- module BudgetType
78
- extend WhopSDK::Internal::Type::Enum
79
-
80
- DAILY = :daily
81
- LIFETIME = :lifetime
82
-
83
- # @!method self.values
84
- # @return [Array<Symbol>]
85
- end
86
-
87
- # The external ad platform this ad group is running on (e.g., meta, tiktok).
88
- #
89
- # @see WhopSDK::Models::AdGroupListResponse#platform
90
- module Platform
91
- extend WhopSDK::Internal::Type::Enum
92
-
93
- META = :meta
94
- TIKTOK = :tiktok
95
-
96
- # @!method self.values
97
- # @return [Array<Symbol>]
98
- end
99
-
100
- # Current operational status of the ad group.
101
- #
102
- # @see WhopSDK::Models::AdGroupListResponse#status
103
- module Status
104
- extend WhopSDK::Internal::Type::Enum
105
-
106
- ACTIVE = :active
107
- PAUSED = :paused
108
- INACTIVE = :inactive
109
- IN_REVIEW = :in_review
110
- REJECTED = :rejected
111
- FLAGGED = :flagged
112
-
113
- # @!method self.values
114
- # @return [Array<Symbol>]
82
+ # @see WhopSDK::Models::AdGroupListResponse#ad_campaign
83
+ class AdCampaign < WhopSDK::Internal::Type::BaseModel
84
+ # @!attribute id
85
+ # The unique identifier for this ad campaign.
86
+ #
87
+ # @return [String]
88
+ required :id, String
89
+
90
+ # @!method initialize(id:)
91
+ # The ad campaign this ad group belongs to.
92
+ #
93
+ # @param id [String] The unique identifier for this ad campaign.
115
94
  end
116
95
  end
117
96
  end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::AdGroups#pause
6
+ class AdGroupPauseParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The status of an external ad group.
6
+ module AdGroupStatus
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ ACTIVE = :active
10
+ PAUSED = :paused
11
+ INACTIVE = :inactive
12
+ IN_REVIEW = :in_review
13
+ REJECTED = :rejected
14
+ FLAGGED = :flagged
15
+
16
+ # @!method self.values
17
+ # @return [Array<Symbol>]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::AdGroups#unpause
6
+ class AdGroupUnpauseParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -21,8 +21,8 @@ module WhopSDK
21
21
  # @!attribute budget_type
22
22
  # The budget type for an ad campaign or ad group.
23
23
  #
24
- # @return [Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType, nil]
25
- optional :budget_type, enum: -> { WhopSDK::AdGroupUpdateParams::BudgetType }, nil?: true
24
+ # @return [Symbol, WhopSDK::Models::AdBudgetType, nil]
25
+ optional :budget_type, enum: -> { WhopSDK::AdBudgetType }, nil?: true
26
26
 
27
27
  # @!attribute config
28
28
  # Unified ad group configuration (bidding, optimization, targeting).
@@ -51,15 +51,15 @@ module WhopSDK
51
51
  # @!attribute status
52
52
  # The status of an external ad group.
53
53
  #
54
- # @return [Symbol, WhopSDK::Models::AdGroupUpdateParams::Status, nil]
55
- optional :status, enum: -> { WhopSDK::AdGroupUpdateParams::Status }, nil?: true
54
+ # @return [Symbol, WhopSDK::Models::AdGroupStatus, nil]
55
+ optional :status, enum: -> { WhopSDK::AdGroupStatus }, nil?: true
56
56
 
57
57
  # @!method initialize(id:, budget: nil, budget_type: nil, config: nil, daily_budget: nil, name: nil, platform_config: nil, status: nil, request_options: {})
58
58
  # @param id [String]
59
59
  #
60
60
  # @param budget [Float, nil] Budget amount in dollars.
61
61
  #
62
- # @param budget_type [Symbol, WhopSDK::Models::AdGroupUpdateParams::BudgetType, nil] The budget type for an ad campaign or ad group.
62
+ # @param budget_type [Symbol, WhopSDK::Models::AdBudgetType, nil] The budget type for an ad campaign or ad group.
63
63
  #
64
64
  # @param config [WhopSDK::Models::AdGroupUpdateParams::Config, nil] Unified ad group configuration (bidding, optimization, targeting).
65
65
  #
@@ -69,21 +69,10 @@ module WhopSDK
69
69
  #
70
70
  # @param platform_config [WhopSDK::Models::AdGroupUpdateParams::PlatformConfig, nil] Platform-specific ad group configuration.
71
71
  #
72
- # @param status [Symbol, WhopSDK::Models::AdGroupUpdateParams::Status, nil] The status of an external ad group.
72
+ # @param status [Symbol, WhopSDK::Models::AdGroupStatus, nil] The status of an external ad group.
73
73
  #
74
74
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
75
75
 
76
- # The budget type for an ad campaign or ad group.
77
- module BudgetType
78
- extend WhopSDK::Internal::Type::Enum
79
-
80
- DAILY = :daily
81
- LIFETIME = :lifetime
82
-
83
- # @!method self.values
84
- # @return [Array<Symbol>]
85
- end
86
-
87
76
  class Config < WhopSDK::Internal::Type::BaseModel
88
77
  # @!attribute bid_amount
89
78
  # Bid cap amount in cents. Used when bid_strategy is bid_cap or cost_cap.
@@ -972,6 +961,7 @@ module WhopSDK
972
961
  IMAGINE = :IMAGINE
973
962
  LEAD_FROM_IG_DIRECT = :LEAD_FROM_IG_DIRECT
974
963
  LEAD_FROM_MESSENGER = :LEAD_FROM_MESSENGER
964
+ LEAD_FORM_MESSENGER = :LEAD_FORM_MESSENGER
975
965
  WEBSITE_AND_LEAD_FORM = :WEBSITE_AND_LEAD_FORM
976
966
  WEBSITE_AND_PHONE_CALL = :WEBSITE_AND_PHONE_CALL
977
967
  BROADCAST_CHANNEL = :BROADCAST_CHANNEL
@@ -1398,6 +1388,7 @@ module WhopSDK
1398
1388
 
1399
1389
  WEBSITE = :website
1400
1390
  INSTANT_FORMS = :instant_forms
1391
+ WEBSITE_AND_INSTANT_FORMS = :website_and_instant_forms
1401
1392
  MESSENGER = :messenger
1402
1393
  INSTAGRAM = :instagram
1403
1394
  CALLS = :calls
@@ -3187,21 +3178,6 @@ module WhopSDK
3187
3178
  end
3188
3179
  end
3189
3180
  end
3190
-
3191
- # The status of an external ad group.
3192
- module Status
3193
- extend WhopSDK::Internal::Type::Enum
3194
-
3195
- ACTIVE = :active
3196
- PAUSED = :paused
3197
- INACTIVE = :inactive
3198
- IN_REVIEW = :in_review
3199
- REJECTED = :rejected
3200
- FLAGGED = :flagged
3201
-
3202
- # @!method self.values
3203
- # @return [Array<Symbol>]
3204
- end
3205
3181
  end
3206
3182
  end
3207
3183
  end
@@ -58,19 +58,56 @@ module WhopSDK
58
58
  # @return [Integer, nil]
59
59
  optional :first, Integer, nil?: true
60
60
 
61
+ # @!attribute include_paused
62
+ # When false, excludes paused ads so pagination matches the dashboard's
63
+ # hide-paused toggle.
64
+ #
65
+ # @return [Boolean, nil]
66
+ optional :include_paused, WhopSDK::Internal::Type::Boolean, nil?: true
67
+
61
68
  # @!attribute last
62
69
  # Returns the last _n_ elements from the list.
63
70
  #
64
71
  # @return [Integer, nil]
65
72
  optional :last, Integer, nil?: true
66
73
 
74
+ # @!attribute order_by
75
+ # Columns that the listAds query can sort by.
76
+ #
77
+ # @return [Symbol, WhopSDK::Models::AdListParams::OrderBy, nil]
78
+ optional :order_by, enum: -> { WhopSDK::AdListParams::OrderBy }, nil?: true
79
+
80
+ # @!attribute order_direction
81
+ # The direction of the sort.
82
+ #
83
+ # @return [Symbol, WhopSDK::Models::Direction, nil]
84
+ optional :order_direction, enum: -> { WhopSDK::Direction }, nil?: true
85
+
86
+ # @!attribute query
87
+ # Case-insensitive substring match against the ad title or tag.
88
+ #
89
+ # @return [String, nil]
90
+ optional :query, String, nil?: true
91
+
92
+ # @!attribute stats_from
93
+ # Start of the stats date range used when order_by is a stats column.
94
+ #
95
+ # @return [Time, nil]
96
+ optional :stats_from, Time, nil?: true
97
+
98
+ # @!attribute stats_to
99
+ # End of the stats date range used when order_by is a stats column.
100
+ #
101
+ # @return [Time, nil]
102
+ optional :stats_to, Time, nil?: true
103
+
67
104
  # @!attribute status
68
105
  # The status of an external ad.
69
106
  #
70
- # @return [Symbol, WhopSDK::Models::AdListParams::Status, nil]
71
- optional :status, enum: -> { WhopSDK::AdListParams::Status }, nil?: true
107
+ # @return [Symbol, WhopSDK::Models::ExternalAdStatus, nil]
108
+ optional :status, enum: -> { WhopSDK::ExternalAdStatus }, nil?: true
72
109
 
73
- # @!method initialize(ad_group_id: nil, after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, last: nil, status: nil, request_options: {})
110
+ # @!method initialize(ad_group_id: nil, after: nil, before: nil, campaign_id: nil, company_id: nil, created_after: nil, created_before: nil, first: nil, include_paused: nil, last: nil, order_by: nil, order_direction: nil, query: nil, stats_from: nil, stats_to: nil, status: nil, request_options: {})
74
111
  # Some parameter documentations has been truncated, see
75
112
  # {WhopSDK::Models::AdListParams} for more details.
76
113
  #
@@ -90,22 +127,30 @@ module WhopSDK
90
127
  #
91
128
  # @param first [Integer, nil] Returns the first _n_ elements from the list.
92
129
  #
130
+ # @param include_paused [Boolean, nil] When false, excludes paused ads so pagination matches the dashboard's hide-pause
131
+ #
93
132
  # @param last [Integer, nil] Returns the last _n_ elements from the list.
94
133
  #
95
- # @param status [Symbol, WhopSDK::Models::AdListParams::Status, nil] The status of an external ad.
134
+ # @param order_by [Symbol, WhopSDK::Models::AdListParams::OrderBy, nil] Columns that the listAds query can sort by.
135
+ #
136
+ # @param order_direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
137
+ #
138
+ # @param query [String, nil] Case-insensitive substring match against the ad title or tag.
139
+ #
140
+ # @param stats_from [Time, nil] Start of the stats date range used when order_by is a stats column.
141
+ #
142
+ # @param stats_to [Time, nil] End of the stats date range used when order_by is a stats column.
143
+ #
144
+ # @param status [Symbol, WhopSDK::Models::ExternalAdStatus, nil] The status of an external ad.
96
145
  #
97
146
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
98
147
 
99
- # The status of an external ad.
100
- module Status
148
+ # Columns that the listAds query can sort by.
149
+ module OrderBy
101
150
  extend WhopSDK::Internal::Type::Enum
102
151
 
103
- ACTIVE = :active
104
- PAUSED = :paused
105
- INACTIVE = :inactive
106
- IN_REVIEW = :in_review
107
- REJECTED = :rejected
108
- FLAGGED = :flagged
152
+ SPEND = :spend
153
+ ROAS = :roas
109
154
 
110
155
  # @!method self.values
111
156
  # @return [Array<Symbol>]
@@ -10,6 +10,18 @@ module WhopSDK
10
10
  # @return [String]
11
11
  required :id, String
12
12
 
13
+ # @!attribute ad_campaign
14
+ # The ad campaign this ad belongs to.
15
+ #
16
+ # @return [WhopSDK::Models::AdListResponse::AdCampaign]
17
+ required :ad_campaign, -> { WhopSDK::Models::AdListResponse::AdCampaign }
18
+
19
+ # @!attribute ad_group
20
+ # The parent ad group this ad belongs to.
21
+ #
22
+ # @return [WhopSDK::Models::AdListResponse::AdGroup]
23
+ required :ad_group, -> { WhopSDK::Models::AdListResponse::AdGroup }
24
+
13
25
  # @!attribute created_at
14
26
  # When the ad was created.
15
27
  #
@@ -19,14 +31,14 @@ module WhopSDK
19
31
  # @!attribute platform
20
32
  # The external ad platform this ad is running on (e.g., meta, tiktok).
21
33
  #
22
- # @return [Symbol, WhopSDK::Models::AdListResponse::Platform]
23
- required :platform, enum: -> { WhopSDK::Models::AdListResponse::Platform }
34
+ # @return [Symbol, WhopSDK::Models::AdCampaignPlatform]
35
+ required :platform, enum: -> { WhopSDK::AdCampaignPlatform }
24
36
 
25
37
  # @!attribute status
26
38
  # Current delivery status of the ad.
27
39
  #
28
- # @return [Symbol, WhopSDK::Models::AdListResponse::Status]
29
- required :status, enum: -> { WhopSDK::Models::AdListResponse::Status }
40
+ # @return [Symbol, WhopSDK::Models::ExternalAdStatus]
41
+ required :status, enum: -> { WhopSDK::ExternalAdStatus }
30
42
 
31
43
  # @!attribute title
32
44
  # The display title of the ad. Falls back to the creative set caption when unset.
@@ -40,49 +52,51 @@ module WhopSDK
40
52
  # @return [Time]
41
53
  required :updated_at, Time
42
54
 
43
- # @!method initialize(id:, created_at:, platform:, status:, title:, updated_at:)
55
+ # @!method initialize(id:, ad_campaign:, ad_group:, created_at:, platform:, status:, title:, updated_at:)
44
56
  # An ad belonging to an ad group.
45
57
  #
46
58
  # @param id [String] The unique identifier for this ad.
47
59
  #
60
+ # @param ad_campaign [WhopSDK::Models::AdListResponse::AdCampaign] The ad campaign this ad belongs to.
61
+ #
62
+ # @param ad_group [WhopSDK::Models::AdListResponse::AdGroup] The parent ad group this ad belongs to.
63
+ #
48
64
  # @param created_at [Time] When the ad was created.
49
65
  #
50
- # @param platform [Symbol, WhopSDK::Models::AdListResponse::Platform] The external ad platform this ad is running on (e.g., meta, tiktok).
66
+ # @param platform [Symbol, WhopSDK::Models::AdCampaignPlatform] The external ad platform this ad is running on (e.g., meta, tiktok).
51
67
  #
52
- # @param status [Symbol, WhopSDK::Models::AdListResponse::Status] Current delivery status of the ad.
68
+ # @param status [Symbol, WhopSDK::Models::ExternalAdStatus] Current delivery status of the ad.
53
69
  #
54
70
  # @param title [String, nil] The display title of the ad. Falls back to the creative set caption when unset.
55
71
  #
56
72
  # @param updated_at [Time] When the ad was last updated.
57
73
 
58
- # The external ad platform this ad is running on (e.g., meta, tiktok).
59
- #
60
- # @see WhopSDK::Models::AdListResponse#platform
61
- module Platform
62
- extend WhopSDK::Internal::Type::Enum
63
-
64
- META = :meta
65
- TIKTOK = :tiktok
74
+ # @see WhopSDK::Models::AdListResponse#ad_campaign
75
+ class AdCampaign < WhopSDK::Internal::Type::BaseModel
76
+ # @!attribute id
77
+ # The unique identifier for this ad campaign.
78
+ #
79
+ # @return [String]
80
+ required :id, String
66
81
 
67
- # @!method self.values
68
- # @return [Array<Symbol>]
82
+ # @!method initialize(id:)
83
+ # The ad campaign this ad belongs to.
84
+ #
85
+ # @param id [String] The unique identifier for this ad campaign.
69
86
  end
70
87
 
71
- # Current delivery status of the ad.
72
- #
73
- # @see WhopSDK::Models::AdListResponse#status
74
- module Status
75
- extend WhopSDK::Internal::Type::Enum
76
-
77
- ACTIVE = :active
78
- PAUSED = :paused
79
- INACTIVE = :inactive
80
- IN_REVIEW = :in_review
81
- REJECTED = :rejected
82
- FLAGGED = :flagged
88
+ # @see WhopSDK::Models::AdListResponse#ad_group
89
+ class AdGroup < WhopSDK::Internal::Type::BaseModel
90
+ # @!attribute id
91
+ # The unique identifier for this ad group.
92
+ #
93
+ # @return [String]
94
+ required :id, String
83
95
 
84
- # @!method self.values
85
- # @return [Array<Symbol>]
96
+ # @!method initialize(id:)
97
+ # The parent ad group this ad belongs to.
98
+ #
99
+ # @param id [String] The unique identifier for this ad group.
86
100
  end
87
101
  end
88
102
  end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Ads#pause
6
+ class AdPauseParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end