Class: UltracartClient::AutoOrderQuery

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AutoOrderQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_order_code ⇒ Object

Auto order code



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

def auto_order_code
  @auto_order_code
end

#card_type ⇒ Object

Card type



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

def card_type
  @card_type
end

#city ⇒ Object

City



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

def city
  @city
end

#company ⇒ Object

Company



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

def company
  @company
end

#country_code ⇒ Object

ISO-3166 two letter country code



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

def country_code
  @country_code
end

#customer_profile_oid ⇒ Object

Customer profile object identifier



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

def customer_profile_oid
  @customer_profile_oid
end

#email ⇒ Object

Email



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

def email
  @email
end

#first_name ⇒ Object

First name



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

def first_name
  @first_name
end

#item_id ⇒ Object

Item ID. Deprecated query field. This incorrectly meant the original order contained this item id.



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

def item_id
  @item_id
end

#last_name ⇒ Object

Last name



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

def last_name
  @last_name
end

#next_item_id ⇒ Object

Next Item ID that is supposed to ship. This is calculated based upon the schedule associated with the original item id.



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

def next_item_id
  @next_item_id
end

#next_shipment_date_begin ⇒ Object

Next shipment date begin



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

def next_shipment_date_begin
  @next_shipment_date_begin
end

#next_shipment_date_end ⇒ Object

Next shipment date end



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

def next_shipment_date_end
  @next_shipment_date_end
end

#original_item_id ⇒ Object

Original Item ID purchased on auto order.



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

def original_item_id
  @original_item_id
end

#original_order_date_begin ⇒ Object

Original order date begin



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

def original_order_date_begin
  @original_order_date_begin
end

#original_order_date_end ⇒ Object

Original order date end



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

def original_order_date_end
  @original_order_date_end
end

#original_order_id ⇒ Object

Original order ID



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

def original_order_id
  @original_order_id
end

#phone ⇒ Object

Phone



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

def phone
  @phone
end

#postal_code ⇒ Object

Postal code



73
74
75
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 73

def postal_code
  @postal_code
end

#state ⇒ Object

State



76
77
78
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 76

def state
  @state
end

#status ⇒ Object

Status



79
80
81
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 79

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



109
110
111
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'auto_order_code' => :'auto_order_code',
    :'card_type' => :'card_type',
    :'city' => :'city',
    :'company' => :'company',
    :'country_code' => :'country_code',
    :'customer_profile_oid' => :'customer_profile_oid',
    :'email' => :'email',
    :'first_name' => :'first_name',
    :'item_id' => :'item_id',
    :'last_name' => :'last_name',
    :'next_item_id' => :'next_item_id',
    :'next_shipment_date_begin' => :'next_shipment_date_begin',
    :'next_shipment_date_end' => :'next_shipment_date_end',
    :'original_item_id' => :'original_item_id',
    :'original_order_date_begin' => :'original_order_date_begin',
    :'original_order_date_end' => :'original_order_date_end',
    :'original_order_id' => :'original_order_id',
    :'phone' => :'phone',
    :'postal_code' => :'postal_code',
    :'state' => :'state',
    :'status' => :'status'
  }
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



362
363
364
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 362

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 141

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'auto_order_code' => :'String',
    :'card_type' => :'String',
    :'city' => :'String',
    :'company' => :'String',
    :'country_code' => :'String',
    :'customer_profile_oid' => :'Integer',
    :'email' => :'String',
    :'first_name' => :'String',
    :'item_id' => :'String',
    :'last_name' => :'String',
    :'next_item_id' => :'String',
    :'next_shipment_date_begin' => :'String',
    :'next_shipment_date_end' => :'String',
    :'original_item_id' => :'String',
    :'original_order_date_begin' => :'String',
    :'original_order_date_end' => :'String',
    :'original_order_id' => :'String',
    :'phone' => :'String',
    :'postal_code' => :'String',
    :'state' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_order_code == o.auto_order_code &&
      card_type == o.card_type &&
      city == o.city &&
      company == o.company &&
      country_code == o.country_code &&
      customer_profile_oid == o.customer_profile_oid &&
      email == o.email &&
      first_name == o.first_name &&
      item_id == o.item_id &&
      last_name == o.last_name &&
      next_item_id == o.next_item_id &&
      next_shipment_date_begin == o.next_shipment_date_begin &&
      next_shipment_date_end == o.next_shipment_date_end &&
      original_item_id == o.original_item_id &&
      original_order_date_begin == o.original_order_date_begin &&
      original_order_date_end == o.original_order_date_end &&
      original_order_id == o.original_order_id &&
      phone == o.phone &&
      postal_code == o.postal_code &&
      state == o.state &&
      status == o.status
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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 393

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



464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 464

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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 369

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


349
350
351
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 349

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



355
356
357
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 355

def hash
  [auto_order_code, card_type, city, company, country_code, customer_profile_oid, email, first_name, item_id, last_name, next_item_id, next_shipment_date_begin, next_shipment_date_end, original_item_id, original_order_date_begin, original_order_date_end, original_order_id, phone, postal_code, state, status].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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 248

def list_invalid_properties
  invalid_properties = Array.new
  if !@card_type.nil? && @card_type.to_s.length > 100
    invalid_properties.push('invalid value for "card_type", the character length must be smaller than or equal to 100.')
  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 !@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 !@phone.nil? && @phone.to_s.length > 25
    invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 25.')
  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



440
441
442
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 440

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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 446

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



434
435
436
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 434

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



271
272
273
274
275
276
277
 
# File 'lib/ultracart_api/models/auto_order_query.rb', line 271

def valid?
  return false if !@card_type.nil? && @card_type.to_s.length > 100
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@email.nil? && @email.to_s.length > 100
  return false if !@phone.nil? && @phone.to_s.length > 25
  true
end