@easyedu/js-lsm-api 1.81.0 → 1.82.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.81.0
+# @easyedu/js-lsm-api@1.82.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -220,6 +220,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *RichTextApi* | [**getRichTextAsset**](docs/RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL
 *RichTextApi* | [**postRichTextAssetComplete**](docs/RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload
 *RichTextApi* | [**postRichTextAssetUpload**](docs/RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload
+*RichTextApi* | [**putRichTextAssetFile**](docs/RichTextApi.md#putrichtextassetfile) | **PUT** /rich-text/assets/{assetId}/file | Upload a pending rich text asset file through the API
 *RoleApi* | [**assignUserRole**](docs/RoleApi.md#assignuserrole) | **POST** /roles/users/{userId}/portals/{portalId}/roles/{roleId} | Assign a role to a user for a portal
 *RoleApi* | [**createRole**](docs/RoleApi.md#createrole) | **POST** /roles | Create a custom role scoped to the current portal
 *RoleApi* | [**deleteRole**](docs/RoleApi.md#deleterole) | **DELETE** /roles/{roleId} | Deactivate a custom role
@@ -570,7 +571,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.81.0`
+- Package version: `1.82.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/RichTextApi.d.ts

@@ -24,6 +24,10 @@ export interface PostRichTextAssetCompleteRequest {
 export interface PostRichTextAssetUploadRequest {
     postRichTextAssetUpload: PostRichTextAssetUpload;
 }
+export interface PutRichTextAssetFileRequest {
+    assetId: string;
+    body: Blob;
+}
 /**
  *
  */
@@ -64,4 +68,16 @@ export declare class RichTextApi extends runtime.BaseAPI {
      * Create a pending rich text asset upload
      */
     postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload>;
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    putRichTextAssetFileRequestOpts(requestParameters: PutRichTextAssetFileRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFileRaw(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFile(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/RichTextApi.js

@@ -154,5 +154,48 @@ class RichTextApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    putRichTextAssetFileRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['assetId'] == null) {
+                throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling putRichTextAssetFile().');
+            }
+            if (requestParameters['body'] == null) {
+                throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling putRichTextAssetFile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'image/png';
+            let urlPath = `/rich-text/assets/{assetId}/file`;
+            urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            };
+        });
+    }
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFileRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putRichTextAssetFileRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.putRichTextAssetFileRaw(requestParameters, initOverrides);
+        });
+    }
 }
 exports.RichTextApi = RichTextApi;

package/dist/esm/apis/RichTextApi.d.ts

@@ -24,6 +24,10 @@ export interface PostRichTextAssetCompleteRequest {
 export interface PostRichTextAssetUploadRequest {
     postRichTextAssetUpload: PostRichTextAssetUpload;
 }
+export interface PutRichTextAssetFileRequest {
+    assetId: string;
+    body: Blob;
+}
 /**
  *
  */
@@ -64,4 +68,16 @@ export declare class RichTextApi extends runtime.BaseAPI {
      * Create a pending rich text asset upload
      */
     postRichTextAssetUpload(requestParameters: PostRichTextAssetUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRichTextAssetUpload>;
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    putRichTextAssetFileRequestOpts(requestParameters: PutRichTextAssetFileRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFileRaw(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFile(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/esm/apis/RichTextApi.js

@@ -151,4 +151,47 @@ export class RichTextApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    putRichTextAssetFileRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['assetId'] == null) {
+                throw new runtime.RequiredError('assetId', 'Required parameter "assetId" was null or undefined when calling putRichTextAssetFile().');
+            }
+            if (requestParameters['body'] == null) {
+                throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling putRichTextAssetFile().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'image/png';
+            let urlPath = `/rich-text/assets/{assetId}/file`;
+            urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: requestParameters['body'],
+            };
+        });
+    }
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFileRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putRichTextAssetFileRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    putRichTextAssetFile(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.putRichTextAssetFileRaw(requestParameters, initOverrides);
+        });
+    }
 }

package/docs/RichTextApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getRichTextAsset**](RichTextApi.md#getrichtextasset) | **GET** /rich-text/assets/{assetId} | Redirect to a signed rich text asset URL |
 | [**postRichTextAssetComplete**](RichTextApi.md#postrichtextassetcomplete) | **POST** /rich-text/assets/{assetId}/complete | Complete a pending rich text asset upload |
 | [**postRichTextAssetUpload**](RichTextApi.md#postrichtextassetupload) | **POST** /rich-text/assets/uploads | Create a pending rich text asset upload |
+| [**putRichTextAssetFile**](RichTextApi.md#putrichtextassetfile) | **PUT** /rich-text/assets/{assetId}/file | Upload a pending rich text asset file through the API |
 
 
 
@@ -210,3 +211,75 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## putRichTextAssetFile
+
+> putRichTextAssetFile(assetId, body)
+
+Upload a pending rich text asset file through the API
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RichTextApi,
+} from '@easyedu/js-lsm-api';
+import type { PutRichTextAssetFileRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new RichTextApi();
+
+  const body = {
+    // string
+    assetId: assetId_example,
+    // Blob
+    body: BINARY_DATA_HERE,
+  } satisfies PutRichTextAssetFileRequest;
+
+  try {
+    const data = await api.putRichTextAssetFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **assetId** | `string` |  | [Defaults to `undefined`] |
+| **body** | `Blob` |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `image/png`, `image/jpeg`, `image/webp`, `image/gif`, `application/octet-stream`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | rich text asset file uploaded |  -  |
+| **400** | invalid upload |  -  |
+| **403** | forbidden |  -  |
+| **404** | rich text asset not found |  -  |
+| **413** | file too large |  -  |
+
+[[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.81.0",
+  "version": "1.82.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/RichTextApi.ts

@@ -47,6 +47,11 @@ export interface PostRichTextAssetUploadRequest {
     postRichTextAssetUpload: PostRichTextAssetUpload;
 }
 
+export interface PutRichTextAssetFileRequest {
+    assetId: string;
+    body: Blob;
+}
+
 /**
  * 
  */
@@ -198,4 +203,58 @@ export class RichTextApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putRichTextAssetFile without sending the request
+     */
+    async putRichTextAssetFileRequestOpts(requestParameters: PutRichTextAssetFileRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['assetId'] == null) {
+            throw new runtime.RequiredError(
+                'assetId',
+                'Required parameter "assetId" was null or undefined when calling putRichTextAssetFile().'
+            );
+        }
+
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError(
+                'body',
+                'Required parameter "body" was null or undefined when calling putRichTextAssetFile().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'image/png';
+
+
+        let urlPath = `/rich-text/assets/{assetId}/file`;
+        urlPath = urlPath.replace('{assetId}', encodeURIComponent(String(requestParameters['assetId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'] as any,
+        };
+    }
+
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    async putRichTextAssetFileRaw(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.putRichTextAssetFileRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Upload a pending rich text asset file through the API
+     */
+    async putRichTextAssetFile(requestParameters: PutRichTextAssetFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.putRichTextAssetFileRaw(requestParameters, initOverrides);
+    }
+
 }