@easyedu/js-lsm-api 1.114.0 → 1.116.0

package/src/apis/index.ts

@@ -11,6 +11,7 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
+export * from './IntegrationApi';
 export * from './LearnerExperienceApi';
 export * from './OtherApi';
 export * from './PlayerApi';

package/src/models/GetZapierCourses.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { ZapierCourse } from './ZapierCourse';
+import {
+    ZapierCourseFromJSON,
+    ZapierCourseFromJSONTyped,
+    ZapierCourseToJSON,
+    ZapierCourseToJSONTyped,
+} from './ZapierCourse';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierCourses
+ */
+export interface GetZapierCourses {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    pageSize: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetZapierCourses
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<ZapierCourse>}
+     * @memberof GetZapierCourses
+     */
+    items: Array<ZapierCourse>;
+}
+
+/**
+ * Check if a given object implements the GetZapierCourses interface.
+ */
+export function instanceOfGetZapierCourses(value: object): value is GetZapierCourses {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierCoursesFromJSON(json: any): GetZapierCourses {
+    return GetZapierCoursesFromJSONTyped(json, false);
+}
+
+export function GetZapierCoursesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierCourses {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(ZapierCourseFromJSON)),
+    };
+}
+
+export function GetZapierCoursesToJSON(json: any): GetZapierCourses {
+    return GetZapierCoursesToJSONTyped(json, false);
+}
+
+export function GetZapierCoursesToJSONTyped(value?: GetZapierCourses | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(ZapierCourseToJSON)),
+    };
+}
+

package/src/models/GetZapierMe.ts

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetZapierMe
+ */
+export interface GetZapierMe {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    integrationId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    integrationName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalSubdomain: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof GetZapierMe
+     */
+    permissionKeys: Array<string>;
+}
+
+/**
+ * Check if a given object implements the GetZapierMe interface.
+ */
+export function instanceOfGetZapierMe(value: object): value is GetZapierMe {
+    if (!('integrationId' in value) || value['integrationId'] === undefined) return false;
+    if (!('integrationName' in value) || value['integrationName'] === undefined) return false;
+    if (!('portalId' in value) || value['portalId'] === undefined) return false;
+    if (!('portalName' in value) || value['portalName'] === undefined) return false;
+    if (!('portalSubdomain' in value) || value['portalSubdomain'] === undefined) return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierMeFromJSON(json: any): GetZapierMe {
+    return GetZapierMeFromJSONTyped(json, false);
+}
+
+export function GetZapierMeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierMe {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'integrationId': json['integration_id'],
+        'integrationName': json['integration_name'],
+        'portalId': json['portal_id'],
+        'portalName': json['portal_name'],
+        'portalSubdomain': json['portal_subdomain'],
+        'permissionKeys': json['permission_keys'],
+    };
+}
+
+export function GetZapierMeToJSON(json: any): GetZapierMe {
+    return GetZapierMeToJSONTyped(json, false);
+}
+
+export function GetZapierMeToJSONTyped(value?: GetZapierMe | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'integration_id': value['integrationId'],
+        'integration_name': value['integrationName'],
+        'portal_id': value['portalId'],
+        'portal_name': value['portalName'],
+        'portal_subdomain': value['portalSubdomain'],
+        'permission_keys': value['permissionKeys'],
+    };
+}
+

package/src/models/GetZapierSetup.ts

@@ -0,0 +1,90 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { GetPermission } from './GetPermission';
+import {
+    GetPermissionFromJSON,
+    GetPermissionFromJSONTyped,
+    GetPermissionToJSON,
+    GetPermissionToJSONTyped,
+} from './GetPermission';
+import type { ZapierIntegration } from './ZapierIntegration';
+import {
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationFromJSONTyped,
+    ZapierIntegrationToJSON,
+    ZapierIntegrationToJSONTyped,
+} from './ZapierIntegration';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierSetup
+ */
+export interface GetZapierSetup {
+    /**
+     * 
+     * @type {Array<GetPermission>}
+     * @memberof GetZapierSetup
+     */
+    availablePermissions: Array<GetPermission>;
+    /**
+     * 
+     * @type {Array<ZapierIntegration>}
+     * @memberof GetZapierSetup
+     */
+    integrations: Array<ZapierIntegration>;
+}
+
+/**
+ * Check if a given object implements the GetZapierSetup interface.
+ */
+export function instanceOfGetZapierSetup(value: object): value is GetZapierSetup {
+    if (!('availablePermissions' in value) || value['availablePermissions'] === undefined) return false;
+    if (!('integrations' in value) || value['integrations'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierSetupFromJSON(json: any): GetZapierSetup {
+    return GetZapierSetupFromJSONTyped(json, false);
+}
+
+export function GetZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierSetup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'availablePermissions': ((json['available_permissions'] as Array<any>).map(GetPermissionFromJSON)),
+        'integrations': ((json['integrations'] as Array<any>).map(ZapierIntegrationFromJSON)),
+    };
+}
+
+export function GetZapierSetupToJSON(json: any): GetZapierSetup {
+    return GetZapierSetupToJSONTyped(json, false);
+}
+
+export function GetZapierSetupToJSONTyped(value?: GetZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'available_permissions': ((value['availablePermissions'] as Array<any>).map(GetPermissionToJSON)),
+        'integrations': ((value['integrations'] as Array<any>).map(ZapierIntegrationToJSON)),
+    };
+}
+

package/src/models/GetZapierShopifyCourseMappings.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { ZapierShopifyCourseMapping } from './ZapierShopifyCourseMapping';
+import {
+    ZapierShopifyCourseMappingFromJSON,
+    ZapierShopifyCourseMappingFromJSONTyped,
+    ZapierShopifyCourseMappingToJSON,
+    ZapierShopifyCourseMappingToJSONTyped,
+} from './ZapierShopifyCourseMapping';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierShopifyCourseMappings
+ */
+export interface GetZapierShopifyCourseMappings {
+    /**
+     * 
+     * @type {Array<ZapierShopifyCourseMapping>}
+     * @memberof GetZapierShopifyCourseMappings
+     */
+    items: Array<ZapierShopifyCourseMapping>;
+}
+
+/**
+ * Check if a given object implements the GetZapierShopifyCourseMappings interface.
+ */
+export function instanceOfGetZapierShopifyCourseMappings(value: object): value is GetZapierShopifyCourseMappings {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierShopifyCourseMappingsFromJSON(json: any): GetZapierShopifyCourseMappings {
+    return GetZapierShopifyCourseMappingsFromJSONTyped(json, false);
+}
+
+export function GetZapierShopifyCourseMappingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierShopifyCourseMappings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(ZapierShopifyCourseMappingFromJSON)),
+    };
+}
+
+export function GetZapierShopifyCourseMappingsToJSON(json: any): GetZapierShopifyCourseMappings {
+    return GetZapierShopifyCourseMappingsToJSONTyped(json, false);
+}
+
+export function GetZapierShopifyCourseMappingsToJSONTyped(value?: GetZapierShopifyCourseMappings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(ZapierShopifyCourseMappingToJSON)),
+    };
+}
+

package/src/models/GetZapierUsers.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+import type { ZapierUser } from './ZapierUser';
+import {
+    ZapierUserFromJSON,
+    ZapierUserFromJSONTyped,
+    ZapierUserToJSON,
+    ZapierUserToJSONTyped,
+} from './ZapierUser';
+
+/**
+ * 
+ * @export
+ * @interface GetZapierUsers
+ */
+export interface GetZapierUsers {
+    /**
+     * 
+     * @type {Array<ZapierUser>}
+     * @memberof GetZapierUsers
+     */
+    items: Array<ZapierUser>;
+}
+
+/**
+ * Check if a given object implements the GetZapierUsers interface.
+ */
+export function instanceOfGetZapierUsers(value: object): value is GetZapierUsers {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierUsersFromJSON(json: any): GetZapierUsers {
+    return GetZapierUsersFromJSONTyped(json, false);
+}
+
+export function GetZapierUsersFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierUsers {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(ZapierUserFromJSON)),
+    };
+}
+
+export function GetZapierUsersToJSON(json: any): GetZapierUsers {
+    return GetZapierUsersToJSONTyped(json, false);
+}
+
+export function GetZapierUsersToJSONTyped(value?: GetZapierUsers | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(ZapierUserToJSON)),
+    };
+}
+

package/src/models/PostZapierEnrollment.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostZapierEnrollment
+ */
+export interface PostZapierEnrollment {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    userId: string;
+    /**
+     * Stable source event ID used to make retries safe.
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    idempotencyKey?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierEnrollment
+     */
+    enrollmentDateStart?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostZapierEnrollment
+     */
+    enrollmentDateEnd?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierEnrollment
+     */
+    notes?: string | null;
+    /**
+     * 
+     * @type {PostZapierEnrollmentReEnrollmentModeEnum}
+     * @memberof PostZapierEnrollment
+     */
+    reEnrollmentMode?: PostZapierEnrollmentReEnrollmentModeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const PostZapierEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+} as const;
+export type PostZapierEnrollmentReEnrollmentModeEnum = typeof PostZapierEnrollmentReEnrollmentModeEnum[keyof typeof PostZapierEnrollmentReEnrollmentModeEnum];
+
+
+/**
+ * Check if a given object implements the PostZapierEnrollment interface.
+ */
+export function instanceOfPostZapierEnrollment(value: object): value is PostZapierEnrollment {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierEnrollmentFromJSON(json: any): PostZapierEnrollment {
+    return PostZapierEnrollmentFromJSONTyped(json, false);
+}
+
+export function PostZapierEnrollmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierEnrollment {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'userId': json['user_id'],
+        'idempotencyKey': json['idempotency_key'] == null ? undefined : json['idempotency_key'],
+        'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
+        'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
+    };
+}
+
+export function PostZapierEnrollmentToJSON(json: any): PostZapierEnrollment {
+    return PostZapierEnrollmentToJSONTyped(json, false);
+}
+
+export function PostZapierEnrollmentToJSONTyped(value?: PostZapierEnrollment | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'user_id': value['userId'],
+        'idempotency_key': value['idempotencyKey'],
+        'enrollment_date_start': value['enrollmentDateStart'],
+        'enrollment_date_end': value['enrollmentDateEnd'],
+        'notes': value['notes'],
+        're_enrollment_mode': value['reEnrollmentMode'],
+    };
+}
+

package/src/models/PostZapierSetup.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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 { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PostZapierSetup
+ */
+export interface PostZapierSetup {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierSetup
+     */
+    name: string;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PostZapierSetup
+     */
+    permissionKeys: Set<string>;
+}
+
+/**
+ * Check if a given object implements the PostZapierSetup interface.
+ */
+export function instanceOfPostZapierSetup(value: object): value is PostZapierSetup {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSetupFromJSON(json: any): PostZapierSetup {
+    return PostZapierSetupFromJSONTyped(json, false);
+}
+
+export function PostZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'permissionKeys': new Set(json['permission_keys']),
+    };
+}
+
+export function PostZapierSetupToJSON(json: any): PostZapierSetup {
+    return PostZapierSetupToJSONTyped(json, false);
+}
+
+export function PostZapierSetupToJSONTyped(value?: PostZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'permission_keys': Array.from(value['permissionKeys'] as Set<any>),
+    };
+}
+