tbctl 0.2.0__py3-none-any.whl

tb_client/models/device_group_ota_package.py

@@ -0,0 +1,116 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.
+
+    The version of the OpenAPI document: 4.3.0.1PE
+    Contact: info@thingsboard.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from uuid import UUID
+from tb_client.models.entity_group_id import EntityGroupId
+from tb_client.models.ota_package_id import OtaPackageId
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class DeviceGroupOtaPackage(BaseModel):
+    """
+    DeviceGroupOtaPackage
+    """ # noqa: E501
+    id: Optional[UUID] = None
+    group_id: Optional[EntityGroupId] = Field(default=None, alias="groupId")
+    ota_package_type: Optional[StrictStr] = Field(default=None, alias="otaPackageType")
+    ota_package_id: Optional[OtaPackageId] = Field(default=None, alias="otaPackageId")
+    ota_package_update_time: Optional[StrictInt] = Field(default=None, alias="otaPackageUpdateTime")
+    __properties: ClassVar[List[str]] = ["id", "groupId", "otaPackageType", "otaPackageId", "otaPackageUpdateTime"]
+
+    @field_validator('ota_package_type')
+    def ota_package_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['FIRMWARE', 'SOFTWARE']):
+            raise ValueError("must be one of enum values ('FIRMWARE', 'SOFTWARE')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceGroupOtaPackage from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of group_id
+        if self.group_id:
+            _dict['groupId'] = self.group_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of ota_package_id
+        if self.ota_package_id:
+            _dict['otaPackageId'] = self.ota_package_id.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceGroupOtaPackage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "groupId": EntityGroupId.from_dict(obj["groupId"]) if obj.get("groupId") is not None else None,
+            "otaPackageType": obj.get("otaPackageType"),
+            "otaPackageId": OtaPackageId.from_dict(obj["otaPackageId"]) if obj.get("otaPackageId") is not None else None,
+            "otaPackageUpdateTime": obj.get("otaPackageUpdateTime")
+        })
+        return _obj
+
+

tb_client/models/device_id.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.
+
+    The version of the OpenAPI document: 4.3.0.1PE
+    Contact: info@thingsboard.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from uuid import UUID
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class DeviceId(BaseModel):
+    """
+    DeviceId
+    """ # noqa: E501
+    id: UUID = Field(description="ID of the entity, time-based UUID v1", json_schema_extra={"examples": ["784f394c-42b6-435a-983c-b7beff2784f9"]})
+    entity_type: StrictStr = Field(description="string", alias="entityType", json_schema_extra={"examples": ["DEVICE"]})
+    __properties: ClassVar[List[str]] = ["id", "entityType"]
+
+    @field_validator('entity_type')
+    def entity_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['DEVICE']):
+            raise ValueError("must be one of enum values ('DEVICE')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceId from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceId from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "entityType": obj.get("entityType")
+        })
+        return _obj
+
+

tb_client/models/device_info.py

