@instructure/athena-api-client 1.0.3 → 1.0.4

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/README.md CHANGED
@@ -66,6 +66,7 @@ All URIs are relative to *http://localhost:3000*
66
66
  *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint
67
67
  *LearningDaysApi* | [**getLearningDays**](docs/LearningDaysApi.md#getlearningdays) | **GET** /api/v1/learning-days | Get learning days in range
68
68
  *LearningMomentsApi* | [**listLearningMoments**](docs/LearningMomentsApi.md#listlearningmoments) | **GET** /api/v1/learning-moments | List learning moments
69
+ *LearningStreakApi* | [**getLearningStreak**](docs/LearningStreakApi.md#getlearningstreak) | **GET** /api/v1/learning-streak | Get learning streak
69
70
  *MessagesApi* | [**deleteMessages**](docs/MessagesApi.md#deletemessages) | **DELETE** /api/v1/chats/{chatId}/messages | Delete messages from timestamp
70
71
  *MessagesApi* | [**getChatMessage**](docs/MessagesApi.md#getchatmessage) | **GET** /api/v1/chats/{chatId}/messages/{messageId} | Get a chat message
71
72
  *MessagesApi* | [**getChatMessages**](docs/MessagesApi.md#getchatmessages) | **GET** /api/v1/chats/{chatId}/messages | List chat messages
@@ -90,6 +91,7 @@ All URIs are relative to *http://localhost:3000*
90
91
  - [HealthCheck](docs/HealthCheck.md)
91
92
  - [LearningDaysResponse](docs/LearningDaysResponse.md)
92
93
  - [LearningMoment](docs/LearningMoment.md)
94
+ - [LearningStreakResponse](docs/LearningStreakResponse.md)
93
95
  - [Message](docs/Message.md)
94
96
  - [MessageCountResponse](docs/MessageCountResponse.md)
95
97
  - [MessagePartsInner](docs/MessagePartsInner.md)
@@ -27,6 +27,7 @@ export interface ListChatsRequest {
27
27
  xUserId: string;
28
28
  limit?: number;
29
29
  cursor?: string;
30
+ chatType?: string;
30
31
  }
31
32
  export interface MarkChatAsViewedRequest {
32
33
  xUserId: string;
@@ -165,6 +165,9 @@ class ChatsApi extends runtime.BaseAPI {
165
165
  if (requestParameters['cursor'] != null) {
166
166
  queryParameters['cursor'] = requestParameters['cursor'];
167
167
  }
168
+ if (requestParameters['chatType'] != null) {
169
+ queryParameters['chatType'] = requestParameters['chatType'];
170
+ }
168
171
  const headerParameters = {};
169
172
  if (requestParameters['xUserId'] != null) {
170
173
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { LearningStreakResponse } from '../models/index';
14
+ export interface GetLearningStreakRequest {
15
+ xUserId: string;
16
+ }
17
+ /**
18
+ *
19
+ */
20
+ export declare class LearningStreakApi extends runtime.BaseAPI {
21
+ /**
22
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
23
+ * Get learning streak
24
+ */
25
+ getLearningStreakRaw(requestParameters: GetLearningStreakRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningStreakResponse>>;
26
+ /**
27
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
28
+ * Get learning streak
29
+ */
30
+ getLearningStreak(requestParameters: GetLearningStreakRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningStreakResponse>;
31
+ }
@@ -0,0 +1,70 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.LearningStreakApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
28
+ /**
29
+ *
30
+ */
31
+ class LearningStreakApi extends runtime.BaseAPI {
32
+ /**
33
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
34
+ * Get learning streak
35
+ */
36
+ getLearningStreakRaw(requestParameters, initOverrides) {
37
+ return __awaiter(this, void 0, void 0, function* () {
38
+ if (requestParameters['xUserId'] == null) {
39
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getLearningStreak().');
40
+ }
41
+ const queryParameters = {};
42
+ const headerParameters = {};
43
+ if (requestParameters['xUserId'] != null) {
44
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
45
+ }
46
+ if (this.configuration && this.configuration.apiKey) {
47
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
48
+ }
49
+ let urlPath = `/api/v1/learning-streak`;
50
+ const response = yield this.request({
51
+ path: urlPath,
52
+ method: 'GET',
53
+ headers: headerParameters,
54
+ query: queryParameters,
55
+ }, initOverrides);
56
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.LearningStreakResponseFromJSON)(jsonValue));
57
+ });
58
+ }
59
+ /**
60
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
61
+ * Get learning streak
62
+ */
63
+ getLearningStreak(requestParameters, initOverrides) {
64
+ return __awaiter(this, void 0, void 0, function* () {
65
+ const response = yield this.getLearningStreakRaw(requestParameters, initOverrides);
66
+ return yield response.value();
67
+ });
68
+ }
69
+ }
70
+ exports.LearningStreakApi = LearningStreakApi;
@@ -3,6 +3,7 @@ export * from './ChatsApi';
3
3
  export * from './HealthApi';
4
4
  export * from './LearningDaysApi';
5
5
  export * from './LearningMomentsApi';
6
+ export * from './LearningStreakApi';
6
7
  export * from './MessagesApi';
7
8
  export * from './ServiceTokensApi';
8
9
  export * from './TagsApi';
@@ -21,6 +21,7 @@ __exportStar(require("./ChatsApi"), exports);
21
21
  __exportStar(require("./HealthApi"), exports);
22
22
  __exportStar(require("./LearningDaysApi"), exports);
23
23
  __exportStar(require("./LearningMomentsApi"), exports);
24
+ __exportStar(require("./LearningStreakApi"), exports);
24
25
  __exportStar(require("./MessagesApi"), exports);
25
26
  __exportStar(require("./ServiceTokensApi"), exports);
26
27
  __exportStar(require("./TagsApi"), exports);
@@ -27,6 +27,7 @@ export interface ListChatsRequest {
27
27
  xUserId: string;
28
28
  limit?: number;
29
29
  cursor?: string;
30
+ chatType?: string;
30
31
  }
31
32
  export interface MarkChatAsViewedRequest {
32
33
  xUserId: string;
@@ -162,6 +162,9 @@ export class ChatsApi extends runtime.BaseAPI {
162
162
  if (requestParameters['cursor'] != null) {
163
163
  queryParameters['cursor'] = requestParameters['cursor'];
164
164
  }
165
+ if (requestParameters['chatType'] != null) {
166
+ queryParameters['chatType'] = requestParameters['chatType'];
167
+ }
165
168
  const headerParameters = {};
166
169
  if (requestParameters['xUserId'] != null) {
167
170
  headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { LearningStreakResponse } from '../models/index';
14
+ export interface GetLearningStreakRequest {
15
+ xUserId: string;
16
+ }
17
+ /**
18
+ *
19
+ */
20
+ export declare class LearningStreakApi extends runtime.BaseAPI {
21
+ /**
22
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
23
+ * Get learning streak
24
+ */
25
+ getLearningStreakRaw(requestParameters: GetLearningStreakRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningStreakResponse>>;
26
+ /**
27
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
28
+ * Get learning streak
29
+ */
30
+ getLearningStreak(requestParameters: GetLearningStreakRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningStreakResponse>;
31
+ }
@@ -0,0 +1,66 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import * as runtime from '../runtime';
24
+ import { LearningStreakResponseFromJSON, } from '../models/index';
25
+ /**
26
+ *
27
+ */
28
+ export class LearningStreakApi extends runtime.BaseAPI {
29
+ /**
30
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
31
+ * Get learning streak
32
+ */
33
+ getLearningStreakRaw(requestParameters, initOverrides) {
34
+ return __awaiter(this, void 0, void 0, function* () {
35
+ if (requestParameters['xUserId'] == null) {
36
+ throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getLearningStreak().');
37
+ }
38
+ const queryParameters = {};
39
+ const headerParameters = {};
40
+ if (requestParameters['xUserId'] != null) {
41
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
42
+ }
43
+ if (this.configuration && this.configuration.apiKey) {
44
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
45
+ }
46
+ let urlPath = `/api/v1/learning-streak`;
47
+ const response = yield this.request({
48
+ path: urlPath,
49
+ method: 'GET',
50
+ headers: headerParameters,
51
+ query: queryParameters,
52
+ }, initOverrides);
53
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearningStreakResponseFromJSON(jsonValue));
54
+ });
55
+ }
56
+ /**
57
+ * Returns the current user\'s learning streak record, or null if they have no learning moments yet.
58
+ * Get learning streak
59
+ */
60
+ getLearningStreak(requestParameters, initOverrides) {
61
+ return __awaiter(this, void 0, void 0, function* () {
62
+ const response = yield this.getLearningStreakRaw(requestParameters, initOverrides);
63
+ return yield response.value();
64
+ });
65
+ }
66
+ }
@@ -3,6 +3,7 @@ export * from './ChatsApi';
3
3
  export * from './HealthApi';
4
4
  export * from './LearningDaysApi';
5
5
  export * from './LearningMomentsApi';
6
+ export * from './LearningStreakApi';
6
7
  export * from './MessagesApi';
7
8
  export * from './ServiceTokensApi';
8
9
  export * from './TagsApi';
@@ -5,6 +5,7 @@ export * from './ChatsApi';
5
5
  export * from './HealthApi';
6
6
  export * from './LearningDaysApi';
7
7
  export * from './LearningMomentsApi';
8
+ export * from './LearningStreakApi';
8
9
  export * from './MessagesApi';
9
10
  export * from './ServiceTokensApi';
10
11
  export * from './TagsApi';
@@ -15,13 +15,39 @@
15
15
  * @interface CreateChatRequest
16
16
  */
17
17
  export interface CreateChatRequest {
18
+ /**
19
+ * Optional caller-supplied UUID for the chat. If omitted, one is generated.
20
+ * @type {string}
21
+ * @memberof CreateChatRequest
22
+ */
23
+ id?: string;
18
24
  /**
19
25
  * Optional title for the chat. Defaults to 'New Chat' if omitted.
20
26
  * @type {string}
21
27
  * @memberof CreateChatRequest
22
28
  */
23
29
  title?: string;
30
+ /**
31
+ * Optional chat type. Defaults to a general chat if omitted.
32
+ * @type {string}
33
+ * @memberof CreateChatRequest
34
+ */
35
+ chatType?: string;
36
+ /**
37
+ * Visibility of the chat. Defaults to 'private' if omitted.
38
+ * @type {string}
39
+ * @memberof CreateChatRequest
40
+ */
41
+ visibility?: CreateChatRequestVisibilityEnum;
24
42
  }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const CreateChatRequestVisibilityEnum: {
47
+ readonly Public: "public";
48
+ readonly Private: "private";
49
+ };
50
+ export type CreateChatRequestVisibilityEnum = typeof CreateChatRequestVisibilityEnum[keyof typeof CreateChatRequestVisibilityEnum];
25
51
  /**
26
52
  * Check if a given object implements the CreateChatRequest interface.
27
53
  */
@@ -11,6 +11,13 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const CreateChatRequestVisibilityEnum = {
18
+ Public: 'public',
19
+ Private: 'private'
20
+ };
14
21
  /**
15
22
  * Check if a given object implements the CreateChatRequest interface.
16
23
  */
@@ -25,7 +32,10 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
25
32
  return json;
26
33
  }
27
34
  return {
35
+ 'id': json['id'] == null ? undefined : json['id'],
28
36
  'title': json['title'] == null ? undefined : json['title'],
37
+ 'chatType': json['chatType'] == null ? undefined : json['chatType'],
38
+ 'visibility': json['visibility'] == null ? undefined : json['visibility'],
29
39
  };
30
40
  }
31
41
  export function CreateChatRequestToJSON(json) {
@@ -36,6 +46,9 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
36
46
  return value;
37
47
  }
38
48
  return {
49
+ 'id': value['id'],
39
50
  'title': value['title'],
51
+ 'chatType': value['chatType'],
52
+ 'visibility': value['visibility'],
40
53
  };
41
54
  }
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface LearningStreakResponse
16
+ */
17
+ export interface LearningStreakResponse {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof LearningStreakResponse
22
+ */
23
+ currentDays: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof LearningStreakResponse
28
+ */
29
+ longestDays: number;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof LearningStreakResponse
34
+ */
35
+ lastMomentDate?: Date | null;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof LearningStreakResponse
40
+ */
41
+ totalMissedDays: number;
42
+ /**
43
+ *
44
+ * @type {Array<number>}
45
+ * @memberof LearningStreakResponse
46
+ */
47
+ missedDaysInCycle: Array<number>;
48
+ /**
49
+ *
50
+ * @type {Date}
51
+ * @memberof LearningStreakResponse
52
+ */
53
+ lastEvaluatedAt?: Date | null;
54
+ /**
55
+ *
56
+ * @type {Date}
57
+ * @memberof LearningStreakResponse
58
+ */
59
+ createdAt: Date;
60
+ /**
61
+ *
62
+ * @type {Date}
63
+ * @memberof LearningStreakResponse
64
+ */
65
+ updatedAt: Date;
66
+ }
67
+ /**
68
+ * Check if a given object implements the LearningStreakResponse interface.
69
+ */
70
+ export declare function instanceOfLearningStreakResponse(value: object): value is LearningStreakResponse;
71
+ export declare function LearningStreakResponseFromJSON(json: any): LearningStreakResponse;
72
+ export declare function LearningStreakResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningStreakResponse;
73
+ export declare function LearningStreakResponseToJSON(json: any): LearningStreakResponse;
74
+ export declare function LearningStreakResponseToJSONTyped(value?: LearningStreakResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,67 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Athena API
5
+ * REST API for the Athena system
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the LearningStreakResponse interface.
16
+ */
17
+ export function instanceOfLearningStreakResponse(value) {
18
+ if (!('currentDays' in value) || value['currentDays'] === undefined)
19
+ return false;
20
+ if (!('longestDays' in value) || value['longestDays'] === undefined)
21
+ return false;
22
+ if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
23
+ return false;
24
+ if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === undefined)
25
+ return false;
26
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
27
+ return false;
28
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
29
+ return false;
30
+ return true;
31
+ }
32
+ export function LearningStreakResponseFromJSON(json) {
33
+ return LearningStreakResponseFromJSONTyped(json, false);
34
+ }
35
+ export function LearningStreakResponseFromJSONTyped(json, ignoreDiscriminator) {
36
+ if (json == null) {
37
+ return json;
38
+ }
39
+ return {
40
+ 'currentDays': json['currentDays'],
41
+ 'longestDays': json['longestDays'],
42
+ 'lastMomentDate': json['lastMomentDate'] == null ? undefined : (new Date(json['lastMomentDate'])),
43
+ 'totalMissedDays': json['totalMissedDays'],
44
+ 'missedDaysInCycle': json['missedDaysInCycle'],
45
+ 'lastEvaluatedAt': json['lastEvaluatedAt'] == null ? undefined : (new Date(json['lastEvaluatedAt'])),
46
+ 'createdAt': (new Date(json['createdAt'])),
47
+ 'updatedAt': (new Date(json['updatedAt'])),
48
+ };
49
+ }
50
+ export function LearningStreakResponseToJSON(json) {
51
+ return LearningStreakResponseToJSONTyped(json, false);
52
+ }
53
+ export function LearningStreakResponseToJSONTyped(value, ignoreDiscriminator = false) {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+ 'currentDays': value['currentDays'],
59
+ 'longestDays': value['longestDays'],
60
+ 'lastMomentDate': value['lastMomentDate'] == null ? value['lastMomentDate'] : value['lastMomentDate'].toISOString().substring(0, 10),
61
+ 'totalMissedDays': value['totalMissedDays'],
62
+ 'missedDaysInCycle': value['missedDaysInCycle'],
63
+ 'lastEvaluatedAt': value['lastEvaluatedAt'] == null ? value['lastEvaluatedAt'] : value['lastEvaluatedAt'].toISOString(),
64
+ 'createdAt': value['createdAt'].toISOString(),
65
+ 'updatedAt': value['updatedAt'].toISOString(),
66
+ };
67
+ }
@@ -21,7 +21,27 @@ export interface UpdateChatRequest {
21
21
  * @memberof UpdateChatRequest
22
22
  */
23
23
  title?: string;
24
+ /**
25
+ * Chat type.
26
+ * @type {string}
27
+ * @memberof UpdateChatRequest
28
+ */
29
+ chatType?: string;
30
+ /**
31
+ * Visibility of the chat.
32
+ * @type {string}
33
+ * @memberof UpdateChatRequest
34
+ */
35
+ visibility?: UpdateChatRequestVisibilityEnum;
24
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const UpdateChatRequestVisibilityEnum: {
41
+ readonly Public: "public";
42
+ readonly Private: "private";
43
+ };
44
+ export type UpdateChatRequestVisibilityEnum = typeof UpdateChatRequestVisibilityEnum[keyof typeof UpdateChatRequestVisibilityEnum];
25
45
  /**
26
46
  * Check if a given object implements the UpdateChatRequest interface.
27
47
  */
@@ -11,6 +11,13 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ /**
15
+ * @export
16
+ */
17
+ export const UpdateChatRequestVisibilityEnum = {
18
+ Public: 'public',
19
+ Private: 'private'
20
+ };
14
21
  /**
15
22
  * Check if a given object implements the UpdateChatRequest interface.
16
23
  */
@@ -26,6 +33,8 @@ export function UpdateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
26
33
  }
27
34
  return {
28
35
  'title': json['title'] == null ? undefined : json['title'],
36
+ 'chatType': json['chatType'] == null ? undefined : json['chatType'],
37
+ 'visibility': json['visibility'] == null ? undefined : json['visibility'],
29
38
  };
30
39
  }
31
40
  export function UpdateChatRequestToJSON(json) {
@@ -37,5 +46,7 @@ export function UpdateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
37
46
  }
38
47
  return {
39
48
  'title': value['title'],
49
+ 'chatType': value['chatType'],
50
+ 'visibility': value['visibility'],
40
51
  };
41
52
  }
@@ -8,6 +8,7 @@ export * from './CreateTokenResponse';
8
8
  export * from './HealthCheck';
9
9
  export * from './LearningDaysResponse';
10
10
  export * from './LearningMoment';
11
+ export * from './LearningStreakResponse';
11
12
  export * from './Message';
12
13
  export * from './MessageCountResponse';
13
14
  export * from './MessagePartsInner';
@@ -10,6 +10,7 @@ export * from './CreateTokenResponse';
10
10
  export * from './HealthCheck';
11
11
  export * from './LearningDaysResponse';
12
12
  export * from './LearningMoment';
13
+ export * from './LearningStreakResponse';
13
14
  export * from './Message';
14
15
  export * from './MessageCountResponse';
15
16
  export * from './MessagePartsInner';
@@ -15,13 +15,39 @@
15
15
  * @interface CreateChatRequest
16
16
  */
17
17
  export interface CreateChatRequest {
18
+ /**
19
+ * Optional caller-supplied UUID for the chat. If omitted, one is generated.
20
+ * @type {string}
21
+ * @memberof CreateChatRequest
22
+ */
23
+ id?: string;
18
24
  /**
19
25
  * Optional title for the chat. Defaults to 'New Chat' if omitted.
20
26
  * @type {string}
21
27
  * @memberof CreateChatRequest
22
28
  */
23
29
  title?: string;
30
+ /**
31
+ * Optional chat type. Defaults to a general chat if omitted.
32
+ * @type {string}
33
+ * @memberof CreateChatRequest
34
+ */
35
+ chatType?: string;
36
+ /**
37
+ * Visibility of the chat. Defaults to 'private' if omitted.
38
+ * @type {string}
39
+ * @memberof CreateChatRequest
40
+ */
41
+ visibility?: CreateChatRequestVisibilityEnum;
24
42
  }
43
+ /**
44
+ * @export
45
+ */
46
+ export declare const CreateChatRequestVisibilityEnum: {
47
+ readonly Public: "public";
48
+ readonly Private: "private";
49
+ };
50
+ export type CreateChatRequestVisibilityEnum = typeof CreateChatRequestVisibilityEnum[keyof typeof CreateChatRequestVisibilityEnum];
25
51
  /**
26
52
  * Check if a given object implements the CreateChatRequest interface.
27
53
  */
@@ -13,11 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateChatRequestVisibilityEnum = void 0;
16
17
  exports.instanceOfCreateChatRequest = instanceOfCreateChatRequest;
17
18
  exports.CreateChatRequestFromJSON = CreateChatRequestFromJSON;
18
19
  exports.CreateChatRequestFromJSONTyped = CreateChatRequestFromJSONTyped;
19
20
  exports.CreateChatRequestToJSON = CreateChatRequestToJSON;
20
21
  exports.CreateChatRequestToJSONTyped = CreateChatRequestToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.CreateChatRequestVisibilityEnum = {
26
+ Public: 'public',
27
+ Private: 'private'
28
+ };
21
29
  /**
22
30
  * Check if a given object implements the CreateChatRequest interface.
23
31
  */
@@ -32,7 +40,10 @@ function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
32
40
  return json;
33
41
  }
34
42
  return {
43
+ 'id': json['id'] == null ? undefined : json['id'],
35
44
  'title': json['title'] == null ? undefined : json['title'],
45
+ 'chatType': json['chatType'] == null ? undefined : json['chatType'],
46
+ 'visibility': json['visibility'] == null ? undefined : json['visibility'],
36
47
  };
37
48
  }
38
49
  function CreateChatRequestToJSON(json) {
@@ -43,6 +54,9 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
43
54
  return value;
44
55
  }
45
56
  return {
57
+ 'id': value['id'],
46
58
  'title': value['title'],
59
+ 'chatType': value['chatType'],
60
+ 'visibility': value['visibility'],
47
61
  };
48
62
  }
@@ -0,0 +1,74 @@
1
+ /**
2
+ * Athena API
3
+ * REST API for the Athena system
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface LearningStreakResponse
16
+ */
17
+ export interface LearningStreakResponse {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof LearningStreakResponse
22
+ */
23
+ currentDays: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof LearningStreakResponse
28
+ */
29
+ longestDays: number;
30
+ /**
31
+ *
32
+ * @type {Date}
33
+ * @memberof LearningStreakResponse
34
+ */
35
+ lastMomentDate?: Date | null;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof LearningStreakResponse
40
+ */
41
+ totalMissedDays: number;
42
+ /**
43
+ *
44
+ * @type {Array<number>}
45
+ * @memberof LearningStreakResponse
46
+ */
47
+ missedDaysInCycle: Array<number>;
48
+ /**
49
+ *
50
+ * @type {Date}
51
+ * @memberof LearningStreakResponse
52
+ */
53
+ lastEvaluatedAt?: Date | null;
54
+ /**
55
+ *
56
+ * @type {Date}
57
+ * @memberof LearningStreakResponse
58
+ */
59
+ createdAt: Date;
60
+ /**
61
+ *
62
+ * @type {Date}
63
+ * @memberof LearningStreakResponse
64
+ */
65
+ updatedAt: Date;
66
+ }
67
+ /**
68
+ * Check if a given object implements the LearningStreakResponse interface.
69
+ */
70
+ export declare function instanceOfLearningStreakResponse(value: object): value is LearningStreakResponse;
71
+ export declare function LearningStreakResponseFromJSON(json: any): LearningStreakResponse;
72
+ export declare function LearningStreakResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningStreakResponse;
73
+ export declare function LearningStreakResponseToJSON(json: any): LearningStreakResponse;
74
+ export declare function LearningStreakResponseToJSONTyped(value?: LearningStreakResponse | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Athena API
6
+ * REST API for the Athena system
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfLearningStreakResponse = instanceOfLearningStreakResponse;
17
+ exports.LearningStreakResponseFromJSON = LearningStreakResponseFromJSON;
18
+ exports.LearningStreakResponseFromJSONTyped = LearningStreakResponseFromJSONTyped;
19
+ exports.LearningStreakResponseToJSON = LearningStreakResponseToJSON;
20
+ exports.LearningStreakResponseToJSONTyped = LearningStreakResponseToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the LearningStreakResponse interface.
23
+ */
24
+ function instanceOfLearningStreakResponse(value) {
25
+ if (!('currentDays' in value) || value['currentDays'] === undefined)
26
+ return false;
27
+ if (!('longestDays' in value) || value['longestDays'] === undefined)
28
+ return false;
29
+ if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
30
+ return false;
31
+ if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === undefined)
32
+ return false;
33
+ if (!('createdAt' in value) || value['createdAt'] === undefined)
34
+ return false;
35
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined)
36
+ return false;
37
+ return true;
38
+ }
39
+ function LearningStreakResponseFromJSON(json) {
40
+ return LearningStreakResponseFromJSONTyped(json, false);
41
+ }
42
+ function LearningStreakResponseFromJSONTyped(json, ignoreDiscriminator) {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+ 'currentDays': json['currentDays'],
48
+ 'longestDays': json['longestDays'],
49
+ 'lastMomentDate': json['lastMomentDate'] == null ? undefined : (new Date(json['lastMomentDate'])),
50
+ 'totalMissedDays': json['totalMissedDays'],
51
+ 'missedDaysInCycle': json['missedDaysInCycle'],
52
+ 'lastEvaluatedAt': json['lastEvaluatedAt'] == null ? undefined : (new Date(json['lastEvaluatedAt'])),
53
+ 'createdAt': (new Date(json['createdAt'])),
54
+ 'updatedAt': (new Date(json['updatedAt'])),
55
+ };
56
+ }
57
+ function LearningStreakResponseToJSON(json) {
58
+ return LearningStreakResponseToJSONTyped(json, false);
59
+ }
60
+ function LearningStreakResponseToJSONTyped(value, ignoreDiscriminator = false) {
61
+ if (value == null) {
62
+ return value;
63
+ }
64
+ return {
65
+ 'currentDays': value['currentDays'],
66
+ 'longestDays': value['longestDays'],
67
+ 'lastMomentDate': value['lastMomentDate'] == null ? value['lastMomentDate'] : value['lastMomentDate'].toISOString().substring(0, 10),
68
+ 'totalMissedDays': value['totalMissedDays'],
69
+ 'missedDaysInCycle': value['missedDaysInCycle'],
70
+ 'lastEvaluatedAt': value['lastEvaluatedAt'] == null ? value['lastEvaluatedAt'] : value['lastEvaluatedAt'].toISOString(),
71
+ 'createdAt': value['createdAt'].toISOString(),
72
+ 'updatedAt': value['updatedAt'].toISOString(),
73
+ };
74
+ }
@@ -21,7 +21,27 @@ export interface UpdateChatRequest {
21
21
  * @memberof UpdateChatRequest
22
22
  */
23
23
  title?: string;
24
+ /**
25
+ * Chat type.
26
+ * @type {string}
27
+ * @memberof UpdateChatRequest
28
+ */
29
+ chatType?: string;
30
+ /**
31
+ * Visibility of the chat.
32
+ * @type {string}
33
+ * @memberof UpdateChatRequest
34
+ */
35
+ visibility?: UpdateChatRequestVisibilityEnum;
24
36
  }
37
+ /**
38
+ * @export
39
+ */
40
+ export declare const UpdateChatRequestVisibilityEnum: {
41
+ readonly Public: "public";
42
+ readonly Private: "private";
43
+ };
44
+ export type UpdateChatRequestVisibilityEnum = typeof UpdateChatRequestVisibilityEnum[keyof typeof UpdateChatRequestVisibilityEnum];
25
45
  /**
26
46
  * Check if a given object implements the UpdateChatRequest interface.
27
47
  */
@@ -13,11 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.UpdateChatRequestVisibilityEnum = void 0;
16
17
  exports.instanceOfUpdateChatRequest = instanceOfUpdateChatRequest;
17
18
  exports.UpdateChatRequestFromJSON = UpdateChatRequestFromJSON;
18
19
  exports.UpdateChatRequestFromJSONTyped = UpdateChatRequestFromJSONTyped;
19
20
  exports.UpdateChatRequestToJSON = UpdateChatRequestToJSON;
20
21
  exports.UpdateChatRequestToJSONTyped = UpdateChatRequestToJSONTyped;
22
+ /**
23
+ * @export
24
+ */
25
+ exports.UpdateChatRequestVisibilityEnum = {
26
+ Public: 'public',
27
+ Private: 'private'
28
+ };
21
29
  /**
22
30
  * Check if a given object implements the UpdateChatRequest interface.
23
31
  */
@@ -33,6 +41,8 @@ function UpdateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
33
41
  }
34
42
  return {
35
43
  'title': json['title'] == null ? undefined : json['title'],
44
+ 'chatType': json['chatType'] == null ? undefined : json['chatType'],
45
+ 'visibility': json['visibility'] == null ? undefined : json['visibility'],
36
46
  };
37
47
  }
