whop_sdk 2.4.0 → 2.5.0

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 (289) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +3 -3
  3. data/.fern/replay.lock +313 -1
  4. data/lib/whop_sdk/access_tokens/client.rb +2 -3
  5. data/lib/whop_sdk/account_links/client.rb +2 -2
  6. data/lib/whop_sdk/accounts/client.rb +8 -19
  7. data/lib/whop_sdk/accounts/fees/client.rb +5 -6
  8. data/lib/whop_sdk/accounts/financing_applications/client.rb +18 -24
  9. data/lib/whop_sdk/accounts/financing_applications/types/update_financing_applications_request_answers_item_money.rb +1 -0
  10. data/lib/whop_sdk/accounts/preferences/client.rb +1 -0
  11. data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response.rb +2 -0
  12. data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response_feedback_options_item.rb +17 -0
  13. data/lib/whop_sdk/accounts/preferences/types/retrieve_preferences_response_feedback_options_item_category.rb +21 -0
  14. data/lib/whop_sdk/accounts/preferences/types/update_preferences_request.rb +2 -0
  15. data/lib/whop_sdk/accounts/preferences/types/update_preferences_request_feedback_options_item.rb +17 -0
  16. data/lib/whop_sdk/accounts/preferences/types/update_preferences_request_feedback_options_item_category.rb +21 -0
  17. data/lib/whop_sdk/accounts/preferences/types/update_preferences_response.rb +2 -0
  18. data/lib/whop_sdk/accounts/preferences/types/update_preferences_response_feedback_options_item.rb +17 -0
  19. data/lib/whop_sdk/accounts/preferences/types/update_preferences_response_feedback_options_item_category.rb +21 -0
  20. data/lib/whop_sdk/accounts/types/form_company_accounts_request.rb +0 -6
  21. data/lib/whop_sdk/accounts/types/post_account_financing_disabled_payload.rb +25 -0
  22. data/lib/whop_sdk/{partners/types/referred_users_partners_request_user_id.rb → accounts/types/post_account_financing_disabled_payload_api_version.rb} +3 -3
  23. data/lib/whop_sdk/accounts/types/post_account_financing_disabled_payload_type.rb +13 -0
  24. data/lib/whop_sdk/accounts/types/transfer_ownership_accounts_request.rb +2 -0
  25. data/lib/whop_sdk/accounts/types/update_accounts_request.rb +2 -6
  26. data/lib/whop_sdk/ad_campaigns/client.rb +4 -4
  27. data/lib/whop_sdk/ad_campaigns/types/post_ad_campaign_payment_failed_payload_data_delivery_status.rb +1 -0
  28. data/lib/whop_sdk/ad_campaigns/types/post_ad_campaign_updated_payload_data_delivery_status.rb +1 -0
  29. data/lib/whop_sdk/ad_conversion_value_rules/client.rb +11 -9
  30. data/lib/whop_sdk/ad_groups/client.rb +7 -11
  31. data/lib/whop_sdk/ads/client.rb +1 -2
  32. data/lib/whop_sdk/affiliates/client.rb +5 -5
  33. data/lib/whop_sdk/api_keys/client.rb +2 -2
  34. data/lib/whop_sdk/api_keys/types/create_api_keys_request_api_version_date.rb +2 -0
  35. data/lib/whop_sdk/api_keys/types/update_api_keys_request_api_version_date.rb +2 -0
  36. data/lib/whop_sdk/app_builds/client.rb +2 -2
  37. data/lib/whop_sdk/app_builds/types/create_app_builds_request_attachment.rb +2 -1
  38. data/lib/whop_sdk/apps/client.rb +2 -4
  39. data/lib/whop_sdk/audiences/client.rb +5 -5
  40. data/lib/whop_sdk/authorized_users/client.rb +3 -4
  41. data/lib/whop_sdk/bounty_submissions/client.rb +7 -10
  42. data/lib/whop_sdk/bounty_submissions/types/submit_bounty_submissions_request_deliverable.rb +3 -1
  43. data/lib/whop_sdk/card_transactions/client.rb +5 -6
  44. data/lib/whop_sdk/cards/client.rb +4 -4
  45. data/lib/whop_sdk/cashback_rules/client.rb +16 -20
  46. data/lib/whop_sdk/chat_channels/client.rb +2 -2
  47. data/lib/whop_sdk/checkout_configurations/client.rb +2 -1
  48. data/lib/whop_sdk/claim_links/client.rb +8 -8
  49. data/lib/whop_sdk/client.rb +1 -1
  50. data/lib/whop_sdk/company_token_transactions/client.rb +3 -4
  51. data/lib/whop_sdk/confirmation_tokens/client.rb +3 -3
  52. data/lib/whop_sdk/course_lesson_interactions/client.rb +2 -1
  53. data/lib/whop_sdk/courses/client.rb +4 -2
  54. data/lib/whop_sdk/deposits/client.rb +3 -2
  55. data/lib/whop_sdk/disputes/client.rb +5 -12
  56. data/lib/whop_sdk/dm_channels/client.rb +5 -6
  57. data/lib/whop_sdk/domains/client.rb +4 -0
  58. data/lib/whop_sdk/domains/types/create_domains_request.rb +4 -0
  59. data/lib/whop_sdk/domains/types/create_domains_request_apple_pay.rb +13 -0
  60. data/lib/whop_sdk/domains/types/create_domains_request_pixel.rb +12 -0
  61. data/lib/whop_sdk/domains/types/list_domains_request.rb +4 -0
  62. data/lib/whop_sdk/domains/types/list_domains_request_apple_pay.rb +17 -0
  63. data/lib/whop_sdk/domains/types/list_domains_request_order.rb +2 -0
  64. data/lib/whop_sdk/domains/types/list_domains_request_pixel.rb +17 -0
  65. data/lib/whop_sdk/domains/types/update_domains_request.rb +4 -0
  66. data/lib/whop_sdk/domains/types/update_domains_request_apple_pay.rb +13 -0
  67. data/lib/whop_sdk/domains/types/update_domains_request_pixel.rb +12 -0
  68. data/lib/whop_sdk/economic_intelligence/client.rb +6 -8
  69. data/lib/whop_sdk/events/client.rb +12 -16
  70. data/lib/whop_sdk/experiences/client.rb +15 -9
  71. data/lib/whop_sdk/experiments/client.rb +16 -29
  72. data/lib/whop_sdk/exports/client.rb +1 -1
  73. data/lib/whop_sdk/external_accounts/client.rb +3 -5
  74. data/lib/whop_sdk/fee_markups/client.rb +5 -6
  75. data/lib/whop_sdk/feedback_submissions/client.rb +0 -1
  76. data/lib/whop_sdk/files/client.rb +2 -2
  77. data/lib/whop_sdk/financial_reports/breakdown/client.rb +3 -1
  78. data/lib/whop_sdk/forum_posts/client.rb +1 -1
  79. data/lib/whop_sdk/forums/client.rb +1 -1
  80. data/lib/whop_sdk/identity_profiles/client.rb +4 -4
  81. data/lib/whop_sdk/internal/http/raw_client.rb +1 -1
  82. data/lib/whop_sdk/invoices/client.rb +1 -1
  83. data/lib/whop_sdk/leads/client.rb +3 -3
  84. data/lib/whop_sdk/members/client.rb +21 -1
  85. data/lib/whop_sdk/members/logs/client.rb +1 -1
  86. data/lib/whop_sdk/members/notes/client.rb +121 -0
  87. data/lib/whop_sdk/members/notes/types/create_notes_request.rb +15 -0
  88. data/lib/whop_sdk/members/notes/types/list_notes_request.rb +21 -0
  89. data/lib/whop_sdk/members/notes/types/list_notes_response.rb +15 -0
  90. data/lib/whop_sdk/members/notes/types/list_notes_response_page_info.rb +19 -0
  91. data/lib/whop_sdk/members/types/list_members_request.rb +10 -0
  92. data/lib/whop_sdk/members/types/list_members_request_membership_status.rb +14 -0
  93. data/lib/whop_sdk/members/types/list_members_request_most_recent_actions_item.rb +25 -0
  94. data/lib/whop_sdk/members/types/list_members_request_order.rb +1 -0
  95. data/lib/whop_sdk/memberships/client.rb +30 -28
  96. data/lib/whop_sdk/memberships/types/cancel_memberships_request.rb +2 -0
  97. data/lib/whop_sdk/memberships/types/list_memberships_request.rb +10 -0
  98. data/lib/whop_sdk/memberships/types/list_memberships_request_status.rb +4 -0
  99. data/lib/whop_sdk/memberships/types/list_memberships_request_statuses_item.rb +24 -0
  100. data/lib/whop_sdk/messages/client.rb +5 -7
  101. data/lib/whop_sdk/notifications/client.rb +6 -9
  102. data/lib/whop_sdk/partner_referral_requests/client.rb +3 -3
  103. data/lib/whop_sdk/partners/businesses/client.rb +99 -0
  104. data/lib/whop_sdk/partners/businesses/earnings/types/list_earnings_request_income_source_item.rb +1 -0
  105. data/lib/whop_sdk/partners/businesses/earnings/types/list_earnings_response_data_item_income_source.rb +1 -0
  106. data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_request.rb +21 -0
  107. data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_request_acknowledgments_item.rb +17 -0
  108. data/lib/whop_sdk/partners/businesses/types/accept_commission_advance_businesses_response.rb +15 -0
  109. data/lib/whop_sdk/partners/businesses/types/list_businesses_request.rb +2 -0
  110. data/lib/whop_sdk/partners/businesses/types/list_businesses_request_advance_status.rb +22 -0
  111. data/lib/whop_sdk/partners/businesses/types/list_businesses_response_data_item.rb +2 -0
  112. data/lib/whop_sdk/partners/businesses/types/retrieve_businesses_response.rb +2 -0
  113. data/lib/whop_sdk/partners/businesses/types/update_businesses_request.rb +17 -0
  114. data/lib/whop_sdk/partners/businesses/types/update_businesses_response.rb +15 -0
  115. data/lib/whop_sdk/partners/client.rb +6 -11
  116. data/lib/whop_sdk/partners/types/referred_users_partners_request.rb +0 -2
  117. data/lib/whop_sdk/payment_method_domains/client.rb +4 -5
  118. data/lib/whop_sdk/payment_methods/client.rb +4 -5
  119. data/lib/whop_sdk/payment_quotes/client.rb +8 -10
  120. data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request.rb +2 -2
  121. data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request_line_items_item.rb +13 -0
  122. data/lib/whop_sdk/payment_rules/client.rb +19 -8
  123. data/lib/whop_sdk/payments/client.rb +26 -24
  124. data/lib/whop_sdk/payments/direct/client.rb +5 -6
  125. data/lib/whop_sdk/payments/direct/types/create_direct_request.rb +2 -2
  126. data/lib/whop_sdk/payments/direct/types/create_direct_request_line_items_item.rb +15 -0
  127. data/lib/whop_sdk/payments/types/create_payments_request.rb +2 -2
  128. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item.rb +13 -0
  129. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan.rb +46 -0
  130. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_currency.rb +102 -0
  131. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_override_tax_type.rb +15 -0
  132. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_plan_type.rb +14 -0
  133. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product.rb +34 -0
  134. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product_global_affiliate_status.rb +14 -0
  135. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_product_visibility.rb +16 -0
  136. data/lib/whop_sdk/payments/types/create_payments_request_line_items_item_plan_visibility.rb +16 -0
  137. data/lib/whop_sdk/payments/types/resume_payments_request.rb +2 -0
  138. data/lib/whop_sdk/payout_methods/client.rb +1 -1
  139. data/lib/whop_sdk/payouts/client.rb +15 -12
  140. data/lib/whop_sdk/payouts/methods/client.rb +2 -2
  141. data/lib/whop_sdk/payouts/methods/types/create_methods_request.rb +2 -0
  142. data/lib/whop_sdk/payouts/methods/types/list_methods_response_limits_standard_error_code.rb +1 -1
  143. data/lib/whop_sdk/payouts/paypal_link_sessions/client.rb +67 -0
  144. data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_request.rb +21 -0
  145. data/lib/whop_sdk/payouts/paypal_link_sessions/types/create_paypal_link_sessions_response.rb +15 -0
  146. data/lib/whop_sdk/payouts/supported_methods/client.rb +2 -1
  147. data/lib/whop_sdk/payouts/supported_methods/types/list_supported_methods_response_data_item.rb +2 -0
  148. data/lib/whop_sdk/people/client.rb +3 -5
  149. data/lib/whop_sdk/plans/client.rb +1 -1
  150. data/lib/whop_sdk/products/client.rb +2 -2
  151. data/lib/whop_sdk/promo_codes/client.rb +1 -1
  152. data/lib/whop_sdk/refunds/client.rb +1 -2
  153. data/lib/whop_sdk/reviews/client.rb +59 -19
  154. data/lib/whop_sdk/reviews/types/delete_reviews_request.rb +11 -0
  155. data/lib/whop_sdk/reviews/types/delete_reviews_response.rb +13 -0
  156. data/lib/whop_sdk/reviews/types/list_reviews_request.rb +14 -8
  157. data/lib/whop_sdk/reviews/types/list_reviews_request_direction.rb +14 -0
  158. data/lib/whop_sdk/reviews/types/list_reviews_request_order.rb +14 -0
  159. data/lib/whop_sdk/reviews/types/list_reviews_response.rb +1 -2
  160. data/lib/whop_sdk/reviews/types/list_reviews_response_page_info.rb +17 -0
  161. data/lib/whop_sdk/setup_intents/client.rb +8 -10
  162. data/lib/whop_sdk/setup_intents/direct/client.rb +6 -7
  163. data/lib/whop_sdk/shipments/client.rb +2 -2
  164. data/lib/whop_sdk/stats/client.rb +2 -3
  165. data/lib/whop_sdk/stats/reports/client.rb +6 -10
  166. data/lib/whop_sdk/stats/time_series/client.rb +3 -8
  167. data/lib/whop_sdk/support_channels/client.rb +12 -4
  168. data/lib/whop_sdk/support_channels/types/list_support_channels_request.rb +8 -0
  169. data/lib/whop_sdk/swaps/client.rb +6 -6
  170. data/lib/whop_sdk/team_members/client.rb +7 -10
  171. data/lib/whop_sdk/topups/client.rb +2 -2
  172. data/lib/whop_sdk/trades/client.rb +6 -8
  173. data/lib/whop_sdk/trades/types/create_trades_request.rb +21 -1
  174. data/lib/whop_sdk/trades/types/create_trades_request_instrument_type.rb +14 -0
  175. data/lib/whop_sdk/trades/types/create_trades_request_order_type.rb +14 -0
  176. data/lib/whop_sdk/trades/types/create_trades_request_side.rb +14 -0
  177. data/lib/whop_sdk/trades/types/create_trades_request_type.rb +3 -1
  178. data/lib/whop_sdk/trades/types/list_trades_request_type.rb +3 -1
  179. data/lib/whop_sdk/transfers/client.rb +6 -3
  180. data/lib/whop_sdk/types/account.rb +2 -2
  181. data/lib/whop_sdk/types/account_level.rb +19 -0
  182. data/lib/whop_sdk/types/account_payment_controls_restricted_payment_methods_item.rb +39 -0
  183. data/lib/whop_sdk/types/account_preferences.rb +2 -0
  184. data/lib/whop_sdk/types/ad_campaign_delivery_status.rb +1 -0
  185. data/lib/whop_sdk/types/api_key_api_version_date.rb +2 -0
  186. data/lib/whop_sdk/types/cancel_options.rb +1 -0
  187. data/lib/whop_sdk/types/dispute_evidence_document.rb +12 -0
  188. data/lib/whop_sdk/types/domain.rb +6 -0
  189. data/lib/whop_sdk/types/domain_apple_pay.rb +9 -0
  190. data/lib/whop_sdk/types/domain_apple_pay_state.rb +14 -0
  191. data/lib/whop_sdk/types/domain_issue.rb +2 -0
  192. data/lib/whop_sdk/types/domain_issue_capability.rb +2 -0
  193. data/lib/whop_sdk/types/domain_issue_code.rb +6 -2
  194. data/lib/whop_sdk/types/domain_list_item.rb +6 -0
  195. data/lib/whop_sdk/types/domain_pixel.rb +9 -0
  196. data/lib/whop_sdk/types/domain_pixel_state.rb +13 -0
  197. data/lib/whop_sdk/types/domain_stats.rb +9 -0
  198. data/lib/whop_sdk/types/domain_website.rb +1 -1
  199. data/lib/whop_sdk/types/domain_website_app.rb +11 -0
  200. data/lib/whop_sdk/types/feedback_option.rb +13 -0
  201. data/lib/whop_sdk/types/feedback_option_category.rb +17 -0
  202. data/lib/whop_sdk/types/file.rb +12 -0
  203. data/lib/whop_sdk/types/financing_access_change.rb +19 -0
  204. data/lib/whop_sdk/types/financing_access_change_disabled_payment_methods_item.rb +33 -0
  205. data/lib/whop_sdk/types/financing_access_change_object.rb +11 -0
  206. data/lib/whop_sdk/types/financing_access_change_provider.rb +15 -0
  207. data/lib/whop_sdk/types/financing_access_change_reason.rb +11 -0
  208. data/lib/whop_sdk/types/member.rb +10 -0
  209. data/lib/whop_sdk/types/member_most_recent_action.rb +23 -0
  210. data/lib/whop_sdk/types/member_note.rb +19 -0
  211. data/lib/whop_sdk/types/membership.rb +24 -0
  212. data/lib/whop_sdk/types/membership_cancel_option.rb +18 -0
  213. data/lib/whop_sdk/types/membership_collection_method.rb +12 -0
  214. data/lib/whop_sdk/types/membership_feedback_option.rb +9 -0
  215. data/lib/whop_sdk/types/membership_legacy.rb +2 -0
  216. data/lib/whop_sdk/types/membership_legacy_feedback_option.rb +11 -0
  217. data/lib/whop_sdk/types/membership_list_item.rb +2 -0
  218. data/lib/whop_sdk/types/membership_list_item_feedback_option.rb +11 -0
  219. data/lib/whop_sdk/types/membership_most_recent_action.rb +21 -0
  220. data/lib/whop_sdk/types/membership_product.rb +13 -0
  221. data/lib/whop_sdk/types/owner_level.rb +17 -0
  222. data/lib/whop_sdk/types/owner_level_points.rb +13 -0
  223. data/lib/whop_sdk/types/partner_advance.rb +41 -0
  224. data/lib/whop_sdk/types/partner_advance_status.rb +17 -0
  225. data/lib/whop_sdk/types/payment.rb +2 -0
  226. data/lib/whop_sdk/types/payment_input.rb +1 -4
  227. data/lib/whop_sdk/types/payment_input_plan.rb +2 -0
  228. data/lib/whop_sdk/types/payment_method_types.rb +3 -0
  229. data/lib/whop_sdk/types/payment_rule_condition_value.rb +2 -2
  230. data/lib/whop_sdk/types/permission_action.rb +3 -0
  231. data/lib/whop_sdk/types/review.rb +2 -3
  232. data/lib/whop_sdk/types/{review_company.rb → review_account.rb} +1 -2
  233. data/lib/whop_sdk/types/{review_attachments_item.rb → review_attachment.rb} +1 -2
  234. data/lib/whop_sdk/types/review_list_item.rb +3 -4
  235. data/lib/whop_sdk/types/review_list_item_status.rb +11 -0
  236. data/lib/whop_sdk/types/review_product.rb +0 -1
  237. data/lib/whop_sdk/types/review_user.rb +0 -1
  238. data/lib/whop_sdk/types/support_channel.rb +8 -0
  239. data/lib/whop_sdk/types/support_channel_last_message.rb +23 -0
  240. data/lib/whop_sdk/types/{review_list_item_attachments_item.rb → support_channel_last_message_attachments_item.rb} +1 -5
  241. data/lib/whop_sdk/types/support_channel_last_message_gifs_item.rb +10 -0
  242. data/lib/whop_sdk/types/support_channel_last_message_poll.rb +10 -0
  243. data/lib/whop_sdk/types/support_channel_last_message_poll_options_item.rb +10 -0
  244. data/lib/whop_sdk/types/support_channel_list_item.rb +8 -0
  245. data/lib/whop_sdk/types/support_channel_list_item_last_message.rb +23 -0
  246. data/lib/whop_sdk/types/support_channel_list_item_last_message_attachments_item.rb +12 -0
  247. data/lib/whop_sdk/types/support_channel_list_item_last_message_gifs_item.rb +10 -0
  248. data/lib/whop_sdk/types/support_channel_list_item_last_message_poll.rb +10 -0
  249. data/lib/whop_sdk/types/support_channel_list_item_last_message_poll_options_item.rb +10 -0
  250. data/lib/whop_sdk/types/trade.rb +17 -1
  251. data/lib/whop_sdk/types/trade_failure_code.rb +1 -0
  252. data/lib/whop_sdk/types/trade_instrument_type.rb +12 -0
  253. data/lib/whop_sdk/types/trade_order_type.rb +12 -0
  254. data/lib/whop_sdk/types/trade_side.rb +12 -0
  255. data/lib/whop_sdk/types/trade_status_detail.rb +0 -3
  256. data/lib/whop_sdk/types/trade_type.rb +3 -1
  257. data/lib/whop_sdk/types/user.rb +7 -1
  258. data/lib/whop_sdk/types/user_social_link.rb +15 -0
  259. data/lib/whop_sdk/types/user_social_link_website.rb +18 -0
  260. data/lib/whop_sdk/types/webhook_event.rb +1 -0
  261. data/lib/whop_sdk/types/webhook_events_item.rb +1 -0
  262. data/lib/whop_sdk/types/webhook_list_item_events_item.rb +1 -0
  263. data/lib/whop_sdk/types/webhook_testable_events_item.rb +1 -0
  264. data/lib/whop_sdk/users/client.rb +13 -18
  265. data/lib/whop_sdk/users/oauth_grants/client.rb +9 -11
  266. data/lib/whop_sdk/users/passkeys/client.rb +3 -3
  267. data/lib/whop_sdk/users/preferences/client.rb +1 -2
  268. data/lib/whop_sdk/users/preferences/notifications/client.rb +4 -13
  269. data/lib/whop_sdk/users/preferences/notifications/topics/client.rb +2 -2
  270. data/lib/whop_sdk/users/preferences/notifications/types/set_notifications_request_preferences_item_scope.rb +3 -1
  271. data/lib/whop_sdk/variants/client.rb +10 -9
  272. data/lib/whop_sdk/verifications/client.rb +7 -9
  273. data/lib/whop_sdk/verifications/types/create_verifications_request_body_business.rb +6 -0
  274. data/lib/whop_sdk/verifications/types/create_verifications_request_body_business_documents.rb +18 -0
  275. data/lib/whop_sdk/verifications/types/create_verifications_response.rb +2 -0
  276. data/lib/whop_sdk/verifications/types/list_verifications_response_data_item.rb +2 -0
  277. data/lib/whop_sdk/verifications/types/retrieve_verifications_response.rb +2 -0
  278. data/lib/whop_sdk/verifications/types/update_verifications_response.rb +2 -0
  279. data/lib/whop_sdk/version.rb +1 -1
  280. data/lib/whop_sdk/waitlist_entries/client.rb +14 -14
  281. data/lib/whop_sdk/webhooks/client.rb +11 -12
  282. data/lib/whop_sdk/webhooks/types/create_webhooks_request_events_item.rb +1 -0
  283. data/lib/whop_sdk/webhooks/types/update_webhooks_request_events_item.rb +1 -0
  284. data/lib/whop_sdk.rb +99 -9
  285. data/reference.md +1431 -573
  286. metadata +99 -9
  287. data/lib/whop_sdk/types/payment_input_line_items_item.rb +0 -11
  288. data/lib/whop_sdk/types/review_list_item_user.rb +0 -14
  289. data/lib/whop_sdk/types/user_staff_access.rb +0 -15
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Whop_sdk
4
+ module Accounts
5
+ module Preferences
6
+ module Types
7
+ module UpdatePreferencesRequestFeedbackOptionsItemCategory
8
+ extend Whop_sdk::Internal::Types::Enum
9
+
10
+ TOO_EXPENSIVE = "too_expensive"
11
+ SWITCHING = "switching"
12
+ MISSING_FEATURES = "missing_features"
13
+ TECHNICAL_ISSUES = "technical_issues"
14
+ BAD_EXPERIENCE = "bad_experience"
15
+ UNUSED = "unused"
16
+ OTHER = "other"
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -37,6 +37,8 @@ module Whop_sdk
37
37
 
