@easyedu/js-lsm-api 1.114.0 → 1.116.0

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

@@ -0,0 +1,229 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * 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;
+}
+/**
+ *
+ */
+export declare class IntegrationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteZapierSetup without sending the request
+     */
+    deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * 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
+     */
+    getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe>;
+    /**
+     * Creates request options for getZapierSetup without sending the request
+     */
+    getZapierSetupRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>>;
+    /**
+     * 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
+     */
+    postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>>;
+    /**
+     * 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
+     */
+    putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
+}