Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ce/docs/AvailableEntityKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | **List[str]** | | |
| **attribute** | **List[str]** | | |
| **timeseries** | **List[str]** | List of unique time series key names available on the matched entities. | |
| **attribute** | **List[str]** | List of unique attribute key names available on the matched entities. | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/AvailableEntityKeysV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | | [optional] |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] |
| **attributes** | **Dict[str, List[KeyInfo]]** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] |


Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityDataDiff.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
#### WidgetsBundleExportData *(extends EntityExportData, entity_type=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List[object] | | [optional] |
| widgets | List[object] | List of widgets in the bundle | [optional] |
| fqns | List[str] | | [optional] |

#### WidgetTypeExportData *(extends EntityExportData, entity_type=`WIDGET_TYPE`)*
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/EntityExportData.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Base export container for ThingsBoard entities
#### WidgetsBundleExportData *(entity_type=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List[object] | | [optional] |
| widgets | List[object] | List of widgets in the bundle | [optional] |
| fqns | List[str] | | [optional] |

#### WidgetTypeExportData *(entity_type=`WIDGET_TYPE`)*
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/TbChatRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#### TbUserMessage
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| contents | List[TbContent] | | |
| contents | List[TbContent] | A list of content parts that make up the complete user prompt | |

#### AiModelConfig
| Name | Type | Description | Notes |
Expand Down
2 changes: 1 addition & 1 deletion ce/docs/TbUserMessage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **contents** | [**List[TbContent]**](TbContent.md) | | |
| **contents** | [**List[TbContent]**](TbContent.md) | A list of content parts that make up the complete user prompt | |



Expand Down
2 changes: 1 addition & 1 deletion ce/docs/WidgetsBundleExportData.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **widgets** | **List[object]** | | [optional] |
| **widgets** | **List[object]** | List of widgets in the bundle | [optional] |
| **fqns** | **List[str]** | | [optional] |


