Metadata-Version: 2.0
Name: mailchimp3
Version: 1.0.17
Summary: A python client for v3 of MailChimp API
Home-page: https://github.com/charlesthk/python-mailchimp
Author: Charles TISSIER
Author-email: charles@vingtcinq.io
License: MIT
Keywords: mailchimp api v3 client wrapper
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Requires-Dist: requests

|mailchimp3 v1.0.17 on PyPi| |MIT license| |Stable|

python-mailchimp-api
====================

A python client for v3 of MailChimp API

About
-----

This package aims to provide a straighforward python client to interact
with Mailchimp API v3.

Installation
------------

This client is hosted at PyPi under the name ``mailchimp3``, to install
it, simply run

``pip install mailchimp3``

Dependencies
------------

requests >= 2.7.0

Examples
--------

::

    from mailchimp3 import MailChimp

    client = MailChimp('YOUR USERNAME', 'YOUR SECRET KEY')

    client.list.all()  # returns all the lists
    client.list.get('123456')  # returns the list matching id '123456'
    client.campaign.all() # returns all the campaigns

Usage
-----

Authorized Apps
~~~~~~~~~~~~~~~

::

    client.authorizedapp.all()
    client.authorizedapp.get(app_id='')

Automation
~~~~~~~~~~

Automation
^^^^^^^^^^

::

    client.automation.all()
    client.automation.get(workflow_id='')
    client.automation.pause(workflow_id='')
    client.automation.start(workflow_id='')

Automation Email
^^^^^^^^^^^^^^^^

::

    client.automationemail.all(workflow_id='')
    client.automationemail.get(workflow_id='', email_id='')
    client.automationemail.pause(workflow_id='', email_id='')
    client.automationemail.start(workflow_id='', email_id='')

Automation Email Queue
^^^^^^^^^^^^^^^^^^^^^^

::

    client.automationemailqueue.all(workflow_id='', email_id='')
    client.automationemailqueue.get(workflow_id='', email_id='', member_id='')
    client.automationemailqueue.create(workflow_id='', email_id='', data='')

Automation Removed Subscribers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

    client.automationeremovedsubscriber.all(workflow_id='')
    client.automationeremovedsubscriber.create(workflow_id='', data='')

Campaign
~~~~~~~~

Campaign
^^^^^^^^

::

    client.campaign.all()
    client.campaign.create(data={})
    client.campaign.get(campaign_id='')
    client.campaign.delete(campaign_id='')
    client.campaign.patch(campaign_id='', data={})
    client.campaign.cancel(campaign_id='')
    client.campaign.get_content(campaign_id='', **kwargs)
    client.campaign.set_content(campaign_id='', data={})

Campaigns feedback
^^^^^^^^^^^^^^^^^^

::

    client.feedback.all(campaign_id='')
    client.feedback.create(campaign_id='', data={})
    client.feedback.get(campaign_id='', feedback_id='')
    client.feedback.update(campaign_id='', feedback_id='', data={})
    client.feedback.delete(campaign_id='', feedback_id='')

Conversations
~~~~~~~~~~~~~

::

    client.conversation.all()
    client.conversation.get(conversation_id='')

Files
~~~~~

::

    client.file.all()
    client.file.create(data='')

Interest
~~~~~~~~

::

    client.interest.all(list_id, category_id, count=100)
    client.interest.create(list_id, category_id, post_data)
    client.interest.get(list_id, category_id, interest_id)
    client.interest.update(list_id, category_id, interest_id, post_data)
    client.interest.delet

.. |mailchimp3 v1.0.17 on PyPi| image:: https://img.shields.io/badge/pypi-1.0.17-green.svg
   :target: https://pypi.python.org/pypi/mailchimp3
.. |MIT license| image:: https://img.shields.io/badge/licence-MIT-blue.svg
.. |Stable| image:: https://img.shields.io/badge/status-stable-green.svg

