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

smartsheet/models/sheet_filter_details.py

@@ -0,0 +1,76 @@
+# 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 ..types import Boolean, EnumeratedValue, TypedList, json
+from ..util import deserialize, serialize
+from .criteria import Criteria
+from .enums import SheetFilterOperator
+
+
+class SheetFilterDetails:
+
+    """Smartsheet SheetFilterDetails data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetFilterDetails model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._criteria = TypedList(Criteria)
+        self._include_parent = Boolean()
+        self._operator = EnumeratedValue(SheetFilterOperator)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def criteria(self):
+        return self._criteria
+
+    @criteria.setter
+    def criteria(self, value):
+        self._criteria.load(value)
+
+    @property
+    def include_parent(self):
+        return self._include_parent.value
+
+    @include_parent.setter
+    def include_parent(self, value):
+        self._include_parent.value = value
+
+    @property
+    def operator(self):
+        return self._operator
+
+    @operator.setter
+    def operator(self, value):
+        self._operator.set(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/sheet_publish.py

@@ -0,0 +1,184 @@
+# 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, String, json
+from ..util import deserialize, serialize
+from .enums import PublishAccessibleBy
+
+
+class SheetPublish:
+
+    """Smartsheet SheetPublish data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetPublish model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._ical_enabled = Boolean()
+        self._ical_url = String()
+        self._read_only_full_accessible_by = EnumeratedValue(PublishAccessibleBy)
+        self._read_only_full_default_view = String()
+        self._read_only_full_enabled = Boolean()
+        self._read_only_full_show_toolbar = Boolean()
+        self._read_only_full_url = String()
+        self._read_only_lite_enabled = Boolean()
+        self._read_only_lite_ssl_url = String()
+        self._read_only_lite_url = String()
+        self._read_write_accessible_by = EnumeratedValue(PublishAccessibleBy)
+        self._read_write_default_view = String()
+        self._read_write_enabled = Boolean()
+        self._read_write_show_toolbar = Boolean()
+        self._read_write_url = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def ical_enabled(self):
+        return self._ical_enabled.value
+
+    @ical_enabled.setter
+    def ical_enabled(self, value):
+        self._ical_enabled.value = value
+
+    @property
+    def ical_url(self):
+        return self._ical_url.value
+
+    @ical_url.setter
+    def ical_url(self, value):
+        self._ical_url.value = value
+
+    @property
+    def read_only_full_accessible_by(self):
+        return self._read_only_full_accessible_by
+
+    @read_only_full_accessible_by.setter
+    def read_only_full_accessible_by(self, value):
+        self._read_only_full_accessible_by.set(value)
+
+    @property
+    def read_only_full_default_view(self):
+        return self._read_only_full_default_view.value
+
+    @read_only_full_default_view.setter
+    def read_only_full_default_view(self, value):
+        self._read_only_full_default_view.value = value
+
+    @property
+    def read_only_full_enabled(self):
+        return self._read_only_full_enabled.value
+
+    @read_only_full_enabled.setter
+    def read_only_full_enabled(self, value):
+        self._read_only_full_enabled.value = value
+
+    @property
+    def read_only_full_show_toolbar(self):
+        return self._read_only_full_show_toolbar.value
+
+    @read_only_full_show_toolbar.setter
+    def read_only_full_show_toolbar(self, value):
+        self._read_only_full_show_toolbar.value = value
+
+    @property
+    def read_only_full_url(self):
+        return self._read_only_full_url.value
+
+    @read_only_full_url.setter
+    def read_only_full_url(self, value):
+        self._read_only_full_url.value = value
+
+    @property
+    def read_only_lite_enabled(self):
+        return self._read_only_lite_enabled.value
+
+    @read_only_lite_enabled.setter
+    def read_only_lite_enabled(self, value):
+        self._read_only_lite_enabled.value = value
+
+    @property
+    def read_only_lite_ssl_url(self):
+        return self._read_only_lite_ssl_url.value
+
+    @read_only_lite_ssl_url.setter
+    def read_only_lite_ssl_url(self, value):
+        self._read_only_lite_ssl_url.value = value
+
+    @property
+    def read_only_lite_url(self):
+        return self._read_only_lite_url.value
+
+    @read_only_lite_url.setter
+    def read_only_lite_url(self, value):
+        self._read_only_lite_url.value = value
+
+    @property
+    def read_write_accessible_by(self):
+        return self._read_write_accessible_by
+
+    @read_write_accessible_by.setter
+    def read_write_accessible_by(self, value):
+        self._read_write_accessible_by.set(value)
+
+    @property
+    def read_write_default_view(self):
+        return self._read_write_default_view.value
+
+    @read_write_default_view.setter
+    def read_write_default_view(self, value):
+        self._read_write_default_view.value = value
+
+    @property
+    def read_write_enabled(self):
+        return self._read_write_enabled.value
+
+    @read_write_enabled.setter
+    def read_write_enabled(self, value):
+        self._read_write_enabled.value = value
+
+    @property
+    def read_write_show_toolbar(self):
+        return self._read_write_show_toolbar.value
+
+    @read_write_show_toolbar.setter
+    def read_write_show_toolbar(self, value):
+        self._read_write_show_toolbar.value = value
+
+    @property
+    def read_write_url(self):
+        return self._read_write_url.value
+
+    @read_write_url.setter
+    def read_write_url(self, value):
+        self._read_write_url.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/sheet_summary.py

