@instructure/athena-api-client 1.0.9 → 1.0.11

package/dist/esm/apis/index.js

@@ -2,13 +2,17 @@
 /* eslint-disable */
 export * from './AccountsApi';
 export * from './ChatsApi';
+export * from './FeatureOverridesApi';
+export * from './FeaturesApi';
 export * from './FilesApi';
 export * from './HealthApi';
 export * from './LearningDaysApi';
 export * from './LearningMomentsApi';
 export * from './LearningStreakApi';
 export * from './MessagesApi';
+export * from './PlansApi';
 export * from './QuizSessionsApi';
 export * from './QuizzesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';
+export * from './VotesApi';

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

@@ -27,7 +27,7 @@ export interface ChatRequest {
      * @type {string}
      * @memberof ChatRequest
      */
-    chatId?: string;
+    chatId: string;
     /**
      * File attachments to include with the message (max 10)
      * @type {Array<ChatRequestAttachmentsInner>}

package/dist/esm/models/ChatRequest.js

@@ -18,6 +18,8 @@ import { ChatRequestAttachmentsInnerFromJSON, ChatRequestAttachmentsInnerToJSON,
 export function instanceOfChatRequest(value) {
     if (!('message' in value) || value['message'] === undefined)
         return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
     return true;
 }
 export function ChatRequestFromJSON(json) {
@@ -29,7 +31,7 @@ export function ChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'message': json['message'],
-        'chatId': json['chatId'] == null ? undefined : json['chatId'],
+        'chatId': json['chatId'],
         'attachments': json['attachments'] == null ? undefined : (json['attachments'].map(ChatRequestAttachmentsInnerFromJSON)),
     };
 }

package/dist/esm/models/CreateChatMessages201Response.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 { Message } from './Message';
+/**
+ *
+ * @export
+ * @interface CreateChatMessages201Response
+ */
+export interface CreateChatMessages201Response {
+    /**
+     *
+     * @type {Array<Message>}
+     * @memberof CreateChatMessages201Response
+     */
+    data?: Array<Message>;
+}
+/**
+ * Check if a given object implements the CreateChatMessages201Response interface.
+ */
+export declare function instanceOfCreateChatMessages201Response(value: object): value is CreateChatMessages201Response;
+export declare function CreateChatMessages201ResponseFromJSON(json: any): CreateChatMessages201Response;
+export declare function CreateChatMessages201ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChatMessages201Response;
+export declare function CreateChatMessages201ResponseToJSON(json: any): CreateChatMessages201Response;
+export declare function CreateChatMessages201ResponseToJSONTyped(value?: CreateChatMessages201Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateChatMessages201Response.js

@@ -0,0 +1,42 @@
+/* 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 { MessageFromJSON, MessageToJSON, } from './Message';
+/**
+ * Check if a given object implements the CreateChatMessages201Response interface.
+ */
+export function instanceOfCreateChatMessages201Response(value) {
+    return true;
+}
+export function CreateChatMessages201ResponseFromJSON(json) {
+    return CreateChatMessages201ResponseFromJSONTyped(json, false);
+}
+export function CreateChatMessages201ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': json['data'] == null ? undefined : (json['data'].map(MessageFromJSON)),
+    };
+}
+export function CreateChatMessages201ResponseToJSON(json) {
+    return CreateChatMessages201ResponseToJSONTyped(json, false);
+}
+export function CreateChatMessages201ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': value['data'] == null ? undefined : (value['data'].map(MessageToJSON)),
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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 CreateFeatureDto
+ */
+export interface CreateFeatureDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFeatureDto
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFeatureDto
+     */
+    description?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateFeatureDto
+     */
+    planId: string;
+}
+/**
+ * Check if a given object implements the CreateFeatureDto interface.
+ */
+export declare function instanceOfCreateFeatureDto(value: object): value is CreateFeatureDto;
+export declare function CreateFeatureDtoFromJSON(json: any): CreateFeatureDto;
+export declare function CreateFeatureDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateFeatureDto;
+export declare function CreateFeatureDtoToJSON(json: any): CreateFeatureDto;
+export declare function CreateFeatureDtoToJSONTyped(value?: CreateFeatureDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateFeatureDto.js

@@ -0,0 +1,49 @@
+/* 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 CreateFeatureDto interface.
+ */
+export function instanceOfCreateFeatureDto(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('planId' in value) || value['planId'] === undefined)
+        return false;
+    return true;
+}
+export function CreateFeatureDtoFromJSON(json) {
+    return CreateFeatureDtoFromJSONTyped(json, false);
+}
+export function CreateFeatureDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'planId': json['planId'],
+    };
+}
+export function CreateFeatureDtoToJSON(json) {
+    return CreateFeatureDtoToJSONTyped(json, false);
+}
+export function CreateFeatureDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'planId': value['planId'],
+    };
+}

package/dist/esm/models/CreateMessagesRequest.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 { CreateMessagesRequestMessagesInner } from './CreateMessagesRequestMessagesInner';
+/**
+ *
+ * @export
+ * @interface CreateMessagesRequest
+ */
+export interface CreateMessagesRequest {
+    /**
+     *
+     * @type {Array<CreateMessagesRequestMessagesInner>}
+     * @memberof CreateMessagesRequest
+     */
+    messages: Array<CreateMessagesRequestMessagesInner>;
+}
+/**
+ * Check if a given object implements the CreateMessagesRequest interface.
+ */
+export declare function instanceOfCreateMessagesRequest(value: object): value is CreateMessagesRequest;
+export declare function CreateMessagesRequestFromJSON(json: any): CreateMessagesRequest;
+export declare function CreateMessagesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateMessagesRequest;
+export declare function CreateMessagesRequestToJSON(json: any): CreateMessagesRequest;
+export declare function CreateMessagesRequestToJSONTyped(value?: CreateMessagesRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateMessagesRequest.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 { CreateMessagesRequestMessagesInnerFromJSON, CreateMessagesRequestMessagesInnerToJSON, } from './CreateMessagesRequestMessagesInner';
+/**
+ * Check if a given object implements the CreateMessagesRequest interface.
+ */
+export function instanceOfCreateMessagesRequest(value) {
+    if (!('messages' in value) || value['messages'] === undefined)
+        return false;
+    return true;
+}
+export function CreateMessagesRequestFromJSON(json) {
+    return CreateMessagesRequestFromJSONTyped(json, false);
+}
+export function CreateMessagesRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'messages': (json['messages'].map(CreateMessagesRequestMessagesInnerFromJSON)),
+    };
+}
+export function CreateMessagesRequestToJSON(json) {
+    return CreateMessagesRequestToJSONTyped(json, false);
+}
+export function CreateMessagesRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'messages': (value['messages'].map(CreateMessagesRequestMessagesInnerToJSON)),
+    };
+}

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

