@whop/sdk 0.0.3 → 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +64 -0
- package/client.d.mts +14 -8
- package/client.d.mts.map +1 -1
- package/client.d.ts +14 -8
- package/client.d.ts.map +1 -1
- package/client.js +6 -0
- package/client.js.map +1 -1
- package/client.mjs +8 -2
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/access-tokens.d.mts +58 -0
- package/resources/access-tokens.d.mts.map +1 -0
- package/resources/access-tokens.d.ts +58 -0
- package/resources/access-tokens.d.ts.map +1 -0
- package/resources/access-tokens.js +25 -0
- package/resources/access-tokens.js.map +1 -0
- package/resources/access-tokens.mjs +21 -0
- package/resources/access-tokens.mjs.map +1 -0
- package/resources/app-builds.d.mts +16 -13
- package/resources/app-builds.d.mts.map +1 -1
- package/resources/app-builds.d.ts +16 -13
- package/resources/app-builds.d.ts.map +1 -1
- package/resources/app-builds.js +1 -1
- package/resources/app-builds.mjs +1 -1
- package/resources/apps.d.mts +15 -10
- package/resources/apps.d.mts.map +1 -1
- package/resources/apps.d.ts +15 -10
- package/resources/apps.d.ts.map +1 -1
- package/resources/checkout-configurations.d.mts +221 -183
- package/resources/checkout-configurations.d.mts.map +1 -1
- package/resources/checkout-configurations.d.ts +221 -183
- package/resources/checkout-configurations.d.ts.map +1 -1
- package/resources/checkout-configurations.js +4 -20
- package/resources/checkout-configurations.js.map +1 -1
- package/resources/checkout-configurations.mjs +4 -20
- package/resources/checkout-configurations.mjs.map +1 -1
- package/resources/companies.d.mts +157 -0
- package/resources/companies.d.mts.map +1 -1
- package/resources/companies.d.ts +157 -0
- package/resources/companies.d.ts.map +1 -1
- package/resources/companies.js +22 -0
- package/resources/companies.js.map +1 -1
- package/resources/companies.mjs +22 -0
- package/resources/companies.mjs.map +1 -1
- package/resources/course-lesson-interactions.d.mts +2 -2
- package/resources/course-lesson-interactions.d.ts +2 -2
- package/resources/course-lesson-interactions.js +2 -2
- package/resources/course-lesson-interactions.mjs +2 -2
- package/resources/course-lessons.d.mts +184 -24
- package/resources/course-lessons.d.mts.map +1 -1
- package/resources/course-lessons.d.ts +184 -24
- package/resources/course-lessons.d.ts.map +1 -1
- package/resources/course-students.d.mts +187 -0
- package/resources/course-students.d.mts.map +1 -0
- package/resources/course-students.d.ts +187 -0
- package/resources/course-students.d.ts.map +1 -0
- package/resources/course-students.js +36 -0
- package/resources/course-students.js.map +1 -0
- package/resources/course-students.mjs +32 -0
- package/resources/course-students.mjs.map +1 -0
- package/resources/courses.d.mts +85 -21
- package/resources/courses.d.mts.map +1 -1
- package/resources/courses.d.ts +85 -21
- package/resources/courses.d.ts.map +1 -1
- package/resources/entries.d.mts +2 -2
- package/resources/entries.d.ts +2 -2
- package/resources/experiences.d.mts +15 -10
- package/resources/experiences.d.mts.map +1 -1
- package/resources/experiences.d.ts +15 -10
- package/resources/experiences.d.ts.map +1 -1
- package/resources/forum-posts.d.mts +29 -19
- package/resources/forum-posts.d.mts.map +1 -1
- package/resources/forum-posts.d.ts +29 -19
- package/resources/forum-posts.d.ts.map +1 -1
- package/resources/index.d.mts +6 -4
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +5 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invoices.d.mts +539 -167
- package/resources/invoices.d.mts.map +1 -1
- package/resources/invoices.d.ts +539 -167
- package/resources/invoices.d.ts.map +1 -1
- package/resources/invoices.js +2 -24
- package/resources/invoices.js.map +1 -1
- package/resources/invoices.mjs +2 -24
- package/resources/invoices.mjs.map +1 -1
- package/resources/ledger-accounts.d.mts +1 -1
- package/resources/ledger-accounts.d.ts +1 -1
- package/resources/ledger-accounts.js +1 -1
- package/resources/ledger-accounts.mjs +1 -1
- package/resources/members.d.mts +11 -11
- package/resources/members.d.mts.map +1 -1
- package/resources/members.d.ts +11 -11
- package/resources/members.d.ts.map +1 -1
- package/resources/memberships.d.mts +4 -4
- package/resources/memberships.d.mts.map +1 -1
- package/resources/memberships.d.ts +4 -4
- package/resources/memberships.d.ts.map +1 -1
- package/resources/messages.d.mts +29 -19
- package/resources/messages.d.mts.map +1 -1
- package/resources/messages.d.ts +29 -19
- package/resources/messages.d.ts.map +1 -1
- package/resources/payments.d.mts +10 -3
- package/resources/payments.d.mts.map +1 -1
- package/resources/payments.d.ts +10 -3
- package/resources/payments.d.ts.map +1 -1
- package/resources/plans.d.mts +118 -20
- package/resources/plans.d.mts.map +1 -1
- package/resources/plans.d.ts +118 -20
- package/resources/plans.d.ts.map +1 -1
- package/resources/plans.js.map +1 -1
- package/resources/plans.mjs.map +1 -1
- package/resources/products.d.mts +20 -15
- package/resources/products.d.mts.map +1 -1
- package/resources/products.d.ts +20 -15
- package/resources/products.d.ts.map +1 -1
- package/resources/promo-codes.d.mts +4 -4
- package/resources/promo-codes.d.ts +4 -4
- package/resources/shared.d.mts +69 -20
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +69 -20
- package/resources/shared.d.ts.map +1 -1
- package/resources/transfers.d.mts +12 -0
- package/resources/transfers.d.mts.map +1 -1
- package/resources/transfers.d.ts +12 -0
- package/resources/transfers.d.ts.map +1 -1
- package/resources/users.d.mts +3 -0
- package/resources/users.d.mts.map +1 -1
- package/resources/users.d.ts +3 -0
- package/resources/users.d.ts.map +1 -1
- package/src/client.ts +45 -10
- package/src/resources/access-tokens.ts +72 -0
- package/src/resources/app-builds.ts +19 -14
- package/src/resources/apps.ts +16 -11
- package/src/resources/checkout-configurations.ts +245 -199
- package/src/resources/companies.ts +196 -0
- package/src/resources/course-lesson-interactions.ts +2 -2
- package/src/resources/course-lessons.ts +223 -24
- package/src/resources/course-students.ts +238 -0
- package/src/resources/courses.ts +104 -22
- package/src/resources/entries.ts +2 -2
- package/src/resources/experiences.ts +19 -11
- package/src/resources/forum-posts.ts +35 -21
- package/src/resources/index.ts +17 -2
- package/src/resources/invoices.ts +630 -171
- package/src/resources/ledger-accounts.ts +1 -1
- package/src/resources/members.ts +12 -12
- package/src/resources/memberships.ts +5 -5
- package/src/resources/messages.ts +35 -21
- package/src/resources/payments.ts +10 -3
- package/src/resources/plans.ts +130 -20
- package/src/resources/products.ts +24 -16
- package/src/resources/promo-codes.ts +4 -4
- package/src/resources/shared.ts +70 -20
- package/src/resources/transfers.ts +10 -0
- package/src/resources/users.ts +3 -0
- 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
|
@@ -87,6 +87,10 @@ export type CourseLessonListResponsesCursorPage = CursorPage<CourseLessonListRes
|
|
|
87
87
|
* The available types for an assessment question
|
|
88
88
|
*/
|
|
89
89
|
export type AssessmentQuestionTypes = 'short_answer' | 'true_false' | 'multiple_choice' | 'multiple_select';
|
|
90
|
+
/**
|
|
91
|
+
* The type of embed for a lesson
|
|
92
|
+
*/
|
|
93
|
+
export type EmbedType = 'youtube' | 'loom';
|
|
90
94
|
/**
|
|
91
95
|
* A lesson from the courses app
|
|
92
96
|
*/
|
|
@@ -111,6 +115,14 @@ export interface Lesson {
|
|
|
111
115
|
* Number of days from course start until the lesson is unlocked
|
|
112
116
|
*/
|
|
113
117
|
days_from_course_start_until_unlock: number | null;
|
|
118
|
+
/**
|
|
119
|
+
* ID for the embed (YouTube video ID or Loom share ID)
|
|
120
|
+
*/
|
|
121
|
+
embed_id: string | null;
|
|
122
|
+
/**
|
|
123
|
+
* The type of embed for a lesson
|
|
124
|
+
*/
|
|
125
|
+
embed_type: EmbedType | null;
|
|
114
126
|
/**
|
|
115
127
|
* The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
|
|
116
128
|
*/
|
|
@@ -123,6 +135,10 @@ export interface Lesson {
|
|
|
123
135
|
* The order of the lesson within its chapter
|
|
124
136
|
*/
|
|
125
137
|
order: number;
|
|
138
|
+
/**
|
|
139
|
+
* The thumbnail for the lesson
|
|
140
|
+
*/
|
|
141
|
+
thumbnail: Lesson.Thumbnail | null;
|
|
126
142
|
/**
|
|
127
143
|
* The title of the lesson
|
|
128
144
|
*/
|
|
@@ -147,9 +163,10 @@ export declare namespace Lesson {
|
|
|
147
163
|
*/
|
|
148
164
|
id: string;
|
|
149
165
|
/**
|
|
150
|
-
* The correct answer for the question. Used for short answer questions
|
|
166
|
+
* The correct answer for the question. Used for short answer questions. Only
|
|
167
|
+
* visible to admins (users with courses:update permission)
|
|
151
168
|
*/
|
|
152
|
-
correct_answer: string;
|
|
169
|
+
correct_answer: string | null;
|
|
153
170
|
/**
|
|
154
171
|
* When the question was created
|
|
155
172
|
*/
|
|
@@ -207,9 +224,10 @@ export declare namespace Lesson {
|
|
|
207
224
|
*/
|
|
208
225
|
id: string;
|
|
209
226
|
/**
|
|
210
|
-
* Whether this option is a correct answer
|
|
227
|
+
* Whether this option is a correct answer. Only visible to admins (users with
|
|
228
|
+
* courses:update permission)
|
|
211
229
|
*/
|
|
212
|
-
is_correct: boolean;
|
|
230
|
+
is_correct: boolean | null;
|
|
213
231
|
/**
|
|
214
232
|
* The text of the answer option
|
|
215
233
|
*/
|
|
@@ -264,6 +282,16 @@ export declare namespace Lesson {
|
|
|
264
282
|
*/
|
|
265
283
|
url: string | null;
|
|
266
284
|
}
|
|
285
|
+
/**
|
|
286
|
+
* The thumbnail for the lesson
|
|
287
|
+
*/
|
|
288
|
+
interface Thumbnail {
|
|
289
|
+
/**
|
|
290
|
+
* This is the URL you use to render optimized attachments on the client. This
|
|
291
|
+
* should be used for apps.
|
|
292
|
+
*/
|
|
293
|
+
url: string | null;
|
|
294
|
+
}
|
|
267
295
|
/**
|
|
268
296
|
* The associated Mux asset for video lessons
|
|
269
297
|
*/
|
|
@@ -307,6 +335,14 @@ export interface CourseLessonListResponse {
|
|
|
307
335
|
* Number of days from course start until the lesson is unlocked
|
|
308
336
|
*/
|
|
309
337
|
days_from_course_start_until_unlock: number | null;
|
|
338
|
+
/**
|
|
339
|
+
* ID for the embed (YouTube video ID or Loom share ID)
|
|
340
|
+
*/
|
|
341
|
+
embed_id: string | null;
|
|
342
|
+
/**
|
|
343
|
+
* The type of embed for a lesson
|
|
344
|
+
*/
|
|
345
|
+
embed_type: EmbedType | null;
|
|
310
346
|
/**
|
|
311
347
|
* The type of the lesson (text, video, pdf, multi, quiz, knowledge_check)
|
|
312
348
|
*/
|
|
@@ -315,6 +351,10 @@ export interface CourseLessonListResponse {
|
|
|
315
351
|
* The order of the lesson within its chapter
|
|
316
352
|
*/
|
|
317
353
|
order: number;
|
|
354
|
+
/**
|
|
355
|
+
* The thumbnail for the lesson
|
|
356
|
+
*/
|
|
357
|
+
thumbnail: CourseLessonListResponse.Thumbnail | null;
|
|
318
358
|
/**
|
|
319
359
|
* The title of the lesson
|
|
320
360
|
*/
|
|
@@ -325,6 +365,18 @@ export interface CourseLessonListResponse {
|
|
|
325
365
|
*/
|
|
326
366
|
visibility: LessonVisibilities;
|
|
327
367
|
}
|
|
368
|
+
export declare namespace CourseLessonListResponse {
|
|
369
|
+
/**
|
|
370
|
+
* The thumbnail for the lesson
|
|
371
|
+
*/
|
|
372
|
+
interface Thumbnail {
|
|
373
|
+
/**
|
|
374
|
+
* This is the URL you use to render optimized attachments on the client. This
|
|
375
|
+
* should be used for apps.
|
|
376
|
+
*/
|
|
377
|
+
url: string | null;
|
|
378
|
+
}
|
|
379
|
+
}
|
|
328
380
|
/**
|
|
329
381
|
* Represents `true` or `false` values.
|
|
330
382
|
*/
|
|
@@ -346,12 +398,52 @@ export interface CourseLessonCreateParams {
|
|
|
346
398
|
* Days from course start until unlock
|
|
347
399
|
*/
|
|
348
400
|
days_from_course_start_until_unlock?: number | null;
|
|
401
|
+
/**
|
|
402
|
+
* ID for the embed (YouTube video ID or Loom share ID)
|
|
403
|
+
*/
|
|
404
|
+
embed_id?: string | null;
|
|
405
|
+
/**
|
|
406
|
+
* The type of embed for a lesson
|
|
407
|
+
*/
|
|
408
|
+
embed_type?: EmbedType | null;
|
|
409
|
+
/**
|
|
410
|
+
* The thumbnail for the lesson in png, jpeg, or gif format
|
|
411
|
+
*/
|
|
412
|
+
thumbnail?: CourseLessonCreateParams.AttachmentInputWithDirectUploadID | CourseLessonCreateParams.AttachmentInputWithID | null;
|
|
349
413
|
/**
|
|
350
414
|
* The title of the lesson
|
|
351
415
|
*/
|
|
352
416
|
title?: string | null;
|
|
353
417
|
}
|
|
418
|
+
export declare namespace CourseLessonCreateParams {
|
|
419
|
+
/**
|
|
420
|
+
* Input for an attachment
|
|
421
|
+
*/
|
|
422
|
+
interface AttachmentInputWithDirectUploadID {
|
|
423
|
+
/**
|
|
424
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
425
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
426
|
+
* mediaDirectUpload mutation.
|
|
427
|
+
*/
|
|
428
|
+
direct_upload_id: string;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* Input for an attachment
|
|
432
|
+
*/
|
|
433
|
+
interface AttachmentInputWithID {
|
|
434
|
+
/**
|
|
435
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
436
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
437
|
+
* doing.
|
|
438
|
+
*/
|
|
439
|
+
id: string;
|
|
440
|
+
}
|
|
441
|
+
}
|
|
354
442
|
export interface CourseLessonUpdateParams {
|
|
443
|
+
/**
|
|
444
|
+
* Completion requirements for quiz/knowledge check lessons
|
|
445
|
+
*/
|
|
446
|
+
assessment_completion_requirement?: CourseLessonUpdateParams.AssessmentCompletionRequirement | null;
|
|
355
447
|
/**
|
|
356
448
|
* Assessment questions for quiz/knowledge check lessons. Replaces all existing
|
|
357
449
|
* questions.
|
|
@@ -361,7 +453,7 @@ export interface CourseLessonUpdateParams {
|
|
|
361
453
|
* General attachments for the lesson (PDFs, files, etc). Replaces all existing
|
|
362
454
|
* attachments.
|
|
363
455
|
*/
|
|
364
|
-
attachments?: Array<CourseLessonUpdateParams.
|
|
456
|
+
attachments?: Array<CourseLessonUpdateParams.AttachmentInputWithDirectUploadID | CourseLessonUpdateParams.AttachmentInputWithID> | null;
|
|
365
457
|
/**
|
|
366
458
|
* The content of the lesson
|
|
367
459
|
*/
|
|
@@ -370,6 +462,14 @@ export interface CourseLessonUpdateParams {
|
|
|
370
462
|
* Days from course start until unlock
|
|
371
463
|
*/
|
|
372
464
|
days_from_course_start_until_unlock?: number | null;
|
|
465
|
+
/**
|
|
466
|
+
* ID for the embed (YouTube video ID or Loom share ID)
|
|
467
|
+
*/
|
|
468
|
+
embed_id?: string | null;
|
|
469
|
+
/**
|
|
470
|
+
* The type of embed for a lesson
|
|
471
|
+
*/
|
|
472
|
+
embed_type?: EmbedType | null;
|
|
373
473
|
/**
|
|
374
474
|
* The available types for a lesson
|
|
375
475
|
*/
|
|
@@ -377,11 +477,19 @@ export interface CourseLessonUpdateParams {
|
|
|
377
477
|
/**
|
|
378
478
|
* The main PDF file for this lesson
|
|
379
479
|
*/
|
|
380
|
-
main_pdf?: CourseLessonUpdateParams.
|
|
480
|
+
main_pdf?: CourseLessonUpdateParams.AttachmentInputWithDirectUploadID | CourseLessonUpdateParams.AttachmentInputWithID | null;
|
|
481
|
+
/**
|
|
482
|
+
* Maximum number of attempts allowed for assessments
|
|
483
|
+
*/
|
|
484
|
+
max_attempts?: number | null;
|
|
381
485
|
/**
|
|
382
486
|
* The ID of the Mux asset to attach to this lesson for video lessons
|
|
383
487
|
*/
|
|
384
488
|
mux_asset_id?: string | null;
|
|
489
|
+
/**
|
|
490
|
+
* The thumbnail for the lesson in png, jpeg, or gif format
|
|
491
|
+
*/
|
|
492
|
+
thumbnail?: CourseLessonUpdateParams.AttachmentInputWithDirectUploadID | CourseLessonUpdateParams.AttachmentInputWithID | null;
|
|
385
493
|
/**
|
|
386
494
|
* The title of the lesson
|
|
387
495
|
*/
|
|
@@ -393,6 +501,21 @@ export interface CourseLessonUpdateParams {
|
|
|
393
501
|
visibility?: LessonVisibilities | null;
|
|
394
502
|
}
|
|
395
503
|
export declare namespace CourseLessonUpdateParams {
|
|
504
|
+
/**
|
|
505
|
+
* Completion requirements for quiz/knowledge check lessons
|
|
506
|
+
*/
|
|
507
|
+
interface AssessmentCompletionRequirement {
|
|
508
|
+
/**
|
|
509
|
+
* The minimum grade percentage required to pass (0-100). Cannot be set together
|
|
510
|
+
* with minimum_questions_correct.
|
|
511
|
+
*/
|
|
512
|
+
minimum_grade_percent?: number | null;
|
|
513
|
+
/**
|
|
514
|
+
* The minimum number of questions that must be answered correctly. Cannot be set
|
|
515
|
+
* together with minimum_grade_percent.
|
|
516
|
+
*/
|
|
517
|
+
minimum_questions_correct?: number | null;
|
|
518
|
+
}
|
|
396
519
|
/**
|
|
397
520
|
* Input for creating or updating an assessment question
|
|
398
521
|
*/
|
|
@@ -417,7 +540,7 @@ export declare namespace CourseLessonUpdateParams {
|
|
|
417
540
|
/**
|
|
418
541
|
* Optional image attachment for the question
|
|
419
542
|
*/
|
|
420
|
-
image?: AssessmentQuestion.
|
|
543
|
+
image?: AssessmentQuestion.AttachmentInputWithDirectUploadID | AssessmentQuestion.AttachmentInputWithID | null;
|
|
421
544
|
/**
|
|
422
545
|
* The answer options for multiple choice/select questions
|
|
423
546
|
*/
|
|
@@ -425,21 +548,26 @@ export declare namespace CourseLessonUpdateParams {
|
|
|
425
548
|
}
|
|
426
549
|
namespace AssessmentQuestion {
|
|
427
550
|
/**
|
|
428
|
-
*
|
|
551
|
+
* Input for an attachment
|
|
429
552
|
*/
|
|
430
|
-
interface
|
|
431
|
-
/**
|
|
432
|
-
* The ID of an existing attachment object. Use this when updating a resource and
|
|
433
|
-
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
434
|
-
* doing.
|
|
435
|
-
*/
|
|
436
|
-
id?: string | null;
|
|
553
|
+
interface AttachmentInputWithDirectUploadID {
|
|
437
554
|
/**
|
|
438
555
|
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
439
556
|
* the direct upload that was created when uploading the file to S3 via the
|
|
440
557
|
* mediaDirectUpload mutation.
|
|
441
558
|
*/
|
|
442
|
-
direct_upload_id
|
|
559
|
+
direct_upload_id: string;
|
|
560
|
+
}
|
|
561
|
+
/**
|
|
562
|
+
* Input for an attachment
|
|
563
|
+
*/
|
|
564
|
+
interface AttachmentInputWithID {
|
|
565
|
+
/**
|
|
566
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
567
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
568
|
+
* doing.
|
|
569
|
+
*/
|
|
570
|
+
id: string;
|
|
443
571
|
}
|
|
444
572
|
/**
|
|
445
573
|
* Input for creating or updating an assessment question option
|
|
@@ -463,36 +591,68 @@ export declare namespace CourseLessonUpdateParams {
|
|
|
463
591
|
/**
|
|
464
592
|
* Input for an attachment
|
|
465
593
|
*/
|
|
466
|
-
interface
|
|
594
|
+
interface AttachmentInputWithDirectUploadID {
|
|
595
|
+
/**
|
|
596
|
+
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
597
|
+
* the direct upload that was created when uploading the file to S3 via the
|
|
598
|
+
* mediaDirectUpload mutation.
|
|
599
|
+
*/
|
|
600
|
+
direct_upload_id: string;
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
* Input for an attachment
|
|
604
|
+
*/
|
|
605
|
+
interface AttachmentInputWithID {
|
|
467
606
|
/**
|
|
468
607
|
* The ID of an existing attachment object. Use this when updating a resource and
|
|
469
608
|
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
470
609
|
* doing.
|
|
471
610
|
*/
|
|
472
|
-
id
|
|
611
|
+
id: string;
|
|
612
|
+
}
|
|
613
|
+
/**
|
|
614
|
+
* Input for an attachment
|
|
615
|
+
*/
|
|
616
|
+
interface AttachmentInputWithDirectUploadID {
|
|
473
617
|
/**
|
|
474
618
|
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
475
619
|
* the direct upload that was created when uploading the file to S3 via the
|
|
476
620
|
* mediaDirectUpload mutation.
|
|
477
621
|
*/
|
|
478
|
-
direct_upload_id
|
|
622
|
+
direct_upload_id: string;
|
|
479
623
|
}
|
|
480
624
|
/**
|
|
481
|
-
*
|
|
625
|
+
* Input for an attachment
|
|
482
626
|
*/
|
|
483
|
-
interface
|
|
627
|
+
interface AttachmentInputWithID {
|
|
484
628
|
/**
|
|
485
629
|
* The ID of an existing attachment object. Use this when updating a resource and
|
|
486
630
|
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
487
631
|
* doing.
|
|
488
632
|
*/
|
|
489
|
-
id
|
|
633
|
+
id: string;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* Input for an attachment
|
|
637
|
+
*/
|
|
638
|
+
interface AttachmentInputWithDirectUploadID {
|
|
490
639
|
/**
|
|
491
640
|
* This ID should be used the first time you upload an attachment. It is the ID of
|
|
492
641
|
* the direct upload that was created when uploading the file to S3 via the
|
|
493
642
|
* mediaDirectUpload mutation.
|
|
494
643
|
*/
|
|
495
|
-
direct_upload_id
|
|
644
|
+
direct_upload_id: string;
|
|
645
|
+
}
|
|
646
|
+
/**
|
|
647
|
+
* Input for an attachment
|
|
648
|
+
*/
|
|
649
|
+
interface AttachmentInputWithID {
|
|
650
|
+
/**
|
|
651
|
+
* The ID of an existing attachment object. Use this when updating a resource and
|
|
652
|
+
* keeping a subset of the attachments. Don't use this unless you know what you're
|
|
653
|
+
* doing.
|
|
654
|
+
*/
|
|
655
|
+
id: string;
|
|
496
656
|
}
|
|
497
657
|
}
|
|
498
658
|
export interface CourseLessonListParams extends CursorPageParams {
|
|
@@ -518,6 +678,6 @@ export interface CourseLessonListParams extends CursorPageParams {
|
|
|
518
678
|
last?: number | null;
|
|
519
679
|
}
|
|
520
680
|
export declare namespace CourseLessons {
|
|
521
|
-
export { type AssessmentQuestionTypes as AssessmentQuestionTypes, type Lesson as Lesson, type LessonTypes as LessonTypes, type LessonVisibilities as LessonVisibilities, type CourseLessonListResponse as CourseLessonListResponse, type CourseLessonDeleteResponse as CourseLessonDeleteResponse, type CourseLessonListResponsesCursorPage as CourseLessonListResponsesCursorPage, type CourseLessonCreateParams as CourseLessonCreateParams, type CourseLessonUpdateParams as CourseLessonUpdateParams, type CourseLessonListParams as CourseLessonListParams, };
|
|
681
|
+
export { type AssessmentQuestionTypes as AssessmentQuestionTypes, type EmbedType as EmbedType, type Lesson as Lesson, type LessonTypes as LessonTypes, type LessonVisibilities as LessonVisibilities, type CourseLessonListResponse as CourseLessonListResponse, type CourseLessonDeleteResponse as CourseLessonDeleteResponse, type CourseLessonListResponsesCursorPage as CourseLessonListResponsesCursorPage, type CourseLessonCreateParams as CourseLessonCreateParams, type CourseLessonUpdateParams as CourseLessonUpdateParams, type CourseLessonListParams as CourseLessonListParams, };
|
|
522
682
|
}
|
|
523
683
|
//# sourceMappingURL=course-lessons.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"course-lessons.d.ts","sourceRoot":"","sources":["../src/resources/course-lessons.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,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;IAO7E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAE5G;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEvD;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX
|
|
1
|
+
{"version":3,"file":"course-lessons.d.ts","sourceRoot":"","sources":["../src/resources/course-lessons.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,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIpF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,wBAAwB,CAAC;IAO7E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGrF;AAED,MAAM,MAAM,mCAAmC,GAAG,UAAU,CAAC,wBAAwB,CAAC,CAAC;AAEvF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC;AAE5G;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAEvD;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAEtC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;QAEvC;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAE1C;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;KACzD;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,KAAK;YACpB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;;eAGG;YACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;;eAGG;YACH,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf;KACF;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;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,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;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,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,mCAAmC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,SAAS,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,wBAAwB,CAAC,SAAS,GAAG,IAAI,CAAC;IAErD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,EAAE,kBAAkB,CAAC;CAChC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,SAAS;QACxB;;;WAGG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;KACpB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAEjD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,mCAAmC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EACN,wBAAwB,CAAC,iCAAiC,GAC1D,wBAAwB,CAAC,qBAAqB,GAC9C,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,iCAAiC,CAAC,EAAE,wBAAwB,CAAC,+BAA+B,GAAG,IAAI,CAAC;IAEpG;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC;IAEjF;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CACf,wBAAwB,CAAC,iCAAiC,GAC1D,wBAAwB,CAAC,qBAAqB,CACjD,GAAG,IAAI,CAAC;IAET;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,mCAAmC,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,EACL,wBAAwB,CAAC,iCAAiC,GAC1D,wBAAwB,CAAC,qBAAqB,GAC9C,IAAI,CAAC;IAET;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EACN,wBAAwB,CAAC,iCAAiC,GAC1D,wBAAwB,CAAC,qBAAqB,GAC9C,IAAI,CAAC;IAET;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,+BAA+B;QAC9C;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC;;;WAGG;QACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3C;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,EAAE,gBAAgB,CAAC,uBAAuB,CAAC;QAExD;;;WAGG;QACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EACF,kBAAkB,CAAC,iCAAiC,GACpD,kBAAkB,CAAC,qBAAqB,GACxC,IAAI,CAAC;QAET;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;KACnD;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,iCAAiC;YAChD;;;;eAIG;YACH,gBAAgB,EAAE,MAAM,CAAC;SAC1B;QAED;;WAEG;QACH,UAAiB,qBAAqB;YACpC;;;;eAIG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;QAED;;WAEG;QACH,UAAiB,MAAM;YACrB;;eAEG;YACH,UAAU,EAAE,OAAO,CAAC;YAEpB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACpB;KACF;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;;;WAIG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;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,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class CourseStudents extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Retrieves a course student by interaction ID
|
|
8
|
+
*
|
|
9
|
+
* Required permissions:
|
|
10
|
+
*
|
|
11
|
+
* - `courses:read`
|
|
12
|
+
* - `course_analytics:read`
|
|
13
|
+
*/
|
|
14
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<CourseStudentRetrieveResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* Lists students for a course
|
|
17
|
+
*
|
|
18
|
+
* Required permissions:
|
|
19
|
+
*
|
|
20
|
+
* - `courses:read`
|
|
21
|
+
* - `course_analytics:read`
|
|
22
|
+
*/
|
|
23
|
+
list(query: CourseStudentListParams, options?: RequestOptions): PagePromise<CourseStudentListResponsesCursorPage, CourseStudentListResponse>;
|
|
24
|
+
}
|
|
25
|
+
export type CourseStudentListResponsesCursorPage = CursorPage<CourseStudentListResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* A course student (enrollment of a student in a course)
|
|
28
|
+
*/
|
|
29
|
+
export interface CourseStudentRetrieveResponse {
|
|
30
|
+
/**
|
|
31
|
+
* The ID of the course student. Looks like crsi_XXX
|
|
32
|
+
*/
|
|
33
|
+
id: string;
|
|
34
|
+
/**
|
|
35
|
+
* The number of lessons the student has completed
|
|
36
|
+
*/
|
|
37
|
+
completed_lessons_count: number;
|
|
38
|
+
/**
|
|
39
|
+
* The percentage of lessons completed (0-100)
|
|
40
|
+
*/
|
|
41
|
+
completion_rate: number;
|
|
42
|
+
/**
|
|
43
|
+
* The course the student is enrolled in
|
|
44
|
+
*/
|
|
45
|
+
course: CourseStudentRetrieveResponse.Course;
|
|
46
|
+
/**
|
|
47
|
+
* When the student first interacted with the course
|
|
48
|
+
*/
|
|
49
|
+
first_interaction_at: string;
|
|
50
|
+
/**
|
|
51
|
+
* When the student last interacted with the course
|
|
52
|
+
*/
|
|
53
|
+
last_interaction_at: string;
|
|
54
|
+
/**
|
|
55
|
+
* The total number of lessons the student has access to
|
|
56
|
+
*/
|
|
57
|
+
total_lessons_count: number;
|
|
58
|
+
/**
|
|
59
|
+
* The user who is enrolled in the course
|
|
60
|
+
*/
|
|
61
|
+
user: CourseStudentRetrieveResponse.User;
|
|
62
|
+
}
|
|
63
|
+
export declare namespace CourseStudentRetrieveResponse {
|
|
64
|
+
/**
|
|
65
|
+
* The course the student is enrolled in
|
|
66
|
+
*/
|
|
67
|
+
interface Course {
|
|
68
|
+
/**
|
|
69
|
+
* The ID of the course. Looks like cors_XXX
|
|
70
|
+
*/
|
|
71
|
+
id: string;
|
|
72
|
+
/**
|
|
73
|
+
* The experience that the course belongs to
|
|
74
|
+
*/
|
|
75
|
+
experience: Course.Experience;
|
|
76
|
+
/**
|
|
77
|
+
* The title of the course
|
|
78
|
+
*/
|
|
79
|
+
title: string | null;
|
|
80
|
+
}
|
|
81
|
+
namespace Course {
|
|
82
|
+
/**
|
|
83
|
+
* The experience that the course belongs to
|
|
84
|
+
*/
|
|
85
|
+
interface Experience {
|
|
86
|
+
/**
|
|
87
|
+
* The unique ID representing this experience
|
|
88
|
+
*/
|
|
89
|
+
id: string;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* The user who is enrolled in the course
|
|
94
|
+
*/
|
|
95
|
+
interface User {
|
|
96
|
+
/**
|
|
97
|
+
* The internal ID of the user.
|
|
98
|
+
*/
|
|
99
|
+
id: string;
|
|
100
|
+
/**
|
|
101
|
+
* The name of the user from their Whop account.
|
|
102
|
+
*/
|
|
103
|
+
name: string | null;
|
|
104
|
+
/**
|
|
105
|
+
* The username of the user from their Whop account.
|
|
106
|
+
*/
|
|
107
|
+
username: string;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* A course student (enrollment of a student in a course)
|
|
112
|
+
*/
|
|
113
|
+
export interface CourseStudentListResponse {
|
|
114
|
+
/**
|
|
115
|
+
* The ID of the course student. Looks like crsi_XXX
|
|
116
|
+
*/
|
|
117
|
+
id: string;
|
|
118
|
+
/**
|
|
119
|
+
* The number of lessons the student has completed
|
|
120
|
+
*/
|
|
121
|
+
completed_lessons_count: number;
|
|
122
|
+
/**
|
|
123
|
+
* The percentage of lessons completed (0-100)
|
|
124
|
+
*/
|
|
125
|
+
completion_rate: number;
|
|
126
|
+
/**
|
|
127
|
+
* When the student first interacted with the course
|
|
128
|
+
*/
|
|
129
|
+
first_interaction_at: string;
|
|
130
|
+
/**
|
|
131
|
+
* When the student last interacted with the course
|
|
132
|
+
*/
|
|
133
|
+
last_interaction_at: string;
|
|
134
|
+
/**
|
|
135
|
+
* The total number of lessons the student has access to
|
|
136
|
+
*/
|
|
137
|
+
total_lessons_count: number;
|
|
138
|
+
/**
|
|
139
|
+
* The user who is enrolled in the course
|
|
140
|
+
*/
|
|
141
|
+
user: CourseStudentListResponse.User;
|
|
142
|
+
}
|
|
143
|
+
export declare namespace CourseStudentListResponse {
|
|
144
|
+
/**
|
|
145
|
+
* The user who is enrolled in the course
|
|
146
|
+
*/
|
|
147
|
+
interface User {
|
|
148
|
+
/**
|
|
149
|
+
* The internal ID of the user.
|
|
150
|
+
*/
|
|
151
|
+
id: string;
|
|
152
|
+
/**
|
|
153
|
+
* The name of the user from their Whop account.
|
|
154
|
+
*/
|
|
155
|
+
name: string | null;
|
|
156
|
+
/**
|
|
157
|
+
* The username of the user from their Whop account.
|
|
158
|
+
*/
|
|
159
|
+
username: string;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
export interface CourseStudentListParams extends CursorPageParams {
|
|
163
|
+
/**
|
|
164
|
+
* The ID of the course
|
|
165
|
+
*/
|
|
166
|
+
course_id: string;
|
|
167
|
+
/**
|
|
168
|
+
* Returns the elements in the list that come before the specified cursor.
|
|
169
|
+
*/
|
|
170
|
+
before?: string | null;
|
|
171
|
+
/**
|
|
172
|
+
* Returns the first _n_ elements from the list.
|
|
173
|
+
*/
|
|
174
|
+
first?: number | null;
|
|
175
|
+
/**
|
|
176
|
+
* Filter students by name - returns students whose names match the keyword
|
|
177
|
+
*/
|
|
178
|
+
keyword?: string | null;
|
|
179
|
+
/**
|
|
180
|
+
* Returns the last _n_ elements from the list.
|
|
181
|
+
*/
|
|
182
|
+
last?: number | null;
|
|
183
|
+
}
|
|
184
|
+
export declare namespace CourseStudents {
|
|
185
|
+
export { type CourseStudentRetrieveResponse as CourseStudentRetrieveResponse, type CourseStudentListResponse as CourseStudentListResponse, type CourseStudentListResponsesCursorPage as CourseStudentListResponsesCursorPage, type CourseStudentListParams as CourseStudentListParams, };
|
|
186
|
+
}
|
|
187
|
+
//# sourceMappingURL=course-students.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"course-students.d.mts","sourceRoot":"","sources":["../src/resources/course-students.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,cAAe,SAAQ,WAAW;IAC7C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAIzF;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,yBAAyB,CAAC;CAMhF;AAED,MAAM,MAAM,oCAAoC,GAAG,UAAU,CAAC,yBAAyB,CAAC,CAAC;AAEzF;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,6BAA6B,CAAC,MAAM,CAAC;IAE7C;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC;QAE9B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;SACZ;KACF;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
|