smartsheet-python-sdk 3.7.2__py3-none-any.whl → 3.9.0__py3-none-any.whl

smartsheet/favorites.py

@@ -23,6 +23,7 @@ import logging
 
 from .util import fresh_operation
 from .models import Error, Favorite, IndexResult, Result
+from .models.enums import FavoriteType
 
 
 class Favorites:
@@ -92,25 +93,21 @@ class Favorites:
 
         return response
 
-    def remove_favorites(self, favorite_type, object_ids) -> Union[Result[None], Error]:
+    def remove_favorites(self, favorite_type: FavoriteType, object_ids: list[int]) -> Union[Result[None], Error]:
         """Delete one or more of Favorite objects of the specified type.
 
-        Specify a favorite type of: folder, report, sheet,
-        template, workspace. The object IDs passed in will be deleted in a
-        batch operation.
-
         Args:
-            favorite_type (str): Name of favorite type to
-                manipulate.
+            favorite_type FavoriteType: The favorite type enum value.
             object_ids (list[int]): a comma-separated list
                 of object IDs representing the items to work on.
 
         Returns:
             Union[Result[None], Error]: The result of the operation, or an Error object if the request fails.
         """
+
         _op = fresh_operation("remove_favorites")
         _op["method"] = "DELETE"
-        _op["path"] = "/favorites/" + str(favorite_type)
+        _op["path"] = "/favorites/" + favorite_type
         _op["query_params"]["objectIds"] = object_ids
 
         expected = ["Result", None]
@@ -118,3 +115,30 @@ class Favorites:
         response = self._base.request(prepped_request, expected, _op)
 
         return response
+
+    def is_favorite(self, favorite_type: FavoriteType, favorite_id: int, include=None) -> Union[Favorite, Error]:
+        """Check whether an item has been tagged as a favorite for the current user.
+
+        Args:
+            favorite_type FavoriteType: The favorite type enum value.
+            favorite_id (int): ID of the favorite being accessed.
+            include (str): A comma-separated list of optional elements to
+                include in the response. Valid values: "directId", "name".
+
+        Returns:
+            Union[Favorite, Error]: The Favorite object if the item is favorited,
+            or an Error object if the request fails or the item is not favorited.
+        """
+
+        _op = fresh_operation("is_favorite")
+        _op["method"] = "GET"
+        _op["path"] = "/favorites/" + favorite_type + "/" + str(favorite_id)
+        if include is not None:
+            _op["query_params"]["include"] = include
+
+        expected = "Favorite"
+
+        prepped_request = self._base.prepare_request(_op)
+        response = self._base.request(prepped_request, expected, _op)
+
+        return response

smartsheet/models/__init__.py

@@ -79,11 +79,22 @@ from .predecessor import Predecessor
 from .predecessor_list import PredecessorList
 from .project_settings import ProjectSettings
 from .recipient import Recipient
+from .create_report_request import CreateReportRequest
+from .create_report_result import CreateReportResult
 from .report import Report
+from .report_summarizing_criterion import ReportSummarizingCriterion
 from .report_cell import ReportCell
 from .report_column import ReportColumn
+from .report_column_identifier import ReportColumnIdentifier
+from .report_definition import ReportDefinition
+from .report_destination import ReportDestination
+from .report_filter_criterion import ReportFilterCriterion
+from .report_filter_expression import ReportFilterExpression
+from .report_grouping_criterion import ReportGroupingCriterion
 from .report_publish import ReportPublish
 from .report_row import ReportRow
+from .report_sorting_criterion import ReportSortingCriterion
+from .report_scope_inclusion import ReportScopeInclusion
 from .result import Result
 from .row import Row
 from .row_email import RowEmail

smartsheet/models/create_report_request.py

