bitpesa-sdk 0.1.0

data/spec/api/payout_methods_api_spec.rb

@@ -0,0 +1,58 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::PayoutMethodsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PayoutMethodsApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::PayoutMethodsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutMethodsApi' do
+    it 'should create an instance of PayoutMethodsApi' do
+      expect(@instance).to be_instance_of(BitPesa::PayoutMethodsApi)
+    end
+  end
+
+  # unit tests for get_payout_method
+  # Fetching a payout method
+  # Show a payout method by id
+  # @param payout_method_id ID of the payout method to get.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20012]
+  describe 'get_payout_method test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payout_methods
+  # Listing payout methods
+  # List available payout methods
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20011]
+  describe 'get_payout_methods test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/recipients_api_spec.rb

@@ -0,0 +1,74 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::RecipientsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RecipientsApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::RecipientsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RecipientsApi' do
+    it 'should create an instance of RecipientsApi' do
+      expect(@instance).to be_instance_of(BitPesa::RecipientsApi)
+    end
+  end
+
+  # unit tests for delete_recipient
+  # Cancelling a recipient
+  # Cancels the recipient specified in the URL path.
+  # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20014]
+  describe 'delete_recipient test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_recipients
+  # Getting a list of recipients with filtering
+  # Fetches details of all recipients.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :state 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;
+  # @option opts [Array<String>] :currency Allows filtering results by &#x60;input_currency&#x60;.  Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60;
+  # @option opts [String] :created_at 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;
+  # @option opts [String] :amount 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;BTC&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60;
+  # @return [InlineResponse20013]
+  describe 'get_recipients test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for patch_recipient
+  # Updating a recipient
+  # Updates the recipient specified in the URL path.
+  # @param recipient_id ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60;
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20014]
+  describe 'patch_recipient test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/senders_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::SendersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SendersApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::SendersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SendersApi' do
+    it 'should create an instance of SendersApi' do
+      expect(@instance).to be_instance_of(BitPesa::SendersApi)
+    end
+  end
+
+  # unit tests for delete_sender
+  # Deleting a sender
+  # Deletes a single sender by the Sender ID
+  # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2011]
+  describe 'delete_sender test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_sender
+  # Fetching a sender
+  # Returns a single sender by the Sender ID
+  # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2011]
+  describe 'get_sender test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_senders
+  # Listing senders
+  # Get a list of available senders
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20015]
+  describe 'get_senders test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for patch_sender
+  # Updating a sender
+  # Updates the sender specified in the URL path.
+  # @param sender_id ID of the sender to get.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param sender 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2011]
+  describe 'patch_sender test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_senders
+  # Creating a sender
+  # Creates a new sender and transitions their onboarding status  When a sender is created you will receive a response which contains the senders status. Possible states for a sender are:  - 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) 
+  # @param sender 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2011]
+  describe 'post_senders test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/transaction_requests_api_spec.rb

@@ -0,0 +1,76 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::TransactionRequestsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TransactionRequestsApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::TransactionRequestsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TransactionRequestsApi' do
+    it 'should create an instance of TransactionRequestsApi' do
+      expect(@instance).to be_instance_of(BitPesa::TransactionRequestsApi)
+    end
+  end
+
+  # unit tests for get_transaction_request
+  # Fetching a transaction request
+  # Returns a single transaction request by the Transaction Request ID
+  # @param transaction_request_id ID of the transaction request to get.  Example: `/v1/transaction_requests/bf9ff782-e182-45ac-abea-5bce83ad6670`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2013]
+  describe 'get_transaction_request test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_transaction_requests
+  # Listing transaction requests
+  # Get a list of transaction requests
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :state Returns transaction requests with specified states.  Example: &#x60;/v1/transaction_requests?state[]&#x3D;pending&amp;state[]&#x3D;modified&#x60;
+  # @option opts [Array<String>] :currency Returns transaction requests with specified input_currency.  Example: &#x60;/v1/transaction_requests?state[]&#x3D;pending&amp;state[]&#x3D;modified&#x60;
+  # @option opts [String] :created_at_from Returns transaction requests with specified created_at lower limit.  Example: &#x60;/v1/transaction_requests?created_at_from&#x3D;2018-06-09&#x60;
+  # @option opts [String] :created_at_to Returns transaction requests with specified created_at upper limit.  Example: &#x60;/v1/transaction_requests?created_at_to&#x3D;2018-06-08&#x60;
+  # @option opts [String] :amount_from Returns transaction requests with specified amount lower limit.  Example: &#x60;/v1/transaction_requests?currency&#x3D;BTC&amp;amount_from&#x3D;2.4319983&#x60;
+  # @option opts [String] :amount_to Returns transaction requests with specified amount upper limit.  Example: &#x60;/v1/transaction_requests?currency&#x3D;BTC&amp;amount_to&#x3D;2.4319985&#x60;
+  # @return [InlineResponse20016]
+  describe 'get_transaction_requests test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_transaction_request
+  # Creating a transaction request
+  # Creates a new transaction request 
+  # @param transaction_request 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2013]
+  describe 'post_transaction_request test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/transactions_api_spec.rb

