smartsheet-python-sdk 3.7.0__py3-none-any.whl → 3.7.2__py3-none-any.whl

smartsheet/favorites.py

@@ -17,7 +17,7 @@
 
 from __future__ import absolute_import
 
-from typing import Union
+from typing import Union, List
 
 import logging
 
@@ -34,7 +34,7 @@ class Favorites:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def add_favorites(self, favorite_obj) -> Union[Result[Favorite], Error]:
+    def add_favorites(self, favorite_obj) -> Union[Result[Union[Favorite, List[Favorite]]], Error]:
         """Add one or more items to the user's list of Favorite items.
 
         Adds one or more items to the user's list of Favorite
@@ -50,7 +50,8 @@ class Favorites:
                 more Favorite objects
 
         Returns:
-            Union[Result[Favorite], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[Union[Favorite, List[Favorite]]], Error]: The result of the operation - either a list or a
+            single object, or an Error object if the request fails.
         """
         _op = fresh_operation("add_favorites")
         _op["method"] = "POST"

smartsheet/groups.py

@@ -17,7 +17,7 @@
 
 from __future__ import absolute_import
 
-from typing import Union
+from typing import Union, List
 
 import logging
 
@@ -34,7 +34,7 @@ class Groups:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def add_members(self, group_id, group_member_obj) -> Union[Result[GroupMember], Error]:
+    def add_members(self, group_id, group_member_obj) -> Union[Result[Union[GroupMember, List[GroupMember]]], Error]:
         """Add one or more members to a Group.
 
         Args:
@@ -43,7 +43,8 @@ class Groups:
                 object(s).
 
         Returns:
-            Union[Result[GroupMember], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[Union[GroupMember, List[GroupMember]]], Error]: The result of the operation - either a list or
+            a single object, or an Error object if the request fails.
         """
         _op = fresh_operation("add_members")
         _op["method"] = "POST"

smartsheet/sheets.py

@@ -20,7 +20,7 @@ from __future__ import absolute_import
 import logging
 import os.path
 from datetime import datetime
-from typing import Union
+from typing import Union, List
 
 import six
 
@@ -40,7 +40,7 @@ class Sheets:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def add_columns(self, sheet_id, list_of_columns) -> Union[Result[Column], Error]:
+    def add_columns(self, sheet_id, list_of_columns) -> Union[Result[Union[Column, List[Column]]], Error]:
         """Insert one or more Columns into the specified Sheet
 
         Args:
@@ -49,7 +49,7 @@ class Sheets:
                 Column objects
 
         Returns:
-            Union[Result[Column], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[Union[Column, List[Column]]], Error]: The result of the operation - either a list or a single object, or an Error object if the request fails.
         """
 
         if isinstance(list_of_columns, (dict, Column)):
@@ -69,7 +69,7 @@ class Sheets:
 
         return response
 
-    def add_rows(self, sheet_id, list_of_rows) -> Union[Result[Row], Error]:
+    def add_rows(self, sheet_id, list_of_rows) -> Union[Result[Union[Row, List[Row]]], Error]:
         """Insert one or more Rows into the specified Sheet.
 
         If multiple rows are specified in the request, all rows
@@ -109,7 +109,7 @@ class Sheets:
                    hyperlink (optional)
 
         Returns:
-            Union[Result[Row], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[Union[Row, List[Row]]], Error]: The result of the operation - either a list or a single object, or an Error object if the request fails.
         """
         if isinstance(list_of_rows, (dict, Row)):
             arg_value = list_of_rows
@@ -281,7 +281,7 @@ class Sheets:
 
         return response
 
-    def delete_rows(self, sheet_id, ids, ignore_rows_not_found=False) -> Union[Result[NumberObjectValue], Error]:
+    def delete_rows(self, sheet_id, ids, ignore_rows_not_found=False) -> Union[Result[List[NumberObjectValue]], Error]:
         """Deletes one or more Row(s) from the specified Sheeet.
 
         Args:
@@ -296,7 +296,7 @@ class Sheets:
                 will be altered).
 
         Returns:
-            Union[Result[NumberObjectValue], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[List[NumberObjectValue]], Error]: The result of the operation - a list of deleted object IDs, or an Error object if the request fails.
         """
         _op = fresh_operation("delete_rows")
         _op["method"] = "DELETE"

smartsheet/sights.py

@@ -16,8 +16,9 @@
 # under the License.
 
 import logging
