@instructure/athena-api-client 2.22.9 → 2.22.11

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.
@@ -15,16 +15,19 @@ export interface AssessCanvasKnowledgeRequest {
15
15
  courseId: number;
16
16
  xCanvasDomain: string;
17
17
  xCanvasToken: string;
18
+ xUserId: string;
18
19
  slug?: string;
19
20
  }
20
21
  export interface GenerateCanvasTaxonomyRequest {
21
22
  courseId: number;
22
23
  xCanvasDomain: string;
23
24
  xCanvasToken: string;
25
+ xUserId: string;
24
26
  }
25
27
  export interface SyncCanvasUserProfileRequest {
26
28
  xCanvasDomain: string;
27
29
  xCanvasToken: string;
30
+ xUserId: string;
28
31
  }
29
32
  /**
30
33
  *
@@ -44,6 +44,9 @@ class StudyPrepApi extends runtime.BaseAPI {
44
44
  if (requestParameters['xCanvasToken'] == null) {
45
45
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
46
46
  }
47
+ if (requestParameters['xUserId'] == null) {
48
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling assessCanvasKnowledge().');
49
+ }
47
50
  const queryParameters = {};
48
51
  if (requestParameters['courseId'] != null) {
49
52
  queryParameters['courseId'] = requestParameters['courseId'];
@@ -58,6 +61,9 @@ class StudyPrepApi extends runtime.BaseAPI {
58
61
  if (requestParameters['xCanvasToken'] != null) {
59
62
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
60
63
  }
64
+ if (requestParameters['xUserId'] != null) {
65
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
66
+ }
61
67
  if (this.configuration && this.configuration.apiKey) {
62
68
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
63
69
  }
@@ -96,6 +102,9 @@ class StudyPrepApi extends runtime.BaseAPI {
96
102
  if (requestParameters['xCanvasToken'] == null) {
97
103
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
98
104
  }
105
+ if (requestParameters['xUserId'] == null) {
106
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling generateCanvasTaxonomy().');
107
+ }
99
108
  const queryParameters = {};
100
109
  if (requestParameters['courseId'] != null) {
101
110
  queryParameters['courseId'] = requestParameters['courseId'];
@@ -107,6 +116,9 @@ class StudyPrepApi extends runtime.BaseAPI {
107
116
  if (requestParameters['xCanvasToken'] != null) {
108
117
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
109
118
  }
119
+ if (requestParameters['xUserId'] != null) {
120
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
121
+ }
110
122
  if (this.configuration && this.configuration.apiKey) {
111
123
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
112
124
  }
@@ -142,6 +154,9 @@ class StudyPrepApi extends runtime.BaseAPI {
142
154
  if (requestParameters['xCanvasToken'] == null) {
143
155
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
144
156
  }
157
+ if (requestParameters['xUserId'] == null) {
158
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling syncCanvasUserProfile().');
159
+ }
145
160
  const queryParameters = {};
146
161
  const headerParameters = {};
147
162
  if (requestParameters['xCanvasDomain'] != null) {
@@ -150,6 +165,9 @@ class StudyPrepApi extends runtime.BaseAPI {
150
165
  if (requestParameters['xCanvasToken'] != null) {
151
166
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
152
167
  }
168
+ if (requestParameters['xUserId'] != null) {
169
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
170
+ }
153
171
  if (this.configuration && this.configuration.apiKey) {
154
172
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
155
173
  }
@@ -15,16 +15,19 @@ export interface AssessCanvasKnowledgeRequest {
15
15
  courseId: number;
16
16
  xCanvasDomain: string;
17
17
  xCanvasToken: string;
18
+ xUserId: string;
18
19
  slug?: string;
19
20
  }
20
21
  export interface GenerateCanvasTaxonomyRequest {
21
22
  courseId: number;
22
23
  xCanvasDomain: string;
23
24
  xCanvasToken: string;
25
+ xUserId: string;
24
26
  }
25
27
  export interface SyncCanvasUserProfileRequest {
26
28
  xCanvasDomain: string;
27
29
  xCanvasToken: string;
30
+ xUserId: string;
28
31
  }
29
32
  /**
30
33
  *
@@ -41,6 +41,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
41
41
  if (requestParameters['xCanvasToken'] == null) {
42
42
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling assessCanvasKnowledge().');
43
43
  }
44
+ if (requestParameters['xUserId'] == null) {
45
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling assessCanvasKnowledge().');
46
+ }
44
47
  const queryParameters = {};
45
48
  if (requestParameters['courseId'] != null) {
46
49
  queryParameters['courseId'] = requestParameters['courseId'];
@@ -55,6 +58,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
55
58
  if (requestParameters['xCanvasToken'] != null) {
56
59
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
57
60
  }
61
+ if (requestParameters['xUserId'] != null) {
62
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
63
+ }
58
64
  if (this.configuration && this.configuration.apiKey) {
59
65
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
60
66
  }
@@ -93,6 +99,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
93
99
  if (requestParameters['xCanvasToken'] == null) {
94
100
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling generateCanvasTaxonomy().');
95
101
  }
102
+ if (requestParameters['xUserId'] == null) {
103
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling generateCanvasTaxonomy().');
104
+ }
96
105
  const queryParameters = {};
97
106
  if (requestParameters['courseId'] != null) {
98
107
  queryParameters['courseId'] = requestParameters['courseId'];
@@ -104,6 +113,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
104
113
  if (requestParameters['xCanvasToken'] != null) {
105
114
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
106
115
  }
116
+ if (requestParameters['xUserId'] != null) {
117
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
118
+ }
107
119
  if (this.configuration && this.configuration.apiKey) {
108
120
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
109
121
  }
@@ -139,6 +151,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
139
151
  if (requestParameters['xCanvasToken'] == null) {
140
152
  throw new runtime.RequiredError('xCanvasToken', 'Required parameter "xCanvasToken" was null or undefined when calling syncCanvasUserProfile().');
141
153
  }
154
+ if (requestParameters['xUserId'] == null) {
155
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling syncCanvasUserProfile().');
156
+ }
142
157
  const queryParameters = {};
143
158
  const headerParameters = {};
144
159
  if (requestParameters['xCanvasDomain'] != null) {
@@ -147,6 +162,9 @@ export class StudyPrepApi extends runtime.BaseAPI {
147
162
  if (requestParameters['xCanvasToken'] != null) {
148
163
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
149
164
  }
165
+ if (requestParameters['xUserId'] != null) {
166
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
167
+ }
150
168
  if (this.configuration && this.configuration.apiKey) {
151
169
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
152
170
  }
@@ -27,6 +27,12 @@ export interface CanvasTaxonomyEntity {
27
27
  * @memberof CanvasTaxonomyEntity
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof CanvasTaxonomyEntity
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Canvas course name
32
38
  * @type {string}
@@ -27,6 +27,8 @@ export function instanceOfCanvasTaxonomyEntity(value) {
27
27
  return false;
28
28
  if (!('slug' in value) || value['slug'] === undefined)
29
29
  return false;
30
+ if (!('courseId' in value) || value['courseId'] === undefined)
31
+ return false;
30
32
  if (!('name' in value) || value['name'] === undefined)
31
33
  return false;
32
34
  if (!('status' in value) || value['status'] === undefined)
@@ -45,6 +47,7 @@ export function CanvasTaxonomyEntityFromJSONTyped(json, ignoreDiscriminator) {
45
47
  return {
46
48
  'id': json['id'],
47
49
  'slug': json['slug'],
50
+ 'courseId': json['courseId'],
48
51
  'name': json['name'],
49
52
  'status': json['status'],
50
53
  'created': json['created'],
@@ -60,6 +63,7 @@ export function CanvasTaxonomyEntityToJSONTyped(value, ignoreDiscriminator = fal
60
63
  return {
61
64
  'id': value['id'],
62
65
  'slug': value['slug'],
66
+ 'courseId': value['courseId'],
63
67
  'name': value['name'],
64
68
  'status': value['status'],
65
69
  'created': value['created'],
@@ -27,6 +27,12 @@ export interface EnrollmentTaxonomy {
27
27
  * @memberof EnrollmentTaxonomy
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof EnrollmentTaxonomy
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Taxonomy name
32
38
  * @type {string}
@@ -26,6 +26,8 @@ export function instanceOfEnrollmentTaxonomy(value) {
26
26
  return false;
27
27
  if (!('slug' in value) || value['slug'] === undefined)
28
28
  return false;
29
+ if (!('courseId' in value) || value['courseId'] === undefined)
30
+ return false;
29
31
  if (!('name' in value) || value['name'] === undefined)
30
32
  return false;
31
33
  if (!('description' in value) || value['description'] === undefined)
@@ -44,6 +46,7 @@ export function EnrollmentTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
44
46
  return {
45
47
  'id': json['id'],
46
48
  'slug': json['slug'],
49
+ 'courseId': json['courseId'],
47
50
  'name': json['name'],
48
51
  'description': json['description'],
49
52
  'status': json['status'],
@@ -59,6 +62,7 @@ export function EnrollmentTaxonomyToJSONTyped(value, ignoreDiscriminator = false
59
62
  return {
60
63
  'id': value['id'],
61
64
  'slug': value['slug'],
65
+ 'courseId': value['courseId'],
62
66
  'name': value['name'],
63
67
  'description': value['description'],
64
68
  'status': value['status'],
@@ -28,6 +28,12 @@ export interface TaxonomyDetail {
28
28
  * @memberof TaxonomyDetail
29
29
  */
