@easyedu/js-lsm-api 1.32.0 → 1.34.0

package/src/apis/PortalApi.ts

@@ -66,7 +66,6 @@ export interface PutPortalBrandingRequest {
 
 export interface UpdateSelectedPortalRequest {
     portalId: string;
-    selectedUserRole?: string;
 }
 
 /**
@@ -75,9 +74,9 @@ export interface UpdateSelectedPortalRequest {
 export class PortalApi extends runtime.BaseAPI {
 
     /**
-     * Get a portal by id (can use \'current\' to get the current users selected portal)
+     * Creates request options for getPortalById without sending the request
      */
-    async getPortalByIdRaw(requestParameters: GetPortalByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+    async getPortalByIdRequestOpts(requestParameters: GetPortalByIdRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -93,12 +92,20 @@ export class PortalApi extends runtime.BaseAPI {
         let urlPath = `/portals/{portalId}`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a portal by id (can use \'current\' to get the current users selected portal)
+     */
+    async getPortalByIdRaw(requestParameters: GetPortalByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        const requestOptions = await this.getPortalByIdRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
     }
@@ -112,9 +119,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get all portals a user has access to
+     * Creates request options for getPortalList without sending the request
      */
-    async getPortalListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>> {
+    async getPortalListRequestOpts(): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         const headerParameters: runtime.HTTPHeaders = {};
@@ -122,12 +129,20 @@ export class PortalApi extends runtime.BaseAPI {
 
         let urlPath = `/portals`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get all portals a user has access to
+     */
+    async getPortalListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalList>> {
+        const requestOptions = await this.getPortalListRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalListFromJSON(jsonValue));
     }
@@ -141,9 +156,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get all users for a portal with optional role filtering
+     * Creates request options for getPortalUsers without sending the request
      */
-    async getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>> {
+    async getPortalUsersRequestOpts(requestParameters: GetPortalUsersRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -179,12 +194,20 @@ export class PortalApi extends runtime.BaseAPI {
         let urlPath = `/portals/{portalId}/users`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    async getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>> {
+        const requestOptions = await this.getPortalUsersRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserListFromJSON(jsonValue));
     }
@@ -198,9 +221,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Invite a new user to a portal
+     * Creates request options for inviteUserToPortal without sending the request
      */
-    async inviteUserToPortalRaw(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async inviteUserToPortalRequestOpts(requestParameters: InviteUserToPortalRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -225,13 +248,21 @@ export class PortalApi extends runtime.BaseAPI {
         let urlPath = `/portals/{portalId}/invite`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostPortalInviteToJSON(requestParameters['postPortalInvite']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Invite a new user to a portal
+     */
+    async inviteUserToPortalRaw(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.inviteUserToPortalRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -244,9 +275,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a new portal as a child of the current selected portal
+     * Creates request options for postPortal without sending the request
      */
-    async postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+    async postPortalRequestOpts(requestParameters: PostPortalRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['postPortal'] == null) {
             throw new runtime.RequiredError(
                 'postPortal',
@@ -263,13 +294,21 @@ export class PortalApi extends runtime.BaseAPI {
 
         let urlPath = `/portals`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostPortalToJSON(requestParameters['postPortal']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    async postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        const requestOptions = await this.postPortalRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
     }
@@ -283,9 +322,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update portal branding (name, background color, text color)
+     * Creates request options for putPortalBranding without sending the request
      */
-    async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+    async putPortalBrandingRequestOpts(requestParameters: PutPortalBrandingRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -310,13 +349,21 @@ export class PortalApi extends runtime.BaseAPI {
         let urlPath = `/portals/{portalId}`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
             body: PutPortalBrandingToJSON(requestParameters['putPortalBranding']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        const requestOptions = await this.putPortalBrandingRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
     }
@@ -330,9 +377,9 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update the users current selected portal
+     * Creates request options for updateSelectedPortal without sending the request
      */
-    async updateSelectedPortalRaw(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async updateSelectedPortalRequestOpts(requestParameters: UpdateSelectedPortalRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['portalId'] == null) {
             throw new runtime.RequiredError(
                 'portalId',
@@ -342,28 +389,32 @@ export class PortalApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
-        if (requestParameters['selectedUserRole'] != null) {
-            queryParameters['selectedUserRole'] = requestParameters['selectedUserRole'];
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
 
         let urlPath = `/portals/{portalId}/selected`;
         urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update the users current selected portal. Returns new JWT with updated roles.
+     */
+    async updateSelectedPortalRaw(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.updateSelectedPortalRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
 
     /**
-     * Update the users current selected portal
+     * Update the users current selected portal. Returns new JWT with updated roles.
      */
     async updateSelectedPortal(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
         await this.updateSelectedPortalRaw(requestParameters, initOverrides);

package/src/apis/QuestionApi.ts

@@ -65,9 +65,9 @@ export interface PutQuestionRequest {
 export class QuestionApi extends runtime.BaseAPI {
 
     /**
-     * Delete a question by ID
+     * Creates request options for deleteQuestion without sending the request
      */
-    async deleteQuestionRaw(requestParameters: DeleteQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+    async deleteQuestionRequestOpts(requestParameters: DeleteQuestionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['questionId'] == null) {
             throw new runtime.RequiredError(
                 'questionId',
@@ -83,12 +83,20 @@ export class QuestionApi extends runtime.BaseAPI {
         let urlPath = `/questions/{questionId}`;
         urlPath = urlPath.replace(`{${"questionId"}}`, encodeURIComponent(String(requestParameters['questionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Delete a question by ID
+     */
+    async deleteQuestionRaw(requestParameters: DeleteQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteQuestionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.VoidApiResponse(response);
     }
@@ -101,9 +109,9 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get a question by ID
+     * Creates request options for getQuestion without sending the request
      */
-    async getQuestionRaw(requestParameters: GetQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+    async getQuestionRequestOpts(requestParameters: GetQuestionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['questionId'] == null) {
             throw new runtime.RequiredError(
                 'questionId',
@@ -119,12 +127,20 @@ export class QuestionApi extends runtime.BaseAPI {
         let urlPath = `/questions/{questionId}`;
         urlPath = urlPath.replace(`{${"questionId"}}`, encodeURIComponent(String(requestParameters['questionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get a question by ID
+     */
+    async getQuestionRaw(requestParameters: GetQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+        const requestOptions = await this.getQuestionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetQuestionFromJSON(jsonValue));
     }
@@ -138,9 +154,9 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Get list of questions with filtering and pagination
+     * Creates request options for getQuestionList without sending the request
      */
-    async getQuestionListRaw(requestParameters: GetQuestionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestionList>> {
+    async getQuestionListRequestOpts(requestParameters: GetQuestionListRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
         if (requestParameters['page'] != null) {
@@ -180,12 +196,20 @@ export class QuestionApi extends runtime.BaseAPI {
 
         let urlPath = `/questions`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'GET',
             headers: headerParameters,
             query: queryParameters,
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Get list of questions with filtering and pagination
+     */
+    async getQuestionListRaw(requestParameters: GetQuestionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestionList>> {
+        const requestOptions = await this.getQuestionListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetQuestionListFromJSON(jsonValue));
     }
@@ -199,9 +223,9 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Create a new question
+     * Creates request options for postQuestion without sending the request
      */
-    async postQuestionRaw(requestParameters: PostQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+    async postQuestionRequestOpts(requestParameters: PostQuestionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['postQuestion'] == null) {
             throw new runtime.RequiredError(
                 'postQuestion',
@@ -218,13 +242,21 @@ export class QuestionApi extends runtime.BaseAPI {
 
         let urlPath = `/questions`;
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
             body: PostQuestionToJSON(requestParameters['postQuestion']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Create a new question
+     */
+    async postQuestionRaw(requestParameters: PostQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+        const requestOptions = await this.postQuestionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetQuestionFromJSON(jsonValue));
     }
@@ -238,9 +270,9 @@ export class QuestionApi extends runtime.BaseAPI {
     }
 
     /**
-     * Update a question by ID
+     * Creates request options for putQuestion without sending the request
      */
-    async putQuestionRaw(requestParameters: PutQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+    async putQuestionRequestOpts(requestParameters: PutQuestionRequest): Promise<runtime.RequestOpts> {
         if (requestParameters['questionId'] == null) {
             throw new runtime.RequiredError(
                 'questionId',
@@ -265,13 +297,21 @@ export class QuestionApi extends runtime.BaseAPI {
         let urlPath = `/questions/{questionId}`;
         urlPath = urlPath.replace(`{${"questionId"}}`, encodeURIComponent(String(requestParameters['questionId'])));
 
-        const response = await this.request({
+        return {
             path: urlPath,
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
             body: PutQuestionToJSON(requestParameters['putQuestion']),
-        }, initOverrides);
+        };
+    }
+
+    /**
+     * Update a question by ID
+     */
+    async putQuestionRaw(requestParameters: PutQuestionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetQuestion>> {
+        const requestOptions = await this.putQuestionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
 
         return new runtime.JSONApiResponse(response, (jsonValue) => GetQuestionFromJSON(jsonValue));
     }