transferzero-sdk 1.5.0 → 1.9.0

data/docs/PayoutMethodDetailsZARBank.md

@@ -0,0 +1,35 @@
+# TransferZero::PayoutMethodDetailsZARBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**phone_number** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsZARBank.new(first_name: null,
+                                 last_name: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 bank_code: null,
+                                 bank_account: null,
+                                 phone_number: null,
+                                 transfer_reason_code: null)
+```
+
+

data/docs/PoliticallyExposedPerson.md

@@ -0,0 +1,31 @@
+# TransferZero::PoliticallyExposedPerson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] 
+**name** | **String** | Full name of the politically exposed person  | [optional] 
+**position** | **String** | The office held by the politically exposed person  | [optional] 
+**started_date** | **DateTime** | The date on which the person started holding the office  | [optional] 
+**ended_date** | **DateTime** | The date on which the person ended holding the office  | [optional] 
+**sender_id** | **String** | The ID of the Sender to whom the person is attached to  | [optional] 
+**created_at** | **DateTime** | Date and time the person was created | [optional] 
+**updated_at** | **DateTime** | Date and time the person was updated | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PoliticallyExposedPerson.new(id: 1,
+                                 name: Ronald Reagan,
+                                 position: President of the United States,
+                                 started_date: null,
+                                 ended_date: null,
+                                 sender_id: 83a4f5fd-9260-4aaa-9743-63f8a6d8309d,
+                                 created_at: null,
+                                 updated_at: null)
+```
+
+

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** | 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] 
+**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] 
 **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] 

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 only recipients where the `may_cancel` attribute is true can be cancelled.
+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
 
 ### Example
 ```ruby

data/docs/Sender.md

@@ -4,68 +4,108 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
 **type** | **String** | Type of sender to create - either person or business (defaults to person)  | [optional] 
-**country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format | 
+**state** | [**SenderState**](SenderState.md) |  | [optional] 
+**country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format. This is the residential country for personal senders and the country of incorporation for business senders. | 
+**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] 
-**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] 
+**legal_entity_type** | **String** | Legal entity type (used only with a Business sender)  Available values:   - sole_proprietorship: Sole Proprietorship   - partnership: Partnership   - privately_owned_company: Privately Owned Company (Limited Company)   - publicly_owned_company: Publicly Listed Company (PLC)   - government_owned_entity: Government Owned Entity Trusts   - trust: Foundations & Similar Entities   - ngo: Non-Government Organisations / Charities inc Religious bodies and place of worship   - club_and_society: Clubs and Societies   - go: GO (Majority Owned Subsidiary of State-Owned Company)   - financial_institution: Financial Institution  Please note not all values are acceptable for some our corridors. Please reach out to our sales teams for more information.  Note that if you select `financial_institution` then the fields `vat_registration_number`, `financial_regulator` and `regulatory_licence_number` will be mandatory as well. | [optional] 
+**registration_date** | **Date** | 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)  Available values:   - personal: Personal   - agriculture_and_hunting: Agriculture and Hunting   - forestry: Forestry   - fishing: Fishing   - agricultural_by_products: Agricultural By-Products   - coal_mining: Coal Mining   - oil_mining: Oil Mining   - iron_ore_mining: Iron Ore Mining   - other_metal_and_diamond_mining: Other Metal and Diamond Mining   - other_mineral_mining: Other Mineral Mining   - manufacturing_of_food_drink_tobacco: Manufacture of Food/Drink/Tobacco   - manufacturing_of_textiles_leather_fur_furniture: Manufacture of Textiles/Leather/Fur/Furniture   - manufacture_of_wooden_products_furniture: Manufacture of Wooden Products/Furniture   - manufacture_of_paper_pulp_allied_products: Manufacture of Paper/Pulp/Allied Products   - manufacture_of_chemicals_medical_petroleum_rubber_plastic_products: Manufacture Of Chemicals Medical Petroleum Rubber Plastic Products   - manufacture_of_pottery_china_glass_stone: Manufacture Of Pottery China Glass Stone   - manufacture_of_iron_steel_non_ferrous_metals_basic_industries: Manufacture Of Iron Steel Non-Ferrous Metals Basic Industries   - manufacture_of_metal_products_electrical_and_scientific_engineering: Manufacture Of Metal Products Electrical And Scientific Engineering   - manufacture_of_jewelry_musical_instruments_toys: Manufacture Of Jewelry Musical Instruments Toys   - electricity_gas_and_water: Electricity, Gas And Water   - construction: Construction   - wholesale_trade: Wholesale Trade   - retail_trade: Retail Trade   - catering_incl_hotels: Catering Incl. Hotels   - transport_storage: Transport Storage   - communications: Communications   - finance_and_holding_companies: Finance And Holding Companies   - insurance: Insurance   - business_services: Business Services   - real_estate_development_investment: Real Estate Development Investment   - central_state_governments: Central State Governments   - community_services_defence_police_prisons_etc: Community Services Defence Police Prisons Etc   - social_services_education_health_care: Social Services Education Health Care   - personal_services_leisure_services: Personal Services - Leisure Services   - personal_services_domestic_laundry_repairs: Personal Services - Domestic Laundry Repairs   - personal_services_embassies_international_organisations: Personal Services - Embassies | [optional] 
+**source_of_funds** | **String** | The source of funds | [optional] 
+**custom_source_of_funds** | **String** | Custom source of funds | [optional] 
+**core_business_activity** | **String** | The core activity (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] 
 **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\"   } ] ``` | 
 **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] 
