@caraer/client 2.0.347

package/docs/TrackingSessionUpsertRequest.md

@@ -0,0 +1,22 @@
+# TrackingSessionUpsertRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitorId** | **string** |  | [optional] [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TrackingSessionUpsertRequest } from '@caraer/client';
+
+const instance: TrackingSessionUpsertRequest = {
+    visitorId,
+    sessionId,
+};
+```
+
+[[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/TraitsApi.md

@@ -0,0 +1,236 @@
+# TraitsApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createTrait**](#createtrait) | **POST** /api/v2/traits/{objectUuid}/{traitName} | Create or update a trait for an object|
+|[**deleteTrait**](#deletetrait) | **DELETE** /api/v2/traits/{objectUuid}/{traitName} | Delete a trait from an object|
+|[**getTrait**](#gettrait) | **GET** /api/v2/traits/{objectUuid}/{traitName} | Fetch a specific trait for an object|
+|[**getTraits**](#gettraits) | **GET** /api/v2/traits/{objectUuid} | Fetch all traits for an object|
+
+# **createTrait**
+> CreateResponse createTrait(body)
+
+Creates a new trait or updates an existing trait for the specified object. The trait name is provided in the URL, and trait details are supplied in the request body as a JSON map. If a trait with the specified name exists, it will be updated; otherwise, a new trait is created. Returns a CreateResponse containing the TraitDTO of the created or updated trait.
+
+### Example
+
+```typescript
+import {
+    TraitsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new TraitsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let traitName: string; // (default to undefined)
+let body: string; //Trait details as a JSON map
+
+const { status, data } = await apiInstance.createTrait(
+    objectUuid,
+    traitName,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **string**| Trait details as a JSON map | |
+| **objectUuid** | [**string**] |  | defaults to undefined|
+| **traitName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**CreateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Trait created successfully |  -  |
+|**400** | Invalid input data |  -  |
+|**404** | Trait type not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **deleteTrait**
+> DeleteResponse deleteTrait()
+
+Removes a trait identified by its name from the specified object. Returns a DeleteResponse confirming that the trait has been removed.
+
+### Example
+
+```typescript
+import {
+    TraitsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new TraitsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let traitName: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteTrait(
+    objectUuid,
+    traitName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectUuid** | [**string**] |  | defaults to undefined|
+| **traitName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Trait removed successfully |  -  |
+|**404** | Trait not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **getTrait**
+> ShowResponse getTrait()
+
+Retrieves details of a specific trait associated with the specified object, identified by the trait name. Returns a ShowResponse containing the TraitDTO. If the trait is not found, a NotFoundError is thrown.
+
+### Example
+
+```typescript
+import {
+    TraitsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new TraitsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let traitName: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getTrait(
+    objectUuid,
+    traitName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectUuid** | [**string**] |  | defaults to undefined|
+| **traitName** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ShowResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Trait retrieved successfully |  -  |
+|**404** | Trait not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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)
+
+# **getTraits**
+> PaginationResponse getTraits()
+
+Retrieves a list of traits associated with the specified object. Returns a paginated response containing TraitDTO objects. The page is set to 0 by default, with a maximum limit of 100.
+
+### Example
+
+```typescript
+import {
+    TraitsApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new TraitsApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getTraits(
+    objectUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Traits retrieved successfully |  -  |
+|**404** | Object or traits not found |  -  |
+|**500** | Internal server error |  -  |
+
+[[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/Tuple2LongLong.md

@@ -0,0 +1,22 @@
+# Tuple2LongLong
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**t1** | **number** |  | [optional] [default to undefined]
+**t2** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Tuple2LongLong } from '@caraer/client';
+
+const instance: Tuple2LongLong = {
+    t1,
+    t2,
+};
+```
+
+[[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/UpdateLifecyclePropertiesDTO.md

@@ -0,0 +1,21 @@
+# UpdateLifecyclePropertiesDTO
+
+Request body for enabling lifecycle tracking on object properties
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**propertyUuids** | **Array<string>** | UUIDs of properties to track in lifecycle history | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateLifecyclePropertiesDTO } from '@caraer/client';
+
+const instance: UpdateLifecyclePropertiesDTO = {
+    propertyUuids,
+};
+```
+
+[[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/UpdateResponse.md

@@ -0,0 +1,23 @@
+# UpdateResponse
+
+Represents the response returned after a successful update 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 { UpdateResponse } from '@caraer/client';
+
+const instance: UpdateResponse = {
+    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/Url.md

@@ -0,0 +1,18 @@
+# Url
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Url } from '@caraer/client';
+
+const instance: Url = {
+};
+```
+
+[[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/UsedInResult.md

@@ -0,0 +1,22 @@
+# UsedInResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recordUuids** | **Array<string>** |  | [optional] [default to undefined]
+**count** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UsedInResult } from '@caraer/client';
+
+const instance: UsedInResult = {
+    recordUuids,
+    count,
+};
+```
+
+[[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/UserRecordResponseDTO.md

@@ -0,0 +1,47 @@
+# UserRecordResponseDTO
+
+Record response for user API endpoints, including linked user data.
+
+## 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]
+**deleted** | **boolean** | Whether the record is soft-deleted. | [optional] [default to undefined]
+**properties** | [**Array<FilledProperty>**](FilledProperty.md) | Record properties for display. | [optional] [default to undefined]
+**objects** | **{ [key: string]: any | null; }** | Primary and morph object metadata for this record. | [optional] [default to undefined]
+**user** | [**PublicUserDTO**](PublicUserDTO.md) | The user linked to this record when the user trait is enabled. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserRecordResponseDTO } from '@caraer/client';
+
+const instance: UserRecordResponseDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    deleted,
+    properties,
+    objects,
+    user,
+};
+```
+
+[[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/UserWithCursorLocationDTO.md

@@ -0,0 +1,33 @@
+# UserWithCursorLocationDTO
+
+User with cursor location
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**email** | **string** |  | [optional] [default to undefined]
+**firstname** | **string** |  | [optional] [default to undefined]
+**lastname** | **string** |  | [optional] [default to undefined]
+**cursorLocation** | [**CursorLocation**](CursorLocation.md) |  | [optional] [default to undefined]
+**reference** | **string** |  | [optional] [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UserWithCursorLocationDTO } from '@caraer/client';
+
+const instance: UserWithCursorLocationDTO = {
+    uuid,
+    email,
+    firstname,
+    lastname,
+    cursorLocation,
+    reference,
+    sessionId,
+};
+```
+
+[[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/ValidationError.md

@@ -0,0 +1,36 @@
+# ValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cause** | [**NotFoundErrorCause**](NotFoundErrorCause.md) |  | [optional] [default to undefined]
+**stackTrace** | [**Array<NotFoundErrorCauseStackTraceInner>**](NotFoundErrorCauseStackTraceInner.md) |  | [optional] [default to undefined]
+**suppressed** | [**Array<NotFoundErrorCause>**](NotFoundErrorCause.md) |  | [optional] [default to undefined]
+**localizedMessage** | **string** |  | [optional] [default to undefined]
+**type** | **string** | The type of error. | [default to undefined]
+**field** | **string** |  | [optional] [default to undefined]
+**message** | **string** | The error message providing details about the failure. | [default to undefined]
+**correctionSuggestion** | **string** | A suggestion on how to correct the error. | [default to undefined]
+**_class** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ValidationError } from '@caraer/client';
+
+const instance: ValidationError = {
+    cause,
+    stackTrace,
+    suppressed,
+    localizedMessage,
+    type,
+    field,
+    message,
+    correctionSuggestion,
+    _class,
+};
+```
+
+[[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/ViewDTO.md

@@ -0,0 +1,72 @@
+# ViewDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** |  | [optional] [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]
+**favorite** | **boolean** |  | [optional] [default to undefined]
+**team** | **boolean** |  | [optional] [default to undefined]
+**shared** | **boolean** |  | [optional] [default to undefined]
+**personal** | **boolean** |  | [optional] [default to undefined]
+**trait** | **string** |  | [optional] [default to undefined]
+**filters** | [**Filter**](Filter.md) |  | [optional] [default to undefined]
+**shows** | [**Array<ShowItem>**](ShowItem.md) |  | [optional] [default to undefined]
+**sorts** | [**Array<SortItem>**](SortItem.md) |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**showIcons** | **boolean** |  | [optional] [default to undefined]
+**rowHeight** | **string** |  | [optional] [default to undefined]
+**query** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**flowProperty** | **string** |  | [optional] [default to undefined]
+**flowPreview** | **string** |  | [optional] [default to undefined]
+**defaultView** | **boolean** |  | [optional] [default to undefined]
+**isInternallyPublic** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ViewDTO } from '@caraer/client';
+
+const instance: ViewDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    favorite,
+    team,
+    shared,
+    personal,
+    trait,
+    filters,
+    shows,
+    sorts,
+    limit,
+    showIcons,
+    rowHeight,
+    query,
+    icon,
+    flowProperty,
+    flowPreview,
+    defaultView,
+    isInternallyPublic,
+};
+```
+
+[[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/ViewShareRequest.md

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