Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/capsulecrm-python
Capsule CRM API wrapper written in python.
https://github.com/gearplug/capsulecrm-python
api api-wrapper capsule capsulecrm python wrapper
Last synced: 3 days ago
JSON representation
Capsule CRM API wrapper written in python.
- Host: GitHub
- URL: https://github.com/gearplug/capsulecrm-python
- Owner: GearPlug
- License: mit
- Created: 2017-10-30T22:05:57.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-28T13:54:08.000Z (over 1 year ago)
- Last Synced: 2023-05-23T23:26:58.783Z (over 1 year ago)
- Topics: api, api-wrapper, capsule, capsulecrm, python, wrapper
- Language: Python
- Size: 36.1 KB
- Stars: 6
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# capsulecrm-python
Capsule CRM API wrapper written in python.
## Installing
```
pip install capsulecrm-python
```
## Requirements
- requests
## Usage
```
from capsulecrm.client import Client
client = Client(client_id, client_secret)
```
### Advanced filtering for parties, organisations and projects
```
# Example:
order_by= [{"field": "addedOn", "direction":"descending"}]
conditions= [{"field":"email", "operator": "is", "value": "[email protected]"}]
parties = client.filter_order_data('parties',conditions=conditions, order_by=order_by, page=1, per_page=1)
```
### Create Person or Organisation
```
client.create_person('embed')
client.create_organisation('embed')
```
### List Parties
```
client.list_parties('since, page, perpage, embed')
```
### Create and list Milestone
```
client.create_milestone('name, description, probability, complete')
client.list_milestone('page, perpage')
```
### Create and List Opportunities
```
client.create_oppotunity('embed')
client.list_opportunities('since, page, perpage, embed')
```
### Create and list tasks
```
client.create_task('embed')
client.list_tasks('since, page, perpage, embed')
```
### Create and list tags
```
client.create_tag('entity, name, description, datatag')
client.list_tag('entity, page, perpage')
```
### List projects, users, countries, currencies and categories
```
client.list_projects('since, page, perpage, embed')
client.list_users()
client.list_countries()
client.list_currencies()
client.list_categories()
```
### Get custom Fields by entity (parties, organisations or projects):
```
client.get_custom_fields('entity, page, perpage')
```
## TODO
- show_party
- show_multiple_parties
- update_party
- delete_party
- list_deleted_parties
- list_opportunities_by_party
- show_opportunity
- show_multiple_opportunities
- update_opportunity
- delete_opportunity
- list_deleted_opportunities
- list_additional_parties
- add_additional_party
- remove_additional_party
- delete tag
- show_tag
- update_tag
- delete_milestone
- show_milestone
- update_milestone