Class: Bitpesa::PayoutMethodDetailsMADCash

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

Overview

“‘JSON "details": { "first_name": "First", "last_name": "Last", "phone_number": "212537718685" # Mandatory; International format preferred "sender_identity_card_type" => "O", # Mandatory; Values: "O": Other, "PP": Passport, "NI": National ID "sender_identity_card_id" => ’AB12345678’, # Mandatory "sender_city_of_birth" => "London", # Mandatory "sender_country_of_birth" => "GB", # Mandatory; ISO 2-letter format "sender_gender" => "M", # Mandatory; Values: "M": Male, "F": Female "reason" => "Remittance payment", # Optional; Default value is ‘Remittance payment’ "identity_card_type" => "NI", # Optional; Values: "PP": Passport, "NI": National ID "identity_card_id" => ‘AB12345678’ # Optional } “‘ Please note when sending MAD::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt - “`JSON { (…) "state":"pending", "metadata": { "payment_reference":"9M5GJRJUBCY" }, (…) } “` The reference can also be provided optionally for MAD::Cash, but if you want to use this functionality please contact us for more details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutMethodDetailsMADCash

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 76

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

Instance Attribute Details

#first_name ⇒ Object

Returns the value of attribute first_name.



18
19
20
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 18

def first_name
  @first_name
end

#identity_card_id ⇒ Object

Returns the value of attribute identity_card_id.



38
39
40
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 38

def identity_card_id
  @identity_card_id
end

#identity_card_type ⇒ Object

Returns the value of attribute identity_card_type.



36
37
38
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 36

def identity_card_type
  @identity_card_type
end

#last_name ⇒ Object

Returns the value of attribute last_name.



20
21
22
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 20

def last_name
  @last_name
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#reason ⇒ Object

Returns the value of attribute reason.



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

def reason
  @reason
end

#sender_city_of_birth ⇒ Object

Returns the value of attribute sender_city_of_birth.



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

def sender_city_of_birth
  @sender_city_of_birth
end

#sender_country_of_birth ⇒ Object

Returns the value of attribute sender_country_of_birth.



30
31
32
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 30

def sender_country_of_birth
  @sender_country_of_birth
end

#sender_gender ⇒ Object

Returns the value of attribute sender_gender.



32
33
34
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 32

def sender_gender
  @sender_gender
end

#sender_identity_card_id ⇒ Object

Returns the value of attribute sender_identity_card_id.



26
27
28
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 26

def sender_identity_card_id
  @sender_identity_card_id
end

#sender_identity_card_type ⇒ Object

Returns the value of attribute sender_identity_card_type.



24
25
26
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 24

def sender_identity_card_type
  @sender_identity_card_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'phone_number' => :'phone_number',
    :'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'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      phone_number == o.phone_number &&
      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
end

#[](key) ⇒ Object 



298
299
300
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 298

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 236

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 310

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 215

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 



302
303
304
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 302

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 200

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 206

def hash
  [first_name, last_name, phone_number, 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].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



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
159
160
161
162
163
164
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 129

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 @phone_number.nil?
    invalid_properties.push('invalid value for "phone_number", phone_number 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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 288

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



276
277
278
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 276

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



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb', line 168

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @phone_number.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?
  true
end