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

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

@@ -5,6 +5,12 @@ 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.4] - 2025-10-31
+
+### Fixed
+
+- [Issue-92](https://github.com/smartsheet/smartsheet-python-sdk/issues/92): Only include the `smartsheet` package in the build.
+
 ## [3.5.3] - 2025-10-31
 
 ### Fixed

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet_python_sdk
-Version: 3.5.3
+Version: 3.5.4
 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

{smartsheet_python_sdk-3.5.3 → smartsheet_python_sdk-3.5.4}/setup.py

@@ -65,7 +65,7 @@ setup(
     },
     setup_requires=['setuptools_scm==7.0.1'],
     install_requires=REQUIRES,
-    packages=find_packages(),
+    packages=find_packages(include=['smartsheet', 'smartsheet.*']),
     include_package_data=True,
     long_description=open('README.md').read(),
     long_description_content_type='text/markdown',

{smartsheet_python_sdk-3.5.3 → smartsheet_python_sdk-3.5.4}/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.3'
-__version_tuple__ = version_tuple = (3, 5, 3)
+__version__ = version = '3.5.4'
+__version_tuple__ = version_tuple = (3, 5, 4)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartsheet_python_sdk
-Version: 3.5.3
+Version: 3.5.4
 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

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

@@ -262,4 +262,8 @@ tests/mock_api/test_mock_api_sheets.py
 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/test_mock_serialization.py
+tests/mock_api/users/common_test_constants.py
+tests/mock_api/users/test_list_user_plans.py
+tests/mock_api/users/test_list_users.py
+tests/mock_api/users/test_user_upgrade_downgrade.py

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

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

smartsheet_python_sdk-3.5.4/tests/mock_api/users/common_test_constants.py

@@ -0,0 +1,4 @@
+TEST_USER_ID = 1234567890
+TEST_PLAN_ID = 1234567890123456
+TEST_SUCCESS_MESSAGE = "SUCCESS"
+TEST_RESULT_CODE = 0

smartsheet_python_sdk-3.5.4/tests/mock_api/users/test_list_user_plans.py

@@ -0,0 +1,110 @@
+import uuid
+
+from urllib.parse import urlparse, parse_qs
+from dateutil import parser
+from smartsheet.models.enums import seat_type
+from smartsheet.models.token_paginated_result import TokenPaginatedResult
+from smartsheet.models.error import Error
+from tests.mock_api.users.common_test_constants import TEST_USER_ID, TEST_PLAN_ID
+from tests.mock_api.mock_api_test_helper import (
+    get_mock_api_client,
+    get_wiremock_request,
+)
+
+TEST_LAST_KEY = '12345678901234569'
+TEST_MAX_ITEMS = 100
+TEST_SEAT_TYPE = seat_type.SeatType.MEMBER
+
+def test_list_user_plans_generated_url_is_correct():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-user-plans/all-response-body-properties", request_id
+    )
+
+    client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    wiremock_request = get_wiremock_request(request_id)
+    url = urlparse(wiremock_request["absoluteUrl"])
+    query = parse_qs(url.query)
+    assert query == {
+        "lastKey": [TEST_LAST_KEY],
+        "maxItems": [str(TEST_MAX_ITEMS)]
+    }
+    assert url.path == f"/2.0/users/{TEST_USER_ID}/plans"
+
+
+def test_list_user_plans_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-user-plans/all-response-body-properties", request_id
+    )
+
+    response = client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    assert isinstance(response, TokenPaginatedResult)
+    assert response.last_key == TEST_LAST_KEY
+    assert response.data[0].plan_id == TEST_PLAN_ID
+    assert response.data[0].seat_type == TEST_SEAT_TYPE.value
+    assert response.data[0].seat_type_last_changed_at == parser.isoparse(
+        "2025-01-01T00:00:00.123456789Z")
+    assert response.data[0].provisional_expiration_date == parser.isoparse(
+        "2026-12-13T12:17:52.525696Z")
+    assert response.data[0].is_internal is False
+
+
+def test_list_user_plans_required_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-user-plans/required-response-body-properties", request_id
+    )
+
+    response = client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    assert isinstance(response, TokenPaginatedResult)
+    assert response.data[0].plan_id == TEST_PLAN_ID
+    assert response.data[0].seat_type == TEST_SEAT_TYPE.value
+    assert response.data[0].seat_type_last_changed_at is None
+    assert response.data[0].provisional_expiration_date is None
+    assert response.data[0].is_internal is False
+
+
+def test_list_user_plans_error_400_response():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/400-response", request_id
+    )
+
+    response = client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_list_user_plans_error_500_reponse():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/500-response", request_id
+    )
+
+    response = client.Users.list_user_plans(
+        user_id=TEST_USER_ID,
+        last_key=TEST_LAST_KEY,
+        max_items=TEST_MAX_ITEMS
+    )
+
+    assert isinstance(response, Error)

smartsheet_python_sdk-3.5.4/tests/mock_api/users/test_list_users.py

