whop_sdk 0.0.39 → 0.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (897) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +3 -3
  4. data/lib/whop_sdk/client.rb +227 -72
  5. data/lib/whop_sdk/internal/transport/base_client.rb +5 -0
  6. data/lib/whop_sdk/internal/type/union.rb +6 -6
  7. data/lib/whop_sdk/models/account.rb +967 -0
  8. data/lib/whop_sdk/models/account_create_params.rb +43 -0
  9. data/lib/whop_sdk/models/account_list_params.rb +83 -0
  10. data/lib/whop_sdk/models/account_me_params.rb +14 -0
  11. data/lib/whop_sdk/models/account_recommend_actions_params.rb +20 -0
  12. data/lib/whop_sdk/models/account_recommend_actions_response.rb +143 -0
  13. data/lib/whop_sdk/models/account_retrieve_params.rb +20 -0
  14. data/lib/whop_sdk/models/account_social_link.rb +60 -0
  15. data/lib/whop_sdk/models/account_update_params.rb +512 -0
  16. data/lib/whop_sdk/models/accounts/preference_retrieve_params.rb +22 -0
  17. data/lib/whop_sdk/models/accounts/preference_retrieve_response.rb +129 -0
  18. data/lib/whop_sdk/models/accounts/preference_update_params.rb +142 -0
  19. data/lib/whop_sdk/models/accounts/preference_update_response.rb +129 -0
  20. data/lib/whop_sdk/models/ad.rb +808 -0
  21. data/lib/whop_sdk/models/ad_campaign.rb +635 -0
  22. data/lib/whop_sdk/models/ad_campaign_create_params.rb +194 -0
  23. data/lib/whop_sdk/models/{payout_method_retrieve_params.rb → ad_campaign_delete_params.rb} +2 -2
  24. data/lib/whop_sdk/models/ad_campaign_delete_response.rb +8 -0
  25. data/lib/whop_sdk/models/ad_campaign_list_params.rb +120 -36
  26. data/lib/whop_sdk/models/ad_campaign_retrieve_params.rb +26 -1
  27. data/lib/whop_sdk/models/ad_campaign_update_params.rb +99 -6
  28. data/lib/whop_sdk/models/ad_create_params.rb +660 -0
  29. data/lib/whop_sdk/models/ad_delete_params.rb +20 -0
  30. data/lib/whop_sdk/models/ad_delete_response.rb +8 -0
  31. data/lib/whop_sdk/models/ad_group.rb +774 -0
  32. data/lib/whop_sdk/models/ad_group_create_params.rb +346 -0
  33. data/lib/whop_sdk/models/ad_group_list_params.rb +114 -44
  34. data/lib/whop_sdk/models/ad_group_pause_params.rb +20 -0
  35. data/lib/whop_sdk/models/ad_group_retrieve_params.rb +26 -1
  36. data/lib/whop_sdk/models/ad_group_unpause_params.rb +20 -0
  37. data/lib/whop_sdk/models/ad_group_update_params.rb +238 -3109
  38. data/lib/whop_sdk/models/ad_list_params.rb +127 -42
  39. data/lib/whop_sdk/models/ad_pause_params.rb +20 -0
  40. data/lib/whop_sdk/models/ad_report_retrieve_params.rb +53 -23
  41. data/lib/whop_sdk/models/ad_report_retrieve_response.rb +403 -130
  42. data/lib/whop_sdk/models/ad_retrieve_params.rb +26 -1
  43. data/lib/whop_sdk/models/ad_unpause_params.rb +20 -0
  44. data/lib/whop_sdk/models/ad_update_params.rb +650 -0
  45. data/lib/whop_sdk/models/app.rb +81 -1
  46. data/lib/whop_sdk/models/app_build_create_params.rb +2 -2
  47. data/lib/whop_sdk/models/app_create_params.rb +10 -1
  48. data/lib/whop_sdk/models/app_list_response.rb +19 -1
  49. data/lib/whop_sdk/models/app_logs_params.rb +103 -0
  50. data/lib/whop_sdk/models/app_logs_response.rb +157 -0
  51. data/lib/whop_sdk/models/app_update_params.rb +21 -1
  52. data/lib/whop_sdk/models/audience.rb +191 -0
  53. data/lib/whop_sdk/models/audience_create_params.rb +96 -0
  54. data/lib/whop_sdk/models/audience_delete_params.rb +20 -0
  55. data/lib/whop_sdk/models/audience_delete_response.rb +16 -0
  56. data/lib/whop_sdk/models/audience_list_params.rb +46 -0
  57. data/lib/whop_sdk/models/authorized_user_create_params.rb +70 -1
  58. data/lib/whop_sdk/models/bounty_create_params.rb +70 -3
  59. data/lib/whop_sdk/models/bounty_create_response.rb +1 -0
  60. data/lib/whop_sdk/models/bounty_list_params.rb +1 -0
  61. data/lib/whop_sdk/models/bounty_list_response.rb +1 -0
  62. data/lib/whop_sdk/models/bounty_retrieve_response.rb +1 -0
  63. data/lib/whop_sdk/models/card_brands.rb +1 -0
  64. data/lib/whop_sdk/models/card_create_params.rb +88 -0
  65. data/lib/whop_sdk/models/card_create_response.rb +277 -0
  66. data/lib/whop_sdk/models/card_list_params.rb +30 -0
  67. data/lib/whop_sdk/models/card_list_response.rb +287 -0
  68. data/lib/whop_sdk/models/card_retrieve_params.rb +37 -0
  69. data/lib/whop_sdk/models/card_retrieve_response.rb +277 -0
  70. data/lib/whop_sdk/models/card_update_params.rb +181 -0
  71. data/lib/whop_sdk/models/card_update_response.rb +277 -0
  72. data/lib/whop_sdk/models/chat_message_created_webhook_event.rb +151 -0
  73. data/lib/whop_sdk/models/chat_reaction_created_webhook_event.rb +159 -0
  74. data/lib/whop_sdk/models/checkout_configuration.rb +35 -24
  75. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +303 -1021
  76. data/lib/whop_sdk/models/checkout_configuration_create_response.rb +275 -0
  77. data/lib/whop_sdk/models/checkout_configuration_delete_params.rb +20 -0
  78. data/lib/whop_sdk/models/checkout_configuration_list_params.rb +50 -41
  79. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +136 -122
  80. data/lib/whop_sdk/models/checkout_configuration_retrieve_response.rb +275 -0
  81. data/lib/whop_sdk/models/company.rb +2 -2
  82. data/lib/whop_sdk/models/company_list_response.rb +2 -2
  83. data/lib/whop_sdk/models/course.rb +2 -2
  84. data/lib/whop_sdk/models/course_list_response.rb +2 -2
  85. data/lib/whop_sdk/models/currency.rb +3 -0
  86. data/lib/whop_sdk/models/deposit_create_params.rb +90 -0
  87. data/lib/whop_sdk/models/deposit_create_response.rb +228 -0
  88. data/lib/whop_sdk/models/deposit_list_params.rb +22 -0
  89. data/lib/whop_sdk/models/deposit_list_response.rb +101 -0
  90. data/lib/whop_sdk/models/dispute.rb +14 -15
  91. data/lib/whop_sdk/models/dispute_alert_created_webhook_event.rb +4 -4
  92. data/lib/whop_sdk/models/dispute_alert_retrieve_response.rb +4 -4
  93. data/lib/whop_sdk/models/dispute_list_response.rb +2 -3
  94. data/lib/whop_sdk/models/{conversion_create_params.rb → event_create_params.rb} +294 -32
  95. data/lib/whop_sdk/models/event_create_response.rb +16 -0
  96. data/lib/whop_sdk/models/event_list_params.rb +75 -0
  97. data/lib/whop_sdk/models/event_list_response.rb +242 -0
  98. data/lib/whop_sdk/models/experience.rb +5 -8
  99. data/lib/whop_sdk/models/experience_list_response.rb +2 -5
  100. data/lib/whop_sdk/models/file_create_params.rb +3 -15
  101. data/lib/whop_sdk/models/file_create_response.rb +3 -16
  102. data/lib/whop_sdk/models/file_retrieve_response.rb +3 -16
  103. data/lib/whop_sdk/models/file_visibility.rb +17 -0
  104. data/lib/whop_sdk/models/financial_activity_list_params.rb +113 -0
  105. data/lib/whop_sdk/models/financial_activity_list_response.rb +1174 -0
  106. data/lib/whop_sdk/models/forum_post.rb +2 -2
  107. data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
  108. data/lib/whop_sdk/models/granularities.rb +18 -0
  109. data/lib/whop_sdk/models/identity_profile_approved_webhook_event.rb +431 -0
  110. data/lib/whop_sdk/models/identity_profile_needs_action_webhook_event.rb +432 -0
  111. data/lib/whop_sdk/models/identity_profile_rejected_webhook_event.rb +431 -0
  112. data/lib/whop_sdk/models/identity_profile_updated_webhook_event.rb +431 -0
  113. data/lib/whop_sdk/models/invoice_create_params.rb +34 -2
  114. data/lib/whop_sdk/models/invoice_update_params.rb +17 -1
  115. data/lib/whop_sdk/models/ledger_account_funds_available_webhook_event.rb +578 -0
  116. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +67 -7
  117. data/lib/whop_sdk/models/lesson.rb +6 -6
  118. data/lib/whop_sdk/models/media_asset.rb +224 -0
  119. data/lib/whop_sdk/models/media_generate_params.rb +105 -0
  120. data/lib/whop_sdk/models/media_retrieve_params.rb +20 -0
  121. data/lib/whop_sdk/models/member_list_response.rb +3 -2
  122. data/lib/whop_sdk/models/member_retrieve_response.rb +3 -2
  123. data/lib/whop_sdk/models/membership.rb +26 -3
  124. data/lib/whop_sdk/models/membership_list_response.rb +26 -3
  125. data/lib/whop_sdk/models/membership_trial_ending_soon_webhook_event.rb +60 -0
  126. data/lib/whop_sdk/models/payment.rb +213 -26
  127. data/lib/whop_sdk/models/payment_create_params.rb +22 -2
  128. data/lib/whop_sdk/models/payment_list_params.rb +9 -1
  129. data/lib/whop_sdk/models/payment_list_response.rb +118 -17
  130. data/lib/whop_sdk/models/payout_create_params.rb +58 -0
  131. data/lib/whop_sdk/models/payout_create_response.rb +185 -0
  132. data/lib/whop_sdk/models/payout_list_params.rb +70 -0
  133. data/lib/whop_sdk/models/payout_list_response.rb +195 -0
  134. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +20 -3
  135. data/lib/whop_sdk/models/payouts/method_list_params.rb +120 -0
  136. data/lib/whop_sdk/models/payouts/method_list_response.rb +315 -0
  137. data/lib/whop_sdk/models/person_list_params.rb +103 -0
  138. data/lib/whop_sdk/models/person_list_response.rb +167 -0
  139. data/lib/whop_sdk/models/person_retrieve_params.rb +50 -0
  140. data/lib/whop_sdk/models/person_retrieve_response.rb +179 -0
  141. data/lib/whop_sdk/models/plan.rb +311 -246
  142. data/lib/whop_sdk/models/plan_calculate_tax_params.rb +248 -0
  143. data/lib/whop_sdk/models/plan_calculate_tax_response.rb +94 -0
  144. data/lib/whop_sdk/models/plan_create_params.rb +137 -153
  145. data/lib/whop_sdk/models/plan_list_params.rb +54 -47
  146. data/lib/whop_sdk/models/plan_list_response.rb +105 -221
  147. data/lib/whop_sdk/models/plan_update_params.rb +116 -133
  148. data/lib/whop_sdk/models/product.rb +40 -37
  149. data/lib/whop_sdk/models/product_create_params.rb +48 -189
  150. data/lib/whop_sdk/models/product_list_item.rb +20 -11
  151. data/lib/whop_sdk/models/product_list_params.rb +35 -57
  152. data/lib/whop_sdk/models/product_update_params.rb +20 -148
  153. data/lib/whop_sdk/models/referral_referred_users_params.rb +66 -0
  154. data/lib/whop_sdk/models/referral_referred_users_response.rb +127 -0
  155. data/lib/whop_sdk/models/referrals/business_leaderboard_params.rb +45 -0
  156. data/lib/whop_sdk/models/referrals/business_leaderboard_response.rb +284 -0
  157. data/lib/whop_sdk/models/referrals/business_list_params.rb +175 -0
  158. data/lib/whop_sdk/models/referrals/business_list_response.rb +361 -0
  159. data/lib/whop_sdk/models/referrals/business_retrieve_params.rb +22 -0
  160. data/lib/whop_sdk/models/referrals/business_retrieve_response.rb +881 -0
  161. data/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb +131 -0
  162. data/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb +371 -0
  163. data/lib/whop_sdk/models/referrals/partner_create_params.rb +16 -0
  164. data/lib/whop_sdk/models/referrals/partner_create_response.rb +31 -0
  165. data/lib/whop_sdk/models/refund_created_webhook_event.rb +86 -5
  166. data/lib/whop_sdk/models/refund_retrieve_response.rb +84 -5
  167. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +86 -5
  168. data/lib/whop_sdk/models/resolution_center_case_platform_response.rb +0 -1
  169. data/lib/whop_sdk/models/result_label_keys.rb +48 -0
  170. data/lib/whop_sdk/models/review_list_response.rb +2 -2
  171. data/lib/whop_sdk/models/review_retrieve_response.rb +4 -7
  172. data/lib/whop_sdk/models/setup_intent.rb +10 -1
  173. data/lib/whop_sdk/models/social_account.rb +101 -0
  174. data/lib/whop_sdk/models/social_account_connect_params.rb +74 -0
  175. data/lib/whop_sdk/models/social_account_connect_response.rb +17 -0
  176. data/lib/whop_sdk/models/social_account_create_params.rb +45 -0
  177. data/lib/whop_sdk/models/social_account_delete_params.rb +42 -0
  178. data/lib/whop_sdk/models/social_account_delete_response.rb +8 -0
  179. data/lib/whop_sdk/models/social_account_list_params.rb +152 -0
  180. data/lib/whop_sdk/models/social_account_post.rb +99 -0
  181. data/lib/whop_sdk/models/social_account_posts_params.rb +53 -0
  182. data/lib/whop_sdk/models/social_account_posts_response.rb +39 -0
  183. data/lib/whop_sdk/models/stat_list_params.rb +14 -0
  184. data/lib/whop_sdk/models/stat_list_response.rb +89 -0
  185. data/lib/whop_sdk/models/stat_retrieve_params.rb +265 -0
  186. data/lib/whop_sdk/models/stat_retrieve_response.rb +88 -0
  187. data/lib/whop_sdk/models/swap_create_params.rb +101 -0
  188. data/lib/whop_sdk/models/swap_create_quote_params.rb +117 -0
  189. data/lib/whop_sdk/models/swap_create_quote_response.rb +130 -0
  190. data/lib/whop_sdk/models/swap_create_response.rb +82 -0
  191. data/lib/whop_sdk/models/swap_list_params.rb +22 -0
  192. data/lib/whop_sdk/models/swap_list_response.rb +77 -0
  193. data/lib/whop_sdk/models/swap_retrieve_params.rb +20 -0
  194. data/lib/whop_sdk/models/swap_retrieve_response.rb +66 -0
  195. data/lib/whop_sdk/models/tax_identifier_type.rb +2 -0
  196. data/lib/whop_sdk/models/transfer_create_params.rb +62 -27
  197. data/lib/whop_sdk/models/transfer_create_response.rb +452 -0
  198. data/lib/whop_sdk/models/transfer_list_params.rb +46 -40
  199. data/lib/whop_sdk/models/transfer_list_response.rb +29 -36
  200. data/lib/whop_sdk/models/transfer_retrieve_response.rb +267 -0
  201. data/lib/whop_sdk/models/unwrap_webhook_event.rb +46 -30
  202. data/lib/whop_sdk/models/user.rb +276 -31
  203. data/lib/whop_sdk/models/user_balance.rb +226 -0
  204. data/lib/whop_sdk/models/user_check_access_response.rb +16 -9
  205. data/lib/whop_sdk/models/user_list_params.rb +15 -15
  206. data/lib/whop_sdk/models/user_retrieve_params.rb +66 -6
  207. data/lib/whop_sdk/models/user_update_me_params.rb +70 -0
  208. data/lib/whop_sdk/models/user_update_params.rb +23 -30
  209. data/lib/whop_sdk/models/verification_create_params.rb +414 -0
  210. data/lib/whop_sdk/models/verification_create_response.rb +400 -0
  211. data/lib/whop_sdk/models/verification_list_params.rb +40 -30
  212. data/lib/whop_sdk/models/verification_list_response.rb +396 -34
  213. data/lib/whop_sdk/models/verification_retrieve_params.rb +4 -4
  214. data/lib/whop_sdk/models/verification_retrieve_response.rb +373 -21
  215. data/lib/whop_sdk/models/verification_update_params.rb +578 -0
  216. data/lib/whop_sdk/models/verification_update_response.rb +400 -0
  217. data/lib/whop_sdk/models/webhook_event.rb +8 -0
  218. data/lib/whop_sdk/models/withdrawal.rb +1 -0
  219. data/lib/whop_sdk/models/withdrawal_create_params.rb +2 -2
  220. data/lib/whop_sdk/models/workforce/bounty_list_params.rb +153 -0
  221. data/lib/whop_sdk/models/workforce/bounty_retrieve_params.rb +22 -0
  222. data/lib/whop_sdk/models/workforce/workforce_bounty.rb +351 -0
  223. data/lib/whop_sdk/models/workforce/workforce_bounty_list_item.rb +347 -0
  224. data/lib/whop_sdk/models.rb +151 -7
  225. data/lib/whop_sdk/resources/access_tokens.rb +0 -1
  226. data/lib/whop_sdk/resources/account_links.rb +0 -1
  227. data/lib/whop_sdk/resources/accounts/preferences.rb +78 -0
  228. data/lib/whop_sdk/resources/accounts.rb +254 -0
  229. data/lib/whop_sdk/resources/ad_campaigns.rb +136 -47
  230. data/lib/whop_sdk/resources/ad_groups.rb +194 -47
  231. data/lib/whop_sdk/resources/ad_reports.rb +14 -9
  232. data/lib/whop_sdk/resources/ads.rb +210 -25
  233. data/lib/whop_sdk/resources/affiliates/overrides.rb +0 -1
  234. data/lib/whop_sdk/resources/affiliates.rb +0 -2
  235. data/lib/whop_sdk/resources/ai_chats.rb +0 -1
  236. data/lib/whop_sdk/resources/app_builds.rb +0 -1
  237. data/lib/whop_sdk/resources/apps.rb +63 -3
  238. data/lib/whop_sdk/resources/audiences.rb +104 -0
  239. data/lib/whop_sdk/resources/authorized_users.rb +3 -2
  240. data/lib/whop_sdk/resources/bounties.rb +9 -2
  241. data/lib/whop_sdk/resources/cards.rb +178 -0
  242. data/lib/whop_sdk/resources/chat_channels.rb +0 -1
  243. data/lib/whop_sdk/resources/checkout_configurations.rb +69 -42
  244. data/lib/whop_sdk/resources/companies.rb +0 -1
  245. data/lib/whop_sdk/resources/company_token_transactions.rb +0 -1
  246. data/lib/whop_sdk/resources/course_chapters.rb +0 -1
  247. data/lib/whop_sdk/resources/course_lesson_interactions.rb +0 -1
  248. data/lib/whop_sdk/resources/course_lessons.rb +0 -1
  249. data/lib/whop_sdk/resources/course_students.rb +0 -1
  250. data/lib/whop_sdk/resources/courses.rb +0 -1
  251. data/lib/whop_sdk/resources/deposits.rb +77 -0
  252. data/lib/whop_sdk/resources/dispute_alerts.rb +0 -1
  253. data/lib/whop_sdk/resources/disputes.rb +0 -1
  254. data/lib/whop_sdk/resources/dm_channels.rb +0 -1
  255. data/lib/whop_sdk/resources/dm_members.rb +0 -1
  256. data/lib/whop_sdk/resources/entries.rb +0 -1
  257. data/lib/whop_sdk/resources/events.rb +121 -0
  258. data/lib/whop_sdk/resources/experiences.rb +0 -1
  259. data/lib/whop_sdk/resources/fee_markups.rb +0 -1
  260. data/lib/whop_sdk/resources/files.rb +1 -2
  261. data/lib/whop_sdk/resources/financial_activity.rb +76 -0
  262. data/lib/whop_sdk/resources/forum_posts.rb +0 -1
  263. data/lib/whop_sdk/resources/forums.rb +0 -1
  264. data/lib/whop_sdk/resources/invoices.rb +0 -1
  265. data/lib/whop_sdk/resources/leads.rb +0 -1
  266. data/lib/whop_sdk/resources/ledger_accounts.rb +0 -1
  267. data/lib/whop_sdk/resources/media.rb +77 -0
  268. data/lib/whop_sdk/resources/members.rb +0 -1
  269. data/lib/whop_sdk/resources/memberships.rb +0 -1
  270. data/lib/whop_sdk/resources/messages.rb +0 -1
  271. data/lib/whop_sdk/resources/notifications.rb +0 -1
  272. data/lib/whop_sdk/resources/payment_methods.rb +0 -1
  273. data/lib/whop_sdk/resources/payments.rb +3 -2
  274. data/lib/whop_sdk/resources/payout_accounts.rb +0 -1
  275. data/lib/whop_sdk/resources/payouts/methods.rb +71 -0
  276. data/lib/whop_sdk/resources/payouts.rb +107 -0
  277. data/lib/whop_sdk/resources/people.rb +99 -0
  278. data/lib/whop_sdk/resources/plans.rb +99 -79
  279. data/lib/whop_sdk/resources/products.rb +48 -93
  280. data/lib/whop_sdk/resources/promo_codes.rb +0 -1
  281. data/lib/whop_sdk/resources/reactions.rb +0 -1
  282. data/lib/whop_sdk/resources/referrals/businesses/earnings.rb +67 -0
  283. data/lib/whop_sdk/resources/referrals/businesses.rb +132 -0
  284. data/lib/whop_sdk/resources/referrals/partners.rb +42 -0
  285. data/lib/whop_sdk/resources/referrals.rb +77 -0
  286. data/lib/whop_sdk/resources/refunds.rb +2 -1
  287. data/lib/whop_sdk/resources/resolution_center_cases.rb +0 -1
  288. data/lib/whop_sdk/resources/reviews.rb +0 -1
  289. data/lib/whop_sdk/resources/setup_intents.rb +0 -1
  290. data/lib/whop_sdk/resources/shipments.rb +0 -1
  291. data/lib/whop_sdk/resources/social_accounts.rb +192 -0
  292. data/lib/whop_sdk/resources/stats.rb +113 -0
  293. data/lib/whop_sdk/resources/support_channels.rb +0 -1
  294. data/lib/whop_sdk/resources/swaps.rb +143 -0
  295. data/lib/whop_sdk/resources/topups.rb +0 -1
  296. data/lib/whop_sdk/resources/transfers.rb +42 -42
  297. data/lib/whop_sdk/resources/users.rb +82 -33
  298. data/lib/whop_sdk/resources/verifications.rb +81 -20
  299. data/lib/whop_sdk/resources/webhooks.rb +1 -2
  300. data/lib/whop_sdk/resources/withdrawals.rb +1 -2
  301. data/lib/whop_sdk/resources/workforce/bounties.rb +97 -0
  302. data/lib/whop_sdk/resources/workforce.rb +25 -0
  303. data/lib/whop_sdk/version.rb +1 -1
  304. data/lib/whop_sdk.rb +148 -21
  305. data/rbi/whop_sdk/client.rbi +211 -69
  306. data/rbi/whop_sdk/models/account.rbi +1532 -0
  307. data/rbi/whop_sdk/models/account_create_params.rbi +72 -0
  308. data/rbi/whop_sdk/models/account_list_params.rbi +145 -0
  309. data/rbi/whop_sdk/models/account_me_params.rbi +27 -0
  310. data/rbi/whop_sdk/models/account_recommend_actions_params.rbi +38 -0
  311. data/rbi/whop_sdk/models/account_recommend_actions_response.rbi +296 -0
  312. data/rbi/whop_sdk/models/account_retrieve_params.rbi +35 -0
  313. data/rbi/whop_sdk/models/account_social_link.rbi +96 -0
  314. data/rbi/whop_sdk/models/account_update_params.rbi +1141 -0
  315. data/rbi/whop_sdk/models/accounts/preference_retrieve_params.rbi +40 -0
  316. data/rbi/whop_sdk/models/accounts/preference_retrieve_response.rbi +323 -0
  317. data/rbi/whop_sdk/models/accounts/preference_update_params.rbi +331 -0
  318. data/rbi/whop_sdk/models/accounts/preference_update_response.rbi +323 -0
  319. data/rbi/whop_sdk/models/ad.rbi +983 -0
  320. data/rbi/whop_sdk/models/ad_campaign.rbi +846 -0
  321. data/rbi/whop_sdk/models/ad_campaign_create_params.rbi +428 -0
  322. data/rbi/whop_sdk/models/{payout_method_retrieve_params.rbi → ad_campaign_delete_params.rbi} +2 -2
  323. data/rbi/whop_sdk/models/ad_campaign_delete_response.rbi +8 -0
  324. data/rbi/whop_sdk/models/ad_campaign_list_params.rbi +248 -56
  325. data/rbi/whop_sdk/models/ad_campaign_retrieve_params.rbi +41 -2
  326. data/rbi/whop_sdk/models/ad_campaign_update_params.rbi +207 -8
  327. data/rbi/whop_sdk/models/ad_create_params.rbi +1491 -0
  328. data/rbi/whop_sdk/models/ad_delete_params.rbi +35 -0
  329. data/rbi/whop_sdk/models/ad_delete_response.rbi +7 -0
  330. data/rbi/whop_sdk/models/ad_group.rbi +948 -0
  331. data/rbi/whop_sdk/models/ad_group_create_params.rbi +654 -0
  332. data/rbi/whop_sdk/models/ad_group_list_params.rbi +217 -67
  333. data/rbi/whop_sdk/models/ad_group_pause_params.rbi +35 -0
  334. data/rbi/whop_sdk/models/ad_group_retrieve_params.rbi +41 -2
  335. data/rbi/whop_sdk/models/ad_group_unpause_params.rbi +35 -0
  336. data/rbi/whop_sdk/models/ad_group_update_params.rbi +494 -5988
  337. data/rbi/whop_sdk/models/ad_list_params.rbi +220 -59
  338. data/rbi/whop_sdk/models/ad_pause_params.rbi +35 -0
  339. data/rbi/whop_sdk/models/ad_report_retrieve_params.rbi +89 -33
  340. data/rbi/whop_sdk/models/ad_report_retrieve_response.rbi +566 -378
  341. data/rbi/whop_sdk/models/ad_retrieve_params.rbi +41 -2
  342. data/rbi/whop_sdk/models/ad_unpause_params.rbi +35 -0
  343. data/rbi/whop_sdk/models/ad_update_params.rbi +1473 -0
  344. data/rbi/whop_sdk/models/app.rbi +111 -0
  345. data/rbi/whop_sdk/models/app_build_create_params.rbi +3 -3
  346. data/rbi/whop_sdk/models/app_create_params.rbi +10 -0
  347. data/rbi/whop_sdk/models/app_list_response.rbi +20 -0
  348. data/rbi/whop_sdk/models/app_logs_params.rbi +154 -0
  349. data/rbi/whop_sdk/models/app_logs_response.rbi +261 -0
  350. data/rbi/whop_sdk/models/app_update_params.rbi +24 -0
  351. data/rbi/whop_sdk/models/audience.rbi +262 -0
  352. data/rbi/whop_sdk/models/audience_create_params.rbi +160 -0
  353. data/rbi/whop_sdk/models/audience_delete_params.rbi +35 -0
  354. data/rbi/whop_sdk/models/audience_delete_response.rbi +26 -0
  355. data/rbi/whop_sdk/models/audience_list_params.rbi +76 -0
  356. data/rbi/whop_sdk/models/authorized_user_create_params.rbi +102 -0
  357. data/rbi/whop_sdk/models/bounty_create_params.rbi +164 -4
  358. data/rbi/whop_sdk/models/bounty_create_response.rbi +5 -0
  359. data/rbi/whop_sdk/models/bounty_list_params.rbi +2 -0
  360. data/rbi/whop_sdk/models/bounty_list_response.rbi +5 -0
  361. data/rbi/whop_sdk/models/bounty_retrieve_response.rbi +5 -0
  362. data/rbi/whop_sdk/models/card_brands.rbi +1 -0
  363. data/rbi/whop_sdk/models/card_create_params.rbi +167 -0
  364. data/rbi/whop_sdk/models/card_create_response.rbi +446 -0
  365. data/rbi/whop_sdk/models/card_list_params.rbi +57 -0
  366. data/rbi/whop_sdk/models/card_list_response.rbi +511 -0
  367. data/rbi/whop_sdk/models/card_retrieve_params.rbi +63 -0
  368. data/rbi/whop_sdk/models/card_retrieve_response.rbi +457 -0
  369. data/rbi/whop_sdk/models/card_update_params.rbi +299 -0
  370. data/rbi/whop_sdk/models/card_update_response.rbi +446 -0
  371. data/rbi/whop_sdk/models/chat_message_created_webhook_event.rbi +319 -0
  372. data/rbi/whop_sdk/models/chat_reaction_created_webhook_event.rbi +335 -0
  373. data/rbi/whop_sdk/models/checkout_configuration.rbi +84 -44
  374. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +404 -1537
  375. data/rbi/whop_sdk/models/checkout_configuration_create_response.rbi +420 -0
  376. data/rbi/whop_sdk/models/checkout_configuration_delete_params.rbi +38 -0
  377. data/rbi/whop_sdk/models/checkout_configuration_list_params.rbi +142 -51
  378. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +202 -161
  379. data/rbi/whop_sdk/models/checkout_configuration_retrieve_response.rbi +422 -0
  380. data/rbi/whop_sdk/models/company.rbi +2 -2
  381. data/rbi/whop_sdk/models/company_list_response.rbi +2 -2
  382. data/rbi/whop_sdk/models/course.rbi +2 -2
  383. data/rbi/whop_sdk/models/course_list_response.rbi +2 -2
  384. data/rbi/whop_sdk/models/currency.rbi +3 -0
  385. data/rbi/whop_sdk/models/deposit_create_params.rbi +165 -0
  386. data/rbi/whop_sdk/models/deposit_create_response.rbi +437 -0
  387. data/rbi/whop_sdk/models/deposit_list_params.rbi +40 -0
  388. data/rbi/whop_sdk/models/deposit_list_response.rbi +163 -0
  389. data/rbi/whop_sdk/models/dispute.rbi +15 -17
  390. data/rbi/whop_sdk/models/dispute_alert_created_webhook_event.rbi +5 -5
  391. data/rbi/whop_sdk/models/dispute_alert_retrieve_response.rbi +5 -5
  392. data/rbi/whop_sdk/models/dispute_list_response.rbi +2 -4
  393. data/rbi/whop_sdk/models/event_create_params.rbi +891 -0
  394. data/rbi/whop_sdk/models/{conversion_create_response.rbi → event_create_response.rbi} +3 -8
  395. data/rbi/whop_sdk/models/event_list_params.rbi +111 -0
  396. data/rbi/whop_sdk/models/event_list_response.rbi +350 -0
  397. data/rbi/whop_sdk/models/experience.rbi +6 -6
  398. data/rbi/whop_sdk/models/experience_list_response.rbi +2 -2
  399. data/rbi/whop_sdk/models/file_create_params.rbi +3 -30
  400. data/rbi/whop_sdk/models/file_create_response.rbi +3 -38
  401. data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -39
  402. data/rbi/whop_sdk/models/file_visibility.rbi +21 -0
  403. data/rbi/whop_sdk/models/financial_activity_list_params.rbi +175 -0
  404. data/rbi/whop_sdk/models/financial_activity_list_response.rbi +2066 -0
  405. data/rbi/whop_sdk/models/forum_post.rbi +2 -2
  406. data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
  407. data/rbi/whop_sdk/models/granularities.rbi +22 -0
  408. data/rbi/whop_sdk/models/identity_profile_approved_webhook_event.rbi +669 -0
  409. data/rbi/whop_sdk/models/identity_profile_needs_action_webhook_event.rbi +669 -0
  410. data/rbi/whop_sdk/models/identity_profile_rejected_webhook_event.rbi +669 -0
  411. data/rbi/whop_sdk/models/identity_profile_updated_webhook_event.rbi +669 -0
  412. data/rbi/whop_sdk/models/invoice_create_params.rbi +32 -0
  413. data/rbi/whop_sdk/models/invoice_update_params.rbi +16 -0
  414. data/rbi/whop_sdk/models/ledger_account_funds_available_webhook_event.rbi +1001 -0
  415. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +111 -5
  416. data/rbi/whop_sdk/models/lesson.rbi +6 -6
  417. data/rbi/whop_sdk/models/media_asset.rbi +325 -0
  418. data/rbi/whop_sdk/models/media_generate_params.rbi +204 -0
  419. data/rbi/whop_sdk/models/media_retrieve_params.rbi +35 -0
  420. data/rbi/whop_sdk/models/member_list_response.rbi +4 -2
  421. data/rbi/whop_sdk/models/member_retrieve_response.rbi +4 -2
  422. data/rbi/whop_sdk/models/membership.rbi +50 -7
  423. data/rbi/whop_sdk/models/membership_list_response.rbi +50 -7
  424. data/rbi/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbi +85 -0
  425. data/rbi/whop_sdk/models/payment.rbi +295 -40
  426. data/rbi/whop_sdk/models/payment_create_params.rbi +30 -6
  427. data/rbi/whop_sdk/models/payment_list_params.rbi +8 -0
  428. data/rbi/whop_sdk/models/payment_list_response.rbi +188 -28
  429. data/rbi/whop_sdk/models/payout_create_params.rbi +83 -0
  430. data/rbi/whop_sdk/models/payout_create_response.rbi +352 -0
  431. data/rbi/whop_sdk/models/payout_list_params.rbi +112 -0
  432. data/rbi/whop_sdk/models/payout_list_response.rbi +353 -0
  433. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +64 -3
  434. data/rbi/whop_sdk/models/payouts/method_list_params.rbi +209 -0
  435. data/rbi/whop_sdk/models/payouts/method_list_response.rbi +554 -0
  436. data/rbi/whop_sdk/models/person_list_params.rbi +160 -0
  437. data/rbi/whop_sdk/models/person_list_response.rbi +282 -0
  438. data/rbi/whop_sdk/models/person_retrieve_params.rbi +76 -0
  439. data/rbi/whop_sdk/models/person_retrieve_response.rbi +349 -0
  440. data/rbi/whop_sdk/models/plan.rbi +346 -332
  441. data/rbi/whop_sdk/models/plan_calculate_tax_params.rbi +795 -0
  442. data/rbi/whop_sdk/models/plan_calculate_tax_response.rbi +170 -0
  443. data/rbi/whop_sdk/models/plan_create_params.rbi +267 -217
  444. data/rbi/whop_sdk/models/plan_list_params.rbi +121 -67
  445. data/rbi/whop_sdk/models/plan_list_response.rbi +127 -360
  446. data/rbi/whop_sdk/models/plan_update_params.rbi +228 -192
  447. data/rbi/whop_sdk/models/product.rbi +48 -44
  448. data/rbi/whop_sdk/models/product_create_params.rbi +69 -273
  449. data/rbi/whop_sdk/models/product_list_item.rbi +24 -14
  450. data/rbi/whop_sdk/models/product_list_params.rbi +75 -78
  451. data/rbi/whop_sdk/models/product_update_params.rbi +30 -207
  452. data/rbi/whop_sdk/models/referral_referred_users_params.rbi +106 -0
  453. data/rbi/whop_sdk/models/referral_referred_users_response.rbi +259 -0
  454. data/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi +120 -0
  455. data/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi +535 -0
  456. data/rbi/whop_sdk/models/referrals/business_list_params.rbi +376 -0
  457. data/rbi/whop_sdk/models/referrals/business_list_response.rbi +701 -0
  458. data/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi +40 -0
  459. data/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi +1846 -0
  460. data/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi +308 -0
  461. data/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi +693 -0
  462. data/rbi/whop_sdk/models/referrals/partner_create_params.rbi +32 -0
  463. data/rbi/whop_sdk/models/referrals/partner_create_response.rbi +48 -0
  464. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +163 -5
  465. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +161 -5
  466. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +163 -5
  467. data/rbi/whop_sdk/models/resolution_center_case_platform_response.rbi +0 -5
  468. data/rbi/whop_sdk/models/result_label_keys.rbi +87 -0
  469. data/rbi/whop_sdk/models/review_list_response.rbi +2 -2
  470. data/rbi/whop_sdk/models/review_retrieve_response.rbi +4 -4
  471. data/rbi/whop_sdk/models/setup_intent.rbi +13 -3
  472. data/rbi/whop_sdk/models/social_account.rbi +129 -0
  473. data/rbi/whop_sdk/models/social_account_connect_params.rbi +146 -0
  474. data/rbi/whop_sdk/models/social_account_connect_response.rbi +30 -0
  475. data/rbi/whop_sdk/models/social_account_create_params.rbi +81 -0
  476. data/rbi/whop_sdk/models/social_account_delete_params.rbi +67 -0
  477. data/rbi/whop_sdk/models/social_account_delete_response.rbi +8 -0
  478. data/rbi/whop_sdk/models/social_account_list_params.rbi +308 -0
  479. data/rbi/whop_sdk/models/social_account_post.rbi +261 -0
  480. data/rbi/whop_sdk/models/social_account_posts_params.rbi +82 -0
  481. data/rbi/whop_sdk/models/social_account_posts_response.rbi +83 -0
  482. data/rbi/whop_sdk/models/stat_list_params.rbi +27 -0
  483. data/rbi/whop_sdk/models/stat_list_response.rbi +159 -0
  484. data/rbi/whop_sdk/models/stat_retrieve_params.rbi +411 -0
  485. data/rbi/whop_sdk/models/stat_retrieve_response.rbi +198 -0
  486. data/rbi/whop_sdk/models/swap_create_params.rbi +128 -0
  487. data/rbi/whop_sdk/models/swap_create_quote_params.rbi +154 -0
  488. data/rbi/whop_sdk/models/swap_create_quote_response.rbi +174 -0
  489. data/rbi/whop_sdk/models/swap_create_response.rbi +127 -0
  490. data/rbi/whop_sdk/models/swap_list_params.rbi +40 -0
  491. data/rbi/whop_sdk/models/swap_list_response.rbi +137 -0
  492. data/rbi/whop_sdk/models/swap_retrieve_params.rbi +35 -0
  493. data/rbi/whop_sdk/models/swap_retrieve_response.rbi +106 -0
  494. data/rbi/whop_sdk/models/tax_identifier_type.rbi +2 -0
  495. data/rbi/whop_sdk/models/transfer_create_params.rbi +94 -36
  496. data/rbi/whop_sdk/models/transfer_create_response.rbi +767 -0
  497. data/rbi/whop_sdk/models/transfer_list_params.rbi +111 -60
  498. data/rbi/whop_sdk/models/transfer_list_response.rbi +32 -40
  499. data/rbi/whop_sdk/models/transfer_retrieve_response.rbi +416 -0
  500. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +29 -21
  501. data/rbi/whop_sdk/models/user.rbi +427 -45
  502. data/rbi/whop_sdk/models/user_balance.rbi +301 -0
  503. data/rbi/whop_sdk/models/user_check_access_response.rbi +46 -12
  504. data/rbi/whop_sdk/models/user_list_params.rbi +40 -25
  505. data/rbi/whop_sdk/models/user_retrieve_params.rbi +106 -8
  506. data/rbi/whop_sdk/models/user_update_me_params.rbi +120 -0
  507. data/rbi/whop_sdk/models/user_update_params.rbi +46 -45
  508. data/rbi/whop_sdk/models/verification_create_params.rbi +783 -0
  509. data/rbi/whop_sdk/models/verification_create_response.rbi +757 -0
  510. data/rbi/whop_sdk/models/verification_list_params.rbi +88 -34
  511. data/rbi/whop_sdk/models/verification_list_response.rbi +783 -39
  512. data/rbi/whop_sdk/models/verification_retrieve_params.rbi +4 -4
  513. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +722 -30
  514. data/rbi/whop_sdk/models/verification_update_params.rbi +1187 -0
  515. data/rbi/whop_sdk/models/verification_update_response.rbi +757 -0
  516. data/rbi/whop_sdk/models/webhook_event.rbi +25 -0
  517. data/rbi/whop_sdk/models/withdrawal.rbi +5 -0
  518. data/rbi/whop_sdk/models/withdrawal_create_params.rbi +2 -2
  519. data/rbi/whop_sdk/models/workforce/bounty_list_params.rbi +313 -0
  520. data/rbi/whop_sdk/models/workforce/bounty_retrieve_params.rbi +40 -0
  521. data/rbi/whop_sdk/models/workforce/workforce_bounty.rbi +588 -0
  522. data/rbi/whop_sdk/models/workforce/workforce_bounty_list_item.rbi +590 -0
  523. data/rbi/whop_sdk/models.rbi +160 -7
  524. data/rbi/whop_sdk/resources/access_tokens.rbi +0 -1
  525. data/rbi/whop_sdk/resources/account_links.rbi +0 -1
  526. data/rbi/whop_sdk/resources/accounts/preferences.rbi +62 -0
  527. data/rbi/whop_sdk/resources/accounts.rbi +253 -0
  528. data/rbi/whop_sdk/resources/ad_campaigns.rbi +173 -60
  529. data/rbi/whop_sdk/resources/ad_groups.rbi +287 -72
  530. data/rbi/whop_sdk/resources/ad_reports.rbi +29 -19
  531. data/rbi/whop_sdk/resources/ads.rbi +254 -39
  532. data/rbi/whop_sdk/resources/affiliates/overrides.rbi +0 -1
  533. data/rbi/whop_sdk/resources/affiliates.rbi +0 -2
  534. data/rbi/whop_sdk/resources/ai_chats.rbi +0 -1
  535. data/rbi/whop_sdk/resources/app_builds.rbi +1 -2
  536. data/rbi/whop_sdk/resources/apps.rbi +66 -1
  537. data/rbi/whop_sdk/resources/audiences.rbi +82 -0
  538. data/rbi/whop_sdk/resources/authorized_users.rbi +4 -1
  539. data/rbi/whop_sdk/resources/bounties.rbi +23 -3
  540. data/rbi/whop_sdk/resources/cards.rbi +160 -0
  541. data/rbi/whop_sdk/resources/chat_channels.rbi +0 -1
  542. data/rbi/whop_sdk/resources/checkout_configurations.rbi +82 -51
  543. data/rbi/whop_sdk/resources/companies.rbi +0 -1
  544. data/rbi/whop_sdk/resources/company_token_transactions.rbi +0 -1
  545. data/rbi/whop_sdk/resources/course_chapters.rbi +0 -1
  546. data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +0 -1
  547. data/rbi/whop_sdk/resources/course_lessons.rbi +0 -1
  548. data/rbi/whop_sdk/resources/course_students.rbi +0 -1
  549. data/rbi/whop_sdk/resources/courses.rbi +0 -1
  550. data/rbi/whop_sdk/resources/deposits.rbi +63 -0
  551. data/rbi/whop_sdk/resources/dispute_alerts.rbi +0 -1
  552. data/rbi/whop_sdk/resources/disputes.rbi +0 -1
  553. data/rbi/whop_sdk/resources/dm_channels.rbi +0 -1
  554. data/rbi/whop_sdk/resources/dm_members.rbi +0 -1
  555. data/rbi/whop_sdk/resources/entries.rbi +0 -1
  556. data/rbi/whop_sdk/resources/events.rbi +122 -0
  557. data/rbi/whop_sdk/resources/experiences.rbi +0 -1
  558. data/rbi/whop_sdk/resources/fee_markups.rbi +0 -1
  559. data/rbi/whop_sdk/resources/files.rbi +1 -3
  560. data/rbi/whop_sdk/resources/financial_activity.rbi +80 -0
  561. data/rbi/whop_sdk/resources/forum_posts.rbi +0 -1
  562. data/rbi/whop_sdk/resources/forums.rbi +0 -1
  563. data/rbi/whop_sdk/resources/invoices.rbi +0 -1
  564. data/rbi/whop_sdk/resources/leads.rbi +0 -1
  565. data/rbi/whop_sdk/resources/ledger_accounts.rbi +0 -1
  566. data/rbi/whop_sdk/resources/media.rbi +67 -0
  567. data/rbi/whop_sdk/resources/members.rbi +0 -1
  568. data/rbi/whop_sdk/resources/memberships.rbi +0 -1
  569. data/rbi/whop_sdk/resources/messages.rbi +0 -1
  570. data/rbi/whop_sdk/resources/notifications.rbi +0 -1
  571. data/rbi/whop_sdk/resources/payment_methods.rbi +0 -1
  572. data/rbi/whop_sdk/resources/payments.rbi +3 -1
  573. data/rbi/whop_sdk/resources/payout_accounts.rbi +0 -1
  574. data/rbi/whop_sdk/resources/payouts/methods.rbi +76 -0
  575. data/rbi/whop_sdk/resources/payouts.rbi +96 -0
  576. data/rbi/whop_sdk/resources/people.rbi +86 -0
  577. data/rbi/whop_sdk/resources/plans.rbi +120 -112
  578. data/rbi/whop_sdk/resources/products.rbi +67 -144
  579. data/rbi/whop_sdk/resources/promo_codes.rbi +0 -1
  580. data/rbi/whop_sdk/resources/reactions.rbi +0 -1
  581. data/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi +67 -0
  582. data/rbi/whop_sdk/resources/referrals/businesses.rbi +122 -0
  583. data/rbi/whop_sdk/resources/referrals/partners.rbi +31 -0
  584. data/rbi/whop_sdk/resources/referrals.rbi +67 -0
  585. data/rbi/whop_sdk/resources/refunds.rbi +2 -1
  586. data/rbi/whop_sdk/resources/resolution_center_cases.rbi +0 -1
  587. data/rbi/whop_sdk/resources/reviews.rbi +0 -1
  588. data/rbi/whop_sdk/resources/setup_intents.rbi +0 -1
  589. data/rbi/whop_sdk/resources/shipments.rbi +0 -1
  590. data/rbi/whop_sdk/resources/social_accounts.rbi +161 -0
  591. data/rbi/whop_sdk/resources/stats.rbi +143 -0
  592. data/rbi/whop_sdk/resources/support_channels.rbi +0 -1
  593. data/rbi/whop_sdk/resources/swaps.rbi +124 -0
  594. data/rbi/whop_sdk/resources/topups.rbi +0 -1
  595. data/rbi/whop_sdk/resources/transfers.rbi +62 -59
  596. data/rbi/whop_sdk/resources/users.rbi +92 -48
  597. data/rbi/whop_sdk/resources/verifications.rbi +85 -35
  598. data/rbi/whop_sdk/resources/webhooks.rbi +29 -22
  599. data/rbi/whop_sdk/resources/withdrawals.rbi +1 -2
  600. data/rbi/whop_sdk/resources/workforce/bounties.rbi +94 -0
  601. data/rbi/whop_sdk/resources/workforce.rbi +22 -0
  602. data/sig/whop_sdk/client.rbs +31 -4
  603. data/sig/whop_sdk/models/account.rbs +706 -0
  604. data/sig/whop_sdk/models/account_create_params.rbs +38 -0
  605. data/sig/whop_sdk/models/account_list_params.rbs +88 -0
  606. data/sig/whop_sdk/models/account_me_params.rbs +14 -0
  607. data/sig/whop_sdk/models/account_recommend_actions_params.rbs +23 -0
  608. data/sig/whop_sdk/models/account_recommend_actions_response.rbs +129 -0
  609. data/sig/whop_sdk/models/account_retrieve_params.rbs +23 -0
  610. data/sig/whop_sdk/models/account_social_link.rbs +62 -0
  611. data/sig/whop_sdk/models/account_update_params.rbs +536 -0
  612. data/sig/whop_sdk/models/accounts/preference_retrieve_params.rbs +25 -0
  613. data/sig/whop_sdk/models/accounts/preference_retrieve_response.rbs +110 -0
  614. data/sig/whop_sdk/models/accounts/preference_update_params.rbs +133 -0
  615. data/sig/whop_sdk/models/accounts/preference_update_response.rbs +110 -0
  616. data/sig/whop_sdk/models/ad.rbs +597 -0
  617. data/sig/whop_sdk/models/ad_campaign.rbs +472 -0
  618. data/sig/whop_sdk/models/ad_campaign_create_params.rbs +179 -0
  619. data/sig/whop_sdk/models/{payout_method_retrieve_params.rbs → ad_campaign_delete_params.rbs} +2 -2
  620. data/sig/whop_sdk/models/ad_campaign_delete_response.rbs +5 -0
  621. data/sig/whop_sdk/models/ad_campaign_list_params.rbs +145 -41
  622. data/sig/whop_sdk/models/ad_campaign_retrieve_params.rbs +24 -2
  623. data/sig/whop_sdk/models/ad_campaign_update_params.rbs +90 -4
  624. data/sig/whop_sdk/models/ad_create_params.rbs +751 -0
  625. data/sig/whop_sdk/models/ad_delete_params.rbs +20 -0
  626. data/sig/whop_sdk/models/ad_delete_response.rbs +5 -0
  627. data/sig/whop_sdk/models/ad_group.rbs +543 -0
  628. data/sig/whop_sdk/models/ad_group_create_params.rbs +292 -0
  629. data/sig/whop_sdk/models/ad_group_list_params.rbs +141 -50
  630. data/sig/whop_sdk/models/ad_group_pause_params.rbs +20 -0
  631. data/sig/whop_sdk/models/ad_group_retrieve_params.rbs +24 -2
  632. data/sig/whop_sdk/models/ad_group_unpause_params.rbs +20 -0
  633. data/sig/whop_sdk/models/ad_group_update_params.rbs +200 -2354
  634. data/sig/whop_sdk/models/ad_list_params.rbs +157 -44
  635. data/sig/whop_sdk/models/ad_pause_params.rbs +20 -0
  636. data/sig/whop_sdk/models/ad_report_retrieve_params.rbs +38 -16
  637. data/sig/whop_sdk/models/ad_report_retrieve_response.rbs +258 -149
  638. data/sig/whop_sdk/models/ad_retrieve_params.rbs +24 -2
  639. data/sig/whop_sdk/models/ad_unpause_params.rbs +20 -0
  640. data/sig/whop_sdk/models/ad_update_params.rbs +742 -0
  641. data/sig/whop_sdk/models/app.rbs +52 -0
  642. data/sig/whop_sdk/models/app_create_params.rbs +6 -1
  643. data/sig/whop_sdk/models/app_list_response.rbs +10 -0
  644. data/sig/whop_sdk/models/app_logs_params.rbs +98 -0
  645. data/sig/whop_sdk/models/app_logs_response.rbs +162 -0
  646. data/sig/whop_sdk/models/app_update_params.rbs +10 -0
  647. data/sig/whop_sdk/models/audience.rbs +145 -0
  648. data/sig/whop_sdk/models/audience_create_params.rbs +88 -0
  649. data/sig/whop_sdk/models/audience_delete_params.rbs +23 -0
  650. data/sig/whop_sdk/models/audience_delete_response.rbs +13 -0
  651. data/sig/whop_sdk/models/audience_list_params.rbs +42 -0
  652. data/sig/whop_sdk/models/authorized_user_create_params.rbs +52 -0
  653. data/sig/whop_sdk/models/bounty_create_params.rbs +56 -1
  654. data/sig/whop_sdk/models/bounty_create_response.rbs +2 -1
  655. data/sig/whop_sdk/models/bounty_list_params.rbs +2 -1
  656. data/sig/whop_sdk/models/bounty_list_response.rbs +2 -1
  657. data/sig/whop_sdk/models/bounty_retrieve_response.rbs +2 -1
  658. data/sig/whop_sdk/models/card_brands.rbs +2 -0
  659. data/sig/whop_sdk/models/card_create_params.rbs +85 -0
  660. data/sig/whop_sdk/models/card_create_response.rbs +200 -0
  661. data/sig/whop_sdk/models/card_list_params.rbs +32 -0
  662. data/sig/whop_sdk/models/card_list_response.rbs +214 -0
  663. data/sig/whop_sdk/models/card_retrieve_params.rbs +36 -0
  664. data/sig/whop_sdk/models/card_retrieve_response.rbs +200 -0
  665. data/sig/whop_sdk/models/card_update_params.rbs +164 -0
  666. data/sig/whop_sdk/models/card_update_response.rbs +200 -0
  667. data/sig/whop_sdk/models/chat_message_created_webhook_event.rbs +149 -0
  668. data/sig/whop_sdk/models/chat_reaction_created_webhook_event.rbs +154 -0
  669. data/sig/whop_sdk/models/checkout_configuration.rbs +16 -5
  670. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +206 -649
  671. data/sig/whop_sdk/models/checkout_configuration_create_response.rbs +196 -0
  672. data/sig/whop_sdk/models/checkout_configuration_delete_params.rbs +20 -0
  673. data/sig/whop_sdk/models/checkout_configuration_list_params.rbs +66 -32
  674. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +88 -56
  675. data/sig/whop_sdk/models/checkout_configuration_retrieve_response.rbs +196 -0
  676. data/sig/whop_sdk/models/currency.rbs +6 -0
  677. data/sig/whop_sdk/models/deposit_create_params.rbs +83 -0
  678. data/sig/whop_sdk/models/deposit_create_response.rbs +187 -0
  679. data/sig/whop_sdk/models/deposit_list_params.rbs +23 -0
  680. data/sig/whop_sdk/models/deposit_list_response.rbs +87 -0
  681. data/sig/whop_sdk/models/dispute.rbs +4 -4
  682. data/sig/whop_sdk/models/dispute_alert_created_webhook_event.rbs +4 -4
  683. data/sig/whop_sdk/models/dispute_alert_retrieve_response.rbs +4 -4
  684. data/sig/whop_sdk/models/event_create_params.rbs +639 -0
  685. data/sig/whop_sdk/models/{conversion_create_response.rbs → event_create_response.rbs} +2 -2
  686. data/sig/whop_sdk/models/event_list_params.rbs +68 -0
  687. data/sig/whop_sdk/models/event_list_response.rbs +231 -0
  688. data/sig/whop_sdk/models/file_create_params.rbs +4 -18
  689. data/sig/whop_sdk/models/file_create_response.rbs +4 -15
  690. data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -15
  691. data/sig/whop_sdk/models/file_visibility.rbs +14 -0
  692. data/sig/whop_sdk/models/financial_activity_list_params.rbs +98 -0
  693. data/sig/whop_sdk/models/financial_activity_list_response.rbs +935 -0
  694. data/sig/whop_sdk/models/granularities.rbs +16 -0
  695. data/sig/whop_sdk/models/identity_profile_approved_webhook_event.rbs +293 -0
  696. data/sig/whop_sdk/models/identity_profile_needs_action_webhook_event.rbs +293 -0
  697. data/sig/whop_sdk/models/identity_profile_rejected_webhook_event.rbs +293 -0
  698. data/sig/whop_sdk/models/identity_profile_updated_webhook_event.rbs +293 -0
  699. data/sig/whop_sdk/models/invoice_create_params.rbs +20 -0
  700. data/sig/whop_sdk/models/invoice_update_params.rbs +10 -0
  701. data/sig/whop_sdk/models/ledger_account_funds_available_webhook_event.rbs +418 -0
  702. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +50 -3
  703. data/sig/whop_sdk/models/media_asset.rbs +160 -0
  704. data/sig/whop_sdk/models/media_generate_params.rbs +99 -0
  705. data/sig/whop_sdk/models/media_retrieve_params.rbs +20 -0
  706. data/sig/whop_sdk/models/membership.rbs +19 -6
  707. data/sig/whop_sdk/models/membership_list_response.rbs +19 -6
  708. data/sig/whop_sdk/models/membership_trial_ending_soon_webhook_event.rbs +45 -0
  709. data/sig/whop_sdk/models/payment.rbs +161 -15
  710. data/sig/whop_sdk/models/payment_create_params.rbs +16 -6
  711. data/sig/whop_sdk/models/payment_list_params.rbs +5 -0
  712. data/sig/whop_sdk/models/payment_list_response.rbs +104 -15
  713. data/sig/whop_sdk/models/payout_create_params.rbs +50 -0
  714. data/sig/whop_sdk/models/payout_create_response.rbs +139 -0
  715. data/sig/whop_sdk/models/payout_list_params.rbs +70 -0
  716. data/sig/whop_sdk/models/payout_list_response.rbs +153 -0
  717. data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +25 -4
  718. data/sig/whop_sdk/models/payouts/method_list_params.rbs +107 -0
  719. data/sig/whop_sdk/models/payouts/method_list_response.rbs +229 -0
  720. data/sig/whop_sdk/models/person_list_params.rbs +97 -0
  721. data/sig/whop_sdk/models/person_list_response.rbs +162 -0
  722. data/sig/whop_sdk/models/person_retrieve_params.rbs +42 -0
  723. data/sig/whop_sdk/models/person_retrieve_response.rbs +175 -0
  724. data/sig/whop_sdk/models/plan.rbs +325 -119
  725. data/sig/whop_sdk/models/plan_calculate_tax_params.rbs +344 -0
  726. data/sig/whop_sdk/models/plan_calculate_tax_response.rbs +67 -0
  727. data/sig/whop_sdk/models/plan_create_params.rbs +139 -98
  728. data/sig/whop_sdk/models/plan_list_params.rbs +93 -54
  729. data/sig/whop_sdk/models/plan_list_response.rbs +75 -126
  730. data/sig/whop_sdk/models/plan_update_params.rbs +115 -82
  731. data/sig/whop_sdk/models/product.rbs +5 -0
  732. data/sig/whop_sdk/models/product_create_params.rbs +33 -124
  733. data/sig/whop_sdk/models/product_list_item.rbs +5 -0
  734. data/sig/whop_sdk/models/product_list_params.rbs +53 -48
  735. data/sig/whop_sdk/models/product_update_params.rbs +15 -88
  736. data/sig/whop_sdk/models/referral_referred_users_params.rbs +63 -0
  737. data/sig/whop_sdk/models/referral_referred_users_response.rbs +140 -0
  738. data/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs +46 -0
  739. data/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs +221 -0
  740. data/sig/whop_sdk/models/referrals/business_list_params.rbs +176 -0
  741. data/sig/whop_sdk/models/referrals/business_list_response.rbs +267 -0
  742. data/sig/whop_sdk/models/referrals/business_retrieve_params.rbs +22 -0
  743. data/sig/whop_sdk/models/referrals/business_retrieve_response.rbs +677 -0
  744. data/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs +139 -0
  745. data/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs +288 -0
  746. data/sig/whop_sdk/models/referrals/partner_create_params.rbs +17 -0
  747. data/sig/whop_sdk/models/referrals/partner_create_response.rbs +21 -0
  748. data/sig/whop_sdk/models/refund_created_webhook_event.rbs +43 -4
  749. data/sig/whop_sdk/models/refund_retrieve_response.rbs +43 -4
  750. data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +43 -4
  751. data/sig/whop_sdk/models/resolution_center_case_platform_response.rbs +0 -2
  752. data/sig/whop_sdk/models/result_label_keys.rbs +80 -0
  753. data/sig/whop_sdk/models/setup_intent.rbs +8 -3
  754. data/sig/whop_sdk/models/social_account.rbs +74 -0
  755. data/sig/whop_sdk/models/social_account_connect_params.rbs +69 -0
  756. data/sig/whop_sdk/models/social_account_connect_response.rbs +13 -0
  757. data/sig/whop_sdk/models/social_account_create_params.rbs +43 -0
  758. data/sig/whop_sdk/models/social_account_delete_params.rbs +36 -0
  759. data/sig/whop_sdk/models/social_account_delete_response.rbs +5 -0
  760. data/sig/whop_sdk/models/social_account_list_params.rbs +152 -0
  761. data/sig/whop_sdk/models/social_account_post.rbs +111 -0
  762. data/sig/whop_sdk/models/social_account_posts_params.rbs +52 -0
  763. data/sig/whop_sdk/models/social_account_posts_response.rbs +37 -0
  764. data/sig/whop_sdk/models/stat_list_params.rbs +14 -0
  765. data/sig/whop_sdk/models/stat_list_response.rbs +72 -0
  766. data/sig/whop_sdk/models/stat_retrieve_params.rbs +211 -0
  767. data/sig/whop_sdk/models/stat_retrieve_response.rbs +81 -0
  768. data/sig/whop_sdk/models/swap_create_params.rbs +72 -0
  769. data/sig/whop_sdk/models/swap_create_quote_params.rbs +84 -0
  770. data/sig/whop_sdk/models/swap_create_quote_response.rbs +97 -0
  771. data/sig/whop_sdk/models/swap_create_response.rbs +73 -0
  772. data/sig/whop_sdk/models/swap_list_params.rbs +23 -0
  773. data/sig/whop_sdk/models/swap_list_response.rbs +68 -0
  774. data/sig/whop_sdk/models/swap_retrieve_params.rbs +20 -0
  775. data/sig/whop_sdk/models/swap_retrieve_response.rbs +55 -0
  776. data/sig/whop_sdk/models/tax_identifier_type.rbs +4 -0
  777. data/sig/whop_sdk/models/transfer_create_params.rbs +47 -10
  778. data/sig/whop_sdk/models/transfer_create_response.rbs +366 -0
  779. data/sig/whop_sdk/models/transfer_list_params.rbs +77 -42
  780. data/sig/whop_sdk/models/transfer_list_response.rbs +14 -14
  781. data/sig/whop_sdk/models/{transfer.rbs → transfer_retrieve_response.rbs} +83 -78
  782. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +30 -22
  783. data/sig/whop_sdk/models/user.rbs +203 -16
  784. data/sig/whop_sdk/models/user_balance.rbs +171 -0
  785. data/sig/whop_sdk/models/user_check_access_response.rbs +19 -4
  786. data/sig/whop_sdk/models/user_list_params.rbs +30 -20
  787. data/sig/whop_sdk/models/user_retrieve_params.rbs +59 -4
  788. data/sig/whop_sdk/models/user_update_me_params.rbs +74 -0
  789. data/sig/whop_sdk/models/user_update_params.rbs +42 -24
  790. data/sig/whop_sdk/models/verification_create_params.rbs +364 -0
  791. data/sig/whop_sdk/models/verification_create_response.rbs +333 -0
  792. data/sig/whop_sdk/models/verification_list_params.rbs +40 -20
  793. data/sig/whop_sdk/models/verification_list_response.rbs +337 -20
  794. data/sig/whop_sdk/models/verification_retrieve_params.rbs +7 -4
  795. data/sig/whop_sdk/models/verification_retrieve_response.rbs +312 -14
  796. data/sig/whop_sdk/models/verification_update_params.rbs +570 -0
  797. data/sig/whop_sdk/models/verification_update_response.rbs +333 -0
  798. data/sig/whop_sdk/models/webhook_event.rbs +16 -0
  799. data/sig/whop_sdk/models/withdrawal.rbs +2 -0
  800. data/sig/whop_sdk/models/workforce/bounty_list_params.rbs +149 -0
  801. data/sig/whop_sdk/models/workforce/bounty_retrieve_params.rbs +22 -0
  802. data/sig/whop_sdk/models/workforce/workforce_bounty.rbs +232 -0
  803. data/sig/whop_sdk/models/workforce/workforce_bounty_list_item.rbs +227 -0
  804. data/sig/whop_sdk/models.rbs +151 -7
  805. data/sig/whop_sdk/resources/accounts/preferences.rbs +20 -0
  806. data/sig/whop_sdk/resources/accounts.rbs +76 -0
  807. data/sig/whop_sdk/resources/ad_campaigns.rbs +47 -15
  808. data/sig/whop_sdk/resources/ad_groups.rbs +77 -20
  809. data/sig/whop_sdk/resources/ad_reports.rbs +6 -4
  810. data/sig/whop_sdk/resources/ads.rbs +74 -12
  811. data/sig/whop_sdk/resources/apps.rbs +16 -0
  812. data/sig/whop_sdk/resources/audiences.rbs +28 -0
  813. data/sig/whop_sdk/resources/authorized_users.rbs +1 -0
  814. data/sig/whop_sdk/resources/bounties.rbs +4 -0
  815. data/sig/whop_sdk/resources/cards.rbs +47 -0
  816. data/sig/whop_sdk/resources/checkout_configurations.rbs +21 -11
  817. data/sig/whop_sdk/resources/deposits.rbs +20 -0
  818. data/sig/whop_sdk/resources/events.rbs +40 -0
  819. data/sig/whop_sdk/resources/files.rbs +1 -1
  820. data/sig/whop_sdk/resources/financial_activity.rbs +22 -0
  821. data/sig/whop_sdk/resources/media.rbs +22 -0
  822. data/sig/whop_sdk/resources/payments.rbs +1 -0
  823. data/sig/whop_sdk/resources/payouts/methods.rbs +23 -0
  824. data/sig/whop_sdk/resources/payouts.rbs +29 -0
  825. data/sig/whop_sdk/resources/people.rbs +28 -0
  826. data/sig/whop_sdk/resources/plans.rbs +37 -25
  827. data/sig/whop_sdk/resources/products.rbs +17 -31
  828. data/sig/whop_sdk/resources/referrals/businesses/earnings.rbs +25 -0
  829. data/sig/whop_sdk/resources/referrals/businesses.rbs +38 -0
  830. data/sig/whop_sdk/resources/referrals/partners.rbs +13 -0
  831. data/sig/whop_sdk/resources/referrals.rbs +21 -0
  832. data/sig/whop_sdk/resources/social_accounts.rbs +52 -0
  833. data/sig/whop_sdk/resources/stats.rbs +39 -0
  834. data/sig/whop_sdk/resources/swaps.rbs +41 -0
  835. data/sig/whop_sdk/resources/transfers.rbs +17 -14
  836. data/sig/whop_sdk/resources/users.rbs +26 -12
  837. data/sig/whop_sdk/resources/verifications.rbs +17 -7
  838. data/sig/whop_sdk/resources/webhooks.rbs +30 -22
  839. data/sig/whop_sdk/resources/workforce/bounties.rbs +30 -0
  840. data/sig/whop_sdk/resources/workforce.rbs +9 -0
  841. metadata +446 -65
  842. data/lib/whop_sdk/models/ad_campaign_list_response.rb +0 -126
  843. data/lib/whop_sdk/models/ad_campaign_pause_response.rb +0 -328
  844. data/lib/whop_sdk/models/ad_campaign_retrieve_response.rb +0 -328
  845. data/lib/whop_sdk/models/ad_campaign_unpause_response.rb +0 -328
  846. data/lib/whop_sdk/models/ad_campaign_update_response.rb +0 -328
  847. data/lib/whop_sdk/models/ad_group_list_response.rb +0 -118
  848. data/lib/whop_sdk/models/ad_group_retrieve_response.rb +0 -140
  849. data/lib/whop_sdk/models/ad_group_update_response.rb +0 -140
  850. data/lib/whop_sdk/models/ad_list_response.rb +0 -89
  851. data/lib/whop_sdk/models/ad_retrieve_response.rb +0 -133
  852. data/lib/whop_sdk/models/conversion_create_response.rb +0 -19
  853. data/lib/whop_sdk/models/payout_destination_category.rb +0 -20
  854. data/lib/whop_sdk/models/payout_method_list_params.rb +0 -54
  855. data/lib/whop_sdk/models/payout_method_list_response.rb +0 -140
  856. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +0 -140
  857. data/lib/whop_sdk/models/transfer.rb +0 -299
  858. data/lib/whop_sdk/models/user_list_response.rb +0 -83
  859. data/lib/whop_sdk/resources/conversions.rb +0 -67
  860. data/lib/whop_sdk/resources/payout_methods.rb +0 -76
  861. data/rbi/whop_sdk/models/ad_campaign_list_response.rbi +0 -239
  862. data/rbi/whop_sdk/models/ad_campaign_pause_response.rbi +0 -668
  863. data/rbi/whop_sdk/models/ad_campaign_retrieve_response.rbi +0 -679
  864. data/rbi/whop_sdk/models/ad_campaign_unpause_response.rbi +0 -675
  865. data/rbi/whop_sdk/models/ad_campaign_update_response.rbi +0 -670
  866. data/rbi/whop_sdk/models/ad_group_list_response.rbi +0 -228
  867. data/rbi/whop_sdk/models/ad_group_retrieve_response.rbi +0 -277
  868. data/rbi/whop_sdk/models/ad_group_update_response.rbi +0 -274
  869. data/rbi/whop_sdk/models/ad_list_response.rbi +0 -146
  870. data/rbi/whop_sdk/models/ad_retrieve_response.rbi +0 -245
  871. data/rbi/whop_sdk/models/conversion_create_params.rbi +0 -661
  872. data/rbi/whop_sdk/models/payout_destination_category.rbi +0 -33
  873. data/rbi/whop_sdk/models/payout_method_list_params.rbi +0 -75
  874. data/rbi/whop_sdk/models/payout_method_list_response.rbi +0 -234
  875. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +0 -238
  876. data/rbi/whop_sdk/models/transfer.rbi +0 -407
  877. data/rbi/whop_sdk/models/user_list_response.rbi +0 -124
  878. data/rbi/whop_sdk/resources/conversions.rbi +0 -71
  879. data/rbi/whop_sdk/resources/payout_methods.rbi +0 -66
  880. data/sig/whop_sdk/models/ad_campaign_list_response.rbs +0 -98
  881. data/sig/whop_sdk/models/ad_campaign_pause_response.rbs +0 -232
  882. data/sig/whop_sdk/models/ad_campaign_retrieve_response.rbs +0 -232
  883. data/sig/whop_sdk/models/ad_campaign_unpause_response.rbs +0 -232
  884. data/sig/whop_sdk/models/ad_campaign_update_response.rbs +0 -232
  885. data/sig/whop_sdk/models/ad_group_list_response.rbs +0 -93
  886. data/sig/whop_sdk/models/ad_group_retrieve_response.rbs +0 -108
  887. data/sig/whop_sdk/models/ad_group_update_response.rbs +0 -108
  888. data/sig/whop_sdk/models/ad_list_response.rbs +0 -72
  889. data/sig/whop_sdk/models/ad_retrieve_response.rbs +0 -102
  890. data/sig/whop_sdk/models/conversion_create_params.rbs +0 -349
  891. data/sig/whop_sdk/models/payout_destination_category.rbs +0 -19
  892. data/sig/whop_sdk/models/payout_method_list_params.rbs +0 -46
  893. data/sig/whop_sdk/models/payout_method_list_response.rbs +0 -97
  894. data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +0 -97
  895. data/sig/whop_sdk/models/user_list_response.rbs +0 -55
  896. data/sig/whop_sdk/resources/conversions.rbs +0 -25
  897. data/sig/whop_sdk/resources/payout_methods.rbs +0 -21
