Class: Bitpesa::PaymentMethod

Inherits:
Object
  • Object
show all
Defined in:
lib/bitpesa-sdk/models/payment_method.rb

Overview

Describes an available payment provider

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentMethod

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 62

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?(:'provider')
    self.provider = attributes[:'provider']
  end

  if attributes.has_key?(:'otc_permitted')
    self.otc_permitted = attributes[:'otc_permitted']
  end

  if attributes.has_key?(:'details')
    if (value = attributes[:'details']).is_a?(Array)
      self.details = value
    end
  end

  if attributes.has_key?(:'default')
    self.default = attributes[:'default']
  end

  if attributes.has_key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Hash)
      self.fields = value
    end
  end
end

Instance Attribute Details

#default ⇒ Object

Boolean revealing whether this is the default payout method. Only present on payout methods



31
32
33
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 31

def default
  @default
end

#details ⇒ Object

Fields required to make the payment depending on type.



28
29
30
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 28

def details
  @details
end

#fields ⇒ Object

The fields needed for payments with this payment method with details on validation requirements



34
35
36
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 34

def fields
  @fields
end

#otc_permitted ⇒ Object

Are over the counter transactions permitted?



25
26
27
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 25

def otc_permitted
  @otc_permitted
end

#provider ⇒ Object

Identifies the payment provider.



22
23
24
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 22

def provider
  @provider
end

#type ⇒ Object

Details currency and type of payment.



19
20
21
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 19

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 37

def self.attribute_map
  {
    :'type' => :'type',
    :'provider' => :'provider',
    :'otc_permitted' => :'otc_permitted',
    :'details' => :'details',
    :'default' => :'default',
    :'fields' => :'fields'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 49

def self.openapi_types
  {
    :'type' => :'String',
    :'provider' => :'String',
    :'otc_permitted' => :'BOOLEAN',
    :'details' => :'Array<String>',
    :'default' => :'BOOLEAN',
    :'fields' => :'Hash<String, FieldDescription>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 112

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      provider == o.provider &&
      otc_permitted == o.otc_permitted &&
      details == o.details &&
      default == o.default &&
      fields == o.fields
end

#[](key) ⇒ Object 



223
224
225
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 223

def [](key)
  to_hash[key]
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 161

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 235

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

#build_from_hash(attributes) ⇒ Object

Returns the model itself

Returns:

  • (Object) —

    Returns the model itself



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 140

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

#dig(*args) ⇒ Object 



227
228
229
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 227

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


125
126
127
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 125

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 131

def hash
  [type, provider, otc_permitted, details, default, fields].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



99
100
101
102
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 99

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 207

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 213

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



201
202
203
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 201

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



106
107
108
 
# File 'lib/bitpesa-sdk/models/payment_method.rb', line 106

def valid?
  true
end