isogeo_pysdk.models.user module¶
Isogeo API v1 - Model of User entity
See: http://help.isogeo.com/api/complete/index.html#definition-user
-
class
isogeo_pysdk.models.user.
User
(_abilities=None, _created=None, _id=None, _modified=None, contact=None, language=None, mailchimp=None, memberships=None, staff=None, timezone=None)¶ Bases:
object
Users in Isogeo platform.
Example: { "_abilities": [ "string" ], "_created": "string (date-time)", "_id": "string (uuid)", "_modified": "string (date-time)", "contact": { "_created": "string (date-time)", "_id": "string (uuid)", "_modified": "string (date-time)", "addressLine1": "string", "addressLine2": "string", "addressLine3": "string", "available": "string", "city": "string", "count": "integer (int32)", "countryCode": "string", "email": "string", "fax": "string", "hash": "string", "name": "string", "organization": "string", "phone": "string", "type": "string", "zipCode": "string" }, "language": "string", "staff": "boolean", "timezone": "string" }
-
ATTR_CREA
= {'contact': <class 'isogeo_pysdk.models.contact.Contact'>, 'language': <class 'str'>, 'mailchimp': <class 'str'>, 'staff': <class 'bool'>, 'timezone': <class 'str'>}¶
-
ATTR_MAP
= {}¶
-
ATTR_TYPES
= {'_abilities': <class 'list'>, '_created': <class 'str'>, '_id': <class 'str'>, '_modified': <class 'str'>, 'contact': <class 'isogeo_pysdk.models.contact.Contact'>, 'language': <class 'str'>, 'mailchimp': <class 'dict'>, 'staff': <class 'bool'>, 'timezone': <class 'str'>}¶
-
email
¶ Shortcut to get the email from the contact data linked to the user.
Return type: str
-
language
¶ Gets the id of this User.
Returns: The id of this User. Return type: str
-
mailchimp
¶ Gets the id of this User.
Returns: The second address line of this User. Return type: str
-
name
¶ Shortcut to get the name from the contact data linked to the user.
Return type: str
-
staff
¶ Staff status for the User.
Returns: the staff status of the User Return type: bool
-
timezone
¶ Gets the timezone of this User.
Returns: The timezone of this User. Return type: str
-
to_dict
()¶ Returns the model properties as a dict.
Return type: dict
-
to_dict_creation
()¶ Returns the model properties as a dict structured for creation purpose (POST)
Return type: dict
-
to_str
()¶ Returns the string representation of the model.
Return type: str
-