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

smartsheet/models/automation_rule.py

@@ -0,0 +1,164 @@
+# 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,
+                     TypedObject, json)
+from ..util import deserialize, serialize
+from .automation_action import AutomationAction
+from .enums import AutomationRuleDisabledReason
+from .user import User
+
+
+class AutomationRule:
+
+    """Smartsheet AutomationRule data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AutomationRule model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._action = TypedObject(AutomationAction)
+        self._created_at = Timestamp()
+        self._created_by = TypedObject(User)
+        self._disabled_reason = EnumeratedValue(AutomationRuleDisabledReason)
+        self._disabled_reason_text = String()
+        self._enabled = Boolean()
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._modified_by = TypedObject(User)
+        self._name = String()
+        self._user_can_modify = Boolean()
+
+        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 action(self):
+        return self._action.value
+
+    @action.setter
+    def action(self, value):
+        self._action.value = 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 created_by(self):
+        return self._created_by.value
+
+    @created_by.setter
+    def created_by(self, value):
+        self._created_by.value = value
+
+    @property
+    def disabled_reason(self):
+        return self._disabled_reason
+
+    @disabled_reason.setter
+    def disabled_reason(self, value):
+        self._disabled_reason.set(value)
+
+    @property
+    def disabled_reason_text(self):
+        return self._disabled_reason_text.value
+
+    @disabled_reason_text.setter
+    def disabled_reason_text(self, value):
+        self._disabled_reason_text.value = value
+
+    @property
+    def enabled(self):
+        return self._enabled.value
+
+    @enabled.setter
+    def enabled(self, value):
+        self._enabled.value = 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 modified_by(self):
+        return self._modified_by.value
+
+    @modified_by.setter
+    def modified_by(self, value):
+        self._modified_by.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def user_can_modify(self):
+        return self._user_can_modify.value
+
+    @user_can_modify.setter
+    def user_can_modify(self, value):
+        self._user_can_modify.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/boolean_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 BOOLEAN
+from .primitive_object_value import PrimitiveObjectValue
+
+
+class BooleanObjectValue(PrimitiveObjectValue):
+    """Smartsheet BooleanObjectValue data model."""
+
+    def __init__(self, value=None, base_obj=None):
+        """Initialize the BooleanObjectValue 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 BOOLEAN

smartsheet/models/bulk_item_failure.py

@@ -0,0 +1,77 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101,W0613
+# 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, TypedObject, json
+from ..util import deserialize, serialize
+from .error_result import ErrorResult
+
+
+class BulkItemFailure:
+
+    """Smartsheet BulkItemFailure data model."""
+
+    def __init__(self, props=None, dynamic_result_type=None, base_obj=None):
+        """Initialize the BulkItemFailure model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._error = TypedObject(ErrorResult)
+        self._index = Number()
+        self._row_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def error(self):
+        return self._error.value
+
+    @error.setter
+    def error(self, value):
+        self._error.value = value
+
+    @property
+    def index(self):
+        return self._index.value
+
+    @index.setter
+    def index(self, value):
+        self._index.value = value
+
+    @property
+    def row_id(self):
+        return self._row_id.value
+
+    @row_id.setter
+    def row_id(self, value):
+        self._row_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/bulk_item_result.py

@@ -0,0 +1,111 @@
+# 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, TypedList, importlib, json
+from ..util import deserialize, serialize
+from .bulk_item_failure import BulkItemFailure
+
+
+class BulkItemResult:
+
+    """Smartsheet BulkItemResult data model."""
+
+    def __init__(self, props=None, dynamic_result_type=None, base_obj=None):
+        """Initialize the BulkItemResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._dynamic_result_type = None
+        if dynamic_result_type is not None:
+            self._dynamic_result_type = dynamic_result_type
+
+        self._failed_items = TypedList(BulkItemFailure)
+        self._message = String()
+        self._result = TypedList(object)
+        self._result_code = Number()
+        self._version = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def failed_items(self):
+        return self._failed_items
+
+    @failed_items.setter
+    def failed_items(self, value):
+        if isinstance(value, list):
+            self._failed_items = [BulkItemFailure(x, self._base) for x in value]
+        else:
+            self._failed_items = BulkItemFailure(value, self._base)
+
+    @property
+    def message(self):
+        return self._message.value
+
+    @message.setter
+    def message(self, value):
+        self._message.value = value
+
+    @property
+    def result(self):
+        return self._result
+
+    @result.setter
+    def result(self, value):
+        class_ = getattr(
+            importlib.import_module("smartsheet.models"), self._dynamic_result_type
+        )
+        if isinstance(value, list):
+            self._result = [class_(x, self._base) for x in value]
+        else:
+            self._result = class_(value, self._base)
+
+    @property
+    def result_code(self):
+        return self._result_code.value
+
+    @result_code.setter
+    def result_code(self, value):
+        self._result_code.value = value
+
+    @property
+    def version(self):
+        return self._version.value
+
+    @version.setter
+    def version(self, value):
+        self._version.value = value
+
+    @property
+    def data(self):
+        """Simplify difference between Result and IndexResult"""
+        return self._result
+
+    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/cell.py

