Class: OrbipayPaymentsapiClient::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/orbipay_paymentsapi_client/wrappers/address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address_line1: nil, address_line2: nil, address_city: nil, address_state: nil, address_country: nil, address_zip1: nil, address_zip2: nil) ⇒ Address

Returns a new instance of Address.

Parameters:

  • address_line1 (String) (defaults to: nil) —

    attribute in the form of String.

  • address_line2 (String) (defaults to: nil) —

    attribute in the form of String.

  • address_city (String) (defaults to: nil) —

    attribute in the form of String.

  • address_state (String) (defaults to: nil) —

    attribute in the form of String.

  • address_country (String) (defaults to: nil) —

    attribute in the form of String.

  • address_zip1 (String) (defaults to: nil) —

    attribute in the form of String.

  • address_zip2 (String) (defaults to: nil) —

    attribute in the form of String.



66
67
68
69
70
71
72
73
74
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 66

def initialize(address_line1: nil, address_line2: nil, address_city: nil, address_state: nil, address_country: nil, address_zip1: nil, address_zip2: nil)
    @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

Instance Attribute Details

#address_city ⇒ String (readonly)

City of the address.

Returns:

  • (String) —

    The attribute address_city.



14
15
16
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 14

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.



22
23
24
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 22

def address_country
  @address_country
end

#address_line1 ⇒ String (readonly)

Line one of the address.

Returns:

  • (String) —

    The attribute address_line1.



6
7
8
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 6

def address_line1
  @address_line1
end

#address_line2 ⇒ String (readonly)

Line two of the address.

Returns:

  • (String) —

    The attribute address_line2.



10
11
12
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 10

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.



18
19
20
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 18

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. In the case of US, it's the 5 digit postal code used by the US Postal Service.

Returns:

  • (String) —

    The attribute address_zip1.



26
27
28
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 26

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.This is not applicable and will be ignored in the case of non-US addresses.

Returns:

  • (String) —

    The attribute address_zip2.



30
31
32
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 30

def address_zip2
  @address_zip2
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 34

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.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 47

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.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 88

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



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 135

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 214

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 114

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

Returns:

  • (Boolean)

See Also:

  • `==` method


101
102
103
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 101

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 107

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

#set_values(args) ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 79

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



193
194
195
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 193

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



199
200
201
202
203
204
205
206
207
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 199

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



187
188
189
 
# File 'lib/orbipay_paymentsapi_client/wrappers/address.rb', line 187

def to_s
  to_hash.to_s
end