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

smartsheet/models/folder.py

@@ -0,0 +1,177 @@
+# 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, Timestamp, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .report import Report
+from .sheet import Sheet
+from .sight import Sight
+from .source import Source
+from .template import Template
+
+
+class Folder:
+
+    """Smartsheet Folder data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Folder model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._created_at = Timestamp()
+        self._favorite = Boolean()
+        self._folders = TypedList(Folder)
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._name = String()
+        self._permalink = String()
+        self._reports = TypedList(Report)
+        self._sheets = TypedList(Sheet)
+        self._sights = TypedList(Sight)
+        self._source = TypedObject(Source)
+        self._templates = TypedList(Template)
+
+        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 favorite(self):
+        return self._favorite.value
+
+    @favorite.setter
+    def favorite(self, value):
+        self._favorite.value = value
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(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 name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def permalink(self):
+        return self._permalink.value
+
+    @permalink.setter
+    def permalink(self, value):
+        self._permalink.value = value
+
+    @property
+    def reports(self):
+        return self._reports
+
+    @reports.setter
+    def reports(self, value):
+        self._reports.load(value)
+
+    @property
+    def sheets(self):
+        return self._sheets
+
+    @sheets.setter
+    def sheets(self, value):
+        self._sheets.load(value)
+
+    @property
+    def sights(self):
+        return self._sights
+
+    @sights.setter
+    def sights(self, value):
+        self._sights.load(value)
+
+    @property
+    def source(self):
+        return self._source.value
+
+    @source.setter
+    def source(self, value):
+        self._source.value = value
+
+    @property
+    def templates(self):
+        return self._templates
+
+    @templates.setter
+    def templates(self, value):
+        self._templates.load(value)
+
+    def create_folder(self, folder_obj):
+        return self._base.Folders.create_folder_in_folder(self.id, folder_obj)
+
+    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/font_family.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 String, TypedList, json
+from ..util import deserialize, serialize
+
+
+class FontFamily:
+
+    """Smartsheet FontFamily data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the FontFamily model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._name = String()
+        self._traits = TypedList(str)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def traits(self):
+        return self._traits
+
+    @traits.setter
+    def traits(self, value):
+        self._traits.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/format_details.py

@@ -0,0 +1,55 @@
+# 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, json
+from ..util import deserialize, serialize
+from .enums import PaperType
+
+
+class FormatDetails:
+
+    """Smartsheet FormatDetails data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the FormatDetails model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._paper_size = EnumeratedValue(PaperType)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def paper_size(self):
+        return self._paper_size
+
+    @paper_size.setter
+    def paper_size(self, value):
+        self._paper_size.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/format_tables.py

@@ -0,0 +1,191 @@
+# 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 String, TypedList, json
+from ..util import deserialize, serialize
+from .currency import Currency
+from .font_family import FontFamily
+
+
+class FormatTables:
+
+    """Smartsheet FormatTables data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the FormatTables model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._bold = TypedList(str)
+        self._color = TypedList(str)
+        self._currency = TypedList(Currency)
+        self._date_format = TypedList(str)
+        self._decimal_count = TypedList(str)
+        self._defaults = String()
+        self._font_family = TypedList(FontFamily)
+        self._font_size = TypedList(str)
+        self._horizontal_align = TypedList(str)
+        self._italic = TypedList(str)
+        self._number_format = TypedList(str)
+        self._strikethrough = TypedList(str)
+        self._text_wrap = TypedList(str)
+        self._thousands_separator = TypedList(str)
+        self._underline = TypedList(str)
+        self._vertical_align = TypedList(str)
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def bold(self):
+        return self._bold
+
+    @bold.setter
+    def bold(self, value):
+        self._bold.load(value)
+
+    @property
+    def color(self):
+        return self._color
+
+    @color.setter
+    def color(self, value):
+        self._color.load(value)
+
+    @property
+    def currency(self):
+        return self._currency
+
+    @currency.setter
+    def currency(self, value):
+        self._currency.load(value)
+
+    @property
+    def date_format(self):
+        return self._date_format
+
+    @date_format.setter
+    def date_format(self, value):
+        self._date_format.load(value)
+
+    @property
+    def decimal_count(self):
+        return self._decimal_count
+
+    @decimal_count.setter
+    def decimal_count(self, value):
+        self._decimal_count.load(value)
+
+    @property
+    def defaults(self):
+        return self._defaults.value
+
+    @defaults.setter
+    def defaults(self, value):
+        self._defaults.value = value
+
+    @property
+    def font_family(self):
+        return self._font_family
+
+    @font_family.setter
+    def font_family(self, value):
+        self._font_family.load(value)
+
+    @property
+    def font_size(self):
+        return self._font_size
+
+    @font_size.setter
+    def font_size(self, value):
+        self._font_size.load(value)
+
+    @property
+    def horizontal_align(self):
+        return self._horizontal_align
+
+    @horizontal_align.setter
+    def horizontal_align(self, value):
+        self._horizontal_align.load(value)
+
+    @property
+    def italic(self):
+        return self._italic
+
+    @italic.setter
+    def italic(self, value):
+        self._italic.load(value)
+
+    @property
+    def number_format(self):
+        return self._number_format
+
+    @number_format.setter
+    def number_format(self, value):
+        self._number_format.load(value)
+
+    @property
+    def strikethrough(self):
+        return self._strikethrough
+
+    @strikethrough.setter
+    def strikethrough(self, value):
+        self._strikethrough.load(value)
+
+    @property
+    def text_wrap(self):
+        return self._text_wrap
+
+    @text_wrap.setter
+    def text_wrap(self, value):
+        self._text_wrap.load(value)
+
+    @property
+    def thousands_separator(self):
+        return self._thousands_separator
+
+    @thousands_separator.setter
+    def thousands_separator(self, value):
+        self._thousands_separator.load(value)
+
+    @property
+    def underline(self):
+        return self._underline
+
+    @underline.setter
+    def underline(self, value):
+        self._underline.load(value)
+
+    @property
+    def vertical_align(self):
+        return self._vertical_align
+
+    @vertical_align.setter
+    def vertical_align(self, value):
+        self._vertical_align.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/group.py

@@ -0,0 +1,134 @@
+# 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 Number, String, Timestamp, TypedList, json
+from ..util import deserialize, serialize
+from .group_member import GroupMember
+
+
+class Group:
+
+    """Smartsheet Group data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Group model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._created_at = Timestamp()
+        self._description = String()
+        self._id_ = Number()
+        self._members = TypedList(GroupMember)
+        self._modified_at = Timestamp()
+        self._name = String()
+        self._owner = String()
+        self._owner_id = Number()
+
+        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 description(self):
+        return self._description.value
+
+    @description.setter
+    def description(self, value):
+        self._description.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def members(self):
+        return self._members
+
+    @members.setter
+    def members(self, value):
+        self._members.load(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 name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def owner(self):
+        return self._owner.value
+
+    @owner.setter
+    def owner(self, value):
+        self._owner.value = value
+
+    @property
+    def owner_id(self):
+        return self._owner_id.value
+
+    @owner_id.setter
+    def owner_id(self, value):
+        self._owner_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()