transferzero-sdk 1.3.0 → 1.8.0

data/docs/PayinMethodDetailsNGNBank.md

@@ -4,14 +4,16 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+**payment_method** | **String** | The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both. | [optional] 
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethodDetailsNGNBank.new(redirect_url: null)
+instance = TransferZero::PayinMethodDetailsNGNBank.new(payment_method: null,
+                                 redirect_url: 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/PayoutMethod.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `XOF::Bank` - for Senegalese bank account payments. *** Currently in Beta phase *** - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
 **details** | [**PayoutMethodDetails**](PayoutMethodDetails.md) |  | [optional] 
 **metadata** | [**Object**](.md) | Metadata of payout method. You can store any kind of information in this field. | [optional] 
 **id** | **String** |  | [optional] 

data/docs/PayoutMethodDetails.md

@@ -8,11 +8,12 @@ Name | Type | Description | Notes
 **last_name** | **String** |  | 
 **bank_code** | **String** |  | 
 **bank_account** | **String** |  | 
-**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | [optional] 
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
-**bank_name** | **String** |  | 
 **iban** | **String** |  | 
+**bank_name** | **String** |  | 
+**bank_country** | **String** |  | 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -36,8 +37,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  bank_account_type: null,
                                  phone_number: null,
                                  mobile_provider: null,
-                                 bank_name: null,
                                  iban: null,
+                                 bank_name: null,
+                                 bank_country: null,
                                  bic: null,
                                  sender_identity_card_type: null,
                                  sender_identity_card_id: null,

data/docs/PayoutMethodDetailsNGNBank.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **last_name** | **String** |  | 
 **bank_code** | **String** |  | 
 **bank_account** | **String** |  | 
-**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/PayoutMethodDetailsXOFBank.md

@@ -0,0 +1,25 @@
+# TransferZero::PayoutMethodDetailsXOFBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**iban** | **String** |  | 
+**bank_name** | **String** |  | 
+**bank_country** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsXOFBank.new(first_name: null,
+                                 last_name: null,
+                                 iban: null,
+                                 bank_name: null,
+                                 bank_country: 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

@@ -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

@@ -91,7 +91,7 @@ opts = {
   created_at_to: 'created_at_to_example' # String | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
   amount_from: 'amount_from_example' # String | Minimum amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
   amount_to: 'amount_to_example' # String | Max amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
-  state: ['state_example'] # Array<String> | Allows filtering results by `state` of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: `/v1/recipients?state[]=error&state[]=initial`
+  state: ['state_example'] # Array<String> | Allows filtering results by `state` of recipient. See [API Documentation - Recipient state](https://docs.transferzero.com/docs/transaction-flow/#state) for possible states.  Example: `/v1/recipients?state[]=error&state[]=initial`
   currency: ['currency_example'] # Array<String> | Allows filtering results by `input_currency`.  Additionally required when filtering by an amount range Example: `/v1/recipients?currency[]=KES&currency[]=NGN`
 }
 
@@ -120,7 +120,7 @@ Name | Type | Description  | Notes
  **created_at_to** | **String**| End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60; | [optional] 
  **amount_from** | **String**| Minimum amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
  **amount_to** | **String**| Max amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
- **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60; | [optional] 
+ **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://docs.transferzero.com/docs/transaction-flow/#state) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60; | [optional] 
  **currency** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;input_currency&#x60;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60; | [optional] 
 
 ### Return type

data/docs/Sender.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **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] 
 **state** | [**SenderState**](SenderState.md) |  | [optional] 
 **id** | **String** |  | [optional] 
@@ -61,6 +62,7 @@ instance = TransferZero::Sender.new(type: person,
                                  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,

data/docs/Transaction.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
-**payin_methods** | [**Array<PayinMethod>**](PayinMethod.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**payin_methods** | [**Array<PayinMethod>**](PayinMethod.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://docs.transferzero.com/docs/additional-features/#collections-from-senders) in the API documentation | [optional] 
 **metadata** | [**Object**](.md) | Additional metadata to store on the transaction. If you widh to store your local transaction ID, you should add it here inside a `sendRef` field, and we will return this value back to you in the daily transaction reports. | [optional] 
 **sender** | [**Sender**](Sender.md) |  | 
 **recipients** | [**Array<Recipient>**](Recipient.md) | The details of where the payment should go. although transactions can support paying out multiple recipients, usually one is provided.  | 
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **due_amount** | **Float** | The amount needed to be paid in for the transaction to get funded | [optional] 
 **created_at** | **DateTime** | The time the transaction was created | [optional] 
 **expires_at** | **DateTime** | The latest time when the transaction has to be funded, otherwise it will be cancelled | [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] 
+**external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Transaction ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional] 
 **id** | **String** |  | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 
@@ -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/docs/TransactionTraits.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**auto_refund** | **Boolean** | Enables or disables the auto refund functionality. Please see [Auto cancellation and refund of transactions](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#auto-cancellation-and-refund-of-transactions) for more details | [optional] 
-**account_validation** | **Boolean** | Enabled or disables the name validation functionality. Please see [Name validation in transactions](https://github.com/transferzero/api-documentation/blob/master/additional-features.md#name-validation-in-transactions) for more details | [optional] 
+**auto_refund** | **Boolean** | Enables or disables the auto refund functionality. Please see [Auto cancellation and refund of transactions](https://docs.transferzero.com/docs/additional-features/#auto-cancellation-and-refund-of-transactions) for more details | [optional] 
+**account_validation** | **Boolean** | Enabled or disables the name validation functionality. Please see [Name validation in transactions](https://docs.transferzero.com/docs/additional-features/#name-validation-in-transactions) for more details | [optional] 
 
 ## Code Sample
 

data/docs/TransactionsApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api-sandbox.transferzero.com/v1*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**calculate_transactions**](TransactionsApi.md#calculate_transactions) | **POST** /transactions/calculate | Calculates transaction amounts for a transaction payload
+[**create_and_fund_transaction**](TransactionsApi.md#create_and_fund_transaction) | **POST** /transactions/create_and_fund | Creates a new transaction and funds it from account balance
 [**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /transactions/{Transaction ID} | Fetch a single transaction
 [**get_transactions**](TransactionsApi.md#get_transactions) | **GET** /transactions | Get a list of transactions
 [**payin_transaction**](TransactionsApi.md#payin_transaction) | **POST** /transactions/{Transaction ID}/payin | Creates a fake payin for transaction
@@ -74,6 +75,67 @@ end
 
 
 
+# **create_and_fund_transaction**
+> TransactionResponse create_and_fund_transaction(transaction_request)
+
+Creates a new transaction and funds it from account balance
+
+This endpoint creates a transaction and funds it from an account balance. You must ensure that you have established an account with us in the pay-in currency of the transactions you wish to create, and that this account is sufficently funded, before calling this endpoint.  Note that the <pre>external_id</pre> field is required for requests to this endpoint.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::TransactionsApi.new
+
+
+begin
+  #Creates a new transaction and funds it from account balance
+  result = api_instance.create_and_fund_transaction(transaction_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("TransactionResponse")
+    p result
+  else
+    puts "Exception when calling TransactionsApi->create_and_fund_transaction: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_request** | [**TransactionRequest**](TransactionRequest.md)|  | 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.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
+
+
+
 # **get_transaction**
 > TransactionResponse get_transaction(transaction_id)
 
@@ -153,6 +215,7 @@ 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)
   external_id: 'external_id_example' # String | Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
+  sender_id: 'sender_id_example' # String | Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
 }
 
 begin
@@ -177,6 +240,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] 
  **external_id** | **String**| Allows filtering results by &#x60;external_id&#x60;.  Example: &#x60;/v1/senders?external_id&#x3D;26ec8517-2f0d-48c0-b74f-0bccb9ab3a87&#x60; | [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/example/client.rb

@@ -15,7 +15,7 @@ credentials = {
     host: "https://api-sandbox.transferzero.com/v1"
 }
 
-# Please see our documentation at https://github.com/transferzero/api-documentation
+# Please see our documentation at https://docs.transferzero.com
 # and the API specification at http://api.transferzero.com/documentation/
 # for more information.
 
@@ -39,7 +39,7 @@ class Client
   end
 
   def account_validation_example
-    # See https://github.com/transferzero/api-documentation/blob/master/additional-features.md#bank-account-name-enquiry
+    # See https://docs.transferzero.com/docs/additional-features/#bank-account-name-enquiry
     # for more information on how this feature can be used
     begin
       request = TransferZero::AccountValidationRequest.new
@@ -63,7 +63,7 @@ class Client
   end
 
   def create_sender_example
-    # For more details on senders please check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+    # For more details on senders please check https://docs.transferzero.com/docs/transaction-flow/#sender
     begin
       api = TransferZero::SendersApi.new
       sender = TransferZero::Sender.new
@@ -98,7 +98,7 @@ class Client
   end
 
   def get_sender_by_external_id_example
-    # Find more details on external IDs at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+    # Find more details on external IDs at https://docs.transferzero.com/docs/transaction-flow/#external-id
     begin
       opts = { external_id: 'SENDER-2b59def0' }
       sender = TransferZero::SendersApi.new
@@ -113,7 +113,7 @@ class Client
   end
 
   def update_sender_example
-    # For more details on senders please check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+    # For more details on senders please check https://docs.transferzero.com/docs/transaction-flow/#sender
     begin
       api = TransferZero::SendersApi.new
       sender = TransferZero::Sender.new
@@ -135,15 +135,15 @@ class Client
     begin
       api = TransferZero::TransactionsApi.new
       transaction = TransferZero::Transaction.new
-      # Please check our documentation at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md
+      # Please check our documentation at https://docs.transferzero.com/docs/transaction-flow/
       # for details on how transactions work.
 
       sender = TransferZero::Sender.new
       # When adding a sender to transaction, please use either an id or external_id. Providing both will result in a validation error.
-      # Please see our documentation at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#sender
+      # Please see our documentation at https://docs.transferzero.com/docs/transaction-flow/#sender
       sender.id = 'ec33484c-4456-4625-a823-9704a3a54e68'
 
-      # You can find the various payout options at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#payout-details
+      # You can find the various payout options at https://docs.transferzero.com/docs/transaction-flow/#payout-details
       ngn_bank_details = TransferZero::PayoutMethodDetails.new
       ngn_bank_details.bank_account = '123456789'
       ngn_bank_details.bank_account_type = TransferZero::PayoutMethodBankAccountTypeEnum::N20
@@ -155,17 +155,17 @@ class Client
       payout_method.type = 'NGN::Bank'
       payout_method.details = ngn_bank_details
 
-      # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#requested-amount-and-currency
+      # Please see https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
       # on what the request amount and currencies do
       recipient = TransferZero::Recipient.new
       recipient.requested_amount = 10000
       recipient.requested_currency = 'NGN'
       recipient.payout_method = payout_method
 
-      # Similarly you can check https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#requested-amount-and-currency
+      # Similarly you can check https://docs.transferzero.com/docs/transaction-flow/#requested-amount-and-currency
       # on details about the input currency parameter
 
-      # Find more details on external IDs at https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+      # Find more details on external IDs at https://docs.transferzero.com/docs/transaction-flow/#external-id
       transaction.external_id = 'TRANSACTION-1f834add' # Optional field for customer's ID
       transaction.input_currency = 'GBP'
       transaction.sender = sender
@@ -188,7 +188,7 @@ class Client
   end
 
   def get_transaction_by_external_id_example
-    # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#external-id
+    # Please see https://docs.transferzero.com/docs/transaction-flow/#external-id
     # for more details on external IDs
     begin
       opts = { external_id: 'TRANSACTION-1f834add' }
@@ -208,7 +208,7 @@ class Client
     if transaction_id.nil?
       puts "Transaction with ID #{transaction_id} does not exist"
     else
-      # Please see https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#funding-transactions
+      # Please see https://docs.transferzero.com/docs/transaction-flow/#funding-transactions
       # on details about funding transactions
       debit = TransferZero::Debit.new
       debit.currency = 'GBP'
@@ -235,7 +235,7 @@ class Client
   end
 
   def webhook_parse_example
-    # Please see https://github.com/transferzero/api-documentation#webhooks
+    # Please see https://docs.transferzero.com#webhooks
     # for more details about how webhooks / callbacks work from our system
     headers = {
       "Authorization-Nonce": "<authorization-nonce>",

data/git_push.sh

@@ -16,7 +16,7 @@ if [ "$git_user_id" = "" ]; then
 fi
 
 if [ "$git_repo_id" = "" ]; then
-    git_repo_id="transferzero-ruby-sdk"
+    git_repo_id="transferzero-sdk-ruby"
     echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
 fi