@instructure/athena-api-client 1.0.10 → 1.0.12

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

@@ -0,0 +1,62 @@
+/**
+ * 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 FeatureOverrideEntity
+ */
+export interface FeatureOverrideEntity {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof FeatureOverrideEntity
+     */
+    id: string;
+    /**
+     * Account ID
+     * @type {string}
+     * @memberof FeatureOverrideEntity
+     */
+    accountId: string;
+    /**
+     * Feature ID
+     * @type {string}
+     * @memberof FeatureOverrideEntity
+     */
+    featureId: string;
+    /**
+     * Whether the feature is enabled for this account
+     * @type {boolean}
+     * @memberof FeatureOverrideEntity
+     */
+    enabled: boolean;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof FeatureOverrideEntity
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof FeatureOverrideEntity
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the FeatureOverrideEntity interface.
+ */
+export declare function instanceOfFeatureOverrideEntity(value: object): value is FeatureOverrideEntity;
+export declare function FeatureOverrideEntityFromJSON(json: any): FeatureOverrideEntity;
+export declare function FeatureOverrideEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureOverrideEntity;
+export declare function FeatureOverrideEntityToJSON(json: any): FeatureOverrideEntity;
+export declare function FeatureOverrideEntityToJSONTyped(value?: FeatureOverrideEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/FeatureOverrideEntity.js

@@ -0,0 +1,63 @@
+/* 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 FeatureOverrideEntity interface.
+ */
+export function instanceOfFeatureOverrideEntity(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountId' in value) || value['accountId'] === undefined)
+        return false;
+    if (!('featureId' in value) || value['featureId'] === undefined)
+        return false;
+    if (!('enabled' in value) || value['enabled'] === 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 FeatureOverrideEntityFromJSON(json) {
+    return FeatureOverrideEntityFromJSONTyped(json, false);
+}
+export function FeatureOverrideEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountId': json['accountId'],
+        'featureId': json['featureId'],
+        'enabled': json['enabled'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function FeatureOverrideEntityToJSON(json) {
+    return FeatureOverrideEntityToJSONTyped(json, false);
+}
+export function FeatureOverrideEntityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountId': value['accountId'],
+        'featureId': value['featureId'],
+        'enabled': value['enabled'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -20,15 +20,8 @@ export interface HealthCheck {
      * @type {string}
      * @memberof HealthCheck
      */
-    status: HealthCheckStatusEnum;
+    status: string;
 }
-/**
- * @export
- */
-export declare const HealthCheckStatusEnum: {
-    readonly Ok: "ok";
-};
-export type HealthCheckStatusEnum = typeof HealthCheckStatusEnum[keyof typeof HealthCheckStatusEnum];
 /**
  * Check if a given object implements the HealthCheck interface.
  */

package/dist/esm/models/HealthCheck.js

@@ -11,12 +11,6 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-/**
- * @export
- */
-export const HealthCheckStatusEnum = {
-    Ok: 'ok'
-};
 /**
  * Check if a given object implements the HealthCheck interface.
  */

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

@@ -44,19 +44,19 @@ export interface LearningMoment {
      * @type {string}
      * @memberof LearningMoment
      */
-    label?: string | null;
+    label: string | null;
     /**
      * Confidence score (0.00 - 1.00)
      * @type {string}
      * @memberof LearningMoment
      */
-    confidence?: string | null;
+    confidence: string | null;
     /**
      * Explanation for the learning moment
      * @type {string}
      * @memberof LearningMoment
      */
-    reason?: string | null;
+    reason: string | null;
     /**
      * Date the learning moment occurred
      * @type {Date}

package/dist/esm/models/LearningMoment.js

@@ -23,6 +23,12 @@ export function instanceOfLearningMoment(value) {
         return false;
     if (!('messageId' in value) || value['messageId'] === undefined)
         return false;
+    if (!('label' in value) || value['label'] === undefined)
+        return false;
+    if (!('confidence' in value) || value['confidence'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
     if (!('occurredOn' in value) || value['occurredOn'] === undefined)
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
@@ -43,9 +49,9 @@ export function LearningMomentFromJSONTyped(json, ignoreDiscriminator) {
         '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'],
+        'label': json['label'],
+        'confidence': json['confidence'],
+        'reason': json['reason'],
         'occurredOn': (new Date(json['occurredOn'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),

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

@@ -32,7 +32,7 @@ export interface LearningStreakResponse {
      * @type {Date}
      * @memberof LearningStreakResponse
      */
-    lastMomentDate?: Date | null;
+    lastMomentDate: Date | null;
     /**
      *
      * @type {number}
@@ -50,7 +50,7 @@ export interface LearningStreakResponse {
      * @type {Date}
      * @memberof LearningStreakResponse
      */
-    lastEvaluatedAt?: Date | null;
+    lastEvaluatedAt: Date | null;
     /**
      *
      * @type {Date}

package/dist/esm/models/LearningStreakResponse.js

@@ -19,10 +19,14 @@ export function instanceOfLearningStreakResponse(value) {
         return false;
     if (!('longestDays' in value) || value['longestDays'] === undefined)
         return false;
+    if (!('lastMomentDate' in value) || value['lastMomentDate'] === undefined)
+        return false;
     if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
         return false;
     if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === undefined)
         return false;
+    if (!('lastEvaluatedAt' in value) || value['lastEvaluatedAt'] === undefined)
+        return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined)
@@ -39,10 +43,10 @@ export function LearningStreakResponseFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'currentDays': json['currentDays'],
         'longestDays': json['longestDays'],
-        'lastMomentDate': json['lastMomentDate'] == null ? undefined : (new Date(json['lastMomentDate'])),
+        'lastMomentDate': (json['lastMomentDate'] == null ? null : new Date(json['lastMomentDate'])),
         'totalMissedDays': json['totalMissedDays'],
         'missedDaysInCycle': json['missedDaysInCycle'],
-        'lastEvaluatedAt': json['lastEvaluatedAt'] == null ? undefined : (new Date(json['lastEvaluatedAt'])),
+        'lastEvaluatedAt': (json['lastEvaluatedAt'] == null ? null : new Date(json['lastEvaluatedAt'])),
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (new Date(json['updatedAt'])),
     };

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

@@ -9,8 +9,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { MessageAttachmentsInner } from './MessageAttachmentsInner';
-import type { MessagePartsInner } from './MessagePartsInner';
+import type { MessageAttachment } from './MessageAttachment';
+import type { MessagePart } from './MessagePart';
 /**
  *
  * @export
@@ -37,16 +37,16 @@ export interface Message {
     role: string;
     /**
      * Message content parts
-     * @type {Array<MessagePartsInner>}
+     * @type {Array<MessagePart>}
      * @memberof Message
      */
-    parts: Array<MessagePartsInner>;
+    parts: Array<MessagePart>;
     /**
      * Message attachments with fresh signed GET URLs
-     * @type {Array<MessageAttachmentsInner>}
+     * @type {Array<MessageAttachment>}
      * @memberof Message
      */
-    attachments: Array<MessageAttachmentsInner>;
+    attachments: Array<MessageAttachment>;
     /**
      * Creation timestamp
      * @type {Date}

package/dist/esm/models/Message.js

@@ -11,8 +11,8 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { MessageAttachmentsInnerFromJSON, MessageAttachmentsInnerToJSON, } from './MessageAttachmentsInner';
-import { MessagePartsInnerFromJSON, MessagePartsInnerToJSON, } from './MessagePartsInner';
+import { MessageAttachmentFromJSON, MessageAttachmentToJSON, } from './MessageAttachment';
+import { MessagePartFromJSON, MessagePartToJSON, } from './MessagePart';
 /**
  * Check if a given object implements the Message interface.
  */
@@ -42,8 +42,8 @@ export function MessageFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'chatId': json['chatId'],
         'role': json['role'],
-        'parts': (json['parts'].map(MessagePartsInnerFromJSON)),
-        'attachments': (json['attachments'].map(MessageAttachmentsInnerFromJSON)),
+        'parts': (json['parts'].map(MessagePartFromJSON)),
+        'attachments': (json['attachments'].map(MessageAttachmentFromJSON)),
         'createdAt': (new Date(json['createdAt'])),
         'isLearningMoment': json['isLearningMoment'] == null ? undefined : json['isLearningMoment'],
     };
@@ -59,8 +59,8 @@ export function MessageToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'chatId': value['chatId'],
         'role': value['role'],
-        'parts': (value['parts'].map(MessagePartsInnerToJSON)),
-        'attachments': (value['attachments'].map(MessageAttachmentsInnerToJSON)),
+        'parts': (value['parts'].map(MessagePartToJSON)),
+        'attachments': (value['attachments'].map(MessageAttachmentToJSON)),
         'createdAt': value['createdAt'].toISOString(),
         'isLearningMoment': value['isLearningMoment'],
     };

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

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

package/dist/esm/models/MessageAttachment.js

@@ -0,0 +1,61 @@
+/* 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 MessageAttachmentMimeTypeEnum = {
+    ImageJpeg: 'image/jpeg',
+    ImageJpg: 'image/jpg',
+    ImagePng: 'image/png',
+    ImageWebp: 'image/webp',
+    ApplicationPdf: 'application/pdf'
+};
+/**
+ * Check if a given object implements the MessageAttachment interface.
+ */
+export function instanceOfMessageAttachment(value) {
+    if (!('mimeType' in value) || value['mimeType'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function MessageAttachmentFromJSON(json) {
+    return MessageAttachmentFromJSONTyped(json, false);
+}
+export function MessageAttachmentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'fileId': json['fileId'] == null ? undefined : json['fileId'],
+        'mimeType': json['mimeType'],
+        'name': json['name'],
+        'url': json['url'] == null ? undefined : json['url'],
+    };
+}
+export function MessageAttachmentToJSON(json) {
+    return MessageAttachmentToJSONTyped(json, false);
+}
+export function MessageAttachmentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'fileId': value['fileId'],
+        'mimeType': value['mimeType'],
+        'name': value['name'],
+        'url': value['url'],
+    };
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 MessagePart
+ */
+export interface MessagePart {
+    /**
+     *
+     * @type {string}
+     * @memberof MessagePart
+     */
+    type?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof MessagePart
+     */
+    text?: string;
+}
+/**
+ * Check if a given object implements the MessagePart interface.
+ */
+export declare function instanceOfMessagePart(value: object): value is MessagePart;
+export declare function MessagePartFromJSON(json: any): MessagePart;
+export declare function MessagePartFromJSONTyped(json: any, ignoreDiscriminator: boolean): MessagePart;
+export declare function MessagePartToJSON(json: any): MessagePart;
+export declare function MessagePartToJSONTyped(value?: MessagePart | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MessagePart.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 MessagePart interface.
+ */
+export function instanceOfMessagePart(value) {
+    return true;
+}
+export function MessagePartFromJSON(json) {
+    return MessagePartFromJSONTyped(json, false);
+}
+export function MessagePartFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'] == null ? undefined : json['type'],
+        'text': json['text'] == null ? undefined : json['text'],
+    };
+}
+export function MessagePartToJSON(json) {
+    return MessagePartToJSONTyped(json, false);
+}
+export function MessagePartToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'text': value['text'],
+    };
+}

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

@@ -17,7 +17,7 @@ import type { Message } from './Message';
  */
 export interface PaginatedMessages {
     /**
-     *
+     * Array of message objects
      * @type {Array<Message>}
      * @memberof PaginatedMessages
      */

package/dist/esm/models/Plan.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 Plan
+ */
+export interface Plan {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof Plan
+     */
+    id: string;
+    /**
+     * Plan name
+     * @type {string}
+     * @memberof Plan
+     */
+    name: string;
+    /**
+     * Plan rank (higher = better)
+     * @type {number}
+     * @memberof Plan
+     */
+    rank: number;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof Plan
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof Plan
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the Plan interface.
+ */
+export declare function instanceOfPlan(value: object): value is Plan;
+export declare function PlanFromJSON(json: any): Plan;
+export declare function PlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): Plan;
+export declare function PlanToJSON(json: any): Plan;
+export declare function PlanToJSONTyped(value?: Plan | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Plan.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 Plan interface.
+ */
+export function instanceOfPlan(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('rank' in value) || value['rank'] === 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 PlanFromJSON(json) {
+    return PlanFromJSONTyped(json, false);
+}
+export function PlanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'rank': json['rank'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function PlanToJSON(json) {
+    return PlanToJSONTyped(json, false);
+}
+export function PlanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'rank': value['rank'],
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}