smartsheet-python-sdk 3.5.5__py3-none-any.whl

smartsheet/sheets.py

@@ -0,0 +1,2062 @@
+# pylint: disable=C0111,R0902,R0913,C0301,R0914
+# Smartsheet Python SDK.
+#
+# Copyright 2018 Smartsheet.com, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"): you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from __future__ import absolute_import
+
+import logging
+import os.path
+from datetime import datetime
+
+import six
+
+from . import fresh_operation
+from .models.column import Column
+from .models.row import Row
+from .models.summary_field import SummaryField
+from .types import TypedList
+from .util import deprecated
+
+class Sheets:
+
+    """Class for handling Sheets operations."""
+
+    def __init__(self, smartsheet_obj):
+        """Init Sheets with base Smartsheet object."""
+        self._base = smartsheet_obj
+        self._log = logging.getLogger(__name__)
+
+    def add_columns(self, sheet_id, list_of_columns):
+        """Insert one or more Columns into the specified Sheet
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_columns (list[Column]): One or more
+                Column objects
+
+        Returns:
+            Result
+        """
+
+        if isinstance(list_of_columns, (dict, Column)):
+            arg_value = list_of_columns
+            list_of_columns = TypedList(Column)
+            list_of_columns.append(arg_value)
+
+        _op = fresh_operation("add_columns")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/columns"
+        _op["json"] = list_of_columns
+
+        expected = ["Result", "Column"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def add_rows(self, sheet_id, list_of_rows):
+        """Insert one or more Rows into the specified Sheet.
+
+        If multiple rows are specified in the request, all rows
+        must be inserted at the same location (i.e. the **toTop**,
+        **toBottom**, **parentId**, **siblingId**, and **above** attributes
+        must be the same for all rows in the request.)
+
+        In a parent row, values of the following fields will be
+        auto-calculated based upon values in the child rows (and therefore
+        cannot be updated using the API): Start Date, End Date, Duration, %
+        Complete.
+
+        Args:
+            sheet_id (int): Sheet ID
+            row_or_list_of_rows (list[Row]): An array of Row objects with the following attributes:
+
+               One or more location-specifier attributes (optional)
+
+               format (optional)
+
+               expanded (optional)
+
+               locked (optional)
+
+               A cells attribute set to an array of Cell objects.
+               To insert an empty row, set the cells attribute to empty or null.
+               Each Cell object may contain the following attributes:
+
+                   columnId (required)
+
+                   value (required)
+
+                   strict (optional)
+
+                   format (optional)
+
+                   hyperlink (optional)
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_rows, (dict, Row)):
+            arg_value = list_of_rows
+            list_of_rows = TypedList(Row)
+            list_of_rows.append(arg_value)
+
+        _op = fresh_operation("add_rows")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows"
+        _op["json"] = list_of_rows
+
+        expected = ["Result", "Row"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def add_rows_with_partial_success(self, sheet_id, list_of_rows):
+        """Insert one or more Rows into the specified Sheet.
+
+        If multiple rows are specified in the request, all rows
+        must be inserted at the same location (i.e. the **toTop**,
+        **toBottom**, **parentId**, **siblingId**, and **above** attributes
+        must be the same for all rows in the request.)
+
+        In a parent row, values of the following fields will be
+        auto-calculated based upon values in the child rows (and therefore
+        cannot be updated using the API): Start Date, End Date, Duration, %
+        Complete.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_rows (list[Row]): An array of Row objects with the following attributes:
+
+                One or more location-specifier attributes (optional)
+
+                format (optional)
+
+                expanded (optional)
+
+                locked (optional)
+
+                A cells attribute set to an array of Cell objects.
+                To insert an empty row, set the cells attribute to empty or null.
+                Each Cell object may contain the following attributes:
+
+                    columnId (required)
+
+                    value (required)
+
+                    strict (optional)
+
+                    format (optional)
+
+                    hyperlink (optional)
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_rows, (dict, Row)):
+            arg_value = list_of_rows
+            list_of_rows = TypedList(Row)
+            list_of_rows.append(arg_value)
+
+        _op = fresh_operation("add_rows")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows"
+        _op["json"] = list_of_rows
+        _op["query_params"]["allowPartialSuccess"] = "true"
+
+        expected = ["BulkItemResult", "Row"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def copy_rows(
+        self,
+        sheet_id,
+        copy_or_move_row_directive_obj,
+        include=None,
+        ignore_rows_not_found=None,
+    ):
+        """Copies Row(s) from the specified Sheet to the bottom of another
+        Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            copy_or_move_row_directive_obj
+                (CopyOrMoveRowDirective): CopyOrMoveRowDirective object.
+            include (list[str]): A comma-separated list of
+                row elements to copy in addition to the cell data. Valid
+                list values: attachments, discussions, children, all.
+            ignore_rows_not_found (bool): If set to `true`,
+                specifying row ids that do not exist within the source sheet
+                will not cause an error response. If omitted or set to false
+                (the default), specifying row ids that do not exist within
+                the source sheet will cause an error response (and no rows
+                will be altered).
+
+        Returns:
+            CopyOrMoveRowResult
+        """
+        _op = fresh_operation("copy_rows")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows/copy"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["ignoreRowsNotFound"] = ignore_rows_not_found
+        _op["json"] = copy_or_move_row_directive_obj
+
+        expected = "CopyOrMoveRowResult"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def copy_sheet(
+        self, sheet_id, container_destination_obj, include=None, exclude=None
+    ):
+        """Creates a copy of the specified Sheet
+
+        Args:
+            sheet_id (int): Sheet ID
+            container_destination_obj
+                (ContainerDestination): Container Destination object.
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list values:
+                attachments, cellLinks, data, discussions, filters, forms, ruleRecipients,
+                rules, shares, all (deprecated).
+            exclude (list[str]): A comma-separated list of optional elements
+                to omit. Only current valid value is sheetHyperlinks
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("copy_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/copy"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+        _op["json"] = container_destination_obj
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_column(self, sheet_id, column_id):
+        """Delete the specified Column.
+
+        Args:
+            sheet_id (int): Sheet ID
+            column_id (int): Column ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_column")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/columns/" + str(column_id)
+
+        expected = "Result"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_rows(self, sheet_id, ids, ignore_rows_not_found=False):
+        """Deletes one or more Row(s) from the specified Sheeet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            ids (list[int]): a comma-separated list of
+                object IDs representing the items to work on.
+            ignore_rows_not_found (bool): If set to `true`,
+                specifying row ids that do not exist within the source sheet
+                will not cause an error response. If omitted or set to false
+                (the default), specifying row ids that do not exist within
+                the source sheet will cause an error response (and no rows
+                will be altered).
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_rows")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows"
+        _op["query_params"]["ids"] = ids
+        _op["query_params"]["ignoreRowsNotFound"] = ignore_rows_not_found
+
+        expected = ["Result", "NumberObjectValue"]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def delete_share(self, sheet_id, share_id):
+        """Delete the specified Share.
+
+        Args:
+            sheet_id (int): Sheet ID
+            share_id (str): Share ID
+
+        Returns:
+            Result
+
+        Deprecated:
+            Use sharing.delete_share instead with assetType=AssetType.SHEET
+        """
+        _op = fresh_operation("delete_share")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_sheet(self, sheet_id):
+        """Delete the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_sheet")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id)
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_column(self, sheet_id, column_id, include=None):
+        """Get the specified Column.
+
+        Args:
+            sheet_id (int): Sheet ID
+            column_id (int): Column ID
+            include (str): (future)
+
+        Returns:
+            Column
+        """
+        _op = fresh_operation("get_column")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/columns/" + str(column_id)
+        _op["query_params"]["include"] = include
+
+        expected = "Column"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_columns(
+        self,
+        sheet_id,
+        include=None,
+        page_size=None,
+        page=None,
+        include_all=None,
+        level=None,
+    ):
+        """Get all columns belonging to the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            include (str): (future)
+            page_size (int): The maximum number of items to
+                return per page.
+            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
+        """
+        _op = fresh_operation("get_columns")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/columns"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+        _op["query_params"]["level"] = level
+
+        expected = ["IndexResult", "Column"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_publish_status(self, sheet_id):
+        """Get the Publish status of the Sheet.
+
+        Get the status of the Publish settings of the Sheet,
+        including URLs of any enabled publishings.
+
+        Args:
+            sheet_id (int): Sheet ID
+
+        Returns:
+            SheetPublish
+        """
+        _op = fresh_operation("get_publish_status")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/publish"
+
+        expected = "SheetPublish"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_row(self, sheet_id, row_id, include=None, exclude=None, level=None):
+        """Get the specified Row of the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            row_id (int): Row ID
+            include (list[str]): A comma-separated list of
+                flags that indicate additional attributes to be included in
+                each Row object within the response. Valid list values:
+                discussions, attachments, format, filters, columnType,
+                rowPermalink, rowWriterInfo.
+            exclude (str): Response will not include cells
+                that have never contained any data.
+            level (int): Indicates compatibility level of data to return.
+                Valid options: 0, 1, 2
+                Option Descriptors:
+
+                    0 - Backwards compatible text format
+                    1 - multi-contact complex object
+                    2 - multi-picklist complex object
+
+        Returns:
+            Row
+        """
+        _op = fresh_operation("get_row")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows/" + str(row_id)
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+        _op["query_params"]["level"] = level
+
+        expected = "Row"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def get_share(self, sheet_id, share_id):
+        """Get the specified Share.
+
+        Args:
+            sheet_id (int): Sheet ID
+            share_id (str): Share ID
+
+        Returns:
+            Share
+
+        Deprecated:
+            Use sharing.get_asset_share instead with assetType=AssetType.SHEET
+        """
+        _op = fresh_operation("get_share")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
+
+        expected = "Share"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_sheet(
+        self,
+        sheet_id,
+        include=None,
+        exclude=None,
+        row_ids=None,
+        row_numbers=None,
+        column_ids=None,
+        page_size=None,
+        page=None,
+        if_version_after=None,
+        level=None,
+        rows_modified_since=None,
+        filter_id=None,
+    ):
+        """Get the specified Sheet.
+
+        Get the specified Sheet. Returns the Sheet, including Rows,
+        and optionally populated with Discussion and Attachment
+        objects.
+
+        Args:
+            sheet_id (int): Sheet ID
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list
+                values: attachments, columnType, crossSheetReferences, discussions, filters,
+                filterDefinitions, format, objectValue, ownerInfo, rowPermalink,
+                rowWriterInfo (deprecated - use writerInfo), source, summary, writerInfo.
+            exclude (str): Response will not include cells
+                that have never contained any data.
+            row_ids (list[int]): comma-separated list of Row
+                IDs on which to filter the rows included in the result.
+            row_numbers (list[int]): comma-separated list of
+                Row numbers on which to filter the rows included in the
+                result. Non-existent row numbers are ignored.
+            column_ids (list[int]): comma-separated list of
+                Column IDs. The response will contain only the specified
+                columns in the 'columns' array, and individual rows' 'cells'
+                array will only contain cells in the specified columns.
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            if_version_after (int): only fetch Sheet if more recent version
+                available.
+            level (int): compatibility level
+            rows_modified_since: Date should be in ISO-8601 format, for example, rowsModifiedSince=2020-01-30T13:25:32-07:00.
+            filter_id (int): Applies the given filter (if accessible by the calling user)
+                and marks the affected rows as "filteredOut": true
+
+        Returns:
+            Sheet
+        """
+        _op = fresh_operation("get_sheet")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id)
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+        _op["query_params"]["rowIds"] = row_ids
+        _op["query_params"]["rowNumbers"] = row_numbers
+        _op["query_params"]["columnIds"] = column_ids
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["ifVersionAfter"] = if_version_after
+        _op["query_params"]["level"] = level
+        _op["query_params"]["rowsModifiedSince"] = rows_modified_since
+        _op["query_params"]["filterId"] = filter_id
+
+        expected = "Sheet"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_sheet_as_csv(self, sheet_id, download_path, alternate_file_name=None):
+        """Get the specified Sheet as a CSV file.
+
+        Args:
+            sheet_id (int): Sheet ID
+            download_path (str): Directory path on local
+                machine to save file.
+            alternate_file_name (str): Filename to use
+                instead of name suggested by Content-Disposition.
+
+        Returns:
+            DownloadedFile
+        """
+        if not os.path.isdir(download_path):
+            raise ValueError("download_path must be a directory.")
+
+        _op = fresh_operation("get_sheet_as_csv")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id)
+        _op["header_params"]["Accept"] = "text/csv"
+        _op["dl_path"] = download_path
+
+        expected = "DownloadedFile"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+        if alternate_file_name is not None:
+            response.filename = alternate_file_name
+
+        response.save_to_file()
+        return response
+
+    def get_sheet_as_excel(self, sheet_id, download_path, alternate_file_name=None):
+        """Get the specified Sheet as an Excel .xls file.
+
+        Args:
+            sheet_id (int): Sheet ID
+            download_path (str): Directory path on local
+                machine to save file.
+            alternate_file_name (str): Filename to use
+                instead of name suggested by Content-Disposition.
+
+        Returns:
+            DownloadedFile
+        """
+        if not os.path.isdir(download_path):
+            raise ValueError("download_path must be a directory.")
+
+        _op = fresh_operation("get_sheet_as_excel")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id)
+        _op["header_params"]["Accept"] = "application/vnd.ms-excel"
+        _op["dl_path"] = download_path
+
+        expected = "DownloadedFile"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+        if alternate_file_name is not None:
+            response.filename = alternate_file_name
+
+        response.save_to_file()
+        return response
+
+    def get_sheet_as_pdf(
+        self, sheet_id, download_path, paper_size=None, alternate_file_name=None
+    ):
+        """Get the specified Sheet as a PDF file.
+
+        Args:
+            sheet_id (int): Sheet ID
+            download_path (str): Directory path on local
+                machine to save file.
+            paper_size (str): Applies to PDF only. One of:
+                LETTER, LEGAL, WIDE, ARCHD, A4, A3, A2, A1, A0
+            alternate_file_name (str): Filename to use
+                instead of name suggested by Content-Disposition.
+
+        Returns:
+            DownloadedFile
+        """
+        if not os.path.isdir(download_path):
+            raise ValueError("download_path must be a directory.")
+
+        _op = fresh_operation("get_sheet_as_pdf")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id)
+        _op["header_params"]["Accept"] = "application/pdf"
+        _op["query_params"]["paperSize"] = paper_size
+        _op["dl_path"] = download_path
+
+        expected = "DownloadedFile"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+        if alternate_file_name is not None:
+            response.filename = alternate_file_name
+
+        response.save_to_file()
+        return response
+
+    def get_sheet_version(self, sheet_id):
+        """Get the Sheet version without loading the entire Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+
+        Returns:
+            Version
+        """
+        _op = fresh_operation("get_sheet_version")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/version"
+
+        expected = "Version"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def list_org_sheets(self):
+        """Get a list of all Sheets owned by an organization.
+
+        Get the list of all Sheets owned by the members of the
+        account (organization).
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_org_sheets")
+        _op["method"] = "GET"
+        _op["path"] = "/users/sheets"
+
+        expected = ["IndexResult", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_shares(
+        self,
+        sheet_id,
+        page_size=None,
+        page=None,
+        include_all=None,
+        include_workspace_shares=False,
+        access_api_level=0,
+    ):
+        """Get the list of all Users and Groups to whom the specified Sheet is
+        shared, and their access level.
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+            include_workspace_shares(bool): Include Workspace shares
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_shares")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/shares"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+        _op["query_params"]["accessApiLevel"] = access_api_level
+        if include_workspace_shares:
+            _op["query_params"]["include"] = "workspaceShares"
+
+        expected = ["IndexResult", "Share"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_sheets(
+        self,
+        include=None,
+        page_size=None,
+        page=None,
+        include_all=None,
+        modified_since=None,
+    ):
+        """Get the list of all Sheets the User has access to, in alphabetical
+        order, by name.
+
+        Args:
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list
+                values: ownerInfo, sheetVersion, source.
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+            modified_since(datetime): Return sheets modified since provided datetime
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_sheets")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+        if isinstance(modified_since, datetime):
+            _op["query_params"]["modifiedSince"] = modified_since.isoformat()
+
+        expected = ["IndexResult", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def move_rows(
+        self,
+        sheet_id,
+        copy_or_move_row_directive_obj,
+        include=None,
+        ignore_rows_not_found=None,
+    ):
+        """Moves Row(s) to the bottom of another Sheet.
+
+        Up to 5,000 row IDs can be specified in the request, but if
+        the total number of rows in the destination Sheet after the move
+        exceeds the Smartsheet row limit, an error response will be
+        returned.
+
+        Any child rows of the rows specified in the request will also be
+        moved. Parent-child relationships amongst rows will be preserved
+        within the destination Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            copy_or_move_row_directive_obj
+                (CopyOrMoveRowDirective): CopyOrMoveRowDirective object.
+            include (list[str]): A comma-separated list of
+                row elements to move in addition to the cell data. Valid
+                list values: attachments, discussions.
+            ignore_rows_not_found (bool): If set to `true`,
+                specifying row ids that do not exist within the source sheet
+                will not cause an error response. If omitted or set to false
+                (the default), specifying row ids that do not exist within
+                the source sheet will cause an error response (and no rows
+                will be altered).
+
+        Returns:
+            CopyOrMoveRowResult
+        """
+        _op = fresh_operation("move_rows")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows/move"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["ignoreRowsNotFound"] = ignore_rows_not_found
+        _op["json"] = copy_or_move_row_directive_obj
+
+        expected = "CopyOrMoveRowResult"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def move_sheet(self, sheet_id, container_destination_obj):
+        """Move the specified Sheet to a new location.
+
+        Args:
+            sheet_id (int): Sheet ID
+            container_destination_obj
+                (ContainerDestination): Container Destination object.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("move_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/move"
+        _op["json"] = container_destination_obj
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def search_sheet(self, sheet_id, query):
+        """Search the specified Sheet for the specified text.
+
+        Args:
+            sheet_id (int): Sheet ID
+            query (str): Text with which to perform the
+                search.
+
+        Returns:
+            SearchResult
+        """
+        _op = fresh_operation("search_sheet")
+        _op["method"] = "GET"
+        _op["path"] = "/search/sheets/" + str(sheet_id)
+        _op["query_params"]["query"] = query
+
+        expected = "SearchResult"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def send_rows(self, sheet_id, multi_row_email_obj):
+        """Send one or more rows via email
+
+        Args:
+            sheet_id (int): Sheet ID
+            multi_row_email_obj (MultiRowEmail):
+                MultiRowEmail object.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("send_rows")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows/emails"
+        _op["json"] = multi_row_email_obj
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def send_sheet(self, sheet_id, sheet_email_obj):
+        """Sends the sheet as an attachment via email to the designated
+        recipients.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sheet_email_obj (SheetEmail): SheetEmail object.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("send_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/emails"
+        _op["json"] = sheet_email_obj
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def send_update_request(self, sheet_id, multi_row_email_obj):
+        """Create an Update Request for the specified Row(s) within the
+        Sheet. An email notification (containing a link to the
+        update request) will be asynchronously send to the specified
+        recipient(s).
+
+        Args:
+            sheet_id (int): Sheet ID
+            multi_row_email_obj (MultiRowEmail):
+                MultiRowEmail object.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("send_update_request")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/updaterequests"
+        _op["json"] = multi_row_email_obj
+
+        expected = ["Result", "UpdateRequest"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def set_publish_status(self, sheet_id, sheet_publish_obj):
+        """Set the publish status of the Sheet and returns the new status,
+        including the URLs of any enabled publishings.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sheet_publish_obj (SheetPublish): SheetPublish
+                object.
+
+        Returns:
+            Result
+        """
+        attributes = [
+            "read_only_lite_enabled",
+            "read_only_full_enabled",
+            "read_write_enabled",
+            "ical_enabled",
+        ]
+
+        fetch_first = False
+        # check for incompleteness, fill in from current status if necessary
+        for attribute in attributes:
+            val = getattr(sheet_publish_obj, attribute, None)
+            if val is None:
+                fetch_first = True
+                break
+
+        if fetch_first:
+            current_status = self.get_publish_status(sheet_id).to_dict()
+            current_status.update(sheet_publish_obj.to_dict())
+            sheet_publish_obj = self._base.models.SheetPublish(current_status)
+
+        _op = fresh_operation("set_publish_status")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/publish"
+        _op["json"] = sheet_publish_obj
+
+        expected = ["Result", "SheetPublish"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def share_sheet(self, sheet_id, share_obj, send_email=None):
+        """Share the specified Sheet.
+
+        Share the specified Sheet with the specified Users and
+        Groups.
+
+        Args:
+            sheet_id (int): Sheet ID
+            share_obj (Share): Share object.
+            send_email (bool): Either true or false to
+                indicate whether or not to notify the user by email. Default
+                is false.
+
+        Returns:
+            Result
+
+        Deprecated:
+            Use sharing.share_asset instead with assetType=AssetType.SHEET
+        """
+        _op = fresh_operation("share_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/shares"
+        _op["json"] = share_obj
+        _op["query_params"]["sendEmail"] = send_email
+
+        expected = ["Result", "Share"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_column(self, sheet_id, column_id, column_obj):
+        """Update properties of the specified Column.
+
+        Args:
+            sheet_id (int): Sheet ID
+            column_id (int): Column ID
+            column_obj (Column): A Column object.
+
+        Returns:
+            Result
+        """
+        if not all(val is not None for val in ["sheet_id", "column_id", "column_obj"]):
+            raise ValueError(
+                ("One or more required values are missing from call to " + __name__)
+            )
+
+        if isinstance(column_obj, dict):
+            column_obj = Column(column_obj)
+
+        _op = fresh_operation("update_column")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/columns/" + str(column_id)
+        _op["json"] = column_obj
+
+        expected = ["Result", "Column"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_rows(self, sheet_id, list_of_rows):
+        """Update properties of the specified Row.
+
+        Updates cell values in the specified row(s),
+        expands/collapses the specified row(s), and/or modifies the
+        position of the specified rows (including indenting/outdenting).
+
+        If a row's position is updated, all child rows are moved with the
+        row.
+
+        In a parent row, values of the following fields are auto-calculated
+        based upon values in the child rows (and therefore cannot be
+        updated using the API): Start Date, End Date, Duration, % Complete.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_rows (list[Row]): Array containing one
+                or more Row objects.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("update_rows")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows"
+        _op["json"] = list_of_rows
+
+        expected = ["Result", "Row"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_rows_with_partial_success(self, sheet_id, list_of_rows):
+        """Update properties of the specified Row(s).
+
+        Updates cell values in the specified row(s),
+        expands/collapses the specified row(s), and/or modifies the
+        position of the specified rows (including indenting/outdenting).
+
+        If a row's position is updated, all child rows are moved with the
+        row.
+
+        In a parent row, values of the following fields are auto-calculated
+        based upon values in the child rows (and therefore cannot be
+        updated using the API): Start Date, End Date, Duration, % Complete.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_rows (list[Row]): Array containing one
+                or more Row objects.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("update_rows")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/rows"
+        _op["json"] = list_of_rows
+        _op["query_params"]["allowPartialSuccess"] = "true"
+
+        expected = ["BulkItemResult", "Row"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def update_share(self, sheet_id, share_id, share_obj):
+        """Update the access level of a User or Group for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            share_id (str): Share ID
+            share_obj (Share): Share object.
+
+        Returns:
+            Result
+
+        Deprecated:
+            Use sharing.update_share instead with assetType=AssetType.SHEET
+        """
+        if not all(val is not None for val in ["sheet_id", "share_id", "share_obj"]):
+            raise ValueError(
+                ("One or more required values are missing from call to " + __name__)
+            )
+
+        _op = fresh_operation("update_share")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/shares/" + str(share_id)
+        _op["json"] = share_obj
+
+        expected = ["Result", "Share"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_sheet(self, sheet_id, sheet_obj):
+        """Updates the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sheet_obj (Sheet): Sheet object.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("update_sheet")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id)
+        _op["json"] = sheet_obj
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_update_requests(
+        self, sheet_id, page_size=None, page=None, include_all=None
+    ):
+        """Get the list of all Sheet UpdateRequests.
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all(bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_update_requests")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/updaterequests"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "UpdateRequest"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_update_request(self, sheet_id, update_request_id):
+        """Get the UpdateRequest for Sheet that has a future schedule.
+
+        Args:
+            sheet_id (int): Sheet ID
+            update_request_id (int): UpdateRequest ID
+
+        Returns:
+            UpdateRequest
+        """
+        _op = fresh_operation("get_update_request")
+        _op["method"] = "GET"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/updaterequests/" + str(update_request_id)
+        )
+
+        expected = "UpdateRequest"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def create_update_request(self, sheet_id, update_request_obj):
+        """Creates an UpdateRequest for the specified Rows(s) within the Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            update_request_obj (UpdateRequest): UpdateRequest object
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("create_update_request")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/updaterequests"
+        _op["json"] = update_request_obj
+
+        expected = ["Result", "UpdateRequest"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_update_request(self, sheet_id, update_request_id):
+        """Deletes an UpdateRequest for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            update_request_id (int): UpdateRequest ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_update_request")
+        _op["method"] = "DELETE"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/updaterequests/" + str(update_request_id)
+        )
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_update_request(self, sheet_id, update_request_id, update_request_obj):
+        """Updates an UpdateRequest for the specified Rows(s) within the Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            update_request_id: Update request ID
+            update_request_obj (UpdateRequest): UpdateRequest object
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("update_update_request")
+        _op["method"] = "PUT"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/updaterequests/" + str(update_request_id)
+        )
+        _op["json"] = update_request_obj
+
+        expected = ["Result", "UpdateRequest"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_sent_update_requests(
+        self, sheet_id, page_size=None, page=None, include_all=None
+    ):
+        """Get the list of all Sent UpdateRequests.
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_update_requests")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/sentupdaterequests"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "SentUpdateRequest"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_sent_update_request(self, sheet_id, sent_update_request_id):
+        """Get the SentUpdateRequest for Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sent_update_request_id (int): SentUpdateRequest ID
+
+        Returns:
+            UpdateRequest
+        """
+        _op = fresh_operation("get_sent_update_request")
+        _op["method"] = "GET"
+        _op["path"] = (
+            "/sheets/"
+            + str(sheet_id)
+            + "/sentupdaterequests/"
+            + str(sent_update_request_id)
+        )
+
+        expected = "SentUpdateRequest"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_sent_update_request(self, sheet_id, sent_update_request_id):
+        """Deletes a SentUpdateRequest for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sent_update_request_id (int): SentUpdateRequest ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_update_request")
+        _op["method"] = "DELETE"
+        _op["path"] = (
+            "/sheets/"
+            + str(sheet_id)
+            + "/sentupdaterequests/"
+            + str(sent_update_request_id)
+        )
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_filters(self, sheet_id, page_size=None, page=None, include_all=None):
+        """Returns a list of all saved sheet filters
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_sheet_filters")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/filters"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "SheetFilter"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_filter(self, sheet_id, filter_id):
+        """Get the Filter.
+
+        Args:
+            sheet_id (int): Sheet ID
+            filter_id (int): Filter ID
+
+        Returns:
+            Filter
+        """
+        _op = fresh_operation("get_sheet_filter")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/filters/" + str(filter_id)
+
+        expected = "SheetFilter"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_filter(self, sheet_id, filter_id):
+        """Deletes a Filter for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            filter_id (int): Filter ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_sheet_filter")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/filters/" + str(filter_id)
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_cross_sheet_references(
+        self, sheet_id, page_size=None, page=None, include_all=None
+    ):
+        """Get the list of all CrossSheetReferences for this Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_cross_sheet_references")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/crosssheetreferences"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "CrossSheetReference"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_cross_sheet_reference(self, sheet_id, cross_sheet_reference_id):
+        """Get the CrossSheetReference.
+
+        Args:
+            sheet_id (int): Sheet ID
+            cross_sheet_reference_id (int): CrossSheetReferenceID
+
+        Returns:
+            CrossSheetReference
+        """
+        _op = fresh_operation("get_cross_sheet_reference")
+        _op["method"] = "GET"
+        _op["path"] = (
+            "/sheets/"
+            + str(sheet_id)
+            + "/crosssheetreferences/"
+            + str(cross_sheet_reference_id)
+        )
+
+        expected = "CrossSheetReference"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def create_cross_sheet_reference(self, sheet_id, cross_sheet_reference_obj):
+        """Creates a CrossSheetReference for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            cross_sheet_reference_obj (CrossSheetReference): CrossSheetReference object
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("create_cross_sheet_reference")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/crosssheetreferences"
+        _op["json"] = cross_sheet_reference_obj
+
+        expected = ["Result", "CrossSheetReference"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def list_automation_rules(
+        self, sheet_id, page_size=None, page=None, include_all=None
+    ):
+        """Get the list of all AutomationRules for this Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_automation_rules")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/automationrules"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "AutomationRule"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_automation_rule(self, sheet_id, automation_rule_id):
+        """Get the AutomationRule.
+
+        Args:
+            sheet_id (int): Sheet ID
+            automation_rule_id (long): AutomationRuleID
+
+        Returns:
+            AutomationRule
+        """
+        _op = fresh_operation("get_automation_rule")
+        _op["method"] = "GET"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/automationrules/" + str(automation_rule_id)
+        )
+
+        expected = "AutomationRule"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_automation_rule(self, sheet_id, automation_rule_id, automation_rule_obj):
+        """Updates an AutomationRule for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            automation_rule_id: AutomationRule ID
+            automation_rule_obj (AutomationRule): AutomationRule object
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("update_automation_rule")
+        _op["method"] = "PUT"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/automationrules/" + str(automation_rule_id)
+        )
+        _op["json"] = automation_rule_obj
+
+        expected = ["Result", "AutomationRule"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_automation_rule(self, sheet_id, automation_rule_id):
+        """Deletes an AutomationRule for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            automation_rule_id (int): AutomationRule ID
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("delete_automation_rule")
+        _op["method"] = "DELETE"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/automationrules/" + str(automation_rule_id)
+        )
+
+        expected = ["Result", None]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def sort_sheet(self, sheet_id, sort_specifier_obj, level=None):
+        """Sort Sheet according to SortSpecifier.
+
+        Args:
+            sheet_id (int): Sheet ID
+            sort_specifier_obj (SortSpecifier): SortSpecifier object
+            level (int): compatibility level
+
+        Returns:
+            Sheet
+        """
+        _op = fresh_operation("sort_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/sort"
+        _op["json"] = sort_specifier_obj
+        _op["query_params"]["level"] = level
+
+        expected = "Sheet"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def import_csv_sheet(
+        self, file, sheet_name=None, header_row_index=None, primary_column_index=None
+    ):
+        """Imports a sheet.
+
+        Args:
+            file (string): path to CSV file.
+            sheet_name (string): destination sheet name
+            header_row_index (int): index (0 based) of row to be used for column names
+            primary_column_index (int): index (0 based) of primary column
+
+        Returns:
+            Result
+        """
+        if not all(val is not None for val in ["folder_id", "file"]):
+            raise ValueError(
+                ("One or more required values are missing from call to " + __name__)
+            )
+
+        return self._import_sheet(
+            file, "text/csv", sheet_name, header_row_index, primary_column_index
+        )
+
+    def import_xlsx_sheet(
+        self, file, sheet_name=None, header_row_index=None, primary_column_index=None
+    ):
+        """Imports a sheet.
+
+        Args:
+            file (string): path to XLSX file.
+            sheet_name (string): destination sheet name
+            header_row_index (int): index (0 based) of row to be used for column names
+            primary_column_index (int): index (0 based) of primary column
+
+        Returns:
+            Result
+        """
+        if not all(val is not None for val in ["folder_id", "file"]):
+            raise ValueError(
+                ("One or more required values are missing from call to " + __name__)
+            )
+
+        return self._import_sheet(
+            file,
+            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+            sheet_name,
+            header_row_index,
+            primary_column_index,
+        )
+
+    def _import_sheet(
+        self, file, file_type, sheet_name, header_row_index, primary_column_index
+    ):
+        """Internal function used to import sheet"""
+
+        if sheet_name is None:
+            head, tail = os.path.split(file)
+            sheet_name = tail or os.path.basename(head)
+
+        _data = open(file, "rb").read()
+        _op = fresh_operation("import_sheet_into_folder")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/import"
+        _op["headers"] = {
+            "content-type": file_type,
+            "content-disposition": "attachment",
+        }
+        _op["form_data"] = _data
+        _op["query_params"]["sheetName"] = sheet_name
+        _op["query_params"]["headerRowIndex"] = header_row_index
+        _op["query_params"]["primaryColumnIndex"] = primary_column_index
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_sheet_summary(
+        self,
+        sheet_id,
+        include=None,
+        exclude=None,
+    ):
+        """Get the SheetSummary.
+
+        Args:
+            sheet_id (int): Sheet ID
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list
+                values: format, writerInfo
+            exclude (list[str]): A comma-separated list of
+                optional elements to exclude from the response. Valid list
+                values: displayValue, image, imageAltText
+
+        Returns:
+            SheetSummary
+        """
+        _op = fresh_operation("get_sheet_summary")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+
+        expected = "SheetSummary"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_sheet_summary_fields(
+        self,
+        sheet_id,
+        include=None,
+        exclude=None,
+        page_size=None,
+        page=None,
+        include_all=None,
+    ):
+        """Get the list of summary fields for this Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list
+                values: format, writerInfo
+            exclude (list[str]): A comma-separated list of
+                optional elements to exclude from the response. Valid list
+                values: displayValue, image, imageAltText
+            page_size (int): The maximum number of items to
+                return per page.
+            page (int): Which page to return.
+            include_all (bool): If true, include all results
+                (i.e. do not paginate).
+
+        Returns:
+            IndexResult
+        """
+        _op = fresh_operation("list_summary_fields")
+        _op["method"] = "GET"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def add_sheet_summary_fields(
+        self, sheet_id, list_of_fields, rename_if_conflict=None
+    ):
+        """Insert one or more SummaryFields into the specified Sheet
+
+        If an error occurs, the Error object returned will contain a detail attribute set to an object with the
+        following attributes:
+
+            - index: the array index of the summary field that caused the error
+                (0 if a single summary field was passed in)
+
+        If any error occurs, the entire request will fail (no summary fields will be updated), and the Error response
+        returned will describe the first problem that was encountered.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_fields (list[SummaryField]): An array of SummaryField objects.
+            rename_if_conflict(Boolean): Normally, this call will fail if it attempts to create a summary field name
+                that already exists. (summary field names must be unique within a sheet.) If this parameter is set to
+                true, then new summary field names will be adjusted to ensure uniqueness.
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_fields, (dict, SummaryField)):
+            arg_value = list_of_fields
+            list_of_fields = TypedList(SummaryField)
+            list_of_fields.append(arg_value)
+
+        _op = fresh_operation("add_sheet_summary_fields")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["json"] = list_of_fields
+        _op["query_params"]["renameIfConflict"] = rename_if_conflict
+
+        expected = ["Result", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def add_sheet_summary_fields_with_partial_success(
+        self, sheet_id, list_of_fields, rename_if_conflict=None
+    ):
+        """Insert one or more SummaryFields into the specified Sheet
+
+        When partial success is enabled, and one or more of the objects in the request fail to be added/updated/deleted,
+        a standard Result object is returned, but with a message of 'PARTIAL_SUCCESS' (instead of 'SUCCESS'), and a
+        resultCode of 3. The object will contain a failedItems attribute - an array of BulkItemFailure objects that
+        contains an item for each object in the request that failed to be added/updated/deleted.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_fields (list[SummaryField]): An array of SummaryField objects.
+            rename_if_conflict(Boolean): Normally, this call will fail if it attempts to create a summary field name
+                that already exists. (summary field names must be unique within a sheet.) If this parameter is set to
+                true, then new summary field names will be adjusted to ensure uniqueness.
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_fields, (dict, SummaryField)):
+            arg_value = list_of_fields
+            list_of_fields = TypedList(SummaryField)
+            list_of_fields.append(arg_value)
+
+        _op = fresh_operation("add_sheet_summary_fields")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["json"] = list_of_fields
+        _op["query_params"]["renameIfConflict"] = rename_if_conflict
+        _op["query_params"]["allowPartialSuccess"] = "true"
+
+        expected = ["BulkItemResult", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete_sheet_summary_fields(
+        self, sheet_id, list_of_ids, ignore_summary_fields_not_found=None
+    ):
+        """Deletes a list of SummaryFields for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_ids (list[int]): list of SummaryField ids
+            ignore_summary_fields_not_found (Boolean): By default, any specified fieldId that isn't found in the sheet
+                summary will cause the entire operation to fail with a "not found" error. If true (default is false),
+                then the operation will not be blocked by fieldIds that are not found. Response will indicate which
+                fields were deleted.
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_ids, six.integer_types):
+            arg_value = list_of_ids
+            list_of_ids = TypedList(six.integer_types)
+            list_of_ids.append(arg_value)
+
+        _op = fresh_operation("delete_sheet_summary_fields")
+        _op["method"] = "DELETE"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["query_params"]["ids"] = list_of_ids
+        _op["query_params"][
+            "ignoreSummaryFieldsNotFound"
+        ] = ignore_summary_fields_not_found
+
+        expected = ["Result", "NumberObjectValue"]
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_sheet_summary_fields(
+        self, sheet_id, list_of_summary_fields, rename_if_conflict=None
+    ):
+        """Updates a list of SummaryFields for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_summary_fields (list[SummaryField]): list of SummaryFields
+            rename_if_conflict (Boolean): true to rename if a name conflict occurs
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_summary_fields, (dict, SummaryField)):
+            arg_value = list_of_summary_fields
+            list_of_summary_fields = TypedList(SummaryField)
+            list_of_summary_fields.append(arg_value)
+
+        _op = fresh_operation("update_sheet_summary_fields")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["json"] = list_of_summary_fields
+        _op["query_params"]["renameIfConflict"] = rename_if_conflict
+
+        expected = ["Result", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def update_sheet_summary_fields_with_partial_success(
+        self, sheet_id, list_of_summary_fields, rename_if_conflict=None
+    ):
+        """Updates a list of SummaryFields for the specified Sheet.
+
+        Args:
+            sheet_id (int): Sheet ID
+            list_of_summary_fields (list[SummaryField]): list of SummaryFields
+            rename_if_conflict (Boolean): true to rename if a name conflict occurs
+
+        Returns:
+            Result
+        """
+        if isinstance(list_of_summary_fields, (dict, SummaryField)):
+            arg_value = list_of_summary_fields
+            list_of_summary_fields = TypedList(SummaryField)
+            list_of_summary_fields.append(arg_value)
+
+        _op = fresh_operation("update_sheet_summary_fields")
+        _op["method"] = "PUT"
+        _op["path"] = "/sheets/" + str(sheet_id) + "/summary/fields"
+        _op["json"] = list_of_summary_fields
+        _op["query_params"]["renameIfConflict"] = rename_if_conflict
+        _op["query_params"]["allowPartialSuccess"] = "true"
+
+        expected = ["BulkItemResult", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def add_sheet_summary_field_image(
+        self, sheet_id, field_id, file, file_type, alt_text=None
+    ):
+
+        _data = open(file, "rb").read()
+        _op = fresh_operation("add_sheet_summary_field_image")
+        _op["method"] = "POST"
+        _op["path"] = (
+            "/sheets/" + str(sheet_id) + "/summary/fields/" + str(field_id) + "/images"
+        )
+        _op["headers"] = {
+            "content-type": file_type,
+            "content-disposition": 'attachment; filename="' + file + '"',
+        }
+        _op["query_params"]["altText"] = alt_text
+        _op["form_data"] = _data
+
+        expected = ["Result", "SummaryField"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def get_column_by_title(self, sheet_id, title, include=None):
+        """For those times when you don't know the Column Id.
+
+        Note: returns the first matching title found.
+
+        Args:
+            sheet_id(int): Sheet ID
+            title(str): Title search string
+            include (str): (future).
+        """
+        all_columns = self.get_columns(sheet_id, include_all=True)
+        for _c in all_columns.data:
+            if _c.title == title:
+                return self.get_column(sheet_id, _c.id, include=include)
+        return False
+
+    def get_sheet_by_name(
+        self,
+        name,
+        include=None,
+        exclude=None,
+        row_ids=None,
+        row_numbers=None,
+        column_ids=None,
+        page_size=None,
+        page=None,
+    ):
+        """For those times when you don't know the Sheet Id.
+
+        Note: returns the first matching name found.
+
+        Args:
+            See arguments for get_sheet()
+        """
+        all_sheets = self.list_sheets(include_all=True)
+        for _s in all_sheets.data:
+            if _s.name == name:
+                return self.get_sheet(
+                    _s.id,
+                    include=include,
+                    exclude=exclude,
+                    row_ids=row_ids,
+                    row_numbers=row_numbers,
+                    column_ids=column_ids,
+                    page_size=page_size,
+                    page=page,
+                )
+        return False