pygeobox 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

pygeobox/attachment.py

@@ -1,298 +1,298 @@
-from typing import List, Dict, Optional, TYPE_CHECKING, Union
-from urllib.parse import urljoin
-
-from .base import Base
-from .utils import clean_data
-from .enums import AttachmentResourceType
-from .map import Map
-from .vectorlayer import VectorLayer
-from .view import VectorLayerView
-from .file import File
-
-if TYPE_CHECKING:
-    from . import GeoboxClient 
-    from .feature import Feature
-
-class Attachment(Base):
-
-    BASE_ENDPOINT = 'attachments/'
-
-    def __init__(self, 
-                 api: 'GeoboxClient', 
-                 attachment_id: str,
-                 data: Optional[Dict] = {}):
-        """
-        Initialize an Attachment instance.
-
-        Args:
-            api (GeoboxClient): The GeoboxClient instance for making requests.
-            attachment_id (str): The id for the attachment.
-            data (Dict, optional): The data of the attachment.
-        """
-        super().__init__(api, data=data)
-        self.attachment_id = attachment_id
-        self.endpoint = urljoin(self.BASE_ENDPOINT, str(self.attachment_id))
-
-
-    def __repr__(self) -> str:
-        """
-        Return a string representation of the attachment.
-
-        Returns:
-            str: The string representation of the attachment.
-        """
-        return f"Attachment(name={self.name}, id={self.attachment_id})"
-
-
-    @property
-    def file(self) -> 'File':
-        """
-        Attachment file property
-
-        Returns:
-            File: the file object
-        """
-        return File(self.api, self.data['file'].get('uuid'), self.data['file'])
-
-
-    @classmethod
-    def get_attachments(cls, api: 'GeoboxClient', resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
-        """
-        Get list of attachments with optional filtering and pagination.
-
-        Args:
-            api (GeoboxClient): The GeoboxClient instance for making requests.
-            resource_type (AttachmentResourceType): The resource type of the attachment. options are: Map, Vector, View
-            resource_uuid (str): The Resoource uuid of the attachment.
-
-        Keyword Args:
-            element_id (str): the id of the element with attachment.
-            search (str): search term for keyword-based searching among all textual fields.
-            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
-            skip (int): Number of items to skip. default is 0.
-            limit (int): Number of items to return. default is 10.
-            return_count (bool): Whether to return total count. default is False.
-
-        Returns:
-            List[Attachment] | int: A list of attachments instances or the total number of attachments.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> attachments = Attachment.get_attachments(client, q="name LIKE '%My attachment%'")
-            or
-            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
-        """
-        params = {
-           'resource_type': resource_type.value,
-           'resource_uuid': resource_uuid,
-           'element_id': kwargs.get('element_id'),
-           'search': kwargs.get('search'),
-           'order_by': kwargs.get('order_by'),
-           'skip': kwargs.get('skip', 0),
-           'limit': kwargs.get('limit', 10),
-           'return_count': kwargs.get('return_count')
-        }
-        return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Attachment(api, item['id'], item))
-    
-
-    @classmethod
-    def create_attachment(cls, 
-                     api: 'GeoboxClient', 
-                     name: str, 
-                     loc_x: int,
-                     loc_y: int,
-                     resource: Union['Map', 'VectorLayer', 'VectorLayerView'],
-                     file: 'File',
-                     feature: 'Feature' = None,
-                     display_name: str = None, 
-                     description: str = None, ) -> 'Attachment':
-        """
-        Create a new Attachment.
-
-        Args:
-            api (GeoboxClient): The GeoboxClient instance for making requests.
-            name (str): The name of the scene.
-            loc_x (int): x parameter of the attachment location.
-            loc_y (int): y parameter of the attachment location.
-            resource (Map | VectorLayer | VectorLayerView): the resource object.
-            file (File): the file object.
-            feature (Feature, optional): the feature object.
-            display_name (str, optional): The display name of the scene.
-            description (str, optional): The description of the scene.
-
-        Returns:
-            Attachment: The newly created Attachment instance.
-
-        Raises:
-            ValidationError: If the Attachment data is invalid.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
-            >>> feature = layer.get_feature(feature_id=1)
-            >>> file = client.get_file(uuid="12345678-1234-5678-1234-567812345678")
-            >>> attachment = Attachment.create_attachment(client, 
-            ...                                             name="my_attachment", 
-            ...                                             loc_x=30, 
-            ...                                             loc_y=50, 
-            ...                                             resource=layer, 
-            ...                                             file=file, 
-            ...                                             feature=feature, 
-            ...                                             display_name="My Attachment", 
-            ...                                             description="Attachment Description")
-            or
-            >>> attachment = client.create_attachment(name="my_attachment", 
-            ...                                             loc_x=30, 
-            ...                                             loc_y=50, 
-            ...                                             resource=layer, 
-            ...                                             file=file, 
-            ...                                             feature=feature, 
-            ...                                             display_name="My Attachment", 
-            ...                                             description="Attachment Description")
-        """
-        if isinstance(resource, VectorLayer):
-            resource_type = AttachmentResourceType.Vector.value
-
-        if isinstance(resource, VectorLayerView):
-            resource_type = AttachmentResourceType.View.value
-
-        if isinstance(resource, Map):
-            resource_type = AttachmentResourceType.Map.value
-
-        data = {
-            "name": name,
-            "display_name": display_name,
-            "description": description,
-            "loc_x": loc_x,
-            "loc_y": loc_y,
-            "resource_type": resource_type,
-            "resource_uuid": resource.uuid,
-            "element_id": feature.id,
-            "file_id": file.id
-            }
-        return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Attachment(api, item['id'], item))
-
-
-    @classmethod
-    def update_attachment(cls, api: 'GeoboxClient', attachment_id: int, **kwargs) -> Dict:
-        """
-        Update the attachment.
-
-        Args:
-            api (GeoboxClient): The GeoboxClient instance for making requests.
-            attachment_id (int): the attachment id.
-
-        Keyword Args:
-            name (str): The name of the attachment.
-            display_name (str): The display name of the attachment.
-            description (str): The description of the attachment.
-            loc_x (int): x parameter of the attachment location.
-            loc_y (int): y parameter of the attachment location.
-
-        Returns:
-            Dict: The updated attachment data.
-
-        Raises:
-            ValidationError: If the attachment data is invalid.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> Attachment.update_attachment(client, attachment_id=1, display_name="New Display Name")
-            or
-            >>> client.update_attachment(attachment_id=1, display_name="New Display Name")
-        """
-        data = clean_data({
-            "name": kwargs.get('name'),
-            "display_name": kwargs.get('display_name'),   
-            "description": kwargs.get('description'),
-            "loc_x": kwargs.get('loc_x'),
-            "loc_y": kwargs.get('loc_y')
-        })
-        endpoint = urljoin(cls.BASE_ENDPOINT, str(attachment_id))
-        response = api.put(endpoint, data)
-        return response
-    
-
-    def update(self, **kwargs) -> Dict:
-        """
-        Update the attachment.
-
-        Keyword Args:
-            name (str): The name of the attachment.
-            display_name (str): The display name of the attachment.
-            description (str): The description of the attachment.
-            loc_x (int): x parameter of the attachment location.
-            loc_y (int): y parameter of the attachment location.
-
-        Returns:
-            Dict: The updated attachment data.
-
-        Raises:
-            ValidationError: If the attachment data is invalid.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> attachment = Attachment.get_attachments(client)[0]
-            >>> attachment.update(display_name="New Display Name")
-        """
-        data = clean_data({
-            "name": kwargs.get('name'),
-            "display_name": kwargs.get('display_name'),   
-            "description": kwargs.get('description'),
-            "loc_x": kwargs.get('loc_x'),
-            "loc_y": kwargs.get('loc_y')
-        })
-        response = self.api.put(self.endpoint, data)
-        self._update_properties(response)
-        return response
-    
-
-    def delete(self) -> None:
-        """
-        Delete the scene.
-
-        Returns:
-            None
-
-        Raises:
-            ApiRequestError: If the API request fails.
-            ValidationError: If the scene data is invalid.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> attachment = Attachment.get_attachments(client)[0]
-            >>> attachment.delete()
-        """
-        super().delete(self.endpoint)
-        self.attachment_id = None
-
-
-    @property
-    def thumbnail(self) -> str:
-        """
-        Get the thumbnail URL of the attachment.
-
-        Returns:
-            str: The thumbnail of the scene.
-
-        Example:
-            >>> from geobox import GeoboxClient
-            >>> from geobox.attachment import Attachment
-            >>> client = GeoboxClient()
-            >>> attachment = Attachment.get_attachment(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> attachment.thumbnail
-            'https://example.com/thumbnail.png'
-        """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail"
-        return endpoint
+from typing import List, Dict, Optional, TYPE_CHECKING, Union
+from urllib.parse import urljoin
+
+from .base import Base
+from .utils import clean_data
+from .enums import AttachmentResourceType
+from .map import Map
+from .vectorlayer import VectorLayer
+from .view import VectorLayerView
+from .file import File
+
+if TYPE_CHECKING:
+    from . import GeoboxClient 
+    from .feature import Feature
+
+class Attachment(Base):
+
+    BASE_ENDPOINT = 'attachments/'
+
+    def __init__(self, 
+                 api: 'GeoboxClient', 
+                 attachment_id: str,
+                 data: Optional[Dict] = {}):
+        """
+        Initialize an Attachment instance.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            attachment_id (str): The id for the attachment.
+            data (Dict, optional): The data of the attachment.
+        """
+        super().__init__(api, data=data)
+        self.attachment_id = attachment_id
+        self.endpoint = urljoin(self.BASE_ENDPOINT, str(self.attachment_id))
+
+
+    def __repr__(self) -> str:
+        """
+        Return a string representation of the attachment.
+
+        Returns:
+            str: The string representation of the attachment.
+        """
+        return f"Attachment(name={self.name}, id={self.attachment_id})"
+
+
+    @property
+    def file(self) -> 'File':
+        """
+        Attachment file property
+
+        Returns:
+            File: the file object
+        """
+        return File(self.api, self.data['file'].get('uuid'), self.data['file'])
+
+
+    @classmethod
+    def get_attachments(cls, api: 'GeoboxClient', resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
+        """
+        Get list of attachments with optional filtering and pagination.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            resource_type (AttachmentResourceType): The resource type of the attachment. options are: Map, Vector, View
+            resource_uuid (str): The Resoource uuid of the attachment.
+
+        Keyword Args:
+            element_id (str): the id of the element with attachment.
+            search (str): search term for keyword-based searching among all textual fields.
+            order_by (str): comma separated list of fields for sorting results [field1 A|D, field2 A|D, …]. e.g. name A, type D. NOTE: "A" denotes ascending order and "D" denotes descending order.
+            skip (int): Number of items to skip. default is 0.
+            limit (int): Number of items to return. default is 10.
+            return_count (bool): Whether to return total count. default is False.
+
+        Returns:
+            List[Attachment] | int: A list of attachments instances or the total number of attachments.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> attachments = Attachment.get_attachments(client, q="name LIKE '%My attachment%'")
+            or
+            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
+        """
+        params = {
+           'resource_type': resource_type.value,
+           'resource_uuid': resource_uuid,
+           'element_id': kwargs.get('element_id'),
+           'search': kwargs.get('search'),
+           'order_by': kwargs.get('order_by'),
+           'skip': kwargs.get('skip', 0),
+           'limit': kwargs.get('limit', 10),
+           'return_count': kwargs.get('return_count')
+        }
+        return super()._get_list(api, cls.BASE_ENDPOINT, params, factory_func=lambda api, item: Attachment(api, item['id'], item))
+    
+
+    @classmethod
+    def create_attachment(cls, 
+                     api: 'GeoboxClient', 
+                     name: str, 
+                     loc_x: int,
+                     loc_y: int,
+                     resource: Union['Map', 'VectorLayer', 'VectorLayerView'],
+                     file: 'File',
+                     feature: 'Feature' = None,
+                     display_name: str = None, 
+                     description: str = None, ) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            name (str): The name of the scene.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+            resource (Map | VectorLayer | VectorLayerView): the resource object.
+            file (File): the file object.
+            feature (Feature, optional): the feature object.
+            display_name (str, optional): The display name of the scene.
+            description (str, optional): The description of the scene.
+
+        Returns:
+            Attachment: The newly created Attachment instance.
+
+        Raises:
+            ValidationError: If the Attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> feature = layer.get_feature(feature_id=1)
+            >>> file = client.get_file(uuid="12345678-1234-5678-1234-567812345678")
+            >>> attachment = Attachment.create_attachment(client, 
+            ...                                             name="my_attachment", 
+            ...                                             loc_x=30, 
+            ...                                             loc_y=50, 
+            ...                                             resource=layer, 
+            ...                                             file=file, 
+            ...                                             feature=feature, 
+            ...                                             display_name="My Attachment", 
+            ...                                             description="Attachment Description")
+            or
+            >>> attachment = client.create_attachment(name="my_attachment", 
+            ...                                             loc_x=30, 
+            ...                                             loc_y=50, 
+            ...                                             resource=layer, 
+            ...                                             file=file, 
+            ...                                             feature=feature, 
+            ...                                             display_name="My Attachment", 
+            ...                                             description="Attachment Description")
+        """
+        if isinstance(resource, VectorLayer):
+            resource_type = AttachmentResourceType.Vector.value
+
+        if isinstance(resource, VectorLayerView):
+            resource_type = AttachmentResourceType.View.value
+
+        if isinstance(resource, Map):
+            resource_type = AttachmentResourceType.Map.value
+
+        data = {
+            "name": name,
+            "display_name": display_name,
+            "description": description,
+            "loc_x": loc_x,
+            "loc_y": loc_y,
+            "resource_type": resource_type,
+            "resource_uuid": resource.uuid,
+            "element_id": feature.id,
+            "file_id": file.id
+            }
+        return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Attachment(api, item['id'], item))
+
+
+    @classmethod
+    def update_attachment(cls, api: 'GeoboxClient', attachment_id: int, **kwargs) -> Dict:
+        """
+        Update the attachment.
+
+        Args:
+            api (GeoboxClient): The GeoboxClient instance for making requests.
+            attachment_id (int): the attachment id.
+
+        Keyword Args:
+            name (str): The name of the attachment.
+            display_name (str): The display name of the attachment.
+            description (str): The description of the attachment.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+
+        Returns:
+            Dict: The updated attachment data.
+
+        Raises:
+            ValidationError: If the attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> Attachment.update_attachment(client, attachment_id=1, display_name="New Display Name")
+            or
+            >>> client.update_attachment(attachment_id=1, display_name="New Display Name")
+        """
+        data = clean_data({
+            "name": kwargs.get('name'),
+            "display_name": kwargs.get('display_name'),   
+            "description": kwargs.get('description'),
+            "loc_x": kwargs.get('loc_x'),
+            "loc_y": kwargs.get('loc_y')
+        })
+        endpoint = urljoin(cls.BASE_ENDPOINT, str(attachment_id))
+        response = api.put(endpoint, data)
+        return response
+    
+
+    def update(self, **kwargs) -> Dict:
+        """
+        Update the attachment.
+
+        Keyword Args:
+            name (str): The name of the attachment.
+            display_name (str): The display name of the attachment.
+            description (str): The description of the attachment.
+            loc_x (int): x parameter of the attachment location.
+            loc_y (int): y parameter of the attachment location.
+
+        Returns:
+            Dict: The updated attachment data.
+
+        Raises:
+            ValidationError: If the attachment data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> attachment = Attachment.get_attachments(client)[0]
+            >>> attachment.update(display_name="New Display Name")
+        """
+        data = clean_data({
+            "name": kwargs.get('name'),
+            "display_name": kwargs.get('display_name'),   
+            "description": kwargs.get('description'),
+            "loc_x": kwargs.get('loc_x'),
+            "loc_y": kwargs.get('loc_y')
+        })
+        response = self.api.put(self.endpoint, data)
+        self._update_properties(response)
+        return response
+    
+
+    def delete(self) -> None:
+        """
+        Delete the scene.
+
+        Returns:
+            None
+
+        Raises:
+            ApiRequestError: If the API request fails.
+            ValidationError: If the scene data is invalid.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> attachment = Attachment.get_attachments(client)[0]
+            >>> attachment.delete()
+        """
+        super().delete(self.endpoint)
+        self.attachment_id = None
+
+
+    @property
+    def thumbnail(self) -> str:
+        """
+        Get the thumbnail URL of the attachment.
+
+        Returns:
+            str: The thumbnail of the scene.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
+            >>> client = GeoboxClient()
+            >>> attachment = Attachment.get_attachment(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> attachment.thumbnail
+            'https://example.com/thumbnail.png'
+        """
+        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail"
+        return endpoint