v2.68.0

[2.68.0] - 2019-5-9

Added

• Event Reporting functionality

v1.5.0

[1.5.0] - 2019-3-19

Added

• WEBCONTENT sight widget type
• Add Workspace to sheet model
• Support for groups in get_current_user
• Multi-contact feature support

Fixed

• Fixed setter for modified_at attribute in row model

v1.4.0

[1.4.0] - 2019-2-19

Added

• Added BASE URI definition for Smartsheetgov

Changed

• Remove enum34 as a dependency for versions of Python after 3.4

v1.3.3

[1.3.3] - 2018-4-19

Added

• XLSX and CSV import endpoints for workspaces, folders and sheets
• Rudimentary support Sight chart objects (chart contents read into JSON strings)
• Exclude permalinks option to Home.list_all_contents
• backgroundColor to Sight object

Fixed

• Improper format strings in Types

v1.3.2

[1.3.2] - 2018-3-15

Fixed

• String representations for EnumeratedValue should contain just their name not class_name.name
  (SO reported).

v1.3.1

[1.3.1] - 2018-3-1

Added

• Implemented 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
• Implemented row sort objects and 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 has been added as a required package for the SDK

v1.3.0

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:

        first_row = Row()
        first_row.id = 10
        first_row.cells.append({
            "columnId": 101,
            "value": "",
            "hyperlink": ExplicitNull()
        })

        response = self.client.Sheets.update_rows(1, [first_row])

• Property values are more strongly type checked on assignment and you will get a ValueError exception if you attempt to assign an incompatible object. Previously, there were a number of cases where assignment of incompatible types would have resulted in a silent failure by the SDK.
• In previous releases, property filters were executed prior to create or update operations on many models within the SDK. Unfortunately, those filters were sometimes at odds with the API and occasionally returned unpredictable results. For that reason those filters have been removed. Be aware that any property that is set in a model will be passed through to the API.
• Properties id, format, and type are accessible without the preceding underscore, e.g. cell._format has changed to cell.format.

v1.2.4

• There is a race condition which exists in the window between when the API servers disconnect an idle connection and when the client receives notification of the disconnection. If a request is made during that window, the client reads a blank status line and issues an error indicating that the session was terminated without a response (UnexpectedRequestError). This release is made to address that issue by implementing appropriate retries in the SDK.

v1.2.3

• Safe defaults for mock api test name and module name

v1.2.2

[1.2.2] - 2017-12-7

Added

• Support for column validation

• New Passthrough object supports get, post, put, or delete with arbitrary json payload. Use this for access to any API feature that isn't yet modeled in the API. Requests still benefit from error retry and logging.

• add_image_to_cell & attach_file_to_cell: Now support override_validation and alt_text parameters

• copy_folder, copy_workspace and copy_sheet: Additional options for include, skip_remap, and omit parameters

• Support for include=sheetVersion for several endpoints that return a list of sheets

• Support for reading sheet filters

• More flags when publishing Sheets or Reports as HTML

• Search

  • Results include favorite information
  • Limit search scope