Models¶
Address¶
-
class
highton.models.address.
Address
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- city – fields.StringField(name=HightonConstants.CITY)
- country – fields.StringField(name=HightonConstants.COUNTRY)
- state – fields.StringField(name=HightonConstants.STATE)
- street – fields.StringField(name=HightonConstants.STREET)
- zip – fields.StringField(name=HightonConstants.ZIP)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'address'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
AssociatedParty¶
-
class
highton.models.associated_party.
AssociatedParty
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- company_id – fields.IntegerField(name=HightonConstants.COMPANY_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- first_name – fields.StringField(name=HightonConstants.FIRST_NAME)
- name – fields.StringField(name=HightonConstants.NAME)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- last_name – fields.StringField(name=HightonConstants.LAST_NAME)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- title – fields.StringField(name=HightonConstants.TITLE)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- company_name – fields.StringField(name=HightonConstants.COMPANY_NAME)
- linkedin_url – fields.StringField(name=HightonConstants.LINKEDIN_URL)
- avatar_url – fields.StringField(name=HightonConstants.AVATAR_URL)
- type – fields.StringField(name=HightonConstants.TYPE)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
-
ENDPOINT
= 'parties'¶
-
TAG_NAME
= 'associated-party'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Attachment¶
-
class
highton.models.attachment.
Attachment
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- url – fields.StringField(name=HightonConstants.URL)
- name – fields.StringField(name=HightonConstants.NAME)
- size – fields.IntegerField(name=HightonConstants.SIZE)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= None¶
-
TAG_NAME
= 'attachment'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Case¶
-
class
highton.models.case.
Case
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- closed_at – fields.DatetimeField(name=HightonConstants.CLOSED_AT)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- name – fields.StringField(name=HightonConstants.NAME)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- parties – fields.ListField(name=HightonConstants.PARTIES, init_class=Party)
- associated_parties – fields.ListField(name=HightonConstants.ASSOCIATED_PARTIES, init_class=AssociatedParty)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
EMAILS_OFFSET
= 25¶
-
ENDPOINT
= 'kases'¶
-
NOTES_OFFSET
= 25¶
-
TAG_NAME
= 'kase'¶
-
add_note
(body)¶ Create a Note to current object
Parameters: body (str) – the body of the note Returns: newly created Note Return type: Tag
-
add_tag
(name)¶ Create a Tag to current object
Parameters: name (str) – the name of the tag Returns: newly created Tag Return type: Tag
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
delete_tag
(tag_id)¶ Deletes a Tag to current object
Parameters: tag_id (int) – the id of the tag which should be deleted Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
list_emails
(page=0, since=None)¶ Get the emails of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the emails
Return type: list
-
list_notes
(page=0, since=None)¶ Get the notes of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the notes
Return type: list
Get the tags of current object
Returns: the tags Return type: list
-
list_tasks
()¶ Get the tasks of current object
Returns: the tasks Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
Category¶
-
class
highton.models.category.
Category
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'category'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Comment¶
-
class
highton.models.comment.
Comment
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- parent_id – fields.IntegerField(name=HightonConstants.PARENT_ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- body – fields.StringField(name=HightonConstants.BODY)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'comments'¶
-
TAG_NAME
= 'comment'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
Company¶
-
class
highton.models.company.
Company
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- linkedin_url – fields.StringField(name=HightonConstants.LINKEDIN_URL)
- avatar_url – fields.StringField(name=HightonConstants.AVATAR_URL)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
- name – fields.StringField(name=HightonConstants.NAME)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
EMAILS_OFFSET
= 25¶
-
ENDPOINT
= 'companies'¶
-
NOTES_OFFSET
= 25¶
-
OFFSET
= 500¶
-
SEARCH_OFFSET
= 25¶
-
TAG_NAME
= 'company'¶
-
add_note
(body)¶ Create a Note to current object
Parameters: body (str) – the body of the note Returns: newly created Note Return type: Tag
-
add_tag
(name)¶ Create a Tag to current object
Parameters: name (str) – the name of the tag Returns: newly created Tag Return type: Tag
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
delete_tag
(tag_id)¶ Deletes a Tag to current object
Parameters: tag_id (int) – the id of the tag which should be deleted Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(page=0, since=None, tag_id=None, title=None)[source]¶ Parameters: - page (int) – page starting by 0
- since (datetime.datetime) –
- tag_id (int) – id of a tag
- title (str) –
Returns: list of customer objects
Return type: list
-
list_emails
(page=0, since=None)¶ Get the emails of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the emails
Return type: list
-
list_notes
(page=0, since=None)¶ Get the notes of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the notes
Return type: list
Get the tags of current object
Returns: the tags Return type: list
-
list_tasks
()¶ Get the tasks of current object
Returns: the tasks Return type: list
-
people
()[source]¶ Retrieve all people of the company
Returns: list of people objects Return type: list
-
classmethod
search
(term=None, page=0, **criteria)¶ Search a list of the model If you use “term”: - Returns a collection of people that have a name matching the term passed in through the URL.
If you use “criteria”: - returns people who match your search criteria. Search by any criteria you can on the Contacts tab, including custom fields. Combine criteria to narrow results
Parameters: - term (str) – params as string
- criteria (dict) – search for more criteria
- page (int) – the page
Returns: the list of the parsed xml objects
Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
Contact¶
-
class
highton.models.contact.
Contact
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- linkedin_url – fields.StringField(name=HightonConstants.LINKEDIN_URL)
- avatar_url – fields.StringField(name=HightonConstants.AVATAR_URL)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
-
ENDPOINT
= None¶
-
TAG_NAME
= None¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
ContactData¶
-
class
highton.models.contact_data.
ContactData
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- phone_numbers – fields.ListField(name=HightonConstants.PHONE_NUMBERS, init_class=PhoneNumber)
- twitter_accounts – fields.ListField(name=HightonConstants.TWITTER_ACCOUNTS, init_class=TwitterAccount)
- web_addresses – fields.ListField(name=HightonConstants.WEB_ADDRESSES, init_class=WebAddress)
- email_addresses – fields.ListField(name=HightonConstants.EMAIL_ADDRESSES, init_class=EmailAddress)
- addresses – fields.ListField(name=HightonConstants.ADDRESSES, init_class=Address)
- instant_messenger – fields.ListField(name=HightonConstants.INSTANT_MESSENGERS, init_class=InstantMessenger)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'contact-data'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Deal¶
-
class
highton.models.deal.
Deal
(**kwargs)[source]¶ A deal which represents:
https://github.com/basecamp/highrise-api/blob/master/sections/deals.md
Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- account_id – fields.IntegerField(name=HightonConstants.ACCOUNT_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- category_id – fields.IntegerField(name=HightonConstants.CATEGORY_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- currency – fields.StringField(name=HightonConstants.CURRENCY)
- duration – fields.IntegerField(name=HightonConstants.DURATION)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- name – fields.StringField(name=HightonConstants.NAME)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- party_id – fields.IntegerField(name=HightonConstants.PARTY_ID)
- price – fields.IntegerField(name=HightonConstants.PRICE)
- price_type – fields.StringField(name=HightonConstants.PRICE_TYPE)
- responsible_party_id – fields.IntegerField(name=HightonConstants.RESPONSIBLE_PARTY_ID)
- status – fields.StringField(name=HightonConstants.STATUS)
- status_changed_on – fields.DateField(name=HightonConstants.STATUS_CHANGED_ON)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- party – fields.ObjectField(name=HightonConstants.PARTY, init_class=Party)
- category – fields.ObjectField(name=HightonConstants.CATEGORY, init_class=Category)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- parties – fields.ListField(name=HightonConstants.PARTIES, init_class=Party)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
- associated_parties – fields.ListField(name=HightonConstants.ASSOCIATED_PARTIES, init_class=AssociatedParty)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
EMAILS_OFFSET
= 25¶
-
ENDPOINT
= 'deals'¶
-
NOTES_OFFSET
= 25¶
-
OFFSET
= 500¶
-
TAG_NAME
= 'deal'¶
-
add_note
(body)¶ Create a Note to current object
Parameters: body (str) – the body of the note Returns: newly created Note Return type: Tag
-
add_tag
(name)¶ Create a Tag to current object
Parameters: name (str) – the name of the tag Returns: newly created Tag Return type: Tag
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
delete_tag
(tag_id)¶ Deletes a Tag to current object
Parameters: tag_id (int) – the id of the tag which should be deleted Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(page=0, status=None, since=None)[source]¶ Parameters: - page (int) – page starting by 0
- since (datetime.datetime) –
- status (str) –
Returns: list of person objects
Return type: list
-
list_emails
(page=0, since=None)¶ Get the emails of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the emails
Return type: list
-
list_notes
(page=0, since=None)¶ Get the notes of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the notes
Return type: list
Get the tags of current object
Returns: the tags Return type: list
-
list_tasks
()¶ Get the tasks of current object
Returns: the tasks Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
DealCategory¶
-
class
highton.models.deal_category.
DealCategory
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
- color – fields.StringField(name=HightonConstants.COLOR)
- account_id – fields.IntegerField(name=HightonConstants.ACCOUNT_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- elements_count – fields.IntegerField(name=HightonConstants.ELEMENTS_COUNT)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'deal_categories'¶
-
TAG_NAME
= 'deal-category'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
Email¶
-
class
highton.models.email.
Email
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- title – fields.StringField(name=HightonConstants.TITLE, required=True)
- body – fields.StringField(name=HightonConstants.BODY, required=True)
- subject_id – fields.IntegerField(name=HightonConstants.SUBJECT_ID, required=True)
- subject_type – fields.StringField(name=HightonConstants.SUBJECT_TYPE, required=True)
- subject_name – fields.StringField(name=HightonConstants.SUBJECT_NAME)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- collection_id – fields.IntegerField(name=HightonConstants.COLLECTION_ID)
- collection_type – fields.StringField(name=HightonConstants.COLLECTION_TYPE)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- attachments – fields.ListField(name=HightonConstants.ATTACHMENTS, init_class=Attachment)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
COMMENT_OFFSET
= 25¶
-
ENDPOINT
= 'emails'¶
-
TAG_NAME
= 'email'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
list_comments
(page=0)¶ Get the comments of current object
Parameters: page – the page starting at 0 Returns: the emails Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
EmailAddress¶
-
class
highton.models.email_address.
EmailAddress
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- address – fields.StringField(name=HightonConstants.ADDRESS)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'email-address'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Group¶
-
class
highton.models.group.
Group
(**kwargs)[source]¶ The authenticated user needs to be an administrator to perform these actions.
Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
- users – fields.ListField(name=HightonConstants.USERS, init_class=models.User)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'groups'¶
-
TAG_NAME
= 'group'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
HightonModel¶
-
class
highton.models.highton_model.
HightonModel
(**kwargs)[source]¶ This class inherit from XMLDecoder and XMLEncoder which allows every HightonModel to be encoded and decoded in xml.
Variables: id – fields.IntegerField(name=HightonConstants.ID) -
ENDPOINT
= None¶
-
TAG_NAME
= None¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
InstantMessenger¶
-
class
highton.models.instant_messenger.
InstantMessenger
(**kwargs)[source]¶ Variables: - id – fields:IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- address – fields.StringField(name=HightonConstants.ADDRESS)
- protocol – fields.StringField(name=HightonConstants.PROTOCOL)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'instant-messenger'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Note¶
-
class
highton.models.note.
Note
(**kwargs)[source]¶ Variables: - id – fields:IntegerField(name=HightonConstants.ID)
- body – fields.StringField(name=HightonConstants.BODY, required=True)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- subject_id – fields.IntegerField(name=HightonConstants.SUBJECT_ID, required=True)
- subject_type – fields.StringField(name=HightonConstants.SUBJECT_TYPE, required=True)
- subject_name – fields.StringField(name=HightonConstants.SUBJECT_NAME)
- collection_id – fields.IntegerField(name=HightonConstants.COLLECTION_ID)
- collection_type – fields.StringField(name=HightonConstants.COLLECTION_TYPE)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- attachments – fields.ListField(name=HightonConstants.ATTACHMENTS, init_class=Attachment)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
COMMENT_OFFSET
= 25¶
-
ENDPOINT
= 'notes'¶
-
TAG_NAME
= 'note'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
list_comments
(page=0)¶ Get the comments of current object
Parameters: page – the page starting at 0 Returns: the emails Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
Party¶
-
class
highton.models.party.
Party
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- company_id – fields.IntegerField(name=HightonConstants.COMPANY_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- first_name – fields.StringField(name=HightonConstants.FIRST_NAME)
- name – fields.StringField(name=HightonConstants.NAME)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- last_name – fields.StringField(name=HightonConstants.LAST_NAME)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- title – fields.StringField(name=HightonConstants.TITLE)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- company_name – fields.StringField(name=HightonConstants.COMPANY_NAME)
- linkedin_url – fields.StringField(name=HightonConstants.LINKEDIN_URL)
- avatar_url – fields.StringField(name=HightonConstants.AVATAR_URL)
- type – fields.StringField(name=HightonConstants.TYPE)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
-
ENDPOINT
= 'parties'¶
-
TAG_NAME
= 'party'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Person¶
-
class
highton.models.person.
Person
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- company_id – fields.IntegerField(name=HightonConstants.COMPANY_ID)
- company_name – fields.StringField(name=HightonConstants.COMPANY_NAME)
- first_name – fields.StringField(name=HightonConstants.FIRST_NAME)
- last_name – fields.StringField(name=HightonConstants.LAST_NAME)
- title – fields.StringField(name=HightonConstants.TITLE)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- background – fields.StringField(name=HightonConstants.BACKGROUND)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- group_id – fields.IntegerField(name=HightonConstants.GROUP_ID)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- visible_to – fields.StringField(name=HightonConstants.VISIBLE_TO)
- linkedin_url – fields.StringField(name=HightonConstants.LINKEDIN_URL)
- avatar_url – fields.StringField(name=HightonConstants.AVATAR_URL)
- tags – fields.ListField(name=HightonConstants.TAGS, init_class=Tag)
- contact_data – fields.ObjectField(name=HightonConstants.CONTACT_DATA, init_class=ContactData)
- subject_datas – fields.ListField(name=HightonConstants.SUBJECT_DATAS, init_class=SubjectData)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
EMAILS_OFFSET
= 25¶
-
ENDPOINT
= 'people'¶
-
NOTES_OFFSET
= 25¶
-
OFFSET
= 500¶
-
SEARCH_OFFSET
= 25¶
-
TAG_NAME
= 'person'¶
-
add_note
(body)¶ Create a Note to current object
Parameters: body (str) – the body of the note Returns: newly created Note Return type: Tag
-
add_tag
(name)¶ Create a Tag to current object
Parameters: name (str) – the name of the tag Returns: newly created Tag Return type: Tag
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
delete_tag
(tag_id)¶ Deletes a Tag to current object
Parameters: tag_id (int) – the id of the tag which should be deleted Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(page=0, since=None, tag_id=None, title=None)[source]¶ Parameters: - page (int) – page starting by 0
- since (datetime.datetime) –
- tag_id (int) – id of a tag
- title (str) –
Returns: list of person objects
Return type: list
-
list_emails
(page=0, since=None)¶ Get the emails of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the emails
Return type: list
-
list_notes
(page=0, since=None)¶ Get the notes of current object
Parameters: - page – the page starting at 0
- since (datetime.datetime) – get all notes since a datetime
Returns: the notes
Return type: list
Get the tags of current object
Returns: the tags Return type: list
-
list_tasks
()¶ Get the tasks of current object
Returns: the tasks Return type: list
-
classmethod
search
(term=None, page=0, **criteria)¶ Search a list of the model If you use “term”: - Returns a collection of people that have a name matching the term passed in through the URL.
If you use “criteria”: - returns people who match your search criteria. Search by any criteria you can on the Contacts tab, including custom fields. Combine criteria to narrow results
Parameters: - term (str) – params as string
- criteria (dict) – search for more criteria
- page (int) – the page
Returns: the list of the parsed xml objects
Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
PhoneNumber¶
-
class
highton.models.phone_number.
PhoneNumber
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- number – fields.StringField(name=HightonConstants.NUMBER)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'phone-number'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
SubjectData¶
-
class
highton.models.subject_data.
SubjectData
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- value – fields.StringField(name=HightonConstants.VALUE)
- type – fields.StringField(name=HightonConstants.TYPE)
- subject_field_id – fields.StringField(name=HightonConstants.SUBJECT_FIELD_ID)
- subject_field_label – fields.StringField(name=HightonConstants.SUBJECT_FIELD_LABEL)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'subject_data'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Tag¶
-
class
highton.models.tag.
Tag
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'tags'¶
-
TAG_NAME
= 'tag'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)[source]¶ Get all parties (people and companies) associated with a given tag. :param object_id: the primary id of the model :type object_id: integer :return: the parties :rtype: list
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
Task¶
-
class
highton.models.task.
Task
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- recording_id – fields.IntegerField(name=HightonConstants.RECORDING_ID)
- subject_id – fields.IntegerField(name=HightonConstants.SUBJECT_ID)
- subject_type – fields.StringField(name=HightonConstants.SUBJECT_TYPE)
- subject_name – fields.StringField(name=HightonConstants.SUBJECT_NAME)
- category_id – fields.IntegerField(name=HightonConstants.CATEGORY_ID, required=True)
- body – fields.StringField(name=HightonConstants.BODY, required=True)
- frame – fields.StringField(name=HightonConstants.FRAME, required=True)
- due_at – fields.DatetimeField(name=HightonConstants.DUE_AT, required=True)
- alert_at – fields.DatetimeField(name=HightonConstants.ALERT_AT)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- author_id – fields.IntegerField(name=HightonConstants.AUTHOR_ID)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- public – fields.BooleanField(name=HightonConstants.PUBLIC)
- recurring_period – fields.StringField(name=HightonConstants.RECURRING_PERIOD)
- anchor_type – fields.IntegerField(name=HightonConstants.ANCHOR_TYPE)
- done_at – fields.DatetimeField(name=HightonConstants.DONE_AT)
- owner_id – fields.IntegerField(name=HightonConstants.OWNER_ID)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'tasks'¶
-
TAG_NAME
= 'task'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete_tag
(tag_id)¶ Deletes a Tag to current object
Parameters: tag_id (int) – the id of the tag which should be deleted Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list_all
()[source]¶ Returns a collection of all tasks visible to the current user.
Returns: Return type: list
-
classmethod
list_assigned
()[source]¶ Returns a collection of upcoming tasks (tasks that have not yet been completed, regardless of whether they’re overdue) that were created by the authenticated user, but assigned to somebody else.
Returns: Return type: list
-
classmethod
list_completed
()[source]¶ Returns a collection of completed tasks.
Returns: Return type: list
-
classmethod
list_today
()[source]¶ Returns a collection of uncompleted tasks due for the rest of today for the authenticated user.
Returns: Return type: list
-
classmethod
list_upcoming
()[source]¶ Returns a collection of upcoming tasks (tasks that have not yet been completed, regardless of whether they’re overdue) for the authenticated user
Returns: Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
TaskCategory¶
-
class
highton.models.task_category.
TaskCategory
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
- color – fields.StringField(name=HightonConstants.COLOR)
- account_id – fields.IntegerField(name=HightonConstants.ACCOUNT_ID)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
- elements_count – fields.IntegerField(name=HightonConstants.ELEMENTS_COUNT)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'task_categories'¶
-
TAG_NAME
= 'task-category'¶
-
create
()¶ Creates the object
Returns: the created object Return type: object
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
delete
()¶ Deletes the object
Returns: Return type: None
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
-
update
()¶ Updates the object
Returns: Return type: response
User¶
-
class
highton.models.user.
User
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- name – fields.StringField(name=HightonConstants.NAME)
- email_address – fields.StringField(name=HightonConstants.EMAIL_ADDRESS)
- admin – fields.BooleanField(name=HightonConstants.ADMIN)
- token – fields.StringField(name=HightonConstants.TOKEN)
- dropbox – fields.StringField(name=HightonConstants.DROPBOX)
- created_at – fields.DatetimeField(name=HightonConstants.CREATED_AT)
- updated_at – fields.DatetimeField(name=HightonConstants.UPDATED_AT)
-
COLLECTION_DATETIME
= '%Y%m%d%H%M%S'¶
-
ENDPOINT
= 'users'¶
-
TAG_NAME
= 'user'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
classmethod
get
(object_id)¶ Retrieves a single model
Parameters: object_id (integer) – the primary id of the model Returns: the object of the parsed xml object Return type: object
-
classmethod
list
(params=None)¶ Retrieves a list of the model
Parameters: params (dict) – params as dictionary Returns: the list of the parsed xml objects Return type: list
-
classmethod
me
()[source]¶ Returns information about the currently authenticated user.
Returns: Return type: User
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
TwitterAccount¶
-
class
highton.models.twitter_account.
TwitterAccount
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- username – fields.StringField(name=HightonConstants.USERNAME)
- url – fields.StringField(name=HightonConstants.URL)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'twitter-account'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict
WebAddress¶
-
class
highton.models.web_address.
WebAddress
(**kwargs)[source]¶ Variables: - id – fields.IntegerField(name=HightonConstants.ID)
- location – fields.StringField(name=HightonConstants.LOCATION)
- url – fields.StringField(name=HightonConstants.URL)
-
ENDPOINT
= None¶
-
TAG_NAME
= 'web-address'¶
-
classmethod
decode
(root_element)¶ Decode the object to the object
Parameters: root_element (xml.etree.ElementTree.Element) – the parsed xml Element Returns: the decoded Element as object Return type: object
-
static
element_from_string
(string)¶ Make a Element from a str
Parameters: string (str) – string you want to parse Returns: the parsed xml string Return type: xml.etree.ElementTree.Element
-
static
element_to_string
(element)¶ Parses the xml.etree.ElementTree.Element to a string
Parameters: element (xml.etree.ElementTree.Element) – a xml element Returns: the parsed string Return type: str
-
encode
()¶ Encodes the object to a xml.etree.ElementTree.Element
Returns: the encoded element Return type: xml.etree.ElementTree.Element
-
to_serializable_value
()¶ Parses the Hightonmodel to a serializable value such dicts, lists, strings This can be used to save the model in a NoSQL database
Returns: the serialized HightonModel Return type: dict