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
@@ -4,13 +4,24 @@ module WhopSDK
4
4
  module Models
5
5
  # @see WhopSDK::Resources::AdReports#retrieve
6
6
  class AdReportRetrieveResponse < WhopSDK::Internal::Type::BaseModel
7
- # @!attribute daily
8
- # Per-day breakdown over the date range, ordered ascending. Null when
9
- # `includeDaily` is false.
7
+ # @!attribute breakdown
8
+ # Per-entity rows over the date range. `null` when the `breakdown` arg on
9
+ # `adReport` is omitted; otherwise contains one row per ad campaign, ad group, or
10
+ # ad inside the requested scope at the requested level.
10
11
  #
11
- # @return [Array<WhopSDK::Models::AdReportRetrieveResponse::Daily>, nil]
12
- required :daily,
13
- -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AdReportRetrieveResponse::Daily] },
12
+ # @return [Array<WhopSDK::Models::AdReportRetrieveResponse::Breakdown>, nil]
13
+ required :breakdown,
14
+ -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AdReportRetrieveResponse::Breakdown] },
15
+ nil?: true
16
+
17
+ # @!attribute granularity
18
+ # Per-bucket time series over the date range, ordered ascending by `bucketStart`.
19
+ # `null` when the `granularity` arg on `adReport` is omitted; otherwise contains
20
+ # rows at the requested grain (`daily` or `hourly`).
21
+ #
22
+ # @return [Array<WhopSDK::Models::AdReportRetrieveResponse::Granularity>, nil]
23
+ required :granularity,
24
+ -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AdReportRetrieveResponse::Granularity] },
14
25
  nil?: true
15
26
 
16
27
  # @!attribute summary
@@ -19,38 +30,359 @@ module WhopSDK
19
30
  # @return [WhopSDK::Models::AdReportRetrieveResponse::Summary]
20
31
  required :summary, -> { WhopSDK::Models::AdReportRetrieveResponse::Summary }
21
32
 
22
- # @!method initialize(daily:, summary:)
33
+ # @!method initialize(breakdown:, granularity:, summary:)
23
34
  # Some parameter documentations has been truncated, see
24
35
  # {WhopSDK::Models::AdReportRetrieveResponse} for more details.
25
36
  #
26
- # An ads performance report. Returns a summary; daily breakdown is included when
27
- # `includeDaily` is true.
37
+ # An ads performance report. Always returns a summary. The `granularity` field
38
+ # contains a per-bucket time series when the `granularity` arg is set; the
39
+ # `breakdown` field contains per-entity rows when the `breakdown` arg is set.
40
+ #
41
+ # @param breakdown [Array<WhopSDK::Models::AdReportRetrieveResponse::Breakdown>, nil] Per-entity rows over the date range. `null` when the `breakdown` arg on `adRepor
28
42
  #
29
- # @param daily [Array<WhopSDK::Models::AdReportRetrieveResponse::Daily>, nil] Per-day breakdown over the date range, ordered ascending. Null when `includeDail
43
+ # @param granularity [Array<WhopSDK::Models::AdReportRetrieveResponse::Granularity>, nil] Per-bucket time series over the date range, ordered ascending by `bucketStart`.
30
44
  #
31
45
  # @param summary [WhopSDK::Models::AdReportRetrieveResponse::Summary] Aggregate totals and rates over the date range.
32
46
 
