smartsheet-python-sdk 3.5.1__tar.gz → 3.5.3__tar.gz

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/.github/workflows/test-build.yaml

@@ -57,8 +57,7 @@ jobs:
           repository: 'smartsheet-sdk-tests'
       - name: Setup Mock API
         run: |
-          smartsheet-sdk-tests/ci_scripts/install_wiremock.sh
-          smartsheet-sdk-tests/ci_scripts/start_wiremock.sh
+          docker compose -f smartsheet-sdk-tests/docker-compose.yml up -d --wait
       - name: Run mock API tests
         run: |
           coverage run --source=smartsheet -m pytest tests/mock_api/

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [3.5.3] - 2025-10-31
+
+### Fixed
+
+- The new sharing endpoints (/2.0/shares) return string for userId and groupId, adjust the SDK to that.
+
+### Added
+
+- `AssetShare` model to fully comply with the new sharing endpoints (/2.0/shares) DTO.
+
+## [3.5.2] - 2025-10-29
+
+### Fixed
+
+- Fix list_asset_shares to return AssetSharesPaginatedResult.
+- Fix update_asset_share to return Share
+
+## Added
+
+- Add AssetSharesPaginatedResult for list asset shares.
+- Add mock api tests for sharing endpoints.
+
 ## [3.5.1] - 2025-10-28
 
 ### Fixed

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: smartsheet_python_sdk
-Version: 3.5.1
+Version: 3.5.3
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 Home-page: http://smartsheet-platform.github.io/api-docs/
 Author: Smartsheet
@@ -20,10 +20,34 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
 Description-Content-Type: text/markdown
-Provides-Extra: test
-Provides-Extra: develop
 License-File: LICENSE.md
 License-File: NOTICE
+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"
+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"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # Smartsheet Python SDK
 

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet/models/__init__.py

@@ -122,3 +122,5 @@ from .widget import Widget
 from .widget_content import WidgetContent
 from .workspace import Workspace
 from .user_plan import UserPlan
+from .asset_shares_paginated_result import AssetSharesPaginatedResult
+from .asset_share import AssetShare

smartsheet_python_sdk-3.5.3/smartsheet/models/asset_share.py

@@ -0,0 +1,138 @@
+# 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 __future__ import absolute_import
+
+from ..types import EnumeratedValue, String, json
+from ..util import deserialize, serialize
+from .enums import AccessLevel, ShareScope, ShareType
+
+
+class AssetShare:
+
+    """Smartsheet AssetShare data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AssetShare model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._email = String()
+        self._group_id = String()
+        self._id_ = String()
+        self._name = String()
+        self._scope = EnumeratedValue(ShareScope)
+        self._type_ = EnumeratedValue(ShareType)
+        self._user_id = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "id":
+            return self.id_
+        elif key == "type":
+            return self.type_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "id":
+            self.id_ = value
+        elif key == "type":
+            self.type_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def access_level(self):
+        return self._access_level
+
+    @access_level.setter
+    def access_level(self, value):
+        self._access_level.set(value)
+
+    @property
+    def email(self):
+        return self._email.value
+
+    @email.setter
+    def email(self, value):
+        self._email.value = value
+
+    @property
+    def group_id(self):
+        return self._group_id.value
+
+    @group_id.setter
+    def group_id(self, value):
+        self._group_id.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def scope(self):
+        return self._scope
+
+    @scope.setter
+    def scope(self, value):
+        self._scope.set(value)
+
+    @property
+    def type_(self):
+        return self._type_
+
+    @type_.setter
+    def type_(self, value):
+        self._type_.set(value)
+
+    @property
+    def user_id(self):
+        return self._user_id.value
+
+    @user_id.setter
+    def user_id(self, value):
+        self._user_id.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet_python_sdk-3.5.3/smartsheet/models/asset_shares_paginated_result.py

@@ -0,0 +1,84 @@
+# 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 __future__ import absolute_import
+
+from typing import TypeVar, List
+from ..types import String, json, TypedList, importlib
+from ..util import deserialize, serialize
+from .asset_share import AssetShare
+
+T = TypeVar('T')
+
+
+class AssetSharesPaginatedResult:
+    """Smartsheet AssetSharesPaginatedResult data model with generic type support.
+    Use only for deserializing the response from GET /2.0/shares.
+    Created because GET /2.0/shares returns items in the response body instead of data.
+    As a result TokenPaginatedResult cannot be used.
+    """
+
+    def __init__(self, props=None, dynamic_data_type=None, base_obj=None):
+        """Initialize the TokenPaginatedResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._dynamic_data_type = None
+        if dynamic_data_type is not None:
+            self._dynamic_data_type = dynamic_data_type
+
+        self._items = TypedList(object)
+        self._last_key = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def items(self) -> List[AssetShare]:
+        return self._items
+
+    @items.setter
+    def items(self, value):
+        class_ = getattr(
+            importlib.import_module("smartsheet.models"), self._dynamic_data_type
+        )
+        if isinstance(value, list):
+            self._items = [class_(x, self._base) for x in value]
+        else:
+            self._items = class_(value, self._base)
+
+
+    @property
+    def last_key(self):
+        return self._last_key.value
+
+    @last_key.setter
+    def last_key(self, value):
+        self._last_key.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet/sharing.py

@@ -43,7 +43,7 @@ class Sharing:
             sharing_include (ShareScope): Scope of share to include in response
 
         Returns:
-            IndexResult
+            AssetSharesPaginatedResult
         """
         _op = fresh_operation('list_asset_shares')
         _op['method'] = 'GET'
@@ -54,7 +54,7 @@ class Sharing:
         _op['query_params']['lastKey'] = last_key
         _op['query_params']['sharingInclude'] = sharing_include.name if sharing_include else None
 
-        expected = ['IndexResult', 'Share']
+        expected = ['AssetSharesPaginatedResult', 'AssetShare']
 
         prepped_request = self._base.prepare_request(_op)
         response = self._base.request(prepped_request, expected, _op)
@@ -70,7 +70,7 @@ class Sharing:
             share_id (str): Share ID
 
         Returns:
-            Share
+            AssetShare
         """
         _op = fresh_operation('get_asset_share')
         _op['method'] = 'GET'
@@ -78,7 +78,7 @@ class Sharing:
         _op['query_params']['assetType'] = asset_type
         _op['query_params']['assetId'] = asset_id
 
-        expected = 'Share'
+        expected = 'AssetShare'
         prepped_request = self._base.prepare_request(_op)
         response = self._base.request(prepped_request, expected, _op)
 
@@ -106,7 +106,7 @@ class Sharing:
         _op['query_params']['sendEmail'] = send_email
         _op['json'] = share_obj
 
-        expected = ['Result', 'Share']
+        expected = ['Result', 'AssetShare']
 
         prepped_request = self._base.prepare_request(_op)
         response = self._base.request(prepped_request, expected, _op)
@@ -132,7 +132,7 @@ class Sharing:
         _op['query_params']['assetId'] = asset_id
         _op['json'] = share_obj
 
-        expected = ['Result', 'Share']
+        expected = 'AssetShare'
 
         prepped_request = self._base.prepare_request(_op)
         response = self._base.request(prepped_request, expected, _op)

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet/smartsheet.py

@@ -185,6 +185,8 @@ class Smartsheet:
         self._api_base = api_base
         self._assume_user = None
         self._test_scenario_name = None
+        self._wiremock_test_name = None
+        self._wiremock_request_id = None
         self._change_agent = None
 
     def assume_user(self, email=None):
@@ -227,6 +229,18 @@ class Smartsheet:
         """
         self._test_scenario_name = name
 
+    def with_wiremock_test_case(self, test_name: str, request_id: str):
+        """
+        Configure client with x-test-name and x-request-id headers.
+        Used for wiremock test cases.
+
+        Args:
+            test_name (str): The name of the wiremock test case.
+            request_id (str): The unique request ID for this test scenario.
+        """
+        self._wiremock_test_name = test_name
+        self._wiremock_request_id = request_id
+
     def with_change_agent(self, change_agent):
         """
         Request headers will contain the 'Smartsheet-Change-Agent' header value
