smartsheet-python-sdk 4.0.2__tar.gz → 4.1.0__tar.gz

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet-python-sdk
-Version: 4.0.2
+Version: 4.1.0
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 License-Expression: Apache-2.0
 License-File: LICENSE.md

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/folders.py

@@ -23,7 +23,7 @@ import logging
 import os.path
 
 from .util import fresh_operation
-from .models import Error, Folder, PaginatedChildrenResult, Result, Sheet
+from .models import Error, Folder, FolderPathNode, PaginatedChildrenResult, Result, Sheet
 
 
 class Folders:
@@ -245,6 +245,26 @@ class Folders:
 
         return response
 
+    def get_folder_path(self, folder_id: int) -> Union[FolderPathNode, Error]:
+        """Get the hierarchical path of a folder.
+
+        Args:
+            folder_id (int): Folder ID
+
+        Returns:
+            Union[FolderPathNode, Error]: A FolderPathNode object describing the folder's
+                location, or an Error object if the request fails.
+        """
+        _op = fresh_operation("get_folder_path")
+        _op["method"] = "GET"
+        _op["path"] = "/folders/" + str(folder_id) + "/path"
+
+        expected = "FolderPathNode"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def get_folder_children(
             self,
             folder_id,

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/models/__init__.py

@@ -131,6 +131,12 @@ from .webhook_subscope import WebhookSubscope
 from .widget import Widget
 from .widget_content import WidgetContent
 from .workspace import Workspace
+from .path_node import PathNode
+from .path_leaf import PathLeaf
+from .folder_path_node import FolderPathNode
+from .sheet_path_node import SheetPathNode
+from .report_path_node import ReportPathNode
+from .sight_path_node import SightPathNode
 from .user_plan import UserPlan
 from .asset_shares_paginated_result import AssetSharesPaginatedResult
 from .asset_share import AssetShare

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/models/enums/publish_accessible_by.py

@@ -20,3 +20,4 @@ from enum import Enum
 class PublishAccessibleBy(Enum):
     ALL = 1
     ORG = 2
+    SHARED = 3

smartsheet_python_sdk-4.1.0/smartsheet/models/folder_path_node.py

@@ -0,0 +1,67 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import TypedList
+from ..util import deserialize
+from .path_node import PathNode
+
+
+class FolderPathNode(PathNode):
+
+    """Node in a folder path response. Contains recursive folders leading to the target folder."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the FolderPathNode model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        self._folders = TypedList(FolderPathNode)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(value)
+
+    def get_leaf_folder(self):
+        """Return the deepest FolderPathNode reachable from this node."""
+        if self.folders:
+            return self.folders[0].get_leaf_folder()
+        return self
+
+    def get_leaf_folder_path(self):
+        """Return a Unix-style path string of folder names from this node to the target folder.
+
+        Unlike get_sheet_path/get_report_path/get_sight_path, this method returns the
+        deepest folder's name even when the root node has no name (e.g. a workspace root),
+        because the target IS a folder rather than an asset nested inside one. An empty
+        FolderPathNode (no id, no name, no children) returns an empty string.
+
+        Example: '/Workspace/Folder/TargetFolder'
+        """
+
+        if not self.name:
+            return None
+        if self.folders:
+            return f"/{self.name}{self.folders[0].get_leaf_folder_path()}"
+        return f"/{self.name}"

smartsheet_python_sdk-4.1.0/smartsheet/models/path_leaf.py

@@ -0,0 +1,53 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import Timestamp
+from ..util import deserialize
+from .path_node import PathNode
+
+
+class PathLeaf(PathNode):
+
+    """Terminal asset node in a Smartsheet path response (sheet, report, sight, or target folder)."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the PathLeaf model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        self._created_at = Timestamp()
+        self._modified_at = Timestamp()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def created_at(self):
+        return self._created_at.value
+
+    @created_at.setter
+    def created_at(self, value):
+        self._created_at.value = value
+
+    @property
+    def modified_at(self):
+        return self._modified_at.value
+
+    @modified_at.setter
+    def modified_at(self, value):
+        self._modified_at.value = value

smartsheet_python_sdk-4.1.0/smartsheet/models/path_node.py

@@ -0,0 +1,84 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import EnumeratedValue, Number, String, json
+from ..util import deserialize, serialize
+from .enums import AccessLevel
+
+
+class PathNode:
+    """Base node in a Smartsheet path response (workspace root or intermediate folder)."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the PathNode model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._id = Number()
+        self._name = String()
+        self._permalink = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def access_level(self):
+        return self._access_level
+
+    @access_level.setter
+    def access_level(self, value):
+        self._access_level.set(value)
+
+    @property
+    def id(self):
+        return self._id.value
+
+    @id.setter
+    def id(self, value):
+        self._id.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def permalink(self):
+        return self._permalink.value
+
+    @permalink.setter
+    def permalink(self, value):
+        self._permalink.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet_python_sdk-4.1.0/smartsheet/models/report_path_node.py

@@ -0,0 +1,72 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import TypedList
+from ..util import deserialize
+from .path_leaf import PathLeaf
+from .path_node import PathNode
+
+
+class ReportPathNode(PathNode):
+
+    """Node in a report path response. Contains recursive folders leading to the target report."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ReportPathNode model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        self._folders = TypedList(ReportPathNode)
+        self._reports = TypedList(PathLeaf)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(value)
+
+    @property
+    def reports(self):
+        return self._reports
+
+    @reports.setter
+    def reports(self, value):
+        self._reports.load(value)
+
+    def get_leaf_report(self):
+        """Return the target PathLeaf report, or None if not reachable."""
+        if self.reports:
+            return self.reports[0]
+        if self.folders:
+            return self.folders[0].get_leaf_report()
+        return None
+
+    def get_leaf_report_path(self):
+        """Return a Unix-style path string from this node to the target report.
+            Example: '/Workspace/Folder/Report'
+        """
+        if self.reports:
+            return f"/{self.name}/{self.reports[0].name}"
+        if self.folders:
+            return f"/{self.name}{self.folders[0].get_leaf_report_path()}"
+        return None

smartsheet_python_sdk-4.1.0/smartsheet/models/sheet_path_node.py

@@ -0,0 +1,72 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import TypedList
+from ..util import deserialize
+from .path_leaf import PathLeaf
+from .path_node import PathNode
+
+
+class SheetPathNode(PathNode):
+
+    """Node in a sheet path response. Contains recursive folders leading to the target sheet."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetPathNode model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        self._folders = TypedList(SheetPathNode)
+        self._sheets = TypedList(PathLeaf)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(value)
+
+    @property
+    def sheets(self):
+        return self._sheets
+
+    @sheets.setter
+    def sheets(self, value):
+        self._sheets.load(value)
+
+    def get_leaf_sheet(self):
+        """Return the target PathLeaf sheet, or None if not reachable."""
+        if self.sheets:
+            return self.sheets[0]
+        if self.folders:
+            return self.folders[0].get_leaf_sheet()
+        return None
+
+    def get_leaf_sheet_path(self):
+        """Return a Unix-style path string from this node to the target sheet.
+            Example: '/Workspace/Folder/Sheet'
+        """
+        if self.sheets:
+            return f"/{self.name}/{self.sheets[0].name}"
+        if self.folders:
+            return f"/{self.name}{self.folders[0].get_leaf_sheet_path()}"
+        return None

smartsheet_python_sdk-4.1.0/smartsheet/models/sight_path_node.py

@@ -0,0 +1,72 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+from ..types import TypedList
+from ..util import deserialize
+from .path_leaf import PathLeaf
+from .path_node import PathNode
+
+
+class SightPathNode(PathNode):
+
+    """Node in a sight path response. Contains recursive folders leading to the target sight."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SightPathNode model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        self._folders = TypedList(SightPathNode)
+        self._sights = TypedList(PathLeaf)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(value)
+
+    @property
+    def sights(self):
+        return self._sights
+
+    @sights.setter
+    def sights(self, value):
+        self._sights.load(value)
+
+    def get_leaf_sight(self):
+        """Return the target PathLeaf sight, or None if not reachable."""
+        if self.sights:
+            return self.sights[0]
+        if self.folders:
+            return self.folders[0].get_leaf_sight()
+        return None
+
+    def get_leaf_sight_path(self):
+        """Return a Unix-style path string from this node to the target sight.
+            Example: '/Workspace/Folder/Sight'
+        """
+        if self.sights:
+            return f"/{self.name}/{self.sights[0].name}"
+        if self.folders:
+            return f"/{self.name}{self.folders[0].get_leaf_sight_path()}"
+        return None

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/reports.py

@@ -35,6 +35,7 @@ from .models import (
     ReportDefinition,
     ReportPublish,
     ReportScopeInclusion,
+    ReportPathNode,
     Result,
 )
 
@@ -160,6 +161,26 @@ class Reports:
 
         return response
 
+    def get_report_path(self, report_id: int) -> Union[ReportPathNode, Error]:
+        """Get the hierarchical path of a report.
+
+        Args:
+            report_id (int): Report ID
+
+        Returns:
+            Union[ReportPathNode, Error]: A ReportPathNode object describing the report's
+                location, or an Error object if the request fails.
+        """
+        _op = fresh_operation("get_report_path")
+        _op["method"] = "GET"
+        _op["path"] = "/reports/" + str(report_id) + "/path"
+
+        expected = "ReportPathNode"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def get_report_as_csv(self, report_id, download_path, alternate_file_name=None) -> Union[DownloadedFile, Error]:
         """Get the specified Report as a CSV file.
 

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/sheets.py

@@ -27,7 +27,7 @@ import six
 from .util import fresh_operation
 from .models import AutomationRule, BulkItemResult, Column, CopyOrMoveRowResult, CrossSheetReference, DownloadedFile, \
     IndexResult, NumberObjectValue, Result, Row, SearchResult, SentUpdateRequest, Sheet, SheetFilter, \
-    SheetPublish, SheetSummary, SummaryField, UpdateRequest, Version, Error
+    SheetPathNode, SheetPublish, SheetSummary, SummaryField, UpdateRequest, Version, Error
 from .types import TypedList
 from .util import deprecated
 
@@ -523,6 +523,26 @@ class Sheets:
 
         return response
 
+    def get_sheet_path(self, sheet_id: int) -> Union[SheetPathNode, Error]:
+        """Get the hierarchical path of a sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+
+        Returns:
+            Union[SheetPathNode, Error]: A SheetPathNode object describing the sheet's
+                location, or an Error object if the request fails.
+        """
+        _op = fresh_operation("get_sheet_path")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/path"
+
+        expected = "SheetPathNode"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def get_sheet_as_csv(self, sheet_id, download_path, alternate_file_name=None) -> Union[DownloadedFile, Error]:
         """Get the specified Sheet as a CSV file.
 

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/sights.py

@@ -19,7 +19,7 @@ import logging
 from typing import Optional, Union
 
 from .util import fresh_operation
-from .models import Error, Result, Sight, SightPublish, TokenPaginatedResult
+from .models import Error, Result, Sight, SightPathNode, SightPublish, TokenPaginatedResult
 
 
 class Sights:
@@ -88,6 +88,26 @@ class Sights:
 
         return response
 
+    def get_sight_path(self, sight_id: int) -> Union[SightPathNode, Error]:
+        """Get the hierarchical path of a sight.
+
+        Args:
+            sight_id (int): Sight ID
+
+        Returns:
+            Union[SightPathNode, Error]: A SightPathNode object describing the Sight's
+                location, or an Error object if the request fails.
+        """
+        _op = fresh_operation("get_sight_path")
+        _op["method"] = "GET"
+        _op["path"] = "/sights/" + str(sight_id) + "/path"
+
+        expected = "SightPathNode"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def update_sight(self, sight_id, sight_obj) -> Union[Result[Sight], Error]:
         """Updates the specified Sight.
 

{smartsheet_python_sdk-4.0.2 → smartsheet_python_sdk-4.1.0}/smartsheet/version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '4.0.2'
-__version_tuple__ = version_tuple = (4, 0, 2)
+__version__ = version = '4.1.0'
+__version_tuple__ = version_tuple = (4, 1, 0)
 
 __commit_id__ = commit_id = None