+import warnings
 from datetime import datetime
-from typing import Union
+from typing import Optional, Union
 
 from .util import fresh_operation
 from .models import Error, IndexResult, Result, Share, Sight, SightPublish
@@ -33,28 +34,80 @@ class Sights:
         self._log = logging.getLogger(__name__)
 
     def list_sights(
-        self, page_size=None, page=None, include_all=None, modified_since=None
+        self,
+        page_size: Optional[int] = None,
+        page: Optional[int] = None,
+        include_all: Optional[bool] = None,
+        last_key: Optional[str] = None,
+        max_items: Optional[int] = None,
+        pagination_type: Optional[str] = None,
+        modified_since: Optional[datetime] = None
     ) -> Union[IndexResult[Sight], Error]:
         """Get the list of all Sights the User has access to, in alphabetical
         order, by name.
 
         Args:
-            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).
-            modified_since(datetime): return sights modified since datetime
+            page_size (int, optional): [DEPRECATED] The maximum number of items to
+                return per page. Use pagination_type='token' with max_items instead.
+            page (int, optional): [DEPRECATED] Which page to return.
+                Use pagination_type='token' with last_key instead.
+            include_all (bool, optional): [DEPRECATED] If true, include all results
+                (i.e. do not paginate). Use pagination_type='token' instead.
+            last_key (str, optional): Pagination cursor for next page (token pagination only).
+            max_items (int, optional): Maximum items per page (token pagination only).
+                Must be a positive integer.
+            pagination_type (str, optional): Use 'token' for efficient cursor-based pagination.
+                Defaults to legacy offset-based pagination if not specified.
+            modified_since (datetime, optional): Return sights modified since datetime.
 
         Returns:
             Union[IndexResult[Sight], Error]: The result of the operation, or an Error object if the request fails.
+                When using legacy pagination, contains paginated results with
+                total_count, total_pages, etc.
+
+        Raises:
+            ValueError: If pagination_type is not 'token' or None, or if max_items <= 0
+                when using token pagination.
         """
+        # Parameter validation
+        if pagination_type is not None and pagination_type not in ['token']:
+            raise ValueError("pagination_type must be 'token' or None")
+        if pagination_type == 'token' and max_items is not None and max_items <= 0:
+            raise ValueError("max_items must be a positive integer")
+
         _op = fresh_operation("list_sights")
         _op["method"] = "GET"
         _op["path"] = "/sights"
-        _op["query_params"]["pageSize"] = page_size
-        _op["query_params"]["page"] = page
-        _op["query_params"]["includeAll"] = include_all
+
+        # Issue deprecation warnings for old parameters when used
+        if page_size is not None:
+            warnings.warn(
+                "page_size parameter is deprecated. Use pagination_type='token' with max_items instead.",
+                DeprecationWarning,
+                stacklevel=2
+            )
+        if page is not None:
+            warnings.warn(
+                "page parameter is deprecated. Use pagination_type='token' with last_key instead.",
+                DeprecationWarning,
+                stacklevel=2
+            )
+        if include_all is not None:
+            warnings.warn(
+                "include_all parameter is deprecated. Use pagination_type='token' instead.",
+                DeprecationWarning,
+                stacklevel=2
+            )
+
+        if pagination_type == "token":
+            _op["query_params"]["lastKey"] = last_key
+            _op["query_params"]["maxItems"] = max_items
+            _op["query_params"]["paginationType"] = pagination_type
+        else:
+            _op["query_params"]["pageSize"] = page_size
+            _op["query_params"]["page"] = page
+            _op["query_params"]["includeAll"] = include_all
+
         if isinstance(modified_since, datetime):
             _op["query_params"]["modifiedSince"] = modified_since.isoformat()
 

smartsheet/smartsheet.py

@@ -38,6 +38,7 @@ from .session import pinned_session
 from .util import is_multipart, serialize
 
 from .attachments import Attachments
+from .cells import Cells
 from .contacts import Contacts
 from .discussions import Discussions
 from .events import Events
@@ -119,6 +120,7 @@ class Smartsheet:
     """Use this to make requests to the Smartsheet API."""
 
     Attachments: Attachments
+    Cells: Cells
     Contacts: Contacts
     Discussions: Discussions
     Events: Events

smartsheet/users.py

@@ -17,7 +17,7 @@
 
 from __future__ import absolute_import
 
-from typing import Union
+from typing import Union, List
 
 import logging
 from datetime import datetime
