geobox 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

geobox/api.py

@@ -29,7 +29,7 @@ from .route import Routing
 from .plan import Plan
 from .dashboard import Dashboard
 from .basemap import Basemap
-from .attachment import Attachment, AttachmentResourceType
+from .attachment import Attachment
 from .apikey import ApiKey
 from .log import Log
 from .usage import Usage, UsageScale, UsageParam
@@ -2294,13 +2294,12 @@ class GeoboxClient:
         return Basemap.proxy_basemap(self, url)
     
 
-    def get_attachments(self, resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
+    def get_attachments(self, resource: Union['Map', 'VectorLayer', 'VectorLayerView'], **kwargs) -> List['Attachment']:
         """
-        Get list of attachments with optional filtering and pagination.
+        Get the resouces attachments
 
         Args:
-            resource_type (AttachmentResourceType): The resource type of the attachment. options are: Map, Vector, View
-            resource_uuid (str): The Resoource uuid of the attachment.
+            resource (Map | VectorLayer | VectorLayerView): options are: Map, Vector, View objects
 
         Keyword Args:
             element_id (str): the id of the element with attachment.
@@ -2313,12 +2312,17 @@ class GeoboxClient:
         Returns:
             List[Attachment] | int: A list of attachments instances or the total number of attachments.
 
+        Raises:
+            TypeError: if the resource type is not supported
+
         Example:
             >>> from geobox import GeoboxClient
+            >>> from geobox.attachment import Attachment
             >>> client = GeoboxClient()
-            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
+            >>> map = client.get_maps()[0]
+            >>> attachments = client.get_attachments(resource=map)
         """
-        return Attachment.get_attachments(self, resource_type, resource_uuid, **kwargs)
+        return Attachment.get_attachments(self, resource=resource, **kwargs)
     
 
     def create_attachment(self,

geobox/attachment.py

@@ -3,7 +3,6 @@ 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
@@ -56,14 +55,13 @@ class Attachment(Base):
 
 
     @classmethod
-    def get_attachments(cls, api: 'GeoboxClient', resource_type: AttachmentResourceType, resource_uuid: str, **kwargs) -> Union[List['Attachment'], int]:
+    def get_attachments(cls, api: 'GeoboxClient', resource: Union['Map', 'VectorLayer', 'VectorLayerView'], **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.
+            resource (Map | VectorLayer | VectorLayerView): options are: Map, Vector, View objects
 
         Keyword Args:
             element_id (str): the id of the element with attachment.
@@ -76,17 +74,34 @@ class Attachment(Base):
         Returns:
             List[Attachment] | int: A list of attachments instances or the total number of attachments.
 
+        Raises:
+            TypeError: if the resource type is not supported
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.attachment import Attachment
             >>> client = GeoboxClient()
-            >>> attachments = Attachment.get_attachments(client, q="name LIKE '%My attachment%'")
+            >>> map = client.get_maps()[0]
+            >>> attachments = Attachment.get_attachments(client, resource=map, q="name LIKE '%My attachment%'")
             or
-            >>> attachments = client.get_attachments(q="name LIKE '%My attachment%'")
+            >>> attachments = client.get_attachments(resource=map, q="name LIKE '%My attachment%'")
         """
+        if type(resource) == VectorLayer:
+            resource_type = 'vector'
+
+        elif type(resource) == VectorLayerView:
+            resource_type = 'view'
+
+        elif type(resource) == Map:
+            resource_type = 'map'
+
+        else:
+            raise TypeError('resource must be a vectorlayer or view or map object')
+
+
         params = {
-           'resource_type': resource_type.value,
-           'resource_uuid': resource_uuid,
+           'resource_type': resource_type,
+           'resource_uuid': resource.uuid,
            'element_id': kwargs.get('element_id'),
            'search': kwargs.get('search'),
            'order_by': kwargs.get('order_by'),
@@ -155,13 +170,13 @@ class Attachment(Base):
             ...                                             description="Attachment Description")
         """
         if isinstance(resource, VectorLayer):
-            resource_type = AttachmentResourceType.Vector.value
+            resource_type = 'vector'
 
         if isinstance(resource, VectorLayerView):
-            resource_type = AttachmentResourceType.View.value
+            resource_type = 'view'
 
         if isinstance(resource, Map):
-            resource_type = AttachmentResourceType.Map.value
+            resource_type = 'map'
 
         data = {
             "name": name,
@@ -171,7 +186,7 @@ class Attachment(Base):
             "loc_y": loc_y,
             "resource_type": resource_type,
             "resource_uuid": resource.uuid,
-            "element_id": feature.id,
+            "element_id": feature.id if feature else None,
             "file_id": file.id
             }
         return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Attachment(api, item['id'], item))

geobox/basemap.py

@@ -95,8 +95,7 @@ class Basemap(Base):
         Returns:
             str: the thumbnail url
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}/thumbnail.png" 
-        return endpoint
+        return super().thumbnail()
     
 
     @property

geobox/enums.py

@@ -272,14 +272,6 @@ class UserStatus(Enum):
     DISABLED = "Disabled"
 
 
-class AttachmentResourceType(Enum):
-    Map = "map"
-
-    Vector = "vector"
-
-    View = "view"
-
-
 class MaxLogPolicy(Enum):
     OverwriteFirstLog = "OverwriteFirstLog"
 

geobox/log.py

@@ -6,6 +6,7 @@ from .base import Base
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .user import User
 
 
 class Log(Base):
@@ -98,4 +99,22 @@ class Log(Base):
             >>> log.delete()
         """
         super().delete(self.endpoint)
-        self.log_id = None
+        self.log_id = None
+
+
+    @property
+    def user(self) -> Union['User', None]:
+        """
+        Get the owner user for the log
+
+        Returns:
+            User | None: if the log has owner user 
+
+        Example:
+            >>> from geobox import Geobox
+            >>> from geopox.log import Log
+            >>> client = GeoboxClient()
+            >>> log = Log.get_logs(client)[0]
+            >>> log.user
+        """
+        return self.api.get_user(self.owner_id)

geobox/map.py

@@ -4,11 +4,15 @@ from urllib.parse import urljoin, urlencode
 from .base import Base
 from .utils import clean_data, join_url_params
 from .model3d import Model
+from .file import File
+from .feature import Feature
 
 if TYPE_CHECKING:
     from . import GeoboxClient
     from .user import User
     from .task import Task
+    from .attachment import Attachment
+
 
 
 class Map(Base):
@@ -570,11 +574,30 @@ class Map(Base):
             'view_settings': {},
             'toc_settings': []
         })
+    
+
+    def update_settings(self, settings: Dict) -> Dict:
+        """
+        Update the settings
+
+        settings (Dict): settings dictionary
+
+        Returns:
+            Dict: updated settings
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> map1 = client.get_map(uuid="12345678-1234-5678-1234-567812345678")
+            >>> map2 = client.get_map(uuid="12345678-1234-5678-1234-567812345678")
+            >>> map1.update_settings(map2.settings)
+        """
+        return super()._set_settings(self.endpoint, settings)    
 
 
     def set_settings(self, **kwargs) -> Dict:
         """
-        Set the settings of the map.
+        Set the settings of the map using keywords
 
         Keyword Args:
             map_unit (str): 'latlng' | 'utm'.
@@ -732,7 +755,7 @@ class Map(Base):
         if not response or json:
             return response
         else:
-            return [Model(self.api, model['obj'], model) for model in response['objects']]
+            return [Model(self.api, model['obj'], model) for model in response['objects'] if response.get('objects')]
     
 
     def set_models(self, data: Dict) -> List['Model']:
@@ -767,7 +790,7 @@ class Map(Base):
         """
         endpoint = urljoin(self.endpoint, 'models/')
         response = self.api.put(endpoint, data)
-        return [Model(self.api, model['obj'], model) for model in response['objects']]
+        return [Model(self.api, model['obj'], model) for model in response['objects'] if response.get('objects')]
 
 
     def add_model(self, 
@@ -899,3 +922,80 @@ class Map(Base):
         endpoint = f"{endpoint}?{query_string}"
         response = self.api.post(endpoint)
         return self.api.get_task(response['task_id'])
+
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        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.
+
+        Raises:
+            TypeError: if the resource type is not supported
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.map import Map
+            >>> client = GeoboxClient()
+            >>> map = Map.get_map(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> map.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            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.
+            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.map import Map
+            >>> client = GeoboxClient()
+            >>> map = Map.get_map(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> map.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

geobox/model3d.py

@@ -1,5 +1,10 @@
 from typing import Dict, List, Optional, Optional, Union, TYPE_CHECKING
 from urllib.parse import urljoin, urlencode
+import os
+import zipfile
+import sys
+import requests
+import mimetypes
 
 from .base import Base
 from .exception import ApiRequestError
@@ -216,33 +221,113 @@ class Model(Base):
         super().delete(self.endpoint)
 
 
-    def get_content(self) -> bytes:
+    def _get_save_path(self, save_path: str = None) -> str:
         """
-        Get the raw content of the 3D model.
+        Get the path where the file should be saved.
+
+        Args:
+            save_path (str, optional): The path to save the file.
 
         Returns:
-            bytes: The raw content of the 3D model in glTF format.
+            str: The path where the file is saved.
+        
+        Raises:
+            ValueError: If save_path does not end with a '/'.
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.file import File
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> file_path = File.get_file(client, uuid="12345678-1234-5678-1234-567812345678")
+        """
+        # If save_path is provided, check if it ends with a '/'
+        if save_path and save_path.endswith('/'):
+            return f'{save_path}'
+        
+        if save_path and not save_path.endswith('/'):
+            raise ValueError("save_path must end with a '/'")
+        
+        return os.getcwd()
+
+
+    def _create_progress_bar(self) -> 'tqdm':
+        """Creates a progress bar for the task."""
+        try:
+            from tqdm.auto import tqdm
+        except ImportError:
+            from .api import logger
+            logger.warning("[tqdm] extra is required to show the progress bar. install with: pip insatll geobox[tqdm]")
+            return None
+
+        return tqdm(unit="B", 
+                        total=int(self.size), 
+                        file=sys.stdout,
+                        dynamic_ncols=True,
+                        desc="Downloading",
+                        unit_scale=True,
+                        unit_divisor=1024, 
+                        ascii=True
+                )
+
+
+    def download(self, save_path: str = None, progress_bar: bool = True) -> str:
+        """
+        Download the 3D model, save it as a .glb file, zip it, and return the zip file path.
+
+        Args:
+            save_path (str, optional): Directory where the file should be saved.
+            progress_bar (bool, optional): Whether to show a progress bar. Default: True
+
+        Returns:
+            str: Path to the .zip file containing the .glb model.
 
         Raises:
             ApiRequestError: If the API request fails.
 
         Example:
             >>> from geobox import GeoboxClient
-            >>> from geobox.model3d import Model
             >>> client = GeoboxClient()
-            >>> model = Model.get_model(api=client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> content = model.get_content()
-            >>> # Save the content to a file
-            >>> with open('model.gltf', 'wb') as f:
-            ...     f.write(content)
+            >>> model = client.get_models()[0]
+            >>> model.get_content()
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}/content/')
-        response = self.api.session.get(endpoint)
-        
-        if response.status_code != 200:
-            raise ApiRequestError(f"Failed to get model content: {response.status_code}")
-            
-        return response.content
+        if not self.uuid:
+            raise ValueError("Model UUID is required to download content")
+
+        if self.data.get('obj'):
+            model = self.api.get_model(self.obj)
+        else:
+            model = self
+
+        save_path = model._get_save_path(save_path)
+        os.makedirs(save_path, exist_ok=True)
+
+        endpoint = urljoin(model.api.base_url, f"{model.endpoint}/content/")
+        with model.api.session.get(endpoint, stream=True) as response:
+            if response.status_code != 200:
+                raise ApiRequestError(f"Failed to get model content: {response.status_code}")
+
+            glb_filename = f"{model.name}.glb"
+            glb_path = os.path.join(save_path, glb_filename)
+
+            with open(glb_path, "wb") as f:
+                pbar = model._create_progress_bar() if progress_bar else None
+                for chunk in response.iter_content(chunk_size=8192):
+                    f.write(chunk)
+                    if pbar:
+                        pbar.update(len(chunk))
+                        pbar.refresh()
+                if pbar:
+                    pbar.close()
+
+        zip_filename = f"{model.name}.zip"
+        zip_path = os.path.join(save_path, zip_filename)
+        with zipfile.ZipFile(zip_path, "w", zipfile.ZIP_DEFLATED) as zipf:
+            zipf.write(glb_path, arcname=os.path.basename(glb_path))
+
+        os.remove(glb_path)
+
+        return os.path.abspath(zip_path)
 
 
     @property

geobox/mosaic.py

@@ -401,6 +401,25 @@ class Mosaic(Raster):
         """
         return super().settings
     
+
+    def update_settings(self, settings: Dict) -> Dict:
+        """
+        Update the settings
+
+        settings (Dict): settings dictionary
+
+        Returns:
+            Dict: updated settings
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> mosaic1 = client.get_mosaic(uuid="12345678-1234-5678-1234-567812345678")
+            >>> mosaic2 = client.get_mosaic(uuid="12345678-1234-5678-1234-567812345678")
+            >>> mosaic1.update_settings(mosaic2.settings)
+        """
+        return super().update_settings(settings)  
+    
     
     def set_settings(self, **kwargs) -> None:
         """

geobox/query.py

@@ -179,7 +179,7 @@ class Query(Base):
 
 
     @classmethod
-    def create_query(cls, api: 'GeoboxClient', name: str, display_name: str = None, sql: str = None, params: List = None) -> 'Query':
+    def create_query(cls, api: 'GeoboxClient', name: str, display_name: str = None, description:str = None, sql: str = None, params: List = None) -> 'Query':
         """
         Creates a new query.
 
@@ -187,6 +187,7 @@ class Query(Base):
             api (Api): The GeoboxClient instance for making requests.
             name (str): The name of the query.
             display_name (str, optional): The display name of the query.
+            description (str, optional): The description of the query.
             sql (str, optional): The SQL statement for the query.
             params (list, optional): The parameters for the SQL statement.
 
@@ -204,6 +205,7 @@ class Query(Base):
         data = {
             "name": name,
             "display_name": display_name,
+            "description": description,
             "sql": sql,
             "params": params
         }

geobox/raster.py

@@ -641,6 +641,25 @@ class Raster(Base):
             >>> raster.settings
         """
         return super()._get_settings(self.endpoint)
+    
+
+    def update_settings(self, settings: Dict) -> Dict:
+        """
+        Update the settings
+
+        settings (Dict): settings dictionary
+
+        Returns:
+            Dict: updated settings
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> raster1 = client.get_raster(uuid="12345678-1234-5678-1234-567812345678")
+            >>> raster2 = client.get_raster(uuid="12345678-1234-5678-1234-567812345678")
+            >>> raster1.update_settings(raster2.settings)
+        """
+        return super()._set_settings(self.endpoint, settings)  
 
 
     def set_settings(self, **kwargs) -> None:

geobox/vectorlayer.py

@@ -11,12 +11,13 @@ from .task import Task
 from .enums import InputGeomType, FileOutputFormat
 from .version import VectorLayerVersion
 
-
 if TYPE_CHECKING:
     from .api import GeoboxClient
     from .view import VectorLayerView
     from .user import User
     from .file import File
+    from .attachment import Attachment
+
 
 class VectorLayer(Base):
     """
@@ -1061,6 +1062,25 @@ class VectorLayer(Base):
             >>> setting = layer.setting
         """
         return super()._get_settings(endpoint=self.endpoint)
+    
+
+    def update_settings(self, settings: Dict) -> Dict:
+        """
+        Update the settings
+
+        settings (Dict): settings dictionary
+
+        Returns:
+            Dict: updated settings
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> layer1 = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer2 = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer1.update_settings(layer2.settings)
+        """
+        return super()._set_settings(self.endpoint, settings)  
 
 
     def set_settings(self, **kwargs) -> Dict:
@@ -1227,4 +1247,81 @@ class VectorLayer(Base):
             >>> layer.prune_edited_areas()
         """
         endpoint = urljoin(self.endpoint, 'prune/')
-        return self.api.post(endpoint)
+        return self.api.post(endpoint)
+    
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        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.
+
+        Raises:
+            TypeError: if the resource type is not supported
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.vectorlayer import VectorLayer
+            >>> client = GeoboxClient()
+            >>> layer = VectorLayer.get_vector(api=client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            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.
+            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.vectorlayer import VectorLayer
+            >>> client = GeoboxClient()
+            >>> layer = VectorLayer.get_vector(api=client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> layer.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

geobox/view.py

@@ -7,9 +7,11 @@ if TYPE_CHECKING:
     from . import GeoboxClient
     from .field import Field
     from .user import User
-    from .enums import InputGeomType, FieldType
+    from .enums import InputGeomType
     from .task import Task
     from .file import File
+    from .attachment import Attachment
+
 
 
 class VectorLayerView(VectorLayer):
@@ -720,6 +722,25 @@ class VectorLayerView(VectorLayer):
         return super().settings
 
 
+    def update_settings(self, settings: Dict) -> Dict:
+        """
+        Update the settings
+
+        settings (Dict): settings dictionary
+
+        Returns:
+            Dict: updated settings
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> client = GeoboxClient()
+            >>> view1 = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view2 = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view1.update_settings(view2.settings)
+        """
+        return super().update_settings(settings) 
+
+
     def set_settings(self, **kwargs) -> Dict:
         """
         Set the settings of the Vector Layer.
@@ -862,3 +883,80 @@ class VectorLayerView(VectorLayer):
             >>> view.prune_edited_areas()
         """
         return super().prune_edited_areas()
+
+
+    def get_attachments(self, **kwargs) -> List['Attachment']:
+        """
+        Get the resouces attachments
+
+        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.
+
+        Raises:
+            TypeError: if the resource type is not supported
+
+        Example:
+            >>> from geobox import GeoboxClient
+            >>> from geobox.view import VectorLayerView
+            >>> client = GeoboxClient()
+            >>> view = VectorLayerView.get_view(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> view.get_attachments()
+        """
+        from .attachment import Attachment
+
+        return Attachment.get_attachments(self.api, resource=self, **kwargs)
+    
+    
+    def create_attachment(self, 
+                            name: str, 
+                            loc_x: int,
+                            loc_y: int,
+                            file: 'File',
+                            feature: 'Feature' = None,
+                            display_name: str = None, 
+                            description: str = None) -> 'Attachment':
+        """
+        Create a new Attachment.
+
+        Args:
+            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.
+            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.view import VectorLayerView
+            >>> client = GeoboxClient()
+            >>> view = VectorLayerView.get_view(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> file = client.get_files()[0]
+            >>> view.create_attachment(name='test', loc_x=10, loc_y=10, file=file)
+        """
+        from .attachment import Attachment
+
+        return Attachment.create_attachment(self.api,
+                                            name=name,
+                                            loc_x=loc_x,
+                                            loc_y=loc_y,
+                                            resource=self,
+                                            file=file,
+                                            feature=feature,
+                                            display_name=display_name,
+                                            description=description)

{geobox-1.4.0.dist-info → geobox-1.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geobox
-Version: 1.4.0
+Version: 1.4.2
 Summary: SDK for Geobox's APIs
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT

{geobox-1.4.0.dist-info → geobox-1.4.2.dist-info}/RECORD

@@ -1,23 +1,23 @@
 geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
-geobox/api.py,sha256=lqVpQ_NLyPpDnySxYlSBLiZelkbL7IFd5uX3K-9QRho,105246
+geobox/api.py,sha256=8wO1AvyIWf0n2gi-Jv22IM6gyjtbX4KGBYXJTKTh01A,105230
 geobox/apikey.py,sha256=OXsf1ltXcN1jIQJHECdnIE5R_Qksb897xVJOkORRsxw,7522
-geobox/attachment.py,sha256=qplcYfHkoV9aHaXQ7xFnkrsYxwmUs0PNPbjoSerET34,11582
+geobox/attachment.py,sha256=Q5LVn2j8gm-CptDVhpqtfzyQTDDd1FjW_9MEJBRQb6M,11865
 geobox/base.py,sha256=OdabLbBflglLkNWM7TGCWtPh73M_-42_Ph963K26JQg,12931
-geobox/basemap.py,sha256=7Jo2MeEN8U8Av54kPPaFzQFjajcNYgMRMOTZXPUcXyk,4529
+geobox/basemap.py,sha256=fQhCj6ERYCEaY4RLINrftEt4RDakddKZ-wG9Av4Rv_8,4468
 geobox/dashboard.py,sha256=x99jUGzUJra4cdcffSYC0_FvrihZh6sPI4o79f-Aptc,11694
-geobox/enums.py,sha256=C7PQf8pisiRwHE7-wsgSQ_rZcpvP6-7EDpx8iXijkMs,6300
+geobox/enums.py,sha256=Ur8zbUjfx09oxXb-uzwFfDT_Nt8I4AP5pFQKJ9bxVxI,6204
 geobox/exception.py,sha256=jvpnv0M2Ck1FpxHTL_aKYWxGvLnCQ3d9vOrMIktjw1U,1507
 geobox/feature.py,sha256=3Kbc1LjIkBt1YqRAry84BrR7qxx9BexvBB3YQ8D9mGk,18504
 geobox/field.py,sha256=p9eitUpnsiGj6GUhjSomk6HWlsNJSbE-Oh_4VcjaqVo,10562
 geobox/file.py,sha256=cMm-SwTzRKALiIj-gkY4UJzUsOuN5SGz50eU1ylNAxk,20079
 geobox/layout.py,sha256=TdE5FJ7fzbhkexojY8h-r68hXb5UYM6MIfNkxfs_RKA,11285
-geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
-geobox/map.py,sha256=oMhpbmeRtamI1iVYZIWXgGQa3NOcKh6O57mgrDBQkno,32723
-geobox/model3d.py,sha256=GUpZdRcy6Fs83PdqdfX70F_uxIAqkyTbsMWYSI7rV5k,12011
-geobox/mosaic.py,sha256=6wSK9xkjtBUEtIsZANWVYwsJbDx112mO1SQOXcPTVo8,23780
+geobox/log.py,sha256=Xuq4oKPwaypZ4nYEOIXu13dH4AkQcf0pkTw85gDQqS4,4063
+geobox/map.py,sha256=kksFBS79TOKN9KBByXzj2atSvZhIAuMA85hSjo_szeA,36788
+geobox/model3d.py,sha256=acT5dXwq3Lmhfq5-cPOnYJMZR1gzj3cfF6kyxMleHag,14924
+geobox/mosaic.py,sha256=zKo6cEtaqz7fFcWIzhURxZIkICUQlpEhpFBjGJ5GJ1M,24385
 geobox/plan.py,sha256=jUzl6CQBY6IsdieEppJOmE0sSjwvu6eHO89pC_JFs6I,12066
-geobox/query.py,sha256=FqeiZf2E4tJ2FG-mIfRKov6H1QWUrMSErVpNWcb3Wx0,24038
-geobox/raster.py,sha256=gBWZUm88uJwjgSlp7auS0nEB9KjkTv1F9hvdPaJqCic,30084
+geobox/query.py,sha256=ubS1Og3rC_6-zW-cbR30o7bZw2MZNZY652VLCvVvmWE,24173
+geobox/raster.py,sha256=fTIM9HKVddaFfO9o-mEbZSM31qpCr6KAszguInZjd2A,30702
 geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
 geobox/scene.py,sha256=GEzvWB-l-xO-8IodwFAPt4T7lZxuzEKJ1H0cqfx78W4,11301
 geobox/settings.py,sha256=rGRdM18Vo7xnjfZXPLRMbKeoVC_lZmzkNRPS0SQv05o,5660
@@ -27,12 +27,12 @@ geobox/tileset.py,sha256=bQOckE04F31vb-NYmNsQzXndZSTDZyskWspRikjZuBs,24241
 geobox/usage.py,sha256=_54xL-n-2Bg9wGpoOBKnh85WqdpMWEtqxRJVaFlVWe0,7908
 geobox/user.py,sha256=YY72uRvjKUUWUZbxhrft37FVBlqDeosPMf3EpMVBhc0,15069
 geobox/utils.py,sha256=qLtchKIdw-az3KCiiFv0-Cpmx9RfBxORjlATvVyDIaQ,1314
-geobox/vectorlayer.py,sha256=5IglRp7uoMm3yggYpHurDRAGQo9x7KdjJGicSLpxrSs,53035
+geobox/vectorlayer.py,sha256=s8zH68ALeBvep5bW5wuHkDm9x07Z52GhPaeDbznJ3wY,57066
 geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
-geobox/view.py,sha256=ZNJNBQclM6fc0cxXmU_L_XEBwd4lbsEncs6ynxWU9lc,37531
+geobox/view.py,sha256=xAxBhxwoWAoiG8YJBEF93UJ4e4VeJx17rZpfdl2Q8DU,41507
 geobox/workflow.py,sha256=_WEIy1zLpBFx5yeuZ4ClnwPdU90jQbdy5bWYYIRa4JY,11549
-geobox-1.4.0.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-1.4.0.dist-info/METADATA,sha256=GGoWFZt8cAf-9N_3YIEz4ZLyv77uMT0IO-kZyAj6-rQ,2658
-geobox-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-1.4.0.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-1.4.0.dist-info/RECORD,,
+geobox-1.4.2.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-1.4.2.dist-info/METADATA,sha256=5-4FR_CCE6LGfz96_urdMuEjN1s0xikKEn8vG2Q5WPI,2658
+geobox-1.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-1.4.2.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-1.4.2.dist-info/RECORD,,