@easyedu/js-lsm-api 1.115.0 → 1.116.0

package/.openapi-generator/FILES

@@ -174,8 +174,11 @@ docs/GetUserCourseListItemCourse.md
 docs/GetUserCourseListItemEnrollment.md
 docs/GetUserCourseListItemProgress.md
 docs/GetUserRole.md
+docs/GetZapierCourses.md
 docs/GetZapierMe.md
 docs/GetZapierSetup.md
+docs/GetZapierShopifyCourseMappings.md
+docs/GetZapierUsers.md
 docs/IntegrationApi.md
 docs/LearnerExperienceApi.md
 docs/LearnerExperienceVersion.md
@@ -273,8 +276,13 @@ docs/PostSignupRequest.md
 docs/PostSignupRequestResponse.md
 docs/PostSupportTicket.md
 docs/PostSupportTicketComment.md
+docs/PostZapierEnrollment.md
 docs/PostZapierSetup.md
 docs/PostZapierSetupResponse.md
+docs/PostZapierShopifyCourseMapping.md
+docs/PostZapierShopifyEnrollment.md
+docs/PostZapierShopifyEnrollmentResponse.md
+docs/PostZapierUser.md
 docs/ProgressionGateError.md
 docs/ProgressionLockReason.md
 docs/PutAttemptAllowance.md
@@ -341,7 +349,11 @@ docs/UpdateSelectedPortalResponse.md
 docs/UpdateSelectedPortalResponseHostPortal.md
 docs/UpdateSelectedPortalResponseSelectedPortal.md
 docs/UserApi.md
+docs/ZapierCourse.md
+docs/ZapierEnrollment.md
 docs/ZapierIntegration.md
+docs/ZapierShopifyCourseMapping.md
+docs/ZapierUser.md
 package.json
 src/apis/CertificateApi.ts
 src/apis/CertificateTemplateApi.ts
@@ -531,8 +543,11 @@ src/models/GetUserCourseListItemCourse.ts
 src/models/GetUserCourseListItemEnrollment.ts
 src/models/GetUserCourseListItemProgress.ts
 src/models/GetUserRole.ts
+src/models/GetZapierCourses.ts
 src/models/GetZapierMe.ts
 src/models/GetZapierSetup.ts
+src/models/GetZapierShopifyCourseMappings.ts
+src/models/GetZapierUsers.ts
 src/models/LearnerExperienceVersion.ts
 src/models/LibraryQuizCriteriaPreviewQuestion.ts
 src/models/LibraryQuizCriterion.ts
@@ -624,8 +639,13 @@ src/models/PostSignupRequest.ts
 src/models/PostSignupRequestResponse.ts
 src/models/PostSupportTicket.ts
 src/models/PostSupportTicketComment.ts
+src/models/PostZapierEnrollment.ts
 src/models/PostZapierSetup.ts
 src/models/PostZapierSetupResponse.ts
+src/models/PostZapierShopifyCourseMapping.ts
+src/models/PostZapierShopifyEnrollment.ts
+src/models/PostZapierShopifyEnrollmentResponse.ts
+src/models/PostZapierUser.ts
 src/models/ProgressionGateError.ts
 src/models/ProgressionLockReason.ts
 src/models/PutAttemptAllowance.ts
@@ -684,7 +704,11 @@ src/models/SupportTicketUser.ts
 src/models/UpdateSelectedPortalResponse.ts
 src/models/UpdateSelectedPortalResponseHostPortal.ts
 src/models/UpdateSelectedPortalResponseSelectedPortal.ts
+src/models/ZapierCourse.ts
+src/models/ZapierEnrollment.ts
 src/models/ZapierIntegration.ts
+src/models/ZapierShopifyCourseMapping.ts
+src/models/ZapierUser.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.esm.json

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.115.0
+# @easyedu/js-lsm-api@1.116.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -274,9 +274,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
 *EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
 *IntegrationApi* | [**deleteZapierSetup**](docs/IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key
+*IntegrationApi* | [**getZapierCourses**](docs/IntegrationApi.md#getzapiercourses) | **GET** /integrations/zapier/courses | List published courses available to a Zapier connection
 *IntegrationApi* | [**getZapierMe**](docs/IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions
 *IntegrationApi* | [**getZapierSetup**](docs/IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal
+*IntegrationApi* | [**getZapierShopifyCourseMappings**](docs/IntegrationApi.md#getzapiershopifycoursemappings) | **GET** /integrations/zapier/shopify/course-mappings | List Shopify variant-to-course mappings
+*IntegrationApi* | [**getZapierUsers**](docs/IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address
+*IntegrationApi* | [**postZapierEnrollment**](docs/IntegrationApi.md#postzapierenrollment) | **POST** /integrations/zapier/enrollments | Enroll an existing learner in a course
 *IntegrationApi* | [**postZapierSetup**](docs/IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal
+*IntegrationApi* | [**postZapierShopifyCourseMapping**](docs/IntegrationApi.md#postzapiershopifycoursemapping) | **POST** /integrations/zapier/shopify/course-mappings | Create or update a Shopify variant-to-course mapping
+*IntegrationApi* | [**postZapierShopifyEnrollment**](docs/IntegrationApi.md#postzapiershopifyenrollment) | **POST** /integrations/zapier/shopify/enrollments | Find or invite a Shopify customer and enroll them using the purchased variant mapping
+*IntegrationApi* | [**postZapierUser**](docs/IntegrationApi.md#postzapieruser) | **POST** /integrations/zapier/users | Find or invite a learner to the connected portal
 *IntegrationApi* | [**putZapierSetup**](docs/IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions
 *LearnerExperienceApi* | [**deleteLearnerExperienceDraft**](docs/LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft
 *LearnerExperienceApi* | [**getCurrentLearnerDashboard**](docs/LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data
@@ -547,8 +554,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetUserCourseListItemEnrollment](docs/GetUserCourseListItemEnrollment.md)
 - [GetUserCourseListItemProgress](docs/GetUserCourseListItemProgress.md)
 - [GetUserRole](docs/GetUserRole.md)
+- [GetZapierCourses](docs/GetZapierCourses.md)
 - [GetZapierMe](docs/GetZapierMe.md)
 - [GetZapierSetup](docs/GetZapierSetup.md)
+- [GetZapierShopifyCourseMappings](docs/GetZapierShopifyCourseMappings.md)
+- [GetZapierUsers](docs/GetZapierUsers.md)
 - [LearnerExperienceVersion](docs/LearnerExperienceVersion.md)
 - [LibraryQuizCriteriaPreviewQuestion](docs/LibraryQuizCriteriaPreviewQuestion.md)
 - [LibraryQuizCriterion](docs/LibraryQuizCriterion.md)
@@ -640,8 +650,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
 - [PostSupportTicket](docs/PostSupportTicket.md)
 - [PostSupportTicketComment](docs/PostSupportTicketComment.md)
+- [PostZapierEnrollment](docs/PostZapierEnrollment.md)
 - [PostZapierSetup](docs/PostZapierSetup.md)
 - [PostZapierSetupResponse](docs/PostZapierSetupResponse.md)
+- [PostZapierShopifyCourseMapping](docs/PostZapierShopifyCourseMapping.md)
+- [PostZapierShopifyEnrollment](docs/PostZapierShopifyEnrollment.md)
+- [PostZapierShopifyEnrollmentResponse](docs/PostZapierShopifyEnrollmentResponse.md)
+- [PostZapierUser](docs/PostZapierUser.md)
 - [ProgressionGateError](docs/ProgressionGateError.md)
 - [ProgressionLockReason](docs/ProgressionLockReason.md)
 - [PutAttemptAllowance](docs/PutAttemptAllowance.md)
@@ -700,7 +715,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [UpdateSelectedPortalResponse](docs/UpdateSelectedPortalResponse.md)
 - [UpdateSelectedPortalResponseHostPortal](docs/UpdateSelectedPortalResponseHostPortal.md)
 - [UpdateSelectedPortalResponseSelectedPortal](docs/UpdateSelectedPortalResponseSelectedPortal.md)
+- [ZapierCourse](docs/ZapierCourse.md)
+- [ZapierEnrollment](docs/ZapierEnrollment.md)
 - [ZapierIntegration](docs/ZapierIntegration.md)
+- [ZapierShopifyCourseMapping](docs/ZapierShopifyCourseMapping.md)
+- [ZapierUser](docs/ZapierUser.md)
 
 ### Authorization
 
@@ -714,7 +733,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.115.0`
+- Package version: `1.116.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/IntegrationApi.d.ts

@@ -10,22 +10,70 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type GetZapierCourses } from '../models/GetZapierCourses';
 import { type GetZapierMe } from '../models/GetZapierMe';
 import { type GetZapierSetup } from '../models/GetZapierSetup';
+import { type GetZapierShopifyCourseMappings } from '../models/GetZapierShopifyCourseMappings';
+import { type GetZapierUsers } from '../models/GetZapierUsers';
+import { type PostZapierEnrollment } from '../models/PostZapierEnrollment';
 import { type PostZapierSetup } from '../models/PostZapierSetup';
 import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
+import { type PostZapierShopifyCourseMapping } from '../models/PostZapierShopifyCourseMapping';
+import { type PostZapierShopifyEnrollment } from '../models/PostZapierShopifyEnrollment';
+import { type PostZapierShopifyEnrollmentResponse } from '../models/PostZapierShopifyEnrollmentResponse';
+import { type PostZapierUser } from '../models/PostZapierUser';
 import { type PutZapierSetup } from '../models/PutZapierSetup';
+import { type ZapierEnrollment } from '../models/ZapierEnrollment';
 import { type ZapierIntegration } from '../models/ZapierIntegration';
+import { type ZapierShopifyCourseMapping } from '../models/ZapierShopifyCourseMapping';
+import { type ZapierUser } from '../models/ZapierUser';
 export interface DeleteZapierSetupRequest {
     zapierIntegrationId: string;
 }
+export interface GetZapierCoursesRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+}
 export interface GetZapierMeRequest {
     xAPIKEY: string;
     xPORTALSUBDOMAIN: string;
 }
+export interface GetZapierShopifyCourseMappingsRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    shopDomain?: string;
+}
+export interface GetZapierUsersRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    email: string;
+}
+export interface PostZapierEnrollmentRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierEnrollment: PostZapierEnrollment;
+}
 export interface PostZapierSetupRequest {
     postZapierSetup: PostZapierSetup;
 }
+export interface PostZapierShopifyCourseMappingRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierShopifyCourseMapping: PostZapierShopifyCourseMapping;
+}
+export interface PostZapierShopifyEnrollmentRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierShopifyEnrollment: PostZapierShopifyEnrollment;
+}
+export interface PostZapierUserRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierUser: PostZapierUser;
+}
 export interface PutZapierSetupRequest {
     zapierIntegrationId: string;
     putZapierSetup: PutZapierSetup;
@@ -46,6 +94,18 @@ export declare class IntegrationApi extends runtime.BaseAPI {
      * Revoke a Zapier connection and its API key
      */
     deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getZapierCourses without sending the request
+     */
+    getZapierCoursesRequestOpts(requestParameters: GetZapierCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List published courses available to a Zapier connection
+     */
+    getZapierCoursesRaw(requestParameters: GetZapierCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierCourses>>;
+    /**
+     * List published courses available to a Zapier connection
+     */
+    getZapierCourses(requestParameters: GetZapierCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierCourses>;
     /**
      * Creates request options for getZapierMe without sending the request
      */
@@ -70,6 +130,42 @@ export declare class IntegrationApi extends runtime.BaseAPI {
      * List Zapier connections and permissions available to the selected portal
      */
     getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup>;
+    /**
+     * Creates request options for getZapierShopifyCourseMappings without sending the request
+     */
+    getZapierShopifyCourseMappingsRequestOpts(requestParameters: GetZapierShopifyCourseMappingsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List Shopify variant-to-course mappings
+     */
+    getZapierShopifyCourseMappingsRaw(requestParameters: GetZapierShopifyCourseMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierShopifyCourseMappings>>;
+    /**
+     * List Shopify variant-to-course mappings
+     */
+    getZapierShopifyCourseMappings(requestParameters: GetZapierShopifyCourseMappingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierShopifyCourseMappings>;
+    /**
+     * Creates request options for getZapierUsers without sending the request
+     */
+    getZapierUsersRequestOpts(requestParameters: GetZapierUsersRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Find a learner by exact email address
+     */
+    getZapierUsersRaw(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierUsers>>;
+    /**
+     * Find a learner by exact email address
+     */
+    getZapierUsers(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierUsers>;
+    /**
+     * Creates request options for postZapierEnrollment without sending the request
+     */
+    postZapierEnrollmentRequestOpts(requestParameters: PostZapierEnrollmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Enroll an existing learner in a course
+     */
+    postZapierEnrollmentRaw(requestParameters: PostZapierEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierEnrollment>>;
+    /**
+     * Enroll an existing learner in a course
+     */
+    postZapierEnrollment(requestParameters: PostZapierEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierEnrollment>;
     /**
      * Creates request options for postZapierSetup without sending the request
      */
@@ -82,6 +178,42 @@ export declare class IntegrationApi extends runtime.BaseAPI {
      * Create a Zapier connection and API key for the selected portal
      */
     postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse>;
+    /**
+     * Creates request options for postZapierShopifyCourseMapping without sending the request
+     */
+    postZapierShopifyCourseMappingRequestOpts(requestParameters: PostZapierShopifyCourseMappingRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create or update a Shopify variant-to-course mapping
+     */
+    postZapierShopifyCourseMappingRaw(requestParameters: PostZapierShopifyCourseMappingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierShopifyCourseMapping>>;
+    /**
+     * Create or update a Shopify variant-to-course mapping
+     */
+    postZapierShopifyCourseMapping(requestParameters: PostZapierShopifyCourseMappingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierShopifyCourseMapping>;
+    /**
+     * Creates request options for postZapierShopifyEnrollment without sending the request
+     */
+    postZapierShopifyEnrollmentRequestOpts(requestParameters: PostZapierShopifyEnrollmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Find or invite a Shopify customer and enroll them using the purchased variant mapping
+     */
+    postZapierShopifyEnrollmentRaw(requestParameters: PostZapierShopifyEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierShopifyEnrollmentResponse>>;
+    /**
+     * Find or invite a Shopify customer and enroll them using the purchased variant mapping
+     */
+    postZapierShopifyEnrollment(requestParameters: PostZapierShopifyEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierShopifyEnrollmentResponse>;
+    /**
+     * Creates request options for postZapierUser without sending the request
+     */
+    postZapierUserRequestOpts(requestParameters: PostZapierUserRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Find or invite a learner to the connected portal
+     */
+    postZapierUserRaw(requestParameters: PostZapierUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierUser>>;
+    /**
+     * Find or invite a learner to the connected portal
+     */
+    postZapierUser(requestParameters: PostZapierUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierUser>;
     /**
      * Creates request options for putZapierSetup without sending the request
      */