@instructure/athena-api-client 1.0.3 → 1.0.5

package/dist/esm/models/ChatRequestAttachmentsInner.js

@@ -0,0 +1,57 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const ChatRequestAttachmentsInnerMimeTypeEnum = {
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImagePng: 'image/png',
+    ImageWebp: 'image/webp',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the ChatRequestAttachmentsInner interface.
+ */
+export function instanceOfChatRequestAttachmentsInner(value) {
+    if (!('fileId' in value) || value['fileId'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestAttachmentsInnerFromJSON(json) {
+    return ChatRequestAttachmentsInnerFromJSONTyped(json, false);
+}
+export function ChatRequestAttachmentsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['fileId'],
+        'mimeType': json['mimeType'],
+    };
+}
+export function ChatRequestAttachmentsInnerToJSON(json) {
+    return ChatRequestAttachmentsInnerToJSONTyped(json, false);
+}
+export function ChatRequestAttachmentsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileId': value['fileId'],
+        'mimeType': value['mimeType'],
+    };
+}

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

@@ -15,13 +15,39 @@
  * @interface CreateChatRequest
  */
 export interface CreateChatRequest {
+    /**
+     * Optional caller-supplied UUID for the chat. If omitted, one is generated.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    id?: string;
     /**
      * Optional title for the chat. Defaults to 'New Chat' if omitted.
      * @type {string}
      * @memberof CreateChatRequest
      */
     title?: string;
+    /**
+     * Optional chat type. Defaults to a general chat if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    chatType?: string;
+    /**
+     * Visibility of the chat. Defaults to 'private' if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    visibility?: CreateChatRequestVisibilityEnum;
 }
+/**
+ * @export
+ */
+export declare const CreateChatRequestVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type CreateChatRequestVisibilityEnum = typeof CreateChatRequestVisibilityEnum[keyof typeof CreateChatRequestVisibilityEnum];
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */

package/dist/esm/models/CreateChatRequest.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const CreateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */
@@ -25,7 +32,10 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'id': json['id'] == null ? undefined : json['id'],
         'title': json['title'] == null ? undefined : json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
     };
 }
 export function CreateChatRequestToJSON(json) {
@@ -36,6 +46,9 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
         return value;
     }
     return {
+        'id': value['id'],
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

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

@@ -0,0 +1,74 @@
+/**
+ * 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 LearningStreakResponse
+ */
+export interface LearningStreakResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    currentDays: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    longestDays: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    lastMomentDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    totalMissedDays: number;
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof LearningStreakResponse
+     */
+    missedDaysInCycle: Array<number>;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    lastEvaluatedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the LearningStreakResponse interface.
+ */
+export declare function instanceOfLearningStreakResponse(value: object): value is LearningStreakResponse;
+export declare function LearningStreakResponseFromJSON(json: any): LearningStreakResponse;
+export declare function LearningStreakResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningStreakResponse;
+export declare function LearningStreakResponseToJSON(json: any): LearningStreakResponse;
+export declare function LearningStreakResponseToJSONTyped(value?: LearningStreakResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearningStreakResponse.js

@@ -0,0 +1,67 @@
+/* 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 LearningStreakResponse interface.
+ */
+export function instanceOfLearningStreakResponse(value) {
+    if (!('currentDays' in value) || value['currentDays'] === undefined)
+        return false;
+    if (!('longestDays' in value) || value['longestDays'] === undefined)
+        return false;
+    if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
+        return false;
+    if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === 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 LearningStreakResponseFromJSON(json) {
+    return LearningStreakResponseFromJSONTyped(json, false);
+}
+export function LearningStreakResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'currentDays': json['currentDays'],
+        'longestDays': json['longestDays'],
+        'lastMomentDate': json['lastMomentDate'] == null ? undefined : (new Date(json['lastMomentDate'])),
+        'totalMissedDays': json['totalMissedDays'],
+        'missedDaysInCycle': json['missedDaysInCycle'],
+        'lastEvaluatedAt': json['lastEvaluatedAt'] == null ? undefined : (new Date(json['lastEvaluatedAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function LearningStreakResponseToJSON(json) {
+    return LearningStreakResponseToJSONTyped(json, false);
+}
+export function LearningStreakResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'currentDays': value['currentDays'],
+        'longestDays': value['longestDays'],
+        'lastMomentDate': value['lastMomentDate'] == null ? value['lastMomentDate'] : value['lastMomentDate'].toISOString().substring(0, 10),
+        'totalMissedDays': value['totalMissedDays'],
+        'missedDaysInCycle': value['missedDaysInCycle'],
+        'lastEvaluatedAt': value['lastEvaluatedAt'] == null ? value['lastEvaluatedAt'] : value['lastEvaluatedAt'].toISOString(),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { MessageAttachmentsInner } from './MessageAttachmentsInner';
 import type { MessagePartsInner } from './MessagePartsInner';
 /**
  *
@@ -41,11 +42,11 @@ export interface Message {
      */
     parts: Array<MessagePartsInner>;
     /**
-     * Message attachments
-     * @type {Array<object>}
+     * Message attachments with fresh signed GET URLs
+     * @type {Array<MessageAttachmentsInner>}
      * @memberof Message
      */
-    attachments: Array<object>;
+    attachments: Array<MessageAttachmentsInner>;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/esm/models/Message.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { MessageAttachmentsInnerFromJSON, MessageAttachmentsInnerToJSON, } from './MessageAttachmentsInner';
 import { MessagePartsInnerFromJSON, MessagePartsInnerToJSON, } from './MessagePartsInner';
 /**
  * Check if a given object implements the Message interface.
@@ -44,7 +45,7 @@ export function MessageFromJSONTyped(json, ignoreDiscriminator) {
         'chatId': json['chatId'],
         'role': json['role'],
         'parts': (json['parts'].map(MessagePartsInnerFromJSON)),
-        'attachments': json['attachments'],
+        'attachments': (json['attachments'].map(MessageAttachmentsInnerFromJSON)),
         'createdAt': (new Date(json['createdAt'])),
         'isLearningMoment': json['isLearningMoment'],
     };
@@ -61,7 +62,7 @@ export function MessageToJSONTyped(value, ignoreDiscriminator = false) {
         'chatId': value['chatId'],
         'role': value['role'],
         'parts': (value['parts'].map(MessagePartsInnerToJSON)),
-        'attachments': value['attachments'],
+        'attachments': (value['attachments'].map(MessageAttachmentsInnerToJSON)),
         'createdAt': value['createdAt'].toISOString(),
         'isLearningMoment': value['isLearningMoment'],
     };

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

@@ -0,0 +1,55 @@
+/**
+ * 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 MessageAttachmentsInner
+ */
+export interface MessageAttachmentsInner {
+    /**
+     * File ID returned from the upload-url endpoint
+     * @type {string}
+     * @memberof MessageAttachmentsInner
+     */
+    fileId: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof MessageAttachmentsInner
+     */
+    mimeType: MessageAttachmentsInnerMimeTypeEnum;
+    /**
+     * Fresh signed GET URL (expires in 30 minutes). Absent for legacy attachments without a fileId.
+     * @type {string}
+     * @memberof MessageAttachmentsInner
+     */
+    url?: string;
+}
+/**
+ * @export
+ */
+export declare const MessageAttachmentsInnerMimeTypeEnum: {
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageJpg: "image/jpg";
+    readonly ImagePng: "image/png";
+    readonly ImageWebp: "image/webp";
+    readonly ApplicationPdf: "application/pdf";
+};
+export type MessageAttachmentsInnerMimeTypeEnum = typeof MessageAttachmentsInnerMimeTypeEnum[keyof typeof MessageAttachmentsInnerMimeTypeEnum];
+/**
+ * Check if a given object implements the MessageAttachmentsInner interface.
+ */
+export declare function instanceOfMessageAttachmentsInner(value: object): value is MessageAttachmentsInner;
+export declare function MessageAttachmentsInnerFromJSON(json: any): MessageAttachmentsInner;
+export declare function MessageAttachmentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): MessageAttachmentsInner;
+export declare function MessageAttachmentsInnerToJSON(json: any): MessageAttachmentsInner;
+export declare function MessageAttachmentsInnerToJSONTyped(value?: MessageAttachmentsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MessageAttachmentsInner.js

@@ -0,0 +1,59 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const MessageAttachmentsInnerMimeTypeEnum = {
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImagePng: 'image/png',
+    ImageWebp: 'image/webp',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the MessageAttachmentsInner interface.
+ */
+export function instanceOfMessageAttachmentsInner(value) {
+    if (!('fileId' in value) || value['fileId'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    return true;
+}
+export function MessageAttachmentsInnerFromJSON(json) {
+    return MessageAttachmentsInnerFromJSONTyped(json, false);
+}
+export function MessageAttachmentsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['fileId'],
+        'mimeType': json['mimeType'],
+        'url': json['url'] == null ? undefined : json['url'],
+    };
+}
+export function MessageAttachmentsInnerToJSON(json) {
+    return MessageAttachmentsInnerToJSONTyped(json, false);
+}
+export function MessageAttachmentsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileId': value['fileId'],
+        'mimeType': value['mimeType'],
+        'url': value['url'],
+    };
+}

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

@@ -21,7 +21,27 @@ export interface UpdateChatRequest {
      * @memberof UpdateChatRequest
      */
     title?: string;
+    /**
+     * Chat type.
+     * @type {string}
+     * @memberof UpdateChatRequest
+     */
+    chatType?: string;
+    /**
+     * Visibility of the chat.
+     * @type {string}
+     * @memberof UpdateChatRequest
+     */
+    visibility?: UpdateChatRequestVisibilityEnum;
 }
+/**
+ * @export
+ */
+export declare const UpdateChatRequestVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type UpdateChatRequestVisibilityEnum = typeof UpdateChatRequestVisibilityEnum[keyof typeof UpdateChatRequestVisibilityEnum];
 /**
  * Check if a given object implements the UpdateChatRequest interface.
  */

package/dist/esm/models/UpdateChatRequest.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const UpdateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the UpdateChatRequest interface.
  */
@@ -26,6 +33,8 @@ export function UpdateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'title': json['title'] == null ? undefined : json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
     };
 }
 export function UpdateChatRequestToJSON(json) {
@@ -37,5 +46,7 @@ export function UpdateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
     }
     return {
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

package/dist/esm/models/UploadUrlRequest.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 { UploadUrlRequestFilesInner } from './UploadUrlRequestFilesInner';
+/**
+ *
+ * @export
+ * @interface UploadUrlRequest
+ */
+export interface UploadUrlRequest {
+    /**
+     * ID of the chat to associate the files with
+     * @type {string}
+     * @memberof UploadUrlRequest
+     */
+    chatId: string;
+    /**
+     *
+     * @type {Array<UploadUrlRequestFilesInner>}
+     * @memberof UploadUrlRequest
+     */
+    files: Array<UploadUrlRequestFilesInner>;
+}
+/**
+ * Check if a given object implements the UploadUrlRequest interface.
+ */
+export declare function instanceOfUploadUrlRequest(value: object): value is UploadUrlRequest;
+export declare function UploadUrlRequestFromJSON(json: any): UploadUrlRequest;
+export declare function UploadUrlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadUrlRequest;
+export declare function UploadUrlRequestToJSON(json: any): UploadUrlRequest;
+export declare function UploadUrlRequestToJSONTyped(value?: UploadUrlRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UploadUrlRequest.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 { UploadUrlRequestFilesInnerFromJSON, UploadUrlRequestFilesInnerToJSON, } from './UploadUrlRequestFilesInner';
+/**
+ * Check if a given object implements the UploadUrlRequest interface.
+ */
+export function instanceOfUploadUrlRequest(value) {
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    return true;
+}
+export function UploadUrlRequestFromJSON(json) {
+    return UploadUrlRequestFromJSONTyped(json, false);
+}
+export function UploadUrlRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chatId': json['chatId'],
+        'files': (json['files'].map(UploadUrlRequestFilesInnerFromJSON)),
+    };
+}
+export function UploadUrlRequestToJSON(json) {
+    return UploadUrlRequestToJSONTyped(json, false);
+}
+export function UploadUrlRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chatId': value['chatId'],
+        'files': (value['files'].map(UploadUrlRequestFilesInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,49 @@
+/**
+ * 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 UploadUrlRequestFilesInner
+ */
+export interface UploadUrlRequestFilesInner {
+    /**
+     * MIME type of the file to upload
+     * @type {string}
+     * @memberof UploadUrlRequestFilesInner
+     */
+    mimeType: UploadUrlRequestFilesInnerMimeTypeEnum;
+    /**
+     * File size in bytes (max 7444889)
+     * @type {number}
+     * @memberof UploadUrlRequestFilesInner
+     */
+    contentLength: number;
+}
+/**
+ * @export
+ */
+export declare const UploadUrlRequestFilesInnerMimeTypeEnum: {
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageJpg: "image/jpg";
+    readonly ImagePng: "image/png";
+    readonly ImageWebp: "image/webp";
+    readonly ApplicationPdf: "application/pdf";
+};
+export type UploadUrlRequestFilesInnerMimeTypeEnum = typeof UploadUrlRequestFilesInnerMimeTypeEnum[keyof typeof UploadUrlRequestFilesInnerMimeTypeEnum];
+/**
+ * Check if a given object implements the UploadUrlRequestFilesInner interface.
+ */
+export declare function instanceOfUploadUrlRequestFilesInner(value: object): value is UploadUrlRequestFilesInner;
+export declare function UploadUrlRequestFilesInnerFromJSON(json: any): UploadUrlRequestFilesInner;
+export declare function UploadUrlRequestFilesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadUrlRequestFilesInner;
+export declare function UploadUrlRequestFilesInnerToJSON(json: any): UploadUrlRequestFilesInner;
+export declare function UploadUrlRequestFilesInnerToJSONTyped(value?: UploadUrlRequestFilesInner | null, ignoreDiscriminator?: boolean): any;