transferzero-sdk 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f333393e130ce032c7ae5f25df97e719a671e3f0071aaef40c6c67ad81295473
-  data.tar.gz: 556e231d7edf40381c86bf3dadcf3b3559d9c799976d1f7a4d2ea69e7428094c
+  metadata.gz: c274d3c1799100cc96b0948c818a02e02ade91172cd7b4525c75a9242852d687
+  data.tar.gz: 7746ed2b6081cf788d8a3894ba3f0ccb4b4bfde981ecc9bfeecc8e11f229cc19
 SHA512:
-  metadata.gz: '0100867ae3b2c304d8914632fcccbaf8312e3d16a65dc136c76f868ef3fabd43479b13aeb2aac5323ca18c83ce8504cc6693d289cee1408b8ea868a746ca16bc'
-  data.tar.gz: a9b1c802ff472b829eca858a92d2a252b41ee163d28eb50c740d778c7aa86cf4fef5a48a876cb028e37ca4e4c3c6378826d7663d5c87d58ca0aec7056f680e12
+  metadata.gz: 7506bb914ebae11b793ac2d3a3e57b08c40d8559bf8d51a49cce4b9a281766a29b92a85be9edf8b1fbad2ff5e62e9e9ae2dde355587d9b4d1a4e1d43017dc417
+  data.tar.gz: 85e630486a5f4aa75d1b19de7ba6f57555ddc56947a6a6f178d11a157aee16138b3967df352b91a6d67b6d4fbc7cbd4d499a04221cd00d16145e47569dc629e2

data/README.md

@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.7.0
+- Package version: 1.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.7.0.gem
+gem install ./transferzero-sdk-1.8.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.7.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.8.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.7.0'
+    gem 'transferzero-sdk', '~> 1.8.0'
 
 ### Install from Git
 
@@ -115,6 +115,7 @@ Class | Method | HTTP request | Description
 *TransferZero::CurrencyInfoApi* | [**info_currencies**](docs/CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
 *TransferZero::CurrencyInfoApi* | [**info_currencies_in**](docs/CurrencyInfoApi.md#info_currencies_in) | **GET** /info/currencies/in | Getting a list of possible input currencies
 *TransferZero::CurrencyInfoApi* | [**info_currencies_out**](docs/CurrencyInfoApi.md#info_currencies_out) | **GET** /info/currencies/out | Getting a list of possible output currencies
+*TransferZero::DocumentsApi* | [**delete_document**](docs/DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
 *TransferZero::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
 *TransferZero::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
 *TransferZero::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
@@ -187,7 +188,6 @@ Class | Method | HTTP request | Description
  - [TransferZero::PaginationMeta](docs/PaginationMeta.md)
  - [TransferZero::PayinMethod](docs/PayinMethod.md)
  - [TransferZero::PayinMethodDetails](docs/PayinMethodDetails.md)
- - [TransferZero::PayinMethodDetailsBTC](docs/PayinMethodDetailsBTC.md)
  - [TransferZero::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
  - [TransferZero::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
  - [TransferZero::PayinMethodRequest](docs/PayinMethodRequest.md)
@@ -197,9 +197,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
- - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
- - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)

data/docs/AccountMeta.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::AccountMeta.new(negative_balance: false)
+instance = TransferZero::AccountMeta.new(negative_balance: null)
 ```
 
 

data/docs/Currency.md

@@ -25,7 +25,7 @@ instance = TransferZero::Currency.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

data/docs/CurrencyExchange.md

@@ -26,7 +26,7 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

data/docs/CurrencyOpposite.md

@@ -27,7 +27,7 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
                                  symbol: ₦,
                                  decimals: 2,
                                  subunit_to_unit: 100,
-                                 primary: true,
+                                 primary: null,
                                  min: 100,
                                  max: 50000000,
                                  margin: null,

data/docs/Document.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**sender_id** | **String** |  | [optional] 
 **upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
-**url** | **String** | URL of the document location | [optional] 
 **upload_file_name** | **String** | Name of the upload | 
 **metadata** | [**Object**](.md) | Metadata of document | [optional] 
 **upload_content_type** | **String** |  | [optional] 
@@ -22,8 +22,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
-                                 url: https://bitpesa-documents.amazonaws.com/document.pdf,
+instance = TransferZero::Document.new(sender_id: ebe9bc0b-f2f6-4ce8-802a-8b79912d041e,
+                                 upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
                                  upload_file_name: example.png,
                                  metadata: {},
                                  upload_content_type: image/png,

data/docs/DocumentsApi.md

@@ -4,13 +4,79 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete_document**](DocumentsApi.md#delete_document) | **DELETE** /documents/{Document ID} | Deleting a document
 [**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
 
 
+# **delete_document**
+> DocumentResponse delete_document(document_idopts)
+
+Deleting a document
+
+Deletes a single document by the Document ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::DocumentsApi.new
+
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+}
+
+begin
+  #Deleting a document
+  result = api_instance.delete_document(document_idopts)
+  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->delete_document: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **document_id** | [**String**](.md)| ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+ **sender_id** | **String**| Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7` | [optional] 
+
+### 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_document**
-> DocumentResponse get_document(document_id)
+> DocumentResponse get_document(document_idopts)
 
 Fetching a document
 
@@ -23,10 +89,13 @@ require 'transferzero-sdk'
 
 api_instance = TransferZero::DocumentsApi.new
 
+opts = { 
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+}
 
 begin
   #Fetching a document
-  result = api_instance.get_document(document_id)
+  result = api_instance.get_document(document_idopts)
   p result
 rescue TransferZero::ApiError => e
   if e.validation_error
@@ -44,6 +113,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **document_id** | [**String**](.md)| ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **sender_id** | **String**| Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60; | [optional] 
 
 ### Return type
 
@@ -87,6 +157,7 @@ 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)
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
 }
 
 begin
@@ -110,6 +181,7 @@ 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] 
+ **sender_id** | **String**| Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60; | [optional] 
 
 ### Return type
 

data/docs/FieldSelectValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::FieldSelectValidation.new(_in: {"20":"Current","10":"Savings"},
-                                 allow_blank: false)
+                                 allow_blank: null)
 ```
 
 

data/docs/FieldValidation.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::FieldValidation.new(presence: true,
+instance = TransferZero::FieldValidation.new(presence: null,
                                  inclusion: null,
                                  format: {"with":"(?-mix:\\A\\d+\\z)"})
 ```

data/docs/PayinMethodDetails.md

@@ -8,7 +8,6 @@ Name | Type | Description | Notes
 **redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
 **phone_number** | **String** | The phone number where the funds should be collected from | 
 **send_instructions** | **Boolean** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
-**refund_address** | **String** | Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded. | [optional] 
 
 ## Code Sample
 
@@ -18,8 +17,7 @@ require 'TransferZero'
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
                                  phone_number: +2569999999,
-                                 send_instructions: true,
-                                 refund_address: null)
+                                 send_instructions: null)
 ```
 
 

data/docs/PayinMethodDetailsMobile.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
-                                 send_instructions: true)
+                                 send_instructions: null)
 ```
 
 

