Class: OpenapiClient::Order

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/order.rb

Overview

Use this model to provide order related details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Order

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
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
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
 
# File 'lib/openapi_client/models/order.rb', line 81

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_details ⇒ Object

Returns the value of attribute additional_details.



37
38
39
 
# File 'lib/openapi_client/models/order.rb', line 37

def additional_details
  @additional_details
end

#bancontact_qr ⇒ Object

Returns the value of attribute bancontact_qr.



39
40
41
 
# File 'lib/openapi_client/models/order.rb', line 39

def bancontact_qr
  @bancontact_qr
end

#billing ⇒ Object

Returns the value of attribute billing.



21
22
23
 
# File 'lib/openapi_client/models/order.rb', line 21

def billing
  @billing
end

#client_locale ⇒ Object

Returns the value of attribute client_locale.



41
42
43
 
# File 'lib/openapi_client/models/order.rb', line 41

def client_locale
  @client_locale
end

#industry_specific_extensions ⇒ Object

Returns the value of attribute industry_specific_extensions.



25
26
27
 
# File 'lib/openapi_client/models/order.rb', line 25

def industry_specific_extensions
  @industry_specific_extensions
end

#installment_options ⇒ Object

Returns the value of attribute installment_options.



29
30
31
 
# File 'lib/openapi_client/models/order.rb', line 29

def installment_options
  @installment_options
end

#order_id ⇒ Object

Note - Client Order ID if supplied by client. If not supplied by client, IPG will generate. The first 12 alphanumeric digits are passed down to Fiserv Enterprise reporting tool, Clientline and Data File Manager (DFM).



19
20
21
 
# File 'lib/openapi_client/models/order.rb', line 19

def order_id
  @order_id
end

#purchase_card ⇒ Object

Returns the value of attribute purchase_card.



27
28
29
 
# File 'lib/openapi_client/models/order.rb', line 27

def purchase_card
  @purchase_card
end

#revolving_options ⇒ Object

Returns the value of attribute revolving_options.



31
32
33
 
# File 'lib/openapi_client/models/order.rb', line 31

def revolving_options
  @revolving_options
end

#shipping ⇒ Object

Returns the value of attribute shipping.



23
24
25
 
# File 'lib/openapi_client/models/order.rb', line 23

def shipping
  @shipping
end

#soft_descriptor ⇒ Object

Returns the value of attribute soft_descriptor.



35
36
37
 
# File 'lib/openapi_client/models/order.rb', line 35

def soft_descriptor
  @soft_descriptor
end

#stand_in_details ⇒ Object

Returns the value of attribute stand_in_details.



33
34
35
 
# File 'lib/openapi_client/models/order.rb', line 33

def stand_in_details
  @stand_in_details
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/openapi_client/models/order.rb', line 44

def self.attribute_map
  {
    :'order_id' => :'orderId',
    :'billing' => :'billing',
    :'shipping' => :'shipping',
    :'industry_specific_extensions' => :'industrySpecificExtensions',
    :'purchase_card' => :'purchaseCard',
    :'installment_options' => :'installmentOptions',
    :'revolving_options' => :'revolvingOptions',
    :'stand_in_details' => :'standInDetails',
    :'soft_descriptor' => :'softDescriptor',
    :'additional_details' => :'additionalDetails',
    :'bancontact_qr' => :'bancontactQR',
    :'client_locale' => :'clientLocale'
  }
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



205
206
207
 
# File 'lib/openapi_client/models/order.rb', line 205

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/openapi_client/models/order.rb', line 62

def self.openapi_types
  {
    :'order_id' => :'String',
    :'billing' => :'Billing',
    :'shipping' => :'Shipping',
    :'industry_specific_extensions' => :'IndustrySpecificExtensions',
    :'purchase_card' => :'PurchaseCards',
    :'installment_options' => :'InstallmentOptions',
    :'revolving_options' => :'RevolvingOptions',
    :'stand_in_details' => :'StandInDetails',
    :'soft_descriptor' => :'SoftDescriptor',
    :'additional_details' => :'AdditionalDetails',
    :'bancontact_qr' => :'BancontactQR',
    :'client_locale' => :'ClientLocale'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/openapi_client/models/order.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      order_id == o.order_id &&
      billing == o.billing &&
      shipping == o.shipping &&
      industry_specific_extensions == o.industry_specific_extensions &&
      purchase_card == o.purchase_card &&
      installment_options == o.installment_options &&
      revolving_options == o.revolving_options &&
      stand_in_details == o.stand_in_details &&
      soft_descriptor == o.soft_descriptor &&
      additional_details == o.additional_details &&
      bancontact_qr == o.bancontact_qr &&
      client_locale == o.client_locale
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



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
 
# File 'lib/openapi_client/models/order.rb', line 233

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/openapi_client/models/order.rb', line 307

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/openapi_client/models/order.rb', line 212

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


192
193
194
 
# File 'lib/openapi_client/models/order.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/openapi_client/models/order.rb', line 198

def hash
  [order_id, billing, shipping, industry_specific_extensions, purchase_card, installment_options, revolving_options, stand_in_details, soft_descriptor, additional_details, bancontact_qr, client_locale].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



145
146
147
148
149
150
151
152
 
# File 'lib/openapi_client/models/order.rb', line 145

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



283
284
285
 
# File 'lib/openapi_client/models/order.rb', line 283

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/openapi_client/models/order.rb', line 289

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = 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



277
278
279
 
# File 'lib/openapi_client/models/order.rb', line 277

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



156
157
158
159
 
# File 'lib/openapi_client/models/order.rb', line 156

def valid?
  return false if !@order_id.nil? && @order_id.to_s.length > 100
  true
end