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

smartsheet/models/widget_hyperlink.py

@@ -0,0 +1,74 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2019 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
+from .hyperlink import Hyperlink
+
+
+class WidgetHyperlink(Hyperlink):
+
+    """Smartsheet WidgetHyperlink data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the WidgetHyperlink model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._interaction_type = String()
+        self._folder_id = Number()
+        self._workspace_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def interaction_type(self):
+        return self._interaction_type.value
+
+    @interaction_type.setter
+    def interaction_type(self, value):
+        self._interaction_type.value = value
+
+    @property
+    def folder_id(self):
+        return self._folder_id.value
+
+    @folder_id.setter
+    def folder_id(self, value):
+        self._folder_id.value = value
+
+    @property
+    def workspace_id(self):
+        return self._workspace_id.value
+
+    @workspace_id.setter
+    def workspace_id(self, value):
+        self._worksspace_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()

smartsheet/models/workspace.py

@@ -0,0 +1,185 @@
+# 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, EnumeratedValue, Number, String, Timestamp, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .enums import AccessLevel
+from .folder import Folder
+from .report import Report
+from .sheet import Sheet
+from .sight import Sight
+from .source import Source
+from .template import Template
+
+
+class Workspace:
+
+    """Smartsheet Workspace data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Workspace model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._created_at = Timestamp()
+        self._favorite = Boolean()
+        self._folders = TypedList(Folder)
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._name = String()
+        self._permalink = String()
+        self._reports = TypedList(Report)
+        self._sheets = TypedList(Sheet)
+        self._sights = TypedList(Sight)
+        self._source = TypedObject(Source)
+        self._templates = TypedList(Template)
+
+        if props:
+            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 access_level(self):
+        return self._access_level
+
+    @access_level.setter
+    def access_level(self, value):
+        self._access_level.set(value)
+
+    @property
+    def created_at(self):
+        return self._created_at.value
+
+    @created_at.setter
+    def created_at(self, value):
+        self._created_at.value = value
+
+    @property
+    def favorite(self):
+        return self._favorite.value
+
+    @favorite.setter
+    def favorite(self, value):
+        self._favorite.value = value
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(value)
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def modified_at(self):
+        return self._modified_at.value
+
+    @modified_at.setter
+    def modified_at(self, value):
+        self._modified_at.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def permalink(self):
+        return self._permalink.value
+
+    @permalink.setter
+    def permalink(self, value):
+        self._permalink.value = value
+
+    @property
+    def reports(self):
+        return self._reports
+
+    @reports.setter
+    def reports(self, value):
+        self._reports.load(value)
+
+    @property
+    def sheets(self):
+        return self._sheets
+
+    @sheets.setter
+    def sheets(self, value):
+        self._sheets.load(value)
+
+    @property
+    def sights(self):
+        return self._sights
+
+    @sights.setter
+    def sights(self, value):
+        self._sights.load(value)
+
+    @property
+    def source(self):
+        return self._source.value
+
+    @source.setter
+    def source(self, value):
+        self._source.value = value
+
+    @property
+    def templates(self):
+        return self._templates
+
+    @templates.setter
+    def templates(self, value):
+        self._templates.load(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/object_value.py

@@ -0,0 +1,72 @@
+# pylint: disable=R0911,R0912
+# Smartsheet Python SDK.
+#
+# Copyright 2019 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 .models.boolean_object_value import BooleanObjectValue
+from .models.contact_object_value import ContactObjectValue
+from .models.date_object_value import DateObjectValue
+from .models.datetime_object_value import DatetimeObjectValue
+from .models.duration import Duration
+from .models.multi_contact_object_value import MultiContactObjectValue
+from .models.multi_picklist_object_value import MultiPicklistObjectValue
+from .models.number_object_value import NumberObjectValue
+from .models.object_value import (ABSTRACT_DATETIME, CONTACT, DATE, DATETIME,
+                                  DURATION, MULTI_CONTACT, MULTI_PICKLIST,
+                                  OBJECT_VALUE, PREDECESSOR_LIST, ObjectValue,
+                                  enum_object_value_type, six)
+from .models.predecessor_list import PredecessorList
+from .models.string_object_value import StringObjectValue
+
+
+def assign_to_object_value(value):
+
+    if isinstance(value, ObjectValue):
+        return value
+    elif isinstance(value, dict):
+        object_type = value["objectType"]
+        if object_type in OBJECT_VALUE["object_type"]:
+            enum_object_type = enum_object_value_type(object_type)
+            if enum_object_type == DURATION:
+                return Duration(value)
+            elif enum_object_type == PREDECESSOR_LIST:
+                return PredecessorList(value)
+            elif enum_object_type == CONTACT:
+                return ContactObjectValue(value)
+            elif enum_object_type == DATE:
+                return DateObjectValue(value)
+            elif enum_object_type in (DATETIME, ABSTRACT_DATETIME):
+                return DatetimeObjectValue(value, enum_object_value_type)
+            elif enum_object_type == MULTI_CONTACT:
+                return MultiContactObjectValue(value)
+            elif enum_object_type == MULTI_PICKLIST:
+                return MultiPicklistObjectValue(value)
+            else:
+                return None
+        else:
+            raise ValueError(
+                (
+                    f"`{object_type}` is an invalid value for ObjectValue`object_type`,"
+                    f" must be one of {OBJECT_VALUE['object_type']}"
+                )
+            )
+    elif isinstance(value, six.string_types):
+        return StringObjectValue(value)
+    elif isinstance(value, bool):
+        return BooleanObjectValue(value)
+    elif isinstance(value, (six.integer_types, float)):
+        return NumberObjectValue(value)
+    else:
+        return None

smartsheet/passthrough.py

@@ -0,0 +1,127 @@
+# pylint: disable=C0111,R0902,R0913
+# Smartsheet Python SDK.
+#
+# Copyright 2017 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 import JSONObject
+
+
+class Passthrough:
+
+    """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 get(self, endpoint, query_params=None):
+        """Issue a GET request on the specified URL.
+
+        Args:
+            endpoint (str): Endpoint URL (relative to base), e.g. '/sheets'
+            query_params (dict): Optional dictionary of additional query parameters
+
+        Returns:
+            JSONObject
+        """
+        _op = fresh_operation("get_passthrough")
+        _op["method"] = "GET"
+        _op["path"] = endpoint
+        _op["query_params"] = query_params
+
+        expected = "JSONObject"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def post(self, endpoint, payload, query_params=None):
+        """Issue a POST request on the specified URL.
+
+        Args:
+            endpoint (str): Endpoint URL (relative to base), e.g. '/sheets'
+            payload (str, dict, or JSONObject): JSON payload
+            query_params (dict): Optional dictionary of additional query parameters
+
+        Returns:
+            JSONObject
+        """
+        _op = fresh_operation("post_passthrough")
+        _op["method"] = "POST"
+        _op["path"] = endpoint
+        if not isinstance(payload, JSONObject):
+            payload = JSONObject(payload)
+        _op["json"] = payload
+        _op["query_params"] = query_params
+
+        expected = "JSONObject"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def put(self, endpoint, payload, query_params=None):
+        """Issue a PUT request on the specified URL.
+
+        Args:
+            endpoint (str): Endpoint URL (relative to base), e.g. '/sheets/{id}'
+            payload (str, dict or JSONObject): JSON payload
+            query_params (dict): Optional dictionary of additional query parameters
+
+        Returns:
+            JSONObject
+        """
+        _op = fresh_operation("put_passthrough")
+        _op["method"] = "PUT"
+        _op["path"] = endpoint
+        if not isinstance(payload, JSONObject):
+            payload = JSONObject(payload)
+        _op["json"] = payload
+        _op["query_params"] = query_params
+
+        expected = "JSONObject"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response
+
+    def delete(self, endpoint):
+        """Issue a DELETE request on the specified URL.
+
+        Args:
+            endpoint (str): Endpoint URL (relative to base), e.g. '/sheets/{id}'
+
+        Returns:
+            JSONObject
+        """
+        _op = fresh_operation("get_passthrough")
+        _op["method"] = "DELETE"
+        _op["path"] = endpoint
+
+        expected = "JSONObject"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response