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

smartsheet/models/index_result.py

@@ -0,0 +1,118 @@
+# 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, TypedList, importlib, json, String
+from ..util import deserialize, serialize
+
+
+class IndexResult:
+
+    """Smartsheet IndexResult data model."""
+
+    def __init__(self, props=None, dynamic_data_type=None, base_obj=None):
+        """Initialize the IndexResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._dynamic_data_type = None
+        if dynamic_data_type is not None:
+            self._dynamic_data_type = dynamic_data_type
+
+        self._data = TypedList(object)
+        self._page_number = Number()
+        self._page_size = Number()
+        self._total_count = Number()
+        self._total_pages = Number()
+        self._last_key = String()
+
+        if props:
+            deserialize(self, props)
+            # account for alternate variable names from raw API response
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def data(self):
+        return self._data
+
+    @data.setter
+    def data(self, value):
+        class_ = getattr(
+            importlib.import_module("smartsheet.models"), self._dynamic_data_type
+        )
+        if isinstance(value, list):
+            self._data = [class_(x, self._base) for x in value]
+        else:
+            self._data = class_(value, self._base)
+
+    @property
+    def page_number(self):
+        return self._page_number.value
+
+    @page_number.setter
+    def page_number(self, value):
+        self._page_number.value = value
+
+    @property
+    def page_size(self):
+        return self._page_size.value
+
+    @page_size.setter
+    def page_size(self, value):
+        self._page_size.value = value
+
+    @property
+    def total_count(self):
+        return self._total_count.value
+
+    @total_count.setter
+    def total_count(self, value):
+        self._total_count.value = value
+
+    @property
+    def total_pages(self):
+        return self._total_pages.value
+
+    @total_pages.setter
+    def total_pages(self, value):
+        self._total_pages.value = value
+
+    @property
+    def last_key(self):
+        return self._last_key.value
+
+    @last_key.setter
+    def last_key(self, value):
+        self._last_key.value = value
+
+    @property
+    def result(self):
+        """Simplify difference between Result and IndexResult"""
+        return self._data
+
+    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/json_object.py

@@ -0,0 +1,59 @@
+# 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
+
+import json
+
+import six
+
+
+class JSONObject:
+
+    """Smartsheet JSONObject data model."""
+
+    def __init__(self, payload=None, base_obj=None):
+        """Initialize the JSONObject model."""
+        self._base = None
+        self._data = None
+        if base_obj is not None:
+            self._base = base_obj
+        if payload is not None:
+            self.data = payload
+
+    @property
+    def data(self):
+        return self._data
+
+    @data.setter
+    def data(self, value):
+        if isinstance(value, dict):
+            self._data = value
+        elif isinstance(value, six.string_types):
+            self._data = json.loads(value)
+
+    def serialize(self):
+        return self._data
+
+    def to_dict(self):
+        return self._data
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet/models/multi_contact_object_value.py

@@ -0,0 +1,49 @@
+# 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 TypedList
+from ..util import deserialize
+from .contact_object_value import ContactObjectValue
+from .object_value import MULTI_CONTACT, ObjectValue
+
+
+class MultiContactObjectValue(ObjectValue):
+    """Smartsheet MultiContactObjectValue data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the MultiContactObjectValue model."""
+        ObjectValue.__init__(self, MULTI_CONTACT, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._values = TypedList(ContactObjectValue)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def values(self):
+        return self._values
+
+    @values.setter
+    def values(self, value):
+        self._values.load(value)

smartsheet/models/multi_picklist_object_value.py

@@ -0,0 +1,48 @@
+# 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 TypedList
+from ..util import deserialize
+from .object_value import MULTI_PICKLIST, ObjectValue
+
+
+class MultiPicklistObjectValue(ObjectValue):
+    """Smartsheet MultiPicklistObjectValue data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the MultiPicklistObjectValue model."""
+        ObjectValue.__init__(self, MULTI_PICKLIST, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._values = TypedList(str)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def values(self):
+        return self._values
+
+    @values.setter
+    def values(self, value):
+        self._values.load(value)

smartsheet/models/multi_row_email.py

@@ -0,0 +1,60 @@
+# 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
+
+import json
+
+import six
+
+from ..types import TypedList
+from ..util import deserialize, serialize
+from .row_email import RowEmail
+
+
+class MultiRowEmail(RowEmail):
+
+    """Smartsheet MultiRowEmail data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the MultiRowEmail model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._row_ids = TypedList(six.integer_types)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def row_ids(self):
+        return self._row_ids
+
+    @row_ids.setter
+    def row_ids(self, value):
+        self._row_ids.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/models/number_object_value.py

