bitpesa-sdk 0.1.0

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

@@ -0,0 +1,167 @@
+=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 CurrencyInfoApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # 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 [CurrencyListResponse]
+    def info_currencies(opts = {})
+      data, _status_code, _headers = info_currencies_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(CurrencyListResponse, Fixnum, Hash)>] CurrencyListResponse data, response status code and response headers
+    def info_currencies_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CurrencyInfoApi.info_currencies ...'
+      end
+      # resource path
+      local_var_path = '/info/currencies'
+
+      # 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 => 'CurrencyListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CurrencyInfoApi#info_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # 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 [CurrencyExchangeListResponse]
+    def info_currencies_in(opts = {})
+      data, _status_code, _headers = info_currencies_in_with_http_info(opts)
+      data
+    end
+
+    # 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&#39;s available. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CurrencyExchangeListResponse, Fixnum, Hash)>] CurrencyExchangeListResponse data, response status code and response headers
+    def info_currencies_in_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CurrencyInfoApi.info_currencies_in ...'
+      end
+      # resource path
+      local_var_path = '/info/currencies/in'
+
+      # 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 => 'CurrencyExchangeListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CurrencyInfoApi#info_currencies_in\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # 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 [CurrencyExchangeListResponse]
+    def info_currencies_out(opts = {})
+      data, _status_code, _headers = info_currencies_out_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(CurrencyExchangeListResponse, Fixnum, Hash)>] CurrencyExchangeListResponse data, response status code and response headers
+    def info_currencies_out_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CurrencyInfoApi.info_currencies_out ...'
+      end
+      # resource path
+      local_var_path = '/info/currencies/out'
+
+      # 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 => 'CurrencyExchangeListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CurrencyInfoApi#info_currencies_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,197 @@
+=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 DocumentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetching a document
+    # 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 [DocumentResponse]
+    def get_document(document_id, opts = {})
+      data, _status_code, _headers = get_document_with_http_info(document_id, opts)
+      data
+    end
+
+    # Fetching a document
+    # 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 [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
+    def get_document_with_http_info(document_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentsApi.get_document ...'
+      end
+      # verify the required parameter 'document_id' is set
+      if @api_client.config.client_side_validation && document_id.nil?
+        fail ArgumentError, "Missing the required parameter 'document_id' when calling DocumentsApi.get_document"
+      end
+      # resource path
+      local_var_path = '/documents/{Document ID}'.sub('{' + 'Document ID' + '}', document_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 => 'DocumentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DocumentsApi#get_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    def get_documents_all(opts = {})
+      result = []
+      response = get_documents(opts)
+      result += response["object"]
+      while next_page = response["meta"]["pagination"]["next_page"]
+        response = get_documents(opts.merge(page: next_page))
+        result += response["object"]
+      end
+      result
+    end
+
+    # Getting a list of documents
+    # Fetches a list of documents.
+    # @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 [DocumentListResponse]
+    def get_documents(opts = {})
+      data, _status_code, _headers = get_documents_with_http_info(opts)
+      data
+    end
+
+    # Getting a list of documents
+    # Fetches a list of documents.
+    # @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<(DocumentListResponse, Fixnum, Hash)>] DocumentListResponse data, response status code and response headers
+    def get_documents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentsApi.get_documents ...'
+      end
+      # resource path
+      local_var_path = '/documents'
+
+      # 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 => 'DocumentListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DocumentsApi#get_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Creating a document
+    # Creates a new document
+    # @param document_request 
+    # @param [Hash] opts the optional parameters
+    # @return [DocumentResponse]
+    def post_documents(document_request, opts = {})
+      data, _status_code, _headers = post_documents_with_http_info(document_request, opts)
+      data
+    end
+
+    # Creating a document
+    # Creates a new document
+    # @param document_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DocumentResponse, Fixnum, Hash)>] DocumentResponse data, response status code and response headers
+    def post_documents_with_http_info(document_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DocumentsApi.post_documents ...'
+      end
+      # verify the required parameter 'document_request' is set
+      if @api_client.config.client_side_validation && document_request.nil?
+        fail ArgumentError, "Missing the required parameter 'document_request' when calling DocumentsApi.post_documents"
+      end
+      # resource path
+      local_var_path = '/documents'
+
+      # 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(document_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 => 'DocumentResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DocumentsApi#post_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/bitpesa-sdk/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 LogsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetch an individual webhook log
+    # 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 [WebhookLogResponse]
+    def get_webhook_log(webhook_log_id, opts = {})
+      data, _status_code, _headers = get_webhook_log_with_http_info(webhook_log_id, opts)
+      data
+    end
+
+    # Fetch an individual webhook log
+    # 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 [Array<(WebhookLogResponse, Fixnum, Hash)>] WebhookLogResponse data, response status code and response headers
+    def get_webhook_log_with_http_info(webhook_log_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LogsApi.get_webhook_log ...'
+      end
+      # verify the required parameter 'webhook_log_id' is set
+      if @api_client.config.client_side_validation && webhook_log_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_log_id' when calling LogsApi.get_webhook_log"
+      end
+      # resource path
+      local_var_path = '/logs/{Webhook Log ID}'.sub('{' + 'Webhook Log ID' + '}', webhook_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 => 'WebhookLogResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LogsApi#get_webhook_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Fetch a list of webhook logs
+    # Returns a list of webhook logs. Response includes pagination.
+    # @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 [WebhookLogListResponse]
+    def get_webhook_logs(opts = {})
+      data, _status_code, _headers = get_webhook_logs_with_http_info(opts)
+      data
+    end
+
+    # Fetch a list of webhook logs
+    # Returns a list of webhook logs. Response includes pagination.
+    # @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<(WebhookLogListResponse, Fixnum, Hash)>] WebhookLogListResponse data, response status code and response headers
+    def get_webhook_logs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LogsApi.get_webhook_logs ...'
+      end
+      # resource path
+      local_var_path = '/logs/webhooks'
+
+      # 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 => 'WebhookLogListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LogsApi#get_webhook_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end