@@ -437,6 +451,9 @@ class Smartsheet:
                 del prepped_request.headers["Api-Scenario"]
             except KeyError:
                 pass
+        if self._wiremock_test_name is not None and self._wiremock_request_id is not None:
+            prepped_request.headers["X-Test-Name"] = self._wiremock_test_name
+            prepped_request.headers["X-Request-ID"] = self._wiremock_request_id
 
         if self._change_agent is not None:
             prepped_request.headers.update(

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet/version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '3.5.1'
-__version_tuple__ = version_tuple = (3, 5, 1)
+__version__ = version = '3.5.3'
+__version_tuple__ = version_tuple = (3, 5, 3)

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
-Name: smartsheet-python-sdk
-Version: 3.5.1
+Metadata-Version: 2.4
+Name: smartsheet_python_sdk
+Version: 3.5.3
 Summary: Library that uses Python to connect to Smartsheet services (using API 2.0).
 Home-page: http://smartsheet-platform.github.io/api-docs/
 Author: Smartsheet
@@ -20,10 +20,34 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
 Description-Content-Type: text/markdown
-Provides-Extra: test
-Provides-Extra: develop
 License-File: LICENSE.md
 License-File: NOTICE
+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"
+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"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # Smartsheet Python SDK
 

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet_python_sdk.egg-info/SOURCES.txt

@@ -55,6 +55,8 @@ smartsheet/models/__init__.py
 smartsheet/models/access_token.py
 smartsheet/models/account.py
 smartsheet/models/alternate_email.py
+smartsheet/models/asset_share.py
+smartsheet/models/asset_shares_paginated_result.py
 smartsheet/models/attachment.py
 smartsheet/models/auto_number_format.py
 smartsheet/models/automation_action.py
@@ -213,6 +215,7 @@ smartsheet_python_sdk.egg-info/SOURCES.txt
 smartsheet_python_sdk.egg-info/dependency_links.txt
 smartsheet_python_sdk.egg-info/requires.txt
 smartsheet_python_sdk.egg-info/top_level.txt
+tests/__init__.py
 tests/integration/README.md
 tests/integration/conftest.py
 tests/integration/test_attachments.py
@@ -248,11 +251,13 @@ tests/integration/fixtures/moe-curly.jpg
 tests/integration/fixtures/quote.txt
 tests/integration/fixtures/stooges_v1.jpg
 tests/integration/fixtures/stooges_v2.jpg
+tests/mock_api/__init__.py
 tests/mock_api/mock_api_test_helper.py
 tests/mock_api/test_mock_api_automation_rules.py
 tests/mock_api/test_mock_api_columns.py
 tests/mock_api/test_mock_api_folders.py
 tests/mock_api/test_mock_api_rows.py
+tests/mock_api/test_mock_api_sharing.py
 tests/mock_api/test_mock_api_sheets.py
 tests/mock_api/test_mock_api_sights.py
 tests/mock_api/test_mock_api_workspaces.py

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/smartsheet_python_sdk.egg-info/top_level.txt

@@ -1 +1,2 @@
 smartsheet
+tests

smartsheet_python_sdk-3.5.3/tests/mock_api/mock_api_test_helper.py

@@ -0,0 +1,73 @@
+import os
+import requests
+import smartsheet
+from smartsheet.exceptions import ApiError
+
+
+def clean_api_error(test_func):
+    def wrapper(*args, **kwargs):
+        try:
+            test_func(*args, **kwargs)
+        except ApiError as error:
+            assert False, 'ApiError: ' + error.message
+
+    return wrapper
+
+
+class MockApiTestHelper(object):
+    def setup_method(self, method):
+        self.client = smartsheet.Smartsheet(access_token='abc123', api_base='http://localhost:8082')
+        self.client.errors_as_exceptions()
+
+    def check_error_code(self, exception_info, expected_error_code):
+        actual_error_code = exception_info.value.error.result.error_code
+
+        if self.is_test_scenario_error_code(actual_error_code):
+            raise exception_info.value
+
+        assert actual_error_code == expected_error_code
+
+    def is_test_scenario_error_code(self, error_code):
+        return error_code == 9999
+
+
+def get_mock_api_client(test_name: str, request_id: str) -> smartsheet.Smartsheet:
+    client = smartsheet.Smartsheet(access_token='abc123', api_base='http://localhost:8082/2.0')
+    client.with_wiremock_test_case(test_name, request_id)
+    return client
+
+
+def get_wiremock_request(request_id: str) -> dict:
+    """
+    Fetch request details from WireMock admin API using the request ID.
+
+    Args:
+        request_id (str): The unique request ID to search for
+
+    Returns:
+        dict: The request details from WireMock, or None if not found
+
+    Raises:
+        requests.RequestException: If the HTTP request fails
+        ValueError: If not exactly 1 match
+    """
+    admin_url = "http://localhost:8082/__admin/requests/find"
+
+    # Search for requests with the specific request ID in headers
+    search_criteria = {
+        "headers": {
+            "X-Request-Id": {
+                "equalTo": request_id
+            }
+        }
+    }
+
+    response = requests.post(admin_url, json=search_criteria, timeout=30)
+    response.raise_for_status()
+
+    data = response.json()
+    requests_found = data.get("requests", [])
+
+    if len(requests_found) != 1:
+        raise ValueError(f'Found {len(requests_found)} requests, expected 1')
+    return requests_found[0]

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/tests/mock_api/test_mock_api_automation_rules.py

@@ -2,7 +2,7 @@
 
 import smartsheet
 import pytest
-from mock_api_test_helper import MockApiTestHelper, clean_api_error
+from tests.mock_api.mock_api_test_helper import MockApiTestHelper, clean_api_error
 
 
 class TestMockApiSheets(MockApiTestHelper):

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/tests/mock_api/test_mock_api_columns.py

@@ -1,7 +1,7 @@
 # pylint: disable=C0103,W0232
 
 from smartsheet.models import Column
-from mock_api_test_helper import MockApiTestHelper, clean_api_error
+from tests.mock_api.mock_api_test_helper import MockApiTestHelper, clean_api_error
 
 class TestMockApiColumns(MockApiTestHelper):
     @clean_api_error

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/tests/mock_api/test_mock_api_folders.py

@@ -3,7 +3,7 @@
 import pytest
 from smartsheet.models import Folder, PaginatedChildrenResult, Sheet, Sight, Report
 from smartsheet.exceptions import ApiError
-from mock_api_test_helper import MockApiTestHelper, clean_api_error
+from tests.mock_api.mock_api_test_helper import MockApiTestHelper, clean_api_error
 
 
 class TestMockApiFolders(MockApiTestHelper):
@@ -181,4 +181,4 @@ class TestMockApiFolders(MockApiTestHelper):
         assert sight.access_level == "EDITOR"
 
         # Verify the lastKey is returned in the response
-        assert response.last_key == "xvmnw4mnx8v9wriot20574xvnjoqt4iuhnow490"
+        assert response.last_key == "xvmnw4mnx8v9wriot20574xvnjoqt4iuhnow490"

{smartsheet_python_sdk-3.5.1 → smartsheet_python_sdk-3.5.3}/tests/mock_api/test_mock_api_rows.py

@@ -4,7 +4,7 @@ import pytest
 from smartsheet.models import Row, PredecessorList, Duration, ExplicitNull
 from smartsheet.exceptions import ApiError
 
-from mock_api_test_helper import MockApiTestHelper, clean_api_error
+from tests.mock_api.mock_api_test_helper import MockApiTestHelper, clean_api_error
 
 
 class TestMockApiRows(MockApiTestHelper):