@caraer/client 2.0.347

package/docs/GridItemDTO.md

@@ -0,0 +1,31 @@
+# GridItemDTO
+
+Represents a single cell within a form grid, which can contain a property, text, nested form, or other form elements
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | [**PropertyDTO**](PropertyDTO.md) | The property associated with this grid item, typically representing a form field or input | [optional] [default to undefined]
+**text** | **string** | Static text content to be displayed in this grid cell | [optional] [default to undefined]
+**form** | [**FormDTO**](FormDTO.md) | A nested form that can be embedded within this grid cell | [optional] [default to undefined]
+**submitButton** | **string** | The text of the submit button for this grid item | [optional] [default to undefined]
+**settings** | [**GridItemSettingsDTO**](GridItemSettingsDTO.md) | Configuration settings for this grid item, including display and validation rules | [optional] [default to undefined]
+**value** | **string** | The value of this grid item, used for form submissions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GridItemDTO } from '@caraer/client';
+
+const instance: GridItemDTO = {
+    property,
+    text,
+    form,
+    submitButton,
+    settings,
+    value,
+};
+```
+
+[[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/GridItemSettingsDTO.md

@@ -0,0 +1,49 @@
+# GridItemSettingsDTO
+
+Configuration settings for a grid item in a form, including property settings and form-related settings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**relation** | [**RelationDTO**](RelationDTO.md) | Defines the relationship between this form field and other entities or forms | [optional] [default to undefined]
+**record** | [**ModelRecord**](ModelRecord.md) | UUID of a record to be pre-filled in this form field | [optional] [default to undefined]
+**aiprompt** | **string** |  | [optional] [default to undefined]
+**label** | **string** | The display label for the form field | [optional] [default to undefined]
+**defaultValue** | **string** | The default value to be pre-filled in the form field | [optional] [default to undefined]
+**isRequired** | **boolean** | Indicates whether this field must be filled out before form submission | [optional] [default to undefined]
+**hidden** | **boolean** | Indicates whether this field should be hidden from view | [optional] [default to undefined]
+**placeholder** | **string** | The placeholder text for the form field | [optional] [default to undefined]
+**helpText** | **string** | The help text for the form field | [optional] [default to undefined]
+**AIPrompt** | **string** | The AI prompt for the form field. Only applicable to text fields. | [optional] [default to undefined]
+**styling** | **string** | The styling for the form field. Can be \'dropdown\', \'grid\' or \'boxes\' | [optional] [default to undefined]
+**stretch** | **boolean** | Whether the form field should be stretched to the full width of the form | [optional] [default to undefined]
+**align** | **string** | The alignment of the form field. Can be \'left\', \'center\' or \'right\' | [optional] [default to undefined]
+**rangeMin** | **number** | The minimum value for the slider field | [optional] [default to undefined]
+**rangeMax** | **number** | The maximum value for the slider field | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GridItemSettingsDTO } from '@caraer/client';
+
+const instance: GridItemSettingsDTO = {
+    relation,
+    record,
+    aiprompt,
+    label,
+    defaultValue,
+    isRequired,
+    hidden,
+    placeholder,
+    helpText,
+    AIPrompt,
+    styling,
+    stretch,
+    align,
+    rangeMin,
+    rangeMax,
+};
+```
+
+[[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/HasAppDTO.md

@@ -0,0 +1,37 @@
+# HasAppDTO
+
+Installation link between a company and an app (per-installation settings and token)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the installation relationship | [optional] [default to undefined]
+**token** | **string** | Installation token | [optional] [default to undefined]
+**scopes** | **Array<string>** | Scopes granted to this installation | [optional] [default to undefined]
+**settingsValues** | **string** | Per-installation app setting values (JSON object keyed by setting name) | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) | Per-object record filters for this installation (object name → filter) | [optional] [default to undefined]
+**appBarVisibility** | [**{ [key: string]: AppBarVisibilityEntry; }**](AppBarVisibilityEntry.md) | Per-app-bar placement config keyed by app bar UUID | [optional] [default to undefined]
+**oauthConnected** | **boolean** | Whether OAuth tokens have been issued for this installation | [optional] [default to undefined]
+**oauthAccessTokenExpiresAt** | **number** | OAuth access token expiry (epoch ms), if connected via OAuth | [optional] [default to undefined]
+**selectedPricingPlanUuid** | **string** | UUID of the pricing plan selected for this installation | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HasAppDTO } from '@caraer/client';
+
+const instance: HasAppDTO = {
+    uuid,
+    token,
+    scopes,
+    settingsValues,
+    filters,
+    appBarVisibility,
+    oauthConnected,
+    oauthAccessTokenExpiresAt,
+    selectedPricingPlanUuid,
+};
+```
+
+[[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/InstallAppRequest.md

@@ -0,0 +1,29 @@
+# InstallAppRequest
+
+Optional initial configuration settings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**settings** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | Optional initial configuration settings (key-value via AppSettingFieldSchema name/value). | [optional] [default to undefined]
+**scopes** | **Array<string>** | Optional scopes to grant to the app. | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) | Optional per-object record filters for this installation (object name → filter). | [optional] [default to undefined]
+**appBarVisibility** | [**{ [key: string]: AppBarVisibilityEntry; }**](AppBarVisibilityEntry.md) | Optional per-app-bar placement config keyed by app bar UUID. | [optional] [default to undefined]
+**selectedPricingPlanUuid** | **string** | UUID of the pricing plan selected for this installation. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InstallAppRequest } from '@caraer/client';
+
+const instance: InstallAppRequest = {
+    settings,
+    scopes,
+    filters,
+    appBarVisibility,
+    selectedPricingPlanUuid,
+};
+```
+
+[[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/Leadscore.md

@@ -0,0 +1,37 @@
+# Leadscore
+
+DTO representing a lead score rule
+
+## 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]
+**smart_value** | **boolean** | Whether the value is a smart value | [optional] [default to undefined]
+**score** | **number** | The score to assign if the rule is met | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Leadscore } from '@caraer/client';
+
+const instance: Leadscore = {
+    object,
+    relation,
+    property,
+    relationIncluded,
+    operator,
+    value,
+    smartContent,
+    smart_value,
+    score,
+};
+```
+
+[[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/LinkedProperty.md

@@ -0,0 +1,20 @@
+# LinkedProperty
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**linkedProperty** | [**PropertyDTO**](PropertyDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LinkedProperty } from '@caraer/client';
+
+const instance: LinkedProperty = {
+    linkedProperty,
+};
+```
+
+[[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/LoadAppSettingOptionsRequest.md

@@ -0,0 +1,27 @@
+# LoadAppSettingOptionsRequest
+
+Request to load dynamic options for a SINGLE_SELECT or MULTI_SELECT setting field.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fieldName** | **string** | Name of the setting field to load options for. | [default to undefined]
+**query** | **string** | Optional search query typed by the installer. | [optional] [default to undefined]
+**settingsSchema** | [**Array<AppSettingFieldSchema>**](AppSettingFieldSchema.md) | Current draft settings schema with values from the installer UI. | [default to undefined]
+**appBarUuid** | **string** | When loading options for an app bar field, the app bar UUID. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LoadAppSettingOptionsRequest } from '@caraer/client';
+
+const instance: LoadAppSettingOptionsRequest = {
+    fieldName,
+    query,
+    settingsSchema,
+    appBarUuid,
+};
+```
+
+[[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/LoginRequest.md

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

@@ -0,0 +1,50 @@
+# MappingDTO
+
+
+## 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]
+**sourceUrl** | **string** |  | [optional] [default to undefined]
+**syncRate** | **number** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**mappingItems** | [**Array<MappingItemDTO>**](MappingItemDTO.md) |  | [optional] [default to undefined]
+**object** | [**CaraerObjectDTO**](CaraerObjectDTO.md) |  | [optional] [default to undefined]
+**unpublishWhenNotInSource** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MappingDTO } from '@caraer/client';
+
+const instance: MappingDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    sourceUrl,
+    syncRate,
+    active,
+    mappingItems,
+    object,
+    unpublishWhenNotInSource,
+};
+```
+
+[[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/MappingItemDTO.md

@@ -0,0 +1,46 @@
+# MappingItemDTO
+
+
+## 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]
+**sourceField** | **string** |  | [optional] [default to undefined]
+**targetObject** | [**CaraerObjectDTO**](CaraerObjectDTO.md) |  | [optional] [default to undefined]
+**targetProperty** | [**PropertyDTO**](PropertyDTO.md) |  | [optional] [default to undefined]
+**conversionFunction** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MappingItemDTO } from '@caraer/client';
+
+const instance: MappingItemDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    sourceField,
+    targetObject,
+    targetProperty,
+    conversionFunction,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)