33
- class Daily < WhopSDK::Internal::Type::BaseModel
47
+ class Breakdown < WhopSDK::Internal::Type::BaseModel
48
+ # @!attribute id
49
+ # Tag of the entity (ad campaign, ad group, or ad).
50
+ #
51
+ # @return [String]
52
+ required :id, String
53
+
54
+ # @!attribute granularity
55
+ # Per-bucket time series for this entity over the date range, ordered ascending by
56
+ # `bucketStart`. `null` when the `granularity` arg on `adReport` is omitted;
57
+ # otherwise contains rows at the requested grain (`daily` or `hourly`).
58
+ #
59
+ # @return [Array<WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Granularity>, nil]
60
+ required :granularity,
61
+ -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Granularity] },
62
+ nil?: true
63
+
64
+ # @!attribute level
65
+ # The entity level of this row — matches the `breakdown` arg.
66
+ #
67
+ # @return [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Level]
68
+ required :level, enum: -> { WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Level }
69
+
70
+ # @!attribute name
71
+ # Display name of the entity, when available.
72
+ #
73
+ # @return [String, nil]
74
+ required :name, String, nil?: true
75
+
76
+ # @!attribute summary
77
+ # Aggregate totals and rates for this entity over the date range.
78
+ #
79
+ # @return [WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Summary]
80
+ required :summary, -> { WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Summary }
81
+
82
+ # @!method initialize(id:, granularity:, level:, name:, summary:)
83
+ # Some parameter documentations has been truncated, see
84
+ # {WhopSDK::Models::AdReportRetrieveResponse::Breakdown} for more details.
85
+ #
86
+ # Per-entity ad performance row. Returned when the `breakdown` arg on `adReport`
87
+ # is set.
88
+ #
89
+ # @param id [String] Tag of the entity (ad campaign, ad group, or ad).
90
+ #
91
+ # @param granularity [Array<WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Granularity>, nil] Per-bucket time series for this entity over the date range, ordered ascending by
92
+ #
93
+ # @param level [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Level] The entity level of this row — matches the `breakdown` arg.
94
+ #
95
+ # @param name [String, nil] Display name of the entity, when available.
96
+ #
97
+ # @param summary [WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Summary] Aggregate totals and rates for this entity over the date range.
98
+
99
+ class Granularity < WhopSDK::Internal::Type::BaseModel
100
+ # @!attribute bucket_start
101
+ # The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved
102
+ # in the ad account's reporting timezone — render this in the viewer's local
103
+ # timezone.
104
+ #
105
+ # @return [Time]
106
+ required :bucket_start, Time
107
+
108
+ # @!attribute clicks
109
+ # Clicks in this bucket.
110
+ #
111
+ # @return [Integer]
112
+ required :clicks, Integer
113
+
114
+ # @!attribute granularity
115
+ # The bucket size of this row (`daily` or `hourly`).
116
+ #
117
+ # @return [Symbol, WhopSDK::Models::Granularities]
118
+ required :granularity, enum: -> { WhopSDK::Granularities }
119
+
120
+ # @!attribute impressions
121
+ # Impressions in this bucket.
122
+ #
123
+ # @return [Integer]
124
+ required :impressions, Integer
125
+
126
+ # @!attribute reach
127
+ # Unique users reached in this bucket. Always `0` for hourly rows (Meta does not
128
+ # return reach at hourly grain).
129
+ #
130
+ # @return [Integer]
131
+ required :reach, Integer
132
+
133
+ # @!attribute result_count
134
+ # Count of the primary optimization result in this bucket.
135
+ #
136
+ # @return [Integer, nil]
137
+ required :result_count, Integer, nil?: true
138
+
139
+ # @!attribute result_label_key
140
+ # Types of optimization results tracked from external ad platforms
141
+ #
142
+ # @return [Symbol, WhopSDK::Models::ResultLabelKeys, nil]
143
+ required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true
144
+
145
+ # @!attribute result_label_override
146
+ # Advertiser-defined label for the result when `resultLabelKey` is `custom`.
147
+ #
148
+ # @return [String, nil]
149
+ required :result_label_override, String, nil?: true
150
+
151
+ # @!attribute spend
152
+ # Charged spend in this bucket in the requested reporting currency — the amount
153
+ # billed including platform fees, not the platform-side net spend.
154
+ #
155
+ # @return [Float]
156
+ required :spend, Float
157
+
158
+ # @!attribute spend_currency
159
+ # Currency of the `spend` value.
160
+ #
161
+ # @return [Symbol, WhopSDK::Models::Currency]
162
+ required :spend_currency, enum: -> { WhopSDK::Currency }
163
+
164
+ # @!attribute stat_date
165
+ # The date these stats cover (midnight UTC). For hourly rows, see `statHour` and
166
+ # `bucketStart`.
167
+ #
168
+ # @return [Time]
169
+ required :stat_date, Time
170
+
171
+ # @!attribute stat_hour
172
+ # Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
173
+ # rows.
174
+ #
175
+ # @return [Integer, nil]
176
+ required :stat_hour, Integer, nil?: true
177
+
178
+ # @!method initialize(bucket_start:, clicks:, granularity:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, spend:, spend_currency:, stat_date:, stat_hour:)
179
+ # Some parameter documentations has been truncated, see
180
+ # {WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Granularity} for more
181
+ # details.
182
+ #
183
+ # Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is
184
+ # set by the `ad_report` query's `granularity` argument.
185
+ #
186
+ # @param bucket_start [Time] The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved i
187
+ #
188
+ # @param clicks [Integer] Clicks in this bucket.
189
+ #
190
+ # @param granularity [Symbol, WhopSDK::Models::Granularities] The bucket size of this row (`daily` or `hourly`).
191
+ #
192
+ # @param impressions [Integer] Impressions in this bucket.
193
+ #
194
+ # @param reach [Integer] Unique users reached in this bucket. Always `0` for hourly rows (Meta does not r
195
+ #
196
+ # @param result_count [Integer, nil] Count of the primary optimization result in this bucket.
197
+ #
198
+ # @param result_label_key [Symbol, WhopSDK::Models::ResultLabelKeys, nil] Types of optimization results tracked from external ad platforms
199
+ #
200
+ # @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
201
+ #
202
+ # @param spend [Float] Charged spend in this bucket in the requested reporting currency — the amount bi
203
+ #
204
+ # @param spend_currency [Symbol, WhopSDK::Models::Currency] Currency of the `spend` value.
205
+ #
206
+ # @param stat_date [Time] The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `
207
+ #
208
+ # @param stat_hour [Integer, nil] Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
209
+ end
210
+
211
+ # The entity level of this row — matches the `breakdown` arg.
212
+ #
213
+ # @see WhopSDK::Models::AdReportRetrieveResponse::Breakdown#level
214
+ module Level
215
+ extend WhopSDK::Internal::Type::Enum
216
+
217
+ CAMPAIGN = :campaign
218
+ AD_GROUP = :ad_group
219
+ AD = :ad
220
+
221
+ # @!method self.values
222
+ # @return [Array<Symbol>]
223
+ end
224
+
225
+ # @see WhopSDK::Models::AdReportRetrieveResponse::Breakdown#summary
226
+ class Summary < WhopSDK::Internal::Type::BaseModel
227
+ # @!attribute clicks
228
+ # Total clicks over the date range.
229
+ #
230
+ # @return [Integer]
231
+ required :clicks, Integer
232
+
233
+ # @!attribute cost_per_result
234
+ # Spend divided by `resultCount`. Null when there are no results.
235
+ #
236
+ # @return [Float, nil]
237
+ required :cost_per_result, Float, nil?: true
238
+
239
+ # @!attribute cpc
240
+ # Cost per click in the requested reporting currency.
241
+ #
242
+ # @return [Float]
243
+ required :cpc, Float
244
+
245
+ # @!attribute cpm
246
+ # Cost per thousand impressions in the requested reporting currency.
247
+ #
248
+ # @return [Float, nil]
249
+ required :cpm, Float, nil?: true
250
+
251
+ # @!attribute ctr
252
+ # Click-through rate (clicks / impressions).
253
+ #
254
+ # @return [Float]
255
+ required :ctr, Float
256
+
257
+ # @!attribute frequency
258
+ # Average number of times each reached user saw an ad.
259
+ #
260
+ # @return [Float, nil]
261
+ required :frequency, Float, nil?: true
262
+
263
+ # @!attribute impressions
264
+ # Total impressions over the date range.
265
+ #
266
+ # @return [Integer]
267
+ required :impressions, Integer
268
+
269
+ # @!attribute reach
270
+ # Unique users reached, deduplicated by the external ad platform.
271
+ #
272
+ # @return [Integer]
273
+ required :reach, Integer
274
+
275
+ # @!attribute result_count
276
+ # Count of the campaign's primary optimization result (purchases, clicks, etc.) —
277
+ # see `resultLabelKey`.
278
+ #
279
+ # @return [Integer, nil]
280
+ required :result_count, Integer, nil?: true
281
+
282
+ # @!attribute result_label_key
283
+ # Types of optimization results tracked from external ad platforms
284
+ #
285
+ # @return [Symbol, WhopSDK::Models::ResultLabelKeys, nil]
286
+ required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true
287
+
288
+ # @!attribute result_label_override
289
+ # Advertiser-defined label for the result when `resultLabelKey` is `custom`.
290
+ #
291
+ # @return [String, nil]
292
+ required :result_label_override, String, nil?: true
293
+
294
+ # @!attribute roas
295
+ # Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
296
+ # external ad platform.
297
+ #
298
+ # @return [Float, nil]
299
+ required :roas, Float, nil?: true
300
+
301
+ # @!attribute spend
302
+ # Total spend over the date range in the requested reporting currency.
303
+ #
304
+ # @return [Float]
305
+ required :spend, Float
306
+
307
+ # @!attribute spend_currency
308
+ # The available currencies on the platform
309
+ #
310
+ # @return [Symbol, WhopSDK::Models::Currency, nil]
311
+ required :spend_currency, enum: -> { WhopSDK::Currency }, nil?: true
312
+
313
+ # @!method initialize(clicks:, cost_per_result:, cpc:, cpm:, ctr:, frequency:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, roas:, spend:, spend_currency:)
314
+ # Some parameter documentations has been truncated, see
315
+ # {WhopSDK::Models::AdReportRetrieveResponse::Breakdown::Summary} for more
316
+ # details.
317
+ #
318
+ # Aggregate totals and rates for this entity over the date range.
319
+ #
320
+ # @param clicks [Integer] Total clicks over the date range.
321
+ #
322
+ # @param cost_per_result [Float, nil] Spend divided by `resultCount`. Null when there are no results.
323
+ #
324
+ # @param cpc [Float] Cost per click in the requested reporting currency.
325
+ #
326
+ # @param cpm [Float, nil] Cost per thousand impressions in the requested reporting currency.
327
+ #
328
+ # @param ctr [Float] Click-through rate (clicks / impressions).
329
+ #
330
+ # @param frequency [Float, nil] Average number of times each reached user saw an ad.
331
+ #
332
+ # @param impressions [Integer] Total impressions over the date range.
333
+ #
334
+ # @param reach [Integer] Unique users reached, deduplicated by the external ad platform.
335
+ #
336
+ # @param result_count [Integer, nil] Count of the campaign's primary optimization result (purchases, clicks, etc.) —
337
+ #
338
+ # @param result_label_key [Symbol, WhopSDK::Models::ResultLabelKeys, nil] Types of optimization results tracked from external ad platforms
339
+ #
340
+ # @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
341
+ #
342
+ # @param roas [Float, nil] Alias for `purchaseRoas` — return on ad spend for purchases, as reported by the
343
+ #
344
+ # @param spend [Float] Total spend over the date range in the requested reporting currency.
345
+ #
346
+ # @param spend_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
347
+ end
348
+ end
349
+
350
+ class Granularity < WhopSDK::Internal::Type::BaseModel
351
+ # @!attribute bucket_start
352
+ # The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved
353
+ # in the ad account's reporting timezone — render this in the viewer's local
354
+ # timezone.
355
+ #
356
+ # @return [Time]
357
+ required :bucket_start, Time
358
+
34
359
  # @!attribute clicks
