Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tizz98/prosperworks-api
Python API wrapper for ProsperWorks
https://github.com/tizz98/prosperworks-api
Last synced: 9 days ago
JSON representation
Python API wrapper for ProsperWorks
- Host: GitHub
- URL: https://github.com/tizz98/prosperworks-api
- Owner: tizz98
- License: mit
- Created: 2016-10-29T04:38:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T23:20:52.000Z (about 5 years ago)
- Last Synced: 2024-11-01T10:07:56.828Z (14 days ago)
- Language: Python
- Size: 48.8 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# This is no longer maintained. Use https://github.com/salespreso/prospyr instead.
# Prosperworks Api
A python based api wrapper for [Prosperworks](https://www.prosperworks.com/developer_api). [](https://travis-ci.org/tizz98/prosperworks-api)
## Installation
From pip (recommended): `pip install prosperworks`
From source: `pip install git+git://github.com:tizz98/prosperworks-api.git@master`
# 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:
```python
from prosperworks import api
from prosperworks.models import Company
api.configure('key', '[email protected]')
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()
```
## `prosperworks.models.Lead`
#### Fields
- id
- name
- address (`prosperworks.models.Address`)
- assignee_id
- company_name
- customer_source_id
- details
- email
- monetary_value
- phone_numbers (list of `prosperworks.models.PhoneNumber`)
- socials (list of `prosperworks.models.Social`)
- status
- 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
- company_name
- customer_source_id
- details
- email
- monetary_value
- phone_numbers[]
- socials[]
- status
- tags
- title
- websites[]
- date_created
- date_modified
- custom_fields[]
- `update` (update current company), _will use currently set values to update_
- `delete` (delete current company)
- `convert` (convert a lead), available kwargs are (all optional):
- person
- company (`prosperworks.models.Company`)
- opportunity
#### Examples:
```python
from prosperworks import api
from prosperworks.models import Company, Lead
api.configure('key', '[email protected]')
new_co = Company.create(name='New Co.')
print new_co.id
lead = Lead.create(name='John Doe')
lead.name = 'Jane Doe'
lead.update()
print lead.id
lead.convert(company=new_co)
```