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

smartsheet/models/row_email.py

@@ -0,0 +1,83 @@
+# 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, String, TypedList, json, six
+from ..util import deserialize, serialize
+from .email import Email
+
+
+class RowEmail(Email):
+
+    """Smartsheet RowEmail data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the RowEmail model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._column_ids = TypedList(six.integer_types)
+        self._include_attachments = Boolean()
+        self._include_discussions = Boolean()
+        self._layout = String()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def column_ids(self):
+        return self._column_ids
+
+    @column_ids.setter
+    def column_ids(self, value):
+        self._column_ids.load(value)
+
+    @property
+    def include_attachments(self):
+        return self._include_attachments.value
+
+    @include_attachments.setter
+    def include_attachments(self, value):
+        self._include_attachments.value = value
+
+    @property
+    def include_discussions(self):
+        return self._include_discussions.value
+
+    @include_discussions.setter
+    def include_discussions(self, value):
+        self._include_discussions.value = value
+
+    @property
+    def layout(self):
+        return self._layout.value
+
+    @layout.setter
+    def layout(self, value):
+        self._layout.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/row_mapping.py

@@ -0,0 +1,77 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101,C0103
+# Smartsheet Python SDK.
+#
+# Copyright 2016 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 RowMapping:
+
+    """Smartsheet RowMapping data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the RowMapping model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._from_ = Number()
+        self._to = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "from":
+            return self.from_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "from":
+            self.from_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def from_(self):
+        return self._from_.value
+
+    @from_.setter
+    def from_(self, value):
+        self._from_.value = value
+
+    @property
+    def to(self):
+        return self._to.value
+
+    @to.setter
+    def to(self, value):
+        self._to.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/schedule.py

@@ -0,0 +1,140 @@
+# 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 EnumeratedList, EnumeratedValue, Number, Timestamp, json
+from ..util import deserialize, serialize
+from .enums import DayDescriptors, DayOrdinal, ScheduleType
+
+
+class Schedule:
+    """Smartsheet Schedule data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Schedule model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._day_descriptors = EnumeratedList(DayDescriptors)
+        self._day_of_month = Number()
+        self._day_ordinal = EnumeratedValue(DayOrdinal)
+        self._end_at = Timestamp()
+        self._last_sent_at = Timestamp()
+        self._next_send_at = Timestamp()
+        self._repeat_every = Number()
+        self._start_at = Timestamp()
+        self._type_ = EnumeratedValue(ScheduleType)
+
+        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 day_descriptors(self):
+        return self._day_descriptors
+
+    @day_descriptors.setter
+    def day_descriptors(self, value):
+        self._day_descriptors.load(value)
+
+    @property
+    def day_of_month(self):
+        return self._day_of_month.value
+
+    @day_of_month.setter
+    def day_of_month(self, value):
+        self._day_of_month.value = value
+
+    @property
+    def day_ordinal(self):
+        return self._day_ordinal
+
+    @day_ordinal.setter
+    def day_ordinal(self, value):
+        self._day_ordinal.set(value)
+
+    @property
+    def end_at(self):
+        return self._end_at.value
+
+    @end_at.setter
+    def end_at(self, value):
+        self._end_at.value = value
+
+    @property
+    def last_sent_at(self):
+        return self._last_sent_at.value
+
+    @last_sent_at.setter
+    def last_sent_at(self, value):
+        self._last_sent_at.value = value
+
+    @property
+    def next_send_at(self):
+        return self._next_send_at.value
+
+    @next_send_at.setter
+    def next_send_at(self, value):
+        self._next_send_at.value = value
+
+    @property
+    def repeat_every(self):
+        return self._repeat_every.value
+
+    @repeat_every.setter
+    def repeat_every(self, value):
+        self._repeat_every.value = value
+
+    @property
+    def start_at(self):
+        return self._start_at.value
+
+    @start_at.setter
+    def start_at(self, value):
+        self._start_at.value = value
+
+    @property
+    def type_(self):
+        return self._type_
+
+    @type_.setter
+    def type_(self, value):
+        self._type_.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/scope.py

@@ -0,0 +1,70 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101,C0415
+# 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 .sheet import Sheet
+
+
+class Scope:
+    """Smartsheet Scope data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Scope model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Workspace creates a circular import dependency
+        # as much as I'm not a fan of moving the import
+        # into the __init__, its the most pragmatic approach for this simple problem.
+        from .workspace import Workspace
+
+        self._sheets = TypedList(Sheet)
+        self._workspaces = TypedList(Workspace)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def sheets(self):
+        return self._sheets
+
+    @sheets.setter
+    def sheets(self, value):
+        self._sheets.load(value)
+
+    @property
+    def workspaces(self):
+        return self._workspaces
+
+    @workspaces.setter
+    def workspaces(self, value):
+        self._workspaces.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/search_result.py

