geobox 1.3.2__py3-none-any.whl → 1.3.4__py3-none-any.whl

geobox/api.py

@@ -781,16 +781,14 @@ class GeoboxClient:
         return VectorLayerView.get_view_by_name(self, name, user_id)
 
 
-    def create_tileset(self, name: str, layers: List[Dict], display_name: str = None, description: str = None,
+    def create_tileset(self, name: str, layers: List[Union['VectorLayer', 'VectorLayerView']], display_name: str = None, description: str = None,
                         min_zoom: int = None, max_zoom: int = None, user_id: int = None) -> 'Tileset':
         """
         Create a new tileset.
 
         Args:
             name (str): The name of the tileset.
-            layers (List[Dict]): The layers of the tileset. a list of dictionaries with the following keys:
-                - layer_type: The type of the layer. valid values are "vector" and "view".
-                - layer_uuid: The uuid of the layer.
+            layers (List['VectorLayer' | 'VectorLayerView']): list of vectorlayer and view objects to add to tileset.
             display_name (str, optional): The display name of the tileset.
             description (str, optional): The description of the tileset.
             min_zoom (int, optional): The minimum zoom level of the tileset.
@@ -802,19 +800,16 @@ class GeoboxClient:
 
         Example:
             >>> from geobox import GeoboxClient
+            >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> layers = [
-            ...     {
-            ...     "layer_type": "vector",
-            ...     "layer_uuid": "12345678-1234-5678-1234-567812345678"
-            ...     }
-            ... ]
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
             >>> tileset = client.create_tileset(name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
         """
         return Tileset.create_tileset(api=self, 
                                       name=name, 

geobox/attachment.py

@@ -31,7 +31,7 @@ class Attachment(Base):
         """
         super().__init__(api, data=data)
         self.attachment_id = attachment_id
-        self.endpoint = urljoin(self.BASE_ENDPOINT, str(self.attachment_id))
+        self.endpoint = f"{self.BASE_ENDPOINT}{str(self.attachment_id)}/"
 
 
     def __repr__(self) -> str:
@@ -293,6 +293,5 @@ class Attachment(Base):
             >>> attachment.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail"
-        return endpoint
+        return super().thumbnail(format='')
     

geobox/base.py

@@ -362,3 +362,24 @@ class Base:
         
         # If all parsing fails, return the original string
         return date_string
+
+
+    def thumbnail(self, format='.png') -> str:
+        """
+        Get the thumbnail URL of the resource.
+        
+        Returns:
+            str: The thumbnail URL
+
+        Raises:
+            ValueError: 
+        """
+        endpoint = f'{self.api.base_url}{self.endpoint}thumbnail{format}'
+        
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+            
+        elif not self.api.access_token and not self.api.apikey:
+            raise ValueError("either access_token or apikey must be available for this action.")
+        
+        return endpoint

geobox/basemap.py

@@ -23,7 +23,7 @@ class Basemap(Base):
             data (Dict): The data of the basemap.
         """
         super().__init__(api, data=data)
-        self.endpoint = f"{self.BASE_ENDPOINT}{self.data.get('name')}"
+        self.endpoint = f"{self.BASE_ENDPOINT}{self.data.get('name')}/"
 
 
     @classmethod
@@ -107,7 +107,11 @@ class Basemap(Base):
         Returns:
             str: the wmts url
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}/wmts" 
+        endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f"{endpoint}?apikey={self.api.apikey}"
+            
         return endpoint
     
 

geobox/dashboard.py

@@ -243,8 +243,7 @@ class Dashboard(Base):
             >>> dashboard.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

geobox/enums.py

@@ -326,12 +326,6 @@ class QueryResultType(Enum):
     both = "both"
 
 
-class TilesetLayerType(Enum):
-    Vector = "vector"
-
-    View = "view"
-
-
 class FileOutputFormat(Enum):
     Shapefile = "Shapefile"
 

geobox/map.py

@@ -2,7 +2,7 @@ from typing import Dict, List, Optional, Union, TYPE_CHECKING
 from urllib.parse import urljoin, urlencode
 
 from .base import Base
-from .utils import clean_data
+from .utils import clean_data, join_url_params
 from .model3d import Model
 
 if TYPE_CHECKING:
@@ -276,8 +276,7 @@ class Map(Base):
             >>> map.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail.png"
-        return endpoint
+        return super().thumbnail()
     
 
     def set_readonly(self, readonly: bool) -> None:
@@ -351,6 +350,10 @@ class Map(Base):
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
         if scale:
             endpoint = f"{endpoint}?scale={scale}"
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
 
     

geobox/model3d.py

@@ -258,11 +258,7 @@ class Model(Base):
             >>> model = Model.get_model(api=client, uuid="12345678-1234-5678-1234-567812345678")
             >>> model.thumbnail
         """
-        if not self.uuid:
-            raise ValueError("Model UUID is required.")
-        
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}/thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

geobox/mosaic.py

@@ -295,14 +295,14 @@ class Mosaic(Raster):
         return super().get_point(lat, lng)
 
 
-    def get_render_png_url(self, x: int, y: int, z: int, **kwargs) -> str:
+    def get_render_png_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}', **kwargs) -> str:
         """
         Get the tile render URL of the mosaic.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Keyword Args:
             indexes (str, optional): list of comma separated band indexes to be rendered. e.g. 1, 2, 3
@@ -326,14 +326,14 @@ class Mosaic(Raster):
         return super().get_render_png_url(x, y, z, **kwargs)
     
 
-    def get_tile_png_url(self, x: int, y: int, z: int) -> str:
+    def get_tile_png_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}') -> str:
         """
         Get the tile PNG URL of the mosaic.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Returns:
             str: The tile PNG URL of the mosaic.

geobox/query.py

@@ -620,22 +620,19 @@ class Query(Base):
             str: The thumbnail URL.
         """
         self._check_access()
