@homespot-sdk/api 0.0.6

package/docs/AgencyQueryControllerApi.md

@@ -0,0 +1,78 @@
+# AgencyQueryControllerApi
+
+All URIs are relative to *http://localhost:8080*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAgency**](AgencyQueryControllerApi.md#getagency) | **GET** /agency/{agencyId} |  |
+
+
+
+## getAgency
+
+> getAgency(agencyId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgencyQueryControllerApi,
+} 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 AgencyQueryControllerApi(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
+
+`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)
+

package/docs/CreateAgencyRequest.md

@@ -0,0 +1,46 @@
+
+# CreateAgencyRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`email` | string
+`seats` | number
+`subDomain` | string
+`phone` | string
+`address` | [AddressRequest](AddressRequest.md)
+`yearSince` | number
+
+## Example
+
+```typescript
+import type { CreateAgencyRequest } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "email": null,
+  "seats": null,
+  "subDomain": null,
+  "phone": null,
+  "address": null,
+  "yearSince": null,
+} satisfies CreateAgencyRequest
+
+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 CreateAgencyRequest
+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/IdResponse.md

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

@@ -0,0 +1,154 @@
+# InvitationControllerApi
+
+All URIs are relative to *http://localhost:8080*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**inviteAccepted**](InvitationControllerApi.md#inviteaccepted) | **POST** /agency/{agencyId}/invitation/{invitationId} |  |
+| [**inviteMember**](InvitationControllerApi.md#invitememberoperation) | **POST** /agency/{agencyId}/invitation |  |
+
+
+
+## inviteAccepted
+
+> inviteAccepted(agencyId, invitationId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitationControllerApi,
+} from '@homespot-sdk/api';
+import type { InviteAcceptedRequest } 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 InvitationControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    invitationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies InviteAcceptedRequest;
+
+  try {
+    const data = await api.inviteAccepted(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`] |
+| **invitationId** | `string` |  | [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)
+
+
+## inviteMember
+
+> inviteMember(agencyId, inviteMemberRequest)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitationControllerApi,
+} from '@homespot-sdk/api';
+import type { InviteMemberOperationRequest } 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 InvitationControllerApi(config);
+
+  const body = {
+    // string
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // InviteMemberRequest
+    inviteMemberRequest: ...,
+  } satisfies InviteMemberOperationRequest;
+
+  try {
+    const data = await api.inviteMember(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`] |
+| **inviteMemberRequest** | [InviteMemberRequest](InviteMemberRequest.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)
+

package/docs/InvitationQueryControllerApi.md

@@ -0,0 +1,78 @@
+# InvitationQueryControllerApi
+
+All URIs are relative to *http://localhost:8080*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAllInvitations**](InvitationQueryControllerApi.md#getallinvitations) | **GET** /agency/{agencyId}/invitation |  |
+
+
+
+## getAllInvitations
+
+> Array<InvitationViewResponse> getAllInvitations(agencyId)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InvitationQueryControllerApi,
+} from '@homespot-sdk/api';
+import type { GetAllInvitationsRequest } 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
+    agencyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAllInvitationsRequest;
+
+  try {
+    const data = await api.getAllInvitations(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
+
+[**Array<InvitationViewResponse>**](InvitationViewResponse.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/InvitationViewResponse.md

@@ -0,0 +1,46 @@
+
+# InvitationViewResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`invitationId` | string
+`email` | string
+`status` | string
+`createdAt` | Date
+`expiresAt` | Date
+`acceptedAt` | Date
+`acceptedBy` | string
+
+## Example
+
+```typescript
+import type { InvitationViewResponse } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "invitationId": null,
+  "email": null,
+  "status": null,
+  "createdAt": null,
+  "expiresAt": null,
+  "acceptedAt": null,
+  "acceptedBy": null,
+} satisfies InvitationViewResponse
+
+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 InvitationViewResponse
+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/InviteMemberRequest.md

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

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

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

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

@@ -0,0 +1,38 @@
+
+# RolesRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`authorities` | Array<string>
+
+## Example
+
+```typescript
+import type { RolesRequest } from '@homespot-sdk/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "authorities": null,
+} satisfies RolesRequest
+
+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 RolesRequest
+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/SocialMediaRequest.md

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

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