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

smartsheet/models/group_member.py

@@ -0,0 +1,104 @@
+# 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 GroupMember:
+
+    """Smartsheet GroupMember data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the GroupMember model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._email = String()
+        self._first_name = String()
+        self._id_ = Number()
+        self._last_name = String()
+        self._name = String()
+
+        if props:
+            deserialize(self, props)
+
+        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 email(self):
+        return self._email.value
+
+    @email.setter
+    def email(self, value):
+        self._email.value = value
+
+    @property
+    def first_name(self):
+        return self._first_name.value
+
+    @first_name.setter
+    def first_name(self, value):
+        self._first_name.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def last_name(self):
+        return self._last_name.value
+
+    @last_name.setter
+    def last_name(self, value):
+        self._last_name.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.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/home.py

@@ -0,0 +1,110 @@
+# 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
+
+import json
+
+from ..types import TypedList
+from ..util import deserialize, serialize
+from .folder import Folder
+from .report import Report
+from .sheet import Sheet
+from .sight import Sight
+from .template import Template
+from .workspace import Workspace
+
+
+class Home:
+
+    """Smartsheet Home data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Home model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._folders = TypedList(Folder)
+        self._reports = TypedList(Report)
+        self._sheets = TypedList(Sheet)
+        self._sights = TypedList(Sight)
+        self._templates = TypedList(Template)
+        self._workspaces = TypedList(Workspace)
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def folders(self):
+        return self._folders
+
+    @folders.setter
+    def folders(self, value):
+        self._folders.load(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 templates(self):
+        return self._templates
+
+    @templates.setter
+    def templates(self, value):
+        self._templates.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/hyperlink.py

@@ -0,0 +1,81 @@
+# 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 Hyperlink:
+
+    """Smartsheet Hyperlink data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Hyperlink model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._report_id = Number()
+        self._sheet_id = Number()
+        self._sight_id = Number()
+        self._url = String()
+
+        if props:
+            deserialize(self, props)
+
+    @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 sight_id(self):
+        return self._sight_id.value
+
+    @sight_id.setter
+    def sight_id(self, value):
+        self._sight_id.value = value
+
+    @property
+    def url(self):
+        return self._url.value
+
+    @url.setter
+    def url(self, value):
+        self._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/image.py

@@ -0,0 +1,101 @@
+# 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 Image:
+
+    """Smartsheet Image data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Image model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._alt_text = String()
+        self._height = Number()
+        self._id_ = String()
+        self._width = Number()
+
+        if props:
+            deserialize(self, props)
+
+    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 alt_text(self):
+        return self._alt_text.value
+
+    @alt_text.setter
+    def alt_text(self, value):
+        self._alt_text.value = value
+
+    @property
+    def height(self):
+        return self._height.value
+
+    @height.setter
+    def height(self, value):
+        self._height.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def image_id(self):
+        return self._id_.value
+
+    @image_id.setter
+    def image_id(self, value):
+        self._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/image_url.py

@@ -0,0 +1,91 @@
+# 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 Number, String, TypedObject, json
+from ..util import deserialize, serialize
+from .error_result import ErrorResult
+
+
+class ImageUrl:
+
+    """Smartsheet ImageUrl data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ImageUrl model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._error = TypedObject(ErrorResult)
+        self._height = Number()
+        self._image_id = String()
+        self._url = String()
+        self._width = Number()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def error(self):
+        return self._error.value
+
+    @error.setter
+    def error(self, value):
+        self._error.value = value
+
+    @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 url(self):
+        return self._url.value
+
+    @url.setter
+    def url(self, value):
+        self._url.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/image_url_map.py

@@ -0,0 +1,68 @@
+# 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 Number, TypedList, json
+from ..util import deserialize, serialize
+from .image_url import ImageUrl
+
+
+class ImageUrlMap:
+
+    """Smartsheet ImageUrlMap data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ImageUrlMap model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._image_urls = TypedList(ImageUrl)
+        self._url_expires_in_millis = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def image_urls(self):
+        return self._image_urls
+
+    @image_urls.setter
+    def image_urls(self, value):
+        self._image_urls.load(value)
+
+    @property
+    def url_expires_in_millis(self):
+        return self._url_expires_in_millis.value
+
+    @url_expires_in_millis.setter
+    def url_expires_in_millis(self, value):
+        self._url_expires_in_millis.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/image_widget_content.py

@@ -0,0 +1,117 @@
+# 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, String, TypedObject, json
+from ..util import deserialize, serialize
+from .enums import WidgetType
+from .widget_content import WidgetContent
+from .widget_hyperlink import WidgetHyperlink
+
+
+class ImageWidgetContent(WidgetContent):
+    """Smartsheet ImageWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ImageWidgetContent model."""
+        super().__init__(WidgetType.IMAGE, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the ImageWidgetContent object.
+        self._file_name = String()
+        self._format_ = String()
+        self._height = Number()
+        self._hyperlink = TypedObject(WidgetHyperlink)
+        self._private_id = String()
+        self._width = Number()
+
+        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 file_name(self):
+        return self._file_name.value
+
+    @file_name.setter
+    def file_name(self, value):
+        self._file_name.value = value
+
+    @property
+    def format_(self):
+        return self._format_.value
+
+    @format_.setter
+    def format_(self, value):
+        self._format_.value = value
+
+    @property
+    def height(self):
+        return self._height.value
+
+    @height.setter
+    def height(self, value):
+        self._height.value = value
+
+    @property
+    def hyperlink(self):
+        return self._hyperlink.value
+
+    @hyperlink.setter
+    def hyperlink(self, value):
+        self._hyperlink.value = value
+
+    @property
+    def private_id(self):
+        return self._private_id.value
+
+    @private_id.setter
+    def private_id(self, value):
+        self._private_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()