-        endpoint = f'{self.api.base_url}{self.endpoint}thumbnail.png'
-        return endpoint
+        return super().thumbnail()
 
 
-    def save_as_layer(self, layer_name: str, layer_type: 'QueryGeometryType') -> Dict:
+    def save_as_layer(self, layer_name: str, layer_type: 'QueryGeometryType' = None) -> Task:
         """
         Saves the query as a new layer.
 
         Args:
-            sql (str): The SQL statement for the query.
-            params (list): The parameters for the SQL statement.
             layer_name (str): The name of the new layer.
-            layer_type (QueryGeometryType): The type of the new layer.
+            layer_type (QueryGeometryType, optional): The type of the new layer.
 
         Returns:
-            Dict: The response from the API.
+            Task: The response task object.
             
         Raises:
             PermissionError: If the query is a read-only system query.
@@ -645,7 +642,7 @@ class Query(Base):
             >>> from geobox.query import Query
             >>> client = GeoboxClient()
             >>> query = Query.get_query(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> query.save_as_layer(layer_name='test', layer_type=QueryGeometryType.POLYGON)
+            >>> query.save_as_layer(layer_name='test')
         """
         self._check_access()
 
@@ -659,7 +656,7 @@ class Query(Base):
             "sql": self.sql,
             "params": params,
             "layer_name": layer_name,
-            "layer_type": layer_type.value
+            "layer_type": layer_type.value if layer_type else None
         })
 
         endpoint = urljoin(self.BASE_ENDPOINT, 'saveAsLayer/')

geobox/raster.py

@@ -6,7 +6,7 @@ import requests
 import sys
 
 from .base import Base
-from .utils import clean_data
+from .utils import clean_data, join_url_params
 from .task import Task
 
 if TYPE_CHECKING:
@@ -231,8 +231,7 @@ class Raster(Base):
             >>> raster = Raster.get_raster(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> raster.thumbnail
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail/')
-        return endpoint
+        return super().thumbnail(format='')
     
     
     @property
@@ -511,19 +510,20 @@ class Raster(Base):
             'colormap': kwargs.get('colormap')
         })
         query_string = urlencode(params)
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}render/{z}/{x}/{y}.png')
-        endpoint = urljoin(endpoint, f'?{query_string}')
+        endpoint = f'{self.api.base_url}{self.endpoint}render/{z}/{x}/{y}.png'
+        if query_string:
+            endpoint = f'{endpoint}?{query_string}'
         return endpoint
     
 
