whop_sdk 0.0.3 → 0.0.5

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 (267) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +47 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +8 -0
  5. data/lib/whop_sdk/internal/transport/base_client.rb +7 -1
  6. data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +6 -2
  7. data/lib/whop_sdk/models/access_level.rb +1 -1
  8. data/lib/whop_sdk/models/access_pass_type.rb +2 -1
  9. data/lib/whop_sdk/models/access_token_create_params.rb +67 -0
  10. data/lib/whop_sdk/models/access_token_create_response.rb +27 -0
  11. data/lib/whop_sdk/models/app_build_create_params.rb +53 -29
  12. data/lib/whop_sdk/models/app_update_params.rb +53 -29
  13. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +119 -43
  14. data/lib/whop_sdk/models/company.rb +13 -1
  15. data/lib/whop_sdk/models/company_create_params.rb +46 -0
  16. data/lib/whop_sdk/models/company_list_params.rb +62 -0
  17. data/lib/whop_sdk/models/company_list_response.rb +175 -0
  18. data/lib/whop_sdk/models/course.rb +18 -1
  19. data/lib/whop_sdk/models/course_create_params.rb +94 -30
  20. data/lib/whop_sdk/models/course_lesson_create_params.rb +77 -1
  21. data/lib/whop_sdk/models/course_lesson_list_response.rb +43 -1
  22. data/lib/whop_sdk/models/course_lesson_update_params.rb +280 -83
  23. data/lib/whop_sdk/models/course_list_response.rb +18 -1
  24. data/lib/whop_sdk/models/course_student_list_params.rb +62 -0
  25. data/lib/whop_sdk/models/course_student_list_response.rb +97 -0
  26. data/lib/whop_sdk/models/course_student_retrieve_params.rb +14 -0
  27. data/lib/whop_sdk/models/course_student_retrieve_response.rb +149 -0
  28. data/lib/whop_sdk/models/course_update_params.rb +70 -28
  29. data/lib/whop_sdk/models/course_visibilities.rb +17 -0
  30. data/lib/whop_sdk/models/embed_type.rb +16 -0
  31. data/lib/whop_sdk/models/entry.rb +3 -3
  32. data/lib/whop_sdk/models/entry_list_response.rb +3 -3
  33. data/lib/whop_sdk/models/experience.rb +5 -6
  34. data/lib/whop_sdk/models/experience_update_params.rb +53 -29
  35. data/lib/whop_sdk/models/forum_post.rb +2 -2
  36. data/lib/whop_sdk/models/forum_post_create_params.rb +51 -27
  37. data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
  38. data/lib/whop_sdk/models/forum_post_update_params.rb +51 -27
  39. data/lib/whop_sdk/models/global_affiliate_status.rb +1 -1
  40. data/lib/whop_sdk/models/invoice_create_params.rb +50 -34
  41. data/lib/whop_sdk/models/invoice_list_params.rb +27 -40
  42. data/lib/whop_sdk/models/lesson.rb +59 -9
  43. data/lib/whop_sdk/models/member_list_params.rb +11 -11
  44. data/lib/whop_sdk/models/member_list_response.rb +3 -3
  45. data/lib/whop_sdk/models/member_retrieve_response.rb +3 -3
  46. data/lib/whop_sdk/models/membership_list_params.rb +9 -9
  47. data/lib/whop_sdk/models/message.rb +2 -2
  48. data/lib/whop_sdk/models/message_create_params.rb +51 -27
  49. data/lib/whop_sdk/models/message_list_response.rb +2 -2
  50. data/lib/whop_sdk/models/message_update_params.rb +51 -27
  51. data/lib/whop_sdk/models/payment.rb +13 -4
  52. data/lib/whop_sdk/models/payment_list_response.rb +13 -4
  53. data/lib/whop_sdk/models/payment_method_types.rb +2 -1
  54. data/lib/whop_sdk/models/plan.rb +54 -5
  55. data/lib/whop_sdk/models/plan_create_params.rb +99 -24
  56. data/lib/whop_sdk/models/plan_list_response.rb +57 -5
  57. data/lib/whop_sdk/models/plan_type.rb +1 -1
  58. data/lib/whop_sdk/models/plan_update_params.rb +97 -22
  59. data/lib/whop_sdk/models/product.rb +1 -1
  60. data/lib/whop_sdk/models/product_create_params.rb +6 -6
  61. data/lib/whop_sdk/models/product_list_item.rb +1 -1
  62. data/lib/whop_sdk/models/product_update_params.rb +57 -33
  63. data/lib/whop_sdk/models/promo_code.rb +3 -3
  64. data/lib/whop_sdk/models/promo_code_list_response.rb +3 -3
  65. data/lib/whop_sdk/models/transfer.rb +9 -1
  66. data/lib/whop_sdk/models/transfer_create_params.rb +9 -1
  67. data/lib/whop_sdk/models/transfer_list_response.rb +9 -1
  68. data/lib/whop_sdk/models.rb +14 -0
  69. data/lib/whop_sdk/resources/access_tokens.rb +46 -0
  70. data/lib/whop_sdk/resources/app_builds.rb +5 -3
  71. data/lib/whop_sdk/resources/apps.rb +4 -3
  72. data/lib/whop_sdk/resources/authorized_users.rb +2 -1
  73. data/lib/whop_sdk/resources/chat_channels.rb +9 -2
  74. data/lib/whop_sdk/resources/checkout_configurations.rb +8 -7
  75. data/lib/whop_sdk/resources/companies.rb +72 -1
  76. data/lib/whop_sdk/resources/course_chapters.rb +5 -3
  77. data/lib/whop_sdk/resources/course_lesson_interactions.rb +4 -3
  78. data/lib/whop_sdk/resources/course_lessons.rb +25 -7
  79. data/lib/whop_sdk/resources/course_students.rb +77 -0
  80. data/lib/whop_sdk/resources/courses.rb +24 -7
  81. data/lib/whop_sdk/resources/entries.rb +6 -3
  82. data/lib/whop_sdk/resources/experiences.rb +9 -7
  83. data/lib/whop_sdk/resources/forum_posts.rb +5 -4
  84. data/lib/whop_sdk/resources/forums.rb +3 -2
  85. data/lib/whop_sdk/resources/invoices.rb +22 -16
  86. data/lib/whop_sdk/resources/ledger_accounts.rb +6 -2
  87. data/lib/whop_sdk/resources/members.rb +6 -5
  88. data/lib/whop_sdk/resources/memberships.rb +10 -8
  89. data/lib/whop_sdk/resources/messages.rb +5 -4
  90. data/lib/whop_sdk/resources/payments.rb +7 -4
  91. data/lib/whop_sdk/resources/plans.rb +14 -8
  92. data/lib/whop_sdk/resources/products.rb +10 -8
  93. data/lib/whop_sdk/resources/promo_codes.rb +4 -2
  94. data/lib/whop_sdk/resources/reactions.rb +2 -1
  95. data/lib/whop_sdk/resources/reviews.rb +2 -1
  96. data/lib/whop_sdk/resources/shipments.rb +2 -1
  97. data/lib/whop_sdk/resources/support_channels.rb +2 -1
  98. data/lib/whop_sdk/resources/transfers.rb +5 -2
  99. data/lib/whop_sdk/resources/users.rb +9 -3
  100. data/lib/whop_sdk/version.rb +1 -1
  101. data/lib/whop_sdk.rb +14 -1
  102. data/manifest.yaml +1 -0
  103. data/rbi/whop_sdk/client.rbi +6 -0
  104. data/rbi/whop_sdk/internal/transport/base_client.rbi +5 -0
  105. data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi +6 -2
  106. data/rbi/whop_sdk/internal/type/base_model.rbi +8 -4
  107. data/rbi/whop_sdk/models/access_level.rbi +1 -1
  108. data/rbi/whop_sdk/models/access_pass_type.rbi +2 -1
  109. data/rbi/whop_sdk/models/access_token_create_params.rbi +126 -0
  110. data/rbi/whop_sdk/models/access_token_create_response.rbi +37 -0
  111. data/rbi/whop_sdk/models/app_build_create_params.rbi +80 -40
  112. data/rbi/whop_sdk/models/app_update_params.rbi +86 -37
  113. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +196 -68
  114. data/rbi/whop_sdk/models/company.rbi +10 -0
  115. data/rbi/whop_sdk/models/company_create_params.rbi +67 -0
  116. data/rbi/whop_sdk/models/company_list_params.rbi +83 -0
  117. data/rbi/whop_sdk/models/company_list_response.rbi +235 -0
  118. data/rbi/whop_sdk/models/course.rbi +21 -3
  119. data/rbi/whop_sdk/models/course_create_params.rbi +126 -38
  120. data/rbi/whop_sdk/models/course_lesson_create_params.rbi +126 -0
  121. data/rbi/whop_sdk/models/course_lesson_list_response.rbi +68 -0
  122. data/rbi/whop_sdk/models/course_lesson_update_params.rbi +449 -111
  123. data/rbi/whop_sdk/models/course_list_response.rbi +21 -3
  124. data/rbi/whop_sdk/models/course_student_list_params.rbi +83 -0
  125. data/rbi/whop_sdk/models/course_student_list_response.rbi +142 -0
  126. data/rbi/whop_sdk/models/course_student_retrieve_params.rbi +30 -0
  127. data/rbi/whop_sdk/models/course_student_retrieve_response.rbi +250 -0
  128. data/rbi/whop_sdk/models/course_update_params.rbi +104 -38
  129. data/rbi/whop_sdk/models/course_visibilities.rbi +23 -0
  130. data/rbi/whop_sdk/models/embed_type.rbi +20 -0
  131. data/rbi/whop_sdk/models/entry.rbi +3 -3
  132. data/rbi/whop_sdk/models/entry_list_response.rbi +3 -3
  133. data/rbi/whop_sdk/models/experience.rbi +7 -9
  134. data/rbi/whop_sdk/models/experience_update_params.rbi +84 -38
  135. data/rbi/whop_sdk/models/forum_post.rbi +2 -2
  136. data/rbi/whop_sdk/models/forum_post_create_params.rbi +85 -32
  137. data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
  138. data/rbi/whop_sdk/models/forum_post_update_params.rbi +85 -32
  139. data/rbi/whop_sdk/models/global_affiliate_status.rbi +1 -1
  140. data/rbi/whop_sdk/models/invoice_create_params.rbi +60 -46
  141. data/rbi/whop_sdk/models/invoice_list_params.rbi +26 -71
  142. data/rbi/whop_sdk/models/lesson.rbi +68 -10
  143. data/rbi/whop_sdk/models/member_list_params.rbi +10 -10
  144. data/rbi/whop_sdk/models/member_list_response.rbi +6 -6
  145. data/rbi/whop_sdk/models/member_retrieve_response.rbi +6 -6
  146. data/rbi/whop_sdk/models/membership_list_params.rbi +8 -8
  147. data/rbi/whop_sdk/models/message.rbi +2 -2
  148. data/rbi/whop_sdk/models/message_create_params.rbi +85 -32
  149. data/rbi/whop_sdk/models/message_list_response.rbi +2 -2
  150. data/rbi/whop_sdk/models/message_update_params.rbi +85 -32
  151. data/rbi/whop_sdk/models/payment.rbi +13 -3
  152. data/rbi/whop_sdk/models/payment_list_response.rbi +13 -3
  153. data/rbi/whop_sdk/models/payment_method_types.rbi +3 -1
  154. data/rbi/whop_sdk/models/plan.rbi +88 -4
  155. data/rbi/whop_sdk/models/plan_create_params.rbi +176 -34
  156. data/rbi/whop_sdk/models/plan_list_response.rbi +100 -4
  157. data/rbi/whop_sdk/models/plan_type.rbi +1 -1
  158. data/rbi/whop_sdk/models/plan_update_params.rbi +174 -32
  159. data/rbi/whop_sdk/models/product.rbi +1 -1
  160. data/rbi/whop_sdk/models/product_create_params.rbi +6 -6
  161. data/rbi/whop_sdk/models/product_list_item.rbi +1 -1
  162. data/rbi/whop_sdk/models/product_update_params.rbi +87 -43
  163. data/rbi/whop_sdk/models/promo_code.rbi +3 -3
  164. data/rbi/whop_sdk/models/promo_code_list_response.rbi +3 -3
  165. data/rbi/whop_sdk/models/transfer.rbi +8 -0
  166. data/rbi/whop_sdk/models/transfer_create_params.rbi +8 -0
  167. data/rbi/whop_sdk/models/transfer_list_response.rbi +8 -0
  168. data/rbi/whop_sdk/models.rbi +14 -0
  169. data/rbi/whop_sdk/resources/access_tokens.rbi +41 -0
  170. data/rbi/whop_sdk/resources/app_builds.rbi +15 -3
  171. data/rbi/whop_sdk/resources/apps.rbi +13 -2
  172. data/rbi/whop_sdk/resources/authorized_users.rbi +5 -1
  173. data/rbi/whop_sdk/resources/chat_channels.rbi +8 -1
  174. data/rbi/whop_sdk/resources/checkout_configurations.rbi +11 -8
  175. data/rbi/whop_sdk/resources/companies.rbi +68 -1
  176. data/rbi/whop_sdk/resources/course_chapters.rbi +11 -2
  177. data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +7 -3
  178. data/rbi/whop_sdk/resources/course_lessons.rbi +62 -4
  179. data/rbi/whop_sdk/resources/course_students.rbi +69 -0
  180. data/rbi/whop_sdk/resources/courses.rbi +50 -4
  181. data/rbi/whop_sdk/resources/entries.rbi +15 -3
  182. data/rbi/whop_sdk/resources/experiences.rbi +21 -3
  183. data/rbi/whop_sdk/resources/forum_posts.rbi +18 -3
  184. data/rbi/whop_sdk/resources/forums.rbi +6 -1
  185. data/rbi/whop_sdk/resources/invoices.rbi +38 -23
  186. data/rbi/whop_sdk/resources/ledger_accounts.rbi +7 -2
  187. data/rbi/whop_sdk/resources/members.rbi +9 -5
  188. data/rbi/whop_sdk/resources/memberships.rbi +16 -5
  189. data/rbi/whop_sdk/resources/messages.rbi +18 -3
  190. data/rbi/whop_sdk/resources/payments.rbi +16 -3
  191. data/rbi/whop_sdk/resources/plans.rbi +40 -5
  192. data/rbi/whop_sdk/resources/products.rbi +21 -7
  193. data/rbi/whop_sdk/resources/promo_codes.rbi +10 -2
  194. data/rbi/whop_sdk/resources/reactions.rbi +5 -1
  195. data/rbi/whop_sdk/resources/reviews.rbi +5 -1
  196. data/rbi/whop_sdk/resources/shipments.rbi +5 -1
  197. data/rbi/whop_sdk/resources/support_channels.rbi +5 -1
  198. data/rbi/whop_sdk/resources/transfers.rbi +8 -1
  199. data/rbi/whop_sdk/resources/users.rbi +13 -2
  200. data/sig/whop_sdk/client.rbs +4 -0
  201. data/sig/whop_sdk/internal/transport/base_client.rbs +2 -0
  202. data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs +4 -1
  203. data/sig/whop_sdk/models/access_token_create_params.rbs +56 -0
  204. data/sig/whop_sdk/models/access_token_create_response.rbs +15 -0
  205. data/sig/whop_sdk/models/app_build_create_params.rbs +29 -10
  206. data/sig/whop_sdk/models/app_update_params.rbs +29 -10
  207. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +72 -21
  208. data/sig/whop_sdk/models/company.rbs +5 -0
  209. data/sig/whop_sdk/models/company_create_params.rbs +41 -0
  210. data/sig/whop_sdk/models/company_list_params.rbs +51 -0
  211. data/sig/whop_sdk/models/company_list_response.rbs +109 -0
  212. data/sig/whop_sdk/models/course.rbs +13 -3
  213. data/sig/whop_sdk/models/course_create_params.rbs +49 -10
  214. data/sig/whop_sdk/models/course_lesson_create_params.rbs +46 -0
  215. data/sig/whop_sdk/models/course_lesson_list_response.rbs +25 -0
  216. data/sig/whop_sdk/models/course_lesson_update_params.rbs +162 -30
  217. data/sig/whop_sdk/models/course_list_response.rbs +13 -3
  218. data/sig/whop_sdk/models/course_student_list_params.rbs +51 -0
  219. data/sig/whop_sdk/models/course_student_list_response.rbs +64 -0
  220. data/sig/whop_sdk/models/course_student_retrieve_params.rbs +15 -0
  221. data/sig/whop_sdk/models/course_student_retrieve_response.rbs +106 -0
  222. data/sig/whop_sdk/models/course_update_params.rbs +40 -11
  223. data/sig/whop_sdk/models/course_visibilities.rbs +14 -0
  224. data/sig/whop_sdk/models/embed_type.rbs +14 -0
  225. data/sig/whop_sdk/models/experience_update_params.rbs +29 -10
  226. data/sig/whop_sdk/models/forum_post_create_params.rbs +29 -10
  227. data/sig/whop_sdk/models/forum_post_update_params.rbs +29 -10
  228. data/sig/whop_sdk/models/invoice_create_params.rbs +28 -18
  229. data/sig/whop_sdk/models/invoice_list_params.rbs +16 -33
  230. data/sig/whop_sdk/models/lesson.rbs +33 -8
  231. data/sig/whop_sdk/models/member_list_params.rbs +5 -5
  232. data/sig/whop_sdk/models/membership_list_params.rbs +5 -5
  233. data/sig/whop_sdk/models/message_create_params.rbs +29 -10
  234. data/sig/whop_sdk/models/message_update_params.rbs +29 -10
  235. data/sig/whop_sdk/models/payment.rbs +5 -0
  236. data/sig/whop_sdk/models/payment_list_response.rbs +5 -0
  237. data/sig/whop_sdk/models/payment_method_types.rbs +4 -2
  238. data/sig/whop_sdk/models/plan.rbs +32 -0
  239. data/sig/whop_sdk/models/plan_create_params.rbs +61 -10
  240. data/sig/whop_sdk/models/plan_list_response.rbs +32 -0
  241. data/sig/whop_sdk/models/plan_update_params.rbs +61 -10
  242. data/sig/whop_sdk/models/product_update_params.rbs +29 -10
  243. data/sig/whop_sdk/models/transfer.rbs +5 -0
  244. data/sig/whop_sdk/models/transfer_create_params.rbs +5 -0
  245. data/sig/whop_sdk/models/transfer_list_response.rbs +5 -0
  246. data/sig/whop_sdk/models.rbs +14 -0
  247. data/sig/whop_sdk/resources/access_tokens.rbs +15 -0
  248. data/sig/whop_sdk/resources/app_builds.rbs +1 -1
  249. data/sig/whop_sdk/resources/apps.rbs +1 -1
  250. data/sig/whop_sdk/resources/checkout_configurations.rbs +2 -2
  251. data/sig/whop_sdk/resources/companies.rbs +18 -0
  252. data/sig/whop_sdk/resources/course_lessons.rbs +10 -2
  253. data/sig/whop_sdk/resources/course_students.rbs +22 -0
  254. data/sig/whop_sdk/resources/courses.rbs +8 -2
  255. data/sig/whop_sdk/resources/experiences.rbs +1 -1
  256. data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
  257. data/sig/whop_sdk/resources/invoices.rbs +8 -6
  258. data/sig/whop_sdk/resources/members.rbs +1 -1
  259. data/sig/whop_sdk/resources/memberships.rbs +1 -1
  260. data/sig/whop_sdk/resources/messages.rbs +2 -2
  261. data/sig/whop_sdk/resources/plans.rbs +4 -2
  262. data/sig/whop_sdk/resources/products.rbs +1 -1
  263. data/sig/whop_sdk/resources/transfers.rbs +1 -0
  264. metadata +41 -5
  265. data/lib/whop_sdk/models/invoice_create_response.rb +0 -27
  266. data/rbi/whop_sdk/models/invoice_create_response.rbi +0 -49
  267. data/sig/whop_sdk/models/invoice_create_response.rbs +0 -19