Expand Down
5 changes: 5 additions & 0 deletions ce/spec/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -84999,6 +84999,7 @@
},
"timeseries": {
"type": "array",
"description": "List of unique time series key names available on the matched entities.",
"items": {
"type": "string",
"example": "temperature",
Expand All @@ -85008,6 +85009,7 @@
},
"attribute": {
"type": "array",
"description": "List of unique attribute key names available on the matched entities.",
"items": {
"type": "string",
"example": "serialNumber",
Expand Down Expand Up @@ -85040,6 +85042,7 @@
},
"timeseries": {
"type": "array",
"description": "List of unique time series keys available on the matched entities, sorted alphabetically.\nOmitted when timeseries keys were not requested.",
"items": {
"$ref": "#/components/schemas/KeyInfo"
}
Expand Down Expand Up @@ -99552,6 +99555,7 @@
"properties": {
"contents": {
"type": "array",
"description": "A list of content parts that make up the complete user prompt",
"items": {
"$ref": "#/components/schemas/TbContent"
},
Expand Down Expand Up @@ -101714,6 +101718,7 @@
"properties": {
"widgets": {
"type": "array",
"description": "List of widgets in the bundle",
"items": {
"$ref": "#/components/schemas/JsonNode"
}
Expand Down
4 changes: 2 additions & 2 deletions ce/tb_ce_client/models/available_entity_keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ class AvailableEntityKeys(BaseModel):
Contains unique time series and attribute key names discovered from entities matching a query. Used primarily for UI hints such as autocomplete suggestions.
""" # noqa: E501
entity_types: List[EntityType] = Field(description="Set of entity types found among the matched entities.", serialization_alias="entityTypes")
timeseries: List[Annotated[str, Field(strict=True)]]
attribute: List[Annotated[str, Field(strict=True)]]
timeseries: List[Annotated[str, Field(strict=True)]] = Field(description="List of unique time series key names available on the matched entities.")
attribute: List[Annotated[str, Field(strict=True)]] = Field(description="List of unique attribute key names available on the matched entities.")
__properties: ClassVar[List[str]] = ["entityTypes", "timeseries", "attribute"]

model_config = ConfigDict(
Expand Down
2 changes: 1 addition & 1 deletion ce/tb_ce_client/models/available_entity_keys_v2.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class AvailableEntityKeysV2(BaseModel):
Contains unique time series and attribute key names discovered from entities matching a query, optionally including a sample value for each key.
""" # noqa: E501
entity_types: List[EntityType] = Field(description="Set of entity types found among the matched entities.", serialization_alias="entityTypes")
timeseries: Optional[List[KeyInfo]] = None
timeseries: Optional[List[KeyInfo]] = Field(default=None, description="List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested.")
attributes: Optional[Dict[str, List[KeyInfo]]] = Field(default=None, description="Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types.")
__properties: ClassVar[List[str]] = ["entityTypes", "timeseries", "attributes"]

Expand Down
2 changes: 1 addition & 1 deletion ce/tb_ce_client/models/tb_user_message.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class TbUserMessage(BaseModel):
"""
TbUserMessage
""" # noqa: E501
contents: Annotated[List[TbContent], Field(min_length=1)]
contents: Annotated[List[TbContent], Field(min_length=1)] = Field(description="A list of content parts that make up the complete user prompt")
__properties: ClassVar[List[str]] = ["contents"]

model_config = ConfigDict(
Expand Down
2 changes: 1 addition & 1 deletion ce/tb_ce_client/models/widgets_bundle_export_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class WidgetsBundleExportData(EntityExportData):
WidgetsBundleExportData
""" # noqa: E501
entity_type: EntityType = Field(default=EntityType.WIDGETS_BUNDLE, serialization_alias="entityType") # post_process: discriminator default
widgets: Optional[List[Any]] = None
widgets: Optional[List[Any]] = Field(default=None, description="List of widgets in the bundle")
fqns: Optional[List[StrictStr]] = None
__properties: ClassVar[List[str]] = ["entity", "relations", "attributes", "calculatedFields", "entityType", "widgets", "fqns"]

Expand Down
5 changes: 3 additions & 2 deletions paas/docs/AiChatControllerApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ object client.create_chat(body: object) # createChat
None client.delete_chat(chat_id: UUID) # deleteChat
object client.get_chat_messages(chat_id: UUID) # getChatMessages
object client.list_chats(chat_type: ChatType) # listChats
List[object] client.send_chat_message(chat_id: UUID, x_authorization: str, body: str) # sendChatMessage
List[object] client.send_chat_message(chat_id: UUID, x_authorization: str, body: str, accept_language: Optional[str] = None) # sendChatMessage
None client.update_chat(chat_id: UUID, body: object) # updateChat
```

Expand Down Expand Up @@ -103,7 +103,7 @@ listChats
## send_chat_message

```python
List[object] client.send_chat_message(chat_id: UUID, x_authorization: str, body: str)
List[object] client.send_chat_message(chat_id: UUID, x_authorization: str, body: str, accept_language: Optional[str] = None)
```

**POST** `/api/ai/chats/{chatId}/messages`
Expand All @@ -118,6 +118,7 @@ sendChatMessage
| **chat_id** | **UUID** | | |
| **x_authorization** | **str** | | |
| **body** | **str** | | |
| **accept_language** | **str** | | [optional] |

### Return type

Expand Down
32 changes: 32 additions & 0 deletions paas/docs/AiDeviceDashboardControllerApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AiDeviceDashboardControllerApi

`ThingsboardClient` methods:

```python
object client.generate_dashboard(device_id: UUID, x_authorization: str, body: object) # generateDashboard
```


## generate_dashboard

```python
object client.generate_dashboard(device_id: UUID, x_authorization: str, body: object)
```

**POST** `/api/ai/devices/{deviceId}/dashboard`

generateDashboard


### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **device_id** | **UUID** | | |
| **x_authorization** | **str** | | |
| **body** | **object** | | |

### Return type

**object**

4 changes: 2 additions & 2 deletions paas/docs/AvailableEntityKeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Contains unique time series and attribute key names discovered from entities mat
| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | **List[str]** | | |
| **attribute** | **List[str]** | | |
| **timeseries** | **List[str]** | List of unique time series key names available on the matched entities. | |
| **attribute** | **List[str]** | List of unique attribute key names available on the matched entities. | |



Expand Down
2 changes: 1 addition & 1 deletion paas/docs/AvailableEntityKeysV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Contains unique time series and attribute key names discovered from entities mat
|------------ | ------------- | ------------- | -------------|
| **total_entities** | **int** | Total number of entities that matched the query filter. | |
| **entity_types** | [**List[EntityType]**](EntityType.md) | Set of entity types found among the matched entities. | |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | | [optional] |
| **timeseries** | [**List[KeyInfo]**](KeyInfo.md) | List of unique time series keys available on the matched entities, sorted alphabetically. Omitted when timeseries keys were not requested. | [optional] |
| **attributes** | **Dict[str, List[KeyInfo]]** | Map of attribute scope to the list of unique attribute keys available on the matched entities. Only scopes supported by the matched entity types are included. Omitted when attribute keys were not requested or when none of the requested scopes apply to the matched entity types. | [optional] |


Expand Down
12 changes: 8 additions & 4 deletions paas/docs/EntityDataDiff.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@
#### EntityGroupExportData *(extends EntityExportData, entity_type=`ENTITY_GROUP`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| permissions | List[GroupPermission] | | [optional] |
| group_ota_packages | List[DeviceGroupOtaPackage] | | [optional] |
| group_entities | bool | | [optional] |
| permissions | List[GroupPermission] | Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group. | [optional] |
| group_ota_packages | List[DeviceGroupOtaPackage] | OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group. | [optional] |
| group_entities | bool | Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default). | [optional] |
| member_ids | List[UUID] | External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched. | [optional] |

#### EntityViewExportData *(extends EntityExportData, entity_type=`ENTITY_VIEW`)*
*See EntityExportData for properties.*
Expand Down Expand Up @@ -93,10 +94,13 @@
#### TbResourceExportData *(extends EntityExportData, entity_type=`TB_RESOURCE`)*
*See EntityExportData for properties.*

#### UserExportData *(extends EntityExportData, entity_type=`USER`)*
*See EntityExportData for properties.*

#### WidgetsBundleExportData *(extends EntityExportData, entity_type=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List[object] | | [optional] |
| widgets | List[object] | List of widgets in the bundle | [optional] |
| fqns | List[str] | | [optional] |

#### WidgetTypeExportData *(extends EntityExportData, entity_type=`WIDGET_TYPE`)*
Expand Down
12 changes: 8 additions & 4 deletions paas/docs/EntityExportData.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,10 @@ Base export container for ThingsBoard entities
#### EntityGroupExportData *(entity_type=`ENTITY_GROUP`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| permissions | List[GroupPermission] | | [optional] |
| group_ota_packages | List[DeviceGroupOtaPackage] | | [optional] |
| group_entities | bool | | [optional] |
| permissions | List[GroupPermission] | Group permissions to apply to this group on import. Meaningful only for USER groups; ignored for groups of any other type. Each entry's userGroupId, roleId, and entityGroupId may use the external IDs of other entities in this payload or the IDs of entities that already exist on the target tenant; the importer resolves them against the target tenant. System-tenant roles are not allowed and will be rejected. Leave null to skip permission management for this group. | [optional] |
| group_ota_packages | List[DeviceGroupOtaPackage] | OTA package assignments to apply to this group on import. Meaningful only for DEVICE groups; ignored for groups of any other type. Each entry's otaPackageId and groupId may reference external IDs of entities in this payload or IDs of entities that already exist on the target tenant. Leave null to skip OTA assignment management for this group. | [optional] |
| group_entities | bool | Marker indicating that the group's member entities are intended to be transported alongside this payload. Used by flows that convey members through a side channel (notably the version control flow, which stores members in a separate git index). The solution import API does not consume this flag and does not require it to be set. Safe to leave false (default). | [optional] |
| member_ids | List[UUID] | External IDs of the entities that should be members of this group after import. Each ID is resolved against the target tenant — by other entity in this payload, by external ID, or by existing internal ID — and the matching entities are added to the group. The import fails if any listed member cannot be resolved. Must be null for the special 'All' group (whose membership is implicit and managed by the platform). Leave null to skip membership wiring; existing membership on the target tenant is left untouched. | [optional] |

#### EntityViewExportData *(entity_type=`ENTITY_VIEW`)*
*(no additional properties)*
Expand Down Expand Up @@ -87,10 +88,13 @@ Base export container for ThingsBoard entities
#### TbResourceExportData *(entity_type=`TB_RESOURCE`)*
*(no additional properties)*

#### UserExportData *(entity_type=`USER`)*
*(no additional properties)*

#### WidgetsBundleExportData *(entity_type=`WIDGETS_BUNDLE`)*
| Name | Type | Description | Notes |
|------|------|-------------|-------|
| widgets | List[object] | | [optional] |
| widgets | List[object] | List of widgets in the bundle | [optional] |
| fqns | List[str] | | [optional] |

#### WidgetTypeExportData *(entity_type=`WIDGET_TYPE`)*
Expand Down
1 change: 1 addition & 0 deletions paas/docs/EntityExportSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| **export_calculated_fields** | **bool** | | [optional] |
| **export_permissions** | **bool** | | [optional] |
| **export_group_entities** | **bool** | | [optional] |
| **embed_group_members** | **bool** | | [optional] |



Expand Down
2 changes: 1 addition & 1 deletion paas/docs/EntityGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A JSON value representing the entity group.
| **created_time** | **int** | Timestamp of the entity group creation, in milliseconds | [optional] [readonly] |
| **type** | **TypeEnum** | | |
| **name** | **str** | Name of the entity group | |
| **owner_id** | [**EntityId**](EntityId.md) | JSON object with the owner of the group - Tenant or Customer Id. | [optional] |
| **owner_id** | [**EntityId**](EntityId.md) | JSON object with the owner of the group - Tenant or Customer Id. When omitted or null on creation, defaults to the current user's owner (Tenant for tenant admins, Customer for customer users). | [optional] |
| **additional_info** | **object** | Additional parameters of the entity group. May include: 'description' (string), 'isPublic' (boolean, whether this group is shared publicly), 'publicCustomerId' (string, UUID of the public customer associated with this group). | [optional] |
| **configuration** | **object** | JSON with the configuration for UI components: list of columns, settings, actions, etc | [optional] |
| **version** | **int** | | [optional] |
Expand Down
Loading
Loading