@easyedu/js-lsm-api 1.103.0 → 1.105.0

package/dist/esm/models/ChatUserIdentity.js

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 ChatUserIdentity interface.
+ */
+export function instanceOfChatUserIdentity(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    return true;
+}
+export function ChatUserIdentityFromJSON(json) {
+    return ChatUserIdentityFromJSONTyped(json, false);
+}
+export function ChatUserIdentityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'email': json['email'],
+    };
+}
+export function ChatUserIdentityToJSON(json) {
+    return ChatUserIdentityToJSONTyped(json, false);
+}
+export function ChatUserIdentityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'email': value['email'],
+    };
+}

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

@@ -0,0 +1,51 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 GetChatSettings
+ */
+export interface GetChatSettings {
+    /**
+     *
+     * @type {number}
+     * @memberof GetChatSettings
+     */
+    learnerDailyMessageLimit: number;
+    /**
+     *
+     * @type {GetChatSettingsResetPolicyEnum}
+     * @memberof GetChatSettings
+     */
+    resetPolicy: GetChatSettingsResetPolicyEnum;
+    /**
+     * Unix timestamp for the last settings update
+     * @type {number}
+     * @memberof GetChatSettings
+     */
+    updatedAt: number;
+}
+/**
+ * @export
+ */
+export declare const GetChatSettingsResetPolicyEnum: {
+    readonly UtcMidnight: "utc_midnight";
+};
+export type GetChatSettingsResetPolicyEnum = typeof GetChatSettingsResetPolicyEnum[keyof typeof GetChatSettingsResetPolicyEnum];
+/**
+ * Check if a given object implements the GetChatSettings interface.
+ */
+export declare function instanceOfGetChatSettings(value: object): value is GetChatSettings;
+export declare function GetChatSettingsFromJSON(json: any): GetChatSettings;
+export declare function GetChatSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChatSettings;
+export declare function GetChatSettingsToJSON(json: any): GetChatSettings;
+export declare function GetChatSettingsToJSONTyped(value?: GetChatSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetChatSettings.js

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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
+ */
+export const GetChatSettingsResetPolicyEnum = {
+    UtcMidnight: 'utc_midnight'
+};
+/**
+ * Check if a given object implements the GetChatSettings interface.
+ */
+export function instanceOfGetChatSettings(value) {
+    if (!('learnerDailyMessageLimit' in value) || value['learnerDailyMessageLimit'] === undefined)
+        return false;
+    if (!('resetPolicy' in value) || value['resetPolicy'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function GetChatSettingsFromJSON(json) {
+    return GetChatSettingsFromJSONTyped(json, false);
+}
+export function GetChatSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'learnerDailyMessageLimit': json['learner_daily_message_limit'],
+        'resetPolicy': json['reset_policy'],
+        'updatedAt': json['updated_at'],
+    };
+}
+export function GetChatSettingsToJSON(json) {
+    return GetChatSettingsToJSONTyped(json, false);
+}
+export function GetChatSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'learner_daily_message_limit': value['learnerDailyMessageLimit'],
+        'reset_policy': value['resetPolicy'],
+        'updated_at': value['updatedAt'],
+    };
+}

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

