smartsheet-python-sdk 3.1.0__tar.gz → 3.2.0__tar.gz

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/ADVANCED.md

@@ -134,6 +134,7 @@ using the same `stream_position` value until the next list of events is retrieve
 Many events have additional information available as a part of the event. That information can be accessed using
 the Python dictionary stored in the `additional_details` property (Note that values of the `additional_details`
 dictionary use camelCase/JSON names, e.g. `sheetName` not `sheet_name`). Information about the additional details
+
 provided can be found on the [Events Description](https://smartsheet.redoc.ly/tag/eventsDescription) page of the API Documentation.
 
 ```python

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/CHANGELOG.md

@@ -5,6 +5,16 @@ 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.2.0] - 2025-09-25
+
+### Added
+
+- Support for POST /2.0/users/{userId}/plans/{planId}/downgrade
+- Support for POST /2.0/users/{userId}/plans/{planId}/upgrade
+- Support for GET /2.0/users/{userId}/plans
+- Support for GET /2.0/users?planId={planId}&seatType={seatType}
+- Support for DELETE /2.0/users/{userId}/plans/{planId}
+
 ## [3.1.0] - 2025-08-28
 
 ### Added

{smartsheet-python-sdk-3.1.0/smartsheet_python_sdk.egg-info → smartsheet-python-sdk-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.1.0
+Version: 3.2.0
 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.1.0 → smartsheet-python-sdk-3.2.0}/docs-source/index.rst

@@ -7,7 +7,11 @@
 Smartsheet Python SDK Documentation
 ===================================
 
-Release v\ |version|.
+* Release v\ |version|
+
+* `GitHub repository <https://github.com/smartsheet/smartsheet-python-sdk>`_
+
+* `Changelog <https://github.com/smartsheet/smartsheet-python-sdk/blob/mainline/CHANGELOG.md>`_
 
 Quickstart
 ----------

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/models/__init__.py

@@ -121,3 +121,4 @@ from .webhook_subscope import WebhookSubscope
 from .widget import Widget
 from .widget_content import WidgetContent
 from .workspace import Workspace
+from .user_plan import UserPlan

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/models/enums/__init__.py

@@ -52,3 +52,4 @@ from .system_column_type import SystemColumnType
 from .update_request_status import UpdateRequestStatus
 from .user_status import UserStatus
 from .widget_type import WidgetType
+from .seat_type import SeatType, DowngradeSeatType, UpgradeSeatType

smartsheet-python-sdk-3.2.0/smartsheet/models/enums/seat_type.py

@@ -0,0 +1,17 @@
+from enum import Enum
+
+class SeatType(str, Enum):
+    VIEWER = 'VIEWER'
+    GUEST = 'GUEST'
+    MEMBER = 'MEMBER'
+    PROVISIONAL_MEMBER = 'PROVISIONAL_MEMBER'
+
+
+class DowngradeSeatType(str, Enum):
+    VIEWER = 'VIEWER'
+    GUEST = 'GUEST'
+
+
+class UpgradeSeatType(str, Enum):
+    GUEST = 'GUEST'
+    MEMBER = 'MEMBER'

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/models/token_paginated_result.py

@@ -18,7 +18,7 @@
 from __future__ import absolute_import
 
 from typing import TypeVar, Generic, List
-from ..types import String, json
+from ..types import String, json, TypedList, importlib
 from ..util import deserialize, serialize
 
 T = TypeVar('T')
@@ -27,13 +27,17 @@ T = TypeVar('T')
 class TokenPaginatedResult(Generic[T]):
     """Smartsheet TokenPaginatedResult data model with generic type support."""
 
-    def __init__(self, props=None, base_obj=None):
+    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._data = []
+        self._dynamic_data_type = None
+        if dynamic_data_type is not None:
+            self._dynamic_data_type = dynamic_data_type
+
+        self._data = TypedList(object)
         self._last_key = String()
 
         if props:
@@ -48,7 +52,14 @@ class TokenPaginatedResult(Generic[T]):
 
     @data.setter
     def data(self, value):
-        self._data = value
+        class_ = getattr(
+            importlib.import_module("smartsheet.models"), self._dynamic_data_type
+        )
+        if isinstance(value, list):
+            self._data = [class_(x, self._base) for x in value]
+        else:
+            self._data = class_(value, self._base)
+
 
     @property
     def last_key(self):

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/models/user_model.py

@@ -19,6 +19,7 @@ from __future__ import absolute_import
 
 from ..types import (Boolean, EnumeratedValue, Number, String, Timestamp,
                      TypedList, TypedObject, json)
+from ..models.enums import SeatType
 from ..util import deserialize, serialize
 from .alternate_email import AlternateEmail
 from .enums import UserStatus
@@ -44,6 +45,7 @@ class UserModel:
         self._first_name = String()
         self._group_admin = Boolean()
         self._id_ = Number()
+        self._is_internal = Boolean()
         self._last_login = Timestamp()
         self._last_name = String()
         self._licensed_sheet_creator = Boolean()
@@ -51,6 +53,8 @@ class UserModel:
         self._profile_image = TypedObject(ProfileImage)
         self._resource_viewer = Boolean()
         self._role = String()
+        self._seat_type = EnumeratedValue(SeatType)
+        self._seat_type_last_changed_at = Timestamp()
         self._sheet_count = Number()
         self._status = EnumeratedValue(UserStatus)
         self._title = String()
@@ -145,6 +149,14 @@ class UserModel:
     def id_(self, value):
         self._id_.value = value
 
+    @property
+    def is_internal(self):
+        return self._is_internal.value
+
+    @is_internal.setter
+    def is_internal(self, value):
+        self._is_internal.value = value
+
     @property
     def last_login(self):
         return self._last_login.value
@@ -201,6 +213,22 @@ class UserModel:
     def role(self, value):
         self._role.value = value
 
+    @property
+    def seat_type(self):
+        return self._seat_type
+
+    @seat_type.setter
+    def seat_type(self, value):
+        self._seat_type.set(value)
+
+    @property
+    def seat_type_last_changed_at(self):
+        return self._seat_type_last_changed_at.value
+
+    @seat_type_last_changed_at.setter
+    def seat_type_last_changed_at(self, value):
+        self._seat_type_last_changed_at.value = value
+
     @property
     def sheet_count(self):
         return self._sheet_count.value

smartsheet-python-sdk-3.2.0/smartsheet/models/user_plan.py

@@ -0,0 +1,68 @@
+from __future__ import absolute_import
+
+from ..types import (Boolean, EnumeratedValue, Number, String, Timestamp,
+                     TypedList, TypedObject, json)
+from ..models.enums import SeatType
+from ..util import deserialize, serialize
+
+
+class UserPlan:
+
+    """Smartsheet Plan for a User data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the UserPlan model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._plan_id = Number()
+        self._seat_type = EnumeratedValue(SeatType)
+        self._seat_type_last_changed_at = Timestamp()
+        self._is_internal = Boolean()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def plan_id(self):
+        return self._plan_id.value
+
+    @plan_id.setter
+    def plan_id(self, value):
+        self._plan_id.value = value
+
+    @property
+    def seat_type(self):
+        return self._seat_type
+
+    @seat_type.setter
+    def seat_type(self, value):
+        self._seat_type.set(value)
+
+    @property
+    def seat_type_last_changed_at(self):
+        return self._seat_type_last_changed_at.value
+
+    @seat_type_last_changed_at.setter
+    def seat_type_last_changed_at(self, value):
+        self._seat_type_last_changed_at.value = value
+
+    @property
+    def is_internal(self):
+        return self._is_internal.value
+
+    @is_internal.setter
+    def is_internal(self, value):
+        self._is_internal.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.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/users.py

@@ -21,6 +21,7 @@ import logging
 from datetime import datetime
 
 from . import fresh_operation
+from .models.enums.seat_type import SeatType
 
 
 class Users:
@@ -254,7 +255,8 @@ class Users:
         return response
 
     def list_users(
-        self, email=None, page_size=None, page=None, include_all=None, include=None
+        self, email=None, page_size=None, page=None, include_all=None, include=None,
+        plan_id=None, seat_type=None
     ):
         """Get the list of Users in the organization.
 
@@ -268,6 +270,10 @@ class Users:
                 (i.e. do not paginate).
             include(list[str]): optional include parameter, only current
                 accepted value is 'lastLogin'
+            plan_id(int): optional plan_id parameter, returns users
+                in the selected plan.
+            seat_type(SeatType): optional seat_type parameter, filters users
+                by their seat type.
 
         Returns:
             IndexResult
@@ -280,6 +286,8 @@ class Users:
         _op["query_params"]["pageSize"] = page_size
         _op["query_params"]["page"] = page
         _op["query_params"]["includeAll"] = include_all
+        _op["query_params"]["planId"] = plan_id
+        _op["query_params"]["seatType"] = seat_type
 
         expected = ["IndexResult", "User"]
 
@@ -358,6 +366,91 @@ class Users:
 
         return response
 
+    def upgrade_user(self, user_id, plan_id, seat_type):
+        """Upgrades a user for a plan.
+
+        Args:
+            user_id (int): User ID
+            plan_id (int): Plan ID
+            seat_type (UpgradeSeatType): Seat type to upgrade to
+
+        Returns:
+            dict: Result
+        """
+        _op = fresh_operation("upgrade_user")
+        _op["method"] = "POST"
+        _op["path"] = f"/users/{user_id}/plans/{plan_id}/upgrade"
+        _op["json"] = {"seatType": seat_type}
+
+        expected = ["Result", None]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def downgrade_user(self, user_id, plan_id, seat_type):
+        """Downgrades a user for a plan.
+
+        Args:
+            user_id (int): User ID
+            plan_id (int): Plan ID
+            seat_type (DowngradeSeatType): Seat type to downgrade to
+
+        Returns:
+            dict: Result
+        """
+        _op = fresh_operation("downgrade_user")
+        _op["method"] = "POST"
+        _op["path"] = f"/users/{user_id}/plans/{plan_id}/downgrade"
+        _op["json"] = {"seatType": seat_type}
+
+        expected = ["Result", None]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_user_plans(self, user_id, last_key=None, max_items=None):
+        """List user's plans.
+                Args:
+                    user_id (int): User ID
+                Returns:
+                    TokenPaginatedResult
+         """
+        _op = fresh_operation("list_user_plans")
+        _op["method"] = "GET"
+        _op["path"] = f"/users/{user_id}/plans"
+        _op["query_params"]["lastKey"] = last_key
+        _op["query_params"]["maxItems"] = max_items
+
+        expected = ["TokenPaginatedResult", "UserPlan"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def remove_user_from_plan(self, user_id, plan_id):
+        """Remove user from plan.
+                        Args:
+                            user_id (int): User ID
+                            plan_id (int): Plan ID
+                        Returns:
+                            Result
+                 """
+        _op = fresh_operation("remove_user_from_plan")
+        _op["method"] = "DELETE"
+        _op["path"] = f"/users/{user_id}/plans/{plan_id}"
+
+        expected = ["Result", None]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def add_profile_image(self, user_id, file, file_type):
         """Uploads a profile image for the specified user.
 

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet/version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '3.1.0'
-__version_tuple__ = version_tuple = (3, 1, 0)
+__version__ = version = '3.2.0'
+__version_tuple__ = version_tuple = (3, 2, 0)

{smartsheet-python-sdk-3.1.0 → smartsheet-python-sdk-3.2.0/smartsheet_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.1.0
+Version: 3.2.0
 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.1.0 → smartsheet-python-sdk-3.2.0}/smartsheet_python_sdk.egg-info/SOURCES.txt

@@ -158,6 +158,7 @@ smartsheet/models/token_paginated_result.py
 smartsheet/models/update_request.py
 smartsheet/models/user.py
 smartsheet/models/user_model.py
+smartsheet/models/user_plan.py
 smartsheet/models/user_profile.py
 smartsheet/models/version.py
 smartsheet/models/web_content_widget_content.py
@@ -193,6 +194,7 @@ smartsheet/models/enums/paper_type.py
 smartsheet/models/enums/predecessor_type.py
 smartsheet/models/enums/publish_accessible_by.py
 smartsheet/models/enums/schedule_type.py
+smartsheet/models/enums/seat_type.py
 smartsheet/models/enums/share_scope.py
 smartsheet/models/enums/share_type.py
 smartsheet/models/enums/sheet_email_format.py