Metadata-Version: 1.0
Name: drift-python
Version: 1.0.0
Summary: A Simple Drift API Wrapper.
Home-page: https://github.com/Driftt/drift-python
Author: Drift Engineering
Author-email: driftintegrations@drift.com
License: MIT
Description: # Drift Python
        A [Drift API](https://devdocs.drift.com) wrapper written in Python.
        
        
        ## Getting Started
        To get started run `pip install drift-python`
        
        ```python
        from drift import Drift
        drift = Drift("YOUR ACCESS TOKEN")
        ```
        
        ## Contacts
        Read the docs here: [Contacts API](https://devdocs.drift.com/docs/contact-model).
        
        **Available Methods**
        
        - `drift.contacts.get()`
            - contact_id (required)
            - email (optional)
            - limit (optional)
        
        - `drift.contacts.list()`
            - limit (optional) - defaults to `40` 
            - cursor (optional)
        
        - `drift.contacts.create()`
            - **attributes (required)
            
            Example:
            `drift.contacts.create(email='johndoe@drift.com')` 
            
        - `drift.contacts.update()`
            - contact_id (required)
            - **attributes (required)
        
        - `drift.contacts.delete()`
            - contact_id (required)
            
        - `drift.contacts.add_tags()`
            - contact_id (required)
            - tags (required)
            
            Example:
            ```
            drift.contacts.add_tags(
              conversation_id=1, 
              tags=[{'name': 'My Tag'}]
            )
            ```
            
        - `drift.contacts.remove_tag()`
            - contact_id (required)
            - tag_name (required)
            
        - `drift.contacts.remove_tags_bulk()`
            - contact_id (required)
        
        ## Conversations
        Read the docs here [Conversations API](https://devdocs.drift.com/docs/conversation-overview)
        
        **Available Methods**
        
        - `drift.conversations.get()`
            - conversation_id (required)
            
        - `drift.conversations.list()`
            - limit (optional) - defaults to `50`
            - next_ (optional)
        
        - `drift.conversations.create_message()`
            - conversation_id (required)
            - org_id (required)
            - type (required)
            - edited_message_id (optional)
            - edit_type (optional)
            
            Example:
            ```
            drift.conversations.create_message(
                conversation_id=1,
                org_id=1,
                type='chat'
            )
            ```
            
        - `drift.conversations.get_messages()`
            - conversation_id (required)
            - next_ (optional)
        
        - `drift.conversations.get_attachments()`
            - doc_id (required)
            
        - `drift.conversations.get_metrics()`
            - query (required)
            
            Example:
            ```
            drift.conversations.get_metrics(
                {
                  "metrics": [
                    {
                      "type": "AVG",
                      "property": "numBotMessages"
                    }
                  ],
                  "filters": [
                    {
                      "property": "createdAt",
                      "operation": "BETWEEN",
                      "values": ["2018-01-01", "2018-07-31"]
                    }
                  ]
                }
            )
          
            ```
            
         
        ## Contributors
        - Lemuel Boyce [rhymiz](https://github.com/rhymiz)
        - Chris Buonocore [cbonoz](https://github.com/cbonoz)
        
        
        ## Support / Feedback / Bugs
        For support and feedback, you can find us on [Slack](https://join.slack.com/t/devdrift/shared_invite/enQtMzg4MTI3NDk5NDQ0LWUwMWYzZTkyMmQ1YjdkNjkwZDg2Mzk2YjAyMDg4MWViYmIzZjVhZTczNDQwMDVjOGRjZGU5OTkxMWQ0ZGU0Mjg)!
        
        If you've found a bug, feel free to open up a PR with a fix or submit an issue.
Platform: UNKNOWN
