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

smartsheet/models/user.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
+from .user_model import UserModel
+
+
+class User(UserModel):
+
+    """Smartsheet User data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the User model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._name = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @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/user_model.py

@@ -0,0 +1,280 @@
+# 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, Number, String, Timestamp,
+                     TypedList, TypedObject, json)
+from ..models.enums import SeatType
+from ..util import deserialize, serialize
+from .alternate_email import AlternateEmail
+from .enums import UserStatus
+from .profile_image import ProfileImage
+
+
+class UserModel:
+
+    """Smartsheet UserModel data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the UserModel model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._admin = Boolean()
+        self._alternate_emails = TypedList(AlternateEmail)
+        self._company = String()
+        self._custom_welcome_screen_viewed = Timestamp()
+        self._department = String()
+        self._email = String()
+        self._first_name = String()
+        self._group_admin = Boolean()
+        self._id_ = Number()
+        self._is_internal = Boolean()
+        self._last_login = Timestamp()
+        self._last_name = String()
+        self._licensed_sheet_creator = Boolean()
+        self._mobile_phone = String()
+        self._profile_image = TypedObject(ProfileImage)
+        self._provisional_expiration_date = Timestamp()
+        self._resource_viewer = Boolean()
+        self._role = String()
+        self._seat_type = EnumeratedValue(SeatType)
+        self._seat_type_last_changed_at = Timestamp()
+        self._sheet_count = Number()
+        self._status = EnumeratedValue(UserStatus)
+        self._title = String()
+        self._work_phone = 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 admin(self):
+        return self._admin.value
+
+    @admin.setter
+    def admin(self, value):
+        self._admin.value = value
+
+    @property
+    def alternate_emails(self):
+        return self._alternate_emails
+
+    @alternate_emails.setter
+    def alternate_emails(self, value):
+        self._alternate_emails.load(value)
+
+    @property
+    def company(self):
+        return self._company.value
+
+    @company.setter
+    def company(self, value):
+        self._company.value = value
+
+    @property
+    def custom_welcome_screen_viewed(self):
+        return self._custom_welcome_screen_viewed.value
+
+    @custom_welcome_screen_viewed.setter
+    def custom_welcome_screen_viewed(self, value):
+        self._custom_welcome_screen_viewed.value = value
+
+    @property
+    def department(self):
+        return self._department.value
+
+    @department.setter
+    def department(self, value):
+        self._department.value = 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 group_admin(self):
+        return self._group_admin.value
+
+    @group_admin.setter
+    def group_admin(self, value):
+        self._group_admin.value = value
+
+    @property
+    def id_(self):
+        return self._id_.value
+
+    @id_.setter
+    def id_(self, value):
+        self._id_.value = value
+
+    @property
+    def is_internal(self):
+        return self._is_internal.value
+
+    @is_internal.setter
+    def is_internal(self, value):
+        self._is_internal.value = value
+
+    @property
+    def last_login(self):
+        return self._last_login.value
+
+    @last_login.setter
+    def last_login(self, value):
+        self._last_login.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 licensed_sheet_creator(self):
+        return self._licensed_sheet_creator.value
+
+    @licensed_sheet_creator.setter
+    def licensed_sheet_creator(self, value):
+        self._licensed_sheet_creator.value = value
+
+    @property
+    def mobile_phone(self):
+        return self._mobile_phone.value
+
+    @mobile_phone.setter
+    def mobile_phone(self, value):
+        self._mobile_phone.value = value
+
+    @property
+    def profile_image(self):
+        return self._profile_image.value
+
+    @profile_image.setter
+    def profile_image(self, value):
+        self._profile_image.value = value
+
+    @property
+    def provisional_expiration_date(self):
+        return self._provisional_expiration_date.value
+
+    @provisional_expiration_date.setter
+    def provisional_expiration_date(self, value):
+        self._provisional_expiration_date.value = value
+
+    @property
+    def resource_viewer(self):
+        return self._resource_viewer.value
+
+    @resource_viewer.setter
+    def resource_viewer(self, value):
+        self._resource_viewer.value = value
+
+    @property
+    def role(self):
+        return self._role.value
+
+    @role.setter
+    def role(self, value):
+        self._role.value = value
+
+    @property
+    def seat_type(self):
+        return self._seat_type
+
+    @seat_type.setter
+    def seat_type(self, value):
+        self._seat_type.set(value)
+
+    @property
+    def seat_type_last_changed_at(self):
+        return self._seat_type_last_changed_at.value
+
+    @seat_type_last_changed_at.setter
+    def seat_type_last_changed_at(self, value):
+        self._seat_type_last_changed_at.value = value
+
+    @property
+    def sheet_count(self):
+        return self._sheet_count.value
+
+    @sheet_count.setter
+    def sheet_count(self, value):
+        self._sheet_count.value = value
+
+    @property
+    def status(self):
+        return self._status
+
+    @status.setter
+    def status(self, value):
+        self._status.set(value)
+
+    @property
+    def title(self):
+        return self._title.value
+
+    @title.setter
+    def title(self, value):
+        self._title.value = value
+
+    @property
+    def work_phone(self):
+        return self._work_phone.value
+
+    @work_phone.setter
+    def work_phone(self, value):
+        self._work_phone.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/user_plan.py

