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
@@ -19,12 +19,34 @@ module WhopSDK
19
19
  # @return [String]
20
20
  required :title, String
21
21
 
22
+ # @!attribute certificate_after_completion_enabled
23
+ # Whether the course will award its students a PDF certificate after completing
24
+ # all lessons
25
+ #
26
+ # @return [Boolean, nil]
27
+ optional :certificate_after_completion_enabled, WhopSDK::Internal::Type::Boolean, nil?: true
28
+
22
29
  # @!attribute cover_image
23
30
  # The cover image URL of the course
24
31
  #
25
32
  # @return [String, nil]
26
33
  optional :cover_image, String, nil?: true
27
34
 
35
+ # @!attribute order
36
+ # The decimal order position of the course within its experience. If not provided,
37
+ # it will be set to the next sequential order. Use fractional values (e.g., 1.5)
38
+ # to place between existing courses.
39
+ #
40
+ # @return [String, nil]
41
+ optional :order, String, nil?: true
42
+
43
+ # @!attribute require_completing_lessons_in_order
44
+ # Whether the course requires students to complete the previous lesson before
45
+ # moving on to the next one
46
+ #
47
+ # @return [Boolean, nil]
48
+ optional :require_completing_lessons_in_order, WhopSDK::Internal::Type::Boolean, nil?: true
49
+
28
50
  # @!attribute tagline
29
51
  # The tagline of the course
30
52
  #
@@ -34,48 +56,90 @@ module WhopSDK
34
56
  # @!attribute thumbnail
35
57
  # The thumbnail for the course in png, jpeg, or gif format
36
58
  #
37
- # @return [WhopSDK::Models::CourseCreateParams::Thumbnail, nil]
38
- optional :thumbnail, -> { WhopSDK::CourseCreateParams::Thumbnail }, nil?: true
59
+ # @return [WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil]
60
+ optional :thumbnail, union: -> { WhopSDK::CourseCreateParams::Thumbnail }, nil?: true
61
+
62
+ # @!attribute visibility
63
+ # The available visibilities for a course. Determines how / whether a course is
64
+ # visible to users.
65
+ #
66
+ # @return [Symbol, WhopSDK::Models::CourseVisibilities, nil]
67
+ optional :visibility, enum: -> { WhopSDK::CourseVisibilities }, nil?: true
39
68
 
40
- # @!method initialize(experience_id:, title:, cover_image: nil, tagline: nil, thumbnail: nil, request_options: {})
69
+ # @!method initialize(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, visibility: nil, request_options: {})
70
+ # Some parameter documentations has been truncated, see
71
+ # {WhopSDK::Models::CourseCreateParams} for more details.
72
+ #
41
73
  # @param experience_id [String] The ID of the experience to create the course in
42
74
  #
43
75
  # @param title [String] The title of the course
44
76
  #
77
+ # @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
78
+ #
45
79
  # @param cover_image [String, nil] The cover image URL of the course
46
80
  #
81
+ # @param order [String, nil] The decimal order position of the course within its experience. If not provided,
82
+ #
83
+ # @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
84
+ #
47
85
  # @param tagline [String, nil] The tagline of the course
48
86
  #
49
- # @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail, nil] The thumbnail for the course in png, jpeg, or gif format
87
+ # @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
88
+ #
89
+ # @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
50
90
  #
51
91
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
52
92
 
