Class: Bitpesa::PayinMethodDetailsMobile

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

Overview

“‘JSON "details": { "phone_number": "+2569999999", "send_instructions": true } “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayinMethodDetailsMobile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 42

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?(:'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



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

def phone_number
  @phone_number
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.



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

def send_instructions
  @send_instructions
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 25

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

.openapi_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 33

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



77
78
79
80
81
82
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 77

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

#[](key) ⇒ Object 



184
185
186
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 184

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 122

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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 196

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 101

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 



188
189
190
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 188

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


86
87
88
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 86

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



92
93
94
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 92

def hash
  [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



59
60
61
62
63
64
65
66
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 59

def list_invalid_properties
  invalid_properties = Array.new
  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



168
169
170
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 168

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



174
175
176
177
178
179
180
181
182
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 174

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



162
163
164
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 162

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



70
71
72
73
 
# File 'lib/bitpesa-sdk/models/payin_method_details_mobile.rb', line 70

def valid?
  return false if @phone_number.nil?
  true
end