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

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,5 +27,6 @@ If applicable, add screenshots to help explain your problem.
 
 **Environment (please complete the following information):**
  - OS: [e.g. Windows 10]
+ - Smartsheet API Version [e.g. 2.0]
  - Smartsheet Python SDK Version [e.g. 3.0.0]
  - Python Version [e.g. 3.10]

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.github/ISSUE_TEMPLATE/feature_request.md

@@ -15,3 +15,9 @@ A clear and concise description of what you want to happen.
 
 **Additional context**
 Add any other context or screenshots about the feature request here.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - Smartsheet API Version [e.g. 2.0]
+ - Smartsheet Python SDK Version [e.g. 3.0.0]
+ - Python Version [e.g. 3.10]

smartsheet-python-sdk-3.1.0/.github/pull_request_template.md

@@ -0,0 +1,43 @@
+# Pull Request
+
+## Description
+<!-- Provide a brief description of the changes in this PR -->
+
+## Related Issue
+<!-- Link to the related issue (if applicable) -->
+
+## Type of Change
+<!-- Check the relevant option by putting an x in the brackets -->
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Other (please describe):
+
+## Environment Information
+<!-- Please complete the following information -->
+- Smartsheet API Version: [e.g. 2.0]
+- Smartsheet Python SDK Version: [e.g. 3.0.0]
+- Python Version: [e.g. 3.10]
+
+## What Changes Were Made
+<!-- Describe the changes you've made in detail -->
+
+## Why These Changes Were Made
+<!-- Explain the reasoning behind these changes -->
+
+## Testing
+<!-- Describe the testing you've done to validate your changes -->
+
+## Checklist
+<!-- Check all that apply -->
+- [ ] My code follows the [style guidelines](../../../CONTRIBUTING.md#code-style-and-quality) of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Additional Notes
+<!-- Add any other context about the PR here -->

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.github/workflows/publish-distribution.yaml

@@ -9,19 +9,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
       - name: Build distribution
         run: |
           python setup.py sdist bdist_wheel
       - name: Archive distribution artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: distribution
           path: dist

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.github/workflows/publish-documentation.yaml

@@ -9,14 +9,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine sphinx sphinx_rtd_theme
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine sphinx sphinx_rtd_theme
       - name: Generate documentation
         run: |
           sphinx-apidoc -o docs-source smartsheet
@@ -40,4 +40,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.github/workflows/test-build.yaml

@@ -6,7 +6,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
@@ -24,17 +24,27 @@ jobs:
 
   mock-api-test:
     needs: lint
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         python-version: ["3.7", "3.8", "3.9", "3.10"]
+        include:
+          - python-version: "3.7"
+            os: ubuntu-22.04
+          - python-version: "3.8"
+            os: ubuntu-latest
+          - python-version: "3.9"
+            os: ubuntu-latest
+          - python-version: "3.10"
+            os: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          os: ${{ matrix.os }}
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
@@ -65,19 +75,17 @@ jobs:
     runs-on: ubuntu-latest
     needs: [mock-api-test]
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python ${{ matrix.python-version }}
+      - uses: actions/checkout@v4
+      - name: Set up Python
         uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
       - name: Install build packages
         run: |
-          pip install enum34 requests six python-dateutil setuptools-scm gitchangelog mako wheel twine 
+          pip install enum34 requests six python-dateutil setuptools-scm==7.1.0 gitchangelog mako wheel twine 
       - name: Build distribution
         run: |
           python setup.py sdist bdist_wheel
       - name: Archive distribution artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: distribution
           path: dist
@@ -87,7 +95,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: [build-packages-test]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install documentation tools
         run: |
           pip install sphinx sphinx_rtd_theme setuptools-scm
@@ -96,7 +104,7 @@ jobs:
       - name: Generate HTML
         run: sphinx-build -b html -d docs-source/_build/doctrees docs-source/. docs-source/_build/html
       - name: Upload artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: html-docs
           path: docs/build/html/

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/.gitignore

@@ -1,6 +1,7 @@
 .sw[op]
 .*.sw[op]
 *.pyc
+*.iml
 
 # Ignore setup.py artifacts
 build/

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

@@ -80,7 +80,7 @@ response = client.Passthrough.post('/sheets', payload)
 
 ### Integration Tests
 
-1. Follow the instructions [here](tests/integration/README.md)
+1. Follow the [Integration test instructions](tests/integration/README.md)
 2. Run `pytest tests/integration`
 
 ### Mock API Tests
@@ -134,7 +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 [here.](https://smartsheet.redoc.ly/tag/eventsDescription)
+provided can be found on the [Events Description](https://smartsheet.redoc.ly/tag/eventsDescription) page of the API Documentation.
 
 ```python
 # this example is looking specifically for new sheet events
@@ -157,7 +157,7 @@ last_week = datetime.now() - timedelta(days=7)
 events_list = smartsheet_client.Events.list_events(since=last_week.isoformat(), max_count=1000)
 print_new_sheet_events_in_list(events_list)
 
-# continue listing events in the stream by using the stream_position, if the previous response indicates that more 
+# continue listing events in the stream by using the stream_position, if the previous response indicates that more
 # data is available.
 while events_list.more_available:
     events_list = smartsheet_client.Events.list_events(stream_position=events_list.next_stream_position, max_count=10000,

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

@@ -5,6 +5,37 @@ 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.1.0] - 2025-08-28
+
+### Added
+
+- New `get_workspace_metadata()` method to get workspace metadata without children
+- New `get_workspace_children()` method to get workspace children with filtering and pagination support
+- New `get_folder_metadata()` method to get folder metadata without children
+- New `get_folder_children()` method to get folder children with filtering and pagination support
+- New `TokenPaginatedResult<T>` generic model for type-safe paginated API responses
+- New `PaginatedChildrenResult` model with custom deserialization for mixed children types based on resourceType
+- Updated `list_workspaces()` method to support Token-based pagination . Use the new `pagination_type='token'` parameter with `last_key` and `max_items` for more efficient pagination. When `pagination_type='token'` is used, the method returns a `Result` object containing `data` and `lastKey`.
+
+### Deprecated
+
+- `get_workspace()` - Use `get_workspace_metadata()` and `get_workspace_children()` instead
+- `list_folders()` in Workspaces - Use `get_workspace_children()` with `children_resource_types=['folders']` instead
+- `get_folder()` - Use `get_folder_metadata()` and `get_folder_children()` instead
+- `list_folders()` in Folders - Use `get_folder_children()` with `children_resource_types=['folders']` instead
+- `create_folder()` in Home
+- `create_sheet()` in Home
+- `create_sheet_from_template()` in Home
+- `list_all_contents()` in Home
+- `list_folders()` in Home
+- `page_size`, `page`, and `include_all` parameters in `list_workspaces()` method are now deprecated. Use `pagination_type='token'` with `max_items` and `last_key` instead. Deprecated parameters will issue `DeprecationWarning` when used.
+
+## [3.0.5] - 2025-04-07
+
+### Changed
+
+- Fallback filename for `DownloadedFile` when `Content-Disposition` header is missing.
+
 ## [3.0.4] - 2024-07-29
 
 ### Changed
@@ -247,7 +278,7 @@ if sheet.access_level == 'OWNER':
     ...
 ```
 
-[enum34](https://pypi.python.org/pypi/enum34) has been added as a required package for the SDK  
+[enum34](https://pypi.python.org/pypi/enum34) has been added as a required package for the SDK
 
 ## [1.3.0] - 2018-02-21
 

smartsheet-python-sdk-3.1.0/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to Smartsheet Python SDK
+
+## Did you find a bug?
+
+- **Send all security related bugs to our maintainer email, <sdk-python@smartsheet.com>**.
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/smartsheet/smartsheet-python-sdk/issues).
+
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/smartsheet/smartsheet-python-sdk/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **[MRE code sample](https://stackoverflow.com/help/minimal-reproducible-example)** or an **executable test case** demonstrating the expected behavior that is not occurring. If possible please also note if this issue concerns the API itself or just the Python SDK.
+
+## Did you write a patch that fixes a bug?
+
+- Open a new GitHub pull request with the patch.
+
+- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+- A maintainer should review your PR within the next few days. If the PR has been dormant for more than a week, consider sending an email to <sdk-python@smartsheet.com>
+
+## Did you fix whitespace, format code, or make a purely cosmetic patch?
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability may take longer to review, but are still welcome.
+
+## Do you intend to add a new feature or change an existing one?
+
+- Suggest your change as an issue with the label #enhancement. Make sure that your new feature description outlines why this would be helpful for users, and how difficult a change it would be to make.
+
+## Code Style and Quality
+
+- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guidelines for Python code.
+
+- Use meaningful variable and function names that clearly describe their purpose.
+
+- Include docstrings for all public modules, functions, classes, and methods following [PEP 257](https://www.python.org/dev/peps/pep-0257/) conventions.
+
+- Run pylint on your code before submitting a PR. The project includes a pylintrc file with project-specific settings.
+
+- Write unit tests for new features and bug fixes. All tests should pass before submitting a PR.
+
+## Running Tests
+
+- To run the test suite, use the following command:
+
+  ```bash
+  python -m pytest tests/
+  ```
+
+- For integration tests, you'll need to set up your Smartsheet API access token as an environment variable:
+
+  ```bash
+  export SMARTSHEET_ACCESS_TOKEN=your_token_here
+  ```
+
+## Do you have questions about the source code or using the SDK?
+
+- For general information on the API and its uses, see the [Smartsheet API Reference](https://smartsheet.redoc.ly/)
+
+- For information on the Python SDK, see the [Smartsheet Python SDK Documentation](https://github.com/smartsheet/smartsheet-python-sdk#readme) or review the [basic](https://github.com/smartsheet/smartsheet-python-sdk#readme) and [advanced](https://github.com/smartsheet/smartsheet-python-sdk/blob/master/ADVANCED.md) READMEs!
+
+- Github issues can also be used for questions on using the Python SDK specifically.
+
+Thanks!
+
+Smartsheet Python SDK Team

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: smartsheet-python-sdk
-Version: 3.0.4
+Version: 3.1.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/pylintrc

@@ -0,0 +1,14 @@
+[MASTER]
+jobs=0
+
+[MESSAGES CONTROL]
+disable=missing-docstring,too-many-arguments,too-many-positional-arguments,locally-disabled,too-few-public-methods,too-many-public-methods,duplicate-code,too-many-instance-attributes,too-many-lines,no-else-return,unused-private-member,cyclic-import,unused-import,import-outside-toplevel,consider-using-with
+
+[REPORTS]
+output-format=colorized
+
+[BASIC]
+include-naming-hint=yes
+
+[FORMAT]
+max-line-length=160

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/setup.py

@@ -63,7 +63,7 @@ setup(
     use_scm_version={
         'write_to': 'smartsheet/version.py'
     },
-    setup_requires=['setuptools_scm'],
+    setup_requires=['setuptools_scm==7.0.1'],
     install_requires=REQUIRES,
     packages=find_packages(),
     include_package_data=True,

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/cells.py

@@ -55,6 +55,7 @@ class Cells:
             page (int): Which page to return.
             include_all (bool): If true, include all results
                 (i.e. do not paginate).
+            level (int): compatibility level
 
         Returns:
             IndexResult

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/folders.py

@@ -22,6 +22,7 @@ import os.path
 
 from . import fresh_operation
 from .models.folder import Folder
+from .util import deprecated
 
 
 class Folders:
@@ -173,9 +174,13 @@ class Folders:
 
         return response
 
+    @deprecated
     def get_folder(self, folder_id, include=None):
         """Get the specified Folder (and list its contents).
 
+        Deprecated: 3.1.0
+           Use `get_folder_metadata` and `get_folder_children` instead.
+
         Args:
             folder_id (int): Folder ID
             include (list[str]): A comma-separated list of
@@ -196,9 +201,13 @@ class Folders:
 
         return response
 
+    @deprecated
     def list_folders(self, folder_id, page_size=None, page=None, include_all=None):
         """Get a list of top-level child Folders within the specified Folder.
 
+        Deprecated: 3.1.0
+           Use `get_folder_children` with children_resource_types=['folders'] instead.
+
         Args:
             folder_id (int): Folder ID
             page_size (int): The maximum number of items to
@@ -272,6 +281,59 @@ class Folders:
 
         return response
 
+    def get_folder_metadata(self, folder_id, include=None):
+        """Get the metadata of a folder.
+
+        Args:
+            folder_id (int): Folder ID
+            include (list[str]): A list of optional elements to include
+            in the response. Valid list values: source.
+
+        Returns:
+            Folder
+        """
+        _op = fresh_operation("get_folder_metadata")
+        _op["method"] = "GET"
+        _op["path"] = "/folders/" + str(folder_id) + "/metadata"
+        _op["query_params"]["include"] = include
+
+        expected = "Folder"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_folder_children(self, folder_id, children_resource_types=None, include=None, last_key=None, max_items=None):
+        """Get the children of a folder.
+
+        Args:
+            folder_id (int): Folder ID
+            children_resource_types (list[str]): The types of the children resources.
+                If not provided, returns children of all types.
+                Valid list values: sheets, reports, sights, folders.
+            include (list[str]): A list of optional elements to include in the
+                response. Valid list values: source, ownerInfo.
+            last_key (str): The token from a previous request that will allow this one
+                to fetch the next page of results.
+            max_items (int): The maximum number of items to return in the response.
+
+        Returns:
+            PaginatedChildrenResult
+        """
+        _op = fresh_operation("get_folder_children")
+        _op["method"] = "GET"
+        _op["path"] = "/folders/" + str(folder_id) + "/children"
+        _op["query_params"]["childrenResourceTypes"] = children_resource_types
+        _op["query_params"]["include"] = include
+        _op["query_params"]["lastKey"] = last_key
+        _op["query_params"]["maxItems"] = max_items
+
+        expected = "PaginatedChildrenResult"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
     def import_csv_sheet(
         self,
         folder_id,

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/home.py

@@ -22,6 +22,7 @@ import logging
 from . import fresh_operation
 from .models.folder import Folder
 from .models.sheet import Sheet
+from .util import deprecated
 
 
 class Home:
@@ -33,6 +34,7 @@ class Home:
         self._base = smartsheet_obj
         self._log = logging.getLogger(__name__)
 
+    @deprecated
     def create_folder(self, folder_obj):
         """Creates a Folder in the user's Sheets folder (Home).
 
@@ -57,6 +59,7 @@ class Home:
 
         return response
 
+    @deprecated
     def create_sheet(self, sheet_obj):
         """Create a Sheet from scratch in the user's Sheets folder within
         Home.
@@ -82,6 +85,7 @@ class Home:
 
         return response
 
+    @deprecated
     def create_sheet_from_template(self, sheet_obj, include=None):
         """Create a Sheet in the Sheets folder from the specified Template.
 
@@ -118,6 +122,7 @@ class Home:
 
         return response
 
+    @deprecated
     def list_all_contents(self, include=None, exclude=None):
         """Get a nested list of all Home objects, including Sheets,
         Workspaces, Folders, Reports and Templates.
@@ -145,6 +150,7 @@ class Home:
 
         return response
 
+    @deprecated
     def list_folders(self, page_size=None, page=None, include_all=None):
         """Gets a list of top-level child Folders within the user's Sheets
         folder.

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

@@ -73,6 +73,8 @@ from .multi_row_email import MultiRowEmail
 from .number_object_value import NumberObjectValue
 from .o_auth_error import OAuthError
 from .object_value import ObjectValue
+from .paginated_children_result import PaginatedChildrenResult
+from .token_paginated_result import TokenPaginatedResult
 from .predecessor import Predecessor
 from .predecessor_list import PredecessorList
 from .project_settings import ProjectSettings

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/models/datetime_object_value.py

@@ -26,10 +26,10 @@ from .object_value import ObjectValue, six
 
 
 class DatetimeObjectValue(ObjectValue):
-    """Smartsheet DateObjectValue data model."""
+    """Smartsheet DatetimeObjectValue data model."""
 
     def __init__(self, props=None, object_type=None, base_obj=None):
-        """Initialize the DateObjectValue model."""
+        """Initialize the DatetimeObjectValue model."""
         super().__init__(object_type, base_obj)
         self._base = None
         if base_obj is not None:

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/models/folder.py

@@ -17,11 +17,12 @@
 
 from __future__ import absolute_import
 
-from ..types import Boolean, Number, String, TypedList, json
+from ..types import Boolean, Number, String, Timestamp, TypedList, TypedObject, json
 from ..util import deserialize, serialize
 from .report import Report
 from .sheet import Sheet
 from .sight import Sight
+from .source import Source
 from .template import Template
 
 
@@ -35,14 +36,17 @@ class Folder:
         if base_obj is not None:
             self._base = base_obj
 
+        self._created_at = Timestamp()
         self._favorite = Boolean()
         self._folders = TypedList(Folder)
         self._id_ = Number()
+        self._modified_at = Timestamp()
         self._name = String()
         self._permalink = String()
         self._reports = TypedList(Report)
         self._sheets = TypedList(Sheet)
         self._sights = TypedList(Sight)
+        self._source = TypedObject(Source)
         self._templates = TypedList(Template)
 
         if props:
@@ -64,6 +68,14 @@ class Folder:
         else:
             super().__setattr__(key, value)
 
+    @property
+    def created_at(self):
+        return self._created_at.value
+
+    @created_at.setter
+    def created_at(self, value):
+        self._created_at.value = value
+
     @property
     def favorite(self):
         return self._favorite.value
@@ -88,6 +100,14 @@ class Folder:
     def id_(self, value):
         self._id_.value = value
 
+    @property
+    def modified_at(self):
+        return self._modified_at.value
+
+    @modified_at.setter
+    def modified_at(self, value):
+        self._modified_at.value = value
+
     @property
     def name(self):
         return self._name.value
@@ -128,6 +148,14 @@ class Folder:
     def sights(self, value):
         self._sights.load(value)
 
+    @property
+    def source(self):
+        return self._source.value
+
+    @source.setter
+    def source(self, value):
+        self._source.value = value
+
     @property
     def templates(self):
         return self._templates

{smartsheet-python-sdk-3.0.4 → smartsheet-python-sdk-3.1.0}/smartsheet/models/index_result.py

@@ -17,7 +17,7 @@
 
 from __future__ import absolute_import
 
-from ..types import Number, TypedList, importlib, json
+from ..types import Number, TypedList, importlib, json, String
 from ..util import deserialize, serialize
 
 
@@ -40,6 +40,7 @@ class IndexResult:
         self._page_size = Number()
         self._total_count = Number()
         self._total_pages = Number()
+        self._last_key = String()
 
         if props:
             deserialize(self, props)
@@ -94,6 +95,14 @@ class IndexResult:
     def total_pages(self, value):
         self._total_pages.value = value
 
+    @property
+    def last_key(self):
+        return self._last_key.value
+
+    @last_key.setter
+    def last_key(self, value):
+        self._last_key.value = value
+
     @property
     def result(self):
         """Simplify difference between Result and IndexResult"""