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

smartsheet/models/webhook.py

@@ -0,0 +1,219 @@
+# pylint: disable=C0111,R0902,R0904,R0912,R0913,R0915,E1101
+# Smartsheet Python SDK.
+#
+# Copyright 2017 - 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 (Boolean, Number, String, Timestamp, TypedList,
+                     TypedObject, json, six)
+from ..util import deserialize, serialize
+from .webhook_stats import WebhookStats
+from .webhook_subscope import WebhookSubscope
+
+
+class Webhook:
+
+    """Smartsheet Webhook data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Webhook model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self.allowed_values = {"scope": ["sheet"]}
+
+        self._api_client_id = String()
+        self._api_client_name = String()
+        self._callback_url = String()
+        self._created_at = Timestamp()
+        self._disabled_details = String()
+        self._enabled = Boolean()
+        self._events = TypedList(six.string_types)
+        self._id_ = Number()
+        self._modified_at = Timestamp()
+        self._name = String()
+        self._scope = String(accept=self.allowed_values["scope"])
+        self._scope_object_id = Number()
+        self._shared_secret = String()
+        self._stats = TypedObject(WebhookStats)
+        self._status = String()
+        self._version = Number()
+        self._subscope = TypedObject(WebhookSubscope)
+
+        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 api_client_id(self):
+        return self._api_client_id.value
+
+    @api_client_id.setter
+    def api_client_id(self, value):
+        self._api_client_id.value = value
+
+    @property
+    def api_client_name(self):
+        return self._api_client_name.value
+
+    @api_client_name.setter
+    def api_client_name(self, value):
+        self._api_client_name.value = value
+
+    @property
+    def callback_url(self):
+        return self._callback_url.value
+
+    @callback_url.setter
+    def callback_url(self, value):
+        self._callback_url.value = 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 disabled_details(self):
+        return self._disabled_details.value
+
+    @disabled_details.setter
+    def disabled_details(self, value):
+        self._disabled_details.value = value
+
+    @property
+    def enabled(self):
+        return self._enabled.value
+
+    @enabled.setter
+    def enabled(self, value):
+        self._enabled.value = value
+
+    @property
+    def events(self):
+        return self._events
+
+    @events.setter
+    def events(self, value):
+        self._events.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 scope(self):
+        return self._scope.value
+
+    @scope.setter
+    def scope(self, value):
+        self._scope.value = value
+
+    @property
+    def scope_object_id(self):
+        return self._scope_object_id.value
+
+    @scope_object_id.setter
+    def scope_object_id(self, value):
+        self._scope_object_id.value = value
+
+    @property
+    def shared_secret(self):
+        return self._shared_secret.value
+
+    @shared_secret.setter
+    def shared_secret(self, value):
+        self._shared_secret.value = value
+
+    @property
+    def stats(self):
+        return self._stats.value
+
+    @stats.setter
+    def stats(self, value):
+        self._stats.value = value
+
+    @property
+    def status(self):
+        return self._status.value
+
+    @status.setter
+    def status(self, value):
+        self._status.value = value
+
+    @property
+    def subscope(self):
+        return self._subscope.value
+
+    @subscope.setter
+    def subscope(self, value):
+        self._subscope.value = value
+
+    @property
+    def version(self):
+        return self._version.value
+
+    @version.setter
+    def version(self, value):
+        self._version.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/webhook_secret.py

@@ -0,0 +1,58 @@
+# 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, json
+from ..util import deserialize, serialize
+
+
+class WebhookSecret:
+
+    """Smartsheet WebhookSecret data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the WebhookSecret model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._shared_secret = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def shared_secret(self):
+        return self._shared_secret.value
+
+    @shared_secret.setter
+    def shared_secret(self, value):
+        self._shared_secret.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/webhook_stats.py

