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

smartsheet/models/column.py

@@ -0,0 +1,253 @@
+# 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, TypedList,
+                     TypedObject, json)
+from ..util import deserialize, serialize
+from .auto_number_format import AutoNumberFormat
+from .contact import Contact
+from .enums import ColumnType, Symbol, SystemColumnType
+
+
+class Column:
+
+    """Smartsheet Column data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Column model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._auto_number_format = TypedObject(AutoNumberFormat)
+        self._contact_options = TypedList(Contact)
+        self._description = String()
+        self._format_ = String()
+        self._formula = String()
+        self._hidden = Boolean()
+        self._id_ = Number()
+        self._index = Number()
+        self._locked = Boolean()
+        self._locked_for_user = Boolean()
+        self._options = TypedList(str)
+        self._primary = Boolean()
+        self._symbol = EnumeratedValue(Symbol)
+        self._system_column_type = EnumeratedValue(SystemColumnType)
+        self._tags = TypedList(str)
+        self._title = String()
+        self._type_ = EnumeratedValue(ColumnType)
+        self._width = Number()
+        self._validation = Boolean()
+        self._version = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "format":
+            return self.format_
+        elif key == "id":
+            return self.id_
+        elif key == "type":
+            return self.type_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "format":
+            self.format_ = value
+        elif key == "id":
+            self.id_ = value
+        elif key == "type":
+            self.type_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def auto_number_format(self):
+        return self._auto_number_format.value
+
+    @auto_number_format.setter
+    def auto_number_format(self, value):
+        self._auto_number_format.value = value
+
+    @property
+    def contact_options(self):
+        return self._contact_options
+
+    @contact_options.setter
+    def contact_options(self, value):
+        self._contact_options.load(value)
+
+    @property
+    def description(self):
+        return self._description.value
+
+    @description.setter
+    def description(self, value):
+        self._description.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 hidden(self):
+        return self._hidden.value
+
+    @hidden.setter
+    def hidden(self, value):
+        self._hidden.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def index(self):
+        return self._index.value
+
+    @index.setter
+    def index(self, value):
+        self._index.value = value
+
+    @property
+    def locked(self):
+        return self._locked.value
+
+    @locked.setter
+    def locked(self, value):
+        self._locked.value = value
+
+    @property
+    def locked_for_user(self):
+        return self._locked_for_user.value
+
+    @locked_for_user.setter
+    def locked_for_user(self, value):
+        self._locked_for_user.value = value
+
+    @property
+    def options(self):
+        return self._options
+
+    @options.setter
+    def options(self, value):
+        self._options.load(value)
+
+    @property
+    def primary(self):
+        return self._primary.value
+
+    @primary.setter
+    def primary(self, value):
+        self._primary.value = value
+
+    @property
+    def symbol(self):
+        return self._symbol
+
+    @symbol.setter
+    def symbol(self, value):
+        self._symbol.set(value)
+
+    @property
+    def system_column_type(self):
+        return self._system_column_type
+
+    @system_column_type.setter
+    def system_column_type(self, value):
+        self._system_column_type.set(value)
+
+    @property
+    def tags(self):
+        return self._tags
+
+    @tags.setter
+    def tags(self, value):
+        self._tags.load(value)
+
+    @property
+    def title(self):
+        return self._title.value
+
+    @title.setter
+    def title(self, value):
+        self._title.value = value
+
+    @property
+    def type_(self):
+        return self._type_
+
+    @type_.setter
+    def type_(self, value):
+        self._type_.set(value)
+
+    @property
+    def width(self):
+        return self._width.value
+
+    @width.setter
+    def width(self, value):
+        self._width.value = value
+
+    @property
+    def validation(self):
+        return self._validation.value
+
+    @validation.setter
+    def validation(self, value):
+        self._validation.value = value
+
+    @property
+    def version(self):
+        return self._version.value
+
+    @version.setter
+    def version(self, value):
+        self._version.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/comment.py

@@ -0,0 +1,126 @@
+# 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, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .attachment import Attachment
+from .user import User
+
+
+class Comment:
+
+    """Smartsheet Comment data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Comment model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._attachments = TypedList(Attachment)
+        self._created_at = Timestamp()
+        self._created_by = TypedObject(User)
+        self._discussion_id = Number()
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._text = String()
+
+        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 attachments(self):
+        return self._attachments
+
+    @attachments.setter
+    def attachments(self, value):
+        self._attachments.load(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 discussion_id(self):
+        return self._discussion_id.value
+
+    @discussion_id.setter
+    def discussion_id(self, value):
+        self._discussion_id.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 text(self):
+        return self._text.value
+
+    @text.setter
+    def text(self, value):
+        self._text.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/contact.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 String, json
+from ..util import deserialize, serialize
+
+
+class Contact:
+
+    """Smartsheet Contact data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Contact model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._email = String()
+        self._id_ = String()
+        self._name = String()
+
+        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 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
+
+    @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/contact_object_value.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
+
+from ..types import Number, String
+from ..util import deserialize
+from .contact import Contact
+from .object_value import CONTACT, ObjectValue
+
+
+class ContactObjectValue(ObjectValue, Contact):
+    """Smartsheet ContactObjectValue data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ContactObjectValue model."""
+        ObjectValue.__init__(self, CONTACT, base_obj)
+        Contact.__init__(self, None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._image_id = String()
+        self._ref_index = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def image_id(self):
+        return self._image_id.value
+
+    @image_id.setter
+    def image_id(self, value):
+        self._image_id.value = value
+
+    @property
+    def ref_index(self):
+        return self._ref_index.value
+
+    @ref_index.setter
+    def ref_index(self, value):
+        self._ref_index.value = value

smartsheet/models/container_destination.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
+
+from ..types import Number, String, json
+from ..util import deserialize, serialize
+
+
+class ContainerDestination:
+
+    """Smartsheet ContainerDestination data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ContainerDestination model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {"destination_type": ["home", "workspace", "folder"]}
+
+        self._destination_id = Number()
+        self._destination_type = String(accept=self.allowed_values["destination_type"])
+        self._new_name = String()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def destination_id(self):
+        return self._destination_id.value
+
+    @destination_id.setter
+    def destination_id(self, value):
+        self._destination_id.value = value
+
+    @property
+    def destination_type(self):
+        return self._destination_type.value
+
+    @destination_type.setter
+    def destination_type(self, value):
+        self._destination_type.value = value
+
+    @property
+    def new_name(self):
+        return self._new_name.value
+
+    @new_name.setter
+    def new_name(self, value):
+        self._new_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/copy_or_move_row_destination.py

@@ -0,0 +1,54 @@
+# 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, json
+from ..util import deserialize, serialize
+
+
+class CopyOrMoveRowDestination:
+
+    """Smartsheet CopyOrMoveRowDestination data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CopyOrMoveRowDestination model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._sheet_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def sheet_id(self):
+        return self._sheet_id.value
+
+    @sheet_id.setter
+    def sheet_id(self, value):
+        self._sheet_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()