@@ -54,8 +54,8 @@ module WhopSDK
54
54
  # @!attribute image
55
55
  # An image for the plan. This will be visible on the product page to customers.
56
56
  #
57
- # @return [WhopSDK::Models::PlanCreateParams::Image, nil]
58
- optional :image, -> { WhopSDK::PlanCreateParams::Image }, nil?: true
57
+ # @return [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil]
58
+ optional :image, union: -> { WhopSDK::PlanCreateParams::Image }, nil?: true
59
59
 
60
60
  # @!attribute initial_price
61
61
  # An additional amount charged upon first purchase. Use only if a one time payment
@@ -78,8 +78,17 @@ module WhopSDK
78
78
  # @return [Symbol, WhopSDK::Models::TaxType, nil]
79
79
  optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
80
80
 
81
+ # @!attribute payment_method_configuration
82
+ # The explicit payment method configuration for the plan. If not provided, the
83
+ # platform or company's defaults will apply.
84
+ #
85
+ # @return [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil]
86
+ optional :payment_method_configuration,
87
+ -> { WhopSDK::PlanCreateParams::PaymentMethodConfiguration },
88
+ nil?: true
89
+
81
90
  # @!attribute plan_type
82
- # The type of plan that can be attached to an access pass
91
+ # The type of plan that can be attached to a product
83
92
  #