@@ -0,0 +1,76 @@
+# 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, Timestamp, json
+from ..util import deserialize, serialize
+
+
+class WebhookStats:
+
+    """Smartsheet WebhookStats data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the WebhookStats model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._last_callback_attempt = Timestamp()
+        self._last_callback_attempt_retry_count = Number()
+        self._last_successful_callback = Timestamp()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def last_callback_attempt(self):
+        return self._last_callback_attempt.value
+
+    @last_callback_attempt.setter
+    def last_callback_attempt(self, value):
+        self._last_callback_attempt.value = value
+
+    @property
+    def last_callback_attempt_retry_count(self):
+        return self._last_callback_attempt_retry_count.value
+
+    @last_callback_attempt_retry_count.setter
+    def last_callback_attempt_retry_count(self, value):
+        self._last_callback_attempt_retry_count.value = value
+
+    @property
+    def last_successful_callback(self):
+        return self._last_successful_callback.value
+
+    @last_successful_callback.setter
+    def last_successful_callback(self, value):
+        self._last_successful_callback.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/webhook_subscope.py

@@ -0,0 +1,50 @@
+# 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 TypedList, json, six
+from ..util import deserialize, serialize
+
+
+class WebhookSubscope:
+
+    """Represents the webhook subscope object."""
+
+    def __init__(self, props=None):
+        """Initialize the Webhook Subscope model."""
+        self._column_ids = TypedList(six.integer_types)
+
+        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)
+
+    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/widget.py

@@ -0,0 +1,211 @@
+# 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 Boolean, EnumeratedValue, Number, String, TypedObject, json
+from ..util import deserialize, serialize
+from .cell_link_widget_content import CellLinkWidgetContent
+from .chart_widget_content import ChartWidgetContent
+from .enums.widget_type import WidgetType
+from .error_result import ErrorResult
+from .image_widget_content import ImageWidgetContent
+from .report_widget_content import ReportWidgetContent
+from .shortcut_widget_content import ShortcutWidgetContent
+from .title_rich_text_widget_content import TitleRichTextWidgetContent
+from .web_content_widget_content import WebContentWidgetContent
+from .widget_content import WidgetContent
+
+
+class Widget:
+    """Smartsheet Widget data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Widget model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._contents = None
+        self._error = TypedObject(ErrorResult)
+        self._height = Number()
+        self._id_ = Number()
+        self._show_title = Boolean()
+        self._show_title_icon = Boolean()
+        self._title = String()
+        self._title_format = String()
+        self._type = EnumeratedValue(WidgetType)
+        self._version = Number()
+        self._width = Number()
+        self._x_position = Number()
+        self._y_position = Number()
+
+        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 contents(self):
+        return self._contents
+
+    @contents.setter
+    def contents(self, value):
+        if isinstance(value, WidgetContent):
+            self._contents = value
+        elif isinstance(value, dict):
+            widget_type = value["type"]
+            try:
+                widget_type = WidgetType[widget_type]
+            except KeyError:
+                if widget_type == "WidgetWebContent":
+                    widget_type = WidgetType.WEBCONTENT
+                else:
+                    widget_type = None
+            if widget_type == WidgetType.CHART:
+                self._contents = ChartWidgetContent(value, self._base)
+            elif widget_type == WidgetType.IMAGE:
+                self._contents = ImageWidgetContent(value, self._base)
+            elif widget_type == WidgetType.METRIC:
+                self._contents = CellLinkWidgetContent(value, self._base)
+            elif widget_type == WidgetType.GRIDGANTT:
+                self._contents = ReportWidgetContent(value, self._base)
+            elif widget_type in (WidgetType.RICHTEXT, WidgetType.TITLE):
+                self._contents = TitleRichTextWidgetContent(value, self._base)
+            elif widget_type == WidgetType.SHORTCUT:
+                self._contents = ShortcutWidgetContent(value, self._base)
+            elif widget_type == WidgetType.WEBCONTENT:
+                self._contents = WebContentWidgetContent(value, self._base)
+            else:
+                self._contents = None
+
+    @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 id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def show_title(self):
+        return self._show_title.value
+
+    @show_title.setter
+    def show_title(self, value):
+        self._show_title.value = value
+
+    @property
+    def show_title_icon(self):
+        return self._show_title_icon.value
+
+    @show_title_icon.setter
+    def show_title_icon(self, value):
+        self._show_title_icon.value = value
+
+    @property
+    def title(self):
+        return self._title.value
+
+    @title.setter
+    def title(self, value):
+        self._title.value = value
+
+    @property
+    def title_format(self):
+        return self._title_format.value
+
+    @title_format.setter
+    def title_format(self, value):
+        self._title_format.value = value
+
+    @property
+    def type(self):
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        self._type.set(value)
+
+    @property
+    def version(self):
+        return self._version.value
+
+    @version.setter
+    def version(self, value):
+        self._version.value = value
+
+    @property
+    def width(self):
+        return self._width.value
+
+    @width.setter
+    def width(self, value):
+        self._width.value = value
+
+    @property
+    def x_position(self):
+        return self._x_position.value
+
+    @x_position.setter
+    def x_position(self, value):
+        self._x_position.value = value
+
+    @property
+    def y_position(self):
+        return self._y_position.value
+
+    @y_position.setter
+    def y_position(self, value):
+        self._y_position.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/widget_content.py

@@ -0,0 +1,52 @@
+# 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 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 WidgetContent:
+    """Smartsheet WidgetContent data model."""
+
+    def __init__(self, widget_type=None, base_obj=None):
+        """Initialize the WidgetContent model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._widget_type = widget_type
+
+        self.__initialized = True
+
+    @property
+    def widget_type(self):
+        return self._widget_type
+
+    def to_dict(self):
+        return serialize(self)
+
+    def to_json(self):
+        return json.dumps(self.to_dict())
+
+    def __str__(self):
+        return self.to_json()