@@ -0,0 +1,179 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.
+
+    The version of the OpenAPI document: 4.3.0.1PE
+    Contact: info@thingsboard.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from tb_client.models.customer_id import CustomerId
+from tb_client.models.device_data import DeviceData
+from tb_client.models.device_id import DeviceId
+from tb_client.models.device_profile_id import DeviceProfileId
+from tb_client.models.entity_id import EntityId
+from tb_client.models.entity_info import EntityInfo
+from tb_client.models.ota_package_id import OtaPackageId
+from tb_client.models.tenant_id import TenantId
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class DeviceInfo(BaseModel):
+    """
+    DeviceInfo
+    """ # noqa: E501
+    id: Optional[DeviceId] = Field(default=None, description="JSON object with the Device Id. Specify this field to update the Device. Referencing non-existing Device Id will cause error. Omit this field to create new Device.")
+    created_time: Optional[StrictInt] = Field(default=None, description="Timestamp of the device creation, in milliseconds", alias="createdTime", json_schema_extra={"examples": [1609459200000]})
+    tenant_id: Optional[TenantId] = Field(default=None, description="JSON object with Tenant Id. Use 'assignDeviceToTenant' to change the Tenant Id.", alias="tenantId")
+    customer_id: Optional[CustomerId] = Field(default=None, description="JSON object with Customer Id. Use 'assignDeviceToCustomer' to change the Customer Id.", alias="customerId")
+    name: Optional[StrictStr] = Field(default=None, description="Unique Device Name in scope of Tenant", json_schema_extra={"examples": ["A4B72CCDFF33"]})
+    type: Optional[StrictStr] = Field(default=None, description="Device Profile Name", json_schema_extra={"examples": ["Temperature Sensor"]})
+    label: Optional[StrictStr] = Field(default=None, description="Label that may be used in widgets", json_schema_extra={"examples": ["Room 234 Sensor"]})
+    device_profile_id: DeviceProfileId = Field(description="JSON object with Device Profile Id.", alias="deviceProfileId")
+    firmware_id: Optional[OtaPackageId] = Field(default=None, description="JSON object with Ota Package Id.", alias="firmwareId")
+    software_id: Optional[OtaPackageId] = Field(default=None, description="JSON object with Ota Package Id.", alias="softwareId")
+    version: Optional[StrictInt] = None
+    owner_name: Optional[StrictStr] = Field(default=None, description="Owner name", alias="ownerName")
+    groups: Optional[List[EntityInfo]] = Field(default=None, description="Groups")
+    active: Optional[StrictBool] = Field(default=None, description="Device active flag.")
+    device_data: Optional[DeviceData] = Field(default=None, description="JSON object with content specific to type of transport in the device profile.", alias="deviceData")
+    owner_id: Optional[EntityId] = Field(default=None, description="JSON object with Customer or Tenant Id", alias="ownerId")
+    additional_info: Optional[Any] = Field(default=None, description="Additional parameters of the device", alias="additionalInfo")
+    __properties: ClassVar[List[str]] = ["id", "createdTime", "tenantId", "customerId", "name", "type", "label", "deviceProfileId", "firmwareId", "softwareId", "version", "ownerName", "groups", "active", "deviceData", "ownerId", "additionalInfo"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "created_time",
+            "tenant_id",
+            "customer_id",
+            "owner_name",
+            "groups",
+            "active",
+            "owner_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of tenant_id
+        if self.tenant_id:
+            _dict['tenantId'] = self.tenant_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of customer_id
+        if self.customer_id:
+            _dict['customerId'] = self.customer_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of device_profile_id
+        if self.device_profile_id:
+            _dict['deviceProfileId'] = self.device_profile_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of firmware_id
+        if self.firmware_id:
+            _dict['firmwareId'] = self.firmware_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of software_id
+        if self.software_id:
+            _dict['softwareId'] = self.software_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in groups (list)
+        _items = []
+        if self.groups:
+            for _item_groups in self.groups:
+                if _item_groups:
+                    _items.append(_item_groups.to_dict())
+            _dict['groups'] = _items
+        # override the default output from pydantic by calling `to_dict()` of device_data
+        if self.device_data:
+            _dict['deviceData'] = self.device_data.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of owner_id
+        if self.owner_id:
+            _dict['ownerId'] = self.owner_id.to_dict()
+        # set to None if additional_info (nullable) is None
+        # and model_fields_set contains the field
+        if self.additional_info is None and "additional_info" in self.model_fields_set:
+            _dict['additionalInfo'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": DeviceId.from_dict(obj["id"]) if obj.get("id") is not None else None,
+            "createdTime": obj.get("createdTime"),
+            "tenantId": TenantId.from_dict(obj["tenantId"]) if obj.get("tenantId") is not None else None,
+            "customerId": CustomerId.from_dict(obj["customerId"]) if obj.get("customerId") is not None else None,
+            "name": obj.get("name"),
+            "type": obj.get("type"),
+            "label": obj.get("label"),
+            "deviceProfileId": DeviceProfileId.from_dict(obj["deviceProfileId"]) if obj.get("deviceProfileId") is not None else None,
+            "firmwareId": OtaPackageId.from_dict(obj["firmwareId"]) if obj.get("firmwareId") is not None else None,
+            "softwareId": OtaPackageId.from_dict(obj["softwareId"]) if obj.get("softwareId") is not None else None,
+            "version": obj.get("version"),
+            "ownerName": obj.get("ownerName"),
+            "groups": [EntityInfo.from_dict(_item) for _item in obj["groups"]] if obj.get("groups") is not None else None,
+            "active": obj.get("active"),
+            "deviceData": DeviceData.from_dict(obj["deviceData"]) if obj.get("deviceData") is not None else None,
+            "ownerId": EntityId.from_dict(obj["ownerId"]) if obj.get("ownerId") is not None else None,
+            "additionalInfo": obj.get("additionalInfo")
+        })
+        return _obj
+
+

