@easyedu/js-lsm-api 1.57.0 → 1.59.0

package/src/apis/SupportTicketApi.ts

@@ -12,36 +12,47 @@
  * 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 {
+    type DownloadSupportTicketAttachment200Response,
     DownloadSupportTicketAttachment200ResponseFromJSON,
     DownloadSupportTicketAttachment200ResponseToJSON,
+} from '../models/DownloadSupportTicketAttachment200Response';
+import {
+    type GetSupportTicket,
     GetSupportTicketFromJSON,
     GetSupportTicketToJSON,
+} from '../models/GetSupportTicket';
+import {
+    type GetSupportTicketAttachment,
     GetSupportTicketAttachmentFromJSON,
     GetSupportTicketAttachmentToJSON,
+} from '../models/GetSupportTicketAttachment';
+import {
+    type GetSupportTicketComment,
     GetSupportTicketCommentFromJSON,
     GetSupportTicketCommentToJSON,
+} from '../models/GetSupportTicketComment';
+import {
+    type GetSupportTicketList,
     GetSupportTicketListFromJSON,
     GetSupportTicketListToJSON,
+} from '../models/GetSupportTicketList';
+import {
+    type PostSupportTicket,
     PostSupportTicketFromJSON,
     PostSupportTicketToJSON,
+} from '../models/PostSupportTicket';
+import {
+    type PostSupportTicketComment,
     PostSupportTicketCommentFromJSON,
     PostSupportTicketCommentToJSON,
+} from '../models/PostSupportTicketComment';
+import {
+    type PutSupportTicket,
     PutSupportTicketFromJSON,
     PutSupportTicketToJSON,
-} from '../models/index';
+} from '../models/PutSupportTicket';
 
 export interface CloseSupportTicketRequest {
     ticketId: string;
@@ -109,7 +120,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}/close`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,
@@ -160,8 +171,8 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}/attachments/{attachmentId}/download`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
-        urlPath = urlPath.replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters['attachmentId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{attachmentId}', encodeURIComponent(String(requestParameters['attachmentId'])));
 
         return {
             path: urlPath,
@@ -206,7 +217,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,
@@ -251,7 +262,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}/comments`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,
@@ -427,7 +438,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}/attachments`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,
@@ -482,7 +493,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}/comments`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,
@@ -537,7 +548,7 @@ export class SupportTicketApi extends runtime.BaseAPI {
 
 
         let urlPath = `/support/tickets/{ticketId}`;
-        urlPath = urlPath.replace(`{${"ticketId"}}`, encodeURIComponent(String(requestParameters['ticketId'])));
+        urlPath = urlPath.replace('{ticketId}', encodeURIComponent(String(requestParameters['ticketId'])));
 
         return {
             path: urlPath,

package/src/apis/UserApi.ts

@@ -12,30 +12,46 @@
  * Do not edit the class manually.
  */
 
-
 import * as runtime from '../runtime';
-import type {
-  GetUser,
-  LoginRes,
-  PostLogin,
-  PostResetPassword,
-  PostSendResetPassword,
-  PutUser,
-} from '../models/index';
 import {
+    type GetUser,
     GetUserFromJSON,
     GetUserToJSON,
+} from '../models/GetUser';
+import {
+    type GetUserAvatarUpload,
+    GetUserAvatarUploadFromJSON,
+    GetUserAvatarUploadToJSON,
+} from '../models/GetUserAvatarUpload';
+import {
+    type LoginRes,
     LoginResFromJSON,
     LoginResToJSON,
+} from '../models/LoginRes';
+import {
+    type PostLogin,
     PostLoginFromJSON,
     PostLoginToJSON,
+} from '../models/PostLogin';
+import {
+    type PostResetPassword,
     PostResetPasswordFromJSON,
     PostResetPasswordToJSON,
+} from '../models/PostResetPassword';
+import {
+    type PostSendResetPassword,
     PostSendResetPasswordFromJSON,
     PostSendResetPasswordToJSON,
+} from '../models/PostSendResetPassword';
+import {
+    type PutUser,
     PutUserFromJSON,
     PutUserToJSON,
-} from '../models/index';
+} from '../models/PutUser';
+
+export interface DeleteUserAvatarRequest {
+    userId: string;
+}
 
 export interface GetUserRequest {
     userId: string;
@@ -45,6 +61,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 +84,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
      */
@@ -155,7 +220,7 @@ export class UserApi extends runtime.BaseAPI {
 
 
         let urlPath = `/users/{userId}`;
-        urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
 
         return {
             path: urlPath,
@@ -266,6 +331,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
      */
@@ -292,7 +430,7 @@ export class UserApi extends runtime.BaseAPI {
 
 
         let urlPath = `/users/{userId}`;
-        urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
 
         return {
             path: urlPath,

package/src/models/GetPortal.ts

@@ -37,6 +37,18 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     parentPortalId?: string;
+    /**
+     * Platform subdomain slug used for '{slug}.edaxu.com'
+     * @type {string}
+     * @memberof GetPortal
+     */
+    slug?: string | null;
+    /**
+     * Customer-owned hostname for this portal
+     * @type {string}
+     * @memberof GetPortal
+     */
+    clientDomain?: string | null;
     /**
      * 
      * @type {string}
@@ -109,6 +121,8 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'id': json['id'],
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
         'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
@@ -131,6 +145,8 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'id': value['id'],
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
+        'slug': value['slug'],
+        'client_domain': value['clientDomain'],
         'logo_url': value['logoUrl'],
         'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],

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/PostPortal.ts

@@ -37,6 +37,18 @@ export interface PostPortal {
      * @memberof PostPortal
      */
     headerTextColor?: string;
+    /**
+     * Platform subdomain slug used for '{slug}.edaxu.com'
+     * @type {string}
+     * @memberof PostPortal
+     */
+    slug?: string | null;
+    /**
+     * Customer-owned hostname for this portal
+     * @type {string}
+     * @memberof PostPortal
+     */
+    clientDomain?: string | null;
 }
 
 /**
@@ -60,6 +72,8 @@ export function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'name': json['name'],
         'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
         'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
 }
 
@@ -77,6 +91,8 @@ export function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscrimin
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'slug': value['slug'],
+        'client_domain': value['clientDomain'],
     };
 }
 

package/src/models/PutPortalBranding.ts

@@ -37,6 +37,18 @@ export interface PutPortalBranding {
      * @memberof PutPortalBranding
      */
     headerTextColor?: string;
+    /**
+     * Platform subdomain slug used for '{slug}.edaxu.com'. Set null to inherit from an ancestor.
+     * @type {string}
+     * @memberof PutPortalBranding
+     */
+    slug?: string | null;
+    /**
+     * Customer-owned hostname for this portal. Set null to inherit from an ancestor.
+     * @type {string}
+     * @memberof PutPortalBranding
+     */
+    clientDomain?: string | null;
 }
 
 /**
@@ -59,6 +71,8 @@ export function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: b
         'name': json['name'] == null ? undefined : json['name'],
         'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
         'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
+        'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
     };
 }
 
@@ -76,6 +90,8 @@ export function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, i
         'name': value['name'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
+        'slug': value['slug'],
+        'client_domain': value['clientDomain'],
     };
 }
 

package/src/models/UpdateSelectedPortalResponse.ts

@@ -0,0 +1,92 @@
+/* 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';
+import type { UpdateSelectedPortalResponseSelectedPortal } from './UpdateSelectedPortalResponseSelectedPortal';
+import {
+    UpdateSelectedPortalResponseSelectedPortalFromJSON,
+    UpdateSelectedPortalResponseSelectedPortalFromJSONTyped,
+    UpdateSelectedPortalResponseSelectedPortalToJSON,
+    UpdateSelectedPortalResponseSelectedPortalToJSONTyped,
+} from './UpdateSelectedPortalResponseSelectedPortal';
+
+/**
+ * 
+ * @export
+ * @interface UpdateSelectedPortalResponse
+ */
+export interface UpdateSelectedPortalResponse {
+    /**
+     * JWT for API clients. Browser clients should rely on the auth cookie.
+     * @type {string}
+     * @memberof UpdateSelectedPortalResponse
+     */
+    token: string;
+    /**
+     * JWT expiration as a Unix timestamp in seconds.
+     * @type {number}
+     * @memberof UpdateSelectedPortalResponse
+     */
+    expiration: number;
+    /**
+     * 
+     * @type {UpdateSelectedPortalResponseSelectedPortal}
+     * @memberof UpdateSelectedPortalResponse
+     */
+    selectedPortal: UpdateSelectedPortalResponseSelectedPortal;
+}
+
+/**
+ * Check if a given object implements the UpdateSelectedPortalResponse interface.
+ */
+export function instanceOfUpdateSelectedPortalResponse(value: object): value is UpdateSelectedPortalResponse {
+    if (!('token' in value) || value['token'] === undefined) return false;
+    if (!('expiration' in value) || value['expiration'] === undefined) return false;
+    if (!('selectedPortal' in value) || value['selectedPortal'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSelectedPortalResponseFromJSON(json: any): UpdateSelectedPortalResponse {
+    return UpdateSelectedPortalResponseFromJSONTyped(json, false);
+}
+
+export function UpdateSelectedPortalResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSelectedPortalResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'token': json['token'],
+        'expiration': json['expiration'],
+        'selectedPortal': UpdateSelectedPortalResponseSelectedPortalFromJSON(json['selected_portal']),
+    };
+}
+
+export function UpdateSelectedPortalResponseToJSON(json: any): UpdateSelectedPortalResponse {
+    return UpdateSelectedPortalResponseToJSONTyped(json, false);
+}
+
+export function UpdateSelectedPortalResponseToJSONTyped(value?: UpdateSelectedPortalResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'token': value['token'],
+        'expiration': value['expiration'],
+        'selected_portal': UpdateSelectedPortalResponseSelectedPortalToJSON(value['selectedPortal']),
+    };
+}
+