smartsheet-python-sdk 3.6.0__tar.gz → 3.7.1__tar.gz

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [x.x.x] - Unreleased
 
+## [3.7.1] - 2025-12-12
+
+### Fixed
+
+- Update correct method types, which may return either list or a singleton object
+
+## [3.7.0] - 2025-12-11
+
+### Added
+
+- Typing to all SDK service methods
+
 ## [3.6.0] - 2025-12-04
 
 ### Added

{smartsheet_python_sdk-3.6.0/smartsheet_python_sdk.egg-info → smartsheet_python_sdk-3.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet-python-sdk
-Version: 3.6.0
+Version: 3.7.1
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 License-Expression: Apache-2.0
 Classifier: Development Status :: 5 - Production/Stable

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/smartsheet/attachments.py

@@ -19,11 +19,12 @@ from __future__ import absolute_import
 
 import logging
 import os.path
+from typing import Union
 
 import requests
 
 from .util import fresh_operation
-from .models import DownloadedFile, Error, ErrorResult
+from .models import Attachment, DownloadedFile, Error, ErrorResult, IndexResult, Result
 
 
 class Attachments:
@@ -35,7 +36,7 @@ class Attachments:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def attach_file_to_comment(self, sheet_id, comment_id, _file):
+    def attach_file_to_comment(self, sheet_id, comment_id, _file) -> Union[Result[Attachment], Error]:
         """Add a file to a Comment.
 
         Args:
@@ -44,7 +45,7 @@ class Attachments:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "comment_id", "_file"]):
             raise ValueError(
@@ -66,7 +67,7 @@ class Attachments:
 
         return response
 
-    def attach_file_to_row(self, sheet_id, row_id, _file):
+    def attach_file_to_row(self, sheet_id, row_id, _file) -> Union[Result[Attachment], Error]:
         """Add a file to the row.
 
         Args:
@@ -75,7 +76,7 @@ class Attachments:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "row_id", "_file"]):
             raise ValueError(
@@ -97,7 +98,7 @@ class Attachments:
 
         return response
 
-    def attach_file_to_sheet(self, sheet_id, _file):
+    def attach_file_to_sheet(self, sheet_id, _file) -> Union[Result[Attachment], Error]:
         """Attach a file to the specified Sheet.
 
         Args:
@@ -105,7 +106,7 @@ class Attachments:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("attach_file_to_sheet")
         _op["method"] = "POST"
@@ -120,7 +121,7 @@ class Attachments:
 
         return response
 
-    def attach_new_version(self, sheet_id, attachment_id, _file):
+    def attach_new_version(self, sheet_id, attachment_id, _file) -> Union[Result[Attachment], Error]:
         """Upload a new version of a file to a Sheet or Row.
 
         Args:
@@ -129,7 +130,7 @@ class Attachments:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "attachment_id", "_file"]):
             raise ValueError(
@@ -155,7 +156,7 @@ class Attachments:
 
         return response
 
-    def attach_url_to_comment(self, sheet_id, comment_id, attachment_obj):
+    def attach_url_to_comment(self, sheet_id, comment_id, attachment_obj) -> Union[Result[Attachment], Error]:
         """Add a URL to a Comment.
 
         Attachment object for this request should be limited to the
@@ -185,7 +186,7 @@ class Attachments:
             attachment_obj (Attachment): Attachment object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(
             val is not None for val in ["sheet_id", "comment_id", "attachment_obj"]
@@ -208,7 +209,7 @@ class Attachments:
 
         return response
 
-    def attach_url_to_row(self, sheet_id, row_id, attachment_obj):
+    def attach_url_to_row(self, sheet_id, row_id, attachment_obj) -> Union[Result[Attachment], Error]:
         """Add a URL to a Row.
 
         Attachment object for this request should be limited to the
@@ -238,7 +239,7 @@ class Attachments:
             attachment_obj (Attachment): Attachment object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "row_id", "attachment_obj"]):
             raise ValueError(
@@ -259,7 +260,7 @@ class Attachments:
 
         return response
 
-    def attach_url_to_sheet(self, sheet_id, attachment_obj):
+    def attach_url_to_sheet(self, sheet_id, attachment_obj) -> Union[Result[Attachment], Error]:
         """Add a URL to a Sheet.
 
         Attachment object for this request should be limited to the
@@ -288,7 +289,7 @@ class Attachments:
             attachment_obj (Attachment): Attachment object.
 
         Returns:
-            Result
+            Union[Result[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("attach_url_to_sheet")
         _op["method"] = "POST"
@@ -302,7 +303,7 @@ class Attachments:
 
         return response
 
-    def delete_attachment(self, sheet_id, attachment_id):
+    def delete_attachment(self, sheet_id, attachment_id) -> Union[Result[None], Error]:
         """Delete the specified Attachment.
 
         Args:
@@ -310,7 +311,7 @@ class Attachments:
             attachment_id (int): Attachment ID
 
         Returns:
-            Result
+            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("delete_attachment")
         _op["method"] = "DELETE"
@@ -322,7 +323,7 @@ class Attachments:
 
         return response
 
-    def delete_attachment_versions(self, sheet_id, attachment_id):
+    def delete_attachment_versions(self, sheet_id, attachment_id) -> Union[Result[None], Error]:
         """Delete all versions of the specified Attachment.
 
         Delete all versions of the attachment corresponding to the
@@ -333,7 +334,7 @@ class Attachments:
             attachment_id (int): Attachment ID
 
         Returns:
-            Result
+            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("delete_attachment_versions")
         _op["method"] = "DELETE"
@@ -351,7 +352,7 @@ class Attachments:
 
         return response
 
-    def get_attachment(self, sheet_id, attachment_id):
+    def get_attachment(self, sheet_id, attachment_id) -> Union[Attachment, Error]:
         """Fetch the specified Attachment.
 
         Args:
@@ -359,7 +360,7 @@ class Attachments:
             attachment_id (int): Attachment ID
 
         Returns:
-            Attachment
+            Union[Attachment, Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_attachment")
         _op["method"] = "GET"
@@ -373,7 +374,7 @@ class Attachments:
 
     def list_all_attachments(
         self, sheet_id, page_size=None, page=None, include_all=None
-    ):
+    ) -> Union[IndexResult[Attachment], Error]:
         """Get a list of Attachments for a Sheet.
 
         Get a list of all Attachments for the specified Sheet,
@@ -388,7 +389,7 @@ class Attachments:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_all_attachments")
         _op["method"] = "GET"
@@ -406,7 +407,7 @@ class Attachments:
 
     def list_attachment_versions(
         self, sheet_id, attachment_id, page_size=None, page=None, include_all=None
-    ):
+    ) -> Union[IndexResult[Attachment], Error]:
         """Get a list of versions for an Attachment.
 
         Get a list of all versions of the given Attachment ID, in
@@ -422,7 +423,7 @@ class Attachments:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_attachment_versions")
         _op["method"] = "GET"
@@ -446,7 +447,7 @@ class Attachments:
 
     def list_discussion_attachments(
         self, sheet_id, discussion_id, page_size=None, page=None, include_all=None
-    ):
+    ) -> Union[IndexResult[Attachment], Error]:
         """Get a list of Attachments for the Sheet Discussion.
 
         Get a list of all Attachments for the specified Sheet
@@ -462,7 +463,7 @@ class Attachments:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_discussion_attachments")
         _op["method"] = "GET"
@@ -486,7 +487,7 @@ class Attachments:
 
     def list_row_attachments(
         self, sheet_id, row_id, page_size=None, page=None, include_all=None
-    ):
+    ) -> Union[IndexResult[Attachment], Error]:
         """Get a list of all Attachments for the specified Sheet Row.
 
         Args:
@@ -499,7 +500,7 @@ class Attachments:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Attachment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_row_attachments")
         _op["method"] = "GET"

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/smartsheet/cells.py

@@ -17,9 +17,12 @@
 
 from __future__ import absolute_import
 
+from typing import Union
+
 import logging
 
 from .util import fresh_operation
+from .models import CellHistory, IndexResult, Result, Row, Error
 
 
 class Cells:
@@ -41,7 +44,7 @@ class Cells:
         page=None,
         include_all=None,
         level=None,
-    ):
+    ) -> Union[IndexResult[CellHistory], Error]:
         """Get the Cell modification history.
 
         Args:
@@ -58,7 +61,7 @@ class Cells:
             level (int): compatibility level
 
         Returns:
-            IndexResult
+            Union[IndexResult[CellHistory], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "row_id", "column_id"]):
             raise ValueError(
@@ -98,7 +101,7 @@ class Cells:
         file_type,
         override_validation=False,
         alt_text=None,
-    ):
+    ) -> Union[Result[Row], Error]:
         """Uploads an image to the specified cell.
 
         Args:
@@ -111,7 +114,7 @@ class Cells:
             alt_text: alternate text for the image
 
         Returns:
-            Result
+            Union[Result[Row], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(
             val is not None
@@ -134,7 +137,7 @@ class Cells:
         file_type,
         override_validation,
         alt_text,
-    ):
+    ) -> Union[Result[Row], Error]:
 
         _data = open(file, "rb").read()
         _op = fresh_operation("attach_file_to_cell")

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/smartsheet/contacts.py

@@ -17,9 +17,12 @@
 
 from __future__ import absolute_import
 
+from typing import Union
+
 import logging
 
 from .util import fresh_operation
+from .models import Error, Contact, IndexResult
 
 
 class Contacts:
@@ -31,14 +34,14 @@ class Contacts:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def get_contact(self, contact_id):
+    def get_contact(self, contact_id) -> Union[Contact, Error]:
         """Get the specified Contact.
 
         Args:
             contact_id (str): Contact ID
 
         Returns:
-            Contact
+            Union[Contact, Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_contact")
         _op["method"] = "GET"
@@ -50,7 +53,7 @@ class Contacts:
 
         return response
 
-    def list_contacts(self, page_size=None, page=None, include_all=None):
+    def list_contacts(self, page_size=None, page=None, include_all=None) -> Union[IndexResult[Contact], Error]:
         """Get a list of the user's Smartsheet Contacts.
 
         Args:
@@ -61,7 +64,7 @@ class Contacts:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Contact], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_contacts")
         _op["method"] = "GET"

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/smartsheet/discussions.py

@@ -17,11 +17,14 @@
 
 from __future__ import absolute_import
 
+from typing import Union
+
 import logging
 
 import six
 
 from .util import fresh_operation
+from .models import Error, Comment, Discussion, IndexResult, Result
 
 
 class Discussions:
@@ -33,7 +36,7 @@ class Discussions:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def add_comment_to_discussion(self, sheet_id, discussion_id, comment_obj=None):
+    def add_comment_to_discussion(self, sheet_id, discussion_id, comment_obj=None) -> Union[Result[Comment], Error]:
         """Add a Comment to the specified Discussion
 
         Args:
@@ -42,7 +45,7 @@ class Discussions:
             comment_obj (Comment): Comment object.
 
         Returns:
-            Result
+            Union[Result[Comment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("add_comment_to_discussion")
         _op["method"] = "POST"
@@ -65,7 +68,7 @@ class Discussions:
     # pylint: disable=invalid-name
     def add_comment_to_discussion_with_attachment(
         self, sheet_id, discussion_id, comment, _file=None
-    ):
+    ) -> Union[Result[Comment], Error]:
         """Add a Comment with an Attachment to the specified Discussion
 
         Args:
@@ -75,7 +78,7 @@ class Discussions:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Comment], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "discussion_id", "comment"]):
             raise ValueError(
@@ -105,7 +108,7 @@ class Discussions:
 
     # pylint: enable=invalid-name
 
-    def create_discussion_on_row(self, sheet_id, row_id, discussion_obj=None):
+    def create_discussion_on_row(self, sheet_id, row_id, discussion_obj=None) -> Union[Result[Discussion], Error]:
         """Create a new Discussion on a Row.
 
 
@@ -116,7 +119,7 @@ class Discussions:
             discussion_obj (Discussion): Discussion object.
 
         Returns:
-            Result
+            Union[Result[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("create_discussion_on_row")
         _op["method"] = "POST"
@@ -135,7 +138,7 @@ class Discussions:
     # pylint: disable=invalid-name
     def create_discussion_on_row_with_attachment(
         self, sheet_id, row_id, discussion, _file=None
-    ):
+    ) -> Union[Result[Discussion], Error]:
         """Create a new Discussion on a Row with an attachment.
 
         Args:
@@ -145,7 +148,7 @@ class Discussions:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         if not all(val is not None for val in ["sheet_id", "row_id", "discussion"]):
             raise ValueError(
@@ -171,7 +174,7 @@ class Discussions:
 
     # pylint: enable=invalid-name
 
-    def create_discussion_on_sheet(self, sheet_id, discussion_obj=None):
+    def create_discussion_on_sheet(self, sheet_id, discussion_obj=None) -> Union[Result[Discussion], Error]:
         """Create a new Discussion on a Sheet.
 
         Args:
@@ -179,7 +182,7 @@ class Discussions:
             discussion_obj (Discussion): Discussion object.
 
         Returns:
-            Result
+            Union[Result[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("create_discussion_on_sheet")
         _op["method"] = "POST"
@@ -196,7 +199,7 @@ class Discussions:
     # pylint: disable=invalid-name
     def create_discussion_on_sheet_with_attachment(
         self, sheet_id, discussion, _file=None
-    ):
+    ) -> Union[Result[Discussion], Error]:
         """Create a new Discussion on a Sheet with an attachment.
 
         Args:
@@ -205,7 +208,7 @@ class Discussions:
             _file (file): String or file stream object.
 
         Returns:
-            Result
+            Union[Result[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("create_discussion_on_sheet_with_attachment")
         _op["method"] = "POST"
@@ -224,7 +227,7 @@ class Discussions:
 
     # pylint: enable=invalid-name
 
-    def delete_discussion(self, sheet_id, discussion_id):
+    def delete_discussion(self, sheet_id, discussion_id) -> Union[Result[None], Error]:
         """Delete the specified Discussion.
 
         Args:
@@ -232,7 +235,7 @@ class Discussions:
             discussion_id (int): Discussion ID
 
         Returns:
-            Result
+            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("delete_discussion")
         _op["method"] = "DELETE"
@@ -244,7 +247,7 @@ class Discussions:
 
         return response
 
-    def delete_discussion_comment(self, sheet_id, comment_id):
+    def delete_discussion_comment(self, sheet_id, comment_id) -> Union[Result[None], Error]:
         """Delete the specified Sheet Comment.
 
         Delete the specified Comment from the specified Sheet.
@@ -254,7 +257,7 @@ class Discussions:
             comment_id (int): Comment ID
 
         Returns:
-            Result
+            Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("delete_discussion_comment")
         _op["method"] = "DELETE"
@@ -268,7 +271,7 @@ class Discussions:
 
     def get_all_discussions(
         self, sheet_id, include=None, page_size=None, page=None, include_all=None
-    ):
+    ) -> Union[IndexResult[Discussion], Error]:
         """Get a list of all Discussions on the specified Sheet.
 
         Get a list of all Discussions associated with the specified
@@ -286,7 +289,7 @@ class Discussions:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_all_discussions")
         _op["method"] = "GET"
@@ -303,7 +306,7 @@ class Discussions:
 
         return response
 
-    def get_discussion(self, sheet_id, discussion_id):
+    def get_discussion(self, sheet_id, discussion_id) -> Union[Discussion, Error]:
         """Get the specified Discussion.
 
         Args:
@@ -311,7 +314,7 @@ class Discussions:
             discussion_id (int): Discussion ID
 
         Returns:
-            Discussion
+            Union[Discussion, Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_discussion")
         _op["method"] = "GET"
@@ -323,7 +326,7 @@ class Discussions:
 
         return response
 
-    def get_discussion_comment(self, sheet_id, comment_id):
+    def get_discussion_comment(self, sheet_id, comment_id) -> Union[Comment, Error]:
         """Get the specified Comment.
 
         Args:
@@ -331,7 +334,7 @@ class Discussions:
             comment_id (int): Comment ID
 
         Returns:
-            Comment
+            Union[Comment, Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_discussion_comment")
         _op["method"] = "GET"
@@ -351,7 +354,7 @@ class Discussions:
         page_size=None,
         page=None,
         include_all=None,
-    ):
+    ) -> Union[IndexResult[Discussion], Error]:
         """Get a list of all Discussions associated with the specified Row.
 
         Args:
@@ -368,7 +371,7 @@ class Discussions:
                 (i.e. do not paginate).
 
         Returns:
-            IndexResult
+            Union[IndexResult[Discussion], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("get_row_discussions")
         _op["method"] = "GET"
@@ -387,7 +390,7 @@ class Discussions:
 
         return response
 
-    def update_comment(self, sheet_id, comment_id, comment_obj):
+    def update_comment(self, sheet_id, comment_id, comment_obj) -> Union[Result[Comment], Error]:
         """Update the specified Comment.
 
         Args:
@@ -396,7 +399,7 @@ class Discussions:
             comment_obj (Comment): Comment object with the following attributes:
 
         Returns:
-            Result
+            Union[Result[Comment], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("update_comment")
         _op["method"] = "PUT"

{smartsheet_python_sdk-3.6.0 → smartsheet_python_sdk-3.7.1}/smartsheet/events.py

@@ -17,10 +17,13 @@
 
 from __future__ import absolute_import
 
+from typing import Union
+
 import logging
 from datetime import datetime
 
 from .util import fresh_operation
+from .models import Error, Event, EventResult
 
 
 class Events:
@@ -31,7 +34,7 @@ class Events:
 
     def list_events(
         self, since=None, to=None, stream_position=None, max_count=None, numeric_dates=None # pylint: disable=invalid-name
-    ):
+    ) -> Union[EventResult[Event], Error]:
         """Get the list of all Events.
 
         Args:
@@ -53,7 +56,7 @@ class Events:
                 Default is false, which means ISO-8601 format
 
         Returns:
-            EventResult containing Event array as data[]
+            Union[EventResult[Event], Error]: The result of the operation, or an Error object if the request fails.
         """
         _op = fresh_operation("list_events")
         _op["method"] = "GET"