84
93
  # @return [Symbol, WhopSDK::Models::PlanType, nil]
85
94
  optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
@@ -141,7 +150,7 @@ module WhopSDK
141
150
  # @return [Symbol, WhopSDK::Models::Visibility, nil]
142
151
  optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
143
152
 
144
- # @!method initialize(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
153
+ # @!method initialize(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
145
154
  # Some parameter documentations has been truncated, see
146
155
  # {WhopSDK::Models::PlanCreateParams} for more details.
147
156
  #
@@ -159,7 +168,7 @@ module WhopSDK
159
168
  #
160
169
  # @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
161
170
  #
162
- # @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
171
+ # @param image [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
163
172
  #
164
173
  # @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
165
174
  #
@@ -167,7 +176,9 @@ module WhopSDK
167
176
  #
168
177
  # @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
169
178
  #
170
- # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
179
+ # @param payment_method_configuration [WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
180
+ #
181
+ # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
171
182
  #
172
183
  # @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
173
184
  #
@@ -240,32 +251,96 @@ module WhopSDK
240
251
  # @param field_type [Symbol, :text] The type of the custom field.
241
252
  end
242
253
 
243
- class Image < WhopSDK::Internal::Type::BaseModel
244
- # @!attribute id
245
- # The ID of an existing attachment object. Use this when updating a resource and
246
- # keeping a subset of the attachments. Don't use this unless you know what you're
247
- # doing.
254
+ # An image for the plan. This will be visible on the product page to customers.
255
+ module Image
256
+ extend WhopSDK::Internal::Type::Union
257
+
258
+ # Input for an attachment
259
+ variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID }
260
+
261
+ # Input for an attachment
262
+ variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithID }
263
+
264
+ class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
265
+ # @!attribute direct_upload_id
266
+ # This ID should be used the first time you upload an attachment. It is the ID of
267
+ # the direct upload that was created when uploading the file to S3 via the
268
+ # mediaDirectUpload mutation.
269
+ #
270
+ # @return [String]
271
+ required :direct_upload_id, String
272
+
273
+ # @!method initialize(direct_upload_id:)
274
+ # Some parameter documentations has been truncated, see
275
+ # {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID}
276
+ # for more details.
277
+ #
278
+ # Input for an attachment
279
+ #
280
+ # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
281
+ end
282
+
283
+ class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
284
+ # @!attribute id
285
+ # The ID of an existing attachment object. Use this when updating a resource and
286
+ # keeping a subset of the attachments. Don't use this unless you know what you're
287
+ # doing.
288
+ #
289
+ # @return [String]
290
+ required :id, String
291
+
292
+ # @!method initialize(id:)
293
+ # Some parameter documentations has been truncated, see
294
+ # {WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID} for more
295
+ # details.
296
+ #
297
+ # Input for an attachment
298
+ #
299
+ # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
300
+ end
301
+
302
+ # @!method self.variants
303
+ # @return [Array(WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID)]
304
+ end
305
+
306
+ class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
307
+ # @!attribute disabled
308
+ # An array of payment method identifiers that are explicitly disabled. Only
309
+ # applies if the include_platform_defaults is true.
248
310
  #