35
- # Clicks on this date.
360
+ # Clicks in this bucket.
36
361
  #
37
362
  # @return [Integer]
38
363
  required :clicks, Integer
39
364
 
365
+ # @!attribute granularity
366
+ # The bucket size of this row (`daily` or `hourly`).
367
+ #
368
+ # @return [Symbol, WhopSDK::Models::Granularities]
369
+ required :granularity, enum: -> { WhopSDK::Granularities }
370
+
40
371
  # @!attribute impressions
41
- # Impressions on this date.
372
+ # Impressions in this bucket.
42
373
  #
43
374
  # @return [Integer]
44
375
  required :impressions, Integer
45
376
 
46
377
  # @!attribute reach
47
- # Unique users reached on this date.
378
+ # Unique users reached in this bucket. Always `0` for hourly rows (Meta does not
379
+ # return reach at hourly grain).
48
380
  #
49
381
  # @return [Integer]
50
382
  required :reach, Integer
51
383
 
52
384
  # @!attribute result_count
53
- # Count of the primary optimization result on this date.
385
+ # Count of the primary optimization result in this bucket.
54
386
  #
55
387
  # @return [Integer, nil]
56
388
  required :result_count, Integer, nil?: true
@@ -58,10 +390,8 @@ module WhopSDK
58
390
  # @!attribute result_label_key
