@instructure/athena-api-client 3.0.2 → 3.0.4

package/dist/apis/StudyObjectivesApi.js

@@ -0,0 +1,378 @@
+"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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StudyObjectivesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class StudyObjectivesApi extends runtime.BaseAPI {
+    /**
+     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Attach a chat resource to a study objective
+     */
+    createObjectiveResourceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createObjectiveResource().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling createObjectiveResource().');
+            }
+            if (requestParameters['createObjectiveResourceDto'] == null) {
+                throw new runtime.RequiredError('createObjectiveResourceDto', 'Required parameter "createObjectiveResourceDto" was null or undefined when calling createObjectiveResource().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}/resources`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateObjectiveResourceDtoToJSON)(requestParameters['createObjectiveResourceDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ObjectiveResourceFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Records that a chat (regular chat, quiz, or flashcard) is being used in service of a study objective.
+     * Attach a chat resource to a study objective
+     */
+    createObjectiveResource(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createObjectiveResourceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Create a study objective
+     */
+    createStudyObjectiveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createStudyObjective().');
+            }
+            if (requestParameters['createStudyObjectiveDto'] == null) {
+                throw new runtime.RequiredError('createStudyObjectiveDto', 'Required parameter "createStudyObjectiveDto" was null or undefined when calling createStudyObjective().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateStudyObjectiveDtoToJSON)(requestParameters['createStudyObjectiveDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyObjectiveFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a study objective
+     */
+    createStudyObjective(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createStudyObjectiveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Detach a resource from a study objective
+     */
+    deleteObjectiveResourceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteObjectiveResource().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling deleteObjectiveResource().');
+            }
+            if (requestParameters['resourceId'] == null) {
+                throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling deleteObjectiveResource().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}/resources/{resourceId}`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            urlPath = urlPath.replace(`{${"resourceId"}}`, encodeURIComponent(String(requestParameters['resourceId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Detach a resource from a study objective
+     */
+    deleteObjectiveResource(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteObjectiveResourceRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Deletes a study objective. Cascade-deletes any objective resources attached to it.
+     * Delete a study objective
+     */
+    deleteStudyObjectiveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteStudyObjective().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling deleteStudyObjective().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes a study objective. Cascade-deletes any objective resources attached to it.
+     * Delete a study objective
+     */
+    deleteStudyObjective(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteStudyObjectiveRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get a study objective by ID
+     */
+    getStudyObjectiveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getStudyObjective().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling getStudyObjective().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyObjectiveFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get a study objective by ID
+     */
+    getStudyObjective(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getStudyObjectiveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List resources attached to a study objective
+     */
+    listObjectiveResourcesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listObjectiveResources().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling listObjectiveResources().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}/resources`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedObjectiveResourcesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List resources attached to a study objective
+     */
+    listObjectiveResources(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listObjectiveResourcesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
+     * List study objectives for a course
+     */
+    listStudyObjectivesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling listStudyObjectives().');
+            }
+            if (requestParameters['courseId'] == null) {
+                throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling listStudyObjectives().');
+            }
+            const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
+            if (requestParameters['cursor'] != null) {
+                queryParameters['cursor'] = requestParameters['cursor'];
+            }
+            if (requestParameters['courseId'] != null) {
+                queryParameters['courseId'] = requestParameters['courseId'];
+            }
+            const headerParameters = {};
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.PaginatedStudyObjectivesFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Returns study objectives for the authenticated user filtered by course, ordered by creation date (newest first).
+     * List study objectives for a course
+     */
+    listStudyObjectives(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listStudyObjectivesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update a study objective
+     */
+    updateStudyObjectiveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling updateStudyObjective().');
+            }
+            if (requestParameters['studyObjectiveId'] == null) {
+                throw new runtime.RequiredError('studyObjectiveId', 'Required parameter "studyObjectiveId" was null or undefined when calling updateStudyObjective().');
+            }
+            if (requestParameters['updateStudyObjectiveDto'] == null) {
+                throw new runtime.RequiredError('updateStudyObjectiveDto', 'Required parameter "updateStudyObjectiveDto" was null or undefined when calling updateStudyObjective().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (requestParameters['xUserId'] != null) {
+                headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
+            }
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/study-objectives/{studyObjectiveId}`;
+            urlPath = urlPath.replace(`{${"studyObjectiveId"}}`, encodeURIComponent(String(requestParameters['studyObjectiveId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateStudyObjectiveDtoToJSON)(requestParameters['updateStudyObjectiveDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.StudyObjectiveFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update a study objective
+     */
+    updateStudyObjective(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateStudyObjectiveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.StudyObjectivesApi = StudyObjectivesApi;

package/dist/apis/UserFilesApi.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 * as runtime from '../runtime';
+import type { AssociateUserFileRequest, UserFile, UserFileAssociation, UserFileUploadUrlRequest, UserFileUploadUrlResponse } from '../models/index';
+export interface CreateUserFileAssociationRequest {
+    xUserId: string;
+    userFileId: string;
+    associateUserFileRequest: AssociateUserFileRequest;
+}
+export interface DeleteUserFileRequest {
+    xUserId: string;
+    userFileId: string;
+}
+export interface DeleteUserFileAssociationRequest {
+    xUserId: string;
+    userFileId: string;
+    associationId: string;
+}
+export interface GetUserFileRequest {
+    xUserId: string;
+    userFileId: string;
+}
+export interface GetUserFileUploadUrlsRequest {
+    xUserId: string;
+    userFileUploadUrlRequest: UserFileUploadUrlRequest;
+}
+/**
+ *
+ */
+export declare class UserFilesApi extends runtime.BaseAPI {
+    /**
+     * Idempotent. Returns the existing association if (userFileId, kind, kindId) already exists.
+     * Attach a user file to a parent resource
+     */
+    createUserFileAssociationRaw(requestParameters: CreateUserFileAssociationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserFileAssociation>>;
+    /**
+     * Idempotent. Returns the existing association if (userFileId, kind, kindId) already exists.
+     * Attach a user file to a parent resource
+     */
+    createUserFileAssociation(requestParameters: CreateUserFileAssociationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserFileAssociation>;
+    /**
+     * Synchronously removes the S3 object and the user_files row (cascade clears remaining associations).
+     * Hard delete a user file
+     */
+    deleteUserFileRaw(requestParameters: DeleteUserFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Synchronously removes the S3 object and the user_files row (cascade clears remaining associations).
+     * Hard delete a user file
+     */
+    deleteUserFile(requestParameters: DeleteUserFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * The file row and S3 object remain.
+     * Detach a user file from a parent resource
+     */
+    deleteUserFileAssociationRaw(requestParameters: DeleteUserFileAssociationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The file row and S3 object remain.
+     * Detach a user file from a parent resource
+     */
+    deleteUserFileAssociation(requestParameters: DeleteUserFileAssociationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the file row with a freshly-signed previewUrl and the full association list.
+     * Get a user file by id
+     */
+    getUserFileRaw(requestParameters: GetUserFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserFile>>;
+    /**
+     * Returns the file row with a freshly-signed previewUrl and the full association list.
+     * Get a user file by id
+     */
+    getUserFile(requestParameters: GetUserFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserFile>;
+    /**
+     * Mints signed S3 PUT/GET/DELETE URLs and creates user_files rows owned by the caller. The returned userFileId is the durable handle clients pass to POST /api/v1/user-files/:userFileId/associations to attach the file to a parent resource.
+     * Get presigned upload URLs for user files
+     */
+    getUserFileUploadUrlsRaw(requestParameters: GetUserFileUploadUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserFileUploadUrlResponse>>;
+    /**
+     * Mints signed S3 PUT/GET/DELETE URLs and creates user_files rows owned by the caller. The returned userFileId is the durable handle clients pass to POST /api/v1/user-files/:userFileId/associations to attach the file to a parent resource.
+     * Get presigned upload URLs for user files
+     */
+    getUserFileUploadUrls(requestParameters: GetUserFileUploadUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserFileUploadUrlResponse>;
+}