transferzero-sdk 1.0.0

data/docs/ValidationErrorDescription.md

@@ -0,0 +1,17 @@
+# TransferZero::ValidationErrorDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | Describes what the problem is with the field | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ValidationErrorDescription.new(error: invalid)
+```
+
+

data/docs/Webhook.md

@@ -0,0 +1,21 @@
+# TransferZero::Webhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **String** | The ID of the webhook that was used to send out this callback | 
+**event** | **String** | The event that triggered this webhook | 
+**object** | [**Object**](.md) | The returned object | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Webhook.new(webhook: b2f574ff-7efe-4579-9f16-fcb9097e5ab6,
+                                 event: transaction.paid,
+                                 object: null)
+```
+
+

data/docs/WebhookDefinition.md

@@ -0,0 +1,25 @@
+# TransferZero::WebhookDefinition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The URL to receive the webhook | 
+**events** | **Array<String>** | A list of events to subscribe to | 
+**metadata** | [**Object**](.md) |  | [optional] 
+**id** | **String** | The ID of the webhook | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookDefinition.new(url: http://webhook.site/webhooks,
+                                 events: null,
+                                 metadata: {},
+                                 id: 1cd580b2-2a1b-4f73-81c8-0308308baef2,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+```
+
+

data/docs/WebhookDefinitionEventListResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::WebhookDefinitionEventListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookDefinitionEventListResponse.new(object: null)
+```
+
+

data/docs/WebhookDefinitionListResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::WebhookDefinitionListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<WebhookDefinition>**](WebhookDefinition.md) |  | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookDefinitionListResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/WebhookDefinitionRequest.md

@@ -0,0 +1,17 @@
+# TransferZero::WebhookDefinitionRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | [**WebhookDefinition**](WebhookDefinition.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookDefinitionRequest.new(webhook: null)
+```
+
+

data/docs/WebhookDefinitionResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::WebhookDefinitionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**WebhookDefinition**](WebhookDefinition.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookDefinitionResponse.new(object: null)
+```
+
+

data/docs/WebhookLog.md

@@ -0,0 +1,27 @@
+# TransferZero::WebhookLog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the webhook log | [optional] 
+**message** | **String** | Message detailing webhook event | [optional] 
+**metadata** | [**WebhookLogMetadata**](WebhookLogMetadata.md) |  | [optional] 
+**created_at** | **String** | Date and time of response | [optional] 
+**parent_id** | **String** |  | [optional] 
+**parent_type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLog.new(id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 message: Transaction(a0696374-de2f-4b4e-a2d7-cb4e0a1240c0) transaction.mispaid pending!,
+                                 metadata: null,
+                                 created_at: 2018-12-31T23:59:50.059+0000,
+                                 parent_id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 parent_type: Webhook)
+```
+
+

data/docs/WebhookLogListResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::WebhookLogListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<WebhookLog>**](WebhookLog.md) | Array of webhook log objects | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLogListResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/WebhookLogMetadata.md

@@ -0,0 +1,35 @@
+# TransferZero::WebhookLogMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**params** | [**WebhookDefinition**](WebhookDefinition.md) |  | [optional] 
+**event** | **String** | Specific event that triggered the webhook | [optional] 
+**instance_id** | **String** | Instance ID of the webhook event | [optional] 
+**instance_type** | **String** | Type of instance event | [optional] 
+**attempt_id** | **String** | Attempt ID | [optional] 
+**tries** | **Integer** | Number of tries at the point webhook was triggered | [optional] 
+**request** | [**WebhookLogMetadataRequest**](WebhookLogMetadataRequest.md) |  | [optional] 
+**response** | [**WebhookLogMetadataResponse**](WebhookLogMetadataResponse.md) |  | [optional] 
+**app_id** | **String** | ID of app on which webhook event was triggered | [optional] 
+**api_key_id** | **String** | ID of API key in use at point of webhook event | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLogMetadata.new(params: null,
+                                 event: transaction.mispaid,
+                                 instance_id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 instance_type: Transaction,
+                                 attempt_id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 tries: 15,
+                                 request: null,
+                                 response: null,
+                                 app_id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 api_key_id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0)
+```
+
+

data/docs/WebhookLogMetadataRequest.md