59
391
  # Types of optimization results tracked from external ad platforms
60
392
  #
61
- # @return [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey, nil]
62
- required :result_label_key,
63
- enum: -> { WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey },
64
- nil?: true
393
+ # @return [Symbol, WhopSDK::Models::ResultLabelKeys, nil]
394
+ required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true
65
395
 
66
396
  # @!attribute result_label_override
67
397
  # Advertiser-defined label for the result when `resultLabelKey` is `custom`.
@@ -70,7 +400,7 @@ module WhopSDK
70
400
  required :result_label_override, String, nil?: true
71
401
 
72
402
  # @!attribute spend
73
- # Charged spend on this date in the requested reporting currency — the amount
403
+ # Charged spend in this bucket in the requested reporting currency — the amount
74
404
  # billed including platform fees, not the platform-side net spend.
75
405
  #
76
406
  # @return [Float]
@@ -83,69 +413,49 @@ module WhopSDK
83
413
  required :spend_currency, enum: -> { WhopSDK::Currency }
84
414
 
85
415
  # @!attribute stat_date
86
- # The date these stats cover (midnight UTC).
416
+ # The date these stats cover (midnight UTC). For hourly rows, see `statHour` and
417
+ # `bucketStart`.
87
418
  #
88
419
  # @return [Time]