@@ -0,0 +1,193 @@
+# 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 ..object_value import assign_to_object_value
+from ..types import Boolean, Number, String, TypedList, TypedObject, json, six
+from ..util import deserialize, serialize
+from .cell_link import CellLink
+from .explicit_null import ExplicitNull
+from .hyperlink import Hyperlink
+from .image import Image
+
+
+class Cell:
+
+    """Smartsheet Cell data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Cell model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._column_id = Number()
+        self._column_type = String()
+        self._conditional_format = String()
+        self._display_value = String()
+        self._format_ = String()
+        self._formula = String()
+        self._hyperlink = TypedObject(Hyperlink)
+        self._image = TypedObject(Image)
+        self._link_in_from_cell = TypedObject(CellLink)
+        self._links_out_to_cells = TypedList(CellLink)
+        self._object_value = None
+        self._override_validation = Boolean()
+        self._strict = Boolean()
+        self._value = None
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "format":
+            return self.format_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "format":
+            self.format_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def column_id(self):
+        return self._column_id.value
+
+    @column_id.setter
+    def column_id(self, value):
+        self._column_id.value = value
+
+    @property
+    def column_type(self):
+        return self._column_type.value
+
+    @column_type.setter
+    def column_type(self, value):
+        self._column_type.value = value
+
+    @property
+    def conditional_format(self):
+        return self._conditional_format.value
+
+    @conditional_format.setter
+    def conditional_format(self, value):
+        self._conditional_format.value = value
+
+    @property
+    def display_value(self):
+        return self._display_value.value
+
+    @display_value.setter
+    def display_value(self, value):
+        self._display_value.value = value
+
+    @property
+    def format_(self):
+        return self._format_.value
+
+    @format_.setter
+    def format_(self, value):
+        self._format_.value = value
+
+    @property
+    def formula(self):
+        return self._formula.value
+
+    @formula.setter
+    def formula(self, value):
+        self._formula.value = value
+
+    @property
+    def hyperlink(self):
+        return self._hyperlink.value
+
+    @hyperlink.setter
+    def hyperlink(self, value):
+        self._hyperlink.value = value
+
+    @property
+    def image(self):
+        return self._image.value
+
+    @image.setter
+    def image(self, value):
+        self._image.value = value
+
+    @property
+    def link_in_from_cell(self):
+        return self._link_in_from_cell.value
+
+    @link_in_from_cell.setter
+    def link_in_from_cell(self, value):
+        self._link_in_from_cell.value = value
+
+    @property
+    def links_out_to_cells(self):
+        return self._links_out_to_cells
+
+    @links_out_to_cells.setter
+    def links_out_to_cells(self, value):
+        self._links_out_to_cells.load(value)
+
+    @property
+    def object_value(self):
+        return self._object_value
+
+    @object_value.setter
+    def object_value(self, value):
+        self._object_value = assign_to_object_value(value)
+
+    @property
+    def override_validation(self):
+        return self._override_validation.value
+
+    @override_validation.setter
+    def override_validation(self, value):
+        self._override_validation.value = value
+
+    @property
+    def strict(self):
+        return self._strict.value
+
+    @strict.setter
+    def strict(self, value):
+        self._strict.value = value
+
+    @property
+    def value(self):
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        if isinstance(
+            value, (six.string_types, six.integer_types, float, bool, ExplicitNull)
+        ):
+            self._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()