38
38
  field :economic_intelligence_previous_period, -> { Whop_sdk::Accounts::Preferences::Types::UpdatePreferencesResponseEconomicIntelligencePreviousPeriod }, optional: false, nullable: true
39
39
 
40
+ field :feedback_options, -> { Internal::Types::Array[Whop_sdk::Accounts::Preferences::Types::UpdatePreferencesResponseFeedbackOptionsItem] }, optional: false, nullable: false
41
+
40
42
  field :preferred_settlement_currency, -> { Whop_sdk::Accounts::Preferences::Types::UpdatePreferencesResponsePreferredSettlementCurrency }, optional: false, nullable: true
41
43
 
42
44
  field :preferred_settlement_currency_changeable_at, -> { String }, optional: false, nullable: true
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Whop_sdk
4
+ module Accounts
5
+ module Preferences
6
+ module Types
7
+ class UpdatePreferencesResponseFeedbackOptionsItem < Internal::Types::Model
8
+ field :category, -> { Whop_sdk::Accounts::Preferences::Types::UpdatePreferencesResponseFeedbackOptionsItemCategory }, optional: false, nullable: false
9
+
10
+ field :id, -> { String }, optional: false, nullable: false
11
+
12
+ field :label, -> { String }, optional: false, nullable: false
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Whop_sdk
4
+ module Accounts
5
+ module Preferences
6
+ module Types
7
+ module UpdatePreferencesResponseFeedbackOptionsItemCategory
8
+ extend Whop_sdk::Internal::Types::Enum
9
+
10
+ TOO_EXPENSIVE = "too_expensive"
11
+ SWITCHING = "switching"
12
+ MISSING_FEATURES = "missing_features"
13
+ TECHNICAL_ISSUES = "technical_issues"
14
+ BAD_EXPERIENCE = "bad_experience"
15
+ UNUSED = "unused"
16
+ OTHER = "other"
17
+ end
18
+ end
19
+ end
20
+ end
21
+ end
@@ -12,8 +12,6 @@ module Whop_sdk
12
12
 