@@ -0,0 +1,59 @@
+# 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, json
+from ..util import deserialize, serialize
+from .summary_field import SummaryField
+
+
+class SheetSummary:
+
+    """Smartsheet SheetSummary data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetSummary model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._fields = TypedList(SummaryField)
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def fields(self):
+        return self._fields
+
+    @fields.setter
+    def fields(self, value):
+        self._fields.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/sheet_user_permissions.py

@@ -0,0 +1,58 @@
+# 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
+
+
+class SheetUserPermissions:
+
+    """Smartsheet SheetUserPermissions data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetUserPermissions model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._summary_permissions = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def summary_permissions(self):
+        return self._summary_permissions.value
+
+    @summary_permissions.setter
+    def summary_permissions(self, value):
+        self._summary_permissions.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/sheet_user_settings.py

@@ -0,0 +1,72 @@
+# 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, json
+from ..util import deserialize, serialize
+
+
+class SheetUserSettings:
+
+    """Smartsheet SheetUserSettings data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SheetUserSettings model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._applied_sheet_filter_id = Number()
+        self._critical_path_enabled = Boolean()
+        self._display_summary_tasks = Boolean()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def applied_sheet_filter_id(self):
+        return self._applied_sheet_filter_id.value
+
+    @applied_sheet_filter_id.setter
+    def applied_sheet_filter_id(self, value):
+        self._applied_sheet_filter_id.value = value
+
+    @property
+    def critical_path_enabled(self):
+        return self._critical_path_enabled.value
+
+    @critical_path_enabled.setter
+    def critical_path_enabled(self, value):
+        self._critical_path_enabled.value = value
+
+    @property
+    def display_summary_tasks(self):
+        return self._display_summary_tasks.value
+
+    @display_summary_tasks.setter
+    def display_summary_tasks(self, value):
+        self._display_summary_tasks.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/shortcut_data_item.py

@@ -0,0 +1,102 @@
+# 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 ..types import EnumeratedValue, Number, String, TypedObject, json
+from ..util import deserialize, serialize
+from .enums import AttachmentType
+from .hyperlink import Hyperlink
+
+
+class ShortcutDataItem:
+    """Smartsheet ShortcutDataItem data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ShortcutDataItem model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._attachment_type = EnumeratedValue(AttachmentType)
+        self._hyperlink = TypedObject(Hyperlink)
+        self._label = String()
+        self._label_format = String()
+        self._mime_type = String()
+        self._order = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def attachment_type(self):
+        return self._attachment_type
+
+    @attachment_type.setter
+    def attachment_type(self, value):
+        self._attachment_type.set(value)
+
+    @property
+    def hyperlink(self):
+        return self._hyperlink.value
+
+    @hyperlink.setter
+    def hyperlink(self, value):
+        self._hyperlink.value = value
+
+    @property
+    def label(self):
+        return self._label.value
+
+    @label.setter
+    def label(self, value):
+        self._label.value = value
+
+    @property
+    def label_format(self):
+        return self._label_format.value
+
+    @label_format.setter
+    def label_format(self, value):
+        self._label_format.value = value
+
+    @property
+    def mime_type(self):
+        return self._mime_type.value
+
+    @mime_type.setter
+    def mime_type(self, value):
+        self._mime_type.value = value
+
+    @property
+    def order(self):
+        return self._order.value
+
+    @order.setter
+    def order(self, value):
+        self._order.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/shortcut_widget_content.py

@@ -0,0 +1,61 @@
+# 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, json
+from ..util import deserialize, serialize
+from .enums import WidgetType
+from .shortcut_data_item import ShortcutDataItem
+from .widget_content import WidgetContent
+
+
+class ShortcutWidgetContent(WidgetContent):
+    """Smartsheet ShortcutWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ShortcutWidgetContent model."""
+        super().__init__(WidgetType.SHORTCUT, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the ShortcutWidgetContent object.
+        self._shortcut_data = TypedList(ShortcutDataItem)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+
+    @property
+    def shortcut_data(self):
+        return self._shortcut_data
+
+    @shortcut_data.setter
+    def shortcut_data(self, value):
+        self._shortcut_data.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()