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

smartsheet/models/cell_data_item.py

@@ -0,0 +1,152 @@
+# 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 Number, String, TypedObject, json
+from ..util import deserialize, serialize
+from .boolean_object_value import BooleanObjectValue
+from .cell import Cell
+from .number_object_value import NumberObjectValue
+from .object_value import ObjectValue
+from .string_object_value import StringObjectValue
+from .summary_field import SummaryField
+
+
+class CellDataItem:
+    """Smartsheet CellDataItem data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CellDataItem model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._cell = TypedObject(Cell)
+        self._column_id = Number()
+        self._data_source = String()
+        self._label = String()
+        self._label_format = String()
+        self._object_value = None
+        self._order = Number()
+        self._profile_field = TypedObject(SummaryField)
+        self._row_id = Number()
+        self._sheet_id = Number()
+        self._value_format = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def cell(self):
+        return self._cell.value
+
+    @cell.setter
+    def cell(self, value):
+        self._cell.value = 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 data_source(self):
+        return self._data_source.value
+
+    @data_source.setter
+    def data_source(self, value):
+        self._data_source.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 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 order(self):
+        return self._order.value
+
+    @order.setter
+    def order(self, value):
+        self._order.value = value
+
+    @property
+    def profile_field(self):
+        return self._profile_field.value
+
+    @profile_field.setter
+    def profile_field(self, value):
+        self._profile_field.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
+
+    @property
+    def sheet_id(self):
+        return self._sheet_id.value
+
+    @sheet_id.setter
+    def sheet_id(self, value):
+        self._sheet_id.value = value
+
+    @property
+    def value_format(self):
+        return self._value_format.value
+
+    @value_format.setter
+    def value_format(self, value):
+        self._value_format.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/cell_history.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 Timestamp, TypedObject, json
+from ..util import deserialize, serialize
+from .cell import Cell
+from .user import User
+
+
+class CellHistory(Cell):
+
+    """Smartsheet CellHistory data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CellHistory model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._modified_at = Timestamp()
+        self._modified_by = TypedObject(User)
+
+        if props:
+            deserialize(self, props)
+        self.__initialized = True
+
+    @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
+
+    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_link.py

@@ -0,0 +1,91 @@
+# 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 EnumeratedValue, Number, String, json
+from ..util import deserialize, serialize
+from .enums import CellLinkStatus
+
+
+class CellLink:
+
+    """Smartsheet CellLink data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CellLink model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._column_id = Number()
+        self._row_id = Number()
+        self._sheet_id = Number()
+        self._sheet_name = String()
+        self._status = EnumeratedValue(CellLinkStatus)
+
+        if props:
+            deserialize(self, props)
+
+    @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 row_id(self):
+        return self._row_id.value
+
+    @row_id.setter
+    def row_id(self, value):
+        self._row_id.value = value
+
+    @property
+    def sheet_id(self):
+        return self._sheet_id.value
+
+    @sheet_id.setter
+    def sheet_id(self, value):
+        self._sheet_id.value = value
+
+    @property
+    def sheet_name(self):
+        return self._sheet_name.value
+
+    @sheet_name.setter
+    def sheet_name(self, value):
+        self._sheet_name.value = value
+
+    @property
+    def status(self):
+        return self._status
+
+    @status.setter
+    def status(self, value):
+        self._status.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/cell_link_widget_content.py

@@ -0,0 +1,101 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101,W0201
+# 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, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .cell_data_item import CellDataItem
+from .column import Column
+from .enums import WidgetType
+from .widget_content import WidgetContent
+from .widget_hyperlink import WidgetHyperlink
+
+
+class CellLinkWidgetContent(WidgetContent):
+    """Smartsheet CellLinkWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CellLinkWidgetContent model."""
+        super().__init__(WidgetType.METRIC, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the CellLinkWidgetContent object.
+        self._sheet_id = Number()
+        self._cell_data = TypedList(CellDataItem)
+        self._columns = TypedList(Column)
+        self._hyperlink = TypedObject(WidgetHyperlink)
+
+        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 sheet_id(self):
+        return self._sheet_id.value
+
+    @sheet_id.setter
+    def sheet_id(self, value):
+        self._sheet_id.value = value
+
+    @property
+    def cell_data(self):
+        return self._cell_data
+
+    @cell_data.setter
+    def cell_data(self, value):
+        self._cell_data.load(value)
+
+    @property
+    def columns(self):
+        return self._columns
+
+    @columns.setter
+    def columns(self, value):
+        self._columns.load(value)
+
+    @property
+    def hyperlink(self):
+        return self._hyperlink.value
+
+    @hyperlink.setter
+    def hyperlink(self, value):
+        self._hyperlink.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/chart_widget_content.py

@@ -0,0 +1,124 @@
+# 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, TypedList, TypedObject, json, six
+from ..util import deserialize, serialize
+from .enums import WidgetType
+from .selection_range import SelectionRange
+from .widget_content import WidgetContent
+from .widget_hyperlink import WidgetHyperlink
+
+
+class ChartWidgetContent(WidgetContent):
+    """Smartsheet ChartWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ChartWidgetContent model."""
+        super().__init__(WidgetType.CHART, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the ChartWidgetContent object
+        self._report_id = Number()
+        self._sheet_id = Number()
+        self._axes = TypedObject(object)
+        self._hyperlink = TypedObject(WidgetHyperlink)
+        self._included_column_ids = TypedList(six.integer_types)
+        self._legend = TypedObject(object)
+        self._selection_ranges = TypedList(SelectionRange)
+        self._series = TypedObject(object)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def report_id(self):
+        return self._report_id.value
+
+    @report_id.setter
+    def report_id(self, value):
+        self._report_id.value = value
+
+    @property
+    def sheet_id(self):
+        return self._sheet_id.value
+
+    @sheet_id.setter
+    def sheet_id(self, value):
+        self._sheet_id.value = value
+
+    @property
+    def axes(self):
+        return self._axes.value
+
+    @axes.setter
+    def axes(self, value):
+        self._axes.value = value
+
+    @property
+    def hyperlink(self):
+        return self._hyperlink.value
+
+    @hyperlink.setter
+    def hyperlink(self, value):
+        self._hyperlink.value = value
+
+    @property
+    def included_column_ids(self):
+        return self._included_column_ids
+
+    @included_column_ids.setter
+    def included_column_ids(self, value):
+        self._included_column_ids.load(value)
+
+    @property
+    def legend(self):
+        return self._legend.value
+
+    @legend.setter
+    def legend(self, value):
+        self._legend.value = value
+
+    @property
+    def selection_ranges(self):
+        return self._selection_ranges
+
+    @selection_ranges.setter
+    def selection_ranges(self, value):
+        self._selection_ranges.load(value)
+
+    @property
+    def series(self):
+        return self._series.value
+
+    @series.setter
+    def series(self, value):
+        self._series.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()