Class: TransferZero::PayoutMethodDetailsXOFCash

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

Overview

“‘JSON "details": { "first_name": "First", "last_name": "Last", "phone_number": "221774044436", // local or international format "cash_provider": "wizall" // Optional; Values: "wizall"; Default value is "wizall"; "country": "SN" // Optional; Values: "CI", "ML" or "SN"; Default value is "SN"; } “` Please note all senders trying to create Wizall cash pickup requests must have `identity_type` and `identity_number` present. The fields above are generally considered optional for senders for other payment corridors. If you wish to use an existing sender who has some of these fields missing you can provide them alongside the `id` or `external_id` field in the sender details. For example - “`JSON { "transaction": { "sender": { "external_id": "<id of sender>", "identity_type": "ID", "identity_number": "AB12345678", (…) }, (…) } } “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutMethodDetailsXOFCash

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
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
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 52

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::PayoutMethodDetailsXOFCash` 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::PayoutMethodDetailsXOFCash`. 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?(:'cash_provider')
    self.cash_provider = attributes[:'cash_provider']
  end

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

Instance Attribute Details

#cash_provider ⇒ Object

Returns the value of attribute cash_provider.



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

def cash_provider
  @cash_provider
end

#country ⇒ Object

Returns the value of attribute country.



26
27
28
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.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_cash.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_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/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 22

def phone_number
  @phone_number
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 29

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

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 40

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'phone_number' => :'String',
    :'cash_provider' => :'PayoutMethodCashProviderEnum',
    :'country' => :'PayoutMethodCountryEnum'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
124
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 116

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

#[](key) ⇒ Object 



226
227
228
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 226

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



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
198
199
200
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 164

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 238

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 143

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 



230
231
232
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 230

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


128
129
130
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 128

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



134
135
136
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 134

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 88

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

  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



210
211
212
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 210

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 216

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



204
205
206
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 204

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



107
108
109
110
111
112
 
# File 'lib/transferzero-sdk/models/payout_method_details_xof_cash.rb', line 107

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