-    def get_tile_pbf_url(self, x: int, y: int, z: int, indexes: str = None) -> str:
+    def get_tile_pbf_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}', indexes: str = None) -> str:
         """
         Get the URL of the tile.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
             indexes (str, optional): list of comma separated band indexes to be rendered. e.g. 1, 2, 3
 
         Returns:
@@ -542,17 +542,21 @@ class Raster(Base):
         query_string = urlencode(params)
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}tiles/{z}/{x}/{y}.pbf')
         endpoint = urljoin(endpoint, f'?{query_string}')
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
     
 
-    def get_tile_png_url(self, x: int, y: int, z: int) -> str:
+    def get_tile_png_url(self, x: int = 'x', y: int = 'y', z: int = 'z') -> str:
         """
         Get the URL of the tile.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optional): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Returns:
             str: The URL of the tile.
@@ -564,7 +568,11 @@ class Raster(Base):
             >>> raster = Raster.get_raster(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> raster.get_tile_png_url(x=10, y=20, z=1)
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}tiles/{z}/{x}/{y}.png')
+        endpoint = f'{self.api.base_url}{self.endpoint}tiles/{z}/{x}/{y}.png'
+            
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+
         return endpoint
 
 
@@ -606,6 +614,10 @@ class Raster(Base):
         endpoint = urljoin(self.api.base_url, f'{self.endpoint}wmts/')
         if scale:
             endpoint = f"{endpoint}?scale={scale}"
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = join_url_params(endpoint, {"apikey": self.api.apikey})
+
         return endpoint
 
 

geobox/scene.py

@@ -244,8 +244,7 @@ class Scene(Base):
             >>> scene.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

geobox/tile3d.py

@@ -1,10 +1,10 @@
 from typing import List, Dict, Optional, TYPE_CHECKING, Union
-from urllib.parse import urljoin
 
 from .base import Base
 
 if TYPE_CHECKING:
     from . import GeoboxClient
+    from .user import User
 
 
 class Tile3d(Base):
@@ -199,8 +199,7 @@ class Tile3d(Base):
             >>> tile.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = urljoin(self.api.base_url, f'{self.endpoint}thumbnail.png')
-        return endpoint
+        return super().thumbnail()
 
 
     def get_item(self, path: str) -> Dict:

geobox/tileset.py

@@ -3,8 +3,8 @@ from typing import Dict, List, Optional, Union, TYPE_CHECKING
 
 from .base import Base
 from .vectorlayer import VectorLayer
+from .view import VectorLayerView
 from .task import Task
-from .enums import TilesetLayerType
 
 if TYPE_CHECKING:
     from . import GeoboxClient 
@@ -35,7 +35,7 @@ class Tileset(Base):
 
 
     @classmethod