data/docs/PaymentMethod.md

@@ -18,9 +18,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethod.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: false,
+                                 otc_permitted: null,
                                  details: ["email","first_name","last_name","address"],
-                                 default: false,
+                                 default: null,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
 ```
 

data/docs/PaymentMethodOpposite.md

@@ -19,9 +19,9 @@ require 'TransferZero'
 
 instance = TransferZero::PaymentMethodOpposite.new(type: NGN::Bank,
                                  provider: Interswitch,
-                                 otc_permitted: false,
+                                 otc_permitted: null,
                                  details: ["email","first_name","last_name","address"],
-                                 default: false,
+                                 default: null,
                                  fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}},
                                  opposites: null)
 ```

data/docs/PayoutMethodDetails.md

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
-**sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -25,8 +24,6 @@ Name | Type | Description | Notes
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
 **identity_card_id** | **String** |  | [optional] 
 **reference** | **String** |  | [optional] 
-**name** | **String** |  | 
-**address** | **String** |  | 
 
 ## Code Sample
 
@@ -43,7 +40,6 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
-                                 sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,
                                  sender_identity_card_id: null,
@@ -53,9 +49,7 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  reason: null,
                                  identity_card_type: null,
                                  identity_card_id: null,
-                                 reference: null,
-                                 name: null,
-                                 address: null)
+                                 reference: null)
 ```
 
 

data/docs/PayoutMethodDetailsIBAN.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
-**bank_name** | **String** |  | [optional] 
+**bank_name** | **String** |  | 
 **iban** | **String** |  | 
 **bic** | **String** |  | [optional] 
 

data/docs/Recipient.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **editable** | **Boolean** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
 **retriable** | **Boolean** | Shows whether the transaction made to the recipient can be retried or not | [optional] 
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
-**may_cancel** | **Boolean** | If true it shows that the payment can be cancelled immediately using the DELETE /v1/recipients/{id} endpoint. If false you can still try to cancel it, however it will only gets cancelled once we have confirmation from our partner that the payment has failed. | [optional] 
+**may_cancel** | **Boolean** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
 **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
 **state** | [**RecipientState**](RecipientState.md) |  | [optional] 
 **transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
@@ -36,10 +36,10 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  payout_method: null,
                                  metadata: {},
                                  created_at: null,
-                                 editable: true,
-                                 retriable: true,
+                                 editable: null,
+                                 retriable: null,
                                  input_usd_amount: 10,
-                                 may_cancel: true,
+                                 may_cancel: null,
                                  state_reason: null,
                                  state: null,
                                  transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,

data/docs/RecipientsApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 Cancelling a recipient
 
-Cancels the payment to the recipient specified in the URL path.  Please note recipients where the `may_cancel` attribute is true will be cancelled immediately. If the `may_cancel` attribute is false you can still try to cancel the recipient, however it will only gets cancelled if we will receive a confirmation from our partner that the payment has failed
+Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
 
 ### Example
 ```ruby