89
420
  required :stat_date, Time
90
421
 
91
- # @!method initialize(clicks:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, spend:, spend_currency:, stat_date:)
422
+ # @!attribute stat_hour
423
+ # Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
424
+ # rows.
425
+ #
426
+ # @return [Integer, nil]
427
+ required :stat_hour, Integer, nil?: true
428
+
429
+ # @!method initialize(bucket_start:, clicks:, granularity:, impressions:, reach:, result_count:, result_label_key:, result_label_override:, spend:, spend_currency:, stat_date:, stat_hour:)
92
430
  # Some parameter documentations has been truncated, see
93
- # {WhopSDK::Models::AdReportRetrieveResponse::Daily} for more details.
431
+ # {WhopSDK::Models::AdReportRetrieveResponse::Granularity} for more details.
432
+ #
433
+ # Per-bucket ad performance for an ad campaign, ad group, or ad. Bucket grain is
434
+ # set by the `ad_report` query's `granularity` argument.
94
435
  #
95
- # Per-day ad performance for an ad campaign, ad group, or ad.
436
+ # @param bucket_start [Time] The bucket's start time as a real UTC instant. `(statDate, statHour)` resolved i
96
437
  #
97
- # @param clicks [Integer] Clicks on this date.
438
+ # @param clicks [Integer] Clicks in this bucket.
98
439
  #
99
- # @param impressions [Integer] Impressions on this date.
440
+ # @param granularity [Symbol, WhopSDK::Models::Granularities] The bucket size of this row (`daily` or `hourly`).
100
441
  #
101
- # @param reach [Integer] Unique users reached on this date.
442
+ # @param impressions [Integer] Impressions in this bucket.
102
443
  #
103
- # @param result_count [Integer, nil] Count of the primary optimization result on this date.
444
+ # @param reach [Integer] Unique users reached in this bucket. Always `0` for hourly rows (Meta does not r
104
445
  #
105
- # @param result_label_key [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Daily::ResultLabelKey, nil] Types of optimization results tracked from external ad platforms
446
+ # @param result_count [Integer, nil] Count of the primary optimization result in this bucket.
447
+ #
448
+ # @param result_label_key [Symbol, WhopSDK::Models::ResultLabelKeys, nil] Types of optimization results tracked from external ad platforms
106
449
  #
107
450
  # @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
108
451
  #
109
- # @param spend [Float] Charged spend on this date in the requested reporting currency — the amount bill
452
+ # @param spend [Float] Charged spend in this bucket in the requested reporting currency — the amount bi
110
453
  #