@@ -36,7 +36,7 @@ class Users:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
-    def add_alternate_email(self, user_id, list_of_alternate_emails) -> Union[Result[AlternateEmail], Error]:
+    def add_alternate_email(self, user_id, list_of_alternate_emails) -> Union[Result[Union[AlternateEmail, List[AlternateEmail]]], Error]:
         """Add one or more alternate email addresses for the specified User
 
         Args:
@@ -45,7 +45,7 @@ class Users:
                 An array of one or more AlternateEmail objects.
 
         Returns:
-            Union[Result[AlternateEmail], Error]: The result of the operation, or an Error object if the request fails.
+            Union[Result[List[AlternateEmail]], Error]: The result of the operation - either a list or a single object, or an Error object if the request fails.
         """
         _op = fresh_operation("add_alternate_email")
         _op["method"] = "POST"

smartsheet/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.7.0'
-__version_tuple__ = version_tuple = (3, 7, 0)
+__version__ = version = '3.7.2'
+__version_tuple__ = version_tuple = (3, 7, 2)
 
 __commit_id__ = commit_id = None

{smartsheet_python_sdk-3.7.0.dist-info → smartsheet_python_sdk-3.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet-python-sdk
-Version: 3.7.0
+Version: 3.7.2
 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.7.0.dist-info → smartsheet_python_sdk-3.7.2.dist-info}/RECORD

@@ -5,9 +5,9 @@ smartsheet/contacts.py,sha256=NXOUWLZYytkPSyoo5XaUvp4agL_JDSOn9KqWtEkVvig,2703
 smartsheet/discussions.py,sha256=xfWiDKOuXdJI0KynVU1cdYryPnsY3oXXau_RLzr63rI,14862
 smartsheet/events.py,sha256=e8JaaAoDf2LwcKz8nzSOGPtbxT615lz6TB11LTTBRcc,3588
 smartsheet/exceptions.py,sha256=ISCV4fIAkYgcYMsZL62zDr48qIPPok6N4myifej2M4c,3894
-smartsheet/favorites.py,sha256=yTMOPNbGF0yVUl0Mu1YmCt1xbljQ3rAYomYdG_RO2sc,4392
+smartsheet/favorites.py,sha256=zLiZavNW-8VuSG8HJtVRNM9wpo7pMQMjwuKhk4GVMEw,4491
 smartsheet/folders.py,sha256=wzpQi1WnIgWTEeP4ukLUcpjxWoqwZUJlVRaCu2XaQCg,16220
-smartsheet/groups.py,sha256=b2n-YTRkrITlGk-e5u7GLy20pgKtWoUsXnTFqJ4ckZM,6281
+smartsheet/groups.py,sha256=uPxr6krN08pxwk4XRv65H6989S6SjdF-sT12X7JVhyE,6386
 smartsheet/home.py,sha256=3klXCDfejwXRsL_n3w_pECm3ugDgSvsWsWmdM-EcTXw,6223
 smartsheet/images.py,sha256=nUjJxSP-O559i3TruB5DTpVl2lOVLC4fWvsYaHEebUI,2026
 smartsheet/object_value.py,sha256=dcPFZEPpqAiZsBRUawozLSSlVjxGBWTT3VXvsRYso8Q,3129
@@ -17,15 +17,15 @@ smartsheet/search.py,sha256=ziSXW9EPf2SvrveHdq1nux74Vkvzk57L-v0gyMz03AY,3694
 smartsheet/server.py,sha256=_HGk5e6N4y8OceFVFXGaKoilrbSXk0OmnKnFFXfyR7A,1610
 smartsheet/session.py,sha256=TQ3IgVZ64r7Dszwo8rMISFezWxuwFYshhW9QhzoA428,2125
 smartsheet/sharing.py,sha256=N0FxpfFINjQ-cb6-zGnAy-a1ViM1YDIMzF1LWJ1hyNY,6623