@@ -0,0 +1,21 @@
+# TransferZero::WebhookLogMetadataRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**headers** | **Hash<String, String>** |  | [optional] 
+**body** | **String** | The body that was sent in the webhook | [optional] 
+**url** | **String** | Webhook URL | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLogMetadataRequest.new(headers: {"Content-Type":"application/json","Authorization-Nonce":"a0696374-de2f-4b4e-a2d7-cb4e0a1240c0","Authorization-Key":"a0696374-de2f-4b4e-a2d7-cb4e0a1240c0","Authorization-Signature":"a0696374-de2f-4b4e-a2d7-cb4e0a1240c0","Accept-Encoding":"gzip;q=1.0,deflate;q=0.6,identity;q=0.3","Accept":"*/*","User-Agent":"Ruby","Host":"localhost:3000","Content-Length":"3549"},
+                                 body: {"webhook":"54cbd6f2-b920-41e9-a225-b1000e024787","event":"transaction.mispaid","object":{"id":"cbcea909-85e3-448f-bd07-b9ecdff6e971"}},
+                                 url: http://localhost:3000)
+```
+
+

data/docs/WebhookLogMetadataResponse.md

@@ -0,0 +1,21 @@
+# TransferZero::WebhookLogMetadataResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Full body of response | [optional] 
+**headers** | **Hash<String, String>** | Headers delivered with webhook response | [optional] 
+**status** | **String** | Status of response | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLogMetadataResponse.new(body: <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <title>Action Controller: Exception caught</title>,
+                                 headers: {"date":"Fri, 11 Jan 2019 09:00:00 GMT","connection":"close","content-type":"text/html; charset=utf-8","x-web-console-session-id":"a0696374-de2f-4b4e-a2d7-cb4e0a1240c0","x-web-console-mount-point":"/__web_console","x-request-id":"a0696374-de2f-4b4e-a2d7-cb4e0a1240c0","x-runtime":"0.484015","content-length":"145453"},
+                                 status: 500)
+```
+
+

data/docs/WebhookLogResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::WebhookLogResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**WebhookLog**](WebhookLog.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::WebhookLogResponse.new(object: null)
+```
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,319 @@
+# TransferZero::WebhooksApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{Webhook ID} | Unsubscribing from a webhook
+[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{Webhook ID} | Find a webhook's details
+[**get_webhook_events**](WebhooksApi.md#get_webhook_events) | **GET** /webhooks/events | Find possible webhook events
+[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Listing webhooks
+[**post_webhooks**](WebhooksApi.md#post_webhooks) | **POST** /webhooks | Creating a webhook
+
+
+# **delete_webhook**
+> WebhookDefinitionResponse delete_webhook(webhook_id)
+
+Unsubscribing from a webhook
+
+Unsubscribes from a webhook specified
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::WebhooksApi.new
+
+
+begin
+  #Unsubscribing from a webhook
+  result = api_instance.delete_webhook(webhook_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| The ID of webhook to cancel.  Example: `/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33` | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_webhook**
+> WebhookDefinitionResponse get_webhook(webhook_id)
+
+Find a webhook's details
+
+Look up a webhook's details with its ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::WebhooksApi.new
+
+
+begin
+  #Find a webhook's details
+  result = api_instance.get_webhook(webhook_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhook: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | [**String**](.md)| The ID of the Webhook to look up  Example: &#x60;/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60; | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_webhook_events**
+> WebhookDefinitionEventListResponse get_webhook_events
+
+Find possible webhook events
+
+Fetching possible webhook events
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::WebhooksApi.new
+
+begin
+  #Find possible webhook events
+  result = api_instance.get_webhook_events
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionEventListResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhook_events: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebhookDefinitionEventListResponse**](WebhookDefinitionEventListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_webhooks**
+> WebhookDefinitionListResponse get_webhooks(opts)
+
+Listing webhooks
+
+Get a list of created webhooks
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::WebhooksApi.new
+
+opts = { 
+  page: 1 # Integer | The page number to request (defaults to 1)
+  per: 10 # Integer | The number of results to load per page (defaults to 10)
+}
+
+begin
+  #Listing webhooks
+  result = api_instance.get_webhooks(opts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionListResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhooks: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page number to request (defaults to 1) | [optional] 
+ **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
+
+### Return type
+
+[**WebhookDefinitionListResponse**](WebhookDefinitionListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_webhooks**
+> WebhookDefinitionResponse post_webhooks(webhook_definition_request)
+
+Creating a webhook
+
+Creates a new webhook, subscribing the provided endpoint to the specified event(s) 
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::WebhooksApi.new
+
+
+begin
+  #Creating a webhook
+  result = api_instance.post_webhooks(webhook_definition_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->post_webhooks: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_definition_request** | [**WebhookDefinitionRequest**](WebhookDefinitionRequest.md)|  | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+