-    def create_tileset(cls, api: 'GeoboxClient', name: str, layers: List[Dict], display_name: str = None, description: str = None,
+    def create_tileset(cls, api: 'GeoboxClient', name: str, layers: List[Union['VectorLayer', 'VectorLayerView']], display_name: str = None, description: str = None,
                         min_zoom: int = None, max_zoom: int = None, user_id: int = None) -> 'Tileset':
         """
         Create a new tileset.
@@ -43,9 +43,7 @@ class Tileset(Base):
         Args:
             api (GeoboxClient): The GeoboxClient instance for making requests.
             name (str): The name of the tileset.
-            layers (List[Dict]): The layers of the tileset. a list of dictionaries with the following keys:
-                - layer_type: The type of the layer. valid values are "vector" and "view".
-                - layer_uuid: The uuid of the layer.
+            layers (List[VectorLayer | VectorLayerView]): list of vectorlayer and view objects to add to tileset.
             display_name (str, optional): The display name of the tileset.
             description (str, optional): The description of the tileset.
             min_zoom (int, optional): The minimum zoom level of the tileset.
@@ -59,34 +57,46 @@ class Tileset(Base):
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> layers = [
-            ...     {
-            ...     "layer_type": "vector",
-            ...     "layer_uuid": "12345678-1234-5678-1234-567812345678"
-            ...     }
-            ... ]
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> view = client.get_view(uuid="12345678-1234-5678-1234-567812345678")
             >>> tileset = Tileset.create_tileset(client, 
             ...                                     name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
             or 
             >>> tileset = client.create_tileset(name="your_tileset_name", 
             ...                                     display_name="Your Tileset", 
             ...                                     description="Your description", 
             ...                                     min_zoom=0, 
             ...                                     max_zoom=14, 
-            ...                                     layers=layers)
+            ...                                     layers=[layer, view])
         """
+        formatted_layers = []
+        for item in layers:
+            if type(item) == VectorLayer:
+                item_type = 'vector'
+
+            elif type(item) == VectorLayerView:
+                item_type = 'view'
+
+            else:
+                continue
+
+            formatted_layers.append({
+                'layer_type': item_type,
+                'layer_uuid': item.uuid
+            })
+
         data = {
             "name": name,
             "display_name": display_name,
             "description": description,
             "min_zoom": min_zoom,
             "max_zoom": max_zoom,
-            "layers": layers,
+            "layers": formatted_layers,
             "user_id": user_id
         }
         return super()._create(api, cls.BASE_ENDPOINT, data, factory_func=lambda api, item: Tileset(api, item['uuid'], item))
@@ -283,7 +293,7 @@ class Tileset(Base):
         super().delete(urljoin(self.BASE_ENDPOINT, f'{self.uuid}/'))
     
     
-    def get_tileset_layers(self, **kwargs) -> List['VectorLayer']:
+    def get_layers(self, **kwargs) -> List['VectorLayer']:
         """
         Retrieves the layers of the tileset with optional parameters.
 
@@ -307,13 +317,14 @@ class Tileset(Base):
         Example:
 
         Returns:
-            List: A list of VectorLayer instances.
+            List: A list of VectorLayer or VectorLayerView instances.
 
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
-            >>> tilesets = Tileset.get_tileset_layers()
+            >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
+            >>> layers = tileset.get_layers()
         """
         params = {
             'f': 'json',
@@ -328,57 +339,82 @@ class Tileset(Base):
             'shared': kwargs.get('shared', False)
         }
         endpoint = urljoin(self.BASE_ENDPOINT, f'{self.uuid}/layers/')
-        return super()._get_list(self.api, endpoint, params, factory_func=lambda api, item: VectorLayer(api, item['uuid'], item['layer_type'], item))
+        return super()._get_list(self.api, endpoint, params, factory_func=lambda api, item: VectorLayer(api, item['uuid'], item['layer_type'], item) if not item['is_view'] else \
+                                                                                            VectorLayerView(api, item['uuid'], item['layer_type'], item)                                    )
 
 
-    def add_layer(self, layer_type: TilesetLayerType, layer_uuid: str) -> None:
+    def add_layer(self, layer: Union['VectorLayer', 'VectorLayerView']) -> None:
         """
         Adds a layer to the tileset.
 
         Args:
-            layer_type (TilesetLayerType): The type of the layer. "vector" or "view".
-            layer_uuid (str): The UUID of the layer.
+            layer (VectorLayer | VectorLayerView): the layer object to add to the tileset
 
         Returns:
             None
 
+        Raises:
+            ValueError: if the layer input is not a 'VectorLayer' or 'VetorLayerview' object
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
             >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> tileset.add_layer_tileset(layer_type=TilesetLayerType.Vector, layer_uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> tileset.add_layer(layer)
         """
+        if type(layer) == VectorLayer:
+            layer_type = 'vector'
+
+        elif type(layer) == VectorLayerView:
+            layer_type = 'view'
+
+        else:
+            raise ValueError("layer input must be either 'VectorLayer' or 'VetorLayerview' object")
+
         data = {
-            "layer_type": layer_type.value,
-            "layer_uuid": layer_uuid
+            "layer_type": layer_type,
+            "layer_uuid": layer.uuid
         }
 
         endpoint = urljoin(self.endpoint, 'layers/')
         return self.api.post(endpoint, data, is_json=False)
 
 
-    def delete_layer(self, layer_type: TilesetLayerType, layer_uuid: str) -> None:
+    def delete_layer(self, layer: Union['VectorLayer', 'VectorLayerView']) -> None:
         """
         Deletes a layer from the tileset.
 
         Args:
-            layer_type (TilesetLayerType): The type of the layer. "vector" or "view".
-            layer_uuid (str): The UUID of the layer.
+            layer (VectorLayer | VectorLayerView): the layer object to delete from the tileset
 
         Returns:
             None
 
+        Raises:
+            ValueError: if the layer input is not a 'VectorLayer' or 'VetorLayerview' object
+
         Example:
             >>> from geobox import GeoboxClient
             >>> from geobox.tileset import Tileset
             >>> client = GeoboxClient()
             >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
-            >>> tileset.delete_layer_tileset(layer_type=TilesetLayerType.Vector, layer_uuid="12345678-1234-5678-1234-567812345678")
+            >>> layer = client.get_vector(uuid="12345678-1234-5678-1234-567812345678")
+            >>> tileset.delete_layer(layer)
         """
+        if type(layer) == VectorLayer:
+            layer_type = 'vector'
+
+        elif type(layer) == VectorLayerView:
+            layer_type = 'view'
+
+        else:
+            raise ValueError("layer input must be either 'VectorLayer' or 'VetorLayerview' object")
+
         data = {
-            "layer_type": layer_type.value,
-            "layer_uuid": layer_uuid
+            "layer_type": layer_type,
+            "layer_uuid": layer.uuid
         }
 
         endpoint = urljoin(self.endpoint, 'layers/')
@@ -490,14 +526,14 @@ class Tileset(Base):
         return self.api.post(endpoint)
 
 
-    def get_tile(self, x: int, y: int, z: int) -> str:
+    def get_tile_pbf_url(self, x: 'int' = '{x}', y: int = '{y}', z: int = '{z}') -> str:
         """
         Retrieves a tile from the tileset.
 
         Args:
-            x (int): The x coordinate of the tile.
-            y (int): The y coordinate of the tile.
-            z (int): The zoom level of the tile.
+            x (int, optional): The x coordinate of the tile.
+            y (int, optioanl): The y coordinate of the tile.
+            z (int, optional): The zoom level of the tile.
 
         Returns:
             str: The url of the tile.
@@ -509,7 +545,11 @@ class Tileset(Base):
             >>> tileset = Tileset.get_tileset(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> tileset.get_tile_tileset(x=1, y=1, z=1)
         """
-        endpoint = urljoin(self.endpoint, f'tiles/{z}/{x}/{y}.pbf') 
+        endpoint = f'{self.api.base_url}{self.endpoint}tiles/{z}/{x}/{y}.pbf'
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+
         return endpoint
 
 
@@ -525,7 +565,7 @@ class Tileset(Base):
             user_id (int, optional): The user ID.
 
         Returns:
-            List[Task]: The task object.
+            List[Task]: list of task objects.
 
         Raises:
             ValueError: If the number of workers is not one of the following: 1, 2, 4, 8, 12, 16, 20, 24.
@@ -547,14 +587,26 @@ class Tileset(Base):
         return super()._seed_cache(endpoint=self.endpoint, data=data)
 
 
-    def update_cache(self) -> List['Task']:
+    def update_cache(self, from_zoom: int, to_zoom: int, extents: List[List[float]] = None, user_id: int = 0) -> List['Task']:
         """
         Updates the cache of the tileset.
 
+        Args:
+            from_zoom (int): The starting zoom level.
+            to_zoom (int): The ending zoom level.
+            extents (List[List[float]], optional): The list of extents to update the cache for.
+            user_id (int, optional): The user ID.
+
         Returns:
-            None
+            List[Task]: list of task objects.
         """
-        return super()._update_cache(endpoint=self.endpoint)
+        data = {
+            "from_zoom": from_zoom,
+            "to_zoom": to_zoom,
+            "extents": extents,
+            "user_id": user_id
+        }
+        return super()._update_cache(endpoint=self.endpoint, data=data)
 
 
     @property

geobox/vectorlayer.py

@@ -1000,17 +1000,17 @@ class VectorLayer(Base):
                             factory_func=lambda api, item: VectorLayerView(api, item['uuid'], self.layer_type, item))
 
 
-    def get_tile(self, x: int, y: int, z: int) -> str:
+    def get_tile_pbf_url(self, x: int = '{x}', y: int = '{y}', z: int = '{z}') -> str:
         """
         Get a vector tile for the layer.
         
         Args:
-            x (int): X coordinate of the tile.
-            y (int): Y coordinate of the tile.
-            z (int): Zoom level of the tile.
+            x (int, optional): X coordinate of the tile.
+            y (int, optional): Y coordinate of the tile.
+            z (int, optioanl): Zoom level of the tile.
 
         Returns:
-            str: The vector tile data.
+            str: The vector tile url.
 
         Example:
             >>> from geobox import GeoboxClient
@@ -1019,7 +1019,11 @@ class VectorLayer(Base):
             >>> layer = VectorLayer.get_vector(api=client, uuid="12345678-1234-5678-1234-567812345678")
             >>> tile = layer.get_tile(x=10, y=20, z=1)
         """
-        endpoint = f'{self.BASE_ENDPOINT}{self.endpoint}tiles/{z}/{x}/{y}.pbf'
+        endpoint = f'{self.api.base_url}{self.endpoint}tiles/{z}/{x}/{y}.pbf'
+
+        if not self.api.access_token and self.api.apikey:
+            endpoint = f'{endpoint}?apikey={self.api.apikey}'
+
         return endpoint
 
 