249
- # @return [String, nil]
250
- optional :id, String, nil?: true
311
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
312
+ required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
313
+
314
+ # @!attribute enabled
315
+ # An array of payment method identifiers that are explicitly enabled. This means
316
+ # these payment methods will be shown on checkout. Example use case is to only
317
+ # enable a specific payment method like cashapp, or extending the platform
318
+ # defaults with additional methods.
319
+ #
320
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
321
+ required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
251
322
 
252
- # @!attribute direct_upload_id
253
- # This ID should be used the first time you upload an attachment. It is the ID of
254
- # the direct upload that was created when uploading the file to S3 via the
255
- # mediaDirectUpload mutation.
323
+ # @!attribute include_platform_defaults
324
+ # Whether Whop's platform default payment method enablement settings are included
325
+ # in this configuration. The full list of default payment methods can be found in
326
+ # the documentation at docs.whop.com/payments.
256
327
  #
257
- # @return [String, nil]
258
- optional :direct_upload_id, String, nil?: true
328
+ # @return [Boolean]
329
+ required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
259
330
 
260
- # @!method initialize(id: nil, direct_upload_id: nil)
331
+ # @!method initialize(disabled:, enabled:, include_platform_defaults:)
261
332
  # Some parameter documentations has been truncated, see
262
- # {WhopSDK::Models::PlanCreateParams::Image} for more details.
333
+ # {WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration} for more
334
+ # details.
335
+ #
336
+ # The explicit payment method configuration for the plan. If not provided, the
337
+ # platform or company's defaults will apply.
263
338
  #