@@ -0,0 +1,147 @@
+import uuid
+
+from urllib.parse import urlparse, parse_qs
+from dateutil import parser
+from smartsheet.models.enums import seat_type
+from smartsheet.models.index_result import IndexResult
+from smartsheet.models.error import Error
+from tests.mock_api.users.common_test_constants import TEST_PLAN_ID
+from tests.mock_api.mock_api_test_helper import (
+    get_mock_api_client,
+    get_wiremock_request,
+)
+
+TEST_EMAIL = "test.user@smartsheet.com"
+TEST_SEAT_TYPE = seat_type.SeatType.MEMBER
+TEST_PAGE = 1
+TEST_PAGE_SIZE = 100
+TEST_INCLUDE_ALL = False
+TEST_FIRST_NAME = "Test"
+TEST_LAST_NAME = "User"
+TEST_NAME = "Test User"
+TEST_ADMIN = True
+TEST_LICENSED_SHEET_CREATOR = True
+TEST_RESOURCE_VIEWER = True
+TEST_GROUP_ADMIN = True
+TEST_STATUS = "ACTIVE"
+TEST_SHEET_COUNT = -1
+TEST_ID_VALUE = TEST_PLAN_ID
+TEST_SEAT_TYPE_LAST_CHANGED_AT = parser.isoparse("2025-06-14T09:55:30Z")
+TEST_PROVISIONAL_EXPIRATION_DATE = parser.isoparse("2026-12-13T12:17:52.525696Z")
+TEST_IS_INTERNAL_TRUE = True
+TEST_IS_INTERNAL_FALSE = False
+TEST_LAST_LOGIN = parser.isoparse("2020-10-04T18:32:47Z")
+TEST_CUSTOM_WELCOME_SCREEN_VIEWED = parser.isoparse("2020-08-25T12:15:47Z")
+
+def test_list_users_generated_url_is_correct():
+    request_id = uuid.uuid4().hex
+
+    client = get_mock_api_client(
+        "/users/list-users/required-response-body-properties", request_id
+    )
+
+    client.Users.list_users(
+        email=TEST_EMAIL,
+        seat_type=TEST_SEAT_TYPE.value,
+        page=TEST_PAGE,
+        page_size=TEST_PAGE_SIZE,
+        include_all=TEST_INCLUDE_ALL
+    )
+
+    wiremock_request = get_wiremock_request(request_id)
+    url = urlparse(wiremock_request["absoluteUrl"])
+    query = parse_qs(url.query)
+    assert query == {
+        "email": [TEST_EMAIL],
+        "seatType": [TEST_SEAT_TYPE.value],
+        "page": [str(TEST_PAGE)],
+        "pageSize": [str(TEST_PAGE_SIZE)],
+        "includeAll": [str(TEST_INCLUDE_ALL)]
+    }
+    assert url.path == "/2.0/users"
+
+
+def test_list_users_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-users/all-response-body-properties", request_id
+    )
+
+    response = client.Users.list_users(
+        plan_id=TEST_PLAN_ID
+    )
+
+    assert isinstance(response, IndexResult)
+    assert response.data[0].seat_type == TEST_SEAT_TYPE.value
+    assert response.data[0].seat_type_last_changed_at == TEST_SEAT_TYPE_LAST_CHANGED_AT
+    assert response.data[0].provisional_expiration_date == TEST_PROVISIONAL_EXPIRATION_DATE
+    assert response.data[0].is_internal is TEST_IS_INTERNAL_TRUE
+    assert response.data[0].first_name == TEST_FIRST_NAME
+    assert response.data[0].last_name == TEST_LAST_NAME
+    assert response.data[0].name == TEST_NAME
+    assert response.data[0].email == TEST_EMAIL
+    assert response.data[0].admin is TEST_ADMIN
+    assert response.data[0].licensed_sheet_creator is TEST_LICENSED_SHEET_CREATOR
+    assert response.data[0].resource_viewer is TEST_RESOURCE_VIEWER
+    assert response.data[0].group_admin is TEST_GROUP_ADMIN
+    assert response.data[0].status == TEST_STATUS
+    assert response.data[0].sheet_count == TEST_SHEET_COUNT
+    assert response.data[0].last_login == TEST_LAST_LOGIN
+    assert response.data[0].custom_welcome_screen_viewed == TEST_CUSTOM_WELCOME_SCREEN_VIEWED
+    assert response.data[0].id == TEST_ID_VALUE
+
+
+def test_list_users_required_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/list-users/required-response-body-properties", request_id
+    )
+
+    response = client.Users.list_users(
+        plan_id=TEST_PLAN_ID
+    )
+
+    assert isinstance(response, IndexResult)
+    assert response.data[0].seat_type == TEST_SEAT_TYPE.value
+    assert response.data[0].seat_type_last_changed_at is None
+    assert response.data[0].provisional_expiration_date is None
+    assert response.data[0].is_internal is TEST_IS_INTERNAL_TRUE
+    assert response.data[0].first_name == TEST_FIRST_NAME
+    assert response.data[0].last_name == TEST_LAST_NAME
+    assert response.data[0].name == TEST_NAME
+    assert response.data[0].email == TEST_EMAIL
+    assert response.data[0].admin is TEST_ADMIN
+    assert response.data[0].licensed_sheet_creator is TEST_LICENSED_SHEET_CREATOR
+    assert response.data[0].resource_viewer is TEST_RESOURCE_VIEWER
+    assert response.data[0].group_admin is TEST_GROUP_ADMIN
+    assert response.data[0].status == TEST_STATUS
+    assert response.data[0].sheet_count == TEST_SHEET_COUNT
+    assert response.data[0].last_login is None
+    assert response.data[0].custom_welcome_screen_viewed is None
+    assert response.data[0].id == TEST_ID_VALUE
+
+
+def test_list_users_error_400_response():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/400-response", request_id
+    )
+
+    response = client.Users.list_users(
+        plan_id=TEST_PLAN_ID
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_list_users_error_500_response():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/500-response", request_id
+    )
+
+    response = client.Users.list_users(
+        plan_id=TEST_PLAN_ID
+    )
+
+    assert isinstance(response, Error)

smartsheet_python_sdk-3.5.4/tests/mock_api/users/test_user_upgrade_downgrade.py

@@ -0,0 +1,147 @@
+import json
+import uuid
+from urllib.parse import urlparse
+
+from smartsheet.models import Error
+from smartsheet.models.enums import UpgradeSeatType, DowngradeSeatType
+from tests.mock_api.users.common_test_constants import TEST_USER_ID, TEST_PLAN_ID, TEST_SUCCESS_MESSAGE, TEST_RESULT_CODE
+from tests.mock_api.mock_api_test_helper import (
+    get_mock_api_client,
+    get_wiremock_request,
+)
+
+TEST_UPGRADE_SEAT_TYPE = UpgradeSeatType.MEMBER
+TEST_DOWNGRADE_SEAT_TYPE = DowngradeSeatType.VIEWER
+
+
+def test_upgrade_user_generated_url_is_correct():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/upgrade-user/all-response-body-properties", request_id
+    )
+
+    client.Users.upgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_UPGRADE_SEAT_TYPE,
+    )
+
+    wiremock_request = get_wiremock_request(request_id)
+    url = urlparse(wiremock_request["absoluteUrl"])
+    assert url.path == f'/2.0/users/{TEST_USER_ID}/plans/{TEST_PLAN_ID}/upgrade'
+
+
+def test_upgrade_user_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/upgrade-user/all-response-body-properties", request_id
+    )
+
+    response = client.Users.upgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_UPGRADE_SEAT_TYPE,
+    )
+
+    assert response.message == TEST_SUCCESS_MESSAGE
+    assert response.result_code == TEST_RESULT_CODE
+
+    wiremock_request = get_wiremock_request(request_id)
+    body = json.loads(wiremock_request["body"])
+    assert body == {"seatType": TEST_UPGRADE_SEAT_TYPE.value}
+
+def test_upgrade_user_error_4xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/400-response", request_id
+    )
+
+    response = client.Users.upgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_UPGRADE_SEAT_TYPE,
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_upgrade_user_error_5xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/500-response", request_id
+    )
+
+    response = client.Users.upgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_UPGRADE_SEAT_TYPE,
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_downgrade_user_generated_url_is_correct():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/downgrade-user/all-response-body-properties", request_id
+    )
+
+    client.Users.downgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_DOWNGRADE_SEAT_TYPE,
+    )
+
+    wiremock_request = get_wiremock_request(request_id)
+    url = urlparse(wiremock_request["absoluteUrl"])
+    assert url.path == f'/2.0/users/{TEST_USER_ID}/plans/{TEST_PLAN_ID}/downgrade'
+
+
+def test_downgrade_user_all_response_properties():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/users/downgrade-user/all-response-body-properties", request_id
+    )
+
+    response = client.Users.downgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_DOWNGRADE_SEAT_TYPE,
+    )
+
+    assert response.message == TEST_SUCCESS_MESSAGE
+    assert response.result_code == TEST_RESULT_CODE
+
+    wiremock_request = get_wiremock_request(request_id)
+    body = json.loads(wiremock_request["body"])
+    assert body == {"seatType": TEST_DOWNGRADE_SEAT_TYPE.value}
+
+
+def test_downgrade_user_error_4xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/400-response", request_id
+    )
+
+    response = client.Users.downgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_DOWNGRADE_SEAT_TYPE,
+    )
+
+    assert isinstance(response, Error)
+
+
+def test_downgrade_user_error_5xx():
+    request_id = uuid.uuid4().hex
+    client = get_mock_api_client(
+        "/errors/500-response", request_id
+    )
+
+    response = client.Users.downgrade_user(
+        user_id=TEST_USER_ID,
+        plan_id=TEST_PLAN_ID,
+        seat_type=TEST_DOWNGRADE_SEAT_TYPE,
+    )
+
+    assert isinstance(response, Error)