@@ -0,0 +1,107 @@
+# 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 Optional
+
+from ..types import Boolean, String, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+
+from .report_column import ReportColumn
+from .report_scope_inclusion import ReportScopeInclusion
+from .report_destination import ReportDestination
+from .report_definition import ReportDefinition
+
+
+class CreateReportRequest:
+    """Smartsheet CreateReportRequest data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CreateReportRequest model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._name = String()
+        self._columns = TypedList(ReportColumn)
+        self._scope = TypedList(ReportScopeInclusion)
+        self._report_definition = TypedObject(ReportDefinition)
+        self._is_summary_report = Boolean()
+        self._destination = TypedObject(ReportDestination)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name.value
+
+    @name.setter
+    def name(self, value: str) -> None:
+        self._name.value = value
+
+    @property
+    def columns(self) -> TypedList:
+        return self._columns
+
+    @columns.setter
+    def columns(self, value) -> None:
+        self._columns.load(value)
+
+    @property
+    def scope(self) -> TypedList:
+        return self._scope
+
+    @scope.setter
+    def scope(self, value) -> None:
+        self._scope.load(value)
+
+    @property
+    def report_definition(self):
+        return self._report_definition.value
+
+    @report_definition.setter
+    def report_definition(self, value) -> None:
+        self._report_definition.value = value
+
+    @property
+    def is_summary_report(self) -> Optional[bool]:
+        return self._is_summary_report.value
+
+    @is_summary_report.setter
+    def is_summary_report(self, value: bool) -> None:
+        self._is_summary_report.value = value
+
+    @property
+    def destination(self):
+        return self._destination.value
+
+    @destination.setter
+    def destination(self, value) -> None:
+        self._destination.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/create_report_result.py

@@ -0,0 +1,105 @@
+# 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 Optional
+
+from smartsheet.models.enums.access_level import AccessLevel
+from .report_column import ReportColumn
+
+from ..types import Boolean, EnumeratedValue, Number, String, TypedList, json
+from ..util import deserialize, serialize
+
+
+class CreateReportResult:
+    """Smartsheet CreateReportResult data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the CreateReportResult model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._id = Number()
+        self._name = String()
+        self._access_level = EnumeratedValue(AccessLevel)
+        self._permalink = String()
+        self._is_summary_report = Boolean()
+        self._columns = TypedList(ReportColumn)
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def id(self) -> Optional[int]:
+        return self._id.value
+
+    @id.setter
+    def id(self, value: int) -> None:
+        self._id.value = value
+
+    @property
+    def name(self) -> Optional[str]:
+        return self._name.value
+
+    @name.setter
+    def name(self, value: str) -> None:
+        self._name.value = value
+
+    @property
+    def access_level(self):
+        return self._access_level.value
+
+    @access_level.setter
+    def access_level(self, value) -> None:
+        self._access_level.set(value)
+
+    @property
+    def permalink(self) -> Optional[str]:
+        return self._permalink.value
+
+    @permalink.setter
+    def permalink(self, value: str) -> None:
+        self._permalink.value = value
+
+    @property
+    def is_summary_report(self) -> Optional[bool]:
+        return self._is_summary_report.value
+
+    @is_summary_report.setter
+    def is_summary_report(self, value: bool) -> None:
+        self._is_summary_report.value = value
+
+    @property
+    def columns(self) -> TypedList:
+        return self._columns
+
+    @columns.setter
+    def columns(self, value) -> None:
+        self._columns.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/enums/__init__.py

@@ -36,11 +36,17 @@ from .day_ordinal import DayOrdinal
 from .event_action import EventAction
 from .event_object_type import EventObjectType
 from .event_source import EventSource
+from .favorite_type import FavoriteType
 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 .report_aggregation_type import ReportAggregationType
+from .report_asset_type import ReportAssetType
+from .report_boolean_operator import ReportBooleanOperator
+from .report_destination_type import ReportDestinationType
+from .report_filter_operator import ReportFilterOperator
 from .schedule_type import ScheduleType
 from .share_scope import ShareScope
 from .share_type import ShareType

