bitpesa-sdk 0.1.0

data/lib/bitpesa-sdk/models/payout_method.rb

@@ -0,0 +1,249 @@
+=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 'date'
+
+module Bitpesa
+  # This describes the specific details on how the payment has to be routed to the recipient.
+  class PayoutMethod
+    # Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance 
+    attr_accessor :type
+
+    attr_accessor :details
+
+    # Metadata of payout method. You can store any kind of information in this field.
+    attr_accessor :metadata
+
+    attr_accessor :id
+
+    # The fields that have some problems and don't pass validation
+    attr_accessor :errors
+
+    # The fields needed for payments with this payment method with details on validation requirements
+    attr_accessor :fields
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'details' => :'details',
+        :'metadata' => :'metadata',
+        :'id' => :'id',
+        :'errors' => :'errors',
+        :'fields' => :'fields'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'type' => :'String',
+        :'details' => :'PayoutMethodDetails',
+        :'metadata' => :'Object',
+        :'id' => :'String',
+        :'errors' => :'Hash<String, Array<ValidationErrorDescription>>',
+        :'fields' => :'Hash<String, FieldDescription>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'details')
+        self.details = attributes[:'details']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Hash)
+          self.errors = value
+        end
+      end
+
+      if attributes.has_key?(:'fields')
+        if (value = attributes[:'fields']).is_a?(Hash)
+          self.fields = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          type == o.type &&
+          details == o.details &&
+          metadata == o.metadata &&
+          id == o.id &&
+          errors == o.errors &&
+          fields == o.fields
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [type, details, metadata, id, errors, fields].hash
+    end
+
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access.rb'
+# Builds the object from hash
+# @param [Hash] attributes Model attributes in the form of hash
+# @return [Object] Returns the model itself
+def build_from_hash(attributes)
+  return nil unless attributes.is_a?(Hash)
+  self.class.openapi_types.each_pair do |key, type|
+    if type =~ /\AArray<(.*)>/i
+      # check to ensure the input is an array given that the the attribute
+      # is documented as an array but the input is not
+      if attributes[self.class.attribute_map[key]].is_a?(Array)
+        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      end
+    elsif !attributes[self.class.attribute_map[key]].nil?
+      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+    end # or else data not found in attributes(hash), not an issue as the data can be optional
+  end
+
+  self
+end
+
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def _deserialize(type, value)
+  case type.to_sym
+  when :DateTime
+    DateTime.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :BOOLEAN
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
+    end
+  else # model
+    temp_model = Bitpesa.const_get(type).new
+    temp_model.build_from_hash(value)
+  end
+end
+
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {}
+  self.class.attribute_map.each_pair do |attr, param|
+    value = self.send(attr)
+    next if value.nil?
+    hash[param] = _to_hash(value)
+  end
+  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
+end
+
+def [](key)
+  to_hash[key]
+end
+
+def dig(*args)
+  to_hash.dig(*args)
+end
+
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
+    end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
+
+  end
+
+end

data/lib/bitpesa-sdk/models/payout_method_bank_account_type_enum.rb

