spatialflow 0.1.0__py3-none-any.whl

spatialflow/_generated/spatialflow_generated/models/update_webhook_request.py

@@ -0,0 +1,186 @@
+# 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 UpdateWebhookRequest(BaseModel):
+    """
+    Schema for updating an existing webhook
+    """ # noqa: E501
+    name: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=255)]] = None
+    description: Optional[Annotated[str, Field(strict=True, max_length=500)]] = None
+    url: Optional[Annotated[str, Field(min_length=1, strict=True, max_length=2048)]] = None
+    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)]] = None
+    custom_payload_template: Optional[StrictStr] = None
+    is_active: Optional[StrictBool] = None
+    max_retries: Optional[Annotated[int, Field(le=10, strict=True, ge=0)]] = None
+    timeout_seconds: Optional[Annotated[int, Field(le=300, strict=True, ge=1)]] = None
+    rate_limit_per_minute: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]] = None
+    __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 UpdateWebhookRequest 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 name (nullable) is None
+        # and model_fields_set contains the field
+        if self.name is None and "name" in self.model_fields_set:
+            _dict['name'] = None
+
+        # 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 url (nullable) is None
+        # and model_fields_set contains the field
+        if self.url is None and "url" in self.model_fields_set:
+            _dict['url'] = None
+
+        # set to None if events (nullable) is None
+        # and model_fields_set contains the field
+        if self.events is None and "events" in self.model_fields_set:
+            _dict['events'] = 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_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.auth_type is None and "auth_type" in self.model_fields_set:
+            _dict['auth_type'] = 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 method (nullable) is None
+        # and model_fields_set contains the field
+        if self.method is None and "method" in self.model_fields_set:
+            _dict['method'] = None
+
+        # set to None if content_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.content_type is None and "content_type" in self.model_fields_set:
+            _dict['content_type'] = 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
+
+        # set to None if is_active (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_active is None and "is_active" in self.model_fields_set:
+            _dict['is_active'] = None
+
+        # set to None if max_retries (nullable) is None
+        # and model_fields_set contains the field
+        if self.max_retries is None and "max_retries" in self.model_fields_set:
+            _dict['max_retries'] = None
+
+        # set to None if timeout_seconds (nullable) is None
+        # and model_fields_set contains the field
+        if self.timeout_seconds is None and "timeout_seconds" in self.model_fields_set:
+            _dict['timeout_seconds'] = None
+
+        # set to None if rate_limit_per_minute (nullable) is None
+        # and model_fields_set contains the field
+        if self.rate_limit_per_minute is None and "rate_limit_per_minute" in self.model_fields_set:
+            _dict['rate_limit_per_minute'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UpdateWebhookRequest 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"),
+            "custom_payload_template": obj.get("custom_payload_template"),
+            "is_active": obj.get("is_active"),
+            "max_retries": obj.get("max_retries"),
+            "timeout_seconds": obj.get("timeout_seconds"),
+            "rate_limit_per_minute": obj.get("rate_limit_per_minute")
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/upload_geofences_request.py

@@ -0,0 +1,95 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UploadGeofencesRequest(BaseModel):
+    """
+    Schema for uploading geofences from a file
+    """ # noqa: E501
+    file_id: StrictStr = Field(description="ID of the uploaded file from storage service")
+    group_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = None
+    __properties: ClassVar[List[str]] = ["file_id", "group_name"]
+
+    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 UploadGeofencesRequest 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 group_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.group_name is None and "group_name" in self.model_fields_set:
+            _dict['group_name'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UploadGeofencesRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "group_name": obj.get("group_name")
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/upload_job_status.py

@@ -0,0 +1,137 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UploadJobStatus(BaseModel):
+    """
+    Schema for upload job status
+    """ # noqa: E501
+    job_id: StrictStr
+    status: StrictStr
+    file_name: StrictStr
+    file_format: StrictStr
+    created_at: datetime
+    started_at: Optional[datetime]
+    completed_at: Optional[datetime]
+    duration: Optional[Union[StrictFloat, StrictInt]] = None
+    total_features: StrictInt
+    created_count: StrictInt
+    failed_count: StrictInt
+    results: Optional[Dict[str, Any]] = None
+    error_message: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["job_id", "status", "file_name", "file_format", "created_at", "started_at", "completed_at", "duration", "total_features", "created_count", "failed_count", "results", "error_message"]
+
+    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 UploadJobStatus 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 started_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.started_at is None and "started_at" in self.model_fields_set:
+            _dict['started_at'] = None
+
+        # set to None if completed_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.completed_at is None and "completed_at" in self.model_fields_set:
+            _dict['completed_at'] = None
+
+        # set to None if duration (nullable) is None
+        # and model_fields_set contains the field
+        if self.duration is None and "duration" in self.model_fields_set:
+            _dict['duration'] = None
+
+        # set to None if results (nullable) is None
+        # and model_fields_set contains the field
+        if self.results is None and "results" in self.model_fields_set:
+            _dict['results'] = None
+
+        # set to None if error_message (nullable) is None
+        # and model_fields_set contains the field
+        if self.error_message is None and "error_message" in self.model_fields_set:
+            _dict['error_message'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UploadJobStatus from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job_id": obj.get("job_id"),
+            "status": obj.get("status"),
+            "file_name": obj.get("file_name"),
+            "file_format": obj.get("file_format"),
+            "created_at": obj.get("created_at"),
+            "started_at": obj.get("started_at"),
+            "completed_at": obj.get("completed_at"),
+            "duration": obj.get("duration"),
+            "total_features": obj.get("total_features"),
+            "created_count": obj.get("created_count"),
+            "failed_count": obj.get("failed_count"),
+            "results": obj.get("results"),
+            "error_message": obj.get("error_message")
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/usage_metrics.py

@@ -0,0 +1,93 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UsageMetrics(BaseModel):
+    """
+    Current usage metrics.
+    """ # noqa: E501
+    api_calls: Optional[StrictInt] = 0
+    geofences: Optional[StrictInt] = 0
+    webhooks_delivered: Optional[StrictInt] = 0
+    test_points: Optional[StrictInt] = 0
+    __properties: ClassVar[List[str]] = ["api_calls", "geofences", "webhooks_delivered", "test_points"]
+
+    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 UsageMetrics 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 UsageMetrics from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "api_calls": obj.get("api_calls") if obj.get("api_calls") is not None else 0,
+            "geofences": obj.get("geofences") if obj.get("geofences") is not None else 0,
+            "webhooks_delivered": obj.get("webhooks_delivered") if obj.get("webhooks_delivered") is not None else 0,
+            "test_points": obj.get("test_points") if obj.get("test_points") is not None else 0
+        })
+        return _obj
+
+

spatialflow/_generated/spatialflow_generated/models/usage_response.py

@@ -0,0 +1,105 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UsageResponse(BaseModel):
+    """
+    Response schema for workspace usage metrics.
+    """ # noqa: E501
+    location_events: StrictInt
+    action_deliveries: StrictInt
+    event_units: Union[StrictFloat, StrictInt]
+    tier: StrictStr
+    tier_limit: Optional[StrictInt]
+    period_start: datetime
+    period_end: datetime
+    __properties: ClassVar[List[str]] = ["location_events", "action_deliveries", "event_units", "tier", "tier_limit", "period_start", "period_end"]
+
+    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 UsageResponse 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 tier_limit (nullable) is None
+        # and model_fields_set contains the field
+        if self.tier_limit is None and "tier_limit" in self.model_fields_set:
+            _dict['tier_limit'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UsageResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "location_events": obj.get("location_events"),
+            "action_deliveries": obj.get("action_deliveries"),
+            "event_units": obj.get("event_units"),
+            "tier": obj.get("tier"),
+            "tier_limit": obj.get("tier_limit"),
+            "period_start": obj.get("period_start"),
+            "period_end": obj.get("period_end")
+        })
+        return _obj
+
+