@instructure/athena-api-client 1.0.3 → 1.0.5

package/dist/esm/models/UploadUrlRequestFilesInner.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 UploadUrlRequestFilesInnerMimeTypeEnum = {
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImagePng: 'image/png',
+    ImageWebp: 'image/webp',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the UploadUrlRequestFilesInner interface.
+ */
+export function instanceOfUploadUrlRequestFilesInner(value) {
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('contentLength' in value) || value['contentLength'] === undefined)
+        return false;
+    return true;
+}
+export function UploadUrlRequestFilesInnerFromJSON(json) {
+    return UploadUrlRequestFilesInnerFromJSONTyped(json, false);
+}
+export function UploadUrlRequestFilesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'mimeType': json['mimeType'],
+        'contentLength': json['contentLength'],
+    };
+}
+export function UploadUrlRequestFilesInnerToJSON(json) {
+    return UploadUrlRequestFilesInnerToJSONTyped(json, false);
+}
+export function UploadUrlRequestFilesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'mimeType': value['mimeType'],
+        'contentLength': value['contentLength'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { UploadUrlResponseFilesInner } from './UploadUrlResponseFilesInner';
+/**
+ *
+ * @export
+ * @interface UploadUrlResponse
+ */
+export interface UploadUrlResponse {
+    /**
+     *
+     * @type {Array<UploadUrlResponseFilesInner>}
+     * @memberof UploadUrlResponse
+     */
+    files: Array<UploadUrlResponseFilesInner>;
+}
+/**
+ * Check if a given object implements the UploadUrlResponse interface.
+ */
+export declare function instanceOfUploadUrlResponse(value: object): value is UploadUrlResponse;
+export declare function UploadUrlResponseFromJSON(json: any): UploadUrlResponse;
+export declare function UploadUrlResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadUrlResponse;
+export declare function UploadUrlResponseToJSON(json: any): UploadUrlResponse;
+export declare function UploadUrlResponseToJSONTyped(value?: UploadUrlResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UploadUrlResponse.js

@@ -0,0 +1,44 @@
+/* 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 { UploadUrlResponseFilesInnerFromJSON, UploadUrlResponseFilesInnerToJSON, } from './UploadUrlResponseFilesInner';
+/**
+ * Check if a given object implements the UploadUrlResponse interface.
+ */
+export function instanceOfUploadUrlResponse(value) {
+    if (!('files' in value) || value['files'] === undefined)
+        return false;
+    return true;
+}
+export function UploadUrlResponseFromJSON(json) {
+    return UploadUrlResponseFromJSONTyped(json, false);
+}
+export function UploadUrlResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'files': (json['files'].map(UploadUrlResponseFilesInnerFromJSON)),
+    };
+}
+export function UploadUrlResponseToJSON(json) {
+    return UploadUrlResponseToJSONTyped(json, false);
+}
+export function UploadUrlResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'files': (value['files'].map(UploadUrlResponseFilesInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 UploadUrlResponseFilesInner
+ */
+export interface UploadUrlResponseFilesInner {
+    /**
+     * Unique identifier for the file
+     * @type {string}
+     * @memberof UploadUrlResponseFilesInner
+     */
+    fileId: string;
+    /**
+     * Presigned S3 PUT URL for uploading the file
+     * @type {string}
+     * @memberof UploadUrlResponseFilesInner
+     */
+    uploadUrl: string;
+    /**
+     * Presigned S3 GET URL for retrieving the file
+     * @type {string}
+     * @memberof UploadUrlResponseFilesInner
+     */
+    previewUrl: string;
+    /**
+     * Presigned S3 DELETE URL for deleting the file
+     * @type {string}
+     * @memberof UploadUrlResponseFilesInner
+     */
+    deleteUrl: string;
+    /**
+     * Expiry timestamp for the presigned URLs
+     * @type {Date}
+     * @memberof UploadUrlResponseFilesInner
+     */
+    expiresAt: Date;
+}
+/**
+ * Check if a given object implements the UploadUrlResponseFilesInner interface.
+ */
+export declare function instanceOfUploadUrlResponseFilesInner(value: object): value is UploadUrlResponseFilesInner;
+export declare function UploadUrlResponseFilesInnerFromJSON(json: any): UploadUrlResponseFilesInner;
+export declare function UploadUrlResponseFilesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): UploadUrlResponseFilesInner;
+export declare function UploadUrlResponseFilesInnerToJSON(json: any): UploadUrlResponseFilesInner;
+export declare function UploadUrlResponseFilesInnerToJSONTyped(value?: UploadUrlResponseFilesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/UploadUrlResponseFilesInner.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.
+ */
+/**
+ * Check if a given object implements the UploadUrlResponseFilesInner interface.
+ */
+export function instanceOfUploadUrlResponseFilesInner(value) {
+    if (!('fileId' in value) || value['fileId'] === undefined)
+        return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined)
+        return false;
+    if (!('previewUrl' in value) || value['previewUrl'] === undefined)
+        return false;
+    if (!('deleteUrl' in value) || value['deleteUrl'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    return true;
+}
+export function UploadUrlResponseFilesInnerFromJSON(json) {
+    return UploadUrlResponseFilesInnerFromJSONTyped(json, false);
+}
+export function UploadUrlResponseFilesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['fileId'],
+        'uploadUrl': json['uploadUrl'],
+        'previewUrl': json['previewUrl'],
+        'deleteUrl': json['deleteUrl'],
+        'expiresAt': (new Date(json['expiresAt'])),
+    };
+}
+export function UploadUrlResponseFilesInnerToJSON(json) {
+    return UploadUrlResponseFilesInnerToJSONTyped(json, false);
+}
+export function UploadUrlResponseFilesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileId': value['fileId'],
+        'uploadUrl': value['uploadUrl'],
+        'previewUrl': value['previewUrl'],
+        'deleteUrl': value['deleteUrl'],
+        'expiresAt': value['expiresAt'].toISOString(),
+    };
+}

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