13
13
  field :business_phone, -> { String }, optional: true, nullable: false
14
14
 
15
- field :business_type, -> { String }, optional: false, nullable: false
16
-
17
15
  field :business_website, -> { String }, optional: true, nullable: false
18
16
 
19
17
  field :entity_suffix, -> { Whop_sdk::Accounts::Types::FormCompanyAccountsRequestEntitySuffix }, optional: true, nullable: false
@@ -26,10 +24,6 @@ module Whop_sdk
26
24
 
27
25
  field :founders, -> { Internal::Types::Array[Whop_sdk::Accounts::Types::FormCompanyAccountsRequestFoundersItem] }, optional: false, nullable: false
28
26
 
29
- field :industry_group, -> { String }, optional: false, nullable: false
30
-
31
- field :industry_type, -> { String }, optional: false, nullable: false
32
-
33
27
  field :share_structure, -> { Whop_sdk::Accounts::Types::FormCompanyAccountsRequestShareStructure }, optional: true, nullable: false
34
28
 
35
29
  field :use_registered_agent, -> { Internal::Types::Boolean }, optional: true, nullable: false
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Whop_sdk
4
+ module Accounts
5
+ module Types
6
+ class PostAccountFinancingDisabledPayload < Internal::Types::Model
7
+ field :account_id, -> { String }, optional: true, nullable: false
8
+
9
+ field :api_version, -> { Whop_sdk::Accounts::Types::PostAccountFinancingDisabledPayloadAPIVersion }, optional: false, nullable: false
10
+
11
+ field :api_version_date, -> { String }, optional: false, nullable: true
12
+
13
+ field :data, -> { Whop_sdk::Types::FinancingAccessChange }, optional: false, nullable: false
14
+
15
+ field :id, -> { String }, optional: false, nullable: false
16
+
17
+ field :previous_attributes, -> { Internal::Types::Hash[String, Object] }, optional: true, nullable: false
18
+
19
+ field :timestamp, -> { String }, optional: false, nullable: false
20
+
21
+ field :type, -> { Whop_sdk::Accounts::Types::PostAccountFinancingDisabledPayloadType }, optional: false, nullable: false
22
+ end
23
+ end
24
+ end
25
+ end
@@ -1,12 +1,12 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Whop_sdk
4
- module Partners
4
+ module Accounts
5
5
  module Types
