Class: OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels::AddressVo

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/models/address_vo.rb

Overview

.

############################################################################################
## This class subject to change without prior notice, Please dont use this class directly.##
############################################################################################

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddressVo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 80

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

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

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

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

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

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

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

Instance Attribute Details

#address_city ⇒ String (readonly)

City of the address.

Returns:

  • (String) —

    The attribute address_city.



34
35
36
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 34

def address_city
  @address_city
end

#address_country ⇒ String (readonly)

The 3 letter country code as per ISO 3166-1 (alpha-3).

Returns:

  • (String) —

    The attribute address_country.



42
43
44
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 42

def address_country
  @address_country
end

#address_line1 ⇒ String (readonly)

Line one of the address.

Returns:

  • (String) —

    The attribute address_line1.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 26

def address_line1
  @address_line1
end

#address_line2 ⇒ String (readonly)

Line two of the address.

Returns:

  • (String) —

    The attribute address_line2.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 30

def address_line2
  @address_line2
end

#address_state ⇒ String (readonly)

The state or province code as per ISO_3166-2.

Returns:

  • (String) —

    The attribute address_state.



38
39
40
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 38

def address_state
  @address_state
end

#address_zip1 ⇒ String (readonly)

The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.

Returns:

  • (String) —

    The attribute address_zip1.



46
47
48
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 46

def address_zip1
  @address_zip1
end

#address_zip2 ⇒ String (readonly)

The 4 digit add-on code used, in addition to the 5 digit postal code, by the US Postal Service.

Returns:

  • (String) —

    The attribute address_zip2.



50
51
52
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 50

def address_zip2
  @address_zip2
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 53

def self.attribute_map
  {
    :'address_line1' => :'address_line1',
    :'address_line2' => :'address_line2',
    :'address_city' => :'address_city',
    :'address_state' => :'address_state',
    :'address_country' => :'address_country',
    :'address_zip1' => :'address_zip1',
    :'address_zip2' => :'address_zip2'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 66

def self.swagger_types
  {
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'address_city' => :'String',
    :'address_state' => :'String',
    :'address_country' => :'String',
    :'address_zip1' => :'String',
    :'address_zip2' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • o (Object) —

    Object to be compared



126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_city == o.address_city &&
      address_state == o.address_state &&
      address_country == o.address_country &&
      address_zip1 == o.address_zip1 &&
      address_zip2 == o.address_zip2
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type (string) —

    Data type

  • value (string) —

    Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 174

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    if value.nil?
      value
    else
      value.to_s
    end
  when :Integer
    if value.nil?
      value
    else
      value.to_i
    end
  when :Float
    if value.nil?
      value
    else
      value.to_f
    end
  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 = OrbipayPaymentsapiClient::OrbipayPaymentsapiClientModels.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash, Object

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

  • (Object) —

    Returns the object if it cannot be converted to hash



253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 253

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 153

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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)
        set_values(key => attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      set_values(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

#eql?(o) ⇒ Boolean

Parameters:

  • o (Object) —

    Object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 146

def hash
  [address_line1, address_line2, address_city, address_state, address_country, address_zip1, address_zip2].hash
end

#set_values(args) ⇒ Object 



116
117
118
119
120
121
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 116

def set_values(args)
  args.each do |attr, arg|
    (class << self; self; end).send(:attr_reader, attr.to_sym)
    instance_variable_set("@#{attr}", arg)
  end
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 232

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



238
239
240
241
242
243
244
245
246
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 238

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
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



226
227
228
 
# File 'lib/orbipay_paymentsapi_client/models/address_vo.rb', line 226

def to_s
  to_hash.to_s
end