@whop/sdk 0.0.26 → 0.0.28
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.
- package/CHANGELOG.md +78 -0
- package/client.d.mts +10 -9
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -9
- package/client.d.ts.map +1 -1
- package/client.js +16 -2
- package/client.js.map +1 -1
- package/client.mjs +16 -2
- package/client.mjs.map +1 -1
- package/package.json +3 -3
- package/resources/access-tokens.d.mts +34 -54
- package/resources/access-tokens.d.mts.map +1 -1
- package/resources/access-tokens.d.ts +34 -54
- package/resources/access-tokens.d.ts.map +1 -1
- package/resources/access-tokens.js +6 -8
- package/resources/access-tokens.js.map +1 -1
- package/resources/access-tokens.mjs +6 -8
- package/resources/access-tokens.mjs.map +1 -1
- package/resources/account-links.d.mts +15 -13
- package/resources/account-links.d.mts.map +1 -1
- package/resources/account-links.d.ts +15 -13
- package/resources/account-links.d.ts.map +1 -1
- package/resources/account-links.js +2 -3
- package/resources/account-links.js.map +1 -1
- package/resources/account-links.mjs +2 -3
- package/resources/account-links.mjs.map +1 -1
- package/resources/ai-chats.d.mts +70 -30
- package/resources/ai-chats.d.mts.map +1 -1
- package/resources/ai-chats.d.ts +70 -30
- package/resources/ai-chats.d.ts.map +1 -1
- package/resources/ai-chats.js +6 -6
- package/resources/ai-chats.js.map +1 -1
- package/resources/ai-chats.mjs +6 -6
- package/resources/ai-chats.mjs.map +1 -1
- package/resources/app-builds.d.mts +37 -35
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +37 -35
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +7 -4
- package/resources/app-builds.js.map +1 -1
- package/resources/app-builds.mjs +7 -4
- package/resources/app-builds.mjs.map +1 -1
- package/resources/apps.d.mts +86 -60
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +86 -60
- package/resources/apps.d.ts.map +1 -1
- package/resources/apps.js +7 -4
- package/resources/apps.js.map +1 -1
- package/resources/apps.mjs +7 -4
- package/resources/apps.mjs.map +1 -1
- package/resources/authorized-users.d.mts +38 -32
- package/resources/authorized-users.d.mts.map +1 -1
- package/resources/authorized-users.d.ts +38 -32
- package/resources/authorized-users.d.ts.map +1 -1
- package/resources/authorized-users.js +3 -2
- package/resources/authorized-users.js.map +1 -1
- package/resources/authorized-users.mjs +3 -2
- package/resources/authorized-users.mjs.map +1 -1
- package/resources/chat-channels.d.mts +28 -20
- package/resources/chat-channels.d.mts.map +1 -1
- package/resources/chat-channels.d.ts +28 -20
- package/resources/chat-channels.d.ts.map +1 -1
- package/resources/chat-channels.js +5 -3
- package/resources/chat-channels.js.map +1 -1
- package/resources/chat-channels.mjs +5 -3
- package/resources/chat-channels.mjs.map +1 -1
- package/resources/checkout-configurations.d.mts +75 -58
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +75 -58
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +3 -2
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +3 -2
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +88 -56
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +88 -56
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +9 -7
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +9 -7
- package/resources/companies.mjs.map +1 -1
- package/resources/company-token-transactions.d.mts +90 -67
- package/resources/company-token-transactions.d.mts.map +1 -1
- package/resources/company-token-transactions.d.ts +90 -67
- package/resources/company-token-transactions.d.ts.map +1 -1
- package/resources/company-token-transactions.js +6 -3
- package/resources/company-token-transactions.js.map +1 -1
- package/resources/company-token-transactions.mjs +6 -3
- package/resources/company-token-transactions.mjs.map +1 -1
- package/resources/course-chapters.d.mts +27 -22
- package/resources/course-chapters.d.mts.map +1 -1
- package/resources/course-chapters.d.ts +27 -22
- package/resources/course-chapters.d.ts.map +1 -1
- package/resources/course-chapters.js +5 -5
- package/resources/course-chapters.mjs +5 -5
- package/resources/course-lesson-interactions.d.mts +7 -6
- package/resources/course-lesson-interactions.d.mts.map +1 -1
- package/resources/course-lesson-interactions.d.ts +7 -6
- package/resources/course-lesson-interactions.d.ts.map +1 -1
- package/resources/course-lesson-interactions.js +3 -2
- package/resources/course-lesson-interactions.js.map +1 -1
- package/resources/course-lesson-interactions.mjs +3 -2
- package/resources/course-lesson-interactions.mjs.map +1 -1
- package/resources/course-lessons.d.mts +141 -99
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +141 -99
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-lessons.js +12 -8
- package/resources/course-lessons.js.map +1 -1
- package/resources/course-lessons.mjs +12 -8
- package/resources/course-lessons.mjs.map +1 -1
- package/resources/course-students.d.mts +44 -35
- package/resources/course-students.d.mts.map +1 -1
- package/resources/course-students.d.ts +44 -35
- package/resources/course-students.d.ts.map +1 -1
- package/resources/course-students.js +3 -2
- package/resources/course-students.js.map +1 -1
- package/resources/course-students.mjs +3 -2
- package/resources/course-students.mjs.map +1 -1
- package/resources/courses.d.mts +140 -99
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +140 -99
- package/resources/courses.d.ts.map +1 -1
- package/resources/courses.js +9 -5
- package/resources/courses.js.map +1 -1
- package/resources/courses.mjs +9 -5
- package/resources/courses.mjs.map +1 -1
- package/resources/disputes.d.mts +176 -120
- package/resources/disputes.d.mts.map +1 -1
- package/resources/disputes.d.ts +176 -120
- package/resources/disputes.d.ts.map +1 -1
- package/resources/disputes.js +4 -2
- package/resources/disputes.js.map +1 -1
- package/resources/disputes.mjs +4 -2
- package/resources/disputes.mjs.map +1 -1
- package/resources/dm-channels.d.mts +29 -16
- package/resources/dm-channels.d.mts.map +1 -1
- package/resources/dm-channels.d.ts +29 -16
- package/resources/dm-channels.d.ts.map +1 -1
- package/resources/dm-channels.js +9 -5
- package/resources/dm-channels.js.map +1 -1
- package/resources/dm-channels.mjs +9 -5
- package/resources/dm-channels.mjs.map +1 -1
- package/resources/dm-members.d.mts +30 -21
- package/resources/dm-members.d.mts.map +1 -1
- package/resources/dm-members.d.ts +30 -21
- package/resources/dm-members.d.ts.map +1 -1
- package/resources/dm-members.js +9 -5
- package/resources/dm-members.js.map +1 -1
- package/resources/dm-members.mjs +9 -5
- package/resources/dm-members.mjs.map +1 -1
- package/resources/entries.d.mts +35 -27
- package/resources/entries.d.mts.map +1 -1
- package/resources/entries.d.ts +35 -27
- package/resources/entries.d.ts.map +1 -1
- package/resources/entries.js +7 -4
- package/resources/entries.js.map +1 -1
- package/resources/entries.mjs +7 -4
- package/resources/entries.mjs.map +1 -1
- package/resources/experiences.d.mts +58 -49
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +58 -49
- package/resources/experiences.d.ts.map +1 -1
- package/resources/experiences.js +6 -5
- package/resources/experiences.js.map +1 -1
- package/resources/experiences.mjs +6 -5
- package/resources/experiences.mjs.map +1 -1
- package/resources/fee-markups.d.mts +38 -27
- package/resources/fee-markups.d.mts.map +1 -1
- package/resources/fee-markups.d.ts +38 -27
- package/resources/fee-markups.d.ts.map +1 -1
- package/resources/fee-markups.js +6 -3
- package/resources/fee-markups.js.map +1 -1
- package/resources/fee-markups.mjs +6 -3
- package/resources/fee-markups.mjs.map +1 -1
- package/resources/files.d.mts +23 -19
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +23 -19
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +3 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +3 -2
- package/resources/files.mjs.map +1 -1
- package/resources/forum-posts.d.mts +68 -45
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +68 -45
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/forum-posts.js +8 -4
- package/resources/forum-posts.js.map +1 -1
- package/resources/forum-posts.mjs +8 -4
- package/resources/forum-posts.mjs.map +1 -1
- package/resources/forums.d.mts +21 -13
- package/resources/forums.d.mts.map +1 -1
- package/resources/forums.d.ts +21 -13
- package/resources/forums.d.ts.map +1 -1
- package/resources/forums.js +5 -3
- package/resources/forums.js.map +1 -1
- package/resources/forums.mjs +5 -3
- package/resources/forums.mjs.map +1 -1
- package/resources/index.d.mts +3 -3
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +3 -3
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +136 -100
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +136 -100
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +7 -4
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +7 -4
- package/resources/invoices.mjs.map +1 -1
- package/resources/leads.d.mts +76 -54
- package/resources/leads.d.mts.map +1 -1
- package/resources/leads.d.ts +76 -54
- package/resources/leads.d.ts.map +1 -1
- package/resources/leads.js +6 -4
- package/resources/leads.js.map +1 -1
- package/resources/leads.mjs +6 -4
- package/resources/leads.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +19 -15
- package/resources/ledger-accounts.d.mts.map +1 -1
- package/resources/ledger-accounts.d.ts +19 -15
- package/resources/ledger-accounts.d.ts.map +1 -1
- package/resources/ledger-accounts.js +1 -1
- package/resources/ledger-accounts.mjs +1 -1
- package/resources/members.d.mts +27 -28
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +27 -28
- package/resources/members.d.ts.map +1 -1
- package/resources/members.js +3 -2
- package/resources/members.js.map +1 -1
- package/resources/members.mjs +3 -2
- package/resources/members.mjs.map +1 -1
- package/resources/memberships.d.mts +85 -62
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +85 -62
- package/resources/memberships.d.ts.map +1 -1
- package/resources/memberships.js +12 -8
- package/resources/memberships.js.map +1 -1
- package/resources/memberships.mjs +12 -8
- package/resources/memberships.mjs.map +1 -1
- package/resources/messages.d.mts +53 -35
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +53 -35
- package/resources/messages.d.ts.map +1 -1
- package/resources/messages.js +9 -5
- package/resources/messages.js.map +1 -1
- package/resources/messages.mjs +9 -5
- package/resources/messages.mjs.map +1 -1
- package/resources/notifications.d.mts +33 -25
- package/resources/notifications.d.mts.map +1 -1
- package/resources/notifications.d.ts +33 -25
- package/resources/notifications.d.ts.map +1 -1
- package/resources/notifications.js +2 -1
- package/resources/notifications.js.map +1 -1
- package/resources/notifications.mjs +2 -1
- package/resources/notifications.mjs.map +1 -1
- package/resources/payment-methods.d.mts +212 -114
- package/resources/payment-methods.d.mts.map +1 -1
- package/resources/payment-methods.d.ts +212 -114
- package/resources/payment-methods.d.ts.map +1 -1
- package/resources/payment-methods.js +5 -10
- package/resources/payment-methods.js.map +1 -1
- package/resources/payment-methods.mjs +5 -10
- package/resources/payment-methods.mjs.map +1 -1
- package/resources/payments.d.mts +96 -56
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +96 -56
- package/resources/payments.d.ts.map +1 -1
- package/resources/payments.js +23 -10
- package/resources/payments.js.map +1 -1
- package/resources/payments.mjs +23 -10
- package/resources/payments.mjs.map +1 -1
- package/resources/payout-methods.d.mts +50 -35
- package/resources/payout-methods.d.mts.map +1 -1
- package/resources/payout-methods.d.ts +50 -35
- package/resources/payout-methods.d.ts.map +1 -1
- package/resources/payout-methods.js +3 -2
- package/resources/payout-methods.js.map +1 -1
- package/resources/payout-methods.mjs +3 -2
- package/resources/payout-methods.mjs.map +1 -1
- package/resources/plans.d.mts +136 -95
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +136 -95
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js +9 -5
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs +9 -5
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +80 -67
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +80 -67
- package/resources/products.d.ts.map +1 -1
- package/resources/products.js +7 -5
- package/resources/products.js.map +1 -1
- package/resources/products.mjs +7 -5
- package/resources/products.mjs.map +1 -1
- package/resources/promo-codes.d.mts +60 -40
- package/resources/promo-codes.d.mts.map +1 -1
- package/resources/promo-codes.d.ts +60 -40
- package/resources/promo-codes.d.ts.map +1 -1
- package/resources/promo-codes.js +7 -4
- package/resources/promo-codes.js.map +1 -1
- package/resources/promo-codes.mjs +7 -4
- package/resources/promo-codes.mjs.map +1 -1
- package/resources/reactions.d.mts +25 -19
- package/resources/reactions.d.mts.map +1 -1
- package/resources/reactions.d.ts +25 -19
- package/resources/reactions.d.ts.map +1 -1
- package/resources/reactions.js +7 -4
- package/resources/reactions.js.map +1 -1
- package/resources/reactions.mjs +7 -4
- package/resources/reactions.mjs.map +1 -1
- package/resources/refunds.d.mts +57 -39
- package/resources/refunds.d.mts.map +1 -1
- package/resources/refunds.d.ts +57 -39
- package/resources/refunds.d.ts.map +1 -1
- package/resources/refunds.js +3 -2
- package/resources/refunds.js.map +1 -1
- package/resources/refunds.mjs +3 -2
- package/resources/refunds.mjs.map +1 -1
- package/resources/reviews.d.mts +76 -60
- package/resources/reviews.d.mts.map +1 -1
- package/resources/reviews.d.ts +76 -60
- package/resources/reviews.d.ts.map +1 -1
- package/resources/reviews.js +3 -2
- package/resources/reviews.js.map +1 -1
- package/resources/reviews.mjs +3 -2
- package/resources/reviews.mjs.map +1 -1
- package/resources/setup-intents.d.mts +77 -61
- package/resources/setup-intents.d.mts.map +1 -1
- package/resources/setup-intents.d.ts +77 -61
- package/resources/setup-intents.d.ts.map +1 -1
- package/resources/setup-intents.js +4 -10
- package/resources/setup-intents.js.map +1 -1
- package/resources/setup-intents.mjs +4 -10
- package/resources/setup-intents.mjs.map +1 -1
- package/resources/shared.d.mts +854 -509
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +854 -509
- package/resources/shared.d.ts.map +1 -1
- package/resources/shipments.d.mts +30 -21
- package/resources/shipments.d.mts.map +1 -1
- package/resources/shipments.d.ts +30 -21
- package/resources/shipments.d.ts.map +1 -1
- package/resources/shipments.js +5 -3
- package/resources/shipments.js.map +1 -1
- package/resources/shipments.mjs +5 -3
- package/resources/shipments.mjs.map +1 -1
- package/resources/support-channels.d.mts +28 -20
- package/resources/support-channels.d.mts.map +1 -1
- package/resources/support-channels.d.ts +28 -20
- package/resources/support-channels.d.ts.map +1 -1
- package/resources/support-channels.js +5 -4
- package/resources/support-channels.js.map +1 -1
- package/resources/support-channels.mjs +5 -4
- package/resources/support-channels.mjs.map +1 -1
- package/resources/topups.d.mts +13 -9
- package/resources/topups.d.mts.map +1 -1
- package/resources/topups.d.ts +13 -9
- package/resources/topups.d.ts.map +1 -1
- package/resources/topups.js +2 -1
- package/resources/topups.js.map +1 -1
- package/resources/topups.mjs +2 -1
- package/resources/topups.mjs.map +1 -1
- package/resources/transfers.d.mts +37 -28
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +37 -28
- package/resources/transfers.d.ts.map +1 -1
- package/resources/transfers.js +5 -3
- package/resources/transfers.js.map +1 -1
- package/resources/transfers.mjs +5 -3
- package/resources/transfers.mjs.map +1 -1
- package/resources/users.d.mts +60 -18
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +60 -18
- package/resources/users.d.ts.map +1 -1
- package/resources/users.js +13 -2
- package/resources/users.js.map +1 -1
- package/resources/users.mjs +13 -2
- package/resources/users.mjs.map +1 -1
- package/resources/verifications.d.mts +7 -5
- package/resources/verifications.d.mts.map +1 -1
- package/resources/verifications.d.ts +7 -5
- package/resources/verifications.d.ts.map +1 -1
- package/resources/verifications.js +1 -1
- package/resources/verifications.mjs +1 -1
- package/resources/webhooks.d.mts +188 -133
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +188 -133
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +3 -2
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +3 -2
- package/resources/webhooks.mjs.map +1 -1
- package/resources/withdrawals.d.mts +60 -47
- package/resources/withdrawals.d.mts.map +1 -1
- package/resources/withdrawals.d.ts +60 -47
- package/resources/withdrawals.d.ts.map +1 -1
- package/resources/withdrawals.js +3 -2
- package/resources/withdrawals.js.map +1 -1
- package/resources/withdrawals.mjs +3 -2
- package/resources/withdrawals.mjs.map +1 -1
- package/src/client.ts +33 -11
- package/src/resources/access-tokens.ts +37 -59
- package/src/resources/account-links.ts +15 -13
- package/src/resources/ai-chats.ts +76 -30
- package/src/resources/app-builds.ts +37 -35
- package/src/resources/apps.ts +89 -60
- package/src/resources/authorized-users.ts +38 -32
- package/src/resources/chat-channels.ts +28 -20
- package/src/resources/checkout-configurations.ts +76 -58
- package/src/resources/companies.ts +94 -57
- package/src/resources/company-token-transactions.ts +91 -68
- package/src/resources/course-chapters.ts +27 -22
- package/src/resources/course-lesson-interactions.ts +7 -6
- package/src/resources/course-lessons.ts +141 -99
- package/src/resources/course-students.ts +44 -35
- package/src/resources/courses.ts +140 -99
- package/src/resources/disputes.ts +176 -120
- package/src/resources/dm-channels.ts +29 -16
- package/src/resources/dm-members.ts +30 -21
- package/src/resources/entries.ts +35 -27
- package/src/resources/experiences.ts +58 -49
- package/src/resources/fee-markups.ts +38 -27
- package/src/resources/files.ts +23 -19
- package/src/resources/forum-posts.ts +69 -45
- package/src/resources/forums.ts +21 -13
- package/src/resources/index.ts +4 -2
- package/src/resources/invoices.ts +140 -100
- package/src/resources/leads.ts +76 -54
- package/src/resources/ledger-accounts.ts +19 -15
- package/src/resources/members.ts +27 -28
- package/src/resources/memberships.ts +86 -62
- package/src/resources/messages.ts +53 -35
- package/src/resources/notifications.ts +33 -25
- package/src/resources/payment-methods.ts +212 -114
- package/src/resources/payments.ts +103 -55
- package/src/resources/payout-methods.ts +50 -35
- package/src/resources/plans.ts +136 -95
- package/src/resources/products.ts +219 -70
- package/src/resources/promo-codes.ts +60 -40
- package/src/resources/reactions.ts +25 -19
- package/src/resources/refunds.ts +59 -39
- package/src/resources/reviews.ts +76 -60
- package/src/resources/setup-intents.ts +77 -61
- package/src/resources/shared.ts +2797 -508
- package/src/resources/shipments.ts +30 -21
- package/src/resources/support-channels.ts +28 -20
- package/src/resources/topups.ts +13 -9
- package/src/resources/transfers.ts +37 -28
- package/src/resources/users.ts +72 -18
- package/src/resources/verifications.ts +7 -5
- package/src/resources/webhooks.ts +188 -133
- package/src/resources/withdrawals.ts +60 -46
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/courses.d.ts
CHANGED
|
@@ -5,7 +5,8 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
|
|
|
5
5
|
import { RequestOptions } from "../internal/request-options.js";
|
|
6
6
|
export declare class Courses extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* Create a new course within an experience, with optional chapters, lessons, and a
|
|
9
|
+
* certificate.
|
|
9
10
|
*
|
|
10
11
|
* Required permissions:
|
|
11
12
|
*
|
|
@@ -21,7 +22,7 @@ export declare class Courses extends APIResource {
|
|
|
21
22
|
*/
|
|
22
23
|
create(body: CourseCreateParams, options?: RequestOptions): APIPromise<Course>;
|
|
23
24
|
/**
|
|
24
|
-
* Retrieves
|
|
25
|
+
* Retrieves the details of an existing course.
|
|
25
26
|
*
|
|
26
27
|
* Required permissions:
|
|
27
28
|
*
|
|
@@ -36,7 +37,8 @@ export declare class Courses extends APIResource {
|
|
|
36
37
|
*/
|
|
37
38
|
retrieve(id: string, options?: RequestOptions): APIPromise<Course>;
|
|
38
39
|
/**
|
|
39
|
-
*
|
|
40
|
+
* Update a course's title, description, visibility, thumbnail, or chapter
|
|
41
|
+
* ordering.
|
|
40
42
|
*
|
|
41
43
|
* Required permissions:
|
|
42
44
|
*
|
|
@@ -51,7 +53,8 @@ export declare class Courses extends APIResource {
|
|
|
51
53
|
*/
|
|
52
54
|
update(id: string, body?: CourseUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Course>;
|
|
53
55
|
/**
|
|
54
|
-
*
|
|
56
|
+
* Returns a paginated list of courses, filtered by either an experience or a
|
|
57
|
+
* company.
|
|
55
58
|
*
|
|
56
59
|
* Required permissions:
|
|
57
60
|
*
|
|
@@ -67,7 +70,8 @@ export declare class Courses extends APIResource {
|
|
|
67
70
|
*/
|
|
68
71
|
list(query?: CourseListParams | null | undefined, options?: RequestOptions): PagePromise<CourseListResponsesCursorPage, CourseListResponse>;
|
|
69
72
|
/**
|
|
70
|
-
*
|
|
73
|
+
* Permanently delete a course and all of its chapters, lessons, and student
|
|
74
|
+
* progress.
|
|
71
75
|
*
|
|
72
76
|
* Required permissions:
|
|
73
77
|
*
|
|
@@ -84,135 +88,151 @@ export declare class Courses extends APIResource {
|
|
|
84
88
|
}
|
|
85
89
|
export type CourseListResponsesCursorPage = CursorPage<CourseListResponse>;
|
|
86
90
|
/**
|
|
87
|
-
* A
|
|
91
|
+
* A structured learning module containing chapters and lessons, belonging to an
|
|
92
|
+
* experience.
|
|
88
93
|
*/
|
|
89
94
|
export interface Course {
|
|
90
95
|
/**
|
|
91
|
-
* The
|
|
96
|
+
* The unique identifier for the course.
|
|
92
97
|
*/
|
|
93
98
|
id: string;
|
|
94
99
|
/**
|
|
95
|
-
* Whether
|
|
96
|
-
*
|
|
100
|
+
* Whether students receive a PDF certificate after completing all lessons in this
|
|
101
|
+
* course. Null if the setting has not been configured.
|
|
97
102
|
*/
|
|
98
103
|
certificate_after_completion_enabled: boolean | null;
|
|
99
104
|
/**
|
|
100
|
-
*
|
|
105
|
+
* An ordered list of all chapters in this course, sorted by their display
|
|
106
|
+
* position.
|
|
101
107
|
*/
|
|
102
108
|
chapters: Array<Course.Chapter>;
|
|
103
109
|
/**
|
|
104
|
-
* The URL of the course
|
|
110
|
+
* The URL of the course cover image shown on preview cards. Null if no cover image
|
|
111
|
+
* has been uploaded.
|
|
105
112
|
*/
|
|
106
113
|
cover_image: string | null;
|
|
107
114
|
/**
|
|
108
|
-
* The
|
|
115
|
+
* The datetime the course was created.
|
|
109
116
|
*/
|
|
110
117
|
created_at: string;
|
|
111
118
|
/**
|
|
112
|
-
* A
|
|
119
|
+
* A brief summary of the course content and objectives. Null if no description has
|
|
120
|
+
* been set.
|
|
113
121
|
*/
|
|
114
122
|
description: string | null;
|
|
115
123
|
/**
|
|
116
|
-
* The language
|
|
117
|
-
* captions
|
|
124
|
+
* The spoken language of the video content, used to generate accurate closed
|
|
125
|
+
* captions. One of: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi,
|
|
126
|
+
* sk, el, cs, hr, da, ro, bg.
|
|
118
127
|
*/
|
|
119
128
|
language: Languages;
|
|
120
129
|
/**
|
|
121
|
-
* The
|
|
130
|
+
* The sort position of this course within its parent experience, as a decimal for
|
|
131
|
+
* flexible ordering.
|
|
122
132
|
*/
|
|
123
133
|
order: string;
|
|
124
134
|
/**
|
|
125
|
-
* Whether
|
|
126
|
-
*
|
|
135
|
+
* Whether students must complete each lesson sequentially before advancing to the
|
|
136
|
+
* next one.
|
|
127
137
|
*/
|
|
128
138
|
require_completing_lessons_in_order: boolean;
|
|
129
139
|
/**
|
|
130
|
-
* A short tagline
|
|
140
|
+
* A short marketing tagline displayed beneath the course title. Null if no tagline
|
|
141
|
+
* has been set.
|
|
131
142
|
*/
|
|
132
143
|
tagline: string | null;
|
|
133
144
|
/**
|
|
134
|
-
* The thumbnail
|
|
145
|
+
* The thumbnail image displayed on course cards and previews. Null if no thumbnail
|
|
146
|
+
* has been uploaded.
|
|
135
147
|
*/
|
|
136
148
|
thumbnail: Course.Thumbnail | null;
|
|
137
149
|
/**
|
|
138
|
-
* The
|
|
150
|
+
* The display name of the course shown to students. Null if no title has been set.
|
|
139
151
|
*/
|
|
140
152
|
title: string | null;
|
|
141
153
|
/**
|
|
142
|
-
* The
|
|
154
|
+
* The datetime the course was last updated.
|
|
143
155
|
*/
|
|
144
156
|
updated_at: string;
|
|
145
157
|
/**
|
|
146
|
-
* The visibility
|
|
147
|
-
*
|
|
158
|
+
* The visibility setting that controls whether this course appears to students.
|
|
159
|
+
* One of: visible, hidden.
|
|
148
160
|
*/
|
|
149
161
|
visibility: CourseVisibilities;
|
|
150
162
|
}
|
|
151
163
|
export declare namespace Course {
|
|
152
164
|
/**
|
|
153
|
-
* A
|
|
165
|
+
* A grouping of related lessons within a course, used to organize content into
|
|
166
|
+
* sections.
|
|
154
167
|
*/
|
|
155
168
|
interface Chapter {
|
|
156
169
|
/**
|
|
157
|
-
* The
|
|
170
|
+
* The unique identifier for the chapter.
|
|
158
171
|
*/
|
|
159
172
|
id: string;
|
|
160
173
|
/**
|
|
161
|
-
*
|
|
174
|
+
* An ordered list of lessons in this chapter, sorted by display position. Hidden
|
|
175
|
+
* lessons are excluded for non-admin users.
|
|
162
176
|
*/
|
|
163
177
|
lessons: Array<Chapter.Lesson>;
|
|
164
178
|
/**
|
|
165
|
-
* The
|
|
179
|
+
* The sort position of this chapter within its parent course, starting from zero.
|
|
166
180
|
*/
|
|
167
181
|
order: number;
|
|
168
182
|
/**
|
|
169
|
-
* The
|
|
183
|
+
* The display name of the chapter shown to students. Maximum 150 characters.
|
|
170
184
|
*/
|
|
171
185
|
title: string;
|
|
172
186
|
}
|
|
173
187
|
namespace Chapter {
|
|
174
188
|
/**
|
|
175
|
-
*
|
|
189
|
+
* An individual learning unit within a chapter, which can contain text, video,
|
|
190
|
+
* PDF, or assessment content.
|
|
176
191
|
*/
|
|
177
192
|
interface Lesson {
|
|
178
193
|
/**
|
|
179
|
-
* The
|
|
194
|
+
* The unique identifier for the lesson.
|
|
180
195
|
*/
|
|
181
196
|
id: string;
|
|
182
197
|
/**
|
|
183
|
-
* The
|
|
198
|
+
* The content format of this lesson. One of: text, video, pdf, multi, quiz,
|
|
199
|
+
* knowledge_check.
|
|
184
200
|
*/
|
|
185
201
|
lesson_type: CourseLessonsAPI.LessonTypes;
|
|
186
202
|
/**
|
|
187
|
-
* The
|
|
203
|
+
* The sort position of this lesson within its parent chapter, starting from zero.
|
|
188
204
|
*/
|
|
189
205
|
order: number;
|
|
190
206
|
/**
|
|
191
|
-
* The thumbnail
|
|
207
|
+
* The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
|
|
208
|
+
* has been uploaded.
|
|
192
209
|
*/
|
|
193
210
|
thumbnail: Lesson.Thumbnail | null;
|
|
194
211
|
/**
|
|
195
|
-
* The
|
|
212
|
+
* The display name of the lesson shown to students. Maximum 120 characters.
|
|
196
213
|
*/
|
|
197
214
|
title: string;
|
|
198
215
|
/**
|
|
199
|
-
* The
|
|
216
|
+
* The Mux video asset for video-type lessons, used for streaming playback. Null if
|
|
217
|
+
* this lesson has no hosted video.
|
|
200
218
|
*/
|
|
201
219
|
video_asset: Lesson.VideoAsset | null;
|
|
202
220
|
}
|
|
203
221
|
namespace Lesson {
|
|
204
222
|
/**
|
|
205
|
-
* The thumbnail
|
|
223
|
+
* The thumbnail image displayed on lesson cards and previews. Null if no thumbnail
|
|
224
|
+
* has been uploaded.
|
|
206
225
|
*/
|
|
207
226
|
interface Thumbnail {
|
|
208
227
|
/**
|
|
209
|
-
*
|
|
210
|
-
*
|
|
228
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
229
|
+
* used for displaying attachments in apps.
|
|
211
230
|
*/
|
|
212
231
|
url: string | null;
|
|
213
232
|
}
|
|
214
233
|
/**
|
|
215
|
-
* The
|
|
234
|
+
* The Mux video asset for video-type lessons, used for streaming playback. Null if
|
|
235
|
+
* this lesson has no hosted video.
|
|
216
236
|
*/
|
|
217
237
|
interface VideoAsset {
|
|
218
238
|
/**
|
|
@@ -231,29 +251,35 @@ export declare namespace Course {
|
|
|
231
251
|
}
|
|
232
252
|
}
|
|
233
253
|
/**
|
|
234
|
-
* The thumbnail
|
|
254
|
+
* The thumbnail image displayed on course cards and previews. Null if no thumbnail
|
|
255
|
+
* has been uploaded.
|
|
235
256
|
*/
|
|
236
257
|
interface Thumbnail {
|
|
237
258
|
/**
|
|
238
|
-
*
|
|
259
|
+
* Represents a unique identifier that is Base64 obfuscated. It is often used to
|
|
260
|
+
* refetch an object or as key for a cache. The ID type appears in a JSON response
|
|
261
|
+
* as a String; however, it is not intended to be human-readable. When expected as
|
|
262
|
+
* an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
|
|
263
|
+
* input value will be accepted as an ID.
|
|
239
264
|
*/
|
|
240
265
|
id: string;
|
|
241
266
|
/**
|
|
242
|
-
* The
|
|
267
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
243
268
|
*/
|
|
244
269
|
content_type: string | null;
|
|
245
270
|
/**
|
|
246
|
-
* The
|
|
271
|
+
* The original filename of the uploaded attachment, including its file extension.
|
|
247
272
|
*/
|
|
248
273
|
filename: string | null;
|
|
249
274
|
/**
|
|
250
|
-
*
|
|
251
|
-
*
|
|
275
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
276
|
+
* used for displaying attachments in apps.
|
|
252
277
|
*/
|
|
253
278
|
optimized_url: string | null;
|
|
254
279
|
/**
|
|
255
|
-
* The original URL of the attachment, such as a direct link to S3. This
|
|
256
|
-
* never be displayed on the client and always passed
|
|
280
|
+
* The original source URL of the attachment, such as a direct link to S3. This
|
|
281
|
+
* should never be displayed on the client and should always be passed through an
|
|
282
|
+
* Imgproxy transformer.
|
|
257
283
|
*/
|
|
258
284
|
source_url: string | null;
|
|
259
285
|
}
|
|
@@ -268,91 +294,104 @@ export type CourseVisibilities = 'visible' | 'hidden';
|
|
|
268
294
|
*/
|
|
269
295
|
export type Languages = 'en' | 'es' | 'it' | 'pt' | 'de' | 'fr' | 'pl' | 'ru' | 'nl' | 'ca' | 'tr' | 'sv' | 'uk' | 'no' | 'fi' | 'sk' | 'el' | 'cs' | 'hr' | 'da' | 'ro' | 'bg';
|
|
270
296
|
/**
|
|
271
|
-
* A
|
|
297
|
+
* A structured learning module containing chapters and lessons, belonging to an
|
|
298
|
+
* experience.
|
|
272
299
|
*/
|
|
273
300
|
export interface CourseListResponse {
|
|
274
301
|
/**
|
|
275
|
-
* The
|
|
302
|
+
* The unique identifier for the course.
|
|
276
303
|
*/
|
|
277
304
|
id: string;
|
|
278
305
|
/**
|
|
279
|
-
* Whether
|
|
280
|
-
*
|
|
306
|
+
* Whether students receive a PDF certificate after completing all lessons in this
|
|
307
|
+
* course. Null if the setting has not been configured.
|
|
281
308
|
*/
|
|
282
309
|
certificate_after_completion_enabled: boolean | null;
|
|
283
310
|
/**
|
|
284
|
-
* The URL of the course
|
|
311
|
+
* The URL of the course cover image shown on preview cards. Null if no cover image
|
|
312
|
+
* has been uploaded.
|
|
285
313
|
*/
|
|
286
314
|
cover_image: string | null;
|
|
287
315
|
/**
|
|
288
|
-
* The
|
|
316
|
+
* The datetime the course was created.
|
|
289
317
|
*/
|
|
290
318
|
created_at: string;
|
|
291
319
|
/**
|
|
292
|
-
* A
|
|
320
|
+
* A brief summary of the course content and objectives. Null if no description has
|
|
321
|
+
* been set.
|
|
293
322
|
*/
|
|
294
323
|
description: string | null;
|
|
295
324
|
/**
|
|
296
|
-
* The language
|
|
297
|
-
* captions
|
|
325
|
+
* The spoken language of the video content, used to generate accurate closed
|
|
326
|
+
* captions. One of: en, es, it, pt, de, fr, pl, ru, nl, ca, tr, sv, uk, no, fi,
|
|
327
|
+
* sk, el, cs, hr, da, ro, bg.
|
|
298
328
|
*/
|
|
299
329
|
language: Languages;
|
|
300
330
|
/**
|
|
301
|
-
* The
|
|
331
|
+
* The sort position of this course within its parent experience, as a decimal for
|
|
332
|
+
* flexible ordering.
|
|
302
333
|
*/
|
|
303
334
|
order: string;
|
|
304
335
|
/**
|
|
305
|
-
* Whether
|
|
306
|
-
*
|
|
336
|
+
* Whether students must complete each lesson sequentially before advancing to the
|
|
337
|
+
* next one.
|
|
307
338
|
*/
|
|
308
339
|
require_completing_lessons_in_order: boolean;
|
|
309
340
|
/**
|
|
310
|
-
* A short tagline
|
|
341
|
+
* A short marketing tagline displayed beneath the course title. Null if no tagline
|
|
342
|
+
* has been set.
|
|
311
343
|
*/
|
|
312
344
|
tagline: string | null;
|
|
313
345
|
/**
|
|
314
|
-
* The thumbnail
|
|
346
|
+
* The thumbnail image displayed on course cards and previews. Null if no thumbnail
|
|
347
|
+
* has been uploaded.
|
|
315
348
|
*/
|
|
316
349
|
thumbnail: CourseListResponse.Thumbnail | null;
|
|
317
350
|
/**
|
|
318
|
-
* The
|
|
351
|
+
* The display name of the course shown to students. Null if no title has been set.
|
|
319
352
|
*/
|
|
320
353
|
title: string | null;
|
|
321
354
|
/**
|
|
322
|
-
* The
|
|
355
|
+
* The datetime the course was last updated.
|
|
323
356
|
*/
|
|
324
357
|
updated_at: string;
|
|
325
358
|
/**
|
|
326
|
-
* The visibility
|
|
327
|
-
*
|
|
359
|
+
* The visibility setting that controls whether this course appears to students.
|
|
360
|
+
* One of: visible, hidden.
|
|
328
361
|
*/
|
|
329
362
|
visibility: CourseVisibilities;
|
|
330
363
|
}
|
|
331
364
|
export declare namespace CourseListResponse {
|
|
332
365
|
/**
|
|
333
|
-
* The thumbnail
|
|
366
|
+
* The thumbnail image displayed on course cards and previews. Null if no thumbnail
|
|
367
|
+
* has been uploaded.
|
|
334
368
|
*/
|
|
335
369
|
interface Thumbnail {
|
|
336
370
|
/**
|
|
337
|
-
*
|
|
371
|
+
* Represents a unique identifier that is Base64 obfuscated. It is often used to
|
|
372
|
+
* refetch an object or as key for a cache. The ID type appears in a JSON response
|
|
373
|
+
* as a String; however, it is not intended to be human-readable. When expected as
|
|
374
|
+
* an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
|
|
375
|
+
* input value will be accepted as an ID.
|
|
338
376
|
*/
|
|
339
377
|
id: string;
|
|
340
378
|
/**
|
|
341
|
-
* The
|
|
379
|
+
* The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
|
|
342
380
|
*/
|
|
343
381
|
content_type: string | null;
|
|
344
382
|
/**
|
|
345
|
-
* The
|
|
383
|
+
* The original filename of the uploaded attachment, including its file extension.
|
|
346
384
|
*/
|
|
347
385
|
filename: string | null;
|
|
348
386
|
/**
|
|
349
|
-
*
|
|
350
|
-
*
|
|
387
|
+
* A pre-optimized URL for rendering this attachment on the client. This should be
|
|
388
|
+
* used for displaying attachments in apps.
|
|
351
389
|
*/
|
|
352
390
|
optimized_url: string | null;
|
|
353
391
|
/**
|
|
354
|
-
* The original URL of the attachment, such as a direct link to S3. This
|
|
355
|
-
* never be displayed on the client and always passed
|
|
392
|
+
* The original source URL of the attachment, such as a direct link to S3. This
|
|
393
|
+
* should never be displayed on the client and should always be passed through an
|
|
394
|
+
* Imgproxy transformer.
|
|
356
395
|
*/
|
|
357
396
|
source_url: string | null;
|
|
358
397
|
}
|
|
@@ -363,35 +402,36 @@ export declare namespace CourseListResponse {
|
|
|
363
402
|
export type CourseDeleteResponse = boolean;
|
|
364
403
|
export interface CourseCreateParams {
|
|
365
404
|
/**
|
|
366
|
-
* The
|
|
405
|
+
* The unique identifier of the experience to create the course in (e.g.,
|
|
406
|
+
* "exp_XXXXX").
|
|
367
407
|
*/
|
|
368
408
|
experience_id: string;
|
|
369
409
|
/**
|
|
370
|
-
* The title of the course
|
|
410
|
+
* The display title of the course (e.g., "Introduction to Web Development").
|
|
371
411
|
*/
|
|
372
412
|
title: string;
|
|
373
413
|
/**
|
|
374
|
-
* Whether the course
|
|
375
|
-
*
|
|
414
|
+
* Whether the course awards students a PDF certificate after completing all
|
|
415
|
+
* lessons.
|
|
376
416
|
*/
|
|
377
417
|
certificate_after_completion_enabled?: boolean | null;
|
|
378
418
|
/**
|
|
379
|
-
* The decimal order position of the course within its experience.
|
|
380
|
-
*
|
|
381
|
-
* to place between existing courses.
|
|
419
|
+
* The decimal order position of the course within its experience. Use fractional
|
|
420
|
+
* values (e.g., "1.5") to place between existing courses.
|
|
382
421
|
*/
|
|
383
422
|
order?: string | null;
|
|
384
423
|
/**
|
|
385
|
-
* Whether
|
|
386
|
-
*
|
|
424
|
+
* Whether students must complete each lesson sequentially before advancing to the
|
|
425
|
+
* next one.
|
|
387
426
|
*/
|
|
388
427
|
require_completing_lessons_in_order?: boolean | null;
|
|
389
428
|
/**
|
|
390
|
-
*
|
|
429
|
+
* A short tagline displayed beneath the course title (e.g., "Master the
|
|
430
|
+
* fundamentals of design").
|
|
391
431
|
*/
|
|
392
432
|
tagline?: string | null;
|
|
393
433
|
/**
|
|
394
|
-
* The thumbnail for the course in
|
|
434
|
+
* The thumbnail image for the course in PNG, JPEG, or GIF format.
|
|
395
435
|
*/
|
|
396
436
|
thumbnail?: CourseCreateParams.Thumbnail | null;
|
|
397
437
|
/**
|
|
@@ -402,7 +442,7 @@ export interface CourseCreateParams {
|
|
|
402
442
|
}
|
|
403
443
|
export declare namespace CourseCreateParams {
|
|
404
444
|
/**
|
|
405
|
-
* The thumbnail for the course in
|
|
445
|
+
* The thumbnail image for the course in PNG, JPEG, or GIF format.
|
|
406
446
|
*/
|
|
407
447
|
interface Thumbnail {
|
|
408
448
|
/**
|
|
@@ -413,16 +453,16 @@ export declare namespace CourseCreateParams {
|
|
|
413
453
|
}
|
|
414
454
|
export interface CourseUpdateParams {
|
|
415
455
|
/**
|
|
416
|
-
* Whether the course
|
|
417
|
-
*
|
|
456
|
+
* Whether the course awards students a PDF certificate after completing all
|
|
457
|
+
* lessons.
|
|
418
458
|
*/
|
|
419
459
|
certificate_after_completion_enabled?: boolean | null;
|
|
420
460
|
/**
|
|
421
|
-
*
|
|
461
|
+
* A list of chapters with nested lessons to reorder or rename in bulk.
|
|
422
462
|
*/
|
|
423
463
|
chapters?: Array<CourseUpdateParams.Chapter> | null;
|
|
424
464
|
/**
|
|
425
|
-
* A short description of the course
|
|
465
|
+
* A short description of the course displayed to students on the course page.
|
|
426
466
|
*/
|
|
427
467
|
description?: string | null;
|
|
428
468
|
/**
|
|
@@ -431,24 +471,25 @@ export interface CourseUpdateParams {
|
|
|
431
471
|
language?: Languages | null;
|
|
432
472
|
/**
|
|
433
473
|
* The decimal order position of the course within its experience. Use fractional
|
|
434
|
-
* values (e.g., 1.5) to place between existing courses.
|
|
474
|
+
* values (e.g., "1.5") to place between existing courses.
|
|
435
475
|
*/
|
|
436
476
|
order?: string | null;
|
|
437
477
|
/**
|
|
438
|
-
* Whether
|
|
439
|
-
*
|
|
478
|
+
* Whether students must complete each lesson sequentially before advancing to the
|
|
479
|
+
* next one.
|
|
440
480
|
*/
|
|
441
481
|
require_completing_lessons_in_order?: boolean | null;
|
|
442
482
|
/**
|
|
443
|
-
* A short tagline
|
|
483
|
+
* A short tagline displayed beneath the course title (e.g., "Master the
|
|
484
|
+
* fundamentals of design").
|
|
444
485
|
*/
|
|
445
486
|
tagline?: string | null;
|
|
446
487
|
/**
|
|
447
|
-
* The thumbnail for the course in
|
|
488
|
+
* The thumbnail image for the course in PNG, JPEG, or GIF format.
|
|
448
489
|
*/
|
|
449
490
|
thumbnail?: CourseUpdateParams.Thumbnail | null;
|
|
450
491
|
/**
|
|
451
|
-
* The title of the course
|
|
492
|
+
* The display title of the course (e.g., "Introduction to Web Development").
|
|
452
493
|
*/
|
|
453
494
|
title?: string | null;
|
|
454
495
|
/**
|
|
@@ -503,7 +544,7 @@ export declare namespace CourseUpdateParams {
|
|
|
503
544
|
}
|
|
504
545
|
}
|
|
505
546
|
/**
|
|
506
|
-
* The thumbnail for the course in
|
|
547
|
+
* The thumbnail image for the course in PNG, JPEG, or GIF format.
|
|
507
548
|
*/
|
|
508
549
|
interface Thumbnail {
|
|
509
550
|
/**
|
|
@@ -518,11 +559,11 @@ export interface CourseListParams extends CursorPageParams {
|
|
|
518
559
|
*/
|
|
519
560
|
before?: string | null;
|
|
520
561
|
/**
|
|
521
|
-
* The
|
|
562
|
+
* The unique identifier of the company to list courses for.
|
|
522
563
|
*/
|
|
523
564
|
company_id?: string | null;
|
|
524
565
|
/**
|
|
525
|
-
* The
|
|
566
|
+
* The unique identifier of the experience to list courses for.
|
|
526
567
|
*/
|
|
527
568
|
experience_id?: string | null;
|
|
528
569
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"courses.d.ts","sourceRoot":"","sources":["../src/resources/courses.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"courses.d.ts","sourceRoot":"","sources":["../src/resources/courses.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oCAAoC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEhC;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,mCAAmC,EAAE,OAAO,CAAC;IAE7C;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,yBAAiB,MAAM,CAAC;IACtB;;;OAGG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE/B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,WAAW,EAAE,gBAAgB,CAAC,WAAW,CAAC;YAE1C;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;YAEnC;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,WAAW,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;SACvC;QAED,UAAiB,MAAM,CAAC;YACtB;;;eAGG;YACH,UAAiB,SAAS;gBACxB;;;mBAGG;gBACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;aACpB;YAED;;;eAGG;YACH,UAAiB,UAAU;gBACzB;;mBAEG;gBACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEhC;;mBAEG;gBACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,+BAA+B,EAAE,MAAM,GAAG,IAAI,CAAC;aAChD;SACF;KACF;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;;;WAMG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEtD;;GAEG;AACH,MAAM,MAAM,SAAS,GACjB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC;AAET;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,oCAAoC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,mCAAmC,EAAE,OAAO,CAAC;IAE7C;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,kBAAkB,CAAC,SAAS,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;OAGG;IACH,UAAiB,SAAS;QACxB;;;;;;WAMG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;;WAGG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;;;WAIG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtD;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,mCAAmC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEhD;;;OAGG;IACH,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,mCAAmC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACxC;IAED,UAAiB,OAAO,CAAC;QACvB;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
package/resources/courses.js
CHANGED
|
@@ -7,7 +7,8 @@ const pagination_1 = require("../core/pagination.js");
|
|
|
7
7
|
const path_1 = require("../internal/utils/path.js");
|
|
8
8
|
class Courses extends resource_1.APIResource {
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* Create a new course within an experience, with optional chapters, lessons, and a
|
|
11
|
+
* certificate.
|
|
11
12
|
*
|
|
12
13
|
* Required permissions:
|
|
13
14
|
*
|
|
@@ -25,7 +26,7 @@ class Courses extends resource_1.APIResource {
|
|
|
25
26
|
return this._client.post('/courses', { body, ...options });
|
|
26
27
|
}
|
|
27
28
|
/**
|
|
28
|
-
* Retrieves
|
|
29
|
+
* Retrieves the details of an existing course.
|
|
29
30
|
*
|
|
30
31
|
* Required permissions:
|
|
31
32
|
*
|
|
@@ -42,7 +43,8 @@ class Courses extends resource_1.APIResource {
|
|
|
42
43
|
return this._client.get((0, path_1.path) `/courses/${id}`, options);
|
|
43
44
|
}
|
|
44
45
|
/**
|
|
45
|
-
*
|
|
46
|
+
* Update a course's title, description, visibility, thumbnail, or chapter
|
|
47
|
+
* ordering.
|
|
46
48
|
*
|
|
47
49
|
* Required permissions:
|
|
48
50
|
*
|
|
@@ -59,7 +61,8 @@ class Courses extends resource_1.APIResource {
|
|
|
59
61
|
return this._client.patch((0, path_1.path) `/courses/${id}`, { body, ...options });
|
|
60
62
|
}
|
|
61
63
|
/**
|
|
62
|
-
*
|
|
64
|
+
* Returns a paginated list of courses, filtered by either an experience or a
|
|
65
|
+
* company.
|
|
63
66
|
*
|
|
64
67
|
* Required permissions:
|
|
65
68
|
*
|
|
@@ -77,7 +80,8 @@ class Courses extends resource_1.APIResource {
|
|
|
77
80
|
return this._client.getAPIList('/courses', (pagination_1.CursorPage), { query, ...options });
|
|
78
81
|
}
|
|
79
82
|
/**
|
|
80
|
-
*
|
|
83
|
+
* Permanently delete a course and all of its chapters, lessons, and student
|
|
84
|
+
* progress.
|
|
81
85
|
*
|
|
82
86
|
* Required permissions:
|
|
83
87
|
*
|
package/resources/courses.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"courses.js","sourceRoot":"","sources":["../src/resources/courses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC
|
|
1
|
+
{"version":3,"file":"courses.js","sourceRoot":"","sources":["../src/resources/courses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAwB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAU,EACV,OAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,uBAA8B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;CACF;AAvGD,0BAuGC"}
|