bitpesa-sdk 0.1.0

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

@@ -0,0 +1,187 @@
+=begin
+#BitPesa API
+
+#Reference documentation for the BitPesa API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
+
+=end
+
+require 'uri'
+
+module Bitpesa
+  class AccountDebitsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetching an account debit
+    # 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 [DebitResponse]
+    def get_accounts_debit(account_debit_id, opts = {})
+      data, _status_code, _headers = get_accounts_debit_with_http_info(account_debit_id, opts)
+      data
+    end
+
+    # Fetching an account debit
+    # 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 [Array<(DebitResponse, Fixnum, Hash)>] DebitResponse data, response status code and response headers
+    def get_accounts_debit_with_http_info(account_debit_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debit ...'
+      end
+      # verify the required parameter 'account_debit_id' is set
+      if @api_client.config.client_side_validation && account_debit_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_debit_id' when calling AccountDebitsApi.get_accounts_debit"
+      end
+      # resource path
+      local_var_path = '/accounts/debits/{Account Debit ID}'.sub('{' + 'Account Debit ID' + '}', account_debit_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Listing Accounts debits
+    # Get a list of accounts debits
+    # @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)
+    # @return [DebitListResponse]
+    def get_accounts_debits(opts = {})
+      data, _status_code, _headers = get_accounts_debits_with_http_info(opts)
+      data
+    end
+
+    # Listing Accounts debits
+    # Get a list of accounts debits
+    # @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)
+    # @return [Array<(DebitListResponse, Fixnum, Hash)>] DebitListResponse data, response status code and response headers
+    def get_accounts_debits_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debits ...'
+      end
+      # resource path
+      local_var_path = '/accounts/debits'
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Creating an account 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 [DebitListResponse]
+    def post_accounts_debits(debit_request_wrapper, opts = {})
+      data, _status_code, _headers = post_accounts_debits_with_http_info(debit_request_wrapper, opts)
+      data
+    end
+
+    # Creating an account 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 [Array<(DebitListResponse, Fixnum, Hash)>] DebitListResponse data, response status code and response headers
+    def post_accounts_debits_with_http_info(debit_request_wrapper, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.post_accounts_debits ...'
+      end
+      # verify the required parameter 'debit_request_wrapper' is set
+      if @api_client.config.client_side_validation && debit_request_wrapper.nil?
+        fail ArgumentError, "Missing the required parameter 'debit_request_wrapper' when calling AccountDebitsApi.post_accounts_debits"
+      end
+      # resource path
+      local_var_path = '/accounts/debits'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(debit_request_wrapper)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#post_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+=begin
+#BitPesa API
+
+#Reference documentation for the BitPesa API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
+
+=end
+
+require 'uri'
+
+module Bitpesa
+  class AccountValidationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Validates the existence of a bank account
+    # Validates the existence of a bank account and returns the associated customer name
+    # @param account_validation_request 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountValidationResponse]
+    def post_account_validations(account_validation_request, opts = {})
+      data, _status_code, _headers = post_account_validations_with_http_info(account_validation_request, opts)
+      data
+    end
+
+    # Validates the existence of a bank account
+    # Validates the existence of a bank account and returns the associated customer name
+    # @param account_validation_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountValidationResponse, Fixnum, Hash)>] AccountValidationResponse data, response status code and response headers
+    def post_account_validations_with_http_info(account_validation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountValidationApi.post_account_validations ...'
+      end
+      # verify the required parameter 'account_validation_request' is set
+      if @api_client.config.client_side_validation && account_validation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_validation_request' when calling AccountValidationApi.post_account_validations"
+      end
+      # resource path
+      local_var_path = '/account_validations'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(account_validation_request)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AccountValidationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountValidationApi#post_account_validations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,135 @@
+=begin
+#BitPesa API
+
+#Reference documentation for the BitPesa API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
+
+=end
+
+require 'uri'
+
+module Bitpesa
+  class AccountsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetches account balance for specified currrency
+    # 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 [AccountResponse]
+    def get_account(currency, opts = {})
+      data, _status_code, _headers = get_account_with_http_info(currency, opts)
+      data
+    end
+
+    # Fetches account balance for specified currrency
+    # 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 [Array<(AccountResponse, Fixnum, Hash)>] AccountResponse data, response status code and response headers
+    def get_account_with_http_info(currency, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.get_account ...'
+      end
+      # verify the required parameter 'currency' is set
+      if @api_client.config.client_side_validation && currency.nil?
+        fail ArgumentError, "Missing the required parameter 'currency' when calling AccountsApi.get_account"
+      end
+      # resource path
+      local_var_path = '/accounts/{Currency}'.sub('{' + 'Currency' + '}', currency.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AccountResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    def get_accounts_all(opts = {})
+      result = []
+      response = get_accounts(opts)
+      result += response["object"]
+      while next_page = response["meta"]["pagination"]["next_page"]
+        response = get_accounts(opts.merge(page: next_page))
+        result += response["object"]
+      end
+      result
+    end
+
+    # 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 [AccountListResponse]
+    def get_accounts(opts = {})
+      data, _status_code, _headers = get_accounts_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(AccountListResponse, Fixnum, Hash)>] AccountListResponse data, response status code and response headers
+    def get_accounts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...'
+      end
+      # resource path
+      local_var_path = '/accounts'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AccountListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,137 @@
+=begin
+#BitPesa API
+
+#Reference documentation for the BitPesa API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta2
+
+=end
+
+require 'uri'
+
+module Bitpesa
+  class APILogsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetch an individual API log
+    # 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 [ApiLogResponse]
+    def get_api_log(api_log_id, opts = {})
+      data, _status_code, _headers = get_api_log_with_http_info(api_log_id, opts)
+      data
+    end
+
+    # Fetch an individual API log
+    # 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 [Array<(ApiLogResponse, Fixnum, Hash)>] ApiLogResponse data, response status code and response headers
+    def get_api_log_with_http_info(api_log_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APILogsApi.get_api_log ...'
+      end
+      # verify the required parameter 'api_log_id' is set
+      if @api_client.config.client_side_validation && api_log_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_log_id' when calling APILogsApi.get_api_log"
+      end
+      # resource path
+      local_var_path = '/api_logs/{API Log ID}'.sub('{' + 'API Log ID' + '}', api_log_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiLogResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APILogsApi#get_api_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # 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
+    # @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 &#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] :created_at_to 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;
+    # @return [ApiLogListResponse]
+    def get_api_logs(opts = {})
+      data, _status_code, _headers = get_api_logs_with_http_info(opts)
+      data
+    end
+
+    # 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
+    # @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 &#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] :created_at_to 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;
+    # @return [Array<(ApiLogListResponse, Fixnum, Hash)>] ApiLogListResponse data, response status code and response headers
+    def get_api_logs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: APILogsApi.get_api_logs ...'
+      end
+      # resource path
+      local_var_path = '/api_logs'
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      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?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ApiLogListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: APILogsApi#get_api_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end