@homespot-sdk/api 0.0.634 → 0.0.636

package/docs/RoleControllerApi.md

@@ -0,0 +1,221 @@
+# RoleControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createRole**](RoleControllerApi.md#createrole) | **POST** /roles |  |
+| [**removeRole**](RoleControllerApi.md#removerole) | **DELETE** /roles/{roleId} |  |
+| [**updateRole**](RoleControllerApi.md#updaterole) | **PUT** /roles/{roleId} |  |
+
+
+
+## createRole
+
+> IdResponse createRole(rolesRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleControllerApi,
+} from '@homespot-sdk/api';
+import type { CreateRoleRequest } from '@homespot-sdk/api';
+
+async function example() {
+  console.log("🚀 Testing @homespot-sdk/api SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: keycloak accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RoleControllerApi(config);
+
+  const body = {
+    // RolesRequest
+    rolesRequest: ...,
+  } satisfies CreateRoleRequest;
+
+  try {
+    const data = await api.createRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **rolesRequest** | [RolesRequest](RolesRequest.md) |  | |
+
+### Return type
+
+[**IdResponse**](IdResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `*/*`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeRole
+
+> removeRole(roleId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleControllerApi,
+} from '@homespot-sdk/api';
+import type { RemoveRoleRequest } from '@homespot-sdk/api';
+
+async function example() {
+  console.log("🚀 Testing @homespot-sdk/api SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: keycloak accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RoleControllerApi(config);
+
+  const body = {
+    // number
+    roleId: 56,
+  } satisfies RemoveRoleRequest;
+
+  try {
+    const data = await api.removeRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `number` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateRole
+
+> updateRole(roleId, rolesRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateRoleRequest } from '@homespot-sdk/api';
+
+async function example() {
+  console.log("🚀 Testing @homespot-sdk/api SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: keycloak accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RoleControllerApi(config);
+
+  const body = {
+    // number
+    roleId: 56,
+    // RolesRequest
+    rolesRequest: ...,
+  } satisfies UpdateRoleRequest;
+
+  try {
+    const data = await api.updateRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **roleId** | `number` |  | [Defaults to `undefined`] |
+| **rolesRequest** | [RolesRequest](RolesRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/RoleQueryControllerApi.md

@@ -0,0 +1,84 @@
+# RoleQueryControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listRoles**](RoleQueryControllerApi.md#listroles) | **GET** /roles |  |
+
+
+
+## listRoles
+
+> PageRoleResponse listRoles(page, size, sort)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RoleQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { ListRolesRequest } from '@homespot-sdk/api';
+
+async function example() {
+  console.log("🚀 Testing @homespot-sdk/api SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: keycloak accessCode
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new RoleQueryControllerApi(config);
+
+  const body = {
+    // number | Zero-based page index (0..N) (optional)
+    page: 56,
+    // number | The size of the page to be returned (optional)
+    size: 56,
+    // Array<string> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
+    sort: ...,
+  } satisfies ListRolesRequest;
+
+  try {
+    const data = await api.listRoles(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Zero-based page index (0..N) | [Optional] [Defaults to `0`] |
+| **size** | `number` | The size of the page to be returned | [Optional] [Defaults to `20`] |
+| **sort** | `Array<string>` | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [Optional] |
+
+### Return type
+
+[**PageRoleResponse**](PageRoleResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `*/*`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/RoleResponse.md

@@ -0,0 +1,40 @@
+
+# RoleResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`description` | string
+`permissions` | Array<string>
+
+## Example
+
+```typescript
+import type { RoleResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "permissions": null,
+} satisfies RoleResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RoleResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RolesRequest.md

@@ -8,7 +8,7 @@ Name | Type
 ------------ | -------------
 `name` | string
 `description` | string
-`authorities` | Array<string>
+`permissions` | Array<string>
 
 ## Example
 
@@ -19,7 +19,7 @@ import type { RolesRequest } from '@homespot-sdk/api'
 const example = {
   "name": null,
   "description": null,
-  "authorities": null,
+  "permissions": null,
 } satisfies RolesRequest
 
 console.log(example)

package/docs/SortObject.md

@@ -0,0 +1,38 @@
+
+# SortObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`empty` | boolean
+`sorted` | boolean
+`unsorted` | boolean
+
+## Example
+
+```typescript
+import type { SortObject } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "empty": null,
+  "sorted": null,
+  "unsorted": null,
+} satisfies SortObject
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SortObject
+console.log(exampleParsed)
+```
+
+[[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": "@homespot-sdk/api",
-  "version": "0.0.634",
+  "version": "0.0.636",
   "description": "OpenAPI client for @homespot-sdk/api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AgencyControllerApi.ts

@@ -19,7 +19,6 @@ import type {
   IdResponse,
   PhotoRequest,
   PresignedUrlsResponse,
-  RolesRequest,
   SocialMediasRequest,
   UploadAcknowledgmentResponse,
 } from '../models/index';
@@ -32,8 +31,6 @@ import {
     PhotoRequestToJSON,
     PresignedUrlsResponseFromJSON,
     PresignedUrlsResponseToJSON,
-    RolesRequestFromJSON,
-    RolesRequestToJSON,
     SocialMediasRequestFromJSON,
     SocialMediasRequestToJSON,
     UploadAcknowledgmentResponseFromJSON,
@@ -44,10 +41,6 @@ export interface ActivateAgencyRequest {
     agencyId: string;
 }
 
-export interface AddRoleRequest {
-    rolesRequest: RolesRequest;
-}
-
 export interface CorrectRegistrationDetailsRequest {
     agencyId: string;
     createAgencyRequest: CreateAgencyRequest;
@@ -69,15 +62,6 @@ export interface NotifyLogoUploadCompletionRequest {
     photoRequest: PhotoRequest;
 }
 
-export interface RemoveRoleRequest {
-    roleId: number;
-}
-
-export interface UpdateRoleRequest {
-    roleId: number;
-    rolesRequest: RolesRequest;
-}
-
 export interface UpdateSocialUrlsRequest {
     socialMediasRequest: SocialMediasRequest;
 }
@@ -102,19 +86,6 @@ export interface AgencyControllerApiInterface {
      */
     activateAgency(requestParameters: ActivateAgencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
-    /**
-     * 
-     * @param {RolesRequest} rolesRequest 
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AgencyControllerApiInterface
-     */
-    addRoleRaw(requestParameters: AddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-
-    /**
-     */
-    addRole(requestParameters: AddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-
     /**
      * 
      * @param {string} agencyId 
@@ -181,33 +152,6 @@ export interface AgencyControllerApiInterface {
      */
     notifyLogoUploadCompletion(requestParameters: NotifyLogoUploadCompletionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadAcknowledgmentResponse>;
 
-    /**
-     * 
-     * @param {number} roleId 
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AgencyControllerApiInterface
-     */
-    removeRoleRaw(requestParameters: RemoveRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-
-    /**
-     */
-    removeRole(requestParameters: RemoveRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-
-    /**
-     * 
-     * @param {number} roleId 
-     * @param {RolesRequest} rolesRequest 
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof AgencyControllerApiInterface
-     */
-    updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
-
-    /**
-     */
-    updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
-
     /**
      * 
      * @param {SocialMediasRequest} socialMediasRequest 
@@ -253,7 +197,7 @@ export class AgencyControllerApi extends runtime.BaseAPI implements AgencyContro
 
         const response = await this.request({
             path: urlPath,
-            method: 'POST',
+            method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
@@ -267,47 +211,6 @@ export class AgencyControllerApi extends runtime.BaseAPI implements AgencyContro
         await this.activateAgencyRaw(requestParameters, initOverrides);
     }
 
-    /**
-     */
-    async addRoleRaw(requestParameters: AddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
-        if (requestParameters['rolesRequest'] == null) {
-            throw new runtime.RequiredError(
-                'rolesRequest',
-                'Required parameter "rolesRequest" was null or undefined when calling addRole().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("keycloak", []);
-        }
-
-
-        let urlPath = `/agency/roles`;
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: RolesRequestToJSON(requestParameters['rolesRequest']),
-        }, initOverrides);
-
-        return new runtime.VoidApiResponse(response);
-    }
-
-    /**
-     */
-    async addRole(requestParameters: AddRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.addRoleRaw(requestParameters, initOverrides);
-    }
-
     /**
      */
     async correctRegistrationDetailsRaw(requestParameters: CorrectRegistrationDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -525,94 +428,6 @@ export class AgencyControllerApi extends runtime.BaseAPI implements AgencyContro
         return await response.value();
     }
 
-    /**
-     */
-    async removeRoleRaw(requestParameters: RemoveRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
-        if (requestParameters['roleId'] == null) {
-            throw new runtime.RequiredError(
-                'roleId',
-                'Required parameter "roleId" was null or undefined when calling removeRole().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("keycloak", []);
-        }
-
-
-        let urlPath = `/agency/roles/{roleId}`;
-        urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'DELETE',
-            headers: headerParameters,
-            query: queryParameters,
-        }, initOverrides);
-
-        return new runtime.VoidApiResponse(response);
-    }
-
-    /**
-     */
-    async removeRole(requestParameters: RemoveRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.removeRoleRaw(requestParameters, initOverrides);
-    }
-
-    /**
-     */
-    async updateRoleRaw(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
-        if (requestParameters['roleId'] == null) {
-            throw new runtime.RequiredError(
-                'roleId',
-                'Required parameter "roleId" was null or undefined when calling updateRole().'
-            );
-        }
-
-        if (requestParameters['rolesRequest'] == null) {
-            throw new runtime.RequiredError(
-                'rolesRequest',
-                'Required parameter "rolesRequest" was null or undefined when calling updateRole().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            // oauth required
-            headerParameters["Authorization"] = await this.configuration.accessToken("keycloak", []);
-        }
-
-
-        let urlPath = `/agency/roles/{roleId}`;
-        urlPath = urlPath.replace(`{${"roleId"}}`, encodeURIComponent(String(requestParameters['roleId'])));
-
-        const response = await this.request({
-            path: urlPath,
-            method: 'PUT',
-            headers: headerParameters,
-            query: queryParameters,
-            body: RolesRequestToJSON(requestParameters['rolesRequest']),
-        }, initOverrides);
-
-        return new runtime.VoidApiResponse(response);
-    }
-
-    /**
-     */
-    async updateRole(requestParameters: UpdateRoleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
-        await this.updateRoleRaw(requestParameters, initOverrides);
-    }
-
     /**
      */
     async updateSocialUrlsRaw(requestParameters: UpdateSocialUrlsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {