bitpesa-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5b80e402eceef9833efcd099523b0fbb57a58c61746d7eee54229e79774302d1
-  data.tar.gz: ebeeb5560dcfb3e759a3724da21db230e41e7980b1d8b4fa19fd8d2c4a265575
+SHA1:
+  metadata.gz: 10dbee3b9f41bb3cbbe88d1f0da8dee44ec7cf15
+  data.tar.gz: d6c3f97311cbaa3918ba1777f140cd5e59b51f5c
 SHA512:
-  metadata.gz: 2717df8e9a025cedd2aeb9334b02fa80f097a8a82fa61cb73a1602407466389ac4daa9bd4fc400ecfa2625f585589771914594b70264673003293339013d7e75
-  data.tar.gz: 42dbc484b8eb729fb10e2149ac142505695291dac5d19e3f5b7e4234b076b44a3da6789d4724dd6eab900689bd4373945480c4d2f7c0b264a7f23ca111d17f63
+  metadata.gz: 39e0a2e0d796eade2d93c368813a6ab40f551fb4d00999b52ecc6f679f5ac6397aadef31da2c7b2c25064d759976c93254ea59cd611b9fb7c5d8d7a6aea17389
+  data.tar.gz: b2eb4b66f1810734df687a252b8f85d6613679ef038dbd911baa48832942583a4172e6218dd332d5b86811397d6cdd248ef7e6d4c51452fd8997058882ea3941

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 12.0.0'
   gem 'pry-byebug'
+  gem 'ZenTest', '~> 4.11', '>= 4.11.2'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bitpesa-sdk (1.0.0)
+    bitpesa-sdk (0.2.0)
       activesupport (~> 5)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -9,8 +9,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.11.1)
