@easyedu/js-lsm-api 1.104.0 → 1.105.0

package/src/apis/EmailTemplateApi.ts

@@ -85,6 +85,10 @@ export interface DeleteSystemEmailTemplateDraftRequest {
 export interface GetEmailDeliveryListRequest {
     page?: number;
     pageSize?: number;
+    templateKey?: string;
+    status?: GetEmailDeliveryListStatusEnum;
+    recipient?: string;
+    isTest?: boolean;
 }
 
 export interface GetEmailTemplateRequest {
@@ -204,6 +208,10 @@ export interface PutSystemEmailTemplateDraftRequest {
     putEmailTemplateDraft: PutEmailTemplateDraft;
 }
 
+export interface ResendEmailDeliveryRequest {
+    deliveryId: string;
+}
+
 /**
  * 
  */
@@ -311,6 +319,22 @@ export class EmailTemplateApi extends runtime.BaseAPI {
             queryParameters['pageSize'] = requestParameters['pageSize'];
         }
 
+        if (requestParameters['templateKey'] != null) {
+            queryParameters['templateKey'] = requestParameters['templateKey'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['recipient'] != null) {
+            queryParameters['recipient'] = requestParameters['recipient'];
+        }
+
+        if (requestParameters['isTest'] != null) {
+            queryParameters['isTest'] = requestParameters['isTest'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1699,4 +1723,63 @@ export class EmailTemplateApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for resendEmailDelivery without sending the request
+     */
+    async resendEmailDeliveryRequestOpts(requestParameters: ResendEmailDeliveryRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['deliveryId'] == null) {
+            throw new runtime.RequiredError(
+                'deliveryId',
+                'Required parameter "deliveryId" was null or undefined when calling resendEmailDelivery().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/email-deliveries/{deliveryId}/resend`;
+        urlPath = urlPath.replace('{deliveryId}', encodeURIComponent(String(requestParameters['deliveryId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Regenerate and queue a portal email from its current business source
+     */
+    async resendEmailDeliveryRaw(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailDelivery>> {
+        const requestOptions = await this.resendEmailDeliveryRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailDeliveryFromJSON(jsonValue));
+    }
+
+    /**
+     * Regenerate and queue a portal email from its current business source
+     */
+    async resendEmailDelivery(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailDelivery> {
+        const response = await this.resendEmailDeliveryRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
+
+/**
+ * @export
+ */
+export const GetEmailDeliveryListStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetEmailDeliveryListStatusEnum = typeof GetEmailDeliveryListStatusEnum[keyof typeof GetEmailDeliveryListStatusEnum];

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/index.ts

@@ -96,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';