whop_sdk 0.0.26 → 0.0.27

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 (302) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +6 -3
  5. data/lib/whop_sdk/internal/util.rb +1 -1
  6. data/lib/whop_sdk/models/access_token_create_params.rb +12 -11
  7. data/lib/whop_sdk/models/ai_chat.rb +8 -8
  8. data/lib/whop_sdk/models/ai_chat_create_params.rb +44 -1
  9. data/lib/whop_sdk/models/ai_chat_list_response.rb +8 -8
  10. data/lib/whop_sdk/models/ai_chat_update_params.rb +9 -1
  11. data/lib/whop_sdk/models/app.rb +12 -11
  12. data/lib/whop_sdk/models/app_build.rb +4 -4
  13. data/lib/whop_sdk/models/app_build_list_response.rb +4 -4
  14. data/lib/whop_sdk/models/app_list_response.rb +8 -7
  15. data/lib/whop_sdk/models/authorized_user_list_response.rb +6 -6
  16. data/lib/whop_sdk/models/authorized_user_retrieve_response.rb +6 -6
  17. data/lib/whop_sdk/models/card_brands.rb +2 -0
  18. data/lib/whop_sdk/models/chat_channel.rb +2 -2
  19. data/lib/whop_sdk/models/chat_channel_list_response.rb +2 -2
  20. data/lib/whop_sdk/models/checkout_configuration.rb +22 -16
  21. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +15 -10
  22. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +22 -16
  23. data/lib/whop_sdk/models/company.rb +12 -11
  24. data/lib/whop_sdk/models/company_create_params.rb +30 -22
  25. data/lib/whop_sdk/models/company_list_params.rb +12 -8
  26. data/lib/whop_sdk/models/company_list_response.rb +10 -9
  27. data/lib/whop_sdk/models/company_token_transaction.rb +10 -10
  28. data/lib/whop_sdk/models/company_token_transaction_list_response.rb +10 -10
  29. data/lib/whop_sdk/models/company_update_params.rb +9 -1
  30. data/lib/whop_sdk/models/course.rb +10 -10
  31. data/lib/whop_sdk/models/course_chapter.rb +4 -4
  32. data/lib/whop_sdk/models/course_chapter_list_response.rb +2 -2
  33. data/lib/whop_sdk/models/course_lesson_interaction.rb +14 -14
  34. data/lib/whop_sdk/models/course_lesson_interaction_list_item.rb +10 -10
  35. data/lib/whop_sdk/models/course_lesson_list_response.rb +4 -4
  36. data/lib/whop_sdk/models/course_lesson_submit_assessment_response.rb +10 -10
  37. data/lib/whop_sdk/models/course_list_response.rb +6 -6
  38. data/lib/whop_sdk/models/course_student_list_response.rb +4 -4
  39. data/lib/whop_sdk/models/course_student_retrieve_response.rb +8 -8
  40. data/lib/whop_sdk/models/dispute.rb +22 -21
  41. data/lib/whop_sdk/models/dispute_created_webhook_event.rb +6 -2
  42. data/lib/whop_sdk/models/dispute_list_response.rb +14 -13
  43. data/lib/whop_sdk/models/dispute_updated_webhook_event.rb +6 -2
  44. data/lib/whop_sdk/models/entry.rb +13 -13
  45. data/lib/whop_sdk/models/entry_approved_webhook_event.rb +2 -2
  46. data/lib/whop_sdk/models/entry_created_webhook_event.rb +2 -2
  47. data/lib/whop_sdk/models/entry_deleted_webhook_event.rb +2 -2
  48. data/lib/whop_sdk/models/entry_denied_webhook_event.rb +2 -2
  49. data/lib/whop_sdk/models/entry_list_response.rb +11 -11
  50. data/lib/whop_sdk/models/experience.rb +14 -12
  51. data/lib/whop_sdk/models/experience_list_response.rb +10 -9
  52. data/lib/whop_sdk/models/fee_markup_create_response.rb +6 -6
  53. data/lib/whop_sdk/models/fee_markup_list_response.rb +6 -6
  54. data/lib/whop_sdk/models/file_create_response.rb +2 -2
  55. data/lib/whop_sdk/models/file_retrieve_response.rb +2 -2
  56. data/lib/whop_sdk/models/forum.rb +2 -2
  57. data/lib/whop_sdk/models/forum_list_response.rb +2 -2
  58. data/lib/whop_sdk/models/forum_post.rb +11 -4
  59. data/lib/whop_sdk/models/forum_post_create_params.rb +3 -3
  60. data/lib/whop_sdk/models/forum_post_list_response.rb +11 -4
  61. data/lib/whop_sdk/models/friendly_receipt_status.rb +3 -1
  62. data/lib/whop_sdk/models/invoice.rb +8 -8
  63. data/lib/whop_sdk/models/invoice_create_params.rb +10 -8
  64. data/lib/whop_sdk/models/invoice_list_item.rb +8 -8
  65. data/lib/whop_sdk/models/lead.rb +12 -12
  66. data/lib/whop_sdk/models/lead_list_response.rb +12 -12
  67. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +16 -14
  68. data/lib/whop_sdk/models/lesson.rb +16 -16
  69. data/lib/whop_sdk/models/member_list_response.rb +8 -8
  70. data/lib/whop_sdk/models/member_retrieve_response.rb +10 -10
  71. data/lib/whop_sdk/models/membership.rb +34 -25
  72. data/lib/whop_sdk/models/membership_activated_webhook_event.rb +3 -3
  73. data/lib/whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event.rb +3 -3
  74. data/lib/whop_sdk/models/membership_deactivated_webhook_event.rb +3 -3
  75. data/lib/whop_sdk/models/membership_list_response.rb +32 -23
  76. data/lib/whop_sdk/models/message.rb +13 -6
  77. data/lib/whop_sdk/models/message_list_response.rb +13 -6
  78. data/lib/whop_sdk/models/payment.rb +33 -27
  79. data/lib/whop_sdk/models/payment_create_params.rb +12 -8
  80. data/lib/whop_sdk/models/payment_created_webhook_event.rb +6 -2
  81. data/lib/whop_sdk/models/payment_failed_webhook_event.rb +6 -2
  82. data/lib/whop_sdk/models/payment_list_response.rb +33 -27
  83. data/lib/whop_sdk/models/payment_method_types.rb +1 -0
  84. data/lib/whop_sdk/models/payment_pending_webhook_event.rb +6 -2
  85. data/lib/whop_sdk/models/payment_provider.rb +1 -0
  86. data/lib/whop_sdk/models/payment_succeeded_webhook_event.rb +6 -2
  87. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +6 -6
  88. data/lib/whop_sdk/models/payout_method_list_response.rb +6 -6
  89. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +6 -6
  90. data/lib/whop_sdk/models/plan.rb +35 -27
  91. data/lib/whop_sdk/models/plan_create_params.rb +5 -4
  92. data/lib/whop_sdk/models/plan_list_response.rb +33 -25
  93. data/lib/whop_sdk/models/plan_update_params.rb +16 -12
  94. data/lib/whop_sdk/models/product.rb +14 -13
  95. data/lib/whop_sdk/models/product_create_params.rb +9 -4
  96. data/lib/whop_sdk/models/product_list_item.rb +8 -7
  97. data/lib/whop_sdk/models/promo_code.rb +15 -11
  98. data/lib/whop_sdk/models/promo_code_create_params.rb +4 -2
  99. data/lib/whop_sdk/models/promo_code_list_response.rb +13 -9
  100. data/lib/whop_sdk/models/reaction.rb +2 -2
  101. data/lib/whop_sdk/models/reaction_list_response.rb +2 -2
  102. data/lib/whop_sdk/models/refund_created_webhook_event.rb +28 -19
  103. data/lib/whop_sdk/models/refund_list_response.rb +14 -9
  104. data/lib/whop_sdk/models/refund_retrieve_response.rb +22 -17
  105. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +28 -19
  106. data/lib/whop_sdk/models/review_list_response.rb +8 -8
  107. data/lib/whop_sdk/models/review_retrieve_response.rb +12 -12
  108. data/lib/whop_sdk/models/setup_intent.rb +17 -18
  109. data/lib/whop_sdk/models/setup_intent_canceled_webhook_event.rb +2 -3
  110. data/lib/whop_sdk/models/setup_intent_list_response.rb +17 -18
  111. data/lib/whop_sdk/models/setup_intent_requires_action_webhook_event.rb +2 -3
  112. data/lib/whop_sdk/models/setup_intent_succeeded_webhook_event.rb +2 -3
  113. data/lib/whop_sdk/models/shipment.rb +8 -8
  114. data/lib/whop_sdk/models/shipment_list_response.rb +8 -8
  115. data/lib/whop_sdk/models/support_channel.rb +2 -2
  116. data/lib/whop_sdk/models/support_channel_list_response.rb +2 -2
  117. data/lib/whop_sdk/models/topup_create_params.rb +6 -2
  118. data/lib/whop_sdk/models/topup_create_response.rb +6 -5
  119. data/lib/whop_sdk/models/transfer.rb +33 -24
  120. data/lib/whop_sdk/models/transfer_create_params.rb +3 -2
  121. data/lib/whop_sdk/models/transfer_list_response.rb +13 -8
  122. data/lib/whop_sdk/models/{user_retrieve_response.rb → user.rb} +12 -11
  123. data/lib/whop_sdk/models/user_update_profile_params.rb +59 -0
  124. data/lib/whop_sdk/models/verification_retrieve_response.rb +2 -2
  125. data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +2 -2
  126. data/lib/whop_sdk/models/webhook.rb +6 -5
  127. data/lib/whop_sdk/models/webhook_create_response.rb +6 -5
  128. data/lib/whop_sdk/models/webhook_list_response.rb +6 -5
  129. data/lib/whop_sdk/models/withdrawal.rb +15 -13
  130. data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +6 -2
  131. data/lib/whop_sdk/models/withdrawal_list_response.rb +9 -7
  132. data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +6 -2
  133. data/lib/whop_sdk/models.rb +4 -0
  134. data/lib/whop_sdk/resources/access_tokens.rb +9 -9
  135. data/lib/whop_sdk/resources/ai_chats.rb +14 -3
  136. data/lib/whop_sdk/resources/companies.rb +24 -14
  137. data/lib/whop_sdk/resources/forum_posts.rb +1 -1
  138. data/lib/whop_sdk/resources/plans.rb +6 -6
  139. data/lib/whop_sdk/resources/promo_codes.rb +1 -1
  140. data/lib/whop_sdk/resources/topups.rb +4 -1
  141. data/lib/whop_sdk/resources/transfers.rb +1 -1
  142. data/lib/whop_sdk/resources/users.rb +34 -2
  143. data/lib/whop_sdk/version.rb +1 -1
  144. data/lib/whop_sdk.rb +2 -1
  145. data/rbi/whop_sdk/client.rbi +6 -3
  146. data/rbi/whop_sdk/internal/util.rbi +1 -1
  147. data/rbi/whop_sdk/models/access_token_create_params.rbi +18 -16
  148. data/rbi/whop_sdk/models/ai_chat.rbi +8 -8
  149. data/rbi/whop_sdk/models/ai_chat_create_params.rbi +66 -1
  150. data/rbi/whop_sdk/models/ai_chat_list_response.rbi +8 -8
  151. data/rbi/whop_sdk/models/ai_chat_update_params.rbi +12 -1
  152. data/rbi/whop_sdk/models/app.rbi +12 -11
  153. data/rbi/whop_sdk/models/app_build.rbi +4 -4
  154. data/rbi/whop_sdk/models/app_build_list_response.rbi +4 -4
  155. data/rbi/whop_sdk/models/app_list_response.rbi +8 -7
  156. data/rbi/whop_sdk/models/authorized_user_list_response.rbi +6 -6
  157. data/rbi/whop_sdk/models/authorized_user_retrieve_response.rbi +6 -6
  158. data/rbi/whop_sdk/models/card_brands.rbi +3 -0
  159. data/rbi/whop_sdk/models/chat_channel.rbi +2 -2
  160. data/rbi/whop_sdk/models/chat_channel_list_response.rbi +2 -2
  161. data/rbi/whop_sdk/models/checkout_configuration.rbi +23 -17
  162. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +22 -12
  163. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +23 -17
  164. data/rbi/whop_sdk/models/company.rbi +12 -11
  165. data/rbi/whop_sdk/models/company_create_params.rbi +32 -24
  166. data/rbi/whop_sdk/models/company_list_params.rbi +10 -8
  167. data/rbi/whop_sdk/models/company_list_response.rbi +10 -9
  168. data/rbi/whop_sdk/models/company_token_transaction.rbi +10 -10
  169. data/rbi/whop_sdk/models/company_token_transaction_list_response.rbi +10 -10
  170. data/rbi/whop_sdk/models/company_update_params.rbi +8 -0
  171. data/rbi/whop_sdk/models/course.rbi +10 -10
  172. data/rbi/whop_sdk/models/course_chapter.rbi +4 -4
  173. data/rbi/whop_sdk/models/course_chapter_list_response.rbi +2 -2
  174. data/rbi/whop_sdk/models/course_lesson_interaction.rbi +14 -14
  175. data/rbi/whop_sdk/models/course_lesson_interaction_list_item.rbi +10 -10
  176. data/rbi/whop_sdk/models/course_lesson_list_response.rbi +4 -4
  177. data/rbi/whop_sdk/models/course_lesson_submit_assessment_response.rbi +10 -10
  178. data/rbi/whop_sdk/models/course_list_response.rbi +6 -6
  179. data/rbi/whop_sdk/models/course_student_list_response.rbi +4 -4
  180. data/rbi/whop_sdk/models/course_student_retrieve_response.rbi +8 -8
  181. data/rbi/whop_sdk/models/dispute.rbi +22 -21
  182. data/rbi/whop_sdk/models/dispute_created_webhook_event.rbi +4 -2
  183. data/rbi/whop_sdk/models/dispute_list_response.rbi +14 -13
  184. data/rbi/whop_sdk/models/dispute_updated_webhook_event.rbi +4 -2
  185. data/rbi/whop_sdk/models/entry.rbi +13 -13
  186. data/rbi/whop_sdk/models/entry_approved_webhook_event.rbi +2 -2
  187. data/rbi/whop_sdk/models/entry_created_webhook_event.rbi +2 -2
  188. data/rbi/whop_sdk/models/entry_deleted_webhook_event.rbi +2 -2
  189. data/rbi/whop_sdk/models/entry_denied_webhook_event.rbi +2 -2
  190. data/rbi/whop_sdk/models/entry_list_response.rbi +11 -11
  191. data/rbi/whop_sdk/models/experience.rbi +14 -12
  192. data/rbi/whop_sdk/models/experience_list_response.rbi +10 -9
  193. data/rbi/whop_sdk/models/fee_markup_create_response.rbi +6 -6
  194. data/rbi/whop_sdk/models/fee_markup_list_response.rbi +6 -6
  195. data/rbi/whop_sdk/models/file_create_response.rbi +2 -2
  196. data/rbi/whop_sdk/models/file_retrieve_response.rbi +2 -2
  197. data/rbi/whop_sdk/models/forum.rbi +2 -2
  198. data/rbi/whop_sdk/models/forum_list_response.rbi +2 -2
  199. data/rbi/whop_sdk/models/forum_post.rbi +12 -4
  200. data/rbi/whop_sdk/models/forum_post_create_params.rbi +4 -4
  201. data/rbi/whop_sdk/models/forum_post_list_response.rbi +12 -4
  202. data/rbi/whop_sdk/models/friendly_receipt_status.rbi +3 -1
  203. data/rbi/whop_sdk/models/invoice.rbi +8 -8
  204. data/rbi/whop_sdk/models/invoice_create_params.rbi +14 -10
  205. data/rbi/whop_sdk/models/invoice_list_item.rbi +8 -8
  206. data/rbi/whop_sdk/models/lead.rbi +12 -12
  207. data/rbi/whop_sdk/models/lead_list_response.rbi +12 -12
  208. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +14 -12
  209. data/rbi/whop_sdk/models/lesson.rbi +16 -16
  210. data/rbi/whop_sdk/models/member_list_response.rbi +8 -8
  211. data/rbi/whop_sdk/models/member_retrieve_response.rbi +10 -10
  212. data/rbi/whop_sdk/models/membership.rbi +34 -24
  213. data/rbi/whop_sdk/models/membership_activated_webhook_event.rbi +4 -4
  214. data/rbi/whop_sdk/models/membership_cancel_at_period_end_changed_webhook_event.rbi +4 -4
  215. data/rbi/whop_sdk/models/membership_deactivated_webhook_event.rbi +4 -4
  216. data/rbi/whop_sdk/models/membership_list_response.rbi +32 -22
  217. data/rbi/whop_sdk/models/message.rbi +14 -6
  218. data/rbi/whop_sdk/models/message_list_response.rbi +14 -6
  219. data/rbi/whop_sdk/models/payment.rbi +32 -27
  220. data/rbi/whop_sdk/models/payment_create_params.rbi +16 -8
  221. data/rbi/whop_sdk/models/payment_created_webhook_event.rbi +4 -2
  222. data/rbi/whop_sdk/models/payment_failed_webhook_event.rbi +4 -2
  223. data/rbi/whop_sdk/models/payment_list_response.rbi +32 -27
  224. data/rbi/whop_sdk/models/payment_method_types.rbi +1 -0
  225. data/rbi/whop_sdk/models/payment_pending_webhook_event.rbi +4 -2
  226. data/rbi/whop_sdk/models/payment_provider.rbi +1 -0
  227. data/rbi/whop_sdk/models/payment_succeeded_webhook_event.rbi +4 -2
  228. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +6 -6
  229. data/rbi/whop_sdk/models/payout_method_list_response.rbi +6 -6
  230. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +6 -6
  231. data/rbi/whop_sdk/models/plan.rbi +37 -27
  232. data/rbi/whop_sdk/models/plan_create_params.rbi +8 -6
  233. data/rbi/whop_sdk/models/plan_list_response.rbi +35 -25
  234. data/rbi/whop_sdk/models/plan_update_params.rbi +22 -14
  235. data/rbi/whop_sdk/models/product.rbi +14 -13
  236. data/rbi/whop_sdk/models/product_create_params.rbi +8 -4
  237. data/rbi/whop_sdk/models/product_list_item.rbi +8 -7
  238. data/rbi/whop_sdk/models/promo_code.rbi +17 -11
  239. data/rbi/whop_sdk/models/promo_code_create_params.rbi +6 -2
  240. data/rbi/whop_sdk/models/promo_code_list_response.rbi +15 -9
  241. data/rbi/whop_sdk/models/reaction.rbi +2 -2
  242. data/rbi/whop_sdk/models/reaction_list_response.rbi +2 -2
  243. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +24 -19
  244. data/rbi/whop_sdk/models/refund_list_response.rbi +12 -9
  245. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +20 -17
  246. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +24 -19
  247. data/rbi/whop_sdk/models/review_list_response.rbi +8 -8
  248. data/rbi/whop_sdk/models/review_retrieve_response.rbi +12 -12
  249. data/rbi/whop_sdk/models/setup_intent.rbi +17 -18
  250. data/rbi/whop_sdk/models/setup_intent_canceled_webhook_event.rbi +2 -4
  251. data/rbi/whop_sdk/models/setup_intent_list_response.rbi +17 -18
  252. data/rbi/whop_sdk/models/setup_intent_requires_action_webhook_event.rbi +2 -4
  253. data/rbi/whop_sdk/models/setup_intent_succeeded_webhook_event.rbi +2 -4
  254. data/rbi/whop_sdk/models/shipment.rbi +8 -8
  255. data/rbi/whop_sdk/models/shipment_list_response.rbi +8 -8
  256. data/rbi/whop_sdk/models/support_channel.rbi +2 -2
  257. data/rbi/whop_sdk/models/support_channel_list_response.rbi +2 -2
  258. data/rbi/whop_sdk/models/topup_create_params.rbi +4 -2
  259. data/rbi/whop_sdk/models/topup_create_response.rbi +6 -5
  260. data/rbi/whop_sdk/models/transfer.rbi +28 -20
  261. data/rbi/whop_sdk/models/transfer_create_params.rbi +4 -2
  262. data/rbi/whop_sdk/models/transfer_list_response.rbi +12 -8
  263. data/rbi/whop_sdk/models/{user_retrieve_response.rbi → user.rbi} +13 -32
  264. data/rbi/whop_sdk/models/user_update_profile_params.rbi +105 -0
  265. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +2 -2
  266. data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +2 -2
  267. data/rbi/whop_sdk/models/webhook.rbi +6 -5
  268. data/rbi/whop_sdk/models/webhook_create_response.rbi +6 -5
  269. data/rbi/whop_sdk/models/webhook_list_response.rbi +6 -5
  270. data/rbi/whop_sdk/models/withdrawal.rbi +16 -13
  271. data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +4 -2
  272. data/rbi/whop_sdk/models/withdrawal_list_response.rbi +10 -7
  273. data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +4 -2
  274. data/rbi/whop_sdk/models.rbi +4 -0
  275. data/rbi/whop_sdk/resources/access_tokens.rbi +14 -13
  276. data/rbi/whop_sdk/resources/ai_chats.rbi +16 -0
  277. data/rbi/whop_sdk/resources/companies.rbi +26 -16
  278. data/rbi/whop_sdk/resources/forum_posts.rbi +2 -2
  279. data/rbi/whop_sdk/resources/plans.rbi +15 -10
  280. data/rbi/whop_sdk/resources/promo_codes.rbi +3 -1
  281. data/rbi/whop_sdk/resources/topups.rbi +2 -1
  282. data/rbi/whop_sdk/resources/transfers.rbi +2 -1
  283. data/rbi/whop_sdk/resources/users.rbi +29 -1
  284. data/sig/whop_sdk/models/access_token_create_params.rbs +8 -8
  285. data/sig/whop_sdk/models/ai_chat_create_params.rbs +29 -1
  286. data/sig/whop_sdk/models/ai_chat_update_params.rbs +6 -1
  287. data/sig/whop_sdk/models/card_brands.rbs +4 -0
  288. data/sig/whop_sdk/models/company_create_params.rbs +15 -10
  289. data/sig/whop_sdk/models/company_list_params.rbs +6 -6
  290. data/sig/whop_sdk/models/company_update_params.rbs +5 -0
  291. data/sig/whop_sdk/models/membership.rbs +5 -0
  292. data/sig/whop_sdk/models/membership_list_response.rbs +5 -0
  293. data/sig/whop_sdk/models/payment_method_types.rbs +2 -0
  294. data/sig/whop_sdk/models/payment_provider.rbs +2 -0
  295. data/sig/whop_sdk/models/{user_retrieve_response.rbs → user.rbs} +6 -6
  296. data/sig/whop_sdk/models/user_update_profile_params.rbs +51 -0
  297. data/sig/whop_sdk/models.rbs +4 -0
  298. data/sig/whop_sdk/resources/access_tokens.rbs +2 -2
  299. data/sig/whop_sdk/resources/ai_chats.rbs +4 -0
  300. data/sig/whop_sdk/resources/companies.rbs +5 -3
  301. data/sig/whop_sdk/resources/users.rbs +9 -1
  302. metadata +8 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6a80be479329709bdcbe983b4d0e2319dfb9f42720475ed5da78872b9510c2e2
4
- data.tar.gz: 8ab39c69907d254193380ce538039600ae3da39cb82058827124e58fe2b33632
3
+ metadata.gz: 9f140db06cc91ed954bc14759b10a84e695e0007503bc19c31755770ae7660c0
4
+ data.tar.gz: 40d54bd980a11bb1989ee91eff031bc6d357e5e66e6c9447b2abdb3ce8bf033d
5
5
  SHA512:
6
- metadata.gz: 54302147cc07d4734043c43e8db74fef84a67ac3b6a4e123bf4f6135c3cbc2f7bd27292caa3805ce6cc00e6b6f2395637c6463c938fb193d3bea763781a39132
7
- data.tar.gz: '0842d8980e5bc4c49e6f37e443e50ae5c1d8aa1610e2e7167d19c5499f47af47393e9e10944c4f8bd90b0f91e3a889fe93f7751d81ebb381df2cba133d4d29d9'
6
+ metadata.gz: 2f5524566eaf93219212e579430ffd9f8b2ce771c3acfa510d3d7d9b84ff689e50a3745e0da015cef58ee7d861c12c36ef48f83cb3805e5692bc7d3156e22f7b
7
+ data.tar.gz: 6fffdaca6dd2e5c6eca5c033678edcbc35c4a09fb308e1a7ebeb9ef61dadeef4bdc95cc3d55d3f0fd2c29b6ee41050d55029301df8188eff48acd390e9cc9c55
data/CHANGELOG.md CHANGED
@@ -1,5 +1,34 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.0.27 (2026-02-09)
4
+
5
+ Full Changelog: [v0.0.26...v0.0.27](https://github.com/whopio/whopsdk-ruby/compare/v0.0.26...v0.0.27)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([65ed264](https://github.com/whopio/whopsdk-ruby/commit/65ed2647981ae0aba98d848dcf31d40303785c35))
10
+ * **api:** api update ([5337616](https://github.com/whopio/whopsdk-ruby/commit/5337616fe580b2afa16b2210eb2113a2755c8529))
11
+ * **api:** api update ([2bec9bc](https://github.com/whopio/whopsdk-ruby/commit/2bec9bc09fbd1a3b41ef8c1ef4bc57a339db43ea))
12
+ * **api:** api update ([0900d40](https://github.com/whopio/whopsdk-ruby/commit/0900d40866a9819b082ccfbe51a531439c5619d8))
13
+ * **api:** api update ([adcace1](https://github.com/whopio/whopsdk-ruby/commit/adcace101df013b38450625f5eacf7573938d902))
14
+ * **api:** api update ([32441bf](https://github.com/whopio/whopsdk-ruby/commit/32441bff9dd037424c7e93be807c3e73250f5b78))
15
+ * **api:** api update ([be694cf](https://github.com/whopio/whopsdk-ruby/commit/be694cff7f498f177f025c75292ce29c800c1658))
16
+ * **api:** api update ([3bdf111](https://github.com/whopio/whopsdk-ruby/commit/3bdf1117e8b6b434b77713fcf534dd112c743ff1))
17
+ * **api:** api update ([71cfae3](https://github.com/whopio/whopsdk-ruby/commit/71cfae32a386c17a95fd5d82a24ae70ec7f5417d))
18
+ * **api:** manual updates ([1cf2d62](https://github.com/whopio/whopsdk-ruby/commit/1cf2d62a8da26bd66c578465980e3600d14e2a94))
19
+ * **api:** manual updates ([60c21fa](https://github.com/whopio/whopsdk-ruby/commit/60c21fa901ca211970592fa6b0ae6650c11a7fc8))
20
+ * **api:** manual updates ([6ea51d3](https://github.com/whopio/whopsdk-ruby/commit/6ea51d3e2a8809d552d1905e6dff99c19e5b1403))
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * **client:** loosen json header parsing ([1020366](https://github.com/whopio/whopsdk-ruby/commit/1020366437c0cdbba833f84deab255a8902cf610))
26
+
27
+
28
+ ### Chores
29
+
30
+ * **docs:** remove www prefix ([d581cb1](https://github.com/whopio/whopsdk-ruby/commit/d581cb174e297c951ac30d0790d48d6a53c046e4))
31
+
3
32
  ## 0.0.26 (2026-02-03)
4
33
 
5
34
  Full Changelog: [v0.0.25...v0.0.26](https://github.com/whopio/whopsdk-ruby/compare/v0.0.25...v0.0.26)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "whop_sdk", "~> 0.0.26"
29
+ gem "whop_sdk", "~> 0.0.27"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -15,7 +15,9 @@ module WhopSDK
15
15
  # Default max retry delay in seconds.
16
16
  DEFAULT_MAX_RETRY_DELAY = 8.0
17
17
 
18
- # The app API key from an app from the /dashboard/developer page
18
+ # A company API key, company scoped JWT, app API key, or user OAuth token. You
19
+ # must prepend your key/token with the word 'Bearer', which will look like
20
+ # `Bearer ***************************`
19
21
  # @return [String]
20
22
  attr_reader :api_key
21
23
 
@@ -182,8 +184,9 @@ module WhopSDK
182
184
 
183
185
  # Creates and returns a new client for interacting with the API.
184
186
  #
185
- # @param api_key [String, nil] The app API key from an app from the /dashboard/developer page Defaults to
186
- # `ENV["WHOP_API_KEY"]`
187
+ # @param api_key [String, nil] A company API key, company scoped JWT, app API key, or user OAuth token. You
188
+ # must prepend your key/token with the word 'Bearer', which will look like
189
+ # `Bearer ***************************` Defaults to `ENV["WHOP_API_KEY"]`
187
190
  #
188
191
  # @param app_id [String, nil] When using the SDK in app mode pass this parameter to allow verifying user
189
192
  # tokens Defaults to `ENV["WHOP_APP_ID"]`
@@ -485,7 +485,7 @@ module WhopSDK
485
485
  end
486
486
 
487
487
  # @type [Regexp]
488
- JSON_CONTENT = %r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}
488
+ JSON_CONTENT = %r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}
489
489
  # @type [Regexp]
490
490
  JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
491
491
 
@@ -12,8 +12,8 @@ module WhopSDK
12
12
  # permission to access this Company, such as the being the company the API key
13
13
  # belongs to or a sub-merchant of it
14
14
  #
15
- # @return [String]
16
- required :company_id, String
15
+ # @return [String, nil]
16
+ optional :company_id, String, nil?: true
17
17
 
18
18
  # @!attribute expires_at
19
19
  # The expiration timestamp for the access token. If not provided, a default
@@ -25,9 +25,10 @@ module WhopSDK
25
25
 
26
26
  # @!attribute scoped_actions
27
27
  # Array of desired scoped actions for the access token. If sent as an empty array
28
- # or not provided, all permissions from the API key making the request will be
29
- # available on the token. If sending an explicit list, they must be a subset of
30
- # the API keys's existing permissions. Otherwise, an error will be raised.
28
+ # or not provided, all permissions from the authenticating credential (API key or
29
+ # OAuth token) will be available on the token. If sending an explicit list, they
30
+ # must be a subset of the credential's existing permissions. Otherwise, an error
31
+ # will be raised.
31
32
  #
32
33
  # @return [Array<String>, nil]
33
34
  optional :scoped_actions, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
@@ -36,21 +37,21 @@ module WhopSDK
36
37
  # The ID of the User to generate the token for. The API key must have permission
37
38
  # to access this User.
38
39
  #
39
- # @return [String]
40
- required :user_id, String
40
+ # @return [String, nil]
41
+ optional :user_id, String, nil?: true
41
42
 
42
- # @!method initialize(company_id:, user_id:, expires_at: nil, scoped_actions: nil, request_options: {})
43
+ # @!method initialize(company_id: nil, expires_at: nil, scoped_actions: nil, user_id: nil, request_options: {})
43
44
  # Some parameter documentations has been truncated, see
44
45
  # {WhopSDK::Models::AccessTokenCreateParams} for more details.
45
46
  #
46
- # @param company_id [String] The ID of the Company to generate the token for. The API key must have permissio
47
- #
48
- # @param user_id [String] The ID of the User to generate the token for. The API key must have permission t
47
+ # @param company_id [String, nil] The ID of the Company to generate the token for. The API key must have permissio
49
48
  #
50
49
  # @param expires_at [Time, nil] The expiration timestamp for the access token. If not provided, a default expira
51
50
  #
52
51
  # @param scoped_actions [Array<String>, nil] Array of desired scoped actions for the access token. If sent as an empty array
53
52
  #
53
+ # @param user_id [String, nil] The ID of the User to generate the token for. The API key must have permission t
54
+ #
54
55
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
55
56
  end
56
57
  end
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::AIChats#create
6
6
  class AIChat < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The unique identifier for the AI chat
8
+ # The unique identifier for the ai chat.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -17,7 +17,7 @@ module WhopSDK
17
17
  required :blended_token_usage, String
18
18
 
19
19
  # @!attribute created_at
20
- # When the AI chat was created
20
+ # The datetime the ai chat was created.
21
21
  #
22
22
  # @return [Time]
23
23
  required :created_at, Time
@@ -41,7 +41,7 @@ module WhopSDK
41
41
  required :title, String, nil?: true
42
42
 
43
43
  # @!attribute updated_at
44
- # When the AI chat was last updated
44
+ # The datetime the ai chat was last updated.
45
45
  #
46
46
  # @return [Time]
47
47
  required :updated_at, Time
@@ -55,11 +55,11 @@ module WhopSDK
55
55
  # @!method initialize(id:, blended_token_usage:, created_at:, last_message_at:, message_count:, title:, updated_at:, user:)
56
56
  # An AI chat conversation belonging to a user
57
57
  #
58
- # @param id [String] The unique identifier for the AI chat
58
+ # @param id [String] The unique identifier for the ai chat.
59
59
  #
60
60
  # @param blended_token_usage [String] The total number of tokens used in the chat
61
61
  #
62
- # @param created_at [Time] When the AI chat was created
62
+ # @param created_at [Time] The datetime the ai chat was created.
63
63
  #
64
64
  # @param last_message_at [Time, nil] When the last message was sent
65
65
  #
@@ -67,14 +67,14 @@ module WhopSDK
67
67
  #
68
68
  # @param title [String, nil] The title of the AI chat
69
69
  #
70
- # @param updated_at [Time] When the AI chat was last updated
70
+ # @param updated_at [Time] The datetime the ai chat was last updated.
71
71
  #
72
72
  # @param user [WhopSDK::Models::AIChat::User] The user who owns the AI chat
73
73
 
74
74
  # @see WhopSDK::Models::AIChat#user
75
75
  class User < WhopSDK::Internal::Type::BaseModel
76
76
  # @!attribute id
77
- # The internal ID of the user.
77
+ # The unique identifier for the user.
78
78
  #
79
79
  # @return [String]
80
80
  required :id, String
@@ -82,7 +82,7 @@ module WhopSDK
82
82
  # @!method initialize(id:)
83
83
  # The user who owns the AI chat
84
84
  #
85
- # @param id [String] The internal ID of the user.
85
+ # @param id [String] The unique identifier for the user.
86
86
  end
87
87
  end
88
88
  end
@@ -7,16 +7,59 @@ module WhopSDK
7
7
  extend WhopSDK::Internal::Type::RequestParameters::Converter
8
8
  include WhopSDK::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute message_text
11
+ # The text content of the first message sent in the chat
12
+ #
13
+ # @return [String]
14
+ required :message_text, String
15
+
16
+ # @!attribute current_company_id
17
+ # The ID of the company to set as the current company in context for the AI chat
18
+ #
19
+ # @return [String, nil]
20
+ optional :current_company_id, String, nil?: true
21
+
22
+ # @!attribute message_attachments
23
+ # The IDs of existing uploaded attachments to include in the first message to the
24
+ # agent
25
+ #
26
+ # @return [Array<WhopSDK::Models::AIChatCreateParams::MessageAttachment>, nil]
27
+ optional :message_attachments,
28
+ -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::AIChatCreateParams::MessageAttachment] },
29
+ nil?: true
30
+
10
31
  # @!attribute title
11
32
  # The title of the AI chat
12
33
  #
13
34
  # @return [String, nil]
14
35
  optional :title, String, nil?: true
15
36
 
16
- # @!method initialize(title: nil, request_options: {})
37
+ # @!method initialize(message_text:, current_company_id: nil, message_attachments: nil, title: nil, request_options: {})
38
+ # Some parameter documentations has been truncated, see
39
+ # {WhopSDK::Models::AIChatCreateParams} for more details.
40
+ #
41
+ # @param message_text [String] The text content of the first message sent in the chat
42
+ #
43
+ # @param current_company_id [String, nil] The ID of the company to set as the current company in context for the AI chat
44
+ #
45
+ # @param message_attachments [Array<WhopSDK::Models::AIChatCreateParams::MessageAttachment>, nil] The IDs of existing uploaded attachments to include in the first message to the
46
+ #
17
47
  # @param title [String, nil] The title of the AI chat
18
48
  #
19
49
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
50
+
51
+ class MessageAttachment < WhopSDK::Internal::Type::BaseModel
52
+ # @!attribute id
53
+ # The ID of an existing file object.
54
+ #
55
+ # @return [String]
56
+ required :id, String
57
+
58
+ # @!method initialize(id:)
59
+ # Input for an attachment
60
+ #
61
+ # @param id [String] The ID of an existing file object.
62
+ end
20
63
  end
21
64
  end
22
65
  end
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::AIChats#list
6
6
  class AIChatListResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The unique identifier for the AI chat
8
+ # The unique identifier for the ai chat.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -17,7 +17,7 @@ module WhopSDK
17
17
  required :blended_token_usage, String
18
18
 
19
19
  # @!attribute created_at
20
- # When the AI chat was created
20
+ # The datetime the ai chat was created.
21
21
  #
22
22
  # @return [Time]
23
23
  required :created_at, Time
@@ -41,7 +41,7 @@ module WhopSDK
41
41
  required :title, String, nil?: true
42
42
 
43
43
  # @!attribute updated_at
44
- # When the AI chat was last updated
44
+ # The datetime the ai chat was last updated.
45
45
  #
46
46
  # @return [Time]
47
47
  required :updated_at, Time
@@ -55,11 +55,11 @@ module WhopSDK
55
55
  # @!method initialize(id:, blended_token_usage:, created_at:, last_message_at:, message_count:, title:, updated_at:, user:)
56
56
  # An AI chat conversation belonging to a user
57
57
  #
58
- # @param id [String] The unique identifier for the AI chat
58
+ # @param id [String] The unique identifier for the ai chat.
59
59
  #
60
60
  # @param blended_token_usage [String] The total number of tokens used in the chat
61
61
  #
62
- # @param created_at [Time] When the AI chat was created
62
+ # @param created_at [Time] The datetime the ai chat was created.
63
63
  #
64
64
  # @param last_message_at [Time, nil] When the last message was sent
65
65
  #
@@ -67,14 +67,14 @@ module WhopSDK
67
67
  #
68
68
  # @param title [String, nil] The title of the AI chat
69
69
  #
70
- # @param updated_at [Time] When the AI chat was last updated
70
+ # @param updated_at [Time] The datetime the ai chat was last updated.
71
71
  #
72
72
  # @param user [WhopSDK::Models::AIChatListResponse::User] The user who owns the AI chat
73
73
 
74
74
  # @see WhopSDK::Models::AIChatListResponse#user
75
75
  class User < WhopSDK::Internal::Type::BaseModel
76
76
  # @!attribute id
77
- # The internal ID of the user.
77
+ # The unique identifier for the user.
78
78
  #
79
79
  # @return [String]
80
80
  required :id, String
@@ -82,7 +82,7 @@ module WhopSDK
82
82
  # @!method initialize(id:)
83
83
  # The user who owns the AI chat
84
84
  #
85
- # @param id [String] The internal ID of the user.
85
+ # @param id [String] The unique identifier for the user.
86
86
  end
87
87
  end
88
88
  end
@@ -7,13 +7,21 @@ module WhopSDK
7
7
  extend WhopSDK::Internal::Type::RequestParameters::Converter
8
8
  include WhopSDK::Internal::Type::RequestParameters
9
9
 
10
+ # @!attribute current_company_id
11
+ # The ID of the company to set as the current company in context for the AI chat
12
+ #
13
+ # @return [String, nil]
14
+ optional :current_company_id, String, nil?: true
15
+
10
16
  # @!attribute title
11
17
  # The new title for the AI chat
12
18
  #
13
19
  # @return [String, nil]
14
20
  optional :title, String, nil?: true
15
21
 
16
- # @!method initialize(title: nil, request_options: {})
22
+ # @!method initialize(current_company_id: nil, title: nil, request_options: {})
23
+ # @param current_company_id [String, nil] The ID of the company to set as the current company in context for the AI chat
24
+ #
17
25
  # @param title [String, nil] The new title for the AI chat
18
26
  #
19
27
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
@@ -4,7 +4,7 @@ module WhopSDK
4
4
  module Models
5
5
  class App < WhopSDK::Internal::Type::BaseModel
6
6
  # @!attribute id
7
- # The ID of the app
7
+ # The unique identifier for the app.
8
8
  #
9
9
  # @return [String]
10
10
  required :id, String
@@ -122,9 +122,10 @@ module WhopSDK
122
122
  # Some parameter documentations has been truncated, see {WhopSDK::Models::App} for
123
123
  # more details.
124
124
  #
125
- # An object representing an app
125
+ # An app is an integration built on Whop. Apps can serve consumers as experiences
126
+ # within products, or serve companies as business tools.
126
127
  #
127
- # @param id [String] The ID of the app
128
+ # @param id [String] The unique identifier for the app.
128
129
  #
129
130
  # @param api_key [WhopSDK::Models::App::APIKey, nil] The API key for the app
130
131
  #
@@ -161,7 +162,7 @@ module WhopSDK
161
162
  # @see WhopSDK::Models::App#api_key
162
163
  class APIKey < WhopSDK::Internal::Type::BaseModel
163
164
  # @!attribute id
164
- # The ID of this API key
165
+ # The unique identifier for the private api key.
165
166
  #
166
167
  # @return [String]
167
168
  required :id, String
@@ -173,7 +174,7 @@ module WhopSDK
173
174
  required :token, String
174
175
 
175
176
  # @!attribute created_at
176
- # When this API key was created at
177
+ # The datetime the private api key was created.
177
178
  #
178
179
  # @return [Time]
179
180
  required :created_at, Time
@@ -181,17 +182,17 @@ module WhopSDK
181
182
  # @!method initialize(id:, token:, created_at:)
182
183
  # The API key for the app
183
184
  #
184
- # @param id [String] The ID of this API key
185
+ # @param id [String] The unique identifier for the private api key.
185
186
  #
186
187
  # @param token [String] This is the API key used to authenticate requests
187
188
  #
188
- # @param created_at [Time] When this API key was created at
189
+ # @param created_at [Time] The datetime the private api key was created.
189
190
  end
190
191
 
191
192
  # @see WhopSDK::Models::App#company
192
193
  class Company < WhopSDK::Internal::Type::BaseModel
193
194
  # @!attribute id
194
- # The ID (tag) of the company.
195
+ # The unique identifier for the company.
195
196
  #
196
197
  # @return [String]
197
198
  required :id, String
@@ -205,7 +206,7 @@ module WhopSDK
205
206
  # @!method initialize(id:, title:)
206
207
  # The company that owns the app
207
208
  #
208
- # @param id [String] The ID (tag) of the company.
209
+ # @param id [String] The unique identifier for the company.
209
210
  #
210
211
  # @param title [String] The title of the company.
211
212
  end
@@ -213,7 +214,7 @@ module WhopSDK
213
214
  # @see WhopSDK::Models::App#creator
214
215
  class Creator < WhopSDK::Internal::Type::BaseModel
215
216
  # @!attribute id
216
- # The internal ID of the user.
217
+ # The unique identifier for the user.
217
218
  #
218
219
  # @return [String]
219
220
  required :id, String
@@ -233,7 +234,7 @@ module WhopSDK
233
234
  # @!method initialize(id:, name:, username:)
234
235
  # The creator of the app
235
236
  #
236
- # @param id [String] The internal ID of the user.
237
+ # @param id [String] The unique identifier for the user.
237
238
  #
238
239
  # @param name [String, nil] The name of the user from their Whop account.
239
240
  #
@@ -4,7 +4,7 @@ module WhopSDK
4
4
  module Models
5
5
  class AppBuild < WhopSDK::Internal::Type::BaseModel
6
6
  # @!attribute id
7
- # The ID of the app build. It will look like apbu_xxxxx.
7
+ # The unique identifier for the app build.
8
8
  #
9
9
  # @return [String]
10
10
  required :id, String
@@ -17,7 +17,7 @@ module WhopSDK
17
17
  required :checksum, String
18
18
 
19
19
  # @!attribute created_at
20
- # When this app build was created.
20
+ # The datetime the app build was created.
21
21
  #
22
22
  # @return [Time]
23
23
  required :created_at, Time
@@ -66,11 +66,11 @@ module WhopSDK
66
66
  #
67
67
  # An App Build object representing a build of an application
68
68
  #
69
- # @param id [String] The ID of the app build. It will look like apbu_xxxxx.
69
+ # @param id [String] The unique identifier for the app build.
70
70
  #
71
71
  # @param checksum [String] This is generated by the client and used to verify the integrity of the file tha
72
72
  #
73
- # @param created_at [Time] When this app build was created.
73
+ # @param created_at [Time] The datetime the app build was created.
74
74
  #
75
75
  # @param file_url [String] The URL to download the app build .zip file.
76
76
  #
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::AppBuilds#list
6
6
  class AppBuildListResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The ID of the app build. It will look like apbu_xxxxx.
8
+ # The unique identifier for the app build.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -18,7 +18,7 @@ module WhopSDK
18
18
  required :checksum, String
19
19
 
20
20
  # @!attribute created_at
21
- # When this app build was created.
21
+ # The datetime the app build was created.
22
22
  #
23
23
  # @return [Time]
24
24
  required :created_at, Time
@@ -67,11 +67,11 @@ module WhopSDK
67
67
  #
68
68
  # An App Build object representing a build of an application
69
69
  #
70
- # @param id [String] The ID of the app build. It will look like apbu_xxxxx.
70
+ # @param id [String] The unique identifier for the app build.
71
71
  #
72
72
  # @param checksum [String] This is generated by the client and used to verify the integrity of the file tha
73
73
  #
74
- # @param created_at [Time] When this app build was created.
74
+ # @param created_at [Time] The datetime the app build was created.
75
75
  #
76
76
  # @param file_url [String] The URL to download the app build .zip file.
77
77
  #
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::Apps#list
6
6
  class AppListResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # The ID of the app
8
+ # The unique identifier for the app.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -103,9 +103,10 @@ module WhopSDK
103
103
  # Some parameter documentations has been truncated, see
104
104
  # {WhopSDK::Models::AppListResponse} for more details.
105
105
  #
106
- # An object representing an app
106
+ # An app is an integration built on Whop. Apps can serve consumers as experiences
107
+ # within products, or serve companies as business tools.
107
108
  #
108
- # @param id [String] The ID of the app
109
+ # @param id [String] The unique identifier for the app.
109
110
  #
110
111
  # @param app_type [Symbol, WhopSDK::Models::AppType] The type of end-user an app is built for
111
112
  #
@@ -136,7 +137,7 @@ module WhopSDK
136
137
  # @see WhopSDK::Models::AppListResponse#company
137
138
  class Company < WhopSDK::Internal::Type::BaseModel
138
139
  # @!attribute id
139
- # The ID (tag) of the company.
140
+ # The unique identifier for the company.
140
141
  #
141
142
  # @return [String]
142
143
  required :id, String
@@ -150,7 +151,7 @@ module WhopSDK
150
151
  # @!method initialize(id:, title:)
151
152
  # The company that owns the app
152
153
  #
153
- # @param id [String] The ID (tag) of the company.
154
+ # @param id [String] The unique identifier for the company.
154
155
  #
155
156
  # @param title [String] The title of the company.
156
157
  end
@@ -158,7 +159,7 @@ module WhopSDK
158
159
  # @see WhopSDK::Models::AppListResponse#creator
159
160
  class Creator < WhopSDK::Internal::Type::BaseModel
160
161
  # @!attribute id
161
- # The internal ID of the user.
162
+ # The unique identifier for the user.
162
163
  #
163
164
  # @return [String]
164
165
  required :id, String
@@ -178,7 +179,7 @@ module WhopSDK
178
179
  # @!method initialize(id:, name:, username:)
179
180
  # The creator of the app
180
181
  #
181
- # @param id [String] The internal ID of the user.
182
+ # @param id [String] The unique identifier for the user.
182
183
  #
183
184
  # @param name [String, nil] The name of the user from their Whop account.
184
185
  #
@@ -5,7 +5,7 @@ module WhopSDK
5
5
  # @see WhopSDK::Resources::AuthorizedUsers#list
6
6
  class AuthorizedUserListResponse < WhopSDK::Internal::Type::BaseModel
7
7
  # @!attribute id
8
- # A unique ID representing the authorized user object.
8
+ # The unique identifier for the authorized user.
9
9
  #
10
10
  # @return [String]
11
11
  required :id, String
@@ -31,7 +31,7 @@ module WhopSDK
31
31
  # @!method initialize(id:, company:, role:, user:)
32
32
  # A user who has elevated security privileges for a company
33
33
  #
34
- # @param id [String] A unique ID representing the authorized user object.
34
+ # @param id [String] The unique identifier for the authorized user.
35
35
  #
36
36
  # @param company [WhopSDK::Models::AuthorizedUserListResponse::Company] The company associated with the authorized user.
37
37
  #
@@ -42,7 +42,7 @@ module WhopSDK
42
42
  # @see WhopSDK::Models::AuthorizedUserListResponse#company
43
43
  class Company < WhopSDK::Internal::Type::BaseModel
44
44
  # @!attribute id
45
- # The ID (tag) of the company.
45
+ # The unique identifier for the company.
46
46
  #
47
47
  # @return [String]
48
48
  required :id, String
@@ -56,7 +56,7 @@ module WhopSDK
56
56
  # @!method initialize(id:, title:)
57
57
  # The company associated with the authorized user.
58
58
  #
59
- # @param id [String] The ID (tag) of the company.
59
+ # @param id [String] The unique identifier for the company.
60
60
  #
61
61
  # @param title [String] The title of the company.
62
62
  end
@@ -64,7 +64,7 @@ module WhopSDK
64
64
  # @see WhopSDK::Models::AuthorizedUserListResponse#user
65
65
  class User < WhopSDK::Internal::Type::BaseModel
66
66
  # @!attribute id
67
- # The internal ID of the user.
67
+ # The unique identifier for the user.
68
68
  #
69
69
  # @return [String]
70
70
  required :id, String
@@ -90,7 +90,7 @@ module WhopSDK
90
90
  # @!method initialize(id:, email:, name:, username:)
91
91
  # The user associated with the authorized user.
92
92
  #
93
- # @param id [String] The internal ID of the user.
93
+ # @param id [String] The unique identifier for the user.
94
94
  #
95
95
  # @param email [String, nil] The email of the user
96
96
  #