@homespot-sdk/api 0.0.636 → 0.0.638

package/docs/LeadControllerApi.md

@@ -0,0 +1,817 @@
+# LeadControllerApi
+
+All URIs are relative to *https://gateway.dev.homespot.ge/rem*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**addListingIntent**](LeadControllerApi.md#addlistingintent) | **POST** /lead/{leadId}/listing-intents |  |
+| [**addSearchIntent**](LeadControllerApi.md#addsearchintent) | **POST** /lead/{leadId}/search-intents |  |
+| [**assignToAgent**](LeadControllerApi.md#assigntoagent) | **PUT** /lead/{leadId}/assign |  |
+| [**changeStatus**](LeadControllerApi.md#changestatusoperation) | **PUT** /lead/{leadId}/status |  |
+| [**createLead**](LeadControllerApi.md#createleadoperation) | **POST** /lead |  |
+| [**removeIntent**](LeadControllerApi.md#removeintent) | **DELETE** /lead/{leadId} |  |
+| [**updateContactInfo**](LeadControllerApi.md#updatecontactinfo) | **PUT** /lead/{leadId}/contact-info |  |
+| [**updateListingIntent**](LeadControllerApi.md#updatelistingintent) | **PUT** /lead/{leadId}/listing-intents |  |
+| [**updateNote**](LeadControllerApi.md#updatenoteoperation) | **PUT** /lead/{leadId}/note |  |
+| [**updateSearchIntent**](LeadControllerApi.md#updatesearchintent) | **PUT** /lead/{leadId}/search-intents |  |
+| [**updateSource**](LeadControllerApi.md#updatesource) | **PUT** /lead/{leadId}/source |  |
+
+
+
+## addListingIntent
+
+> addListingIntent(leadId, listingIntentRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { AddListingIntentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ListingIntentRequest
+    listingIntentRequest: ...,
+  } satisfies AddListingIntentRequest;
+
+  try {
+    const data = await api.addListingIntent(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`] |
+| **listingIntentRequest** | [ListingIntentRequest](ListingIntentRequest.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)
+
+
+## addSearchIntent
+
+> addSearchIntent(leadId, searchIntentRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { AddSearchIntentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SearchIntentRequest
+    searchIntentRequest: ...,
+  } satisfies AddSearchIntentRequest;
+
+  try {
+    const data = await api.addSearchIntent(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`] |
+| **searchIntentRequest** | [SearchIntentRequest](SearchIntentRequest.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)
+
+
+## assignToAgent
+
+> assignToAgent(leadId, assignToMemberRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { AssignToAgentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AssignToMemberRequest
+    assignToMemberRequest: ...,
+  } satisfies AssignToAgentRequest;
+
+  try {
+    const data = await api.assignToAgent(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`] |
+| **assignToMemberRequest** | [AssignToMemberRequest](AssignToMemberRequest.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)
+
+
+## changeStatus
+
+> changeStatus(leadId, changeStatusRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { ChangeStatusOperationRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ChangeStatusRequest
+    changeStatusRequest: ...,
+  } satisfies ChangeStatusOperationRequest;
+
+  try {
+    const data = await api.changeStatus(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`] |
+| **changeStatusRequest** | [ChangeStatusRequest](ChangeStatusRequest.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)
+
+
+## createLead
+
+> IdResponse createLead(createLeadRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { CreateLeadOperationRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // CreateLeadRequest
+    createLeadRequest: ...,
+  } satisfies CreateLeadOperationRequest;
+
+  try {
+    const data = await api.createLead(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createLeadRequest** | [CreateLeadRequest](CreateLeadRequest.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)
+
+
+## removeIntent
+
+> removeIntent(leadId, index, type)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { RemoveIntentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number
+    index: 56,
+    // 'SEARCH' | 'LISTING'
+    type: type_example,
+  } satisfies RemoveIntentRequest;
+
+  try {
+    const data = await api.removeIntent(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`] |
+| **index** | `number` |  | [Defaults to `undefined`] |
+| **type** | `SEARCH`, `LISTING` |  | [Defaults to `undefined`] [Enum: SEARCH, LISTING] |
+
+### 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)
+
+
+## updateContactInfo
+
+> updateContactInfo(leadId, contactInfoRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateContactInfoRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ContactInfoRequest
+    contactInfoRequest: ...,
+  } satisfies UpdateContactInfoRequest;
+
+  try {
+    const data = await api.updateContactInfo(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`] |
+| **contactInfoRequest** | [ContactInfoRequest](ContactInfoRequest.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)
+
+
+## updateListingIntent
+
+> updateListingIntent(leadId, index, listingIntentRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateListingIntentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number
+    index: 56,
+    // ListingIntentRequest
+    listingIntentRequest: ...,
+  } satisfies UpdateListingIntentRequest;
+
+  try {
+    const data = await api.updateListingIntent(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`] |
+| **index** | `number` |  | [Defaults to `undefined`] |
+| **listingIntentRequest** | [ListingIntentRequest](ListingIntentRequest.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)
+
+
+## updateNote
+
+> updateNote(leadId, updateNoteRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateNoteOperationRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateNoteRequest
+    updateNoteRequest: ...,
+  } satisfies UpdateNoteOperationRequest;
+
+  try {
+    const data = await api.updateNote(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`] |
+| **updateNoteRequest** | [UpdateNoteRequest](UpdateNoteRequest.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)
+
+
+## updateSearchIntent
+
+> updateSearchIntent(leadId, index, searchIntentRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateSearchIntentRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // number
+    index: 56,
+    // SearchIntentRequest
+    searchIntentRequest: ...,
+  } satisfies UpdateSearchIntentRequest;
+
+  try {
+    const data = await api.updateSearchIntent(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`] |
+| **index** | `number` |  | [Defaults to `undefined`] |
+| **searchIntentRequest** | [SearchIntentRequest](SearchIntentRequest.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)
+
+
+## updateSource
+
+> updateSource(leadId, sourceRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  LeadControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateSourceRequest } 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 LeadControllerApi(config);
+
+  const body = {
+    // string
+    leadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SourceRequest
+    sourceRequest: ...,
+  } satisfies UpdateSourceRequest;
+
+  try {
+    const data = await api.updateSource(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`] |
+| **sourceRequest** | [SourceRequest](SourceRequest.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)
+