@@ -7,1050 +7,332 @@ module WhopSDK
7
7
  extend WhopSDK::Internal::Type::RequestParameters::Converter
8
8
  include WhopSDK::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute body
11
- # Parameters for CreateCheckoutSession
10
+ # @!attribute affiliate_code
11
+ # Affiliate code to apply to the checkout.
12
12
  #
13
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup]
14
- required :body, union: -> { WhopSDK::CheckoutConfigurationCreateParams::Body }
13
+ # @return [String, nil]
14
+ optional :affiliate_code, String, nil?: true
15
15
 
16
- # @!method initialize(body:, request_options: {})
17
- # @param body [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup] Parameters for CreateCheckoutSession
16
+ # @!attribute company_id
17
+ # Account ID, prefixed `biz_`.
18
18
  #
19
- # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
20
-
21
- # Parameters for CreateCheckoutSession
22
- module Body
23
- extend WhopSDK::Internal::Type::Union
24
-
25
- # Autogenerated input type of CreateCheckoutSession
26
- variant -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan }
27
-
28
- # Autogenerated input type of CreateCheckoutSession
29
- variant -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID }
30
-
31
- # Autogenerated input type of CreateCheckoutSession
32
- variant -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup }
33
-
34
- class CreateCheckoutSessionInputModePaymentWithPlan < WhopSDK::Internal::Type::BaseModel
35
- # @!attribute plan
36
- # The plan attributes to create a new plan inline for this checkout configuration.
37
- #
38
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan]
39
- required :plan,
40
- -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan }
41
-
42
- # @!attribute affiliate_code
43
- # An affiliate tracking code to attribute the checkout to a specific affiliate.
44
- #
45
- # @return [String, nil]
46
- optional :affiliate_code, String, nil?: true
47
-
48
- # @!attribute allow_promo_codes
49
- # Whether the checkout should show the promo code input field and accept promo
50
- # codes. Defaults to true.
51
- #
52
- # @return [Boolean, nil]
53
- optional :allow_promo_codes, WhopSDK::Internal::Type::Boolean, nil?: true
54
-
55
- # @!attribute checkout_styling
56
- # Checkout styling overrides for this session. Overrides plan and company
57
- # defaults.
58
- #
59
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling, nil]
60
- optional :checkout_styling,
61
- -> {
62
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling
63
- },
64
- nil?: true
65
-
66
- # @!attribute currency
67
- # The available currencies on the platform
68
- #
69
- # @return [Symbol, WhopSDK::Models::Currency, nil]
70
- optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
71
-
72
- # @!attribute metadata
73
- # Custom key-value metadata to attach to the checkout configuration.
74
- #
75
- # @return [Hash{Symbol=>Object}, nil]
76
- optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
77
-
78
- # @!attribute mode
79
- #
80
- # @return [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Mode, nil]
81
- optional :mode,
82
- enum: -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Mode }
83
-
84
- # @!attribute payment_method_configuration
85
- # The explicit payment method configuration for the checkout session. Only applies
86
- # to setup mode. If not provided, the platform or company defaults will apply.
87
- #
88
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::PaymentMethodConfiguration, nil]
89
- optional :payment_method_configuration,
90
- -> {
91
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::PaymentMethodConfiguration
92
- },
93
- nil?: true
94
-
95
- # @!attribute redirect_url
96
- # The URL to redirect the user to after checkout is completed.
97
- #
98
- # @return [String, nil]
99
- optional :redirect_url, String, nil?: true
100
-
101
- # @!attribute source_url
102
- # The URL of the page where the checkout is being initiated from.
103
- #
104
- # @return [String, nil]
105
- optional :source_url, String, nil?: true
106
-
107
- # @!method initialize(plan:, affiliate_code: nil, allow_promo_codes: nil, checkout_styling: nil, currency: nil, metadata: nil, mode: nil, payment_method_configuration: nil, redirect_url: nil, source_url: nil)
108
- # Some parameter documentations has been truncated, see
109
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan}
110
- # for more details.
111
- #
112
- # Autogenerated input type of CreateCheckoutSession
113
- #
114
- # @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan] The plan attributes to create a new plan inline for this checkout configuration.
115
- #
116
- # @param affiliate_code [String, nil] An affiliate tracking code to attribute the checkout to a specific affiliate.
117
- #
118
- # @param allow_promo_codes [Boolean, nil] Whether the checkout should show the promo code input field and accept promo cod
119
- #
120
- # @param checkout_styling [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling, nil] Checkout styling overrides for this session. Overrides plan and company defaults
121
- #
122
- # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
123
- #
124
- # @param metadata [Hash{Symbol=>Object}, nil] Custom key-value metadata to attach to the checkout configuration.
125
- #
126
- # @param mode [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Mode]
127
- #
128
- # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::PaymentMethodConfiguration, nil] The explicit payment method configuration for the checkout session. Only applies
129
- #
130
- # @param redirect_url [String, nil] The URL to redirect the user to after checkout is completed.
131
- #
132
- # @param source_url [String, nil] The URL of the page where the checkout is being initiated from.
133
-
134
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan#plan
135
- class Plan < WhopSDK::Internal::Type::BaseModel
136
- # @!attribute company_id
137
- # The company the plan should be created for.
138
- #
139
- # @return [String]
140
- required :company_id, String
141
-
142
- # @!attribute currency
143
- # The respective currency identifier for the plan.
144
- #
145
- # @return [Symbol, WhopSDK::Models::Currency]
146
- required :currency, enum: -> { WhopSDK::Currency }
147
-
148
- # @!attribute adaptive_pricing_enabled
149
- # Whether this plan accepts local currency payments via adaptive pricing.
150
- #
151
- # @return [Boolean, nil]
152
- optional :adaptive_pricing_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
153
-
154
- # @!attribute application_fee_amount
155
- # The application fee amount collected by the platform from this connected
156
- # account. Provided as a number in dollars (e.g., 5.00 for $5.00). Must be less
157
- # than the total payment amount. Only valid for connected accounts with a parent
158
- # company.
159
- #
160
- # @return [Float, nil]
161
- optional :application_fee_amount, Float, nil?: true
162
-
163
- # @!attribute billing_period
164
- # The interval in days at which the plan charges (renewal plans). For example, 30
165
- # for monthly billing.
166
- #
167
- # @return [Integer, nil]
168
- optional :billing_period, Integer, nil?: true
169
-
170
- # @!attribute custom_fields
171
- # An array of custom field objects.
172
- #
173
- # @return [Array<WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::CustomField>, nil]
174
- optional :custom_fields,
175
- -> do
176
- WhopSDK::Internal::Type::ArrayOf[
177
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::CustomField
178
- ]
179
- end,
180
- nil?: true
181
-
182
- # @!attribute description
183
- # The description of the plan.
184
- #
185
- # @return [String, nil]
186
- optional :description, String, nil?: true
187
-
188
- # @!attribute expiration_days
189
- # The number of days until the membership expires (for expiration-based plans).
190
- # For example, 365 for a one-year access pass.
191
- #
192
- # @return [Integer, nil]
193
- optional :expiration_days, Integer, nil?: true
194
-
195
- # @!attribute force_create_new_plan
196
- # Whether to force the creation of a new plan even if one with the same attributes
197
- # already exists.
198
- #
199
- # @return [Boolean, nil]
200
- optional :force_create_new_plan, WhopSDK::Internal::Type::Boolean, nil?: true
201
-
202
- # @!attribute image
203
- # An image for the plan. This will be visible on the product page to customers.
204
- #
205
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Image, nil]
206
- optional :image,
207
- -> {
208
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Image
209
- },
210
- nil?: true
211
-
212
- # @!attribute initial_price
213
- # An additional amount charged upon first purchase. Provided as a number in
214
- # dollars (e.g., 10.00 for $10.00).
215
- #
216
- # @return [Float, nil]
217
- optional :initial_price, Float, nil?: true
218
-
219
- # @!attribute internal_notes
220
- # A personal description or notes section for the business.
221
- #
222
- # @return [String, nil]
223
- optional :internal_notes, String, nil?: true
224
-
225
- # @!attribute override_tax_type
226
- # Whether or not the tax is included in a plan's price (or if it hasn't been set
227
- # up)
228
- #
229
- # @return [Symbol, WhopSDK::Models::TaxType, nil]
230
- optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
231
-
232
- # @!attribute payment_method_configuration
233
- # The explicit payment method configuration for the plan. If not provided, the
234
- # platform or company's defaults will apply.
235
- #
236
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::PaymentMethodConfiguration, nil]
237
- optional :payment_method_configuration,
238
- -> {
239
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::PaymentMethodConfiguration
240
- },
241
- nil?: true
242
-
243
- # @!attribute plan_type
244
- # The type of plan that can be attached to a product
245
- #
246
- # @return [Symbol, WhopSDK::Models::PlanType, nil]
247
- optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
248
-
249
- # @!attribute product
250
- # Pass this object to create a new product for this plan. We will use the product
251
- # external identifier to find or create an existing product.
252
- #
253
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Product, nil]
254
- optional :product,
255
- -> {
256
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Product
257
- },
258
- nil?: true
259
-
260
- # @!attribute product_id
261
- # The product the plan is related to. Either this or product is required.
262
- #
263
- # @return [String, nil]
264
- optional :product_id, String, nil?: true
265
-
266
- # @!attribute release_method
267
- # The methods of how a plan can be released.
268
- #
269
- # @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
270
- optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
271
-
272
- # @!attribute renewal_price
273
- # The amount the customer is charged every billing period. Provided as a number in
274
- # dollars (e.g., 9.99 for $9.99/period).
275
- #
276
- # @return [Float, nil]
277
- optional :renewal_price, Float, nil?: true
278
-
279
- # @!attribute split_pay_required_payments
280
- # The number of payments required before pausing the subscription.
281
- #
282
- # @return [Integer, nil]
283
- optional :split_pay_required_payments, Integer, nil?: true
284
-
285
- # @!attribute stock
286
- # The number of units available for purchase. If not provided, stock is unlimited.
287
- #
288
- # @return [Integer, nil]
289
- optional :stock, Integer, nil?: true
290
-
291
- # @!attribute title
292
- # The title of the plan. This will be visible on the product page to customers.
293
- #
294
- # @return [String, nil]
295
- optional :title, String, nil?: true
296
-
297
- # @!attribute trial_period_days
298
- # The number of free trial days added before a renewal plan.
299
- #
300
- # @return [Integer, nil]
301
- optional :trial_period_days, Integer, nil?: true
302
-
303
- # @!attribute visibility
304
- # Visibility of a resource
305
- #
306
- # @return [Symbol, WhopSDK::Models::Visibility, nil]
307
- optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
308
-
309
- # @!method initialize(company_id:, currency:, adaptive_pricing_enabled: nil, application_fee_amount: nil, billing_period: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, split_pay_required_payments: nil, stock: nil, title: nil, trial_period_days: nil, visibility: nil)
310
- # Some parameter documentations has been truncated, see
311
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan}
312
- # for more details.
313
- #
314
- # The plan attributes to create a new plan inline for this checkout configuration.
315
- #
316
- # @param company_id [String] The company the plan should be created for.
317
- #
318
- # @param currency [Symbol, WhopSDK::Models::Currency] The respective currency identifier for the plan.
319
- #
320
- # @param adaptive_pricing_enabled [Boolean, nil] Whether this plan accepts local currency payments via adaptive pricing.
321
- #
322
- # @param application_fee_amount [Float, nil] The application fee amount collected by the platform from this connected account
323
- #
324
- # @param billing_period [Integer, nil] The interval in days at which the plan charges (renewal plans). For example, 30
325
- #
326
- # @param custom_fields [Array<WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::CustomField>, nil] An array of custom field objects.
327
- #
328
- # @param description [String, nil] The description of the plan.
329
- #
330
- # @param expiration_days [Integer, nil] The number of days until the membership expires (for expiration-based plans). Fo
331
- #
332
- # @param force_create_new_plan [Boolean, nil] Whether to force the creation of a new plan even if one with the same attributes
333
- #
334
- # @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Image, nil] An image for the plan. This will be visible on the product page to customers.
335
- #
336
- # @param initial_price [Float, nil] An additional amount charged upon first purchase. Provided as a number in dollar
337
- #
338
- # @param internal_notes [String, nil] A personal description or notes section for the business.
339
- #
340
- # @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
341
- #
342
- # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
343
- #
344
- # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
345
- #
346
- # @param product [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Product, nil] Pass this object to create a new product for this plan. We will use the product
347
- #
348
- # @param product_id [String, nil] The product the plan is related to. Either this or product is required.
349
- #
350
- # @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
351
- #
352
- # @param renewal_price [Float, nil] The amount the customer is charged every billing period. Provided as a number in
353
- #
354
- # @param split_pay_required_payments [Integer, nil] The number of payments required before pausing the subscription.
355
- #
356
- # @param stock [Integer, nil] The number of units available for purchase. If not provided, stock is unlimited.
357
- #
358
- # @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
359
- #
360
- # @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
361
- #
362
- # @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
363
-
364
- class CustomField < WhopSDK::Internal::Type::BaseModel
365
- # @!attribute field_type
366
- # The type of the custom field.
367
- #
368
- # @return [Symbol, :text]
369
- required :field_type, const: :text
370
-
371
- # @!attribute name
372
- # The name of the custom field.
373
- #
374
- # @return [String]
375
- required :name, String
376
-
377
- # @!attribute id
378
- # The ID of the custom field (if being updated)
379
- #
380
- # @return [String, nil]
381
- optional :id, String, nil?: true
382
-
383
- # @!attribute order
384
- # The order of the field.
385
- #
386
- # @return [Integer, nil]
387
- optional :order, Integer, nil?: true
388
-
389
- # @!attribute placeholder
390
- # The placeholder value of the field.
391
- #
392
- # @return [String, nil]
393
- optional :placeholder, String, nil?: true
394
-
395
- # @!attribute required
396
- # Whether or not the field is required.
397
- #
398
- # @return [Boolean, nil]
399
- optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
400
-
401
- # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
402
- # @param name [String] The name of the custom field.
403
- #
404
- # @param id [String, nil] The ID of the custom field (if being updated)
405
- #
406
- # @param order [Integer, nil] The order of the field.
407
- #
408
- # @param placeholder [String, nil] The placeholder value of the field.
409
- #
410
- # @param required [Boolean, nil] Whether or not the field is required.
411
- #
412
- # @param field_type [Symbol, :text] The type of the custom field.
413
- end
414
-
415
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan#image
416
- class Image < WhopSDK::Internal::Type::BaseModel
417
- # @!attribute id
418
- # The ID of an existing file object.
419
- #
420
- # @return [String]
421
- required :id, String
422
-
423
- # @!method initialize(id:)
424
- # An image for the plan. This will be visible on the product page to customers.
425
- #
426
- # @param id [String] The ID of an existing file object.
427
- end
428
-
429
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan#payment_method_configuration
430
- class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
431
- # @!attribute disabled
432
- # An array of payment method identifiers that are explicitly disabled. Only
433
- # applies if the include_platform_defaults is true.
434
- #
435
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
436
- required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
437
-
438
- # @!attribute enabled
439
- # An array of payment method identifiers that are explicitly enabled. This means
440
- # these payment methods will be shown on checkout. Example use case is to only
441
- # enable a specific payment method like cashapp, or extending the platform
442
- # defaults with additional methods.
443
- #
444
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
445
- required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
446
-
447
- # @!attribute include_platform_defaults
448
- # Whether Whop's platform default payment method enablement settings are included
449
- # in this configuration. The full list of default payment methods can be found in
450
- # the documentation at docs.whop.com/payments.
451
- #
452
- # @return [Boolean, nil]
453
- optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
454
-
455
- # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
456
- # Some parameter documentations has been truncated, see
457
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::PaymentMethodConfiguration}
458
- # for more details.
459
- #
460
- # The explicit payment method configuration for the plan. If not provided, the
461
- # platform or company's defaults will apply.
462
- #
463
- # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
464
- #
465
- # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
466
- #
467
- # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
468
- end
469
-
470
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan#product
471
- class Product < WhopSDK::Internal::Type::BaseModel
472
- # @!attribute external_identifier
473
- # A unique ID used to find or create a product. When provided during creation, we
474
- # will look for an existing product with this external identifier — if found, it
475
- # will be updated; otherwise, a new product will be created.
476
- #
477
- # @return [String]
478
- required :external_identifier, String
479
-
480
- # @!attribute title
481
- # The title of the product.
482
- #
483
- # @return [String]
484
- required :title, String
485
-
486
- # @!attribute collect_shipping_address
487
- # Whether or not to collect shipping information at checkout from the customer.
488
- #
489
- # @return [Boolean, nil]
490
- optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true
491
-
492
- # @!attribute custom_statement_descriptor
493
- # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
494
- # between 5 and 22 characters, contain at least one letter, and not contain any of
495
- # the following characters: <, >, \, ', "
496
- #
497
- # @return [String, nil]
498
- optional :custom_statement_descriptor, String, nil?: true
499
-
500
- # @!attribute description
501
- # A written description of the product.
502
- #
503
- # @return [String, nil]
504
- optional :description, String, nil?: true
505
-
506
- # @!attribute global_affiliate_percentage
507
- # The percentage of the revenue that goes to the global affiliate program.
508
- #
509
- # @return [Float, nil]
510
- optional :global_affiliate_percentage, Float, nil?: true
511
-
512
- # @!attribute global_affiliate_status
513
- # The different statuses of the global affiliate program for a product.
514
- #
515
- # @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
516
- optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
517
-
518
- # @!attribute headline
519
- # The headline of the product.
520
- #
521
- # @return [String, nil]
522
- optional :headline, String, nil?: true
523
-
524
- # @!attribute product_tax_code_id
525
- # The ID of the product tax code to apply to this product.
526
- #
527
- # @return [String, nil]
528
- optional :product_tax_code_id, String, nil?: true
529
-
530
- # @!attribute redirect_purchase_url
531
- # The URL to redirect the customer to after a purchase.
532
- #
533
- # @return [String, nil]
534
- optional :redirect_purchase_url, String, nil?: true
535
-
536
- # @!attribute route
537
- # The route of the product.
538
- #
539
- # @return [String, nil]
540
- optional :route, String, nil?: true
541
-
542
- # @!attribute visibility
543
- # Visibility of a resource
544
- #
545
- # @return [Symbol, WhopSDK::Models::Visibility, nil]
546
- optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
547
-
548
- # @!method initialize(external_identifier:, title:, collect_shipping_address: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil)
549
- # Some parameter documentations has been truncated, see
550
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::Plan::Product}
551
- # for more details.
552
- #
553
- # Pass this object to create a new product for this plan. We will use the product
554
- # external identifier to find or create an existing product.
555
- #
556
- # @param external_identifier [String] A unique ID used to find or create a product. When provided during creation, we
557
- #
558
- # @param title [String] The title of the product.
559
- #
560
- # @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
561
- #
562
- # @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
563
- # betwee
564
- #
565
- # @param description [String, nil] A written description of the product.
566
- #
567
- # @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
568
- #
569
- # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
570
- #
571
- # @param headline [String, nil] The headline of the product.
572
- #
573
- # @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
574
- #
575
- # @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
576
- #
577
- # @param route [String, nil] The route of the product.
578
- #
579
- # @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
580
- end
581
- end
582
-
583
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan#checkout_styling
584
- class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
585
- # @!attribute background_color
586
- # A hex color code for the checkout page background, applied to the order summary
587
- # panel (e.g. #F4F4F5).
588
- #
589
- # @return [String, nil]
590
- optional :background_color, String, nil?: true
591
-
592
- # @!attribute border_style
593
- # The different border-radius styles available for checkout pages.
594
- #
595
- # @return [Symbol, WhopSDK::Models::CheckoutShape, nil]
596
- optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true
597
-
598
- # @!attribute button_color
599
- # A hex color code for the button color (e.g. #FF5733).
600
- #
601
- # @return [String, nil]
602
- optional :button_color, String, nil?: true
603
-
604
- # @!attribute font_family
605
- # The different font families available for checkout pages.
606
- #
607
- # @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
608
- optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
609
-
610
- # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
611
- # Some parameter documentations has been truncated, see
612
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::CheckoutStyling}
613
- # for more details.
614
- #
615
- # Checkout styling overrides for this session. Overrides plan and company
616
- # defaults.
617
- #
618
- # @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
619
- #
620
- # @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
621
- #
622
- # @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
623
- #
624
- # @param font_family [Symbol, WhopSDK::Models::CheckoutFont, nil] The different font families available for checkout pages.
625
- end
626
-
627
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan#mode
628
- module Mode
629
- extend WhopSDK::Internal::Type::Enum
630
-
631
- PAYMENT = :payment
19
+ # @return [String, nil]
20
+ optional :company_id, String
632
21
 