geobox/view.py

@@ -663,7 +663,7 @@ class VectorLayerView(VectorLayer):
                                        bbox, out_srid, zipped, feature_ids, bbox_srid, q, fields)
 
     
-    def get_tile(self, x: int, y: int, z: int) -> Dict:
+    def get_tile_pbf_url(self, x: int, y: int, z: int) -> str:
         """
         Get a vector tile for the layer.
         
@@ -673,7 +673,7 @@ class VectorLayerView(VectorLayer):
             z (int): Zoom level of the tile.
 
         Returns:
-            Dict: The vector tile data.
+            str: the vector tile url.
 
         Example:
             >>> from geobox import GeoboxClient
@@ -682,7 +682,7 @@ class VectorLayerView(VectorLayer):
             >>> view = VectorLayerView.get_view(client, uuid="12345678-1234-5678-1234-567812345678")
             >>> tile = view.get_tile(x=10, y=20, z=1)
         """
-        return super().get_tile(x, y, z)
+        return super().get_tile_pbf_url(x, y, z)
     
 
     def get_tile_json(self) -> Dict:

geobox/workflow.py

@@ -242,8 +242,7 @@ class Workflow(Base):
             >>> workflow.thumbnail
             'https://example.com/thumbnail.png'
         """
-        endpoint = f"{self.api.base_url}{self.endpoint}thumbnail.png"
-        return endpoint
+        return super().thumbnail()
     
 
     def share(self, users: List['User']) -> None:

{geobox-1.3.2.dist-info → geobox-1.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geobox
-Version: 1.3.2
+Version: 1.3.4
 Summary: SDK for Geobox's APIs
 Author-email: Hamid Heydari <heydari.h62@gmail.com>
 License: MIT
@@ -31,6 +31,8 @@ Geobox® is a cloud-based GIS platform that enables users (local governments, co
 
 Geobox python SDK provides seamless integration with the Geobox API, enabling developers to work with geospatial data and services programmatically. This comprehensive toolkit empowers applications to leverage advanced geospatial capabilities including data management and analysis.
 
+[Here](https://geobox.readthedocs.io) you can find the official documentation for Geobox Python SDK.
+
 Installation
 ============
 

geobox-1.3.4.dist-info/RECORD

@@ -0,0 +1,37 @@
+geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
+geobox/api.py,sha256=spbIWSeYCml_rmiisDLQjFcvm6I_UJGobUJm9H-Z9sQ,100719
+geobox/apikey.py,sha256=FBio1PtGovAUaTE0HW9IJ55UuFdR_1ICk_FQhHu5dAE,7427
+geobox/attachment.py,sha256=qplcYfHkoV9aHaXQ7xFnkrsYxwmUs0PNPbjoSerET34,11582
+geobox/base.py,sha256=OdabLbBflglLkNWM7TGCWtPh73M_-42_Ph963K26JQg,12931
+geobox/basemap.py,sha256=7Jo2MeEN8U8Av54kPPaFzQFjajcNYgMRMOTZXPUcXyk,4529
+geobox/dashboard.py,sha256=x99jUGzUJra4cdcffSYC0_FvrihZh6sPI4o79f-Aptc,11694
+geobox/enums.py,sha256=mGF6eXQlNHcUXV0AVMolI200a__g-S9wMjQ1p4ka28g,6244
+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=Ula8r8pZaCmifsnUHDbaJujw53SLxUiCiBzVS358o88,19967
+geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
+geobox/map.py,sha256=6pyD4rpw-Z9DIuvVg66UCBsPk30eCt0b1cIjVBxA_1Q,31348
+geobox/model3d.py,sha256=8P7_Yj1JvumCHWqMxgUmIvQvsKs5tSjI1vf00AItyHQ,11901
+geobox/mosaic.py,sha256=6wSK9xkjtBUEtIsZANWVYwsJbDx112mO1SQOXcPTVo8,23780
+geobox/plan.py,sha256=_ZV9F6loG92uQZGJl_9T08Kg85g3hnODmpccSkTYVdw,11193
+geobox/query.py,sha256=FqeiZf2E4tJ2FG-mIfRKov6H1QWUrMSErVpNWcb3Wx0,24038
+geobox/raster.py,sha256=Gt2bHb8NYm-8JkJlFm4-VccihcfZQzhQA8hPc3xzfvI,29934
+geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
+geobox/scene.py,sha256=GEzvWB-l-xO-8IodwFAPt4T7lZxuzEKJ1H0cqfx78W4,11301
+geobox/settings.py,sha256=rGRdM18Vo7xnjfZXPLRMbKeoVC_lZmzkNRPS0SQv05o,5660
+geobox/task.py,sha256=eLMgbhcYTADooWqKDPh6Jlh5S5oqxMMKoYIm0YPVZvg,13519
+geobox/tile3d.py,sha256=5z6zOihHiwCDizP_9Zwsm87gkTMljm9rQ8hFpAUkA10,10398
+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/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
+geobox/view.py,sha256=ZNJNBQclM6fc0cxXmU_L_XEBwd4lbsEncs6ynxWU9lc,37531
+geobox/workflow.py,sha256=7Ne_42-nG88_Po-OAK0ChWkfrknxJiPW6JFiElTwh3Q,11547
+geobox-1.3.4.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
+geobox-1.3.4.dist-info/METADATA,sha256=r4Bk6des4BDQI3KU3Kmt1rFhXQGSkYwiOVCgGRMvPPI,2658
+geobox-1.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geobox-1.3.4.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
+geobox-1.3.4.dist-info/RECORD,,

geobox-1.3.2.dist-info/RECORD

@@ -1,37 +0,0 @@
-geobox/__init__.py,sha256=iRkJAFIjMXiAaLTVXvZcW5HM7ttyipGdxFZ15NCM8qU,1895
-geobox/api.py,sha256=v-_Vay_xIXZRG3-0ahiOWxVT9QkrIyuOcd2KYFyVK04,100795
-geobox/apikey.py,sha256=FBio1PtGovAUaTE0HW9IJ55UuFdR_1ICk_FQhHu5dAE,7427
-geobox/attachment.py,sha256=XbGwfWWuFAMimj4tsjKBvlSLP-rhpNACCtxgRmUvcdY,11631
-geobox/base.py,sha256=p0UVZo9CINw0mW9o0nNR_VNCk7V1r-FrLQ_NH39WARE,12299
-geobox/basemap.py,sha256=fDWwkMf-F2NTE1tVLijoxQku55825b6gj8nk69TMOII,4386
-geobox/dashboard.py,sha256=MYyT3YJEGPCbTXHcYoZmn14rFOaut1J3idEA8bCdFgI,11762
-geobox/enums.py,sha256=eYD-SVXCSp4l08DlxymJTqYzTLouRziWhLZd7letnTM,6317
-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=Ula8r8pZaCmifsnUHDbaJujw53SLxUiCiBzVS358o88,19967
-geobox/log.py,sha256=ZTmVErhyAszf7M5YFxT5mqXNNDGPnRwXPeGLDS1G6PE,3582
-geobox/map.py,sha256=RjuhbOVQN-OBwjBtO46AosB_Ta348EA1nExBdnxH3nw,31252
-geobox/model3d.py,sha256=qRYCx-q9LpGhdu5oz3av0uUoiDimuk4BvXXwMW5bo9Q,12061
-geobox/mosaic.py,sha256=feBRsAgvhl0tKoghfZiQsxFntS7skAnzEYYuU4GKbP0,23672
-geobox/plan.py,sha256=_ZV9F6loG92uQZGJl_9T08Kg85g3hnODmpccSkTYVdw,11193
-geobox/query.py,sha256=KHUKx3vbdkwBQYsb9Lg9D3eHBEBFVVtqehqkd31mmjU,24216
-geobox/raster.py,sha256=ex2nUiMGwGN-9Zp3-Fotj9Z2noJRkyDf4-ZhwIponHw,29459
-geobox/route.py,sha256=cKZTTHBHM8woWbhHIpCvrRX_doJcTkGktouee0z7oG0,2723
-geobox/scene.py,sha256=Sz2tiyJk-bXYjktfcp1d2gGrW3gt2T4D1FAMoRHOCng,11369
-geobox/settings.py,sha256=rGRdM18Vo7xnjfZXPLRMbKeoVC_lZmzkNRPS0SQv05o,5660
-geobox/task.py,sha256=eLMgbhcYTADooWqKDPh6Jlh5S5oqxMMKoYIm0YPVZvg,13519
-geobox/tile3d.py,sha256=MHDoj2OIUf3VMQtq7ysrayh8njAPSgwgPJCm4ySEB7A,10472
-geobox/tileset.py,sha256=F_oEV0TERMc2seLcYNu-i_TF4MNSdXPUWcxBCSR8aFw,22242
-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=yK_5ZD7eBAbRV2ruZCMptCtNU-S0AMvsAFiGIcLf3LQ,52853
-geobox/version.py,sha256=0GLPhxCeEb2bAkdpPJWtXPXc1KP6kQ_TOMwLAL0ldo0,9374
-geobox/view.py,sha256=sIi6Mi7NUAX5gN83cpubD3l7AcZ-1g5kG2NKHeVeW-g,37518
-geobox/workflow.py,sha256=6hKnSw4G0_ZlgmUb0g3fxT-UVsFbiYpF2FbEO5fpQv0,11606
-geobox-1.3.2.dist-info/licenses/LICENSE,sha256=AvFB7W94sJYKLDhBxLRshL3upexCOG8HQY_1JibB96w,1063
-geobox-1.3.2.dist-info/METADATA,sha256=Upop-Ls1kfz5xjJKkxZ9WTKJqZEepRFc-4vptsZ7A70,2556
-geobox-1.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geobox-1.3.2.dist-info/top_level.txt,sha256=ppXH8Bu2mlB-pLQ6lsoWEm2Gr6wZx1uzkhetsYA5ins,7
-geobox-1.3.2.dist-info/RECORD,,