@easyedu/js-lsm-api 1.104.0 → 1.106.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.
- package/.openapi-generator/FILES +8 -0
- package/README.md +8 -3
- package/dist/apis/EmailTemplateApi.d.ts +32 -0
- package/dist/apis/EmailTemplateApi.js +64 -1
- package/dist/apis/PortalApi.d.ts +2 -2
- package/dist/apis/PortalApi.js +2 -2
- package/dist/esm/apis/EmailTemplateApi.d.ts +32 -0
- package/dist/esm/apis/EmailTemplateApi.js +63 -0
- package/dist/esm/apis/PortalApi.d.ts +2 -2
- package/dist/esm/apis/PortalApi.js +2 -2
- package/dist/esm/models/GetEmailDelivery.d.ts +31 -0
- package/dist/esm/models/GetEmailDelivery.js +13 -0
- package/dist/esm/models/GetPortal.d.ts +11 -2
- package/dist/esm/models/GetPortal.js +5 -0
- package/dist/esm/models/GetPortalInvitationSummary.d.ts +102 -0
- package/dist/esm/models/GetPortalInvitationSummary.js +87 -0
- package/dist/esm/models/GetPortalUser.d.ts +7 -0
- package/dist/esm/models/GetPortalUser.js +3 -0
- package/dist/esm/models/GetPublicPortalBranding.d.ts +11 -2
- package/dist/esm/models/GetPublicPortalBranding.js +5 -0
- package/dist/esm/models/PortalBrandColorsV1.d.ts +194 -0
- package/dist/esm/models/PortalBrandColorsV1.js +151 -0
- package/dist/esm/models/PortalBrandThemeV1.d.ts +53 -0
- package/dist/esm/models/PortalBrandThemeV1.js +59 -0
- package/dist/esm/models/PortalBrandTypographyV1.d.ts +80 -0
- package/dist/esm/models/PortalBrandTypographyV1.js +78 -0
- package/dist/esm/models/PostPortal.d.ts +9 -0
- package/dist/esm/models/PostPortal.js +3 -0
- package/dist/esm/models/PutPortalBranding.d.ts +9 -0
- package/dist/esm/models/PutPortalBranding.js +3 -0
- package/dist/esm/models/index.d.ts +4 -0
- package/dist/esm/models/index.js +4 -0
- package/dist/models/GetEmailDelivery.d.ts +31 -0
- package/dist/models/GetEmailDelivery.js +13 -0
- package/dist/models/GetPortal.d.ts +11 -2
- package/dist/models/GetPortal.js +5 -0
- package/dist/models/GetPortalInvitationSummary.d.ts +102 -0
- package/dist/models/GetPortalInvitationSummary.js +95 -0
- package/dist/models/GetPortalUser.d.ts +7 -0
- package/dist/models/GetPortalUser.js +3 -0
- package/dist/models/GetPublicPortalBranding.d.ts +11 -2
- package/dist/models/GetPublicPortalBranding.js +5 -0
- package/dist/models/PortalBrandColorsV1.d.ts +194 -0
- package/dist/models/PortalBrandColorsV1.js +158 -0
- package/dist/models/PortalBrandThemeV1.d.ts +53 -0
- package/dist/models/PortalBrandThemeV1.js +67 -0
- package/dist/models/PortalBrandTypographyV1.d.ts +80 -0
- package/dist/models/PortalBrandTypographyV1.js +86 -0
- package/dist/models/PostPortal.d.ts +9 -0
- package/dist/models/PostPortal.js +3 -0
- package/dist/models/PutPortalBranding.d.ts +9 -0
- package/dist/models/PutPortalBranding.js +3 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/docs/EmailTemplateApi.md +82 -1
- package/docs/GetEmailDelivery.md +10 -0
- package/docs/GetPortal.md +2 -0
- package/docs/GetPortalInvitationSummary.md +51 -0
- package/docs/GetPortalUser.md +2 -0
- package/docs/GetPublicPortalBranding.md +2 -0
- package/docs/PortalApi.md +2 -2
- package/docs/PortalBrandColorsV1.md +89 -0
- package/docs/PortalBrandThemeV1.md +39 -0
- package/docs/PortalBrandTypographyV1.md +47 -0
- package/docs/PostPortal.md +2 -0
- package/docs/PutPortalBranding.md +2 -0
- package/package.json +1 -1
- package/src/apis/EmailTemplateApi.ts +83 -0
- package/src/apis/PortalApi.ts +2 -2
- package/src/models/GetEmailDelivery.ts +49 -0
- package/src/models/GetPortal.ts +21 -2
- package/src/models/GetPortalInvitationSummary.ts +160 -0
- package/src/models/GetPortalUser.ts +16 -0
- package/src/models/GetPublicPortalBranding.ts +21 -2
- package/src/models/PortalBrandColorsV1.ts +309 -0
- package/src/models/PortalBrandThemeV1.ts +109 -0
- package/src/models/PortalBrandTypographyV1.ts +135 -0
- package/src/models/PostPortal.ts +18 -0
- package/src/models/PutPortalBranding.ts +18 -0
- package/src/models/index.ts +4 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -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
|
|
@@ -174,6 +175,9 @@ docs/OtherApi.md
|
|
|
174
175
|
docs/Paginated.md
|
|
175
176
|
docs/PlayerApi.md
|
|
176
177
|
docs/PortalApi.md
|
|
178
|
+
docs/PortalBrandColorsV1.md
|
|
179
|
+
docs/PortalBrandThemeV1.md
|
|
180
|
+
docs/PortalBrandTypographyV1.md
|
|
177
181
|
docs/PortalSublicense.md
|
|
178
182
|
docs/PortalSublicenseApi.md
|
|
179
183
|
docs/PortalUserFieldConfig.md
|
|
@@ -420,6 +424,7 @@ src/models/GetLibraryQuizVersion.ts
|
|
|
420
424
|
src/models/GetPermission.ts
|
|
421
425
|
src/models/GetPortal.ts
|
|
422
426
|
src/models/GetPortalFaviconUpload.ts
|
|
427
|
+
src/models/GetPortalInvitationSummary.ts
|
|
423
428
|
src/models/GetPortalList.ts
|
|
424
429
|
src/models/GetPortalLogoUpload.ts
|
|
425
430
|
src/models/GetPortalUser.ts
|
|
@@ -482,6 +487,9 @@ src/models/LoginResAuthData.ts
|
|
|
482
487
|
src/models/LoginResUserData.ts
|
|
483
488
|
src/models/LoginResUserDataSelectedPortal.ts
|
|
484
489
|
src/models/Paginated.ts
|
|
490
|
+
src/models/PortalBrandColorsV1.ts
|
|
491
|
+
src/models/PortalBrandThemeV1.ts
|
|
492
|
+
src/models/PortalBrandTypographyV1.ts
|
|
485
493
|
src/models/PortalSublicense.ts
|
|
486
494
|
src/models/PortalUserFieldConfig.ts
|
|
487
495
|
src/models/PortalUserFieldDefinition.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.106.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
|
|
@@ -298,7 +299,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
298
299
|
*PortalApi* | [**postPortal**](docs/PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal
|
|
299
300
|
*PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
|
|
300
301
|
*PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
|
|
301
|
-
*PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding
|
|
302
|
+
*PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding and complete application theme
|
|
302
303
|
*PortalApi* | [**putPortalUserFieldConfig**](docs/PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration
|
|
303
304
|
*PortalApi* | [**putPortalUserFieldValues**](docs/PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values
|
|
304
305
|
*PortalApi* | [**removePortalUser**](docs/PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal
|
|
@@ -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)
|
|
@@ -515,6 +517,9 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
515
517
|
- [LoginResUserData](docs/LoginResUserData.md)
|
|
516
518
|
- [LoginResUserDataSelectedPortal](docs/LoginResUserDataSelectedPortal.md)
|
|
517
519
|
- [Paginated](docs/Paginated.md)
|
|
520
|
+
- [PortalBrandColorsV1](docs/PortalBrandColorsV1.md)
|
|
521
|
+
- [PortalBrandThemeV1](docs/PortalBrandThemeV1.md)
|
|
522
|
+
- [PortalBrandTypographyV1](docs/PortalBrandTypographyV1.md)
|
|
518
523
|
- [PortalSublicense](docs/PortalSublicense.md)
|
|
519
524
|
- [PortalUserFieldConfig](docs/PortalUserFieldConfig.md)
|
|
520
525
|
- [PortalUserFieldDefinition](docs/PortalUserFieldDefinition.md)
|
|
@@ -645,7 +650,7 @@ and is automatically generated by the
|
|
|
645
650
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
646
651
|
|
|
647
652
|
- API version: `1.0.0`
|
|
648
|
-
- Package version: `1.
|
|
653
|
+
- Package version: `1.106.0`
|
|
649
654
|
- Generator version: `7.22.0`
|
|
650
655
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
651
656
|
|
|
@@ -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
|
+
};
|
package/dist/apis/PortalApi.d.ts
CHANGED
|
@@ -295,11 +295,11 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
295
295
|
*/
|
|
296
296
|
putPortalBrandingRequestOpts(requestParameters: PutPortalBrandingRequest): Promise<runtime.RequestOpts>;
|
|
297
297
|
/**
|
|
298
|
-
* Update portal branding
|
|
298
|
+
* Update portal branding and complete application theme
|
|
299
299
|
*/
|
|
300
300
|
putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
|
|
301
301
|
/**
|
|
302
|
-
* Update portal branding
|
|
302
|
+
* Update portal branding and complete application theme
|
|
303
303
|
*/
|
|
304
304
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
305
305
|
/**
|
package/dist/apis/PortalApi.js
CHANGED
|
@@ -747,7 +747,7 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
747
747
|
});
|
|
748
748
|
}
|
|
749
749
|
/**
|
|
750
|
-
* Update portal branding
|
|
750
|
+
* Update portal branding and complete application theme
|
|
751
751
|
*/
|
|
752
752
|
putPortalBrandingRaw(requestParameters, initOverrides) {
|
|
753
753
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -757,7 +757,7 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
757
757
|
});
|
|
758
758
|
}
|
|
759
759
|
/**
|
|
760
|
-
* Update portal branding
|
|
760
|
+
* Update portal branding and complete application theme
|
|
761
761
|
*/
|
|
762
762
|
putPortalBranding(requestParameters, initOverrides) {
|
|
763
763
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -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
|
+
};
|
|
@@ -295,11 +295,11 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
295
295
|
*/
|
|
296
296
|
putPortalBrandingRequestOpts(requestParameters: PutPortalBrandingRequest): Promise<runtime.RequestOpts>;
|
|
297
297
|
/**
|
|
298
|
-
* Update portal branding
|
|
298
|
+
* Update portal branding and complete application theme
|
|
299
299
|
*/
|
|
300
300
|
putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
|
|
301
301
|
/**
|
|
302
|
-
* Update portal branding
|
|
302
|
+
* Update portal branding and complete application theme
|
|
303
303
|
*/
|
|
304
304
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
305
305
|
/**
|
|
@@ -744,7 +744,7 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
744
744
|
});
|
|
745
745
|
}
|
|
746
746
|
/**
|
|
747
|
-
* Update portal branding
|
|
747
|
+
* Update portal branding and complete application theme
|
|
748
748
|
*/
|
|
749
749
|
putPortalBrandingRaw(requestParameters, initOverrides) {
|
|
750
750
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -754,7 +754,7 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
754
754
|
});
|
|
755
755
|
}
|
|
756
756
|
/**
|
|
757
|
-
* Update portal branding
|
|
757
|
+
* Update portal branding and complete application theme
|
|
758
758
|
*/
|
|
759
759
|
putPortalBranding(requestParameters, initOverrides) {
|
|
760
760
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -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
|
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -58,17 +59,25 @@ export interface GetPortal {
|
|
|
58
59
|
*/
|
|
59
60
|
faviconUrl?: string | null;
|
|
60
61
|
/**
|
|
61
|
-
*
|
|
62
|
+
* Deprecated compatibility alias for branding_theme.colors.header_background.
|
|
62
63
|
* @type {string}
|
|
63
64
|
* @memberof GetPortal
|
|
65
|
+
* @deprecated
|
|
64
66
|
*/
|
|
65
67
|
headerBackgroundColor: string;
|
|
66
68
|
/**
|
|
67
|
-
*
|
|
69
|
+
* Deprecated compatibility alias for branding_theme.colors.header_foreground.
|
|
68
70
|
* @type {string}
|
|
69
71
|
* @memberof GetPortal
|
|
72
|
+
* @deprecated
|
|
70
73
|
*/
|
|
71
74
|
headerTextColor: string;
|
|
75
|
+
/**
|
|
76
|
+
*
|
|
77
|
+
* @type {PortalBrandThemeV1}
|
|
78
|
+
* @memberof GetPortal
|
|
79
|
+
*/
|
|
80
|
+
brandingTheme: PortalBrandThemeV1;
|
|
72
81
|
/**
|
|
73
82
|
* The user's highest-privilege role base type for this portal
|
|
74
83
|
* @type {GetPortalBaseTypeEnum}
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { PortalBrandThemeV1FromJSON, PortalBrandThemeV1ToJSON, } from './PortalBrandThemeV1';
|
|
14
15
|
/**
|
|
15
16
|
* @export
|
|
16
17
|
*/
|
|
@@ -35,6 +36,8 @@ export function instanceOfGetPortal(value) {
|
|
|
35
36
|
return false;
|
|
36
37
|
if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
|
|
37
38
|
return false;
|
|
39
|
+
if (!('brandingTheme' in value) || value['brandingTheme'] === undefined)
|
|
40
|
+
return false;
|
|
38
41
|
return true;
|
|
39
42
|
}
|
|
40
43
|
export function GetPortalFromJSON(json) {
|
|
@@ -54,6 +57,7 @@ export function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
54
57
|
'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
|
|
55
58
|
'headerBackgroundColor': json['header_background_color'],
|
|
56
59
|
'headerTextColor': json['header_text_color'],
|
|
60
|
+
'brandingTheme': PortalBrandThemeV1FromJSON(json['branding_theme']),
|
|
57
61
|
'baseType': json['base_type'] == null ? undefined : json['base_type'],
|
|
58
62
|
};
|
|
59
63
|
}
|
|
@@ -74,6 +78,7 @@ export function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
74
78
|
'favicon_url': value['faviconUrl'],
|
|
75
79
|
'header_background_color': value['headerBackgroundColor'],
|
|
76
80
|
'header_text_color': value['headerTextColor'],
|
|
81
|
+
'branding_theme': PortalBrandThemeV1ToJSON(value['brandingTheme']),
|
|
77
82
|
'base_type': value['baseType'],
|
|
78
83
|
};
|
|
79
84
|
}
|