633
- # @!method self.values
634
- # @return [Array<Symbol>]
635
- end
636
-
637
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan#payment_method_configuration
638
- class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
639
- # @!attribute disabled
640
- # An array of payment method identifiers that are explicitly disabled. Only
641
- # applies if the include_platform_defaults is true.
642
- #
643
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
644
- required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
645
-
646
- # @!attribute enabled
647
- # An array of payment method identifiers that are explicitly enabled. This means
648
- # these payment methods will be shown on checkout. Example use case is to only
649
- # enable a specific payment method like cashapp, or extending the platform
650
- # defaults with additional methods.
651
- #
652
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
653
- required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
654
-
655
- # @!attribute include_platform_defaults
656
- # Whether Whop's platform default payment method enablement settings are included
657
- # in this configuration. The full list of default payment methods can be found in
658
- # the documentation at docs.whop.com/payments.
659
- #
660
- # @return [Boolean, nil]
661
- optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
662
-
663
- # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
664
- # Some parameter documentations has been truncated, see
665
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan::PaymentMethodConfiguration}
666
- # for more details.
667
- #
668
- # The explicit payment method configuration for the checkout session. Only applies
669
- # to setup mode. If not provided, the platform or company defaults will apply.
670
- #
671
- # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
672
- #
673
- # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
674
- #
675
- # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
676
- end
677
- end
678
-
679
- class CreateCheckoutSessionInputModePaymentWithPlanID < WhopSDK::Internal::Type::BaseModel
680
- # @!attribute plan_id
681
- # The unique identifier of an existing plan to use for this checkout
682
- # configuration.
683
- #
684
- # @return [String]
685
- required :plan_id, String
686
-
687
- # @!attribute affiliate_code
688
- # An affiliate tracking code to attribute the checkout to a specific affiliate.
689
- #
690
- # @return [String, nil]
691
- optional :affiliate_code, String, nil?: true
692
-
693
- # @!attribute allow_promo_codes
694
- # Whether the checkout should show the promo code input field and accept promo
695
- # codes. Defaults to true.
696
- #
697
- # @return [Boolean, nil]
698
- optional :allow_promo_codes, WhopSDK::Internal::Type::Boolean, nil?: true
699
-
700
- # @!attribute checkout_styling
701
- # Checkout styling overrides for this session. Overrides plan and company
702
- # defaults.
703
- #
704
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling, nil]
705
- optional :checkout_styling,
706
- -> {
707
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling
708
- },
709
- nil?: true
710
-
711
- # @!attribute currency
712
- # The available currencies on the platform
713
- #
714
- # @return [Symbol, WhopSDK::Models::Currency, nil]
715
- optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
716
-
717
- # @!attribute metadata
718
- # Custom key-value metadata to attach to the checkout configuration.
719
- #
720
- # @return [Hash{Symbol=>Object}, nil]
721
- optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
722
-
723
- # @!attribute mode
724
- #
725
- # @return [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::Mode, nil]
726
- optional :mode,
727
- enum: -> { WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::Mode }
728
-
729
- # @!attribute payment_method_configuration
730
- # The explicit payment method configuration for the checkout session. Only applies
731
- # to setup mode. If not provided, the platform or company defaults will apply.
732
- #
733
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::PaymentMethodConfiguration, nil]
734
- optional :payment_method_configuration,
735
- -> {
736
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::PaymentMethodConfiguration
737
- },
738
- nil?: true
739
-
740
- # @!attribute redirect_url
741
- # The URL to redirect the user to after checkout is completed.
742
- #
743
- # @return [String, nil]
744
- optional :redirect_url, String, nil?: true
745
-
746
- # @!attribute source_url
747
- # The URL of the page where the checkout is being initiated from.
748
- #
749
- # @return [String, nil]
750
- optional :source_url, String, nil?: true
751
-
752
- # @!method initialize(plan_id:, affiliate_code: nil, allow_promo_codes: nil, checkout_styling: nil, currency: nil, metadata: nil, mode: nil, payment_method_configuration: nil, redirect_url: nil, source_url: nil)
753
- # Some parameter documentations has been truncated, see
754
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID}
755
- # for more details.
756
- #
757
- # Autogenerated input type of CreateCheckoutSession
758
- #
759
- # @param plan_id [String] The unique identifier of an existing plan to use for this checkout configuration
760
- #
761
- # @param affiliate_code [String, nil] An affiliate tracking code to attribute the checkout to a specific affiliate.
762
- #
763
- # @param allow_promo_codes [Boolean, nil] Whether the checkout should show the promo code input field and accept promo cod
764
- #
765
- # @param checkout_styling [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling, nil] Checkout styling overrides for this session. Overrides plan and company defaults
766
- #
767
- # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
768
- #
769
- # @param metadata [Hash{Symbol=>Object}, nil] Custom key-value metadata to attach to the checkout configuration.
770
- #
771
- # @param mode [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::Mode]
772
- #
773
- # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::PaymentMethodConfiguration, nil] The explicit payment method configuration for the checkout session. Only applies
774
- #
775
- # @param redirect_url [String, nil] The URL to redirect the user to after checkout is completed.
776
- #
777
- # @param source_url [String, nil] The URL of the page where the checkout is being initiated from.
778
-
779
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID#checkout_styling
780
- class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
781
- # @!attribute background_color
782
- # A hex color code for the checkout page background, applied to the order summary
783
- # panel (e.g. #F4F4F5).
784
- #
785
- # @return [String, nil]
786
- optional :background_color, String, nil?: true
787
-
788
- # @!attribute border_style
789
- # The different border-radius styles available for checkout pages.
790
- #
791
- # @return [Symbol, WhopSDK::Models::CheckoutShape, nil]
792
- optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true
793
-
794
- # @!attribute button_color
795
- # A hex color code for the button color (e.g. #FF5733).
796
- #
797
- # @return [String, nil]
798
- optional :button_color, String, nil?: true
22
+ # @!attribute currency
23
+ # Currency used for setup-mode payment method availability.
24
+ #
25
+ # @return [String, nil]
26
+ optional :currency, String, nil?: true
799
27
 