@@ -0,0 +1,59 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 type { ChatDailyUsage } from './ChatDailyUsage';
+import type { ChatModelUsage } from './ChatModelUsage';
+import type { ChatUsageTotals } from './ChatUsageTotals';
+/**
+ *
+ * @export
+ * @interface GetChatUsage
+ */
+export interface GetChatUsage {
+    /**
+     *
+     * @type {number}
+     * @memberof GetChatUsage
+     */
+    from: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetChatUsage
+     */
+    to: number;
+    /**
+     *
+     * @type {ChatUsageTotals}
+     * @memberof GetChatUsage
+     */
+    totals: ChatUsageTotals;
+    /**
+     *
+     * @type {Array<ChatDailyUsage>}
+     * @memberof GetChatUsage
+     */
+    daily: Array<ChatDailyUsage>;
+    /**
+     *
+     * @type {Array<ChatModelUsage>}
+     * @memberof GetChatUsage
+     */
+    modelUsage: Array<ChatModelUsage>;
+}
+/**
+ * Check if a given object implements the GetChatUsage interface.
+ */
+export declare function instanceOfGetChatUsage(value: object): value is GetChatUsage;
+export declare function GetChatUsageFromJSON(json: any): GetChatUsage;
+export declare function GetChatUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChatUsage;
+export declare function GetChatUsageToJSON(json: any): GetChatUsage;
+export declare function GetChatUsageToJSONTyped(value?: GetChatUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetChatUsage.js

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 { ChatDailyUsageFromJSON, ChatDailyUsageToJSON, } from './ChatDailyUsage';
+import { ChatModelUsageFromJSON, ChatModelUsageToJSON, } from './ChatModelUsage';
+import { ChatUsageTotalsFromJSON, ChatUsageTotalsToJSON, } from './ChatUsageTotals';
+/**
+ * Check if a given object implements the GetChatUsage interface.
+ */
+export function instanceOfGetChatUsage(value) {
+    if (!('from' in value) || value['from'] === undefined)
+        return false;
+    if (!('to' in value) || value['to'] === undefined)
+        return false;
+    if (!('totals' in value) || value['totals'] === undefined)
+        return false;
+    if (!('daily' in value) || value['daily'] === undefined)
+        return false;
+    if (!('modelUsage' in value) || value['modelUsage'] === undefined)
+        return false;
+    return true;
+}
+export function GetChatUsageFromJSON(json) {
+    return GetChatUsageFromJSONTyped(json, false);
+}
+export function GetChatUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'from': json['from'],
+        'to': json['to'],
+        'totals': ChatUsageTotalsFromJSON(json['totals']),
+        'daily': (json['daily'].map(ChatDailyUsageFromJSON)),
+        'modelUsage': (json['model_usage'].map(ChatModelUsageFromJSON)),
+    };
+}
+export function GetChatUsageToJSON(json) {
+    return GetChatUsageToJSONTyped(json, false);
+}
+export function GetChatUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'from': value['from'],
+        'to': value['to'],
+        'totals': ChatUsageTotalsToJSON(value['totals']),
+        'daily': (value['daily'].map(ChatDailyUsageToJSON)),
+        'model_usage': (value['modelUsage'].map(ChatModelUsageToJSON)),
+    };
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  *
  * @export
@@ -39,6 +40,12 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     recipient: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    subject?: string | null;
     /**
      *
      * @type {boolean}
@@ -99,6 +106,30 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     failedAt?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    resendOfDeliveryId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetEmailDelivery
+     */
+    canResend: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    resendBlockedReason?: string | null;
+    /**
+     *
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetEmailDelivery
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 /**
  * @export

package/dist/esm/models/GetEmailDelivery.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { GetPortalInvitationSummaryFromJSON, GetPortalInvitationSummaryToJSON, } from './GetPortalInvitationSummary';
 /**
  * @export
  */
@@ -41,6 +42,8 @@ export function instanceOfGetEmailDelivery(value) {
         return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined)
         return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
     return true;
 }
 export function GetEmailDeliveryFromJSON(json) {
@@ -55,6 +58,7 @@ export function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         'templateKey': json['template_key'],
         'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
         'recipient': json['recipient'],
+        'subject': json['subject'] == null ? undefined : json['subject'],
         'isTest': json['is_test'],
         'status': json['status'],
         'attempts': json['attempts'],
@@ -65,6 +69,10 @@ export function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
         'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
         'deliveredAt': json['delivered_at'] == null ? undefined : json['delivered_at'],
         'failedAt': json['failed_at'] == null ? undefined : json['failed_at'],
+        'resendOfDeliveryId': json['resend_of_delivery_id'] == null ? undefined : json['resend_of_delivery_id'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+        'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
     };
 }
 export function GetEmailDeliveryToJSON(json) {
@@ -79,6 +87,7 @@ export function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false)
         'template_key': value['templateKey'],
         'template_version_id': value['templateVersionId'],
         'recipient': value['recipient'],
+        'subject': value['subject'],
         'is_test': value['isTest'],
         'status': value['status'],
         'attempts': value['attempts'],
@@ -89,5 +98,9 @@ export function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false)
         'accepted_at': value['acceptedAt'],
         'delivered_at': value['deliveredAt'],
         'failed_at': value['failedAt'],
