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

smartsheet/models/enums/update_request_status.py

@@ -0,0 +1,23 @@
+# 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 enum import Enum
+
+
+class UpdateRequestStatus(Enum):
+    PENDING = 1
+    COMPLETE = 2
+    CANCELED = 3

smartsheet/models/enums/user_status.py

@@ -0,0 +1,23 @@
+# 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 enum import Enum
+
+
+class UserStatus(Enum):
+    ACTIVE = 1
+    PENDING = 2
+    DECLINED = 3

smartsheet/models/enums/widget_type.py

@@ -0,0 +1,32 @@
+# 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 enum import Enum
+
+
+class WidgetType(Enum):
+    CHART = 1
+    IMAGE = 2
+    METRIC = 3
+    GRIDGANTT = 4
+    RICHTEXT = 5
+    SHORTCUT = 6
+    TITLE = 7
+    WEBCONTENT = 8
+    # NOTE: These are level=0 widget types that should be supported for now
+    SHORTCUTLIST = 9  # SHORTCUTLIST --> SHORTCUT
+    SHORTCUTICON = 10  # SHORTCUTICON --> SHORTCUT
+    SHEETSUMMARY = 11  # SHEETSUMMARY --> METRIC

smartsheet/models/error.py

@@ -0,0 +1,74 @@
+# 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
+
+from ..types import TypedObject
+from ..util import deserialize, serialize
+from .error_result import ErrorResult
+
+
+class Error:
+
+    """Smartsheet Error data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Error model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._request_response = None
+        self._result = TypedObject(ErrorResult)
+
+        if props:
+            deserialize(self, props)
+
+        self.message = "ERROR"
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def request_response(self):
+        return self._request_response
+
+    @request_response.setter
+    def request_response(self, value):
+        if isinstance(value, object):
+            self._request_response = value
+        else:
+            self._request_response = object(value, self._base)
+
+    @property
+    def result(self):
+        return self._result.value
+
+    @result.setter
+    def result(self, value):
+        self._result.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/error_result.py

@@ -0,0 +1,117 @@
+# 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 ErrorResult:
+
+    """Smartsheet ErrorResult data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ErrorResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._code = Number()
+        self._message = String()
+        self._name = String()
+        self._recommendation = String()
+        self._ref_id = String()
+        self._should_retry = Boolean()
+        self._status_code = Number()
+
+        if props:
+            deserialize(self, props)
+            # account for alternate variable names from raw API response
+
+    @property
+    def code(self):
+        return self._code.value
+
+    @code.setter
+    def code(self, value):
+        self._code.value = value
+
+    @property
+    def error_code(self):
+        return self.code
+
+    @error_code.setter
+    def error_code(self, value):
+        self.code = value
+
+    @property
+    def message(self):
+        return self._message.value
+
+    @message.setter
+    def message(self, value):
+        self._message.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def recommendation(self):
+        return self._recommendation.value
+
+    @recommendation.setter
+    def recommendation(self, value):
+        self._recommendation.value = value
+
+    @property
+    def ref_id(self):
+        return self._ref_id.value
+
+    @ref_id.setter
+    def ref_id(self, value):
+        self._ref_id.value = value
+
+    @property
+    def should_retry(self):
+        return self._should_retry.value
+
+    @should_retry.setter
+    def should_retry(self, value):
+        self._should_retry.value = value
+
+    @property
+    def status_code(self):
+        return self._status_code.value
+
+    @status_code.setter
+    def status_code(self, value):
+        self._status_code.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/event.py

@@ -0,0 +1,153 @@
+# 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 EnumeratedValue, Number, String, Timestamp, json, six
+from ..util import deserialize, serialize
+from .enums import EventAction, EventObjectType, EventSource
+
+
+class Event:
+
+    """Smartsheet Event data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Event model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._access_token_name = String()
+        self._action = EnumeratedValue(EventAction)
+        self._additional_details = None
+        self._event_id = String()
+        self._event_timestamp = None
+        self._object_id = None
+        self._object_type = EnumeratedValue(EventObjectType)
+        self._request_user_id = Number()
+        self._source = EnumeratedValue(EventSource)
+        self._user_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        super().__setattr__(key, value)
+
+    @property
+    def access_token_name(self):
+        return self._access_token_name.value
+
+    @access_token_name.setter
+    def access_token_name(self, value):
+        self._access_token_name.value = value
+
+    @property
+    def action(self):
+        return self._action
+
+    @action.setter
+    def action(self, value):
+        self._action.set(value)
+
+    @property
+    def additional_details(self):
+        return self._additional_details
+
+    @additional_details.setter
+    def additional_details(self, value):
+        self._additional_details = value
+
+    @property
+    def event_id(self):
+        return self._event_id.value
+
+    @event_id.setter
+    def event_id(self, value):
+        self._event_id.value = value
+
+    @property
+    def event_timestamp(self):
+        if self._event_timestamp is not None:
+            return self._event_timestamp.value
+        else:
+            return None
+
+    @event_timestamp.setter
+    def event_timestamp(self, value):
+        if isinstance(value, six.string_types):
+            self._event_timestamp = Timestamp()
+        else:
+            self._event_timestamp = Number()
+        self._event_timestamp.value = value
+
+    @property
+    def object_id(self):
+        return self._object_id
+
+    @object_id.setter
+    def object_id(self, value):
+        self._object_id = value
+
+    @property
+    def object_type(self):
+        return self._object_type
+
+    @object_type.setter
+    def object_type(self, value):
+        self._object_type.set(value)
+
+    @property
+    def request_user_id(self):
+        return self._request_user_id.value
+
+    @request_user_id.setter
+    def request_user_id(self, value):
+        self._request_user_id.value = value
+
+    @property
+    def source(self):
+        return self._source
+
+    @source.setter
+    def source(self, value):
+        self._source.set(value)
+
+    @property
+    def user_id(self):
+        return self._user_id.value
+
+    @user_id.setter
+    def user_id(self, value):
+        self._user_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/event_result.py

@@ -0,0 +1,86 @@
+# 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 Boolean, String, TypedList, importlib, json
+from ..util import deserialize, serialize
+
+
+class EventResult:
+
+    """Smartsheet EventResult data model."""
+
+    def __init__(self, props=None, dynamic_data_type=None, base_obj=None):
+        """Initialize the EventResult 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._more_available = Boolean()
+        self._next_stream_position = 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 more_available(self):
+        return self._more_available.value
+
+    @more_available.setter
+    def more_available(self, value):
+        self._more_available.value = value
+
+    @property
+    def next_stream_position(self):
+        return self._next_stream_position.value
+
+    @next_stream_position.setter
+    def next_stream_position(self, value):
+        self._next_stream_position.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/explicit_null.py

@@ -0,0 +1,24 @@
+# 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
+
+
+class ExplicitNull:
+    def __init__(self):
+        pass
+
+    def is_explicit_null(self):
+        pass

smartsheet/models/favorite.py

@@ -0,0 +1,81 @@
+# 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 Favorite:
+
+    """Smartsheet Favorite data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Favorite model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {
+            "_type": ["workspace", "folder", "sheet", "report", "template", "sight"]
+        }
+
+        self._object_id = Number()
+        self._type_ = String(accept=self.allowed_values["_type"])
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "type":
+            return self.type_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "type":
+            self.type_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def object_id(self):
+        return self._object_id.value
+
+    @object_id.setter
+    def object_id(self, value):
+        self._object_id.value = value
+
+    @property
+    def type_(self):
+        return self._type_.value
+
+    @type_.setter
+    def type_(self, value):
+        self._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()