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

smartsheet/home.py

@@ -0,0 +1,180 @@
+# pylint: disable=C0111,R0902,R0913
+# 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
+
+from . import fresh_operation
+from .models.folder import Folder
+from .models.sheet import Sheet
+from .util import deprecated
+
+
+class Home:
+
+    """Class for handling Home operations."""
+
+    def __init__(self, smartsheet_obj):
+        """Init Home with base Smartsheet object."""
+        self._base = smartsheet_obj
+        self._log = logging.getLogger(__name__)
+
+    @deprecated
+    def create_folder(self, folder_obj):
+        """Creates a Folder in the user's Sheets folder (Home).
+
+        Args:
+            folder_obj (Folder): Folder object.
+
+        Returns:
+            Result
+        """
+        if isinstance(folder_obj, str):
+            folder_obj = Folder({"name": folder_obj})
+
+        _op = fresh_operation("create_folder")
+        _op["method"] = "POST"
+        _op["path"] = "/home/folders"
+        _op["json"] = folder_obj
+
+        expected = ["Result", "Folder"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def create_sheet(self, sheet_obj):
+        """Create a Sheet from scratch in the user's Sheets folder within
+        Home.
+
+        Args:
+            sheet_obj (Sheet): Sheet object.
+
+        Returns:
+            Result
+        """
+        if isinstance(sheet_obj, dict):
+            sheet_obj = Sheet(sheet_obj)
+
+        _op = fresh_operation("create_sheet")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets"
+        _op["json"] = sheet_obj
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def create_sheet_from_template(self, sheet_obj, include=None):
+        """Create a Sheet in the Sheets folder from the specified Template.
+
+        The Sheet object should be limited to the following
+        attributes:
+
+        name (required): need not be unique.
+        fromId (required): the ID of the Template to use in creating the
+        Sheet.
+
+        The optional Include parameter is a list of elements to copy from
+        the Template. It may include: data, attachments, discussions,
+        cellLinks, forms
+
+        Args:
+            sheet_obj (Sheet): Sheet object.
+            include (list[str]): A list of optional elements
+                to include from the source Template. Valid list values:
+                attachments, cellLinks, data, discussions, forms, rules and ruleRecipients.
+
+        Returns:
+            Result
+        """
+        _op = fresh_operation("create_sheet_from_template")
+        _op["method"] = "POST"
+        _op["path"] = "/sheets"
+        _op["query_params"]["include"] = include
+        _op["json"] = sheet_obj
+
+        expected = ["Result", "Sheet"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def list_all_contents(self, include=None, exclude=None):
+        """Get a nested list of all Home objects, including Sheets,
+        Workspaces, Folders, Reports and Templates.
+
+        Args:
+            include (list[str]): A comma-separated list of
+                optional elements to include in the response. Valid list
+                values: ownerInfo, sheetVersion, source.
+            include (list[str]): A comma-separated list of
+                optional elements to exclude from the response. Valid list
+                values: permalinks.
+
+        Returns:
+            Home
+        """
+        _op = fresh_operation("list_all_contents")
+        _op["method"] = "GET"
+        _op["path"] = "/home"
+        _op["query_params"]["include"] = include
+        _op["query_params"]["exclude"] = exclude
+
+        expected = "Home"
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    @deprecated
+    def list_folders(self, page_size=None, page=None, include_all=None):
+        """Gets a list of top-level child Folders within the user's Sheets
+        folder.
+
+        Args:
+            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_folders")
+        _op["method"] = "GET"
+        _op["path"] = "/home/folders"
+        _op["query_params"]["pageSize"] = page_size
+        _op["query_params"]["page"] = page
+        _op["query_params"]["includeAll"] = include_all
+
+        expected = ["IndexResult", "Folder"]
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response

smartsheet/images.py

@@ -0,0 +1,61 @@
+# pylint: disable=C0111,R0902,R0913
+# Smartsheet Python SDK.
+#
+# Copyright 2016 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
+
+from . import fresh_operation
+from .models.image_url import ImageUrl
+from .types import TypedList
+
+
+class Images:
+
+    """Class for handling Images operations."""
+
+    def __init__(self, smartsheet_obj):
+        """Init Images with base Smartsheet object."""
+        self._base = smartsheet_obj
+        self._log = logging.getLogger(__name__)
+
+    def get_image_urls(self, list_of_images):
+        """Get URLs that can be used to retrieve specified cell images.
+
+        Args:
+            list_of_images (list[ImageURL]): Array containing one
+                or more ImageURL objects.
+
+        Returns:
+            ImageURLMap
+        """
+        if isinstance(list_of_images, (dict, ImageUrl)):
+            arg_value = list_of_images
+            list_of_images = TypedList(ImageUrl)
+            list_of_images.append(arg_value)
+
+        _op = fresh_operation("get_image_urls")
+        _op["method"] = "POST"
+        _op["path"] = "/imageurls"
+        _op["json"] = list_of_images
+
+        expected = "ImageUrlMap"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response

smartsheet/models/__init__.py

@@ -0,0 +1,126 @@
+# pylint: disable=C0111,C0413
+# Smartsheet Python SDK.
+#
+# Copyright 2016 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 models into model package
+from .access_token import AccessToken
+from .account import Account
+from .alternate_email import AlternateEmail
+from .attachment import Attachment
+from .auto_number_format import AutoNumberFormat
+from .automation_action import AutomationAction
+from .automation_rule import AutomationRule
+from .boolean_object_value import BooleanObjectValue
+from .bulk_item_failure import BulkItemFailure
+from .bulk_item_result import BulkItemResult
+from .cell import Cell
+from .cell_data_item import CellDataItem
+from .cell_history import CellHistory
+from .cell_link import CellLink
+from .column import Column
+from .comment import Comment
+from .contact import Contact
+from .contact_object_value import ContactObjectValue
+from .container_destination import ContainerDestination
+from .copy_or_move_row_destination import CopyOrMoveRowDestination
+from .copy_or_move_row_directive import CopyOrMoveRowDirective
+from .copy_or_move_row_result import CopyOrMoveRowResult
+from .criteria import Criteria
+from .cross_sheet_reference import CrossSheetReference
+from .currency import Currency
+from .date_object_value import DateObjectValue
+from .discussion import Discussion
+from .downloaded_file import DownloadedFile
+from .duration import Duration
+from .email import Email
+from .error import Error
+from .error_result import ErrorResult
+from .event import Event
+from .event_result import EventResult
+from .explicit_null import ExplicitNull
+from .favorite import Favorite
+from .folder import Folder
+from .font_family import FontFamily
+from .format_details import FormatDetails
+from .format_tables import FormatTables
+from .group import Group
+from .group_member import GroupMember
+from .home import Home
+from .hyperlink import Hyperlink
+from .image import Image
+from .image_url import ImageUrl
+from .image_url_map import ImageUrlMap
+from .index_result import IndexResult
+from .json_object import JSONObject
+from .multi_contact_object_value import MultiContactObjectValue
+from .multi_picklist_object_value import MultiPicklistObjectValue
+from .multi_row_email import MultiRowEmail
+from .number_object_value import NumberObjectValue
+from .o_auth_error import OAuthError
+from .object_value import ObjectValue
+from .paginated_children_result import PaginatedChildrenResult
+from .token_paginated_result import TokenPaginatedResult
+from .predecessor import Predecessor
+from .predecessor_list import PredecessorList
+from .project_settings import ProjectSettings
+from .recipient import Recipient
+from .report import Report
+from .report_cell import ReportCell
+from .report_column import ReportColumn
+from .report_publish import ReportPublish
+from .report_row import ReportRow
+from .result import Result
+from .row import Row
+from .row_email import RowEmail
+from .row_mapping import RowMapping
+from .schedule import Schedule
+from .search_result import SearchResult
+from .search_result_item import SearchResultItem
+from .sent_update_request import SentUpdateRequest
+from .server_info import ServerInfo
+from .share import Share
+from .sheet import Sheet
+from .sheet_email import SheetEmail
+from .sheet_filter import SheetFilter
+from .sheet_filter_details import SheetFilterDetails
+from .sheet_publish import SheetPublish
+from .sheet_summary import SheetSummary
+from .sheet_user_settings import SheetUserSettings
+from .shortcut_data_item import ShortcutDataItem
+from .sight import Sight
+from .sight_publish import SightPublish
+from .sort_criterion import SortCriterion
+from .sort_specifier import SortSpecifier
+from .source import Source
+from .string_object_value import StringObjectValue
+from .summary_field import SummaryField
+from .template import Template
+from .update_request import UpdateRequest
+from .user import User
+from .user_profile import UserProfile
+from .version import Version
+from .webhook import Webhook
+from .webhook_secret import WebhookSecret
+from .webhook_stats import WebhookStats
+from .webhook_subscope import WebhookSubscope
+from .widget import Widget
+from .widget_content import WidgetContent
+from .workspace import Workspace
+from .user_plan import UserPlan
+from .asset_shares_paginated_result import AssetSharesPaginatedResult
+from .asset_share import AssetShare

smartsheet/models/access_token.py

@@ -0,0 +1,95 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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
+
+from ..types import Number, String, Timestamp, json
+from ..util import deserialize, serialize
+
+
+class AccessToken:
+
+    """Smartsheet AccessToken data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AccessToken model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {"token_type": ["bearer"]}
+
+        self._access_token = String()
+        self._expires_at = Timestamp()
+        self._expires_in = Number()
+        self._refresh_token = String()
+        self._token_type = String(accept=self.allowed_values["token_type"])
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def access_token(self):
+        return self._access_token.value
+
+    @access_token.setter
+    def access_token(self, value):
+        self._access_token.value = value
+
+    @property
+    def expires_at(self):
+        return self._expires_at.value
+
+    @expires_at.setter
+    def expires_at(self, value):
+        self._expires_at.value = value
+
+    @property
+    def expires_in(self):
+        return self._expires_in.value
+
+    @expires_in.setter
+    def expires_in(self, value):
+        self._expires_in.value = value
+
+    @property
+    def refresh_token(self):
+        return self._refresh_token.value
+
+    @refresh_token.setter
+    def refresh_token(self, value):
+        self._refresh_token.value = value
+
+    @property
+    def token_type(self):
+        return self._token_type.value
+
+    @token_type.setter
+    def token_type(self, value):
+        self._token_type.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet/models/account.py

@@ -0,0 +1,77 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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
+
+from ..types import Number, String, json
+from ..util import deserialize, serialize
+
+
+class Account:
+
+    """Smartsheet Account data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Account model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._id_ = Number()
+        self._name = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "id":
+            return self.id_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "id":
+            self.id_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet/models/alternate_email.py

@@ -0,0 +1,88 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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
+
+from ..types import Boolean, Number, String, json
+from ..util import deserialize, serialize
+
+
+class AlternateEmail:
+
+    """Smartsheet AlternateEmail data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AlternateEmail model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._confirmed = Boolean()
+        self._email = String()
+        self._id_ = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "id":
+            return self.id_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "id":
+            self.id_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def confirmed(self):
+        return self._confirmed.value
+
+    @confirmed.setter
+    def confirmed(self, value):
+        self._confirmed.value = value
+
+    @property
+    def email(self):
+        return self._email.value
+
+    @email.setter
+    def email(self, value):
+        self._email.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()