smartsheet/models/enums/favorite_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 FavoriteType(str, Enum):
+    FOLDER = "folder"
+    REPORT = "report"
+    SHEET = "sheet"
+    SIGHT = "sight"
+    TEMPLATE = "template"
+    WORKSPACE = "workspace"

smartsheet/models/enums/report_aggregation_type.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 ReportAggregationType(str, Enum):
+    SUM = 'SUM'
+    AVG = 'AVG'
+    MIN = 'MIN'
+    MAX = 'MAX'
+    COUNT = 'COUNT'
+    FIRST = 'FIRST'
+    LAST = 'LAST'

smartsheet/models/enums/report_asset_type.py

@@ -0,0 +1,22 @@
+# 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 ReportAssetType(str, Enum):
+    SHEET = 'sheet'
+    WORKSPACE = 'workspace'

smartsheet/models/enums/report_boolean_operator.py

@@ -0,0 +1,22 @@
+# 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 ReportBooleanOperator(str, Enum):
+    AND = 'AND'
+    OR = 'OR'

smartsheet/models/enums/report_destination_type.py

@@ -0,0 +1,22 @@
+# 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 ReportDestinationType(str, Enum):
+    WORKSPACE = 'workspace'
+    FOLDER = 'folder'

smartsheet/models/enums/report_filter_operator.py

@@ -0,0 +1,56 @@
+# 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 ReportFilterOperator(str, Enum):
+    EQUAL = 'EQUAL'
+    NOT_EQUAL = 'NOT_EQUAL'
+    GREATER_THAN = 'GREATER_THAN'
+    LESS_THAN = 'LESS_THAN'
+    CONTAINS = 'CONTAINS'
+    BETWEEN = 'BETWEEN'
+    TODAY = 'TODAY'
+    PAST = 'PAST'
+    FUTURE = 'FUTURE'
+    LAST_N_DAYS = 'LAST_N_DAYS'
+    NEXT_N_DAYS = 'NEXT_N_DAYS'
+    IS_BLANK = 'IS_BLANK'
+    IS_NOT_BLANK = 'IS_NOT_BLANK'
+    IS_NUMBER = 'IS_NUMBER'
+    IS_NOT_NUMBER = 'IS_NOT_NUMBER'
+    IS_DATE = 'IS_DATE'
+    IS_NOT_DATE = 'IS_NOT_DATE'
+    IS_CHECKED = 'IS_CHECKED'
+    IS_UNCHECKED = 'IS_UNCHECKED'
+    IS_ONE_OF = 'IS_ONE_OF'
+    IS_NOT_ONE_OF = 'IS_NOT_ONE_OF'
+    LESS_THAN_OR_EQUAL = 'LESS_THAN_OR_EQUAL'
+    GREATER_THAN_OR_EQUAL = 'GREATER_THAN_OR_EQUAL'
+    DOES_NOT_CONTAIN = 'DOES_NOT_CONTAIN'
+    NOT_BETWEEN = 'NOT_BETWEEN'
+    NOT_TODAY = 'NOT_TODAY'
+    NOT_PAST = 'NOT_PAST'
+    NOT_FUTURE = 'NOT_FUTURE'
+    NOT_LAST_N_DAYS = 'NOT_LAST_N_DAYS'
+    NOT_NEXT_N_DAYS = 'NOT_NEXT_N_DAYS'
+    HAS_ANY_OF = 'HAS_ANY_OF'
+    HAS_NONE_OF = 'HAS_NONE_OF'
+    HAS_ALL_OF = 'HAS_ALL_OF'
+    NOT_ALL_OF = 'NOT_ALL_OF'
+    MULTI_IS_EQUAL = 'MULTI_IS_EQUAL'
+    MULTI_IS_NOT_EQUAL = 'MULTI_IS_NOT_EQUAL'

smartsheet/models/enums/seat_type.py

