A simple python wrapper for the ProsperWorks API
Project description
Prosperworks Api
A python based api wrapper for Prosperworks.
Installation
From source: pip install git+git://github.com:tizz98/prosperworks-api.git@master
From pip: coming soon
Models
prosperworks.models.Company
Fields
id
name
address (prosperworks.models.Address)
assignee_id
contact_type_id
details
email_domain
phone_numbers (list of prosperworks.models.PhoneNumber)
socials (list of prosperworks.models.Social)
tags (list of strings)
websites (list of prosperworks.models.Website)
date_created
date_modified
custom_fields (list of prosperworks.models.CustomField)
Methods
search (search for companies), available kwargs are:
page_number
page_size
sort_by
sort_direction
tags
age
assignee_ids
city
state
postal_code
country
minimum_interaction_count
maximum_interaction_count
minimum_interaction_date
maximum_interaction_date
minimum_created_date
maximum_created_date
minimum_modified_date
maximum_modified_date
create (create new company), available kwargs are:
name
address
assignee_id
contact_type_id
details
email_domain
phone_numbers[]
socials[]
tags
websites[]
date_created
date_modified
custom_fields[]
update (update current company), will use currently set values to update
delete (delete current company)
Examples:
from prosperworks import api, utils
from prosperworks.models import Company
api.configure('key', 'your.name@example.com')
for company in Company.search():
print company.name
new_co = Company.create(name='New Co.')
print new_co.id
new_co.name = 'New Co. (updated)'
new_co.update()
new_co.delete()
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
