@instructure/athena-api-client 2.22.15 → 2.23.1

package/README.md

@@ -131,6 +131,7 @@ All URIs are relative to *http://localhost:3000*
 *UserConceptsApi* | [**upsertUserConceptByName**](docs/UserConceptsApi.md#upsertuserconceptbynameoperation) | **POST** /api/v1/user-concepts | Upsert user concept by name
 *UserContextApi* | [**getUserContext**](docs/UserContextApi.md#getusercontext) | **GET** /api/v1/user-context | Get user context
 *UserContextApi* | [**upsertUserContext**](docs/UserContextApi.md#upsertusercontextoperation) | **PUT** /api/v1/user-context | Create or update user context
+*UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deletecurrentuser) | **DELETE** /api/v1/users/me | Delete the current user
 *VotesApi* | [**listChatVotes**](docs/VotesApi.md#listchatvotes) | **GET** /api/v1/chats/{chatId}/votes | List votes for a chat
 *VotesApi* | [**upsertChatVote**](docs/VotesApi.md#upsertchatvote) | **PATCH** /api/v1/chats/{chatId}/votes | Create or update a vote
 
@@ -174,6 +175,7 @@ All URIs are relative to *http://localhost:3000*
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [DailyQuizStatus](docs/DailyQuizStatus.md)
+- [DeleteCurrentUserResponse](docs/DeleteCurrentUserResponse.md)
 - [EnrollmentTaxonomy](docs/EnrollmentTaxonomy.md)
 - [FeatureEntity](docs/FeatureEntity.md)
 - [FeatureOverrideEntity](docs/FeatureOverrideEntity.md)

package/dist/apis/UsersApi.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { DeleteCurrentUserResponse } from '../models/index';
+export interface DeleteCurrentUserRequest {
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class UsersApi extends runtime.BaseAPI {
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUserRaw(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCurrentUserResponse>>;
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUser(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCurrentUserResponse>;
+}

package/dist/apis/UsersApi.js

@@ -0,0 +1,70 @@
+"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.UsersApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class UsersApi extends runtime.BaseAPI {
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUserRaw(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 deleteCurrentUser().');
+            }
+            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/users/me`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeleteCurrentUserResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUser(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteCurrentUserRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.UsersApi = UsersApi;

package/dist/apis/index.d.ts

@@ -22,4 +22,5 @@ export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';
 export * from './UserConceptsApi';
 export * from './UserContextApi';
+export * from './UsersApi';
 export * from './VotesApi';

package/dist/apis/index.js

@@ -40,4 +40,5 @@ __exportStar(require("./TaxonomiesApi"), exports);
 __exportStar(require("./TaxonomyEnrollmentsApi"), exports);
 __exportStar(require("./UserConceptsApi"), exports);
 __exportStar(require("./UserContextApi"), exports);
+__exportStar(require("./UsersApi"), exports);
 __exportStar(require("./VotesApi"), exports);

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { DeleteCurrentUserResponse } from '../models/index';
+export interface DeleteCurrentUserRequest {
+    xUserId: string;
+}
+/**
+ *
+ */
+export declare class UsersApi extends runtime.BaseAPI {
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUserRaw(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCurrentUserResponse>>;
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUser(requestParameters: DeleteCurrentUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCurrentUserResponse>;
+}

package/dist/esm/apis/UsersApi.js

@@ -0,0 +1,66 @@
+/* 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 { DeleteCurrentUserResponseFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class UsersApi extends runtime.BaseAPI {
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUserRaw(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 deleteCurrentUser().');
+            }
+            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/users/me`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DeleteCurrentUserResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Hard-deletes the authenticated account user, the underlying user record, and all dependent data (chats, messages, quizzes, sessions, learning moments, streaks, etc.).
+     * Delete the current user
+     */
+    deleteCurrentUser(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.deleteCurrentUserRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -22,4 +22,5 @@ export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';
 export * from './UserConceptsApi';
 export * from './UserContextApi';
+export * from './UsersApi';
 export * from './VotesApi';

package/dist/esm/apis/index.js

@@ -24,4 +24,5 @@ export * from './TaxonomiesApi';
 export * from './TaxonomyEnrollmentsApi';
 export * from './UserConceptsApi';
 export * from './UserContextApi';
+export * from './UsersApi';
 export * from './VotesApi';

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

@@ -0,0 +1,32 @@
+/**
+ * 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 DeleteCurrentUserResponse
+ */
+export interface DeleteCurrentUserResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof DeleteCurrentUserResponse
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the DeleteCurrentUserResponse interface.
+ */
+export declare function instanceOfDeleteCurrentUserResponse(value: object): value is DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseFromJSON(json: any): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseToJSON(json: any): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseToJSONTyped(value?: DeleteCurrentUserResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DeleteCurrentUserResponse.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.
+ */
+/**
+ * Check if a given object implements the DeleteCurrentUserResponse interface.
+ */
+export function instanceOfDeleteCurrentUserResponse(value) {
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+export function DeleteCurrentUserResponseFromJSON(json) {
+    return DeleteCurrentUserResponseFromJSONTyped(json, false);
+}
+export function DeleteCurrentUserResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deleted': json['deleted'],
+    };
+}
+export function DeleteCurrentUserResponseToJSON(json) {
+    return DeleteCurrentUserResponseToJSONTyped(json, false);
+}
+export function DeleteCurrentUserResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted': value['deleted'],
+    };
+}

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

@@ -35,6 +35,7 @@ export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
+export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';

package/dist/esm/models/index.js

@@ -37,6 +37,7 @@ export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
+export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';

package/dist/models/DeleteCurrentUserResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 DeleteCurrentUserResponse
+ */
+export interface DeleteCurrentUserResponse {
+    /**
+     *
+     * @type {boolean}
+     * @memberof DeleteCurrentUserResponse
+     */
+    deleted: boolean;
+}
+/**
+ * Check if a given object implements the DeleteCurrentUserResponse interface.
+ */
+export declare function instanceOfDeleteCurrentUserResponse(value: object): value is DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseFromJSON(json: any): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseToJSON(json: any): DeleteCurrentUserResponse;
+export declare function DeleteCurrentUserResponseToJSONTyped(value?: DeleteCurrentUserResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DeleteCurrentUserResponse.js

@@ -0,0 +1,50 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfDeleteCurrentUserResponse = instanceOfDeleteCurrentUserResponse;
+exports.DeleteCurrentUserResponseFromJSON = DeleteCurrentUserResponseFromJSON;
+exports.DeleteCurrentUserResponseFromJSONTyped = DeleteCurrentUserResponseFromJSONTyped;
+exports.DeleteCurrentUserResponseToJSON = DeleteCurrentUserResponseToJSON;
+exports.DeleteCurrentUserResponseToJSONTyped = DeleteCurrentUserResponseToJSONTyped;
+/**
+ * Check if a given object implements the DeleteCurrentUserResponse interface.
+ */
+function instanceOfDeleteCurrentUserResponse(value) {
+    if (!('deleted' in value) || value['deleted'] === undefined)
+        return false;
+    return true;
+}
+function DeleteCurrentUserResponseFromJSON(json) {
+    return DeleteCurrentUserResponseFromJSONTyped(json, false);
+}
+function DeleteCurrentUserResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deleted': json['deleted'],
+    };
+}
+function DeleteCurrentUserResponseToJSON(json) {
+    return DeleteCurrentUserResponseToJSONTyped(json, false);
+}
+function DeleteCurrentUserResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deleted': value['deleted'],
+    };
+}

package/dist/models/index.d.ts

@@ -35,6 +35,7 @@ export * from './CreatePlanDto';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './DailyQuizStatus';
+export * from './DeleteCurrentUserResponse';
 export * from './EnrollmentTaxonomy';
 export * from './FeatureEntity';
 export * from './FeatureOverrideEntity';

package/dist/models/index.js

@@ -53,6 +53,7 @@ __exportStar(require("./CreatePlanDto"), exports);
 __exportStar(require("./CreateTokenRequest"), exports);
 __exportStar(require("./CreateTokenResponse"), exports);
 __exportStar(require("./DailyQuizStatus"), exports);
+__exportStar(require("./DeleteCurrentUserResponse"), exports);
 __exportStar(require("./EnrollmentTaxonomy"), exports);
 __exportStar(require("./FeatureEntity"), exports);
 __exportStar(require("./FeatureOverrideEntity"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@instructure/athena-api-client",
   "private": false,
-  "version": "2.22.15",
+  "version": "2.23.1",
   "description": "OpenAPI client for the Athena API",
   "author": "Instructure",
   "repository": {