800
- # @!attribute font_family
801
- # The different font families available for checkout pages.
802
- #
803
- # @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
804
- optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
28
+ # @!attribute metadata
29
+ # Custom key-value metadata copied to payments and memberships.
30
+ #
31
+ # @return [Object, nil]
32
+ optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
805
33
 
806
- # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
807
- # Some parameter documentations has been truncated, see
808
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::CheckoutStyling}
809
- # for more details.
810
- #
811
- # Checkout styling overrides for this session. Overrides plan and company
812
- # defaults.
813
- #
814
- # @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
815
- #
816
- # @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
817
- #
818
- # @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
819
- #
820
- # @param font_family [Symbol, WhopSDK::Models::CheckoutFont, nil] The different font families available for checkout pages.
821
- end
34
+ # @!attribute mode
35
+ # Checkout mode: `payment` collects payment for a plan now; `setup` saves payment
36
+ # details without charging. Defaults to `payment`.
37
+ #
38
+ # @return [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Mode, nil]
39
+ optional :mode, enum: -> { WhopSDK::CheckoutConfigurationCreateParams::Mode }
822
40
 
823
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID#mode
824
- module Mode
825
- extend WhopSDK::Internal::Type::Enum
41
+ # @!attribute payment_method_configuration
42
+ # Payment method overrides for this checkout. `null` uses the plan or platform
43
+ # defaults.
44
+ #
45
+ # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::PaymentMethodConfiguration, nil]
46
+ optional :payment_method_configuration,
47
+ -> { WhopSDK::CheckoutConfigurationCreateParams::PaymentMethodConfiguration },
48
+ nil?: true
49
+
50
+ # @!attribute plan
51
+ # Plan attributes used to create or find a plan for this checkout configuration.
52
+ # Mutually exclusive with `plan_id`.
53
+ #
54
+ # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil]
55
+ optional :plan, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan }, nil?: true
826
56
 
