spatialflow 0.1.0__py3-none-any.whl

spatialflow/_generated/spatialflow_generated/models/create_user_schema.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateUserSchema(BaseModel):
+    """
+    CreateUserSchema
+    """ # noqa: E501
+    email: StrictStr
+    password: StrictStr
+    first_name: Optional[StrictStr] = 'Test'
+    last_name: Optional[StrictStr] = 'User'
+    email_verified: Optional[StrictBool] = True
+    is_staff: Optional[StrictBool] = False
+    is_superuser: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["email", "password", "first_name", "last_name", "email_verified", "is_staff", "is_superuser"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateUserSchema 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 CreateUserSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "email": obj.get("email"),
+            "password": obj.get("password"),
+            "first_name": obj.get("first_name") if obj.get("first_name") is not None else 'Test',
+            "last_name": obj.get("last_name") if obj.get("last_name") is not None else 'User',
+            "email_verified": obj.get("email_verified") if obj.get("email_verified") is not None else True,
+            "is_staff": obj.get("is_staff") if obj.get("is_staff") is not None else False,
+            "is_superuser": obj.get("is_superuser") if obj.get("is_superuser") is not None else False
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/create_webhook_request.py

@@ -0,0 +1,136 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from .auth_type_enum import AuthTypeEnum
+from .method_enum import MethodEnum
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateWebhookRequest(BaseModel):
+    """
+    Schema for creating a new webhook
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=1, strict=True, max_length=255)]
+    description: Optional[Annotated[str, Field(strict=True, max_length=500)]] = None
+    url: Annotated[str, Field(min_length=1, strict=True, max_length=2048)]
+    events: Optional[List[StrictStr]] = None
+    headers: Optional[Dict[str, StrictStr]] = None
+    auth_type: Optional[AuthTypeEnum] = None
+    auth_config: Optional[Dict[str, Any]] = None
+    method: Optional[MethodEnum] = None
+    content_type: Optional[Annotated[str, Field(strict=True, max_length=100)]] = 'application/json'
+    custom_payload_template: Optional[StrictStr] = None
+    is_active: Optional[StrictBool] = True
+    max_retries: Optional[Annotated[int, Field(le=10, strict=True, ge=0)]] = 3
+    timeout_seconds: Optional[Annotated[int, Field(le=300, strict=True, ge=1)]] = 30
+    rate_limit_per_minute: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = 60
+    __properties: ClassVar[List[str]] = ["name", "description", "url", "events", "headers", "auth_type", "auth_config", "method", "content_type", "custom_payload_template", "is_active", "max_retries", "timeout_seconds", "rate_limit_per_minute"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateWebhookRequest 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,
+        )
+        # set to None if description (nullable) is None
+        # and model_fields_set contains the field
+        if self.description is None and "description" in self.model_fields_set:
+            _dict['description'] = None
+
+        # set to None if headers (nullable) is None
+        # and model_fields_set contains the field
+        if self.headers is None and "headers" in self.model_fields_set:
+            _dict['headers'] = None
+
+        # set to None if auth_config (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_config is None and "auth_config" in self.model_fields_set:
+            _dict['auth_config'] = None
+
+        # set to None if custom_payload_template (nullable) is None
+        # and model_fields_set contains the field
+        if self.custom_payload_template is None and "custom_payload_template" in self.model_fields_set:
+            _dict['custom_payload_template'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateWebhookRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "url": obj.get("url"),
+            "events": obj.get("events"),
+            "headers": obj.get("headers"),
+            "auth_type": obj.get("auth_type"),
+            "auth_config": obj.get("auth_config"),
+            "method": obj.get("method"),
+            "content_type": obj.get("content_type") if obj.get("content_type") is not None else 'application/json',
+            "custom_payload_template": obj.get("custom_payload_template"),
+            "is_active": obj.get("is_active") if obj.get("is_active") is not None else True,
+            "max_retries": obj.get("max_retries") if obj.get("max_retries") is not None else 3,
+            "timeout_seconds": obj.get("timeout_seconds") if obj.get("timeout_seconds") is not None else 30,
+            "rate_limit_per_minute": obj.get("rate_limit_per_minute") if obj.get("rate_limit_per_minute") is not None else 60
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/dashboard_comparison_metrics.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DashboardComparisonMetrics(BaseModel):
+    """
+    Comparison metrics vs previous period.
+    """ # noqa: E501
+    events_change: StrictInt = Field(description="Absolute change in events vs previous period")
+    workflows_change: StrictInt = Field(description="Absolute change in active workflows vs previous period")
+    success_rate_change: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["events_change", "workflows_change", "success_rate_change"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DashboardComparisonMetrics 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,
+        )
+        # set to None if success_rate_change (nullable) is None
+        # and model_fields_set contains the field
+        if self.success_rate_change is None and "success_rate_change" in self.model_fields_set:
+            _dict['success_rate_change'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DashboardComparisonMetrics from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "events_change": obj.get("events_change"),
+            "workflows_change": obj.get("workflows_change"),
+            "success_rate_change": obj.get("success_rate_change")
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/dashboard_metrics_response.py

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from .action_delivery_success_metrics import ActionDeliverySuccessMetrics
+from .dashboard_comparison_metrics import DashboardComparisonMetrics
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DashboardMetricsResponse(BaseModel):
+    """
+    Dashboard metrics response schema.
+    """ # noqa: E501
+    time_range: StrictStr = Field(description="Time range: today, 7d, 30d, or custom")
+    period_start: datetime = Field(description="Start of the period")
+    period_end: datetime = Field(description="End of the period")
+    active_workflows: StrictInt = Field(description="Number of active workflows in period")
+    events_total: StrictInt = Field(description="Total geofence events (entry/exit) in period")
+    action_delivery_success: ActionDeliverySuccessMetrics = Field(description="Action delivery success metrics (north-star KPI)")
+    comparison: DashboardComparisonMetrics = Field(description="Comparison vs previous period")
+    __properties: ClassVar[List[str]] = ["time_range", "period_start", "period_end", "active_workflows", "events_total", "action_delivery_success", "comparison"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DashboardMetricsResponse 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 action_delivery_success
+        if self.action_delivery_success:
+            _dict['action_delivery_success'] = self.action_delivery_success.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of comparison
+        if self.comparison:
+            _dict['comparison'] = self.comparison.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DashboardMetricsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "time_range": obj.get("time_range"),
+            "period_start": obj.get("period_start"),
+            "period_end": obj.get("period_end"),
+            "active_workflows": obj.get("active_workflows"),
+            "events_total": obj.get("events_total"),
+            "action_delivery_success": ActionDeliverySuccessMetrics.from_dict(obj["action_delivery_success"]) if obj.get("action_delivery_success") is not None else None,
+            "comparison": DashboardComparisonMetrics.from_dict(obj["comparison"]) if obj.get("comparison") is not None else None
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/delete_file_response.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DeleteFileResponse(BaseModel):
+    """
+    DeleteFileResponse
+    """ # noqa: E501
+    message: StrictStr
+    key: StrictStr
+    __properties: ClassVar[List[str]] = ["message", "key"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeleteFileResponse 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 DeleteFileResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "message": obj.get("message"),
+            "key": obj.get("key")
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/delivery_status_enum.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class DeliveryStatusEnum(str, Enum):
+    """
+    Webhook delivery status
+    """
+
+    """
+    allowed enum values
+    """
+    PENDING = 'pending'
+    SUCCESS = 'success'
+    FAILED = 'failed'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DeliveryStatusEnum from a JSON string"""
+        return cls(json.loads(json_str))
+
+

spatialflow/_generated/spatialflow_generated/models/device_in.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    SpatialFlow API
+
+    Real-time geospatial automation platform API.  ## Authentication  **API Key:** Include `X-API-Key` header **JWT Token:** Include `Authorization: Bearer <token>` header  ## Rate Limits  - Per API Key: 200 rps sustained, 1,000 rps burst - Per Organization: 1,000 rps aggregate  ## Webhook Verification  Outbound webhooks include HMAC-SHA256 signatures in `X-SF-Signature` header.  ## Support  - Documentation: https://docs.spatialflow.io - GitHub: https://github.com/spatialflow/spatialflow - Email: support@spatialflow.io     
+
+    The version of the OpenAPI document: 1.0.0
+    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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DeviceIn(BaseModel):
+    """
+    DeviceIn
+    """ # noqa: E501
+    device_id: StrictStr
+    name: StrictStr
+    device_type: Optional[StrictStr] = 'mobile'
+    metadata: Optional[Dict[str, Any]] = None
+    __properties: ClassVar[List[str]] = ["device_id", "name", "device_type", "metadata"]
+
+    model_config = ConfigDict(
+        populate_by_name=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"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of DeviceIn 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,
+        )
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DeviceIn from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "device_id": obj.get("device_id"),
+            "name": obj.get("name"),
+            "device_type": obj.get("device_type") if obj.get("device_type") is not None else 'mobile',
+            "metadata": obj.get("metadata")
+        })
+        return _obj
+
+