@instructure/athena-api-client 3.38.2 → 3.38.4

package/dist/esm/models/AdminCanvasItem.js

@@ -0,0 +1,79 @@
+/* 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 { AdminCanvasUsageFirstSeenFromJSON, AdminCanvasUsageFirstSeenToJSON, } from './AdminCanvasUsageFirstSeen';
+import { AdminCanvasItemIdFromJSON, AdminCanvasItemIdToJSON, } from './AdminCanvasItemId';
+/**
+ * @export
+ */
+export const AdminCanvasItemKindEnum = {
+    Page: 'page',
+    Assignment: 'assignment',
+    Quiz: 'quiz',
+    Discussion: 'discussion',
+    Other: 'other'
+};
+/**
+ * Check if a given object implements the AdminCanvasItem interface.
+ */
+export function instanceOfAdminCanvasItem(value) {
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('htmlUrl' in value) || value['htmlUrl'] === undefined)
+        return false;
+    if (!('firstSeen' in value) || value['firstSeen'] === undefined)
+        return false;
+    if (!('canvas' in value) || value['canvas'] === undefined)
+        return false;
+    return true;
+}
+export function AdminCanvasItemFromJSON(json) {
+    return AdminCanvasItemFromJSONTyped(json, false);
+}
+export function AdminCanvasItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'kind': json['kind'],
+        'id': AdminCanvasItemIdFromJSON(json['id']),
+        'courseId': json['courseId'],
+        'title': json['title'],
+        'htmlUrl': json['htmlUrl'],
+        'firstSeen': AdminCanvasUsageFirstSeenFromJSON(json['firstSeen']),
+        'canvas': json['canvas'],
+    };
+}
+export function AdminCanvasItemToJSON(json) {
+    return AdminCanvasItemToJSONTyped(json, false);
+}
+export function AdminCanvasItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'kind': value['kind'],
+        'id': AdminCanvasItemIdToJSON(value['id']),
+        'courseId': value['courseId'],
+        'title': value['title'],
+        'htmlUrl': value['htmlUrl'],
+        'firstSeen': AdminCanvasUsageFirstSeenToJSON(value['firstSeen']),
+        'canvas': value['canvas'],
+    };
+}

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

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+/**
+ * @type AdminCanvasItemId
+ * Canvas id; a page uses its slug
+ * @export
+ */
+export type AdminCanvasItemId = number | string;
+export declare function AdminCanvasItemIdFromJSON(json: any): AdminCanvasItemId;
+export declare function AdminCanvasItemIdFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasItemId;
+export declare function AdminCanvasItemIdToJSON(json: any): any;
+export declare function AdminCanvasItemIdToJSONTyped(value?: AdminCanvasItemId | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminCanvasItemId.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.
+ */
+export function AdminCanvasItemIdFromJSON(json) {
+    return AdminCanvasItemIdFromJSONTyped(json, false);
+}
+export function AdminCanvasItemIdFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    if (typeof json === 'number') {
+        return json;
+    }
+    if (typeof json === 'string') {
+        return json;
+    }
+    return {};
+}
+export function AdminCanvasItemIdToJSON(json) {
+    return AdminCanvasItemIdToJSONTyped(json, false);
+}
+export function AdminCanvasItemIdToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    if (typeof value === 'number') {
+        return value;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return {};
+}

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