6
- module ReferredUsersPartnersRequestUserID
6
+ module PostAccountFinancingDisabledPayloadAPIVersion
7
7
  extend Whop_sdk::Internal::Types::Enum
8
8
 
9
- GLOBAL = "global"
9
+ V1 = "v1"
10
10
  end
11
11
  end
12
12
  end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Whop_sdk
4
+ module Accounts
5
+ module Types
6
+ module PostAccountFinancingDisabledPayloadType
7
+ extend Whop_sdk::Internal::Types::Enum
8
+
9
+ ACCOUNT_FINANCING_DISABLED = "account.financing_disabled"
10
+ end
11
+ end
12
+ end
13
+ end
@@ -8,6 +8,8 @@ module Whop_sdk
8
8
 
9
9
  field :as_partner, -> { Internal::Types::Boolean }, optional: true, nullable: false
10
10
 
11
+ field :authorized_user_id, -> { String }, optional: true, nullable: false
12
+
11
13
  field :identifier, -> { String }, optional: false, nullable: false
12
14
 
13
15
  field :message, -> { String }, optional: true, nullable: false
@@ -16,8 +16,6 @@ module Whop_sdk
16
16
 
17
17
  field :business_name, -> { String }, optional: true, nullable: false
18
18
 
19
- field :business_type, -> { String }, optional: true, nullable: false
20
-
21
19
  field :cancellation_policy, -> { Whop_sdk::Accounts::Types::UpdateAccountsRequestCancellationPolicy }, optional: true, nullable: false