264
- # An image for the plan. This will be visible on the product page to customers.
339
+ # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
265
340
  #
266
- # @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
341
+ # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
267
342
  #
268
- # @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
343
+ # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
269
344
  end
270
345
  end
271
346
  end
@@ -70,6 +70,14 @@ module WhopSDK
70
70
  # @return [Integer, nil]
71
71
  required :member_count, Integer, nil?: true
72
72
 
73
+ # @!attribute payment_method_configuration
74
+ # The explicit payment method configuration for the plan, if any.
75
+ #
76
+ # @return [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil]
77
+ required :payment_method_configuration,
78
+ -> { WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration },
79
+ nil?: true
80
+
73
81
  # @!attribute plan_type
74
82
  # Indicates if the plan is a one time payment or recurring.
75
83
  #
@@ -77,7 +85,7 @@ module WhopSDK
77
85
  required :plan_type, enum: -> { WhopSDK::PlanType }
78
86
 
79
87
  # @!attribute product
80
- # The access pass for the plan.
88
+ # The product that this plan belongs to.
81
89
  #
82
90
  # @return [WhopSDK::Models::PlanListResponse::Product, nil]
83
91
  required :product, -> { WhopSDK::Models::PlanListResponse::Product }, nil?: true
@@ -136,8 +144,10 @@ module WhopSDK
136
144
  # @return [Symbol, WhopSDK::Models::Visibility]
