Class: TransferZero::PayoutMethodDetailsXOFMobile

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb

Overview

“‘JSON "details": { "first_name": "First", "last_name": "Last", "phone_number": "+221708766123", // E.164 international format "mobile_provider": "orange", // "orange", "tigo", "emoney", "free" or "wave" for Senegal; "orange", "mtn" or "moov" for Ivory Coast; "orange" or "mobicash" for Burkina Faso and Mali "country" // Optional; Values: "SN" for Senegal; "CI" for Ivory Coast; "ML" for Mali; "BF" for Burkina Faso; Default value is "SN" "transfer_reason": "personal_account" // mandatory for Mali payouts, optional otherwise } “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutMethodDetailsXOFMobile

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
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
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 56

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::PayoutMethodDetailsXOFMobile` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::PayoutMethodDetailsXOFMobile`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

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

  if attributes.key?(:'mobile_provider')
    self.mobile_provider = attributes[:'mobile_provider']
  end

  if attributes.key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.key?(:'transfer_reason')
    self.transfer_reason = attributes[:'transfer_reason']
  end
end

Instance Attribute Details

#country ⇒ Object

Returns the value of attribute country.



26
27
28
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 26

def country
  @country
end

#first_name ⇒ Object

Returns the value of attribute first_name.



18
19
20
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 18

def first_name
  @first_name
end

#last_name ⇒ Object

Returns the value of attribute last_name.



20
21
22
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 20

def last_name
  @last_name
end

#mobile_provider ⇒ Object

Returns the value of attribute mobile_provider.



24
25
26
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 24

def mobile_provider
  @mobile_provider
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



22
23
24
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 22

def phone_number
  @phone_number
end

#transfer_reason ⇒ Object

Returns the value of attribute transfer_reason.



28
29
30
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 28

def transfer_reason
  @transfer_reason
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 31

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'phone_number' => :'phone_number',
    :'mobile_provider' => :'mobile_provider',
    :'country' => :'country',
    :'transfer_reason' => :'transfer_reason'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 43

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'String',
    :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
    :'country' => :'PayoutMethodCountryEnum',
    :'transfer_reason' => :'PayoutMethodTransferReasonEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 129

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 &&
      mobile_provider == o.mobile_provider &&
      country == o.country &&
      transfer_reason == o.transfer_reason
end

#[](key) ⇒ Object 



240
241
242
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 240

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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 178

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 = TransferZero.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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 252

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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 157

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 



244
245
246
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 244

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 148

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 96

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



224
225
226
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 224

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



230
231
232
233
234
235
236
237
238
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 230

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



218
219
220
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 218

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



119
120
121
122
123
124
125
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb', line 119

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