22
20
 
23
21
  field :collect_vat_id, -> { Internal::Types::Boolean }, optional: true, nullable: false
@@ -34,10 +32,6 @@ module Whop_sdk
34
32
 
35
33
  field :home_preferences, -> { Internal::Types::Array[Whop_sdk::Accounts::Types::UpdateAccountsRequestHomePreferencesItem] }, optional: true, nullable: false
36
34
 
37
- field :industry_group, -> { String }, optional: true, nullable: false
38
-
39
- field :industry_type, -> { String }, optional: true, nullable: false
40
-
41
35
  field :invoice_prefix, -> { String }, optional: true, nullable: false
42
36
 
43
37
  field :logo, -> { Whop_sdk::Accounts::Types::UpdateAccountsRequestLogo }, optional: true, nullable: false
@@ -99,6 +93,8 @@ module Whop_sdk
99
93
  field :use_logo_as_opengraph_image_fallback, -> { Internal::Types::Boolean }, optional: true, nullable: false
100
94
 
101
95
  field :website, -> { String }, optional: true, nullable: false
96
+
97
+ field :industry_type, -> { Object }, optional: true, nullable: false
102
98
  end
103
99
  end
104
100
  end
@@ -93,7 +93,8 @@ module Whop_sdk
93
93
  end
94
94
  end
95
95
 
96
- # Creates an ad campaign for an account.
96
+ # Creates an ad campaign in `draft` status for an account. Nothing runs until you launch it by setting `status` to
97
+ # `active` with `PATCH /ad_campaigns/:id`.
97
98
  #
98
99
  # @param request_options [Hash]
99
100
  # @param params [Whop_sdk::AdCampaigns::Types::CreateAdCampaignsRequest]
@@ -219,9 +220,8 @@ module Whop_sdk
219
220
  end
220
221
  end
221
222
 
222
- # Updates an ad campaign's editable fields (title, budget, schedule, bid strategy, special ad categories, and,
223
- # before launch, budget type and budget optimization), and launches a draft campaign by setting status to active.
224
- # Objective and desired cost per result are fixed at creation and cannot be changed.
223
+ # Updates an ad campaign's settings, or launches a draft campaign by setting `status` to `active`. The objective
224
+ # and desired cost per result are fixed at creation and cannot be changed.
225
225
  #
226
226
  # @param request_options [Hash]
227
227
  # @param params [Whop_sdk::AdCampaigns::Types::UpdateAdCampaignsRequest]
