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

smartsheet/models/downloaded_file.py

@@ -0,0 +1,106 @@
+# 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 contextlib
+import os.path
+
+from ..types import Number, String, json
+from ..util import deserialize, serialize
+
+
+class DownloadedFile:
+
+    """Smartsheet DownloadedFile data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the DownloadedFile model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._download_directory = String()
+        self._filename = String()
+        self._message = String()
+        self._resp = None
+        self._result_code = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @property
+    def download_directory(self):
+        return self._download_directory.value
+
+    @download_directory.setter
+    def download_directory(self, value):
+        self._download_directory.value = value
+
+    @property
+    def filename(self):
+        return self._filename.value
+
+    @filename.setter
+    def filename(self, value):
+        self._filename.value = value
+
+    @property
+    def message(self):
+        return self._message.value
+
+    @message.setter
+    def message(self, value):
+        self._message.value = value
+
+    @property
+    def resp(self):
+        return self._resp
+
+    @resp.setter
+    def resp(self, value):
+        if isinstance(value, object):
+            self._resp = value
+        else:
+            self._resp = object(value, self._base)
+
+    @property
+    def result_code(self):
+        return self._result_code.value
+
+    @result_code.setter
+    def result_code(self, value):
+        self._result_code.value = value
+
+    def save_to_file(self, chunksize=2**16):
+        download_path = os.path.join(self.download_directory, self.filename)
+        with open(download_path, "wb") as dlfile:
+            with contextlib.closing(self.resp):
+                for chunk in self.resp.iter_content(chunksize):
+                    dlfile.write(chunk)
+
+    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/duration.py

@@ -0,0 +1,112 @@
+# 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
+from ..util import deserialize
+from .object_value import DURATION, ObjectValue
+
+
+class Duration(ObjectValue):
+
+    """Smartsheet Duration data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Duration model."""
+        super().__init__(DURATION, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._days = Number()
+        self._elapsed = Boolean()
+        self._hours = Number()
+        self._milliseconds = Number()
+        self._minutes = Number()
+        self._negative = Boolean()
+        self._seconds = Number()
+        self._weeks = Number()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def days(self):
+        return self._days.value
+
+    @days.setter
+    def days(self, value):
+        self._days.value = value
+
+    @property
+    def elapsed(self):
+        return self._elapsed.value
+
+    @elapsed.setter
+    def elapsed(self, value):
+        self._elapsed.value = value
+
+    @property
+    def hours(self):
+        return self._hours.value
+
+    @hours.setter
+    def hours(self, value):
+        self._hours.value = value
+
+    @property
+    def milliseconds(self):
+        return self._milliseconds.value
+
+    @milliseconds.setter
+    def milliseconds(self, value):
+        self._milliseconds.value = value
+
+    @property
+    def minutes(self):
+        return self._minutes.value
+
+    @minutes.setter
+    def minutes(self, value):
+        self._minutes.value = value
+
+    @property
+    def negative(self):
+        return self._negative.value
+
+    @negative.setter
+    def negative(self, value):
+        self._negative.value = value
+
+    @property
+    def seconds(self):
+        return self._seconds.value
+
+    @seconds.setter
+    def seconds(self, value):
+        self._seconds.value = value
+
+    @property
+    def weeks(self):
+        return self._weeks.value
+
+    @weeks.setter
+    def weeks(self, value):
+        self._weeks.value = value

smartsheet/models/email.py

@@ -0,0 +1,82 @@
+# 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, String, TypedList, json
+from ..util import deserialize, serialize
+from .recipient import Recipient
+
+
+class Email:
+
+    """Smartsheet Email data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Email model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._cc_me = Boolean()
+        self._message = String()
+        self._send_to = TypedList(Recipient)
+        self._subject = String()
+
+        if props:
+            deserialize(self, props)
+
+    @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 send_to(self):
+        return self._send_to
+
+    @send_to.setter
+    def send_to(self, value):
+        self._send_to.load(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/enums/__init__.py

@@ -0,0 +1,56 @@
+# pylint: disable=C0111,C0413
+# 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
+
+# import enums into enum package
+from .access_level import AccessLevel
+from .asset_type import AssetType
+from .attachment_parent_type import AttachmentParentType
+from .attachment_sub_type import AttachmentSubType
+from .attachment_type import AttachmentType
+from .automation_action_frequency import AutomationActionFrequency
+from .automation_action_type import AutomationActionType
+from .automation_rule_disabled_reason import AutomationRuleDisabledReason
+from .cell_link_status import CellLinkStatus
+from .column_type import ColumnType
+from .criteria_target import CriteriaTarget
+from .cross_sheet_reference_status import CrossSheetReferenceStatus
+from .currency_code import CurrencyCode
+from .day_descriptors import DayDescriptors
+from .day_ordinal import DayOrdinal
+from .event_action import EventAction
+from .event_obejct_type import EventObjectType
+from .event_source import EventSource
+from .global_template import GlobalTemplate
+from .operator import Operator
+from .paper_type import PaperType
+from .predecessor_type import PredecessorType
+from .publish_accessible_by import PublishAccessibleBy
+from .schedule_type import ScheduleType
+from .share_scope import ShareScope
+from .share_type import ShareType
+from .sheet_email_format import SheetEmailFormat
+from .sheet_filter_operator import SheetFilterOperator
+from .sheet_filter_type import SheetFilterType
+from .sort_direction import SortDirection
+from .symbol import Symbol
+from .system_column_type import SystemColumnType
+from .update_request_status import UpdateRequestStatus
+from .user_status import UserStatus
+from .widget_type import WidgetType
+from .seat_type import SeatType, DowngradeSeatType, UpgradeSeatType

smartsheet/models/enums/access_level.py

@@ -0,0 +1,26 @@
+# 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 enum import Enum
+
+
+class AccessLevel(Enum):
+    VIEWER = 1
+    COMMENTER = 2
+    EDITOR = 3
+    EDITOR_SHARE = 4
+    ADMIN = 5
+    OWNER = 6

smartsheet/models/enums/asset_type.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+class AssetType(str, Enum):
+    """Defines the asset types supported by the Sharing API."""
+    SHEET = 'sheet'
+    REPORT = 'report'
+    SIGHT = 'sight'
+    WORKSPACE = 'workspace'
+    COLLECTION = 'collection'
+    FILE = 'file'

smartsheet/models/enums/attachment_parent_type.py

@@ -0,0 +1,23 @@
+# 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 enum import Enum
+
+
+class AttachmentParentType(Enum):
+    SHEET = 1
+    ROW = 2
+    COMMENT = 3

smartsheet/models/enums/attachment_sub_type.py

@@ -0,0 +1,26 @@
+# 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 enum import Enum
+
+
+class AttachmentSubType(Enum):
+    DOCUMENT = 1
+    SPREADSHEET = 2
+    PRESENTATION = 3
+    PDF = 4
+    DRAWING = 5
+    FOLDER = 6

smartsheet/models/enums/attachment_type.py

@@ -0,0 +1,29 @@
+# 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 enum import Enum
+
+
+class AttachmentType(Enum):
+    FILE = 1
+    GOOGLE_DRIVE = 2
+    LINK = 3
+    BOX_COM = 4
+    DROPBOX = 5
+    EVERNOTE = 6
+    EGNYTE = 7
+    ONEDRIVE = 8
+    SMARTSHEET = 9

smartsheet/models/enums/automation_action_frequency.py

@@ -0,0 +1,24 @@
+# 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 enum import Enum
+
+
+class AutomationActionFrequency(Enum):
+    IMMEDIATELY = 1
+    HOURLY = 2
+    DAILY = 3
+    WEEKLY = 4

smartsheet/models/enums/automation_action_type.py

@@ -0,0 +1,23 @@
+# 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 enum import Enum
+
+
+class AutomationActionType(Enum):
+    NOTIFICATION_ACTION = 1
+    UPDATE_REQUEST_ACTION = 2
+    APPROVAL_REQUEST_ACTION = 3

smartsheet/models/enums/automation_rule_disabled_reason.py

@@ -0,0 +1,27 @@
+# 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 enum import Enum
+
+
+class AutomationRuleDisabledReason(Enum):
+    AUTOMATION_NOT_ENABLED_FOR_ORG = 1
+    COLUMN_MISSING = 2
+    COLUMN_TYPE_INCOMPATIBLE = 3
+    NO_POTENTIAL_RECIPIENTS = 4
+    NO_VALID_SELECTED_COLUMNS = 5
+    APPROVAL_COLUMN_MISSING = 6
+    APPROVAL_COLUMN_WRONG_TYPE = 7

smartsheet/models/enums/cell_link_status.py

@@ -0,0 +1,28 @@
+# 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 enum import Enum
+
+
+class CellLinkStatus(Enum):
+    OK = 1
+    BROKEN = 2
+    INACCESSIBLE = 3
+    NOT_SHARED = 4
+    BLOCKED = 5
+    CIRCULAR = 6
+    INVALID = 7
+    DISABLED = 8

smartsheet/models/enums/column_type.py

@@ -0,0 +1,31 @@
+# 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 enum import Enum
+
+
+class ColumnType(Enum):
+    TEXT_NUMBER = 1
+    DATE = 2
+    DATETIME = 3
+    CONTACT_LIST = 4
+    CHECKBOX = 5
+    PICKLIST = 6
+    DURATION = 7
+    PREDECESSOR = 8
+    ABSTRACT_DATETIME = 9
+    MULTI_CONTACT_LIST = 10
+    MULTI_PICKLIST = 11

smartsheet/models/enums/criteria_target.py

@@ -0,0 +1,21 @@
+# 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 enum import Enum
+
+
+class CriteriaTarget(Enum):
+    ROW = 1

smartsheet/models/enums/cross_sheet_reference_status.py

@@ -0,0 +1,28 @@
+# 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 enum import Enum
+
+
+class CrossSheetReferenceStatus(Enum):
+    BLOCKED = 1
+    BROKEN = 2
+    CIRCULAR = 3
+    DISABLED = 4
+    INACCESSIBLE = 5
+    INVALID = 6
+    NOT_SHARED = 7
+    OK = 8