@easyedu/js-lsm-api 1.113.0 → 1.115.0

package/docs/ZapierIntegration.md

@@ -0,0 +1,55 @@
+
+# ZapierIntegration
+
+A portal-scoped Zapier connection. The API key secret is never included here.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`portalId` | string
+`portalName` | string
+`portalSubdomain` | string
+`keyPrefix` | string
+`permissionKeys` | Array<string>
+`createdAt` | number
+`updatedAt` | number
+`lastUsedAt` | number
+`revokedAt` | number
+
+## Example
+
+```typescript
+import type { ZapierIntegration } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "portalId": null,
+  "portalName": null,
+  "portalSubdomain": null,
+  "keyPrefix": null,
+  "permissionKeys": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+} satisfies ZapierIntegration
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ZapierIntegration
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.113.0",
+  "version": "1.115.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

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/ChatFeatureUsage.ts

@@ -0,0 +1,94 @@
+/* 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 { ChatUsageTotals } from './ChatUsageTotals';
+import {
+    ChatUsageTotalsFromJSON,
+    ChatUsageTotalsFromJSONTyped,
+    ChatUsageTotalsToJSON,
+    ChatUsageTotalsToJSONTyped,
+} from './ChatUsageTotals';
+
+/**
+ * 
+ * @export
+ * @interface ChatFeatureUsage
+ */
+export interface ChatFeatureUsage {
+    /**
+     * 
+     * @type {ChatFeatureUsageFeatureEnum}
+     * @memberof ChatFeatureUsage
+     */
+    feature: ChatFeatureUsageFeatureEnum;
+    /**
+     * 
+     * @type {ChatUsageTotals}
+     * @memberof ChatFeatureUsage
+     */
+    usage: ChatUsageTotals;
+}
+
+
+/**
+ * @export
+ */
+export const ChatFeatureUsageFeatureEnum = {
+    Chat: 'chat',
+    QuestionImport: 'question_import'
+} as const;
+export type ChatFeatureUsageFeatureEnum = typeof ChatFeatureUsageFeatureEnum[keyof typeof ChatFeatureUsageFeatureEnum];
+
+
+/**
+ * Check if a given object implements the ChatFeatureUsage interface.
+ */
+export function instanceOfChatFeatureUsage(value: object): value is ChatFeatureUsage {
+    if (!('feature' in value) || value['feature'] === undefined) return false;
+    if (!('usage' in value) || value['usage'] === undefined) return false;
+    return true;
+}
+
+export function ChatFeatureUsageFromJSON(json: any): ChatFeatureUsage {
+    return ChatFeatureUsageFromJSONTyped(json, false);
+}
+
+export function ChatFeatureUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChatFeatureUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'feature': json['feature'],
+        'usage': ChatUsageTotalsFromJSON(json['usage']),
+    };
+}
+
+export function ChatFeatureUsageToJSON(json: any): ChatFeatureUsage {
+    return ChatFeatureUsageToJSONTyped(json, false);
+}
+
+export function ChatFeatureUsageToJSONTyped(value?: ChatFeatureUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'feature': value['feature'],
+        'usage': ChatUsageTotalsToJSON(value['usage']),
+    };
+}
+

package/src/models/GetChatUsage.ts

@@ -34,6 +34,13 @@ import {
     ChatUsageTotalsToJSON,
     ChatUsageTotalsToJSONTyped,
 } from './ChatUsageTotals';
+import type { ChatFeatureUsage } from './ChatFeatureUsage';
+import {
+    ChatFeatureUsageFromJSON,
+    ChatFeatureUsageFromJSONTyped,
+    ChatFeatureUsageToJSON,
+    ChatFeatureUsageToJSONTyped,
+} from './ChatFeatureUsage';
 
 /**
  * 
@@ -71,6 +78,12 @@ export interface GetChatUsage {
      * @memberof GetChatUsage
      */
     modelUsage: Array<ChatModelUsage>;
+    /**
+     * 
+     * @type {Array<ChatFeatureUsage>}
+     * @memberof GetChatUsage
+     */
+    featureUsage: Array<ChatFeatureUsage>;
 }
 
 /**
@@ -82,6 +95,7 @@ export function instanceOfGetChatUsage(value: object): value is GetChatUsage {
     if (!('totals' in value) || value['totals'] === undefined) return false;
     if (!('daily' in value) || value['daily'] === undefined) return false;
     if (!('modelUsage' in value) || value['modelUsage'] === undefined) return false;
+    if (!('featureUsage' in value) || value['featureUsage'] === undefined) return false;
     return true;
 }
 
@@ -100,6 +114,7 @@ export function GetChatUsageFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'totals': ChatUsageTotalsFromJSON(json['totals']),
         'daily': ((json['daily'] as Array<any>).map(ChatDailyUsageFromJSON)),
         'modelUsage': ((json['model_usage'] as Array<any>).map(ChatModelUsageFromJSON)),
+        'featureUsage': ((json['feature_usage'] as Array<any>).map(ChatFeatureUsageFromJSON)),
     };
 }
 
@@ -119,6 +134,7 @@ export function GetChatUsageToJSONTyped(value?: GetChatUsage | null, ignoreDiscr
         'totals': ChatUsageTotalsToJSON(value['totals']),
         'daily': ((value['daily'] as Array<any>).map(ChatDailyUsageToJSON)),
         'model_usage': ((value['modelUsage'] as Array<any>).map(ChatModelUsageToJSON)),
+        'feature_usage': ((value['featureUsage'] as Array<any>).map(ChatFeatureUsageToJSON)),
     };
 }
 

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'],
+    };
+}
+