+        'resend_of_delivery_id': value['resendOfDeliveryId'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+        'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
     };
 }

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

@@ -0,0 +1,102 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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.
+ */
+/**
+ * Invitation lifecycle and latest email delivery state for a portal user.
+ * @export
+ * @interface GetPortalInvitationSummary
+ */
+export interface GetPortalInvitationSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    id: string;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    status: GetPortalInvitationSummaryStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    invitedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    expiresAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    acceptedAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    lastSentAt?: number | null;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryLatestDeliveryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    latestDeliveryStatus?: GetPortalInvitationSummaryLatestDeliveryStatusEnum | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetPortalInvitationSummary
+     */
+    canResend: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    resendBlockedReason?: string | null;
+}
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryStatusEnum: {
+    readonly Pending: "pending";
+    readonly Expired: "expired";
+    readonly Accepted: "accepted";
+};
+export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryLatestDeliveryStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Accepted: "accepted";
+    readonly Delivered: "delivered";
+    readonly Deferred: "deferred";
+    readonly Failed: "failed";
+    readonly Complained: "complained";
+};
+export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export declare function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalInvitationSummary.js

@@ -0,0 +1,87 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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
+ */
+export const GetPortalInvitationSummaryStatusEnum = {
+    Pending: 'pending',
+    Expired: 'expired',
+    Accepted: 'accepted'
+};
+/**
+ * @export
+ */
+export const GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+};
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export function instanceOfGetPortalInvitationSummary(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
+    return true;
+}
+export function GetPortalInvitationSummaryFromJSON(json) {
+    return GetPortalInvitationSummaryFromJSONTyped(json, false);
+}
+export function GetPortalInvitationSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': json['invited_at'],
+        'expiresAt': json['expires_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'lastSentAt': json['last_sent_at'] == null ? undefined : json['last_sent_at'],
+        'latestDeliveryStatus': json['latest_delivery_status'] == null ? undefined : json['latest_delivery_status'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+    };
+}
+export function GetPortalInvitationSummaryToJSON(json) {
+    return GetPortalInvitationSummaryToJSONTyped(json, false);
+}
+export function GetPortalInvitationSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'],
+        'expires_at': value['expiresAt'],
+        'accepted_at': value['acceptedAt'],
+        'last_sent_at': value['lastSentAt'],
+        'latest_delivery_status': value['latestDeliveryStatus'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+    };
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  * A user with their portal access information
  * @export
@@ -51,6 +52,12 @@ export interface GetPortalUser {
      * @memberof GetPortalUser
      */
     isActive: boolean;
+    /**
+     *
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetPortalUser
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 /**
  * Check if a given object implements the GetPortalUser interface.

package/dist/esm/models/GetPortalUser.js

@@ -11,6 +11,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { GetPortalInvitationSummaryFromJSON, GetPortalInvitationSummaryToJSON, } from './GetPortalInvitationSummary';
 /**
  * Check if a given object implements the GetPortalUser interface.
  */
@@ -43,6 +44,7 @@ export function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
         'lastName': json['last_name'],
         'role': json['role'],
         'isActive': json['is_active'],
+        'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
     };
 }
 export function GetPortalUserToJSON(json) {
@@ -59,5 +61,6 @@ export function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
         'last_name': value['lastName'],
         'role': value['role'],
         'is_active': value['isActive'],
+        'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
     };
 }

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

@@ -0,0 +1,32 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * 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 PutChatSettings
+ */
+export interface PutChatSettings {
+    /**
+     *
+     * @type {number}
+     * @memberof PutChatSettings
+     */
+    learnerDailyMessageLimit: number;
+}
+/**
+ * Check if a given object implements the PutChatSettings interface.
+ */
+export declare function instanceOfPutChatSettings(value: object): value is PutChatSettings;
+export declare function PutChatSettingsFromJSON(json: any): PutChatSettings;
+export declare function PutChatSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutChatSettings;
+export declare function PutChatSettingsToJSON(json: any): PutChatSettings;
+export declare function PutChatSettingsToJSONTyped(value?: PutChatSettings | null, ignoreDiscriminator?: boolean): any;