@easyedu/js-lsm-api 1.128.0 → 1.130.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.
Files changed (49) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +7 -2
  3. package/dist/apis/MarketingApi.d.ts +34 -0
  4. package/dist/apis/MarketingApi.js +74 -0
  5. package/dist/apis/UserApi.d.ts +16 -0
  6. package/dist/apis/UserApi.js +42 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/esm/apis/MarketingApi.d.ts +34 -0
  10. package/dist/esm/apis/MarketingApi.js +70 -0
  11. package/dist/esm/apis/UserApi.d.ts +16 -0
  12. package/dist/esm/apis/UserApi.js +42 -0
  13. package/dist/esm/apis/index.d.ts +1 -0
  14. package/dist/esm/apis/index.js +1 -0
  15. package/dist/esm/models/GetSignupSlugAvailability.d.ts +38 -0
  16. package/dist/esm/models/GetSignupSlugAvailability.js +47 -0
  17. package/dist/esm/models/PostDemoRequest.d.ts +100 -0
  18. package/dist/esm/models/PostDemoRequest.js +83 -0
  19. package/dist/esm/models/PostDemoRequestResponse.d.ts +38 -0
  20. package/dist/esm/models/PostDemoRequestResponse.js +47 -0
  21. package/dist/esm/models/PostSignupRequest.d.ts +6 -0
  22. package/dist/esm/models/PostSignupRequest.js +2 -0
  23. package/dist/esm/models/index.d.ts +3 -0
  24. package/dist/esm/models/index.js +3 -0
  25. package/dist/models/GetSignupSlugAvailability.d.ts +38 -0
  26. package/dist/models/GetSignupSlugAvailability.js +54 -0
  27. package/dist/models/PostDemoRequest.d.ts +100 -0
  28. package/dist/models/PostDemoRequest.js +91 -0
  29. package/dist/models/PostDemoRequestResponse.d.ts +38 -0
  30. package/dist/models/PostDemoRequestResponse.js +54 -0
  31. package/dist/models/PostSignupRequest.d.ts +6 -0
  32. package/dist/models/PostSignupRequest.js +2 -0
  33. package/dist/models/index.d.ts +3 -0
  34. package/dist/models/index.js +3 -0
  35. package/docs/GetSignupSlugAvailability.md +36 -0
  36. package/docs/MarketingApi.md +78 -0
  37. package/docs/PostDemoRequest.md +50 -0
  38. package/docs/PostDemoRequestResponse.md +36 -0
  39. package/docs/PostSignupRequest.md +2 -0
  40. package/docs/UserApi.md +69 -0
  41. package/package.json +1 -1
  42. package/src/apis/MarketingApi.ts +83 -0
  43. package/src/apis/UserApi.ts +57 -0
  44. package/src/apis/index.ts +1 -0
  45. package/src/models/GetSignupSlugAvailability.ts +75 -0
  46. package/src/models/PostDemoRequest.ts +157 -0
  47. package/src/models/PostDemoRequestResponse.ts +75 -0
  48. package/src/models/PostSignupRequest.ts +8 -0
  49. package/src/models/index.ts +3 -0