@@ -5,11 +5,13 @@ class SeatType(str, Enum):
     GUEST = 'GUEST'
     MEMBER = 'MEMBER'
     PROVISIONAL_MEMBER = 'PROVISIONAL_MEMBER'
+    CONTRIBUTOR = 'CONTRIBUTOR'
 
 
 class DowngradeSeatType(str, Enum):
     VIEWER = 'VIEWER'
     GUEST = 'GUEST'
+    CONTRIBUTOR = 'CONTRIBUTOR'
 
 
 class UpgradeSeatType(str, Enum):

smartsheet/models/favorite.py

@@ -37,6 +37,8 @@ class Favorite:
 
         self._object_id = Number()
         self._type_ = String(accept=self.allowed_values["_type"])
+        self._direct_id = String()
+        self._name = String()
 
         if props:
             deserialize(self, props)
@@ -71,6 +73,22 @@ class Favorite:
     def type_(self, value):
         self._type_.value = value
 
+    @property
+    def direct_id(self):
+        return self._direct_id.value
+
+    @direct_id.setter
+    def direct_id(self, value):
+        self._direct_id.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)
 

smartsheet/models/report_column_identifier.py

@@ -0,0 +1,117 @@
+# 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 typing import Optional, Union
+
+from ..types import EnumeratedValue, String, Boolean, json
+from ..util import deserialize, serialize
+from .enums import ColumnType, SystemColumnType
+
+
+class ReportColumnIdentifier:
+    """Smartsheet ReportColumnIdentifier data model.
+
+    Object used to match a sheet column for a report. Either 'type' or 'primary' must be
+    specified.
+
+    **Column Matching Options:**
+    - **Regular columns**: Specify 'type' to match columns by type (optionally with 'title'
+      for additional matching).
+    - **System columns**: Specify both 'type' and 'systemColumnType' to match system columns
+      (e.g., Created By, Modified Date).
+    - **Sheet name column**: Specify 'type=TEXT_NUMBER' and 'sheetNameColumn=True' to match
+      the special "Sheet Name" column.
+    - **Primary column**: Specify 'primary=True' to match the primary column. When matching
+      primary columns, 'title' can be used to customize the primary column name in the
+      rendered report.
+
+    **Note:** Columns in the report are matched by the combination of 'title' and 'type'
+    (and 'systemColumnType' or 'sheetNameColumn' if specified).
+
+    **Note:** 'symbol' is not used for matching and as a result 'CHECKBOX' or 'PICKLIST'
+    columns with different symbols (from different sheets) can be combined into the same
+    column in the report. You cannot combine 'CHECKBOX' with 'PICKLIST' into the same column
+    in the report because they are different types.
+    """
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the ReportColumnIdentifier model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._title = String()
+        self._type = EnumeratedValue(ColumnType)
+        self._system_column_type = EnumeratedValue(SystemColumnType)
+        self._primary = Boolean()
+        self._sheet_name_column = Boolean()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def title(self) -> Optional[str]:
+        return self._title.value
+
+    @title.setter
+    def title(self, value: str) -> None:
+        self._title.value = value
+
+    @property
+    def type(self) -> EnumeratedValue:
+        return self._type
+
+    @type.setter
+    def type(self, value: Union[ColumnType, str]) -> None:
+        self._type.set(value)
+
+    @property
+    def system_column_type(self) -> EnumeratedValue:
+        return self._system_column_type
+
+    @system_column_type.setter
+    def system_column_type(self, value: Union[SystemColumnType, str]) -> None:
+        self._system_column_type.set(value)
+
+    @property
+    def primary(self) -> Optional[bool]:
+        return self._primary.value
+
+    @primary.setter
+    def primary(self, value: bool) -> None:
+        self._primary.value = value
+
+    @property
+    def sheet_name_column(self) -> Optional[bool]:
+        return self._sheet_name_column.value
+
+    @sheet_name_column.setter
+    def sheet_name_column(self, value: bool) -> None:
+        self._sheet_name_column.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()