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

smartsheet/models/summary_field.py

@@ -0,0 +1,256 @@
+# 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 ..object_value import assign_to_object_value
+from ..types import (Boolean, EnumeratedValue, Number, String, Timestamp,
+                     TypedList, TypedObject, json)
+from ..util import deserialize, serialize
+from .contact import Contact
+from .enums.column_type import ColumnType
+from .hyperlink import Hyperlink
+from .image import Image
+from .user import User
+
+
+class SummaryField:
+
+    """Smartsheet SummaryField data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SummaryField model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._contact_options = TypedList(Contact)
+        self._created_at = Timestamp()
+        self._created_by = TypedObject(User)
+        self._display_value = String()
+        self._format_ = String()
+        self._formula = String()
+        self._hyperlink = TypedObject(Hyperlink)
+        self._id_ = Number()
+        self._image = TypedObject(Image)
+        self._index = Number()
+        self._locked = Boolean()
+        self._locked_for_user = Boolean()
+        self._modified_at = Timestamp()
+        self._modified_by = TypedObject(User)
+        self._object_value = None
+        self._options = TypedList(str)
+        self._symbol = String()
+        self._title = String()
+        self._type_ = EnumeratedValue(ColumnType)
+        self._validation = Boolean()
+
+        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 contact_options(self):
+        return self._contact_options
+
+    @contact_options.setter
+    def contact_options(self, value):
+        self._contact_options.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 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 id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def image(self):
+        return self._image.value
+
+    @image.setter
+    def image(self, value):
+        self._image.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 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 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 options(self):
+        return self._options
+
+    @options.setter
+    def options(self, value):
+        self._options.load(value)
+
+    @property
+    def symbol(self):
+        return self._symbol.value
+
+    @symbol.setter
+    def symbol(self, value):
+        self._symbol.value = 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 validation(self):
+        return self._validation.value
+
+    @validation.setter
+    def validation(self, value):
+        self._validation.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/template.py

@@ -0,0 +1,171 @@
+# 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, json,
+                     six)
+from ..util import deserialize, serialize
+from .enums import AccessLevel, GlobalTemplate
+
+
+class Template:
+
+    """Smartsheet Template data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Template model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {"type": ["sheet", "report"]}
+
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._blank = Boolean()
+        self._categories = TypedList(six.string_types)
+        self._description = String()
+        self._global_template = EnumeratedValue(GlobalTemplate)
+        self._id_ = Number()
+        self._image = String()
+        self._large_image = String()
+        self._locale = String()
+        self._name = String()
+        self._tags = TypedList(six.string_types)
+        self._type = String(accept=self.allowed_values["type"])
+
+        if props:
+            deserialize(self, props)
+
+        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 blank(self):
+        return self._blank.value
+
+    @blank.setter
+    def blank(self, value):
+        self._blank.value = value
+
+    @property
+    def categories(self):
+        return self._categories
+
+    @categories.setter
+    def categories(self, value):
+        self._categories.load(value)
+
+    @property
+    def description(self):
+        return self._description.value
+
+    @description.setter
+    def description(self, value):
+        self._description.value = value
+
+    @property
+    def global_template(self):
+        return self._global_template
+
+    @global_template.setter
+    def global_template(self, value):
+        self._global_template.set(value)
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def image(self):
+        return self._image.value
+
+    @image.setter
+    def image(self, value):
+        self._image.value = value
+
+    @property
+    def large_image(self):
+        return self._large_image.value
+
+    @large_image.setter
+    def large_image(self, value):
+        self._large_image.value = value
+
+    @property
+    def locale(self):
+        return self._locale.value
+
+    @locale.setter
+    def locale(self, value):
+        self._locale.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def tags(self):
+        return self._tags
+
+    @tags.setter
+    def tags(self, value):
+        self._tags.load(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()

smartsheet/models/title_rich_text_widget_content.py

@@ -0,0 +1,68 @@
+# 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 String, json
+from ..util import deserialize, serialize
+from .enums import WidgetType
+from .widget_content import WidgetContent
+
+
+class TitleRichTextWidgetContent(WidgetContent):
+    """Smartsheet TitleRichTextWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the TitleRichTextWidgetContent model."""
+        super().__init__(WidgetType.TITLE, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the TitleWidgetContent object
+        self._background_color = String()
+        self._html_content = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def background_color(self):
+        return self._background_color.value
+
+    @background_color.setter
+    def background_color(self, value):
+        self._background_color.value = value
+
+    @property
+    def html_content(self):
+        return self._html_content.value
+
+    @html_content.setter
+    def html_content(self, value):
+        self._html_content.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/token_paginated_result.py

@@ -0,0 +1,79 @@
+# 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 TypeVar, Generic, List
+from ..types import String, json, TypedList, importlib
+from ..util import deserialize, serialize
+
+T = TypeVar('T')
+
+
+class TokenPaginatedResult(Generic[T]):
+    """Smartsheet TokenPaginatedResult data model with generic type support."""
+
+    def __init__(self, props=None, dynamic_data_type=None, base_obj=None):
+        """Initialize the TokenPaginatedResult 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._last_key = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def data(self) -> List[T]:
+        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 last_key(self):
+        return self._last_key.value
+
+    @last_key.setter
+    def last_key(self, value):
+        self._last_key.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/update_request.py

@@ -0,0 +1,110 @@
+# 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, Timestamp, TypedObject, json
+from ..util import deserialize, serialize
+from .multi_row_email import MultiRowEmail
+from .schedule import Schedule
+from .user import User
+
+
+class UpdateRequest(MultiRowEmail):
+
+    """Smartsheet UpdateRequest data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the UpdateRequest model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._created_at = Timestamp()
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._schedule = TypedObject(Schedule)
+        self._sent_by = TypedObject(User)
+
+        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 created_at(self):
+        return self._created_at.value
+
+    @created_at.setter
+    def created_at(self, value):
+        self._created_at.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 schedule(self):
+        return self._schedule.value
+
+    @schedule.setter
+    def schedule(self, value):
+        self._schedule.value = value
+
+    @property
+    def sent_by(self):
+        return self._sent_by.value
+
+    @sent_by.setter
+    def sent_by(self, value):
+        self._sent_by.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()