38
48
  function UpdateChatRequestToJSON(json) {
@@ -44,5 +54,7 @@ function UpdateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
44
54
  }
45
55
  return {
46
56
  'title': value['title'],
57
+ 'chatType': value['chatType'],
58
+ 'visibility': value['visibility'],
47
59
  };
48
60
  }
@@ -8,6 +8,7 @@ export * from './CreateTokenResponse';
8
8
  export * from './HealthCheck';
9
9
  export * from './LearningDaysResponse';
10
10
  export * from './LearningMoment';
11
+ export * from './LearningStreakResponse';
11
12
  export * from './Message';
12
13
  export * from './MessageCountResponse';
13
14
  export * from './MessagePartsInner';
@@ -26,6 +26,7 @@ __exportStar(require("./CreateTokenResponse"), exports);
26
26
  __exportStar(require("./HealthCheck"), exports);
27
27
  __exportStar(require("./LearningDaysResponse"), exports);
28
28
  __exportStar(require("./LearningMoment"), exports);
29
+ __exportStar(require("./LearningStreakResponse"), exports);
29
30
  __exportStar(require("./Message"), exports);
30
31
  __exportStar(require("./MessageCountResponse"), exports);
31
32
  __exportStar(require("./MessagePartsInner"), exports);
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@instructure/athena-api-client",
3
3
  "private": false,
4
- "version": "1.0.3",
4
+ "version": "1.0.4",
5
5
  "description": "OpenAPI client for the Athena API",
6
6
  "author": "Instructure",
7
7
  "repository": {