@instructure/athena-api-client 1.0.2 → 1.0.4

package/dist/esm/apis/MessagesApi.js

@@ -26,6 +26,52 @@ import { MessageFromJSON, MessageCountResponseFromJSON, PaginatedMessagesFromJSO
  *
  */
 export class MessagesApi extends runtime.BaseAPI {
+    /**
+     * 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().');
+            }
+            const queryParameters = {};
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            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/chats/{chatId}/messages`;
+            urlPath = urlPath.replace(`{${"chatId"}}`, encodeURIComponent(String(requestParameters['chatId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Deletes all messages in a chat at or after the given timestamp.
+     * Delete messages from timestamp
+     */
+    deleteMessages(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteMessagesRaw(requestParameters, initOverrides);
+        });
+    }
     /**
      * Returns a single message belonging to the specified chat.
      * Get a chat message

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

@@ -1,7 +1,9 @@
 export * from './AccountsApi';
 export * from './ChatsApi';
 export * from './HealthApi';
+export * from './LearningDaysApi';
 export * from './LearningMomentsApi';
+export * from './LearningStreakApi';
 export * from './MessagesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';

package/dist/esm/apis/index.js

@@ -3,7 +3,9 @@
 export * from './AccountsApi';
 export * from './ChatsApi';
 export * from './HealthApi';
+export * from './LearningDaysApi';
 export * from './LearningMomentsApi';
+export * from './LearningStreakApi';
 export * from './MessagesApi';
 export * from './ServiceTokensApi';
 export * from './TagsApi';

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

@@ -15,13 +15,39 @@
  * @interface CreateChatRequest
  */
 export interface CreateChatRequest {
+    /**
+     * Optional caller-supplied UUID for the chat. If omitted, one is generated.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    id?: string;
     /**
      * Optional title for the chat. Defaults to 'New Chat' if omitted.
      * @type {string}
      * @memberof CreateChatRequest
      */
     title?: string;
+    /**
+     * Optional chat type. Defaults to a general chat if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    chatType?: string;
+    /**
+     * Visibility of the chat. Defaults to 'private' if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    visibility?: CreateChatRequestVisibilityEnum;
 }
+/**
+ * @export
+ */
+export declare const CreateChatRequestVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type CreateChatRequestVisibilityEnum = typeof CreateChatRequestVisibilityEnum[keyof typeof CreateChatRequestVisibilityEnum];
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */

package/dist/esm/models/CreateChatRequest.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const CreateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */
@@ -25,7 +32,10 @@ export function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'id': json['id'] == null ? undefined : json['id'],
         'title': json['title'] == null ? undefined : json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
     };
 }
 export function CreateChatRequestToJSON(json) {
@@ -36,6 +46,9 @@ export function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
         return value;
     }
     return {
+        'id': value['id'],
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

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

@@ -0,0 +1,38 @@
+/**
+ * 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 LearningDaysResponse
+ */
+export interface LearningDaysResponse {
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningDaysResponse
+     */
+    latestMomentDate: Date | null;
+    /**
+     *
+     * @type {Array<Date>}
+     * @memberof LearningDaysResponse
+     */
+    days: Array<Date>;
+}
+/**
+ * Check if a given object implements the LearningDaysResponse interface.
+ */
+export declare function instanceOfLearningDaysResponse(value: object): value is LearningDaysResponse;
+export declare function LearningDaysResponseFromJSON(json: any): LearningDaysResponse;
+export declare function LearningDaysResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningDaysResponse;
+export declare function LearningDaysResponseToJSON(json: any): LearningDaysResponse;
+export declare function LearningDaysResponseToJSONTyped(value?: LearningDaysResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearningDaysResponse.js

@@ -0,0 +1,47 @@
+/* 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 LearningDaysResponse interface.
+ */
+export function instanceOfLearningDaysResponse(value) {
+    if (!('latestMomentDate' in value) || value['latestMomentDate'] === undefined)
+        return false;
+    if (!('days' in value) || value['days'] === undefined)
+        return false;
+    return true;
+}
+export function LearningDaysResponseFromJSON(json) {
+    return LearningDaysResponseFromJSONTyped(json, false);
+}
+export function LearningDaysResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'latestMomentDate': (json['latestMomentDate'] == null ? null : new Date(json['latestMomentDate'])),
+        'days': json['days'],
+    };
+}
+export function LearningDaysResponseToJSON(json) {
+    return LearningDaysResponseToJSONTyped(json, false);
+}
+export function LearningDaysResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'latestMomentDate': value['latestMomentDate'] == null ? value['latestMomentDate'] : value['latestMomentDate'].toISOString().substring(0, 10),
+        'days': value['days'],
+    };
+}

