@instructure/athena-api-client 1.0.9 → 1.0.11

package/dist/apis/index.js

@@ -18,13 +18,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable */
 __exportStar(require("./AccountsApi"), exports);
 __exportStar(require("./ChatsApi"), exports);
+__exportStar(require("./FeatureOverridesApi"), exports);
+__exportStar(require("./FeaturesApi"), exports);
 __exportStar(require("./FilesApi"), exports);
 __exportStar(require("./HealthApi"), exports);
 __exportStar(require("./LearningDaysApi"), exports);
 __exportStar(require("./LearningMomentsApi"), exports);
 __exportStar(require("./LearningStreakApi"), exports);
 __exportStar(require("./MessagesApi"), exports);
+__exportStar(require("./PlansApi"), exports);
 __exportStar(require("./QuizSessionsApi"), exports);
 __exportStar(require("./QuizzesApi"), exports);
 __exportStar(require("./ServiceTokensApi"), exports);
 __exportStar(require("./TagsApi"), exports);
+__exportStar(require("./VotesApi"), exports);

package/dist/esm/apis/AccountsApi.d.ts

@@ -10,32 +10,40 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { Account, CreateAccountRequest } from '../models/index';
+import type { Account, CreateAccountRequest, UpdateAccountDto } from '../models/index';
 export interface CreateAccountOperationRequest {
     createAccountRequest: CreateAccountRequest;
 }
