Class: Bitpesa::PayinMethodDetails

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

Overview

Fields needed by the payment processor. Depends on the chose payin type. See the appropriate model details for more info: - ‘NGN::Bank`: see [`PayinMethodDetailsNGNBank`](#model-PayinMethodDetailsNGNBank) - `GHS::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile) - `UGX::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile) - `TZS::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayinMethodDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/bitpesa-sdk/models/payin_method_details.rb', line 55

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

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

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

Instance Attribute Details

#phone_number ⇒ Object

The phone number where the funds should be collected from



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

def phone_number
  @phone_number
end

#redirect_url ⇒ Object

This is where the user should be redirected back when the payment has been finished



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

def redirect_url
  @redirect_url
end

#send_instructions ⇒ Object

States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment.



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

def send_instructions
  @send_instructions
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/bitpesa-sdk/models/payin_method_details.rb', line 28

def self.attribute_map
  {
    :'redirect_url' => :'redirect_url',
    :'phone_number' => :'phone_number',
    :'send_instructions' => :'send_instructions'
  }
end

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



46
47
48
49
50
51
 
# File 'lib/bitpesa-sdk/models/payin_method_details.rb', line 46

def self.openapi_one_of
  [
  :'PayinMethodDetailsMobile',
  :'PayinMethodDetailsNGNBank'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'redirect_url' => :'String',
    :'phone_number' => :'String',
    :'send_instructions' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      redirect_url == o.redirect_url &&
      phone_number == o.phone_number &&
      send_instructions == o.send_instructions
end

#[](key) ⇒ Object 



223
224
225
 
# File 'lib/bitpesa-sdk/models/payin_method_details.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/payin_method_details.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/payin_method_details.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/payin_method_details.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/payin_method_details.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/payin_method_details.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/payin_method_details.rb', line 131

def hash
  [redirect_url, phone_number, send_instructions].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



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/bitpesa-sdk/models/payin_method_details.rb', line 76

def list_invalid_properties
  invalid_properties = Array.new
  if @redirect_url.nil?
    invalid_properties.push('invalid value for "redirect_url", redirect_url cannot be nil.')
  end

  if @phone_number.nil?
    invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
  end

  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/payin_method_details.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/payin_method_details.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/payin_method_details.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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/bitpesa-sdk/models/payin_method_details.rb', line 91

def valid?
  return false if @redirect_url.nil?
  return false if @phone_number.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