bitpesa-sdk 0.1.0

data/docs/RecipientRequest.md

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

data/docs/RecipientResponse.md

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

data/docs/RecipientState.md

@@ -0,0 +1,7 @@
+# Bitpesa::RecipientState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RecipientValidResponse.md

@@ -0,0 +1,26 @@
+# Bitpesa::RecipientValidResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_amount** | **Float** | the amount that should be paid to the recipient. This can be in any currency, usually either the input or the output currency. If the value here is not the output currency we will calculate how much the recipient is going to get using the exchange rates active when the transaction was created. | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethodBase**](PayoutMethodBase.md) |  | 
+**metadata** | **Object** | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
+**created_at** | **DateTime** | Date and time that the recipient was created. | [optional] 
+**editable** | **BOOLEAN** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint 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] 
+**state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state** | **String** | The state of the recipient. Can be one of the following:  * `initial`: We haven't initiated the payout yet, you can still cancel the transaction * `pending`: Payout has been initiated and we're waiting from a response from the provider. The transaction cannot be cancelled * `success`: Payout is done, and the recipient has been paid. * `error`: There was an error from the provider, you can find more details in the `state_reason` attribute. We will usually retry the transaction at a later date. You can either wait, edit the recipient or cancel the transaction. * `refunded`: You asked us to cancel the transaction and we refunded the money. * `manual`: There were too many errors on this transaction, and we stopped retrying. Please edit the recipient, contact us or cancel the transaction. * `stuck`: We didn't receive a response from the provider in time, and we don't know whether it has been paid our not. Please contact us for further details. * `overpaid`: The recipient was paid out more than was requested (not applicable for most of the payout providers) * `canceled`: The transaction has been cancelled, and we will refund the money soon * `exception`: Some exception has happened; please contact BitPesa | [optional] 
+**transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
+**transaction_state** | **String** | The state of the transaction related to this recipient. Please note that even if the transaction's state is `approved`, the state here will only say `initial`. This still means that the sender is approved however and the transaction can be funded. | [optional] 
+**exchange_rate** | **Float** | The exchange rate used in this payment | [optional] 
+**fee_fractional** | **Float** | The fee for this payment in fractioanl units (for example cents for USD transactions) | [optional] 
+**input_amount** | **Float** | The amount that had to be paid in for this payment to proceed | [optional] 
+**input_currency** | **String** | The currency this payment was paid in | [optional] 
+**output_amount** | **Float** | The amount that will be paid to the recipient | [optional] 
+**output_currency** | **String** | The currency the payment will be delivered in | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/RecipientWebhook.md

@@ -0,0 +1,10 @@
+# Bitpesa::RecipientWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **String** | The ID of the webhook that was used to send out this callback | 
+**event** | **String** | The event that triggered this webhook | 
+**object** | [**Recipient**](Recipient.md) |  | 
+
+

data/docs/RecipientsApi.md

@@ -0,0 +1,212 @@
+# Bitpesa::RecipientsApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_recipient**](RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
+[**get_recipients**](RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
+[**patch_recipient**](RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+
+
+# **delete_recipient**
+> RecipientResponse delete_recipient(recipient_id)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::RecipientsApi.new
+
+
+begin
+  #Cancelling a recipient
+  result = api_instance.delete_recipient(recipient_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->delete_recipient: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33` | 
+
+### Return type
+
+[**RecipientResponse**](RecipientResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_recipients**
+> RecipientListResponse get_recipients(opts)
+
+Getting a list of recipients with filtering
+
+Fetches details of all recipients.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::RecipientsApi.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)
+  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`
+  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/bitpesa/api-documentation/blob/master/transaction-flow.md#state-1) 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`
+}
+
+begin
+  #Getting a list of recipients with filtering
+  result = api_instance.get_recipients(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientListResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->get_recipients: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page number to request (defaults to 1) | [optional] 
+ **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
+ **created_at_from** | **String**| Start 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] 
+ **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/bitpesa/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] 
+ **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
+
+[**RecipientListResponse**](RecipientListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **patch_recipient**
+> RecipientResponse patch_recipient(recipient_idrecipient_request)
+
+Updating a recipient
+
+Updates the recipient specified in the URL path.  Please note that only recipients where the `editable` field is true can be modified. Once the recipient is modified any subsequent payout tries will be sent to the updated details.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::RecipientsApi.new
+
+
+begin
+  #Updating a recipient
+  result = api_instance.patch_recipient(recipient_idrecipient_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->patch_recipient: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60; | 
+ **recipient_request** | [**RecipientRequest**](RecipientRequest.md)|  | 
+
+### Return type
+
+[**RecipientResponse**](RecipientResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Sender.md

@@ -0,0 +1,32 @@
+# Bitpesa::Sender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+**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 | 
+**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] 
+**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 | 
+**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] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+

data/docs/SenderBase.md

@@ -0,0 +1,30 @@
+# Bitpesa::SenderBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+**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 | 
+**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] 
+**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 | 
+**documents** | [**Array<DocumentBase>**](DocumentBase.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** | 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] 
+**providers** | **Object** | Providers associated with sender (deprecated) | [optional] 
+
+

data/docs/SenderErrorResponse.md

@@ -0,0 +1,32 @@
+# Bitpesa::SenderErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+**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 | 
+**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] 
+**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 | 
+**documents** | [**Array<DocumentBase>**](DocumentBase.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** | 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] 
+**providers** | **Object** | Providers associated with sender (deprecated) | [optional] 
+**state** | **String** | The state of the sender. Can be one of the following:  - `initial`: When a sender is created and has not been through any KYC checking (cannot transact) - `verified`: A sender has passed sanction list checks (cannot transact) - `approved`: The sender has passed both KYC and sanction checks (can transact) - `banned`: An admin has banned the sender (cannot transact) - `rejected`: The sender has failed sanction list checks (cannot transact) - `disabled`: A sender is put into this state as a result of a delete request via the API (cannot transact) | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/SenderExistingRequest.md

@@ -0,0 +1,8 @@
+# Bitpesa::SenderExistingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+
+

data/docs/SenderFullRequest.md

@@ -0,0 +1,30 @@
+# Bitpesa::SenderFullRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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 | 
+**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 | 
+**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] 
+**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 | 
+**documents** | [**Array<DocumentBase>**](DocumentBase.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** | 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] 
+**providers** | **Object** | Providers associated with sender (deprecated) | [optional] 
+
+

data/docs/SenderListResponse.md

@@ -0,0 +1,9 @@
+# Bitpesa::SenderListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<Sender>**](Sender.md) |  | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+

data/docs/SenderRequest.md

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

data/docs/SenderResponse.md

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