@easyedu/js-lsm-api 1.116.0 → 1.118.0

package/src/apis/IntegrationApi.ts

@@ -13,6 +13,11 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type CustomWebhookIntegration,
+    CustomWebhookIntegrationFromJSON,
+    CustomWebhookIntegrationToJSON,
+} from '../models/CustomWebhookIntegration';
 import {
     type GetZapierCourses,
     GetZapierCoursesFromJSON,
@@ -38,6 +43,16 @@ import {
     GetZapierUsersFromJSON,
     GetZapierUsersToJSON,
 } from '../models/GetZapierUsers';
+import {
+    type IntegrationEvent,
+    IntegrationEventFromJSON,
+    IntegrationEventToJSON,
+} from '../models/IntegrationEvent';
+import {
+    type PostCustomWebhookIntegration,
+    PostCustomWebhookIntegrationFromJSON,
+    PostCustomWebhookIntegrationToJSON,
+} from '../models/PostCustomWebhookIntegration';
 import {
     type PostZapierEnrollment,
     PostZapierEnrollmentFromJSON,
@@ -68,11 +83,21 @@ import {
     PostZapierShopifyEnrollmentResponseFromJSON,
     PostZapierShopifyEnrollmentResponseToJSON,
 } from '../models/PostZapierShopifyEnrollmentResponse';
+import {
+    type PostZapierSubscription,
+    PostZapierSubscriptionFromJSON,
+    PostZapierSubscriptionToJSON,
+} from '../models/PostZapierSubscription';
 import {
     type PostZapierUser,
     PostZapierUserFromJSON,
     PostZapierUserToJSON,
 } from '../models/PostZapierUser';
+import {
+    type PutCustomWebhookIntegration,
+    PutCustomWebhookIntegrationFromJSON,
+    PutCustomWebhookIntegrationToJSON,
+} from '../models/PutCustomWebhookIntegration';
 import {
     type PutZapierSetup,
     PutZapierSetupFromJSON,
@@ -93,16 +118,31 @@ import {
     ZapierShopifyCourseMappingFromJSON,
     ZapierShopifyCourseMappingToJSON,
 } from '../models/ZapierShopifyCourseMapping';
+import {
+    type ZapierSubscription,
+    ZapierSubscriptionFromJSON,
+    ZapierSubscriptionToJSON,
+} from '../models/ZapierSubscription';
 import {
     type ZapierUser,
     ZapierUserFromJSON,
     ZapierUserToJSON,
 } 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;
@@ -111,6 +151,13 @@ export interface GetZapierCoursesRequest {
     search?: string;
 }
 
+export interface GetZapierEventsRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+    eventType: GetZapierEventsEventTypeEnum;
+    pageSize?: number;
+}
+
 export interface GetZapierMeRequest {
     xAPIKEY: string;
     xPORTALSUBDOMAIN: string;
@@ -128,6 +175,10 @@ export interface GetZapierUsersRequest {
     email: string;
 }
 
+export interface PostCustomWebhookIntegrationRequest {
+    postCustomWebhookIntegration: PostCustomWebhookIntegration;
+}
+
 export interface PostZapierEnrollmentRequest {
     xAPIKEY: string;
     xPORTALSUBDOMAIN: string;
@@ -150,12 +201,23 @@ export interface PostZapierShopifyEnrollmentRequest {
     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;
@@ -166,6 +228,50 @@ export interface PutZapierSetupRequest {
  */
 export class IntegrationApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteCustomWebhookIntegration without sending the request
+     */
+    async deleteCustomWebhookIntegrationRequestOpts(requestParameters: DeleteCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['webhookIntegrationId'] == null) {
+            throw new runtime.RequiredError(
+                'webhookIntegrationId',
+                'Required parameter "webhookIntegrationId" was null or undefined when calling deleteCustomWebhookIntegration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/integrations/webhooks/{webhookIntegrationId}`;
+        urlPath = urlPath.replace('{webhookIntegrationId}', encodeURIComponent(String(requestParameters['webhookIntegrationId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a custom webhook destination
+     */
+    async deleteCustomWebhookIntegrationRaw(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCustomWebhookIntegrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a custom webhook destination
+     */
+    async deleteCustomWebhookIntegration(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCustomWebhookIntegrationRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for deleteZapierSetup without sending the request
      */
@@ -210,6 +316,109 @@ export class IntegrationApi extends runtime.BaseAPI {
         await this.deleteZapierSetupRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteZapierSubscription without sending the request
+     */
+    async deleteZapierSubscriptionRequestOpts(requestParameters: DeleteZapierSubscriptionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['subscriptionId'] == null) {
+            throw new runtime.RequiredError(
+                'subscriptionId',
+                'Required parameter "subscriptionId" was null or undefined when calling deleteZapierSubscription().'
+            );
+        }
+
+        if (requestParameters['xAPIKEY'] == null) {
+            throw new runtime.RequiredError(
+                'xAPIKEY',
+                'Required parameter "xAPIKEY" was null or undefined when calling deleteZapierSubscription().'
+            );
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] == null) {
+            throw new runtime.RequiredError(
+                'xPORTALSUBDOMAIN',
+                'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling deleteZapierSubscription().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xAPIKEY'] != null) {
+            headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] != null) {
+            headerParameters['X-PORTAL-SUBDOMAIN'] = String(requestParameters['xPORTALSUBDOMAIN']);
+        }
+
+
+        let urlPath = `/integrations/zapier/subscriptions/{subscriptionId}`;
+        urlPath = urlPath.replace('{subscriptionId}', encodeURIComponent(String(requestParameters['subscriptionId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Unsubscribe a Zap from an Edaxu lifecycle event
+     */
+    async deleteZapierSubscriptionRaw(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteZapierSubscriptionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Unsubscribe a Zap from an Edaxu lifecycle event
+     */
+    async deleteZapierSubscription(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteZapierSubscriptionRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getCustomWebhookIntegrations without sending the request
+     */
+    async getCustomWebhookIntegrationsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/integrations/webhooks`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List custom webhook destinations for the selected portal
+     */
+    async getCustomWebhookIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomWebhookIntegration>>> {
+        const requestOptions = await this.getCustomWebhookIntegrationsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CustomWebhookIntegrationFromJSON));
+    }
+
+    /**
+     * List custom webhook destinations for the selected portal
+     */
+    async getCustomWebhookIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomWebhookIntegration>> {
+        const response = await this.getCustomWebhookIntegrationsRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getZapierCourses without sending the request
      */
@@ -281,6 +490,80 @@ export class IntegrationApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getZapierEvents without sending the request
+     */
+    async getZapierEventsRequestOpts(requestParameters: GetZapierEventsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['xAPIKEY'] == null) {
+            throw new runtime.RequiredError(
+                'xAPIKEY',
+                'Required parameter "xAPIKEY" was null or undefined when calling getZapierEvents().'
+            );
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] == null) {
+            throw new runtime.RequiredError(
+                'xPORTALSUBDOMAIN',
+                'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierEvents().'
+            );
+        }
+
+        if (requestParameters['eventType'] == null) {
+            throw new runtime.RequiredError(
+                'eventType',
+                'Required parameter "eventType" was null or undefined when calling getZapierEvents().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['eventType'] != null) {
+            queryParameters['eventType'] = requestParameters['eventType'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xAPIKEY'] != null) {
+            headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] != null) {
+            headerParameters['X-PORTAL-SUBDOMAIN'] = String(requestParameters['xPORTALSUBDOMAIN']);
+        }
+
+
+        let urlPath = `/integrations/zapier/events`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List recent lifecycle events for Zapier trigger setup
+     */
+    async getZapierEventsRaw(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationEvent>>> {
+        const requestOptions = await this.getZapierEventsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IntegrationEventFromJSON));
+    }
+
+    /**
+     * List recent lifecycle events for Zapier trigger setup
+     */
+    async getZapierEvents(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationEvent>> {
+        const response = await this.getZapierEventsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getZapierMe without sending the request
      */
@@ -510,6 +793,53 @@ export class IntegrationApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCustomWebhookIntegration without sending the request
+     */
+    async postCustomWebhookIntegrationRequestOpts(requestParameters: PostCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postCustomWebhookIntegration'] == null) {
+            throw new runtime.RequiredError(
+                'postCustomWebhookIntegration',
+                'Required parameter "postCustomWebhookIntegration" was null or undefined when calling postCustomWebhookIntegration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/integrations/webhooks`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostCustomWebhookIntegrationToJSON(requestParameters['postCustomWebhookIntegration']),
+        };
+    }
+
+    /**
+     * Create a custom webhook destination for lifecycle events
+     */
+    async postCustomWebhookIntegrationRaw(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>> {
+        const requestOptions = await this.postCustomWebhookIntegrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CustomWebhookIntegrationFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a custom webhook destination for lifecycle events
+     */
+    async postCustomWebhookIntegration(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration> {
+        const response = await this.postCustomWebhookIntegrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postZapierEnrollment without sending the request
      */
@@ -764,6 +1094,75 @@ export class IntegrationApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postZapierSubscription without sending the request
+     */
+    async postZapierSubscriptionRequestOpts(requestParameters: PostZapierSubscriptionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['xAPIKEY'] == null) {
+            throw new runtime.RequiredError(
+                'xAPIKEY',
+                'Required parameter "xAPIKEY" was null or undefined when calling postZapierSubscription().'
+            );
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] == null) {
+            throw new runtime.RequiredError(
+                'xPORTALSUBDOMAIN',
+                'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling postZapierSubscription().'
+            );
+        }
+
+        if (requestParameters['postZapierSubscription'] == null) {
+            throw new runtime.RequiredError(
+                'postZapierSubscription',
+                'Required parameter "postZapierSubscription" was null or undefined when calling postZapierSubscription().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['xAPIKEY'] != null) {
+            headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] != null) {
+            headerParameters['X-PORTAL-SUBDOMAIN'] = String(requestParameters['xPORTALSUBDOMAIN']);
+        }
+
+
+        let urlPath = `/integrations/zapier/subscriptions`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostZapierSubscriptionToJSON(requestParameters['postZapierSubscription']),
+        };
+    }
+
+    /**
+     * Subscribe a Zap to an Edaxu lifecycle event
+     */
+    async postZapierSubscriptionRaw(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierSubscription>> {
+        const requestOptions = await this.postZapierSubscriptionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ZapierSubscriptionFromJSON(jsonValue));
+    }
+
+    /**
+     * Subscribe a Zap to an Edaxu lifecycle event
+     */
+    async postZapierSubscription(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierSubscription> {
+        const response = await this.postZapierSubscriptionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postZapierUser without sending the request
      */
@@ -833,6 +1232,61 @@ export class IntegrationApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putCustomWebhookIntegration without sending the request
+     */
+    async putCustomWebhookIntegrationRequestOpts(requestParameters: PutCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['webhookIntegrationId'] == null) {
+            throw new runtime.RequiredError(
+                'webhookIntegrationId',
+                'Required parameter "webhookIntegrationId" was null or undefined when calling putCustomWebhookIntegration().'
+            );
+        }
+
+        if (requestParameters['putCustomWebhookIntegration'] == null) {
+            throw new runtime.RequiredError(
+                'putCustomWebhookIntegration',
+                'Required parameter "putCustomWebhookIntegration" was null or undefined when calling putCustomWebhookIntegration().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/integrations/webhooks/{webhookIntegrationId}`;
+        urlPath = urlPath.replace('{webhookIntegrationId}', encodeURIComponent(String(requestParameters['webhookIntegrationId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutCustomWebhookIntegrationToJSON(requestParameters['putCustomWebhookIntegration']),
+        };
+    }
+
+    /**
+     * Update a custom webhook destination
+     */
+    async putCustomWebhookIntegrationRaw(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>> {
+        const requestOptions = await this.putCustomWebhookIntegrationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CustomWebhookIntegrationFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a custom webhook destination
+     */
+    async putCustomWebhookIntegration(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration> {
+        const response = await this.putCustomWebhookIntegrationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putZapierSetup without sending the request
      */
@@ -889,3 +1343,15 @@ export class IntegrationApi extends runtime.BaseAPI {
     }
 
 }
+
+/**
+ * @export
+ */
+export const GetZapierEventsEventTypeEnum = {
+    ComEdaxuEnrollmentEnrolledV1: 'com.edaxu.enrollment.enrolled.v1',
+    ComEdaxuEnrollmentCompletedV1: 'com.edaxu.enrollment.completed.v1',
+    ComEdaxuCertificateIssuedV1: 'com.edaxu.certificate.issued.v1',
+    ComEdaxuPortalUserInvitedV1: 'com.edaxu.portal.user_invited.v1',
+    ComEdaxuPortalUserJoinedV1: 'com.edaxu.portal.user_joined.v1'
+} as const;
+export type GetZapierEventsEventTypeEnum = typeof GetZapierEventsEventTypeEnum[keyof typeof GetZapierEventsEventTypeEnum];