@easyedu/js-lsm-api 1.40.0 → 1.42.0

package/src/apis/PortalApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   GetPortal,
   GetPortalList,
+  GetPortalLogoUpload,
   GetPortalUserList,
   PostPortal,
   PostPortalInvite,
@@ -27,6 +28,8 @@ import {
     GetPortalToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
+    GetPortalLogoUploadFromJSON,
+    GetPortalLogoUploadToJSON,
     GetPortalUserListFromJSON,
     GetPortalUserListToJSON,
     PostPortalFromJSON,
@@ -37,6 +40,10 @@ import {
     PutPortalBrandingToJSON,
 } from '../models/index';
 
+export interface DeletePortalLogoRequest {
+    portalId: string;
+}
+
 export interface GetPortalByIdRequest {
     portalId: string;
 }
@@ -59,6 +66,11 @@ export interface PostPortalRequest {
     postPortal: PostPortal;
 }
 
+export interface PostPortalLogoUploadRequest {
+    portalId: string;
+    file: Blob;
+}
+
 export interface PutPortalBrandingRequest {
     portalId: string;
     putPortalBranding: PutPortalBranding;
@@ -73,6 +85,50 @@ export interface UpdateSelectedPortalRequest {
  */
 export class PortalApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deletePortalLogo without sending the request
+     */
+    async deletePortalLogoRequestOpts(requestParameters: DeletePortalLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling deletePortalLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/portals/{portalId}/branding/logo`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove the portal logo
+     */
+    async deletePortalLogoRaw(requestParameters: DeletePortalLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deletePortalLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the portal logo
+     */
+    async deletePortalLogo(requestParameters: DeletePortalLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deletePortalLogoRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getPortalById without sending the request
      */
@@ -321,6 +377,79 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postPortalLogoUpload without sending the request
+     */
+    async postPortalLogoUploadRequestOpts(requestParameters: PostPortalLogoUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling postPortalLogoUpload().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postPortalLogoUpload().'
+            );
+        }
+
+        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 = `/portals/{portalId}/branding/logo`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a logo image for portal branding
+     */
+    async postPortalLogoUploadRaw(requestParameters: PostPortalLogoUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalLogoUpload>> {
+        const requestOptions = await this.postPortalLogoUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalLogoUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a logo image for portal branding
+     */
+    async postPortalLogoUpload(requestParameters: PostPortalLogoUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalLogoUpload> {
+        const response = await this.postPortalLogoUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putPortalBranding without sending the request
      */