+export interface UpdateAccountRequest {
+    id: string;
+    updateAccountDto: UpdateAccountDto;
+}
 /**
  *
  */
 export declare class AccountsApi extends runtime.BaseAPI {
     /**
-     * Creates a new account (admin only)
      * Create a new account
      */
     createAccountRaw(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Account>>;
     /**
-     * Creates a new account (admin only)
      * Create a new account
      */
     createAccount(requestParameters: CreateAccountOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Account>;
     /**
-     * Retrieves a list of all accounts (admin only)
      * List all accounts
      */
     listAccountsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Account>>>;
     /**
-     * Retrieves a list of all accounts (admin only)
      * List all accounts
      */
     listAccounts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Account>>;
+    /**
+     * Update an account
+     */
+    updateAccountRaw(requestParameters: UpdateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Account>>;
+    /**
+     * Update an account
+     */
+    updateAccount(requestParameters: UpdateAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Account>;
 }

package/dist/esm/apis/AccountsApi.js

@@ -21,13 +21,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { AccountFromJSON, CreateAccountRequestToJSON, } from '../models/index';
+import { AccountFromJSON, CreateAccountRequestToJSON, UpdateAccountDtoToJSON, } from '../models/index';
 /**
  *
  */
 export class AccountsApi extends runtime.BaseAPI {
     /**
-     * Creates a new account (admin only)
      * Create a new account
      */
     createAccountRaw(requestParameters, initOverrides) {
@@ -53,7 +52,6 @@ export class AccountsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a new account (admin only)
      * Create a new account
      */
     createAccount(requestParameters, initOverrides) {
@@ -63,7 +61,6 @@ export class AccountsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves a list of all accounts (admin only)
      * List all accounts
      */
     listAccountsRaw(initOverrides) {
@@ -84,7 +81,6 @@ export class AccountsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Retrieves a list of all accounts (admin only)
      * List all accounts
      */
     listAccounts(initOverrides) {
@@ -93,4 +89,42 @@ export class AccountsApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Update an account
+     */
+    updateAccountRaw(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 updateAccount().');
+            }
+            if (requestParameters['updateAccountDto'] == null) {
+                throw new runtime.RequiredError('updateAccountDto', 'Required parameter "updateAccountDto" was null or undefined when calling updateAccount().');
+            }
+            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/accounts/{id}`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateAccountDtoToJSON(requestParameters['updateAccountDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AccountFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update an account
+     */
+    updateAccount(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateAccountRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
 }

package/dist/esm/apis/ChatsApi.d.ts

@@ -13,15 +13,15 @@ import * as runtime from '../runtime';
 import type { Chat, ChatRequest, CreateChatRequest, PaginatedChats, UpdateChatRequest } from '../models/index';
 export interface CreateChatOperationRequest {
     xUserId: string;
-    createChatRequest?: CreateChatRequest;
+    createChatRequest: CreateChatRequest;
 }
 export interface DeleteChatRequest {
-    xUserId: string;
     chatId: string;
+    xUserId: string;
 }
 export interface GetChatRequest {
-    xUserId: string;
     chatId: string;
+    xUserId: string;
 }
 export interface ListChatsRequest {
     xUserId: string;
@@ -30,19 +30,20 @@ export interface ListChatsRequest {
     chatType?: string;
 }
 export interface MarkChatAsViewedRequest {
-    xUserId: string;
     chatId: string;
+    xUserId: string;
 }
 export interface SendChatMessageRequest {
     xUserId: string;
     chatRequest: ChatRequest;
-    xUserTimezone?: string;
+    xCanvasDomain?: string;
     xCanvasToken?: string;
+    xUserTimezone?: string;
 }
 export interface UpdateChatOperationRequest {
-    xUserId: string;
     chatId: string;
-    updateChatRequest?: UpdateChatRequest;
+    xUserId: string;
+    updateChatRequest: UpdateChatRequest;
 }
 /**
  *

package/dist/esm/apis/ChatsApi.js

@@ -35,6 +35,9 @@ export class ChatsApi extends runtime.BaseAPI {
             if (requestParameters['xUserId'] == null) {
                 throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling createChat().');
             }
+            if (requestParameters['createChatRequest'] == null) {
+                throw new runtime.RequiredError('createChatRequest', 'Required parameter "createChatRequest" was null or undefined when calling createChat().');
+            }
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
@@ -71,12 +74,12 @@ export class ChatsApi extends runtime.BaseAPI {
      */
     deleteChatRaw(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 deleteChat().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling deleteChat().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling deleteChat().');
+            }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
@@ -111,12 +114,12 @@ export class ChatsApi extends runtime.BaseAPI {
      */
     getChatRaw(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 getChat().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling getChat().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling getChat().');
+            }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
@@ -198,12 +201,12 @@ export class ChatsApi extends runtime.BaseAPI {
      */
     markChatAsViewedRaw(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 markChatAsViewed().');
-            }
             if (requestParameters['chatId'] == null) {
                 throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling markChatAsViewed().');
             }
+            if (requestParameters['xUserId'] == null) {
+                throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling markChatAsViewed().');
+            }
             const queryParameters = {};
             const headerParameters = {};
             if (requestParameters['xUserId'] != null) {
@@ -248,12 +251,15 @@ export class ChatsApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            if (requestParameters['xUserTimezone'] != null) {
-                headerParameters['X-User-Timezone'] = String(requestParameters['xUserTimezone']);
+            if (requestParameters['xCanvasDomain'] != null) {
+                headerParameters['X-Canvas-Domain'] = String(requestParameters['xCanvasDomain']);
             }
             if (requestParameters['xCanvasToken'] != null) {
                 headerParameters['X-Canvas-Token'] = String(requestParameters['xCanvasToken']);
             }
+            if (requestParameters['xUserTimezone'] != null) {
+                headerParameters['X-User-Timezone'] = String(requestParameters['xUserTimezone']);
+            }
             if (requestParameters['xUserId'] != null) {
                 headerParameters['X-User-Id'] = String(requestParameters['xUserId']);
             }
@@ -292,11 +298,14 @@ export class ChatsApi extends runtime.BaseAPI {
      */
     updateChatRaw(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 updateChat().');
+            }
             if (requestParameters['xUserId'] == null) {
                 throw new runtime.RequiredError('xUserId', 'Required parameter "xUserId" was null or undefined when calling updateChat().');
             }
-            if (requestParameters['chatId'] == null) {
-                throw new runtime.RequiredError('chatId', 'Required parameter "chatId" was null or undefined when calling updateChat().');
+            if (requestParameters['updateChatRequest'] == null) {
+                throw new runtime.RequiredError('updateChatRequest', 'Required parameter "updateChatRequest" was null or undefined when calling updateChat().');
             }
             const queryParameters = {};
             const headerParameters = {};

package/dist/esm/apis/FeatureOverridesApi.d.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 { FeatureOverrideEntity, UpsertOverrideDto } from '../models/index';
+export interface DeleteFeatureOverrideRequest {
+    id: string;
+}
+export interface ListFeatureOverridesRequest {
+    accountId?: string;
+}
+export interface UpsertFeatureOverrideRequest {
+    upsertOverrideDto: UpsertOverrideDto;
+}
+/**
+ *
+ */
+export declare class FeatureOverridesApi extends runtime.BaseAPI {
+    /**
+     * Delete a feature override
+     */
+    deleteFeatureOverrideRaw(requestParameters: DeleteFeatureOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a feature override
+     */
+    deleteFeatureOverride(requestParameters: DeleteFeatureOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * List feature overrides
+     */
+    listFeatureOverridesRaw(requestParameters: ListFeatureOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FeatureOverrideEntity>>>;
+    /**
+     * List feature overrides
+     */
+    listFeatureOverrides(requestParameters?: ListFeatureOverridesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FeatureOverrideEntity>>;
+    /**
+     * Upsert a feature override for an account
+     */
+    upsertFeatureOverrideRaw(requestParameters: UpsertFeatureOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeatureOverrideEntity>>;
+    /**
+     * Upsert a feature override for an account
+     */
+    upsertFeatureOverride(requestParameters: UpsertFeatureOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeatureOverrideEntity>;
+}

package/dist/esm/apis/FeatureOverridesApi.js

@@ -0,0 +1,127 @@
+/* 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());
+    });
+};
+import * as runtime from '../runtime';
+import { FeatureOverrideEntityFromJSON, UpsertOverrideDtoToJSON, } from '../models/index';
+/**
+ *
+ */
+export class FeatureOverridesApi extends runtime.BaseAPI {
+    /**
+     * Delete a feature override
+     */
+    deleteFeatureOverrideRaw(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 deleteFeatureOverride().');
+            }
+            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/feature-overrides/{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 override
+     */
+    deleteFeatureOverride(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteFeatureOverrideRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * List feature overrides
+     */
+    listFeatureOverridesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['accountId'] != null) {
+                queryParameters['accountId'] = requestParameters['accountId'];
+            }
+            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/feature-overrides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(FeatureOverrideEntityFromJSON));
+        });
+    }
+    /**
+     * List feature overrides
+     */
+    listFeatureOverrides() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.listFeatureOverridesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Upsert a feature override for an account
+     */
+    upsertFeatureOverrideRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['upsertOverrideDto'] == null) {
+                throw new runtime.RequiredError('upsertOverrideDto', 'Required parameter "upsertOverrideDto" was null or undefined when calling upsertFeatureOverride().');
+            }
+            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/feature-overrides`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpsertOverrideDtoToJSON(requestParameters['upsertOverrideDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => FeatureOverrideEntityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Upsert a feature override for an account
+     */
+    upsertFeatureOverride(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.upsertFeatureOverrideRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/FeaturesApi.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 { CreateFeatureDto, FeatureEntity, UpdateFeatureDto } from '../models/index';
+export interface CreateFeatureRequest {
+    createFeatureDto: CreateFeatureDto;
+}
+export interface DeleteFeatureRequest {
+    id: string;
+}
+export interface GetFeatureRequest {
+    id: string;
+}
+export interface UpdateFeatureRequest {
+    id: string;
+    updateFeatureDto: UpdateFeatureDto;
+}
+/**
+ *
+ */
+export declare class FeaturesApi extends runtime.BaseAPI {
+    /**
+     * Create a new feature
+     */
+    createFeatureRaw(requestParameters: CreateFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeatureEntity>>;
+    /**
+     * Create a new feature
+     */
+    createFeature(requestParameters: CreateFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeatureEntity>;
+    /**
+     * Delete a feature
+     */
+    deleteFeatureRaw(requestParameters: DeleteFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a feature
+     */
+    deleteFeature(requestParameters: DeleteFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get feature by ID
+     */
+    getFeatureRaw(requestParameters: GetFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeatureEntity>>;
+    /**
+     * Get feature by ID
+     */
+    getFeature(requestParameters: GetFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeatureEntity>;
+    /**
+     * List all features
+     */
+    listFeaturesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<FeatureEntity>>>;
+    /**
+     * List all features
+     */
+    listFeatures(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<FeatureEntity>>;
+    /**
+     * Update a feature
+     */
+    updateFeatureRaw(requestParameters: UpdateFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FeatureEntity>>;
+    /**
+     * Update a feature
+     */
+    updateFeature(requestParameters: UpdateFeatureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FeatureEntity>;
+}