@easyedu/js-lsm-api 1.104.0 → 1.105.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -109,6 +109,7 @@ docs/GetLibraryQuizVersion.md
109
109
  docs/GetPermission.md
110
110
  docs/GetPortal.md
111
111
  docs/GetPortalFaviconUpload.md
112
+ docs/GetPortalInvitationSummary.md
112
113
  docs/GetPortalList.md
113
114
  docs/GetPortalLogoUpload.md
114
115
  docs/GetPortalUser.md
@@ -420,6 +421,7 @@ src/models/GetLibraryQuizVersion.ts
420
421
  src/models/GetPermission.ts
421
422
  src/models/GetPortal.ts
422
423
  src/models/GetPortalFaviconUpload.ts
424
+ src/models/GetPortalInvitationSummary.ts
423
425
  src/models/GetPortalList.ts
424
426
  src/models/GetPortalLogoUpload.ts
425
427
  src/models/GetPortalUser.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.104.0
1
+ # @easyedu/js-lsm-api@1.105.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -262,6 +262,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
262
262
  *EmailTemplateApi* | [**putEmailTemplateDraft**](docs/EmailTemplateApi.md#putemailtemplatedraft) | **PUT** /email-templates/{templateKey}/draft | Update a portal email template draft
263
263
  *EmailTemplateApi* | [**putSystemEmailAssetFile**](docs/EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image
264
264
  *EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
265
+ *EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
265
266
  *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
266
267
  *PlayerApi* | [**commitResourceScormSession**](docs/PlayerApi.md#commitresourcescormsession) | **POST** /resource/sessions/{sessionId}/commit | Commit a reusable SCORM resource session
267
268
  *PlayerApi* | [**getCourseVersionResourceAsset**](docs/PlayerApi.md#getcourseversionresourceasset) | **GET** /resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath} | Stream an asset from an exact course and resource version
@@ -453,6 +454,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
453
454
  - [GetPermission](docs/GetPermission.md)
454
455
  - [GetPortal](docs/GetPortal.md)
455
456
  - [GetPortalFaviconUpload](docs/GetPortalFaviconUpload.md)
457
+ - [GetPortalInvitationSummary](docs/GetPortalInvitationSummary.md)
456
458
  - [GetPortalList](docs/GetPortalList.md)
457
459
  - [GetPortalLogoUpload](docs/GetPortalLogoUpload.md)
458
460
  - [GetPortalUser](docs/GetPortalUser.md)
@@ -645,7 +647,7 @@ and is automatically generated by the
645
647
  [OpenAPI Generator](https://openapi-generator.tech) project:
646
648
 
647
649
  - API version: `1.0.0`
648
- - Package version: `1.104.0`
650
+ - Package version: `1.105.0`
649
651
  - Generator version: `7.22.0`
650
652
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
651
653
 
@@ -31,6 +31,10 @@ export interface DeleteSystemEmailTemplateDraftRequest {
31
31
  export interface GetEmailDeliveryListRequest {
32
32
  page?: number;
33
33
  pageSize?: number;
34
+ templateKey?: string;
35
+ status?: GetEmailDeliveryListStatusEnum;
36
+ recipient?: string;
37
+ isTest?: boolean;
34
38
  }
35
39
  export interface GetEmailTemplateRequest {
36
40
  templateKey: string;
@@ -125,6 +129,9 @@ export interface PutSystemEmailTemplateDraftRequest {
125
129
  templateKey: string;
126
130
  putEmailTemplateDraft: PutEmailTemplateDraft;
127
131
  }
132
+ export interface ResendEmailDeliveryRequest {
133
+ deliveryId: string;
134
+ }
128
135
  /**
129
136
  *
130
137
  */
@@ -501,4 +508,29 @@ export declare class EmailTemplateApi extends runtime.BaseAPI {
501
508
  * Update a platform email template draft
502
509
  */
503
510
  putSystemEmailTemplateDraft(requestParameters: PutSystemEmailTemplateDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailTemplateVersion>;
511
+ /**
512
+ * Creates request options for resendEmailDelivery without sending the request
513
+ */
514
+ resendEmailDeliveryRequestOpts(requestParameters: ResendEmailDeliveryRequest): Promise<runtime.RequestOpts>;
515
+ /**
516
+ * Regenerate and queue a portal email from its current business source
517
+ */
518
+ resendEmailDeliveryRaw(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailDelivery>>;
519
+ /**
520
+ * Regenerate and queue a portal email from its current business source
521
+ */
522
+ resendEmailDelivery(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailDelivery>;
504
523
  }
524
+ /**
525
+ * @export
526
+ */
527
+ export declare const GetEmailDeliveryListStatusEnum: {
528
+ readonly Queued: "queued";
529
+ readonly Processing: "processing";
530
+ readonly Accepted: "accepted";
531
+ readonly Delivered: "delivered";
532
+ readonly Deferred: "deferred";
533
+ readonly Failed: "failed";
534
+ readonly Complained: "complained";
535
+ };
536
+ export type GetEmailDeliveryListStatusEnum = typeof GetEmailDeliveryListStatusEnum[keyof typeof GetEmailDeliveryListStatusEnum];
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.EmailTemplateApi = void 0;
25
+ exports.GetEmailDeliveryListStatusEnum = exports.EmailTemplateApi = void 0;
26
26
  const runtime = require("../runtime");
27
27
  const EmailTemplateVersion_1 = require("../models/EmailTemplateVersion");
28
28
  const GetEmailAssetUpload_1 = require("../models/GetEmailAssetUpload");
@@ -128,6 +128,18 @@ class EmailTemplateApi extends runtime.BaseAPI {
128
128
  if (requestParameters['pageSize'] != null) {
129
129
  queryParameters['pageSize'] = requestParameters['pageSize'];
130
130
  }
131
+ if (requestParameters['templateKey'] != null) {
132
+ queryParameters['templateKey'] = requestParameters['templateKey'];
133
+ }
134
+ if (requestParameters['status'] != null) {
135
+ queryParameters['status'] = requestParameters['status'];
136
+ }
137
+ if (requestParameters['recipient'] != null) {
138
+ queryParameters['recipient'] = requestParameters['recipient'];
139
+ }
140
+ if (requestParameters['isTest'] != null) {
141
+ queryParameters['isTest'] = requestParameters['isTest'];
142
+ }
131
143
  const headerParameters = {};
132
144
  let urlPath = `/email-deliveries`;
133
145
  return {
@@ -1295,5 +1307,56 @@ class EmailTemplateApi extends runtime.BaseAPI {
1295
1307
  return yield response.value();
1296
1308
  });
1297
1309
  }
1310
+ /**
1311
+ * Creates request options for resendEmailDelivery without sending the request
1312
+ */
1313
+ resendEmailDeliveryRequestOpts(requestParameters) {
1314
+ return __awaiter(this, void 0, void 0, function* () {
1315
+ if (requestParameters['deliveryId'] == null) {
1316
+ throw new runtime.RequiredError('deliveryId', 'Required parameter "deliveryId" was null or undefined when calling resendEmailDelivery().');
1317
+ }
1318
+ const queryParameters = {};
1319
+ const headerParameters = {};
1320
+ let urlPath = `/email-deliveries/{deliveryId}/resend`;
1321
+ urlPath = urlPath.replace('{deliveryId}', encodeURIComponent(String(requestParameters['deliveryId'])));
1322
+ return {
1323
+ path: urlPath,
1324
+ method: 'POST',
1325
+ headers: headerParameters,
1326
+ query: queryParameters,
1327
+ };
1328
+ });
1329
+ }
1330
+ /**
1331
+ * Regenerate and queue a portal email from its current business source
1332
+ */
1333
+ resendEmailDeliveryRaw(requestParameters, initOverrides) {
1334
+ return __awaiter(this, void 0, void 0, function* () {
1335
+ const requestOptions = yield this.resendEmailDeliveryRequestOpts(requestParameters);
1336
+ const response = yield this.request(requestOptions, initOverrides);
1337
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetEmailDelivery_1.GetEmailDeliveryFromJSON)(jsonValue));
1338
+ });
1339
+ }
1340
+ /**
1341
+ * Regenerate and queue a portal email from its current business source
1342
+ */
1343
+ resendEmailDelivery(requestParameters, initOverrides) {
1344
+ return __awaiter(this, void 0, void 0, function* () {
1345
+ const response = yield this.resendEmailDeliveryRaw(requestParameters, initOverrides);
1346
+ return yield response.value();
1347
+ });
1348
+ }
1298
1349
  }
1299
1350
  exports.EmailTemplateApi = EmailTemplateApi;
1351
+ /**
1352
+ * @export
1353
+ */
1354
+ exports.GetEmailDeliveryListStatusEnum = {
1355
+ Queued: 'queued',
1356
+ Processing: 'processing',
1357
+ Accepted: 'accepted',
1358
+ Delivered: 'delivered',
1359
+ Deferred: 'deferred',
1360
+ Failed: 'failed',
1361
+ Complained: 'complained'
1362
+ };
@@ -31,6 +31,10 @@ export interface DeleteSystemEmailTemplateDraftRequest {
31
31
  export interface GetEmailDeliveryListRequest {
32
32
  page?: number;
33
33
  pageSize?: number;
34
+ templateKey?: string;
35
+ status?: GetEmailDeliveryListStatusEnum;
36
+ recipient?: string;
37
+ isTest?: boolean;
34
38
  }
35
39
  export interface GetEmailTemplateRequest {
36
40
  templateKey: string;
@@ -125,6 +129,9 @@ export interface PutSystemEmailTemplateDraftRequest {
125
129
  templateKey: string;
126
130
  putEmailTemplateDraft: PutEmailTemplateDraft;
127
131
  }
132
+ export interface ResendEmailDeliveryRequest {
133
+ deliveryId: string;
134
+ }
128
135
  /**
129
136
  *
130
137
  */
@@ -501,4 +508,29 @@ export declare class EmailTemplateApi extends runtime.BaseAPI {
501
508
  * Update a platform email template draft
502
509
  */
503
510
  putSystemEmailTemplateDraft(requestParameters: PutSystemEmailTemplateDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailTemplateVersion>;
511
+ /**
512
+ * Creates request options for resendEmailDelivery without sending the request
513
+ */
514
+ resendEmailDeliveryRequestOpts(requestParameters: ResendEmailDeliveryRequest): Promise<runtime.RequestOpts>;
515
+ /**
516
+ * Regenerate and queue a portal email from its current business source
517
+ */
518
+ resendEmailDeliveryRaw(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailDelivery>>;
519
+ /**
520
+ * Regenerate and queue a portal email from its current business source
521
+ */
522
+ resendEmailDelivery(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailDelivery>;
504
523
  }
524
+ /**
525
+ * @export
526
+ */
527
+ export declare const GetEmailDeliveryListStatusEnum: {
528
+ readonly Queued: "queued";
529
+ readonly Processing: "processing";
530
+ readonly Accepted: "accepted";
531
+ readonly Delivered: "delivered";
532
+ readonly Deferred: "deferred";
533
+ readonly Failed: "failed";
534
+ readonly Complained: "complained";
535
+ };
536
+ export type GetEmailDeliveryListStatusEnum = typeof GetEmailDeliveryListStatusEnum[keyof typeof GetEmailDeliveryListStatusEnum];
@@ -125,6 +125,18 @@ export class EmailTemplateApi extends runtime.BaseAPI {
125
125
  if (requestParameters['pageSize'] != null) {
126
126
  queryParameters['pageSize'] = requestParameters['pageSize'];
127
127
  }
128
+ if (requestParameters['templateKey'] != null) {
129
+ queryParameters['templateKey'] = requestParameters['templateKey'];
130
+ }
131
+ if (requestParameters['status'] != null) {
132
+ queryParameters['status'] = requestParameters['status'];
133
+ }
134
+ if (requestParameters['recipient'] != null) {
135
+ queryParameters['recipient'] = requestParameters['recipient'];
136
+ }
137
+ if (requestParameters['isTest'] != null) {
138
+ queryParameters['isTest'] = requestParameters['isTest'];
139
+ }
128
140
  const headerParameters = {};
129
141
  let urlPath = `/email-deliveries`;
130
142
  return {
@@ -1292,4 +1304,55 @@ export class EmailTemplateApi extends runtime.BaseAPI {
1292
1304
  return yield response.value();
1293
1305
  });
1294
1306
  }
1307
+ /**
1308
+ * Creates request options for resendEmailDelivery without sending the request
1309
+ */
1310
+ resendEmailDeliveryRequestOpts(requestParameters) {
1311
+ return __awaiter(this, void 0, void 0, function* () {
1312
+ if (requestParameters['deliveryId'] == null) {
1313
+ throw new runtime.RequiredError('deliveryId', 'Required parameter "deliveryId" was null or undefined when calling resendEmailDelivery().');
1314
+ }
1315
+ const queryParameters = {};
1316
+ const headerParameters = {};
1317
+ let urlPath = `/email-deliveries/{deliveryId}/resend`;
1318
+ urlPath = urlPath.replace('{deliveryId}', encodeURIComponent(String(requestParameters['deliveryId'])));
1319
+ return {
1320
+ path: urlPath,
1321
+ method: 'POST',
1322
+ headers: headerParameters,
1323
+ query: queryParameters,
1324
+ };
1325
+ });
1326
+ }
1327
+ /**
1328
+ * Regenerate and queue a portal email from its current business source
1329
+ */
1330
+ resendEmailDeliveryRaw(requestParameters, initOverrides) {
1331
+ return __awaiter(this, void 0, void 0, function* () {
1332
+ const requestOptions = yield this.resendEmailDeliveryRequestOpts(requestParameters);
1333
+ const response = yield this.request(requestOptions, initOverrides);
1334
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEmailDeliveryFromJSON(jsonValue));
1335
+ });
1336
+ }
1337
+ /**
1338
+ * Regenerate and queue a portal email from its current business source
1339
+ */
1340
+ resendEmailDelivery(requestParameters, initOverrides) {
1341
+ return __awaiter(this, void 0, void 0, function* () {
1342
+ const response = yield this.resendEmailDeliveryRaw(requestParameters, initOverrides);
1343
+ return yield response.value();
1344
+ });
1345
+ }
1295
1346
  }
1347
+ /**
1348
+ * @export
1349
+ */
1350
+ export const GetEmailDeliveryListStatusEnum = {
1351
+ Queued: 'queued',
1352
+ Processing: 'processing',
1353
+ Accepted: 'accepted',
1354
+ Delivered: 'delivered',
1355
+ Deferred: 'deferred',
1356
+ Failed: 'failed',
1357
+ Complained: 'complained'
1358
+ };
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -39,6 +40,12 @@ export interface GetEmailDelivery {
39
40
  * @memberof GetEmailDelivery
40
41
  */
41
42
  recipient: string;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof GetEmailDelivery
47
+ */
48
+ subject?: string | null;
42
49
  /**
43
50
  *
44
51
  * @type {boolean}
@@ -99,6 +106,30 @@ export interface GetEmailDelivery {
99
106
  * @memberof GetEmailDelivery
100
107
  */
101
108
  failedAt?: number | null;
109
+ /**
110
+ *
111
+ * @type {string}
112
+ * @memberof GetEmailDelivery
113
+ */
114
+ resendOfDeliveryId?: string | null;
115
+ /**
116
+ *
117
+ * @type {boolean}
118
+ * @memberof GetEmailDelivery
119
+ */
120
+ canResend: boolean;
121
+ /**
122
+ *
123
+ * @type {string}
124
+ * @memberof GetEmailDelivery
125
+ */
126
+ resendBlockedReason?: string | null;
127
+ /**
128
+ *
129
+ * @type {GetPortalInvitationSummary}
130
+ * @memberof GetEmailDelivery
131
+ */
132
+ invitation?: GetPortalInvitationSummary | null;
102
133
  }
103
134
  /**
104
135
  * @export
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { GetPortalInvitationSummaryFromJSON, GetPortalInvitationSummaryToJSON, } from './GetPortalInvitationSummary';
14
15
  /**
15
16
  * @export
16
17
  */
@@ -41,6 +42,8 @@ export function instanceOfGetEmailDelivery(value) {
41
42
  return false;
42
43
  if (!('createdAt' in value) || value['createdAt'] === undefined)
43
44
  return false;
45
+ if (!('canResend' in value) || value['canResend'] === undefined)
46
+ return false;
44
47
  return true;
45
48
  }
46
49
  export function GetEmailDeliveryFromJSON(json) {
@@ -55,6 +58,7 @@ export function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
55
58
  'templateKey': json['template_key'],
56
59
  'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
57
60
  'recipient': json['recipient'],
61
+ 'subject': json['subject'] == null ? undefined : json['subject'],
58
62
  'isTest': json['is_test'],
59
63
  'status': json['status'],
60
64
  'attempts': json['attempts'],
@@ -65,6 +69,10 @@ export function GetEmailDeliveryFromJSONTyped(json, ignoreDiscriminator) {
65
69
  'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
66
70
  'deliveredAt': json['delivered_at'] == null ? undefined : json['delivered_at'],
67
71
  'failedAt': json['failed_at'] == null ? undefined : json['failed_at'],
72
+ 'resendOfDeliveryId': json['resend_of_delivery_id'] == null ? undefined : json['resend_of_delivery_id'],
73
+ 'canResend': json['can_resend'],
74
+ 'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
75
+ 'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
68
76
  };
69
77
  }
70
78
  export function GetEmailDeliveryToJSON(json) {
@@ -79,6 +87,7 @@ export function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false)
79
87
  'template_key': value['templateKey'],
80
88
  'template_version_id': value['templateVersionId'],
81
89
  'recipient': value['recipient'],
90
+ 'subject': value['subject'],
82
91
  'is_test': value['isTest'],
83
92
  'status': value['status'],
84
93
  'attempts': value['attempts'],
@@ -89,5 +98,9 @@ export function GetEmailDeliveryToJSONTyped(value, ignoreDiscriminator = false)
89
98
  'accepted_at': value['acceptedAt'],
90
99
  'delivered_at': value['deliveredAt'],
91
100
  'failed_at': value['failedAt'],
101
+ 'resend_of_delivery_id': value['resendOfDeliveryId'],
102
+ 'can_resend': value['canResend'],
103
+ 'resend_blocked_reason': value['resendBlockedReason'],
104
+ 'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
92
105
  };
93
106
  }
@@ -0,0 +1,102 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Invitation lifecycle and latest email delivery state for a portal user.
14
+ * @export
15
+ * @interface GetPortalInvitationSummary
16
+ */
17
+ export interface GetPortalInvitationSummary {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetPortalInvitationSummary
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {GetPortalInvitationSummaryStatusEnum}
27
+ * @memberof GetPortalInvitationSummary
28
+ */
29
+ status: GetPortalInvitationSummaryStatusEnum;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof GetPortalInvitationSummary
34
+ */
35
+ invitedAt: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof GetPortalInvitationSummary
40
+ */
41
+ expiresAt: number;
42
+ /**
43
+ *
44
+ * @type {number}
45
+ * @memberof GetPortalInvitationSummary
46
+ */
47
+ acceptedAt?: number | null;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof GetPortalInvitationSummary
52
+ */
53
+ lastSentAt?: number | null;
54
+ /**
55
+ *
56
+ * @type {GetPortalInvitationSummaryLatestDeliveryStatusEnum}
57
+ * @memberof GetPortalInvitationSummary
58
+ */
59
+ latestDeliveryStatus?: GetPortalInvitationSummaryLatestDeliveryStatusEnum | null;
60
+ /**
61
+ *
62
+ * @type {boolean}
63
+ * @memberof GetPortalInvitationSummary
64
+ */
65
+ canResend: boolean;
66
+ /**
67
+ *
68
+ * @type {string}
69
+ * @memberof GetPortalInvitationSummary
70
+ */
71
+ resendBlockedReason?: string | null;
72
+ }
73
+ /**
74
+ * @export
75
+ */
76
+ export declare const GetPortalInvitationSummaryStatusEnum: {
77
+ readonly Pending: "pending";
78
+ readonly Expired: "expired";
79
+ readonly Accepted: "accepted";
80
+ };
81
+ export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
82
+ /**
83
+ * @export
84
+ */
85
+ export declare const GetPortalInvitationSummaryLatestDeliveryStatusEnum: {
86
+ readonly Queued: "queued";
87
+ readonly Processing: "processing";
88
+ readonly Accepted: "accepted";
89
+ readonly Delivered: "delivered";
90
+ readonly Deferred: "deferred";
91
+ readonly Failed: "failed";
92
+ readonly Complained: "complained";
93
+ };
94
+ export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
95
+ /**
96
+ * Check if a given object implements the GetPortalInvitationSummary interface.
97
+ */
98
+ export declare function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary;
99
+ export declare function GetPortalInvitationSummaryFromJSON(json: any): GetPortalInvitationSummary;
100
+ export declare function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary;
101
+ export declare function GetPortalInvitationSummaryToJSON(json: any): GetPortalInvitationSummary;
102
+ export declare function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,87 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * @export
16
+ */
17
+ export const GetPortalInvitationSummaryStatusEnum = {
18
+ Pending: 'pending',
19
+ Expired: 'expired',
20
+ Accepted: 'accepted'
21
+ };
22
+ /**
23
+ * @export
24
+ */
25
+ export const GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
26
+ Queued: 'queued',
27
+ Processing: 'processing',
28
+ Accepted: 'accepted',
29
+ Delivered: 'delivered',
30
+ Deferred: 'deferred',
31
+ Failed: 'failed',
32
+ Complained: 'complained'
33
+ };
34
+ /**
35
+ * Check if a given object implements the GetPortalInvitationSummary interface.
36
+ */
37
+ export function instanceOfGetPortalInvitationSummary(value) {
38
+ if (!('id' in value) || value['id'] === undefined)
39
+ return false;
40
+ if (!('status' in value) || value['status'] === undefined)
41
+ return false;
42
+ if (!('invitedAt' in value) || value['invitedAt'] === undefined)
43
+ return false;
44
+ if (!('expiresAt' in value) || value['expiresAt'] === undefined)
45
+ return false;
46
+ if (!('canResend' in value) || value['canResend'] === undefined)
47
+ return false;
48
+ return true;
49
+ }
50
+ export function GetPortalInvitationSummaryFromJSON(json) {
51
+ return GetPortalInvitationSummaryFromJSONTyped(json, false);
52
+ }
53
+ export function GetPortalInvitationSummaryFromJSONTyped(json, ignoreDiscriminator) {
54
+ if (json == null) {
55
+ return json;
56
+ }
57
+ return {
58
+ 'id': json['id'],
59
+ 'status': json['status'],
60
+ 'invitedAt': json['invited_at'],
61
+ 'expiresAt': json['expires_at'],
62
+ 'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
63
+ 'lastSentAt': json['last_sent_at'] == null ? undefined : json['last_sent_at'],
64
+ 'latestDeliveryStatus': json['latest_delivery_status'] == null ? undefined : json['latest_delivery_status'],
65
+ 'canResend': json['can_resend'],
66
+ 'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
67
+ };
68
+ }
69
+ export function GetPortalInvitationSummaryToJSON(json) {
70
+ return GetPortalInvitationSummaryToJSONTyped(json, false);
71
+ }
72
+ export function GetPortalInvitationSummaryToJSONTyped(value, ignoreDiscriminator = false) {
73
+ if (value == null) {
74
+ return value;
75
+ }
76
+ return {
77
+ 'id': value['id'],
78
+ 'status': value['status'],
79
+ 'invited_at': value['invitedAt'],
80
+ 'expires_at': value['expiresAt'],
81
+ 'accepted_at': value['acceptedAt'],
82
+ 'last_sent_at': value['lastSentAt'],
83
+ 'latest_delivery_status': value['latestDeliveryStatus'],
84
+ 'can_resend': value['canResend'],
85
+ 'resend_blocked_reason': value['resendBlockedReason'],
86
+ };
87
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
12
13
  /**
13
14
  * A user with their portal access information
14
15
  * @export
@@ -51,6 +52,12 @@ export interface GetPortalUser {
51
52
  * @memberof GetPortalUser
52
53
  */
53
54
  isActive: boolean;
55
+ /**
56
+ *
57
+ * @type {GetPortalInvitationSummary}
58
+ * @memberof GetPortalUser
59
+ */
60
+ invitation?: GetPortalInvitationSummary | null;
54
61
  }
55
62
  /**
56
63
  * Check if a given object implements the GetPortalUser interface.
@@ -11,6 +11,7 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
+ import { GetPortalInvitationSummaryFromJSON, GetPortalInvitationSummaryToJSON, } from './GetPortalInvitationSummary';
14
15
  /**
15
16
  * Check if a given object implements the GetPortalUser interface.
16
17
  */
@@ -43,6 +44,7 @@ export function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
43
44
  'lastName': json['last_name'],
44
45
  'role': json['role'],
45
46
  'isActive': json['is_active'],
47
+ 'invitation': json['invitation'] == null ? undefined : GetPortalInvitationSummaryFromJSON(json['invitation']),
46
48
  };
47
49
  }
48
50
  export function GetPortalUserToJSON(json) {
@@ -59,5 +61,6 @@ export function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
59
61
  'last_name': value['lastName'],
60
62
  'role': value['role'],
61
63
  'is_active': value['isActive'],
64
+ 'invitation': GetPortalInvitationSummaryToJSON(value['invitation']),
62
65
  };
63
66
  }
@@ -94,6 +94,7 @@ export * from './GetLibraryQuizVersion';
94
94
  export * from './GetPermission';
95
95
  export * from './GetPortal';
96
96
  export * from './GetPortalFaviconUpload';
97
+ export * from './GetPortalInvitationSummary';
97
98
  export * from './GetPortalList';
98
99
  export * from './GetPortalLogoUpload';
99
100
  export * from './GetPortalUser';
@@ -96,6 +96,7 @@ export * from './GetLibraryQuizVersion';
96
96
  export * from './GetPermission';
97
97
  export * from './GetPortal';
98
98
  export * from './GetPortalFaviconUpload';
99
+ export * from './GetPortalInvitationSummary';
99
100
  export * from './GetPortalList';
100
101
  export * from './GetPortalLogoUpload';
101
102
  export * from './GetPortalUser';