@@ -1,6 +1,7 @@
 export * from './Account';
 export * from './Chat';
 export * from './ChatRequest';
+export * from './ChatRequestAttachmentsInner';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
@@ -8,7 +9,9 @@ export * from './CreateTokenResponse';
 export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningStreakResponse';
 export * from './Message';
+export * from './MessageAttachmentsInner';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ModelError';
@@ -20,3 +23,7 @@ export * from './Tag';
 export * from './UpdateChatRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
+export * from './UploadUrlRequest';
+export * from './UploadUrlRequestFilesInner';
+export * from './UploadUrlResponse';
+export * from './UploadUrlResponseFilesInner';

package/dist/esm/models/index.js

@@ -3,6 +3,7 @@
 export * from './Account';
 export * from './Chat';
 export * from './ChatRequest';
+export * from './ChatRequestAttachmentsInner';
 export * from './CreateAccountRequest';
 export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
@@ -10,7 +11,9 @@ export * from './CreateTokenResponse';
 export * from './HealthCheck';
 export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningStreakResponse';
 export * from './Message';
+export * from './MessageAttachmentsInner';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';
 export * from './ModelError';
@@ -22,3 +25,7 @@ export * from './Tag';
 export * from './UpdateChatRequest';
 export * from './UpdateTokenRequest';
 export * from './UpdateTokenResponse';
+export * from './UploadUrlRequest';
+export * from './UploadUrlRequestFilesInner';
+export * from './UploadUrlResponse';
+export * from './UploadUrlResponseFilesInner';

package/dist/models/ChatRequest.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 /**
  *
  * @export
@@ -27,6 +28,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     chatId?: string;
+    /**
+     * File attachments to include with the message (max 10)
+     * @type {Array<ChatRequestAttachmentsInner>}
+     * @memberof ChatRequest
+     */
+    attachments?: Array<ChatRequestAttachmentsInner>;
 }
 /**
  * Check if a given object implements the ChatRequest interface.

package/dist/models/ChatRequest.js

@@ -18,6 +18,7 @@ exports.ChatRequestFromJSON = ChatRequestFromJSON;
 exports.ChatRequestFromJSONTyped = ChatRequestFromJSONTyped;
 exports.ChatRequestToJSON = ChatRequestToJSON;
 exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
+const ChatRequestAttachmentsInner_1 = require("./ChatRequestAttachmentsInner");
 /**
  * Check if a given object implements the ChatRequest interface.
  */
