@instructure/athena-api-client 2.28.0 → 3.0.1

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 (11) hide show
  1. package/dist/apis/PracticeQuizzesApi.d.ts +3 -3
  2. package/dist/apis/PracticeQuizzesApi.js +6 -6
  3. package/dist/esm/apis/PracticeQuizzesApi.d.ts +3 -3
  4. package/dist/esm/apis/PracticeQuizzesApi.js +6 -6
  5. package/dist/esm/models/CreatePracticeQuizRequest.d.ts +2 -2
  6. package/dist/esm/models/CreatePracticeQuizRequest.js +3 -3
  7. package/dist/esm/models/PracticeQuizStatusList.d.ts +1 -1
  8. package/dist/models/CreatePracticeQuizRequest.d.ts +2 -2
  9. package/dist/models/CreatePracticeQuizRequest.js +3 -3
  10. package/dist/models/PracticeQuizStatusList.d.ts +1 -1
  11. package/package.json +1 -1
package/dist/apis/PracticeQuizzesApi.d.ts CHANGED
@@ -16,7 +16,7 @@ export interface CreatePracticeQuizOperationRequest {
16
16
  createPracticeQuizRequest: CreatePracticeQuizRequest;
17
17
  }
18
18
  export interface ListPracticeQuizzesRequest {
19
- globalCourseId: string;
19
+ canvasCourseId: string;
20
20
  canvasObjectIds: Array<string>;
21
21
  xUserId: string;
22
22
  modes?: Array<ListPracticeQuizzesModesEnum>;
@@ -26,12 +26,12 @@ export interface ListPracticeQuizzesRequest {
26
26
  */
27
27
  export declare class PracticeQuizzesApi extends runtime.BaseAPI {
28
28
  /**
29
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
29
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
30
30
  * Find or create a practice-quiz slot
31
31
  */
32
32
  createPracticeQuizRaw(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuiz>>;
33
33
  /**
34
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
34
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
35
35
  * Find or create a practice-quiz slot
36
36
  */
37
37
  createPracticeQuiz(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuiz>;
package/dist/apis/PracticeQuizzesApi.js CHANGED
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
30
30
  */
31
31
  class PracticeQuizzesApi extends runtime.BaseAPI {
32
32
  /**
33
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
33
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
34
34
  * Find or create a practice-quiz slot
35
35
  */
36
36
  createPracticeQuizRaw(requestParameters, initOverrides) {
@@ -62,7 +62,7 @@ class PracticeQuizzesApi extends runtime.BaseAPI {
62
62
  });
63
63
  }
64
64
  /**
65
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
65
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
66
66
  * Find or create a practice-quiz slot
67
67
  */
68
68
  createPracticeQuiz(requestParameters, initOverrides) {
@@ -77,8 +77,8 @@ class PracticeQuizzesApi extends runtime.BaseAPI {
77
77
  */
78
78
  listPracticeQuizzesRaw(requestParameters, initOverrides) {
79
79
  return __awaiter(this, void 0, void 0, function* () {
80
- if (requestParameters['globalCourseId'] == null) {
81
- throw new runtime.RequiredError('globalCourseId', 'Required parameter "globalCourseId" was null or undefined when calling listPracticeQuizzes().');
80
+ if (requestParameters['canvasCourseId'] == null) {
81
+ throw new runtime.RequiredError('canvasCourseId', 'Required parameter "canvasCourseId" was null or undefined when calling listPracticeQuizzes().');
82
82
  }
83
83
  if (requestParameters['canvasObjectIds'] == null) {
84
84
  throw new runtime.RequiredError('canvasObjectIds', 'Required parameter "canvasObjectIds" was null or undefined when calling listPracticeQuizzes().');
@@ -87,8 +87,8 @@ class PracticeQuizzesApi extends runtime.BaseAPI {
87
87
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listPracticeQuizzes().');
88
88
  }
89
89
  const queryParameters = {};
90
- if (requestParameters['globalCourseId'] != null) {
91
- queryParameters['globalCourseId'] = requestParameters['globalCourseId'];
90
+ if (requestParameters['canvasCourseId'] != null) {
91
+ queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
92
92
  }
93
93
  if (requestParameters['canvasObjectIds'] != null) {
94
94
  queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
package/dist/esm/apis/PracticeQuizzesApi.d.ts CHANGED
@@ -16,7 +16,7 @@ export interface CreatePracticeQuizOperationRequest {
16
16
  createPracticeQuizRequest: CreatePracticeQuizRequest;
17
17
  }
18
18
  export interface ListPracticeQuizzesRequest {
19
- globalCourseId: string;
19
+ canvasCourseId: string;
20
20
  canvasObjectIds: Array<string>;
21
21
  xUserId: string;
22
22
  modes?: Array<ListPracticeQuizzesModesEnum>;
@@ -26,12 +26,12 @@ export interface ListPracticeQuizzesRequest {
26
26
  */
27
27
  export declare class PracticeQuizzesApi extends runtime.BaseAPI {
28
28
  /**
29
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
29
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
30
30
  * Find or create a practice-quiz slot
31
31
  */
32
32
  createPracticeQuizRaw(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PracticeQuiz>>;
33
33
  /**
34
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
34
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
35
35
  * Find or create a practice-quiz slot
36
36
  */
37
37
  createPracticeQuiz(requestParameters: CreatePracticeQuizOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PracticeQuiz>;
package/dist/esm/apis/PracticeQuizzesApi.js CHANGED
@@ -27,7 +27,7 @@ import { CreatePracticeQuizRequestToJSON, PracticeQuizFromJSON, PracticeQuizStat
27
27
  */
28
28
  export class PracticeQuizzesApi extends runtime.BaseAPI {
29
29
  /**
30
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
30
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
31
31
  * Find or create a practice-quiz slot
32
32
  */
33
33
  createPracticeQuizRaw(requestParameters, initOverrides) {
@@ -59,7 +59,7 @@ export class PracticeQuizzesApi extends runtime.BaseAPI {
59
59
  });
60
60
  }
61
61
  /**
62
- * Atomically finds the existing chat for (globalCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
62
+ * Atomically finds the existing chat for (canvasCourseId, canvasObjectId, mode) or creates a new one with chatType=\'practice-quiz\'. When forceNew=true, abandons the existing association and creates a fresh chat; the old chat remains in the learner\'s history.
63
63
  * Find or create a practice-quiz slot
64
64
  */
65
65
  createPracticeQuiz(requestParameters, initOverrides) {
@@ -74,8 +74,8 @@ export class PracticeQuizzesApi extends runtime.BaseAPI {
74
74
  */
75
75
  listPracticeQuizzesRaw(requestParameters, initOverrides) {
76
76
  return __awaiter(this, void 0, void 0, function* () {
77
- if (requestParameters['globalCourseId'] == null) {
78
- throw new runtime.RequiredError('globalCourseId', 'Required parameter "globalCourseId" was null or undefined when calling listPracticeQuizzes().');
77
+ if (requestParameters['canvasCourseId'] == null) {
78
+ throw new runtime.RequiredError('canvasCourseId', 'Required parameter "canvasCourseId" was null or undefined when calling listPracticeQuizzes().');
79
79
  }
80
80
  if (requestParameters['canvasObjectIds'] == null) {
81
81
  throw new runtime.RequiredError('canvasObjectIds', 'Required parameter "canvasObjectIds" was null or undefined when calling listPracticeQuizzes().');
@@ -84,8 +84,8 @@ export class PracticeQuizzesApi extends runtime.BaseAPI {
84
84
  throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listPracticeQuizzes().');
85
85
  }
86
86
  const queryParameters = {};
87
- if (requestParameters['globalCourseId'] != null) {
88
- queryParameters['globalCourseId'] = requestParameters['globalCourseId'];
87
+ if (requestParameters['canvasCourseId'] != null) {
88
+ queryParameters['canvasCourseId'] = requestParameters['canvasCourseId'];
89
89
  }
90
90
  if (requestParameters['canvasObjectIds'] != null) {
91
91
  queryParameters['canvasObjectIds'] = requestParameters['canvasObjectIds'];
package/dist/esm/models/CreatePracticeQuizRequest.d.ts CHANGED
@@ -16,11 +16,11 @@
16
16
  */
17
17
  export interface CreatePracticeQuizRequest {
18
18
  /**
19
- * Canvas global course id. Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
19
+ * Canvas local course id (e.g. '587077'). Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
20
20
  * @type {string}
21
21
  * @memberof CreatePracticeQuizRequest
22
22
  */
23
- globalCourseId: string;
23
+ canvasCourseId: string;
24
24
  /**
25
25
  * Canvas object identifier formatted '{type}:{local_id}' — e.g. 'assignment:67890' or 'quiz:99999'. The type prefix is required because Canvas namespaces local ids by type.
26
26
  * @type {string}
package/dist/esm/models/CreatePracticeQuizRequest.js CHANGED
@@ -22,7 +22,7 @@ export const CreatePracticeQuizRequestModeEnum = {
22
22
  * Check if a given object implements the CreatePracticeQuizRequest interface.
23
23
  */
24
24
  export function instanceOfCreatePracticeQuizRequest(value) {
25
- if (!('globalCourseId' in value) || value['globalCourseId'] === undefined)
25
+ if (!('canvasCourseId' in value) || value['canvasCourseId'] === undefined)
26
26
  return false;
27
27
  if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
28
28
  return false;
@@ -38,7 +38,7 @@ export function CreatePracticeQuizRequestFromJSONTyped(json, ignoreDiscriminator
38
38
  return json;
39
39
  }
40
40
  return {
41
- 'globalCourseId': json['globalCourseId'],
41
+ 'canvasCourseId': json['canvasCourseId'],
42
42
  'canvasObjectId': json['canvasObjectId'],
43
43
  'mode': json['mode'],
44
44
  'forceNew': json['forceNew'] == null ? undefined : json['forceNew'],
@@ -52,7 +52,7 @@ export function CreatePracticeQuizRequestToJSONTyped(value, ignoreDiscriminator
52
52
  return value;
53
53
  }
54
54
  return {
55
- 'globalCourseId': value['globalCourseId'],
55
+ 'canvasCourseId': value['canvasCourseId'],
56
56
  'canvasObjectId': value['canvasObjectId'],
57
57
  'mode': value['mode'],
58
58
  'forceNew': value['forceNew'],
package/dist/esm/models/PracticeQuizStatusList.d.ts CHANGED
@@ -17,7 +17,7 @@ import type { PracticeQuizStatus } from './PracticeQuizStatus';
17
17
  */
18
18
  export interface PracticeQuizStatusList {
19
19
  /**
20
- * One entry per requested (canvasObjectId, mode) pair within the supplied globalCourseId, including nulls for pairs with no row.
20
+ * One entry per requested (canvasObjectId, mode) pair within the supplied canvasCourseId, including nulls for pairs with no row.
21
21
  * @type {Array<PracticeQuizStatus>}
22
22
  * @memberof PracticeQuizStatusList
23
23
  */
package/dist/models/CreatePracticeQuizRequest.d.ts CHANGED
@@ -16,11 +16,11 @@
16
16
  */
17
17
  export interface CreatePracticeQuizRequest {
18
18
  /**
19
- * Canvas global course id. Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
19
+ * Canvas local course id (e.g. '587077'). Together with canvasObjectId + mode it identifies the per-exam slot for this learner.
20
20
  * @type {string}
21
21
  * @memberof CreatePracticeQuizRequest
22
22
  */
23
- globalCourseId: string;
23
+ canvasCourseId: string;
24
24
  /**
25
25
  * Canvas object identifier formatted '{type}:{local_id}' — e.g. 'assignment:67890' or 'quiz:99999'. The type prefix is required because Canvas namespaces local ids by type.
26
26
  * @type {string}
package/dist/models/CreatePracticeQuizRequest.js CHANGED
@@ -30,7 +30,7 @@ exports.CreatePracticeQuizRequestModeEnum = {
30
30
  * Check if a given object implements the CreatePracticeQuizRequest interface.
31
31
  */
32
32
  function instanceOfCreatePracticeQuizRequest(value) {
33
- if (!('globalCourseId' in value) || value['globalCourseId'] === undefined)
33
+ if (!('canvasCourseId' in value) || value['canvasCourseId'] === undefined)
34
34
  return false;
35
35
  if (!('canvasObjectId' in value) || value['canvasObjectId'] === undefined)
36
36
  return false;
@@ -46,7 +46,7 @@ function CreatePracticeQuizRequestFromJSONTyped(json, ignoreDiscriminator) {
46
46
  return json;
47
47
  }
48
48
  return {
49
- 'globalCourseId': json['globalCourseId'],
49
+ 'canvasCourseId': json['canvasCourseId'],
50
50
  'canvasObjectId': json['canvasObjectId'],
51
51
  'mode': json['mode'],
52
52
  'forceNew': json['forceNew'] == null ? undefined : json['forceNew'],
@@ -60,7 +60,7 @@ function CreatePracticeQuizRequestToJSONTyped(value, ignoreDiscriminator = false
60
60
  return value;
61
61
  }
62
62
  return {
63
- 'globalCourseId': value['globalCourseId'],
63
+ 'canvasCourseId': value['canvasCourseId'],
64
64
  'canvasObjectId': value['canvasObjectId'],
65
65
  'mode': value['mode'],
66
66
  'forceNew': value['forceNew'],
package/dist/models/PracticeQuizStatusList.d.ts CHANGED
@@ -17,7 +17,7 @@ import type { PracticeQuizStatus } from './PracticeQuizStatus';
17
17
  */
18
18
  export interface PracticeQuizStatusList {
19
19
  /**
20
- * One entry per requested (canvasObjectId, mode) pair within the supplied globalCourseId, including nulls for pairs with no row.
20
+ * One entry per requested (canvasObjectId, mode) pair within the supplied canvasCourseId, including nulls for pairs with no row.
21
21
  * @type {Array<PracticeQuizStatus>}
22
22
  * @memberof PracticeQuizStatusList
23
23
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.28.0",
4
+ "version": "3.0.1",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {