smartsheet-python-sdk 1.3.0__tar.gz → 1.3.1__tar.gz

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/.travis.yml

@@ -19,7 +19,7 @@ before_install:
 install:
   - pip install --upgrade pip
   - pip install certifi
-  - pip install requests six python-dateutil coverage coveralls[yaml] pytest pytest-travis-fold pytest-instafail requests-toolbelt
+  - pip install enum34 requests six python-dateutil coverage coveralls[yaml] pytest pytest-travis-fold pytest-instafail requests-toolbelt
 
 script:
   - smartsheet-sdk-tests/travis_scripts/start_wiremock.sh

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/CHANGELOG.md

@@ -6,11 +6,40 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.3.1] - 2018-3-1
+
+### Added
+- Implemented [cross-sheet References](http://smartsheet-platform.github.io/api-docs/?shell#cross-sheet-references)
+- Updated UserProfile and added support for profile images
+- Added an argument to the client constructor method to externally set the API base URI
+- Implemented [Automation Rules](http://smartsheet-platform.github.io/api-docs/?shell#automation-rules)
+- Implemented row sort objects and [Sort Rows in Sheet](http://smartsheet-platform.github.io/api-docs/?shell#sort-rows-in-sheet) endpoint
+- Added row filter properties to SheetFilter
+- Added ifVersionAfter parameter to Sheet.get_sheet() method
+
+### Changed
+In our efforts to further streamline the SDK, enumerated properties have been changed from type String to type EnumeratedValue, which wraps Python Enum. 
+In addition to allowing us to remove a number of redundant string arrays, this also provides the benefit of better code completion (in most IDEs) 
+and provides for more programmatic clarity, for example:
+ ```
+sheet = smartsheet.Sheets.get_sheet(sheet_id)
+if sheet.access_level == AccessLevel.OWNER:
+    # perform some task for OWNER
+    ...
+```
+However, string comparisons will continue to operate as they did previously. No change is required if your code uses comparisons such as:
+```
+sheet = smartsheet.Sheets.get_sheet(sheet_id)
+if sheet.access_level == 'OWNER':
+    # perform some task for OWNER
+    ...
+```
+[enum34](https://pypi.python.org/pypi/enum34) has been added as a required package for the SDK  
+
 ## [1.3.0] - 2018-2-21
 
-## Pre-release SDK version 1.3
+### Changed 
 
-###Changed 
 Several changes have been made to the SDK to improve both the maintainability of the SDK and the predictability/reliability of the results returned by the SDK. Some of these changes may be breaking to code that currently uses the SDK. The following changes should be reviewed:
 * The JSON serializer has been changed to ignore `null` values and empty lists (`[]`). A new Smartsheet model, ExplicitNull, is provided for circumstances where there is a need to force the serialization of a null value. As an example, to clear a hyperlink value from a cell, you can perform the following operation:
 ```

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.1
 Name: smartsheet-python-sdk
-Version: 1.3.0
+Version: 1.3.1
 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
@@ -17,7 +17,7 @@ Description: Smartsheet Python SDK
         System Requirements
         -------------------
         
-        The SDK currently supports Python 2.7, 3.3, 3.4, 3.5, 3.6, pypy, and pypy3.
+        The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.
         The following packages are required.
         
         -  `requests <https://pypi.python.org/pypi/requests>`__
@@ -25,6 +25,7 @@ Description: Smartsheet Python SDK
         -  `six <https://pypi.python.org/pypi/six>`__
         -  `certifi <https://pypi.python.org/pypi/certifi>`__
         -  `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__
+        -  `enum34 <https://pypi.python.org/pypi/enum34>`__
         
         Installation
         ------------

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/README.rst

@@ -8,7 +8,7 @@ applications.
 System Requirements
 -------------------
 
-The SDK currently supports Python 2.7, 3.3, 3.4, 3.5, 3.6, pypy, and pypy3.
+The SDK currently supports Python 2.7, 3.4, 3.5, 3.6, pypy, and pypy3.
 The following packages are required.
 
 -  `requests <https://pypi.python.org/pypi/requests>`__
@@ -16,6 +16,7 @@ The following packages are required.
 -  `six <https://pypi.python.org/pypi/six>`__
 -  `certifi <https://pypi.python.org/pypi/certifi>`__
 -  `python-dateutil <https://pypi.python.org/pypi/python-dateutil>`__
+-  `enum34 <https://pypi.python.org/pypi/enum34>`__
 
 Installation
 ------------

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 2a9aefe4202d8f91b6d416ef70220ded
+config: 182ba4142853120fe0a76a6374d55800
 tags: 645f666f9bcd5a90fca523b33c5a78b7

smartsheet-python-sdk-1.3.1/docs/_sources/smartsheet.models.enums.rst.txt

@@ -0,0 +1,262 @@
+smartsheet.models.enums package
+===============================
+
+Submodules
+----------
+
+smartsheet.models.enums.access\_level module
+--------------------------------------------
+
+.. automodule:: smartsheet.models.enums.access_level
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_parent\_type module
+-------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_parent_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_sub\_type module
+----------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_sub_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.attachment\_type module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.attachment_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_action\_frequency module
+------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_action_frequency
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_action\_type module
+-------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_action_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.automation\_rule\_disabled\_reason module
+-----------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.automation_rule_disabled_reason
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.cell\_link\_status module
+-------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.cell_link_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.column\_type module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.column_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.criteria\_target module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.criteria_target
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.cross\_sheet\_reference\_status module
+--------------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.cross_sheet_reference_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.currency\_code module
+---------------------------------------------
+
+.. automodule:: smartsheet.models.enums.currency_code
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.day\_descriptors module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.day_descriptors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.day\_ordinal module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.day_ordinal
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.global\_template module
+-----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.global_template
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.operator module
+---------------------------------------
+
+.. automodule:: smartsheet.models.enums.operator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.paper\_type module
+------------------------------------------
+
+.. automodule:: smartsheet.models.enums.paper_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.predecessor\_type module
+------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.predecessor_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.publish\_accessible\_by module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.publish_accessible_by
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.schedule\_type module
+---------------------------------------------
+
+.. automodule:: smartsheet.models.enums.schedule_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.share\_scope module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.share_scope
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.share\_type module
+------------------------------------------
+
+.. automodule:: smartsheet.models.enums.share_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_email\_format module
+---------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_email_format
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_filter\_operator module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_filter_operator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sheet\_filter\_type module
+--------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sheet_filter_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.sort\_direction module
+----------------------------------------------
+
+.. automodule:: smartsheet.models.enums.sort_direction
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.symbol module
+-------------------------------------
+
+.. automodule:: smartsheet.models.enums.symbol
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.system\_column\_type module
+---------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.system_column_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.update\_request\_status module
+------------------------------------------------------
+
+.. automodule:: smartsheet.models.enums.update_request_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.user\_status module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.user_status
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.enums.widget\_type module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.enums.widget_type
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: smartsheet.models.enums
+    :members:
+    :undoc-members:
+    :show-inheritance:

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/docs/_sources/smartsheet.models.rst.txt

@@ -1,6 +1,13 @@
 smartsheet.models package
 =========================
 
+Subpackages
+-----------
+
+.. toctree::
+
+    smartsheet.models.enums
+
 Submodules
 ----------
 
@@ -44,6 +51,22 @@ smartsheet.models.auto\_number\_format module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.automation\_action module
+-------------------------------------------
+
+.. automodule:: smartsheet.models.automation_action
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.automation\_rule module
+-----------------------------------------
+
+.. automodule:: smartsheet.models.automation_rule
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.boolean\_object\_value module
 -----------------------------------------------
 
@@ -180,6 +203,14 @@ smartsheet.models.criteria module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.cross\_sheet\_reference module
+------------------------------------------------
+
+.. automodule:: smartsheet.models.cross_sheet_reference
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.currency module
 ---------------------------------
 
@@ -628,6 +659,22 @@ smartsheet.models.sight\_publish module
     :undoc-members:
     :show-inheritance:
 
+smartsheet.models.sort\_criterion module
+----------------------------------------
+
+.. automodule:: smartsheet.models.sort_criterion
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+smartsheet.models.sort\_specifier module
+----------------------------------------
+
+.. automodule:: smartsheet.models.sort_specifier
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 smartsheet.models.source module
 -------------------------------
 

{smartsheet-python-sdk-1.3.0 → smartsheet-python-sdk-1.3.1}/docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: '',
-    VERSION: '1.2.5.dev38+g7d61cc0',
+    VERSION: '1.3.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',