@caraer/client 2.0.347

package/docs/SyncApi.md

@@ -0,0 +1,344 @@
+# SyncApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSync**](#createsync) | **POST** /api/v2/sync/ | Create a sync|
+|[**deleteSync**](#deletesync) | **DELETE** /api/v2/sync/{uuid} | Delete a sync|
+|[**getSync**](#getsync) | **GET** /api/v2/sync/{uuid} | Get a sync|
+|[**getSyncs**](#getsyncs) | **POST** /api/v2/sync/index | Fetch paginated syncs|
+|[**restoreSync**](#restoresync) | **POST** /api/v2/sync/{uuid}/restore | Restore a deleted sync|
+|[**updateSync**](#updatesync) | **PUT** /api/v2/sync/{uuid} | Update a sync|
+
+# **createSync**
+> CreateResponse createSync(syncDTO)
+
+Creates a new sync. Returns a CreateResponse containing the created sync details.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration,
+    SyncDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let syncDTO: SyncDTO; //Sync data
+
+const { status, data } = await apiInstance.createSync(
+    syncDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **syncDTO** | **SyncDTO**| Sync data | |
+
+
+### 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 |
+|-------------|-------------|------------------|
+|**200** | Sync created successfully |  -  |
+|**400** | Invalid sync data |  -  |
+|**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)
+
+# **deleteSync**
+> DeleteResponse deleteSync(syncDTO)
+
+Deletes an existing sync. Returns a DeleteResponse containing the deleted sync details.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration,
+    SyncDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let uuid: string; // (default to undefined)
+let syncDTO: SyncDTO; //Sync data
+
+const { status, data } = await apiInstance.deleteSync(
+    uuid,
+    syncDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **syncDTO** | **SyncDTO**| Sync data | |
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sync deleted successfully |  -  |
+|**400** | Invalid sync data |  -  |
+|**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)
+
+# **getSync**
+> SyncDTO getSync(syncDTO)
+
+Retrieves a sync by its UUID. Returns a SyncDTO containing the sync details.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration,
+    SyncDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let uuid: string; // (default to undefined)
+let syncDTO: SyncDTO; //Sync data
+
+const { status, data } = await apiInstance.getSync(
+    uuid,
+    syncDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **syncDTO** | **SyncDTO**| Sync data | |
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SyncDTO**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sync fetched successfully |  -  |
+|**400** | Invalid sync data |  -  |
+|**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)
+
+# **getSyncs**
+> PaginationResponse getSyncs(body)
+
+Retrieves a paginated list of syncs. Returns a PaginationResponse containing SyncDTO objects based on the provided pagination criteria.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let body: any; //Pagination request for syncs
+
+const { status, data } = await apiInstance.getSyncs(
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**| Pagination request for syncs | |
+
+
+### Return type
+
+**PaginationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Syncs fetched successfully |  -  |
+|**400** | Invalid pagination request |  -  |
+|**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)
+
+# **restoreSync**
+> RestoreResponse restoreSync()
+
+Restores a previously deleted sync by its UUID. Returns a RestoreResponse containing the restored sync details.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let uuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.restoreSync(
+    uuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RestoreResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sync restored successfully |  -  |
+|**404** | Sync 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)
+
+# **updateSync**
+> UpdateResponse updateSync(syncDTO)
+
+Updates an existing sync. Returns a UpdateResponse containing the updated sync details.
+
+### Example
+
+```typescript
+import {
+    SyncApi,
+    Configuration,
+    SyncDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new SyncApi(configuration);
+
+let uuid: string; // (default to undefined)
+let syncDTO: SyncDTO; //Sync data
+
+const { status, data } = await apiInstance.updateSync(
+    uuid,
+    syncDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **syncDTO** | **SyncDTO**| Sync data | |
+| **uuid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**UpdateResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Sync updated successfully |  -  |
+|**400** | Invalid sync data |  -  |
+|**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/SyncDTO.md

@@ -0,0 +1,40 @@
+# SyncDTO
+
+
+## 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** |  | [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]
+**mappings** | [**Array<MappingDTO>**](MappingDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SyncDTO } from '@caraer/client';
+
+const instance: SyncDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    mappings,
+};
+```
+
+[[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/Tag.md

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

@@ -0,0 +1,52 @@
+# Team
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**createdAt** | **number** |  | [optional] [default to undefined]
+**updatedAt** | **number** |  | [optional] [default to undefined]
+**deletedAt** | **number** |  | [optional] [default to undefined]
+**createdByUuid** | **string** |  | [optional] [default to undefined]
+**updatedByUuid** | **string** |  | [optional] [default to undefined]
+**deletedByUuid** | **string** |  | [optional] [default to undefined]
+**index** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**filtersString** | **string** |  | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) |  | [optional] [default to undefined]
+**memberCount** | **number** |  | [optional] [default to undefined]
+**deleted** | **boolean** |  | [optional] [default to undefined]
+**complete** | **boolean** |  | [optional] [default to undefined]
+**uuid** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Team } from '@caraer/client';
+
+const instance: Team = {
+    name,
+    label,
+    createdAt,
+    updatedAt,
+    deletedAt,
+    createdByUuid,
+    updatedByUuid,
+    deletedByUuid,
+    index,
+    description,
+    scopes,
+    filtersString,
+    filters,
+    memberCount,
+    deleted,
+    complete,
+    uuid,
+};
+```
+
+[[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/TeamDTO.md

@@ -0,0 +1,48 @@
+# TeamDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**memberCount** | **number** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**members** | [**Array<UserRecordResponseDTO>**](UserRecordResponseDTO.md) |  | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) |  | [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]
+
+## Example
+
+```typescript
+import { TeamDTO } from '@caraer/client';
+
+const instance: TeamDTO = {
+    description,
+    memberCount,
+    scopes,
+    members,
+    filters,
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+};
+```
+
+[[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/TemplateWebpageDTO.md

@@ -0,0 +1,69 @@
+# TemplateWebpageDTO
+
+DTO for Template Webpage
+
+## 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]
+**environment** | **string** | The environment of the webpage. | [optional] [default to undefined]
+**title** | **string** | The title of the webpage. | [optional] [default to undefined]
+**excerpt** | **string** | Short summary or excerpt displayed for the webpage. | [optional] [default to undefined]
+**slug** | **string** | URL-friendly identifier for the webpage. | [optional] [default to undefined]
+**image** | **string** | URL or identifier of the image associated with the webpage. | [optional] [default to undefined]
+**customCss** | **string** | Custom CSS for the webpage. | [optional] [default to undefined]
+**customJsHead** | **string** | Custom JS for the webpage. | [optional] [default to undefined]
+**customJsBody** | **string** | Custom JS for the webpage. | [optional] [default to undefined]
+**content** | [**PageContentDTO**](PageContentDTO.md) | Content of the webpage | [optional] [default to undefined]
+**sidebar** | [**PreviewDTO**](PreviewDTO.md) | Preview of the sidebar | [optional] [default to undefined]
+**sidebarRelation** | [**RelationDTO**](RelationDTO.md) | Relation of the sidebar | [optional] [default to undefined]
+**sidebarObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Object of the sidebar | [optional] [default to undefined]
+**_options** | [**WebpageOptionsDTO**](WebpageOptionsDTO.md) | Custom options and configurations specific to the webpage. | [optional] [default to undefined]
+**metaData** | **{ [key: string]: any | null; }** | Map of additional metadata and attributes for the webpage. | [optional] [default to undefined]
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | Represents the associated Caraer object | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TemplateWebpageDTO } from '@caraer/client';
+
+const instance: TemplateWebpageDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    environment,
+    title,
+    excerpt,
+    slug,
+    image,
+    customCss,
+    customJsHead,
+    customJsBody,
+    content,
+    sidebar,
+    sidebarRelation,
+    sidebarObject,
+    _options,
+    metaData,
+    object,
+};
+```
+
+[[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/TestServerlessFunctionRequest.md

@@ -0,0 +1,25 @@
+# TestServerlessFunctionRequest
+
+Request body for testing a serverless function with a specific record and event type.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**recordUuid** | **string** | UUID of the record to base the event on. | [optional] [default to undefined]
+**eventType** | **string** | Event type to simulate (created, updated, deleted, etc.). | [optional] [default to undefined]
+**forceProvision** | **boolean** | If true, forces re-provisioning of the serverless function before invocation. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TestServerlessFunctionRequest } from '@caraer/client';
+
+const instance: TestServerlessFunctionRequest = {
+    recordUuid,
+    eventType,
+    forceProvision,
+};
+```
+
+[[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/TestWebhookRequest.md

@@ -0,0 +1,27 @@
+# TestWebhookRequest
+
+Webhook configuration and test parameters
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | [**SubscribeWebhookDTO**](SubscribeWebhookDTO.md) | Webhook configuration to test (not saved). | [default to undefined]
+**recordUuid** | **string** | UUID of the record to base the event on. Omit to auto-resolve from webhook topic. | [optional] [default to undefined]
+**eventType** | **string** | Event type to simulate (created, updated, deleted, etc.). | [optional] [default to undefined]
+**propertyName** | **string** | Property name when simulating property_changed. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TestWebhookRequest } from '@caraer/client';
+
+const instance: TestWebhookRequest = {
+    webhook,
+    recordUuid,
+    eventType,
+    propertyName,
+};
+```
+
+[[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/TrackingEventRequest.md

@@ -0,0 +1,72 @@
+# TrackingEventRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**visitorId** | **string** |  | [optional] [default to undefined]
+**sessionId** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**ts** | **number** |  | [optional] [default to undefined]
+**pageUrl** | **string** |  | [optional] [default to undefined]
+**pageTitle** | **string** |  | [optional] [default to undefined]
+**webpageUuid** | **string** |  | [optional] [default to undefined]
+**recordUuid** | **string** |  | [optional] [default to undefined]
+**formUuid** | **string** |  | [optional] [default to undefined]
+**formName** | **string** |  | [optional] [default to undefined]
+**utm** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+**referrer** | **string** |  | [optional] [default to undefined]
+**scrollPct** | **number** |  | [optional] [default to undefined]
+**timeOnPage** | **number** |  | [optional] [default to undefined]
+**activeTime** | **number** |  | [optional] [default to undefined]
+**ctaId** | **string** |  | [optional] [default to undefined]
+**ctaLabel** | **string** |  | [optional] [default to undefined]
+**stepIndex** | **number** |  | [optional] [default to undefined]
+**stepTitle** | **string** |  | [optional] [default to undefined]
+**progressPct** | **number** |  | [optional] [default to undefined]
+**completedFieldsCount** | **number** |  | [optional] [default to undefined]
+**consentChoice** | **string** |  | [optional] [default to undefined]
+**requestedRoute** | **string** |  | [optional] [default to undefined]
+**userAgent** | **string** |  | [optional] [default to undefined]
+**clientIp** | **string** |  | [optional] [default to undefined]
+**country** | **string** |  | [optional] [default to undefined]
+**region** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { TrackingEventRequest } from '@caraer/client';
+
+const instance: TrackingEventRequest = {
+    visitorId,
+    sessionId,
+    type,
+    ts,
+    pageUrl,
+    pageTitle,
+    webpageUuid,
+    recordUuid,
+    formUuid,
+    formName,
+    utm,
+    referrer,
+    scrollPct,
+    timeOnPage,
+    activeTime,
+    ctaId,
+    ctaLabel,
+    stepIndex,
+    stepTitle,
+    progressPct,
+    completedFieldsCount,
+    consentChoice,
+    requestedRoute,
+    userAgent,
+    clientIp,
+    country,
+    region,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)