@examplary/sdk 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.mts +48 -7
  2. package/dist/index.d.ts +48 -7
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.mjs.map +1 -1
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -2528,6 +2528,9 @@ interface operations {
2528
2528
  templateId?: string | null;
2529
2529
  } | null;
2530
2530
  showDoneButton?: boolean | null;
2531
+ hideTemplateOptions?: boolean | null;
2532
+ hideGenerateOptions?: boolean | null;
2533
+ hideExportOptions?: boolean | null;
2531
2534
  };
2532
2535
  } | {
2533
2536
  /** @description The user ID for whom the embed session is created */
@@ -2636,6 +2639,38 @@ interface operations {
2636
2639
  presets: {
2637
2640
  examId: string;
2638
2641
  };
2642
+ } | {
2643
+ /** @description The user ID for whom the embed session is created */
2644
+ actor: string;
2645
+ /** @description UI options for the embed session */
2646
+ theme: {
2647
+ /** @description CSS hex color code for primary UI elements, either #RRGGBB or #RGB */
2648
+ primaryColor?: string;
2649
+ /** @description CSS hex color code for background, either #RRGGBB or #RGB */
2650
+ backgroundColor?: string;
2651
+ /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
2652
+ locale?: string;
2653
+ };
2654
+ /** @description Additional key-value metadata */
2655
+ metadata?: {
2656
+ [key: string]: string | number | boolean | null;
2657
+ };
2658
+ /**
2659
+ * Format: uri
2660
+ * @description Optional redirect URL after completion
2661
+ */
2662
+ returnUrl?: string;
2663
+ /**
2664
+ * Format: uri
2665
+ * @description Optional allowed origin for postMessage events
2666
+ */
2667
+ allowedOrigin?: string;
2668
+ /** @enum {string} */
2669
+ flow: "practice-space-student";
2670
+ /** @description Preset values for the practice-space-student flow */
2671
+ presets: {
2672
+ practiceSpaceId: string;
2673
+ };
2639
2674
  };
2640
2675
  };
2641
2676
  };