tb_client/models/device_profile.py

@@ -0,0 +1,189 @@
+# coding: utf-8
+
+"""
+    ThingsBoard REST API
+
+     ThingsBoard Professional Edition IoT platform REST API documentation.
+
+    The version of the OpenAPI document: 4.3.0.1PE
+    Contact: info@thingsboard.io
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from tb_client.models.dashboard_id import DashboardId
+from tb_client.models.device_profile_data import DeviceProfileData
+from tb_client.models.device_profile_id import DeviceProfileId
+from tb_client.models.ota_package_id import OtaPackageId
+from tb_client.models.rule_chain_id import RuleChainId
+from tb_client.models.tenant_id import TenantId
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class DeviceProfile(BaseModel):
+    """
+    A JSON value representing the device profile.
+    """ # noqa: E501
+    id: Optional[DeviceProfileId] = Field(default=None, description="JSON object with the device profile Id. Specify this field to update the device profile. Referencing non-existing device profile Id will cause error. Omit this field to create new device profile.")
+    created_time: Optional[StrictInt] = Field(default=None, description="Timestamp of the profile creation, in milliseconds", alias="createdTime", json_schema_extra={"examples": [1609459200000]})
+    tenant_id: Optional[TenantId] = Field(default=None, description="JSON object with Tenant Id that owns the profile.", alias="tenantId")
+    name: Optional[StrictStr] = Field(default=None, description="Unique Device Profile Name in scope of Tenant.", json_schema_extra={"examples": ["Moisture Sensor"]})
+    description: Optional[StrictStr] = Field(default=None, description="Device Profile description. ")
+    image: Optional[StrictStr] = Field(default=None, description="Either URL or Base64 data of the icon. Used in the mobile application to visualize set of device profiles in the grid view. ")
+    type: Optional[StrictStr] = Field(default=None, description="Type of the profile. Always 'DEFAULT' for now. Reserved for future use.")
+    transport_type: Optional[StrictStr] = Field(default=None, description="Type of the transport used to connect the device. Default transport supports HTTP, CoAP and MQTT.", alias="transportType")
+    provision_type: Optional[StrictStr] = Field(default=None, description="Provisioning strategy.", alias="provisionType")
+    default_rule_chain_id: Optional[RuleChainId] = Field(default=None, description="Reference to the rule chain. If present, the specified rule chain will be used to process all messages related to device, including telemetry, attribute updates, etc. Otherwise, the root rule chain will be used to process those messages.", alias="defaultRuleChainId")
+    default_dashboard_id: Optional[DashboardId] = Field(default=None, description="Reference to the dashboard. Used in the mobile application to open the default dashboard when user navigates to device details.", alias="defaultDashboardId")
+    default_queue_name: Optional[StrictStr] = Field(default=None, description="Rule engine queue name. If present, the specified queue will be used to store all unprocessed messages related to device, including telemetry, attribute updates, etc. Otherwise, the 'Main' queue will be used to store those messages.", alias="defaultQueueName")
+    provision_device_key: Optional[StrictStr] = Field(default=None, description="Unique provisioning key used by 'Device Provisioning' feature.", alias="provisionDeviceKey")
+    firmware_id: Optional[OtaPackageId] = Field(default=None, description="Reference to the firmware OTA package. If present, the specified package will be used as default device firmware. ", alias="firmwareId")
+    software_id: Optional[OtaPackageId] = Field(default=None, description="Reference to the software OTA package. If present, the specified package will be used as default device software. ", alias="softwareId")
+    default_edge_rule_chain_id: Optional[RuleChainId] = Field(default=None, description="Reference to the edge rule chain. If present, the specified edge rule chain will be used on the edge to process all messages related to device, including telemetry, attribute updates, etc. Otherwise, the edge root rule chain will be used to process those messages.", alias="defaultEdgeRuleChainId")
+    version: Optional[StrictInt] = None
+    default: Optional[StrictBool] = Field(default=None, description="Used to mark the default profile. Default profile is used when the device profile is not specified during device creation.")
+    profile_data: Optional[DeviceProfileData] = Field(default=None, description="Complex JSON object that includes addition device profile configuration (transport, alarm rules, etc).", alias="profileData")
+    __properties: ClassVar[List[str]] = ["id", "createdTime", "tenantId", "name", "description", "image", "type", "transportType", "provisionType", "defaultRuleChainId", "defaultDashboardId", "defaultQueueName", "provisionDeviceKey", "firmwareId", "softwareId", "defaultEdgeRuleChainId", "version", "default", "profileData"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFAULT']):
+            raise ValueError("must be one of enum values ('DEFAULT')")
+        return value
+
+    @field_validator('transport_type')
+    def transport_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DEFAULT', 'MQTT', 'COAP', 'LWM2M', 'SNMP']):
+            raise ValueError("must be one of enum values ('DEFAULT', 'MQTT', 'COAP', 'LWM2M', 'SNMP')")
+        return value
+
+    @field_validator('provision_type')
+    def provision_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['DISABLED', 'ALLOW_CREATE_NEW_DEVICES', 'CHECK_PRE_PROVISIONED_DEVICES', 'X509_CERTIFICATE_CHAIN']):
+            raise ValueError("must be one of enum values ('DISABLED', 'ALLOW_CREATE_NEW_DEVICES', 'CHECK_PRE_PROVISIONED_DEVICES', 'X509_CERTIFICATE_CHAIN')")
+        return value
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceProfile from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set([
+            "created_time",
+            "tenant_id",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of id
+        if self.id:
+            _dict['id'] = self.id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of tenant_id
+        if self.tenant_id:
+            _dict['tenantId'] = self.tenant_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of default_rule_chain_id
+        if self.default_rule_chain_id:
+            _dict['defaultRuleChainId'] = self.default_rule_chain_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of default_dashboard_id
+        if self.default_dashboard_id:
+            _dict['defaultDashboardId'] = self.default_dashboard_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of firmware_id
+        if self.firmware_id:
+            _dict['firmwareId'] = self.firmware_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of software_id
+        if self.software_id:
+            _dict['softwareId'] = self.software_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of default_edge_rule_chain_id
+        if self.default_edge_rule_chain_id:
+            _dict['defaultEdgeRuleChainId'] = self.default_edge_rule_chain_id.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of profile_data
+        if self.profile_data:
+            _dict['profileData'] = self.profile_data.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceProfile from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": DeviceProfileId.from_dict(obj["id"]) if obj.get("id") is not None else None,
+            "createdTime": obj.get("createdTime"),
+            "tenantId": TenantId.from_dict(obj["tenantId"]) if obj.get("tenantId") is not None else None,
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "image": obj.get("image"),
+            "type": obj.get("type"),
+            "transportType": obj.get("transportType"),
+            "provisionType": obj.get("provisionType"),
+            "defaultRuleChainId": RuleChainId.from_dict(obj["defaultRuleChainId"]) if obj.get("defaultRuleChainId") is not None else None,
+            "defaultDashboardId": DashboardId.from_dict(obj["defaultDashboardId"]) if obj.get("defaultDashboardId") is not None else None,
+            "defaultQueueName": obj.get("defaultQueueName"),
+            "provisionDeviceKey": obj.get("provisionDeviceKey"),
+            "firmwareId": OtaPackageId.from_dict(obj["firmwareId"]) if obj.get("firmwareId") is not None else None,
+            "softwareId": OtaPackageId.from_dict(obj["softwareId"]) if obj.get("softwareId") is not None else None,
+            "defaultEdgeRuleChainId": RuleChainId.from_dict(obj["defaultEdgeRuleChainId"]) if obj.get("defaultEdgeRuleChainId") is not None else None,
+            "version": obj.get("version"),
+            "default": obj.get("default"),
+            "profileData": DeviceProfileData.from_dict(obj["profileData"]) if obj.get("profileData") is not None else None
+        })
+        return _obj
+
+