@@ -0,0 +1,157 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostDemoRequest
20
+ */
21
+ export interface PostDemoRequest {
22
+ /**
23
+ * Stable for retries of the same submission; use a new UUID when details change.
24
+ * @type {string}
25
+ * @memberof PostDemoRequest
26
+ */
27
+ submissionId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof PostDemoRequest
32
+ */
33
+ fullName: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof PostDemoRequest
38
+ */
39
+ email: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof PostDemoRequest
44
+ */
45
+ organization: string;
46
+ /**
47
+ *
48
+ * @type {PostDemoRequestLearnerRangeEnum}
49
+ * @memberof PostDemoRequest
50
+ */
51
+ learnerRange?: PostDemoRequestLearnerRangeEnum;
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof PostDemoRequest
56
+ */
57
+ message?: string;
58
+ /**
59
+ *
60
+ * @type {PostDemoRequestInquiryTypeEnum}
61
+ * @memberof PostDemoRequest
62
+ */
63
+ inquiryType?: PostDemoRequestInquiryTypeEnum;
64
+ /**
65
+ * Originating site pathname; query strings and fragments are removed.
66
+ * @type {string}
67
+ * @memberof PostDemoRequest
68
+ */
69
+ sourcePath?: string;
70
+ /**
71
+ *
72
+ * @type {string}
73
+ * @memberof PostDemoRequest
74
+ */
75
+ sourceCta?: string;
76
+ }
77
+
78
+
79
+ /**
80
+ * @export
81
+ */
82
+ export const PostDemoRequestLearnerRangeEnum = {
83
+ _150: '1-50',
84
+ _511000: '51-1000',
85
+ _10013000: '1001-3000',
86
+ _3001: '3001+'
87
+ } as const;
88
+ export type PostDemoRequestLearnerRangeEnum = typeof PostDemoRequestLearnerRangeEnum[keyof typeof PostDemoRequestLearnerRangeEnum];
89
+
90
+ /**
91
+ * @export
92
+ */
93
+ export const PostDemoRequestInquiryTypeEnum = {
94
+ Demo: 'demo',
95
+ Enterprise: 'enterprise',
96
+ Migration: 'migration',
97
+ Sales: 'sales'
98
+ } as const;
99
+ export type PostDemoRequestInquiryTypeEnum = typeof PostDemoRequestInquiryTypeEnum[keyof typeof PostDemoRequestInquiryTypeEnum];
100
+
101
+
102
+ /**
103
+ * Check if a given object implements the PostDemoRequest interface.
104
+ */
105
+ export function instanceOfPostDemoRequest(value: object): value is PostDemoRequest {
106
+ if (!('submissionId' in value) || value['submissionId'] === undefined) return false;
107
+ if (!('fullName' in value) || value['fullName'] === undefined) return false;
108
+ if (!('email' in value) || value['email'] === undefined) return false;
109
+ if (!('organization' in value) || value['organization'] === undefined) return false;
110
+ return true;
111
+ }
112
+
113
+ export function PostDemoRequestFromJSON(json: any): PostDemoRequest {
114
+ return PostDemoRequestFromJSONTyped(json, false);
115
+ }
116
+
117
+ export function PostDemoRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequest {
118
+ if (json == null) {
119
+ return json;
120
+ }
121
+ return {
122
+
123
+ 'submissionId': json['submission_id'],
124
+ 'fullName': json['full_name'],
125
+ 'email': json['email'],
126
+ 'organization': json['organization'],
127
+ 'learnerRange': json['learner_range'] == null ? undefined : json['learner_range'],
128
+ 'message': json['message'] == null ? undefined : json['message'],
129
+ 'inquiryType': json['inquiry_type'] == null ? undefined : json['inquiry_type'],
130
+ 'sourcePath': json['source_path'] == null ? undefined : json['source_path'],
131
+ 'sourceCta': json['source_cta'] == null ? undefined : json['source_cta'],
132
+ };
133
+ }
134
+
135
+ export function PostDemoRequestToJSON(json: any): PostDemoRequest {
136
+ return PostDemoRequestToJSONTyped(json, false);
137
+ }
138
+
139
+ export function PostDemoRequestToJSONTyped(value?: PostDemoRequest | null, ignoreDiscriminator: boolean = false): any {
140
+ if (value == null) {
141
+ return value;
142
+ }
143
+
144
+ return {
145
+
146
+ 'submission_id': value['submissionId'],
147
+ 'full_name': value['fullName'],
148
+ 'email': value['email'],
149
+ 'organization': value['organization'],
150
+ 'learner_range': value['learnerRange'],
151
+ 'message': value['message'],
152
+ 'inquiry_type': value['inquiryType'],
153
+ 'source_path': value['sourcePath'],
154
+ 'source_cta': value['sourceCta'],
155
+ };
156
+ }
157
+
@@ -0,0 +1,75 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostDemoRequestResponse
20
+ */
21
+ export interface PostDemoRequestResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PostDemoRequestResponse
26
+ */
27
+ requestId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof PostDemoRequestResponse
32
+ */
33
+ message: string;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the PostDemoRequestResponse interface.
38
+ */
39
+ export function instanceOfPostDemoRequestResponse(value: object): value is PostDemoRequestResponse {
40
+ if (!('requestId' in value) || value['requestId'] === undefined) return false;
41
+ if (!('message' in value) || value['message'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function PostDemoRequestResponseFromJSON(json: any): PostDemoRequestResponse {
46
+ return PostDemoRequestResponseFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function PostDemoRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequestResponse {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'requestId': json['request_id'],
56
+ 'message': json['message'],
57
+ };
58
+ }
59
+
60
+ export function PostDemoRequestResponseToJSON(json: any): PostDemoRequestResponse {
61
+ return PostDemoRequestResponseToJSONTyped(json, false);
62
+ }
63
+
64
+ export function PostDemoRequestResponseToJSONTyped(value?: PostDemoRequestResponse | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'request_id': value['requestId'],
72
+ 'message': value['message'],
73
+ };
74
+ }
75
+
@@ -49,6 +49,12 @@ export interface PostSignupRequest {
49
49
  * @memberof PostSignupRequest
50
50
  */
51
51
  organization: string;
52
+ /**
53
+ * Requested learner subdomain, without the domain suffix. Must be available and not reserved. If omitted, it is derived from the organization. Availability does not reserve the address; verification checks again and never substitutes another address.
54
+ * @type {string}
55
+ * @memberof PostSignupRequest
56
+ */
57
+ slug?: string;
52
58
  /**
53
59
  * Signup/onboarding role supplied by the user; not an LMS RBAC role.
54
60
  * @type {string}
@@ -92,6 +98,7 @@ export function PostSignupRequestFromJSONTyped(json: any, ignoreDiscriminator: b
92
98
  'email': json['email'],
93
99
  'password': json['password'],
94
100
  'organization': json['organization'],
101
+ 'slug': json['slug'] == null ? undefined : json['slug'],
95
102
  'jobRole': json['job_role'],
96
103
  'learnerCount': json['learner_count'],
97
104
  };
@@ -113,6 +120,7 @@ export function PostSignupRequestToJSONTyped(value?: PostSignupRequest | null, i
113
120
  'email': value['email'],
114
121
  'password': value['password'],
115
122
  'organization': value['organization'],
123
+ 'slug': value['slug'],
116
124
  'job_role': value['jobRole'],
117
125
  'learner_count': value['learnerCount'],
118
126
  };
@@ -157,6 +157,7 @@ export * from './GetResourceUsageCoursesInner';
157
157
  export * from './GetResourceVersionUpload';
158
158
  export * from './GetRichTextAssetUpload';
159
159
  export * from './GetRole';
160
+ export * from './GetSignupSlugAvailability';
160
161
  export * from './GetSupportTicket';
161
162
  export * from './GetSupportTicketAttachment';
162
163
  export * from './GetSupportTicketComment';
@@ -243,6 +244,8 @@ export * from './PostCourseVersionPublish';
243
244
  export * from './PostCourseVersionSection';
244
245
  export * from './PostCourseVersionSectionDuplicate';
245
246
  export * from './PostCustomWebhookIntegration';
247
+ export * from './PostDemoRequest';
248
+ export * from './PostDemoRequestResponse';
246
249
  export * from './PostDispatchItemLaunch';
247
250
  export * from './PostDispatchItemLaunchResponse';
248
251
  export * from './PostDispatchLaunch';