-**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] 
 **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] 
+**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] 
+**city_of_birth** | **String** | City of birth of sender | [optional] 
+**country_of_birth** | **String** | Country of birth of sender in 2-character alpha ISO 3166-2 country format | [optional] 
+**gender** | **String** | The gender of the sender:  - `M`: Male - `F`: Female - `O`: Other | [optional] 
+**created_at** | **String** | Date and time of sender was created | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::Sender.new(type: person,
+instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
+                                 type: person,
+                                 state: null,
                                  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,
-                                 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,
+                                 legal_entity_type: privately_owned_company,
+                                 registration_date: null,
+                                 registration_number: null,
+                                 nature_of_business: null,
+                                 source_of_funds: null,
+                                 custom_source_of_funds: null,
+                                 core_business_activity: 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: {},
-                                 state: null,
-                                 id: bf9ff782-e182-45ac-abea-5bce83ad6670,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]},
+                                 onboarding_status: null,
+                                 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"}],
                                  external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
-                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+                                 city_of_birth: London,
+                                 country_of_birth: GB,
+                                 gender: M,
+                                 created_at: 2019-01-11T00:00:00.001+0000)
 ```
 
 

data/docs/Transaction.md

@@ -33,10 +33,10 @@ instance = TransferZero::Transaction.new(input_currency: NGN,
                                  recipients: null,
                                  traits: null,
                                  state: null,
-                                 input_amount: null,
+                                 input_amount: 1000,
                                  payin_reference: null,
-                                 paid_amount: null,
-                                 due_amount: null,
+                                 paid_amount: 1000,
+                                 due_amount: 1000,
                                  created_at: null,
                                  expires_at: null,
                                  external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,

data/lib/transferzero-sdk.rb

@@ -52,6 +52,7 @@ require 'transferzero-sdk/models/pagination'
 require 'transferzero-sdk/models/pagination_meta'
 require 'transferzero-sdk/models/payin_method'
 require 'transferzero-sdk/models/payin_method_details'
+require 'transferzero-sdk/models/payin_method_details_btc'
 require 'transferzero-sdk/models/payin_method_details_mobile'
 require 'transferzero-sdk/models/payin_method_details_ngn_bank'
 require 'transferzero-sdk/models/payin_method_request'
@@ -61,7 +62,9 @@ require 'transferzero-sdk/models/payment_method_opposite'
 require 'transferzero-sdk/models/payout_method'
 require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
 require 'transferzero-sdk/models/payout_method_details'
+require 'transferzero-sdk/models/payout_method_details_btc'
 require 'transferzero-sdk/models/payout_method_details_balance'
+require 'transferzero-sdk/models/payout_method_details_gbp_bank'
 require 'transferzero-sdk/models/payout_method_details_ghs_bank'
 require 'transferzero-sdk/models/payout_method_details_iban'
 require 'transferzero-sdk/models/payout_method_details_mad_cash'
@@ -69,6 +72,7 @@ require 'transferzero-sdk/models/payout_method_details_mobile'
 require 'transferzero-sdk/models/payout_method_details_ngn_bank'
 require 'transferzero-sdk/models/payout_method_details_xof_bank'
 require 'transferzero-sdk/models/payout_method_details_xof_mobile'
+require 'transferzero-sdk/models/payout_method_details_zar_bank'
 require 'transferzero-sdk/models/payout_method_gender_enum'
 require 'transferzero-sdk/models/payout_method_identity_card_type_enum'
 require 'transferzero-sdk/models/payout_method_list_response'
@@ -76,6 +80,7 @@ require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
 require 'transferzero-sdk/models/payout_method_request'
 require 'transferzero-sdk/models/payout_method_response'
 require 'transferzero-sdk/models/payout_method_webhook'
+require 'transferzero-sdk/models/politically_exposed_person'
 require 'transferzero-sdk/models/recipient'
 require 'transferzero-sdk/models/recipient_list_response'
 require 'transferzero-sdk/models/recipient_request'

data/lib/transferzero-sdk/api/documents_api.rb

@@ -21,68 +21,10 @@ module TransferZero
     end
 
 
-    # Deleting a document
-    # Deletes a single document by the Document ID
-    # @param document_id ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670`
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
-    # @return [DocumentResponse]
-    def delete_document(document_id, opts = {})
-      data, _status_code, _headers = delete_document_with_http_info(document_id, opts)
-      data
-    end
-
-    # Deleting a document
-    # Deletes a single document by the Document ID
-    # @param document_id ID of the document to delete.  Example: `/v1/document/bf9ff782-e182-45ac-abea-5bce83ad6670`
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
-    # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
-    def delete_document_with_http_info(document_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: DocumentsApi.delete_document ...'
-      end
-      # verify the required parameter 'document_id' is set
-      if @api_client.config.client_side_validation && document_id.nil?
-        fail ArgumentError, "Missing the required parameter 'document_id' when calling DocumentsApi.delete_document"
-      end
-      # resource path
-      local_var_path = '/documents/{Document ID}'.sub('{' + 'Document ID' + '}', document_id.to_s)
-
-      # query parameters
-      query_params = {}
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'DocumentResponse')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DocumentsApi#delete_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-
     # Fetching a document
     # Returns a single document by the Documents ID
     # @param document_id ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [DocumentResponse]
     def get_document(document_id, opts = {})
       data, _status_code, _headers = get_document_with_http_info(document_id, opts)
