This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
dwolla-swagger-python
=====================

The new Dwolla API V2 SDK, as generated by `this fork of
swagger-codegen <https: github.com="" mach-kernel="" swagger-codegen="">`__.

Version
-------

1.0.9

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

``dwollaswagger`` is available on
`PyPi <https: pypi.python.org="" pypi="" dwollaswagger="">`__, and therefore can
be installed automagically via
`pip <https: pip.pypa.io="" en="" latest="" installing.html="">`__.

*To install via pip:*

::

pip install dwollaswagger

*To add to ``requirements.txt`` and make this a permanent dependency of
your package:*

.. code:: requirements.txt

YourApp
SomeLibrary==1.2.3
dwollaswagger>=1.0.0

::

pip install -r requirements.txt

*To install directly from source:*

::

git clone https://github.com/Dwolla/dwolla-swagger-python && cd dwolla-swagger-python && python setup.py install

*OS X users may need to run ``setup.py`` as a privileged user.*

Quickstart
----------

``dwollaswagger`` makes it easy for developers to hit the ground running
with our API. Before attempting the following, you should ideally create
`an application key and secret <https: www.dwolla.com="" applications="">`__.

Configuring a client
~~~~~~~~~~~~~~~~~~~~

To get started, all you need to set is the ``access_token`` and ``host``
values.

.. code:: python

dwollaswagger.configuration.access_token = 'token'

# For UAT/Sandbox
client = dwollaswagger.ApiClient('https://api-uat.dwolla.com')

# For Production
client = dwollaswagger.ApiClient('https://api.dwolla.com')

List 10 customers
~~~~~~~~~~~~~~~~~

Now that we've set up our client, we can use it to make requests to the
API. Let's retrieve 10 customer records associated with the
authorization token used.

.. code:: python

dwollaswagger.configuration.access_token = 'token'
client = dwollaswagger.ApiClient('https://api-uat.dwolla.com')

customers_api = dwollaswagger.CustomersApi(client)
my_custies = customers_api.list(limit=10)

``my_custies`` will be a Python list that consists of ``Customer``
objects.

Creating a new customer
~~~~~~~~~~~~~~~~~~~~~~~

To create a customer, we can either provide a ``dict`` with the expected
values, or a ``CreateCustomer`` object.

.. code:: python

customers_api = dwollaswagger.CustomersApi(client)

location = customers_api.create(body = {
'firstName': "Jennifer",
'lastName': "Smith",
'email': "jsmith@gmail.com",
'phone': "7188675309"})

or
^^

.. code:: python

customers_api = dwollaswagger.CustomersApi(client)

new_cust = dwollaswagger.CreateCustomer
new_cust.first_name = "Jennifer"
new_cust.last_name = "Smith"
new_cust.email = "jsmith@gmail.com"
new_cust.phone = "7188675309"

location = customers_api.create(body=new_cust)

``location`` will contain a URL to your newly created resource (HTTP 201
/ Location header).

Modules
-------

``dwolla-python-swagger`` contains ``API`` modules which allow the user
to make requests, as well as ``models`` which are
`DAOs <https: en.wikipedia.org="" wiki="" data_access_object="">`__ that the
library uses to serialize responses.

API
~~~

