@easyedu/js-lsm-api 1.41.0 → 1.43.0

package/docs/PutSupportTicket.md

@@ -0,0 +1,38 @@
+
+# PutSupportTicket
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`priority` | string
+`assignedTo` | string
+
+## Example
+
+```typescript
+import type { PutSupportTicket } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "priority": null,
+  "assignedTo": null,
+} satisfies PutSupportTicket
+
+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 PutSupportTicket
+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/docs/SupportTicketApi.md

@@ -0,0 +1,651 @@
+# SupportTicketApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**closeSupportTicket**](SupportTicketApi.md#closesupportticket) | **POST** /support/tickets/{ticketId}/close | Close a support ticket |
+| [**downloadSupportTicketAttachment**](SupportTicketApi.md#downloadsupportticketattachment) | **GET** /support/tickets/{ticketId}/attachments/{attachmentId}/download | Download a ticket attachment |
+| [**getSupportTicket**](SupportTicketApi.md#getsupportticket) | **GET** /support/tickets/{ticketId} | Get support ticket details |
+| [**getSupportTicketComments**](SupportTicketApi.md#getsupportticketcomments) | **GET** /support/tickets/{ticketId}/comments | Get comments for a ticket |
+| [**getSupportTickets**](SupportTicketApi.md#getsupporttickets) | **GET** /support/tickets | List support tickets |
+| [**postSupportTicket**](SupportTicketApi.md#postsupportticket) | **POST** /support/tickets | Create a support ticket |
+| [**postSupportTicketAttachment**](SupportTicketApi.md#postsupportticketattachment) | **POST** /support/tickets/{ticketId}/attachments | Upload an attachment to a ticket |
+| [**postSupportTicketComment**](SupportTicketApi.md#postsupportticketcomment) | **POST** /support/tickets/{ticketId}/comments | Add a comment to a ticket |
+| [**putSupportTicket**](SupportTicketApi.md#putsupportticket) | **PUT** /support/tickets/{ticketId} | Update a support ticket |
+
+
+
+## closeSupportTicket
+
+> closeSupportTicket(ticketId)
+
+Close a support ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { CloseSupportTicketRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+  } satisfies CloseSupportTicketRequest;
+
+  try {
+    const data = await api.closeSupportTicket(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ticket closed |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## downloadSupportTicketAttachment
+
+> DownloadSupportTicketAttachment200Response downloadSupportTicketAttachment(ticketId, attachmentId)
+
+Download a ticket attachment
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { DownloadSupportTicketAttachmentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+    // string
+    attachmentId: attachmentId_example,
+  } satisfies DownloadSupportTicketAttachmentRequest;
+
+  try {
+    const data = await api.downloadSupportTicketAttachment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+| **attachmentId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DownloadSupportTicketAttachment200Response**](DownloadSupportTicketAttachment200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Presigned download URL |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Attachment not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSupportTicket
+
+> GetSupportTicket getSupportTicket(ticketId)
+
+Get support ticket details
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSupportTicketRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+  } satisfies GetSupportTicketRequest;
+
+  try {
+    const data = await api.getSupportTicket(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSupportTicket**](GetSupportTicket.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Support ticket details |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSupportTicketComments
+
+> Array<GetSupportTicketComment> getSupportTicketComments(ticketId)
+
+Get comments for a ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSupportTicketCommentsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+  } satisfies GetSupportTicketCommentsRequest;
+
+  try {
+    const data = await api.getSupportTicketComments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetSupportTicketComment>**](GetSupportTicketComment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of comments |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSupportTickets
+
+> GetSupportTicketList getSupportTickets(page, pageSize, status, priority, category)
+
+List support tickets
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSupportTicketsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // 'Open' | 'InProgress' | 'Closed' (optional)
+    status: status_example,
+    // 'Low' | 'Medium' | 'High' | 'Critical' (optional)
+    priority: priority_example,
+    // 'Bug' | 'FeatureRequest' | 'AccountIssue' | 'ContentIssue' | 'Other' (optional)
+    category: category_example,
+  } satisfies GetSupportTicketsRequest;
+
+  try {
+    const data = await api.getSupportTickets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **status** | `Open`, `InProgress`, `Closed` |  | [Optional] [Defaults to `undefined`] [Enum: Open, InProgress, Closed] |
+| **priority** | `Low`, `Medium`, `High`, `Critical` |  | [Optional] [Defaults to `undefined`] [Enum: Low, Medium, High, Critical] |
+| **category** | `Bug`, `FeatureRequest`, `AccountIssue`, `ContentIssue`, `Other` |  | [Optional] [Defaults to `undefined`] [Enum: Bug, FeatureRequest, AccountIssue, ContentIssue, Other] |
+
+### Return type
+
+[**GetSupportTicketList**](GetSupportTicketList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated list of support tickets |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSupportTicket
+
+> GetSupportTicket postSupportTicket(postSupportTicket)
+
+Create a support ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSupportTicketRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // PostSupportTicket
+    postSupportTicket: ...,
+  } satisfies PostSupportTicketRequest;
+
+  try {
+    const data = await api.postSupportTicket(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postSupportTicket** | [PostSupportTicket](PostSupportTicket.md) |  | |
+
+### Return type
+
+[**GetSupportTicket**](GetSupportTicket.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Ticket created |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSupportTicketAttachment
+
+> GetSupportTicketAttachment postSupportTicketAttachment(ticketId, file)
+
+Upload an attachment to a ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSupportTicketAttachmentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+    // Blob
+    file: BINARY_DATA_HERE,
+  } satisfies PostSupportTicketAttachmentRequest;
+
+  try {
+    const data = await api.postSupportTicketAttachment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSupportTicketAttachment**](GetSupportTicketAttachment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Attachment uploaded |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postSupportTicketComment
+
+> GetSupportTicketComment postSupportTicketComment(ticketId, postSupportTicketComment)
+
+Add a comment to a ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { PostSupportTicketCommentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+    // PostSupportTicketComment
+    postSupportTicketComment: ...,
+  } satisfies PostSupportTicketCommentRequest;
+
+  try {
+    const data = await api.postSupportTicketComment(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+| **postSupportTicketComment** | [PostSupportTicketComment](PostSupportTicketComment.md) |  | |
+
+### Return type
+
+[**GetSupportTicketComment**](GetSupportTicketComment.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Comment added |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putSupportTicket
+
+> putSupportTicket(ticketId, putSupportTicket)
+
+Update a support ticket
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SupportTicketApi,
+} from '@easyedu/js-lsm-api';
+import type { PutSupportTicketRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new SupportTicketApi();
+
+  const body = {
+    // string
+    ticketId: ticketId_example,
+    // PutSupportTicket
+    putSupportTicket: ...,
+  } satisfies PutSupportTicketRequest;
+
+  try {
+    const data = await api.putSupportTicket(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ticketId** | `string` |  | [Defaults to `undefined`] |
+| **putSupportTicket** | [PutSupportTicket](PutSupportTicket.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Ticket updated |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Ticket not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

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)
+
+