@easyedu/js-lsm-api 1.56.0 → 1.58.0

package/src/apis/UserApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   GetUser,
+  GetUserAvatarUpload,
   LoginRes,
   PostLogin,
   PostResetPassword,
@@ -25,6 +26,8 @@ import type {
 import {
     GetUserFromJSON,
     GetUserToJSON,
+    GetUserAvatarUploadFromJSON,
+    GetUserAvatarUploadToJSON,
     LoginResFromJSON,
     LoginResToJSON,
     PostLoginFromJSON,
@@ -37,6 +40,10 @@ import {
     PutUserToJSON,
 } from '../models/index';
 
+export interface DeleteUserAvatarRequest {
+    userId: string;
+}
+
 export interface GetUserRequest {
     userId: string;
 }
@@ -45,6 +52,11 @@ export interface PostLoginRequest {
     postLogin: PostLogin;
 }
 
+export interface PostUserAvatarUploadRequest {
+    userId: string;
+    file: Blob;
+}
+
 export interface PutUserRequest {
     userId: string;
     putUser: Omit<PutUser, 'id'|'last_updated'>;
@@ -63,6 +75,50 @@ export interface SendResetPasswordRequest {
  */
 export class UserApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteUserAvatar without sending the request
+     */
+    async deleteUserAvatarRequestOpts(requestParameters: DeleteUserAvatarRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling deleteUserAvatar().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/{userId}/avatar`;
+        urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove the current user\'s profile photo
+     */
+    async deleteUserAvatarRaw(requestParameters: DeleteUserAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteUserAvatarRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the current user\'s profile photo
+     */
+    async deleteUserAvatar(requestParameters: DeleteUserAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteUserAvatarRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getAuthCheck without sending the request
      */
@@ -266,6 +322,79 @@ export class UserApi extends runtime.BaseAPI {
         await this.postLogoutRaw(initOverrides);
     }
 
+    /**
+     * Creates request options for postUserAvatarUpload without sending the request
+     */
+    async postUserAvatarUploadRequestOpts(requestParameters: PostUserAvatarUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling postUserAvatarUpload().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postUserAvatarUpload().'
+            );
+        }
+
+        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 = `/users/{userId}/avatar`;
+        urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a profile photo for the current user
+     */
+    async postUserAvatarUploadRaw(requestParameters: PostUserAvatarUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserAvatarUpload>> {
+        const requestOptions = await this.postUserAvatarUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUserAvatarUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a profile photo for the current user
+     */
+    async postUserAvatarUpload(requestParameters: PostUserAvatarUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserAvatarUpload> {
+        const response = await this.postUserAvatarUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putUser without sending the request
      */

package/src/models/GetPortal.ts

@@ -43,6 +43,12 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortal
+     */
+    faviconUrl?: string | null;
     /**
      * 
      * @type {string}
@@ -104,6 +110,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
@@ -125,6 +132,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
         'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
         'base_type': value['baseType'],

package/src/models/GetPortalFaviconUpload.ts

@@ -0,0 +1,66 @@
+/* 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 GetPortalFaviconUpload
+ */
+export interface GetPortalFaviconUpload {
+    /**
+     * Presigned URL for the uploaded favicon image
+     * @type {string}
+     * @memberof GetPortalFaviconUpload
+     */
+    faviconUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export function instanceOfGetPortalFaviconUpload(value: object): value is GetPortalFaviconUpload {
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalFaviconUploadFromJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadFromJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalFaviconUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'faviconUrl': json['favicon_url'],
+    };
+}
+
+export function GetPortalFaviconUploadToJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadToJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadToJSONTyped(value?: GetPortalFaviconUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'favicon_url': value['faviconUrl'],
+    };
+}
+

package/src/models/GetUser.ts

@@ -43,6 +43,12 @@ export interface GetUser {
      * @memberof GetUser
      */
     email: string;
+    /**
+     * Presigned URL for the user's profile photo, or null if none set
+     * @type {string}
+     * @memberof GetUser
+     */
+    avatarUrl?: string | null;
     /**
      * Unix timestamp in seconds
      * @type {number}
@@ -77,6 +83,7 @@ export function GetUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): G
         'firstName': json['first_name'],
         'lastName': json['last_name'],
         'email': json['email'],
+        'avatarUrl': json['avatar_url'] == null ? undefined : json['avatar_url'],
         'lastUpdated': json['last_updated'],
     };
 }
@@ -95,6 +102,7 @@ export function GetUserToJSONTyped(value?: Omit<GetUser, 'id'> | null, ignoreDis
         'first_name': value['firstName'],
         'last_name': value['lastName'],
         'email': value['email'],
+        'avatar_url': value['avatarUrl'],
         'last_updated': value['lastUpdated'],
     };
 }

package/src/models/GetUserAvatarUpload.ts

@@ -0,0 +1,66 @@
+/* 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 GetUserAvatarUpload
+ */
+export interface GetUserAvatarUpload {
+    /**
+     * Presigned URL for the uploaded avatar image
+     * @type {string}
+     * @memberof GetUserAvatarUpload
+     */
+    avatarUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetUserAvatarUpload interface.
+ */
+export function instanceOfGetUserAvatarUpload(value: object): value is GetUserAvatarUpload {
+    if (!('avatarUrl' in value) || value['avatarUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetUserAvatarUploadFromJSON(json: any): GetUserAvatarUpload {
+    return GetUserAvatarUploadFromJSONTyped(json, false);
+}
+
+export function GetUserAvatarUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserAvatarUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'avatarUrl': json['avatar_url'],
+    };
+}
+
+export function GetUserAvatarUploadToJSON(json: any): GetUserAvatarUpload {
+    return GetUserAvatarUploadToJSONTyped(json, false);
+}
+
+export function GetUserAvatarUploadToJSONTyped(value?: GetUserAvatarUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'avatar_url': value['avatarUrl'],
+    };
+}
+

package/src/models/index.ts

@@ -72,6 +72,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';
@@ -141,6 +142,7 @@ export * from './GetSupportTicketAttachment';
 export * from './GetSupportTicketComment';
 export * from './GetSupportTicketList';
 export * from './GetUser';
+export * from './GetUserAvatarUpload';
 export * from './GetUserQuizAttempts';
 export * from './GetUserQuizAttemptsAllOfAttempts';
 export * from './GetUserQuizAttemptsAllOfFilters';