@homespot-sdk/api 0.0.633 → 0.0.635

package/docs/AgencyQueryControllerApi.md

@@ -5,6 +5,9 @@ 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 |  |
+| [**getAllPermissions**](AgencyQueryControllerApi.md#getallpermissions) | **GET** /agency/roles/permissions |  |
 
 
 
@@ -76,3 +79,205 @@ example().catch(console.error);
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## getAgencyBySubdomain
+
+> AgencyPeekViewResponse getAgencyBySubdomain(subDomain)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetAgencyBySubdomainRequest } 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 AgencyQueryControllerApi(config);
+
+  const body = {
+    // string
+    subDomain: subDomain_example,
+  } satisfies GetAgencyBySubdomainRequest;
+
+  try {
+    const data = await api.getAgencyBySubdomain(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **subDomain** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AgencyPeekViewResponse**](AgencyPeekViewResponse.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)
+
+
+## getAllAgencies
+
+> PagedModelAgencyPeekViewResponse getAllAgencies(pageable, status)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetAllAgenciesRequest } 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 AgencyQueryControllerApi(config);
+
+  const body = {
+    // Pageable
+    pageable: ...,
+    // 'NEW' | 'ACTIVE' | 'PAYMENT_FAILED' | 'INACTIVE' (optional)
+    status: status_example,
+  } satisfies GetAllAgenciesRequest;
+
+  try {
+    const data = await api.getAllAgencies(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| 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] |
+
+### Return type
+
+[**PagedModelAgencyPeekViewResponse**](PagedModelAgencyPeekViewResponse.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)
+
+
+## getAllPermissions
+
+> Array<GroupedPermissionsResponse> getAllPermissions()
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetAllPermissionsRequest } 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 AgencyQueryControllerApi(config);
+
+  try {
+    const data = await api.getAllPermissions();
+    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)
+

package/docs/GroupedPermissionsResponse.md

@@ -0,0 +1,36 @@
+
+# GroupedPermissionsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`permissions` | [Array<PermissionResponse>](PermissionResponse.md)
+
+## Example
+
+```typescript
+import type { GroupedPermissionsResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "permissions": null,
+} satisfies GroupedPermissionsResponse
+
+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 GroupedPermissionsResponse
+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/InvitationControllerApi.md

@@ -4,8 +4,8 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**inviteAccepted**](InvitationControllerApi.md#inviteaccepted) | **POST** /agency/{agencyId}/invitation/{invitationId} |  |
-| [**inviteMember**](InvitationControllerApi.md#invitememberoperation) | **POST** /agency/{agencyId}/invitation |  |
+| [**inviteAccepted**](InvitationControllerApi.md#inviteaccepted) | **POST** /invitation/{invitationId} |  |
+| [**inviteMember**](InvitationControllerApi.md#invitememberoperation) | **POST** /invitation |  |
 
 
 
@@ -83,7 +83,7 @@ example().catch(console.error);
 
 ## inviteMember
 
-> inviteMember(agencyId, inviteMemberRequest)
+> inviteMember(inviteMemberRequest)
 
 
 
@@ -105,8 +105,6 @@ async function example() {
   const api = new InvitationControllerApi(config);
 
   const body = {
-    // string
-    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // InviteMemberRequest
     inviteMemberRequest: ...,
   } satisfies InviteMemberOperationRequest;
@@ -128,7 +126,6 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **agencyId** | `string` |  | [Defaults to `undefined`] |
 | **inviteMemberRequest** | [InviteMemberRequest](InviteMemberRequest.md) |  | |
 
 ### Return type

package/docs/InvitationDetailsRequest.md

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

@@ -0,0 +1,44 @@
+
+# InvitationDetailsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`invitationId` | string
+`agencyId` | string
+`email` | string
+`status` | string
+`agencyName` | string
+`agencyLogo` | string
+
+## Example
+
+```typescript
+import type { InvitationDetailsResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "invitationId": null,
+  "agencyId": null,
+  "email": null,
+  "status": null,
+  "agencyName": null,
+  "agencyLogo": null,
+} satisfies InvitationDetailsResponse
+
+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 InvitationDetailsResponse
+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/InvitationQueryControllerApi.md

@@ -4,13 +4,14 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**getAllInvitations**](InvitationQueryControllerApi.md#getallinvitations) | **GET** /agency/{agencyId}/invitation |  |
+| [**getAllInvitations**](InvitationQueryControllerApi.md#getallinvitations) | **GET** /invitation |  |
+| [**getInvitationDetails**](InvitationQueryControllerApi.md#getinvitationdetails) | **GET** /invitation/{invitationId} |  |
 
 
 
 ## getAllInvitations
 
-> Array<InvitationViewResponse> getAllInvitations(agencyId)
+> PagedModelInvitationViewResponse getAllInvitations(pageable)
 
 
 
@@ -32,8 +33,8 @@ async function example() {
   const api = new InvitationQueryControllerApi(config);
 
   const body = {
-    // string
-    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Pageable
+    pageable: ...,
   } satisfies GetAllInvitationsRequest;
 
   try {
@@ -53,11 +54,83 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **pageable** | [](.md) |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PagedModelInvitationViewResponse**](PagedModelInvitationViewResponse.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)
+
+
+## getInvitationDetails
+
+> InvitationDetailsResponse getInvitationDetails(invitationId, agencyId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitationQueryControllerApi,
+} 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 InvitationQueryControllerApi(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
 
-[**Array<InvitationViewResponse>**](InvitationViewResponse.md)
+[**InvitationDetailsResponse**](InvitationDetailsResponse.md)
 
 ### Authorization
 

package/docs/InviteMemberRequest.md

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`emails` | Array<string>
+`emails` | [Array<InvitationDetailsRequest>](InvitationDetailsRequest.md)
 
 ## Example
 

package/docs/MemberQueryControllerApi.md

@@ -0,0 +1,78 @@
+# MemberQueryControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAllMembers**](MemberQueryControllerApi.md#getallmembers) | **GET** /member |  |
+
+
+
+## getAllMembers
+
+> PagedModelMemberViewResponse getAllMembers(pageable)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MemberQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetAllMembersRequest } 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 MemberQueryControllerApi(config);
+
+  const body = {
+    // Pageable
+    pageable: ...,
+  } satisfies GetAllMembersRequest;
+
+  try {
+    const data = await api.getAllMembers(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pageable** | [](.md) |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PagedModelMemberViewResponse**](PagedModelMemberViewResponse.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/MemberViewResponse.md

@@ -0,0 +1,48 @@
+
+# MemberViewResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`firstName` | string
+`lastName` | string
+`phone` | string
+`email` | string
+`roleId` | number
+`roleName` | string
+`joinedAt` | Date
+
+## Example
+
+```typescript
+import type { MemberViewResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "firstName": null,
+  "lastName": null,
+  "phone": null,
+  "email": null,
+  "roleId": null,
+  "roleName": null,
+  "joinedAt": null,
+} satisfies MemberViewResponse
+
+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 MemberViewResponse
+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/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/PageMetadata.md

@@ -0,0 +1,40 @@
+
+# PageMetadata
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | number
+`number` | number
+`totalElements` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PageMetadata } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "number": null,
+  "totalElements": null,
+  "totalPages": null,
+} satisfies PageMetadata
+
+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 PageMetadata
+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)
+
+