README user guide

Author: Yordy Gelvez

README.md

@@ -31,6 +31,217 @@ token = client.refresh_token('REFRESH TOKEN')
 token = client.set_token('TOKEN')
 ```
 
+#### Get recent changes
+```
+token = client.get_recent_changes(since_timestamp="YYYY-MM-DD HH:MM:SS")
+```
+
+### Deals section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals
+
+#### Get deals
+```
+get_deals = client.get_deals()
+```
+
+#### Create deal
+```
+create_deal = client.create_deal(title="")
+```
+
+#### Update deal
+```
+update_deal = client.update_deal(deal_id="")
+```
+
+#### Delete deal
+```
+delete_deal = client.delete_deal(deal_id="")
+```
+
+#### Duplicate deal
+```
+duplicate_deal = client.duplicate_deal(deal_id="")
+```
+
+#### Get details of a deal
+```
+details_deal = client.get_deal_details(deal_id="")
+```
+
+#### Find deals by name
+```
+find_deal = client.get_deals_by_name(term="")
+```
+
+#### Get followers of a deal
+```
+followers_deal = client.get_deal_followers(deal_id="")
+```
+
+#### Add a follower to a deal
+```
+add_follower_deal = client.add_follower_to_deal(deal_id="", user_id="")
+```
+
+#### Delete a follower from a deal
+```
+delete_followers_deal = client.delete_follower_to_deal(deal_id="", follower_id="")
+```
+
+#### Get participants of a deal
+```
+get_participants_deal = client.get_deal_participants(deal_id="")
+```
+
+#### Add a participant to a deal
+```
+add_participants_deal = client.add_participants_to_deal(deal_id="", person_id="")
+```
+
+#### Delete a participant from a deal
+```
+delete_participants_deal = client.delete_participant_to_deal(deal_id="", participant_id="")
+```
+
+#### Get activities associated with a deal
+```
+get_activities_deal = client.get_deal_activities(deal_id="")
+```
+
+#### Get mail messages associated with a deal
+```
+get_messages_deal = client.get_deal_mail_messages(deal_id="")
+```
+
+#### Get products attached to a deal
+```
+get_products_deal = client.get_deal_products(deal_id="")
+```
+
+### Notes section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes
+
+#### Get notes
+If you need a specific note send the note id, if you don't just call the method without send anything
+```
+get_specific_note = client.get_notes(note_id="")
+
+get_notes = client.get_notes()
+```
+
+#### Add a note
+```
+add_note = client.create_note(content="")
+```
+
+#### Update a note
+```
+update_note = client.update_note(note_id="", content="")
+```
+
+#### Delete a note
+```
+delete_note = client.delete_note(note_id="")
+```
+
+### Organizations section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations
+
+#### Get organizations
+```
+get_organizations = client.get_organizations()
+```
+
+#### Add organization
+```
+add_organization = client.create_organization(name="")
+```
+
+#### Update organization
+```
+update_organization = client.update_organization(data_id="", name="")
+```
+
+#### Delete an organization
+```
+delete_organization = client.delete_organization(data_id="")
+```
+
+### Persons section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons
+
+#### Get persons
+If you need the details of a person send the person id, if you don't just call the method without send anything
+```
+get_details_person = client.get_persons(person_id="")
+
+get_persons = client.get_persons()
+```
+
+#### Get persons by name
+```
+find_persons = client.get_persons_by_name(term="")
+```
+
+#### Create person
+```
+add_persons = client.create_person(name="")
+```
+
+#### Update person
+```
+update_persons = client.update_person(data_id="", name="")
+```
+
+#### Delete person
+```
+delete_persons = client.delete_person(data_id="")
+```
+
+#### Get deals associated with a person
+```
+get_persons_deals = client.get_person_deals(person_id="")
+```
+
+### Activities section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities
+
+#### Get activities
+If you need the activity details send the activity id, if you don't just call the method without send anything
+```
+get_details_activity = client.get_activities(activity_id="")
+
+get_activities = client.get_activities()
+```
+
+#### Create an activity
+```
+add_activity = client.create_activity(subject="", type="")
+```
+
+#### Update an activity
+```
+edit_activity = client.update_activity(activity_id="")
+```
+
+#### Delete an activity
+```
+delete_activity = client.delete_activity(activity_id="")
+```
+
+### Webhook section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks
+
+#### Get webhooks
+```
+get_hooks = client.get_hooks_subscription()
+```
+
+#### Add webhook
+```
+add_hook = client.create_hook_subscription(subscription_url="", event_action="", event_object="")
+```
+
+#### Delete webhook
+```
+delete_hooks = client.delete_hook_subscription(hook_id="")
+```
+
 ## Requirements
 - requests
 - base64 -- b64encode

pipedrive/client.py

@@ -191,10 +191,10 @@ def get_deal_details(self, deal_id):
             url = "deals/{0}".format(deal_id)
             return self._get(url)
 
-    def get_deals_by_name(self, params=None):
-        if params is not None:
+    def get_deals_by_name(self, **kwargs):
+        if kwargs is not None:
             url = "deals/find"
-            return self._get(url, params=params)
+            return self._get(url, **kwargs)
 
     def get_deal_followers(self, deal_id):
         if deal_id is not None:
@@ -216,10 +216,10 @@ def get_deal_participants(self, deal_id, **kwargs):
             url = "deals/{0}/participants".format(deal_id)
             return self._get(url, **kwargs)
 
-    def add_participants_to_deal(self, deal_id, participant_id):
-        if deal_id is not None and participant_id is not None:
+    def add_participants_to_deal(self, deal_id, person_id):
+        if deal_id is not None and person_id is not None:
             url = "deals/{0}/participants".format(deal_id)
-            return self._post(url, json=participant_id)
+            return self._post(url, json=person_id)
 
     def delete_participant_to_deal(self, deal_id, participant_id):
         if deal_id is not None and participant_id is not None:
@@ -293,20 +293,18 @@ def delete_organization(self, data_id):
             return self._delete(url)
 
     # Persons section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons
-    def get_persons(self, **kwargs):
-        url = "persons"
+    def get_persons(self, person_id=None, **kwargs):
+        if person_id is not None:
+            url = "persons/{0}".format(person_id)
+        else:
+            url = "persons"
         return self._get(url, **kwargs)
 
     def get_persons_by_name(self, params=None):
         if params is not None:
             url = "persons/find"
             return self._get(url, params=params)
 
-    def get_person_details(self, person_id):
-        if person_id is not None:
-            url = "persons/{0}".format(person_id)
-            return self._get(url)
-
     def create_person(self, **kwargs):
         if kwargs is not None:
             url = "persons"
@@ -369,14 +367,12 @@ def get_product_deal(self, product_id, **kwargs):
             return self._get(url, **kwargs)
 
     # Activities section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities
-    def get_activities(self, **kwargs):
-        url = "activities"
-        return self._get(url, **kwargs)
-
-    def get_activity_details(self, activity_id):
+    def get_activities(self, activity_id=None, **kwargs):
         if activity_id is not None:
             url = "activities/{0}".format(activity_id)
-            return self._get(url)
+        else:
+            url = "activities"
+        return self._get(url, **kwargs)
 
     def create_activity(self, **kwargs):
         if kwargs is not None:
@@ -386,7 +382,7 @@ def create_activity(self, **kwargs):
             return self._post(url, json=params)
 
     def update_activity(self, activity_id, **kwargs):
-        if activity_id is not None and kwargs is not None:
+        if activity_id is not None:
             url = "activities/{0}".format(activity_id)
             params = {}
             params.update(kwargs)