-smartsheet/sheets.py,sha256=zupO4RHwnwJb9NAmxY2TDf6RWytDeGZXuWQc4T5RF8k,78946
-smartsheet/sights.py,sha256=F5lQ1lowQFq1yIr3aD6GUH_BJ2b-krbOU2CjU1xH-cg,13254
-smartsheet/smartsheet.py,sha256=qvDHQmUUjiJzDxb5Tot9SUS3toCcHpdvcXd1xWzkSgk,25405
+smartsheet/sheets.py,sha256=V_rgks6duwUu0mggn-uCse0AyADkHSiS4LXJMKlEW1s,79143
+smartsheet/sights.py,sha256=08HNkZzbNw2MvrEqTnFvqnHglv61bZDjYwXs43O_Ekw,15787
+smartsheet/smartsheet.py,sha256=8ESvLqmgfGozE1aQRnmC26oqPuNVL4AYISV7z7IA8gU,25447
 smartsheet/templates.py,sha256=LgFisxV1yU6OuUcxg8dKo-otG2eATMTwxE4tTfLDJDU,3245
 smartsheet/token.py,sha256=NDej84rGP55yOgkrtgAggL1F0HN3zFH9Xw0r2z-To7s,5128
 smartsheet/types.py,sha256=aIdRJ89jwclmiZ4RH3hnZHJTFWFxgNKW3d8fghm21eM,9126
-smartsheet/users.py,sha256=eQFUy3S1LEgqjEJ8Jm4E5sEqt65mrdbLZgeDzsy_dV4,21535
+smartsheet/users.py,sha256=R5ssS7n-rJihyRexqCTZxiY3au8VmWlYwFf_eQMi1d0,21611
 smartsheet/util.py,sha256=-eNjczPYtmtlnSF28z1lUdb6X_DLsHFPSqG1AJpvj8c,6157
-smartsheet/version.py,sha256=frF0s_klEYGUc3TneTySz4_c3QJVUDixsbSrgy4TDFU,704
+smartsheet/version.py,sha256=U56HPfvEIuf7OLsDIujfkDm-48o-vtgN9ELCjYsmg1s,704
 smartsheet/webhooks.py,sha256=pihpwFJ-IY8RRwWPlNZN71hdM6IsvzAoOzjSTqMGSi0,5492
 smartsheet/workspaces.py,sha256=4l2VH4ojvE8Mr5Mnm5xVmSWgk4owJ37eQqA5oE0IocE,25100
 smartsheet/models/__init__.py,sha256=wJter68K1D2T3Noq4r7SooPhahtdkJBKIrrUwJxymNQ,4860
@@ -187,9 +187,9 @@ smartsheet/models/enums/system_column_type.py,sha256=UfhNUBGD_0K1Pas7fujGEuax55O
 smartsheet/models/enums/update_request_status.py,sha256=xYF84x1dTFhJMYVi1q3G1T9u1IGN3szlR1jj5HHC0hE,777
 smartsheet/models/enums/user_status.py,sha256=SB7qRcA0dhdRimsOKHCGF3CB6fL0XuifxQEWZGNNS8Q,766
 smartsheet/models/enums/widget_type.py,sha256=VfVq59fLZsT4ks_ZBrtv52u2Cl60iAdlA6mGD_elz-k,1072
-smartsheet_python_sdk-3.7.0.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-smartsheet_python_sdk-3.7.0.dist-info/licenses/NOTICE,sha256=mXr2ryVjnCjykeW0J79kFfVXQG_Z9SV4BV_QPNENW1U,420
-smartsheet_python_sdk-3.7.0.dist-info/METADATA,sha256=7jR8S8qdqPskCkZBk4K20ydFjBHP867Nc0VH2XdIpu4,5618
-smartsheet_python_sdk-3.7.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-smartsheet_python_sdk-3.7.0.dist-info/top_level.txt,sha256=kozWEYiKjyJmSXzd6p5ugkQ5bhoHS9V3NnvLagUfcNw,11
-smartsheet_python_sdk-3.7.0.dist-info/RECORD,,
+smartsheet_python_sdk-3.7.2.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+smartsheet_python_sdk-3.7.2.dist-info/licenses/NOTICE,sha256=mXr2ryVjnCjykeW0J79kFfVXQG_Z9SV4BV_QPNENW1U,420
+smartsheet_python_sdk-3.7.2.dist-info/METADATA,sha256=QUH-3fsmyGvlmBTQ5uyTGarnTEZCsjHr6Qw5bhz_x24,5618
+smartsheet_python_sdk-3.7.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+smartsheet_python_sdk-3.7.2.dist-info/top_level.txt,sha256=kozWEYiKjyJmSXzd6p5ugkQ5bhoHS9V3NnvLagUfcNw,11
+smartsheet_python_sdk-3.7.2.dist-info/RECORD,,

{smartsheet_python_sdk-3.7.0.dist-info → smartsheet_python_sdk-3.7.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any