@examplary/sdk 2.15.0 → 2.16.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.
package/dist/index.d.mts CHANGED
@@ -946,7 +946,7 @@ interface paths {
946
946
  */
947
947
  get: operations["exams.get"];
948
948
  put?: never;
949
- post: operations["postExams:id"];
949
+ post?: never;
950
950
  /**
951
951
  * Delete exam
952
952
  * @description Delete the exam.
@@ -1187,6 +1187,25 @@ interface paths {
1187
1187
  patch?: never;
1188
1188
  trace?: never;
1189
1189
  };
1190
+ "/org/identity-provider": {
1191
+ parameters: {
1192
+ query?: never;
1193
+ header?: never;
1194
+ path?: never;
1195
+ cookie?: never;
1196
+ };
1197
+ /** Get single sign-on configuration */
1198
+ get: operations["org.identityProvider.get"];
1199
+ put?: never;
1200
+ /** Configure single sign-on */
1201
+ post: operations["org.identityProvider.update"];
1202
+ /** Turn off single sign-on */
1203
+ delete: operations["org.identityProvider.delete"];
1204
+ options?: never;
1205
+ head?: never;
1206
+ patch?: never;
1207
+ trace?: never;
1208
+ };
1190
1209
  "/orgs": {
1191
1210
  parameters: {
1192
1211
  query?: never;
@@ -1997,7 +2016,7 @@ interface paths {
1997
2016
  };
1998
2017
  get?: never;
1999
2018
  put?: never;
2000
- post: operations["postFolders:id"];
2019
+ post?: never;
2001
2020
  /**
2002
2021
  * Delete folder
2003
2022
  * @description Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
@@ -2633,6 +2652,8 @@ interface operations {
2633
2652
  }[];
2634
2653
  /** @description Whether this question type is public and can be used by all users */
2635
2654
  public?: boolean;
2655
+ /** @description Whether this question type is deprecated: existing questions keep working, but no new ones can be added */
2656
+ deprecated?: boolean;
2636
2657
  /** @description Custom translations for this question type */
2637
2658
  translations?: {
2638
2659
  [key: string]: string | {
@@ -3463,7 +3484,15 @@ interface operations {
3463
3484
  };
3464
3485
  cookie?: never;
3465
3486
  };
3466
- requestBody?: never;
3487
+ requestBody?: {
3488
+ content: {
3489
+ "application/json": {
3490
+ /** Format: uri */
3491
+ image: string;
3492
+ questionId?: string | null;
3493
+ };
3494
+ };
3495
+ };
3467
3496
  responses: never;
3468
3497
  };
3469
3498
  "exams.sessions.releaseGrades": {
@@ -4228,18 +4257,6 @@ interface operations {
4228
4257
  requestBody?: never;
4229
4258
  responses: never;
4230
4259
  };
4231
- "postExams:id": {
4232
- parameters: {
4233
- query?: never;
4234
- header?: never;
4235
- path: {
4236
- id: string;
4237
- };
4238
- cookie?: never;
4239
- };
4240
- requestBody?: never;
4241
- responses: never;
4242
- };
4243
4260
  "exams.delete": {
4244
4261
  parameters: {
4245
4262
  query?: never;
@@ -4508,6 +4525,59 @@ interface operations {
4508
4525
  };
4509
4526
  responses: never;
4510
4527
  };
4528
+ "org.identityProvider.get": {
4529
+ parameters: {
4530
+ query?: never;
4531
+ header?: never;
4532
+ path?: never;
4533
+ cookie?: never;
4534
+ };
4535
+ requestBody?: never;
4536
+ responses: never;
4537
+ };
4538
+ "org.identityProvider.update": {
4539
+ parameters: {
4540
+ query?: never;
4541
+ header?: never;
4542
+ path?: never;
4543
+ cookie?: never;
4544
+ };
4545
+ requestBody?: {
4546
+ content: {
4547
+ "application/json": {
4548
+ /** @constant */
4549
+ providerType: "google";
4550
+ domain?: string | null;
4551
+ } | {
4552
+ /** @constant */
4553
+ providerType: "entree";
4554
+ externalId: string;
4555
+ } | {
4556
+ /** @constant */
4557
+ providerType: "oidc";
4558
+ oidc: {
4559
+ /** Format: uri */
4560
+ issuer: string;
4561
+ clientId: string;
4562
+ clientSecret?: string;
4563
+ /** @default openid profile email */
4564
+ scopes?: string;
4565
+ };
4566
+ };
4567
+ };
4568
+ };
4569
+ responses: never;
4570
+ };
4571
+ "org.identityProvider.delete": {
4572
+ parameters: {
4573
+ query?: never;
4574
+ header?: never;
4575
+ path?: never;
4576
+ cookie?: never;
4577
+ };
4578
+ requestBody?: never;
4579
+ responses: never;
4580
+ };
4511
4581
  "orgs.list": {
4512
4582
  parameters: {
4513
4583
  query?: never;
@@ -5919,24 +5989,6 @@ interface operations {
5919
5989
  };
5920
5990
  responses: never;
5921
5991
  };
5922
- "postFolders:id": {
5923
- parameters: {
5924
- query?: never;
5925
- header?: never;
5926
- path: {
5927
- id: string;
5928
- };
5929
- cookie?: never;
5930
- };
5931
- requestBody?: {
5932
- content: {
5933
- "application/json": {
5934
- name: string;
5935
- };
5936
- };
5937
- };
5938
- responses: never;
5939
- };
5940
5992
  "folders.delete": {
5941
5993
  parameters: {
5942
5994
  query?: never;
@@ -6914,9 +6966,6 @@ interface _PathOverrides {
6914
6966
  "exams.update": {
6915
6967
  id: string;
6916
6968
  };
6917
- "postExams:id": {
6918
- id: string;
6919
- };
6920
6969
  "exams.delete": {
6921
6970
  id: string;
6922
6971
  };
@@ -7038,9 +7087,6 @@ interface _PathOverrides {
7038
7087
  "folders.update": {
7039
7088
  id: string;
7040
7089
  };
7041
- "postFolders:id": {
7042
- id: string;
7043
- };
7044
7090
  "folders.delete": {
7045
7091
  id: string;
7046
7092
  };
@@ -7423,7 +7469,6 @@ declare class ExamsSessions {
7423
7469
  *
7424
7470
  * API endpoint: `POST /exams/{examId}/sessions/scan`
7425
7471
  */
7426
- scan(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
7427
7472
  scan(args: Args<"exams.sessions.scan">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
7428
7473
  /**
7429
7474
  * Release grades
@@ -7809,9 +7854,32 @@ declare class OrgCustomDomain {
7809
7854
  */
7810
7855
  update(args?: Args<"org.customDomain.update">, options?: ExamplaryRequestOptions): Promise<Response<"org.customDomain.update">>;
7811
7856
  }
7857
+ declare class OrgIdentityProvider {
7858
+ private readonly ctx;
7859
+ constructor(ctx: ClientContext);
7860
+ /**
7861
+ * Get single sign-on configuration
7862
+ *
7863
+ * API endpoint: `GET /org/identity-provider`
7864
+ */
7865
+ get(args?: Args<"org.identityProvider.get">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.get">>;
7866
+ /**
7867
+ * Configure single sign-on
7868
+ *
7869
+ * API endpoint: `POST /org/identity-provider`
7870
+ */
7871
+ update(args?: Args<"org.identityProvider.update">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.update">>;
7872
+ /**
7873
+ * Turn off single sign-on
7874
+ *
7875
+ * API endpoint: `DELETE /org/identity-provider`
7876
+ */
7877
+ delete(args?: Args<"org.identityProvider.delete">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.delete">>;
7878
+ }
7812
7879
  declare class Org {
7813
7880
  private readonly ctx;
7814
7881
  readonly customDomain: OrgCustomDomain;
7882
+ readonly identityProvider: OrgIdentityProvider;
7815
7883
  constructor(ctx: ClientContext);
7816
7884
  /**
7817
7885
  * Get organization
@@ -8584,15 +8652,6 @@ declare class Examplary {
8584
8652
  readonly prompts: Prompts;
8585
8653
  readonly jobs: Jobs;
8586
8654
  constructor(options: ExamplaryClientOptions);
8587
- /**
8588
- * API endpoint: `POST /exams/{id}`
8589
- */
8590
- postExamsId(id: string, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
8591
- postExamsId(args: Args<"postExams:id">, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
8592
- /**
8593
- * API endpoint: `POST /folders/{id}`
8594
- */
8595
- postFoldersId(args: Args<"postFolders:id">, options?: ExamplaryRequestOptions): Promise<Response<"postFolders:id">>;
8596
8655
  /**
8597
8656
  * Get rubrics
8598
8657
  *
package/dist/index.d.ts CHANGED
@@ -946,7 +946,7 @@ interface paths {
946
946
  */
947
947
  get: operations["exams.get"];
948
948
  put?: never;
949
- post: operations["postExams:id"];
949
+ post?: never;
950
950
  /**
951
951
  * Delete exam
952
952
  * @description Delete the exam.
@@ -1187,6 +1187,25 @@ interface paths {
1187
1187
  patch?: never;
1188
1188
  trace?: never;
1189
1189
  };
1190
+ "/org/identity-provider": {
1191
+ parameters: {
1192
+ query?: never;
1193
+ header?: never;
1194
+ path?: never;
1195
+ cookie?: never;
1196
+ };
1197
+ /** Get single sign-on configuration */
1198
+ get: operations["org.identityProvider.get"];
1199
+ put?: never;
1200
+ /** Configure single sign-on */
1201
+ post: operations["org.identityProvider.update"];
1202
+ /** Turn off single sign-on */
1203
+ delete: operations["org.identityProvider.delete"];
1204
+ options?: never;
1205
+ head?: never;
1206
+ patch?: never;
1207
+ trace?: never;
1208
+ };
1190
1209
  "/orgs": {
1191
1210
  parameters: {
1192
1211
  query?: never;
@@ -1997,7 +2016,7 @@ interface paths {
1997
2016
  };
1998
2017
  get?: never;
1999
2018
  put?: never;
2000
- post: operations["postFolders:id"];
2019
+ post?: never;
2001
2020
  /**
2002
2021
  * Delete folder
2003
2022
  * @description Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
@@ -2633,6 +2652,8 @@ interface operations {
2633
2652
  }[];
2634
2653
  /** @description Whether this question type is public and can be used by all users */
2635
2654
  public?: boolean;
2655
+ /** @description Whether this question type is deprecated: existing questions keep working, but no new ones can be added */
2656
+ deprecated?: boolean;
2636
2657
  /** @description Custom translations for this question type */
2637
2658
  translations?: {
2638
2659
  [key: string]: string | {
@@ -3463,7 +3484,15 @@ interface operations {
3463
3484
  };
3464
3485
  cookie?: never;
3465
3486
  };
3466
- requestBody?: never;
3487
+ requestBody?: {
3488
+ content: {
3489
+ "application/json": {
3490
+ /** Format: uri */
3491
+ image: string;
3492
+ questionId?: string | null;
3493
+ };
3494
+ };
3495
+ };
3467
3496
  responses: never;
3468
3497
  };
3469
3498
  "exams.sessions.releaseGrades": {
@@ -4228,18 +4257,6 @@ interface operations {
4228
4257
  requestBody?: never;
4229
4258
  responses: never;
4230
4259
  };
4231
- "postExams:id": {
4232
- parameters: {
4233
- query?: never;
4234
- header?: never;
4235
- path: {
4236
- id: string;
4237
- };
4238
- cookie?: never;
4239
- };
4240
- requestBody?: never;
4241
- responses: never;
4242
- };
4243
4260
  "exams.delete": {
4244
4261
  parameters: {
4245
4262
  query?: never;
@@ -4508,6 +4525,59 @@ interface operations {
4508
4525
  };
4509
4526
  responses: never;
4510
4527
  };
4528
+ "org.identityProvider.get": {
4529
+ parameters: {
4530
+ query?: never;
4531
+ header?: never;
4532
+ path?: never;
4533
+ cookie?: never;
4534
+ };
4535
+ requestBody?: never;
4536
+ responses: never;
4537
+ };
4538
+ "org.identityProvider.update": {
4539
+ parameters: {
4540
+ query?: never;
4541
+ header?: never;
4542
+ path?: never;
4543
+ cookie?: never;
4544
+ };
4545
+ requestBody?: {
4546
+ content: {
4547
+ "application/json": {
4548
+ /** @constant */
4549
+ providerType: "google";
4550
+ domain?: string | null;
4551
+ } | {
4552
+ /** @constant */
4553
+ providerType: "entree";
4554
+ externalId: string;
4555
+ } | {
4556
+ /** @constant */
4557
+ providerType: "oidc";
4558
+ oidc: {
4559
+ /** Format: uri */
4560
+ issuer: string;
4561
+ clientId: string;
4562
+ clientSecret?: string;
4563
+ /** @default openid profile email */
4564
+ scopes?: string;
4565
+ };
4566
+ };
4567
+ };
4568
+ };
4569
+ responses: never;
4570
+ };
4571
+ "org.identityProvider.delete": {
4572
+ parameters: {
4573
+ query?: never;
4574
+ header?: never;
4575
+ path?: never;
4576
+ cookie?: never;
4577
+ };
4578
+ requestBody?: never;
4579
+ responses: never;
4580
+ };
4511
4581
  "orgs.list": {
4512
4582
  parameters: {
4513
4583
  query?: never;
@@ -5919,24 +5989,6 @@ interface operations {
5919
5989
  };
5920
5990
  responses: never;
5921
5991
  };
5922
- "postFolders:id": {
5923
- parameters: {
5924
- query?: never;
5925
- header?: never;
5926
- path: {
5927
- id: string;
5928
- };
5929
- cookie?: never;
5930
- };
5931
- requestBody?: {
5932
- content: {
5933
- "application/json": {
5934
- name: string;
5935
- };
5936
- };
5937
- };
5938
- responses: never;
5939
- };
5940
5992
  "folders.delete": {
5941
5993
  parameters: {
5942
5994
  query?: never;
@@ -6914,9 +6966,6 @@ interface _PathOverrides {
6914
6966
  "exams.update": {
6915
6967
  id: string;
6916
6968
  };
6917
- "postExams:id": {
6918
- id: string;
6919
- };
6920
6969
  "exams.delete": {
6921
6970
  id: string;
6922
6971
  };
@@ -7038,9 +7087,6 @@ interface _PathOverrides {
7038
7087
  "folders.update": {
7039
7088
  id: string;
7040
7089
  };
7041
- "postFolders:id": {
7042
- id: string;
7043
- };
7044
7090
  "folders.delete": {
7045
7091
  id: string;
7046
7092
  };
@@ -7423,7 +7469,6 @@ declare class ExamsSessions {
7423
7469
  *
7424
7470
  * API endpoint: `POST /exams/{examId}/sessions/scan`
7425
7471
  */
7426
- scan(examId: string, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
7427
7472
  scan(args: Args<"exams.sessions.scan">, options?: ExamplaryRequestOptions): Promise<Response<"exams.sessions.scan">>;
7428
7473
  /**
7429
7474
  * Release grades
@@ -7809,9 +7854,32 @@ declare class OrgCustomDomain {
7809
7854
  */
7810
7855
  update(args?: Args<"org.customDomain.update">, options?: ExamplaryRequestOptions): Promise<Response<"org.customDomain.update">>;
7811
7856
  }
7857
+ declare class OrgIdentityProvider {
7858
+ private readonly ctx;
7859
+ constructor(ctx: ClientContext);
7860
+ /**
7861
+ * Get single sign-on configuration
7862
+ *
7863
+ * API endpoint: `GET /org/identity-provider`
7864
+ */
7865
+ get(args?: Args<"org.identityProvider.get">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.get">>;
7866
+ /**
7867
+ * Configure single sign-on
7868
+ *
7869
+ * API endpoint: `POST /org/identity-provider`
7870
+ */
7871
+ update(args?: Args<"org.identityProvider.update">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.update">>;
7872
+ /**
7873
+ * Turn off single sign-on
7874
+ *
7875
+ * API endpoint: `DELETE /org/identity-provider`
7876
+ */
7877
+ delete(args?: Args<"org.identityProvider.delete">, options?: ExamplaryRequestOptions): Promise<Response<"org.identityProvider.delete">>;
7878
+ }
7812
7879
  declare class Org {
7813
7880
  private readonly ctx;
7814
7881
  readonly customDomain: OrgCustomDomain;
7882
+ readonly identityProvider: OrgIdentityProvider;
7815
7883
  constructor(ctx: ClientContext);
7816
7884
  /**
7817
7885
  * Get organization
@@ -8584,15 +8652,6 @@ declare class Examplary {
8584
8652
  readonly prompts: Prompts;
8585
8653
  readonly jobs: Jobs;
8586
8654
  constructor(options: ExamplaryClientOptions);
8587
- /**
8588
- * API endpoint: `POST /exams/{id}`
8589
- */
8590
- postExamsId(id: string, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
8591
- postExamsId(args: Args<"postExams:id">, options?: ExamplaryRequestOptions): Promise<Response<"postExams:id">>;
8592
- /**
8593
- * API endpoint: `POST /folders/{id}`
8594
- */
8595
- postFoldersId(args: Args<"postFolders:id">, options?: ExamplaryRequestOptions): Promise<Response<"postFolders:id">>;
8596
8655
  /**
8597
8656
  * Get rubrics
8598
8657
  *
package/dist/index.js CHANGED
@@ -323,8 +323,8 @@ var ExamsSessions = class {
323
323
  return request(this.ctx, "POST", "/exams/{examId}/sessions", ["examId"], [], true, args, options);
324
324
  }
325
325
  scan(arg, options) {
326
- const args = typeof arg === "string" ? { examId: arg } : arg;
327
- return request(this.ctx, "POST", "/exams/{examId}/sessions/scan", ["examId"], [], false, args, options);
326
+ const args = arg;
327
+ return request(this.ctx, "POST", "/exams/{examId}/sessions/scan", ["examId"], [], true, args, options);
328
328
  }
329
329
  releaseGrades(arg, options) {
330
330
  const args = arg;
@@ -544,10 +544,28 @@ var OrgCustomDomain = class {
544
544
  return request(this.ctx, "POST", "/org/custom-domain", [], [], true, args, options);
545
545
  }
546
546
  };
547
+ var OrgIdentityProvider = class {
548
+ constructor(ctx) {
549
+ this.ctx = ctx;
550
+ }
551
+ get(arg, options) {
552
+ const args = arg;
553
+ return request(this.ctx, "GET", "/org/identity-provider", [], [], false, args, options);
554
+ }
555
+ update(arg, options) {
556
+ const args = arg;
557
+ return request(this.ctx, "POST", "/org/identity-provider", [], [], true, args, options);
558
+ }
559
+ delete(arg, options) {
560
+ const args = arg;
561
+ return request(this.ctx, "DELETE", "/org/identity-provider", [], [], false, args, options);
562
+ }
563
+ };
547
564
  var Org = class {
548
565
  constructor(ctx) {
549
566
  this.ctx = ctx;
550
567
  this.customDomain = new OrgCustomDomain(this.ctx);
568
+ this.identityProvider = new OrgIdentityProvider(this.ctx);
551
569
  }
552
570
  get(arg, options) {
553
571
  const args = arg;
@@ -1000,14 +1018,6 @@ var Examplary = class {
1000
1018
  this.prompts = new Prompts(this.ctx);
1001
1019
  this.jobs = new Jobs(this.ctx);
1002
1020
  }
1003
- postExamsId(arg, options) {
1004
- const args = typeof arg === "string" ? { id: arg } : arg;
1005
- return request(this.ctx, "POST", "/exams/{id}", ["id"], [], false, args, options);
1006
- }
1007
- postFoldersId(arg, options) {
1008
- const args = arg;
1009
- return request(this.ctx, "POST", "/folders/{id}", ["id"], [], true, args, options);
1010
- }
1011
1021
  getRubrics(arg, options) {
1012
1022
  const args = arg;
1013
1023
  return request(this.ctx, "GET", "/rubrics", [], [], false, args, options);