@@ -2652,7 +2687,7 @@ interface operations {
2652
2687
  /** Format: uri */
2653
2688
  embedUrl: string;
2654
2689
  /** @enum {string} */
2655
- flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer";
2690
+ flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer" | "practice-space-student";
2656
2691
  actor: string;
2657
2692
  enabledResponseModes: ("return_url" | "post_message")[];
2658
2693
  /** Format: date-time */
@@ -2703,7 +2738,7 @@ interface operations {
2703
2738
  /** Format: uri */
2704
2739
  embedUrl: string;
2705
2740
  /** @enum {string} */
2706
- flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer";
2741
+ flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer" | "practice-space-student";
2707
2742
  actor: string;
2708
2743
  enabledResponseModes: ("return_url" | "post_message")[];
2709
2744
  /** Format: date-time */
@@ -3237,7 +3272,7 @@ interface operations {
3237
3272
  header?: never;
3238
3273
  path: {
3239
3274
  /** @description The ID of the actor to check role for, e.g. `user_abcd`. */
3240
- actor: (string) | string;
3275
+ actor: ((string) | "me") | string;
3241
3276
  /** @description The ID of the resource to check role for, e.g. `exam_1234`. */
3242
3277
  resource: string;
3243
3278
  };
@@ -3843,6 +3878,8 @@ interface operations {
3843
3878
  } | null;
3844
3879
  /** @description Tags associated with the question for categorization and search */
3845
3880
  tags?: string[] | null;
3881
+ /** @description Optional external ID for the question, used to link to external systems */
3882
+ externalId?: string | null;
3846
3883
  /** @description Metadata for the question */
3847
3884
  metadata?: {
3848
3885
  [key: string]: string | number | boolean | null;
@@ -5145,6 +5182,8 @@ interface operations {
5145
5182
  } | null;
5146
5183
  /** @description Tags associated with the question for categorization and search */
5147
5184
  tags?: string[] | null;
5185
+ /** @description Optional external ID for the question, used to link to external systems */
5186
+ externalId?: string | null;
5148
5187
  /** @description Metadata for the question */
5149
5188
  metadata?: {
5150
5189
  [key: string]: string | number | boolean | null;
@@ -5239,6 +5278,8 @@ interface operations {
5239
5278
  } | null;
5240
5279
  /** @description Tags associated with the question for categorization and search */
5241
5280
  tags?: string[] | null;
5281
+ /** @description Optional external ID for the question, used to link to external systems */
5282
+ externalId?: string | null;
5242
5283
  /** @description Metadata for the question */
5243
5284
  metadata?: {
5244
5285
  [key: string]: string | number | boolean | null;
@@ -5995,7 +6036,7 @@ declare class Media {
5995
6036
  *
5996
6037
  * API endpoint: `GET /media/upload`
5997
6038
  */
5998
- upload(args: Args<"media.upload">, options?: ExamplaryRequestOptions): Promise<Response<"media.upload">>;
6039
+ upload(args?: Args<"media.upload">, options?: ExamplaryRequestOptions): Promise<Response<"media.upload">>;
5999
6040
  }
6000
6041
  declare class OrgCustomDomain {
6001
6042
  private readonly ctx;
@@ -6424,7 +6465,7 @@ declare class Exams {
6424
6465
  *
6425
6466
  * API endpoint: `GET /exams`
6426
6467
  */
6427
- list(args: Args<"exams.list">, options?: ExamplaryRequestOptions): Promise<Response<"exams.list">>;
6468
+ list(args?: Args<"exams.list">, options?: ExamplaryRequestOptions): Promise<Response<"exams.list">>;
6428
6469
  /**
6429
6470
  * Create exam
6430
6471
  *
@@ -6583,7 +6624,7 @@ declare class PracticeSpaces {
6583
6624
  *
6584
6625
  * API endpoint: `GET /practice-spaces`
6585
6626
  */
6586
- list(args: Args<"practiceSpaces.list">, options?: ExamplaryRequestOptions): Promise<Response<"practiceSpaces.list">>;
6627
+ list(args?: Args<"practiceSpaces.list">, options?: ExamplaryRequestOptions): Promise<Response<"practiceSpaces.list">>;
6587
6628
  /**
6588
6629
  * Create practice space
6589
6630
  *
@@ -6681,7 +6722,7 @@ declare class SourceMaterials {
6681
6722
  *
6682
6723
  * API endpoint: `GET /source-materials`
6683
6724
  */
6684
- list(args: Args<"sourceMaterials.list">, options?: ExamplaryRequestOptions): Promise<Response<"sourceMaterials.list">>;
6725
+ list(args?: Args<"sourceMaterials.list">, options?: ExamplaryRequestOptions): Promise<Response<"sourceMaterials.list">>;
6685
6726
  /**
6686
6727
  * Add source material
6687
6728
  *
package/dist/index.d.ts CHANGED
@@ -2528,6 +2528,9 @@ interface operations {
2528
2528
  templateId?: string | null;
2529
2529
  } | null;
2530
2530
  showDoneButton?: boolean | null;
2531
+ hideTemplateOptions?: boolean | null;
2532
+ hideGenerateOptions?: boolean | null;
2533
+ hideExportOptions?: boolean | null;
2531
2534
  };
2532
2535
  } | {
2533
2536
  /** @description The user ID for whom the embed session is created */
@@ -2636,6 +2639,38 @@ interface operations {
2636
2639
  presets: {
2637
2640
  examId: string;
2638
2641
  };
2642
+ } | {
2643
+ /** @description The user ID for whom the embed session is created */
2644
+ actor: string;
2645
+ /** @description UI options for the embed session */
2646
+ theme: {
2647
+ /** @description CSS hex color code for primary UI elements, either #RRGGBB or #RGB */
2648
+ primaryColor?: string;
2649
+ /** @description CSS hex color code for background, either #RRGGBB or #RGB */
2650
+ backgroundColor?: string;
2651
+ /** @description Locale code for UI language. Currently supported: 'en', 'nl' - other values accepted, but will default to English */
2652
+ locale?: string;
2653
+ };
2654
+ /** @description Additional key-value metadata */
2655
+ metadata?: {
2656
+ [key: string]: string | number | boolean | null;
2657
+ };
2658
+ /**
2659
+ * Format: uri
2660
+ * @description Optional redirect URL after completion
2661
+ */
2662
+ returnUrl?: string;
2663
+ /**
2664
+ * Format: uri
2665
+ * @description Optional allowed origin for postMessage events
2666
+ */
2667
+ allowedOrigin?: string;
2668
+ /** @enum {string} */
2669
+ flow: "practice-space-student";
2670
+ /** @description Preset values for the practice-space-student flow */
2671
+ presets: {
2672
+ practiceSpaceId: string;
2673
+ };
2639
2674
  };
2640
2675
  };
2641
2676
  };
@@ -2652,7 +2687,7 @@ interface operations {
2652
2687
  /** Format: uri */
2653
2688
  embedUrl: string;
2654
2689
  /** @enum {string} */
2655
- flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer";
2690
+ flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer" | "practice-space-student";
2656
2691
  actor: string;
2657
2692
  enabledResponseModes: ("return_url" | "post_message")[];
2658
2693
  /** Format: date-time */
@@ -2703,7 +2738,7 @@ interface operations {
2703
2738
  /** Format: uri */
2704
2739
  embedUrl: string;
2705
2740
  /** @enum {string} */
2706
- flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer";
2741
+ flow: "generate-exam" | "generate-question" | "edit-exam" | "edit-rubric" | "mark-answer" | "practice-space-student";
2707
2742
  actor: string;
2708
2743
  enabledResponseModes: ("return_url" | "post_message")[];
2709
2744
  /** Format: date-time */
@@ -3237,7 +3272,7 @@ interface operations {
3237
3272
  header?: never;
3238
3273
  path: {
3239
3274
  /** @description The ID of the actor to check role for, e.g. `user_abcd`. */
3240
- actor: (string) | string;
3275
+ actor: ((string) | "me") | string;
3241
3276
  /** @description The ID of the resource to check role for, e.g. `exam_1234`. */
3242
3277
  resource: string;
3243
3278
  };
@@ -3843,6 +3878,8 @@ interface operations {
3843
3878
  } | null;
3844
3879
  /** @description Tags associated with the question for categorization and search */
3845
3880
  tags?: string[] | null;
3881
+ /** @description Optional external ID for the question, used to link to external systems */
3882
+ externalId?: string | null;
3846
3883
  /** @description Metadata for the question */
3847
3884
  metadata?: {
3848
3885
  [key: string]: string | number | boolean | null;
@@ -5145,6 +5182,8 @@ interface operations {
5145
5182
  } | null;
5146
5183
  /** @description Tags associated with the question for categorization and search */
5147
5184
  tags?: string[] | null;
5185
+ /** @description Optional external ID for the question, used to link to external systems */
5186
+ externalId?: string | null;
5148
5187
  /** @description Metadata for the question */
5149
5188
  metadata?: {
5150
5189
  [key: string]: string | number | boolean | null;
@@ -5239,6 +5278,8 @@ interface operations {
5239
5278
  } | null;
5240
5279
  /** @description Tags associated with the question for categorization and search */
5241
5280
  tags?: string[] | null;
5281
+ /** @description Optional external ID for the question, used to link to external systems */
5282
+ externalId?: string | null;
5242
5283
  /** @description Metadata for the question */
5243
5284
  metadata?: {
5244
5285
  [key: string]: string | number | boolean | null;
@@ -5995,7 +6036,7 @@ declare class Media {
5995
6036
  *
5996
6037
  * API endpoint: `GET /media/upload`
5997
6038
  */
5998
- upload(args: Args<"media.upload">, options?: ExamplaryRequestOptions): Promise<Response<"media.upload">>;
6039
+ upload(args?: Args<"media.upload">, options?: ExamplaryRequestOptions): Promise<Response<"media.upload">>;
5999
6040
  }
6000
6041
  declare class OrgCustomDomain {
6001
6042
  private readonly ctx;
@@ -6424,7 +6465,7 @@ declare class Exams {
6424
6465
  *
6425
6466
  * API endpoint: `GET /exams`
6426
6467
  */
6427
- list(args: Args<"exams.list">, options?: ExamplaryRequestOptions): Promise<Response<"exams.list">>;
6468
+ list(args?: Args<"exams.list">, options?: ExamplaryRequestOptions): Promise<Response<"exams.list">>;
6428
6469
  /**
6429
6470
  * Create exam
6430
6471
  *
@@ -6583,7 +6624,7 @@ declare class PracticeSpaces {
6583
6624
  *
6584
6625
  * API endpoint: `GET /practice-spaces`
6585
6626
  */
6586
- list(args: Args<"practiceSpaces.list">, options?: ExamplaryRequestOptions): Promise<Response<"practiceSpaces.list">>;
6627
+ list(args?: Args<"practiceSpaces.list">, options?: ExamplaryRequestOptions): Promise<Response<"practiceSpaces.list">>;
6587
6628
  /**
6588
6629
  * Create practice space
6589
6630
  *
@@ -6681,7 +6722,7 @@ declare class SourceMaterials {
6681
6722
  *
6682
6723
  * API endpoint: `GET /source-materials`
6683
6724
  */
6684
- list(args: Args<"sourceMaterials.list">, options?: ExamplaryRequestOptions): Promise<Response<"sourceMaterials.list">>;
6725
+ list(args?: Args<"sourceMaterials.list">, options?: ExamplaryRequestOptions): Promise<Response<"sourceMaterials.list">>;
6685
6726
  /**
6686
6727
  * Add source material
6687
6728
  *