@homespot-sdk/api 0.0.636 → 0.0.638

package/docs/LeadProjectionResponse.md

@@ -0,0 +1,62 @@
+
+# LeadProjectionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`createdBy` | string
+`assignedTo` | string
+`status` | string
+`contactFullName` | string
+`contactPhoneNumber` | string
+`contactEmail` | string
+`noteTitle` | string
+`noteContent` | string
+`sourceType` | string
+`sourceLink` | string
+`isSearcher` | boolean
+`isLister` | boolean
+`searchIntents` | [Array<SearchIntentResponse>](SearchIntentResponse.md)
+`listingIntents` | [Array<ListingIntentResponse>](ListingIntentResponse.md)
+
+## Example
+
+```typescript
+import type { LeadProjectionResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "createdBy": null,
+  "assignedTo": null,
+  "status": null,
+  "contactFullName": null,
+  "contactPhoneNumber": null,
+  "contactEmail": null,
+  "noteTitle": null,
+  "noteContent": null,
+  "sourceType": null,
+  "sourceLink": null,
+  "isSearcher": null,
+  "isLister": null,
+  "searchIntents": null,
+  "listingIntents": null,
+} satisfies LeadProjectionResponse
+
+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 LeadProjectionResponse
+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/LeadQueryControllerApi.md

@@ -0,0 +1,163 @@
+# LeadQueryControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getLeadById**](LeadQueryControllerApi.md#getleadbyid) | **GET** /lead/{leadId} |  |
+| [**searchLeads**](LeadQueryControllerApi.md#searchleads) | **GET** /lead |  |
+
+
+
+## getLeadById
+
+> LeadProjectionResponse getLeadById(leadId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetLeadByIdRequest } 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 LeadQueryControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetLeadByIdRequest;
+
+  try {
+    const data = await api.getLeadById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **leadId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**LeadProjectionResponse**](LeadProjectionResponse.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)
+
+
+## searchLeads
+
+> PageLeadProjectionResponse searchLeads(status, isSearcher, isLister, page, size, sort)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { SearchLeadsRequest } 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 LeadQueryControllerApi(config);
+
+  const body = {
+    // 'NEW' | 'ATTEMPTED_CONTACT' | 'CONTACTED' | 'DISQUALIFIED' | 'CONVERTED' | 'LOST' (optional)
+    status: status_example,
+    // boolean (optional)
+    isSearcher: true,
+    // boolean (optional)
+    isLister: true,
+    // 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 SearchLeadsRequest;
+
+  try {
+    const data = await api.searchLeads(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **status** | `NEW`, `ATTEMPTED_CONTACT`, `CONTACTED`, `DISQUALIFIED`, `CONVERTED`, `LOST` |  | [Optional] [Defaults to `undefined`] [Enum: NEW, ATTEMPTED_CONTACT, CONTACTED, DISQUALIFIED, CONVERTED, LOST] |
+| **isSearcher** | `boolean` |  | [Optional] [Defaults to `undefined`] |
+| **isLister** | `boolean` |  | [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 `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
+
+[**PageLeadProjectionResponse**](PageLeadProjectionResponse.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/ListingIntentRequest.md

@@ -0,0 +1,44 @@
+
+# ListingIntentRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`propertyType` | string
+`dealType` | string
+`desiredPrice` | [PriceRangeRequest](PriceRangeRequest.md)
+`address` | [AddressRefRequest](AddressRefRequest.md)
+`area` | number
+`numberOfRooms` | number
+
+## Example
+
+```typescript
+import type { ListingIntentRequest } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "propertyType": null,
+  "dealType": null,
+  "desiredPrice": null,
+  "address": null,
+  "area": null,
+  "numberOfRooms": null,
+} satisfies ListingIntentRequest
+
+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 ListingIntentRequest
+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/ListingIntentResponse.md

@@ -0,0 +1,58 @@
+
+# ListingIntentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`propertyType` | string
+`dealType` | string
+`desiredPriceMin` | number
+`desiredPriceMax` | number
+`regionId` | number
+`cityId` | number
+`districtId` | number
+`subDistrictId` | number
+`streetId` | number
+`lat` | number
+`lng` | number
+`area` | number
+`numberOfRooms` | number
+
+## Example
+
+```typescript
+import type { ListingIntentResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "propertyType": null,
+  "dealType": null,
+  "desiredPriceMin": null,
+  "desiredPriceMax": null,
+  "regionId": null,
+  "cityId": null,
+  "districtId": null,
+  "subDistrictId": null,
+  "streetId": null,
+  "lat": null,
+  "lng": null,
+  "area": null,
+  "numberOfRooms": null,
+} satisfies ListingIntentResponse
+
+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 ListingIntentResponse
+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/LocationRefRequest.md

@@ -0,0 +1,42 @@
+
+# LocationRefRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`regionId` | number
+`cityId` | number
+`districtId` | number
+`subDistrictId` | number
+`streetId` | number
+
+## Example
+
+```typescript
+import type { LocationRefRequest } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "regionId": null,
+  "cityId": null,
+  "districtId": null,
+  "subDistrictId": null,
+  "streetId": null,
+} satisfies LocationRefRequest
+
+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 LocationRefRequest
+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/PageLeadProjectionResponse.md

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

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

package/docs/PageableObject.md

@@ -7,11 +7,11 @@
 Name | Type
 ------------ | -------------
 `offset` | number
-`sort` | [SortObject](SortObject.md)
 `unpaged` | boolean
 `paged` | boolean
 `pageNumber` | number
 `pageSize` | number
+`sort` | [SortObject](SortObject.md)
 
 ## Example
 
@@ -21,11 +21,11 @@ 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,
+  "sort": null,
 } satisfies PageableObject
 
 console.log(example)

package/docs/PriceRangeRequest.md

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

@@ -4,81 +4,11 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**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
-
-> AgencyProfileResponse getAgency(agencyId)
-
-
-
-### Example
-
-```ts
-import {
-  Configuration,
-  PublicAgencyControllerApi,
-} from '@homespot-sdk/api';
-import type { GetAgencyRequest } 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 PublicAgencyControllerApi(config);
-
-  const body = {
-    // string
-    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-  } satisfies GetAgencyRequest;
-
-  try {
-    const data = await api.getAgency(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **agencyId** | `string` |  | [Defaults to `undefined`] |
-
-### Return type
-
-[**AgencyProfileResponse**](AgencyProfileResponse.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)
-
-
 ## getAgencyBySubdomain
 
 > AgencySummaryResponse getAgencyBySubdomain(subDomain)

package/docs/PublicRoleControllerApi.md

@@ -4,7 +4,7 @@ All URIs are relative to *https://gateway.dev.homespot.ge/rem*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**listPermissionCatalog**](PublicRoleControllerApi.md#listpermissioncatalog) | **GET** /agency/roles/permissions |  |
+| [**listPermissionCatalog**](PublicRoleControllerApi.md#listpermissioncatalog) | **GET** /public/agency/roles/permissions |  |
 
 
 

package/docs/SearchIntentRequest.md

@@ -0,0 +1,44 @@
+
+# SearchIntentRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`propertyType` | string
+`dealType` | string
+`budget` | [PriceRangeRequest](PriceRangeRequest.md)
+`targetLocation` | [LocationRefRequest](LocationRefRequest.md)
+`area` | number
+`numberOfRooms` | number
+
+## Example
+
+```typescript
+import type { SearchIntentRequest } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "propertyType": null,
+  "dealType": null,
+  "budget": null,
+  "targetLocation": null,
+  "area": null,
+  "numberOfRooms": null,
+} satisfies SearchIntentRequest
+
+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 SearchIntentRequest
+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)
+
+