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

smartsheet/models/predecessor.py

@@ -0,0 +1,102 @@
+# 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, TypedObject, json
+from ..util import deserialize, serialize
+from .duration import Duration
+from .enums import PredecessorType
+
+
+class Predecessor:
+    """Smartsheet Predecessor data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Predecessor model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._in_critical_path = Boolean()
+        self._invalid = Boolean()
+        self._lag = TypedObject(Duration)
+        self._row_id = Number()
+        self._row_number = Number()
+        self._type = EnumeratedValue(PredecessorType)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def in_critical_path(self):
+        return self._in_critical_path.value
+
+    @in_critical_path.setter
+    def in_critical_path(self, value):
+        self._in_critical_path.value = value
+
+    @property
+    def invalid(self):
+        return self._invalid.value
+
+    @invalid.setter
+    def invalid(self, value):
+        self._invalid.value = value
+
+    @property
+    def lag(self):
+        return self._lag.value
+
+    @lag.setter
+    def lag(self, value):
+        self._lag.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 row_number(self):
+        return self._row_number.value
+
+    @row_number.setter
+    def row_number(self, value):
+        self._row_number.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/predecessor_list.py

@@ -0,0 +1,49 @@
+# 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 TypedList
+from ..util import deserialize
+from .object_value import PREDECESSOR_LIST, ObjectValue
+from .predecessor import Predecessor
+
+
+class PredecessorList(ObjectValue):
+    """Smartsheet PredecessorList data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the PredecessorList model."""
+        super().__init__(PREDECESSOR_LIST, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._predecessors = TypedList(Predecessor)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def predecessors(self):
+        return self._predecessors
+
+    @predecessors.setter
+    def predecessors(self, value):
+        self._predecessors.load(value)

smartsheet/models/primitive_object_value.py

@@ -0,0 +1,59 @@
+# 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
+
+import json
+
+import six
+
+from ..util import serialize
+
+
+class PrimitiveObjectValue:
+    """Smartsheet PrimitiveObjectValue data model."""
+
+    def __init__(self, value=None, base_obj=None):
+        """Initialize the PrimitiveObjectValue model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._value = value
+
+        self.__initialized = True
+
+    @property
+    def value(self):
+        return self._value
+
+    @value.setter
+    def value(self, value):
+        if isinstance(value, (six.string_types, six.integer_types, float, bool)):
+            self._value = value
+
+    def serialize(self):
+        return self._value
+
+    def to_dict(self):
+        return self._value
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()

smartsheet/models/profile_image.py

@@ -0,0 +1,72 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2020 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 ProfileImage:
+
+    """Smartsheet Profile Image data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ProfileImage model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._height = Number()
+        self._image_id_ = String()
+        self._width = Number()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def height(self):
+        return self._height.value
+
+    @height.setter
+    def height(self, value):
+        self._height.value = value
+
+    @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 width(self):
+        return self._width.value
+
+    @width.setter
+    def width(self, value):
+        self._width.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/project_settings.py

@@ -0,0 +1,89 @@
+# 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 datetime import date
+
+from dateutil.parser import parse
+
+from ..types import Number, TypedList, json, six
+from ..util import deserialize, serialize
+
+
+class ProjectSettings:
+    """Smartsheet ProjectSettings data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ProjectSettings model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._length_of_day = Number()
+        self._non_working_days = TypedList(date)
+        self._working_days = TypedList(str)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def length_of_day(self):
+        return self._length_of_day.value
+
+    @length_of_day.setter
+    def length_of_day(self, value):
+        self._length_of_day.value = value
+
+    @property
+    def non_working_days(self):
+        return self._non_working_days
+
+    @non_working_days.setter
+    def non_working_days(self, value):
+        if isinstance(value, list):
+            self._non_working_days.purge()
+            for item in value:
+                if isinstance(item, six.string_types):
+                    item = parse(item).date()
+                if isinstance(item, date):
+                    self._non_working_days.extend([item])
+        elif isinstance(value, six.string_types):
+            value = parse(value).date()
+            self._non_working_days.purge()
+            self._non_working_days.append(value)
+        else:
+            self._non_working_days.load(value)
+
+    @property
+    def working_days(self):
+        return self._working_days
+
+    @working_days.setter
+    def working_days(self, value):
+        self._working_days.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/recipient.py

@@ -0,0 +1,63 @@
+# 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 Recipient:
+
+    """Smartsheet Recipient data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Recipient model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._email = String()
+        self._group_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def email(self):
+        return self._email.value
+
+    @email.setter
+    def email(self, value):
+        self._email.value = value
+
+    @property
+    def group_id(self):
+        return self._group_id.value
+
+    @group_id.setter
+    def group_id(self, value):
+        self._group_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()

smartsheet/models/report.py

@@ -0,0 +1,90 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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 TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .report_column import ReportColumn
+from .report_row import ReportRow
+from .scope import Scope
+from .sheet import Sheet
+
+
+class Report(Sheet):
+
+    """Smartsheet Report data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Report model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._columns = TypedList(ReportColumn)
+        self._rows = TypedList(ReportRow)
+        self._scope = TypedObject(Scope)
+        self._source_sheets = TypedList(Sheet)
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def columns(self):
+        return self._columns
+
+    @columns.setter
+    def columns(self, value):
+        self._columns.load(value)
+
+    @property
+    def rows(self):
+        return self._rows
+
+    @rows.setter
+    def rows(self, value):
+        self._rows.load(value)
+
+    @property
+    def scope(self):
+        return self._scope.value
+
+    @scope.setter
+    def scope(self, value):
+        self._scope.value = value
+
+    @property
+    def source_sheets(self):
+        return self._source_sheets
+
+    @source_sheets.setter
+    def source_sheets(self, value):
+        self._source_sheets.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/report_cell.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, json
+from ..util import deserialize, serialize
+from .cell import Cell
+
+
+class ReportCell(Cell):
+
+    """Smartsheet ReportCell data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ReportCell model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._virtual_column_id = Number()
+
+        if props:
+            deserialize(self, props)
+            # account for alternate variable names from raw API response
+
+        self.__initialized = True
+
+    @property
+    def virtual_column_id(self):
+        return self._virtual_column_id.value
+
+    @virtual_column_id.setter
+    def virtual_column_id(self, value):
+        self._virtual_column_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()

smartsheet/models/report_column.py

@@ -0,0 +1,67 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# 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 Boolean, Number, json
+from ..util import deserialize, serialize
+from .column import Column
+
+
+class ReportColumn(Column):
+
+    """Smartsheet ReportColumn data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ReportColumn model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._sheet_name_column = Boolean()
+        self._virtual_id = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def sheet_name_column(self):
+        return self._sheet_name_column.value
+
+    @sheet_name_column.setter
+    def sheet_name_column(self, value):
+        self._sheet_name_column.value = value
+
+    @property
+    def virtual_id(self):
+        return self._virtual_id.value
+
+    @virtual_id.setter
+    def virtual_id(self, value):
+        self._virtual_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()