@@ -0,0 +1,77 @@
+from __future__ import absolute_import
+
+from ..types import (Boolean, EnumeratedValue, Number, String, Timestamp,
+                     TypedList, TypedObject, json)
+from ..models.enums import SeatType
+from ..util import deserialize, serialize
+
+
+class UserPlan:
+
+    """Smartsheet Plan for a User data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the UserPlan model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._plan_id = Number()
+        self._seat_type = EnumeratedValue(SeatType)
+        self._seat_type_last_changed_at = Timestamp()
+        self._is_internal = Boolean()
+        self._provisional_expiration_date = Timestamp()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @property
+    def plan_id(self):
+        return self._plan_id.value
+
+    @plan_id.setter
+    def plan_id(self, value):
+        self._plan_id.value = value
+
+    @property
+    def seat_type(self):
+        return self._seat_type
+
+    @seat_type.setter
+    def seat_type(self, value):
+        self._seat_type.set(value)
+
+    @property
+    def seat_type_last_changed_at(self):
+        return self._seat_type_last_changed_at.value
+
+    @seat_type_last_changed_at.setter
+    def seat_type_last_changed_at(self, value):
+        self._seat_type_last_changed_at.value = value
+
+    @property
+    def is_internal(self):
+        return self._is_internal.value
+
+    @is_internal.setter
+    def is_internal(self, value):
+        self._is_internal.value = value
+
+    @property
+    def provisional_expiration_date(self):
+        return self._provisional_expiration_date.value
+
+    @provisional_expiration_date.setter
+    def provisional_expiration_date(self, value):
+        self._provisional_expiration_date.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/user_profile.py

@@ -0,0 +1,89 @@
+# 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, TypedList, TypedObject, json
+from ..util import deserialize, serialize
+from .account import Account
+from .group import Group
+from .user_model import UserModel
+
+
+class UserProfile(UserModel):
+
+    """Smartsheet UserProfile data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the UserProfile model."""
+        super().__init__(None, base_obj)
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._account = TypedObject(Account)
+        self._groups = TypedList(Group)
+        self._locale = String()
+        self._time_zone = String()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+        self.__initialized = True
+
+    @property
+    def account(self):
+        return self._account.value
+
+    @account.setter
+    def account(self, value):
+        self._account.value = value
+
+    @property
+    def groups(self):
+        return self._groups
+
+    @groups.setter
+    def groups(self, value):
+        self._groups.load(value)
+
+    @property
+    def locale(self):
+        return self._locale.value
+
+    @locale.setter
+    def locale(self, value):
+        self._locale.value = value
+
+    @property
+    def time_zone(self):
+        return self._time_zone.value
+
+    @time_zone.setter
+    def time_zone(self, value):
+        self._time_zone.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/version.py

@@ -0,0 +1,57 @@
+# 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, json
+from ..util import deserialize, serialize
+
+
+class Version:
+
+    """Smartsheet Version data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the Version model."""
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        self._version = Number()
+
+        if props:
+            deserialize(self, props)
+
+        # requests package Response object
+        self.request_response = None
+
+    @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/web_content_widget_content.py

@@ -0,0 +1,60 @@
+# 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 String, json
+from ..util import deserialize, serialize
+from .enums import WidgetType
+from .widget_content import WidgetContent
+
+
+class WebContentWidgetContent(WidgetContent):
+    """Smartsheet WebContentWidgetContent data model."""
+
+    def __init__(self, props=None, base_obj=None):
+        """Initialize the WebContentWidgetContent model."""
+        super().__init__(WidgetType.WEBCONTENT, base_obj)
+
+        self._base = None
+        if base_obj is not None:
+            self._base = base_obj
+
+        # Represents the WebContentWidgetContent object
+        self._url = String()
+
+        if props:
+            deserialize(self, props)
+
+        self.__initialized = True
+
+    @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()