@@ -13,6 +13,7 @@ module Whop_sdk
13
13
  NO_AD_GROUPS = "no_ad_groups"
14
14
  NO_ADS = "no_ads"
15
15
  PAUSED = "paused"
16
+ LEARNING = "learning"
16
17
  PROCESSING = "processing"
17
18
  ISSUES = "issues"
18
19
  SCHEDULED = "scheduled"
@@ -13,6 +13,7 @@ module Whop_sdk
13
13
  NO_AD_GROUPS = "no_ad_groups"
14
14
  NO_ADS = "no_ads"
15
15
  PAUSED = "paused"
16
+ LEARNING = "learning"
16
17
  PROCESSING = "processing"
17
18
  ISSUES = "issues"
18
19
  SCHEDULED = "scheduled"
@@ -14,7 +14,7 @@ module Whop_sdk
14
14
  @environment = environment
15
15
  end
16
16
 
17
- # List saved rules the caller can read. Filter by business with account_id.
17
+ # Lists the conversion value rules you can read.
18
18
  #
19
19
  # @param request_options [Hash]
20
20
  # @param params [Hash]
@@ -81,7 +81,7 @@ module Whop_sdk
81
81
  end
82
82
  end
83
83
 
84
- # Create one rule covering every selected target and event combination. Active rules cannot overlap for the same
84
+ # Creates one rule covering every selected target and event combination. Active rules cannot overlap for the same
85
85
  # platform and event. Customer prices and Whop revenue stay unchanged.
86
86
  #
87
87
  # @param request_options [Hash]
@@ -129,6 +129,8 @@ module Whop_sdk
129
129
  end
130
130
  end
131
131
 
132
+ # Retrieves a conversion value rule with its targets, events, and value adjustment.
133
+ #
132
134
  # @param request_options [Hash]
133
135
  # @param params [Hash]
134
136
  # @option request_options [String] :base_url
@@ -164,7 +166,7 @@ module Whop_sdk
164
166
  end
165
167
  end
166
168
 
167
- # Soft-delete a rule and deactivate all its coverage. Preserve its stored settings.
169
+ # Deletes a rule and deactivates all its coverage. The rule's stored settings are preserved.
168
170
  #
169
171
  # @param request_options [Hash]
170
172
  # @param params [Hash]
@@ -201,8 +203,8 @@ module Whop_sdk
201
203
  end
202
204
  end
203
205
 
204
- # Edit a rule without changing its status. Supplied targets or events replace that selection in full. Omitted
205
- # fields stay unchanged. All changes succeed or fail together.
206
+ # Edits a rule without changing its status. Supplied `targets` or `events` replace that selection in full, and
207
+ # omitted fields stay unchanged. All changes succeed or fail together.
206
208
  #
207
209
  # @param request_options [Hash]
208
210
  # @param params [Whop_sdk::AdConversionValueRules::Types::UpdateAdConversionValueRulesRequest]
@@ -244,7 +246,7 @@ module Whop_sdk
244
246
  end
245
247
  end
246
248
 
247
- # Pause the rule across all selected targets and events.
249
+ # Pauses the rule across all selected targets and events.
248
250
  #
249
251
  # @param request_options [Hash]
250
252
  # @param params [Hash]
@@ -281,9 +283,9 @@ module Whop_sdk
281
283
  end
282
284
  end
283
285
 
284
- # Resume the rule and automatically replace overlapping selections in the same transaction. Other selections keep
285
- # their values, and broader rules remain as defaults. Rules with no remaining selections are paused. Resuming an
286
- # already-active rule makes no changes.
286
+ # Resumes the rule and automatically replaces overlapping selections in the same transaction. Other selections
287
+ # keep their values, and broader rules remain as defaults. Rules with no remaining selections are paused. Resuming
288
+ # an already-active rule makes no changes.
287
289
  #
288
290
  # @param request_options [Hash]
289
291
  # @param params [Hash]
@@ -142,8 +142,7 @@ module Whop_sdk
142
142
  end
143
143
 
144
144
  # Estimates how many people a draft targeting spec can reach, before an ad group is created. The body takes the
145
- # same targeting fields as creating an ad group — `regions`, `demographics`, `detailed_targeting`, `audiences`,
146
- # `languages`, and `devices` — and nothing is persisted.
145
+ # same targeting fields as creating an ad group, and nothing is persisted.
147
146
  #
148
147
  # @param request_options [Hash]
149
148
  # @param params [Whop_sdk::AdGroups::Types::EstimateReachAdGroupsRequest]
@@ -182,8 +181,7 @@ module Whop_sdk
182
181
 
183
182
  # Searches the ad platform's targeting taxonomy for options to target an ad group with. Each result comes back in
184
183
  # the exact shape the ad-group body accepts for its `type`, so it can be used in `detailed_targeting`, `regions`,
185
- # or `languages` as-is. A blank `query` browses the small fixed lists (behaviors, browse demographic categories,
186
- # languages); interests, work employers, job titles, schools, majors, and locations need a search term.
184
+ # or `languages` as-is.
187
185
  #
188
186
  # @param request_options [Hash]
189
187
  # @param params [Hash]
@@ -238,7 +236,7 @@ module Whop_sdk
238
236
  end
239
237
  end
240
238
 
241
- # Retrieves a single ad group.
239
+ # Retrieves an ad group, with performance stats for the window set by `stats_from` and `stats_to`.
242
240
  #
243
241
  # @param request_options [Hash]
244
242
  # @param params [Hash]
@@ -286,7 +284,7 @@ module Whop_sdk
286
284
  end
287
285
  end
288
286
 
289
- # Deletes an ad group.
287
+ # Deletes an ad group, removing it from the ad platform so it stops delivering.
290
288
  #
291
289
  # @param request_options [Hash]
292
290
  # @param params [Hash]
@@ -370,11 +368,9 @@ module Whop_sdk
370
368
  end
371
369
  end
372
370
 
373
- # Creates copies of the ad group in `duplicating` status and returns them — into its own campaign, or into
374
- # target_ad_campaign_id (which must belong to the same account and be compatible with the ad group's targeting and
375
- # goals); each copy transitions to its final status (matching the source's active/paused state) once duplication
376
- # completes. Poll each returned ad group until it leaves `duplicating` — a copy that could not be completed is
377
- # deleted and returns 404.
371
+ # Starts copying an ad group and returns the copies in `duplicating` status. Poll each returned ad group until it
372
+ # leaves `duplicating`: it then takes the source's `active` or `paused` status, or, if the copy could not be
373
+ # completed, is deleted and returns 404.
378
374
  #
379
375
  # @param request_options [Hash]
380
376
  # @param params [Whop_sdk::AdGroups::Types::DuplicateAdGroupsRequest]
