bitpesa-sdk 0.1.0

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

@@ -0,0 +1,119 @@
+=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 PaymentMethodsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # This method returns possible payin methods.
+    # Fetching possible payin methods. 
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentMethodListResponse]
+    def payment_methods_in(opts = {})
+      data, _status_code, _headers = payment_methods_in_with_http_info(opts)
+      data
+    end
+
+    # This method returns possible payin methods.
+    # Fetching possible payin methods. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentMethodListResponse, Fixnum, Hash)>] PaymentMethodListResponse data, response status code and response headers
+    def payment_methods_in_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.payment_methods_in ...'
+      end
+      # resource path
+      local_var_path = '/info/payment_methods/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 => 'PaymentMethodListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentMethodsApi#payment_methods_in\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # This method returns possible payout methods.
+    # Fetching possible payout methods. 
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentMethodListResponse]
+    def payment_methods_out(opts = {})
+      data, _status_code, _headers = payment_methods_out_with_http_info(opts)
+      data
+    end
+
+    # This method returns possible payout methods.
+    # Fetching possible payout methods. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentMethodListResponse, Fixnum, Hash)>] PaymentMethodListResponse data, response status code and response headers
+    def payment_methods_out_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PaymentMethodsApi.payment_methods_out ...'
+      end
+      # resource path
+      local_var_path = '/info/payment_methods/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 => 'PaymentMethodListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PaymentMethodsApi#payment_methods_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,321 @@
+=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 PayoutMethodsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Deleting a payout method
+    # Deletes a single payout method by the Payout Method ID
+    # @param payout_method_id ID of the payout method to delete.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutMethodResponse]
+    def delete_payout_method(payout_method_id, opts = {})
+      data, _status_code, _headers = delete_payout_method_with_http_info(payout_method_id, opts)
+      data
+    end
+
+    # Deleting a payout method
+    # Deletes a single payout method by the Payout Method ID
+    # @param payout_method_id ID of the payout method to delete.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutMethodResponse, Fixnum, Hash)>] PayoutMethodResponse data, response status code and response headers
+    def delete_payout_method_with_http_info(payout_method_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.delete_payout_method ...'
+      end
+      # verify the required parameter 'payout_method_id' is set
+      if @api_client.config.client_side_validation && payout_method_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.delete_payout_method"
+      end
+      # resource path
+      local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PayoutMethodResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutMethodsApi#delete_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Fetching a payout method
+    # Show a payout method by id
+    # @param payout_method_id ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutMethodResponse]
+    def get_payout_method(payout_method_id, opts = {})
+      data, _status_code, _headers = get_payout_method_with_http_info(payout_method_id, opts)
+      data
+    end
+
+    # Fetching a payout method
+    # Show a payout method by id
+    # @param payout_method_id ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutMethodResponse, Fixnum, Hash)>] PayoutMethodResponse data, response status code and response headers
+    def get_payout_method_with_http_info(payout_method_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.get_payout_method ...'
+      end
+      # verify the required parameter 'payout_method_id' is set
+      if @api_client.config.client_side_validation && payout_method_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.get_payout_method"
+      end
+      # resource path
+      local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_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 => 'PayoutMethodResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutMethodsApi#get_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Listing payout methods
+    # List available payout methods
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :state Allows filtering results by &#x60;state&#x60; of the payout method.  Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60;
+    # @option opts [Array<String>] :type Allows filtering results by the specified type.  Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60;
+    # @option opts [String] :sender_id Allows filtering results by the specified sender id.  Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @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 [PayoutMethodListResponse]
+    def get_payout_methods(opts = {})
+      data, _status_code, _headers = get_payout_methods_with_http_info(opts)
+      data
+    end
+
+    # Listing payout methods
+    # List available payout methods
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :state Allows filtering results by &#x60;state&#x60; of the payout method.  Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60;
+    # @option opts [Array<String>] :type Allows filtering results by the specified type.  Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60;
+    # @option opts [String] :sender_id Allows filtering results by the specified sender id.  Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @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<(PayoutMethodListResponse, Fixnum, Hash)>] PayoutMethodListResponse data, response status code and response headers
+    def get_payout_methods_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.get_payout_methods ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'state'] && !opts[:'state'].all? { |item| ['enabled', 'disabled'].include?(item) }
+        fail ArgumentError, 'invalid value for "state", must include one of enabled, disabled'
+      end
+      # resource path
+      local_var_path = '/payout_methods'
+
+      # query parameters
+      query_params = {}
+      query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :multi) if !opts[:'state'].nil?
+      query_params[:'type'] = @api_client.build_collection_param(opts[:'type'], :multi) if !opts[:'type'].nil?
+      query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
+      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 => 'PayoutMethodListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutMethodsApi#get_payout_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Updating a payout method
+    # Updates the payout method specified in the URL path.
+    # @param payout_method_id ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @param payout_method 
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutMethodResponse]
+    def patch_payout_method(payout_method_id, payout_method, opts = {})
+      data, _status_code, _headers = patch_payout_method_with_http_info(payout_method_id, payout_method, opts)
+      data
+    end
+
+    # Updating a payout method
+    # Updates the payout method specified in the URL path.
+    # @param payout_method_id ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60;
+    # @param payout_method 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutMethodResponse, Fixnum, Hash)>] PayoutMethodResponse data, response status code and response headers
+    def patch_payout_method_with_http_info(payout_method_id, payout_method, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.patch_payout_method ...'
+      end
+      # verify the required parameter 'payout_method_id' is set
+      if @api_client.config.client_side_validation && payout_method_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_method_id' when calling PayoutMethodsApi.patch_payout_method"
+      end
+      # verify the required parameter 'payout_method' is set
+      if @api_client.config.client_side_validation && payout_method.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_method' when calling PayoutMethodsApi.patch_payout_method"
+      end
+      # resource path
+      local_var_path = '/payout_methods/{Payout Method ID}'.sub('{' + 'Payout Method ID' + '}', payout_method_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'])
+      # 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(payout_method)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PayoutMethodResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutMethodsApi#patch_payout_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Creating a payout method
+    # Creates a new payout method in our system. 
+    # @param payout_method_request 
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutMethodResponse]
+    def post_payout_methods(payout_method_request, opts = {})
+      data, _status_code, _headers = post_payout_methods_with_http_info(payout_method_request, opts)
+      data
+    end
+
+    # Creating a payout method
+    # Creates a new payout method in our system. 
+    # @param payout_method_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutMethodResponse, Fixnum, Hash)>] PayoutMethodResponse data, response status code and response headers
+    def post_payout_methods_with_http_info(payout_method_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutMethodsApi.post_payout_methods ...'
+      end
+      # verify the required parameter 'payout_method_request' is set
+      if @api_client.config.client_side_validation && payout_method_request.nil?
+        fail ArgumentError, "Missing the required parameter 'payout_method_request' when calling PayoutMethodsApi.post_payout_methods"
+      end
+      # resource path
+      local_var_path = '/payout_methods'
+
+      # 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(payout_method_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 => 'PayoutMethodResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutMethodsApi#post_payout_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,221 @@
+=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 RecipientsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # 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.
+    # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
+    # @param [Hash] opts the optional parameters
+    # @return [RecipientResponse]
+    def delete_recipient(recipient_id, opts = {})
+      data, _status_code, _headers = delete_recipient_with_http_info(recipient_id, opts)
+      data
+    end
+
+    # 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.
+    # @param recipient_id ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RecipientResponse, Fixnum, Hash)>] RecipientResponse data, response status code and response headers
+    def delete_recipient_with_http_info(recipient_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecipientsApi.delete_recipient ...'
+      end
+      # verify the required parameter 'recipient_id' is set
+      if @api_client.config.client_side_validation && recipient_id.nil?
+        fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RecipientsApi.delete_recipient"
+      end
+      # resource path
+      local_var_path = '/recipients/{Recipient ID}'.sub('{' + 'Recipient ID' + '}', recipient_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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'RecipientResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecipientsApi#delete_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    def get_recipients_all(opts = {})
+      result = []
+      response = get_recipients(opts)
+      result += response["object"]
+      while next_page = response["meta"]["pagination"]["next_page"]
+        response = get_recipients(opts.merge(page: next_page))
+        result += response["object"]
+      end
+      result
+    end
+
+    # Getting a list of recipients with filtering
+    # Fetches details of all recipients.
+    # @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;
+    # @option opts [String] :amount_from 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;
+    # @option opts [String] :amount_to 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;
+    # @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;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60;
+    # @return [RecipientListResponse]
+    def get_recipients(opts = {})
+      data, _status_code, _headers = get_recipients_with_http_info(opts)
+      data
+    end
+
+    # Getting a list of recipients with filtering
+    # Fetches details of all recipients.
+    # @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;
+    # @option opts [String] :amount_from 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;
+    # @option opts [String] :amount_to 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;
+    # @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;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60;
+    # @return [Array<(RecipientListResponse, Fixnum, Hash)>] RecipientListResponse data, response status code and response headers
+    def get_recipients_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecipientsApi.get_recipients ...'
+      end
+      # resource path
+      local_var_path = '/recipients'
+
+      # 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?
+      query_params[:'amount_from'] = opts[:'amount_from'] if !opts[:'amount_from'].nil?
+      query_params[:'amount_to'] = opts[:'amount_to'] if !opts[:'amount_to'].nil?
+      query_params[:'state'] = @api_client.build_collection_param(opts[:'state'], :multi) if !opts[:'state'].nil?
+      query_params[:'currency'] = @api_client.build_collection_param(opts[:'currency'], :multi) if !opts[:'currency'].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 => 'RecipientListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecipientsApi#get_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # 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.
+    # @param recipient_id ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60;
+    # @param recipient_request 
+    # @param [Hash] opts the optional parameters
+    # @return [RecipientResponse]
+    def patch_recipient(recipient_id, recipient_request, opts = {})
+      data, _status_code, _headers = patch_recipient_with_http_info(recipient_id, recipient_request, opts)
+      data
+    end
+
+    # Updating a recipient
+    # Updates the recipient specified in the URL path.  Please note that only recipients where the &#x60;editable&#x60; field is true can be modified. Once the recipient is modified any subsequent payout tries will be sent to the updated details.
+    # @param recipient_id ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60;
+    # @param recipient_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RecipientResponse, Fixnum, Hash)>] RecipientResponse data, response status code and response headers
+    def patch_recipient_with_http_info(recipient_id, recipient_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RecipientsApi.patch_recipient ...'
+      end
+      # verify the required parameter 'recipient_id' is set
+      if @api_client.config.client_side_validation && recipient_id.nil?
+        fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RecipientsApi.patch_recipient"
+      end
+      # verify the required parameter 'recipient_request' is set
+      if @api_client.config.client_side_validation && recipient_request.nil?
+        fail ArgumentError, "Missing the required parameter 'recipient_request' when calling RecipientsApi.patch_recipient"
+      end
+      # resource path
+      local_var_path = '/recipients/{Recipient ID}'.sub('{' + 'Recipient ID' + '}', recipient_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'])
+      # 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(recipient_request)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'RecipientResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecipientsApi#patch_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end