-    activesupport (5.2.2)
+    ZenTest (4.11.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -77,6 +77,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  ZenTest (~> 4.11, >= 4.11.2)
   autotest (~> 4.4, >= 4.4.6)
   autotest-fsevent (~> 0.2, >= 0.2.12)
   autotest-growl (~> 0.2, >= 0.2.16)
@@ -89,4 +90,4 @@ DEPENDENCIES
   webmock (~> 1.24, >= 1.24.3)
 
 BUNDLED WITH
-   1.16.6
+   2.0.1

data/README.md

@@ -1,4 +1,4 @@
-# bitpesa
+# bitpesa-sdk
 
 Bitpesa - the Ruby gem for the BitPesa API
 
@@ -7,9 +7,17 @@ Reference documentation for the BitPesa API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.0.0
+- Package version: 0.2.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
+For more information, please visit:
+
+* [API Documentation](https://github.com/bitpesa/api-documentation)
+  * [Onboarding guide](https://github.com/bitpesa/api-documentation/blob/master/quick-integration.md)
+  * [Transaction flow](https://github.com/bitpesa/api-documentation/blob/master/transaction-flow.md)
+  * [Additional features](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md)
+* [API Specification](https://api.bitpesa.co/documentation)
+
 ## Installation
 
 ### Build a gem
@@ -17,27 +25,27 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 To build the Ruby code into a gem:
 
 ```shell
-gem build bitpesa.gemspec
+gem build bitpesa-sdk.gemspec
 ```
 
 Then either install the gem locally:
 
 ```shell
-gem install ./bitpesa-1.0.0.gem
+gem install ./bitpesa-sdk-0.2.0.gem
 ```
-(for development, run `gem install --dev ./bitpesa-1.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./bitpesa-sdk-0.2.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 'bitpesa', '~> 1.0.0'
+    gem 'bitpesa-sdk', '~> 0.2.0'
 
 ### Install from Git
 
 If the Ruby gem is hosted at a git repository: https://github.com/bitpesa/bitpesa-ruby-sdk, then add the following in the Gemfile:
 
-    gem 'bitpesa', :git => 'https://github.com/bitpesa/bitpesa-ruby-sdk.git'
+    gem 'bitpesa-sdk', :git => 'https://github.com/bitpesa/bitpesa-ruby-sdk.git'
 
 ### Include the Ruby code directly
 
@@ -201,12 +209,16 @@ Class | Method | HTTP request | Description
  - [Bitpesa::SenderListResponse](docs/SenderListResponse.md)
  - [Bitpesa::SenderRequest](docs/SenderRequest.md)
  - [Bitpesa::SenderResponse](docs/SenderResponse.md)
+ - [Bitpesa::SenderResponseExisting](docs/SenderResponseExisting.md)
+ - [Bitpesa::SenderResponseMeta](docs/SenderResponseMeta.md)
  - [Bitpesa::SenderState](docs/SenderState.md)
  - [Bitpesa::SenderWebhook](docs/SenderWebhook.md)
  - [Bitpesa::Transaction](docs/Transaction.md)
  - [Bitpesa::TransactionListResponse](docs/TransactionListResponse.md)
  - [Bitpesa::TransactionRequest](docs/TransactionRequest.md)
  - [Bitpesa::TransactionResponse](docs/TransactionResponse.md)
+ - [Bitpesa::TransactionResponseExisting](docs/TransactionResponseExisting.md)
+ - [Bitpesa::TransactionResponseMeta](docs/TransactionResponseMeta.md)
  - [Bitpesa::TransactionState](docs/TransactionState.md)
  - [Bitpesa::TransactionTraits](docs/TransactionTraits.md)
  - [Bitpesa::TransactionWebhook](docs/TransactionWebhook.md)

data/docs/Sender.md

@@ -27,6 +27,7 @@ Name | Type | Description | Notes
 **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] 
 
 

data/docs/SenderResponse.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **object** | [**Sender**](Sender.md) |  | [optional] 
+**meta** | [**SenderResponseMeta**](SenderResponseMeta.md) |  | [optional] 
 
 

data/docs/SenderResponseExisting.md

@@ -0,0 +1,8 @@
+# Bitpesa::SenderResponseExisting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | [**Sender**](Sender.md) |  | [optional] 
+
+

data/docs/SenderResponseMeta.md

@@ -0,0 +1,8 @@
+# Bitpesa::SenderResponseMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**existing** | [**SenderResponseExisting**](SenderResponseExisting.md) |  | [optional] 
+
+

data/docs/SendersApi.md

@@ -152,6 +152,7 @@ opts = {
   per: 10 # Integer | The number of results to load per page (defaults to 10)
   created_at_from: 'created_at_from_example' # String | Start 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`
   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`
+  external_id: 'external_id_example' # String | Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
 }
 
 begin
@@ -177,6 +178,7 @@ Name | Type | Description  | Notes
  **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
  **created_at_from** | **String**| Start 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` | [optional] 
  **created_at_to** | **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` | [optional] 
+ **external_id** | **String**| Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional] 
 
 ### Return type
 

data/docs/Transaction.md

@@ -16,6 +16,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] 
 **id** | **String** |  | [optional] 
 **errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
 

data/docs/TransactionResponse.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **object** | [**Transaction**](Transaction.md) |  | [optional] 
+**meta** | [**TransactionResponseMeta**](TransactionResponseMeta.md) |  | [optional] 
 
 

data/docs/TransactionResponseExisting.md

@@ -0,0 +1,9 @@
+# Bitpesa::TransactionResponseExisting
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sender** | [**Sender**](Sender.md) |  | [optional] 
+**transaction** | [**Transaction**](Transaction.md) |  | [optional] 
+
+

data/docs/TransactionResponseMeta.md

@@ -0,0 +1,8 @@
+# Bitpesa::TransactionResponseMeta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**existing** | [**TransactionResponseExisting**](TransactionResponseExisting.md) |  | [optional] 
+
+

data/docs/TransactionsApi.md

@@ -152,6 +152,7 @@ api_instance = Bitpesa::TransactionsApi.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)
+  external_id: 'external_id_example' # String | Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
 }
 
 begin
@@ -175,6 +176,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 `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87` | [optional] 
 
 ### Return type
 

data/example/client.rb

@@ -4,15 +4,15 @@ require 'securerandom'
 require 'bundler/inline'
 
 gemfile do
-  gem "bitpesa-sdk", "=0.1.0"
+  gem "bitpesa-sdk", "=0.2.0"
 end
 
 require 'bitpesa-sdk'
 
 credentials = {
-    key: "/8w2C+cXLixtV+erRpFK3kd/neknrfToQGCw9zoCYw5jAFJEv6XrnOhF0+Vk65jgq094J8LDQ9H8x1hEgeXdFA==",
-    secret: "biBm9X2y2wRY4U1WZPpFrxCSoHQ1Xtyy9VPxbfhAI70wxsnmvEGhC4PlTyjejRqvrnIT7velS8WyYb0AN4Y29A==",
-    host: 'localhost:3002/v1',
+    key: "<key>",
+    secret: "<secret>",
+    host: 'https://api-sandbox.bitpesa.co/v1',
 }
 
 class Client
@@ -21,7 +21,6 @@ class Client
       config.api_key = credentials[:key]
       config.api_secret = credentials[:secret]
       config.host = credentials[:host]
-      config.scheme = 'http'
     end
   end
 
@@ -73,11 +72,15 @@ class Client
       sender.postal_code = "798983"
       sender.birth_date = "1900-12-31"
       sender.ip = '127.0.0.1'
+      sender.external_id = 'SENDER-2b59def0' # Optional field for customer ID
 
       sender_request = Bitpesa::SenderRequest.new
       sender_request.sender = sender
-      api.post_senders(sender_request)
-      # SenderRequest |
+      sender_response = api.post_senders(sender_request)
+      created_sender = sender_response.object
+
+      puts "Sender created! ID: #{created_sender.id}"
+      created_sender.id
     rescue Bitpesa::ApiError => e
       if e.validation_error
         puts e.response_object("SenderResponse").object.errors
@@ -87,6 +90,20 @@ class Client
     end
   end
 
+  def get_sender_by_external_id_example
+    begin
+      opts = { external_id: 'SENDER-2b59def0' }
+      sender = Bitpesa::SendersApi.new
+      sender.get_senders(opts).object.first
+    rescue Bitpesa::ApiError => e
+      if e.validation_error
+        puts e.response_object("SenderResponse").object.errors
+      else
+        puts "Exception when calling SendersApi#get_sender_by_external_id_example: #{e}"
+      end
+    end
+  end
+
   def update_sender_example
     begin
       api = Bitpesa::SendersApi.new
@@ -95,7 +112,7 @@ class Client
       sender_request = Bitpesa::SenderRequest.new
       sender_request.sender = sender
 
-      api.patch_sender('0789f89b-a2f3-4323-b8cc-c901692889d4', sender_request)
+      api.patch_sender('ec33484c-4456-4625-a823-9704a3a54e68', sender_request)
     rescue Bitpesa::ApiError => e
       if e.validation_error
         puts e.response_object("SenderResponse").object.errors
@@ -111,6 +128,8 @@ class Client
       transaction = Bitpesa::Transaction.new
 
       sender = Bitpesa::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/bitpesa/api-documentation/blob/master/transaction-flow.md#external-id
       sender.id = 'ec33484c-4456-4625-a823-9704a3a54e68'
 
       ngn_bank_details = Bitpesa::PayoutMethodDetails.new
@@ -129,6 +148,7 @@ class Client
       recipient.requested_currency = 'NGN'
       recipient.payout_method = payout_method
 
+      transaction.external_id = 'TRANSACTION-1f834add' # Optional field for customer's ID
       transaction.input_currency = 'GBP'
       transaction.sender = sender
       transaction.recipients = [recipient]
@@ -149,6 +169,20 @@ class Client
     end
   end
 
+  def get_transaction_by_external_id_example
+    begin
+      opts = { external_id: 'TRANSACTION-1f834add' }
+      transaction = Bitpesa::TransactionsApi.new
+      transaction.get_transactions(opts).object.first
+    rescue Bitpesa::ApiError => e
+      if e.validation_error
+        puts e.response_object("TransactionResponse").object.errors
+      else
+        puts "Exception when calling TransactionsApi#get_transaction_by_external_id_example: #{e}"
+      end
+    end
+  end
+
   def create_and_fund_transaction_example
     transaction_id = create_transaction_example
     if transaction_id.nil?
@@ -387,9 +421,13 @@ class Client
   end
 end
 
-CLIENT = Client.new(credentials)
+# client = Client.new(credentials)
 # client.list_currencies_example
 # client.account_validation_example
+# client.create_sender_example
+# client.get_sender_by_external_id_example
+# client.update_sender_example
 # client.create_transaction_example
+# client.get_transaction_by_external_id_example
 # client.create_and_fund_transaction_example
 # client.webhook_parse_example

data/lib/bitpesa-sdk.rb

@@ -85,12 +85,16 @@ require 'bitpesa-sdk/models/sender'
 require 'bitpesa-sdk/models/sender_list_response'
 require 'bitpesa-sdk/models/sender_request'
 require 'bitpesa-sdk/models/sender_response'
+require 'bitpesa-sdk/models/sender_response_existing'
+require 'bitpesa-sdk/models/sender_response_meta'
 require 'bitpesa-sdk/models/sender_state'
 require 'bitpesa-sdk/models/sender_webhook'
 require 'bitpesa-sdk/models/transaction'
 require 'bitpesa-sdk/models/transaction_list_response'
 require 'bitpesa-sdk/models/transaction_request'
 require 'bitpesa-sdk/models/transaction_response'
+require 'bitpesa-sdk/models/transaction_response_existing'
+require 'bitpesa-sdk/models/transaction_response_meta'
 require 'bitpesa-sdk/models/transaction_state'
 require 'bitpesa-sdk/models/transaction_traits'
 require 'bitpesa-sdk/models/transaction_webhook'

data/lib/bitpesa-sdk/api/senders_api.rb

@@ -146,6 +146,7 @@ module Bitpesa
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
     # @option opts [String] :created_at_from Start 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`
     # @option opts [String] :created_at_to 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`
+    # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [SenderListResponse]
     def get_senders(opts = {})
       data, _status_code, _headers = get_senders_with_http_info(opts)
@@ -159,6 +160,7 @@ module Bitpesa
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
     # @option opts [String] :created_at_from Start 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`
     # @option opts [String] :created_at_to 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`
+    # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [Array<(SenderListResponse, Fixnum, Hash)>] SenderListResponse data, response status code and response headers
     def get_senders_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -173,6 +175,7 @@ module Bitpesa
       query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
       query_params[:'created_at_from'] = opts[:'created_at_from'] if !opts[:'created_at_from'].nil?
       query_params[:'created_at_to'] = opts[:'created_at_to'] if !opts[:'created_at_to'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
 
       # header parameters
       header_params = {}

data/lib/bitpesa-sdk/api/transactions_api.rb

@@ -146,6 +146,7 @@ module Bitpesa
     # @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] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [TransactionListResponse]
     def get_transactions(opts = {})
       data, _status_code, _headers = get_transactions_with_http_info(opts)
@@ -157,6 +158,7 @@ module Bitpesa
     # @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] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @return [Array<(TransactionListResponse, Fixnum, Hash)>] TransactionListResponse data, response status code and response headers
     def get_transactions_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -169,6 +171,7 @@ module Bitpesa
       query_params = {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
+      query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
 
       # header parameters
       header_params = {}

data/lib/bitpesa-sdk/api_client.rb

@@ -35,7 +35,7 @@ module Bitpesa
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
+      @user_agent = "BitPesa Ruby Client"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/bitpesa-sdk/models/sender.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta2
 require 'date'
 
 module Bitpesa
-  # This contains the details of the sender. The first time a specific sender is used the full details should be provided. Once a sender is created and is used, the next time you MUST only send the ID of the sender. This is so we can match the same sender across multiple transactions for KYC and audit purposes.  Personal Sender Example: ```json {   \"country\": \"UG\",   \"phone_country\": \"UG\",   \"phone_number\": \"752403639\",   \"email\": \"example@home.org\",   \"first_name\": \"Johnny\",   \"last_name\": \"English\",   \"city\": \"Kampala\",   \"street\": \"Unknown 17-3\",   \"address_description\": \"Description of address\",   \"postal_code\": \"798983\",   \"birth_date\": \"1900-12-31\",   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": { } } ```  Business Sender Example:  ```json {   \"type\": \"business\",   \"country\": \"UG\",   \"phone_country\": \"UG\",   \"phone_number\": \"752403639\",   \"email\": \"example@home.org\",   \"name\": \"MyCompany\",   \"city\": \"Kampala\",   \"street\": \"Unknown 17-3\",   \"postal_code\": \"798983\",   \"address_description\": \"Description of address\",   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": { } } ```  [Sender in the API documentation](https://github.com/bitpesa/api-documentation/blob/master/transaction-flow.md#sender)
+  # This contains the details of the sender. The first time a specific sender is used the full details should be provided. Once a sender is created and is used, the next time you MUST only send the ID of the sender. This is so we can match the same sender across multiple transactions for KYC and audit purposes.  Personal Sender Example: ```json {   \"country\": \"UG\",   \"phone_country\": \"UG\",   \"phone_number\": \"752403639\",   \"email\": \"example@home.org\",   \"first_name\": \"Johnny\",   \"last_name\": \"English\",   \"city\": \"Kampala\",   \"street\": \"Unknown 17-3\",   \"address_description\": \"Description of address\",   \"postal_code\": \"798983\",   \"birth_date\": \"1900-12-31\",   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"external_id\": \"806ec63a-a5a7-43cc-9d75-1ee74fbcc026\",   \"metadata\": { } } ```  Business Sender Example:  ```json {   \"type\": \"business\",   \"country\": \"UG\",   \"phone_country\": \"UG\",   \"phone_number\": \"752403639\",   \"email\": \"example@home.org\",   \"name\": \"MyCompany\",   \"city\": \"Kampala\",   \"street\": \"Unknown 17-3\",   \"postal_code\": \"798983\",   \"address_description\": \"Description of address\",   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"external_id\": \"806ec63a-a5a7-43cc-9d75-1ee74fbcc026\",   \"metadata\": { } } ```  [Sender in the API documentation](https://github.com/bitpesa/api-documentation/blob/master/transaction-flow.md#sender)
   class Sender
     # Type of sender to create - either person or business (defaults to person) 
     attr_accessor :type
@@ -85,6 +85,9 @@ module Bitpesa
 
     attr_accessor :id
 
+    # 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.
+    attr_accessor :external_id
+
     # The fields that have some problems and don't pass validation
     attr_accessor :errors
 
@@ -137,6 +140,7 @@ module Bitpesa
         :'metadata' => :'metadata',
         :'state' => :'state',
         :'id' => :'id',
+        :'external_id' => :'external_id',
         :'errors' => :'errors'
       }
     end
@@ -168,6 +172,7 @@ module Bitpesa
         :'metadata' => :'Object',
         :'state' => :'SenderState',
         :'id' => :'String',
+        :'external_id' => :'String',
         :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
       }
     end
@@ -278,6 +283,10 @@ module Bitpesa
         self.id = attributes[:'id']
       end
 
+      if attributes.has_key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      end
+
       if attributes.has_key?(:'errors')
         if (value = attributes[:'errors']).is_a?(Hash)
           self.errors = value
@@ -379,6 +388,7 @@ module Bitpesa
           metadata == o.metadata &&
           state == o.state &&
           id == o.id &&
+          external_id == o.external_id &&
           errors == o.errors
     end
 
@@ -391,7 +401,7 @@ module Bitpesa
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, country, phone_country, phone_number, email, first_name, middle_name, last_name, occupation, nationality, onboarding_status, address, description, name, city, street, address_description, postal_code, birth_date, ip, documents, metadata, state, id, errors].hash
+      [type, country, phone_country, phone_number, email, first_name, middle_name, last_name, occupation, nationality, onboarding_status, address, description, name, city, street, address_description, postal_code, birth_date, ip, documents, metadata, state, id, external_id, errors].hash
     end
 
 require 'active_support/core_ext/hash'