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

smartsheet/models/asset_share.py

@@ -0,0 +1,165 @@
+# 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, String, Boolean, json
+from ..util import deserialize, serialize
+from .enums import AccessLevel, ShareScope, ShareType
+
+
+class AssetShare:
+
+    """Smartsheet AssetShare data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AssetShare model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._email = String()
+        self._group_id = String()
+        self._id_ = String()
+        self._name = String()
+        self._scope = EnumeratedValue(ShareScope)
+        self._type_ = EnumeratedValue(ShareType)
+        self._user_id = String()
+        self._cc_me = Boolean()
+        self._message = String()
+        self._subject = String()
+
+        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_
+        elif key == "type":
+            return self.type_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "id":
+            self.id_ = value
+        elif key == "type":
+            self.type_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def access_level(self):
+        return self._access_level
+
+    @access_level.setter
+    def access_level(self, value):
+        self._access_level.set(value)
+
+    @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
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.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
+
+    @scope.setter
+    def scope(self, value):
+        self._scope.set(value)
+
+    @property
+    def type_(self):
+        return self._type_
+
+    @type_.setter
+    def type_(self, value):
+        self._type_.set(value)
+
+    @property
+    def user_id(self):
+        return self._user_id.value
+
+    @user_id.setter
+    def user_id(self, value):
+        self._user_id.value = value
+
+    @property
+    def cc_me(self):
+        return self._cc_me.value
+
+    @cc_me.setter
+    def cc_me(self, value):
+        self._cc_me.value = value
+
+    @property
+    def message(self):
+        return self._message.value
+
+    @message.setter
+    def message(self, value):
+        self._message.value = value
+
+    @property
+    def subject(self):
+        return self._subject.value
+
+    @subject.setter
+    def subject(self, value):
+        self._subject.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/asset_shares_paginated_result.py

@@ -0,0 +1,84 @@
+# 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 typing import TypeVar, List
+from ..types import String, json, TypedList, importlib
+from ..util import deserialize, serialize
+from .asset_share import AssetShare
+
+T = TypeVar('T')
+
+
+class AssetSharesPaginatedResult:
+    """Smartsheet AssetSharesPaginatedResult data model with generic type support.
+    Use only for deserializing the response from GET /2.0/shares.
+    Created because GET /2.0/shares returns items in the response body instead of data.
+    As a result TokenPaginatedResult cannot be used.
+    """
+
+    def __init__(self, props=None, dynamic_data_type=None, base_obj=None):
+        """Initialize the TokenPaginatedResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._dynamic_data_type = None
+        if dynamic_data_type is not None:
+            self._dynamic_data_type = dynamic_data_type
+
+        self._items = TypedList(object)
+        self._last_key = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def items(self) -> List[AssetShare]:
+        return self._items
+
+    @items.setter
+    def items(self, value):
+        class_ = getattr(
+            importlib.import_module("smartsheet.models"), self._dynamic_data_type
+        )
+        if isinstance(value, list):
+            self._items = [class_(x, self._base) for x in value]
+        else:
+            self._items = class_(value, self._base)
+
+
+    @property
+    def last_key(self):
+        return self._last_key.value
+
+    @last_key.setter
+    def last_key(self, value):
+        self._last_key.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/attachment.py