@@ -0,0 +1,38 @@
+=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 'date'
+
+module Bitpesa
+  class PayoutMethodBankAccountTypeEnum
+    
+    N10 = '10'.freeze
+    N20 = '20'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = PayoutMethodBankAccountTypeEnum.constants.select { |c| PayoutMethodBankAccountTypeEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #PayoutMethodBankAccountTypeEnum" if constantValues.empty?
+      value
+    end
+  end
+
+end

data/lib/bitpesa-sdk/models/payout_method_details.rb

@@ -0,0 +1,456 @@
+=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 'date'
+
+module Bitpesa
+  class PayoutMethodDetails
+    attr_accessor :first_name
+
+    attr_accessor :last_name
+
+    attr_accessor :bank_code
+
+    attr_accessor :bank_account
+
+    attr_accessor :bank_account_type
+
+    attr_accessor :phone_number
+
+    attr_accessor :mobile_provider
+
+    attr_accessor :bank_name
+
+    attr_accessor :iban
+
+    attr_accessor :bic
+
+    attr_accessor :sender_identity_card_type
+
+    attr_accessor :sender_identity_card_id
+
+    attr_accessor :sender_city_of_birth
+
+    attr_accessor :sender_country_of_birth
+
+    attr_accessor :sender_gender
+
+    attr_accessor :reason
+
+    attr_accessor :identity_card_type
+
+    attr_accessor :identity_card_id
+
+    attr_accessor :reference
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'bank_code' => :'bank_code',
+        :'bank_account' => :'bank_account',
+        :'bank_account_type' => :'bank_account_type',
+        :'phone_number' => :'phone_number',
+        :'mobile_provider' => :'mobile_provider',
+        :'bank_name' => :'bank_name',
+        :'iban' => :'iban',
+        :'bic' => :'bic',
+        :'sender_identity_card_type' => :'sender_identity_card_type',
+        :'sender_identity_card_id' => :'sender_identity_card_id',
+        :'sender_city_of_birth' => :'sender_city_of_birth',
+        :'sender_country_of_birth' => :'sender_country_of_birth',
+        :'sender_gender' => :'sender_gender',
+        :'reason' => :'reason',
+        :'identity_card_type' => :'identity_card_type',
+        :'identity_card_id' => :'identity_card_id',
+        :'reference' => :'reference'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'bank_code' => :'String',
+        :'bank_account' => :'String',
+        :'bank_account_type' => :'PayoutMethodBankAccountTypeEnum',
+        :'phone_number' => :'String',
+        :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
+        :'bank_name' => :'String',
+        :'iban' => :'String',
+        :'bic' => :'String',
+        :'sender_identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
+        :'sender_identity_card_id' => :'String',
+        :'sender_city_of_birth' => :'String',
+        :'sender_country_of_birth' => :'String',
+        :'sender_gender' => :'PayoutMethodGenderEnum',
+        :'reason' => :'String',
+        :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
+        :'identity_card_id' => :'String',
+        :'reference' => :'String'
+      }
+    end
+
+    # List of class defined in oneOf (OpenAPI v3)
+    def self.openapi_one_of
+      [
+      :'PayoutMethodDetailsBalance',
+      :'PayoutMethodDetailsGHSBank',
+      :'PayoutMethodDetailsIBAN',
+      :'PayoutMethodDetailsMADCash',
+      :'PayoutMethodDetailsMobile',
+      :'PayoutMethodDetailsNGNBank',
+      :'PayoutMethodDetailsXOFMobile'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.has_key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.has_key?(:'bank_code')
+        self.bank_code = attributes[:'bank_code']
+      end
+
+      if attributes.has_key?(:'bank_account')
+        self.bank_account = attributes[:'bank_account']
+      end
+
+      if attributes.has_key?(:'bank_account_type')
+        self.bank_account_type = attributes[:'bank_account_type']
+      end
+
+      if attributes.has_key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.has_key?(:'mobile_provider')
+        self.mobile_provider = attributes[:'mobile_provider']
+      end
+
+      if attributes.has_key?(:'bank_name')
+        self.bank_name = attributes[:'bank_name']
+      end
+
+      if attributes.has_key?(:'iban')
+        self.iban = attributes[:'iban']
+      end
+
+      if attributes.has_key?(:'bic')
+        self.bic = attributes[:'bic']
+      end
+
+      if attributes.has_key?(:'sender_identity_card_type')
+        self.sender_identity_card_type = attributes[:'sender_identity_card_type']
+      end
+
+      if attributes.has_key?(:'sender_identity_card_id')
+        self.sender_identity_card_id = attributes[:'sender_identity_card_id']
+      end
+
+      if attributes.has_key?(:'sender_city_of_birth')
+        self.sender_city_of_birth = attributes[:'sender_city_of_birth']
+      end
+
+      if attributes.has_key?(:'sender_country_of_birth')
+        self.sender_country_of_birth = attributes[:'sender_country_of_birth']
+      end
+
+      if attributes.has_key?(:'sender_gender')
+        self.sender_gender = attributes[:'sender_gender']
+      end
+
+      if attributes.has_key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.has_key?(:'identity_card_type')
+        self.identity_card_type = attributes[:'identity_card_type']
+      end
+
+      if attributes.has_key?(:'identity_card_id')
+        self.identity_card_id = attributes[:'identity_card_id']
+      end
+
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @bank_code.nil?
+        invalid_properties.push('invalid value for "bank_code", bank_code cannot be nil.')
+      end
+
+      if @bank_account.nil?
+        invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.')
+      end
+
+      if @bank_account_type.nil?
+        invalid_properties.push('invalid value for "bank_account_type", bank_account_type cannot be nil.')
+      end
+
+      if @phone_number.nil?
+        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+      end
+
+      if @mobile_provider.nil?
+        invalid_properties.push('invalid value for "mobile_provider", mobile_provider cannot be nil.')
+      end
+
+      if @bank_name.nil?
+        invalid_properties.push('invalid value for "bank_name", bank_name cannot be nil.')
+      end
+
+      if @iban.nil?
+        invalid_properties.push('invalid value for "iban", iban cannot be nil.')
+      end
+
+      if @sender_identity_card_type.nil?
+        invalid_properties.push('invalid value for "sender_identity_card_type", sender_identity_card_type cannot be nil.')
+      end
+
+      if @sender_identity_card_id.nil?
+        invalid_properties.push('invalid value for "sender_identity_card_id", sender_identity_card_id cannot be nil.')
+      end
+
+      if @sender_city_of_birth.nil?
+        invalid_properties.push('invalid value for "sender_city_of_birth", sender_city_of_birth cannot be nil.')
+      end
+
+      if @sender_country_of_birth.nil?
+        invalid_properties.push('invalid value for "sender_country_of_birth", sender_country_of_birth cannot be nil.')
+      end
+
+      if @sender_gender.nil?
+        invalid_properties.push('invalid value for "sender_gender", sender_gender cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @first_name.nil?
+      return false if @last_name.nil?
+      return false if @bank_code.nil?
+      return false if @bank_account.nil?
+      return false if @bank_account_type.nil?
+      return false if @phone_number.nil?
+      return false if @mobile_provider.nil?
+      return false if @bank_name.nil?
+      return false if @iban.nil?
+      return false if @sender_identity_card_type.nil?
+      return false if @sender_identity_card_id.nil?
+      return false if @sender_city_of_birth.nil?
+      return false if @sender_country_of_birth.nil?
+      return false if @sender_gender.nil?
+      _one_of_found = false
+      openapi_one_of.each do |_class|
+        _one_of = Bitpesa.const_get(_class).build_from_hash(self.to_hash)
+        if _one_of.valid?
+          if _one_of_found?
+            return false
+          else
+            _one_of_found = true
+          end
+        end
+      end
+
+      if !_one_of_found?
+        return false
+      end
+
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          bank_code == o.bank_code &&
+          bank_account == o.bank_account &&
+          bank_account_type == o.bank_account_type &&
+          phone_number == o.phone_number &&
+          mobile_provider == o.mobile_provider &&
+          bank_name == o.bank_name &&
+          iban == o.iban &&
+          bic == o.bic &&
+          sender_identity_card_type == o.sender_identity_card_type &&
+          sender_identity_card_id == o.sender_identity_card_id &&
+          sender_city_of_birth == o.sender_city_of_birth &&
+          sender_country_of_birth == o.sender_country_of_birth &&
+          sender_gender == o.sender_gender &&
+          reason == o.reason &&
+          identity_card_type == o.identity_card_type &&
+          identity_card_id == o.identity_card_id &&
+          reference == o.reference
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, bank_name, iban, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference].hash
+    end
+
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access.rb'
+# Builds the object from hash
+# @param [Hash] attributes Model attributes in the form of hash
+# @return [Object] Returns the model itself
+def build_from_hash(attributes)
+  return nil unless attributes.is_a?(Hash)
+  self.class.openapi_types.each_pair do |key, type|
+    if type =~ /\AArray<(.*)>/i
+      # check to ensure the input is an array given that the the attribute
+      # is documented as an array but the input is not
+      if attributes[self.class.attribute_map[key]].is_a?(Array)
+        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      end
+    elsif !attributes[self.class.attribute_map[key]].nil?
+      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+    end # or else data not found in attributes(hash), not an issue as the data can be optional
+  end
+
+  self
+end
+
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def _deserialize(type, value)
+  case type.to_sym
+  when :DateTime
+    DateTime.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :BOOLEAN
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
+    end
+  else # model
+    temp_model = Bitpesa.const_get(type).new
+    temp_model.build_from_hash(value)
+  end
+end
+
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {}
+  self.class.attribute_map.each_pair do |attr, param|
+    value = self.send(attr)
+    next if value.nil?
+    hash[param] = _to_hash(value)
+  end
+  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
+end
+
+def [](key)
+  to_hash[key]
+end
+
+def dig(*args)
+  to_hash.dig(*args)
+end
+
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
+    end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
+
+  end
+
+end