data/docs/Sender.md

@@ -4,100 +4,70 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
 **type** | **String** | Type of sender to create - either person or business (defaults to person)  | [optional] 
-**state** | [**SenderState**](SenderState.md) |  | [optional] 
 **country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format | 
-**street** | **String** | Sender's street | 
-**postal_code** | **String** | Zip code of sender | 
-**city** | **String** | Sender's city | 
 **phone_country** | **String** | Phone country of sender in 2-character alpha ISO 3166-2 country format | 
 **phone_number** | **String** | Phone number of sender (without country callcode) | [optional] 
 **email** | **String** | Email of sender | 
-**ip** | **String** | IP of sender | 
-**address_description** | **String** | Description of address | [optional] 
-**identification_number** | **String** | Identification number of document used | [optional] 
-**identification_type** | **String** | Document to be identified. The identification type can be one of the following:  - `DL`: Driving License - `PP`: International Passport - `ID`: National ID - `OT`: Other | [optional] 
-**name** | **String** | Name of sender (used only with a Business sender) | [optional] 
 **first_name** | **String** | First name of sender (used only with a Personal sender) | [optional] 
 **middle_name** | **String** | Middle name of sender (used only with a Personal sender) | [optional] 
 **last_name** | **String** | Last name of sender (used only with a Personal sender) | [optional] 
-**birth_date** | **Date** | Date of birth of sender (used only with a Personal sender) | [optional] 
 **occupation** | **String** | Occupation of sender (used only with a Personal sender) | [optional] 
 **nationality** | **String** | The nationality of the sender (used only with a Personal sender) | [optional] 
-**legal_entity_type** | **String** | Legal entity type (used only with a Business sender) | [optional] 
-**registration_date** | **String** | The registration date (used only with a Business sender) | [optional] 
-**registration_number** | **String** | The registration number (used only with a Business sender) | [optional] 
-**nature_of_business** | **String** | Nature of business options (used only with a Business sender) | [optional] 
-**source_of_funds** | **String** | The source of funds | [optional] 
-**core_business_activities** | **String** | The core activities (used only with a Business sender) | [optional] 
-**purpose_of_opening_account** | **String** | The purpose for opening their account (used only with a Business sender) | [optional] 
-**office_phone** | **String** | The official phone number (used only with a Business sender) | [optional] 
-**vat_registration_number** | **String** | The VAT registration number (used only with a Business sender) | [optional] 
-**financial_regulator** | **String** | The Financial Regulator (used only with a Business sender) | [optional] 
-**regulatory_licence_number** | **String** | The Regulatory Licence Number (used only with a Business sender) | [optional] 
-**contact_person_email** | **String** | The contact's email address (used only with a Business sender) | [optional] 
-**trading_country** | **String** | The Business trading country (used only with a Business sender) | [optional] 
-**trading_address** | **String** | The Business trading address (used only with a Business sender) | [optional] 
-**number_monthly_transactions** | **String** | The estimated number of monthly transactions (used only with a Business sender) | [optional] 
-**amount_monthly_transactions** | **String** | The estimated amount for all transactions each month in USD (used only with a Business sender) | [optional] 
+**onboarding_status** | **String** | The onboarding status of the sender | [optional] 
+**address** | **String** | The address of the sender | [optional] 
+**description** | **String** | Description of the sender | [optional] 
+**name** | **String** | Name of sender (used only with a Business sender) | [optional] 
+**city** | **String** | Sender's city | 
+**street** | **String** | Sender's street | 
+**address_description** | **String** | Description of address | [optional] 
+**postal_code** | **String** | Zip code of sender | 
+**birth_date** | **Date** | Date of birth of sender | [optional] 
+**ip** | **String** | IP of sender | 
+**identification_number** | **String** | Identification number of document used | [optional] 
+**identification_type** | **String** | Document to be identified. The identification type can be one of the following:  - `DL`: Driving License - `PP`: International Passport - `ID`: National ID - `OT`: Other | [optional] 
 **documents** | [**Array<Document>**](Document.md) | Needed for KYC checks. Required to approve the sender unless KYC is waived for your account. Please send us an empty list of documents: `\"documents\": [ ]` in the request if KYC has been waived.  If the documents already exist, please send the Document ID eg. ```JSON \"documents\": [   {     \"id\": \"b6648ba3-1c7b-4f59-8580-684899c84a07\"   } ] ``` | 