137
145
  required :visibility, enum: -> { WhopSDK::Visibility }
138
146
 
139
- # @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
140
- # An object representing a (sanitized) plan of an access pass.
147
+ # @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
148
+ # A plan for an product. Plans define the core parameters that define a checkout
149
+ # and payment on whop. Use plans to create different ways to price your products
150
+ # (Eg renewal / one_time)
141
151
  #
142
152
  # @param id [String] The internal ID of the plan.
143
153
  #
@@ -161,9 +171,11 @@ module WhopSDK
161
171
  #
162
172
  # @param member_count [Integer, nil] The number of members for the plan.
163
173
  #
174
+ # @param payment_method_configuration [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan, if any.
175
+ #
164
176
  # @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
165
177
  #
166
- # @param product [WhopSDK::Models::PlanListResponse::Product, nil] The access pass for the plan.
178
+ # @param product [WhopSDK::Models::PlanListResponse::Product, nil] The product that this plan belongs to.
167
179
  #
168
180
  # @param purchase_url [String] The direct link to purchase the product.
169
181
  #
@@ -219,6 +231,46 @@ module WhopSDK
219
231
  # @param id [String] The ID of the invoice.
220
232
  end
221
233
 
234
+ # @see WhopSDK::Models::PlanListResponse#payment_method_configuration
235
+ class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
236
+ # @!attribute disabled
237
+ # An array of payment method identifiers that are explicitly disabled. Only
238
+ # applies if the include_platform_defaults is true.
239
+ #
240
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
241
+ required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
242
+
243
+ # @!attribute enabled
244
+ # An array of payment method identifiers that are explicitly enabled. This means
245
+ # these payment methods will be shown on checkout. Example use case is to only
246
+ # enable a specific payment method like cashapp, or extending the platform
247
+ # defaults with additional methods.
248
+ #
249
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
250
+ required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
251
+
252
+ # @!attribute include_platform_defaults
253
+ # Whether Whop's platform default payment method enablement settings are included
254
+ # in this configuration. The full list of default payment methods can be found in
255
+ # the documentation at docs.whop.com/payments.
256
+ #
257
+ # @return [Boolean]
258
+ required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
259
+
260
+ # @!method initialize(disabled:, enabled:, include_platform_defaults:)
261
+ # Some parameter documentations has been truncated, see
262
+ # {WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration} for more
263
+ # details.
264
+ #
265
+ # The explicit payment method configuration for the plan, if any.
266
+ #
267
+ # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
268
+ #
269
+ # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
270
+ #
271
+ # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
272
+ end
273
+
222
274
  # @see WhopSDK::Models::PlanListResponse#product
223
275
  class Product < WhopSDK::Internal::Type::BaseModel