111
454
  # @param spend_currency [Symbol, WhopSDK::Models::Currency] Currency of the `spend` value.
112
455
  #
113
- # @param stat_date [Time] The date these stats cover (midnight UTC).
114
-
115
- # Types of optimization results tracked from external ad platforms
456
+ # @param stat_date [Time] The date these stats cover (midnight UTC). For hourly rows, see `statHour` and `
116
457
  #
117
- # @see WhopSDK::Models::AdReportRetrieveResponse::Daily#result_label_key
118
- module ResultLabelKey
119
- extend WhopSDK::Internal::Type::Enum
120
-
121
- APP_INSTALLS = :app_installs
122
- MESSAGING_CONVERSATIONS_STARTED = :messaging_conversations_started
123
- POST_ENGAGEMENT = :post_engagement
124
- EVENT_RESPONSES = :event_responses
125
- IMPRESSIONS = :impressions
126
- WEBSITE_PURCHASES = :website_purchases
127
- LANDING_PAGE_VIEWS = :landing_page_views
128
- LEADS = :leads
129
- LINK_CLICKS = :link_clicks
130
- QUALITY_CALLS = :quality_calls
131
- APPOINTMENTS_BOOKED = :appointments_booked
132
- MESSAGING_PURCHASES = :messaging_purchases
133
- PAGE_LIKES = :page_likes
134
- INSTAGRAM_PROFILE_VISITS = :instagram_profile_visits
135
- REACH = :reach
136
- REMINDERS_SET = :reminders_set
137
- NEW_SUBSCRIBERS = :new_subscribers
138
- VIDEO_VIEWS = :video_views
139
- REGISTRATIONS = :registrations
140
- CONTENT_VIEWS = :content_views
141
- SEARCHES = :searches
142
- WEBSITE_SCHEDULES = :website_schedules
143
- WEBSITE_SUBMIT_APPLICATIONS = :website_submit_applications
144
- CUSTOM = :custom
145
-
146
- # @!method self.values
147
- # @return [Array<Symbol>]
148
- end
458
+ # @param stat_hour [Integer, nil] Hour of the day in the ad account's reporting timezone (0-23). `null` for daily
149
459
  end
150
460
 
151
461
  # @see WhopSDK::Models::AdReportRetrieveResponse#summary
@@ -208,10 +518,8 @@ module WhopSDK
208
518
  # @!attribute result_label_key
209
519
  # Types of optimization results tracked from external ad platforms
210
520
  #
211
- # @return [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey, nil]
212
- required :result_label_key,
213
- enum: -> { WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey },
214
- nil?: true
521
+ # @return [Symbol, WhopSDK::Models::ResultLabelKeys, nil]
522
+ required :result_label_key, enum: -> { WhopSDK::ResultLabelKeys }, nil?: true
215
523
 
216
524
  # @!attribute result_label_override
217
525
  # Advertiser-defined label for the result when `resultLabelKey` is `custom`.
@@ -262,7 +570,7 @@ module WhopSDK
262
570
  #
263
571
  # @param result_count [Integer, nil] Count of the campaign's primary optimization result (purchases, clicks, etc.) —
264
572
  #
265
- # @param result_label_key [Symbol, WhopSDK::Models::AdReportRetrieveResponse::Summary::ResultLabelKey, nil] Types of optimization results tracked from external ad platforms
573
+ # @param result_label_key [Symbol, WhopSDK::Models::ResultLabelKeys, nil] Types of optimization results tracked from external ad platforms
266
574
  #
267
575
  # @param result_label_override [String, nil] Advertiser-defined label for the result when `resultLabelKey` is `custom`.
268
576
  #
@@ -271,41 +579,6 @@ module WhopSDK
271
579
  # @param spend [Float] Total spend over the date range in the requested reporting currency.
272
580
  #
273
581
  # @param spend_currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
