bf_ruby2 1.2016.229

data/docs/VaultedgatewaysApi.md

@@ -0,0 +1,648 @@
+# BillForward::VaultedgatewaysApi
+
+All URIs are relative to *https://localhost:8080/RestAPI*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_authorize_net_token**](VaultedgatewaysApi.md#create_authorize_net_token) | **POST** /vaulted-gateways/authorize-net | Create an authorize-net-token.
+[**create_braintree_token**](VaultedgatewaysApi.md#create_braintree_token) | **POST** /vaulted-gateways/braintree | Create a braintree-token.
+[**create_stripe_ach_token**](VaultedgatewaysApi.md#create_stripe_ach_token) | **POST** /vaulted-gateways/stripe-ACH | Create a stripe-ACH-token.
+[**create_stripe_token**](VaultedgatewaysApi.md#create_stripe_token) | **POST** /vaulted-gateways/stripe | Create a stripe-token.
+[**create_trust_commerce_token**](VaultedgatewaysApi.md#create_trust_commerce_token) | **POST** /vaulted-gateways/trustCommerce | Create a trust-commerce-token.
+[**get_braintree_by_account_id**](VaultedgatewaysApi.md#get_braintree_by_account_id) | **GET** /vaulted-gateways/braintree/{accountID} | Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter.
+[**get_by_card_details_id**](VaultedgatewaysApi.md#get_by_card_details_id) | **GET** /vaulted-gateways/stripe/card-details-id/{cardDetailsID} | Returns a single stripe-token, specified by the cardDetailsID parameter.
+[**get_stripe_ach**](VaultedgatewaysApi.md#get_stripe_ach) | **GET** /vaulted-gateways/stripe-ACH/{stripeACHTokenID} | Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter.
+[**get_stripe_token**](VaultedgatewaysApi.md#get_stripe_token) | **GET** /vaulted-gateways/stripe/{stripeTokenID} | Returns a single stripe-token, specified by the stripeTokenID parameter.
+[**update_stripe_ach_token**](VaultedgatewaysApi.md#update_stripe_ach_token) | **PUT** /vaulted-gateways/stripe-ACH | Update a stripe-ACH-token.
+[**update_stripe_token**](VaultedgatewaysApi.md#update_stripe_token) | **PUT** /vaulted-gateways/stripe | Update a stripe-token.
+[**verify_bank_account**](VaultedgatewaysApi.md#verify_bank_account) | **POST** /vaulted-gateways/stripe/verify-bank-account | Verify Stripe bank account.
+[**webhook**](VaultedgatewaysApi.md#webhook) | **POST** /vaulted-gateways/stripe/webhook | Receive and handle webhook from Stripe.
+
+
+# **create_authorize_net_token**
+> AuthorizeNetTokenPagedMetadata create_authorize_net_token(authorize_net_token)
+
+Create an authorize-net-token.
+
+{\"nickname\":\"Create a authorize-net-token\",\"request\":\"createAuthorizeNetTokenRequest.html\",\"response\":\"createAuthorizeNetTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+authorize_net_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The authorize-net-token object to be created.
+
+
+begin
+  #Create an authorize-net-token.
+  result = api_instance.create_authorize_net_token(authorize_net_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->create_authorize_net_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorize_net_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The authorize-net-token object to be created. | 
+
+### Return type
+
+[**AuthorizeNetTokenPagedMetadata**](AuthorizeNetTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **create_braintree_token**
+> BraintreeTokenPagedMetadata create_braintree_token(braintree_token)
+
+Create a braintree-token.
+
+{\"nickname\":\"Create a braintree-token\",\"request\":\"createBraintreeTokenRequest.html\",\"response\":\"BraintreeTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+braintree_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The braintree-token object to be created.
+
+
+begin
+  #Create a braintree-token.
+  result = api_instance.create_braintree_token(braintree_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->create_braintree_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **braintree_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The braintree-token object to be created. | 
+
+### Return type
+
+[**BraintreeTokenPagedMetadata**](BraintreeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **create_stripe_ach_token**
+> StripeACHTokenPagedMetadata create_stripe_ach_token(stripe_ach_token)
+
+Create a stripe-ACH-token.
+
+{\"nickname\":\"Create a stripe-ACH-token\",\"request\":\"createstripeACHTokenRequest.html\",\"response\":\"createstripeACHTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_ach_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The stripe-ACH-token object to be created.
+
+
+begin
+  #Create a stripe-ACH-token.
+  result = api_instance.create_stripe_ach_token(stripe_ach_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->create_stripe_ach_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_ach_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-ACH-token object to be created. | 
+
+### Return type
+
+[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **create_stripe_token**
+> StripeTokenPagedMetadata create_stripe_token(stripe_token)
+
+Create a stripe-token.
+
+{\"nickname\":\"Create a stripe-token\",\"request\":\"createstripeTokenRequest.html\",\"response\":\"createstripeTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The stripe-token object to be created.
+
+
+begin
+  #Create a stripe-token.
+  result = api_instance.create_stripe_token(stripe_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->create_stripe_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-token object to be created. | 
+
+### Return type
+
+[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **create_trust_commerce_token**
+> TrustCommerceTokenPagedMetadata create_trust_commerce_token(trust_commerce_token)
+
+Create a trust-commerce-token.
+
+{\"nickname\":\"Create a trust-commerce-token\",\"request\":\"createTrustCommerceTokenRequest.html\",\"response\":\"TrustCommerceTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+trust_commerce_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The trust-commerce-token object to be created.
+
+
+begin
+  #Create a trust-commerce-token.
+  result = api_instance.create_trust_commerce_token(trust_commerce_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->create_trust_commerce_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **trust_commerce_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The trust-commerce-token object to be created. | 
+
+### Return type
+
+[**TrustCommerceTokenPagedMetadata**](TrustCommerceTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **get_braintree_by_account_id**
+> BraintreeTokenPagedMetadata get_braintree_by_account_id(account_id, opts)
+
+Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter.
+
+{\"nickname\":\"Retrieve a list of braintree-token\",\"response\":\"getBraintreeByAccountID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+account_id = "account_id_example" # String | The string ID of the account-ID.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2
+}
+
+begin
+  #Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter.
+  result = api_instance.get_braintree_by_account_id(account_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->get_braintree_by_account_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| The string ID of the account-ID. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2 | [optional] 
+
+### Return type
+
+[**BraintreeTokenPagedMetadata**](BraintreeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_by_card_details_id**
+> StripeTokenPagedMetadata get_by_card_details_id(card_details_id, opts)
+
+Returns a single stripe-token, specified by the cardDetailsID parameter.
+
+{\"nickname\":\"Retrieve a stripe-token by cardDetailsID\",\"response\":\"getStripeTokenByCardDetailsID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+card_details_id = "card_details_id_example" # String | The card details id of the stripe-token.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
+}
+
+begin
+  #Returns a single stripe-token, specified by the cardDetailsID parameter.
+  result = api_instance.get_by_card_details_id(card_details_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->get_by_card_details_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **card_details_id** | **String**| The card details id of the stripe-token. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional] 
+
+### Return type
+
+[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_stripe_ach**
+> StripeACHTokenPagedMetadata get_stripe_ach(stripe_ach_token_id, opts)
+
+Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter.
+
+{\"nickname\":\"Retrieve a stripe-ACH-token\",\"response\":\"getStripeACHTokenByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_ach_token_id = "stripe_ach_token_id_example" # String | The string ID of the stripe-ACH-token.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2
+}
+
+begin
+  #Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter.
+  result = api_instance.get_stripe_ach(stripe_ach_token_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->get_stripe_ach: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_ach_token_id** | **String**| The string ID of the stripe-ACH-token. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2 | [optional] 
+
+### Return type
+
+[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **get_stripe_token**
+> StripeTokenPagedMetadata get_stripe_token(stripe_token_id, opts)
+
+Returns a single stripe-token, specified by the stripeTokenID parameter.
+
+{\"nickname\":\"Retrieve a stripe-token\",\"response\":\"getStripeTokenByID.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_token_id = "stripe_token_id_example" # String | The string ID of the stripe-token.
+
+opts = { 
+  organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&organizations=org1&organizations=org2
+}
+
+begin
+  #Returns a single stripe-token, specified by the stripeTokenID parameter.
+  result = api_instance.get_stripe_token(stripe_token_id, opts)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->get_stripe_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_token_id** | **String**| The string ID of the stripe-token. | 
+ **organizations** | [**Array&lt;String&gt;**](String.md)| A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: ...&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2 | [optional] 
+
+### Return type
+
+[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **update_stripe_ach_token**
+> StripeACHTokenPagedMetadata update_stripe_ach_token(stripe_token)
+
+Update a stripe-ACH-token.
+
+{\"nickname\":\"Update a stripe-ACH-token\",\"request\":\"updatestripeACHTokenRequest.html\",\"response\":\"updatestripeACHTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The stripe-ACH-token object to be updated.
+
+
+begin
+  #Update a stripe-ACH-token.
+  result = api_instance.update_stripe_ach_token(stripe_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->update_stripe_ach_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-ACH-token object to be updated. | 
+
+### Return type
+
+[**StripeACHTokenPagedMetadata**](StripeACHTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **update_stripe_token**
+> StripeTokenPagedMetadata update_stripe_token(stripe_token)
+
+Update a stripe-token.
+
+{\"nickname\":\"Update a stripe-token\",\"request\":\"updatestripeTokenRequest.html\",\"response\":\"updatestripeTokenResponse.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+stripe_token = BillForward::MutableBillingEntity.new # MutableBillingEntity | The stripe-token object to be updated.
+
+
+begin
+  #Update a stripe-token.
+  result = api_instance.update_stripe_token(stripe_token)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->update_stripe_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **stripe_token** | [**MutableBillingEntity**](MutableBillingEntity.md)| The stripe-token object to be updated. | 
+
+### Return type
+
+[**StripeTokenPagedMetadata**](StripeTokenPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+
+# **verify_bank_account**
+> BankAccountVerificationPagedMetadata verify_bank_account(bank_account_verification)
+
+Verify Stripe bank account.
+
+{\"nickname\":\"Verify Stripe bank account\",\"response\":\"verifyStripeBankAccount.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+bank_account_verification = BillForward::BillingEntityBase.new # BillingEntityBase | The Bank-Account-Verification object.
+
+
+begin
+  #Verify Stripe bank account.
+  result = api_instance.verify_bank_account(bank_account_verification)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->verify_bank_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **bank_account_verification** | [**BillingEntityBase**](BillingEntityBase.md)| The Bank-Account-Verification object. | 
+
+### Return type
+
+[**BankAccountVerificationPagedMetadata**](BankAccountVerificationPagedMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhook**
+> String webhook(event)
+
+Receive and handle webhook from Stripe.
+
+{\"nickname\":\"Receive Stripe webhook\",\"response\":\"receiveStripeWebhook.html\"}
+
+### Example
+```ruby
+# load the gem
+require 'bf_ruby2'
+
+api_instance = BillForward::VaultedgatewaysApi.new
+
+event = BillForward::Event.new # Event | The event received.
+
+
+begin
+  #Receive and handle webhook from Stripe.
+  result = api_instance.webhook(event)
+  p result
+rescue BillForward::ApiError => e
+  puts "Exception when calling VaultedgatewaysApi->webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **event** | [**Event**](Event.md)| The event received. | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/xml, application/xml, application/json
+
+
+

data/docs/WebhookPagedMetadata.md

@@ -0,0 +1,14 @@
+# BillForward::WebhookPagedMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+**results** | [**Array<MutableBillingEntity>**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} | 
+
+