@instructure/athena-api-client 3.0.3 → 3.0.5

package/dist/esm/models/CreateStudyObjectiveDtoCanvasDocumentsInner.js

@@ -0,0 +1,55 @@
+/* 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 CreateStudyObjectiveDtoCanvasDocumentsInner interface.
+ */
+export function instanceOfCreateStudyObjectiveDtoCanvasDocumentsInner(value) {
+    if (!('canonicalId' in value) || value['canonicalId'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('contentType' in value) || value['contentType'] === undefined)
+        return false;
+    return true;
+}
+export function CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSON(json) {
+    return CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSONTyped(json, false);
+}
+export function CreateStudyObjectiveDtoCanvasDocumentsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canonicalId': json['canonicalId'],
+        'displayName': json['displayName'],
+        'filename': json['filename'],
+        'contentType': json['contentType'],
+    };
+}
+export function CreateStudyObjectiveDtoCanvasDocumentsInnerToJSON(json) {
+    return CreateStudyObjectiveDtoCanvasDocumentsInnerToJSONTyped(json, false);
+}
+export function CreateStudyObjectiveDtoCanvasDocumentsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canonicalId': value['canonicalId'],
+        'displayName': value['displayName'],
+        'filename': value['filename'],
+        'contentType': value['contentType'],
+    };
+}

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

@@ -0,0 +1,71 @@
+/**
+ * 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 ObjectiveResource
+ */
+export interface ObjectiveResource {
+    /**
+     *
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    studyObjectiveId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    chatId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ObjectiveResource
+     */
+    resourceType: ObjectiveResourceResourceTypeEnum;
+    /**
+     *
+     * @type {Date}
+     * @memberof ObjectiveResource
+     */
+    createdAt: Date;
+}
+/**
+ * @export
+ */
+export declare const ObjectiveResourceResourceTypeEnum: {
+    readonly Chat: "chat";
+    readonly Quiz: "quiz";
+    readonly Flashcard: "flashcard";
+};
+export type ObjectiveResourceResourceTypeEnum = typeof ObjectiveResourceResourceTypeEnum[keyof typeof ObjectiveResourceResourceTypeEnum];
+/**
+ * Check if a given object implements the ObjectiveResource interface.
+ */
+export declare function instanceOfObjectiveResource(value: object): value is ObjectiveResource;
+export declare function ObjectiveResourceFromJSON(json: any): ObjectiveResource;
+export declare function ObjectiveResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): ObjectiveResource;
+export declare function ObjectiveResourceToJSON(json: any): ObjectiveResource;
+export declare function ObjectiveResourceToJSONTyped(value?: ObjectiveResource | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ObjectiveResource.js

@@ -0,0 +1,71 @@
+/* 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 ObjectiveResourceResourceTypeEnum = {
+    Chat: 'chat',
+    Quiz: 'quiz',
+    Flashcard: 'flashcard'
+};
+/**
+ * Check if a given object implements the ObjectiveResource interface.
+ */
+export function instanceOfObjectiveResource(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('studyObjectiveId' in value) || value['studyObjectiveId'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('chatId' in value) || value['chatId'] === undefined)
+        return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    return true;
+}
+export function ObjectiveResourceFromJSON(json) {
+    return ObjectiveResourceFromJSONTyped(json, false);
+}
+export function ObjectiveResourceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'studyObjectiveId': json['studyObjectiveId'],
+        'accountUserId': json['accountUserId'],
+        'chatId': json['chatId'],
+        'resourceType': json['resourceType'],
+        'createdAt': (new Date(json['createdAt'])),
+    };
+}
+export function ObjectiveResourceToJSON(json) {
+    return ObjectiveResourceToJSONTyped(json, false);
+}
+export function ObjectiveResourceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'studyObjectiveId': value['studyObjectiveId'],
+        'accountUserId': value['accountUserId'],
+        'chatId': value['chatId'],
+        'resourceType': value['resourceType'],
+        'createdAt': value['createdAt'].toISOString(),
+    };
+}

