@easyedu/js-lsm-api 1.103.0 → 1.105.0

package/src/models/GetChatUsage.ts

@@ -0,0 +1,124 @@
+/* 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 { mapValues } from '../runtime';
+import type { ChatDailyUsage } from './ChatDailyUsage';
+import {
+    ChatDailyUsageFromJSON,
+    ChatDailyUsageFromJSONTyped,
+    ChatDailyUsageToJSON,
+    ChatDailyUsageToJSONTyped,
+} from './ChatDailyUsage';
+import type { ChatModelUsage } from './ChatModelUsage';
+import {
+    ChatModelUsageFromJSON,
+    ChatModelUsageFromJSONTyped,
+    ChatModelUsageToJSON,
+    ChatModelUsageToJSONTyped,
+} from './ChatModelUsage';
+import type { ChatUsageTotals } from './ChatUsageTotals';
+import {
+    ChatUsageTotalsFromJSON,
+    ChatUsageTotalsFromJSONTyped,
+    ChatUsageTotalsToJSON,
+    ChatUsageTotalsToJSONTyped,
+} 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 function instanceOfGetChatUsage(value: object): value is GetChatUsage {
+    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: any): GetChatUsage {
+    return GetChatUsageFromJSONTyped(json, false);
+}
+
+export function GetChatUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChatUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'from': json['from'],
+        'to': json['to'],
+        'totals': ChatUsageTotalsFromJSON(json['totals']),
+        'daily': ((json['daily'] as Array<any>).map(ChatDailyUsageFromJSON)),
+        'modelUsage': ((json['model_usage'] as Array<any>).map(ChatModelUsageFromJSON)),
+    };
+}
+
+export function GetChatUsageToJSON(json: any): GetChatUsage {
+    return GetChatUsageToJSONTyped(json, false);
+}
+
+export function GetChatUsageToJSONTyped(value?: GetChatUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'from': value['from'],
+        'to': value['to'],
+        'totals': ChatUsageTotalsToJSON(value['totals']),
+        'daily': ((value['daily'] as Array<any>).map(ChatDailyUsageToJSON)),
+        'model_usage': ((value['modelUsage'] as Array<any>).map(ChatModelUsageToJSON)),
+    };
+}
+

package/src/models/GetEmailDelivery.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
+import {
+    GetPortalInvitationSummaryFromJSON,
+    GetPortalInvitationSummaryFromJSONTyped,
+    GetPortalInvitationSummaryToJSON,
+    GetPortalInvitationSummaryToJSONTyped,
+} from './GetPortalInvitationSummary';
+
 /**
  * 
  * @export
@@ -43,6 +51,12 @@ export interface GetEmailDelivery {
      * @memberof GetEmailDelivery
      */
     recipient: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    subject?: string | null;
     /**
      * 
      * @type {boolean}
@@ -103,6 +117,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;
 }
 
 
@@ -132,6 +170,7 @@ export function instanceOfGetEmailDelivery(value: object): value is GetEmailDeli
     if (!('status' in value) || value['status'] === undefined) return false;
     if (!('attempts' in value) || value['attempts'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('canResend' in value) || value['canResend'] === undefined) return false;
     return true;
 }
 
@@ -149,6 +188,7 @@ export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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'],
@@ -159,6 +199,10 @@ export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: bo
         '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']),
     };
 }
 
@@ -177,6 +221,7 @@ export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ign
         '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'],
@@ -187,6 +232,10 @@ export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ign
         '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/src/models/GetPortalInvitationSummary.ts

@@ -0,0 +1,160 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 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 const GetPortalInvitationSummaryStatusEnum = {
+    Pending: 'pending',
+    Expired: 'expired',
+    Accepted: 'accepted'
+} as const;
+export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
+
+/**
+ * @export
+ */
+export const GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary {
+    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: any): GetPortalInvitationSummary {
+    return GetPortalInvitationSummaryFromJSONTyped(json, false);
+}
+
+export function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary {
+    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: any): GetPortalInvitationSummary {
+    return GetPortalInvitationSummaryToJSONTyped(json, false);
+}
+
+export function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/GetPortalUser.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
+import {
+    GetPortalInvitationSummaryFromJSON,
+    GetPortalInvitationSummaryFromJSONTyped,
+    GetPortalInvitationSummaryToJSON,
+    GetPortalInvitationSummaryToJSONTyped,
+} from './GetPortalInvitationSummary';
+
 /**
  * A user with their portal access information
  * @export
@@ -55,6 +63,12 @@ export interface GetPortalUser {
      * @memberof GetPortalUser
      */
     isActive: boolean;
+    /**
+     * 
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetPortalUser
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 
 /**
@@ -86,6 +100,7 @@ export function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boole
         'lastName': json['last_name'],
         'role': json['role'],
         'isActive': json['is_active'],
+        'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
     };
 }
 
@@ -106,6 +121,7 @@ export function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDis
         'last_name': value['lastName'],
         'role': value['role'],
         'is_active': value['isActive'],
+        'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
     };
 }
 

package/src/models/PutChatSettings.ts

@@ -0,0 +1,66 @@
+/* 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PutChatSettings
+ */
+export interface PutChatSettings {
+    /**
+     * 
+     * @type {number}
+     * @memberof PutChatSettings
+     */
+    learnerDailyMessageLimit: number;
+}
+
+/**
+ * Check if a given object implements the PutChatSettings interface.
+ */
+export function instanceOfPutChatSettings(value: object): value is PutChatSettings {
+    if (!('learnerDailyMessageLimit' in value) || value['learnerDailyMessageLimit'] === undefined) return false;
+    return true;
+}
+
+export function PutChatSettingsFromJSON(json: any): PutChatSettings {
+    return PutChatSettingsFromJSONTyped(json, false);
+}
+
+export function PutChatSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutChatSettings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'learnerDailyMessageLimit': json['learner_daily_message_limit'],
+    };
+}
+
+export function PutChatSettingsToJSON(json: any): PutChatSettings {
+    return PutChatSettingsToJSONTyped(json, false);
+}
+
+export function PutChatSettingsToJSONTyped(value?: PutChatSettings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'learner_daily_message_limit': value['learnerDailyMessageLimit'],
+    };
+}
+

package/src/models/index.ts

@@ -1,5 +1,9 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AdminChatMessage';
+export * from './AdminConversationDetail';
+export * from './AdminConversationList';
+export * from './AdminConversationSummary';
 export * from './ArtifactConflict';
 export * from './BadgeIssuer';
 export * from './Certificate';
@@ -22,6 +26,13 @@ export * from './CertificatePublic';
 export * from './CertificateRenewalPolicy';
 export * from './CertificateTemplate';
 export * from './CertificateTemplateVersion';
+export * from './ChatDailyUsage';
+export * from './ChatModelUsage';
+export * from './ChatQuota';
+export * from './ChatQuotaExceeded';
+export * from './ChatTurnUsage';
+export * from './ChatUsageTotals';
+export * from './ChatUserIdentity';
 export * from './ContentLaunchMode';
 export * from './ContentLibraryVersionStatus';
 export * from './CourseCatalog';
@@ -41,6 +52,8 @@ export * from './GetCertificateTemplateList';
 export * from './GetChangelogEntry';
 export * from './GetChangelogList';
 export * from './GetChatMessage';
+export * from './GetChatSettings';
+export * from './GetChatUsage';
 export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
@@ -83,6 +96,7 @@ export * from './GetLibraryQuizVersion';
 export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalFaviconUpload';
+export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalUser';
@@ -220,6 +234,7 @@ export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
 export * from './PutCertificateTemplate';
 export * from './PutCertificateTemplateDraft';
+export * from './PutChatSettings';
 export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';