@caraer/client 2.0.347

package/docs/FileManagementApi.md

@@ -0,0 +1,228 @@
+# FileManagementApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteFile**](#deletefile) | **DELETE** /api/v2/files/ | Delete file|
+|[**downloadFile**](#downloadfile) | **GET** /api/v2/files/ | Download file|
+|[**listFiles**](#listfiles) | **GET** /api/v2/files/list | List files|
+|[**uploadFile2**](#uploadfile2) | **POST** /api/v2/files/ | Upload files|
+
+# **deleteFile**
+> SuccessResponse deleteFile()
+
+Deletes a file from the S3-compatible storage identified by its unique key.
+
+### Example
+
+```typescript
+import {
+    FileManagementApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FileManagementApi(configuration);
+
+let key: string; //The key of the file to delete. (default to undefined)
+
+const { status, data } = await apiInstance.deleteFile(
+    key
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | The key of the file to delete. | defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File deleted successfully. |  -  |
+|**404** | File 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)
+
+# **downloadFile**
+> SuccessResponse downloadFile()
+
+Generates a pre-signed URL to download a file stored in S3-compatible storage. The URL expiry time and download behavior can be specified using the query parameters.
+
+### Example
+
+```typescript
+import {
+    FileManagementApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FileManagementApi(configuration);
+
+let key: string; //The key of the file to download. (default to undefined)
+let expireAfter: number; //The URL expiry period in seconds. (optional) (default to 86400)
+let download: boolean; //Whether to download the file in the browser. (optional) (default to false)
+
+const { status, data } = await apiInstance.downloadFile(
+    key,
+    expireAfter,
+    download
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **key** | [**string**] | The key of the file to download. | defaults to undefined|
+| **expireAfter** | [**number**] | The URL expiry period in seconds. | (optional) defaults to 86400|
+| **download** | [**boolean**] | Whether to download the file in the browser. | (optional) defaults to false|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | File URL generated successfully. |  -  |
+|**404** | File 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)
+
+# **listFiles**
+> SuccessResponse listFiles()
+
+Lists all files stored in the system or, if a record UUID is provided, lists the files related to that record.
+
+### Example
+
+```typescript
+import {
+    FileManagementApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FileManagementApi(configuration);
+
+let recordUuid: string; //An optional record UUID to filter files. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.listFiles(
+    recordUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **recordUuid** | [**string**] | An optional record UUID to filter files. | (optional) defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Files listed successfully. |  -  |
+|**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)
+
+# **uploadFile2**
+> SuccessResponse uploadFile2()
+
+Uploads multiple files to an S3-compatible storage and returns their unique keys. The request must contain one or more files in multipart/form-data format.
+
+### Example
+
+```typescript
+import {
+    FileManagementApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FileManagementApi(configuration);
+
+let recordUuid: string; //Optional record UUID to directly link uploaded files as attachments. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.uploadFile2(
+    recordUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **recordUuid** | [**string**] | Optional record UUID to directly link uploaded files as attachments. | (optional) defaults to undefined|
+
+
+### Return type
+
+**SuccessResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Files uploaded successfully. |  -  |
+|**400** | Invalid input, e.g., file size exceeds the limit. |  -  |
+|**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/FilledProperty.md

@@ -0,0 +1,28 @@
+# FilledProperty
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**icon** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilledProperty } from '@caraer/client';
+
+const instance: FilledProperty = {
+    icon,
+    name,
+    value,
+    type,
+    label,
+};
+```
+
+[[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/Filter.md

@@ -0,0 +1,21 @@
+# Filter
+
+DTO representing a filter composed of filter groups for querying records. The filter groups are combined using a logical OR operation. The filter items within each group are combined using a logical AND operation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groups** | [**Set<FilterGroup>**](FilterGroup.md) | A collection of filter groups. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Filter } from '@caraer/client';
+
+const instance: Filter = {
+    groups,
+};
+```
+
+[[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/FilterApi.md

@@ -0,0 +1,286 @@
+# FilterApi
+
+All URIs are relative to *https://v2.api.caraer.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createFilter**](#createfilter) | **POST** /api/v2/filters | Create a new saved filter|
+|[**deleteFilter**](#deletefilter) | **DELETE** /api/v2/filters/{filterUuid} | Delete a saved filter|
+|[**getFilter**](#getfilter) | **GET** /api/v2/filters/{filterUuid} | Fetch a specific saved filter|
+|[**getFilters**](#getfilters) | **POST** /api/v2/filters/index/{objectUuid} | Fetch paginated saved filters|
+|[**updateFilter**](#updatefilter) | **PUT** /api/v2/filters/{filterUuid} | Update an existing saved filter|
+
+# **createFilter**
+> CreateResponse createFilter(savedFilterDTO)
+
+Creates a new saved filter with the provided configuration.
+
+### Example
+
+```typescript
+import {
+    FilterApi,
+    Configuration,
+    SavedFilterDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FilterApi(configuration);
+
+let savedFilterDTO: SavedFilterDTO; //Saved filter details for creation
+
+const { status, data } = await apiInstance.createFilter(
+    savedFilterDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **savedFilterDTO** | **SavedFilterDTO**| Saved filter details for creation | |
+
+
+### 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** | Filter created successfully |  -  |
+|**400** | Invalid input 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)
+
+# **deleteFilter**
+> DeleteResponse deleteFilter()
+
+Soft deletes a saved filter identified by its UUID.
+
+### Example
+
+```typescript
+import {
+    FilterApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FilterApi(configuration);
+
+let filterUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deleteFilter(
+    filterUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **filterUuid** | [**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** | Filter deleted successfully |  -  |
+|**404** | Filter 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)
+
+# **getFilter**
+> ShowResponse getFilter()
+
+Retrieves details of a saved filter by its UUID.
+
+### Example
+
+```typescript
+import {
+    FilterApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FilterApi(configuration);
+
+let filterUuid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getFilter(
+    filterUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **filterUuid** | [**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** | Filter retrieved successfully |  -  |
+|**404** | Filter 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)
+
+# **getFilters**
+> PaginationResponse getFilters(body)
+
+Fetches a paginated list of saved filters. The request body should contain pagination details such as limit, page, filters, and sort.
+
+### Example
+
+```typescript
+import {
+    FilterApi,
+    Configuration
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FilterApi(configuration);
+
+let objectUuid: string; // (default to undefined)
+let body: any; //Pagination request details
+
+const { status, data } = await apiInstance.getFilters(
+    objectUuid,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **any**| Pagination request details | |
+| **objectUuid** | [**string**] |  | defaults to undefined|
+
+
+### 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** | Filters fetched successfully |  -  |
+|**400** | Bad 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)
+
+# **updateFilter**
+> UpdateResponse updateFilter(savedFilterDTO)
+
+Updates an existing saved filter identified by its UUID.
+
+### Example
+
+```typescript
+import {
+    FilterApi,
+    Configuration,
+    SavedFilterDTO
+} from '@caraer/client';
+
+const configuration = new Configuration();
+const apiInstance = new FilterApi(configuration);
+
+let filterUuid: string; // (default to undefined)
+let savedFilterDTO: SavedFilterDTO; //Updated saved filter details
+
+const { status, data } = await apiInstance.updateFilter(
+    filterUuid,
+    savedFilterDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **savedFilterDTO** | **SavedFilterDTO**| Updated saved filter details | |
+| **filterUuid** | [**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** | Filter updated successfully |  -  |
+|**400** | Invalid input data |  -  |
+|**404** | Filter 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/FilterGroup.md

@@ -0,0 +1,21 @@
+# FilterGroup
+
+A DTO that defines a group of filter items used for record filtering.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**FilterItem**](FilterItem.md) | A set of filter items included in the group. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilterGroup } from '@caraer/client';
+
+const instance: FilterGroup = {
+    items,
+};
+```
+
+[[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/FilterItem.md

@@ -0,0 +1,33 @@
+# FilterItem
+
+DTO representing a filter used in querying records.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **string** | The name of the object to which this pagination item belongs. | [optional] [default to undefined]
+**relation** | **string** | The relationship between objects. | [optional] [default to undefined]
+**property** | **string** | The name of the property within the object. | [optional] [default to undefined]
+**relationIncluded** | **boolean** | Specifies whether the relation is included. | [optional] [default to undefined]
+**operator** | **string** | Defines the operator used in the filter. Available operators are defined in the API documentation. | [optional] [default to undefined]
+**value** | **any** |  | [optional] [default to undefined]
+**smartContent** | **boolean** | When true, filter fields contain smart content placeholders resolved at runtime. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FilterItem } from '@caraer/client';
+
+const instance: FilterItem = {
+    object,
+    relation,
+    property,
+    relationIncluded,
+    operator,
+    value,
+    smartContent,
+};
+```
+
+[[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/FontVariantDTO.md

@@ -0,0 +1,24 @@
+# FontVariantDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weight** | **number** |  | [optional] [default to undefined]
+**style** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FontVariantDTO } from '@caraer/client';
+
+const instance: FontVariantDTO = {
+    weight,
+    style,
+    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/FormDTO.md

@@ -0,0 +1,59 @@
+# FormDTO
+
+Data transfer object representing a form with its associated properties and structure
+
+## 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]
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The associated Caraer object that this form belongs to | [optional] [default to undefined]
+**grids** | [**Array<FormItemDTO>**](FormItemDTO.md) | List of form items that make up the form\'s structure. Each grid represents a section or group of form elements | [optional] [default to undefined]
+**description** | **string** | Descriptive text providing additional information about the form | [optional] [default to undefined]
+**styling** | **string** | The styling of the form. Can be \'standard\', \'underline\' or \'plain\' | [optional] [default to undefined]
+**leadscores** | [**Array<Leadscore>**](Leadscore.md) | List of lead scoring rules associated with this form. Used to evaluate and score form submissions | [optional] [default to undefined]
+**relations** | [**Array<FormRelationDTO>**](FormRelationDTO.md) | List of form relations that define the relationships between this form conversion record and other records in the system | [optional] [default to undefined]
+**wizard** | **boolean** | Indicates if the form should be displayed as a step-by-step wizard interface | [optional] [default to undefined]
+**metadata** | **{ [key: string]: string; }** | Metadata associated with the form | [optional] [default to undefined]
+**thankYouMessage** | **string** | Thank you message to be displayed after the form is submitted | [optional] [default to undefined]
+**redirectUrl** | **string** | Redirect URL to be displayed after the form is submitted | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FormDTO } from '@caraer/client';
+
+const instance: FormDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    object,
+    grids,
+    description,
+    styling,
+    leadscores,
+    relations,
+    wizard,
+    metadata,
+    thankYouMessage,
+    redirectUrl,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)