@instructure/athena-api-client 1.0.2 → 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.
Files changed (42) hide show
  1. package/README.md +5 -0
  2. package/dist/apis/ChatsApi.d.ts +2 -0
  3. package/dist/apis/ChatsApi.js +6 -0
  4. package/dist/apis/LearningDaysApi.d.ts +33 -0
  5. package/dist/apis/LearningDaysApi.js +82 -0
  6. package/dist/apis/LearningStreakApi.d.ts +31 -0
  7. package/dist/apis/LearningStreakApi.js +70 -0
  8. package/dist/apis/MessagesApi.d.ts +15 -0
  9. package/dist/apis/MessagesApi.js +46 -0
  10. package/dist/apis/index.d.ts +2 -0
  11. package/dist/apis/index.js +2 -0
  12. package/dist/esm/apis/ChatsApi.d.ts +2 -0
  13. package/dist/esm/apis/ChatsApi.js +6 -0
  14. package/dist/esm/apis/LearningDaysApi.d.ts +33 -0
  15. package/dist/esm/apis/LearningDaysApi.js +78 -0
  16. package/dist/esm/apis/LearningStreakApi.d.ts +31 -0
  17. package/dist/esm/apis/LearningStreakApi.js +66 -0
  18. package/dist/esm/apis/MessagesApi.d.ts +15 -0
  19. package/dist/esm/apis/MessagesApi.js +46 -0
  20. package/dist/esm/apis/index.d.ts +2 -0
  21. package/dist/esm/apis/index.js +2 -0
  22. package/dist/esm/models/CreateChatRequest.d.ts +26 -0
  23. package/dist/esm/models/CreateChatRequest.js +13 -0
  24. package/dist/esm/models/LearningDaysResponse.d.ts +38 -0
  25. package/dist/esm/models/LearningDaysResponse.js +47 -0
  26. package/dist/esm/models/LearningStreakResponse.d.ts +74 -0
  27. package/dist/esm/models/LearningStreakResponse.js +67 -0
  28. package/dist/esm/models/UpdateChatRequest.d.ts +20 -0
  29. package/dist/esm/models/UpdateChatRequest.js +11 -0
  30. package/dist/esm/models/index.d.ts +2 -0
  31. package/dist/esm/models/index.js +2 -0
  32. package/dist/models/CreateChatRequest.d.ts +26 -0
  33. package/dist/models/CreateChatRequest.js +14 -0
  34. package/dist/models/LearningDaysResponse.d.ts +38 -0
  35. package/dist/models/LearningDaysResponse.js +54 -0
  36. package/dist/models/LearningStreakResponse.d.ts +74 -0
  37. package/dist/models/LearningStreakResponse.js +74 -0
  38. package/dist/models/UpdateChatRequest.d.ts +20 -0
  39. package/dist/models/UpdateChatRequest.js +12 -0
  40. package/dist/models/index.d.ts +2 -0
  41. package/dist/models/index.js +2 -0
  42. package/package.json +1 -1
package/README.md CHANGED
@@ -64,7 +64,10 @@ All URIs are relative to *http://localhost:3000*
64
64
  *ChatsApi* | [**sendChatMessage**](docs/ChatsApi.md#sendchatmessage) | **POST** /api/v1/chat | Send a message to a chat
65
65
  *ChatsApi* | [**updateChat**](docs/ChatsApi.md#updatechatoperation) | **PATCH** /api/v1/chats/{chatId} | Update a chat
66
66
  *HealthApi* | [**healthCheck**](docs/HealthApi.md#healthcheck) | **GET** /health | Health check endpoint
67
+ *LearningDaysApi* | [**getLearningDays**](docs/LearningDaysApi.md#getlearningdays) | **GET** /api/v1/learning-days | Get learning days in range
67
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
70
+ *MessagesApi* | [**deleteMessages**](docs/MessagesApi.md#deletemessages) | **DELETE** /api/v1/chats/{chatId}/messages | Delete messages from timestamp
68
71
  *MessagesApi* | [**getChatMessage**](docs/MessagesApi.md#getchatmessage) | **GET** /api/v1/chats/{chatId}/messages/{messageId} | Get a chat message
69
72
  *MessagesApi* | [**getChatMessages**](docs/MessagesApi.md#getchatmessages) | **GET** /api/v1/chats/{chatId}/messages | List chat messages
70
73
  *MessagesApi* | [**getMessageCount**](docs/MessagesApi.md#getmessagecount) | **GET** /api/v1/messages/count | Count user messages
@@ -86,7 +89,9 @@ All URIs are relative to *http://localhost:3000*
86
89
  - [CreateTokenRequest](docs/CreateTokenRequest.md)
87
90
  - [CreateTokenResponse](docs/CreateTokenResponse.md)
88
91
  - [HealthCheck](docs/HealthCheck.md)
92
+ - [LearningDaysResponse](docs/LearningDaysResponse.md)
89
93
  - [LearningMoment](docs/LearningMoment.md)
94
+ - [LearningStreakResponse](docs/LearningStreakResponse.md)
90
95
  - [Message](docs/Message.md)
91
96
  - [MessageCountResponse](docs/MessageCountResponse.md)
92
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;
@@ -35,6 +36,7 @@ export interface MarkChatAsViewedRequest {
35
36
  export interface SendChatMessageRequest {
36
37
  xUserId: string;
37
38
  chatRequest: ChatRequest;
39
+ xUserTimezone?: string;
38
40
  xCanvasToken?: string;
39
41
  }
40
42
  export interface UpdateChatOperationRequest {
@@ -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']);
@@ -248,6 +251,9 @@ class ChatsApi extends runtime.BaseAPI {
248
251
  const queryParameters = {};
249
252
  const headerParameters = {};
250
253
  headerParameters['Content-Type'] = 'application/json';
254
+ if (requestParameters['xUserTimezone'] != null) {
255
+ headerParameters['X-User-Timezone'] = String(requestParameters['xUserTimezone']);
256
+ }
251
257
  if (requestParameters['xCanvasToken'] != null) {
252
258
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
253
259
  }
@@ -0,0 +1,33 @@
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 { LearningDaysResponse } from '../models/index';
14
+ export interface GetLearningDaysRequest {
15
+ xUserId: string;
16
+ startDate: Date;
17
+ endDate: Date;
18
+ }
19
+ /**
20
+ *
21
+ */
22
+ export declare class LearningDaysApi extends runtime.BaseAPI {
23
+ /**
24
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
25
+ * Get learning days in range
26
+ */
27
+ getLearningDaysRaw(requestParameters: GetLearningDaysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningDaysResponse>>;
28
+ /**
29
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
30
+ * Get learning days in range
31
+ */
32
+ getLearningDays(requestParameters: GetLearningDaysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningDaysResponse>;
33
+ }
@@ -0,0 +1,82 @@
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.LearningDaysApi = void 0;
26
+ const runtime = require("../runtime");
27
+ const index_1 = require("../models/index");
28
+ /**
29
+ *
30
+ */
31
+ class LearningDaysApi extends runtime.BaseAPI {
32
+ /**
33
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
34
+ * Get learning days in range
35
+ */
36
+ getLearningDaysRaw(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 getLearningDays().');
40
+ }
41
+ if (requestParameters['startDate'] == null) {
42
+ throw new runtime.RequiredError('startDate', 'Required parameter "startDate" was null or undefined when calling getLearningDays().');
43
+ }
44
+ if (requestParameters['endDate'] == null) {
45
+ throw new runtime.RequiredError('endDate', 'Required parameter "endDate" was null or undefined when calling getLearningDays().');
46
+ }
47
+ const queryParameters = {};
48
+ if (requestParameters['startDate'] != null) {
49
+ queryParameters['startDate'] = requestParameters['startDate'].toISOString().substring(0, 10);
50
+ }
51
+ if (requestParameters['endDate'] != null) {
52
+ queryParameters['endDate'] = requestParameters['endDate'].toISOString().substring(0, 10);
53
+ }
54
+ const headerParameters = {};
55
+ if (requestParameters['xUserId'] != null) {
56
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
57
+ }
58
+ if (this.configuration && this.configuration.apiKey) {
59
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
60
+ }
61
+ let urlPath = `/api/v1/learning-days`;
62
+ const response = yield this.request({
63
+ path: urlPath,
64
+ method: 'GET',
65
+ headers: headerParameters,
66
+ query: queryParameters,
67
+ }, initOverrides);
68
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.LearningDaysResponseFromJSON)(jsonValue));
69
+ });
70
+ }
71
+ /**
72
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
73
+ * Get learning days in range
74
+ */
75
+ getLearningDays(requestParameters, initOverrides) {
76
+ return __awaiter(this, void 0, void 0, function* () {
77
+ const response = yield this.getLearningDaysRaw(requestParameters, initOverrides);
78
+ return yield response.value();
79
+ });
80
+ }
81
+ }
82
+ exports.LearningDaysApi = LearningDaysApi;
@@ -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;
@@ -11,6 +11,11 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import type { Message, MessageCountResponse, PaginatedMessages } from '../models/index';
14
+ export interface DeleteMessagesRequest {
15
+ xUserId: string;
16
+ chatId: string;
17
+ since: Date;
18
+ }
14
19
  export interface GetChatMessageRequest {
15
20
  xUserId: string;
16
21
  chatId: string;
@@ -30,6 +35,16 @@ export interface GetMessageCountRequest {
30
35
  *
31
36
  */
32
37
  export declare class MessagesApi extends runtime.BaseAPI {
38
+ /**
39
+ * Deletes all messages in a chat at or after the given timestamp.
40
+ * Delete messages from timestamp
41
+ */
42
+ deleteMessagesRaw(requestParameters: DeleteMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
43
+ /**
44
+ * Deletes all messages in a chat at or after the given timestamp.
45
+ * Delete messages from timestamp
46
+ */
47
+ deleteMessages(requestParameters: DeleteMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
33
48
  /**
34
49
  * Returns a single message belonging to the specified chat.
35
50
  * Get a chat message
@@ -29,6 +29,52 @@ const index_1 = require("../models/index");
29
29
  *
30
30
  */
31
31
  class MessagesApi extends runtime.BaseAPI {
32
+ /**
33
+ * Deletes all messages in a chat at or after the given timestamp.
34
+ * Delete messages from timestamp
35
+ */
36
+ deleteMessagesRaw(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 deleteMessages().');
40
+ }
41
+ if (requestParameters['chatId'] == null) {
42
+ throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling deleteMessages().');
43
+ }
44
+ if (requestParameters['since'] == null) {
45
+ throw new runtime.RequiredError('since', 'Required parameter "since" was null or undefined when calling deleteMessages().');
46
+ }
47
+ const queryParameters = {};
48
+ if (requestParameters['since'] != null) {
49
+ queryParameters['since'] = requestParameters['since'].toISOString();
50
+ }
51
+ const headerParameters = {};
52
+ if (requestParameters['xUserId'] != null) {
53
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
54
+ }
55
+ if (this.configuration && this.configuration.apiKey) {
56
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
57
+ }
58
+ let urlPath = `/api/v1/chats/{chatId}/messages`;
59
+ urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
60
+ const response = yield this.request({
61
+ path: urlPath,
62
+ method: 'DELETE',
63
+ headers: headerParameters,
64
+ query: queryParameters,
65
+ }, initOverrides);
66
+ return new runtime.VoidApiResponse(response);
67
+ });
68
+ }
69
+ /**
70
+ * Deletes all messages in a chat at or after the given timestamp.
71
+ * Delete messages from timestamp
72
+ */
73
+ deleteMessages(requestParameters, initOverrides) {
74
+ return __awaiter(this, void 0, void 0, function* () {
75
+ yield this.deleteMessagesRaw(requestParameters, initOverrides);
76
+ });
77
+ }
32
78
  /**
33
79
  * Returns a single message belonging to the specified chat.
34
80
  * Get a chat message
@@ -1,7 +1,9 @@
1
1
  export * from './AccountsApi';
2
2
  export * from './ChatsApi';
3
3
  export * from './HealthApi';
4
+ export * from './LearningDaysApi';
4
5
  export * from './LearningMomentsApi';
6
+ export * from './LearningStreakApi';
5
7
  export * from './MessagesApi';
6
8
  export * from './ServiceTokensApi';
7
9
  export * from './TagsApi';
@@ -19,7 +19,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
19
19
  __exportStar(require("./AccountsApi"), exports);
20
20
  __exportStar(require("./ChatsApi"), exports);
21
21
  __exportStar(require("./HealthApi"), exports);
22
+ __exportStar(require("./LearningDaysApi"), exports);
22
23
  __exportStar(require("./LearningMomentsApi"), exports);
24
+ __exportStar(require("./LearningStreakApi"), exports);
23
25
  __exportStar(require("./MessagesApi"), exports);
24
26
  __exportStar(require("./ServiceTokensApi"), exports);
25
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;
@@ -35,6 +36,7 @@ export interface MarkChatAsViewedRequest {
35
36
  export interface SendChatMessageRequest {
36
37
  xUserId: string;
37
38
  chatRequest: ChatRequest;
39
+ xUserTimezone?: string;
38
40
  xCanvasToken?: string;
39
41
  }
40
42
  export interface UpdateChatOperationRequest {
@@ -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']);
@@ -245,6 +248,9 @@ export class ChatsApi extends runtime.BaseAPI {
245
248
  const queryParameters = {};
246
249
  const headerParameters = {};
247
250
  headerParameters['Content-Type'] = 'application/json';
251
+ if (requestParameters['xUserTimezone'] != null) {
252
+ headerParameters['X-User-Timezone'] = String(requestParameters['xUserTimezone']);
253
+ }
248
254
  if (requestParameters['xCanvasToken'] != null) {
249
255
  headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
250
256
  }
@@ -0,0 +1,33 @@
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 { LearningDaysResponse } from '../models/index';
14
+ export interface GetLearningDaysRequest {
15
+ xUserId: string;
16
+ startDate: Date;
17
+ endDate: Date;
18
+ }
19
+ /**
20
+ *
21
+ */
22
+ export declare class LearningDaysApi extends runtime.BaseAPI {
23
+ /**
24
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
25
+ * Get learning days in range
26
+ */
27
+ getLearningDaysRaw(requestParameters: GetLearningDaysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LearningDaysResponse>>;
28
+ /**
29
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
30
+ * Get learning days in range
31
+ */
32
+ getLearningDays(requestParameters: GetLearningDaysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LearningDaysResponse>;
33
+ }
@@ -0,0 +1,78 @@
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 { LearningDaysResponseFromJSON, } from '../models/index';
25
+ /**
26
+ *
27
+ */
28
+ export class LearningDaysApi extends runtime.BaseAPI {
29
+ /**
30
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
31
+ * Get learning days in range
32
+ */
33
+ getLearningDaysRaw(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 getLearningDays().');
37
+ }
38
+ if (requestParameters['startDate'] == null) {
39
+ throw new runtime.RequiredError('startDate', 'Required parameter "startDate" was null or undefined when calling getLearningDays().');
40
+ }
41
+ if (requestParameters['endDate'] == null) {
42
+ throw new runtime.RequiredError('endDate', 'Required parameter "endDate" was null or undefined when calling getLearningDays().');
43
+ }
44
+ const queryParameters = {};
45
+ if (requestParameters['startDate'] != null) {
46
+ queryParameters['startDate'] = requestParameters['startDate'].toISOString().substring(0, 10);
47
+ }
48
+ if (requestParameters['endDate'] != null) {
49
+ queryParameters['endDate'] = requestParameters['endDate'].toISOString().substring(0, 10);
50
+ }
51
+ const headerParameters = {};
52
+ if (requestParameters['xUserId'] != null) {
53
+ headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
54
+ }
55
+ if (this.configuration && this.configuration.apiKey) {
56
+ headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
57
+ }
58
+ let urlPath = `/api/v1/learning-days`;
59
+ const response = yield this.request({
60
+ path: urlPath,
61
+ method: 'GET',
62
+ headers: headerParameters,
63
+ query: queryParameters,
64
+ }, initOverrides);
65
+ return new runtime.JSONApiResponse(response, (jsonValue) => LearningDaysResponseFromJSON(jsonValue));
66
+ });
67
+ }
68
+ /**
69
+ * Returns distinct dates within the given range on which the user had at least one learning moment, plus the date of their most recent learning moment overall.
70
+ * Get learning days in range
71
+ */
72
+ getLearningDays(requestParameters, initOverrides) {
73
+ return __awaiter(this, void 0, void 0, function* () {
74
+ const response = yield this.getLearningDaysRaw(requestParameters, initOverrides);
75
+ return yield response.value();
76
+ });
77
+ }
78
+ }
@@ -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
+ }
@@ -11,6 +11,11 @@
11
11
  */
12
12
  import * as runtime from '../runtime';
13
13
  import type { Message, MessageCountResponse, PaginatedMessages } from '../models/index';
14
+ export interface DeleteMessagesRequest {
15
+ xUserId: string;
16
+ chatId: string;
17
+ since: Date;
18
+ }
14
19
  export interface GetChatMessageRequest {
15
20
  xUserId: string;
16
21
  chatId: string;
@@ -30,6 +35,16 @@ export interface GetMessageCountRequest {
30
35
  *
31
36
  */
32
37
  export declare class MessagesApi extends runtime.BaseAPI {
38
+ /**
39
+ * Deletes all messages in a chat at or after the given timestamp.
40
+ * Delete messages from timestamp
41
+ */
42
+ deleteMessagesRaw(requestParameters: DeleteMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
43
+ /**
44
+ * Deletes all messages in a chat at or after the given timestamp.
45
+ * Delete messages from timestamp
46
+ */
47
+ deleteMessages(requestParameters: DeleteMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
33
48
  /**
34
49
  * Returns a single message belonging to the specified chat.
35
50
  * Get a chat message