Class: UltracartClient::OrderBilling

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/order_billing.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderBilling

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ultracart_api/models/order_billing.rb', line 133

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

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

  if attributes.key?(:'cc_emails')
    if (value = attributes[:'cc_emails']).is_a?(Array)
      self.cc_emails = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

Address line 1



19
20
21
 
# File 'lib/ultracart_api/models/order_billing.rb', line 19

def address1
  @address1
end

#address2 ⇒ Object

Address line 2



22
23
24
 
# File 'lib/ultracart_api/models/order_billing.rb', line 22

def address2
  @address2
end

#cc_emails ⇒ Object

CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.



25
26
27
 
# File 'lib/ultracart_api/models/order_billing.rb', line 25

def cc_emails
  @cc_emails
end

#cell_phone ⇒ Object

Cell phone



28
29
30
 
# File 'lib/ultracart_api/models/order_billing.rb', line 28

def cell_phone
  @cell_phone
end

#cell_phone_e164 ⇒ Object

Cell phone (E164 format)



31
32
33
 
# File 'lib/ultracart_api/models/order_billing.rb', line 31

def cell_phone_e164
  @cell_phone_e164
end

#city ⇒ Object

City



34
35
36
 
# File 'lib/ultracart_api/models/order_billing.rb', line 34

def city
  @city
end

#company ⇒ Object

Company



37
38
39
 
# File 'lib/ultracart_api/models/order_billing.rb', line 37

def company
  @company
end

#country_code ⇒ Object

ISO-3166 two letter country code



40
41
42
 
# File 'lib/ultracart_api/models/order_billing.rb', line 40

def country_code
  @country_code
end

#day_phone ⇒ Object

Day time phone



43
44
45
 
# File 'lib/ultracart_api/models/order_billing.rb', line 43

def day_phone
  @day_phone
end

#day_phone_e164 ⇒ Object

Day time phone (E164 format)



46
47
48
 
# File 'lib/ultracart_api/models/order_billing.rb', line 46

def day_phone_e164
  @day_phone_e164
end

#email ⇒ Object

Email



49
50
51
 
# File 'lib/ultracart_api/models/order_billing.rb', line 49

def email
  @email
end

#evening_phone ⇒ Object

Evening phone



52
53
54
 
# File 'lib/ultracart_api/models/order_billing.rb', line 52

def evening_phone
  @evening_phone
end

#evening_phone_e164 ⇒ Object

Evening phone (E164 format)



55
56
57
 
# File 'lib/ultracart_api/models/order_billing.rb', line 55

def evening_phone_e164
  @evening_phone_e164
end

#first_name ⇒ Object

First name



58
59
60
 
# File 'lib/ultracart_api/models/order_billing.rb', line 58

def first_name
  @first_name
end

#last_name ⇒ Object

Last name



61
62
63
 
# File 'lib/ultracart_api/models/order_billing.rb', line 61

def last_name
  @last_name
end

#postal_code ⇒ Object

Postal code



64
65
66
 
# File 'lib/ultracart_api/models/order_billing.rb', line 64

def postal_code
  @postal_code
end

#state_region ⇒ Object

State for United States otherwise region or province for other countries



67
68
69
 
# File 'lib/ultracart_api/models/order_billing.rb', line 67

def state_region
  @state_region
end

#title ⇒ Object

Title



70
71
72
 
# File 'lib/ultracart_api/models/order_billing.rb', line 70

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/ultracart_api/models/order_billing.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ultracart_api/models/order_billing.rb', line 73

def self.attribute_map
  {
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'cc_emails' => :'cc_emails',
    :'cell_phone' => :'cell_phone',
    :'cell_phone_e164' => :'cell_phone_e164',
    :'city' => :'city',
    :'company' => :'company',
    :'country_code' => :'country_code',
    :'day_phone' => :'day_phone',
    :'day_phone_e164' => :'day_phone_e164',
    :'email' => :'email',
    :'evening_phone' => :'evening_phone',
    :'evening_phone_e164' => :'evening_phone_e164',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'postal_code' => :'postal_code',
    :'state_region' => :'state_region',
    :'title' => :'title'
  }
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



529
530
531
 
# File 'lib/ultracart_api/models/order_billing.rb', line 529

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/ultracart_api/models/order_billing.rb', line 126

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/ultracart_api/models/order_billing.rb', line 102

def self.openapi_types
  {
    :'address1' => :'String',
    :'address2' => :'String',
    :'cc_emails' => :'Array<String>',
    :'cell_phone' => :'String',
    :'cell_phone_e164' => :'String',
    :'city' => :'String',
    :'company' => :'String',
    :'country_code' => :'String',
    :'day_phone' => :'String',
    :'day_phone_e164' => :'String',
    :'email' => :'String',
    :'evening_phone' => :'String',
    :'evening_phone_e164' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'postal_code' => :'String',
    :'state_region' => :'String',
    :'title' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/ultracart_api/models/order_billing.rb', line 491

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      cc_emails == o.cc_emails &&
      cell_phone == o.cell_phone &&
      cell_phone_e164 == o.cell_phone_e164 &&
      city == o.city &&
      company == o.company &&
      country_code == o.country_code &&
      day_phone == o.day_phone &&
      day_phone_e164 == o.day_phone_e164 &&
      email == o.email &&
      evening_phone == o.evening_phone &&
      evening_phone_e164 == o.evening_phone_e164 &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      postal_code == o.postal_code &&
      state_region == o.state_region &&
      title == o.title
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



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/ultracart_api/models/order_billing.rb', line 560

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



631
632
633
634
635
636
637
638
639
640
641
642
643
 
# File 'lib/ultracart_api/models/order_billing.rb', line 631

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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/ultracart_api/models/order_billing.rb', line 536

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


516
517
518
 
# File 'lib/ultracart_api/models/order_billing.rb', line 516

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



522
523
524
 
# File 'lib/ultracart_api/models/order_billing.rb', line 522

def hash
  [address1, address2, cc_emails, cell_phone, cell_phone_e164, city, company, country_code, day_phone, day_phone_e164, email, evening_phone, evening_phone_e164, first_name, last_name, postal_code, state_region, title].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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
289
290
291
292
293
294
 
# File 'lib/ultracart_api/models/order_billing.rb', line 223

def list_invalid_properties
  invalid_properties = Array.new
  if !@address1.nil? && @address1.to_s.length > 50
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 50.')
  end

  if !@address2.nil? && @address2.to_s.length > 50
    invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 50.')
  end

  if !@cell_phone.nil? && @cell_phone.to_s.length > 25
    invalid_properties.push('invalid value for "cell_phone", the character length must be smaller than or equal to 25.')
  end

  if !@cell_phone_e164.nil? && @cell_phone_e164.to_s.length > 25
    invalid_properties.push('invalid value for "cell_phone_e164", the character length must be smaller than or equal to 25.')
  end

  if !@city.nil? && @city.to_s.length > 32
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 32.')
  end

  if !@company.nil? && @company.to_s.length > 50
    invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 50.')
  end

  if !@country_code.nil? && @country_code.to_s.length > 2
    invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
  end

  if !@day_phone.nil? && @day_phone.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone", the character length must be smaller than or equal to 25.')
  end

  if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
    invalid_properties.push('invalid value for "day_phone_e164", the character length must be smaller than or equal to 25.')
  end

  if !@email.nil? && @email.to_s.length > 100
    invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
  end

  if !@evening_phone.nil? && @evening_phone.to_s.length > 25
    invalid_properties.push('invalid value for "evening_phone", the character length must be smaller than or equal to 25.')
  end

  if !@evening_phone_e164.nil? && @evening_phone_e164.to_s.length > 25
    invalid_properties.push('invalid value for "evening_phone_e164", the character length must be smaller than or equal to 25.')
  end

  if !@first_name.nil? && @first_name.to_s.length > 30
    invalid_properties.push('invalid value for "first_name", the character length must be smaller than or equal to 30.')
  end

  if !@last_name.nil? && @last_name.to_s.length > 30
    invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 30.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 20
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 20.')
  end

  if !@state_region.nil? && @state_region.to_s.length > 32
    invalid_properties.push('invalid value for "state_region", the character length must be smaller than or equal to 32.')
  end

  if !@title.nil? && @title.to_s.length > 50
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 50.')
  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



607
608
609
 
# File 'lib/ultracart_api/models/order_billing.rb', line 607

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



613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/ultracart_api/models/order_billing.rb', line 613

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



601
602
603
 
# File 'lib/ultracart_api/models/order_billing.rb', line 601

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ultracart_api/models/order_billing.rb', line 298

def valid?
  return false if !@address1.nil? && @address1.to_s.length > 50
  return false if !@address2.nil? && @address2.to_s.length > 50
  return false if !@cell_phone.nil? && @cell_phone.to_s.length > 25
  return false if !@cell_phone_e164.nil? && @cell_phone_e164.to_s.length > 25
  return false if !@city.nil? && @city.to_s.length > 32
  return false if !@company.nil? && @company.to_s.length > 50
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@day_phone.nil? && @day_phone.to_s.length > 25
  return false if !@day_phone_e164.nil? && @day_phone_e164.to_s.length > 25
  return false if !@email.nil? && @email.to_s.length > 100
  return false if !@evening_phone.nil? && @evening_phone.to_s.length > 25
  return false if !@evening_phone_e164.nil? && @evening_phone_e164.to_s.length > 25
  return false if !@first_name.nil? && @first_name.to_s.length > 30
  return false if !@last_name.nil? && @last_name.to_s.length > 30
  return false if !@postal_code.nil? && @postal_code.to_s.length > 20
  return false if !@state_region.nil? && @state_region.to_s.length > 32
  return false if !@title.nil? && @title.to_s.length > 50
  true
end