whop-sdk 0.0.10__py3-none-any.whl

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 (352) hide show
  1. whop_sdk/__init__.py +94 -0
  2. whop_sdk/_base_client.py +1995 -0
  3. whop_sdk/_client.py +800 -0
  4. whop_sdk/_compat.py +219 -0
  5. whop_sdk/_constants.py +14 -0
  6. whop_sdk/_exceptions.py +112 -0
  7. whop_sdk/_files.py +123 -0
  8. whop_sdk/_models.py +857 -0
  9. whop_sdk/_qs.py +150 -0
  10. whop_sdk/_resource.py +43 -0
  11. whop_sdk/_response.py +830 -0
  12. whop_sdk/_streaming.py +333 -0
  13. whop_sdk/_types.py +260 -0
  14. whop_sdk/_utils/__init__.py +64 -0
  15. whop_sdk/_utils/_compat.py +45 -0
  16. whop_sdk/_utils/_datetime_parse.py +136 -0
  17. whop_sdk/_utils/_logs.py +25 -0
  18. whop_sdk/_utils/_proxy.py +65 -0
  19. whop_sdk/_utils/_reflection.py +42 -0
  20. whop_sdk/_utils/_resources_proxy.py +24 -0
  21. whop_sdk/_utils/_streams.py +12 -0
  22. whop_sdk/_utils/_sync.py +58 -0
  23. whop_sdk/_utils/_transform.py +457 -0
  24. whop_sdk/_utils/_typing.py +156 -0
  25. whop_sdk/_utils/_utils.py +421 -0
  26. whop_sdk/_version.py +4 -0
  27. whop_sdk/lib/.keep +4 -0
  28. whop_sdk/pagination.py +61 -0
  29. whop_sdk/py.typed +0 -0
  30. whop_sdk/resources/__init__.py +540 -0
  31. whop_sdk/resources/access_tokens.py +341 -0
  32. whop_sdk/resources/account_links.py +211 -0
  33. whop_sdk/resources/app_builds.py +587 -0
  34. whop_sdk/resources/apps.py +684 -0
  35. whop_sdk/resources/authorized_users.py +353 -0
  36. whop_sdk/resources/chat_channels.py +469 -0
  37. whop_sdk/resources/checkout_configurations.py +776 -0
  38. whop_sdk/resources/companies.py +465 -0
  39. whop_sdk/resources/course_chapters.py +602 -0
  40. whop_sdk/resources/course_lesson_interactions.py +343 -0
  41. whop_sdk/resources/course_lessons.py +1040 -0
  42. whop_sdk/resources/course_students.py +327 -0
  43. whop_sdk/resources/courses.py +776 -0
  44. whop_sdk/resources/disputes.py +693 -0
  45. whop_sdk/resources/entries.py +556 -0
  46. whop_sdk/resources/experiences.py +983 -0
  47. whop_sdk/resources/forum_posts.py +656 -0
  48. whop_sdk/resources/forums.py +446 -0
  49. whop_sdk/resources/invoices.py +1099 -0
  50. whop_sdk/resources/ledger_accounts.py +171 -0
  51. whop_sdk/resources/members.py +429 -0
  52. whop_sdk/resources/memberships.py +818 -0
  53. whop_sdk/resources/messages.py +558 -0
  54. whop_sdk/resources/notifications.py +388 -0
  55. whop_sdk/resources/payment_tokens.py +359 -0
  56. whop_sdk/resources/payments.py +1040 -0
  57. whop_sdk/resources/plans.py +1001 -0
  58. whop_sdk/resources/products.py +970 -0
  59. whop_sdk/resources/promo_codes.py +668 -0
  60. whop_sdk/resources/reactions.py +423 -0
  61. whop_sdk/resources/refunds.py +347 -0
  62. whop_sdk/resources/reviews.py +332 -0
  63. whop_sdk/resources/setup_intents.py +349 -0
  64. whop_sdk/resources/shipments.py +451 -0
  65. whop_sdk/resources/support_channels.py +455 -0
  66. whop_sdk/resources/transfers.py +513 -0
  67. whop_sdk/resources/users.py +248 -0
  68. whop_sdk/resources/webhooks.py +69 -0
  69. whop_sdk/resources/withdrawals.py +341 -0
  70. whop_sdk/types/__init__.py +262 -0
  71. whop_sdk/types/access_token_create_params.py +64 -0
  72. whop_sdk/types/access_token_create_response.py +15 -0
  73. whop_sdk/types/account_link_create_params.py +27 -0
  74. whop_sdk/types/account_link_create_response.py +15 -0
  75. whop_sdk/types/app_build_create_params.py +72 -0
  76. whop_sdk/types/app_build_list_params.py +42 -0
  77. whop_sdk/types/app_build_list_response.py +50 -0
  78. whop_sdk/types/app_create_params.py +19 -0
  79. whop_sdk/types/app_list_params.py +59 -0
  80. whop_sdk/types/app_list_response.py +110 -0
  81. whop_sdk/types/app_type.py +7 -0
  82. whop_sdk/types/app_update_params.py +67 -0
  83. whop_sdk/types/assessment_question_types.py +7 -0
  84. whop_sdk/types/authorized_user_list_params.py +41 -0
  85. whop_sdk/types/authorized_user_list_response.py +33 -0
  86. whop_sdk/types/authorized_user_retrieve_response.py +33 -0
  87. whop_sdk/types/billing_reasons.py +9 -0
  88. whop_sdk/types/card_brands.py +25 -0
  89. whop_sdk/types/chat_channel_list_params.py +28 -0
  90. whop_sdk/types/chat_channel_list_response.py +43 -0
  91. whop_sdk/types/chat_channel_update_params.py +32 -0
  92. whop_sdk/types/checkout_configuration_create_params.py +373 -0
  93. whop_sdk/types/checkout_configuration_list_params.py +41 -0
  94. whop_sdk/types/checkout_configuration_list_response.py +104 -0
  95. whop_sdk/types/checkout_modes.py +7 -0
  96. whop_sdk/types/company_create_params.py +22 -0
  97. whop_sdk/types/company_list_params.py +38 -0
  98. whop_sdk/types/company_list_response.py +76 -0
  99. whop_sdk/types/course.py +122 -0
  100. whop_sdk/types/course_chapter.py +32 -0
  101. whop_sdk/types/course_chapter_create_params.py +16 -0
  102. whop_sdk/types/course_chapter_delete_response.py +7 -0
  103. whop_sdk/types/course_chapter_list_params.py +25 -0
  104. whop_sdk/types/course_chapter_list_response.py +16 -0
  105. whop_sdk/types/course_chapter_update_params.py +12 -0
  106. whop_sdk/types/course_create_params.py +78 -0
  107. whop_sdk/types/course_delete_response.py +7 -0
  108. whop_sdk/types/course_lesson_create_params.py +63 -0
  109. whop_sdk/types/course_lesson_delete_response.py +7 -0
  110. whop_sdk/types/course_lesson_interaction_completed_webhook_event.py +26 -0
  111. whop_sdk/types/course_lesson_interaction_list_params.py +34 -0
  112. whop_sdk/types/course_lesson_list_params.py +28 -0
  113. whop_sdk/types/course_lesson_list_response.py +57 -0
  114. whop_sdk/types/course_lesson_mark_as_completed_response.py +7 -0
  115. whop_sdk/types/course_lesson_start_response.py +7 -0
  116. whop_sdk/types/course_lesson_submit_assessment_params.py +26 -0
  117. whop_sdk/types/course_lesson_submit_assessment_response.py +62 -0
  118. whop_sdk/types/course_lesson_update_params.py +222 -0
  119. whop_sdk/types/course_list_params.py +28 -0
  120. whop_sdk/types/course_list_response.py +90 -0
  121. whop_sdk/types/course_student_list_params.py +28 -0
  122. whop_sdk/types/course_student_list_response.py +42 -0
  123. whop_sdk/types/course_student_retrieve_response.py +61 -0
  124. whop_sdk/types/course_update_params.py +114 -0
  125. whop_sdk/types/course_visibilities.py +7 -0
  126. whop_sdk/types/dispute.py +284 -0
  127. whop_sdk/types/dispute_created_webhook_event.py +26 -0
  128. whop_sdk/types/dispute_list_params.py +38 -0
  129. whop_sdk/types/dispute_list_response.py +77 -0
  130. whop_sdk/types/dispute_statuses.py +17 -0
  131. whop_sdk/types/dispute_update_evidence_params.py +159 -0
  132. whop_sdk/types/dispute_updated_webhook_event.py +26 -0
  133. whop_sdk/types/embed_type.py +7 -0
  134. whop_sdk/types/entry_approve_response.py +10 -0
  135. whop_sdk/types/entry_approved_webhook_event.py +26 -0
  136. whop_sdk/types/entry_created_webhook_event.py +26 -0
  137. whop_sdk/types/entry_deleted_webhook_event.py +26 -0
  138. whop_sdk/types/entry_denied_webhook_event.py +26 -0
  139. whop_sdk/types/entry_list_params.py +52 -0
  140. whop_sdk/types/entry_list_response.py +56 -0
  141. whop_sdk/types/experience_attach_params.py +12 -0
  142. whop_sdk/types/experience_create_params.py +22 -0
  143. whop_sdk/types/experience_delete_response.py +7 -0
  144. whop_sdk/types/experience_detach_params.py +12 -0
  145. whop_sdk/types/experience_duplicate_params.py +13 -0
  146. whop_sdk/types/experience_list_params.py +40 -0
  147. whop_sdk/types/experience_list_response.py +73 -0
  148. whop_sdk/types/experience_update_params.py +46 -0
  149. whop_sdk/types/forum_list_params.py +28 -0
  150. whop_sdk/types/forum_list_response.py +33 -0
  151. whop_sdk/types/forum_post_create_params.py +101 -0
  152. whop_sdk/types/forum_post_list_params.py +31 -0
  153. whop_sdk/types/forum_post_list_response.py +60 -0
  154. whop_sdk/types/forum_post_update_params.py +56 -0
  155. whop_sdk/types/forum_post_visibility_type.py +7 -0
  156. whop_sdk/types/forum_update_params.py +23 -0
  157. whop_sdk/types/invoice_create_params.py +515 -0
  158. whop_sdk/types/invoice_created_webhook_event.py +26 -0
  159. whop_sdk/types/invoice_list_params.py +53 -0
  160. whop_sdk/types/invoice_paid_webhook_event.py +26 -0
  161. whop_sdk/types/invoice_past_due_webhook_event.py +26 -0
  162. whop_sdk/types/invoice_void_response.py +7 -0
  163. whop_sdk/types/invoice_voided_webhook_event.py +26 -0
  164. whop_sdk/types/languages.py +30 -0
  165. whop_sdk/types/ledger_account_retrieve_response.py +93 -0
  166. whop_sdk/types/lesson.py +219 -0
  167. whop_sdk/types/lesson_types.py +7 -0
  168. whop_sdk/types/lesson_visibilities.py +7 -0
  169. whop_sdk/types/member_list_params.py +73 -0
  170. whop_sdk/types/member_list_response.py +65 -0
  171. whop_sdk/types/member_retrieve_response.py +79 -0
  172. whop_sdk/types/membership_activated_webhook_event.py +29 -0
  173. whop_sdk/types/membership_cancel_params.py +13 -0
  174. whop_sdk/types/membership_deactivated_webhook_event.py +29 -0
  175. whop_sdk/types/membership_list_params.py +73 -0
  176. whop_sdk/types/membership_list_response.py +128 -0
  177. whop_sdk/types/membership_pause_params.py +16 -0
  178. whop_sdk/types/membership_update_params.py +13 -0
  179. whop_sdk/types/message_create_params.py +63 -0
  180. whop_sdk/types/message_list_params.py +30 -0
  181. whop_sdk/types/message_list_response.py +90 -0
  182. whop_sdk/types/message_update_params.py +45 -0
  183. whop_sdk/types/notification_create_params.py +93 -0
  184. whop_sdk/types/notification_create_response.py +10 -0
  185. whop_sdk/types/payment_create_params.py +162 -0
  186. whop_sdk/types/payment_failed_webhook_event.py +26 -0
  187. whop_sdk/types/payment_list_params.py +67 -0
  188. whop_sdk/types/payment_list_response.py +273 -0
  189. whop_sdk/types/payment_method_types.py +94 -0
  190. whop_sdk/types/payment_pending_webhook_event.py +26 -0
  191. whop_sdk/types/payment_provider.py +9 -0
  192. whop_sdk/types/payment_refund_params.py +13 -0
  193. whop_sdk/types/payment_succeeded_webhook_event.py +26 -0
  194. whop_sdk/types/payment_token_list_params.py +38 -0
  195. whop_sdk/types/payment_token_list_response.py +41 -0
  196. whop_sdk/types/payment_token_retrieve_params.py +12 -0
  197. whop_sdk/types/payment_token_retrieve_response.py +41 -0
  198. whop_sdk/types/plan_create_params.py +162 -0
  199. whop_sdk/types/plan_delete_response.py +7 -0
  200. whop_sdk/types/plan_list_params.py +57 -0
  201. whop_sdk/types/plan_list_response.py +128 -0
  202. whop_sdk/types/plan_update_params.py +155 -0
  203. whop_sdk/types/product_create_params.py +147 -0
  204. whop_sdk/types/product_delete_response.py +7 -0
  205. whop_sdk/types/product_list_params.py +49 -0
  206. whop_sdk/types/product_update_params.py +82 -0
  207. whop_sdk/types/promo_code.py +90 -0
  208. whop_sdk/types/promo_code_create_params.py +70 -0
  209. whop_sdk/types/promo_code_delete_response.py +7 -0
  210. whop_sdk/types/promo_code_list_params.py +45 -0
  211. whop_sdk/types/promo_code_list_response.py +79 -0
  212. whop_sdk/types/promo_code_status.py +7 -0
  213. whop_sdk/types/promo_duration.py +7 -0
  214. whop_sdk/types/reaction_create_params.py +19 -0
  215. whop_sdk/types/reaction_list_params.py +25 -0
  216. whop_sdk/types/reaction_list_response.py +32 -0
  217. whop_sdk/types/refund_created_webhook_event.py +154 -0
  218. whop_sdk/types/refund_list_params.py +38 -0
  219. whop_sdk/types/refund_list_response.py +53 -0
  220. whop_sdk/types/refund_reference_status.py +7 -0
  221. whop_sdk/types/refund_reference_type.py +9 -0
  222. whop_sdk/types/refund_retrieve_response.py +129 -0
  223. whop_sdk/types/refund_status.py +7 -0
  224. whop_sdk/types/refund_updated_webhook_event.py +154 -0
  225. whop_sdk/types/review_list_params.py +40 -0
  226. whop_sdk/types/review_list_response.py +78 -0
  227. whop_sdk/types/review_retrieve_response.py +103 -0
  228. whop_sdk/types/review_status.py +7 -0
  229. whop_sdk/types/setup_intent.py +111 -0
  230. whop_sdk/types/setup_intent_canceled_webhook_event.py +29 -0
  231. whop_sdk/types/setup_intent_list_params.py +38 -0
  232. whop_sdk/types/setup_intent_list_response.py +111 -0
  233. whop_sdk/types/setup_intent_requires_action_webhook_event.py +29 -0
  234. whop_sdk/types/setup_intent_status.py +7 -0
  235. whop_sdk/types/setup_intent_succeeded_webhook_event.py +29 -0
  236. whop_sdk/types/shared/__init__.py +62 -0
  237. whop_sdk/types/shared/access_level.py +7 -0
  238. whop_sdk/types/shared/access_pass_type.py +7 -0
  239. whop_sdk/types/shared/app.py +187 -0
  240. whop_sdk/types/shared/app_build.py +50 -0
  241. whop_sdk/types/shared/app_build_platforms.py +7 -0
  242. whop_sdk/types/shared/app_build_statuses.py +7 -0
  243. whop_sdk/types/shared/app_statuses.py +7 -0
  244. whop_sdk/types/shared/app_view_type.py +7 -0
  245. whop_sdk/types/shared/authorized_user_roles.py +9 -0
  246. whop_sdk/types/shared/business_types.py +22 -0
  247. whop_sdk/types/shared/chat_channel.py +43 -0
  248. whop_sdk/types/shared/checkout_configuration.py +104 -0
  249. whop_sdk/types/shared/collection_method.py +7 -0
  250. whop_sdk/types/shared/company.py +91 -0
  251. whop_sdk/types/shared/course_lesson_interaction.py +63 -0
  252. whop_sdk/types/shared/course_lesson_interaction_list_item.py +44 -0
  253. whop_sdk/types/shared/currency.py +93 -0
  254. whop_sdk/types/shared/custom_cta.py +21 -0
  255. whop_sdk/types/shared/direction.py +7 -0
  256. whop_sdk/types/shared/dms_post_types.py +7 -0
  257. whop_sdk/types/shared/email_notification_preferences.py +7 -0
  258. whop_sdk/types/shared/entry.py +70 -0
  259. whop_sdk/types/shared/entry_status.py +7 -0
  260. whop_sdk/types/shared/experience.py +91 -0
  261. whop_sdk/types/shared/forum.py +33 -0
  262. whop_sdk/types/shared/forum_post.py +60 -0
  263. whop_sdk/types/shared/friendly_receipt_status.py +24 -0
  264. whop_sdk/types/shared/global_affiliate_status.py +7 -0
  265. whop_sdk/types/shared/industry_types.py +67 -0
  266. whop_sdk/types/shared/invoice.py +64 -0
  267. whop_sdk/types/shared/invoice_list_item.py +64 -0
  268. whop_sdk/types/shared/invoice_status.py +7 -0
  269. whop_sdk/types/shared/member_most_recent_actions.py +22 -0
  270. whop_sdk/types/shared/member_statuses.py +7 -0
  271. whop_sdk/types/shared/membership.py +128 -0
  272. whop_sdk/types/shared/membership_status.py +9 -0
  273. whop_sdk/types/shared/message.py +90 -0
  274. whop_sdk/types/shared/page_info.py +21 -0
  275. whop_sdk/types/shared/payment.py +273 -0
  276. whop_sdk/types/shared/plan.py +159 -0
  277. whop_sdk/types/shared/plan_type.py +7 -0
  278. whop_sdk/types/shared/product.py +132 -0
  279. whop_sdk/types/shared/product_list_item.py +57 -0
  280. whop_sdk/types/shared/promo_type.py +7 -0
  281. whop_sdk/types/shared/reaction.py +32 -0
  282. whop_sdk/types/shared/receipt_status.py +7 -0
  283. whop_sdk/types/shared/release_method.py +7 -0
  284. whop_sdk/types/shared/shipment.py +48 -0
  285. whop_sdk/types/shared/shipment_carrier.py +84 -0
  286. whop_sdk/types/shared/shipment_status.py +18 -0
  287. whop_sdk/types/shared/shipment_substatus.py +36 -0
  288. whop_sdk/types/shared/support_channel.py +39 -0
  289. whop_sdk/types/shared/tax_type.py +7 -0
  290. whop_sdk/types/shared/transfer.py +112 -0
  291. whop_sdk/types/shared/visibility.py +7 -0
  292. whop_sdk/types/shared/visibility_filter.py +9 -0
  293. whop_sdk/types/shared/who_can_comment_types.py +7 -0
  294. whop_sdk/types/shared/who_can_post.py +7 -0
  295. whop_sdk/types/shared/who_can_post_types.py +7 -0
  296. whop_sdk/types/shared/who_can_react.py +7 -0
  297. whop_sdk/types/shared_params/__init__.py +34 -0
  298. whop_sdk/types/shared_params/access_level.py +9 -0
  299. whop_sdk/types/shared_params/access_pass_type.py +9 -0
  300. whop_sdk/types/shared_params/app_build_platforms.py +9 -0
  301. whop_sdk/types/shared_params/app_build_statuses.py +9 -0
  302. whop_sdk/types/shared_params/app_statuses.py +9 -0
  303. whop_sdk/types/shared_params/app_view_type.py +9 -0
  304. whop_sdk/types/shared_params/authorized_user_roles.py +11 -0
  305. whop_sdk/types/shared_params/business_types.py +24 -0
  306. whop_sdk/types/shared_params/collection_method.py +9 -0
  307. whop_sdk/types/shared_params/currency.py +95 -0
  308. whop_sdk/types/shared_params/custom_cta.py +23 -0
  309. whop_sdk/types/shared_params/direction.py +9 -0
  310. whop_sdk/types/shared_params/email_notification_preferences.py +9 -0
  311. whop_sdk/types/shared_params/entry_status.py +9 -0
  312. whop_sdk/types/shared_params/friendly_receipt_status.py +26 -0
  313. whop_sdk/types/shared_params/global_affiliate_status.py +9 -0
  314. whop_sdk/types/shared_params/industry_types.py +69 -0
  315. whop_sdk/types/shared_params/invoice_status.py +9 -0
  316. whop_sdk/types/shared_params/member_most_recent_actions.py +24 -0
  317. whop_sdk/types/shared_params/member_statuses.py +9 -0
  318. whop_sdk/types/shared_params/membership_status.py +11 -0
  319. whop_sdk/types/shared_params/plan_type.py +9 -0
  320. whop_sdk/types/shared_params/promo_type.py +9 -0
  321. whop_sdk/types/shared_params/receipt_status.py +9 -0
  322. whop_sdk/types/shared_params/release_method.py +9 -0
  323. whop_sdk/types/shared_params/tax_type.py +9 -0
  324. whop_sdk/types/shared_params/visibility.py +9 -0
  325. whop_sdk/types/shared_params/visibility_filter.py +11 -0
  326. whop_sdk/types/shared_params/who_can_comment_types.py +9 -0
  327. whop_sdk/types/shared_params/who_can_post.py +9 -0
  328. whop_sdk/types/shared_params/who_can_post_types.py +9 -0
  329. whop_sdk/types/shared_params/who_can_react.py +9 -0
  330. whop_sdk/types/shipment_create_params.py +18 -0
  331. whop_sdk/types/shipment_list_params.py +31 -0
  332. whop_sdk/types/shipment_list_response.py +48 -0
  333. whop_sdk/types/support_channel_create_params.py +15 -0
  334. whop_sdk/types/support_channel_list_params.py +40 -0
  335. whop_sdk/types/support_channel_list_response.py +39 -0
  336. whop_sdk/types/transfer_create_params.py +39 -0
  337. whop_sdk/types/transfer_list_params.py +50 -0
  338. whop_sdk/types/transfer_list_response.py +38 -0
  339. whop_sdk/types/unwrap_webhook_event.py +52 -0
  340. whop_sdk/types/user_check_access_response.py +14 -0
  341. whop_sdk/types/user_retrieve_response.py +36 -0
  342. whop_sdk/types/withdrawal_fee_types.py +7 -0
  343. whop_sdk/types/withdrawal_list_params.py +38 -0
  344. whop_sdk/types/withdrawal_list_response.py +45 -0
  345. whop_sdk/types/withdrawal_retrieve_response.py +154 -0
  346. whop_sdk/types/withdrawal_speeds.py +7 -0
  347. whop_sdk/types/withdrawal_status.py +9 -0
  348. whop_sdk/types/withdrawal_types.py +7 -0
  349. whop_sdk-0.0.10.dist-info/METADATA +509 -0
  350. whop_sdk-0.0.10.dist-info/RECORD +352 -0
  351. whop_sdk-0.0.10.dist-info/WHEEL +4 -0
  352. whop_sdk-0.0.10.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,1040 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ from typing import Iterable, Optional