827
- PAYMENT = :payment
57
+ # @!attribute plan_id
58
+ # Existing plan ID, prefixed `plan_`. Mutually exclusive with `plan`.
59
+ #
60
+ # @return [String, nil]
61
+ optional :plan_id, String, nil?: true
828
62
 
829
- # @!method self.values
830
- # @return [Array<Symbol>]
831
- end
63
+ # @!attribute redirect_url
64
+ # URL customers are sent to after checkout.
65
+ #
66
+ # @return [String, nil]
67
+ optional :redirect_url, String, nil?: true
832
68
 
833
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID#payment_method_configuration
834
- class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
835
- # @!attribute disabled
836
- # An array of payment method identifiers that are explicitly disabled. Only
837
- # applies if the include_platform_defaults is true.
838
- #
839
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
840
- required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
69
+ # @!attribute three_ds_level
70
+ # 3D Secure behavior for this checkout.
71
+ #
72
+ # @return [String, nil]
73
+ optional :three_ds_level, String, nil?: true
841
74
 
842
- # @!attribute enabled
843
- # An array of payment method identifiers that are explicitly enabled. This means
844
- # these payment methods will be shown on checkout. Example use case is to only
845
- # enable a specific payment method like cashapp, or extending the platform
846
- # defaults with additional methods.
847
- #
848
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
849
- required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
75
+ # @!method initialize(affiliate_code: nil, company_id: nil, currency: nil, metadata: nil, mode: nil, payment_method_configuration: nil, plan: nil, plan_id: nil, redirect_url: nil, three_ds_level: nil, request_options: {})
76
+ # Some parameter documentations has been truncated, see
77
+ # {WhopSDK::Models::CheckoutConfigurationCreateParams} for more details.
78
+ #
79
+ # @param affiliate_code [String, nil] Affiliate code to apply to the checkout.
80
+ #
81
+ # @param company_id [String] Account ID, prefixed `biz_`.
82
+ #
83
+ # @param currency [String, nil] Currency used for setup-mode payment method availability.
84
+ #
85
+ # @param metadata [Object, nil] Custom key-value metadata copied to payments and memberships.
86
+ #
87
+ # @param mode [Symbol, WhopSDK::Models::CheckoutConfigurationCreateParams::Mode] Checkout mode: `payment` collects payment for a plan now; `setup` saves payment
88
+ #
89
+ # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::PaymentMethodConfiguration, nil] Payment method overrides for this checkout. `null` uses the plan or platform def
90
+ #
91
+ # @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil] Plan attributes used to create or find a plan for this checkout configuration. M
92
+ #
93
+ # @param plan_id [String, nil] Existing plan ID, prefixed `plan_`. Mutually exclusive with `plan`.
94
+ #
95
+ # @param redirect_url [String, nil] URL customers are sent to after checkout.
96
+ #
97
+ # @param three_ds_level [String, nil] 3D Secure behavior for this checkout.
98
+ #
99
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
850
100
 
