Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
sausman committed May 26, 2017
1 parent f89d3c9 commit 913489f
Showing 1 changed file with 20 additions and 17 deletions.
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
dwolla-swagger-php
=========

The new Dwolla API V2 SDK, as generated by [this fork of swagger-codegen](https://github.com/mach-kernel/swagger-codegen).
The new Dwolla API V2 SDK, as generated by [this fork of swagger-codegen](https://github.com/mach-kernel/swagger-codegen).

## Version

1.0.12
1.0.13

## Installation

`DwollaSwagger` is available on [Packagist](https://packagist.org/packages/dwolla/dwollaswagger), and can therefore be installed with [Composer](https://getcomposer.org/).
`DwollaSwagger` is available on [Packagist](https://packagist.org/packages/dwolla/dwollaswagger), and can therefore be installed with [Composer](https://getcomposer.org/).

```
composer require dwolla/dwollaswagger
Expand All @@ -27,7 +27,7 @@ require('../path/to/vendor/autoload.php');

### Configuring a client

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

```php
DwollaSwagger\Configuration::$access_token = 'a token';
Expand All @@ -41,7 +41,7 @@ $apiClient = new 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.
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.

```php
DwollaSwagger\Configuration::$access_token = 'a token';
Expand All @@ -53,7 +53,7 @@ $myCusties = $customersApi->_list(10);

### Creating a new customer

To create a customer, we can either provide an (associative) `array` with the expected values, or a `CreateCustomer` object.
To create a customer, we can either provide an (associative) `array` with the expected values, or a `CreateCustomer` object.

```php
$location = $customersApi->create([
Expand All @@ -64,7 +64,7 @@ $location = $customersApi->create([
]);
```

#### or
#### or

```php
$jenny = new DwollaSwagger\CreateCustomer();
Expand All @@ -80,10 +80,10 @@ $location = $customersApi->create($jenny);

## Modules

`DwollaSwagger` 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.
`DwollaSwagger` 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.
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`
Expand All @@ -100,14 +100,14 @@ Each API module is named in accordance to ([Dwolla's API Spec](http://docsv2.dwo

API objects take an `ApiClient` argument, which you created [here](##Configuring a client).

##### Example
##### Example
```php
$documentsApi = new DwollaSwagger\DocumentsApi($apiClient);
```

### Models

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

* `AccountInfo`
* `Amount`
Expand Down Expand Up @@ -147,6 +147,9 @@ Each model represents the different kinds of requests and responses that can be

## Changelog

1.0.13
* Add control over IPV4 and V6 connections.

1.0.12
* API schema updated, `CustomersApi` updated to allow for null limit, offset, and search. Existing `CreateFundingSourceRequest`, `FundingSource`, `HalLink`, `MicroDepositsInitiated`, `Transfer`, and `TransferRequestBody` models updated. New `Clearing` and `FailureDetails` models.
* Fix README example for creating a Customer.
Expand All @@ -166,18 +169,18 @@ Each model represents the different kinds of requests and responses that can be
* Fix transfer failure to support deserialization with new transfer failure model.

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

1.0.6
* API schema updated, `TransfersApi` has new endpoints for cancel a transfer and get a transfer's fees, new `OndemandauthorizationsApi`, new `MasspaymentsApi`.
* API schema updated, `TransfersApi` has new endpoints for cancel a transfer and get a transfer's fees, new `OndemandauthorizationsApi`, new `MasspaymentsApi`.
* Existing `Document`, `CreateFundingSourceRequest`, and `TransferRequestBody` models updated, new `MassPayment`, `Authorization`, `UpdateTransfer`, and `FacilitatorFeeRequest` models.

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

1.0.4
* Avoid use of function names if found in list of PHP reserved words.
* API schema updated, `CustomersApi` has new endpoints for IAV verification.
* Avoid use of function names if found in list of PHP reserved words.
* 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)

Expand All @@ -198,7 +201,7 @@ Each model represents the different kinds of requests and responses that can be

## Credits

This wrapper is semantically generated by a fork of [swagger-codegen](http://github.com/mach-kernel/swagger-codegen).
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)

Expand Down

0 comments on commit 913489f

Please sign in to comment.