@@ -36,6 +37,7 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'message': json['message'],
         'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerFromJSON)),
     };
 }
 function ChatRequestToJSON(json) {
@@ -48,5 +50,6 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'message': value['message'],
         'chatId': value['chatId'],
+        'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerToJSON)),
     };
 }

package/dist/models/ChatRequestAttachmentsInner.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 ChatRequestAttachmentsInner
+ */
+export interface ChatRequestAttachmentsInner {
+    /**
+     * File ID returned from the upload-url endpoint
+     * @type {string}
+     * @memberof ChatRequestAttachmentsInner
+     */
+    fileId: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof ChatRequestAttachmentsInner
+     */
+    mimeType: ChatRequestAttachmentsInnerMimeTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestAttachmentsInnerMimeTypeEnum: {
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageJpg: "image/jpg";
+    readonly ImagePng: "image/png";
+    readonly ImageWebp: "image/webp";
+    readonly ApplicationPdf: "application/pdf";
+};
+export type ChatRequestAttachmentsInnerMimeTypeEnum = typeof ChatRequestAttachmentsInnerMimeTypeEnum[keyof typeof ChatRequestAttachmentsInnerMimeTypeEnum];
+/**
+ * Check if a given object implements the ChatRequestAttachmentsInner interface.
+ */
+export declare function instanceOfChatRequestAttachmentsInner(value: object): value is ChatRequestAttachmentsInner;
+export declare function ChatRequestAttachmentsInnerFromJSON(json: any): ChatRequestAttachmentsInner;
+export declare function ChatRequestAttachmentsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestAttachmentsInner;
+export declare function ChatRequestAttachmentsInnerToJSON(json: any): ChatRequestAttachmentsInner;
+export declare function ChatRequestAttachmentsInnerToJSONTyped(value?: ChatRequestAttachmentsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestAttachmentsInner.js

@@ -0,0 +1,65 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatRequestAttachmentsInnerMimeTypeEnum = void 0;
+exports.instanceOfChatRequestAttachmentsInner = instanceOfChatRequestAttachmentsInner;
+exports.ChatRequestAttachmentsInnerFromJSON = ChatRequestAttachmentsInnerFromJSON;
+exports.ChatRequestAttachmentsInnerFromJSONTyped = ChatRequestAttachmentsInnerFromJSONTyped;
+exports.ChatRequestAttachmentsInnerToJSON = ChatRequestAttachmentsInnerToJSON;
+exports.ChatRequestAttachmentsInnerToJSONTyped = ChatRequestAttachmentsInnerToJSONTyped;
+/**
+ * @export
+ */
+exports.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.
+ */
+function instanceOfChatRequestAttachmentsInner(value) {
+    if (!('fileId' in value) || value['fileId'] === undefined)
+        return false;
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestAttachmentsInnerFromJSON(json) {
+    return ChatRequestAttachmentsInnerFromJSONTyped(json, false);
+}
+function ChatRequestAttachmentsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['fileId'],
+        'mimeType': json['mimeType'],
+    };
+}
+function ChatRequestAttachmentsInnerToJSON(json) {
+    return ChatRequestAttachmentsInnerToJSONTyped(json, false);
+}
+function ChatRequestAttachmentsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileId': value['fileId'],
+        'mimeType': value['mimeType'],
+    };
+}

package/dist/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/models/CreateChatRequest.js

@@ -13,11 +13,19 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateChatRequestVisibilityEnum = void 0;
 exports.instanceOfCreateChatRequest = instanceOfCreateChatRequest;
 exports.CreateChatRequestFromJSON = CreateChatRequestFromJSON;
 exports.CreateChatRequestFromJSONTyped = CreateChatRequestFromJSONTyped;
 exports.CreateChatRequestToJSON = CreateChatRequestToJSON;
 exports.CreateChatRequestToJSONTyped = CreateChatRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.CreateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */
@@ -32,7 +40,10 @@ 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'],
     };
 }
 function CreateChatRequestToJSON(json) {
@@ -43,6 +54,9 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
+        'id': value['id'],
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

package/dist/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;