851
- # @!attribute include_platform_defaults
852
- # Whether Whop's platform default payment method enablement settings are included
853
- # in this configuration. The full list of default payment methods can be found in
854
- # the documentation at docs.whop.com/payments.
855
- #
856
- # @return [Boolean, nil]
857
- optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
101
+ # Checkout mode: `payment` collects payment for a plan now; `setup` saves payment
102
+ # details without charging. Defaults to `payment`.
103
+ module Mode
104
+ extend WhopSDK::Internal::Type::Enum
858
105
 
859
- # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
860
- # Some parameter documentations has been truncated, see
861
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID::PaymentMethodConfiguration}
862
- # for more details.
863
- #
864
- # The explicit payment method configuration for the checkout session. Only applies
865
- # to setup mode. If not provided, the platform or company defaults will apply.
866
- #
867
- # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
868
- #
869
- # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
870
- #
871
- # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
872
- end
873
- end
106
+ PAYMENT = :payment
107
+ SETUP = :setup
874
108
 
875
- class CreateCheckoutSessionInputModeSetup < WhopSDK::Internal::Type::BaseModel
876
- # @!attribute company_id
877
- # The unique identifier of the company to create the checkout configuration for.
878
- # Only required in setup mode.
879
- #
880
- # @return [String]
881
- required :company_id, String
109
+ # @!method self.values
110
+ # @return [Array<Symbol>]
111
+ end
882
112
 
