@caraer/client 2.0.347

package/docs/PropertyDTO.md

@@ -0,0 +1,77 @@
+# PropertyDTO
+
+Data transfer object representing a property with its configuration and metadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** | Unique identifier for the entity | [default to undefined]
+**name** | **string** | The name identifier of the property | [optional] [default to undefined]
+**label** | **string** | Display label for the property | [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]
+**description** | **string** | Detailed description of the property\'s purpose and usage | [optional] [default to undefined]
+**type** | **string** | The data type of the property (e.g., \'string\', \'number\', \'date\', etc.) | [optional] [default to undefined]
+**_options** | [**Array<PropertyOption>**](PropertyOption.md) | List of predefined options for properties that support selection | [optional] [default to undefined]
+**group** | **string** | Group name for organizing related properties | [optional] [default to undefined]
+**format** | [**PropertyDTOFormat**](PropertyDTOFormat.md) |  | [optional] [default to undefined]
+**rules** | **Array<string>** | Collection of validation rules applied to the property | [optional] [default to undefined]
+**immutable** | **boolean** | Indicates if the property value cannot be modified after initial creation | [optional] [default to undefined]
+**hidden** | **boolean** | Indicates if the property should be hidden from view | [optional] [default to undefined]
+**lifecycleActive** | **boolean** | When true, property value changes are tracked as lifecycle records | [optional] [default to undefined]
+**nonPublic** | **boolean** | Indicates if the property should be excluded from public APIs | [optional] [default to undefined]
+**indexed** | **boolean** | Indicates if the property should be indexed for searching | [optional] [default to undefined]
+**editable** | **boolean** | Indicates if the property value can be modified | [optional] [default to undefined]
+**formatSettings** | **{ [key: string]: any | null; }** | Additional format-specific settings for the property | [optional] [default to undefined]
+**usedIn** | [**UsedInResult**](UsedInResult.md) | Information about where this property is used in the system | [optional] [default to undefined]
+**icon** | **string** | Icon identifier for visual representation of the property | [optional] [default to undefined]
+**webpagePublic** | **boolean** | Indicates if the property can be used in webpages | [optional] [default to undefined]
+**embeddable** | **boolean** | Indicates if the property can be embedded in other properties | [optional] [default to undefined]
+**minAndMaxValue** | [**Tuple2LongLong**](Tuple2LongLong.md) | The minimum and maximum value of the property | [optional] [default to undefined]
+**pinned** | **boolean** | Indicates if the property is pinned by the logged-in user | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PropertyDTO } from '@caraer/client';
+
+const instance: PropertyDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    description,
+    type,
+    _options,
+    group,
+    format,
+    rules,
+    immutable,
+    hidden,
+    lifecycleActive,
+    nonPublic,
+    indexed,
+    editable,
+    formatSettings,
+    usedIn,
+    icon,
+    webpagePublic,
+    embeddable,
+    minAndMaxValue,
+    pinned,
+};
+```
+
+[[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/PropertyDTOFormat.md

@@ -0,0 +1,35 @@
+# PropertyDTOFormat
+
+Format configuration for the property\'s display and validation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**settings** | [**Array<SettingField>**](SettingField.md) |  | [optional] [default to undefined]
+**filters** | **Array<string>** |  | [optional] [default to undefined]
+**rules** | **Array<string>** |  | [optional] [default to undefined]
+**linkedProperty** | [**PropertyDTO**](PropertyDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PropertyDTOFormat } from '@caraer/client';
+
+const instance: PropertyDTOFormat = {
+    label,
+    name,
+    icon,
+    type,
+    settings,
+    filters,
+    rules,
+    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/PropertyFormat.md

@@ -0,0 +1,32 @@
+# PropertyFormat
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**settings** | [**Array<SettingField>**](SettingField.md) |  | [optional] [default to undefined]
+**filters** | **Array<string>** |  | [optional] [default to undefined]
+**rules** | **Array<string>** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PropertyFormat } from '@caraer/client';
+
+const instance: PropertyFormat = {
+    label,
+    name,
+    icon,
+    type,
+    settings,
+    filters,
+    rules,
+};
+```
+
+[[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/PropertyOption.md

@@ -0,0 +1,30 @@
+# PropertyOption
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**icon** | **string** |  | [optional] [default to undefined]
+**color** | **string** |  | [optional] [default to undefined]
+**disabled** | **boolean** |  | [optional] [default to undefined]
+**usedIn** | [**UsedInResult**](UsedInResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PropertyOption } from '@caraer/client';
+
+const instance: PropertyOption = {
+    name,
+    label,
+    icon,
+    color,
+    disabled,
+    usedIn,
+};
+```
+
+[[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/PublicUserDTO.md

@@ -0,0 +1,36 @@
+# PublicUserDTO
+
+
+## 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]
+**initials** | **string** |  | [optional] [default to undefined]
+**scopes** | **Array<string>** |  | [optional] [default to undefined]
+**filters** | [**{ [key: string]: Filter; }**](Filter.md) |  | [optional] [default to undefined]
+**role** | **string** |  | [optional] [default to undefined]
+**record** | [**ModelRecord**](ModelRecord.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PublicUserDTO } from '@caraer/client';
+
+const instance: PublicUserDTO = {
+    uuid,
+    email,
+    firstname,
+    lastname,
+    initials,
+    scopes,
+    filters,
+    role,
+    record,
+};
+```
+
+[[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/Record.md

@@ -0,0 +1,48 @@
+# ModelRecord
+
+
+## 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]
+**deleted** | **boolean** |  | [optional] [default to undefined]
+**complete** | **boolean** |  | [optional] [default to undefined]
+**uuid** | **string** |  | [default to undefined]
+**properties** | [**Array<FilledProperty>**](FilledProperty.md) |  | [optional] [default to undefined]
+**objects** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+**user** | [**PublicUserDTO**](PublicUserDTO.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ModelRecord } from '@caraer/client';
+
+const instance: ModelRecord = {
+    name,
+    label,
+    createdAt,
+    updatedAt,
+    deletedAt,
+    createdByUuid,
+    updatedByUuid,
+    deletedByUuid,
+    index,
+    deleted,
+    complete,
+    uuid,
+    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/RecordDTO.md

@@ -0,0 +1,45 @@
+# RecordDTO
+
+Data Transfer Object for representing a record with dynamic properties.
+
+## 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]
+**properties** | **{ [key: string]: any | null; }** | A map of property names to their corresponding values for this record. | [optional] [default to undefined]
+**user** | [**PublicUserDTO**](PublicUserDTO.md) | The user of the record if the user trait is enabled. | [optional] [default to undefined]
+**relations** | [**Array<RecordRelationRequestDTO>**](RecordRelationRequestDTO.md) | Relations to create or merge after the record is saved. Each item links to an existing record (uuid) or creates a nested record first. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RecordDTO } from '@caraer/client';
+
+const instance: RecordDTO = {
+    uuid,
+    name,
+    label,
+    createdAt,
+    createdBy,
+    updatedAt,
+    updatedBy,
+    deletedAt,
+    deletedBy,
+    index,
+    properties,
+    user,
+    relations,
+};
+```
+
+[[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/RecordRelationRequestDTO.md

@@ -0,0 +1,33 @@
+# RecordRelationRequestDTO
+
+Relation to create when saving a record
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**relationName** | **string** | Name of the relation type | [default to undefined]
+**uuid** | **string** | UUID of an existing record to link to | [optional] [default to undefined]
+**properties** | **{ [key: string]: any | null; }** | Properties to update on the existing record referenced by uuid before linking | [optional] [default to undefined]
+**record** | [**RecordDTO**](RecordDTO.md) | Nested record to create before linking, or update first when record.uuid is provided | [optional] [default to undefined]
+**objectName** | **string** | Object name for nested record create when relation allows multiple target types | [optional] [default to undefined]
+**primary** | **boolean** | When true, marks this relation edge as primary | [optional] [default to undefined]
+**merge** | **boolean** | When true, MERGE relation edge instead of CREATE | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RecordRelationRequestDTO } from '@caraer/client';
+
+const instance: RecordRelationRequestDTO = {
+    relationName,
+    uuid,
+    properties,
+    record,
+    objectName,
+    primary,
+    merge,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)