@homespot-sdk/api 0.0.634 → 0.0.636

package/docs/MemberControllerApi.md

@@ -0,0 +1,151 @@
+# MemberControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**assignRole**](MemberControllerApi.md#assignroleoperation) | **PUT** /member/{memberId}/role |  |
+| [**assignRoleBatch**](MemberControllerApi.md#assignrolebatch) | **PUT** /member/role |  |
+
+
+
+## assignRole
+
+> assignRole(memberId, assignRoleRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemberControllerApi,
+} from '@homespot-sdk/api';
+import type { AssignRoleOperationRequest } 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 MemberControllerApi(config);
+
+  const body = {
+    // string
+    memberId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AssignRoleRequest
+    assignRoleRequest: ...,
+  } satisfies AssignRoleOperationRequest;
+
+  try {
+    const data = await api.assignRole(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **memberId** | `string` |  | [Defaults to `undefined`] |
+| **assignRoleRequest** | [AssignRoleRequest](AssignRoleRequest.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)
+
+
+## assignRoleBatch
+
+> assignRoleBatch(batchAssignRoleRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemberControllerApi,
+} from '@homespot-sdk/api';
+import type { AssignRoleBatchRequest } 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 MemberControllerApi(config);
+
+  const body = {
+    // BatchAssignRoleRequest
+    batchAssignRoleRequest: ...,
+  } satisfies AssignRoleBatchRequest;
+
+  try {
+    const data = await api.assignRoleBatch(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **batchAssignRoleRequest** | [BatchAssignRoleRequest](BatchAssignRoleRequest.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/MemberQueryControllerApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 ## getAllMembers
 
-> PagedModelMemberViewResponse getAllMembers(pageable)
+> PagedModelMemberViewResponse getAllMembers(roleId, page, size, sort)
 
 
 
@@ -32,8 +32,14 @@ async function example() {
   const api = new MemberQueryControllerApi(config);
 
   const body = {
-    // Pageable
-    pageable: ...,
+    // number (optional)
+    roleId: 56,
+    // 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 GetAllMembersRequest;
 
   try {
@@ -53,7 +59,10 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **pageable** | [](.md) |  | [Defaults to `undefined`] |
+| **roleId** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **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 `10`] |
+| **sort** | `Array<string>` | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [Optional] |
 
 ### Return type
 

package/docs/OrganizationSummaryViewResponse.md

@@ -13,7 +13,7 @@ Name | Type
 `roleId` | number
 `memberId` | string
 `roleName` | string
-`authorities` | Array<string>
+`permissions` | Array<string>
 `status` | string
 
 ## Example
@@ -30,7 +30,7 @@ const example = {
   "roleId": null,
   "memberId": null,
   "roleName": null,
-  "authorities": null,
+  "permissions": null,
   "status": null,
 } satisfies OrganizationSummaryViewResponse
 

package/docs/PageRoleResponse.md

@@ -0,0 +1,54 @@
+
+# PageRoleResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalElements` | number
+`totalPages` | number
+`size` | number
+`content` | [Array<RoleResponse>](RoleResponse.md)
+`number` | number
+`first` | boolean
+`last` | boolean
+`numberOfElements` | number
+`sort` | [SortObject](SortObject.md)
+`pageable` | [PageableObject](PageableObject.md)
+`empty` | boolean
+
+## Example
+
+```typescript
+import type { PageRoleResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalElements": null,
+  "totalPages": null,
+  "size": null,
+  "content": null,
+  "number": null,
+  "first": null,
+  "last": null,
+  "numberOfElements": null,
+  "sort": null,
+  "pageable": null,
+  "empty": null,
+} satisfies PageRoleResponse
+
+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 PageRoleResponse
+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/PageableObject.md

@@ -0,0 +1,44 @@
+
+# PageableObject
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`offset` | number
+`sort` | [SortObject](SortObject.md)
+`unpaged` | boolean
+`paged` | boolean
+`pageNumber` | number
+`pageSize` | number
+
+## Example
+
+```typescript
+import type { PageableObject } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "offset": null,
+  "sort": null,
+  "unpaged": null,
+  "paged": null,
+  "pageNumber": null,
+  "pageSize": null,
+} satisfies PageableObject
+
+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 PageableObject
+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/{PagedModelAgencyPeekViewResponse.md → PagedModelAgencySummaryResponse.md}

@@ -1,24 +1,24 @@
 
-# PagedModelAgencyPeekViewResponse
+# PagedModelAgencySummaryResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`content` | [Array<AgencyPeekViewResponse>](AgencyPeekViewResponse.md)
+`content` | [Array<AgencySummaryResponse>](AgencySummaryResponse.md)
 `page` | [PageMetadata](PageMetadata.md)
 
 ## Example
 
 ```typescript
-import type { PagedModelAgencyPeekViewResponse } from '@homespot-sdk/api'
+import type { PagedModelAgencySummaryResponse } from '@homespot-sdk/api'
 
 // TODO: Update the object below with actual values
 const example = {
   "content": null,
   "page": null,
-} satisfies PagedModelAgencyPeekViewResponse
+} satisfies PagedModelAgencySummaryResponse
 
 console.log(example)
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as PagedModelAgencyPeekViewResponse
+const exampleParsed = JSON.parse(exampleJSON) as PagedModelAgencySummaryResponse
 console.log(exampleParsed)
 ```
 

package/docs/PermissionResponse.md

@@ -0,0 +1,36 @@
+
+# PermissionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permission` | string
+`implied` | Array<string>
+
+## Example
+
+```typescript
+import type { PermissionResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "permission": null,
+  "implied": null,
+} satisfies PermissionResponse
+
+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 PermissionResponse
+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/{AgencyQueryControllerApi.md → PublicAgencyControllerApi.md}

@@ -1,18 +1,18 @@
-# AgencyQueryControllerApi
+# PublicAgencyControllerApi
 
 All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getAgency**](AgencyQueryControllerApi.md#getagency) | **GET** /agency/{agencyId} |  |
-| [**getAgencyBySubdomain**](AgencyQueryControllerApi.md#getagencybysubdomain) | **GET** /agency/subdomain/{subDomain} |  |
-| [**getAllAgencies**](AgencyQueryControllerApi.md#getallagencies) | **GET** /agency |  |
+| [**getAgency**](PublicAgencyControllerApi.md#getagency) | **GET** /public/agency/{agencyId} |  |
+| [**getAgencyBySubdomain**](PublicAgencyControllerApi.md#getagencybysubdomain) | **GET** /public/agency/subdomain/{subDomain} |  |
+| [**getAllAgencies**](PublicAgencyControllerApi.md#getallagencies) | **GET** /public/agency |  |
 
 
 
 ## getAgency
 
-> AgencyViewResponse getAgency(agencyId)
+> AgencyProfileResponse getAgency(agencyId)
 
 
 
@@ -21,7 +21,7 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 ```ts
 import {
   Configuration,
-  AgencyQueryControllerApi,
+  PublicAgencyControllerApi,
 } from '@homespot-sdk/api';
 import type { GetAgencyRequest } from '@homespot-sdk/api';
 
@@ -31,7 +31,7 @@ async function example() {
     // To configure OAuth2 access token for authorization: keycloak accessCode
     accessToken: "YOUR ACCESS TOKEN",
   });
-  const api = new AgencyQueryControllerApi(config);
+  const api = new PublicAgencyControllerApi(config);
 
   const body = {
     // string
@@ -59,7 +59,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**AgencyViewResponse**](AgencyViewResponse.md)
+[**AgencyProfileResponse**](AgencyProfileResponse.md)
 
 ### Authorization
 
@@ -81,7 +81,7 @@ example().catch(console.error);
 
 ## getAgencyBySubdomain
 
-> AgencyPeekViewResponse getAgencyBySubdomain(subDomain)
+> AgencySummaryResponse getAgencyBySubdomain(subDomain)
 
 
 
@@ -90,7 +90,7 @@ example().catch(console.error);
 ```ts
 import {
   Configuration,
-  AgencyQueryControllerApi,
+  PublicAgencyControllerApi,
 } from '@homespot-sdk/api';
 import type { GetAgencyBySubdomainRequest } from '@homespot-sdk/api';
 
@@ -100,7 +100,7 @@ async function example() {
     // To configure OAuth2 access token for authorization: keycloak accessCode
     accessToken: "YOUR ACCESS TOKEN",
   });
-  const api = new AgencyQueryControllerApi(config);
+  const api = new PublicAgencyControllerApi(config);
 
   const body = {
     // string
@@ -128,7 +128,7 @@ example().catch(console.error);
 
 ### Return type
 
-[**AgencyPeekViewResponse**](AgencyPeekViewResponse.md)
+[**AgencySummaryResponse**](AgencySummaryResponse.md)
 
 ### Authorization
 
@@ -150,7 +150,7 @@ example().catch(console.error);
 
 ## getAllAgencies
 
-> PagedModelAgencyPeekViewResponse getAllAgencies(pageable, status)
+> PagedModelAgencySummaryResponse getAllAgencies(status, page, size, sort)
 
 
 
@@ -159,7 +159,7 @@ example().catch(console.error);
 ```ts
 import {
   Configuration,
-  AgencyQueryControllerApi,
+  PublicAgencyControllerApi,
 } from '@homespot-sdk/api';
 import type { GetAllAgenciesRequest } from '@homespot-sdk/api';
 
@@ -169,13 +169,17 @@ async function example() {
     // To configure OAuth2 access token for authorization: keycloak accessCode
     accessToken: "YOUR ACCESS TOKEN",
   });
-  const api = new AgencyQueryControllerApi(config);
+  const api = new PublicAgencyControllerApi(config);
 
   const body = {
-    // Pageable
-    pageable: ...,
     // 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' (optional)
     status: status_example,
+    // 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 GetAllAgenciesRequest;
 
   try {
@@ -195,12 +199,14 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **pageable** | [](.md) |  | [Defaults to `undefined`] |
 | **status** | `NEW`, `ACTIVE`, `PAYMENT_FAILED`, `INACTIVE` |  | [Optional] [Defaults to `undefined`] [Enum: NEW, ACTIVE, PAYMENT_FAILED, INACTIVE] |
+| **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 `10`] |
+| **sort** | `Array<string>` | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [Optional] |
 
 ### Return type
 
-[**PagedModelAgencyPeekViewResponse**](PagedModelAgencyPeekViewResponse.md)
+[**PagedModelAgencySummaryResponse**](PagedModelAgencySummaryResponse.md)
 
 ### Authorization
 

package/docs/PublicInvitationControllerApi.md

@@ -0,0 +1,81 @@
+# PublicInvitationControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getInvitationDetails**](PublicInvitationControllerApi.md#getinvitationdetails) | **GET** /public/invitation/{invitationId} |  |
+
+
+
+## getInvitationDetails
+
+> InvitationDetailsResponse getInvitationDetails(invitationId, agencyId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicInvitationControllerApi,
+} from '@homespot-sdk/api';
+import type { GetInvitationDetailsRequest } 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 PublicInvitationControllerApi(config);
+
+  const body = {
+    // string
+    invitationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetInvitationDetailsRequest;
+
+  try {
+    const data = await api.getInvitationDetails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **invitationId** | `string` |  | [Defaults to `undefined`] |
+| **agencyId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**InvitationDetailsResponse**](InvitationDetailsResponse.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/PublicRoleControllerApi.md

@@ -0,0 +1,70 @@
+# PublicRoleControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listPermissionCatalog**](PublicRoleControllerApi.md#listpermissioncatalog) | **GET** /agency/roles/permissions |  |
+
+
+
+## listPermissionCatalog
+
+> Array<GroupedPermissionsResponse> listPermissionCatalog()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PublicRoleControllerApi,
+} from '@homespot-sdk/api';
+import type { ListPermissionCatalogRequest } 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 PublicRoleControllerApi(config);
+
+  try {
+    const data = await api.listPermissionCatalog();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<GroupedPermissionsResponse>**](GroupedPermissionsResponse.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)
+