@@ -0,0 +1,68 @@
+/**
+ * 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 CreateMessagesRequestMessagesInner
+ */
+export interface CreateMessagesRequestMessagesInner {
+    /**
+     * Optional client-generated ID. If omitted, the server generates one.
+     * @type {string}
+     * @memberof CreateMessagesRequestMessagesInner
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateMessagesRequestMessagesInner
+     */
+    role: CreateMessagesRequestMessagesInnerRoleEnum;
+    /**
+     * Message content parts
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof CreateMessagesRequestMessagesInner
+     */
+    parts: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     * File attachments
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof CreateMessagesRequestMessagesInner
+     */
+    attachments?: Array<{
+        [key: string]: any;
+    }>;
+    /**
+     * Message creation timestamp
+     * @type {Date}
+     * @memberof CreateMessagesRequestMessagesInner
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const CreateMessagesRequestMessagesInnerRoleEnum: {
+    readonly User: "user";
+    readonly Assistant: "assistant";
+};
+export type CreateMessagesRequestMessagesInnerRoleEnum = typeof CreateMessagesRequestMessagesInnerRoleEnum[keyof typeof CreateMessagesRequestMessagesInnerRoleEnum];
+/**
+ * Check if a given object implements the CreateMessagesRequestMessagesInner interface.
+ */
+export declare function instanceOfCreateMessagesRequestMessagesInner(value: object): value is CreateMessagesRequestMessagesInner;
+export declare function CreateMessagesRequestMessagesInnerFromJSON(json: any): CreateMessagesRequestMessagesInner;
+export declare function CreateMessagesRequestMessagesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateMessagesRequestMessagesInner;
+export declare function CreateMessagesRequestMessagesInnerToJSON(json: any): CreateMessagesRequestMessagesInner;
+export declare function CreateMessagesRequestMessagesInnerToJSONTyped(value?: CreateMessagesRequestMessagesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateMessagesRequestMessagesInner.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 CreateMessagesRequestMessagesInnerRoleEnum = {
+    User: 'user',
+    Assistant: 'assistant'
+};
+/**
+ * Check if a given object implements the CreateMessagesRequestMessagesInner interface.
+ */
+export function instanceOfCreateMessagesRequestMessagesInner(value) {
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('parts' in value) || value['parts'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function CreateMessagesRequestMessagesInnerFromJSON(json) {
+    return CreateMessagesRequestMessagesInnerFromJSONTyped(json, false);
+}
+export function CreateMessagesRequestMessagesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'role': json['role'],
+        'parts': json['parts'],
+        'attachments': json['attachments'] == null ? undefined : json['attachments'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function CreateMessagesRequestMessagesInnerToJSON(json) {
+    return CreateMessagesRequestMessagesInnerToJSONTyped(json, false);
+}
+export function CreateMessagesRequestMessagesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'role': value['role'],
+        'parts': value['parts'],
+        'attachments': value['attachments'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

package/dist/esm/models/CreateMessagesResponse.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 { Message } from './Message';
+/**
+ *
+ * @export
+ * @interface CreateMessagesResponse
+ */
+export interface CreateMessagesResponse {
+    /**
+     *
+     * @type {Array<Message>}
+     * @memberof CreateMessagesResponse
+     */
+    data: Array<Message>;
+}
+/**
+ * Check if a given object implements the CreateMessagesResponse interface.
+ */
+export declare function instanceOfCreateMessagesResponse(value: object): value is CreateMessagesResponse;
+export declare function CreateMessagesResponseFromJSON(json: any): CreateMessagesResponse;
+export declare function CreateMessagesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateMessagesResponse;
+export declare function CreateMessagesResponseToJSON(json: any): CreateMessagesResponse;
+export declare function CreateMessagesResponseToJSONTyped(value?: CreateMessagesResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreateMessagesResponse.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 { MessageFromJSON, MessageToJSON, } from './Message';
+/**
+ * Check if a given object implements the CreateMessagesResponse interface.
+ */
+export function instanceOfCreateMessagesResponse(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    return true;
+}
+export function CreateMessagesResponseFromJSON(json) {
+    return CreateMessagesResponseFromJSONTyped(json, false);
+}
+export function CreateMessagesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(MessageFromJSON)),
+    };
+}
+export function CreateMessagesResponseToJSON(json) {
+    return CreateMessagesResponseToJSONTyped(json, false);
+}
+export function CreateMessagesResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(MessageToJSON)),
+    };
+}

package/dist/esm/models/CreatePlanDto.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 CreatePlanDto
+ */
+export interface CreatePlanDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreatePlanDto
+     */
+    name: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CreatePlanDto
+     */
+    rank: number;
+}
+/**
+ * Check if a given object implements the CreatePlanDto interface.
+ */
+export declare function instanceOfCreatePlanDto(value: object): value is CreatePlanDto;
+export declare function CreatePlanDtoFromJSON(json: any): CreatePlanDto;
+export declare function CreatePlanDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePlanDto;
+export declare function CreatePlanDtoToJSON(json: any): CreatePlanDto;
+export declare function CreatePlanDtoToJSONTyped(value?: CreatePlanDto | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CreatePlanDto.js

@@ -0,0 +1,47 @@
+/* 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 CreatePlanDto interface.
+ */
+export function instanceOfCreatePlanDto(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('rank' in value) || value['rank'] === undefined)
+        return false;
+    return true;
+}
+export function CreatePlanDtoFromJSON(json) {
+    return CreatePlanDtoFromJSONTyped(json, false);
+}
+export function CreatePlanDtoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'rank': json['rank'],
+    };
+}
+export function CreatePlanDtoToJSON(json) {
+    return CreatePlanDtoToJSONTyped(json, false);
+}
+export function CreatePlanDtoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'rank': value['rank'],
+    };
+}

package/dist/esm/models/FeatureEntity.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 FeatureEntity
+ */
+export interface FeatureEntity {
+    /**
+     * Unique identifier
+     * @type {string}
+     * @memberof FeatureEntity
+     */
+    id: string;
+    /**
+     * Feature name
+     * @type {string}
+     * @memberof FeatureEntity
+     */
+    name: string;
+    /**
+     * Feature description
+     * @type {string}
+     * @memberof FeatureEntity
+     */
+    description?: string | null;
+    /**
+     * ID of the plan this feature belongs to
+     * @type {string}
+     * @memberof FeatureEntity
+     */
+    planId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof FeatureEntity
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof FeatureEntity
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the FeatureEntity interface.
+ */
+export declare function instanceOfFeatureEntity(value: object): value is FeatureEntity;
+export declare function FeatureEntityFromJSON(json: any): FeatureEntity;
+export declare function FeatureEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeatureEntity;
+export declare function FeatureEntityToJSON(json: any): FeatureEntity;
+export declare function FeatureEntityToJSONTyped(value?: FeatureEntity | null, ignoreDiscriminator?: boolean): any;