@easyedu/js-lsm-api 1.117.0 → 1.118.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 +4 -0
- package/README.md +4 -2
- package/dist/apis/IntegrationApi.d.ts +2 -0
- package/dist/apis/IntegrationApi.js +3 -1
- package/dist/esm/apis/IntegrationApi.d.ts +2 -0
- package/dist/esm/apis/IntegrationApi.js +3 -1
- package/dist/esm/models/CustomWebhookIntegration.d.ts +2 -0
- package/dist/esm/models/CustomWebhookIntegration.js +3 -1
- package/dist/esm/models/IntegrationEvent.d.ts +2 -0
- package/dist/esm/models/IntegrationEvent.js +3 -1
- package/dist/esm/models/IntegrationEventData.d.ts +16 -2
- package/dist/esm/models/IntegrationEventData.js +10 -0
- package/dist/esm/models/IntegrationEventInvitation.d.ts +71 -0
- package/dist/esm/models/IntegrationEventInvitation.js +71 -0
- package/dist/esm/models/IntegrationEventUser.d.ts +50 -0
- package/dist/esm/models/IntegrationEventUser.js +55 -0
- package/dist/esm/models/PostCustomWebhookIntegration.d.ts +2 -0
- package/dist/esm/models/PostCustomWebhookIntegration.js +3 -1
- package/dist/esm/models/PostZapierSubscription.d.ts +2 -0
- package/dist/esm/models/PostZapierSubscription.js +3 -1
- package/dist/esm/models/PutCustomWebhookIntegration.d.ts +2 -0
- package/dist/esm/models/PutCustomWebhookIntegration.js +3 -1
- package/dist/esm/models/ZapierSubscription.d.ts +2 -0
- package/dist/esm/models/ZapierSubscription.js +3 -1
- package/dist/esm/models/index.d.ts +2 -0
- package/dist/esm/models/index.js +2 -0
- package/dist/models/CustomWebhookIntegration.d.ts +2 -0
- package/dist/models/CustomWebhookIntegration.js +3 -1
- package/dist/models/IntegrationEvent.d.ts +2 -0
- package/dist/models/IntegrationEvent.js +3 -1
- package/dist/models/IntegrationEventData.d.ts +16 -2
- package/dist/models/IntegrationEventData.js +10 -0
- package/dist/models/IntegrationEventInvitation.d.ts +71 -0
- package/dist/models/IntegrationEventInvitation.js +79 -0
- package/dist/models/IntegrationEventUser.d.ts +50 -0
- package/dist/models/IntegrationEventUser.js +62 -0
- package/dist/models/PostCustomWebhookIntegration.d.ts +2 -0
- package/dist/models/PostCustomWebhookIntegration.js +3 -1
- package/dist/models/PostZapierSubscription.d.ts +2 -0
- package/dist/models/PostZapierSubscription.js +3 -1
- package/dist/models/PutCustomWebhookIntegration.d.ts +2 -0
- package/dist/models/PutCustomWebhookIntegration.js +3 -1
- package/dist/models/ZapierSubscription.d.ts +2 -0
- package/dist/models/ZapierSubscription.js +3 -1
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/IntegrationApi.md +2 -2
- package/docs/IntegrationEventData.md +4 -0
- package/docs/IntegrationEventInvitation.md +45 -0
- package/docs/IntegrationEventUser.md +41 -0
- package/package.json +1 -1
- package/src/apis/IntegrationApi.ts +3 -1
- package/src/models/CustomWebhookIntegration.ts +3 -1
- package/src/models/IntegrationEvent.ts +3 -1
- package/src/models/IntegrationEventData.ts +34 -2
- package/src/models/IntegrationEventInvitation.ts +130 -0
- package/src/models/IntegrationEventUser.ts +93 -0
- package/src/models/PostCustomWebhookIntegration.ts +3 -1
- package/src/models/PostZapierSubscription.ts +3 -1
- package/src/models/PutCustomWebhookIntegration.ts +3 -1
- package/src/models/ZapierSubscription.ts +3 -1
- package/src/models/index.ts +2 -0
|
@@ -9,11 +9,13 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { IntegrationEventUser } from './IntegrationEventUser';
|
|
12
13
|
import type { IntegrationEventLearner } from './IntegrationEventLearner';
|
|
13
14
|
import type { IntegrationEventCertificate } from './IntegrationEventCertificate';
|
|
14
15
|
import type { IntegrationEventEnrollment } from './IntegrationEventEnrollment';
|
|
15
16
|
import type { IntegrationEventPortal } from './IntegrationEventPortal';
|
|
16
17
|
import type { IntegrationEventCourse } from './IntegrationEventCourse';
|
|
18
|
+
import type { IntegrationEventInvitation } from './IntegrationEventInvitation';
|
|
17
19
|
/**
|
|
18
20
|
*
|
|
19
21
|
* @export
|
|
@@ -31,13 +33,19 @@ export interface IntegrationEventData {
|
|
|
31
33
|
* @type {IntegrationEventLearner}
|
|
32
34
|
* @memberof IntegrationEventData
|
|
33
35
|
*/
|
|
34
|
-
learner: IntegrationEventLearner;
|
|
36
|
+
learner: IntegrationEventLearner | null;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {IntegrationEventUser}
|
|
40
|
+
* @memberof IntegrationEventData
|
|
41
|
+
*/
|
|
42
|
+
user: IntegrationEventUser | null;
|
|
35
43
|
/**
|
|
36
44
|
*
|
|
37
45
|
* @type {IntegrationEventCourse}
|
|
38
46
|
* @memberof IntegrationEventData
|
|
39
47
|
*/
|
|
40
|
-
course: IntegrationEventCourse;
|
|
48
|
+
course: IntegrationEventCourse | null;
|
|
41
49
|
/**
|
|
42
50
|
*
|
|
43
51
|
* @type {IntegrationEventEnrollment}
|
|
@@ -50,6 +58,12 @@ export interface IntegrationEventData {
|
|
|
50
58
|
* @memberof IntegrationEventData
|
|
51
59
|
*/
|
|
52
60
|
certificate: IntegrationEventCertificate | null;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @type {IntegrationEventInvitation}
|
|
64
|
+
* @memberof IntegrationEventData
|
|
65
|
+
*/
|
|
66
|
+
invitation: IntegrationEventInvitation | null;
|
|
53
67
|
}
|
|
54
68
|
/**
|
|
55
69
|
* Check if a given object implements the IntegrationEventData interface.
|
|
@@ -18,11 +18,13 @@ exports.IntegrationEventDataFromJSON = IntegrationEventDataFromJSON;
|
|
|
18
18
|
exports.IntegrationEventDataFromJSONTyped = IntegrationEventDataFromJSONTyped;
|
|
19
19
|
exports.IntegrationEventDataToJSON = IntegrationEventDataToJSON;
|
|
20
20
|
exports.IntegrationEventDataToJSONTyped = IntegrationEventDataToJSONTyped;
|
|
21
|
+
const IntegrationEventUser_1 = require("./IntegrationEventUser");
|
|
21
22
|
const IntegrationEventLearner_1 = require("./IntegrationEventLearner");
|
|
22
23
|
const IntegrationEventCertificate_1 = require("./IntegrationEventCertificate");
|
|
23
24
|
const IntegrationEventEnrollment_1 = require("./IntegrationEventEnrollment");
|
|
24
25
|
const IntegrationEventPortal_1 = require("./IntegrationEventPortal");
|
|
25
26
|
const IntegrationEventCourse_1 = require("./IntegrationEventCourse");
|
|
27
|
+
const IntegrationEventInvitation_1 = require("./IntegrationEventInvitation");
|
|
26
28
|
/**
|
|
27
29
|
* Check if a given object implements the IntegrationEventData interface.
|
|
28
30
|
*/
|
|
@@ -31,12 +33,16 @@ function instanceOfIntegrationEventData(value) {
|
|
|
31
33
|
return false;
|
|
32
34
|
if (!('learner' in value) || value['learner'] === undefined)
|
|
33
35
|
return false;
|
|
36
|
+
if (!('user' in value) || value['user'] === undefined)
|
|
37
|
+
return false;
|
|
34
38
|
if (!('course' in value) || value['course'] === undefined)
|
|
35
39
|
return false;
|
|
36
40
|
if (!('enrollment' in value) || value['enrollment'] === undefined)
|
|
37
41
|
return false;
|
|
38
42
|
if (!('certificate' in value) || value['certificate'] === undefined)
|
|
39
43
|
return false;
|
|
44
|
+
if (!('invitation' in value) || value['invitation'] === undefined)
|
|
45
|
+
return false;
|
|
40
46
|
return true;
|
|
41
47
|
}
|
|
42
48
|
function IntegrationEventDataFromJSON(json) {
|
|
@@ -49,9 +55,11 @@ function IntegrationEventDataFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
49
55
|
return {
|
|
50
56
|
'portal': (0, IntegrationEventPortal_1.IntegrationEventPortalFromJSON)(json['portal']),
|
|
51
57
|
'learner': (0, IntegrationEventLearner_1.IntegrationEventLearnerFromJSON)(json['learner']),
|
|
58
|
+
'user': (0, IntegrationEventUser_1.IntegrationEventUserFromJSON)(json['user']),
|
|
52
59
|
'course': (0, IntegrationEventCourse_1.IntegrationEventCourseFromJSON)(json['course']),
|
|
53
60
|
'enrollment': (0, IntegrationEventEnrollment_1.IntegrationEventEnrollmentFromJSON)(json['enrollment']),
|
|
54
61
|
'certificate': (0, IntegrationEventCertificate_1.IntegrationEventCertificateFromJSON)(json['certificate']),
|
|
62
|
+
'invitation': (0, IntegrationEventInvitation_1.IntegrationEventInvitationFromJSON)(json['invitation']),
|
|
55
63
|
};
|
|
56
64
|
}
|
|
57
65
|
function IntegrationEventDataToJSON(json) {
|
|
@@ -64,8 +72,10 @@ function IntegrationEventDataToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
64
72
|
return {
|
|
65
73
|
'portal': (0, IntegrationEventPortal_1.IntegrationEventPortalToJSON)(value['portal']),
|
|
66
74
|
'learner': (0, IntegrationEventLearner_1.IntegrationEventLearnerToJSON)(value['learner']),
|
|
75
|
+
'user': (0, IntegrationEventUser_1.IntegrationEventUserToJSON)(value['user']),
|
|
67
76
|
'course': (0, IntegrationEventCourse_1.IntegrationEventCourseToJSON)(value['course']),
|
|
68
77
|
'enrollment': (0, IntegrationEventEnrollment_1.IntegrationEventEnrollmentToJSON)(value['enrollment']),
|
|
69
78
|
'certificate': (0, IntegrationEventCertificate_1.IntegrationEventCertificateToJSON)(value['certificate']),
|
|
79
|
+
'invitation': (0, IntegrationEventInvitation_1.IntegrationEventInvitationToJSON)(value['invitation']),
|
|
70
80
|
};
|
|
71
81
|
}
|
|
@@ -0,0 +1,71 @@
|
|
|
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
|
+
import type { IntegrationEventUser } from './IntegrationEventUser';
|
|
13
|
+
/**
|
|
14
|
+
* Portal invitation lifecycle details for the affected user.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface IntegrationEventInvitation
|
|
17
|
+
*/
|
|
18
|
+
export interface IntegrationEventInvitation {
|
|
19
|
+
/**
|
|
20
|
+
* Stable invitation ID.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof IntegrationEventInvitation
|
|
23
|
+
*/
|
|
24
|
+
id: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {IntegrationEventInvitationStatusEnum}
|
|
28
|
+
* @memberof IntegrationEventInvitation
|
|
29
|
+
*/
|
|
30
|
+
status: IntegrationEventInvitationStatusEnum;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {Date}
|
|
34
|
+
* @memberof IntegrationEventInvitation
|
|
35
|
+
*/
|
|
36
|
+
invitedAt: Date;
|
|
37
|
+
/**
|
|
38
|
+
*
|
|
39
|
+
* @type {Date}
|
|
40
|
+
* @memberof IntegrationEventInvitation
|
|
41
|
+
*/
|
|
42
|
+
expiresAt: Date;
|
|
43
|
+
/**
|
|
44
|
+
*
|
|
45
|
+
* @type {Date}
|
|
46
|
+
* @memberof IntegrationEventInvitation
|
|
47
|
+
*/
|
|
48
|
+
acceptedAt: Date | null;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {IntegrationEventUser}
|
|
52
|
+
* @memberof IntegrationEventInvitation
|
|
53
|
+
*/
|
|
54
|
+
invitedBy: IntegrationEventUser | null;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @export
|
|
58
|
+
*/
|
|
59
|
+
export declare const IntegrationEventInvitationStatusEnum: {
|
|
60
|
+
readonly Pending: "pending";
|
|
61
|
+
readonly Accepted: "accepted";
|
|
62
|
+
};
|
|
63
|
+
export type IntegrationEventInvitationStatusEnum = typeof IntegrationEventInvitationStatusEnum[keyof typeof IntegrationEventInvitationStatusEnum];
|
|
64
|
+
/**
|
|
65
|
+
* Check if a given object implements the IntegrationEventInvitation interface.
|
|
66
|
+
*/
|
|
67
|
+
export declare function instanceOfIntegrationEventInvitation(value: object): value is IntegrationEventInvitation;
|
|
68
|
+
export declare function IntegrationEventInvitationFromJSON(json: any): IntegrationEventInvitation;
|
|
69
|
+
export declare function IntegrationEventInvitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventInvitation;
|
|
70
|
+
export declare function IntegrationEventInvitationToJSON(json: any): IntegrationEventInvitation;
|
|
71
|
+
export declare function IntegrationEventInvitationToJSONTyped(value?: IntegrationEventInvitation | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.IntegrationEventInvitationStatusEnum = void 0;
|
|
17
|
+
exports.instanceOfIntegrationEventInvitation = instanceOfIntegrationEventInvitation;
|
|
18
|
+
exports.IntegrationEventInvitationFromJSON = IntegrationEventInvitationFromJSON;
|
|
19
|
+
exports.IntegrationEventInvitationFromJSONTyped = IntegrationEventInvitationFromJSONTyped;
|
|
20
|
+
exports.IntegrationEventInvitationToJSON = IntegrationEventInvitationToJSON;
|
|
21
|
+
exports.IntegrationEventInvitationToJSONTyped = IntegrationEventInvitationToJSONTyped;
|
|
22
|
+
const IntegrationEventUser_1 = require("./IntegrationEventUser");
|
|
23
|
+
/**
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
exports.IntegrationEventInvitationStatusEnum = {
|
|
27
|
+
Pending: 'pending',
|
|
28
|
+
Accepted: 'accepted'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the IntegrationEventInvitation interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfIntegrationEventInvitation(value) {
|
|
34
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('status' in value) || value['status'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('invitedAt' in value) || value['invitedAt'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('expiresAt' in value) || value['expiresAt'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
if (!('acceptedAt' in value) || value['acceptedAt'] === undefined)
|
|
43
|
+
return false;
|
|
44
|
+
if (!('invitedBy' in value) || value['invitedBy'] === undefined)
|
|
45
|
+
return false;
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
function IntegrationEventInvitationFromJSON(json) {
|
|
49
|
+
return IntegrationEventInvitationFromJSONTyped(json, false);
|
|
50
|
+
}
|
|
51
|
+
function IntegrationEventInvitationFromJSONTyped(json, ignoreDiscriminator) {
|
|
52
|
+
if (json == null) {
|
|
53
|
+
return json;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
'id': json['id'],
|
|
57
|
+
'status': json['status'],
|
|
58
|
+
'invitedAt': (new Date(json['invited_at'])),
|
|
59
|
+
'expiresAt': (new Date(json['expires_at'])),
|
|
60
|
+
'acceptedAt': (json['accepted_at'] == null ? null : new Date(json['accepted_at'])),
|
|
61
|
+
'invitedBy': (0, IntegrationEventUser_1.IntegrationEventUserFromJSON)(json['invited_by']),
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function IntegrationEventInvitationToJSON(json) {
|
|
65
|
+
return IntegrationEventInvitationToJSONTyped(json, false);
|
|
66
|
+
}
|
|
67
|
+
function IntegrationEventInvitationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
68
|
+
if (value == null) {
|
|
69
|
+
return value;
|
|
70
|
+
}
|
|
71
|
+
return {
|
|
72
|
+
'id': value['id'],
|
|
73
|
+
'status': value['status'],
|
|
74
|
+
'invited_at': value['invitedAt'].toISOString(),
|
|
75
|
+
'expires_at': value['expiresAt'].toISOString(),
|
|
76
|
+
'accepted_at': value['acceptedAt'] == null ? value['acceptedAt'] : value['acceptedAt'].toISOString(),
|
|
77
|
+
'invited_by': (0, IntegrationEventUser_1.IntegrationEventUserToJSON)(value['invitedBy']),
|
|
78
|
+
};
|
|
79
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
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
|
+
* User affected by a portal membership lifecycle event.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface IntegrationEventUser
|
|
16
|
+
*/
|
|
17
|
+
export interface IntegrationEventUser {
|
|
18
|
+
/**
|
|
19
|
+
* Stable external user ID.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof IntegrationEventUser
|
|
22
|
+
*/
|
|
23
|
+
id: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof IntegrationEventUser
|
|
28
|
+
*/
|
|
29
|
+
email: string;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof IntegrationEventUser
|
|
34
|
+
*/
|
|
35
|
+
firstName: string;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof IntegrationEventUser
|
|
40
|
+
*/
|
|
41
|
+
lastName: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the IntegrationEventUser interface.
|
|
45
|
+
*/
|
|
46
|
+
export declare function instanceOfIntegrationEventUser(value: object): value is IntegrationEventUser;
|
|
47
|
+
export declare function IntegrationEventUserFromJSON(json: any): IntegrationEventUser;
|
|
48
|
+
export declare function IntegrationEventUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): IntegrationEventUser;
|
|
49
|
+
export declare function IntegrationEventUserToJSON(json: any): IntegrationEventUser;
|
|
50
|
+
export declare function IntegrationEventUserToJSONTyped(value?: IntegrationEventUser | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.instanceOfIntegrationEventUser = instanceOfIntegrationEventUser;
|
|
17
|
+
exports.IntegrationEventUserFromJSON = IntegrationEventUserFromJSON;
|
|
18
|
+
exports.IntegrationEventUserFromJSONTyped = IntegrationEventUserFromJSONTyped;
|
|
19
|
+
exports.IntegrationEventUserToJSON = IntegrationEventUserToJSON;
|
|
20
|
+
exports.IntegrationEventUserToJSONTyped = IntegrationEventUserToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the IntegrationEventUser interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfIntegrationEventUser(value) {
|
|
25
|
+
if (!('id' in value) || value['id'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('email' in value) || value['email'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('firstName' in value) || value['firstName'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('lastName' in value) || value['lastName'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
function IntegrationEventUserFromJSON(json) {
|
|
36
|
+
return IntegrationEventUserFromJSONTyped(json, false);
|
|
37
|
+
}
|
|
38
|
+
function IntegrationEventUserFromJSONTyped(json, ignoreDiscriminator) {
|
|
39
|
+
if (json == null) {
|
|
40
|
+
return json;
|
|
41
|
+
}
|
|
42
|
+
return {
|
|
43
|
+
'id': json['id'],
|
|
44
|
+
'email': json['email'],
|
|
45
|
+
'firstName': json['first_name'],
|
|
46
|
+
'lastName': json['last_name'],
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
function IntegrationEventUserToJSON(json) {
|
|
50
|
+
return IntegrationEventUserToJSONTyped(json, false);
|
|
51
|
+
}
|
|
52
|
+
function IntegrationEventUserToJSONTyped(value, ignoreDiscriminator = false) {
|
|
53
|
+
if (value == null) {
|
|
54
|
+
return value;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'id': value['id'],
|
|
58
|
+
'email': value['email'],
|
|
59
|
+
'first_name': value['firstName'],
|
|
60
|
+
'last_name': value['lastName'],
|
|
61
|
+
};
|
|
62
|
+
}
|
|
@@ -53,6 +53,8 @@ export declare const PostCustomWebhookIntegrationEventTypesEnum: {
|
|
|
53
53
|
readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
|
|
54
54
|
readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
|
|
55
55
|
readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
|
|
56
|
+
readonly ComEdaxuPortalUserInvitedV1: "com.edaxu.portal.user_invited.v1";
|
|
57
|
+
readonly ComEdaxuPortalUserJoinedV1: "com.edaxu.portal.user_joined.v1";
|
|
56
58
|
};
|
|
57
59
|
export type PostCustomWebhookIntegrationEventTypesEnum = typeof PostCustomWebhookIntegrationEventTypesEnum[keyof typeof PostCustomWebhookIntegrationEventTypesEnum];
|
|
58
60
|
/**
|
|
@@ -25,7 +25,9 @@ exports.PostCustomWebhookIntegrationToJSONTyped = PostCustomWebhookIntegrationTo
|
|
|
25
25
|
exports.PostCustomWebhookIntegrationEventTypesEnum = {
|
|
26
26
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
27
27
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
28
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
28
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
29
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
30
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
29
31
|
};
|
|
30
32
|
/**
|
|
31
33
|
* Check if a given object implements the PostCustomWebhookIntegration interface.
|
|
@@ -41,6 +41,8 @@ export declare const PostZapierSubscriptionEventTypeEnum: {
|
|
|
41
41
|
readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
|
|
42
42
|
readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
|
|
43
43
|
readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
|
|
44
|
+
readonly ComEdaxuPortalUserInvitedV1: "com.edaxu.portal.user_invited.v1";
|
|
45
|
+
readonly ComEdaxuPortalUserJoinedV1: "com.edaxu.portal.user_joined.v1";
|
|
44
46
|
};
|
|
45
47
|
export type PostZapierSubscriptionEventTypeEnum = typeof PostZapierSubscriptionEventTypeEnum[keyof typeof PostZapierSubscriptionEventTypeEnum];
|
|
46
48
|
/**
|
|
@@ -25,7 +25,9 @@ exports.PostZapierSubscriptionToJSONTyped = PostZapierSubscriptionToJSONTyped;
|
|
|
25
25
|
exports.PostZapierSubscriptionEventTypeEnum = {
|
|
26
26
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
27
27
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
28
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
28
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
29
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
30
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
29
31
|
};
|
|
30
32
|
/**
|
|
31
33
|
* Check if a given object implements the PostZapierSubscription interface.
|
|
@@ -53,6 +53,8 @@ export declare const PutCustomWebhookIntegrationEventTypesEnum: {
|
|
|
53
53
|
readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
|
|
54
54
|
readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
|
|
55
55
|
readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
|
|
56
|
+
readonly ComEdaxuPortalUserInvitedV1: "com.edaxu.portal.user_invited.v1";
|
|
57
|
+
readonly ComEdaxuPortalUserJoinedV1: "com.edaxu.portal.user_joined.v1";
|
|
56
58
|
};
|
|
57
59
|
export type PutCustomWebhookIntegrationEventTypesEnum = typeof PutCustomWebhookIntegrationEventTypesEnum[keyof typeof PutCustomWebhookIntegrationEventTypesEnum];
|
|
58
60
|
/**
|
|
@@ -25,7 +25,9 @@ exports.PutCustomWebhookIntegrationToJSONTyped = PutCustomWebhookIntegrationToJS
|
|
|
25
25
|
exports.PutCustomWebhookIntegrationEventTypesEnum = {
|
|
26
26
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
27
27
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
28
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
28
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
29
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
30
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
29
31
|
};
|
|
30
32
|
/**
|
|
31
33
|
* Check if a given object implements the PutCustomWebhookIntegration interface.
|
|
@@ -41,6 +41,8 @@ export declare const ZapierSubscriptionEventTypeEnum: {
|
|
|
41
41
|
readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
|
|
42
42
|
readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
|
|
43
43
|
readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
|
|
44
|
+
readonly ComEdaxuPortalUserInvitedV1: "com.edaxu.portal.user_invited.v1";
|
|
45
|
+
readonly ComEdaxuPortalUserJoinedV1: "com.edaxu.portal.user_joined.v1";
|
|
44
46
|
};
|
|
45
47
|
export type ZapierSubscriptionEventTypeEnum = typeof ZapierSubscriptionEventTypeEnum[keyof typeof ZapierSubscriptionEventTypeEnum];
|
|
46
48
|
/**
|
|
@@ -25,7 +25,9 @@ exports.ZapierSubscriptionToJSONTyped = ZapierSubscriptionToJSONTyped;
|
|
|
25
25
|
exports.ZapierSubscriptionEventTypeEnum = {
|
|
26
26
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
27
27
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
28
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
28
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
29
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
30
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
29
31
|
};
|
|
30
32
|
/**
|
|
31
33
|
* Check if a given object implements the ZapierSubscription interface.
|
package/dist/models/index.d.ts
CHANGED
|
@@ -170,8 +170,10 @@ export * from './IntegrationEventCertificate';
|
|
|
170
170
|
export * from './IntegrationEventCourse';
|
|
171
171
|
export * from './IntegrationEventData';
|
|
172
172
|
export * from './IntegrationEventEnrollment';
|
|
173
|
+
export * from './IntegrationEventInvitation';
|
|
173
174
|
export * from './IntegrationEventLearner';
|
|
174
175
|
export * from './IntegrationEventPortal';
|
|
176
|
+
export * from './IntegrationEventUser';
|
|
175
177
|
export * from './LearnerExperienceVersion';
|
|
176
178
|
export * from './LibraryQuizCriteriaPreviewQuestion';
|
|
177
179
|
export * from './LibraryQuizCriterion';
|
package/dist/models/index.js
CHANGED
|
@@ -188,8 +188,10 @@ __exportStar(require("./IntegrationEventCertificate"), exports);
|
|
|
188
188
|
__exportStar(require("./IntegrationEventCourse"), exports);
|
|
189
189
|
__exportStar(require("./IntegrationEventData"), exports);
|
|
190
190
|
__exportStar(require("./IntegrationEventEnrollment"), exports);
|
|
191
|
+
__exportStar(require("./IntegrationEventInvitation"), exports);
|
|
191
192
|
__exportStar(require("./IntegrationEventLearner"), exports);
|
|
192
193
|
__exportStar(require("./IntegrationEventPortal"), exports);
|
|
194
|
+
__exportStar(require("./IntegrationEventUser"), exports);
|
|
193
195
|
__exportStar(require("./LearnerExperienceVersion"), exports);
|
|
194
196
|
__exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
|
|
195
197
|
__exportStar(require("./LibraryQuizCriterion"), exports);
|
package/docs/IntegrationApi.md
CHANGED
|
@@ -393,7 +393,7 @@ async function example() {
|
|
|
393
393
|
xAPIKEY: xAPIKEY_example,
|
|
394
394
|
// string
|
|
395
395
|
xPORTALSUBDOMAIN: xPORTALSUBDOMAIN_example,
|
|
396
|
-
// 'com.edaxu.enrollment.enrolled.v1' | 'com.edaxu.enrollment.completed.v1' | 'com.edaxu.certificate.issued.v1'
|
|
396
|
+
// 'com.edaxu.enrollment.enrolled.v1' | 'com.edaxu.enrollment.completed.v1' | 'com.edaxu.certificate.issued.v1' | 'com.edaxu.portal.user_invited.v1' | 'com.edaxu.portal.user_joined.v1'
|
|
397
397
|
eventType: eventType_example,
|
|
398
398
|
// number (optional)
|
|
399
399
|
pageSize: 56,
|
|
@@ -418,7 +418,7 @@ example().catch(console.error);
|
|
|
418
418
|
|------------- | ------------- | ------------- | -------------|
|
|
419
419
|
| **xAPIKEY** | `string` | | [Defaults to `undefined`] |
|
|
420
420
|
| **xPORTALSUBDOMAIN** | `string` | | [Defaults to `undefined`] |
|
|
421
|
-
| **eventType** | `com.edaxu.enrollment.enrolled.v1`, `com.edaxu.enrollment.completed.v1`, `com.edaxu.certificate.issued.v1` | | [Defaults to `undefined`] [Enum: com.edaxu.enrollment.enrolled.v1, com.edaxu.enrollment.completed.v1, com.edaxu.certificate.issued.v1] |
|
|
421
|
+
| **eventType** | `com.edaxu.enrollment.enrolled.v1`, `com.edaxu.enrollment.completed.v1`, `com.edaxu.certificate.issued.v1`, `com.edaxu.portal.user_invited.v1`, `com.edaxu.portal.user_joined.v1` | | [Defaults to `undefined`] [Enum: com.edaxu.enrollment.enrolled.v1, com.edaxu.enrollment.completed.v1, com.edaxu.certificate.issued.v1, com.edaxu.portal.user_invited.v1, com.edaxu.portal.user_joined.v1] |
|
|
422
422
|
| **pageSize** | `number` | | [Optional] [Defaults to `3`] |
|
|
423
423
|
|
|
424
424
|
### Return type
|
|
@@ -8,9 +8,11 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`portal` | [IntegrationEventPortal](IntegrationEventPortal.md)
|
|
10
10
|
`learner` | [IntegrationEventLearner](IntegrationEventLearner.md)
|
|
11
|
+
`user` | [IntegrationEventUser](IntegrationEventUser.md)
|
|
11
12
|
`course` | [IntegrationEventCourse](IntegrationEventCourse.md)
|
|
12
13
|
`enrollment` | [IntegrationEventEnrollment](IntegrationEventEnrollment.md)
|
|
13
14
|
`certificate` | [IntegrationEventCertificate](IntegrationEventCertificate.md)
|
|
15
|
+
`invitation` | [IntegrationEventInvitation](IntegrationEventInvitation.md)
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -21,9 +23,11 @@ import type { IntegrationEventData } from '@easyedu/js-lsm-api'
|
|
|
21
23
|
const example = {
|
|
22
24
|
"portal": null,
|
|
23
25
|
"learner": null,
|
|
26
|
+
"user": null,
|
|
24
27
|
"course": null,
|
|
25
28
|
"enrollment": null,
|
|
26
29
|
"certificate": null,
|
|
30
|
+
"invitation": null,
|
|
27
31
|
} satisfies IntegrationEventData
|
|
28
32
|
|
|
29
33
|
console.log(example)
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
|
|
2
|
+
# IntegrationEventInvitation
|
|
3
|
+
|
|
4
|
+
Portal invitation lifecycle details for the affected user.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`status` | string
|
|
12
|
+
`invitedAt` | Date
|
|
13
|
+
`expiresAt` | Date
|
|
14
|
+
`acceptedAt` | Date
|
|
15
|
+
`invitedBy` | [IntegrationEventUser](IntegrationEventUser.md)
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { IntegrationEventInvitation } from '@easyedu/js-lsm-api'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"id": null,
|
|
25
|
+
"status": null,
|
|
26
|
+
"invitedAt": null,
|
|
27
|
+
"expiresAt": null,
|
|
28
|
+
"acceptedAt": null,
|
|
29
|
+
"invitedBy": null,
|
|
30
|
+
} satisfies IntegrationEventInvitation
|
|
31
|
+
|
|
32
|
+
console.log(example)
|
|
33
|
+
|
|
34
|
+
// Convert the instance to a JSON string
|
|
35
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
36
|
+
console.log(exampleJSON)
|
|
37
|
+
|
|
38
|
+
// Parse the JSON string back to an object
|
|
39
|
+
const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventInvitation
|
|
40
|
+
console.log(exampleParsed)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
44
|
+
|
|
45
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# IntegrationEventUser
|
|
3
|
+
|
|
4
|
+
User affected by a portal membership lifecycle event.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`id` | string
|
|
11
|
+
`email` | string
|
|
12
|
+
`firstName` | string
|
|
13
|
+
`lastName` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IntegrationEventUser } from '@easyedu/js-lsm-api'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"email": null,
|
|
24
|
+
"firstName": null,
|
|
25
|
+
"lastName": null,
|
|
26
|
+
} satisfies IntegrationEventUser
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventUser
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
package/package.json
CHANGED
|
@@ -1350,6 +1350,8 @@ export class IntegrationApi extends runtime.BaseAPI {
|
|
|
1350
1350
|
export const GetZapierEventsEventTypeEnum = {
|
|
1351
1351
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
1352
1352
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
1353
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
1353
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
1354
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
1355
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
1354
1356
|
} as const;
|
|
1355
1357
|
export type GetZapierEventsEventTypeEnum = typeof GetZapierEventsEventTypeEnum[keyof typeof GetZapierEventsEventTypeEnum];
|
|
@@ -76,7 +76,9 @@ export interface CustomWebhookIntegration {
|
|
|
76
76
|
export const CustomWebhookIntegrationEventTypesEnum = {
|
|
77
77
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
78
78
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
79
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
79
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
80
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
81
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
80
82
|
} as const;
|
|
81
83
|
export type CustomWebhookIntegrationEventTypesEnum = typeof CustomWebhookIntegrationEventTypesEnum[keyof typeof CustomWebhookIntegrationEventTypesEnum];
|
|
82
84
|
|
|
@@ -92,7 +92,9 @@ export type IntegrationEventSpecversionEnum = typeof IntegrationEventSpecversion
|
|
|
92
92
|
export const IntegrationEventTypeEnum = {
|
|
93
93
|
ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
|
|
94
94
|
ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
|
|
95
|
-
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1'
|
|
95
|
+
ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
|
|
96
|
+
ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
|
|
97
|
+
ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
|
|
96
98
|
} as const;
|
|
97
99
|
export type IntegrationEventTypeEnum = typeof IntegrationEventTypeEnum[keyof typeof IntegrationEventTypeEnum];
|
|
98
100
|
|