@@ -281,8 +281,7 @@ module Whop_sdk
281
281
  end
282
282
  end
283
283
 
284
- # Copies the ad into its own ad group, or into target_ad_group_id (which must belong to the same account and be
285
- # compatible with the ad). Copies keep the source ad's active/paused state.
284
+ # Copies an ad into its own ad group or into another one. Copies keep the source ad's active or paused state.
286
285
  #
287
286
  # @param request_options [Hash]
288
287
  # @param params [Whop_sdk::Ads::Types::DuplicateAdsRequest]
@@ -14,8 +14,7 @@ module Whop_sdk
14
14
  @environment = environment
15
15
  end
16
16
 
17
- # Returns a paginated list of affiliates for the actor in context, with optional filtering by status, search, and
18
- # sorting.
17
+ # Lists the affiliates of an account.
19
18
  #
20
19
  # Required permissions:
21
20
  # - `affiliate:basic:read`
@@ -87,7 +86,8 @@ module Whop_sdk
87
86
  end
88
87
  end
89
88
 
90
- # Creates or finds an affiliate for a company and user.
89
+ # Creates an affiliate for a user on an account. If the user is already an affiliate of the account, returns that
90
+ # affiliate, reactivating it if it was archived.
91
91
  #
92
92
  # Required permissions:
93
93
  # - `affiliate:create`
@@ -170,7 +170,7 @@ module Whop_sdk
170
170
  end
171
171
  end
172
172
 
173
- # Archives an existing Affiliate
173
+ # Archives an affiliate. The affiliate that handles Whop marketplace referrals cannot be archived.
174
174
  #
175
175
  # Required permissions:
176
176
  # - `affiliate:update`
@@ -210,7 +210,7 @@ module Whop_sdk
210
210
  end
211
211
  end
212
212
 
213
- # Unarchives an existing Affiliate
213
+ # Unarchives an archived affiliate.
214
214
  #
215
215
  # Required permissions:
216
216
  # - `affiliate:update`
@@ -128,8 +128,8 @@ module Whop_sdk
128
128
  end
129
129
  end
130
130
 
131
- # Lists the catalog of permission actions that can be granted to users, apps, and API keys — the source for the
132
- # dashboard's permission pickers. Small and returned in full on one page.
131
+ # Lists the catalog of permission actions that can be granted to users, apps, and API keys. Use it to choose the
132
+ # `permissions` for an API key or to build a permission picker. Small and returned in full on one page.
133
133
  #
134
134
  # @param request_options [Hash]
135
135
  # @param _params [Hash]
@@ -70,6 +70,8 @@ module Whop_sdk
70
70
  TWO_THOUSAND_TWENTY_SIX1009 = "2026-10-09"
71
71
  TWO_THOUSAND_TWENTY_SIX10091 = "2026-10-09-1"
72
72
  TWO_THOUSAND_TWENTY_SIX10092 = "2026-10-09-2"
73
+ TWO_THOUSAND_TWENTY_SIX1013 = "2026-10-13"
74
+ TWO_THOUSAND_TWENTY_SIX10131 = "2026-10-13-1"
73
75
  end
74
76
  end
75
77
  end
@@ -70,6 +70,8 @@ module Whop_sdk
70
70
  TWO_THOUSAND_TWENTY_SIX1009 = "2026-10-09"
71
71
  TWO_THOUSAND_TWENTY_SIX10091 = "2026-10-09-1"
72
72
  TWO_THOUSAND_TWENTY_SIX10092 = "2026-10-09-2"
73
+ TWO_THOUSAND_TWENTY_SIX1013 = "2026-10-13"
74
+ TWO_THOUSAND_TWENTY_SIX10131 = "2026-10-13-1"
73
75
  end
74
76
  end
75
77
  end
@@ -80,8 +80,8 @@ module Whop_sdk
80
80
  end
81
81
  end
82
82
 
83
- # Uploads a new build artifact for an app. Upload the file first (POST /files or a direct upload), then reference
84
- # it here; iOS and Android take a .zip bundle, web takes a JavaScript file or a .zip archive of the hosted site.
83
+ # Uploads a new build artifact for an app. Upload the file first with `POST /files` or a direct upload, then
84
+ # reference it in `attachment`.
85
85
  #
86
86
  # @param request_options [Hash]
87
87
  # @param params [Whop_sdk::AppBuilds::Types::CreateAppBuildsRequest]
@@ -3,7 +3,8 @@
3
3
  module Whop_sdk
4
4
  module AppBuilds
5
5
  module Types
6
- # The uploaded build file: `{ id }` for an existing file or `{ direct_upload_id }` for a completed direct upload.
6
+ # The uploaded build file: pass `id` for an existing file or `direct_upload_id` for a completed direct upload. iOS
7
+ # and Android builds take a .zip bundle; web builds take a JavaScript file or a .zip archive of the hosted site.
7
8
  class CreateAppBuildsRequestAttachment < Internal::Types::Model
8
9
  field :direct_upload_id, -> { String }, optional: true, nullable: false
9
10
 
@@ -128,10 +128,8 @@ module Whop_sdk
128
128
  end
129
129
  end
130
130
 
131
- # Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Custom hostnames
132
- # return 404 for inactive assignments, suspended accounts, or deleted apps. Credential fields (api_key,
133
- # default_api_key, secrets) render `null` unless the caller has the corresponding developer permission on the
134
- # owning account.
131
+ # Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Authentication is
132
+ # optional; credential fields stay `null` unless you have the matching developer permission on the owning account.
135
133
  #
136
134
  # @param request_options [Hash]
137
135
  # @param params [Hash]
@@ -14,7 +14,7 @@ module Whop_sdk
14
14
  @environment = environment
15
15
  end
16
16
 
17
- # List custom and lookalike audiences for an account. Pass `audience_id` to return a specific audience.
17
+ # Lists an account's custom and lookalike audiences.
18
18
  #
19
19
  # @param request_options [Hash]
20
20
  # @param params [Hash]
@@ -73,10 +73,10 @@ module Whop_sdk
73
73
  end
74
74
  end
75
75
 
76
- # Create an audience from a customer list, your account's Whop People data, or engagement with videos, lead forms,
77
- # Instagram profiles, or Facebook pages. Create lookalike audiences to reach people similar to an existing
78
- # audience. Processing runs asynchronously. Custom creation returns one audience; lookalike creation returns the
79
- # requested similarity bands in `data`.
76
+ # Creates a custom audience from a customer list, your account's Whop People data, or engagement with videos, lead
77
+ # forms, Instagram profiles, or Facebook pages, or a lookalike audience that reaches people similar to an existing
78
+ # one. Processing runs asynchronously. A custom audience returns one audience; a lookalike returns the requested
79
+ # similarity bands in `data`.
80
80
  #
