@caraer/client 2.0.347

package/docs/FormItemDTO.md

@@ -0,0 +1,31 @@
+# FormItemDTO
+
+Represents a section or group within a form, containing a grid of form elements
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**aiprompt** | **string** |  | [optional] [default to undefined]
+**title** | **string** | The title or heading of this form section | [optional] [default to undefined]
+**description** | **string** | Additional descriptive text explaining the purpose or instructions for this section | [optional] [default to undefined]
+**type** | **string** | The type of form section (e.g., \'grid\', \'section\', etc.) | [optional] [default to undefined]
+**AIPrompt** | **string** | The AI prompt for the form section. Only applicable to steps. | [optional] [default to undefined]
+**grid** | **Array<Array<GridItemDTO>>** | A two-dimensional array representing the layout of form elements. Each inner list represents a row of elements | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FormItemDTO } from '@caraer/client';
+
+const instance: FormItemDTO = {
+    aiprompt,
+    title,
+    description,
+    type,
+    AIPrompt,
+    grid,
+};
+```
+
+[[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/FormRelationDTO.md

@@ -0,0 +1,31 @@
+# FormRelationDTO
+
+Data transfer object representing a form relation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of the form relation. The options are: CONVERSION_PAGE_RECORD, RELATED_RECORD_TO_CONVERSION_PAGE_RECORD, STATIC | [optional] [default to undefined]
+**relation** | [**RelationDTO**](RelationDTO.md) | The relation to be created. | [optional] [default to undefined]
+**relatedRelation** | [**RelationDTO**](RelationDTO.md) | The related relation associated with conversion page record | [optional] [default to undefined]
+**relatedObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) | The related object associated with conversion page record or for static | [optional] [default to undefined]
+**recordUuid** | **string** | UUID of the record for the static connection. | [optional] [default to undefined]
+**relatedObjectConnection** | **string** | The connection type for the related object. The options are: PRIMARY, ALL | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FormRelationDTO } from '@caraer/client';
+
+const instance: FormRelationDTO = {
+    type,
+    relation,
+    relatedRelation,
+    relatedObject,
+    recordUuid,
+    relatedObjectConnection,
+};
+```
+
+[[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/FormWithAiPromptDTO.md

@@ -0,0 +1,61 @@
+# FormWithAiPromptDTO
+
+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]
+**aiPrompt** | **string** | AI prompt to be used for the form | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FormWithAiPromptDTO } from '@caraer/client';
+
+const instance: FormWithAiPromptDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    object,
+    grids,
+    description,
+    styling,
+    leadscores,
+    relations,
+    wizard,
+    metadata,
+    thankYouMessage,
+    redirectUrl,
+    aiPrompt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)