Each API module is named in accordance to (`Dwolla's API
Spec <http: docsv2.dwolla.com=""/>`__ and encapsulates all of the
documented functionality.

- ``AccountsApi``
- ``BusinessclassificationsApi``
- ``CustomersApi``
- ``DocumentsApi``
- ``EventsApi``
- ``FundingsourcesApi``
- ``RootApi``
- ``TransfersApi``
- ``WebhooksApi``
- ``WebhooksubscriptionsApi``

--------------

API objects take an ``ApiClient`` argument, which you created
`here <##Configuring%20a%20client>`__.

Example
^^^^^^^

.. code:: python

doc_api = dwollaswagger.DocumentsApi(your_client_object)

Models
~~~~~~

Each model represents the different kinds of requests and responses that
can be made with the Dwolla API.

- ``AccountInfo``
- ``Amount``
- ``ApplicationEvent``
- ``BaseObject``
- ``BusinessClassification``
- ``BusinessClassificationListResponse``
- ``CreateCustomer``
- ``CreateFundingSourceRequest``
- ``CreateWebhook``
- ``Customer``
- ``CustomerListResponse``
- ``Document``
- ``DocumentListResponse``
- ``EventListResponse``
- ``FundingSource``
- ``FundingSourceListResponse``
- ``HalLink``
- ``Money``
- ``Transfer``
- ``TransferListResponse``
- ``TransferRequestBody``
- ``Unit``
- ``UpdateCustomer``
- ``VerificationToken``
- ``VerifyMicroDepositsRequest``
- ``Webhook``
- ``WebhookAttempt``
- ``WebhookEventListResponse``
- ``WebhookHeader``
- ``WebhookHttpRequest``
- ``WebhookHttpResponse``
- ``WebhookListResponse``
- ``WebhookRetry``
- ``WebhookRetryRequestListResponse``
- ``WebhookSubscription``

README
------

In order for the library's README file to display nicely on PyPi, we
must use the ``*.rst`` file format. When making changes to this README
file, please `use this tool <http: johnmacfarlane.net="" pandoc="" try=""/>`__
to convert the ``*.md`` file to ``*.rst``, and make sure to keep both
files updated.

Changelog
---------

1.0.9 \* API schema updated, ``CustomersAPI`` supports Customer search,
new softDelete method in ``FundingSourcesApi``.

1.0.8 \* API schema updated, new ``MasspaymentsApi`` and
``MasspaymentitemsApi``. New ``MassPayment`` and ``MassPaymentItem``
models.

1.0.7 \* API schema updated, ``TransfersApi`` has new endpoints for
cancel a transfer and get a transfer’s fees, new
``OndemandauthorizationsApi``. \* Existing ``MicroDeposits`` and
``Documents`` models updated, new ``FacilitatorFeeRequest``,
``Authorization``, and ``UpdateTransfer`` models.

1.0.6 \* Patch datetime issue in Models.

1.0.5 \* API schema error fixed, ``FundingSource`` object now has
``_embedded`` key to fix serialization issues.

1.0.4 \* API schema updated, ``CustomersApi`` has new endpoints for IAV
verification. \* Existing ``Customer`` related models updated, new
``VerificationToken`` model. \* (release skipped, features in 1.0.5)

1.0.3 \* API schema updated, ``RootApi`` now added. \* Changed
``auth_token`` to ``access_token`` in compliance with
`RFC-6749 <https: tools.ietf.org="" html="" rfc6749="">`__ recommended
nomenclature.

1.0.2 \* API schema updated, new methods in ``FundingsourcesApi``. \*
All methods which take Swagger variables in ``path`` (e.g,
``/resource/{id}``) can now be passed a resource URL to make it easier
for HAL-styled API consumption. \* More idiomatic response logic for
HTTP 201 responses. \* Fix syntax error in README

1.0.1 \* API schema updated, new methods in ``CustomersApi`` and
``TransfersApi``

1.0.0 \* Initial release.

Credits
-------

This wrapper is semantically generated by a fork of
`swagger-codegen <http: github.com="" mach-kernel="" swagger-codegen="">`__. -
`swagger-codegen
contributors <https: github.com="" swagger-api="" swagger-codegen="" network="" members="">`__
- `David Stancu <http: github.com="" mach-kernel="">`__

License
-------

Copyright 2015 Swagger Contributors, David Stancu

Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at

::

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Release History

Release History

1.0.9

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.8

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.7

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.6

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.5

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
dwollaswagger-1.0.9-py2-none-any.whl (91.1 kB) Copy SHA256 Checksum SHA256 2.7 Wheel May 3, 2016
dwollaswagger-1.0.9.tar.gz (20.7 kB) Copy SHA256 Checksum SHA256 Source May 3, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting