@instructure/athena-api-client 1.0.0 → 1.0.2

package/dist/esm/apis/MessagesApi.js

@@ -21,11 +21,56 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { PaginatedMessagesFromJSON, } from '../models/index';
+import { MessageFromJSON, MessageCountResponseFromJSON, PaginatedMessagesFromJSON, } from '../models/index';
 /**
  *
  */
 export class MessagesApi extends runtime.BaseAPI {
+    /**
+     * Returns a single message belonging to the specified chat.
+     * Get a chat message
+     */
+    getChatMessageRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChatMessage().');
+            }
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatMessage().');
+            }
+            if (requestParameters['messageId'] == null) {
+                throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling getChatMessage().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/chats/{chatId}/messages/{messageId}`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            urlPath = urlPath.replace(`{${"messageId"}}`, encodeURIComponent(String(requestParameters['messageId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => MessageFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns a single message belonging to the specified chat.
+     * Get a chat message
+     */
+    getChatMessage(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getChatMessageRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Returns paginated messages belonging to the specified chat, ordered by creation date (newest first).
      * List chat messages
@@ -73,4 +118,47 @@ export class MessagesApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Returns the number of user-role messages sent by the authenticated account user within the given time window.
+     * Count user messages
+     */
+    getMessageCountRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getMessageCount().');
+            }
+            if (requestParameters['hours'] == null) {
+                throw new runtime.RequiredError('hours', 'Required parameter "hours" was null or undefined when calling getMessageCount().');
+            }
+            const queryParameters = {};
+            if (requestParameters['hours'] != null) {
+                queryParameters['hours'] = requestParameters['hours'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/messages/count`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => MessageCountResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Returns the number of user-role messages sent by the authenticated account user within the given time window.
+     * Count user messages
+     */
+    getMessageCount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getMessageCountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }

package/dist/esm/apis/index.d.ts

@@ -1,6 +1,7 @@
 export * from './AccountsApi';
 export * from './ChatsApi';
 export * from './HealthApi';
+export * from './LearningMomentsApi';
 export * from './MessagesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';

package/dist/esm/apis/index.js

@@ -3,6 +3,7 @@
 export * from './AccountsApi';
 export * from './ChatsApi';
 export * from './HealthApi';
+export * from './LearningMomentsApi';
 export * from './MessagesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';

package/dist/esm/models/Account.d.ts

@@ -27,6 +27,12 @@ export interface Account {
      * @memberof Account
      */
     name: string;
+    /**
+     * ID of the account's assigned plan
+     * @type {string}
+     * @memberof Account
+     */
+    planId?: string | null;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/esm/models/Account.js

@@ -35,6 +35,7 @@ export function AccountFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'planId': json['planId'] == null ? undefined : json['planId'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -49,6 +50,7 @@ export function AccountToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'planId': value['planId'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };

package/dist/esm/models/LearningMoment.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface LearningMoment
+ */
+export interface LearningMoment {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    id: string;
+    /**
+     * ID of the account user
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    accountUserId: string;
+    /**
+     * ID of the chat where the learning moment occurred
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    chatId: string;
+    /**
+     * ID of the message that triggered the learning moment
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    messageId: string;
+    /**
+     * Learning signal label (e.g. 'yes', 'weak')
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    label?: string | null;
+    /**
+     * Confidence score (0.00 - 1.00)
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    confidence?: string | null;
+    /**
+     * Explanation for the learning moment
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    reason?: string | null;
+    /**
+     * Date the learning moment occurred
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    occurredOn: Date;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the LearningMoment interface.
+ */
+export declare function instanceOfLearningMoment(value: object): value is LearningMoment;
+export declare function LearningMomentFromJSON(json: any): LearningMoment;
+export declare function LearningMomentFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningMoment;
+export declare function LearningMomentToJSON(json: any): LearningMoment;
+export declare function LearningMomentToJSONTyped(value?: LearningMoment | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearningMoment.js

@@ -0,0 +1,73 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the LearningMoment interface.
+ */
+export function instanceOfLearningMoment(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('messageId' in value) || value['messageId'] === undefined)
+        return false;
+    if (!('occurredOn' in value) || value['occurredOn'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function LearningMomentFromJSON(json) {
+    return LearningMomentFromJSONTyped(json, false);
+}
+export function LearningMomentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'],
+        'messageId': json['messageId'],
+        'label': json['label'] == null ? undefined : json['label'],
+        'confidence': json['confidence'] == null ? undefined : json['confidence'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'occurredOn': (new Date(json['occurredOn'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function LearningMomentToJSON(json) {
+    return LearningMomentToJSONTyped(json, false);
+}
+export function LearningMomentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'chatId': value['chatId'],
+        'messageId': value['messageId'],
+        'label': value['label'],
+        'confidence': value['confidence'],
+        'reason': value['reason'],
+        'occurredOn': value['occurredOn'].toISOString().substring(0, 10),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

package/dist/esm/models/Message.d.ts

@@ -52,6 +52,12 @@ export interface Message {
      * @memberof Message
      */
     createdAt: Date;
+    /**
+     * Whether a learning moment exists for this message
+     * @type {boolean}
+     * @memberof Message
+     */
+    isLearningMoment: boolean;
 }
 /**
  * Check if a given object implements the Message interface.

package/dist/esm/models/Message.js

@@ -28,6 +28,8 @@ export function instanceOfMessage(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('isLearningMoment' in value) || value['isLearningMoment'] === undefined)
+        return false;
     return true;
 }
 export function MessageFromJSON(json) {
@@ -44,6 +46,7 @@ export function MessageFromJSONTyped(json, ignoreDiscriminator) {
         'parts': (json['parts'].map(MessagePartsInnerFromJSON)),
         'attachments': json['attachments'],
         'createdAt': (new Date(json['createdAt'])),
+        'isLearningMoment': json['isLearningMoment'],
     };
 }
 export function MessageToJSON(json) {
@@ -60,5 +63,6 @@ export function MessageToJSONTyped(value, ignoreDiscriminator = false) {
         'parts': (value['parts'].map(MessagePartsInnerToJSON)),
         'attachments': value['attachments'],
         'createdAt': value['createdAt'].toISOString(),
+        'isLearningMoment': value['isLearningMoment'],
     };
 }

package/dist/esm/models/MessageCountResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface MessageCountResponse
+ */
+export interface MessageCountResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof MessageCountResponse
+     */
+    count: number;
+}
+/**
+ * Check if a given object implements the MessageCountResponse interface.
+ */
+export declare function instanceOfMessageCountResponse(value: object): value is MessageCountResponse;
+export declare function MessageCountResponseFromJSON(json: any): MessageCountResponse;
+export declare function MessageCountResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MessageCountResponse;
+export declare function MessageCountResponseToJSON(json: any): MessageCountResponse;
+export declare function MessageCountResponseToJSONTyped(value?: MessageCountResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MessageCountResponse.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the MessageCountResponse interface.
+ */
+export function instanceOfMessageCountResponse(value) {
+    if (!('count' in value) || value['count'] === undefined)
+        return false;
+    return true;
+}
+export function MessageCountResponseFromJSON(json) {
+    return MessageCountResponseFromJSONTyped(json, false);
+}
+export function MessageCountResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'count': json['count'],
+    };
+}
+export function MessageCountResponseToJSON(json) {
+    return MessageCountResponseToJSONTyped(json, false);
+}
+export function MessageCountResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'count': value['count'],
+    };
+}

package/dist/esm/models/PaginatedLearningMoments.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LearningMoment } from './LearningMoment';
+/**
+ *
+ * @export
+ * @interface PaginatedLearningMoments
+ */
+export interface PaginatedLearningMoments {
+    /**
+     * Array of learning moment objects
+     * @type {Array<LearningMoment>}
+     * @memberof PaginatedLearningMoments
+     */
+    data: Array<LearningMoment>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedLearningMoments
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedLearningMoments interface.
+ */
+export declare function instanceOfPaginatedLearningMoments(value: object): value is PaginatedLearningMoments;
+export declare function PaginatedLearningMomentsFromJSON(json: any): PaginatedLearningMoments;
+export declare function PaginatedLearningMomentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedLearningMoments;
+export declare function PaginatedLearningMomentsToJSON(json: any): PaginatedLearningMoments;
+export declare function PaginatedLearningMomentsToJSONTyped(value?: PaginatedLearningMoments | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedLearningMoments.js

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { LearningMomentFromJSON, LearningMomentToJSON, } from './LearningMoment';
+/**
+ * Check if a given object implements the PaginatedLearningMoments interface.
+ */
+export function instanceOfPaginatedLearningMoments(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedLearningMomentsFromJSON(json) {
+    return PaginatedLearningMomentsFromJSONTyped(json, false);
+}
+export function PaginatedLearningMomentsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(LearningMomentFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedLearningMomentsToJSON(json) {
+    return PaginatedLearningMomentsToJSONTyped(json, false);
+}
+export function PaginatedLearningMomentsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(LearningMomentToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -6,10 +6,13 @@ export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './HealthCheck';
+export * from './LearningMoment';
 export * from './Message';
+export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ModelError';
 export * from './PaginatedChats';
+export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './ServiceToken';
 export * from './Tag';

package/dist/esm/models/index.js

@@ -8,10 +8,13 @@ export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './HealthCheck';
+export * from './LearningMoment';
 export * from './Message';
+export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ModelError';
 export * from './PaginatedChats';
+export * from './PaginatedLearningMoments';
 export * from './PaginatedMessages';
 export * from './ServiceToken';
 export * from './Tag';

package/dist/models/Account.d.ts

@@ -27,6 +27,12 @@ export interface Account {
      * @memberof Account
      */
     name: string;
+    /**
+     * ID of the account's assigned plan
+     * @type {string}
+     * @memberof Account
+     */
+    planId?: string | null;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/models/Account.js

@@ -42,6 +42,7 @@ function AccountFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'id': json['id'],
         'name': json['name'],
+        'planId': json['planId'] == null ? undefined : json['planId'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };
@@ -56,6 +57,7 @@ function AccountToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'id': value['id'],
         'name': value['name'],
+        'planId': value['planId'],
         'createdAt': value['createdAt'].toISOString(),
         'updatedAt': value['updatedAt'].toISOString(),
     };

package/dist/models/LearningMoment.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface LearningMoment
+ */
+export interface LearningMoment {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    id: string;
+    /**
+     * ID of the account user
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    accountUserId: string;
+    /**
+     * ID of the chat where the learning moment occurred
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    chatId: string;
+    /**
+     * ID of the message that triggered the learning moment
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    messageId: string;
+    /**
+     * Learning signal label (e.g. 'yes', 'weak')
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    label?: string | null;
+    /**
+     * Confidence score (0.00 - 1.00)
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    confidence?: string | null;
+    /**
+     * Explanation for the learning moment
+     * @type {string}
+     * @memberof LearningMoment
+     */
+    reason?: string | null;
+    /**
+     * Date the learning moment occurred
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    occurredOn: Date;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof LearningMoment
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the LearningMoment interface.
+ */
+export declare function instanceOfLearningMoment(value: object): value is LearningMoment;
+export declare function LearningMomentFromJSON(json: any): LearningMoment;
+export declare function LearningMomentFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningMoment;
+export declare function LearningMomentToJSON(json: any): LearningMoment;
+export declare function LearningMomentToJSONTyped(value?: LearningMoment | null, ignoreDiscriminator?: boolean): any;