883
- # @!attribute mode
884
- #
885
- # @return [Symbol, :setup]
886
- required :mode, const: :setup
113
+ class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
114
+ # @!attribute disabled
115
+ # Payment methods explicitly disabled for checkout.
116
+ #
117
+ # @return [Array<String>, nil]
118
+ optional :disabled, WhopSDK::Internal::Type::ArrayOf[String]
119
+
120
+ # @!attribute enabled
121
+ # Payment methods explicitly enabled for checkout.
122
+ #
123
+ # @return [Array<String>, nil]
124
+ optional :enabled, WhopSDK::Internal::Type::ArrayOf[String]
125
+
126
+ # @!attribute include_platform_defaults
127
+ # Whether platform default payment methods are included.
128
+ #
129
+ # @return [Boolean, nil]
130
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean
131
+
132
+ # @!method initialize(disabled: nil, enabled: nil, include_platform_defaults: nil)
133
+ # Payment method overrides for this checkout. `null` uses the plan or platform
134
+ # defaults.
135
+ #
136
+ # @param disabled [Array<String>] Payment methods explicitly disabled for checkout.
137
+ #
138
+ # @param enabled [Array<String>] Payment methods explicitly enabled for checkout.
139
+ #
140
+ # @param include_platform_defaults [Boolean] Whether platform default payment methods are included.
141
+ end
887
142
 
888
- # @!attribute allow_promo_codes
889
- # Whether the checkout should show the promo code input field and accept promo
890
- # codes. Defaults to true.
143
+ class Plan < WhopSDK::Internal::Type::BaseModel
144
+ # @!attribute billing_period
145
+ # Recurring billing interval in days, such as 30 for monthly or 365 for annual.
146
+ #
147
+ # @return [Integer, nil]
148
+ optional :billing_period, Integer, nil?: true
149
+
150
+ # @!attribute company_id
151
+ # Account ID for the inline plan, prefixed `biz_`. Defaults to the account
152
+ # resolved from the request.
153
+ #
154
+ # @return [String, nil]
155
+ optional :company_id, String, nil?: true
156
+
157
+ # @!attribute currency
158
+ # Three-letter ISO currency code for the plan's prices.
159
+ #
160
+ # @return [String, nil]
161
+ optional :currency, String, nil?: true
162
+
163
+ # @!attribute description
164
+ # Customer-visible plan description.
165
+ #
166
+ # @return [String, nil]
167
+ optional :description, String, nil?: true
168
+
169
+ # @!attribute expiration_days
170
+ # Access duration in days for expiration-based plans.
171
+ #
172
+ # @return [Integer, nil]
173
+ optional :expiration_days, Integer, nil?: true
174
+
175
+ # @!attribute force_create_new_plan
176
+ # Whether to create a new plan instead of reusing a matching one.
177
+ #
178
+ # @return [Boolean, nil]
179
+ optional :force_create_new_plan, WhopSDK::Internal::Type::Boolean, nil?: true
180
+
181
+ # @!attribute initial_price
182
+ # Initial purchase price in the plan currency.
183
+ #
184
+ # @return [Float, nil]
185
+ optional :initial_price, Float, nil?: true
186
+
187
+ # @!attribute metadata
188
+ # Custom key-value metadata stored on the plan.
189
+ #
190
+ # @return [Object, nil]
191
+ optional :metadata, WhopSDK::Internal::Type::Unknown, nil?: true
192
+
193
+ # @!attribute override_tax_type
194
+ # Tax classification override for this plan.
195
+ #
196
+ # @return [String, nil]
197
+ optional :override_tax_type, String, nil?: true
198
+
199
+ # @!attribute payment_method_configuration
200
+ # Payment method overrides for the inline plan. `null` uses platform defaults.
201
+ #
202
+ # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil]
203
+ optional :payment_method_configuration,
204
+ -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration },
205
+ nil?: true
206
+
207
+ # @!attribute plan_type
208
+ # Billing model for the plan: `renewal` (recurring) or `one_time` (single
209
+ # payment).
210
+ #
211
+ # @return [String, nil]
212
+ optional :plan_type, String, nil?: true
213
+
214
+ # @!attribute product_id
215
+ # Product ID the inline plan should belong to, prefixed `prod_`.
216
+ #
217
+ # @return [String, nil]
218
+ optional :product_id, String, nil?: true
219
+
220
+ # @!attribute release_method
221
+ # Sales method for the plan, such as `buy_now` or `waitlist`.
222
+ #
223
+ # @return [String, nil]
224
+ optional :release_method, String, nil?: true
225
+
226
+ # @!attribute renewal_price
227
+ # Recurring price charged each billing period.
228
+ #
229
+ # @return [Float, nil]
230
+ optional :renewal_price, Float, nil?: true
231
+
232
+ # @!attribute stock
233
+ # Units available for purchase.
234
+ #
235
+ # @return [Integer, nil]
236
+ optional :stock, Integer, nil?: true
237
+
238
+ # @!attribute title
239
+ # Plan display name shown to customers.
240
+ #
241
+ # @return [String, nil]
242
+ optional :title, String, nil?: true
243
+
244
+ # @!attribute trial_period_days
245
+ # Free trial days before the first renewal charge.
246
+ #
247
+ # @return [Integer, nil]
248
+ optional :trial_period_days, Integer, nil?: true
249
+
250
+ # @!attribute unlimited_stock
251
+ # Whether the plan has unlimited stock.
252
+ #
253
+ # @return [Boolean, nil]
254
+ optional :unlimited_stock, WhopSDK::Internal::Type::Boolean, nil?: true
255
+
256
+ # @!attribute visibility
257
+ # Whether the plan is visible to customers or hidden from public view.
258
+ #
259
+ # @return [String, nil]
260
+ optional :visibility, String, nil?: true
261
+
262
+ # @!method initialize(billing_period: nil, company_id: nil, currency: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, initial_price: nil, metadata: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product_id: nil, release_method: nil, renewal_price: nil, stock: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil)
263
+ # Some parameter documentations has been truncated, see
264
+ # {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan} for more details.
265
+ #
266
+ # Plan attributes used to create or find a plan for this checkout configuration.
267
+ # Mutually exclusive with `plan_id`.
268
+ #
269
+ # @param billing_period [Integer, nil] Recurring billing interval in days, such as 30 for monthly or 365 for annual.
270
+ #
271
+ # @param company_id [String, nil] Account ID for the inline plan, prefixed `biz_`. Defaults to the account resolve
272
+ #
273
+ # @param currency [String, nil] Three-letter ISO currency code for the plan's prices.
274
+ #
275
+ # @param description [String, nil] Customer-visible plan description.
276
+ #
277
+ # @param expiration_days [Integer, nil] Access duration in days for expiration-based plans.
278
+ #
279
+ # @param force_create_new_plan [Boolean, nil] Whether to create a new plan instead of reusing a matching one.
280
+ #
281
+ # @param initial_price [Float, nil] Initial purchase price in the plan currency.
282
+ #
283
+ # @param metadata [Object, nil] Custom key-value metadata stored on the plan.
284
+ #
285
+ # @param override_tax_type [String, nil] Tax classification override for this plan.
286
+ #
287
+ # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil] Payment method overrides for the inline plan. `null` uses platform defaults.
288
+ #
289
+ # @param plan_type [String, nil] Billing model for the plan: `renewal` (recurring) or `one_time` (single payment)
290
+ #
291
+ # @param product_id [String, nil] Product ID the inline plan should belong to, prefixed `prod_`.
292
+ #
293
+ # @param release_method [String, nil] Sales method for the plan, such as `buy_now` or `waitlist`.
294
+ #
295
+ # @param renewal_price [Float, nil] Recurring price charged each billing period.
296
+ #
297
+ # @param stock [Integer, nil] Units available for purchase.
298
+ #
299
+ # @param title [String, nil] Plan display name shown to customers.
300
+ #
301
+ # @param trial_period_days [Integer, nil] Free trial days before the first renewal charge.
302
+ #
303
+ # @param unlimited_stock [Boolean, nil] Whether the plan has unlimited stock.
304
+ #
305
+ # @param visibility [String, nil] Whether the plan is visible to customers or hidden from public view.
306
+
307
+ # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#payment_method_configuration
308
+ class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
309
+ # @!attribute disabled
310
+ # Payment methods explicitly disabled for this plan.
311
+ #
312
+ # @return [Array<String>, nil]
313
+ optional :disabled, WhopSDK::Internal::Type::ArrayOf[String]
314
+
315
+ # @!attribute enabled
316
+ # Payment methods explicitly enabled for this plan.
317
+ #
318
+ # @return [Array<String>, nil]
319
+ optional :enabled, WhopSDK::Internal::Type::ArrayOf[String]
320
+
321
+ # @!attribute include_platform_defaults
322
+ # Whether platform default payment methods are included.
891
323
  #
892
324
  # @return [Boolean, nil]
893
- optional :allow_promo_codes, WhopSDK::Internal::Type::Boolean, nil?: true
325
+ optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean
894
326
 
895
- # @!attribute checkout_styling
896
- # Checkout styling overrides for this session. Overrides plan and company
897
- # defaults.
327
+ # @!method initialize(disabled: nil, enabled: nil, include_platform_defaults: nil)
328
+ # Payment method overrides for the inline plan. `null` uses platform defaults.
898
329
  #
899
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling, nil]
900
- optional :checkout_styling,
901
- -> {
902
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling
903
- },
904
- nil?: true
905
-
906
- # @!attribute currency
907
- # The available currencies on the platform
908
- #
909
- # @return [Symbol, WhopSDK::Models::Currency, nil]
910
- optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
911
-
912
- # @!attribute metadata
913
- # Custom key-value metadata to attach to the checkout configuration.
330
+ # @param disabled [Array<String>] Payment methods explicitly disabled for this plan.
914
331
  #
915
- # @return [Hash{Symbol=>Object}, nil]
916
- optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
917
-
918
- # @!attribute payment_method_configuration
919
- # The explicit payment method configuration for the checkout session. Only applies
920
- # to setup mode. If not provided, the platform or company defaults will apply.
921
- #
922
- # @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::PaymentMethodConfiguration, nil]
923
- optional :payment_method_configuration,
924
- -> {
925
- WhopSDK::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::PaymentMethodConfiguration
926
- },
927
- nil?: true
928
-
929
- # @!attribute redirect_url
930
- # The URL to redirect the user to after checkout is completed.
332
+ # @param enabled [Array<String>] Payment methods explicitly enabled for this plan.
931
333
  #
932
- # @return [String, nil]
933
- optional :redirect_url, String, nil?: true
934
-
935
- # @!attribute source_url
936
- # The URL of the page where the checkout is being initiated from.
937
- #
938
- # @return [String, nil]
939
- optional :source_url, String, nil?: true
940
-
941
- # @!method initialize(company_id:, allow_promo_codes: nil, checkout_styling: nil, currency: nil, metadata: nil, payment_method_configuration: nil, redirect_url: nil, source_url: nil, mode: :setup)
942
- # Some parameter documentations has been truncated, see
943
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup}
944
- # for more details.
945
- #
946
- # Autogenerated input type of CreateCheckoutSession
947
- #
948
- # @param company_id [String] The unique identifier of the company to create the checkout configuration for. O
949
- #
950
- # @param allow_promo_codes [Boolean, nil] Whether the checkout should show the promo code input field and accept promo cod
951
- #
952
- # @param checkout_styling [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling, nil] Checkout styling overrides for this session. Overrides plan and company defaults
953
- #
954
- # @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
955
- #
956
- # @param metadata [Hash{Symbol=>Object}, nil] Custom key-value metadata to attach to the checkout configuration.
957
- #
958
- # @param payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::PaymentMethodConfiguration, nil] The explicit payment method configuration for the checkout session. Only applies
959
- #
960
- # @param redirect_url [String, nil] The URL to redirect the user to after checkout is completed.
961
- #
962
- # @param source_url [String, nil] The URL of the page where the checkout is being initiated from.
963
- #
964
- # @param mode [Symbol, :setup]
965
-
966
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup#checkout_styling
967
- class CheckoutStyling < WhopSDK::Internal::Type::BaseModel
968
- # @!attribute background_color
969
- # A hex color code for the checkout page background, applied to the order summary
970
- # panel (e.g. #F4F4F5).
971
- #
972
- # @return [String, nil]
973
- optional :background_color, String, nil?: true
974
-
975
- # @!attribute border_style
976
- # The different border-radius styles available for checkout pages.
977
- #
978
- # @return [Symbol, WhopSDK::Models::CheckoutShape, nil]
979
- optional :border_style, enum: -> { WhopSDK::CheckoutShape }, nil?: true
980
-
981
- # @!attribute button_color
982
- # A hex color code for the button color (e.g. #FF5733).
983
- #
984
- # @return [String, nil]
985
- optional :button_color, String, nil?: true
986
-
987
- # @!attribute font_family
988
- # The different font families available for checkout pages.
989
- #
990
- # @return [Symbol, WhopSDK::Models::CheckoutFont, nil]
991
- optional :font_family, enum: -> { WhopSDK::CheckoutFont }, nil?: true
992
-
993
- # @!method initialize(background_color: nil, border_style: nil, button_color: nil, font_family: nil)
994
- # Some parameter documentations has been truncated, see
995
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::CheckoutStyling}
996
- # for more details.
997
- #
998
- # Checkout styling overrides for this session. Overrides plan and company
999
- # defaults.
1000
- #
1001
- # @param background_color [String, nil] A hex color code for the checkout page background, applied to the order summary
1002
- #
1003
- # @param border_style [Symbol, WhopSDK::Models::CheckoutShape, nil] The different border-radius styles available for checkout pages.
1004
- #
1005
- # @param button_color [String, nil] A hex color code for the button color (e.g. #FF5733).
1006
- #
1007
- # @param font_family [Symbol, WhopSDK::Models::CheckoutFont, nil] The different font families available for checkout pages.
1008
- end
1009
-
1010
- # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup#payment_method_configuration
1011
- class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
1012
- # @!attribute disabled
1013
- # An array of payment method identifiers that are explicitly disabled. Only
1014
- # applies if the include_platform_defaults is true.
1015
- #
1016
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
1017
- required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
1018
-
1019
- # @!attribute enabled
1020
- # An array of payment method identifiers that are explicitly enabled. This means
1021
- # these payment methods will be shown on checkout. Example use case is to only
1022
- # enable a specific payment method like cashapp, or extending the platform
1023
- # defaults with additional methods.
1024
- #
1025
- # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
1026
- required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
1027
-
1028
- # @!attribute include_platform_defaults
1029
- # Whether Whop's platform default payment method enablement settings are included
1030
- # in this configuration. The full list of default payment methods can be found in
1031
- # the documentation at docs.whop.com/payments.
1032
- #
1033
- # @return [Boolean, nil]
1034
- optional :include_platform_defaults, WhopSDK::Internal::Type::Boolean, nil?: true
1035
-
1036
- # @!method initialize(disabled:, enabled:, include_platform_defaults: nil)
1037
- # Some parameter documentations has been truncated, see
1038
- # {WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup::PaymentMethodConfiguration}
1039
- # for more details.
1040
- #
1041
- # The explicit payment method configuration for the checkout session. Only applies
1042
- # to setup mode. If not provided, the platform or company defaults will apply.
1043
- #
1044
- # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
1045
- #
1046
- # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
1047
- #
1048
- # @param include_platform_defaults [Boolean, nil] Whether Whop's platform default payment method enablement settings are included
1049
- end
334
+ # @param include_platform_defaults [Boolean] Whether platform default payment methods are included.
1050
335
  end
1051
-
1052
- # @!method self.variants
1053
- # @return [Array(WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlan, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModePaymentWithPlanID, WhopSDK::Models::CheckoutConfigurationCreateParams::Body::CreateCheckoutSessionInputModeSetup)]
1054
336
  end
1055
337
  end
1056
338
  end