30
30
  slug: string;
31
+ /**
32
+ * Canvas course ID associated with this taxonomy
33
+ * @type {string}
34
+ * @memberof TaxonomyDetail
35
+ */
36
+ courseId: string | null;
31
37
  /**
32
38
  * Taxonomy name
33
39
  * @type {string}
@@ -29,6 +29,8 @@ export function instanceOfTaxonomyDetail(value) {
29
29
  return false;
30
30
  if (!('slug' in value) || value['slug'] === undefined)
31
31
  return false;
32
+ if (!('courseId' in value) || value['courseId'] === undefined)
33
+ return false;
32
34
  if (!('name' in value) || value['name'] === undefined)
33
35
  return false;
34
36
  if (!('description' in value) || value['description'] === undefined)
@@ -55,6 +57,7 @@ export function TaxonomyDetailFromJSONTyped(json, ignoreDiscriminator) {
55
57
  return {
56
58
  'id': json['id'],
57
59
  'slug': json['slug'],
60
+ 'courseId': json['courseId'],
58
61
  'name': json['name'],
59
62
  'description': json['description'],
60
63
  'status': json['status'],
@@ -74,6 +77,7 @@ export function TaxonomyDetailToJSONTyped(value, ignoreDiscriminator = false) {
74
77
  return {
75
78
  'id': value['id'],
76
79
  'slug': value['slug'],
80
+ 'courseId': value['courseId'],
77
81
  'name': value['name'],
78
82
  'description': value['description'],
79
83
  'status': value['status'],
@@ -27,6 +27,12 @@ export interface TaxonomySummary {
27
27
  * @memberof TaxonomySummary
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof TaxonomySummary
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Taxonomy name
32
38
  * @type {string}
@@ -28,6 +28,8 @@ export function instanceOfTaxonomySummary(value) {
28
28
  return false;
29
29
  if (!('slug' in value) || value['slug'] === undefined)
30
30
  return false;
31
+ if (!('courseId' in value) || value['courseId'] === undefined)
32
+ return false;
31
33
  if (!('name' in value) || value['name'] === undefined)
32
34
  return false;
33
35
  if (!('description' in value) || value['description'] === undefined)
@@ -50,6 +52,7 @@ export function TaxonomySummaryFromJSONTyped(json, ignoreDiscriminator) {
50
52
  return {
51
53
  'id': json['id'],
52
54
  'slug': json['slug'],
55
+ 'courseId': json['courseId'],
53
56
  'name': json['name'],
54
57
  'description': json['description'],
55
58
  'status': json['status'],
@@ -67,6 +70,7 @@ export function TaxonomySummaryToJSONTyped(value, ignoreDiscriminator = false) {
67
70
  return {
68
71
  'id': value['id'],
69
72
  'slug': value['slug'],
73
+ 'courseId': value['courseId'],
70
74
  'name': value['name'],
71
75
  'description': value['description'],
72
76
  'status': value['status'],
@@ -27,6 +27,12 @@ export interface CanvasTaxonomyEntity {
27
27
  * @memberof CanvasTaxonomyEntity
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof CanvasTaxonomyEntity
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Canvas course name
32
38
  * @type {string}
@@ -35,6 +35,8 @@ function instanceOfCanvasTaxonomyEntity(value) {
35
35
  return false;
36
36
  if (!('slug' in value) || value['slug'] === undefined)
37
37
  return false;
38
+ if (!('courseId' in value) || value['courseId'] === undefined)
39
+ return false;
38
40
  if (!('name' in value) || value['name'] === undefined)
39
41
  return false;
40
42
  if (!('status' in value) || value['status'] === undefined)
@@ -53,6 +55,7 @@ function CanvasTaxonomyEntityFromJSONTyped(json, ignoreDiscriminator) {
53
55
  return {
54
56
  'id': json['id'],
55
57
  'slug': json['slug'],
58
+ 'courseId': json['courseId'],
56
59
  'name': json['name'],
57
60
  'status': json['status'],
58
61
  'created': json['created'],
@@ -68,6 +71,7 @@ function CanvasTaxonomyEntityToJSONTyped(value, ignoreDiscriminator = false) {
68
71
  return {
69
72
  'id': value['id'],
70
73
  'slug': value['slug'],
74
+ 'courseId': value['courseId'],
71
75
  'name': value['name'],
72
76
  'status': value['status'],
73
77
  'created': value['created'],
@@ -27,6 +27,12 @@ export interface EnrollmentTaxonomy {
27
27
  * @memberof EnrollmentTaxonomy
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof EnrollmentTaxonomy
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Taxonomy name
32
38
  * @type {string}
@@ -34,6 +34,8 @@ function instanceOfEnrollmentTaxonomy(value) {
34
34
  return false;
35
35
  if (!('slug' in value) || value['slug'] === undefined)
36
36
  return false;
37
+ if (!('courseId' in value) || value['courseId'] === undefined)
38
+ return false;
37
39
  if (!('name' in value) || value['name'] === undefined)
38
40
  return false;
39
41
  if (!('description' in value) || value['description'] === undefined)
@@ -52,6 +54,7 @@ function EnrollmentTaxonomyFromJSONTyped(json, ignoreDiscriminator) {
52
54
  return {
53
55
  'id': json['id'],
54
56
  'slug': json['slug'],
57
+ 'courseId': json['courseId'],
55
58
  'name': json['name'],
56
59
  'description': json['description'],
57
60
  'status': json['status'],
@@ -67,6 +70,7 @@ function EnrollmentTaxonomyToJSONTyped(value, ignoreDiscriminator = false) {
67
70
  return {
68
71
  'id': value['id'],
69
72
  'slug': value['slug'],
73
+ 'courseId': value['courseId'],
70
74
  'name': value['name'],
71
75
  'description': value['description'],
72
76
  'status': value['status'],
@@ -28,6 +28,12 @@ export interface TaxonomyDetail {
28
28
  * @memberof TaxonomyDetail
29
29
  */
30
30
  slug: string;
31
+ /**
32
+ * Canvas course ID associated with this taxonomy
33
+ * @type {string}
34
+ * @memberof TaxonomyDetail
35
+ */
36
+ courseId: string | null;
31
37
  /**
32
38
  * Taxonomy name
33
39
  * @type {string}
@@ -37,6 +37,8 @@ function instanceOfTaxonomyDetail(value) {
37
37
  return false;
38
38
  if (!('slug' in value) || value['slug'] === undefined)
39
39
  return false;
40
+ if (!('courseId' in value) || value['courseId'] === undefined)
41
+ return false;
40
42
  if (!('name' in value) || value['name'] === undefined)
41
43
  return false;
42
44
  if (!('description' in value) || value['description'] === undefined)
@@ -63,6 +65,7 @@ function TaxonomyDetailFromJSONTyped(json, ignoreDiscriminator) {
63
65
  return {
64
66
  'id': json['id'],
65
67
  'slug': json['slug'],
68
+ 'courseId': json['courseId'],
66
69
  'name': json['name'],
67
70
  'description': json['description'],
68
71
  'status': json['status'],
@@ -82,6 +85,7 @@ function TaxonomyDetailToJSONTyped(value, ignoreDiscriminator = false) {
82
85
  return {
83
86
  'id': value['id'],
84
87
  'slug': value['slug'],
88
+ 'courseId': value['courseId'],
85
89
  'name': value['name'],
86
90
  'description': value['description'],
87
91
  'status': value['status'],
@@ -27,6 +27,12 @@ export interface TaxonomySummary {
27
27
  * @memberof TaxonomySummary
28
28
  */
