smartsheet-python-sdk 3.7.2__tar.gz → 3.8.0__tar.gz

{smartsheet_python_sdk-3.7.2 → smartsheet_python_sdk-3.8.0}/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [x.x.x] - Unreleased
 
+## [3.8.0] - 2026-04-17
+
+### Added
+
+- Added support for the GET /2.0/favorites/{favoriteType}/{favoriteId} endpoint
+- Added directId and name fields to the Favorite model
+- Added FavoriteType enum
+- WireMock integration tests for contract testing for GET /2.0/favorites/{favoriteType}/{favoriteId} endpoint
+
 ## [3.7.2] - 2026-01-29
 
 ### Added

{smartsheet_python_sdk-3.7.2/smartsheet_python_sdk.egg-info → smartsheet_python_sdk-3.8.0}/PKG-INFO

@@ -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 → smartsheet_python_sdk-3.8.0}/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_python_sdk-3.7.2 → smartsheet_python_sdk-3.8.0}/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_python_sdk-3.8.0/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_python_sdk-3.7.2 → smartsheet_python_sdk-3.8.0}/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_python_sdk-3.8.0/smartsheet/version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '3.8.0'
+__version_tuple__ = version_tuple = (3, 8, 0)
+
+__commit_id__ = commit_id = 'g6bceafe0e'

{smartsheet_python_sdk-3.7.2 → smartsheet_python_sdk-3.8.0/smartsheet_python_sdk.egg-info}/PKG-INFO

@@ -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 → smartsheet_python_sdk-3.8.0}/smartsheet_python_sdk.egg-info/SOURCES.txt

@@ -197,6 +197,7 @@ smartsheet/models/enums/day_ordinal.py
 smartsheet/models/enums/event_action.py
 smartsheet/models/enums/event_object_type.py
 smartsheet/models/enums/event_source.py
+smartsheet/models/enums/favorite_type.py
 smartsheet/models/enums/global_template.py
 smartsheet/models/enums/operator.py
 smartsheet/models/enums/paper_type.py
@@ -234,6 +235,9 @@ tests/mock_api/test_mock_api_sights.py
 tests/mock_api/test_mock_api_workspaces.py
 tests/mock_api/test_mock_change_agent.py
 tests/mock_api/test_mock_serialization.py
+tests/mock_api/favorites/__init__.py
+tests/mock_api/favorites/common_test_constants.py
+tests/mock_api/favorites/test_is_favorite.py
 tests/mock_api/users/common_test_constants.py
 tests/mock_api/users/test_deactivate_user.py
 tests/mock_api/users/test_list_user_plans.py

smartsheet_python_sdk-3.8.0/tests/mock_api/favorites/__init__.py

@@ -0,0 +1 @@
+# Test module for favorites

smartsheet_python_sdk-3.8.0/tests/mock_api/favorites/common_test_constants.py

@@ -0,0 +1,7 @@
+from smartsheet.models.enums import FavoriteType
+
+TEST_FAVORITE_ID = 1234567890123456
+TEST_OBJECT_ID = 1234567890123456
+TEST_FAVORITE_TYPE = FavoriteType.SHEET
+TEST_DIRECT_ID = "pxjX72pQ9Cj8vPqHchrh7xMFqFG7RM5jJJ3MFJM1"
+TEST_OBJECT_NAME = "Test Sheet"

smartsheet_python_sdk-3.8.0/tests/mock_api/favorites/test_is_favorite.py

@@ -0,0 +1,93 @@
+import json
+import uuid
+from urllib.parse import urlparse, parse_qs
+
+from smartsheet.models import Error
+from tests.mock_api.favorites.common_test_constants import TEST_FAVORITE_ID, TEST_OBJECT_ID, TEST_FAVORITE_TYPE, TEST_DIRECT_ID, TEST_OBJECT_NAME
+from tests.mock_api.mock_api_test_helper import (
+    get_mock_api_client,
+    get_wiremock_request,
+)
+
+
+def test_is_favorite_generated_url_is_correct():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/favorites/is-favorite/all-response-body-properties", request_id
+    )
+
+    client.Favorites.is_favorite(
+        favorite_type=TEST_FAVORITE_TYPE,
+        favorite_id=TEST_FAVORITE_ID,
+        include="directId,name"
+    )
+
+    wiremock_request = get_wiremock_request(request_id)
+    url = urlparse(wiremock_request["absoluteUrl"])
+    query = parse_qs(url.query)
+    assert query == {
+        "include": ["directId,name"]
+    }
+    assert url.path == f'/2.0/favorites/{TEST_FAVORITE_TYPE.value}/{TEST_FAVORITE_ID}'
+
+def test_is_favorite_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/favorites/is-favorite/all-response-body-properties", request_id
+    )
+
+    response = client.Favorites.is_favorite(
+        favorite_type=TEST_FAVORITE_TYPE,
+        favorite_id=TEST_FAVORITE_ID,
+    )
+
+    assert response.to_dict() == {
+        "objectId": TEST_OBJECT_ID,
+        "type": TEST_FAVORITE_TYPE,
+        "directId": TEST_DIRECT_ID,
+        "name": TEST_OBJECT_NAME
+    }
+
+def test_is_favorite_required_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/favorites/is-favorite/required-response-body-properties", request_id
+    )
+
+    response = client.Favorites.is_favorite(
+        favorite_type=TEST_FAVORITE_TYPE,
+        favorite_id=TEST_FAVORITE_ID,
+    )
+
+    assert response.to_dict() == {
+        "objectId": TEST_OBJECT_ID,
+        "type": TEST_FAVORITE_TYPE
+    }
+
+
+def test_is_favorite_error_4xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/400-response", request_id
+    )
+
+    response = client.Favorites.is_favorite(
+        favorite_type=TEST_FAVORITE_TYPE,
+        favorite_id=TEST_FAVORITE_ID,
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_is_favorite_error_5xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/500-response", request_id
+    )
+
+    response = client.Favorites.is_favorite(
+        favorite_type=TEST_FAVORITE_TYPE,
+        favorite_id=TEST_FAVORITE_ID,
+    )
+
+    assert isinstance(response, Error)

smartsheet_python_sdk-3.7.2/smartsheet/version.py

@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "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__ = version = '3.7.2'
-__version_tuple__ = version_tuple = (3, 7, 2)
-
-__commit_id__ = commit_id = 'g76a2ad575'