bitpesa-sdk 0.1.0 → 0.2.0

data/lib/bitpesa-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.0.0-beta2
 =end
 
 module Bitpesa
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/api/account_debits_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::AccountDebitsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::AccountDebitsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AccountDebitsApi' do
   before do
     # run before each test
-    @instance = BitPesa::AccountDebitsApi.new
+    @instance = Bitpesa::AccountDebitsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'AccountDebitsApi' do
 
   describe 'test an instance of AccountDebitsApi' do
     it 'should create an instance of AccountDebitsApi' do
-      expect(@instance).to be_instance_of(BitPesa::AccountDebitsApi)
+      expect(@instance).to be_instance_of(Bitpesa::AccountDebitsApi)
     end
   end
 
@@ -37,9 +37,9 @@ describe 'AccountDebitsApi' do
   # Returns a single account debit by the account debit ID
   # @param account_debit_id ID of the account debit to get.  Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2003]
+  # @return [DebitResponse]
   describe 'get_accounts_debit test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,21 +48,23 @@ describe 'AccountDebitsApi' do
   # Listing Accounts debits
   # Get a list of accounts debits
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2002]
+  # @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)
+  # @return [DebitListResponse]
   describe 'get_accounts_debits test' do
-    it "should work" 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_accounts_debits
   # Creating an account debit
-  # Creates a new account debit  Funding transactions can be done using the POST /v1/accounts/debits endpoint, with the following body - ```JSON {   \"debit\": {     \"currency\": \"NGN\",     \"amount\": \"2000.0\",     \"to_id\": \"5f44026b-7904-4c30-87d6-f8972d790ded\",     \"to_type\": \"Transaction\"   } } ```  To successfully fund a transaction -  - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet  Once the transaction is funded, we will immediately start trying to pay out the recipient(s).  ## Creating bulk account debits  To create multiple account debits an array of account debit objects should be sent using the POST /v1/accounts/debits endpoint. An example is below -  ```JSON {   \"debit\": [     {       \"currency\": \"BTC\",       \"amount\": 2.0,       \"to_id\": \"d9269c2a-7049-4625-b3b8-30e25ad33162\",       \"to_type\": \"Transaction\",       \"metadata\": {         \"id\": \"b783a4f5-a959-4a1f-87fa-112fe6eae9e4\"       }     },     {       \"currency\": \"BTC\",       \"amount\": 2.0,       \"to_id\": \"912973a9-e027-4768-8e98-5a8f44469bf4\",       \"to_type\": \"Transaction\",       \"metadata\": {         \"id\": \"4900f50a-bfb6-469f-ad0e-8c8cf0ef5dfa\"       }     }   ] } ``` 
-  # @param debit 
+  # Creates a new account debit finding transaction through the internal balance  To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet  Once the transaction is funded, we will immediately start trying to pay out the recipient(s).  It is also possible to create multiple account debits by supplying an array of debit objects 
+  # @param debit_request_wrapper 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201]
+  # @return [DebitListResponse]
   describe 'post_accounts_debits test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/account_validation_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::AccountValidationApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::AccountValidationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AccountValidationApi' do
   before do
     # run before each test
-    @instance = BitPesa::AccountValidationApi.new
+    @instance = Bitpesa::AccountValidationApi.new
   end
 
   after do
@@ -28,18 +28,18 @@ describe 'AccountValidationApi' do
 
   describe 'test an instance of AccountValidationApi' do
     it 'should create an instance of AccountValidationApi' do
-      expect(@instance).to be_instance_of(BitPesa::AccountValidationApi)
+      expect(@instance).to be_instance_of(Bitpesa::AccountValidationApi)
     end
   end
 
   # unit tests for post_account_validations
   # Validates the existence of a bank account
   # Validates the existence of a bank account and returns the associated customer name
-  # @param body 
+  # @param account_validation_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2002]
+  # @return [AccountValidationResponse]
   describe 'post_account_validations test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/accounts_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::AccountsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::AccountsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'AccountsApi' do
   before do
     # run before each test
-    @instance = BitPesa::AccountsApi.new
+    @instance = Bitpesa::AccountsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'AccountsApi' do
 
   describe 'test an instance of AccountsApi' do
     it 'should create an instance of AccountsApi' do
-      expect(@instance).to be_instance_of(BitPesa::AccountsApi)
+      expect(@instance).to be_instance_of(Bitpesa::AccountsApi)
     end
   end
 
@@ -37,20 +37,20 @@ describe 'AccountsApi' do
   # Fetches account balance for specified currrency, and returns current balance and associated currency code
   # @param currency Currency code of account balance to fetch  Example: `/v1/accounts/USD`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2001]
+  # @return [AccountResponse]
   describe 'get_account test' do
-    it "should work" 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_accounts
-  # Fetches account balances for all currrencies
-  # Fetches account balances for all currrencies, and returns an array of the current balances and associated currency codes.
+  # Fetches account balances for all currencies
+  # Fetches account balances for all currencies, and returns an array of the current balances and associated currency codes.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
+  # @return [AccountListResponse]
   describe 'get_accounts test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/api_logs_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::APILogsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::APILogsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'APILogsApi' do
   before do
     # run before each test