@@ -0,0 +1,90 @@
+/**
+ * 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 { AdminCanvasUsageFirstSeen } from './AdminCanvasUsageFirstSeen';
+import type { AdminCanvasModuleItem } from './AdminCanvasModuleItem';
+/**
+ *
+ * @export
+ * @interface AdminCanvasModule
+ */
+export interface AdminCanvasModule {
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasModule
+     */
+    moduleId: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasModule
+     */
+    courseId: number;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModule
+     */
+    name: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasModule
+     */
+    position: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModule
+     */
+    state: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AdminCanvasModule
+     */
+    published: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModule
+     */
+    unlockAt: string | null;
+    /**
+     *
+     * @type {Array<AdminCanvasModuleItem>}
+     * @memberof AdminCanvasModule
+     */
+    items: Array<AdminCanvasModuleItem>;
+    /**
+     *
+     * @type {AdminCanvasUsageFirstSeen}
+     * @memberof AdminCanvasModule
+     */
+    firstSeen: AdminCanvasUsageFirstSeen;
+    /**
+     * Every field Canvas returned for this object, merged across calls. Signed download URLs are removed or redacted.
+     * @type {{ [key: string]: any; }}
+     * @memberof AdminCanvasModule
+     */
+    canvas: {
+        [key: string]: any;
+    };
+}
+/**
+ * Check if a given object implements the AdminCanvasModule interface.
+ */
+export declare function instanceOfAdminCanvasModule(value: object): value is AdminCanvasModule;
+export declare function AdminCanvasModuleFromJSON(json: any): AdminCanvasModule;
+export declare function AdminCanvasModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasModule;
+export declare function AdminCanvasModuleToJSON(json: any): AdminCanvasModule;
+export declare function AdminCanvasModuleToJSONTyped(value?: AdminCanvasModule | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminCanvasModule.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 { AdminCanvasUsageFirstSeenFromJSON, AdminCanvasUsageFirstSeenToJSON, } from './AdminCanvasUsageFirstSeen';
+import { AdminCanvasModuleItemFromJSON, AdminCanvasModuleItemToJSON, } from './AdminCanvasModuleItem';
+/**
+ * Check if a given object implements the AdminCanvasModule interface.
+ */
+export function instanceOfAdminCanvasModule(value) {
+    if (!('moduleId' in value) || value['moduleId'] === undefined)
+        return false;
+    if (!('courseId' in value) || value['courseId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('position' in value) || value['position'] === undefined)
+        return false;
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('published' in value) || value['published'] === undefined)
+        return false;
+    if (!('unlockAt' in value) || value['unlockAt'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('firstSeen' in value) || value['firstSeen'] === undefined)
+        return false;
+    if (!('canvas' in value) || value['canvas'] === undefined)
+        return false;
+    return true;
+}
+export function AdminCanvasModuleFromJSON(json) {
+    return AdminCanvasModuleFromJSONTyped(json, false);
+}
+export function AdminCanvasModuleFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'moduleId': json['moduleId'],
+        'courseId': json['courseId'],
+        'name': json['name'],
+        'position': json['position'],
+        'state': json['state'],
+        'published': json['published'],
+        'unlockAt': json['unlockAt'],
+        'items': (json['items'].map(AdminCanvasModuleItemFromJSON)),
+        'firstSeen': AdminCanvasUsageFirstSeenFromJSON(json['firstSeen']),
+        'canvas': json['canvas'],
+    };
+}
+export function AdminCanvasModuleToJSON(json) {
+    return AdminCanvasModuleToJSONTyped(json, false);
+}
+export function AdminCanvasModuleToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'moduleId': value['moduleId'],
+        'courseId': value['courseId'],
+        'name': value['name'],
+        'position': value['position'],
+        'state': value['state'],
+        'published': value['published'],
+        'unlockAt': value['unlockAt'],
+        'items': (value['items'].map(AdminCanvasModuleItemToJSON)),
+        'firstSeen': AdminCanvasUsageFirstSeenToJSON(value['firstSeen']),
+        'canvas': value['canvas'],
+    };
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 AdminCanvasModuleItem
+ */
+export interface AdminCanvasModuleItem {
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasModuleItem
+     */
+    moduleItemId: number;
+    /**
+     * Canvas module item type (File, Page, Assignment, Quiz, ...)
+     * @type {string}
+     * @memberof AdminCanvasModuleItem
+     */
+    type: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModuleItem
+     */
+    title: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasModuleItem
+     */
+    contentId: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModuleItem
+     */
+    pageUrl: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasModuleItem
+     */
+    htmlUrl: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof AdminCanvasModuleItem
+     */
+    contentDetails: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ * Check if a given object implements the AdminCanvasModuleItem interface.
+ */
+export declare function instanceOfAdminCanvasModuleItem(value: object): value is AdminCanvasModuleItem;
+export declare function AdminCanvasModuleItemFromJSON(json: any): AdminCanvasModuleItem;
+export declare function AdminCanvasModuleItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasModuleItem;
+export declare function AdminCanvasModuleItemToJSON(json: any): AdminCanvasModuleItem;
+export declare function AdminCanvasModuleItemToJSONTyped(value?: AdminCanvasModuleItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminCanvasModuleItem.js

@@ -0,0 +1,67 @@
+/* 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 AdminCanvasModuleItem interface.
+ */
+export function instanceOfAdminCanvasModuleItem(value) {
+    if (!('moduleItemId' in value) || value['moduleItemId'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('title' in value) || value['title'] === undefined)
+        return false;
+    if (!('contentId' in value) || value['contentId'] === undefined)
+        return false;
+    if (!('pageUrl' in value) || value['pageUrl'] === undefined)
+        return false;
+    if (!('htmlUrl' in value) || value['htmlUrl'] === undefined)
+        return false;
+    if (!('contentDetails' in value) || value['contentDetails'] === undefined)
+        return false;
+    return true;
+}
+export function AdminCanvasModuleItemFromJSON(json) {
+    return AdminCanvasModuleItemFromJSONTyped(json, false);
+}
+export function AdminCanvasModuleItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'moduleItemId': json['moduleItemId'],
+        'type': json['type'],
+        'title': json['title'],
+        'contentId': json['contentId'],
+        'pageUrl': json['pageUrl'],
+        'htmlUrl': json['htmlUrl'],
+        'contentDetails': json['contentDetails'],
+    };
+}
+export function AdminCanvasModuleItemToJSON(json) {
+    return AdminCanvasModuleItemToJSONTyped(json, false);
+}
+export function AdminCanvasModuleItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'moduleItemId': value['moduleItemId'],
+        'type': value['type'],
+        'title': value['title'],
+        'contentId': value['contentId'],
+        'pageUrl': value['pageUrl'],
+        'htmlUrl': value['htmlUrl'],
+        'contentDetails': value['contentDetails'],
+    };
+}