package/dist/esm/models/LearningStreakResponse.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 LearningStreakResponse
+ */
+export interface LearningStreakResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    currentDays: number;
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    longestDays: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    lastMomentDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof LearningStreakResponse
+     */
+    totalMissedDays: number;
+    /**
+     *
+     * @type {Array<number>}
+     * @memberof LearningStreakResponse
+     */
+    missedDaysInCycle: Array<number>;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    lastEvaluatedAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningStreakResponse
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the LearningStreakResponse interface.
+ */
+export declare function instanceOfLearningStreakResponse(value: object): value is LearningStreakResponse;
+export declare function LearningStreakResponseFromJSON(json: any): LearningStreakResponse;
+export declare function LearningStreakResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningStreakResponse;
+export declare function LearningStreakResponseToJSON(json: any): LearningStreakResponse;
+export declare function LearningStreakResponseToJSONTyped(value?: LearningStreakResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/LearningStreakResponse.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 LearningStreakResponse interface.
+ */
+export function instanceOfLearningStreakResponse(value) {
+    if (!('currentDays' in value) || value['currentDays'] === undefined)
+        return false;
+    if (!('longestDays' in value) || value['longestDays'] === undefined)
+        return false;
+    if (!('totalMissedDays' in value) || value['totalMissedDays'] === undefined)
+        return false;
+    if (!('missedDaysInCycle' in value) || value['missedDaysInCycle'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function LearningStreakResponseFromJSON(json) {
+    return LearningStreakResponseFromJSONTyped(json, false);
+}
+export function LearningStreakResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'currentDays': json['currentDays'],
+        'longestDays': json['longestDays'],
+        'lastMomentDate': json['lastMomentDate'] == null ? undefined : (new Date(json['lastMomentDate'])),
+        'totalMissedDays': json['totalMissedDays'],
+        'missedDaysInCycle': json['missedDaysInCycle'],
+        'lastEvaluatedAt': json['lastEvaluatedAt'] == null ? undefined : (new Date(json['lastEvaluatedAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (new Date(json['updatedAt'])),
+    };
+}
+export function LearningStreakResponseToJSON(json) {
+    return LearningStreakResponseToJSONTyped(json, false);
+}
+export function LearningStreakResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'currentDays': value['currentDays'],
+        'longestDays': value['longestDays'],
+        'lastMomentDate': value['lastMomentDate'] == null ? value['lastMomentDate'] : value['lastMomentDate'].toISOString().substring(0, 10),
+        'totalMissedDays': value['totalMissedDays'],
+        'missedDaysInCycle': value['missedDaysInCycle'],
+        'lastEvaluatedAt': value['lastEvaluatedAt'] == null ? value['lastEvaluatedAt'] : value['lastEvaluatedAt'].toISOString(),
+        'createdAt': value['createdAt'].toISOString(),
+        'updatedAt': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -21,7 +21,27 @@ export interface UpdateChatRequest {
      * @memberof UpdateChatRequest
      */
     title?: string;
+    /**
+     * Chat type.
+     * @type {string}
+     * @memberof UpdateChatRequest
+     */
+    chatType?: string;
+    /**
+     * Visibility of the chat.
+     * @type {string}
+     * @memberof UpdateChatRequest
+     */
+    visibility?: UpdateChatRequestVisibilityEnum;
 }
+/**
+ * @export
+ */
+export declare const UpdateChatRequestVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type UpdateChatRequestVisibilityEnum = typeof UpdateChatRequestVisibilityEnum[keyof typeof UpdateChatRequestVisibilityEnum];
 /**
  * Check if a given object implements the UpdateChatRequest interface.
  */

package/dist/esm/models/UpdateChatRequest.js

@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const UpdateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the UpdateChatRequest interface.
  */
@@ -26,6 +33,8 @@ export function UpdateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'title': json['title'] == null ? undefined : json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
     };
 }
 export function UpdateChatRequestToJSON(json) {
@@ -37,5 +46,7 @@ export function UpdateChatRequestToJSONTyped(value, ignoreDiscriminator = false)
     }
     return {
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

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

@@ -6,7 +6,9 @@ export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './HealthCheck';
+export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';

package/dist/esm/models/index.js

@@ -8,7 +8,9 @@ export * from './CreateChatRequest';
 export * from './CreateTokenRequest';
 export * from './CreateTokenResponse';
 export * from './HealthCheck';
+export * from './LearningDaysResponse';
 export * from './LearningMoment';
+export * from './LearningStreakResponse';
 export * from './Message';
 export * from './MessageCountResponse';
 export * from './MessagePartsInner';

package/dist/models/CreateChatRequest.d.ts

@@ -15,13 +15,39 @@
  * @interface CreateChatRequest
  */
 export interface CreateChatRequest {
+    /**
+     * Optional caller-supplied UUID for the chat. If omitted, one is generated.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    id?: string;
     /**
      * Optional title for the chat. Defaults to 'New Chat' if omitted.
      * @type {string}
      * @memberof CreateChatRequest
      */
     title?: string;
+    /**
+     * Optional chat type. Defaults to a general chat if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    chatType?: string;
+    /**
+     * Visibility of the chat. Defaults to 'private' if omitted.
+     * @type {string}
+     * @memberof CreateChatRequest
+     */
+    visibility?: CreateChatRequestVisibilityEnum;
 }
+/**
+ * @export
+ */
+export declare const CreateChatRequestVisibilityEnum: {
+    readonly Public: "public";
+    readonly Private: "private";
+};
+export type CreateChatRequestVisibilityEnum = typeof CreateChatRequestVisibilityEnum[keyof typeof CreateChatRequestVisibilityEnum];
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */

package/dist/models/CreateChatRequest.js

@@ -13,11 +13,19 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateChatRequestVisibilityEnum = void 0;
 exports.instanceOfCreateChatRequest = instanceOfCreateChatRequest;
 exports.CreateChatRequestFromJSON = CreateChatRequestFromJSON;
 exports.CreateChatRequestFromJSONTyped = CreateChatRequestFromJSONTyped;
 exports.CreateChatRequestToJSON = CreateChatRequestToJSON;
 exports.CreateChatRequestToJSONTyped = CreateChatRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.CreateChatRequestVisibilityEnum = {
+    Public: 'public',
+    Private: 'private'
+};
 /**
  * Check if a given object implements the CreateChatRequest interface.
  */
@@ -32,7 +40,10 @@ function CreateChatRequestFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'id': json['id'] == null ? undefined : json['id'],
         'title': json['title'] == null ? undefined : json['title'],
+        'chatType': json['chatType'] == null ? undefined : json['chatType'],
+        'visibility': json['visibility'] == null ? undefined : json['visibility'],
     };
 }
 function CreateChatRequestToJSON(json) {
@@ -43,6 +54,9 @@ function CreateChatRequestToJSONTyped(value, ignoreDiscriminator = false) {
         return value;
     }
     return {
+        'id': value['id'],
         'title': value['title'],
+        'chatType': value['chatType'],
+        'visibility': value['visibility'],
     };
 }

package/dist/models/LearningDaysResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 LearningDaysResponse
+ */
+export interface LearningDaysResponse {
+    /**
+     *
+     * @type {Date}
+     * @memberof LearningDaysResponse
+     */
+    latestMomentDate: Date | null;
+    /**
+     *
+     * @type {Array<Date>}
+     * @memberof LearningDaysResponse
+     */
+    days: Array<Date>;
+}
+/**
+ * Check if a given object implements the LearningDaysResponse interface.
+ */
+export declare function instanceOfLearningDaysResponse(value: object): value is LearningDaysResponse;
+export declare function LearningDaysResponseFromJSON(json: any): LearningDaysResponse;
+export declare function LearningDaysResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LearningDaysResponse;
+export declare function LearningDaysResponseToJSON(json: any): LearningDaysResponse;
+export declare function LearningDaysResponseToJSONTyped(value?: LearningDaysResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/LearningDaysResponse.js

@@ -0,0 +1,54 @@
+"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.instanceOfLearningDaysResponse = instanceOfLearningDaysResponse;
+exports.LearningDaysResponseFromJSON = LearningDaysResponseFromJSON;
+exports.LearningDaysResponseFromJSONTyped = LearningDaysResponseFromJSONTyped;
+exports.LearningDaysResponseToJSON = LearningDaysResponseToJSON;
+exports.LearningDaysResponseToJSONTyped = LearningDaysResponseToJSONTyped;
+/**
+ * Check if a given object implements the LearningDaysResponse interface.
+ */
+function instanceOfLearningDaysResponse(value) {
+    if (!('latestMomentDate' in value) || value['latestMomentDate'] === undefined)
+        return false;
+    if (!('days' in value) || value['days'] === undefined)
+        return false;
+    return true;
+}
+function LearningDaysResponseFromJSON(json) {
+    return LearningDaysResponseFromJSONTyped(json, false);
+}
+function LearningDaysResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'latestMomentDate': (json['latestMomentDate'] == null ? null : new Date(json['latestMomentDate'])),
+        'days': json['days'],
+    };
+}
+function LearningDaysResponseToJSON(json) {
+    return LearningDaysResponseToJSONTyped(json, false);
+}
+function LearningDaysResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'latestMomentDate': value['latestMomentDate'] == null ? value['latestMomentDate'] : value['latestMomentDate'].toISOString().substring(0, 10),
+        'days': value['days'],
+    };
+}