@homespot-sdk/api 0.0.6

package/docs/AgencyControllerApi.md

@@ -0,0 +1,662 @@
+# AgencyControllerApi
+
+All URIs are relative to *http://localhost:8080*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**activateAgency**](AgencyControllerApi.md#activateagency) | **POST** /agency/{agencyId}/activate |  |
+| [**addRole**](AgencyControllerApi.md#addrole) | **POST** /agency/{agencyId}/roles |  |
+| [**createAgency**](AgencyControllerApi.md#createagencyoperation) | **POST** /agency |  |
+| [**generatePresignedUrl**](AgencyControllerApi.md#generatepresignedurl) | **PUT** /agency/{agencyId}/presigned-urls |  |
+| [**notifyCoverUploadCompletion**](AgencyControllerApi.md#notifycoveruploadcompletion) | **POST** /agency/{agencyId}/presigned-urls/notify/cover |  |
+| [**notifyLogoUploadCompletion**](AgencyControllerApi.md#notifylogouploadcompletion) | **POST** /agency/{agencyId}/presigned-urls/notify/logo |  |
+| [**removeRole**](AgencyControllerApi.md#removerole) | **DELETE** /agency/{agencyId}/roles/{roleId} |  |
+| [**updateRole**](AgencyControllerApi.md#updaterole) | **PUT** /agency/{agencyId}/roles/{roleId} |  |
+| [**updateSocialUrls**](AgencyControllerApi.md#updatesocialurls) | **PUT** /agency/{agencyId}/social-media |  |
+
+
+
+## activateAgency
+
+> IdResponse activateAgency(agencyId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { ActivateAgencyRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ActivateAgencyRequest;
+
+  try {
+    const data = await api.activateAgency(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
+
+[**IdResponse**](IdResponse.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)
+
+
+## addRole
+
+> addRole(agencyId, rolesRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { AddRoleRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // RolesRequest
+    rolesRequest: ...,
+  } satisfies AddRoleRequest;
+
+  try {
+    const data = await api.addRole(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`] |
+| **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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## createAgency
+
+> IdResponse createAgency(createAgencyRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { CreateAgencyOperationRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // CreateAgencyRequest
+    createAgencyRequest: ...,
+  } satisfies CreateAgencyOperationRequest;
+
+  try {
+    const data = await api.createAgency(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAgencyRequest** | [CreateAgencyRequest](CreateAgencyRequest.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)
+
+
+## generatePresignedUrl
+
+> PresignedUrlsResponse generatePresignedUrl(agencyId, photoRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { GeneratePresignedUrlRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PhotoRequest
+    photoRequest: ...,
+  } satisfies GeneratePresignedUrlRequest;
+
+  try {
+    const data = await api.generatePresignedUrl(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`] |
+| **photoRequest** | [PhotoRequest](PhotoRequest.md) |  | |
+
+### Return type
+
+[**PresignedUrlsResponse**](PresignedUrlsResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## notifyCoverUploadCompletion
+
+> UploadAcknowledgmentResponse notifyCoverUploadCompletion(agencyId, photoRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { NotifyCoverUploadCompletionRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PhotoRequest
+    photoRequest: ...,
+  } satisfies NotifyCoverUploadCompletionRequest;
+
+  try {
+    const data = await api.notifyCoverUploadCompletion(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`] |
+| **photoRequest** | [PhotoRequest](PhotoRequest.md) |  | |
+
+### Return type
+
+[**UploadAcknowledgmentResponse**](UploadAcknowledgmentResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## notifyLogoUploadCompletion
+
+> UploadAcknowledgmentResponse notifyLogoUploadCompletion(agencyId, photoRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { NotifyLogoUploadCompletionRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PhotoRequest
+    photoRequest: ...,
+  } satisfies NotifyLogoUploadCompletionRequest;
+
+  try {
+    const data = await api.notifyLogoUploadCompletion(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`] |
+| **photoRequest** | [PhotoRequest](PhotoRequest.md) |  | |
+
+### Return type
+
+[**UploadAcknowledgmentResponse**](UploadAcknowledgmentResponse.md)
+
+### Authorization
+
+[keycloak accessCode](../README.md#keycloak-accessCode)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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)
+
+
+## removeRole
+
+> removeRole(agencyId, roleId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // 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 |
+|------------- | ------------- | ------------- | -------------|
+| **agencyId** | `string` |  | [Defaults to `undefined`] |
+| **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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## updateRole
+
+> updateRole(agencyId, roleId, rolesRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // 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 |
+|------------- | ------------- | ------------- | -------------|
+| **agencyId** | `string` |  | [Defaults to `undefined`] |
+| **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 |
+|-------------|-------------|------------------|
+| **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)
+
+
+## updateSocialUrls
+
+> updateSocialUrls(agencyId, socialMediasRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyControllerApi,
+} from '@homespot-sdk/api';
+import type { UpdateSocialUrlsRequest } 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 AgencyControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // SocialMediasRequest
+    socialMediasRequest: ...,
+  } satisfies UpdateSocialUrlsRequest;
+
+  try {
+    const data = await api.updateSocialUrls(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`] |
+| **socialMediasRequest** | [SocialMediasRequest](SocialMediasRequest.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 |
+|-------------|-------------|------------------|
+| **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)
+