The new Dwolla API V2 SDK, as generated by this fork of swagger-codegen.
1.0.3
dwolla_swagger is available on RubyGems.
gem install dwolla_swagger
To add as a dependency
echo "gem dwolla_swagger, '~>1.0.0'" >> Gemfile
bundle installTo install directly from source:
git clone https://github.com/Dwolla/dwolla-swagger-ruby
cd dwolla-swagger-ruby
gem build *.gemspec && gem install --local *.gem
OS X users may need to run gem install as a privileged user.
dwolla_swagger 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.
To get started, all you need to set is the access_token and host values.
require 'dwolla_swagger'
DwollaSwagger::Swagger.configure do |config|
config.access_token = 'a token'
config.host = 'api-uat.dwolla.com'
config.base_path = '/'
endNow 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.
my_custies = DwollaSwagger::CustomersApi.list(:limit => 10)
p my_custies.to_bodyTo create a customer, we can either provide a Hash with the expected values, or a CreateCustomer object.
location = DwollaSwagger::CustomersApi.create({:body => {
:firstName => 'Jennifer',
:lastName => 'Smith',
:email => '[email protected]',
:phone => '7188675309'
}})jenny = DwollaSwagger::CreateCustomer.new
jenny.first_name = 'Jennifer'
jenny.last_name = 'Smith'
jenny.email = '[email protected]'
jenny.phone = '7188675309'
location = DwollaSwagger::CustomersApi.create(:body => jenny)location will contain a URL to your newly created resource (HTTP 201 / Location header).
dwolla_swagger contains API modules which allow the user to make requests, as well as models which are DAOs that the library uses to serialize responses.
Each API module is named in accordance to (Dwolla's API Spec and encapsulates all of the documented functionality.
AccountsApiBusinessclassificationsApiCustomersApiDocumentsApiEventsApiFundingsourcesApiRootApiTransfersApiWebhooksApiWebhooksubscriptionsApi
Each model represents the different kinds of requests and responses that can be made with the Dwolla API.
AccountInfoAmountApplicationEventBaseObjectBusinessClassificationBusinessClassificationListResponseCreateCustomerCreateFundingSourceRequestCreateWebhookCustomerCustomerListResponseDocumentDocumentListResponseEventListResponseFundingSourceFundingSourceListResponseHalLinkMoneyTransferTransferListResponseTransferRequestBodyUnitUpdateCustomerVerificationTokenVerifyMicroDepositsRequestWebhookWebhookAttemptWebhookEventListResponseWebhookHeaderWebhookHttpRequestWebhookHttpResponseWebhookListResponseWebhookRetryWebhookRetryRequestListResponseWebhookSubscription
1.0.3
- API schema updated,
RootApinow added. - Changed
auth_tokentoaccess_tokenin compliance with RFC-6749 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.
1.0.1
- API schema updated, new methods in
CustomersApiandTransfersApi
1.0.0
- Initial release.
This wrapper is semantically generated by a fork of swagger-codegen.
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.