-    @instance = BitPesa::APILogsApi.new
+    @instance = Bitpesa::APILogsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'APILogsApi' do
 
   describe 'test an instance of APILogsApi' do
     it 'should create an instance of APILogsApi' do
-      expect(@instance).to be_instance_of(BitPesa::APILogsApi)
+      expect(@instance).to be_instance_of(Bitpesa::APILogsApi)
     end
   end
 
@@ -37,9 +37,9 @@ describe 'APILogsApi' do
   # Returns a single API log based on the API log ID.
   # @param api_log_id ID of the API log to retrieve  Example: `/v1/api_logs/00485ce9-532b-45e7-8518-7e5582242407`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2004]
+  # @return [ApiLogResponse]
   describe 'get_api_log test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,9 +48,13 @@ describe 'APILogsApi' do
   # Fetch a list of API logs
   # Returns a list of API logs. Also includes information relating to the original request.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2003]
+  # @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] :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`
+  # @return [ApiLogListResponse]
   describe 'get_api_logs test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/currency_info_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::CurrencyInfoApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::CurrencyInfoApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'CurrencyInfoApi' do
   before do
     # run before each test
-    @instance = BitPesa::CurrencyInfoApi.new
+    @instance = Bitpesa::CurrencyInfoApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'CurrencyInfoApi' do
 
   describe 'test an instance of CurrencyInfoApi' do
     it 'should create an instance of CurrencyInfoApi' do
-      expect(@instance).to be_instance_of(BitPesa::CurrencyInfoApi)
+      expect(@instance).to be_instance_of(Bitpesa::CurrencyInfoApi)
     end
   end
 
@@ -36,9 +36,9 @@ describe 'CurrencyInfoApi' do
   # Getting a list of possible requested currencies
   # Fetches a list of currencies available to use in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2005]
+  # @return [CurrencyListResponse]
   describe 'info_currencies test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -47,9 +47,9 @@ describe 'CurrencyInfoApi' do
   # Getting a list of possible input currencies
   # Fetches a list of currencies available to use as the input currency in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. Use this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available. 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2006]
+  # @return [CurrencyExchangeListResponse]
   describe 'info_currencies_in test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -58,9 +58,9 @@ describe 'CurrencyInfoApi' do
   # Getting a list of possible output currencies
   # Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2006]
+  # @return [CurrencyExchangeListResponse]
   describe 'info_currencies_out test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/documents_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::DocumentsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::DocumentsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'DocumentsApi' do
   before do
     # run before each test
-    @instance = BitPesa::DocumentsApi.new
+    @instance = Bitpesa::DocumentsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'DocumentsApi' do
 
   describe 'test an instance of DocumentsApi' do
     it 'should create an instance of DocumentsApi' do
-      expect(@instance).to be_instance_of(BitPesa::DocumentsApi)
+      expect(@instance).to be_instance_of(Bitpesa::DocumentsApi)
     end
   end
 
@@ -37,9 +37,9 @@ describe 'DocumentsApi' do
   # Returns a single document by the Documents ID
   # @param document_id ID of the document to get.  Example: `/v1/documents/bf9ff782-e182-45ac-abea-5bce83ad6670`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201]
+  # @return [DocumentResponse]
   describe 'get_document test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,9 +48,11 @@ describe 'DocumentsApi' do
   # Getting a list of documents
   # Fetches a list of documents.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2007]
+  # @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)
+  # @return [DocumentListResponse]
   describe 'get_documents test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -58,11 +60,11 @@ describe 'DocumentsApi' do
   # unit tests for post_documents
   # Creating a document
   # Creates a new document
-  # @param document 
+  # @param document_request 
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201]
+  # @return [DocumentResponse]
   describe 'post_documents test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end

data/spec/api/logs_api_spec.rb

@@ -1,25 +1,25 @@
 =begin
 #BitPesa API
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#Reference documentation for the BitPesa API V1
 
 OpenAPI spec version: 1.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
 
 =end
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for BitPesa::LogsApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Unit tests for Bitpesa::LogsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'LogsApi' do
   before do
     # run before each test
-    @instance = BitPesa::LogsApi.new
+    @instance = Bitpesa::LogsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'LogsApi' do
 
   describe 'test an instance of LogsApi' do
     it 'should create an instance of LogsApi' do
-      expect(@instance).to be_instance_of(BitPesa::LogsApi)
+      expect(@instance).to be_instance_of(Bitpesa::LogsApi)
     end
   end
 
@@ -37,9 +37,9 @@ describe 'LogsApi' do
   # Returns a single webhook log based on the webhook log ID.
   # @param webhook_log_id ID of the webhook log to retrieve  Example: `/v1/logs/9d1ad631-f34a-4cff-9a7e-2c83e3a556df`
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse20010]
+  # @return [WebhookLogResponse]
   describe 'get_webhook_log test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -48,9 +48,13 @@ describe 'LogsApi' do
   # Fetch a list of webhook logs
   # Returns a list of webhook logs. Response includes pagination.
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse2009]
+  # @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] :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`
+  # @return [WebhookLogListResponse]
   describe 'get_webhook_logs test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end