+**politically_exposed_people** | [**Array<PoliticallyExposedPerson>**](PoliticallyExposedPerson.md) | A list of politically exposed people, individuals who are or have been entrusted with prominent public functions by a country, for example heads of state or heads of government, senior politicians, senior government, judicial or military officials, senior executives of state owned corporations, important political party officials.  There is a limit of three (3) politically exposed people per Sender.  Politically exposed person example: ```json   {     \"name\": \"Ronald Reagan\",     \"position\": \"President of the United States\",     \"started_date\": \"1981-01-20T00:00:00.000Z\",     \"ended_date\": \"1989-01-20T00:00:00.000Z\"   } ``` | [optional] 
 **metadata** | [**Object**](.md) | Metadata of sender. You can store any detail specific to your integration here (for example the local ID of the sender on your end). When requesting sender details you will receive the sent metadata back. Also when sending sender related webhooks you will receive the details stored here as well. | [optional] 
-**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
-**onboarding_status** | **String** | The onboarding status of the sender | [optional] 
-**politically_exposed_people** | [**Array<PoliticallyExposedPerson>**](PoliticallyExposedPerson.md) | An optional list of politically exposed people, individuals who are or have been entrusted with prominent public functions by a country, for example heads of state or heads of government, senior politicians, senior government, judicial or military officials, senior executives of state owned corporations, important political party officials.  There is a limit of three (3) politically exposed people per Sender.  Politically exposed person example: ```json   {     \"politically_exposed_person\": {       \"name\": \"Ronald Reagan\",       \"position\": \"President of the United States\",       \"started_date\": \"1981-01-20T00:00:00.000Z\",       \"ended_date\": \"1989-01-20T00:00:00.000Z\",       \"sender_id\": \"344fb668-196d-43db-9d94-b34b7e6c7e0b\"     }   } ``` | [optional] 
+**state** | [**SenderState**](SenderState.md) |  | [optional] 
+**id** | **String** |  | [optional] 
 **external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional] 
-**created_at** | **String** | Date and time of sender was created | [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::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
-                                 type: person,
-                                 state: null,
+instance = TransferZero::Sender.new(type: person,
                                  country: NG,
-                                 street: Fake Street,
-                                 postal_code: 798983,
-                                 city: Kampala,
                                  phone_country: NG,
                                  phone_number: 752403639,
                                  email: example@home.org,
-                                 ip: 127.0.0.1,
-                                 address_description: null,
-                                 identification_number: AB123456,
-                                 identification_type: ID,
-                                 name: null,
                                  first_name: Johnny,
                                  middle_name: Johnny,
                                  last_name: English,
-                                 birth_date: null,
                                  occupation: Accountant,
                                  nationality: NG,
-                                 legal_entity_type: sole_proprietorship,
-                                 registration_date: null,
-                                 registration_number: null,
-                                 nature_of_business: null,
-                                 source_of_funds: null,
-                                 core_business_activities: null,
-                                 purpose_of_opening_account: null,
-                                 office_phone: null,
-                                 vat_registration_number: null,
-                                 financial_regulator: null,
-                                 regulatory_licence_number: null,
-                                 contact_person_email: null,
-                                 trading_country: null,
-                                 trading_address: null,
-                                 number_monthly_transactions: null,
-                                 amount_monthly_transactions: null,
-                                 documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
-                                 metadata: {},
-                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
                                  onboarding_status: null,
+                                 address: null,
+                                 description: null,
+                                 name: null,
+                                 city: Kampala,
+                                 street: Fake Street,
+                                 address_description: null,
+                                 postal_code: 798983,
+                                 birth_date: null,
+                                 ip: 127.0.0.1,
+                                 identification_number: AB123456,
+                                 identification_type: ID,
+                                 documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
                                  politically_exposed_people: [{"id":"40","name":"Ronald Reagan","position":"President of the United States","started_date":"1981-01-20T00:00:00.000Z","ended_date":"1989-01-20T00:00:00.000Z","sender_id":"f9dc79ca-0c39-4add-9f4d-5ad7e6f187fb"}],
+                                 metadata: {},
+                                 state: null,
+                                 id: bf9ff782-e182-45ac-abea-5bce83ad6670,
                                  external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
-                                 created_at: 2019-01-11T00:00:00.001+0000)
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
 ```