@@ -93,7 +35,6 @@ module TransferZero
     # Returns a single document by the Documents ID
     # @param document_id ID of the document to get.  Example: &#x60;/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
     def get_document_with_http_info(document_id, opts = {})
       if @api_client.config.debugging
@@ -108,7 +49,6 @@ module TransferZero
 
       # query parameters
       query_params = {}
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
 
       # header parameters
       header_params = {}
@@ -150,7 +90,6 @@ module TransferZero
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page number to request (defaults to 1)
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [DocumentListResponse]
     def get_documents(opts = {})
       data, _status_code, _headers = get_documents_with_http_info(opts)
@@ -162,7 +101,6 @@ module TransferZero
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page The page number to request (defaults to 1)
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
-    # @option opts [String] :sender_id Allows filtering results by &#x60;sender_id&#x60;.  Example: &#x60;/v1/transactions?sender_id&#x3D;b41d3cb7-6c54-4245-85fc-8e30690eb0f7&#x60;
     # @return [Array<(DocumentListResponse, Fixnum, Hash)>] DocumentListResponse data, response status code and response headers
     def get_documents_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -175,7 +113,6 @@ module TransferZero
       query_params = {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
-      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
 
       # header parameters
       header_params = {}

data/lib/transferzero-sdk/api/recipients_api.rb

@@ -22,7 +22,7 @@ module TransferZero
 
 
     # Cancelling a recipient
-    # 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.
+    # 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
     # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
     # @param [Hash] opts the optional parameters
     # @return [RecipientResponse]
@@ -32,7 +32,7 @@ module TransferZero
     end
 
     # Cancelling a recipient
-    # 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.
+    # 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
     # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
     # @param [Hash] opts the optional parameters
     # @return [Array<(RecipientResponse, Fixnum, Hash)>] RecipientResponse data, response status code and response headers

data/lib/transferzero-sdk/api_client.rb

@@ -35,7 +35,7 @@ module TransferZero
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "TransferZero-SDK/Ruby/1.5.0"
+      @user_agent = "TransferZero-SDK/Ruby/1.9.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -106,12 +106,14 @@ module TransferZero
       url_with_params = add_query(url, query_params)
       form_params = opts[:form_params] || {}
 
+      request_body = opts[:body].to_s.gsub(/[[:space:]]+/, ' ').strip
+
       request_nonce = SecureRandom.uuid
       request_signature = sign_request([
         request_nonce,
         http_method.to_s.upcase,
         url_with_params,
-        DIGEST.hexdigest(opts[:body].to_s.gsub(/[[:space:]]+/, ' ').strip)
+        DIGEST.hexdigest(request_body)
       ])
 
       header_params['Authorization-Nonce'] = request_nonce
@@ -138,7 +140,7 @@ module TransferZero
       req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
 
       if [:post, :patch, :put, :delete].include?(http_method)
-        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_body = build_request_body(header_params, form_params, request_body)
         req_opts.update :body => req_body
         if @config.debugging
           @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"

data/lib/transferzero-sdk/models/account.rb

@@ -13,86 +13,86 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-  class Account
-    # The account balance for the given currency
-    attr_accessor :amount
-
-    # The currency of this balance
-    attr_accessor :currency
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'amount' => :'amount',
-        :'currency' => :'currency'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'amount' => :'Float',
-        :'currency' => :'String'
-      }
-    end
+class Account
+  # The account balance for the given currency
+  attr_accessor :amount
+
+  # The currency of this balance
+  attr_accessor :currency
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'amount' => :'amount',
+      :'currency' => :'currency'
+    }
+  end
 
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Account` initialize method"
-      end
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'amount' => :'Float',
+      :'currency' => :'String'
+    }
+  end
 
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
+  # Initializes the object
+  # @param [Hash] attributes Model attributes in the form of hash
+  def initialize(attributes = {})
+    if (!attributes.is_a?(Hash))
+      fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Account` initialize method"
+    end
 
-      if attributes.key?(:'amount')
-        self.amount = attributes[:'amount']
+    # check to see if the attribute exists and convert string to symbol for hash key
+    attributes = attributes.each_with_object({}) { |(k, v), h|
+      if (!self.class.attribute_map.key?(k.to_sym))
+        fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::Account`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
       end
+      h[k.to_sym] = v
+    }
 
-      if attributes.key?(:'currency')
-        self.currency = attributes[:'currency']
-      end
+    if attributes.key?(:'amount')
+      self.amount = attributes[:'amount']
     end
 
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
+    if attributes.key?(:'currency')
+      self.currency = attributes[:'currency']
     end
+  end
 
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
+  # Show invalid properties with the reasons. Usually used together with valid?
+  # @return Array for valid properties with the reasons
+  def list_invalid_properties
+    invalid_properties = Array.new
+    invalid_properties
+  end
 
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          amount == o.amount &&
-          currency == o.currency
-    end
+  # Check to see if the all the properties in the model are valid
+  # @return true if the model is valid
+  def valid?
+    true
+  end
 
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
+  # Checks equality by comparing each attribute.
+  # @param [Object] Object to be compared
+  def ==(o)
+    return true if self.equal?(o)
+    self.class == o.class &&
+        amount == o.amount &&
+        currency == o.currency
+  end
 
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [amount, currency].hash
-    end
+  # @see the `==` method
+  # @param [Object] Object to be compared
+  def eql?(o)
+    self == o
+  end
+
+  # Calculates hash code according to all attributes.
+  # @return [Integer] Hash code
+  def hash
+    [amount, currency].hash
+  end
 
 require 'active_support/core_ext/hash'
 require 'active_support/hash_with_indifferent_access.rb'
@@ -208,5 +208,6 @@ def _to_hash(value)
   end
 end
 
-  end
+end
+
 end