package/dist/esm/models/PaginatedObjectiveResources.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 { ObjectiveResource } from './ObjectiveResource';
+/**
+ *
+ * @export
+ * @interface PaginatedObjectiveResources
+ */
+export interface PaginatedObjectiveResources {
+    /**
+     * Array of objective resources
+     * @type {Array<ObjectiveResource>}
+     * @memberof PaginatedObjectiveResources
+     */
+    data: Array<ObjectiveResource>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedObjectiveResources
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedObjectiveResources interface.
+ */
+export declare function instanceOfPaginatedObjectiveResources(value: object): value is PaginatedObjectiveResources;
+export declare function PaginatedObjectiveResourcesFromJSON(json: any): PaginatedObjectiveResources;
+export declare function PaginatedObjectiveResourcesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedObjectiveResources;
+export declare function PaginatedObjectiveResourcesToJSON(json: any): PaginatedObjectiveResources;
+export declare function PaginatedObjectiveResourcesToJSONTyped(value?: PaginatedObjectiveResources | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedObjectiveResources.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 { ObjectiveResourceFromJSON, ObjectiveResourceToJSON, } from './ObjectiveResource';
+/**
+ * Check if a given object implements the PaginatedObjectiveResources interface.
+ */
+export function instanceOfPaginatedObjectiveResources(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedObjectiveResourcesFromJSON(json) {
+    return PaginatedObjectiveResourcesFromJSONTyped(json, false);
+}
+export function PaginatedObjectiveResourcesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(ObjectiveResourceFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedObjectiveResourcesToJSON(json) {
+    return PaginatedObjectiveResourcesToJSONTyped(json, false);
+}
+export function PaginatedObjectiveResourcesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(ObjectiveResourceToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

package/dist/esm/models/PaginatedStudyObjectives.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 { StudyObjective } from './StudyObjective';
+/**
+ *
+ * @export
+ * @interface PaginatedStudyObjectives
+ */
+export interface PaginatedStudyObjectives {
+    /**
+     * Array of study objectives
+     * @type {Array<StudyObjective>}
+     * @memberof PaginatedStudyObjectives
+     */
+    data: Array<StudyObjective>;
+    /**
+     * Opaque cursor for fetching the next page. Null when there are no more results.
+     * @type {string}
+     * @memberof PaginatedStudyObjectives
+     */
+    nextCursor: string | null;
+}
+/**
+ * Check if a given object implements the PaginatedStudyObjectives interface.
+ */
+export declare function instanceOfPaginatedStudyObjectives(value: object): value is PaginatedStudyObjectives;
+export declare function PaginatedStudyObjectivesFromJSON(json: any): PaginatedStudyObjectives;
+export declare function PaginatedStudyObjectivesFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStudyObjectives;
+export declare function PaginatedStudyObjectivesToJSON(json: any): PaginatedStudyObjectives;
+export declare function PaginatedStudyObjectivesToJSONTyped(value?: PaginatedStudyObjectives | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedStudyObjectives.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 { StudyObjectiveFromJSON, StudyObjectiveToJSON, } from './StudyObjective';
+/**
+ * Check if a given object implements the PaginatedStudyObjectives interface.
+ */
+export function instanceOfPaginatedStudyObjectives(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if (!('nextCursor' in value) || value['nextCursor'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedStudyObjectivesFromJSON(json) {
+    return PaginatedStudyObjectivesFromJSONTyped(json, false);
+}
+export function PaginatedStudyObjectivesFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(StudyObjectiveFromJSON)),
+        'nextCursor': json['nextCursor'],
+    };
+}
+export function PaginatedStudyObjectivesToJSON(json) {
+    return PaginatedStudyObjectivesToJSONTyped(json, false);
+}
+export function PaginatedStudyObjectivesToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(StudyObjectiveToJSON)),
+        'nextCursor': value['nextCursor'],
+    };
+}

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

@@ -0,0 +1,88 @@
+/**
+ * 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 { StudyObjectiveFileAttachment } from './StudyObjectiveFileAttachment';
+import type { StudyObjectiveCanvasDocument } from './StudyObjectiveCanvasDocument';
+/**
+ *
+ * @export
+ * @interface StudyObjective
+ */
+export interface StudyObjective {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    accountUserId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    courseId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjective
+     */
+    notes: string | null;
+    /**
+     *
+     * @type {Array<StudyObjectiveFileAttachment>}
+     * @memberof StudyObjective
+     */
+    fileAttachments: Array<StudyObjectiveFileAttachment>;
+    /**
+     *
+     * @type {Array<StudyObjectiveCanvasDocument>}
+     * @memberof StudyObjective
+     */
+    canvasDocuments: Array<StudyObjectiveCanvasDocument>;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyObjective
+     */
+    dueAt: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyObjective
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof StudyObjective
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the StudyObjective interface.
+ */
+export declare function instanceOfStudyObjective(value: object): value is StudyObjective;
+export declare function StudyObjectiveFromJSON(json: any): StudyObjective;
+export declare function StudyObjectiveFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjective;
+export declare function StudyObjectiveToJSON(json: any): StudyObjective;
+export declare function StudyObjectiveToJSONTyped(value?: StudyObjective | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyObjective.js

@@ -0,0 +1,81 @@
+/* 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 { StudyObjectiveFileAttachmentFromJSON, StudyObjectiveFileAttachmentToJSON, } from './StudyObjectiveFileAttachment';
+import { StudyObjectiveCanvasDocumentFromJSON, StudyObjectiveCanvasDocumentToJSON, } from './StudyObjectiveCanvasDocument';
+/**
+ * Check if a given object implements the StudyObjective interface.
+ */
+export function instanceOfStudyObjective(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('accountUserId' in value) || value['accountUserId'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('notes' in value) || value['notes'] === undefined)
+        return false;
+    if (!('fileAttachments' in value) || value['fileAttachments'] === undefined)
+        return false;
+    if (!('canvasDocuments' in value) || value['canvasDocuments'] === undefined)
+        return false;
+    if (!('dueAt' in value) || value['dueAt'] === 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 StudyObjectiveFromJSON(json) {
+    return StudyObjectiveFromJSONTyped(json, false);
+}
+export function StudyObjectiveFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'accountUserId': json['accountUserId'],
+        'courseId': json['courseId'],
+        'title': json['title'],
+        'notes': json['notes'],
+        'fileAttachments': (json['fileAttachments'].map(StudyObjectiveFileAttachmentFromJSON)),
+        'canvasDocuments': (json['canvasDocuments'].map(StudyObjectiveCanvasDocumentFromJSON)),
+        'dueAt': (json['dueAt'] == null ? null : new Date(json['dueAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function StudyObjectiveToJSON(json) {
+    return StudyObjectiveToJSONTyped(json, false);
+}
+export function StudyObjectiveToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'accountUserId': value['accountUserId'],
+        'courseId': value['courseId'],
+        'title': value['title'],
+        'notes': value['notes'],
+        'fileAttachments': (value['fileAttachments'].map(StudyObjectiveFileAttachmentToJSON)),
+        'canvasDocuments': (value['canvasDocuments'].map(StudyObjectiveCanvasDocumentToJSON)),
+        'dueAt': value['dueAt'] == null ? value['dueAt'] : value['dueAt'].toISOString(),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 StudyObjectiveCanvasDocument
+ */
+export interface StudyObjectiveCanvasDocument {
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjectiveCanvasDocument
+     */
+    canonicalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjectiveCanvasDocument
+     */
+    displayName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjectiveCanvasDocument
+     */
+    filename: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StudyObjectiveCanvasDocument
+     */
+    contentType: string;
+}
+/**
+ * Check if a given object implements the StudyObjectiveCanvasDocument interface.
+ */
+export declare function instanceOfStudyObjectiveCanvasDocument(value: object): value is StudyObjectiveCanvasDocument;
+export declare function StudyObjectiveCanvasDocumentFromJSON(json: any): StudyObjectiveCanvasDocument;
+export declare function StudyObjectiveCanvasDocumentFromJSONTyped(json: any, ignoreDiscriminator: boolean): StudyObjectiveCanvasDocument;
+export declare function StudyObjectiveCanvasDocumentToJSON(json: any): StudyObjectiveCanvasDocument;
+export declare function StudyObjectiveCanvasDocumentToJSONTyped(value?: StudyObjectiveCanvasDocument | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/StudyObjectiveCanvasDocument.js

@@ -0,0 +1,55 @@
+/* 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 StudyObjectiveCanvasDocument interface.
+ */
+export function instanceOfStudyObjectiveCanvasDocument(value) {
+    if (!('canonicalId' in value) || value['canonicalId'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('contentType' in value) || value['contentType'] === undefined)
+        return false;
+    return true;
+}
+export function StudyObjectiveCanvasDocumentFromJSON(json) {
+    return StudyObjectiveCanvasDocumentFromJSONTyped(json, false);
+}
+export function StudyObjectiveCanvasDocumentFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'canonicalId': json['canonicalId'],
+        'displayName': json['displayName'],
+        'filename': json['filename'],
+        'contentType': json['contentType'],
+    };
+}
+export function StudyObjectiveCanvasDocumentToJSON(json) {
+    return StudyObjectiveCanvasDocumentToJSONTyped(json, false);
+}
+export function StudyObjectiveCanvasDocumentToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'canonicalId': value['canonicalId'],
+        'displayName': value['displayName'],
+        'filename': value['filename'],
+        'contentType': value['contentType'],
+    };
+}