checkbook 1.0.1

data/docs/Invoice.md

@@ -0,0 +1,452 @@
+# Checkbook::Invoice
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_invoice**](Invoice.md#delete_invoice) | **DELETE** /v3/invoice/{invoice_id} | Void an invoice |
+| [**get_invoice**](Invoice.md#get_invoice) | **GET** /v3/invoice/{invoice_id} | Get invoice |
+| [**get_invoice_attachment**](Invoice.md#get_invoice_attachment) | **GET** /v3/invoice/{invoice_id}/attachment | Get attachment for an invoice |
+| [**get_invoices**](Invoice.md#get_invoices) | **GET** /v3/invoice | Get sent/received invoices |
+| [**post_invoice**](Invoice.md#post_invoice) | **POST** /v3/invoice | Create an invoice |
+| [**post_invoice_payment**](Invoice.md#post_invoice_payment) | **POST** /v3/invoice/payment | Pay an invoice |
+
+
+## delete_invoice
+
+> delete_invoice(invoice_id)
+
+Void an invoice
+
+Cancel the specified invoice
+
+### 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::Invoice.new
+invoice_id = 'invoice_id_example' # String | 
+
+begin
+  # Void an invoice
+  api_instance.delete_invoice(invoice_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->delete_invoice: #{e}"
+end
+```
+
+#### Using the delete_invoice_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)> delete_invoice_with_http_info(invoice_id)
+
+```ruby
+begin
+  # Void an invoice
+  data, status_code, headers = api_instance.delete_invoice_with_http_info(invoice_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->delete_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_invoice
+
+> <GetInvoiceResponse> get_invoice(invoice_id)
+
+Get invoice
+
+Get the specified invoice
+
+### 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::Invoice.new
+invoice_id = 'invoice_id_example' # String | 
+
+begin
+  # Get invoice
+  result = api_instance.get_invoice(invoice_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoice: #{e}"
+end
+```
+
+#### Using the get_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetInvoiceResponse>, Integer, Hash)> get_invoice_with_http_info(invoice_id)
+
+```ruby
+begin
+  # Get invoice
+  data, status_code, headers = api_instance.get_invoice_with_http_info(invoice_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetInvoiceResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** |  |  |
+
+### Return type
+
+[**GetInvoiceResponse**](GetInvoiceResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_invoice_attachment
+
+> File get_invoice_attachment(invoice_id)
+
+Get attachment for an invoice
+
+Get the attachment for an invoice
+
+### 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::Invoice.new
+invoice_id = 'invoice_id_example' # String | 
+
+begin
+  # Get attachment for an invoice
+  result = api_instance.get_invoice_attachment(invoice_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoice_attachment: #{e}"
+end
+```
+
+#### Using the get_invoice_attachment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_invoice_attachment_with_http_info(invoice_id)
+
+```ruby
+begin
+  # Get attachment for an invoice
+  data, status_code, headers = api_instance.get_invoice_attachment_with_http_info(invoice_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoice_attachment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## get_invoices
+
+> <GetInvoicesResponse> get_invoices(opts)
+
+Get sent/received invoices
+
+Get sent/received invoices
+
+### 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::Invoice.new
+opts = {
+  direction: 'INCOMING', # String | Direction
+  end_date: Date.parse('2013-10-20'), # Date | End date
+  page: 56, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'q_example', # String | Query
+  sort: '+NUMBER', # String | Sort
+  start_date: Date.parse('2013-10-20'), # Date | Start date
+  status: 'PAID' # String | Status
+}
+
+begin
+  # Get sent/received invoices
+  result = api_instance.get_invoices(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoices: #{e}"
+end
+```
+
+#### Using the get_invoices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetInvoicesResponse>, Integer, Hash)> get_invoices_with_http_info(opts)
+
+```ruby
+begin
+  # Get sent/received invoices
+  data, status_code, headers = api_instance.get_invoices_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetInvoicesResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->get_invoices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direction** | **String** | Direction | [optional] |
+| **end_date** | **Date** | End date | [optional] |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **q** | **String** | Query | [optional] |
+| **sort** | **String** | Sort | [optional] |
+| **start_date** | **Date** | Start date | [optional] |
+| **status** | **String** | Status | [optional] |
+
+### Return type
+
+[**GetInvoicesResponse**](GetInvoicesResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_invoice
+
+> <CreateInvoiceResponse> post_invoice(create_invoice_request)
+
+Create an invoice
+
+Create a new invoice
+
+### 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::Invoice.new
+create_invoice_request = Checkbook::CreateInvoiceRequest.new({amount: 3.56, description: 'description_example', name: 'name_example', recipient: 'recipient_example'}) # CreateInvoiceRequest | 
+
+begin
+  # Create an invoice
+  result = api_instance.post_invoice(create_invoice_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->post_invoice: #{e}"
+end
+```
+
+#### Using the post_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateInvoiceResponse>, Integer, Hash)> post_invoice_with_http_info(create_invoice_request)
+
+```ruby
+begin
+  # Create an invoice
+  data, status_code, headers = api_instance.post_invoice_with_http_info(create_invoice_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateInvoiceResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->post_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_invoice_request** | [**CreateInvoiceRequest**](CreateInvoiceRequest.md) |  |  |
+
+### Return type
+
+[**CreateInvoiceResponse**](CreateInvoiceResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_invoice_payment
+
+> <PayInvoiceResponse> post_invoice_payment(pay_invoice_request)
+
+Pay an invoice
+
+Pay an outstanding invoice
+
+### 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::Invoice.new
+pay_invoice_request = Checkbook::PayInvoiceRequest.new({amount: 3.56, id: 'id_example'}) # PayInvoiceRequest | 
+
+begin
+  # Pay an invoice
+  result = api_instance.post_invoice_payment(pay_invoice_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->post_invoice_payment: #{e}"
+end
+```
+
+#### Using the post_invoice_payment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayInvoiceResponse>, Integer, Hash)> post_invoice_payment_with_http_info(pay_invoice_request)
+
+```ruby
+begin
+  # Pay an invoice
+  data, status_code, headers = api_instance.post_invoice_payment_with_http_info(pay_invoice_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayInvoiceResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Invoice->post_invoice_payment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pay_invoice_request** | [**PayInvoiceRequest**](PayInvoiceRequest.md) |  |  |
+
+### Return type
+
+[**PayInvoiceResponse**](PayInvoiceResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+