{
    "info": {
        "author": "Miguel Ferrer",
        "author_email": "ingferrermiguel@gmail.com",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# pipedrive-python\n\npipedrive-python is an API wrapper for Pipedrive written in Python.\n\n## Installing\n```\npip install pipedrive-python-lib\n```\n\n## Usage\n\n### Using this library with OAuth 2.0\n\n#### Client instantiation\n```\nfrom pipedrive.client import Client\n\nclient = Client('CLIENT_ID', 'CLIENT_SECRET')\n```\n\n#### Get authorization url\n```\nurl = client.authorization_url('REDIRECT_URL')\n```\n\n#### Exchange the code for an access token\n```\ntoken = client.exchange_code('REDIRECT_URL', 'CODE')\n```\n\n#### Set access token in the library\n```\nclient.set_access_token('ACCESS_TOKEN')\n```\n\n#### Refresh token\n```\ntoken = client.refresh_token('REFRESH_TOKEN')\n```\n\n### Using this library with API Token\n\n#### Client instantiation\n```\nfrom pipedrive.client import Client\n\nclient = Client(domain='https://companydomain.pipedrive.com/')\n```\n\n#### Set API token in the library\n```\nclient.set_api_token('API_TOKEN')\n```\n\n### Activities \n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Activities\n\n#### Get an activity\n```\nresponse = client.activities.get_activity('ACTIVITY_ID')\n```\n\n#### Get all activities\n```\nresponse = client.activities.get_all_activities()\n```\n\n#### Create an activity\n```\ndata = {\n    'subject': '',\n    'type': ''\n}\nresponse = client.activities.create_activity(data)\n```\n\n#### Update an activity\n```\ndata = {\n    'subject': '',\n    'type': ''\n}\nresponse = client.activities.update_activity('ACTIVITY_ID', data)\n```\n\n#### Delete an activity\n```\nresponse = client.activities.delete_activity('ACTIVITY_ID')\n```\n\n#### Get activity fields\n```\nresponse = client.activities.get_activity_fields()\n```\n\n### Deals\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Deals\n\n#### Get a deal\n```\nresponse = client.deals.get_deal('DEAL_ID')\n```\n\n#### Get all deals\n```\nresponse = client.deals.get_all_deals()\n```\n\n#### Create deal\n```\ndata = {\n    'title': ''\n}\nresponse = client.deals.create_deal(data)\n```\n\n#### Update deal\n```\ndata = {\n    'title': ''\n}\nresponse = client.deals.update_deal('DEAL_ID', data)\n```\n\n#### Delete deal\n```\nresponse = client.deals.delete_deal('DEAL_ID')\n```\n\n#### Duplicate deal\n```\nresponse = client.deals.duplicate_deal('DEAL_ID')\n```\n\n#### Get details of a deal\n```\nresponse = client.deals.get_deal_details('DEAL_ID')\n```\n\n#### Find deals by name\n```\nparams = {\n    'term': ''\n}\nresponse = client.deals.get_deals_by_name(params=params)\n```\n\n#### Get followers of a deal\n```\nresponse = client.deals.get_deal_followers('DEAL_ID')\n```\n\n#### Add a follower to a deal\n```\nresponse = client.deals.add_follower_to_deal('DEAL_ID', 'USER_ID')\n```\n\n#### Delete a follower from a deal\n```\nresponse = client.deals.delete_follower_to_deal('DEAL_ID', 'FOLLOWER_ID')\n```\n\n#### Get participants of a deal\n```\nresponse = client.deals.get_deal_participants('DEAL_ID')\n```\n\n#### Add a participant to a deal\n```\nresponse = client.deals.add_participants_to_deal('DEAL_ID', 'PERSON_ID')\n```\n\n#### Delete a participant from a deal\n```\nresponse = client.deals.delete_participant_to_deal('DEAL_ID', 'PARTICIPANT_ID')\n```\n\n#### Get activities associated with a deal\n```\nresponse = client.deals.get_deal_activities('DEAL_ID')\n```\n\n#### Get mail messages associated with a deal\n```\nresponse = client.deals.get_deal_mail_messages('DEAL_ID')\n```\n\n#### Get products attached to a deal\n```\nresponse = client.deals.get_deal_products('DEAL_ID')\n```\n\n#### Get deal fields\n```\nresponse = client.deals.get_deal_fields()\n```\n\n### Filters\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Filters\n\n#### Get a filter\n```\nresponse = client.filters.get_filter('FILTER_ID')\n```\n\n#### Get all filters\n```\nresponse = client.filters.get_all_filters()\n```\n\n#### Create filter\n```\ndata = {\n    'name': '', \n    'conditions': {},\n    'type': ''\n}\nresponse = client.filters.create_filter(data)\n```\n\n#### Update filter\n```\ndata = {\n    'name': '', \n    'conditions': {},\n    'type': ''\n}\nresponse = client.filters.update_filter('FILTER_ID', data)\n```\n\n#### Delete filter\n```\nresponse = client.filters.delete_filter('FILTER_ID')\n```\n\n### Notes\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Notes\n\n#### Get a note\n```\nresponse = client.notes.get_note('NOTE_ID')\n```\n\n#### Get all notes\n```\nresponse = client.notes.get_all_notes()\n```\n\n#### Add a note\n```\ndata = {\n    'content': ''\n}\nresponse = client.notes.create_note(data)\n```\n\n#### Update a note\n```\ndata = {\n    'content': ''\n}\nresponse = client.notes.update_note('NOTE_ID', data)\n```\n\n#### Delete a note\n```\nresponse = client.notes.delete_note('NOTE_ID')\n```\n\n#### Get note fields\n```\nresponse = client.notes.get_note_fields()\n```\n\n### Organizations\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Organizations\n\n#### Get an organization\n```\nresponse = client.organizations.get_organization('ORGANIZATION_ID')\n```\n\n#### Get all organizations\n```\nresponse = client.organizations.get_all_organizations()\n```\n\n#### Add organization\n```\ndata = {\n    'name': ''\n}\nresponse = client.organizations.create_organization(data)\n```\n\n#### Update organization\n```\ndata = {\n    'name': ''\n}\nresponse = client.organizations.update_organization('ORGANIZATION_ID', data)\n```\n\n#### Delete an organization\n```\nresponse = client.organizations.delete_organization('ORGANIZATION_ID')\n```\n\n#### Get organization fields\n```\nresponse = client.organizations.get_organization_fields()\n```\n\n### Persons \n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Persons\n\n#### Get a person\n```\nresponse = client.persons.get_person('PERSON_ID')\n```\n\n#### Get all persons\n```\nresponse = client.persons.get_all_persons()\n```\n\n#### Get persons by name\n```\nparams = {\n    'term': ''\n}\nresponse = client.persons.get_persons_by_name(params=params)\n```\n\n#### Create person\n```\ndata = {\n    'name': ''\n}\nresponse = client.persons.create_person(data)\n```\n\n#### Update person\n```\ndata = {\n    'name': ''\n}\nresponse = client.persons.update_person('PERSON_ID', data)\n```\n\n#### Delete person\n```\nresponse = client.persons.delete_person('PERSON_ID')\n```\n\n#### Get deals associated with a person\n```\nresponse = client.persons.get_person_deals('PERSON_ID')\n```\n\n#### Get person fields\n```\nresponse = client.persons.get_person_fields()\n```\n\n### Pipelines\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Pipelines\n\n#### Get a pipeline\n```\nresponse = client.pipelines.get_pipeline('PIPELINE_ID')\n```\n\n#### Get all pipelines\n```\nresponse = client.pipelines.get_all_pipelines()\n```\n\n#### Get deals attached to a pipeline\n```\nresponse = client.pipelines.get_pipeline_deals()\n```\n\n### Products\n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Products\n\n#### Get a product\n```\nresponse = client.products.get_product('PRODUCT_ID')\n```\n\n#### Get all products\n```\nresponse = client.products.get_all_products()\n```\n\n#### Get products by name\n```\nparams = {\n    'term': ''\n}\nresponse = client.products.get_product_by_name(params=params)\n```\n\n#### Create a product\n```\ndata = {\n    'name': ''\n}\nresponse = client.products.create_product(data)\n```\n\n#### Update a product\n```\ndata = {\n    'name': ''\n}\nresponse = client.products.update_product('PRODUCT_ID', data)\n```\n\n#### Delete a product\n```\nresponse = client.products.delete_product('PRODUCT_ID')\n```\n\n#### Get deals where a product is attached to\n```\nresponse = client.products.get_product_deal('PRODUCT_ID')\n```\n\n#### Get product fields\n```\nresponse = client.products.get_product_fields()\n```\n\n### Recents\n\n#### Get recent changes\n```\nparams = {\n    'since_timestamp': 'YYYY-MM-DD HH:MM:SS'\n}\nresponse = client.recents.get_recent_changes(params=params)\n```\n\n### Users \n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Users\n\n#### Get an user\n```\nresponse = client.users.get_users('USER_ID')\n```\n\n#### Get all users\n```\nresponse = client.users.get_all_users()\n```\n\n#### Get me\n```\nresponse = client.users.get_me()\n```\n\n### Webhook \n\nAPI docs: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks\n\n#### Get webhooks\n```\nresponse = client.webhooks.get_hooks_subscription()\n```\n\n#### Add webhook\n```\ndata = {\n    'subscription_url': '',\n    'event_action': '',\n    'event_object': ''\n}\nresponse = client.webhooks.create_hook_subscription(data)\n```\n\n#### Delete webhook\n```\nresponse = client.webhooks.delete_hook_subscription('HOOK_ID')\n```\n\n## Requirements\n- requests\n\n\n## Contributing\nWe are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.\n\n#### You can report any bug you find or suggest new functionality with a new [issue](https://github.com/GearPlug/pipedrive-python/issues).\n\n#### If you want to add yourself some functionality to the wrapper:\n1. Fork it ( https://github.com/GearPlug/pipedrive-python )\n2. Create your feature branch (git checkout -b my-new-feature)\n3. Commit your changes (git commit -am 'Adds my new feature')\n4. Push to the branch (git push origin my-new-feature)\n5. Create a new Pull Request",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/GearPlug/pipedrive-python",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pipedrive-python-lib",
        "package_url": "https://pypi.org/project/pipedrive-python-lib/",
        "platform": "",
        "project_url": "https://pypi.org/project/pipedrive-python-lib/",
        "project_urls": {
            "Homepage": "https://github.com/GearPlug/pipedrive-python"
        },
        "release_url": "https://pypi.org/project/pipedrive-python-lib/1.1.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "API wrapper for Pipedrive written in Python",
        "version": "1.1.0"
    },
    "last_serial": 5837347,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "997130012a0a46e67e8b94bcbc7947d0",
                    "sha256": "396c22c584d7fce83bf548fea5a7d392ed89f321c24f8970d8243c5c19007e41"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "997130012a0a46e67e8b94bcbc7947d0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5976,
                "upload_time": "2018-03-05T14:07:15",
                "url": "https://files.pythonhosted.org/packages/7b/b5/6bd56e5f8c20ea837b3b28b92bd74667dee6efdb6f68dd1dba86fb1333d0/pipedrive-python-lib-0.1.0.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fdc3ecac5811b03045692092db1528c0",
                    "sha256": "4f45e1a02f088c6d2339509eca930e31b051458119ac06bbc31f880e440df09f"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fdc3ecac5811b03045692092db1528c0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6046,
                "upload_time": "2018-09-20T15:34:02",
                "url": "https://files.pythonhosted.org/packages/ce/f3/906ee3e8e6094d73181c6692332e087bb2311c4749fa905ae1d962516e46/pipedrive-python-lib-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9305455e71d1b200a9ebc5a1194dfeb1",
                    "sha256": "6c01fe05f4f3d87e3f77d3b8c9b5372b9906c34c122dd7519b45e38008546c56"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "9305455e71d1b200a9ebc5a1194dfeb1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6390,
                "upload_time": "2018-11-29T21:19:39",
                "url": "https://files.pythonhosted.org/packages/e4/2b/59bcbc948a83a6e929a9bc6c3a04778ef445e4b96af00f8faa769a17112a/pipedrive-python-lib-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8d367d7e249415c875898cc9c29434a9",
                    "sha256": "ba78e92ad541d5db3f5fc20a2a55fba3cf1910fdb829e8379171fab47c5d68f6"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "8d367d7e249415c875898cc9c29434a9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6391,
                "upload_time": "2018-11-29T22:01:05",
                "url": "https://files.pythonhosted.org/packages/84/a7/ee8d7bcc4429b2b6340ce823c3f5a3331989285b5950c6ff9147c3a0d5d9/pipedrive-python-lib-0.1.3.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ecfc5d2752765495b0a899507987b090",
                    "sha256": "1529147cc012f8bdecc904d17b6e820e0a061a946e898b2880422deb9b576ba1"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ecfc5d2752765495b0a899507987b090",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6664,
                "upload_time": "2019-09-06T20:15:48",
                "url": "https://files.pythonhosted.org/packages/08/45/7f7cc20483163dae6cad6dc33779f43a009142656b09c4620e4c3bdb7bc1/pipedrive-python-lib-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a098466ad9861303e618e02dbd506529",
                    "sha256": "062e8e6940d9ac0cb6e4416d14c3292b9ed4a1feabaa101da4c932c08ee42131"
                },
                "downloads": -1,
                "filename": "pipedrive-python-lib-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "a098466ad9861303e618e02dbd506529",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6873,
                "upload_time": "2019-09-16T17:09:14",
                "url": "https://files.pythonhosted.org/packages/4f/54/9697a12bc64d4a5d017dc085b49a73f06ad07742c9694d4d0574c3660b28/pipedrive-python-lib-1.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a098466ad9861303e618e02dbd506529",
                "sha256": "062e8e6940d9ac0cb6e4416d14c3292b9ed4a1feabaa101da4c932c08ee42131"
            },
            "downloads": -1,
            "filename": "pipedrive-python-lib-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a098466ad9861303e618e02dbd506529",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6873,
            "upload_time": "2019-09-16T17:09:14",
            "url": "https://files.pythonhosted.org/packages/4f/54/9697a12bc64d4a5d017dc085b49a73f06ad07742c9694d4d0574c3660b28/pipedrive-python-lib-1.1.0.tar.gz"
        }
    ]
}