@easyedu/js-lsm-api 1.132.0 → 1.134.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 +6 -0
- package/README.md +8 -3
- package/dist/apis/IntegrationApi.d.ts +7 -3
- package/dist/apis/IntegrationApi.js +10 -5
- package/dist/apis/PortalApi.d.ts +30 -0
- package/dist/apis/PortalApi.js +63 -1
- package/dist/apis/QuestionApi.d.ts +19 -0
- package/dist/apis/QuestionApi.js +44 -0
- package/dist/esm/apis/IntegrationApi.d.ts +7 -3
- package/dist/esm/apis/IntegrationApi.js +10 -5
- package/dist/esm/apis/PortalApi.d.ts +30 -0
- package/dist/esm/apis/PortalApi.js +62 -0
- package/dist/esm/apis/QuestionApi.d.ts +19 -0
- package/dist/esm/apis/QuestionApi.js +44 -0
- package/dist/esm/models/GetCourse.d.ts +6 -0
- package/dist/esm/models/GetCourse.js +4 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.d.ts +6 -0
- package/dist/esm/models/GetCourseEnrollmentListItem.js +2 -0
- package/dist/esm/models/GetPortalUser.d.ts +6 -0
- package/dist/esm/models/GetPortalUser.js +4 -0
- package/dist/esm/models/GetResource.d.ts +6 -0
- package/dist/esm/models/GetResource.js +4 -0
- package/dist/esm/models/GetResourceUsageCoursesInner.d.ts +6 -0
- package/dist/esm/models/GetResourceUsageCoursesInner.js +4 -0
- package/dist/esm/models/IntegrationEventCourse.d.ts +6 -0
- package/dist/esm/models/IntegrationEventCourse.js +2 -0
- package/dist/esm/models/IntegrationEventLearner.d.ts +6 -0
- package/dist/esm/models/IntegrationEventLearner.js +2 -0
- package/dist/esm/models/IntegrationEventUser.d.ts +6 -0
- package/dist/esm/models/IntegrationEventUser.js +2 -0
- package/dist/esm/models/PostCourse.d.ts +6 -0
- package/dist/esm/models/PostCourse.js +2 -0
- package/dist/esm/models/PostPortalInvite.d.ts +6 -0
- package/dist/esm/models/PostPortalInvite.js +2 -0
- package/dist/esm/models/PostQuestionTags.d.ts +38 -0
- package/dist/esm/models/PostQuestionTags.js +47 -0
- package/dist/esm/models/PostQuestionTagsResponse.d.ts +32 -0
- package/dist/esm/models/PostQuestionTagsResponse.js +43 -0
- package/dist/esm/models/PostResource.d.ts +6 -0
- package/dist/esm/models/PostResource.js +2 -0
- package/dist/esm/models/PostRichTextAssetUpload.d.ts +6 -0
- package/dist/esm/models/PostRichTextAssetUpload.js +2 -0
- package/dist/esm/models/PostZapierEnrollment.d.ts +16 -4
- package/dist/esm/models/PostZapierEnrollment.js +6 -6
- package/dist/esm/models/PostZapierShopifyCourseMapping.d.ts +8 -2
- package/dist/esm/models/PostZapierShopifyCourseMapping.js +3 -3
- package/dist/esm/models/PostZapierUser.d.ts +6 -0
- package/dist/esm/models/PostZapierUser.js +2 -0
- package/dist/esm/models/PutCourse.d.ts +6 -0
- package/dist/esm/models/PutCourse.js +2 -0
- package/dist/esm/models/PutPortalUser.d.ts +32 -0
- package/dist/esm/models/PutPortalUser.js +41 -0
- package/dist/esm/models/PutResource.d.ts +6 -0
- package/dist/esm/models/PutResource.js +2 -0
- package/dist/esm/models/RichTextAsset.d.ts +6 -0
- package/dist/esm/models/RichTextAsset.js +2 -0
- package/dist/esm/models/ZapierCourse.d.ts +6 -0
- package/dist/esm/models/ZapierCourse.js +4 -0
- package/dist/esm/models/ZapierEnrollment.d.ts +12 -0
- package/dist/esm/models/ZapierEnrollment.js +8 -0
- package/dist/esm/models/ZapierUser.d.ts +6 -0
- package/dist/esm/models/ZapierUser.js +4 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/GetCourse.d.ts +6 -0
- package/dist/models/GetCourse.js +4 -0
- package/dist/models/GetCourseEnrollmentListItem.d.ts +6 -0
- package/dist/models/GetCourseEnrollmentListItem.js +2 -0
- package/dist/models/GetPortalUser.d.ts +6 -0
- package/dist/models/GetPortalUser.js +4 -0
- package/dist/models/GetResource.d.ts +6 -0
- package/dist/models/GetResource.js +4 -0
- package/dist/models/GetResourceUsageCoursesInner.d.ts +6 -0
- package/dist/models/GetResourceUsageCoursesInner.js +4 -0
- package/dist/models/IntegrationEventCourse.d.ts +6 -0
- package/dist/models/IntegrationEventCourse.js +2 -0
- package/dist/models/IntegrationEventLearner.d.ts +6 -0
- package/dist/models/IntegrationEventLearner.js +2 -0
- package/dist/models/IntegrationEventUser.d.ts +6 -0
- package/dist/models/IntegrationEventUser.js +2 -0
- package/dist/models/PostCourse.d.ts +6 -0
- package/dist/models/PostCourse.js +2 -0
- package/dist/models/PostPortalInvite.d.ts +6 -0
- package/dist/models/PostPortalInvite.js +2 -0
- package/dist/models/PostQuestionTags.d.ts +38 -0
- package/dist/models/PostQuestionTags.js +54 -0
- package/dist/models/PostQuestionTagsResponse.d.ts +32 -0
- package/dist/models/PostQuestionTagsResponse.js +50 -0
- package/dist/models/PostResource.d.ts +6 -0
- package/dist/models/PostResource.js +2 -0
- package/dist/models/PostRichTextAssetUpload.d.ts +6 -0
- package/dist/models/PostRichTextAssetUpload.js +2 -0
- package/dist/models/PostZapierEnrollment.d.ts +16 -4
- package/dist/models/PostZapierEnrollment.js +6 -6
- package/dist/models/PostZapierShopifyCourseMapping.d.ts +8 -2
- package/dist/models/PostZapierShopifyCourseMapping.js +3 -3
- package/dist/models/PostZapierUser.d.ts +6 -0
- package/dist/models/PostZapierUser.js +2 -0
- package/dist/models/PutCourse.d.ts +6 -0
- package/dist/models/PutCourse.js +2 -0
- package/dist/models/PutPortalUser.d.ts +32 -0
- package/dist/models/PutPortalUser.js +48 -0
- package/dist/models/PutResource.d.ts +6 -0
- package/dist/models/PutResource.js +2 -0
- package/dist/models/RichTextAsset.d.ts +6 -0
- package/dist/models/RichTextAsset.js +2 -0
- package/dist/models/ZapierCourse.d.ts +6 -0
- package/dist/models/ZapierCourse.js +4 -0
- package/dist/models/ZapierEnrollment.d.ts +12 -0
- package/dist/models/ZapierEnrollment.js +8 -0
- package/dist/models/ZapierUser.d.ts +6 -0
- package/dist/models/ZapierUser.js +4 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/GetCourse.md +2 -0
- package/docs/GetCourseEnrollmentListItem.md +2 -0
- package/docs/GetPortalUser.md +2 -0
- package/docs/GetResource.md +2 -0
- package/docs/GetResourceUsageCoursesInner.md +2 -0
- package/docs/IntegrationApi.md +15 -6
- package/docs/IntegrationEventCourse.md +2 -0
- package/docs/IntegrationEventLearner.md +2 -0
- package/docs/IntegrationEventUser.md +2 -0
- package/docs/PortalApi.md +82 -1
- package/docs/PostCourse.md +2 -0
- package/docs/PostPortalInvite.md +2 -0
- package/docs/PostQuestionTags.md +37 -0
- package/docs/PostQuestionTagsResponse.md +34 -0
- package/docs/PostResource.md +2 -0
- package/docs/PostRichTextAssetUpload.md +2 -0
- package/docs/PostZapierEnrollment.md +4 -0
- package/docs/PostZapierShopifyCourseMapping.md +2 -0
- package/docs/PostZapierUser.md +2 -0
- package/docs/PutCourse.md +2 -0
- package/docs/PutPortalUser.md +35 -0
- package/docs/PutResource.md +2 -0
- package/docs/QuestionApi.md +71 -0
- package/docs/RichTextAsset.md +2 -0
- package/docs/ZapierCourse.md +2 -0
- package/docs/ZapierEnrollment.md +4 -0
- package/docs/ZapierUser.md +2 -0
- package/package.json +1 -1
- package/src/apis/IntegrationApi.ts +15 -10
- package/src/apis/PortalApi.ts +94 -0
- package/src/apis/QuestionApi.ts +63 -0
- package/src/models/GetCourse.ts +9 -0
- package/src/models/GetCourseEnrollmentListItem.ts +8 -0
- package/src/models/GetPortalUser.ts +9 -0
- package/src/models/GetResource.ts +9 -0
- package/src/models/GetResourceUsageCoursesInner.ts +9 -0
- package/src/models/IntegrationEventCourse.ts +8 -0
- package/src/models/IntegrationEventLearner.ts +8 -0
- package/src/models/IntegrationEventUser.ts +8 -0
- package/src/models/PostCourse.ts +8 -0
- package/src/models/PostPortalInvite.ts +8 -0
- package/src/models/PostQuestionTags.ts +75 -0
- package/src/models/PostQuestionTagsResponse.ts +66 -0
- package/src/models/PostResource.ts +8 -0
- package/src/models/PostRichTextAssetUpload.ts +8 -0
- package/src/models/PostZapierEnrollment.ts +22 -8
- package/src/models/PostZapierShopifyCourseMapping.ts +11 -4
- package/src/models/PostZapierUser.ts +8 -0
- package/src/models/PutCourse.ts +8 -0
- package/src/models/PutPortalUser.ts +65 -0
- package/src/models/PutResource.ts +8 -0
- package/src/models/RichTextAsset.ts +8 -0
- package/src/models/ZapierCourse.ts +9 -0
- package/src/models/ZapierEnrollment.ts +18 -0
- package/src/models/ZapierUser.ts +9 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -299,6 +299,8 @@ docs/PostQuestionImportCommit.md
|
|
|
299
299
|
docs/PostQuestionImportCommitItem.md
|
|
300
300
|
docs/PostQuestionImportCommitResponse.md
|
|
301
301
|
docs/PostQuestionImportParseResponse.md
|
|
302
|
+
docs/PostQuestionTags.md
|
|
303
|
+
docs/PostQuestionTagsResponse.md
|
|
302
304
|
docs/PostReportExport.md
|
|
303
305
|
docs/PostReportQuery.md
|
|
304
306
|
docs/PostResetPassword.md
|
|
@@ -358,6 +360,7 @@ docs/PutLibraryQuizVersion.md
|
|
|
358
360
|
docs/PutPortalBranding.md
|
|
359
361
|
docs/PutPortalCertificateTemplate.md
|
|
360
362
|
docs/PutPortalSublicense.md
|
|
363
|
+
docs/PutPortalUser.md
|
|
361
364
|
docs/PutPortalUserFieldValues.md
|
|
362
365
|
docs/PutQuestion.md
|
|
363
366
|
docs/PutQuestionAnswerChoicesInner.md
|
|
@@ -737,6 +740,8 @@ src/models/PostQuestionImportCommit.ts
|
|
|
737
740
|
src/models/PostQuestionImportCommitItem.ts
|
|
738
741
|
src/models/PostQuestionImportCommitResponse.ts
|
|
739
742
|
src/models/PostQuestionImportParseResponse.ts
|
|
743
|
+
src/models/PostQuestionTags.ts
|
|
744
|
+
src/models/PostQuestionTagsResponse.ts
|
|
740
745
|
src/models/PostReportExport.ts
|
|
741
746
|
src/models/PostReportQuery.ts
|
|
742
747
|
src/models/PostResetPassword.ts
|
|
@@ -796,6 +801,7 @@ src/models/PutLibraryQuizVersion.ts
|
|
|
796
801
|
src/models/PutPortalBranding.ts
|
|
797
802
|
src/models/PutPortalCertificateTemplate.ts
|
|
798
803
|
src/models/PutPortalSublicense.ts
|
|
804
|
+
src/models/PutPortalUser.ts
|
|
799
805
|
src/models/PutPortalUserFieldValues.ts
|
|
800
806
|
src/models/PutQuestion.ts
|
|
801
807
|
src/models/PutQuestionAnswerChoicesInner.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.134.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -292,7 +292,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
292
292
|
*IntegrationApi* | [**getZapierMe**](docs/IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions
|
|
293
293
|
*IntegrationApi* | [**getZapierSetup**](docs/IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal
|
|
294
294
|
*IntegrationApi* | [**getZapierShopifyCourseMappings**](docs/IntegrationApi.md#getzapiershopifycoursemappings) | **GET** /integrations/zapier/shopify/course-mappings | List Shopify variant-to-course mappings
|
|
295
|
-
*IntegrationApi* | [**getZapierUsers**](docs/IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address
|
|
295
|
+
*IntegrationApi* | [**getZapierUsers**](docs/IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address or customer_ref
|
|
296
296
|
*IntegrationApi* | [**postCustomWebhookIntegration**](docs/IntegrationApi.md#postcustomwebhookintegration) | **POST** /integrations/webhooks | Create a custom webhook destination for lifecycle events
|
|
297
297
|
*IntegrationApi* | [**postZapierEnrollment**](docs/IntegrationApi.md#postzapierenrollment) | **POST** /integrations/zapier/enrollments | Enroll an existing learner in a course
|
|
298
298
|
*IntegrationApi* | [**postZapierSetup**](docs/IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal
|
|
@@ -351,6 +351,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
351
351
|
*PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
|
|
352
352
|
*PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
|
|
353
353
|
*PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding and complete application theme
|
|
354
|
+
*PortalApi* | [**putPortalUser**](docs/PortalApi.md#putportaluser) | **PUT** /portals/{portalId}/users/{userId} | Update admin-managed details for a portal member
|
|
354
355
|
*PortalApi* | [**putPortalUserFieldConfig**](docs/PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration
|
|
355
356
|
*PortalApi* | [**putPortalUserFieldValues**](docs/PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values
|
|
356
357
|
*PortalApi* | [**removePortalUser**](docs/PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal
|
|
@@ -361,6 +362,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
361
362
|
*QuestionApi* | [**getQuestionList**](docs/QuestionApi.md#getquestionlist) | **GET** /questions | Get list of questions with filtering and pagination
|
|
362
363
|
*QuestionApi* | [**getQuestionVersions**](docs/QuestionApi.md#getquestionversions) | **GET** /questions/{questionId}/versions | Get all versions of a question
|
|
363
364
|
*QuestionApi* | [**postQuestion**](docs/QuestionApi.md#postquestion) | **POST** /questions | Create a new question
|
|
365
|
+
*QuestionApi* | [**postQuestionTags**](docs/QuestionApi.md#postquestiontags) | **POST** /questions/tags | Add tags to several questions
|
|
364
366
|
*QuestionApi* | [**putQuestion**](docs/QuestionApi.md#putquestion) | **PUT** /questions/{questionId} | Create the next version of a question
|
|
365
367
|
*QuestionImportApi* | [**postQuestionImportCommit**](docs/QuestionImportApi.md#postquestionimportcommit) | **POST** /question-imports/commit | Validate and atomically create, version, or skip approved question drafts
|
|
366
368
|
*QuestionImportApi* | [**postQuestionImportParse**](docs/QuestionImportApi.md#postquestionimportparse) | **POST** /question-imports/parse | Parse a question document into stateless review drafts
|
|
@@ -698,6 +700,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
698
700
|
- [PostQuestionImportCommitItem](docs/PostQuestionImportCommitItem.md)
|
|
699
701
|
- [PostQuestionImportCommitResponse](docs/PostQuestionImportCommitResponse.md)
|
|
700
702
|
- [PostQuestionImportParseResponse](docs/PostQuestionImportParseResponse.md)
|
|
703
|
+
- [PostQuestionTags](docs/PostQuestionTags.md)
|
|
704
|
+
- [PostQuestionTagsResponse](docs/PostQuestionTagsResponse.md)
|
|
701
705
|
- [PostReportExport](docs/PostReportExport.md)
|
|
702
706
|
- [PostReportQuery](docs/PostReportQuery.md)
|
|
703
707
|
- [PostResetPassword](docs/PostResetPassword.md)
|
|
@@ -757,6 +761,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
757
761
|
- [PutPortalBranding](docs/PutPortalBranding.md)
|
|
758
762
|
- [PutPortalCertificateTemplate](docs/PutPortalCertificateTemplate.md)
|
|
759
763
|
- [PutPortalSublicense](docs/PutPortalSublicense.md)
|
|
764
|
+
- [PutPortalUser](docs/PutPortalUser.md)
|
|
760
765
|
- [PutPortalUserFieldValues](docs/PutPortalUserFieldValues.md)
|
|
761
766
|
- [PutQuestion](docs/PutQuestion.md)
|
|
762
767
|
- [PutQuestionAnswerChoicesInner](docs/PutQuestionAnswerChoicesInner.md)
|
|
@@ -831,7 +836,7 @@ and is automatically generated by the
|
|
|
831
836
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
832
837
|
|
|
833
838
|
- API version: `1.0.0`
|
|
834
|
-
- Package version: `1.
|
|
839
|
+
- Package version: `1.134.0`
|
|
835
840
|
- Generator version: `7.22.0`
|
|
836
841
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
837
842
|
|
|
@@ -50,6 +50,7 @@ export interface GetZapierCoursesRequest {
|
|
|
50
50
|
page?: number;
|
|
51
51
|
pageSize?: number;
|
|
52
52
|
search?: string;
|
|
53
|
+
customerRef?: string;
|
|
53
54
|
}
|
|
54
55
|
export interface GetZapierEventsRequest {
|
|
55
56
|
xAPIKEY: string;
|
|
@@ -69,7 +70,8 @@ export interface GetZapierShopifyCourseMappingsRequest {
|
|
|
69
70
|
export interface GetZapierUsersRequest {
|
|
70
71
|
xAPIKEY: string;
|
|
71
72
|
xPORTALSUBDOMAIN: string;
|
|
72
|
-
email
|
|
73
|
+
email?: string;
|
|
74
|
+
customerRef?: string;
|
|
73
75
|
}
|
|
74
76
|
export interface PostCustomWebhookIntegrationRequest {
|
|
75
77
|
postCustomWebhookIntegration: PostCustomWebhookIntegration;
|
|
@@ -227,11 +229,13 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
227
229
|
*/
|
|
228
230
|
getZapierUsersRequestOpts(requestParameters: GetZapierUsersRequest): Promise<runtime.RequestOpts>;
|
|
229
231
|
/**
|
|
230
|
-
*
|
|
232
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
233
|
+
* Find a learner by exact email address or customer_ref
|
|
231
234
|
*/
|
|
232
235
|
getZapierUsersRaw(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierUsers>>;
|
|
233
236
|
/**
|
|
234
|
-
*
|
|
237
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
238
|
+
* Find a learner by exact email address or customer_ref
|
|
235
239
|
*/
|
|
236
240
|
getZapierUsers(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierUsers>;
|
|
237
241
|
/**
|
|
@@ -233,6 +233,9 @@ class IntegrationApi extends runtime.BaseAPI {
|
|
|
233
233
|
if (requestParameters['search'] != null) {
|
|
234
234
|
queryParameters['search'] = requestParameters['search'];
|
|
235
235
|
}
|
|
236
|
+
if (requestParameters['customerRef'] != null) {
|
|
237
|
+
queryParameters['customer_ref'] = requestParameters['customerRef'];
|
|
238
|
+
}
|
|
236
239
|
const headerParameters = {};
|
|
237
240
|
if (requestParameters['xAPIKEY'] != null) {
|
|
238
241
|
headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
|
|
@@ -467,13 +470,13 @@ class IntegrationApi extends runtime.BaseAPI {
|
|
|
467
470
|
if (requestParameters['xPORTALSUBDOMAIN'] == null) {
|
|
468
471
|
throw new runtime.RequiredError('xPORTALSUBDOMAIN', 'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierUsers().');
|
|
469
472
|
}
|
|
470
|
-
if (requestParameters['email'] == null) {
|
|
471
|
-
throw new runtime.RequiredError('email', 'Required parameter "email" was null or undefined when calling getZapierUsers().');
|
|
472
|
-
}
|
|
473
473
|
const queryParameters = {};
|
|
474
474
|
if (requestParameters['email'] != null) {
|
|
475
475
|
queryParameters['email'] = requestParameters['email'];
|
|
476
476
|
}
|
|
477
|
+
if (requestParameters['customerRef'] != null) {
|
|
478
|
+
queryParameters['customer_ref'] = requestParameters['customerRef'];
|
|
479
|
+
}
|
|
477
480
|
const headerParameters = {};
|
|
478
481
|
if (requestParameters['xAPIKEY'] != null) {
|
|
479
482
|
headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
|
|
@@ -491,7 +494,8 @@ class IntegrationApi extends runtime.BaseAPI {
|
|
|
491
494
|
});
|
|
492
495
|
}
|
|
493
496
|
/**
|
|
494
|
-
*
|
|
497
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
498
|
+
* Find a learner by exact email address or customer_ref
|
|
495
499
|
*/
|
|
496
500
|
getZapierUsersRaw(requestParameters, initOverrides) {
|
|
497
501
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -501,7 +505,8 @@ class IntegrationApi extends runtime.BaseAPI {
|
|
|
501
505
|
});
|
|
502
506
|
}
|
|
503
507
|
/**
|
|
504
|
-
*
|
|
508
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
509
|
+
* Find a learner by exact email address or customer_ref
|
|
505
510
|
*/
|
|
506
511
|
getZapierUsers(requestParameters, initOverrides) {
|
|
507
512
|
return __awaiter(this, void 0, void 0, function* () {
|
package/dist/apis/PortalApi.d.ts
CHANGED
|
@@ -14,6 +14,7 @@ import { type GetPortal } from '../models/GetPortal';
|
|
|
14
14
|
import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
|
|
15
15
|
import { type GetPortalList } from '../models/GetPortalList';
|
|
16
16
|
import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
|
|
17
|
+
import { type GetPortalUser } from '../models/GetPortalUser';
|
|
17
18
|
import { type GetPortalUserFieldValues } from '../models/GetPortalUserFieldValues';
|
|
18
19
|
import { type GetPortalUserList } from '../models/GetPortalUserList';
|
|
19
20
|
import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
|
|
@@ -21,6 +22,7 @@ import { type PortalUserFieldConfig } from '../models/PortalUserFieldConfig';
|
|
|
21
22
|
import { type PostPortal } from '../models/PostPortal';
|
|
22
23
|
import { type PostPortalInvite } from '../models/PostPortalInvite';
|
|
23
24
|
import { type PutPortalBranding } from '../models/PutPortalBranding';
|
|
25
|
+
import { type PutPortalUser } from '../models/PutPortalUser';
|
|
24
26
|
import { type PutPortalUserFieldValues } from '../models/PutPortalUserFieldValues';
|
|
25
27
|
import { type UpdateSelectedPortalResponse } from '../models/UpdateSelectedPortalResponse';
|
|
26
28
|
export interface DeletePortalFaviconRequest {
|
|
@@ -50,6 +52,7 @@ export interface GetPortalUsersRequest {
|
|
|
50
52
|
type?: GetPortalUsersTypeEnum;
|
|
51
53
|
roles?: Array<GetPortalUsersRolesEnum>;
|
|
52
54
|
search?: string;
|
|
55
|
+
status?: GetPortalUsersStatusEnum;
|
|
53
56
|
page?: number;
|
|
54
57
|
pageSize?: number;
|
|
55
58
|
}
|
|
@@ -72,6 +75,11 @@ export interface PutPortalBrandingRequest {
|
|
|
72
75
|
portalId: string;
|
|
73
76
|
putPortalBranding: PutPortalBranding;
|
|
74
77
|
}
|
|
78
|
+
export interface PutPortalUserRequest {
|
|
79
|
+
portalId: string;
|
|
80
|
+
userId: string;
|
|
81
|
+
putPortalUser: PutPortalUser;
|
|
82
|
+
}
|
|
75
83
|
export interface PutPortalUserFieldConfigRequest {
|
|
76
84
|
portalId: string;
|
|
77
85
|
portalUserFieldConfig: PortalUserFieldConfig;
|
|
@@ -302,6 +310,20 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
302
310
|
* Update portal branding and complete application theme
|
|
303
311
|
*/
|
|
304
312
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
313
|
+
/**
|
|
314
|
+
* Creates request options for putPortalUser without sending the request
|
|
315
|
+
*/
|
|
316
|
+
putPortalUserRequestOpts(requestParameters: PutPortalUserRequest): Promise<runtime.RequestOpts>;
|
|
317
|
+
/**
|
|
318
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
319
|
+
* Update admin-managed details for a portal member
|
|
320
|
+
*/
|
|
321
|
+
putPortalUserRaw(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUser>>;
|
|
322
|
+
/**
|
|
323
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
324
|
+
* Update admin-managed details for a portal member
|
|
325
|
+
*/
|
|
326
|
+
putPortalUser(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUser>;
|
|
305
327
|
/**
|
|
306
328
|
* Creates request options for putPortalUserFieldConfig without sending the request
|
|
307
329
|
*/
|
|
@@ -368,3 +390,11 @@ export declare const GetPortalUsersRolesEnum: {
|
|
|
368
390
|
readonly Learner: "Learner";
|
|
369
391
|
};
|
|
370
392
|
export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
|
|
393
|
+
/**
|
|
394
|
+
* @export
|
|
395
|
+
*/
|
|
396
|
+
export declare const GetPortalUsersStatusEnum: {
|
|
397
|
+
readonly Active: "active";
|
|
398
|
+
readonly Removed: "removed";
|
|
399
|
+
};
|
|
400
|
+
export type GetPortalUsersStatusEnum = typeof GetPortalUsersStatusEnum[keyof typeof GetPortalUsersStatusEnum];
|
package/dist/apis/PortalApi.js
CHANGED
|
@@ -22,12 +22,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.GetPortalUsersRolesEnum = exports.GetPortalUsersTypeEnum = exports.PortalApi = void 0;
|
|
25
|
+
exports.GetPortalUsersStatusEnum = exports.GetPortalUsersRolesEnum = exports.GetPortalUsersTypeEnum = exports.PortalApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const GetPortal_1 = require("../models/GetPortal");
|
|
28
28
|
const GetPortalFaviconUpload_1 = require("../models/GetPortalFaviconUpload");
|
|
29
29
|
const GetPortalList_1 = require("../models/GetPortalList");
|
|
30
30
|
const GetPortalLogoUpload_1 = require("../models/GetPortalLogoUpload");
|
|
31
|
+
const GetPortalUser_1 = require("../models/GetPortalUser");
|
|
31
32
|
const GetPortalUserFieldValues_1 = require("../models/GetPortalUserFieldValues");
|
|
32
33
|
const GetPortalUserList_1 = require("../models/GetPortalUserList");
|
|
33
34
|
const GetPublicPortalBranding_1 = require("../models/GetPublicPortalBranding");
|
|
@@ -35,6 +36,7 @@ const PortalUserFieldConfig_1 = require("../models/PortalUserFieldConfig");
|
|
|
35
36
|
const PostPortal_1 = require("../models/PostPortal");
|
|
36
37
|
const PostPortalInvite_1 = require("../models/PostPortalInvite");
|
|
37
38
|
const PutPortalBranding_1 = require("../models/PutPortalBranding");
|
|
39
|
+
const PutPortalUser_1 = require("../models/PutPortalUser");
|
|
38
40
|
const PutPortalUserFieldValues_1 = require("../models/PutPortalUserFieldValues");
|
|
39
41
|
const UpdateSelectedPortalResponse_1 = require("../models/UpdateSelectedPortalResponse");
|
|
40
42
|
/**
|
|
@@ -369,6 +371,9 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
369
371
|
if (requestParameters['search'] != null) {
|
|
370
372
|
queryParameters['search'] = requestParameters['search'];
|
|
371
373
|
}
|
|
374
|
+
if (requestParameters['status'] != null) {
|
|
375
|
+
queryParameters['status'] = requestParameters['status'];
|
|
376
|
+
}
|
|
372
377
|
if (requestParameters['page'] != null) {
|
|
373
378
|
queryParameters['page'] = requestParameters['page'];
|
|
374
379
|
}
|
|
@@ -765,6 +770,56 @@ class PortalApi extends runtime.BaseAPI {
|
|
|
765
770
|
return yield response.value();
|
|
766
771
|
});
|
|
767
772
|
}
|
|
773
|
+
/**
|
|
774
|
+
* Creates request options for putPortalUser without sending the request
|
|
775
|
+
*/
|
|
776
|
+
putPortalUserRequestOpts(requestParameters) {
|
|
777
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
778
|
+
if (requestParameters['portalId'] == null) {
|
|
779
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalUser().');
|
|
780
|
+
}
|
|
781
|
+
if (requestParameters['userId'] == null) {
|
|
782
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putPortalUser().');
|
|
783
|
+
}
|
|
784
|
+
if (requestParameters['putPortalUser'] == null) {
|
|
785
|
+
throw new runtime.RequiredError('putPortalUser', 'Required parameter "putPortalUser" was null or undefined when calling putPortalUser().');
|
|
786
|
+
}
|
|
787
|
+
const queryParameters = {};
|
|
788
|
+
const headerParameters = {};
|
|
789
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
790
|
+
let urlPath = `/portals/{portalId}/users/{userId}`;
|
|
791
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
792
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
793
|
+
return {
|
|
794
|
+
path: urlPath,
|
|
795
|
+
method: 'PUT',
|
|
796
|
+
headers: headerParameters,
|
|
797
|
+
query: queryParameters,
|
|
798
|
+
body: (0, PutPortalUser_1.PutPortalUserToJSON)(requestParameters['putPortalUser']),
|
|
799
|
+
};
|
|
800
|
+
});
|
|
801
|
+
}
|
|
802
|
+
/**
|
|
803
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
804
|
+
* Update admin-managed details for a portal member
|
|
805
|
+
*/
|
|
806
|
+
putPortalUserRaw(requestParameters, initOverrides) {
|
|
807
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
808
|
+
const requestOptions = yield this.putPortalUserRequestOpts(requestParameters);
|
|
809
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
810
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPortalUser_1.GetPortalUserFromJSON)(jsonValue));
|
|
811
|
+
});
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
815
|
+
* Update admin-managed details for a portal member
|
|
816
|
+
*/
|
|
817
|
+
putPortalUser(requestParameters, initOverrides) {
|
|
818
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
819
|
+
const response = yield this.putPortalUserRaw(requestParameters, initOverrides);
|
|
820
|
+
return yield response.value();
|
|
821
|
+
});
|
|
822
|
+
}
|
|
768
823
|
/**
|
|
769
824
|
* Creates request options for putPortalUserFieldConfig without sending the request
|
|
770
825
|
*/
|
|
@@ -955,3 +1010,10 @@ exports.GetPortalUsersRolesEnum = {
|
|
|
955
1010
|
Instructor: 'Instructor',
|
|
956
1011
|
Learner: 'Learner'
|
|
957
1012
|
};
|
|
1013
|
+
/**
|
|
1014
|
+
* @export
|
|
1015
|
+
*/
|
|
1016
|
+
exports.GetPortalUsersStatusEnum = {
|
|
1017
|
+
Active: 'active',
|
|
1018
|
+
Removed: 'removed'
|
|
1019
|
+
};
|
|
@@ -13,6 +13,8 @@ import * as runtime from '../runtime';
|
|
|
13
13
|
import { type GetQuestion } from '../models/GetQuestion';
|
|
14
14
|
import { type GetQuestionList } from '../models/GetQuestionList';
|
|
15
15
|
import { type PostQuestion } from '../models/PostQuestion';
|
|
16
|
+
import { type PostQuestionTags } from '../models/PostQuestionTags';
|
|
17
|
+
import { type PostQuestionTagsResponse } from '../models/PostQuestionTagsResponse';
|
|
16
18
|
import { type PutQuestion } from '../models/PutQuestion';
|
|
17
19
|
export interface DeleteQuestionRequest {
|
|
18
20
|
questionId: string;
|
|
@@ -33,6 +35,9 @@ export interface GetQuestionVersionsRequest {
|
|
|
33
35
|
export interface PostQuestionRequest {
|
|
34
36
|
postQuestion: PostQuestion;
|
|
35
37
|
}
|
|
38
|
+
export interface PostQuestionTagsRequest {
|
|
39
|
+
postQuestionTags: PostQuestionTags;
|
|
40
|
+
}
|
|
36
41
|
export interface PutQuestionRequest {
|
|
37
42
|
questionId: string;
|
|
38
43
|
putQuestion: PutQuestion;
|
|
@@ -101,6 +106,20 @@ export declare class QuestionApi extends runtime.BaseAPI {
|
|
|
101
106
|
* Create a new question
|
|
102
107
|
*/
|
|
103
108
|
postQuestion(requestParameters: PostQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetQuestion>;
|
|
109
|
+
/**
|
|
110
|
+
* Creates request options for postQuestionTags without sending the request
|
|
111
|
+
*/
|
|
112
|
+
postQuestionTagsRequestOpts(requestParameters: PostQuestionTagsRequest): Promise<runtime.RequestOpts>;
|
|
113
|
+
/**
|
|
114
|
+
* Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
|
|
115
|
+
* Add tags to several questions
|
|
116
|
+
*/
|
|
117
|
+
postQuestionTagsRaw(requestParameters: PostQuestionTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostQuestionTagsResponse>>;
|
|
118
|
+
/**
|
|
119
|
+
* Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
|
|
120
|
+
* Add tags to several questions
|
|
121
|
+
*/
|
|
122
|
+
postQuestionTags(requestParameters: PostQuestionTagsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostQuestionTagsResponse>;
|
|
104
123
|
/**
|
|
105
124
|
* Creates request options for putQuestion without sending the request
|
|
106
125
|
*/
|
package/dist/apis/QuestionApi.js
CHANGED
|
@@ -27,6 +27,8 @@ const runtime = require("../runtime");
|
|
|
27
27
|
const GetQuestion_1 = require("../models/GetQuestion");
|
|
28
28
|
const GetQuestionList_1 = require("../models/GetQuestionList");
|
|
29
29
|
const PostQuestion_1 = require("../models/PostQuestion");
|
|
30
|
+
const PostQuestionTags_1 = require("../models/PostQuestionTags");
|
|
31
|
+
const PostQuestionTagsResponse_1 = require("../models/PostQuestionTagsResponse");
|
|
30
32
|
const PutQuestion_1 = require("../models/PutQuestion");
|
|
31
33
|
/**
|
|
32
34
|
*
|
|
@@ -238,6 +240,48 @@ class QuestionApi extends runtime.BaseAPI {
|
|
|
238
240
|
return yield response.value();
|
|
239
241
|
});
|
|
240
242
|
}
|
|
243
|
+
/**
|
|
244
|
+
* Creates request options for postQuestionTags without sending the request
|
|
245
|
+
*/
|
|
246
|
+
postQuestionTagsRequestOpts(requestParameters) {
|
|
247
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
248
|
+
if (requestParameters['postQuestionTags'] == null) {
|
|
249
|
+
throw new runtime.RequiredError('postQuestionTags', 'Required parameter "postQuestionTags" was null or undefined when calling postQuestionTags().');
|
|
250
|
+
}
|
|
251
|
+
const queryParameters = {};
|
|
252
|
+
const headerParameters = {};
|
|
253
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
254
|
+
let urlPath = `/questions/tags`;
|
|
255
|
+
return {
|
|
256
|
+
path: urlPath,
|
|
257
|
+
method: 'POST',
|
|
258
|
+
headers: headerParameters,
|
|
259
|
+
query: queryParameters,
|
|
260
|
+
body: (0, PostQuestionTags_1.PostQuestionTagsToJSON)(requestParameters['postQuestionTags']),
|
|
261
|
+
};
|
|
262
|
+
});
|
|
263
|
+
}
|
|
264
|
+
/**
|
|
265
|
+
* Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
|
|
266
|
+
* Add tags to several questions
|
|
267
|
+
*/
|
|
268
|
+
postQuestionTagsRaw(requestParameters, initOverrides) {
|
|
269
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
270
|
+
const requestOptions = yield this.postQuestionTagsRequestOpts(requestParameters);
|
|
271
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
272
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostQuestionTagsResponse_1.PostQuestionTagsResponseFromJSON)(jsonValue));
|
|
273
|
+
});
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* Adds the given tags to every listed question, keeping existing tags. Tags are metadata, so no new question versions are created.
|
|
277
|
+
* Add tags to several questions
|
|
278
|
+
*/
|
|
279
|
+
postQuestionTags(requestParameters, initOverrides) {
|
|
280
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
281
|
+
const response = yield this.postQuestionTagsRaw(requestParameters, initOverrides);
|
|
282
|
+
return yield response.value();
|
|
283
|
+
});
|
|
284
|
+
}
|
|
241
285
|
/**
|
|
242
286
|
* Creates request options for putQuestion without sending the request
|
|
243
287
|
*/
|
|
@@ -50,6 +50,7 @@ export interface GetZapierCoursesRequest {
|
|
|
50
50
|
page?: number;
|
|
51
51
|
pageSize?: number;
|
|
52
52
|
search?: string;
|
|
53
|
+
customerRef?: string;
|
|
53
54
|
}
|
|
54
55
|
export interface GetZapierEventsRequest {
|
|
55
56
|
xAPIKEY: string;
|
|
@@ -69,7 +70,8 @@ export interface GetZapierShopifyCourseMappingsRequest {
|
|
|
69
70
|
export interface GetZapierUsersRequest {
|
|
70
71
|
xAPIKEY: string;
|
|
71
72
|
xPORTALSUBDOMAIN: string;
|
|
72
|
-
email
|
|
73
|
+
email?: string;
|
|
74
|
+
customerRef?: string;
|
|
73
75
|
}
|
|
74
76
|
export interface PostCustomWebhookIntegrationRequest {
|
|
75
77
|
postCustomWebhookIntegration: PostCustomWebhookIntegration;
|
|
@@ -227,11 +229,13 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
227
229
|
*/
|
|
228
230
|
getZapierUsersRequestOpts(requestParameters: GetZapierUsersRequest): Promise<runtime.RequestOpts>;
|
|
229
231
|
/**
|
|
230
|
-
*
|
|
232
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
233
|
+
* Find a learner by exact email address or customer_ref
|
|
231
234
|
*/
|
|
232
235
|
getZapierUsersRaw(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierUsers>>;
|
|
233
236
|
/**
|
|
234
|
-
*
|
|
237
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
238
|
+
* Find a learner by exact email address or customer_ref
|
|
235
239
|
*/
|
|
236
240
|
getZapierUsers(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierUsers>;
|
|
237
241
|
/**
|
|
@@ -230,6 +230,9 @@ export class IntegrationApi extends runtime.BaseAPI {
|
|
|
230
230
|
if (requestParameters['search'] != null) {
|
|
231
231
|
queryParameters['search'] = requestParameters['search'];
|
|
232
232
|
}
|
|
233
|
+
if (requestParameters['customerRef'] != null) {
|
|
234
|
+
queryParameters['customer_ref'] = requestParameters['customerRef'];
|
|
235
|
+
}
|
|
233
236
|
const headerParameters = {};
|
|
234
237
|
if (requestParameters['xAPIKEY'] != null) {
|
|
235
238
|
headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
|
|
@@ -464,13 +467,13 @@ export class IntegrationApi extends runtime.BaseAPI {
|
|
|
464
467
|
if (requestParameters['xPORTALSUBDOMAIN'] == null) {
|
|
465
468
|
throw new runtime.RequiredError('xPORTALSUBDOMAIN', 'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierUsers().');
|
|
466
469
|
}
|
|
467
|
-
if (requestParameters['email'] == null) {
|
|
468
|
-
throw new runtime.RequiredError('email', 'Required parameter "email" was null or undefined when calling getZapierUsers().');
|
|
469
|
-
}
|
|
470
470
|
const queryParameters = {};
|
|
471
471
|
if (requestParameters['email'] != null) {
|
|
472
472
|
queryParameters['email'] = requestParameters['email'];
|
|
473
473
|
}
|
|
474
|
+
if (requestParameters['customerRef'] != null) {
|
|
475
|
+
queryParameters['customer_ref'] = requestParameters['customerRef'];
|
|
476
|
+
}
|
|
474
477
|
const headerParameters = {};
|
|
475
478
|
if (requestParameters['xAPIKEY'] != null) {
|
|
476
479
|
headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
|
|
@@ -488,7 +491,8 @@ export class IntegrationApi extends runtime.BaseAPI {
|
|
|
488
491
|
});
|
|
489
492
|
}
|
|
490
493
|
/**
|
|
491
|
-
*
|
|
494
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
495
|
+
* Find a learner by exact email address or customer_ref
|
|
492
496
|
*/
|
|
493
497
|
getZapierUsersRaw(requestParameters, initOverrides) {
|
|
494
498
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -498,7 +502,8 @@ export class IntegrationApi extends runtime.BaseAPI {
|
|
|
498
502
|
});
|
|
499
503
|
}
|
|
500
504
|
/**
|
|
501
|
-
*
|
|
505
|
+
* Send email, customer_ref, or both. When both are sent the learner must match both.
|
|
506
|
+
* Find a learner by exact email address or customer_ref
|
|
502
507
|
*/
|
|
503
508
|
getZapierUsers(requestParameters, initOverrides) {
|
|
504
509
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -14,6 +14,7 @@ import { type GetPortal } from '../models/GetPortal';
|
|
|
14
14
|
import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
|
|
15
15
|
import { type GetPortalList } from '../models/GetPortalList';
|
|
16
16
|
import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
|
|
17
|
+
import { type GetPortalUser } from '../models/GetPortalUser';
|
|
17
18
|
import { type GetPortalUserFieldValues } from '../models/GetPortalUserFieldValues';
|
|
18
19
|
import { type GetPortalUserList } from '../models/GetPortalUserList';
|
|
19
20
|
import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
|
|
@@ -21,6 +22,7 @@ import { type PortalUserFieldConfig } from '../models/PortalUserFieldConfig';
|
|
|
21
22
|
import { type PostPortal } from '../models/PostPortal';
|
|
22
23
|
import { type PostPortalInvite } from '../models/PostPortalInvite';
|
|
23
24
|
import { type PutPortalBranding } from '../models/PutPortalBranding';
|
|
25
|
+
import { type PutPortalUser } from '../models/PutPortalUser';
|
|
24
26
|
import { type PutPortalUserFieldValues } from '../models/PutPortalUserFieldValues';
|
|
25
27
|
import { type UpdateSelectedPortalResponse } from '../models/UpdateSelectedPortalResponse';
|
|
26
28
|
export interface DeletePortalFaviconRequest {
|
|
@@ -50,6 +52,7 @@ export interface GetPortalUsersRequest {
|
|
|
50
52
|
type?: GetPortalUsersTypeEnum;
|
|
51
53
|
roles?: Array<GetPortalUsersRolesEnum>;
|
|
52
54
|
search?: string;
|
|
55
|
+
status?: GetPortalUsersStatusEnum;
|
|
53
56
|
page?: number;
|
|
54
57
|
pageSize?: number;
|
|
55
58
|
}
|
|
@@ -72,6 +75,11 @@ export interface PutPortalBrandingRequest {
|
|
|
72
75
|
portalId: string;
|
|
73
76
|
putPortalBranding: PutPortalBranding;
|
|
74
77
|
}
|
|
78
|
+
export interface PutPortalUserRequest {
|
|
79
|
+
portalId: string;
|
|
80
|
+
userId: string;
|
|
81
|
+
putPortalUser: PutPortalUser;
|
|
82
|
+
}
|
|
75
83
|
export interface PutPortalUserFieldConfigRequest {
|
|
76
84
|
portalId: string;
|
|
77
85
|
portalUserFieldConfig: PortalUserFieldConfig;
|
|
@@ -302,6 +310,20 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
302
310
|
* Update portal branding and complete application theme
|
|
303
311
|
*/
|
|
304
312
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
313
|
+
/**
|
|
314
|
+
* Creates request options for putPortalUser without sending the request
|
|
315
|
+
*/
|
|
316
|
+
putPortalUserRequestOpts(requestParameters: PutPortalUserRequest): Promise<runtime.RequestOpts>;
|
|
317
|
+
/**
|
|
318
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
319
|
+
* Update admin-managed details for a portal member
|
|
320
|
+
*/
|
|
321
|
+
putPortalUserRaw(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUser>>;
|
|
322
|
+
/**
|
|
323
|
+
* Sets or clears the member\'s customer_ref for this portal.
|
|
324
|
+
* Update admin-managed details for a portal member
|
|
325
|
+
*/
|
|
326
|
+
putPortalUser(requestParameters: PutPortalUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUser>;
|
|
305
327
|
/**
|
|
306
328
|
* Creates request options for putPortalUserFieldConfig without sending the request
|
|
307
329
|
*/
|
|
@@ -368,3 +390,11 @@ export declare const GetPortalUsersRolesEnum: {
|
|
|
368
390
|
readonly Learner: "Learner";
|
|
369
391
|
};
|
|
370
392
|
export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];
|
|
393
|
+
/**
|
|
394
|
+
* @export
|
|
395
|
+
*/
|
|
396
|
+
export declare const GetPortalUsersStatusEnum: {
|
|
397
|
+
readonly Active: "active";
|
|
398
|
+
readonly Removed: "removed";
|
|
399
|
+
};
|
|
400
|
+
export type GetPortalUsersStatusEnum = typeof GetPortalUsersStatusEnum[keyof typeof GetPortalUsersStatusEnum];
|