@@ -0,0 +1,181 @@
+# 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, Timestamp, TypedObject,
+                     json)
+from ..util import deserialize, serialize
+from .enums import AttachmentParentType, AttachmentSubType, AttachmentType
+from .user import User
+
+
+class Attachment:
+
+    """Smartsheet Attachment data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Attachment model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._attachment_sub_type = EnumeratedValue(AttachmentSubType)
+        self._attachment_type = EnumeratedValue(AttachmentType)
+        self._created_at = Timestamp()
+        self._created_by = TypedObject(User)
+        self._description = String()
+        self._id_ = Number()
+        self._mime_type = String()
+        self._name = String()
+        self._parent_id = Number()
+        self._parent_type = EnumeratedValue(AttachmentParentType)
+        self._size_in_kb = Number()
+        self._url = String()
+        self._url_expires_in_millis = 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 attachment_sub_type(self):
+        return self._attachment_sub_type
+
+    @attachment_sub_type.setter
+    def attachment_sub_type(self, value):
+        self._attachment_sub_type.set(value)
+
+    @property
+    def attachment_type(self):
+        return self._attachment_type
+
+    @attachment_type.setter
+    def attachment_type(self, value):
+        self._attachment_type.set(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 created_by(self):
+        return self._created_by.value
+
+    @created_by.setter
+    def created_by(self, value):
+        self._created_by.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 mime_type(self):
+        return self._mime_type.value
+
+    @mime_type.setter
+    def mime_type(self, value):
+        self._mime_type.value = value
+
+    @property
+    def name(self):
+        return self._name.value
+
+    @name.setter
+    def name(self, value):
+        self._name.value = value
+
+    @property
+    def parent_id(self):
+        return self._parent_id.value
+
+    @parent_id.setter
+    def parent_id(self, value):
+        self._parent_id.value = value
+
+    @property
+    def parent_type(self):
+        return self._parent_type
+
+    @parent_type.setter
+    def parent_type(self, value):
+        self._parent_type.set(value)
+
+    @property
+    def size_in_kb(self):
+        return self._size_in_kb.value
+
+    @size_in_kb.setter
+    def size_in_kb(self, value):
+        self._size_in_kb.value = value
+
+    @property
+    def url(self):
+        return self._url.value
+
+    @url.setter
+    def url(self, value):
+        self._url.value = 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/auto_number_format.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 AutoNumberFormat:
+
+    """Smartsheet AutoNumberFormat data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AutoNumberFormat model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._fill = String()
+        self._prefix = String()
+        self._starting_number = Number()
+        self._suffix = String()
+
+        if props:
+            deserialize(self, props)
+
+    @property
+    def fill(self):
+        return self._fill.value
+
+    @fill.setter
+    def fill(self, value):
+        self._fill.value = value
+
+    @property
+    def prefix(self):
+        return self._prefix.value
+
+    @prefix.setter
+    def prefix(self, value):
+        self._prefix.value = value
+
+    @property
+    def starting_number(self):
+        return self._starting_number.value
+
+    @starting_number.setter
+    def starting_number(self, value):
+        self._starting_number.value = value
+
+    @property
+    def suffix(self):
+        return self._suffix.value
+
+    @suffix.setter
+    def suffix(self, value):
+        self._suffix.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/automation_action.py

@@ -0,0 +1,162 @@
+# 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, String, TypedList, json, six
+from ..util import deserialize, serialize
+from .enums import AutomationActionFrequency, AutomationActionType
+from .recipient import Recipient
+
+
+class AutomationAction:
+
+    """Smartsheet AutomationAction data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the AutomationAction model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._frequency = EnumeratedValue(AutomationActionFrequency)
+        self._include_all_columns = Boolean()
+        self._include_attachments = Boolean()
+        self._include_discussions = Boolean()
+        self._included_column_ids = TypedList(six.integer_types)
+        self._message = String()
+        self._notify_all_shared_users = Boolean()
+        self._recipient_column_ids = TypedList(six.integer_types)
+        self._recipients = TypedList(Recipient)
+        self._subject = String()
+        self._type_ = EnumeratedValue(AutomationActionType)
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    def __getattr__(self, key):
+        if key == "type":
+            return self.type_
+        else:
+            raise AttributeError(key)
+
+    def __setattr__(self, key, value):
+        if key == "type":
+            self.type_ = value
+        else:
+            super().__setattr__(key, value)
+
+    @property
+    def frequency(self):
+        return self._frequency
+
+    @frequency.setter
+    def frequency(self, value):
+        self._frequency.set(value)
+
+    @property
+    def include_all_columns(self):
+        return self._include_all_columns.value
+
+    @include_all_columns.setter
+    def include_all_columns(self, value):
+        self._include_all_columns.value = value
+
+    @property
+    def include_attachments(self):
+        return self._include_attachments.value
+
+    @include_attachments.setter
+    def include_attachments(self, value):
+        self._include_attachments.value = value
+
+    @property
+    def include_discussions(self):
+        return self._include_discussions.value
+
+    @include_discussions.setter
+    def include_discussions(self, value):
+        self._include_discussions.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 message(self):
+        return self._message.value
+
+    @message.setter
+    def message(self, value):
+        self._message.value = value
+
+    @property
+    def notify_all_shared_users(self):
+        return self._notify_all_shared_users.value
+
+    @notify_all_shared_users.setter
+    def notify_all_shared_users(self, value):
+        self._notify_all_shared_users.value = value
+
+    @property
+    def recipient_column_ids(self):
+        return self._recipient_column_ids
+
+    @recipient_column_ids.setter
+    def recipient_column_ids(self, value):
+        self._recipient_column_ids.load(value)
+
+    @property
+    def recipients(self):
+        return self._recipients
+
+    @recipients.setter
+    def recipients(self, value):
+        self._recipients.load(value)
+
+    @property
+    def subject(self):
+        return self._subject.value
+
+    @subject.setter
+    def subject(self, value):
+        self._subject.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()