package/dist/esm/models/AdminCanvasUsageFirstSeen.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 AdminCanvasUsageFirstSeen
+ */
+export interface AdminCanvasUsageFirstSeen {
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasUsageFirstSeen
+     */
+    messageId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof AdminCanvasUsageFirstSeen
+     */
+    at: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AdminCanvasUsageFirstSeen
+     */
+    toolCallId: string;
+}
+/**
+ * Check if a given object implements the AdminCanvasUsageFirstSeen interface.
+ */
+export declare function instanceOfAdminCanvasUsageFirstSeen(value: object): value is AdminCanvasUsageFirstSeen;
+export declare function AdminCanvasUsageFirstSeenFromJSON(json: any): AdminCanvasUsageFirstSeen;
+export declare function AdminCanvasUsageFirstSeenFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasUsageFirstSeen;
+export declare function AdminCanvasUsageFirstSeenToJSON(json: any): AdminCanvasUsageFirstSeen;
+export declare function AdminCanvasUsageFirstSeenToJSONTyped(value?: AdminCanvasUsageFirstSeen | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/AdminCanvasUsageFirstSeen.js

@@ -0,0 +1,51 @@
+/* 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 AdminCanvasUsageFirstSeen interface.
+ */
+export function instanceOfAdminCanvasUsageFirstSeen(value) {
+    if (!('messageId' in value) || value['messageId'] === undefined)
+        return false;
+    if (!('at' in value) || value['at'] === undefined)
+        return false;
+    if (!('toolCallId' in value) || value['toolCallId'] === undefined)
+        return false;
+    return true;
+}
+export function AdminCanvasUsageFirstSeenFromJSON(json) {
+    return AdminCanvasUsageFirstSeenFromJSONTyped(json, false);
+}
+export function AdminCanvasUsageFirstSeenFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'messageId': json['messageId'],
+        'at': (new Date(json['at'])),
+        'toolCallId': json['toolCallId'],
+    };
+}
+export function AdminCanvasUsageFirstSeenToJSON(json) {
+    return AdminCanvasUsageFirstSeenToJSONTyped(json, false);
+}
+export function AdminCanvasUsageFirstSeenToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'messageId': value['messageId'],
+        'at': value['at'].toISOString(),
+        'toolCallId': value['toolCallId'],
+    };
+}

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

@@ -0,0 +1,74 @@
+/**
+ * Athena API
+ * REST API for the Athena system
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AdminCanvasUsageSummary
+ */
+export interface AdminCanvasUsageSummary {
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    canvasCallCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    failedCanvasCallCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    courseCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    moduleCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    fileCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    otherItemCount: number;
+    /**
+     * Files whose content was injected into the model's context
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    filesAnalyzedCount: number;
+    /**
+     *
+     * @type {number}
+     * @memberof AdminCanvasUsageSummary
+     */
+    quizGenerationCount: number;
+}
+/**
+ * Check if a given object implements the AdminCanvasUsageSummary interface.
+ */
+export declare function instanceOfAdminCanvasUsageSummary(value: object): value is AdminCanvasUsageSummary;
+export declare function AdminCanvasUsageSummaryFromJSON(json: any): AdminCanvasUsageSummary;
+export declare function AdminCanvasUsageSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminCanvasUsageSummary;
+export declare function AdminCanvasUsageSummaryToJSON(json: any): AdminCanvasUsageSummary;
+export declare function AdminCanvasUsageSummaryToJSONTyped(value?: AdminCanvasUsageSummary | null, ignoreDiscriminator?: boolean): any;