224
276
  # @!attribute id
@@ -234,7 +286,7 @@ module WhopSDK
234
286
  required :title, String
235
287
 
236
288
  # @!method initialize(id:, title:)
237
- # The access pass for the plan.
289
+ # The product that this plan belongs to.
238
290
  #
239
291
  # @param id [String] The internal ID of the public product.
240
292
  #
@@ -2,7 +2,7 @@
2
2
 
3
3
  module WhopSDK
4
4
  module Models
5
- # The type of plan that can be attached to an access pass
5
+ # The type of plan that can be attached to a product
6
6
  module PlanType
7
7
  extend WhopSDK::Internal::Type::Enum
8
8
 
@@ -42,8 +42,8 @@ module WhopSDK
42
42
  # @!attribute image
43
43
  # An image for the plan. This will be visible on the product page to customers.
44
44
  #
45
- # @return [WhopSDK::Models::PlanUpdateParams::Image, nil]
46
- optional :image, -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
45
+ # @return [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil]
46
+ optional :image, union: -> { WhopSDK::PlanUpdateParams::Image }, nil?: true
47
47
 
48
48
  # @!attribute initial_price
49
49
  # An additional amount charged upon first purchase.
@@ -70,6 +70,15 @@ module WhopSDK
70
70
  # @return [Symbol, WhopSDK::Models::TaxType, nil]
71
71
  optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
72
72
 
73
+ # @!attribute payment_method_configuration
74
+ # The explicit payment method configuration for the plan. If sent as null, the
75
+ # custom configuration will be removed.
76
+ #
77
+ # @return [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil]
78
+ optional :payment_method_configuration,
79
+ -> { WhopSDK::PlanUpdateParams::PaymentMethodConfiguration },
80
+ nil?: true
81
+
73
82
  # @!attribute renewal_price
74
83
  # The amount the customer is charged every billing period.
75
84
  #
@@ -120,7 +129,7 @@ module WhopSDK
120
129
  # @return [Symbol, WhopSDK::Models::Visibility, nil]
121
130
  optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
122
131
 
123
- # @!method initialize(billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
132
+ # @!method initialize(billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, offer_cancel_discount: nil, override_tax_type: nil, payment_method_configuration: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
124
133
  # Some parameter documentations has been truncated, see
125
134
  # {WhopSDK::Models::PlanUpdateParams} for more details.
126
135
  #
@@ -134,7 +143,7 @@ module WhopSDK
134
143
  #
135
144
  # @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
136
145
  #
137
- # @param image [WhopSDK::Models::PlanUpdateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
146
+ # @param image [WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID, nil] An image for the plan. This will be visible on the product page to customers.
138
147
  #
139
148
  # @param initial_price [Float, nil] An additional amount charged upon first purchase.
140
149
  #
@@ -144,6 +153,8 @@ module WhopSDK
144
153
  #
145
154
  # @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
146
155
  #
156
+ # @param payment_method_configuration [WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If sent as null, the cus
157
+ #
147
158
  # @param renewal_price [Float, nil] The amount the customer is charged every billing period.
148
159
  #
149
160
  # @param stock [Integer, nil] The number of units available for purchase.
@@ -213,32 +224,96 @@ module WhopSDK
213
224
  # @param field_type [Symbol, :text] The type of the custom field.
214
225
  end
215
226
 
216
- class Image < WhopSDK::Internal::Type::BaseModel
217
- # @!attribute id
218
- # The ID of an existing attachment object. Use this when updating a resource and
219
- # keeping a subset of the attachments. Don't use this unless you know what you're
220
- # doing.
227
+ # An image for the plan. This will be visible on the product page to customers.
228
+ module Image
229
+ extend WhopSDK::Internal::Type::Union
230
+
231
+ # Input for an attachment
232
+ variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID }
233
+
234
+ # Input for an attachment
235
+ variant -> { WhopSDK::PlanUpdateParams::Image::AttachmentInputWithID }
236
+
237
+ class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
238
+ # @!attribute direct_upload_id
239
+ # This ID should be used the first time you upload an attachment. It is the ID of
240
+ # the direct upload that was created when uploading the file to S3 via the
241
+ # mediaDirectUpload mutation.
242
+ #
243
+ # @return [String]
244
+ required :direct_upload_id, String
245
+
246
+ # @!method initialize(direct_upload_id:)
247
+ # Some parameter documentations has been truncated, see
248
+ # {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID}
249
+ # for more details.
250
+ #
251
+ # Input for an attachment
252
+ #
253
+ # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
254
+ end
255
+
256
+ class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
257
+ # @!attribute id
258
+ # The ID of an existing attachment object. Use this when updating a resource and
259
+ # keeping a subset of the attachments. Don't use this unless you know what you're
260
+ # doing.
261
+ #
262
+ # @return [String]
263
+ required :id, String
264
+
265
+ # @!method initialize(id:)
266
+ # Some parameter documentations has been truncated, see
267
+ # {WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID} for more
268
+ # details.
269
+ #
270
+ # Input for an attachment
271
+ #
272
+ # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
273
+ end
274
+
275
+ # @!method self.variants
276
+ # @return [Array(WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanUpdateParams::Image::AttachmentInputWithID)]
277
+ end
278
+
279
+ class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
280
+ # @!attribute disabled
281
+ # An array of payment method identifiers that are explicitly disabled. Only
282
+ # applies if the include_platform_defaults is true.
221
283
  #
222
- # @return [String, nil]
223
- optional :id, String, nil?: true
284
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
285
+ required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
224
286
 
225
- # @!attribute direct_upload_id
226
- # This ID should be used the first time you upload an attachment. It is the ID of
227
- # the direct upload that was created when uploading the file to S3 via the
228
- # mediaDirectUpload mutation.
287
+ # @!attribute enabled
288
+ # An array of payment method identifiers that are explicitly enabled. This means
289
+ # these payment methods will be shown on checkout. Example use case is to only
290
+ # enable a specific payment method like cashapp, or extending the platform
291
+ # defaults with additional methods.
229
292
  #
230
- # @return [String, nil]
231
- optional :direct_upload_id, String, nil?: true
293
+ # @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
294
+ required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
232
295
 
233
- # @!method initialize(id: nil, direct_upload_id: nil)
296
+ # @!attribute include_platform_defaults
297
+ # Whether Whop's platform default payment method enablement settings are included
298
+ # in this configuration. The full list of default payment methods can be found in
299
+ # the documentation at docs.whop.com/payments.
300
+ #
301
+ # @return [Boolean]
302
+ required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
303
+
304
+ # @!method initialize(disabled:, enabled:, include_platform_defaults:)
234
305
  # Some parameter documentations has been truncated, see
235
- # {WhopSDK::Models::PlanUpdateParams::Image} for more details.
306
+ # {WhopSDK::Models::PlanUpdateParams::PaymentMethodConfiguration} for more
307
+ # details.
308
+ #
309
+ # The explicit payment method configuration for the plan. If sent as null, the
310
+ # custom configuration will be removed.
236
311
  #
237
- # An image for the plan. This will be visible on the product page to customers.
312
+ # @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
238
313
  #
239
- # @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
314
+ # @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
240
315
  #
241
- # @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
316
+ # @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
242
317
  end
243
318
  end
244
319
  end
@@ -155,7 +155,7 @@ module WhopSDK
155
155
  # Some parameter documentations has been truncated, see {WhopSDK::Models::Product}
156
156
  # for more details.
157
157
  #
158
- # An object representing a (sanitized) access pass.
158
+ # Represents a product on whop. Use products to sell anything on the platform.
159
159
  #
160
160
  # @param id [String] The internal ID of the public product.
161
161
  #
@@ -70,7 +70,7 @@ module WhopSDK
70
70
  optional :global_affiliate_percentage, Float, nil?: true
71
71
 
72
72
  # @!attribute global_affiliate_status
73
- # The different statuses of the global affiliate program for an access pass.
73
+ # The different statuses of the global affiliate program for a product.
74
74
  #
75
75
  # @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
76
76
  optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
@@ -94,7 +94,7 @@ module WhopSDK
94
94
  optional :member_affiliate_percentage, Float, nil?: true
95
95
 
96
96
  # @!attribute member_affiliate_status
97
- # The different statuses of the global affiliate program for an access pass.
97
+ # The different statuses of the global affiliate program for a product.
98
98
  #
99
99
  # @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
100
100
  optional :member_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
@@ -162,7 +162,7 @@ module WhopSDK
162
162
  #
163
163
  # @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
164
164
  #
165
- # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
165
+ # @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
166
166
  #
167
167
  # @param headline [String, nil] The headline of the product.
168
168
  #
@@ -170,7 +170,7 @@ module WhopSDK
170
170
  #
171
171
  # @param member_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the member affiliate program.
172
172
  #
173
- # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
173
+ # @param member_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for a product.
174
174
  #
175
175
  # @param plan_options [WhopSDK::Models::ProductCreateParams::PlanOptions, nil] The details to assign an autogenerated plan.
176
176
  #
@@ -216,7 +216,7 @@ module WhopSDK
216
216
  optional :initial_price, Float, nil?: true
217
217
 
218
218
  # @!attribute plan_type
219
- # The type of plan that can be attached to an access pass
219
+ # The type of plan that can be attached to a product
220
220
  #
221
221
  # @return [Symbol, WhopSDK::Models::PlanType, nil]
222
222
  optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
@@ -250,7 +250,7 @@ module WhopSDK
250
250
  #
251
251
  # @param initial_price [Float, nil] An additional amount charged upon first purchase.
252
252
  #
253
- # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
253
+ # @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to a product
254
254
  #
255
255
  # @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
256
256
  #
@@ -87,7 +87,7 @@ module WhopSDK
87
87
  # Some parameter documentations has been truncated, see
88
88
  # {WhopSDK::Models::ProductListItem} for more details.
89
89
  #
90
- # An object representing a (sanitized) access pass.
90
+ # Represents a product on whop. Use products to sell anything on the platform.
91
91
  #
92
92
  # @param id [String] The internal ID of the public product.
93
93
  #