@@ -0,0 +1,96 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::TransactionsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'TransactionsApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::TransactionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TransactionsApi' do
+    it 'should create an instance of TransactionsApi' do
+      expect(@instance).to be_instance_of(BitPesa::TransactionsApi)
+    end
+  end
+
+  # unit tests for calculate_transactions
+  # Calculates transaction amounts for a transaction payload
+  # Calculates the input, output and fee amounts for the recipients in a transaction payload
+  # @param transaction Transaction payload to be calculated
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2012]
+  describe 'calculate_transactions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payin_transaction
+  # Creates a fake payin for transaction
+  # This method is available only in sandbox environment and is supposed to be used only for testing integration. It allows you to emulate a payin without paying actual money. 
+  # @param transaction_id ID of the transaction to payin.  Example: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payin`
+  # @param payin_method A partial payin method object
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2012]
+  describe 'payin_transaction test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for payout_transaction
+  # Creates a fake payout for transaction
+  # This method is available only in sandbox environment and is supposed to be used only for testing. It allows you to emulate the payout of a transaction after payin. 
+  # @param transaction_id ID of the transaction to payout.  Example: `/v1/transactions/bf9ff782-e182-45ac-abea-5bce83ad6670/payout`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2012]
+  describe 'payout_transaction test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_transactions
+  # Creates a new transaction
+  # Transactions are the main objects in the BitPesa API, so it's important to understand how to create and manage them. Transactions facilitate money movement from one Sender in a specific currency to one or multiple Recipients in another currency.  The main flow of a successful transaction flow is the following - - Transaction is created linking the Sender to the Recipient(s) with the requested amounts. - Once the sender is KYC'd and approved the transaction can be funded. - Once the transaction is funded, we will initiate the payout to the recipient(s). - After the recipient (or all recipients) has received the money, the transaction is finished.  Unfortunately not all transactions are successful. The main causes of issues are the following - - Transactions are cancelled automatically if they are not funded within the first hour of creation. - The recipient details might be wrong (for example the destination bank account number is invalid), or there are other issues blocking the successful payout. In these cases the transaction has to be cancelled.  In order to transact with Bitpesa we need to have an approved sender record. The flow for approving senders depend on whether KYC requirements are waived for your integration or not (See the notes section).  In case the KYC requirements are not waived then the typical flow for approval this will be the following.  ![Senders KYC Flow](https://raw.githubusercontent.com/bitpesa/api-documentation/master/uml/sender-kyc.png)  *Notes*  - The sender's phone number is composed of two parts, the phone_country (in ISO 2-letter format), and the phone_number. The phone number should be specified without the international prefix. - The documents should contain all documents necessary to KYC the sender.   - If you already do KYC on your system, then please contact us and we can waive this requirement from you. In this case you should send us an empty list of documents - `\"documents\": [ ]` in the request. All of the senders you create in the system will be immediately set to the approved state and you won't need to wait for them to get approved.   - If when creating senders or transactions you get the following error in the response - `\"errors\":{\"documents\":[{\"error\":\"blank\"}]}` it means that KYC requirements are not yet waived for your account. If we already approved your KYC process and so they should be, then please contact us so we can rectify the issue and update your account accordingly.   - In case you don't do KYC on your site, then you will need to send us documents that we can use to verify the sender's identity, for more details on this please see the API reference documentation. - The metadata field can store any information you wish to store with the sender. Usual data would include the ID inside your own system for this particular sender. If you don't wish to store anything simply specify {}.
+  # @param transaction Transaction object to be created
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2012]
+  describe 'post_transactions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for validate_transactions
+  # Validates a transaction payload
+  # Validates fields in a transaction payload and displays invalid or missing fields
+  # @param transaction Transaction payload to be validated
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2012]
+  describe 'validate_transactions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/webhooks_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#BitPesa API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BitPesa::WebhooksApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'WebhooksApi' do
+  before do
+    # run before each test
+    @instance = BitPesa::WebhooksApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhooksApi' do
+    it 'should create an instance of WebhooksApi' do
+      expect(@instance).to be_instance_of(BitPesa::WebhooksApi)
+    end
+  end
+
+  # unit tests for delete_webhook
+  # Unsubscribing from a webhook
+  # Unsubscribes from a webhook specified
+  # @param webhook_id The ID of webhook to cancel.  Example: `/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2014]
+  describe 'delete_webhook test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_webhook
+  # Find a webhook's details
+  # Look up a webhook's details with its ID
+  # @param webhook_id The ID of the Webhook to look up  Example: `/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33`
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2014]
+  describe 'get_webhook test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_webhook_events
+  # Find possible webhook events
+  # Fetching possible webhook events
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20018]
+  describe 'get_webhook_events test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_webhooks
+  # Listing webhooks
+  # Get a list of created webhooks
+  # @param page The page number to request
+  # @param per The number of results to load per page
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse20017]
+  describe 'get_webhooks test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_webhooks
+  # Creating a webhook
+  # Creates a new webhook, subscribing the provided endpoint to the specified event(s) 
+  # @param webhook Webhook object to be created
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2014]
+  describe 'post_webhooks test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end