smartsheet-python-sdk 3.9.0__tar.gz → 4.0.1__tar.gz

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/.gitignore

@@ -33,3 +33,14 @@ smartsheet/version.py
 
 # ignore ugly batch files
 *.bat
+
+# ignore uv virtual environment
+.venv
+# Sphinx auto-generated files
+docs-source/modules.rst
+docs-source/smartsheet*.rst
+# Claude Code settings
+.claude/settings.local.json
+# Superpowers documentation
+docs/superpowers
+.DS_Store

{smartsheet_python_sdk-3.9.0/smartsheet_python_sdk.egg-info → smartsheet_python_sdk-4.0.1}/PKG-INFO

@@ -1,8 +1,10 @@
 Metadata-Version: 2.4
 Name: smartsheet-python-sdk
-Version: 3.9.0
+Version: 4.0.1
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 License-Expression: Apache-2.0
+License-File: LICENSE.md
+License-File: NOTICE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
@@ -17,39 +19,35 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3.15
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-License-File: NOTICE
+Requires-Dist: certifi
+Requires-Dist: python-dateutil
 Requires-Dist: requests
 Requires-Dist: requests-toolbelt
 Requires-Dist: six>=1.9
-Requires-Dist: certifi
-Requires-Dist: python-dateutil
-Provides-Extra: test
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: coveralls; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-rerunfailures; extra == "test"
-Requires-Dist: requests-toolbelt; extra == "test"
 Provides-Extra: develop
-Requires-Dist: coverage; extra == "develop"
-Requires-Dist: coveralls[yaml]; extra == "develop"
-Requires-Dist: pytest; extra == "develop"
-Requires-Dist: pytest-instafail; extra == "develop"
-Requires-Dist: pylint; extra == "develop"
+Requires-Dist: coverage; extra == 'develop'
+Requires-Dist: coveralls[yaml]; extra == 'develop'
+Requires-Dist: pylint; extra == 'develop'
+Requires-Dist: pytest; extra == 'develop'
+Requires-Dist: pytest-instafail; extra == 'develop'
 Provides-Extra: docs
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: setuptools_scm; extra == "docs"
+Requires-Dist: setuptools-scm; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
 Provides-Extra: packaging
-Requires-Dist: wheel; extra == "packaging"
-Requires-Dist: twine; extra == "packaging"
-Requires-Dist: gitchangelog; extra == "packaging"
-Requires-Dist: mako; extra == "packaging"
-Dynamic: license-file
+Requires-Dist: gitchangelog; extra == 'packaging'
+Requires-Dist: mako; extra == 'packaging'
+Requires-Dist: wheel; extra == 'packaging'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: coveralls; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-rerunfailures; extra == 'test'
+Requires-Dist: requests-toolbelt; extra == 'test'
+Description-Content-Type: text/markdown
 
 # Smartsheet Python SDK
 

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/pyproject.toml

@@ -1,6 +1,18 @@
 [build-system]