6
+
7
+ import httpx
8
+
9
+ from ..types import (
10
+ EmbedType,
11
+ LessonTypes,
12
+ LessonVisibilities,
13
+ course_lesson_list_params,
14
+ course_lesson_create_params,
15
+ course_lesson_update_params,
16
+ course_lesson_submit_assessment_params,
17
+ )
18
+ from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
19
+ from .._utils import maybe_transform, async_maybe_transform
20
+ from .._compat import cached_property
21
+ from .._resource import SyncAPIResource, AsyncAPIResource
22
+ from .._response import (
23
+ to_raw_response_wrapper,
24
+ to_streamed_response_wrapper,
25
+ async_to_raw_response_wrapper,
26
+ async_to_streamed_response_wrapper,
27
+ )
28
+ from ..pagination import SyncCursorPage, AsyncCursorPage
29
+ from .._base_client import AsyncPaginator, make_request_options
30
+ from ..types.lesson import Lesson
31
+ from ..types.embed_type import EmbedType
32
+ from ..types.lesson_types import LessonTypes
33
+ from ..types.lesson_visibilities import LessonVisibilities
34
+ from ..types.course_lesson_list_response import CourseLessonListResponse
35
+ from ..types.course_lesson_start_response import CourseLessonStartResponse
36
+ from ..types.course_lesson_delete_response import CourseLessonDeleteResponse
37
+ from ..types.course_lesson_mark_as_completed_response import CourseLessonMarkAsCompletedResponse
38
+ from ..types.course_lesson_submit_assessment_response import CourseLessonSubmitAssessmentResponse
39
+
40
+ __all__ = ["CourseLessonsResource", "AsyncCourseLessonsResource"]
41
+
42
+
43
+ class CourseLessonsResource(SyncAPIResource):
44
+ @cached_property
45
+ def with_raw_response(self) -> CourseLessonsResourceWithRawResponse:
46
+ """
47
+ This property can be used as a prefix for any HTTP method call to return
48
+ the raw response object instead of the parsed content.
49
+
50
+ For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
51
+ """
52
+ return CourseLessonsResourceWithRawResponse(self)
53
+
54
+ @cached_property
55
+ def with_streaming_response(self) -> CourseLessonsResourceWithStreamingResponse:
56
+ """
57
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
58
+
59
+ For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
60
+ """
61
+ return CourseLessonsResourceWithStreamingResponse(self)
62
+
63
+ def create(
64
+ self,
65
+ *,
66
+ chapter_id: str,
67
+ lesson_type: LessonTypes,
68
+ content: Optional[str] | Omit = omit,
69
+ days_from_course_start_until_unlock: Optional[int] | Omit = omit,
70
+ embed_id: Optional[str] | Omit = omit,
71
+ embed_type: Optional[EmbedType] | Omit = omit,
72
+ thumbnail: Optional[course_lesson_create_params.Thumbnail] | Omit = omit,
73
+ title: Optional[str] | Omit = omit,
74
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
75
+ # The extra values given here take precedence over values defined on the client or passed to this method.
76
+ extra_headers: Headers | None = None,
77
+ extra_query: Query | None = None,
78
+ extra_body: Body | None = None,
79
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
80
+ ) -> Lesson:
81
+ """
82
+ Creates a new course lesson
83
+
84
+ Required permissions:
85
+
86
+ - `courses:update`
87
+
88
+ Args:
89
+ chapter_id: The ID of the chapter to create the lesson in
90
+
91
+ lesson_type: The type of the lesson
92
+
93
+ content: The content of the lesson
94
+
95
+ days_from_course_start_until_unlock: Days from course start until unlock
96
+
97
+ embed_id: ID for the embed (YouTube video ID or Loom share ID)
98
+
99
+ embed_type: The type of embed for a lesson
100
+
101
+ thumbnail: The thumbnail for the lesson in png, jpeg, or gif format
102
+
103
+ title: The title of the lesson
104
+
105
+ extra_headers: Send extra headers
106
+
107
+ extra_query: Add additional query parameters to the request
108
+
109
+ extra_body: Add additional JSON properties to the request
110
+
111
+ timeout: Override the client-level default timeout for this request, in seconds
112
+ """
113
+ return self._post(
114
+ "/course_lessons",
115
+ body=maybe_transform(
116
+ {
117
+ "chapter_id": chapter_id,
118
+ "lesson_type": lesson_type,
119
+ "content": content,
120
+ "days_from_course_start_until_unlock": days_from_course_start_until_unlock,
121
+ "embed_id": embed_id,
122
+ "embed_type": embed_type,
123
+ "thumbnail": thumbnail,
124
+ "title": title,
125
+ },
126
+ course_lesson_create_params.CourseLessonCreateParams,
127
+ ),
128
+ options=make_request_options(
129
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
130
+ ),
131
+ cast_to=Lesson,
132
+ )
133
+
134
+ def retrieve(
135
+ self,
136
+ id: str,
137
+ *,
138
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
139
+ # The extra values given here take precedence over values defined on the client or passed to this method.
140
+ extra_headers: Headers | None = None,
141
+ extra_query: Query | None = None,
142
+ extra_body: Body | None = None,
143
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
144
+ ) -> Lesson:
145
+ """
146
+ Retrieves a course lesson by ID
147
+
148
+ Required permissions:
149
+
150
+ - `courses:read`
151
+
152
+ Args:
153
+ extra_headers: Send extra headers
154
+
155
+ extra_query: Add additional query parameters to the request
156
+
157
+ extra_body: Add additional JSON properties to the request
158
+
159
+ timeout: Override the client-level default timeout for this request, in seconds
160
+ """
161
+ if not id:
162
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
163
+ return self._get(
164
+ f"/course_lessons/{id}",
165
+ options=make_request_options(
166
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
167
+ ),
168
+ cast_to=Lesson,
169
+ )
170
+
171
+ def update(
172
+ self,
173
+ id: str,
174
+ *,
175
+ assessment_completion_requirement: Optional[course_lesson_update_params.AssessmentCompletionRequirement]
176
+ | Omit = omit,
177
+ assessment_questions: Optional[Iterable[course_lesson_update_params.AssessmentQuestion]] | Omit = omit,
178
+ attachments: Optional[Iterable[course_lesson_update_params.Attachment]] | Omit = omit,
179
+ content: Optional[str] | Omit = omit,
180
+ days_from_course_start_until_unlock: Optional[int] | Omit = omit,
181
+ embed_id: Optional[str] | Omit = omit,
182
+ embed_type: Optional[EmbedType] | Omit = omit,
183
+ lesson_type: Optional[LessonTypes] | Omit = omit,
184
+ main_pdf: Optional[course_lesson_update_params.MainPdf] | Omit = omit,
185
+ max_attempts: Optional[int] | Omit = omit,
186
+ mux_asset_id: Optional[str] | Omit = omit,
187
+ thumbnail: Optional[course_lesson_update_params.Thumbnail] | Omit = omit,
188
+ title: Optional[str] | Omit = omit,
189
+ visibility: Optional[LessonVisibilities] | Omit = omit,
190
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
191
+ # The extra values given here take precedence over values defined on the client or passed to this method.
192
+ extra_headers: Headers | None = None,
193
+ extra_query: Query | None = None,
194
+ extra_body: Body | None = None,
195
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
196
+ ) -> Lesson:
197
+ """
198
+ Updates a course lesson
199
+
200
+ Required permissions:
201
+
202
+ - `courses:update`
203
+
204
+ Args:
205
+ assessment_completion_requirement: Completion requirements for quiz/knowledge check lessons
206
+
207
+ assessment_questions: Assessment questions for quiz/knowledge check lessons. Replaces all existing
208
+ questions.
209
+
210
+ attachments: General attachments for the lesson (PDFs, files, etc). Replaces all existing
211
+ attachments.
212
+
213
+ content: The content of the lesson
214
+
215
+ days_from_course_start_until_unlock: Days from course start until unlock
216
+
217
+ embed_id: ID for the embed (YouTube video ID or Loom share ID)
218
+
219
+ embed_type: The type of embed for a lesson
220
+
221
+ lesson_type: The available types for a lesson
222
+
223
+ main_pdf: The main PDF file for this lesson
224
+
225
+ max_attempts: Maximum number of attempts allowed for assessments
226
+
227
+ mux_asset_id: The ID of the Mux asset to attach to this lesson for video lessons
228
+
229
+ thumbnail: The thumbnail for the lesson in png, jpeg, or gif format
230
+
231
+ title: The title of the lesson
232
+
233
+ visibility: The available visibilities for a lesson. Determines how / whether a lesson is
234
+ visible to users.
235
+
236
+ extra_headers: Send extra headers
237
+
238
+ extra_query: Add additional query parameters to the request
239
+
240
+ extra_body: Add additional JSON properties to the request
241
+
242
+ timeout: Override the client-level default timeout for this request, in seconds
243
+ """
244
+ if not id:
245
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
246
+ return self._patch(
247
+ f"/course_lessons/{id}",
248
+ body=maybe_transform(
249
+ {
250
+ "assessment_completion_requirement": assessment_completion_requirement,
251
+ "assessment_questions": assessment_questions,
252
+ "attachments": attachments,
253
+ "content": content,
254
+ "days_from_course_start_until_unlock": days_from_course_start_until_unlock,
255
+ "embed_id": embed_id,
256
+ "embed_type": embed_type,
257
+ "lesson_type": lesson_type,
258
+ "main_pdf": main_pdf,
259
+ "max_attempts": max_attempts,
260
+ "mux_asset_id": mux_asset_id,
261
+ "thumbnail": thumbnail,
262
+ "title": title,
263
+ "visibility": visibility,
264
+ },
265
+ course_lesson_update_params.CourseLessonUpdateParams,
266
+ ),
267
+ options=make_request_options(
268
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
269
+ ),
270
+ cast_to=Lesson,
271
+ )
272
+
273
+ def list(
274
+ self,
275
+ *,
276
+ after: Optional[str] | Omit = omit,
277
+ before: Optional[str] | Omit = omit,
278
+ chapter_id: Optional[str] | Omit = omit,
279
+ course_id: Optional[str] | Omit = omit,
280
+ first: Optional[int] | Omit = omit,
281
+ last: Optional[int] | Omit = omit,
282
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
283
+ # The extra values given here take precedence over values defined on the client or passed to this method.
284
+ extra_headers: Headers | None = None,
285
+ extra_query: Query | None = None,
286
+ extra_body: Body | None = None,
287
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
288
+ ) -> SyncCursorPage[CourseLessonListResponse]:
289
+ """
290
+ Lists lessons for a course or chapter
291
+
292
+ Required permissions:
293
+
294
+ - `courses:read`
295
+
296
+ Args:
297
+ after: Returns the elements in the list that come after the specified cursor.
298
+
299
+ before: Returns the elements in the list that come before the specified cursor.
300
+
301
+ chapter_id: The ID of the chapter (returns lessons only for this chapter)
302
+
303
+ course_id: The ID of the course (returns all lessons across all chapters)
304
+
305
+ first: Returns the first _n_ elements from the list.
306
+
307
+ last: Returns the last _n_ elements from the list.
308
+
309
+ extra_headers: Send extra headers
310
+
311
+ extra_query: Add additional query parameters to the request
312
+
313
+ extra_body: Add additional JSON properties to the request
314
+
315
+ timeout: Override the client-level default timeout for this request, in seconds
316
+ """
317
+ return self._get_api_list(
318
+ "/course_lessons",
319
+ page=SyncCursorPage[CourseLessonListResponse],
320
+ options=make_request_options(
321
+ extra_headers=extra_headers,
322
+ extra_query=extra_query,
323
+ extra_body=extra_body,
324
+ timeout=timeout,
325
+ query=maybe_transform(
326
+ {
327
+ "after": after,
328
+ "before": before,
329
+ "chapter_id": chapter_id,
330
+ "course_id": course_id,
331
+ "first": first,
332
+ "last": last,
333
+ },
334
+ course_lesson_list_params.CourseLessonListParams,
335
+ ),
336
+ ),
337
+ model=CourseLessonListResponse,
338
+ )
339
+
340
+ def delete(
341
+ self,
342
+ id: str,
343
+ *,
344
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
345
+ # The extra values given here take precedence over values defined on the client or passed to this method.
346
+ extra_headers: Headers | None = None,
347
+ extra_query: Query | None = None,
348
+ extra_body: Body | None = None,
349
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
350
+ ) -> CourseLessonDeleteResponse:
351
+ """
352
+ Deletes a course lesson
353
+
354
+ Required permissions:
355
+
356
+ - `courses:update`
357
+
358
+ Args:
359
+ extra_headers: Send extra headers
360
+
361
+ extra_query: Add additional query parameters to the request
362
+
363
+ extra_body: Add additional JSON properties to the request
364
+
365
+ timeout: Override the client-level default timeout for this request, in seconds
366
+ """
367
+ if not id:
368
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
369
+ return self._delete(
370
+ f"/course_lessons/{id}",
371
+ options=make_request_options(
372
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
373
+ ),
374
+ cast_to=CourseLessonDeleteResponse,
375
+ )
376
+
377
+ def mark_as_completed(
378
+ self,
379
+ lesson_id: str,
380
+ *,
381
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
382
+ # The extra values given here take precedence over values defined on the client or passed to this method.
383
+ extra_headers: Headers | None = None,
384
+ extra_query: Query | None = None,
385
+ extra_body: Body | None = None,
386
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
387
+ ) -> CourseLessonMarkAsCompletedResponse:
388
+ """
389
+ Marks a course lesson as completed
390
+
391
+ Args:
392
+ extra_headers: Send extra headers
393
+
394
+ extra_query: Add additional query parameters to the request
395
+
396
+ extra_body: Add additional JSON properties to the request
397
+
398
+ timeout: Override the client-level default timeout for this request, in seconds
399
+ """
400
+ if not lesson_id:
401
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
402
+ return self._post(
403
+ f"/course_lessons/{lesson_id}/mark_as_completed",
404
+ options=make_request_options(
405
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
406
+ ),
407
+ cast_to=CourseLessonMarkAsCompletedResponse,
408
+ )
409
+
410
+ def start(
411
+ self,
412
+ lesson_id: str,
413
+ *,
414
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
415
+ # The extra values given here take precedence over values defined on the client or passed to this method.
416
+ extra_headers: Headers | None = None,
417
+ extra_query: Query | None = None,
418
+ extra_body: Body | None = None,
419
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
420
+ ) -> CourseLessonStartResponse:
421
+ """
422
+ Starts a course lesson
423
+
424
+ Args:
425
+ extra_headers: Send extra headers
426
+
427
+ extra_query: Add additional query parameters to the request
428
+
429
+ extra_body: Add additional JSON properties to the request
430
+
431
+ timeout: Override the client-level default timeout for this request, in seconds
432
+ """
433
+ if not lesson_id:
434
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
435
+ return self._post(
436
+ f"/course_lessons/{lesson_id}/start",
437
+ options=make_request_options(
438
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
439
+ ),
440
+ cast_to=CourseLessonStartResponse,
441
+ )
442
+
443
+ def submit_assessment(
444
+ self,
445
+ lesson_id: str,
446
+ *,
447
+ answers: Iterable[course_lesson_submit_assessment_params.Answer],
448
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
449
+ # The extra values given here take precedence over values defined on the client or passed to this method.
450
+ extra_headers: Headers | None = None,
451
+ extra_query: Query | None = None,
452
+ extra_body: Body | None = None,
453
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
454
+ ) -> CourseLessonSubmitAssessmentResponse:
455
+ """
456
+ Submits answers for a course assessment
457
+
458
+ Args:
459
+ answers: The answers to the assessment questions
460
+
461
+ extra_headers: Send extra headers
462
+
463
+ extra_query: Add additional query parameters to the request
464
+
465
+ extra_body: Add additional JSON properties to the request
466
+
467
+ timeout: Override the client-level default timeout for this request, in seconds
468
+ """
469
+ if not lesson_id:
470
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
471
+ return self._post(
472
+ f"/course_lessons/{lesson_id}/submit_assessment",
473
+ body=maybe_transform(
474
+ {"answers": answers}, course_lesson_submit_assessment_params.CourseLessonSubmitAssessmentParams
475
+ ),
476
+ options=make_request_options(
477
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
478
+ ),
479
+ cast_to=CourseLessonSubmitAssessmentResponse,
480
+ )
481
+
482
+
483
+ class AsyncCourseLessonsResource(AsyncAPIResource):
484
+ @cached_property
485
+ def with_raw_response(self) -> AsyncCourseLessonsResourceWithRawResponse:
486
+ """
487
+ This property can be used as a prefix for any HTTP method call to return
488
+ the raw response object instead of the parsed content.
489
+
490
+ For more information, see https://www.github.com/whopio/whopsdk-python#accessing-raw-response-data-eg-headers
491
+ """
492
+ return AsyncCourseLessonsResourceWithRawResponse(self)
493
+
494
+ @cached_property
495
+ def with_streaming_response(self) -> AsyncCourseLessonsResourceWithStreamingResponse:
496
+ """
497
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
498
+
499
+ For more information, see https://www.github.com/whopio/whopsdk-python#with_streaming_response
500
+ """
501
+ return AsyncCourseLessonsResourceWithStreamingResponse(self)
502
+
503
+ async def create(
504
+ self,
505
+ *,
506
+ chapter_id: str,
507
+ lesson_type: LessonTypes,
508
+ content: Optional[str] | Omit = omit,
509
+ days_from_course_start_until_unlock: Optional[int] | Omit = omit,
510
+ embed_id: Optional[str] | Omit = omit,
511
+ embed_type: Optional[EmbedType] | Omit = omit,
512
+ thumbnail: Optional[course_lesson_create_params.Thumbnail] | Omit = omit,
513
+ title: Optional[str] | Omit = omit,
514
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
515
+ # The extra values given here take precedence over values defined on the client or passed to this method.
516
+ extra_headers: Headers | None = None,
517
+ extra_query: Query | None = None,
518
+ extra_body: Body | None = None,
519
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
520
+ ) -> Lesson:
521
+ """
522
+ Creates a new course lesson
523
+
524
+ Required permissions:
525
+
526
+ - `courses:update`
527
+
528
+ Args:
529
+ chapter_id: The ID of the chapter to create the lesson in
530
+
531
+ lesson_type: The type of the lesson
532
+
533
+ content: The content of the lesson
534
+
535
+ days_from_course_start_until_unlock: Days from course start until unlock
536
+
537
+ embed_id: ID for the embed (YouTube video ID or Loom share ID)
538
+
539
+ embed_type: The type of embed for a lesson
540
+
541
+ thumbnail: The thumbnail for the lesson in png, jpeg, or gif format
542
+
543
+ title: The title of the lesson
544
+
545
+ extra_headers: Send extra headers
546
+
547
+ extra_query: Add additional query parameters to the request
548
+
549
+ extra_body: Add additional JSON properties to the request
550
+
551
+ timeout: Override the client-level default timeout for this request, in seconds
552
+ """
553
+ return await self._post(
554
+ "/course_lessons",
555
+ body=await async_maybe_transform(
556
+ {
557
+ "chapter_id": chapter_id,
558
+ "lesson_type": lesson_type,
559
+ "content": content,
560
+ "days_from_course_start_until_unlock": days_from_course_start_until_unlock,
561
+ "embed_id": embed_id,
562
+ "embed_type": embed_type,
563
+ "thumbnail": thumbnail,
564
+ "title": title,
565
+ },
566
+ course_lesson_create_params.CourseLessonCreateParams,
567
+ ),
568
+ options=make_request_options(
569
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
570
+ ),
571
+ cast_to=Lesson,
572
+ )
573
+
574
+ async def retrieve(
575
+ self,
576
+ id: str,
577
+ *,
578
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
579
+ # The extra values given here take precedence over values defined on the client or passed to this method.
580
+ extra_headers: Headers | None = None,
581
+ extra_query: Query | None = None,
582
+ extra_body: Body | None = None,
583
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
584
+ ) -> Lesson:
585
+ """
586
+ Retrieves a course lesson by ID
587
+
588
+ Required permissions:
589
+
590
+ - `courses:read`
591
+
592
+ Args:
593
+ extra_headers: Send extra headers
594
+
595
+ extra_query: Add additional query parameters to the request
596
+
597
+ extra_body: Add additional JSON properties to the request
598
+
599
+ timeout: Override the client-level default timeout for this request, in seconds
600
+ """
601
+ if not id:
602
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
603
+ return await self._get(
604
+ f"/course_lessons/{id}",
605
+ options=make_request_options(
606
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
607
+ ),
608
+ cast_to=Lesson,
609
+ )
610
+
611
+ async def update(
612
+ self,
613
+ id: str,
614
+ *,
615
+ assessment_completion_requirement: Optional[course_lesson_update_params.AssessmentCompletionRequirement]
616
+ | Omit = omit,
617
+ assessment_questions: Optional[Iterable[course_lesson_update_params.AssessmentQuestion]] | Omit = omit,
618
+ attachments: Optional[Iterable[course_lesson_update_params.Attachment]] | Omit = omit,
619
+ content: Optional[str] | Omit = omit,
620
+ days_from_course_start_until_unlock: Optional[int] | Omit = omit,
621
+ embed_id: Optional[str] | Omit = omit,
622
+ embed_type: Optional[EmbedType] | Omit = omit,
623
+ lesson_type: Optional[LessonTypes] | Omit = omit,
624
+ main_pdf: Optional[course_lesson_update_params.MainPdf] | Omit = omit,
625
+ max_attempts: Optional[int] | Omit = omit,
626
+ mux_asset_id: Optional[str] | Omit = omit,
627
+ thumbnail: Optional[course_lesson_update_params.Thumbnail] | Omit = omit,
628
+ title: Optional[str] | Omit = omit,
629
+ visibility: Optional[LessonVisibilities] | Omit = omit,
630
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
631
+ # The extra values given here take precedence over values defined on the client or passed to this method.
632
+ extra_headers: Headers | None = None,
633
+ extra_query: Query | None = None,
634
+ extra_body: Body | None = None,
635
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
636
+ ) -> Lesson:
637
+ """
638
+ Updates a course lesson
639
+
640
+ Required permissions:
641
+
642
+ - `courses:update`
643
+
644
+ Args:
645
+ assessment_completion_requirement: Completion requirements for quiz/knowledge check lessons
646
+
647
+ assessment_questions: Assessment questions for quiz/knowledge check lessons. Replaces all existing
648
+ questions.
649
+
650
+ attachments: General attachments for the lesson (PDFs, files, etc). Replaces all existing
651
+ attachments.
652
+
653
+ content: The content of the lesson
654
+
655
+ days_from_course_start_until_unlock: Days from course start until unlock
656
+
657
+ embed_id: ID for the embed (YouTube video ID or Loom share ID)
658
+
659
+ embed_type: The type of embed for a lesson
660
+
661
+ lesson_type: The available types for a lesson
662
+
663
+ main_pdf: The main PDF file for this lesson
664
+
665
+ max_attempts: Maximum number of attempts allowed for assessments
666
+
667
+ mux_asset_id: The ID of the Mux asset to attach to this lesson for video lessons
668
+
669
+ thumbnail: The thumbnail for the lesson in png, jpeg, or gif format
670
+
671
+ title: The title of the lesson
672
+
673
+ visibility: The available visibilities for a lesson. Determines how / whether a lesson is
674
+ visible to users.
675
+
676
+ extra_headers: Send extra headers
677
+
678
+ extra_query: Add additional query parameters to the request
679
+
680
+ extra_body: Add additional JSON properties to the request
681
+
682
+ timeout: Override the client-level default timeout for this request, in seconds
683
+ """
684
+ if not id:
685
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
686
+ return await self._patch(
687
+ f"/course_lessons/{id}",
688
+ body=await async_maybe_transform(
689
+ {
690
+ "assessment_completion_requirement": assessment_completion_requirement,
691
+ "assessment_questions": assessment_questions,
692
+ "attachments": attachments,
693
+ "content": content,
694
+ "days_from_course_start_until_unlock": days_from_course_start_until_unlock,
695
+ "embed_id": embed_id,
696
+ "embed_type": embed_type,
697
+ "lesson_type": lesson_type,
698
+ "main_pdf": main_pdf,
699
+ "max_attempts": max_attempts,
700
+ "mux_asset_id": mux_asset_id,
701
+ "thumbnail": thumbnail,
702
+ "title": title,
703
+ "visibility": visibility,
704
+ },
705
+ course_lesson_update_params.CourseLessonUpdateParams,
706
+ ),
707
+ options=make_request_options(
708
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
709
+ ),
710
+ cast_to=Lesson,
711
+ )
712
+
713
+ def list(
714
+ self,
715
+ *,
716
+ after: Optional[str] | Omit = omit,
717
+ before: Optional[str] | Omit = omit,
718
+ chapter_id: Optional[str] | Omit = omit,
719
+ course_id: Optional[str] | Omit = omit,
720
+ first: Optional[int] | Omit = omit,
721
+ last: Optional[int] | Omit = omit,
722
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
723
+ # The extra values given here take precedence over values defined on the client or passed to this method.
724
+ extra_headers: Headers | None = None,
725
+ extra_query: Query | None = None,
726
+ extra_body: Body | None = None,
727
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
728
+ ) -> AsyncPaginator[CourseLessonListResponse, AsyncCursorPage[CourseLessonListResponse]]:
729
+ """
730
+ Lists lessons for a course or chapter
731
+
732
+ Required permissions:
733
+
734
+ - `courses:read`
735
+
736
+ Args:
737
+ after: Returns the elements in the list that come after the specified cursor.
738
+
739
+ before: Returns the elements in the list that come before the specified cursor.
740
+
741
+ chapter_id: The ID of the chapter (returns lessons only for this chapter)
742
+
743
+ course_id: The ID of the course (returns all lessons across all chapters)
744
+
745
+ first: Returns the first _n_ elements from the list.
746
+
747
+ last: Returns the last _n_ elements from the list.
748
+
749
+ extra_headers: Send extra headers
750
+
751
+ extra_query: Add additional query parameters to the request
752
+
753
+ extra_body: Add additional JSON properties to the request
754
+
755
+ timeout: Override the client-level default timeout for this request, in seconds
756
+ """
757
+ return self._get_api_list(
758
+ "/course_lessons",
759
+ page=AsyncCursorPage[CourseLessonListResponse],
760
+ options=make_request_options(
761
+ extra_headers=extra_headers,
762
+ extra_query=extra_query,
763
+ extra_body=extra_body,
764
+ timeout=timeout,
765
+ query=maybe_transform(
766
+ {
767
+ "after": after,
768
+ "before": before,
769
+ "chapter_id": chapter_id,
770
+ "course_id": course_id,
771
+ "first": first,
772
+ "last": last,
773
+ },
774
+ course_lesson_list_params.CourseLessonListParams,
775
+ ),
776
+ ),
777
+ model=CourseLessonListResponse,
778
+ )
779
+
780
+ async def delete(
781
+ self,
782
+ id: str,
783
+ *,
784
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
785
+ # The extra values given here take precedence over values defined on the client or passed to this method.
786
+ extra_headers: Headers | None = None,
787
+ extra_query: Query | None = None,
788
+ extra_body: Body | None = None,
789
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
790
+ ) -> CourseLessonDeleteResponse:
791
+ """
792
+ Deletes a course lesson
793
+
794
+ Required permissions:
795
+
796
+ - `courses:update`
797
+
798
+ Args:
799
+ extra_headers: Send extra headers
800
+
801
+ extra_query: Add additional query parameters to the request
802
+
803
+ extra_body: Add additional JSON properties to the request
804
+
805
+ timeout: Override the client-level default timeout for this request, in seconds
806
+ """
807
+ if not id:
808
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
809
+ return await self._delete(
810
+ f"/course_lessons/{id}",
811
+ options=make_request_options(
812
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
813
+ ),
814
+ cast_to=CourseLessonDeleteResponse,
815
+ )
816
+
817
+ async def mark_as_completed(
818
+ self,
819
+ lesson_id: str,
820
+ *,
821
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
822
+ # The extra values given here take precedence over values defined on the client or passed to this method.
823
+ extra_headers: Headers | None = None,
824
+ extra_query: Query | None = None,
825
+ extra_body: Body | None = None,
826
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
827
+ ) -> CourseLessonMarkAsCompletedResponse:
828
+ """
829
+ Marks a course lesson as completed
830
+
831
+ Args:
832
+ extra_headers: Send extra headers
833
+
834
+ extra_query: Add additional query parameters to the request
835
+
836
+ extra_body: Add additional JSON properties to the request
837
+
838
+ timeout: Override the client-level default timeout for this request, in seconds
839
+ """
840
+ if not lesson_id:
841
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
842
+ return await self._post(
843
+ f"/course_lessons/{lesson_id}/mark_as_completed",
844
+ options=make_request_options(
845
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
846
+ ),
847
+ cast_to=CourseLessonMarkAsCompletedResponse,
848
+ )
849
+
850
+ async def start(
851
+ self,
852
+ lesson_id: str,
853
+ *,
854
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
855
+ # The extra values given here take precedence over values defined on the client or passed to this method.
856
+ extra_headers: Headers | None = None,
857
+ extra_query: Query | None = None,
858
+ extra_body: Body | None = None,
859
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
860
+ ) -> CourseLessonStartResponse:
861
+ """
862
+ Starts a course lesson
863
+
864
+ Args:
865
+ extra_headers: Send extra headers
866
+
867
+ extra_query: Add additional query parameters to the request
868
+
869
+ extra_body: Add additional JSON properties to the request
870
+
871
+ timeout: Override the client-level default timeout for this request, in seconds
872
+ """
873
+ if not lesson_id:
874
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
875
+ return await self._post(
876
+ f"/course_lessons/{lesson_id}/start",
877
+ options=make_request_options(
878
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
879
+ ),
880
+ cast_to=CourseLessonStartResponse,
881
+ )
882
+
883
+ async def submit_assessment(
884
+ self,
885
+ lesson_id: str,
886
+ *,
887
+ answers: Iterable[course_lesson_submit_assessment_params.Answer],
888
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
889
+ # The extra values given here take precedence over values defined on the client or passed to this method.
890
+ extra_headers: Headers | None = None,
891
+ extra_query: Query | None = None,
892
+ extra_body: Body | None = None,
893
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
894
+ ) -> CourseLessonSubmitAssessmentResponse:
895
+ """
896
+ Submits answers for a course assessment
897
+
898
+ Args:
899
+ answers: The answers to the assessment questions
900
+
901
+ extra_headers: Send extra headers
902
+
903
+ extra_query: Add additional query parameters to the request
904
+
905
+ extra_body: Add additional JSON properties to the request
906
+
907
+ timeout: Override the client-level default timeout for this request, in seconds
908
+ """
909
+ if not lesson_id:
910
+ raise ValueError(f"Expected a non-empty value for `lesson_id` but received {lesson_id!r}")
911
+ return await self._post(
912
+ f"/course_lessons/{lesson_id}/submit_assessment",
913
+ body=await async_maybe_transform(
914
+ {"answers": answers}, course_lesson_submit_assessment_params.CourseLessonSubmitAssessmentParams
915
+ ),
916
+ options=make_request_options(
917
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
918
+ ),
919
+ cast_to=CourseLessonSubmitAssessmentResponse,
920
+ )
921
+
922
+
923
+ class CourseLessonsResourceWithRawResponse:
924
+ def __init__(self, course_lessons: CourseLessonsResource) -> None:
925
+ self._course_lessons = course_lessons
926
+
927
+ self.create = to_raw_response_wrapper(
928
+ course_lessons.create,
929
+ )
930
+ self.retrieve = to_raw_response_wrapper(
931
+ course_lessons.retrieve,
932
+ )
933
+ self.update = to_raw_response_wrapper(
934
+ course_lessons.update,
935
+ )
936
+ self.list = to_raw_response_wrapper(
937
+ course_lessons.list,
938
+ )
939
+ self.delete = to_raw_response_wrapper(
940
+ course_lessons.delete,
941
+ )
942
+ self.mark_as_completed = to_raw_response_wrapper(
943
+ course_lessons.mark_as_completed,
944
+ )
945
+ self.start = to_raw_response_wrapper(
946
+ course_lessons.start,
947
+ )
948
+ self.submit_assessment = to_raw_response_wrapper(
949
+ course_lessons.submit_assessment,
950
+ )
951
+
952
+
953
+ class AsyncCourseLessonsResourceWithRawResponse:
954
+ def __init__(self, course_lessons: AsyncCourseLessonsResource) -> None:
955
+ self._course_lessons = course_lessons
956
+
957
+ self.create = async_to_raw_response_wrapper(
958
+ course_lessons.create,
959
+ )
960
+ self.retrieve = async_to_raw_response_wrapper(
961
+ course_lessons.retrieve,
962
+ )
963
+ self.update = async_to_raw_response_wrapper(
964
+ course_lessons.update,
965
+ )
966
+ self.list = async_to_raw_response_wrapper(
967
+ course_lessons.list,
968
+ )
969
+ self.delete = async_to_raw_response_wrapper(
970
+ course_lessons.delete,
971
+ )
972
+ self.mark_as_completed = async_to_raw_response_wrapper(
973
+ course_lessons.mark_as_completed,
974
+ )
975
+ self.start = async_to_raw_response_wrapper(
976
+ course_lessons.start,
977
+ )
978
+ self.submit_assessment = async_to_raw_response_wrapper(
979
+ course_lessons.submit_assessment,
980
+ )
981
+
982
+
983
+ class CourseLessonsResourceWithStreamingResponse:
984
+ def __init__(self, course_lessons: CourseLessonsResource) -> None:
985
+ self._course_lessons = course_lessons
986
+
987
+ self.create = to_streamed_response_wrapper(
988
+ course_lessons.create,
989
+ )
990
+ self.retrieve = to_streamed_response_wrapper(
991
+ course_lessons.retrieve,
992
+ )
993
+ self.update = to_streamed_response_wrapper(
994
+ course_lessons.update,
995
+ )
996
+ self.list = to_streamed_response_wrapper(
997
+ course_lessons.list,
998
+ )
999
+ self.delete = to_streamed_response_wrapper(
1000
+ course_lessons.delete,
1001
+ )
1002
+ self.mark_as_completed = to_streamed_response_wrapper(
1003
+ course_lessons.mark_as_completed,
1004
+ )
1005
+ self.start = to_streamed_response_wrapper(
1006
+ course_lessons.start,
1007
+ )
1008
+ self.submit_assessment = to_streamed_response_wrapper(
1009
+ course_lessons.submit_assessment,
1010
+ )
1011
+
1012
+
1013
+ class AsyncCourseLessonsResourceWithStreamingResponse:
1014
+ def __init__(self, course_lessons: AsyncCourseLessonsResource) -> None:
1015
+ self._course_lessons = course_lessons
1016
+
1017
+ self.create = async_to_streamed_response_wrapper(
1018
+ course_lessons.create,
1019
+ )
1020
+ self.retrieve = async_to_streamed_response_wrapper(
1021
+ course_lessons.retrieve,
1022
+ )
1023
+ self.update = async_to_streamed_response_wrapper(
1024
+ course_lessons.update,
1025
+ )
1026
+ self.list = async_to_streamed_response_wrapper(
1027
+ course_lessons.list,
1028
+ )
1029
+ self.delete = async_to_streamed_response_wrapper(
1030
+ course_lessons.delete,
1031
+ )
1032
+ self.mark_as_completed = async_to_streamed_response_wrapper(
1033
+ course_lessons.mark_as_completed,
1034
+ )
1035
+ self.start = async_to_streamed_response_wrapper(
1036
+ course_lessons.start,
1037
+ )
1038
+ self.submit_assessment = async_to_streamed_response_wrapper(
1039
+ course_lessons.submit_assessment,
1040
+ )