Metadata-Version: 1.1
Name: emailage-official
Version: 1.0.0
Summary: Emailage API client written in Python
Home-page: https://emailage.com/
Author: Sergey Baev
Author-email: tinbka@gmail.com
License: MIT
Description: |alt text|\ (https://www.emailage.com)
        
        The Emailage™ API is organized around REST (Representational State
        Transfer). The API was built to help companies integrate with our highly
        efficient fraud risk and scoring system. By calling our API endpoints
        and simply passing us an email and/or IP Address, companies will be
        provided with real-time risk scoring assessments based around machine
        learning and proprietary algorithms that evolve with new fraud trends.
        
        Getting Started
        ---------------
        
        Requirements
        ~~~~~~~~~~~~
        
        -  Python 2.7+ or 3.3+
        
        Installation
        ~~~~~~~~~~~~
        
        Emailage can be installed with pip:
        
        ::
        
            $ pip install emailage
        
        or directly from the source code:
        
        ::
        
            $ git clone https://github.com/emailage/Emailage_Python.git
            $ cd Emailage_Python
            $ python setup.py install
        
        Usage
        -----
        
        Instantiate a client
        
        .. code:: python
        
            from emailage.client import EmailageClient
            # For a production server
            emailage = EmailageClient('My account SID', 'My auth token')
            # ... or for a sandbox
            emailage = EmailageClient('My account SID', 'My auth token', sandbox=True)
        
        Query a risk score information for the provided email address, IP
        address, or a combination
        
        .. code:: python
        
            # For an email address
            emailage.query('test@example.com')
            # For an IP address
            emailage.query('127.0.0.1')
            # For a combination. Please note the order
            emailage.query(('test@example.com', '127.0.0.1'))
            # Pass a User Defined Record ID.
            # Can be used when you want to add an identifier for a query.
            # The identifier will be displayed in the result.
            emailage.query('test@example.com', urid='My record ID for test@example.com')
        
        Explicit methods produce the same request while validating format of the
        arguments passed
        
        .. code:: python
        
            # For an email address
            emailage.query_email('test@example.com')
            # For an IP address
            emailage.query_ip_address('127.0.0.1')
            # For a combination. Please note the order
            emailage.query_email_and_ip_address('test@example.com', '127.0.0.1')
            # Pass a User Defined Record ID
            emailage.query_email_and_ip_address('test@example.com', '127.0.0.1', urid='My record ID for test@example.com and 127.0.0.1')
        
        | Mark an email address as fraud, good, or neutral.
        | All the listed forms are possible.
        | When you mark something as fraud, don't forget to pass a fraud code number from this list:
        | 1 - Card Not Present Fraud
        | 2 - Customer Dispute (Chargeback)
        | 3 - First Party Fraud
        | 4 - First Payment Default
        | 5 - Identify Theft (Fraud Application)
        | 6 - Identify Theft (Account Take Over)
        | 7 - Suspected Fraud (Not Confirmed)
        | 8 - Synthetic ID
        | 9 - Other
        
        .. code:: python
        
            # Mark an email address as fraud because of Synthetic ID.
            emailage.flag('fraud', 'test@example.com', 8)
            emailage.flag_as_fraud('test@example.com', 8)
            # Mark an email address as good.
            emailage.flag('good', 'test@example.com')
            emailage.flag_as_good('test@example.com')
            # Unflag an email address that was previously marked as good or fraud.
            emailage.flag('neutral', 'test@example.com')
            emailage.remove_flag('test@example.com')
        
        Exceptions
        ~~~~~~~~~~
        
        This gem can throw exceptions on any of the following issues:
        
        #. When Requests has an issue, like not being able to connect from your
           server to Emailage API,
        #. When bad formatted JSON is received,
        #. When an incorrect email or IP address is passed to a flagging or
           explicitly querying method.
        
        .. |alt text| image:: https://emailage.com/Content/Images/logo.svg
        
        2.0.0
        ~~~~~~~~~~~~
        
        The revision is created from scratch for the new API version.
        
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