@@ -0,0 +1,67 @@
+# 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, TypedList, json
+from ..util import deserialize, serialize
+from .search_result_item import SearchResultItem
+
+
+class SearchResult:
+
+    """Smartsheet SearchResult data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SearchResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._results = TypedList(SearchResultItem)
+        self._total_count = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def results(self):
+        return self._results
+
+    @results.setter
+    def results(self, value):
+        self._results.load(value)
+
+    @property
+    def total_count(self):
+        return self._total_count.value
+
+    @total_count.setter
+    def total_count(self, value):
+        self._total_count.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/search_result_item.py

@@ -0,0 +1,150 @@
+# 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, TypedList, json
+from ..util import deserialize, serialize
+
+
+class SearchResultItem:
+
+    """Smartsheet SearchResultItem data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SearchResultItem model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {
+            "object_type": [
+                "row",
+                "sheet",
+                "report",
+                "folder",
+                "workspace",
+                "sight",
+                "summaryField",
+                "template",
+                "discussion",
+                "attachment",
+            ],
+            "parent_object_type": [
+                "workspace",
+                "folder",
+                "sheet",
+                "report",
+                "template",
+            ],
+        }
+
+        self._context_data = TypedList(str)
+        self._favorite = Boolean()
+        self._object_id = Number()
+        self._object_type = String(accept=self.allowed_values["object_type"])
+        self._parent_object_favorite = Boolean()
+        self._parent_object_id = Number()
+        self._parent_object_name = String()
+        self._parent_object_type = String(
+            accept=self.allowed_values["parent_object_type"]
+        )
+        self._text = String()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def context_data(self):
+        return self._context_data
+
+    @context_data.setter
+    def context_data(self, value):
+        self._context_data.load(value)
+
+    @property
+    def favorite(self):
+        return self._favorite.value
+
+    @favorite.setter
+    def favorite(self, value):
+        self._favorite.value = 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 object_type(self):
+        return self._object_type.value
+
+    @object_type.setter
+    def object_type(self, value):
+        self._object_type.value = value
+
+    @property
+    def parent_object_favorite(self):
+        return self._parent_object_favorite.value
+
+    @parent_object_favorite.setter
+    def parent_object_favorite(self, value):
+        self._parent_object_favorite.value = value
+
+    @property
+    def parent_object_id(self):
+        return self._parent_object_id.value
+
+    @parent_object_id.setter
+    def parent_object_id(self, value):
+        self._parent_object_id.value = value
+
+    @property
+    def parent_object_name(self):
+        return self._parent_object_name.value
+
+    @parent_object_name.setter
+    def parent_object_name(self, value):
+        self._parent_object_name.value = value
+
+    @property
+    def parent_object_type(self):
+        return self._parent_object_type.value
+
+    @parent_object_type.setter
+    def parent_object_type(self, value):
+        self._parent_object_type.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/selection_range.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 Number, json
+from ..util import deserialize, serialize
+from .cell_data_item import CellDataItem
+from .column import Column
+from .hyperlink import Hyperlink
+from .shortcut_data_item import ShortcutDataItem
+
+
+class SelectionRange:
+    """Smartsheet SelectionRange data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the SelectionRange model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._source_column_id1 = Number()
+        self._source_column_id2 = Number()
+        self._source_row_id1 = Number()
+        self._source_row_id2 = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def source_column_id1(self):
+        return self._source_column_id1.value
+
+    @source_column_id1.setter
+    def source_column_id1(self, value):
+        self._source_column_id1.value = value
+
+    @property
+    def source_column_id2(self):
+        return self._source_column_id2.value
+
+    @source_column_id2.setter
+    def source_column_id2(self, value):
+        self._source_column_id2.value = value
+
+    @property
+    def source_row_id1(self):
+        return self._source_row_id1.value
+
+    @source_row_id1.setter
+    def source_row_id1(self, value):
+        self._source_row_id1.value = value
+
+    @property
+    def source_row_id2(self):
+        return self._source_row_id2.value
+
+    @source_row_id2.setter
+    def source_row_id2(self, value):
+        self._source_row_id2.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()