53
- class Thumbnail < WhopSDK::Internal::Type::BaseModel
54
- # @!attribute id
55
- # The ID of an existing attachment object. Use this when updating a resource and
56
- # keeping a subset of the attachments. Don't use this unless you know what you're
57
- # doing.
58
- #
59
- # @return [String, nil]
60
- optional :id, String, nil?: true
61
-
62
- # @!attribute direct_upload_id
63
- # This ID should be used the first time you upload an attachment. It is the ID of
64
- # the direct upload that was created when uploading the file to S3 via the
65
- # mediaDirectUpload mutation.
66
- #
67
- # @return [String, nil]
68
- optional :direct_upload_id, String, nil?: true
69
-
70
- # @!method initialize(id: nil, direct_upload_id: nil)
71
- # Some parameter documentations has been truncated, see
72
- # {WhopSDK::Models::CourseCreateParams::Thumbnail} for more details.
73
- #
74
- # The thumbnail for the course in png, jpeg, or gif format
75
- #
76
- # @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
77
- #
78
- # @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
93
+ # The thumbnail for the course in png, jpeg, or gif format
94
+ module Thumbnail
95
+ extend WhopSDK::Internal::Type::Union
96
+
97
+ # Input for an attachment
98
+ variant -> { WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID }
99
+
100
+ # Input for an attachment
101
+ variant -> { WhopSDK::CourseCreateParams::Thumbnail::AttachmentInputWithID }
102
+
103
+ class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
104
+ # @!attribute direct_upload_id
105
+ # This ID should be used the first time you upload an attachment. It is the ID of
106
+ # the direct upload that was created when uploading the file to S3 via the
107
+ # mediaDirectUpload mutation.
108
+ #
109
+ # @return [String]
110
+ required :direct_upload_id, String
111
+
112
+ # @!method initialize(direct_upload_id:)
113
+ # Some parameter documentations has been truncated, see
114
+ # {WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID}
115
+ # for more details.
116
+ #
117
+ # Input for an attachment
118
+ #
119
+ # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
120
+ end
121
+
122
+ class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
123
+ # @!attribute id
124
+ # The ID of an existing attachment object. Use this when updating a resource and
125
+ # keeping a subset of the attachments. Don't use this unless you know what you're
126
+ # doing.
127
+ #
128
+ # @return [String]
129
+ required :id, String
130
+
131
+ # @!method initialize(id:)
132
+ # Some parameter documentations has been truncated, see
133
+ # {WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID} for more
134
+ # details.
135
+ #
136
+ # Input for an attachment
137
+ #
138
+ # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
139
+ end
140
+
141
+ # @!method self.variants
142
+ # @return [Array(WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID)]
79
143
  end
80
144
  end
81
145
  end
@@ -31,13 +31,31 @@ module WhopSDK
31
31
  # @return [Integer, nil]
32
32
  optional :days_from_course_start_until_unlock, Integer, nil?: true
33
33
 
34
+ # @!attribute embed_id
35
+ # ID for the embed (YouTube video ID or Loom share ID)
36
+ #
37
+ # @return [String, nil]
38
+ optional :embed_id, String, nil?: true
39
+
40
+ # @!attribute embed_type
41
+ # The type of embed for a lesson
42
+ #
43
+ # @return [Symbol, WhopSDK::Models::EmbedType, nil]
44
+ optional :embed_type, enum: -> { WhopSDK::EmbedType }, nil?: true
45
+
46
+ # @!attribute thumbnail
47
+ # The thumbnail for the lesson in png, jpeg, or gif format
48
+ #
49
+ # @return [WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID, nil]
50
+ optional :thumbnail, union: -> { WhopSDK::CourseLessonCreateParams::Thumbnail }, nil?: true
51
+
34
52
  # @!attribute title
35
53
  # The title of the lesson
36
54
  #
37
55
  # @return [String, nil]
38
56
  optional :title, String, nil?: true
39
57
 
40
- # @!method initialize(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, title: nil, request_options: {})
58
+ # @!method initialize(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {})
41
59
  # @param chapter_id [String] The ID of the chapter to create the lesson in
42
60
  #
43
61
  # @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson
@@ -46,9 +64,67 @@ module WhopSDK
46
64
  #
47
65
  # @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
48
66
  #
67
+ # @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
68
+ #
69
+ # @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
70
+ #
71
+ # @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
72
+ #
49
73
  # @param title [String, nil] The title of the lesson
50
74
  #
51
75
  # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
76
+
77
+ # The thumbnail for the lesson in png, jpeg, or gif format
78
+ module Thumbnail
79
+ extend WhopSDK::Internal::Type::Union
80
+
81
+ # Input for an attachment
82
+ variant -> { WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID }
83
+
84
+ # Input for an attachment
85
+ variant -> { WhopSDK::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID }
86
+
87
+ class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
88
+ # @!attribute direct_upload_id
89
+ # This ID should be used the first time you upload an attachment. It is the ID of
90
+ # the direct upload that was created when uploading the file to S3 via the
91
+ # mediaDirectUpload mutation.
92
+ #
93
+ # @return [String]
94
+ required :direct_upload_id, String
95
+
96
+ # @!method initialize(direct_upload_id:)
97
+ # Some parameter documentations has been truncated, see
98
+ # {WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID}
99
+ # for more details.
100
+ #
101
+ # Input for an attachment
102
+ #
103
+ # @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
104
+ end
105
+
106
+ class AttachmentInputWithID < WhopSDK::Internal::Type::BaseModel
107
+ # @!attribute id
108
+ # The ID of an existing attachment object. Use this when updating a resource and
109
+ # keeping a subset of the attachments. Don't use this unless you know what you're
110
+ # doing.
111
+ #
112
+ # @return [String]
113
+ required :id, String
114
+
115
+ # @!method initialize(id:)
116
+ # Some parameter documentations has been truncated, see
117
+ # {WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID}
118
+ # for more details.
119
+ #
120
+ # Input for an attachment
121
+ #
122
+ # @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
123
+ end
124
+
125
+ # @!method self.variants
126
+ # @return [Array(WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID)]
127
+ end
52
128
  end