81
81
  # @param request_options [Hash]
82
82
  # @param params [Whop_sdk::Audiences::Types::CreateAudiencesRequest]
@@ -14,8 +14,7 @@ module Whop_sdk
14
14
  @environment = environment
15
15
  end
16
16
 
17
- # Returns a paginated list of authorized team members for a company, with optional filtering by user, role, and
18
- # creation date.
17
+ # Lists the authorized users on an account's team.
19
18
  #
20
19
  # Required permissions:
21
20
  # - `company:authorized_user:read`
@@ -91,7 +90,7 @@ module Whop_sdk
91
90
  end
92
91
  end
93
92
 
94
- # Add a new authorized user to a company.
93
+ # Adds a user to an account's team as an authorized user with the given role.
95
94
  #
96
95
  # Required permissions:
97
96
  # - `authorized_user:create`
@@ -177,7 +176,7 @@ module Whop_sdk
177
176
  end
178
177
  end
179
178
 
180
- # Remove an authorized user from a company.
179
+ # Removes an authorized user from an account's team.
181
180
  #
182
181
  # Required permissions:
183
182
  # - `authorized_user:delete`
@@ -85,11 +85,10 @@ module Whop_sdk
85
85
  end
86
86
  end
87
87
 
88
- # Creates a submission on a workforce bounty. Include a `deliverable` payload — any combination of links and
89
- # uploaded files, with at least one of the two — and the submission goes straight to review; create is the only
90
- # step. For `data_capture` bounties, omit the deliverable: this starts a claimed attempt whose proof accumulates
91
- # server-side, and the separate submit endpoint sends it to review once complete. Requires a user credential —
92
- # account API keys cannot author submissions.
88
+ # Creates a submission on a workforce bounty. Include a `deliverable` and the submission goes straight to review;
89
+ # create is the only step. For `data_capture` bounties, omit the deliverable: this starts a claimed attempt whose
90
+ # proof accumulates server-side, and `POST /bounty_submissions/:id/submit` sends it to review once complete.
91
+ # Requires a user credential — account API keys cannot author submissions.
93
92
  #
94
93
  # @param request_options [Hash]
95
94
  # @param params [Whop_sdk::BountySubmissions::Types::CreateBountySubmissionsRequest]
@@ -208,11 +207,9 @@ module Whop_sdk
208
207
  end
209
208
  end
210
209
 
211
- # Submits a claimed attempt for review. A livestream attempt needs an ended proof stream and can attach an
212
- # optional `deliverable` — links, files, and a caption in any combination; if the attempt already went to review
213
- # when its stream ended, the payload attaches to it once, until reviewers start voting. A data capture attempt
214
- # instead needs enough validated clip time and takes no payload. Only the worker who started the attempt can
215
- # submit it — account API keys cannot.
210
+ # Submits a claimed attempt for review. A livestream attempt needs an ended proof stream and can attach a
211
+ # `deliverable`; a data capture attempt instead needs enough validated clip time and takes no payload. Only the
212
+ # worker who started the attempt can submit it — account API keys cannot.
216
213
  #
217
214
  # @param request_options [Hash]
218
215
  # @param params [Whop_sdk::BountySubmissions::Types::SubmitBountySubmissionsRequest]
@@ -3,7 +3,9 @@
3
3
  module Whop_sdk
4
4
  module BountySubmissions
5
5
  module Types
6
- # Work to attach to the submission. Combine `urls`, `file_ids`, and `caption` freely; all are optional.
6
+ # Work to attach to a livestream attempt. Combine `urls`, `file_ids`, and `caption` freely; all are optional. If
7
+ # the attempt already went to review when its stream ended, the deliverable attaches to it once, until reviewers
8
+ # start voting. Data capture attempts take no deliverable.
7
9
  class SubmitBountySubmissionsRequestDeliverable < Internal::Types::Model
8
10
  field :caption, -> { String }, optional: true, nullable: false
9
11
 
@@ -14,10 +14,9 @@ module Whop_sdk
14
14
  @environment = environment
15
15
  end
16
16
 
17
- # Lists the card transactions of an account or a user, newest first. Defaults to the account the credential
18
- # belongs to. Covers every card the owner has ever had, including canceled cards and spend that predates a
19
- # re-application, and team members only see transactions on the cards assigned to them. Pass `transaction_ids` to
20
- # fetch specific transactions instead of paging for them.
17
+ # Lists the card transactions of an account or a user, newest first. Covers every card the owner has ever had,
18
+ # including canceled cards and spend that predates a re-application, and team members only see transactions on the
19
+ # cards assigned to them. Pass `transaction_ids` to fetch specific transactions instead of paging for them.
21
20
  #
22
21
  # @param request_options [Hash]
23
22
  # @param params [Hash]
@@ -96,8 +95,8 @@ module Whop_sdk
96
95
  end
97
96
  end
98
97
 
99
- # Fetches a single card transaction by its `citx_` identifier. The owner defaults to the account the credential
100
- # belongs to.
98
+ # Retrieves a single card transaction from any card the owner has ever had, including canceled cards. Team members
99
+ # can retrieve only transactions on the cards assigned to them.
101
100
  #
102
101
  # @param request_options [Hash]
103
102
  # @param params [Hash]
@@ -58,8 +58,8 @@ module Whop_sdk
58
58
  end
59
59
  end
60
60
 
61
- # Issue a virtual card, or apply for card issuing. An account with no application files one here and gets back a
62
- # `202`; call again to issue the card once it is approved.
61
+ # Issues a virtual card, or applies for card issuing. An account with no application files one here and gets back
62
+ # a `202`; call again to issue the card once it is approved.
63
63
  #
64
64
  # @param request_options [Hash]
65
65
  # @param params [Whop_sdk::Cards::Types::CreateCardsRequest]
@@ -96,7 +96,7 @@ module Whop_sdk
96
96
  end
97
97
  end
98
98
 
99
- # Retrieve a single card.
99
+ # Retrieves a single card, including its `secrets` (card number, CVC, and PIN), which List Cards does not return.
100
100
  #
101
101
  # @param request_options [Hash]
102
102
  # @param params [Hash]
@@ -140,7 +140,7 @@ module Whop_sdk
140
140
  end
141
141
  end
142
142
 
143
- # Update, freeze, or cancel a card. Updating the card's name, billing address, or limits requires both
143
+ # Updates, freezes, or cancels a card. Updating the card's name, billing address, or limits requires both
144
144
  # `payout:account:update` and `company:balance:read`; a card's assigned holder may update their own card's pin and
145
145
  # frozen state with any user token.
146
146
  #