@instructure/athena-api-client 2.9.0 → 2.11.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 (8) hide show
  1. package/README.md +3 -3
  2. package/dist/apis/TaxonomyEnrollmentsApi.js +3 -3
  3. package/dist/esm/apis/TaxonomyEnrollmentsApi.js +3 -3
  4. package/dist/esm/models/ChatRequest.d.ts +6 -0
  5. package/dist/esm/models/ChatRequest.js +2 -0
  6. package/dist/models/ChatRequest.d.ts +6 -0
  7. package/dist/models/ChatRequest.js +2 -0
  8. package/package.json +1 -1
package/README.md CHANGED
@@ -117,9 +117,9 @@ All URIs are relative to *http://localhost:3000*
117
117
  *TaxonomiesApi* | [**getTaxonomyBySlug**](docs/TaxonomiesApi.md#gettaxonomybyslug) | **GET** /api/v1/taxonomies/by-slug/{slug} | Get taxonomy by slug
118
118
  *TaxonomiesApi* | [**getTaxonomyProgress**](docs/TaxonomiesApi.md#gettaxonomyprogress) | **GET** /api/v1/taxonomies/{id}/progress | Get progress and readiness for a taxonomy
119
119
  *TaxonomiesApi* | [**listTaxonomies**](docs/TaxonomiesApi.md#listtaxonomies) | **GET** /api/v1/taxonomies | List available taxonomies
120
- *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomies/{id}/enroll | Enroll in a taxonomy
121
- *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomies/enrollments | List current user\'s active enrollments
122
- *TaxonomyEnrollmentsApi* | [**unenrollFromTaxonomy**](docs/TaxonomyEnrollmentsApi.md#unenrollfromtaxonomy) | **DELETE** /api/v1/taxonomies/{id}/enroll | Unenroll from a taxonomy
120
+ *TaxonomyEnrollmentsApi* | [**enrollInTaxonomy**](docs/TaxonomyEnrollmentsApi.md#enrollintaxonomy) | **POST** /api/v1/taxonomy_enrollments/{id} | Enroll in a taxonomy
121
+ *TaxonomyEnrollmentsApi* | [**listMyEnrollments**](docs/TaxonomyEnrollmentsApi.md#listmyenrollments) | **GET** /api/v1/taxonomy_enrollments | List current user\'s active enrollments
122
+ *TaxonomyEnrollmentsApi* | [**unenrollFromTaxonomy**](docs/TaxonomyEnrollmentsApi.md#unenrollfromtaxonomy) | **DELETE** /api/v1/taxonomy_enrollments/{id} | Unenroll from a taxonomy
123
123
  *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context
124
124
  *UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context
125
125
  *VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat
package/dist/apis/TaxonomyEnrollmentsApi.js CHANGED
@@ -49,7 +49,7 @@ class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
49
49
  if (this.configuration && this.configuration.apiKey) {
50
50
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
51
51
  }
52
- let urlPath = `/api/v1/taxonomies/{id}/enroll`;
52
+ let urlPath = `/api/v1/taxonomy_enrollments/{id}`;
53
53
  urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
54
54
  const response = yield this.request({
55
55
  path: urlPath,
@@ -87,7 +87,7 @@ class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
87
87
  if (this.configuration && this.configuration.apiKey) {
88
88
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
89
89
  }
90
- let urlPath = `/api/v1/taxonomies/enrollments`;
90
+ let urlPath = `/api/v1/taxonomy_enrollments`;
91
91
  const response = yield this.request({
92
92
  path: urlPath,
93
93
  method: 'GET',
@@ -127,7 +127,7 @@ class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
127
127
  if (this.configuration && this.configuration.apiKey) {
128
128
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
129
129
  }
130
- let urlPath = `/api/v1/taxonomies/{id}/enroll`;
130
+ let urlPath = `/api/v1/taxonomy_enrollments/{id}`;
131
131
  urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
132
132
  const response = yield this.request({
133
133
  path: urlPath,
package/dist/esm/apis/TaxonomyEnrollmentsApi.js CHANGED
@@ -46,7 +46,7 @@ export class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
46
46
  if (this.configuration && this.configuration.apiKey) {
47
47
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
48
48
  }
49
- let urlPath = `/api/v1/taxonomies/{id}/enroll`;
49
+ let urlPath = `/api/v1/taxonomy_enrollments/{id}`;
50
50
  urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
51
51
  const response = yield this.request({
52
52
  path: urlPath,
@@ -84,7 +84,7 @@ export class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
84
84
  if (this.configuration && this.configuration.apiKey) {
85
85
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
86
86
  }
87
- let urlPath = `/api/v1/taxonomies/enrollments`;
87
+ let urlPath = `/api/v1/taxonomy_enrollments`;
88
88
  const response = yield this.request({
89
89
  path: urlPath,
90
90
  method: 'GET',
@@ -124,7 +124,7 @@ export class TaxonomyEnrollmentsApi extends runtime.BaseAPI {
124
124
  if (this.configuration && this.configuration.apiKey) {
125
125
  headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
126
126
  }
127
- let urlPath = `/api/v1/taxonomies/{id}/enroll`;
127
+ let urlPath = `/api/v1/taxonomy_enrollments/{id}`;
128
128
  urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
129
129
  const response = yield this.request({
130
130
  path: urlPath,
package/dist/esm/models/ChatRequest.d.ts CHANGED
@@ -54,6 +54,12 @@ export interface ChatRequest {
54
54
  * @memberof ChatRequest
55
55
  */
56
56
  quizContext?: ChatRequestQuizContext;
57
+ /**
58
+ * Optional taxonomy ID to scope this chat to a taxonomy. Only applied when a new chat is created. Requires an active enrollment.
59
+ * @type {string}
60
+ * @memberof ChatRequest
61
+ */
62
+ taxonomyId?: string;
57
63
  }
58
64
  /**
59
65
  * Check if a given object implements the ChatRequest interface.
package/dist/esm/models/ChatRequest.js CHANGED
@@ -38,6 +38,7 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
38
38
  'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInnerFromJSON)),
39
39
  'externalFileUrl': json['externalFileUrl'] == null ? undefined : ChatRequestExternalFileUrlFromJSON(json['externalFileUrl']),
40
40
  'quizContext': json['quizContext'] == null ? undefined : ChatRequestQuizContextFromJSON(json['quizContext']),
41
+ 'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
41
42
  };
42
43
  }
43
44
  export function ChatRequestToJSON(json) {
@@ -54,5 +55,6 @@ export function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
54
55
  'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInnerToJSON)),
55
56
  'externalFileUrl': ChatRequestExternalFileUrlToJSON(value['externalFileUrl']),
56
57
  'quizContext': ChatRequestQuizContextToJSON(value['quizContext']),
58
+ 'taxonomyId': value['taxonomyId'],
57
59
  };
58
60
  }
package/dist/models/ChatRequest.d.ts CHANGED
@@ -54,6 +54,12 @@ export interface ChatRequest {
54
54
  * @memberof ChatRequest
55
55
  */
56
56
  quizContext?: ChatRequestQuizContext;
57
+ /**
58
+ * Optional taxonomy ID to scope this chat to a taxonomy. Only applied when a new chat is created. Requires an active enrollment.
59
+ * @type {string}
60
+ * @memberof ChatRequest
61
+ */
62
+ taxonomyId?: string;
57
63
  }
58
64
  /**
59
65
  * Check if a given object implements the ChatRequest interface.
package/dist/models/ChatRequest.js CHANGED
@@ -45,6 +45,7 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
45
45
  'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerFromJSON)),
46
46
  'externalFileUrl': json['externalFileUrl'] == null ? undefined : (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlFromJSON)(json['externalFileUrl']),
47
47
  'quizContext': json['quizContext'] == null ? undefined : (0, ChatRequestQuizContext_1.ChatRequestQuizContextFromJSON)(json['quizContext']),
48
+ 'taxonomyId': json['taxonomyId'] == null ? undefined : json['taxonomyId'],
48
49
  };
49
50
  }
50
51
  function ChatRequestToJSON(json) {
@@ -61,5 +62,6 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
61
62
  'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerToJSON)),
62
63
  'externalFileUrl': (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlToJSON)(value['externalFileUrl']),
63
64
  'quizContext': (0, ChatRequestQuizContext_1.ChatRequestQuizContextToJSON)(value['quizContext']),
65
+ 'taxonomyId': value['taxonomyId'],
64
66
  };
65
67
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "2.9.0",
4
+ "version": "2.11.0",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {