@easyedu/js-lsm-api 1.41.0 → 1.42.0

package/docs/SupportTicketUser.md

@@ -0,0 +1,40 @@
+
+# SupportTicketUser
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { SupportTicketUser } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies SupportTicketUser
+
+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 SupportTicketUser
+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.41.0",
+  "version": "1.42.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/SupportTicketApi.ts

@@ -0,0 +1,599 @@
+/* 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 {
+  DownloadSupportTicketAttachment200Response,
+  GetSupportTicket,
+  GetSupportTicketAttachment,
+  GetSupportTicketComment,
+  GetSupportTicketList,
+  PostSupportTicket,
+  PostSupportTicketComment,
+  PutSupportTicket,
+} from '../models/index';
+import {
+    DownloadSupportTicketAttachment200ResponseFromJSON,
+    DownloadSupportTicketAttachment200ResponseToJSON,
+    GetSupportTicketFromJSON,
+    GetSupportTicketToJSON,
+    GetSupportTicketAttachmentFromJSON,
+    GetSupportTicketAttachmentToJSON,
+    GetSupportTicketCommentFromJSON,
+    GetSupportTicketCommentToJSON,
+    GetSupportTicketListFromJSON,
+    GetSupportTicketListToJSON,
+    PostSupportTicketFromJSON,
+    PostSupportTicketToJSON,
+    PostSupportTicketCommentFromJSON,
+    PostSupportTicketCommentToJSON,
+    PutSupportTicketFromJSON,
+    PutSupportTicketToJSON,
+} from '../models/index';
+
+export interface CloseSupportTicketRequest {
+    ticketId: string;
+}
+
+export interface DownloadSupportTicketAttachmentRequest {
+    ticketId: string;
+    attachmentId: string;
+}
+
+export interface GetSupportTicketRequest {
+    ticketId: string;
+}
+
+export interface GetSupportTicketCommentsRequest {
+    ticketId: string;
+}
+
+export interface GetSupportTicketsRequest {
+    page?: number;
+    pageSize?: number;
+    status?: GetSupportTicketsStatusEnum;
+    priority?: GetSupportTicketsPriorityEnum;
+    category?: GetSupportTicketsCategoryEnum;
+}
+
+export interface PostSupportTicketRequest {
+    postSupportTicket: PostSupportTicket;
+}
+
+export interface PostSupportTicketAttachmentRequest {
+    ticketId: string;
+    file: Blob;
+}
+
+export interface PostSupportTicketCommentRequest {
+    ticketId: string;
+    postSupportTicketComment: PostSupportTicketComment;
+}
+
+export interface PutSupportTicketRequest {
+    ticketId: string;
+    putSupportTicket: PutSupportTicket;
+}
+
+/**
+ * 
+ */
+export class SupportTicketApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for closeSupportTicket without sending the request
+     */
+    async closeSupportTicketRequestOpts(requestParameters: CloseSupportTicketRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling closeSupportTicket().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/support/tickets/{ticketId}/close`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Close a support ticket
+     */
+    async closeSupportTicketRaw(requestParameters: CloseSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.closeSupportTicketRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Close a support ticket
+     */
+    async closeSupportTicket(requestParameters: CloseSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.closeSupportTicketRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for downloadSupportTicketAttachment without sending the request
+     */
+    async downloadSupportTicketAttachmentRequestOpts(requestParameters: DownloadSupportTicketAttachmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling downloadSupportTicketAttachment().'
+            );
+        }
+
+        if (requestParameters['attachmentId'] == null) {
+            throw new runtime.RequiredError(
+                'attachmentId',
+                'Required parameter "attachmentId" was null or undefined when calling downloadSupportTicketAttachment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/support/tickets/{ticketId}/attachments/{attachmentId}/download`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters['attachmentId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Download a ticket attachment
+     */
+    async downloadSupportTicketAttachmentRaw(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DownloadSupportTicketAttachment200Response>> {
+        const requestOptions = await this.downloadSupportTicketAttachmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DownloadSupportTicketAttachment200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Download a ticket attachment
+     */
+    async downloadSupportTicketAttachment(requestParameters: DownloadSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DownloadSupportTicketAttachment200Response> {
+        const response = await this.downloadSupportTicketAttachmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSupportTicket without sending the request
+     */
+    async getSupportTicketRequestOpts(requestParameters: GetSupportTicketRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling getSupportTicket().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/support/tickets/{ticketId}`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get support ticket details
+     */
+    async getSupportTicketRaw(requestParameters: GetSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicket>> {
+        const requestOptions = await this.getSupportTicketRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketFromJSON(jsonValue));
+    }
+
+    /**
+     * Get support ticket details
+     */
+    async getSupportTicket(requestParameters: GetSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicket> {
+        const response = await this.getSupportTicketRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSupportTicketComments without sending the request
+     */
+    async getSupportTicketCommentsRequestOpts(requestParameters: GetSupportTicketCommentsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling getSupportTicketComments().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/support/tickets/{ticketId}/comments`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get comments for a ticket
+     */
+    async getSupportTicketCommentsRaw(requestParameters: GetSupportTicketCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetSupportTicketComment>>> {
+        const requestOptions = await this.getSupportTicketCommentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetSupportTicketCommentFromJSON));
+    }
+
+    /**
+     * Get comments for a ticket
+     */
+    async getSupportTicketComments(requestParameters: GetSupportTicketCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetSupportTicketComment>> {
+        const response = await this.getSupportTicketCommentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getSupportTickets without sending the request
+     */
+    async getSupportTicketsRequestOpts(requestParameters: GetSupportTicketsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['priority'] != null) {
+            queryParameters['priority'] = requestParameters['priority'];
+        }
+
+        if (requestParameters['category'] != null) {
+            queryParameters['category'] = requestParameters['category'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/support/tickets`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List support tickets
+     */
+    async getSupportTicketsRaw(requestParameters: GetSupportTicketsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketList>> {
+        const requestOptions = await this.getSupportTicketsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketListFromJSON(jsonValue));
+    }
+
+    /**
+     * List support tickets
+     */
+    async getSupportTickets(requestParameters: GetSupportTicketsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketList> {
+        const response = await this.getSupportTicketsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postSupportTicket without sending the request
+     */
+    async postSupportTicketRequestOpts(requestParameters: PostSupportTicketRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postSupportTicket'] == null) {
+            throw new runtime.RequiredError(
+                'postSupportTicket',
+                'Required parameter "postSupportTicket" was null or undefined when calling postSupportTicket().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/support/tickets`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostSupportTicketToJSON(requestParameters['postSupportTicket']),
+        };
+    }
+
+    /**
+     * Create a support ticket
+     */
+    async postSupportTicketRaw(requestParameters: PostSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicket>> {
+        const requestOptions = await this.postSupportTicketRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a support ticket
+     */
+    async postSupportTicket(requestParameters: PostSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicket> {
+        const response = await this.postSupportTicketRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postSupportTicketAttachment without sending the request
+     */
+    async postSupportTicketAttachmentRequestOpts(requestParameters: PostSupportTicketAttachmentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling postSupportTicketAttachment().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postSupportTicketAttachment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+
+        let urlPath = `/support/tickets/{ticketId}/attachments`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload an attachment to a ticket
+     */
+    async postSupportTicketAttachmentRaw(requestParameters: PostSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketAttachment>> {
+        const requestOptions = await this.postSupportTicketAttachmentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketAttachmentFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload an attachment to a ticket
+     */
+    async postSupportTicketAttachment(requestParameters: PostSupportTicketAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketAttachment> {
+        const response = await this.postSupportTicketAttachmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for postSupportTicketComment without sending the request
+     */
+    async postSupportTicketCommentRequestOpts(requestParameters: PostSupportTicketCommentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling postSupportTicketComment().'
+            );
+        }
+
+        if (requestParameters['postSupportTicketComment'] == null) {
+            throw new runtime.RequiredError(
+                'postSupportTicketComment',
+                'Required parameter "postSupportTicketComment" was null or undefined when calling postSupportTicketComment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/support/tickets/{ticketId}/comments`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostSupportTicketCommentToJSON(requestParameters['postSupportTicketComment']),
+        };
+    }
+
+    /**
+     * Add a comment to a ticket
+     */
+    async postSupportTicketCommentRaw(requestParameters: PostSupportTicketCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSupportTicketComment>> {
+        const requestOptions = await this.postSupportTicketCommentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSupportTicketCommentFromJSON(jsonValue));
+    }
+
+    /**
+     * Add a comment to a ticket
+     */
+    async postSupportTicketComment(requestParameters: PostSupportTicketCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSupportTicketComment> {
+        const response = await this.postSupportTicketCommentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putSupportTicket without sending the request
+     */
+    async putSupportTicketRequestOpts(requestParameters: PutSupportTicketRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['ticketId'] == null) {
+            throw new runtime.RequiredError(
+                'ticketId',
+                'Required parameter "ticketId" was null or undefined when calling putSupportTicket().'
+            );
+        }
+
+        if (requestParameters['putSupportTicket'] == null) {
+            throw new runtime.RequiredError(
+                'putSupportTicket',
+                'Required parameter "putSupportTicket" was null or undefined when calling putSupportTicket().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/support/tickets/{ticketId}`;
+        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutSupportTicketToJSON(requestParameters['putSupportTicket']),
+        };
+    }
+
+    /**
+     * Update a support ticket
+     */
+    async putSupportTicketRaw(requestParameters: PutSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putSupportTicketRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Update a support ticket
+     */
+    async putSupportTicket(requestParameters: PutSupportTicketRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putSupportTicketRaw(requestParameters, initOverrides);
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetSupportTicketsStatusEnum = {
+    Open: 'Open',
+    InProgress: 'InProgress',
+    Closed: 'Closed'
+} as const;
+export type GetSupportTicketsStatusEnum = typeof GetSupportTicketsStatusEnum[keyof typeof GetSupportTicketsStatusEnum];
+/**
+ * @export
+ */
+export const GetSupportTicketsPriorityEnum = {
+    Low: 'Low',
+    Medium: 'Medium',
+    High: 'High',
+    Critical: 'Critical'
+} as const;
+export type GetSupportTicketsPriorityEnum = typeof GetSupportTicketsPriorityEnum[keyof typeof GetSupportTicketsPriorityEnum];
+/**
+ * @export
+ */
+export const GetSupportTicketsCategoryEnum = {
+    Bug: 'Bug',
+    FeatureRequest: 'FeatureRequest',
+    AccountIssue: 'AccountIssue',
+    ContentIssue: 'ContentIssue',
+    Other: 'Other'
+} as const;
+export type GetSupportTicketsCategoryEnum = typeof GetSupportTicketsCategoryEnum[keyof typeof GetSupportTicketsCategoryEnum];

package/src/apis/index.ts

@@ -10,4 +10,5 @@ export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
 export * from './RoleApi';
+export * from './SupportTicketApi';
 export * from './UserApi';