-requires = ["setuptools>=61.0", "setuptools_scm>=7.0.1"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "smartsheet/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["smartsheet"]
+
+[tool.hatch.build.targets.sdist]
+include = ["smartsheet"]
 
 [project]
 name = "smartsheet-python-sdk"
@@ -58,14 +70,10 @@ docs = [
 ]
 packaging = [
     "wheel",
-    "twine",
     "gitchangelog",
     "mako"
 ]
 
-[tool.setuptools_scm]
-write_to = "smartsheet/version.py"
-
 [tool.pytest.ini_options]
 addopts = "-ra --color=yes --showlocals --verbose --ignore=docs --ignore=examples --tb=native"
 log_cli = true

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/folders.py

@@ -23,8 +23,7 @@ import logging
 import os.path
 
 from .util import fresh_operation
-from .models import Error, Folder, IndexResult, PaginatedChildrenResult, Result, Sheet
-from .util import deprecated
+from .models import Error, Folder, PaginatedChildrenResult, Result, Sheet
 
 
 class Folders:
@@ -176,65 +175,6 @@ class Folders:
 
         return response
 
-    @deprecated
-    def get_folder(self, folder_id, include=None) -> Union[Folder, Error]:
-        """Get the specified Folder (and list its contents).
-
-        Deprecated: 3.1.0
-           Use `get_folder_metadata` and `get_folder_children` instead.
-
-        Args:
-            folder_id (int): Folder ID
-            include (list[str]): A comma-separated list of
-                optional elements to include in the response. Valid list
-                values: ownerInfo, sheetVersion, source.
-
-        Returns:
-            Union[Folder, Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("get_folder")
-        _op["method"] = "GET"
-        _op["path"] = "/folders/" + str(folder_id)
-        _op["query_params"]["include"] = include
-
-        expected = "Folder"
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
-    @deprecated
-    def list_folders(self, folder_id, page_size=None, page=None, include_all=None) -> Union[IndexResult[Folder], Error]:
-        """Get a list of top-level child Folders within the specified Folder.
-
-        Deprecated: 3.1.0
-           Use `get_folder_children` with children_resource_types=['folders'] instead.
-
-        Args:
-            folder_id (int): Folder ID
-            page_size (int): The maximum number of items to
-                return per page.
-            page (int): Which page to return.
-            include_all (bool): If true, include all results
-                (i.e. do not paginate).
-
-        Returns:
-            Union[IndexResult[Folder], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("list_folders")
-        _op["method"] = "GET"
-        _op["path"] = "/folders/" + str(folder_id) + "/folders"
-        _op["query_params"]["pageSize"] = page_size
-        _op["query_params"]["page"] = page
-        _op["query_params"]["includeAll"] = include_all
-
-        expected = ["IndexResult", "Folder"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def move_folder(self, folder_id, container_destination_obj) -> Union[Result[Folder], Error]:
         """Moves the specified Folder to another location.
 

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/__init__.py

@@ -104,7 +104,6 @@ from .search_result import SearchResult
 from .search_result_item import SearchResultItem
 from .sent_update_request import SentUpdateRequest
 from .server_info import ServerInfo
-from .share import Share
 from .sheet import Sheet
 from .sheet_email import SheetEmail
 from .sheet_filter import SheetFilter

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/create_report_result.py

@@ -65,7 +65,7 @@ class CreateReportResult:
 
     @property
     def access_level(self):
-        return self._access_level.value
+        return self._access_level
 
     @access_level.setter
     def access_level(self, value) -> None:

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/event.py

@@ -38,6 +38,7 @@ class Event:
         self._event_id = String()
         self._event_timestamp = None
         self._object_id = None
+        self._object_id_str = String()
         self._object_type = EnumeratedValue(EventObjectType)
         self._request_user_id = Number()
         self._source = EnumeratedValue(EventSource)
@@ -111,6 +112,14 @@ class Event:
     def object_id(self, value):
         self._object_id = value
 
+    @property
+    def object_id_str(self):
+        return self._object_id_str.value
+
+    @object_id_str.setter
+    def object_id_str(self, value):
+        self._object_id_str.value = value
+
     @property
     def object_type(self):
         return self._object_type

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/report_destination.py

@@ -48,7 +48,7 @@ class ReportDestination:
 
     @property
     def destination_type(self):
-        return self._destination_type.value
+        return self._destination_type
 
     @destination_type.setter
     def destination_type(self, value):

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/report_scope_inclusion.py

@@ -48,7 +48,7 @@ class ReportScopeInclusion:
 
     @property
     def asset_type(self) -> ReportAssetType:
-        return self._asset_type.value
+        return self._asset_type
 
     @asset_type.setter
     def asset_type(self, value):

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/models/sheet.py

@@ -385,40 +385,6 @@ class Sheet:
     def get_version(self):
         return self._base.Sheets.get_sheet_version(self.id)
 
-    def list_shares(
-        self,
-        page_size=100,
-        page=1,
-        include_all=False,
-        include_workspace_shares=False,
-        access_api_level=0,
-    ):
-        return self._base.Sheets.list_shares(
-            self.id,
-            page_size,
-            page,
-            include_all,
-            include_workspace_shares,
-            access_api_level,
-        )
-
-    def share(self, share_obj, send_email=False):
-        return self._base.Sheets.share_sheet(self.id, share_obj, send_email)
-
-    def shares(self, page_size=100, page=1, include_all=False):
-        return self._base.Sheets.list_shares(
-            self.id, page_size=100, page=1, include_all=False
-        )
-
-    def update_share(self, share_id, share_obj):
-        return self._base.Sheets.update_share(self.id, share_id, share_obj)
-
-    def get_share(self, share_id):
-        return self._base.Sheets.get_share(self.id, share_id)
-
-    def delete_share(self, share_id):
-        return self._base.Sheets.delete_share(self.id, share_id)
-
     def update_name(self, new_name):
         return self._base.Sheets.update_sheet(self.id, Sheet({"name": new_name}))
 

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/reports.py

@@ -36,7 +36,6 @@ from .models import (
     ReportPublish,
     ReportScopeInclusion,
     Result,
-    Share,
 )
 
 
@@ -79,26 +78,6 @@ class Reports:
 
         return response
 
-    def delete_share(self, report_id, share_id) -> Union[Result[None], Error]:
-        """Deletes the specified Share
-
-        Args:
-            report_id (int): Report ID
-            share_id (str): Share ID
-
-        Returns:
-            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("delete_share")
-        _op["method"] = "DELETE"
-        _op["path"] = "/reports/" + str(report_id) + "/shares/" + str(share_id)
-
-        expected = ["Result", None]
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def delete_report(self, report_id) -> Union[Result[None], Error]:
         """Deletes a report based on the specified ID
 
@@ -243,26 +222,6 @@ class Reports:
         response.save_to_file()
         return response
 
-    def get_share(self, report_id, share_id) -> Union[Share, Error]:
-        """Get the specified Share.
-
-        Args:
-            report_id (int): Report ID
-            share_id (str): Share ID
-
-        Returns:
-            Union[Share, Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("get_share")
-        _op["method"] = "GET"
-        _op["path"] = "/reports/" + str(report_id) + "/shares/" + str(share_id)
-
-        expected = "Share"
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def list_reports(
         self, page_size=None, page=None, include_all=None, modified_since=None
     ) -> Union[IndexResult[Report], Error]:
@@ -298,45 +257,6 @@ class Reports:
 
         return response
 
-    def list_shares(
-        self,
-        report_id,
-        page_size=None,
-        page=None,
-        include_all=None,
-        include_workspace_shares=False,
-    ) -> Union[IndexResult[Share], Error]:
-        """Get a list of all Users and Groups to whom the specified Report is
-        shared, and their access level.
-
-        Args:
-            report_id (int): Report ID
-            page_size (int): The maximum number of items to
-                return per page.
-            page (int): Which page to return.
-            include_all (bool): If true, include all results
-                (i.e. do not paginate).
-            include_workspace_shares(bool): include Workspace shares
-
-        Returns:
-            Union[IndexResult[Share], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("list_shares")
-        _op["method"] = "GET"
-        _op["path"] = "/reports/" + str(report_id) + "/shares"
-        _op["query_params"]["pageSize"] = page_size
-        _op["query_params"]["page"] = page
-        _op["query_params"]["includeAll"] = include_all
-        if include_workspace_shares:
-            _op["query_params"]["include"] = "workspaceShares"
-
-        expected = ["IndexResult", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def send_report(self, report_id, sheet_email_obj) -> Union[Result[None], Error]:
         """Send the specified Report as a PDF attachment via email to the
         designated recipients.
@@ -359,60 +279,6 @@ class Reports:
 
         return response
 
-    def share_report(self, report_id, share_obj, send_email=False) -> Union[Result[Share], Error]:
-        """Shares a Report with the specified Users and Groups.
-
-        Args:
-            report_id (int): Report ID
-            share_obj (Share): Share object.
-            send_email (bool): Either true or false to
-                indicate whether or not to notify the user by email. Default
-                is false.
-
-        Returns:
-            Union[Result[Share], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("share_report")
-        _op["method"] = "POST"
-        _op["path"] = "/reports/" + str(report_id) + "/shares"
-        _op["query_params"]["sendEmail"] = send_email
-        _op["json"] = share_obj
-
-        expected = ["Result", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
-    def update_share(self, report_id, share_id, share_obj) -> Union[Result[Share], Error]:
-        """Update the access level of a User or Group for the specified Report
-
-        Args:
-            report_id (int): Report ID
-            share_id (str): Share ID
-            share_obj (Share): Share object.
-
-        Returns:
-            Union[Result[Share], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        if not all(val is not None for val in ["report_id", "share_id", "share_obj"]):
-            raise ValueError(
-                ("One or more required values are missing from call to " + __name__)
-            )
-
-        _op = fresh_operation("update_share")
-        _op["method"] = "PUT"
-        _op["path"] = "/reports/" + str(report_id) + "/shares/" + str(share_id)
-        _op["json"] = share_obj
-
-        expected = ["Result", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def get_publish_status(self, report_id) -> Union[ReportPublish, Error]:
         """Get the Publish status of the Report.
 

{smartsheet_python_sdk-3.9.0 → smartsheet_python_sdk-4.0.1}/smartsheet/sheets.py

@@ -26,7 +26,7 @@ import six
 
 from .util import fresh_operation
 from .models import AutomationRule, BulkItemResult, Column, CopyOrMoveRowResult, CrossSheetReference, DownloadedFile, \
-    IndexResult, NumberObjectValue, Result, Row, SearchResult, SentUpdateRequest, Share, Sheet, SheetFilter, \
+    IndexResult, NumberObjectValue, Result, Row, SearchResult, SentUpdateRequest, Sheet, SheetFilter, \
     SheetPublish, SheetSummary, SummaryField, UpdateRequest, Version, Error
 from .types import TypedList
 from .util import deprecated
@@ -310,30 +310,6 @@ class Sheets:
 
         return response
 
-    @deprecated
-    def delete_share(self, sheet_id, share_id) -> Union[Result[None], Error]:
-        """Delete the specified Share.
-
-        Args:
-            sheet_id (int): Sheet ID
-            share_id (str): Share ID
-
-        Returns:
-            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
-
-        Deprecated:
-            Use sharing.delete_share instead with assetType=AssetType.SHEET
-        """
-        _op = fresh_operation("delete_share")
-        _op["method"] = "DELETE"
-        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
-
-        expected = ["Result", None]
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def delete_sheet(self, sheet_id) -> Union[Result[None], Error]:
         """Delete the specified Sheet.
 
@@ -474,30 +450,6 @@ class Sheets:
 
         return response
 
-    @deprecated
-    def get_share(self, sheet_id, share_id) -> Union[Share, Error]:
-        """Get the specified Share.
-
-        Args:
-            sheet_id (int): Sheet ID
-            share_id (str): Share ID
-
-        Returns:
-            Union[Share, Error]: The result of the operation, or an Error object if the request fails.
-
-        Deprecated:
-            Use sharing.get_asset_share instead with assetType=AssetType.SHEET
-        """
-        _op = fresh_operation("get_share")
-        _op["method"] = "GET"
-        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
-
-        expected = "Share"
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def get_sheet(
         self,
         sheet_id,
@@ -708,47 +660,6 @@ class Sheets:
 
         return response
 
-    def list_shares(
-        self,
-        sheet_id,
-        page_size=None,
-        page=None,
-        include_all=None,
-        include_workspace_shares=False,
-        access_api_level=0,
-    ) -> Union[IndexResult[Share], Error]:
-        """Get the list of all Users and Groups to whom the specified Sheet is
-        shared, and their access level.
-
-        Args:
-            sheet_id (int): Sheet ID
-            page_size (int): The maximum number of items to
-                return per page.
-            page (int): Which page to return.
-            include_all (bool): If true, include all results
-                (i.e. do not paginate).
-            include_workspace_shares(bool): Include Workspace shares
-
-        Returns:
-            Union[IndexResult[Share], Error]: The result of the operation, or an Error object if the request fails.
-        """
-        _op = fresh_operation("list_shares")
-        _op["method"] = "GET"
-        _op["path"] = "/sheets/" + str(sheet_id) + "/shares"
-        _op["query_params"]["pageSize"] = page_size
-        _op["query_params"]["page"] = page
-        _op["query_params"]["includeAll"] = include_all
-        _op["query_params"]["accessApiLevel"] = access_api_level
-        if include_workspace_shares:
-            _op["query_params"]["include"] = "workspaceShares"
-
-        expected = ["IndexResult", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def list_sheets(
         self,
         include=None,
@@ -999,39 +910,6 @@ class Sheets:
 
         return response
 
-    @deprecated
-    def share_sheet(self, sheet_id, share_obj, send_email=None) -> Union[Result[Share], Error]:
-        """Share the specified Sheet.
-
-        Share the specified Sheet with the specified Users and
-        Groups.
-
-        Args:
-            sheet_id (int): Sheet ID
-            share_obj (Share): Share object.
-            send_email (bool): Either true or false to
-                indicate whether or not to notify the user by email. Default
-                is false.
-
-        Returns:
-            Union[Result[Share], Error]: The result of the operation, or an Error object if the request fails.
-
-        Deprecated:
-            Use sharing.share_asset instead with assetType=AssetType.SHEET
-        """
-        _op = fresh_operation("share_sheet")
-        _op["method"] = "POST"
-        _op["path"] = "/sheets/" + str(sheet_id) + "/shares"
-        _op["json"] = share_obj
-        _op["query_params"]["sendEmail"] = send_email
-
-        expected = ["Result", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def update_column(self, sheet_id, column_id, column_obj) -> Union[Result[Column], Error]:
         """Update properties of the specified Column.
 
@@ -1132,38 +1010,6 @@ class Sheets:
 
         return response
 
-    @deprecated
-    def update_share(self, sheet_id, share_id, share_obj) -> Union[Result[Share], Error]:
-        """Update the access level of a User or Group for the specified Sheet.
-
-        Args:
-            sheet_id (int): Sheet ID
-            share_id (str): Share ID
-            share_obj (Share): Share object.
-
-        Returns:
-            Union[Result[Share], Error]: The result of the operation, or an Error object if the request fails.
-
-        Deprecated:
-            Use sharing.update_share instead with assetType=AssetType.SHEET
-        """
-        if not all(val is not None for val in ["sheet_id", "share_id", "share_obj"]):
-            raise ValueError(
-                ("One or more required values are missing from call to " + __name__)
-            )
-
-        _op = fresh_operation("update_share")
-        _op["method"] = "PUT"
-        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
-        _op["json"] = share_obj
-
-        expected = ["Result", "Share"]
-
-        prepped_request = self._base.prepare_request(_op)
-        response = self._base.request(prepped_request, expected, _op)
-
-        return response
-
     def update_sheet(self, sheet_id, sheet_obj) -> Union[Result[Sheet], Error]:
         """Updates the specified Sheet.