checkbook 1.0.1

data/docs/Wire.md

@@ -0,0 +1,290 @@
+# Checkbook::Wire
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_wire**](Wire.md#add_wire) | **POST** /v3/account/wire | Create wire account |
+| [**get_wire**](Wire.md#get_wire) | **GET** /v3/account/wire | Get wire accounts |
+| [**put_wire**](Wire.md#put_wire) | **PUT** /v3/account/wire/{account_id} | Update Wire account |
+| [**remove_wire**](Wire.md#remove_wire) | **DELETE** /v3/account/wire/{wire_id} | Remove wire account |
+
+
+## add_wire
+
+> <WireAccountResponse> add_wire(create_wire_request)
+
+Create wire account
+
+Create a new wire account
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Wire.new
+create_wire_request = Checkbook::CreateWireRequest.new({account: '428100000', routing: '021000021', type: 'CHECKING'}) # CreateWireRequest | 
+
+begin
+  # Create wire account
+  result = api_instance.add_wire(create_wire_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->add_wire: #{e}"
+end
+```
+
+#### Using the add_wire_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WireAccountResponse>, Integer, Hash)> add_wire_with_http_info(create_wire_request)
+
+```ruby
+begin
+  # Create wire account
+  data, status_code, headers = api_instance.add_wire_with_http_info(create_wire_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WireAccountResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->add_wire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_wire_request** | [**CreateWireRequest**](CreateWireRequest.md) |  |  |
+
+### Return type
+
+[**WireAccountResponse**](WireAccountResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_wire
+
+> <GetWireResponse> get_wire
+
+Get wire accounts
+
+Return the wire accounts
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Wire.new
+
+begin
+  # Get wire accounts
+  result = api_instance.get_wire
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->get_wire: #{e}"
+end
+```
+
+#### Using the get_wire_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWireResponse>, Integer, Hash)> get_wire_with_http_info
+
+```ruby
+begin
+  # Get wire accounts
+  data, status_code, headers = api_instance.get_wire_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWireResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->get_wire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetWireResponse**](GetWireResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## put_wire
+
+> put_wire(account_id, update_wire_request)
+
+Update Wire account
+
+Update an existing wire account
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Wire.new
+account_id = 'account_id_example' # String | 
+update_wire_request = Checkbook::UpdateWireRequest.new # UpdateWireRequest | 
+
+begin
+  # Update Wire account
+  api_instance.put_wire(account_id, update_wire_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->put_wire: #{e}"
+end
+```
+
+#### Using the put_wire_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> put_wire_with_http_info(account_id, update_wire_request)
+
+```ruby
+begin
+  # Update Wire account
+  data, status_code, headers = api_instance.put_wire_with_http_info(account_id, update_wire_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->put_wire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** |  |  |
+| **update_wire_request** | [**UpdateWireRequest**](UpdateWireRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remove_wire
+
+> remove_wire(wire_id)
+
+Remove wire account
+
+Remove an existing wire account
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Wire.new
+wire_id = 'wire_id_example' # String | 
+
+begin
+  # Remove wire account
+  api_instance.remove_wire(wire_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->remove_wire: #{e}"
+end
+```
+
+#### Using the remove_wire_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> remove_wire_with_http_info(wire_id)
+
+```ruby
+begin
+  # Remove wire account
+  data, status_code, headers = api_instance.remove_wire_with_http_info(wire_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wire->remove_wire_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wire_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+