Class: UltracartClient::OrderReplacement

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderReplacement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
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
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 106

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_merchant_notes_new_order ⇒ Object

Additional merchant notes to append to the new order



18
19
20
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 18

def additional_merchant_notes_new_order
  @additional_merchant_notes_new_order
end

#additional_merchant_notes_original_order ⇒ Object

Additional merchant notes to append to the original order



21
22
23
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 21

def additional_merchant_notes_original_order
  @additional_merchant_notes_original_order
end

#custom_field1 ⇒ Object

Custom field 1



24
25
26
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 24

def custom_field1
  @custom_field1
end

#custom_field2 ⇒ Object

Custom field 2



27
28
29
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 27

def custom_field2
  @custom_field2
end

#custom_field3 ⇒ Object

Custom field 3



30
31
32
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 30

def custom_field3
  @custom_field3
end

#custom_field4 ⇒ Object

Custom field 4



33
34
35
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 33

def custom_field4
  @custom_field4
end

#custom_field5 ⇒ Object

Custom field 5



36
37
38
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 36

def custom_field5
  @custom_field5
end

#custom_field6 ⇒ Object

Custom field 6



39
40
41
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 39

def custom_field6
  @custom_field6
end

#custom_field7 ⇒ Object

Custom field 7



42
43
44
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 42

def custom_field7
  @custom_field7
end

#free ⇒ Object

Set to true if this replacement shipment should be free for the customer.



45
46
47
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 45

def free
  @free
end

#immediate_charge ⇒ Object

Set to true if you want to immediately charge the payment on this order, otherwise it will go to Accounts Receivable.



48
49
50
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 48

def immediate_charge
  @immediate_charge
end

#items ⇒ Object

Items to include in the replacement order



51
52
53
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 51

def items
  @items
end

#original_order_id ⇒ Object

Original order id



54
55
56
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 54

def original_order_id
  @original_order_id
end

#shipping_method ⇒ Object

Shipping method to use. If not specified or invalid then least cost shipping will take place.



57
58
59
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 57

def shipping_method
  @shipping_method
end

#skip_payment ⇒ Object

Set to true if you want to skip the payment as if it was successful.



60
61
62
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 60

def skip_payment
  @skip_payment
end

Class Method Details

.attribute_map ⇒ Object

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

def self.attribute_map
  {
    :'additional_merchant_notes_new_order' => :'additional_merchant_notes_new_order',
    :'additional_merchant_notes_original_order' => :'additional_merchant_notes_original_order',
    :'custom_field1' => :'custom_field1',
    :'custom_field2' => :'custom_field2',
    :'custom_field3' => :'custom_field3',
    :'custom_field4' => :'custom_field4',
    :'custom_field5' => :'custom_field5',
    :'custom_field6' => :'custom_field6',
    :'custom_field7' => :'custom_field7',
    :'free' => :'free',
    :'immediate_charge' => :'immediate_charge',
    :'items' => :'items',
    :'original_order_id' => :'original_order_id',
    :'shipping_method' => :'shipping_method',
    :'skip_payment' => :'skip_payment'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'additional_merchant_notes_new_order' => :'String',
    :'additional_merchant_notes_original_order' => :'String',
    :'custom_field1' => :'String',
    :'custom_field2' => :'String',
    :'custom_field3' => :'String',
    :'custom_field4' => :'String',
    :'custom_field5' => :'String',
    :'custom_field6' => :'String',
    :'custom_field7' => :'String',
    :'free' => :'BOOLEAN',
    :'immediate_charge' => :'BOOLEAN',
    :'items' => :'Array<OrderReplacementItem>',
    :'original_order_id' => :'String',
    :'shipping_method' => :'String',
    :'skip_payment' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_merchant_notes_new_order == o.additional_merchant_notes_new_order &&
      additional_merchant_notes_original_order == o.additional_merchant_notes_original_order &&
      custom_field1 == o.custom_field1 &&
      custom_field2 == o.custom_field2 &&
      custom_field3 == o.custom_field3 &&
      custom_field4 == o.custom_field4 &&
      custom_field5 == o.custom_field5 &&
      custom_field6 == o.custom_field6 &&
      custom_field7 == o.custom_field7 &&
      free == o.free &&
      immediate_charge == o.immediate_charge &&
      items == o.items &&
      original_order_id == o.original_order_id &&
      shipping_method == o.shipping_method &&
      skip_payment == o.skip_payment
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



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 351

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 =~ /\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 = UltracartClient.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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 417

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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 330

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


317
318
319
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



323
324
325
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 323

def hash
  [additional_merchant_notes_new_order, additional_merchant_notes_original_order, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, free, immediate_charge, items, original_order_id, shipping_method, skip_payment].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



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

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

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

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

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

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

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

  if !@custom_field7.nil? && @custom_field7.to_s.length > 50
    invalid_properties.push('invalid value for "custom_field7", 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



397
398
399
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 397

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



403
404
405
406
407
408
409
410
411
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 403

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



391
392
393
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 391

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



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/ultracart_api/models/order_replacement.rb', line 212

def valid?
  return false if !@custom_field1.nil? && @custom_field1.to_s.length > 50
  return false if !@custom_field2.nil? && @custom_field2.to_s.length > 50
  return false if !@custom_field3.nil? && @custom_field3.to_s.length > 50
  return false if !@custom_field4.nil? && @custom_field4.to_s.length > 50
  return false if !@custom_field5.nil? && @custom_field5.to_s.length > 75
  return false if !@custom_field6.nil? && @custom_field6.to_s.length > 50
  return false if !@custom_field7.nil? && @custom_field7.to_s.length > 50
  true
end