274
-
275
- # Types of optimization results tracked from external ad platforms
276
- #
277
- # @see WhopSDK::Models::AdReportRetrieveResponse::Summary#result_label_key
278
- module ResultLabelKey
279
- extend WhopSDK::Internal::Type::Enum
280
-
281
- APP_INSTALLS = :app_installs
282
- MESSAGING_CONVERSATIONS_STARTED = :messaging_conversations_started
283
- POST_ENGAGEMENT = :post_engagement
284
- EVENT_RESPONSES = :event_responses
285
- IMPRESSIONS = :impressions
286
- WEBSITE_PURCHASES = :website_purchases
287
- LANDING_PAGE_VIEWS = :landing_page_views
288
- LEADS = :leads
289
- LINK_CLICKS = :link_clicks
290
- QUALITY_CALLS = :quality_calls
291
- APPOINTMENTS_BOOKED = :appointments_booked
292
- MESSAGING_PURCHASES = :messaging_purchases
293
- PAGE_LIKES = :page_likes
294
- INSTAGRAM_PROFILE_VISITS = :instagram_profile_visits
295
- REACH = :reach
296
- REMINDERS_SET = :reminders_set
297
- NEW_SUBSCRIBERS = :new_subscribers
298
- VIDEO_VIEWS = :video_views
299
- REGISTRATIONS = :registrations
300
- CONTENT_VIEWS = :content_views
301
- SEARCHES = :searches
302
- WEBSITE_SCHEDULES = :website_schedules
303
- WEBSITE_SUBMIT_APPLICATIONS = :website_submit_applications
304
- CUSTOM = :custom
305
-
306
- # @!method self.values
307
- # @return [Array<Symbol>]
308
- end
309
582
  end
310
583
  end
311
584
  end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Ads#unpause
6
+ class AdUnpauseParams < 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
@@ -212,6 +212,12 @@ module WhopSDK
212
212
  # @return [Float]
213
213
  required :renewal_price, Float
214
214
 
215
+ # @!attribute three_ds_level
216
+ # The 3D Secure behavior for a plan.
217
+ #
218
+ # @return [Symbol, WhopSDK::Models::CheckoutConfiguration::Plan::ThreeDSLevel, nil]
219
+ required :three_ds_level, enum: -> { WhopSDK::CheckoutConfiguration::Plan::ThreeDSLevel }, nil?: true
220
+
215
221
  # @!attribute trial_period_days
216
222
  # The number of free trial days before the first charge on a renewal plan. Null if
217
223
  # no trial is configured or the current user has already used a trial for this
@@ -227,7 +233,7 @@ module WhopSDK
227
233
  # @return [Symbol, WhopSDK::Models::Visibility]
228
234
  required :visibility, enum: -> { WhopSDK::Visibility }
229
235
 
230
- # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, trial_period_days:, visibility:)
236
+ # @!method initialize(id:, adaptive_pricing_enabled:, billing_period:, currency:, expiration_days:, initial_price:, plan_type:, release_method:, renewal_price:, three_ds_level:, trial_period_days:, visibility:)
231
237
  # Some parameter documentations has been truncated, see
232
238
  # {WhopSDK::Models::CheckoutConfiguration::Plan} for more details.
233
239
  #
@@ -251,9 +257,24 @@ module WhopSDK
251
257
  #
252
258
  # @param renewal_price [Float] The recurring price charged every billing_period in the plan's base_currency (e.
253
259
  #
260
+ # @param three_ds_level [Symbol, WhopSDK::Models::CheckoutConfiguration::Plan::ThreeDSLevel, nil] The 3D Secure behavior for a plan.
261
+ #
254
262
  # @param trial_period_days [Integer, nil] The number of free trial days before the first charge on a renewal plan. Null if
255
263
  #
256
264
  # @param visibility [Symbol, WhopSDK::Models::Visibility] Controls whether the plan is visible to customers. When set to 'hidden', the pla
265
+
266
+ # The 3D Secure behavior for a plan.
267
+ #
268
+ # @see WhopSDK::Models::CheckoutConfiguration::Plan#three_ds_level
269
+ module ThreeDSLevel
270
+ extend WhopSDK::Internal::Type::Enum
271
+
272
+ MANDATE_CHALLENGE = :mandate_challenge
273
+ FRICTIONLESS = :frictionless
274
+
275
+ # @!method self.values
276
+ # @return [Array<Symbol>]
277
+ end
257
278
  end
258
279
  end
259
280
  end