@caraer/client 2.0.347

package/docs/CreateCompanyRequest.md

@@ -0,0 +1,29 @@
+# CreateCompanyRequest
+
+DTO representing a request to create a new company, including the company\'s name and subdomain.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The name of the company to be created. | [optional] [default to undefined]
+**subdomain** | **string** | The desired subdomain for the company. This will be used for company-specific URLs. | [optional] [default to undefined]
+**companyName** | **string** | The company name. | [optional] [default to undefined]
+**copyDatabaseId** | **string** | The copy database id. | [optional] [default to undefined]
+**includeRecords** | **boolean** | Whether to include records in the company. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCompanyRequest } from '@caraer/client';
+
+const instance: CreateCompanyRequest = {
+    name,
+    subdomain,
+    companyName,
+    copyDatabaseId,
+    includeRecords,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateOrUpdateEnvironmentRequest.md

@@ -0,0 +1,22 @@
+# CreateOrUpdateEnvironmentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**environment** | **string** |  | [optional] [default to undefined]
+**webpageObjects** | [**Array<CaraerObjectDTO>**](CaraerObjectDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateOrUpdateEnvironmentRequest } from '@caraer/client';
+
+const instance: CreateOrUpdateEnvironmentRequest = {
+    environment,
+    webpageObjects,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreatePrivateAppRequest.md

@@ -0,0 +1,27 @@
+# CreatePrivateAppRequest
+
+Private app creation request with label and optional description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** | The display label for the private app. | [default to undefined]
+**description** | **string** | Optional description text for the app. | [optional] [default to undefined]
+**authMethod** | **string** | Authentication method (API_KEY default, OAUTH2 for OAuth 2.0) | [optional] [default to undefined]
+**oauthRedirectUris** | **Array<string>** | Registered OAuth redirect URIs (required when authMethod is OAUTH2) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreatePrivateAppRequest } from '@caraer/client';
+
+const instance: CreatePrivateAppRequest = {
+    label,
+    description,
+    authMethod,
+    oauthRedirectUris,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateResponse.md

@@ -0,0 +1,23 @@
+# CreateResponse
+
+Response for a successful resource creation operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateResponse } from '@caraer/client';
+
+const instance: CreateResponse = {
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateResponseSignedUrlResultDTO.md

@@ -0,0 +1,23 @@
+# CreateResponseSignedUrlResultDTO
+
+Response for a successful resource creation operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | [**SignedUrlResultDTO**](SignedUrlResultDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateResponseSignedUrlResultDTO } from '@caraer/client';
+
+const instance: CreateResponseSignedUrlResultDTO = {
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateSignedUrlRequest.md

@@ -0,0 +1,20 @@
+# CreateSignedUrlRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ttlSeconds** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CreateSignedUrlRequest } from '@caraer/client';
+
+const instance: CreateSignedUrlRequest = {
+    ttlSeconds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Currency.md

@@ -0,0 +1,18 @@
+# Currency
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Currency } from '@caraer/client';
+
+const instance: Currency = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CurrencyRange.md

@@ -0,0 +1,18 @@
+# CurrencyRange
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { CurrencyRange } from '@caraer/client';
+
+const instance: CurrencyRange = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CursorLocation.md

@@ -0,0 +1,25 @@
+# CursorLocation
+
+Cursor location
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**x** | **number** |  | [optional] [default to undefined]
+**y** | **number** |  | [optional] [default to undefined]
+**z** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CursorLocation } from '@caraer/client';
+
+const instance: CursorLocation = {
+    x,
+    y,
+    z,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CustomFontDTO.md

@@ -0,0 +1,22 @@
+# CustomFontDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**familyName** | **string** |  | [optional] [default to undefined]
+**variants** | [**Array<FontVariantDTO>**](FontVariantDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomFontDTO } from '@caraer/client';
+
+const instance: CustomFontDTO = {
+    familyName,
+    variants,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Date.md

@@ -0,0 +1,18 @@
+# ModelDate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { ModelDate } from '@caraer/client';
+
+const instance: ModelDate = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeleteResponse.md

@@ -0,0 +1,23 @@
+# DeleteResponse
+
+Response class representing the result of a delete operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **any** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteResponse } from '@caraer/client';
+
+const instance: DeleteResponse = {
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeleteResponseString.md

@@ -0,0 +1,23 @@
+# DeleteResponseString
+
+Response class representing the result of a delete operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
+**data** | **string** | The data payload of the response, if any. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteResponseString } from '@caraer/client';
+
+const instance: DeleteResponseString = {
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DigitalIdentityDTO.md

@@ -0,0 +1,115 @@
+# DigitalIdentityDTO
+
+A DTO representing the digital identity of a company.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lightPrimaryColor** | **string** | The primary color of the company in light mode. | [optional] [default to undefined]
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name of the entity | [default to undefined]
+**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
+**lightFontColor** | **string** | The font color of the company in light mode. | [optional] [default to undefined]
+**lightSecondaryColor** | **string** | The secondary color of the company in light mode. | [optional] [default to undefined]
+**lightPrimary100Color** | **string** | The primary 100 color of the company in light mode. | [optional] [default to undefined]
+**lightAccentColor** | **string** | The accent color of the company in light mode. | [optional] [default to undefined]
+**lightBlackColor** | **string** | The black color of the company in light mode. | [optional] [default to undefined]
+**lightGray900Color** | **string** | The gray 900 color of the company in light mode. | [optional] [default to undefined]
+**lightGray800Color** | **string** | The gray 800 color of the company in light mode. | [optional] [default to undefined]
+**lightGray700Color** | **string** | The gray 700 color of the company in light mode. | [optional] [default to undefined]
+**lightGray600Color** | **string** | The gray 600 color of the company in light mode. | [optional] [default to undefined]
+**lightGray500Color** | **string** | The gray 500 color of the company in light mode. | [optional] [default to undefined]
+**lightGray400Color** | **string** | The gray 400 color of the company in light mode. | [optional] [default to undefined]
+**lightGray300Color** | **string** | The gray 300 color of the company in light mode. | [optional] [default to undefined]
+**lightGray200Color** | **string** | The gray 200 color of the company in light mode. | [optional] [default to undefined]
+**lightGray100Color** | **string** | The gray 100 color of the company in light mode. | [optional] [default to undefined]
+**lightGray50Color** | **string** | The gray 50 color of the company in light mode. | [optional] [default to undefined]
+**lightWhiteColor** | **string** | The white color of the company in light mode. | [optional] [default to undefined]
+**lightBackgroundColor** | **string** | The background color of the company in light mode. | [optional] [default to undefined]
+**lightDestructiveColor** | **string** | The destructive color of the company in light mode. | [optional] [default to undefined]
+**darkFontColor** | **string** | The font color of the company in dark mode. | [optional] [default to undefined]
+**darkPrimaryColor** | **string** | The primary color of the company in dark mode. | [optional] [default to undefined]
+**darkSecondaryColor** | **string** | The secondary color of the company in dark mode. | [optional] [default to undefined]
+**darkPrimary100Color** | **string** | The primary 100 color of the company in dark mode. | [optional] [default to undefined]
+**darkAccentColor** | **string** | The accent color of the company in dark mode. | [optional] [default to undefined]
+**darkBlackColor** | **string** | The black color of the company in dark mode. | [optional] [default to undefined]
+**darkGray900Color** | **string** | The gray 900 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray800Color** | **string** | The gray 800 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray700Color** | **string** | The gray 700 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray600Color** | **string** | The gray 600 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray500Color** | **string** | The gray 500 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray400Color** | **string** | The gray 400 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray300Color** | **string** | The gray 300 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray200Color** | **string** | The gray 200 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray100Color** | **string** | The gray 100 color of the company in dark mode. | [optional] [default to undefined]
+**darkGray50Color** | **string** | The gray 50 color of the company in dark mode. | [optional] [default to undefined]
+**darkWhiteColor** | **string** | The white color of the company in dark mode. | [optional] [default to undefined]
+**darkBackgroundColor** | **string** | The background color of the company in dark mode. | [optional] [default to undefined]
+**darkDestructiveColor** | **string** | The destructive color of the company in dark mode. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DigitalIdentityDTO } from '@caraer/client';
+
+const instance: DigitalIdentityDTO = {
+    lightPrimaryColor,
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    lightFontColor,
+    lightSecondaryColor,
+    lightPrimary100Color,
+    lightAccentColor,
+    lightBlackColor,
+    lightGray900Color,
+    lightGray800Color,
+    lightGray700Color,
+    lightGray600Color,
+    lightGray500Color,
+    lightGray400Color,
+    lightGray300Color,
+    lightGray200Color,
+    lightGray100Color,
+    lightGray50Color,
+    lightWhiteColor,
+    lightBackgroundColor,
+    lightDestructiveColor,
+    darkFontColor,
+    darkPrimaryColor,
+    darkSecondaryColor,
+    darkPrimary100Color,
+    darkAccentColor,
+    darkBlackColor,
+    darkGray900Color,
+    darkGray800Color,
+    darkGray700Color,
+    darkGray600Color,
+    darkGray500Color,
+    darkGray400Color,
+    darkGray300Color,
+    darkGray200Color,
+    darkGray100Color,
+    darkGray50Color,
+    darkWhiteColor,
+    darkBackgroundColor,
+    darkDestructiveColor,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Duration.md

@@ -0,0 +1,18 @@
+# Duration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Duration } from '@caraer/client';
+
+const instance: Duration = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Email.md

@@ -0,0 +1,18 @@
+# Email
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Email } from '@caraer/client';
+
+const instance: Email = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/EngagementBatchRequest.md

@@ -0,0 +1,24 @@
+# EngagementBatchRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitorId** | **string** |  | [optional] [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+**events** | [**Array<TrackingEventRequest>**](TrackingEventRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EngagementBatchRequest } from '@caraer/client';
+
+const instance: EngagementBatchRequest = {
+    visitorId,
+    sessionId,
+    events,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ErrorResponse.md

@@ -0,0 +1,31 @@
+# ErrorResponse
+
+Defines the structure of error responses returned by the API.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | The error message providing details about the failure. | [optional] [default to undefined]
+**errors** | [**CaraerErrorType**](CaraerErrorType.md) | A list of error types providing further details about the error. | [optional] [default to undefined]
+**status** | **number** | The HTTP status code associated with the error. | [optional] [default to undefined]
+**stackTrace** | **string** |  | [optional] [default to undefined]
+**roles** | **Array<string>** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorResponse } from '@caraer/client';
+
+const instance: ErrorResponse = {
+    message,
+    errors,
+    status,
+    stackTrace,
+    roles,
+    scopes,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FeedDTO.md

@@ -0,0 +1,66 @@
+# FeedDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name of the entity | [default to undefined]
+**label** | **string** | Display label for the entity, can be different from name | [optional] [default to undefined]
+**createdAt** | **number** | Unix timestamp when the entity was created | [optional] [default to undefined]
+**createdBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who created the entity | [optional] [default to undefined]
+**updatedAt** | **number** | Unix timestamp when the entity was last updated | [optional] [default to undefined]
+**updatedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who last updated the entity | [optional] [default to undefined]
+**deletedAt** | **number** | Unix timestamp when the entity was deleted (null if not deleted) | [optional] [default to undefined]
+**deletedBy** | [**ModelRecord**](ModelRecord.md) | Identifier of the user who deleted the entity | [optional] [default to undefined]
+**index** | **number** | Index number for ordering entities | [optional] [default to undefined]
+**slug** | **string** |  | [optional] [default to undefined]
+**format** | **string** |  | [optional] [default to undefined]
+**mainObject** | **string** |  | [optional] [default to undefined]
+**isPublic** | **boolean** |  | [optional] [default to undefined]
+**publicToken** | **string** |  | [optional] [default to undefined]
+**filter** | **any** |  | [optional] [default to undefined]
+**filterJson** | **string** |  | [optional] [default to undefined]
+**mapping** | **any** |  | [optional] [default to undefined]
+**mappingJson** | **string** |  | [optional] [default to undefined]
+**parseRecord** | **boolean** |  | [optional] [default to undefined]
+**rootElement** | **string** |  | [optional] [default to undefined]
+**itemElement** | **string** |  | [optional] [default to undefined]
+**cacheTtlSeconds** | **number** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FeedDTO } from '@caraer/client';
+
+const instance: FeedDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    slug,
+    format,
+    mainObject,
+    isPublic,
+    publicToken,
+    filter,
+    filterJson,
+    mapping,
+    mappingJson,
+    parseRecord,
+    rootElement,
+    itemElement,
+    cacheTtlSeconds,
+    active,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FeedsApi.md

@@ -0,0 +1,58 @@
+# FeedsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**index1**](#index1) | **POST** /api/v2/feeds/index | List feeds|
+
+# **index1**
+> any index1(body)
+
+
+### Example
+
+```typescript
+import {
+    FeedsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FeedsApi(configuration);
+
+let body: any; //
+
+const { status, data } = await apiInstance.index1(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**|  | |
+
+
+### Return type
+
+**any**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/File.md

@@ -0,0 +1,18 @@
+# ModelFile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { ModelFile } from '@caraer/client';
+
+const instance: ModelFile = {
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)