29
29
  slug: string;
30
+ /**
31
+ * Canvas course ID associated with this taxonomy
32
+ * @type {string}
33
+ * @memberof TaxonomySummary
34
+ */
35
+ courseId: string | null;
30
36
  /**
31
37
  * Taxonomy name
32
38
  * @type {string}
@@ -36,6 +36,8 @@ function instanceOfTaxonomySummary(value) {
36
36
  return false;
37
37
  if (!('slug' in value) || value['slug'] === undefined)
38
38
  return false;
39
+ if (!('courseId' in value) || value['courseId'] === undefined)
40
+ return false;
39
41
  if (!('name' in value) || value['name'] === undefined)
40
42
  return false;
41
43
  if (!('description' in value) || value['description'] === undefined)
@@ -58,6 +60,7 @@ function TaxonomySummaryFromJSONTyped(json, ignoreDiscriminator) {
58
60
  return {
59
61
  'id': json['id'],
60
62
  'slug': json['slug'],
63
+ 'courseId': json['courseId'],
61
64
  'name': json['name'],
62
65
  'description': json['description'],
63
66
  'status': json['status'],
@@ -75,6 +78,7 @@ function TaxonomySummaryToJSONTyped(value, ignoreDiscriminator = false) {
75
78
  return {
76
79
  'id': value['id'],
77
80
  'slug': value['slug'],
81
+ 'courseId': value['courseId'],
78
82
  'name': value['name'],
79
83
  'description': value['description'],
80
84
  'status': value['status'],
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.22.9",
4
+ "version": "2.22.11",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {