@easyedu/js-lsm-api 1.114.0 → 1.115.0

package/src/apis/IntegrationApi.ts

@@ -0,0 +1,312 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type GetZapierMe,
+    GetZapierMeFromJSON,
+    GetZapierMeToJSON,
+} from '../models/GetZapierMe';
+import {
+    type GetZapierSetup,
+    GetZapierSetupFromJSON,
+    GetZapierSetupToJSON,
+} from '../models/GetZapierSetup';
+import {
+    type PostZapierSetup,
+    PostZapierSetupFromJSON,
+    PostZapierSetupToJSON,
+} from '../models/PostZapierSetup';
+import {
+    type PostZapierSetupResponse,
+    PostZapierSetupResponseFromJSON,
+    PostZapierSetupResponseToJSON,
+} from '../models/PostZapierSetupResponse';
+import {
+    type PutZapierSetup,
+    PutZapierSetupFromJSON,
+    PutZapierSetupToJSON,
+} from '../models/PutZapierSetup';
+import {
+    type ZapierIntegration,
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationToJSON,
+} from '../models/ZapierIntegration';
+
+export interface DeleteZapierSetupRequest {
+    zapierIntegrationId: string;
+}
+
+export interface GetZapierMeRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+}
+
+export interface PostZapierSetupRequest {
+    postZapierSetup: PostZapierSetup;
+}
+
+export interface PutZapierSetupRequest {
+    zapierIntegrationId: string;
+    putZapierSetup: PutZapierSetup;
+}
+
+/**
+ * 
+ */
+export class IntegrationApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for deleteZapierSetup without sending the request
+     */
+    async deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['zapierIntegrationId'] == null) {
+            throw new runtime.RequiredError(
+                'zapierIntegrationId',
+                'Required parameter "zapierIntegrationId" was null or undefined when calling deleteZapierSetup().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
+        urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    async deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteZapierSetupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    async deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteZapierSetupRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getZapierMe without sending the request
+     */
+    async getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['xAPIKEY'] == null) {
+            throw new runtime.RequiredError(
+                'xAPIKEY',
+                'Required parameter "xAPIKEY" was null or undefined when calling getZapierMe().'
+            );
+        }
+
+        if (requestParameters['xPORTALSUBDOMAIN'] == null) {
+            throw new runtime.RequiredError(
+                'xPORTALSUBDOMAIN',
+                'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierMe().'
+            );
+        }
+
+        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/me`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    async getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>> {
+        const requestOptions = await this.getZapierMeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetZapierMeFromJSON(jsonValue));
+    }
+
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    async getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe> {
+        const response = await this.getZapierMeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getZapierSetup without sending the request
+     */
+    async getZapierSetupRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/integrations/zapier/setup`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    async getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>> {
+        const requestOptions = await this.getZapierSetupRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetZapierSetupFromJSON(jsonValue));
+    }
+
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    async getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup> {
+        const response = await this.getZapierSetupRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postZapierSetup without sending the request
+     */
+    async postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postZapierSetup'] == null) {
+            throw new runtime.RequiredError(
+                'postZapierSetup',
+                'Required parameter "postZapierSetup" was null or undefined when calling postZapierSetup().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/integrations/zapier/setup`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostZapierSetupToJSON(requestParameters['postZapierSetup']),
+        };
+    }
+
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    async postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>> {
+        const requestOptions = await this.postZapierSetupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostZapierSetupResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    async postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse> {
+        const response = await this.postZapierSetupRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putZapierSetup without sending the request
+     */
+    async putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['zapierIntegrationId'] == null) {
+            throw new runtime.RequiredError(
+                'zapierIntegrationId',
+                'Required parameter "zapierIntegrationId" was null or undefined when calling putZapierSetup().'
+            );
+        }
+
+        if (requestParameters['putZapierSetup'] == null) {
+            throw new runtime.RequiredError(
+                'putZapierSetup',
+                'Required parameter "putZapierSetup" was null or undefined when calling putZapierSetup().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
+        urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutZapierSetupToJSON(requestParameters['putZapierSetup']),
+        };
+    }
+
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    async putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>> {
+        const requestOptions = await this.putZapierSetupRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ZapierIntegrationFromJSON(jsonValue));
+    }
+
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    async putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration> {
+        const response = await this.putZapierSetupRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

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/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/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>),
+    };
+}
+

package/src/models/PostZapierSetupResponse.ts

@@ -0,0 +1,83 @@
+/* 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 { ZapierIntegration } from './ZapierIntegration';
+import {
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationFromJSONTyped,
+    ZapierIntegrationToJSON,
+    ZapierIntegrationToJSONTyped,
+} from './ZapierIntegration';
+
+/**
+ * A newly created Zapier connection. The API key is returned only once.
+ * @export
+ * @interface PostZapierSetupResponse
+ */
+export interface PostZapierSetupResponse {
+    /**
+     * 
+     * @type {ZapierIntegration}
+     * @memberof PostZapierSetupResponse
+     */
+    integration: ZapierIntegration;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostZapierSetupResponse
+     */
+    apiKey: string;
+}
+
+/**
+ * Check if a given object implements the PostZapierSetupResponse interface.
+ */
+export function instanceOfPostZapierSetupResponse(value: object): value is PostZapierSetupResponse {
+    if (!('integration' in value) || value['integration'] === undefined) return false;
+    if (!('apiKey' in value) || value['apiKey'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSetupResponseFromJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseFromJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetupResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'integration': ZapierIntegrationFromJSON(json['integration']),
+        'apiKey': json['api_key'],
+    };
+}
+
+export function PostZapierSetupResponseToJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseToJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseToJSONTyped(value?: PostZapierSetupResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'integration': ZapierIntegrationToJSON(value['integration']),
+        'api_key': value['apiKey'],
+    };
+}
+