@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/dist/esm/apis/IntegrationApi.d.ts

@@ -10,22 +10,102 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type CustomWebhookIntegration } from '../models/CustomWebhookIntegration';
+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 IntegrationEvent } from '../models/IntegrationEvent';
+import { type PostCustomWebhookIntegration } from '../models/PostCustomWebhookIntegration';
+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 PostZapierSubscription } from '../models/PostZapierSubscription';
+import { type PostZapierUser } from '../models/PostZapierUser';
+import { type PutCustomWebhookIntegration } from '../models/PutCustomWebhookIntegration';
 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 ZapierSubscription } from '../models/ZapierSubscription';
+import { type ZapierUser } from '../models/ZapierUser';
+export interface DeleteCustomWebhookIntegrationRequest {
+    webhookIntegrationId: string;
+}
 export interface DeleteZapierSetupRequest {
     zapierIntegrationId: string;
 }
+export interface DeleteZapierSubscriptionRequest {
+    subscriptionId: string;
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+}
+export interface GetZapierCoursesRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+}
+export interface GetZapierEventsRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    eventType: GetZapierEventsEventTypeEnum;
+    pageSize?: number;
+}
 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 PostCustomWebhookIntegrationRequest {
+    postCustomWebhookIntegration: PostCustomWebhookIntegration;
+}
+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 PostZapierSubscriptionRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierSubscription: PostZapierSubscription;
+}
+export interface PostZapierUserRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    postZapierUser: PostZapierUser;
+}
+export interface PutCustomWebhookIntegrationRequest {
+    webhookIntegrationId: string;
+    putCustomWebhookIntegration: PutCustomWebhookIntegration;
+}
 export interface PutZapierSetupRequest {
     zapierIntegrationId: string;
     putZapierSetup: PutZapierSetup;
@@ -34,6 +114,18 @@ export interface PutZapierSetupRequest {
  *
  */
 export declare class IntegrationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteCustomWebhookIntegration without sending the request
+     */
+    deleteCustomWebhookIntegrationRequestOpts(requestParameters: DeleteCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete a custom webhook destination
+     */
+    deleteCustomWebhookIntegrationRaw(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a custom webhook destination
+     */
+    deleteCustomWebhookIntegration(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for deleteZapierSetup without sending the request
      */
@@ -46,6 +138,54 @@ 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 deleteZapierSubscription without sending the request
+     */
+    deleteZapierSubscriptionRequestOpts(requestParameters: DeleteZapierSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Unsubscribe a Zap from an Edaxu lifecycle event
+     */
+    deleteZapierSubscriptionRaw(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unsubscribe a Zap from an Edaxu lifecycle event
+     */
+    deleteZapierSubscription(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCustomWebhookIntegrations without sending the request
+     */
+    getCustomWebhookIntegrationsRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List custom webhook destinations for the selected portal
+     */
+    getCustomWebhookIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomWebhookIntegration>>>;
+    /**
+     * List custom webhook destinations for the selected portal
+     */
+    getCustomWebhookIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomWebhookIntegration>>;
+    /**
+     * 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 getZapierEvents without sending the request
+     */
+    getZapierEventsRequestOpts(requestParameters: GetZapierEventsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List recent lifecycle events for Zapier trigger setup
+     */
+    getZapierEventsRaw(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationEvent>>>;
+    /**
+     * List recent lifecycle events for Zapier trigger setup
+     */
+    getZapierEvents(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationEvent>>;
     /**
      * Creates request options for getZapierMe without sending the request
      */
@@ -70,6 +210,54 @@ 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 postCustomWebhookIntegration without sending the request
+     */
+    postCustomWebhookIntegrationRequestOpts(requestParameters: PostCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a custom webhook destination for lifecycle events
+     */
+    postCustomWebhookIntegrationRaw(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>>;
+    /**
+     * Create a custom webhook destination for lifecycle events
+     */
+    postCustomWebhookIntegration(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration>;
+    /**
+     * 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 +270,66 @@ 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 postZapierSubscription without sending the request
+     */
+    postZapierSubscriptionRequestOpts(requestParameters: PostZapierSubscriptionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Subscribe a Zap to an Edaxu lifecycle event
+     */
+    postZapierSubscriptionRaw(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierSubscription>>;
+    /**
+     * Subscribe a Zap to an Edaxu lifecycle event
+     */
+    postZapierSubscription(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierSubscription>;
+    /**
+     * 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 putCustomWebhookIntegration without sending the request
+     */
+    putCustomWebhookIntegrationRequestOpts(requestParameters: PutCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a custom webhook destination
+     */
+    putCustomWebhookIntegrationRaw(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>>;
+    /**
+     * Update a custom webhook destination
+     */
+    putCustomWebhookIntegration(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration>;
     /**
      * Creates request options for putZapierSetup without sending the request
      */
@@ -95,3 +343,12 @@ export declare class IntegrationApi extends runtime.BaseAPI {
      */
     putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
 }
+/**
+ * @export
+ */
+export declare const GetZapierEventsEventTypeEnum: {
+    readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
+    readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
+    readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
+};
+export type GetZapierEventsEventTypeEnum = typeof GetZapierEventsEventTypeEnum[keyof typeof GetZapierEventsEventTypeEnum];