@instructure/athena-api-client 1.0.9 → 1.0.11

package/dist/apis/FeaturesApi.js

@@ -0,0 +1,199 @@
+"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.FeaturesApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class FeaturesApi extends runtime.BaseAPI {
+    /**
+     * Create a new feature
+     */
+    createFeatureRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createFeatureDto'] == null) {
+                throw new runtime.RequiredError('createFeatureDto', 'Required parameter "createFeatureDto" was null or undefined when calling createFeature().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/features`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateFeatureDtoToJSON)(requestParameters['createFeatureDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FeatureEntityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a new feature
+     */
+    createFeature(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createFeatureRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Delete a feature
+     */
+    deleteFeatureRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteFeature().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/features/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Delete a feature
+     */
+    deleteFeature(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteFeatureRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Get feature by ID
+     */
+    getFeatureRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getFeature().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/features/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FeatureEntityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get feature by ID
+     */
+    getFeature(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getFeatureRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List all features
+     */
+    listFeaturesRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/features`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.FeatureEntityFromJSON));
+        });
+    }
+    /**
+     * List all features
+     */
+    listFeatures(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listFeaturesRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update a feature
+     */
+    updateFeatureRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling updateFeature().');
+            }
+            if (requestParameters['updateFeatureDto'] == null) {
+                throw new runtime.RequiredError('updateFeatureDto', 'Required parameter "updateFeatureDto" was null or undefined when calling updateFeature().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                headerParameters["X-Auth-Token"] = yield this.configuration.apiKey("X-Auth-Token"); // AuthToken authentication
+            }
+            let urlPath = `/api/v1/features/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.UpdateFeatureDtoToJSON)(requestParameters['updateFeatureDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.FeatureEntityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update a feature
+     */
+    updateFeature(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateFeatureRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.FeaturesApi = FeaturesApi;

package/dist/apis/HealthApi.d.ts

@@ -16,12 +16,10 @@ import type { HealthCheck } from '../models/index';
  */
 export declare class HealthApi extends runtime.BaseAPI {
     /**
-     * Returns the health status of the API server
      * Health check endpoint
      */
     healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HealthCheck>>;
     /**
-     * Returns the health status of the API server
      * Health check endpoint
      */
     healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HealthCheck>;

package/dist/apis/HealthApi.js

@@ -30,7 +30,6 @@ const index_1 = require("../models/index");
  */
 class HealthApi extends runtime.BaseAPI {
     /**
-     * Returns the health status of the API server
      * Health check endpoint
      */
     healthCheckRaw(initOverrides) {
@@ -48,7 +47,6 @@ class HealthApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Returns the health status of the API server
      * Health check endpoint
      */
     healthCheck(initOverrides) {

package/dist/apis/LearningDaysApi.d.ts

@@ -12,9 +12,9 @@
 import * as runtime from '../runtime';
 import type { LearningDaysResponse } from '../models/index';
 export interface GetLearningDaysRequest {
-    xUserId: string;
     startDate: Date;
     endDate: Date;
+    xUserId: string;
 }
 /**
  *

package/dist/apis/LearningDaysApi.js

@@ -35,15 +35,15 @@ class LearningDaysApi extends runtime.BaseAPI {
      */
     getLearningDaysRaw(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 getLearningDays().');
-            }
             if (requestParameters['startDate'] == null) {
                 throw new runtime.RequiredError('startDate', 'Required parameter "startDate" was null or undefined when calling getLearningDays().');
             }
             if (requestParameters['endDate'] == null) {
                 throw new runtime.RequiredError('endDate', 'Required parameter "endDate" was null or undefined when calling getLearningDays().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getLearningDays().');
+            }
             const queryParameters = {};
             if (requestParameters['startDate'] != null) {
                 queryParameters['startDate'] = requestParameters['startDate'].toISOString().substring(0, 10);

package/dist/apis/MessagesApi.d.ts

@@ -10,31 +10,46 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { Message, MessageCountResponse, PaginatedMessages } from '../models/index';
-export interface DeleteMessagesRequest {
+import type { CreateMessagesRequest, CreateMessagesResponse, Message, MessageCountResponse, PaginatedMessages } from '../models/index';
+export interface CreateChatMessagesRequest {
+    chatId: string;
     xUserId: string;
+    createMessagesRequest: CreateMessagesRequest;
+}
+export interface DeleteMessagesRequest {
     chatId: string;
     since: Date;
+    xUserId: string;
 }
 export interface GetChatMessageRequest {
-    xUserId: string;
     chatId: string;
     messageId: string;
+    xUserId: string;
 }
 export interface GetChatMessagesRequest {
-    xUserId: string;
     chatId: string;
+    xUserId: string;
     limit?: number;
     cursor?: string;
 }
 export interface GetMessageCountRequest {
-    xUserId: string;
     hours: number;
+    xUserId: string;
 }
 /**
  *
  */
 export declare class MessagesApi extends runtime.BaseAPI {
+    /**
+     * Saves one or more messages to the specified chat.
+     * Save messages to a chat
+     */
+    createChatMessagesRaw(requestParameters: CreateChatMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateMessagesResponse>>;
+    /**
+     * Saves one or more messages to the specified chat.
+     * Save messages to a chat
+     */
+    createChatMessages(requestParameters: CreateChatMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateMessagesResponse>;
     /**
      * Deletes all messages in a chat at or after the given timestamp.
      * Delete messages from timestamp

package/dist/apis/MessagesApi.js

@@ -29,21 +29,67 @@ const index_1 = require("../models/index");
  *
  */
 class MessagesApi extends runtime.BaseAPI {
+    /**
+     * Saves one or more messages to the specified chat.
+     * Save messages to a chat
+     */
+    createChatMessagesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['chatId'] == null) {
+                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling createChatMessages().');
+            }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createChatMessages().');
+            }
+            if (requestParameters['createMessagesRequest'] == null) {
+                throw new runtime.RequiredError('createMessagesRequest', 'Required parameter "createMessagesRequest" was null or undefined when calling createChatMessages().');
+            }
+            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/chats/{chatId}/messages`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateMessagesRequestToJSON)(requestParameters['createMessagesRequest']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateMessagesResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Saves one or more messages to the specified chat.
+     * Save messages to a chat
+     */
+    createChatMessages(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createChatMessagesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Deletes all messages in a chat at or after the given timestamp.
      * Delete messages from timestamp
      */
     deleteMessagesRaw(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 deleteMessages().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling deleteMessages().');
             }
             if (requestParameters['since'] == null) {
                 throw new runtime.RequiredError('since', 'Required parameter "since" was null or undefined when calling deleteMessages().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteMessages().');
+            }
             const queryParameters = {};
             if (requestParameters['since'] != null) {
                 queryParameters['since'] = requestParameters['since'].toISOString();
@@ -81,15 +127,15 @@ class MessagesApi extends runtime.BaseAPI {
      */
     getChatMessageRaw(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 getChatMessage().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatMessage().');
             }
             if (requestParameters['messageId'] == null) {
                 throw new runtime.RequiredError('messageId', 'Required parameter "messageId" was null or undefined when calling getChatMessage().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChatMessage().');
+            }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
@@ -126,12 +172,12 @@ class MessagesApi extends runtime.BaseAPI {
      */
     getChatMessagesRaw(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 getChatMessages().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChatMessages().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChatMessages().');
+            }
             const queryParameters = {};
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];
@@ -173,12 +219,12 @@ class MessagesApi extends runtime.BaseAPI {
      */
     getMessageCountRaw(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 getMessageCount().');
-            }
             if (requestParameters['hours'] == null) {
                 throw new runtime.RequiredError('hours', 'Required parameter "hours" was null or undefined when calling getMessageCount().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getMessageCount().');
+            }
             const queryParameters = {};
             if (requestParameters['hours'] != null) {
                 queryParameters['hours'] = requestParameters['hours'];

package/dist/apis/PlansApi.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.
+ */
+import * as runtime from '../runtime';
+import type { CreatePlanDto, Plan, UpdatePlanDto } from '../models/index';
+export interface CreatePlanRequest {
+    createPlanDto: CreatePlanDto;
+}
+export interface DeletePlanRequest {
+    id: string;
+}
+export interface GetPlanRequest {
+    id: string;
+}
+export interface UpdatePlanRequest {
+    id: string;
+    updatePlanDto: UpdatePlanDto;
+}
+/**
+ *
+ */
+export declare class PlansApi extends runtime.BaseAPI {
+    /**
+     * Create a new plan
+     */
+    createPlanRaw(requestParameters: CreatePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Plan>>;
+    /**
+     * Create a new plan
+     */
+    createPlan(requestParameters: CreatePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Plan>;
+    /**
+     * Delete a plan
+     */
+    deletePlanRaw(requestParameters: DeletePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a plan
+     */
+    deletePlan(requestParameters: DeletePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get plan by ID
+     */
+    getPlanRaw(requestParameters: GetPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Plan>>;
+    /**
+     * Get plan by ID
+     */
+    getPlan(requestParameters: GetPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Plan>;
+    /**
+     * List all plans
+     */
+    listPlansRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Plan>>>;
+    /**
+     * List all plans
+     */
+    listPlans(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Plan>>;
+    /**
+     * Update a plan
+     */
+    updatePlanRaw(requestParameters: UpdatePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Plan>>;
+    /**
+     * Update a plan
+     */
+    updatePlan(requestParameters: UpdatePlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Plan>;
+}