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

smartsheet/favorites.py

@@ -23,6 +23,7 @@ import logging
 
 from .util import fresh_operation
 from .models import Error, Favorite, IndexResult, Result
+from .models.enums import FavoriteType
 
 
 class Favorites:
@@ -92,25 +93,21 @@ class Favorites:
 
         return response
 
-    def remove_favorites(self, favorite_type, object_ids) -> Union[Result[None], Error]:
+    def remove_favorites(self, favorite_type: FavoriteType, object_ids: list[int]) -> Union[Result[None], Error]:
         """Delete one or more of Favorite objects of the specified type.
 
-        Specify a favorite type of: folder, report, sheet,
-        template, workspace. The object IDs passed in will be deleted in a
-        batch operation.
-
         Args:
-            favorite_type (str): Name of favorite type to
-                manipulate.
+            favorite_type FavoriteType: The favorite type enum value.
             object_ids (list[int]): a comma-separated list
                 of object IDs representing the items to work on.
 
         Returns:
             Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
+
         _op = fresh_operation("remove_favorites")
         _op["method"] = "DELETE"
-        _op["path"] = "/favorites/" + str(favorite_type)
+        _op["path"] = "/favorites/" + favorite_type
         _op["query_params"]["objectIds"] = object_ids
 
         expected = ["Result", None]
@@ -118,3 +115,30 @@ class Favorites:
         response = self._base.request(prepped_request, expected, _op)
 
         return response
+
+    def is_favorite(self, favorite_type: FavoriteType, favorite_id: int, include=None) -> Union[Favorite, Error]:
+        """Check whether an item has been tagged as a favorite for the current user.
+
+        Args:
+            favorite_type FavoriteType: The favorite type enum value.
+            favorite_id (int): ID of the favorite being accessed.
+            include (str): A comma-separated list of optional elements to
+                include in the response. Valid values: "directId", "name".
+
+        Returns:
+            Union[Favorite, Error]: The Favorite object if the item is favorited,
+            or an Error object if the request fails or the item is not favorited.
+        """
+
+        _op = fresh_operation("is_favorite")
+        _op["method"] = "GET"
+        _op["path"] = "/favorites/" + favorite_type + "/" + str(favorite_id)
+        if include is not None:
+            _op["query_params"]["include"] = include
+
+        expected = "Favorite"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response

smartsheet/models/enums/__init__.py

@@ -36,6 +36,7 @@ from .day_ordinal import DayOrdinal
 from .event_action import EventAction
 from .event_object_type import EventObjectType
 from .event_source import EventSource
+from .favorite_type import FavoriteType
 from .global_template import GlobalTemplate
 from .operator import Operator
 from .paper_type import PaperType

smartsheet/models/enums/favorite_type.py

@@ -0,0 +1,26 @@
+# 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 enum import Enum
+
+
+class FavoriteType(str, Enum):
+    FOLDER = "folder"
+    REPORT = "report"
+    SHEET = "sheet"
+    SIGHT = "sight"
+    TEMPLATE = "template"
+    WORKSPACE = "workspace"

smartsheet/models/favorite.py

@@ -37,6 +37,8 @@ class Favorite:
 
         self._object_id = Number()
         self._type_ = String(accept=self.allowed_values["_type"])
+        self._direct_id = String()
+        self._name = String()
 
         if props:
             deserialize(self, props)
@@ -71,6 +73,22 @@ class Favorite:
     def type_(self, value):
         self._type_.value = value
 
+    @property
+    def direct_id(self):
+        return self._direct_id.value
+
+    @direct_id.setter
+    def direct_id(self, value):
+        self._direct_id.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
     def to_dict(self):
         return serialize(self)
 

smartsheet/version.py

@@ -1,5 +1,6 @@
-# file generated by setuptools-scm
+# file generated by vcs-versioning
 # don't change, don't track in version control
+from __future__ import annotations
 
 __all__ = [
     "__version__",
@@ -10,25 +11,14 @@ __all__ = [
     "commit_id",
 ]
 
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
 version: str
 __version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
 
-__version__ = version = '3.7.2'
-__version_tuple__ = version_tuple = (3, 7, 2)
+__version__ = version = '3.8.0'
+__version_tuple__ = version_tuple = (3, 8, 0)
 
 __commit_id__ = commit_id = None

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

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

@@ -5,7 +5,7 @@ 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=zLiZavNW-8VuSG8HJtVRNM9wpo7pMQMjwuKhk4GVMEw,4491
+smartsheet/favorites.py,sha256=Gv4w8Icf2KvEnAcZZnH_nYFIkvcyp_FxHNoPPOtt0eA,5492
 smartsheet/folders.py,sha256=wzpQi1WnIgWTEeP4ukLUcpjxWoqwZUJlVRaCu2XaQCg,16220
 smartsheet/groups.py,sha256=uPxr6krN08pxwk4XRv65H6989S6SjdF-sT12X7JVhyE,6386
 smartsheet/home.py,sha256=3klXCDfejwXRsL_n3w_pECm3ugDgSvsWsWmdM-EcTXw,6223
@@ -25,7 +25,7 @@ smartsheet/token.py,sha256=NDej84rGP55yOgkrtgAggL1F0HN3zFH9Xw0r2z-To7s,5128
 smartsheet/types.py,sha256=aIdRJ89jwclmiZ4RH3hnZHJTFWFxgNKW3d8fghm21eM,9126
 smartsheet/users.py,sha256=R5ssS7n-rJihyRexqCTZxiY3au8VmWlYwFf_eQMi1d0,21611
 smartsheet/util.py,sha256=-eNjczPYtmtlnSF28z1lUdb6X_DLsHFPSqG1AJpvj8c,6157
-smartsheet/version.py,sha256=U56HPfvEIuf7OLsDIujfkDm-48o-vtgN9ELCjYsmg1s,704
+smartsheet/version.py,sha256=LquZ2PiLwBUfZDl-AcmTob2jcVqOFv3hELKt5TZ7DKU,520
 smartsheet/webhooks.py,sha256=pihpwFJ-IY8RRwWPlNZN71hdM6IsvzAoOzjSTqMGSi0,5492
 smartsheet/workspaces.py,sha256=4l2VH4ojvE8Mr5Mnm5xVmSWgk4owJ37eQqA5oE0IocE,25100
 smartsheet/models/__init__.py,sha256=wJter68K1D2T3Noq4r7SooPhahtdkJBKIrrUwJxymNQ,4860
@@ -69,7 +69,7 @@ smartsheet/models/error_result.py,sha256=kwMIb5YkEcPhpbkqKh63FAVLmvBL_SYt-bjDuGq
 smartsheet/models/event.py,sha256=GFs2nK2wPfPOCiRlu6qhn0Teu_b2-JcIdA7nlo_TDf0,4050
 smartsheet/models/event_result.py,sha256=o80wEQHfhqUehKIMPnXOXQGehm2thUpanEbuOotzWxw,2648
 smartsheet/models/explicit_null.py,sha256=ajwJRTseizgnf2ZY0qf5k97zvNTm033bKduA1OGCm0M,774
-smartsheet/models/favorite.py,sha256=BTQumH0o-MQ93AS02qymyIxEVCR_CrwMWfuT0H051dc,2157
+smartsheet/models/favorite.py,sha256=52p3KlDUuNsMRN-3rZNQGJL9jxcjZtnGsimTA-WSK8w,2537
 smartsheet/models/folder.py,sha256=WOLaECb18w07tn5PuRpF0aNiovZ9I3B9oH5-1QMgoi8,4325
 smartsheet/models/font_family.py,sha256=32tBgd0w58dWco3goN4NZ9eMafaU3szzXYdQudGmeUM,1646
 smartsheet/models/format_details.py,sha256=DwVi1XpXq__lFa1WQHzciE9s8nJltUmfq9l7xTM4uec,1542
@@ -150,7 +150,7 @@ smartsheet/models/widget.py,sha256=G5UKR1latGSuXqm-MCRQxn9W7IJgo2FsUWJ9heEW0RA,6
 smartsheet/models/widget_content.py,sha256=hxv3DJWO8YPe4ND-HUZ59eOVU9LAy02owU-KQVWUsDU,1525
 smartsheet/models/widget_hyperlink.py,sha256=JPjaSftHFHiFj48tfOckGWzrew_CLKmE2k9lUA_RQSk,2059
 smartsheet/models/workspace.py,sha256=_YT4i4DEK32kEyqlWixZUQSQyBiZkNtwtSmuhc98H2s,4522
-smartsheet/models/enums/__init__.py,sha256=3WfK4QQnd0zHCchGFalzKqkuYIwSTOxBAhdS3IOhldA,2356
+smartsheet/models/enums/__init__.py,sha256=0BtIiNRFPMpoFsnVEFa3ZBpYbVVF9p4ZTuTpHQk2whw,2396
 smartsheet/models/enums/access_level.py,sha256=LvKh3Z2LrFeLm-R-dT0qOVinBsA4jEOxM02flg0LFaY,816
 smartsheet/models/enums/asset_type.py,sha256=hrNXZDk_mme57f-0wO86mk_RwzNP8zkb9h7GAEZbhjQ,253
 smartsheet/models/enums/attachment_parent_type.py,sha256=EFcrHg8xpx_ZxrrGb3vkk9Ji8PD74Q8GeWhXZMquVEw,770
@@ -169,6 +169,7 @@ smartsheet/models/enums/day_ordinal.py,sha256=Wg2H2oOefSEH5hMJyo5vZ8Ge4_D6lXbq6p
 smartsheet/models/enums/event_action.py,sha256=zO8QQN1doN5FaxuWtLMRQWRwDZ-iQ_aaq-jl9SlIUto,2005
 smartsheet/models/enums/event_object_type.py,sha256=hB_J5FfiNJuaodxgjjcNehL1e8Pooq1yVtgP_ITS7lI,946
 smartsheet/models/enums/event_source.py,sha256=tB9IEhZY4JvOUxX0qjckturiWMLF8S05gFh557DvjNk,847
+smartsheet/models/enums/favorite_type.py,sha256=YgQMRzVtk_UzMhmAXIhvF42HQW7i9DTltjD2sqKznMA,863
 smartsheet/models/enums/global_template.py,sha256=NQjHD1h9rn7B4CvOAeJzRVisCoGmlcdn_t-ZGaE7rTQ,782
 smartsheet/models/enums/operator.py,sha256=fREabjb27V-vt2KDHZpDFwLf75TrAQwTte6S0OrEU0U,1606
 smartsheet/models/enums/paper_type.py,sha256=vh0VrF6G9xB5Kdt979I51wulnTqYl8hMrXoUaR0MXUo,828
@@ -187,9 +188,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.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.8.0.dist-info/licenses/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+smartsheet_python_sdk-3.8.0.dist-info/licenses/NOTICE,sha256=mXr2ryVjnCjykeW0J79kFfVXQG_Z9SV4BV_QPNENW1U,420
+smartsheet_python_sdk-3.8.0.dist-info/METADATA,sha256=OMF57tGu0DFiu5ildgVDHV0XclhO5wQCrL1rkm6GnJw,5618
+smartsheet_python_sdk-3.8.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+smartsheet_python_sdk-3.8.0.dist-info/top_level.txt,sha256=kozWEYiKjyJmSXzd6p5ugkQ5bhoHS9V3NnvLagUfcNw,11
+smartsheet_python_sdk-3.8.0.dist-info/RECORD,,

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

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