@@ -0,0 +1,38 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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
+
+from .object_value import NUMBER
+from .primitive_object_value import PrimitiveObjectValue
+
+
+class NumberObjectValue(PrimitiveObjectValue):
+    """Smartsheet NumberObjectValue data model."""
+
+    def __init__(self, value=None, base_obj=None):
+        """Initialize the NumberObjectValue model."""
+        super().__init__(value, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.__initialized = True
+
+    @property
+    def object_type(self):
+        return NUMBER

smartsheet/models/o_auth_error.py

@@ -0,0 +1,86 @@
+# 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 OAuthError:
+
+    """Smartsheet OAuthError data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the OAuthError model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {
+            "error": [
+                "invalid_request",
+                "invalid_client",
+                "invalid_grant",
+                "unauthorized_client",
+                "unsupported_grant_type",
+                "invalid_scope",
+            ]
+        }
+
+        self._error = String(accept=self.allowed_values["error"])
+        self._error_code = Number()
+        self._error_description = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def error(self):
+        return self._error.value
+
+    @error.setter
+    def error(self, value):
+        self._error.value = value
+
+    @property
+    def error_code(self):
+        return self._error_code.value
+
+    @error_code.setter
+    def error_code(self, value):
+        self._error_code.value = value
+
+    @property
+    def error_description(self):
+        return self._error_description.value
+
+    @error_description.setter
+    def error_description(self, value):
+        self._error_description.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/object_value.py

@@ -0,0 +1,130 @@
+# 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
+
+import json
+
+import six
+
+from ..util import get_child_properties, serialize
+from .explicit_null import ExplicitNull
+
+DATE = 1
+DATETIME = 2
+ABSTRACT_DATETIME = 3
+CONTACT = 4
+DURATION = 5
+PREDECESSOR_LIST = 6
+MULTI_CONTACT = 7
+MULTI_PICKLIST = 8
+NUMBER = 9
+BOOLEAN = 10
+STRING = 11
+
+OBJECT_VALUE = {
+    "object_type": [
+        "DATE",
+        "DATETIME",
+        "ABSTRACT_DATETIME",
+        "CONTACT",
+        "DURATION",
+        "PREDECESSOR_LIST",
+        "MULTI_CONTACT",
+        "MULTI_PICKLIST",
+    ]
+}
+
+_TYPE_TO_NAME = {
+    DATE: "DATE",
+    DATETIME: "DATETIME",
+    ABSTRACT_DATETIME: "ABSTRACT_DATETIME",
+    CONTACT: "CONTACT",
+    DURATION: "DURATION",
+    PREDECESSOR_LIST: "PREDECESSOR_LIST",
+    MULTI_CONTACT: "MULTI_CONTACT",
+    MULTI_PICKLIST: "MULTI_PICKLIST",
+}
+
+_NAME_TO_TYPE = {
+    "DATE": DATE,
+    "DATETIME": DATETIME,
+    "ABSTRACT_DATETIME": ABSTRACT_DATETIME,
+    "CONTACT": CONTACT,
+    "DURATION": DURATION,
+    "PREDECESSOR_LIST": PREDECESSOR_LIST,
+    "MULTI_CONTACT": MULTI_CONTACT,
+    "MULTI_PICKLIST": MULTI_PICKLIST,
+}
+
+
+def enum_object_value_type(object_type=None):
+    return _NAME_TO_TYPE.get(object_type)
+
+
+class ObjectValue:
+    """Smartsheet ObjectValue data model."""
+
+    def __init__(self, object_type=None, base_obj=None):
+        """Initialize the ObjectValue model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._object_type = object_type
+
+        self.__initialized = True
+
+    @property
+    def object_type(self):
+        return self._object_type
+
+    @object_type.setter
+    def object_type(self, value):
+        if isinstance(value, six.string_types):
+            self._object_type = _NAME_TO_TYPE.get(value)
+        else:
+            self._object_type = value
+
+    def serialize(self):
+        # when serializing an objectValue object, change objectType to a string value
+        retval = {}
+        prop_list = get_child_properties(self)
+        for prop in prop_list:
+            prop_name = prop[0]
+            camel_case = prop[1]
+            prop_value = getattr(self, prop_name)
+            if prop_value is not None:
+                serialized = serialize(prop_value)
+                if isinstance(
+                    serialized, ExplicitNull
+                ):  # object forcing serialization of a null
+                    retval[camel_case] = None
+                elif serialized is not None:
+                    retval[camel_case] = serialized
+
+        retval["objectType"] = _TYPE_TO_NAME.get(self._object_type)
+        return retval
+
+    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/paginated_children_result.py

@@ -0,0 +1,80 @@
+# 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 typing import Union
+from ..util import deserialize
+from .token_paginated_result import TokenPaginatedResult
+from .folder import Folder
+from .sheet import Sheet
+from .sight import Sight
+from .report import Report
+
+# Type alias for children that can be any of these types
+ChildType = Union[Folder, Sheet, Sight, Report]
+
+
+class PaginatedChildrenResult(TokenPaginatedResult[ChildType]):
+    """Smartsheet PaginatedChildrenResult that deserializes mixed children based on resourceType."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the PaginatedChildrenResult model."""
+        super().__init__(props=None, base_obj=base_obj)
+
+        if props:
+            self._deserialize_data(props)
+            deserialize(self, props)
+
+    def _deserialize_data(self, props):
+        """Custom deserialization for data array based on resourceType."""
+        if 'data' in props:
+            self._data = []
+            for item in props['data']:
+                self.append_data(item)
+
+    def append_data(self, item):
+        """Append data item, converting to appropriate model based on resourceType."""
+        # Get resource type from either dict or object
+        if isinstance(item, dict):
+            resource_type = item.get('resourceType', '').lower()
+        else:
+            resource_type = getattr(item, 'resourceType', '').lower()
+
+        # Convert to appropriate model object based on resource type
+        if resource_type == 'folder':
+            self._data.append(Folder(item, self._base))
+        elif resource_type == 'sheet':
+            self._data.append(Sheet(item, self._base))
+        elif resource_type == 'sight':
+            self._data.append(Sight(item, self._base))
+        elif resource_type == 'report':
+            self._data.append(Report(item, self._base))
+        else:
+            # If no resource type or unknown type, append as-is
+            self._data.append(item)
+
+    @property
+    def data(self):
+        return self._data
+
+    @data.setter
+    def data(self, value):
+        """Custom setter that handles deserialization of mixed resource types."""
+        self._data = []
+        for item in value:
+            self.append_data(item)