transferzero-sdk 1.0.0

data/docs/DebitListResponse.md

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

data/docs/DebitRequest.md

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

data/docs/DebitRequestWrapper.md

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

data/docs/DebitResponse.md

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

data/docs/Document.md

@@ -0,0 +1,35 @@
+# TransferZero::Document
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
+**upload_file_name** | **String** | Name of the upload | 
+**metadata** | [**Object**](.md) | Metadata of document | [optional] 
+**upload_content_type** | **String** |  | [optional] 
+**upload_file_size** | **Integer** |  | [optional] 
+**category** | **String** | uncategorised | [optional] 
+**side** | **String** | The side of the KYC ID. One of 'front' or 'back' | [optional] 
+**issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional] 
+**id** | **String** |  | [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::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+                                 upload_file_name: example.png,
+                                 metadata: {},
+                                 upload_content_type: image/png,
+                                 upload_file_size: 30255,
+                                 category: null,
+                                 side: null,
+                                 issuing_country: NG,
+                                 id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+```
+
+

data/docs/DocumentListResponse.md

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

data/docs/DocumentRequest.md

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

data/docs/DocumentResponse.md

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

data/docs/DocumentWebhook.md

@@ -0,0 +1,21 @@
+# TransferZero::DocumentWebhook
+
+## 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** | [**Document**](Document.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::DocumentWebhook.new(webhook: b2f574ff-7efe-4579-9f16-fcb9097e5ab6,
+                                 event: transaction.paid,
+                                 object: null)
+```
+
+

data/docs/DocumentsApi.md

@@ -0,0 +1,199 @@
+# TransferZero::DocumentsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_document**](DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
+[**get_documents**](DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
+[**post_documents**](DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
+
+
+# **get_document**
+> DocumentResponse get_document(document_id)
+
+Fetching a document
+
+Returns a single document by the Documents ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DocumentsApi.new
+
+
+begin
+  #Fetching a document
+  result = api_instance.get_document(document_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DocumentResponse")
+    p result
+  else
+    puts "Exception when calling DocumentsApi->get_document: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document_id** | [**String**](.md)| ID of the document to get.  Example: `/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.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_documents**
+> DocumentListResponse get_documents(opts)
+
+Getting a list of documents
+
+Fetches a list of documents.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DocumentsApi.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
+  #Getting a list of documents
+  result = api_instance.get_documents(opts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DocumentListResponse")
+    p result
+  else
+    puts "Exception when calling DocumentsApi->get_documents: #{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
+
+[**DocumentListResponse**](DocumentListResponse.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_documents**
+> DocumentResponse post_documents(document_request)
+
+Creating a document
+
+Creates a new document
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DocumentsApi.new
+
+
+begin
+  #Creating a document
+  result = api_instance.post_documents(document_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DocumentResponse")
+    p result
+  else
+    puts "Exception when calling DocumentsApi->post_documents: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document_request** | [**DocumentRequest**](DocumentRequest.md)|  | 
+
+### Return type
+
+[**DocumentResponse**](DocumentResponse.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
+
+
+

data/docs/ErrorStatus.md

@@ -0,0 +1,19 @@
+# TransferZero::ErrorStatus
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **Integer** |  | [optional] 
+**error** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ErrorStatus.new(status: null,
+                                 error: null)
+```
+
+

data/docs/FieldDescription.md

@@ -0,0 +1,19 @@
+# TransferZero::FieldDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | the type of the field. | [optional] 
+**validations** | [**FieldValidation**](FieldValidation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::FieldDescription.new(type: input,
+                                 validations: null)
+```
+
+

data/docs/FieldSelectValidation.md

@@ -0,0 +1,19 @@
+# TransferZero::FieldSelectValidation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_in** | [**Object**](.md) | Describes the valid options for this selectbox | [optional] 
+**allow_blank** | **Boolean** | Describes whether the field is optional or not | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::FieldSelectValidation.new(_in: {"20":"Current","10":"Savings"},
+                                 allow_blank: null)
+```
+
+