53
129
  end
54
130
  end
@@ -22,6 +22,18 @@ module WhopSDK
22
22
  # @return [Integer, nil]
23
23
  required :days_from_course_start_until_unlock, Integer, nil?: true
24
24
 
25
+ # @!attribute embed_id
26
+ # ID for the embed (YouTube video ID or Loom share ID)
27
+ #
28
+ # @return [String, nil]
29
+ required :embed_id, String, nil?: true
30
+
31
+ # @!attribute embed_type
32
+ # The type of embed for a lesson
33
+ #
34
+ # @return [Symbol, WhopSDK::Models::EmbedType, nil]
35
+ required :embed_type, enum: -> { WhopSDK::EmbedType }, nil?: true
36
+
25
37
  # @!attribute lesson_type
26
38
  # The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
27
39
  #
@@ -34,6 +46,12 @@ module WhopSDK
34
46
  # @return [Integer]
35
47
  required :order, Integer
36
48
 
49
+ # @!attribute thumbnail
50
+ # The thumbnail for the lesson
51
+ #
52
+ # @return [WhopSDK::Models::CourseLessonListResponse::Thumbnail, nil]
53
+ required :thumbnail, -> { WhopSDK::Models::CourseLessonListResponse::Thumbnail }, nil?: true
54
+
37
55
  # @!attribute title
38
56
  # The title of the lesson
39
57
  #
@@ -47,7 +65,7 @@ module WhopSDK
47
65
  # @return [Symbol, WhopSDK::Models::LessonVisibilities]
48
66
  required :visibility, enum: -> { WhopSDK::LessonVisibilities }
49
67
 
50
- # @!method initialize(id:, content:, days_from_course_start_until_unlock:, lesson_type:, order:, title:, visibility:)
68
+ # @!method initialize(id:, content:, days_from_course_start_until_unlock:, embed_id:, embed_type:, lesson_type:, order:, thumbnail:, title:, visibility:)
51
69
  # Some parameter documentations has been truncated, see
52
70
  # {WhopSDK::Models::CourseLessonListResponse} for more details.
53
71
  #
@@ -59,13 +77,37 @@ module WhopSDK
59
77
  #
60
78
  # @param days_from_course_start_until_unlock [Integer, nil] Number of days from course start until the lesson is unlocked
61
79
  #
80
+ # @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
81
+ #
82
+ # @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
83
+ #
62
84
  # @param lesson_type [Symbol, WhopSDK::Models::LessonTypes] The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
63
85
  #
64
86
  # @param order [Integer] The order of the lesson within its chapter
65
87
  #
88
+ # @param thumbnail [WhopSDK::Models::CourseLessonListResponse::Thumbnail, nil] The thumbnail for the lesson
89
+ #
66
90
  # @param title [String] The title of the lesson
67
91
  #
68
92
  # @param visibility [Symbol, WhopSDK::Models::LessonVisibilities] The visibility of the lesson. Determines how / whether this lesson is visible to
93
+
94
+ # @see WhopSDK::Models::CourseLessonListResponse#thumbnail
95
+ class Thumbnail < WhopSDK::Internal::Type::BaseModel
96
+ # @!attribute url
97
+ # This is the URL you use to render optimized attachments on the client. This
98
+ # should be used for apps.
99
+ #
100
+ # @return [String, nil]
101
+ required :url, String, nil?: true
102
+
103
+ # @!method initialize(url:)
104
+ # Some parameter documentations has been truncated, see
105
+ # {WhopSDK::Models::CourseLessonListResponse::Thumbnail} for more details.
106
+ #
107
+ # The thumbnail for the lesson
108
+ #
109
+ # @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
110
+ end
69
111
  end
70
112
  end
71
113
  end