Class: CyberSource::Acpv1instructionsinstructionIdconfirmationsOrderInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Acpv1instructionsinstructionIdconfirmationsOrderInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
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
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 92

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_detail ⇒ Object

Returns the value of attribute amount_detail.



28
29
30
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 28

def amount_detail
  @amount_detail
end

#carrier ⇒ Object

Shipping carrier or provider



38
39
40
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 38

def carrier
  @carrier
end

#expected_delivery_date ⇒ Object

Expected delivery date for the order (UTC time in Epoch format)



26
27
28
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 26

def expected_delivery_date
  @expected_delivery_date
end

#line_items ⇒ Object

Returns the value of attribute line_items.



40
41
42
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 40

def line_items
  @line_items
end

#order_date ⇒ Object

Order date (UTC time in Epoch format)



23
24
25
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 23

def order_date
  @order_date
end

#order_id ⇒ Object

Unique identifier for the order



17
18
19
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 17

def order_id
  @order_id
end

#order_status ⇒ Object

Status of the order



20
21
22
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 20

def order_status
  @order_status
end

#ship_to ⇒ Object

Returns the value of attribute ship_to.



30
31
32
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 30

def ship_to
  @ship_to
end

#shipping_details ⇒ Object

Returns the value of attribute shipping_details.



32
33
34
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 32

def shipping_details
  @shipping_details
end

#tracking_id ⇒ Object

Tracking ID for the shipment



35
36
37
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 35

def tracking_id
  @tracking_id
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 43

def self.attribute_map
  {
    :'order_id' => :'orderId',
    :'order_status' => :'orderStatus',
    :'order_date' => :'orderDate',
    :'expected_delivery_date' => :'expectedDeliveryDate',
    :'amount_detail' => :'amountDetail',
    :'ship_to' => :'shipTo',
    :'shipping_details' => :'shippingDetails',
    :'tracking_id' => :'trackingId',
    :'carrier' => :'carrier',
    :'line_items' => :'lineItems'
  }
end

.json_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 59

def self.json_map
  {
    :'order_id' => :'order_id',
    :'order_status' => :'order_status',
    :'order_date' => :'order_date',
    :'expected_delivery_date' => :'expected_delivery_date',
    :'amount_detail' => :'amount_detail',
    :'ship_to' => :'ship_to',
    :'shipping_details' => :'shipping_details',
    :'tracking_id' => :'tracking_id',
    :'carrier' => :'carrier',
    :'line_items' => :'line_items'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 75

def self.swagger_types
  {
    :'order_id' => :'String',
    :'order_status' => :'String',
    :'order_date' => :'String',
    :'expected_delivery_date' => :'String',
    :'amount_detail' => :'Acpv1instructionsinstructionIdcredentialsOrderInformationAmountDetail',
    :'ship_to' => :'Acpv1instructionsinstructionIdcredentialsOrderInformationShipTo',
    :'shipping_details' => :'Acpv1instructionsinstructionIdconfirmationsOrderInformationShippingDetails',
    :'tracking_id' => :'String',
    :'carrier' => :'String',
    :'line_items' => :'Array<Acpv1instructionsinstructionIdcredentialsOrderInformationLineItems>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order_id == o.order_id &&
      order_status == o.order_status &&
      order_date == o.order_date &&
      expected_delivery_date == o.expected_delivery_date &&
      amount_detail == o.amount_detail &&
      ship_to == o.ship_to &&
      shipping_details == o.shipping_details &&
      tracking_id == o.tracking_id &&
      carrier == o.carrier &&
      line_items == o.line_items
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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 297

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 = CyberSource.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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 363

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 276

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)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


263
264
265
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 269

def hash
  [order_id, order_status, order_date, expected_delivery_date, amount_detail, ship_to, shipping_details, tracking_id, carrier, line_items].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



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
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 143

def list_invalid_properties
  invalid_properties = Array.new
  #if !@order_id.nil? && @order_id !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "order_id", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #end

  #if !@order_status.nil? && @order_status !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "order_status", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #end

  #if !@order_date.nil? && @order_date !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "order_date", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #end

  #if !@expected_delivery_date.nil? && @expected_delivery_date !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "expected_delivery_date", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #end

  #if !@tracking_id.nil? && @tracking_id !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "tracking_id", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #end

  #if [email protected]? && @carrier !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
    #invalid_properties.push('invalid value for "carrier", must conform to the pattern /(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/.')
  #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



343
344
345
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 343

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



349
350
351
352
353
354
355
356
357
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 349

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



337
338
339
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 337

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



174
175
176
177
178
179
180
181
182
 
# File 'lib/cybersource_rest_client/models/acpv1instructionsinstruction_idconfirmations_order_information.rb', line 174

def valid?
  #return false if !@order_id.nil? && @order_id !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  #return false if !@order_status.nil? && @order_status !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  #return false if !@order_date.nil? && @order_date !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  #return false if !@expected_delivery_date.nil? && @expected_delivery_date !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  #return false if !@tracking_id.nil? && @tracking_id !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  #return false if [email protected]? && @carrier !~ Regexp.new(/(?!^[*.,'#_\/-]+$)(?!.*\\.\/.*)^.*$/)
  true
end