Class: OrderCloud::BuyerAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/models/buyer_address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BuyerAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/order_cloud/models/buyer_address.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#address_nameObject

Returns the value of attribute address_name.



57
58
59
# File 'lib/order_cloud/models/buyer_address.rb', line 57

def address_name
  @address_name
end

#billingObject

Returns the value of attribute billing.



33
34
35
# File 'lib/order_cloud/models/buyer_address.rb', line 33

def billing
  @billing
end

#cityObject

Returns the value of attribute city.



47
48
49
# File 'lib/order_cloud/models/buyer_address.rb', line 47

def city
  @city
end

#company_nameObject

Returns the value of attribute company_name.



37
38
39
# File 'lib/order_cloud/models/buyer_address.rb', line 37

def company_name
  @company_name
end

#countryObject

Returns the value of attribute country.



53
54
55
# File 'lib/order_cloud/models/buyer_address.rb', line 53

def country
  @country
end

#editableObject

Returns the value of attribute editable.



35
36
37
# File 'lib/order_cloud/models/buyer_address.rb', line 35

def editable
  @editable
end

#first_nameObject

Returns the value of attribute first_name.



39
40
41
# File 'lib/order_cloud/models/buyer_address.rb', line 39

def first_name
  @first_name
end

#idObject

Returns the value of attribute id.



29
30
31
# File 'lib/order_cloud/models/buyer_address.rb', line 29

def id
  @id
end

#last_nameObject

Returns the value of attribute last_name.



41
42
43
# File 'lib/order_cloud/models/buyer_address.rb', line 41

def last_name
  @last_name
end

#phoneObject

Returns the value of attribute phone.



55
56
57
# File 'lib/order_cloud/models/buyer_address.rb', line 55

def phone
  @phone
end

#shippingObject

Returns the value of attribute shipping.



31
32
33
# File 'lib/order_cloud/models/buyer_address.rb', line 31

def shipping
  @shipping
end

#stateObject

Returns the value of attribute state.



49
50
51
# File 'lib/order_cloud/models/buyer_address.rb', line 49

def state
  @state
end

#street1Object

Returns the value of attribute street1.



43
44
45
# File 'lib/order_cloud/models/buyer_address.rb', line 43

def street1
  @street1
end

#street2Object

Returns the value of attribute street2.



45
46
47
# File 'lib/order_cloud/models/buyer_address.rb', line 45

def street2
  @street2
end

#xpObject

Returns the value of attribute xp.



59
60
61
# File 'lib/order_cloud/models/buyer_address.rb', line 59

def xp
  @xp
end

#zipObject

Returns the value of attribute zip.



51
52
53
# File 'lib/order_cloud/models/buyer_address.rb', line 51

def zip
  @zip
end

Class Method Details

.attribute_mapObject

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/order_cloud/models/buyer_address.rb', line 63

def self.attribute_map
  {
    :'id' => :'ID',
    :'shipping' => :'Shipping',
    :'billing' => :'Billing',
    :'editable' => :'Editable',
    :'company_name' => :'CompanyName',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'street1' => :'Street1',
    :'street2' => :'Street2',
    :'city' => :'City',
    :'state' => :'State',
    :'zip' => :'Zip',
    :'country' => :'Country',
    :'phone' => :'Phone',
    :'address_name' => :'AddressName',
    :'xp' => :'xp'
  }
end

.swagger_typesObject

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/order_cloud/models/buyer_address.rb', line 85

def self.swagger_types
  {
    :'id' => :'String',
    :'shipping' => :'BOOLEAN',
    :'billing' => :'BOOLEAN',
    :'editable' => :'BOOLEAN',
    :'company_name' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'street1' => :'String',
    :'street2' => :'String',
    :'city' => :'String',
    :'state' => :'String',
    :'zip' => :'String',
    :'country' => :'String',
    :'phone' => :'String',
    :'address_name' => :'String',
    :'xp' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/order_cloud/models/buyer_address.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      shipping == o.shipping &&
      billing == o.billing &&
      editable == o.editable &&
      company_name == o.company_name &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      street1 == o.street1 &&
      street2 == o.street2 &&
      city == o.city &&
      state == o.state &&
      zip == o.zip &&
      country == o.country &&
      phone == o.phone &&
      address_name == o.address_name &&
      xp == o.xp
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/order_cloud/models/buyer_address.rb', line 252

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 =~ /^(true|t|yes|y|1)$/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 = OrderCloud.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



318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/order_cloud/models/buyer_address.rb', line 318

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/order_cloud/models/buyer_address.rb', line 231

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
# File 'lib/order_cloud/models/buyer_address.rb', line 218

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



224
225
226
# File 'lib/order_cloud/models/buyer_address.rb', line 224

def hash
  [id, shipping, billing, editable, company_name, first_name, last_name, street1, street2, city, state, zip, country, phone, address_name, xp].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



182
183
184
185
# File 'lib/order_cloud/models/buyer_address.rb', line 182

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



298
299
300
# File 'lib/order_cloud/models/buyer_address.rb', line 298

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



304
305
306
307
308
309
310
311
312
# File 'lib/order_cloud/models/buyer_address.rb', line 304

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



292
293
294
# File 'lib/order_cloud/models/buyer_address.rb', line 292

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



189
190
191
# File 'lib/order_cloud/models/buyer_address.rb', line 189

def valid?
  return true
end