Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

A simple python wrapper for the ProsperWorks API

Project Description

Prosperworks Api

A python based api wrapper for Prosperworks.

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:

from prosperworks import api
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()

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:

from prosperworks import api
from prosperworks.models import Company, Lead

api.configure('key', 'your.name@example.com')

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)
Release History

Release History

This version
History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.3

History Node

0.1.1

History Node

0.1.0

History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1.1.1

History Node

0.0.1.1

History Node

0.0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
prosperworks-0.1.6.tar.gz (10.3 kB) Copy SHA256 Checksum SHA256 Source Dec 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting