@instructure/athena-api-client 2.0.3 → 2.0.4

package/README.md

@@ -127,6 +127,7 @@ All URIs are relative to *http://localhost:3000*
 - [ChatAnalysis](docs/ChatAnalysis.md)
 - [ChatRequest](docs/ChatRequest.md)
 - [ChatRequestAttachmentsInner](docs/ChatRequestAttachmentsInner.md)
+- [ChatRequestExternalFileUrl](docs/ChatRequestExternalFileUrl.md)
 - [ChatRequestQuizContext](docs/ChatRequestQuizContext.md)
 - [ChatRequestQuizContextAnswerState](docs/ChatRequestQuizContextAnswerState.md)
 - [ChatRequestQuizContextCurrentQuestion](docs/ChatRequestQuizContextCurrentQuestion.md)

package/dist/apis/ChatsApi.d.ts

@@ -100,12 +100,12 @@ export declare class ChatsApi extends runtime.BaseAPI {
      */
     markChatAsViewed(requestParameters: MarkChatAsViewedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessageRaw(requestParameters: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessage(requestParameters: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;

package/dist/apis/ChatsApi.js

@@ -240,7 +240,7 @@ class ChatsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessageRaw(requestParameters, initOverrides) {
@@ -286,7 +286,7 @@ class ChatsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessage(requestParameters, initOverrides) {

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

@@ -100,12 +100,12 @@ export declare class ChatsApi extends runtime.BaseAPI {
      */
     markChatAsViewed(requestParameters: MarkChatAsViewedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Chat>;
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessageRaw(requestParameters: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessage(requestParameters: SendChatMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;

package/dist/esm/apis/ChatsApi.js

@@ -237,7 +237,7 @@ export class ChatsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessageRaw(requestParameters, initOverrides) {
@@ -283,7 +283,7 @@ export class ChatsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time.
+     * Sends a message to a chat conversation with an AI assistant. The client must provide a chatId (UUID v4). If the chatId doesn\'t exist, a new chat will be created with that ID. If it exists and belongs to the user, the conversation continues. The response is streamed in real-time. An optional externalFileUrl (url + mediaType) can be included to have the model read a file as part of its response.
      * Send a message to a chat
      */
     sendChatMessage(requestParameters, initOverrides) {

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -41,6 +42,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     attachments?: Array<ChatRequestAttachmentsInner>;
+    /**
+     *
+     * @type {ChatRequestExternalFileUrl}
+     * @memberof ChatRequest
+     */
+    externalFileUrl?: ChatRequestExternalFileUrl;
     /**
      *
      * @type {ChatRequestQuizContext}

package/dist/esm/models/ChatRequest.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ChatRequestExternalFileUrlFromJSON, ChatRequestExternalFileUrlToJSON, } from './ChatRequestExternalFileUrl';
 import { ChatRequestAttachmentsInnerFromJSON, ChatRequestAttachmentsInnerToJSON, } from './ChatRequestAttachmentsInner';
 import { ChatRequestQuizContextFromJSON, ChatRequestQuizContextToJSON, } from './ChatRequestQuizContext';
 /**
@@ -35,6 +36,7 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'chatId': json['chatId'],
         'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInnerFromJSON)),
+        'externalFileUrl': json['externalFileUrl'] == null ? undefined : ChatRequestExternalFileUrlFromJSON(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : ChatRequestQuizContextFromJSON(json['quizContext']),
     };
 }
@@ -50,6 +52,7 @@ export function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'chatId': value['chatId'],
         'chatType': value['chatType'],
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInnerToJSON)),
+        'externalFileUrl': ChatRequestExternalFileUrlToJSON(value['externalFileUrl']),
         'quizContext': ChatRequestQuizContextToJSON(value['quizContext']),
     };
 }

package/dist/esm/models/ChatRequestExternalFileUrl.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.
+ */
+/**
+ * Optional external file URL to pass directly to the AI in this message. The model will read the file content as part of its response.
+ * @export
+ * @interface ChatRequestExternalFileUrl
+ */
+export interface ChatRequestExternalFileUrl {
+    /**
+     * Publicly accessible or pre-signed URL of the file
+     * @type {string}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    url: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    mediaType: ChatRequestExternalFileUrlMediaTypeEnum;
+    /**
+     * File size in bytes (max 20971520)
+     * @type {number}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    size: number;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestExternalFileUrlMediaTypeEnum: {
+    readonly ImagePng: "image/png";
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageJpg: "image/jpg";
+    readonly ImageWebp: "image/webp";
+    readonly ImageGif: "image/gif";
+    readonly ApplicationPdf: "application/pdf";
+};
+export type ChatRequestExternalFileUrlMediaTypeEnum = typeof ChatRequestExternalFileUrlMediaTypeEnum[keyof typeof ChatRequestExternalFileUrlMediaTypeEnum];
+/**
+ * Check if a given object implements the ChatRequestExternalFileUrl interface.
+ */
+export declare function instanceOfChatRequestExternalFileUrl(value: object): value is ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlFromJSON(json: any): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlToJSON(json: any): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlToJSONTyped(value?: ChatRequestExternalFileUrl | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ChatRequestExternalFileUrl.js

@@ -0,0 +1,62 @@
+/* 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 ChatRequestExternalFileUrlMediaTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the ChatRequestExternalFileUrl interface.
+ */
+export function instanceOfChatRequestExternalFileUrl(value) {
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('mediaType' in value) || value['mediaType'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+export function ChatRequestExternalFileUrlFromJSON(json) {
+    return ChatRequestExternalFileUrlFromJSONTyped(json, false);
+}
+export function ChatRequestExternalFileUrlFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'url': json['url'],
+        'mediaType': json['mediaType'],
+        'size': json['size'],
+    };
+}
+export function ChatRequestExternalFileUrlToJSON(json) {
+    return ChatRequestExternalFileUrlToJSONTyped(json, false);
+}
+export function ChatRequestExternalFileUrlToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'url': value['url'],
+        'mediaType': value['mediaType'],
+        'size': value['size'],
+    };
+}

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

@@ -34,11 +34,23 @@ export interface MessageAttachment {
      */
     name: string;
     /**
-     * Fresh signed GET URL (expires in 30 minutes). Absent for legacy attachments without a fileId.
+     * For S3 attachments: a fresh signed GET URL (expires in 30 minutes). For canvas-file attachments: the permanent Canvas file URL.
      * @type {string}
      * @memberof MessageAttachment
      */
     url?: string;
+    /**
+     * Attachment type identifier (e.g. 'canvas-file').
+     * @type {string}
+     * @memberof MessageAttachment
+     */
+    type?: string;
+    /**
+     * Canvas course name the file belongs to.
+     * @type {string}
+     * @memberof MessageAttachment
+     */
+    courseName?: string;
 }
 /**
  * @export

package/dist/esm/models/MessageAttachment.js

@@ -43,6 +43,8 @@ export function MessageAttachmentFromJSONTyped(json, ignoreDiscriminator) {
         'mimeType': json['mimeType'],
         'name': json['name'],
         'url': json['url'] == null ? undefined : json['url'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'courseName': json['courseName'] == null ? undefined : json['courseName'],
     };
 }
 export function MessageAttachmentToJSON(json) {
@@ -57,5 +59,7 @@ export function MessageAttachmentToJSONTyped(value, ignoreDiscriminator = false)
         'mimeType': value['mimeType'],
         'name': value['name'],
         'url': value['url'],
+        'type': value['type'],
+        'courseName': value['courseName'],
     };
 }

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

@@ -9,6 +9,7 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestExternalFileUrl';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/esm/models/index.js

@@ -11,6 +11,7 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestExternalFileUrl';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/models/ChatRequest.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ChatRequestExternalFileUrl } from './ChatRequestExternalFileUrl';
 import type { ChatRequestAttachmentsInner } from './ChatRequestAttachmentsInner';
 import type { ChatRequestQuizContext } from './ChatRequestQuizContext';
 /**
@@ -41,6 +42,12 @@ export interface ChatRequest {
      * @memberof ChatRequest
      */
     attachments?: Array<ChatRequestAttachmentsInner>;
+    /**
+     *
+     * @type {ChatRequestExternalFileUrl}
+     * @memberof ChatRequest
+     */
+    externalFileUrl?: ChatRequestExternalFileUrl;
     /**
      *
      * @type {ChatRequestQuizContext}

package/dist/models/ChatRequest.js

@@ -18,6 +18,7 @@ exports.ChatRequestFromJSON = ChatRequestFromJSON;
 exports.ChatRequestFromJSONTyped = ChatRequestFromJSONTyped;
 exports.ChatRequestToJSON = ChatRequestToJSON;
 exports.ChatRequestToJSONTyped = ChatRequestToJSONTyped;
+const ChatRequestExternalFileUrl_1 = require("./ChatRequestExternalFileUrl");
 const ChatRequestAttachmentsInner_1 = require("./ChatRequestAttachmentsInner");
 const ChatRequestQuizContext_1 = require("./ChatRequestQuizContext");
 /**
@@ -42,6 +43,7 @@ function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         'chatId': json['chatId'],
         'chatType': json['chatType'] == null ? undefined : json['chatType'],
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerFromJSON)),
+        'externalFileUrl': json['externalFileUrl'] == null ? undefined : (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlFromJSON)(json['externalFileUrl']),
         'quizContext': json['quizContext'] == null ? undefined : (0, ChatRequestQuizContext_1.ChatRequestQuizContextFromJSON)(json['quizContext']),
     };
 }
@@ -57,6 +59,7 @@ function ChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'chatId': value['chatId'],
         'chatType': value['chatType'],
         'attachments': value['attachments'] == null ? undefined : (value['attachments'].map(ChatRequestAttachmentsInner_1.ChatRequestAttachmentsInnerToJSON)),
+        'externalFileUrl': (0, ChatRequestExternalFileUrl_1.ChatRequestExternalFileUrlToJSON)(value['externalFileUrl']),
         'quizContext': (0, ChatRequestQuizContext_1.ChatRequestQuizContextToJSON)(value['quizContext']),
     };
 }

package/dist/models/ChatRequestExternalFileUrl.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.
+ */
+/**
+ * Optional external file URL to pass directly to the AI in this message. The model will read the file content as part of its response.
+ * @export
+ * @interface ChatRequestExternalFileUrl
+ */
+export interface ChatRequestExternalFileUrl {
+    /**
+     * Publicly accessible or pre-signed URL of the file
+     * @type {string}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    url: string;
+    /**
+     * MIME type of the file
+     * @type {string}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    mediaType: ChatRequestExternalFileUrlMediaTypeEnum;
+    /**
+     * File size in bytes (max 20971520)
+     * @type {number}
+     * @memberof ChatRequestExternalFileUrl
+     */
+    size: number;
+}
+/**
+ * @export
+ */
+export declare const ChatRequestExternalFileUrlMediaTypeEnum: {
+    readonly ImagePng: "image/png";
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageJpg: "image/jpg";
+    readonly ImageWebp: "image/webp";
+    readonly ImageGif: "image/gif";
+    readonly ApplicationPdf: "application/pdf";
+};
+export type ChatRequestExternalFileUrlMediaTypeEnum = typeof ChatRequestExternalFileUrlMediaTypeEnum[keyof typeof ChatRequestExternalFileUrlMediaTypeEnum];
+/**
+ * Check if a given object implements the ChatRequestExternalFileUrl interface.
+ */
+export declare function instanceOfChatRequestExternalFileUrl(value: object): value is ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlFromJSON(json: any): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlToJSON(json: any): ChatRequestExternalFileUrl;
+export declare function ChatRequestExternalFileUrlToJSONTyped(value?: ChatRequestExternalFileUrl | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ChatRequestExternalFileUrl.js

@@ -0,0 +1,70 @@
+"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.ChatRequestExternalFileUrlMediaTypeEnum = void 0;
+exports.instanceOfChatRequestExternalFileUrl = instanceOfChatRequestExternalFileUrl;
+exports.ChatRequestExternalFileUrlFromJSON = ChatRequestExternalFileUrlFromJSON;
+exports.ChatRequestExternalFileUrlFromJSONTyped = ChatRequestExternalFileUrlFromJSONTyped;
+exports.ChatRequestExternalFileUrlToJSON = ChatRequestExternalFileUrlToJSON;
+exports.ChatRequestExternalFileUrlToJSONTyped = ChatRequestExternalFileUrlToJSONTyped;
+/**
+ * @export
+ */
+exports.ChatRequestExternalFileUrlMediaTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the ChatRequestExternalFileUrl interface.
+ */
+function instanceOfChatRequestExternalFileUrl(value) {
+    if (!('url' in value) || value['url'] === undefined)
+        return false;
+    if (!('mediaType' in value) || value['mediaType'] === undefined)
+        return false;
+    if (!('size' in value) || value['size'] === undefined)
+        return false;
+    return true;
+}
+function ChatRequestExternalFileUrlFromJSON(json) {
+    return ChatRequestExternalFileUrlFromJSONTyped(json, false);
+}
+function ChatRequestExternalFileUrlFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'url': json['url'],
+        'mediaType': json['mediaType'],
+        'size': json['size'],
+    };
+}
+function ChatRequestExternalFileUrlToJSON(json) {
+    return ChatRequestExternalFileUrlToJSONTyped(json, false);
+}
+function ChatRequestExternalFileUrlToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'url': value['url'],
+        'mediaType': value['mediaType'],
+        'size': value['size'],
+    };
+}

package/dist/models/MessageAttachment.d.ts

@@ -34,11 +34,23 @@ export interface MessageAttachment {
      */
     name: string;
     /**
-     * Fresh signed GET URL (expires in 30 minutes). Absent for legacy attachments without a fileId.
+     * For S3 attachments: a fresh signed GET URL (expires in 30 minutes). For canvas-file attachments: the permanent Canvas file URL.
      * @type {string}
      * @memberof MessageAttachment
      */
     url?: string;
+    /**
+     * Attachment type identifier (e.g. 'canvas-file').
+     * @type {string}
+     * @memberof MessageAttachment
+     */
+    type?: string;
+    /**
+     * Canvas course name the file belongs to.
+     * @type {string}
+     * @memberof MessageAttachment
+     */
+    courseName?: string;
 }
 /**
  * @export

package/dist/models/MessageAttachment.js

@@ -51,6 +51,8 @@ function MessageAttachmentFromJSONTyped(json, ignoreDiscriminator) {
         'mimeType': json['mimeType'],
         'name': json['name'],
         'url': json['url'] == null ? undefined : json['url'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'courseName': json['courseName'] == null ? undefined : json['courseName'],
     };
 }
 function MessageAttachmentToJSON(json) {
@@ -65,5 +67,7 @@ function MessageAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
         'mimeType': value['mimeType'],
         'name': value['name'],
         'url': value['url'],
+        'type': value['type'],
+        'courseName': value['courseName'],
     };
 }

package/dist/models/index.d.ts

@@ -9,6 +9,7 @@ export * from './Chat';
 export * from './ChatAnalysis';
 export * from './ChatRequest';
 export * from './ChatRequestAttachmentsInner';
+export * from './ChatRequestExternalFileUrl';
 export * from './ChatRequestQuizContext';
 export * from './ChatRequestQuizContextAnswerState';
 export * from './ChatRequestQuizContextCurrentQuestion';

package/dist/models/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./Chat"), exports);
 __exportStar(require("./ChatAnalysis"), exports);
 __exportStar(require("./ChatRequest"), exports);
 __exportStar(require("./ChatRequestAttachmentsInner"), exports);
+__exportStar(require("./ChatRequestExternalFileUrl"), exports);
 __exportStar(require("./ChatRequestQuizContext"), exports);
 __exportStar(require("./ChatRequestQuizContextAnswerState"), exports);
 __exportStar(require("./ChatRequestQuizContextCurrentQuestion"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {