Class: OpenapiClient::AdditionalDetails

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

Overview

Merchant supplied tracking numbers.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AdditionalDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/openapi_client/models/additional_details.rb', line 104

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

Comments for the payment.



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

def comments
  @comments
end

#high_risk_purchase_indicator ⇒ Object

this is highRiskPurchaseIndicator.



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

def high_risk_purchase_indicator
  @high_risk_purchase_indicator
end

#invoice_number ⇒ Object

Invoice number.



22
23
24
 
# File 'lib/openapi_client/models/additional_details.rb', line 22

def invoice_number
  @invoice_number
end

#ipg_deferred_auth ⇒ Object

Indicates if the particular transaction is a deferred authorization.



34
35
36
 
# File 'lib/openapi_client/models/additional_details.rb', line 34

def ipg_deferred_auth
  @ipg_deferred_auth
end

#operator_id ⇒ Object

The operator ID.



28
29
30
 
# File 'lib/openapi_client/models/additional_details.rb', line 28

def operator_id
  @operator_id
end

#purchase_order_number ⇒ Object

Purchase order number.



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

def purchase_order_number
  @purchase_order_number
end

#receipts ⇒ Object

Provides request information that is necessary to generate receipts.



40
41
42
 
# File 'lib/openapi_client/models/additional_details.rb', line 40

def receipts
  @receipts
end

#sales_system_id ⇒ Object

The sales system ID.



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

def sales_system_id
  @sales_system_id
end

#sca_exemption_type ⇒ Object

Strong customer authentication exemption type indicator.



43
44
45
 
# File 'lib/openapi_client/models/additional_details.rb', line 43

def sca_exemption_type
  @sca_exemption_type
end

#sca_visa_merchant_id ⇒ Object

Eight-character Visa merchant identifier (VMID) assigned by Visa, required for trusted merchant and delegated authentication.



46
47
48
 
# File 'lib/openapi_client/models/additional_details.rb', line 46

def sca_visa_merchant_id
  @sca_visa_merchant_id
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_client/models/additional_details.rb', line 71

def self.attribute_map
  {
    :'comments' => :'comments',
    :'invoice_number' => :'invoiceNumber',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'operator_id' => :'operatorId',
    :'sales_system_id' => :'salesSystemId',
    :'ipg_deferred_auth' => :'ipgDeferredAuth',
    :'high_risk_purchase_indicator' => :'highRiskPurchaseIndicator',
    :'receipts' => :'receipts',
    :'sca_exemption_type' => :'scaExemptionType',
    :'sca_visa_merchant_id' => :'scaVisaMerchantID'
  }
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



329
330
331
 
# File 'lib/openapi_client/models/additional_details.rb', line 329

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

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/openapi_client/models/additional_details.rb', line 87

def self.openapi_types
  {
    :'comments' => :'String',
    :'invoice_number' => :'String',
    :'purchase_order_number' => :'String',
    :'operator_id' => :'String',
    :'sales_system_id' => :'String',
    :'ipg_deferred_auth' => :'Boolean',
    :'high_risk_purchase_indicator' => :'Boolean',
    :'receipts' => :'Array<ReceiptRequestInfo>',
    :'sca_exemption_type' => :'String',
    :'sca_visa_merchant_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/openapi_client/models/additional_details.rb', line 299

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comments == o.comments &&
      invoice_number == o.invoice_number &&
      purchase_order_number == o.purchase_order_number &&
      operator_id == o.operator_id &&
      sales_system_id == o.sales_system_id &&
      ipg_deferred_auth == o.ipg_deferred_auth &&
      high_risk_purchase_indicator == o.high_risk_purchase_indicator &&
      receipts == o.receipts &&
      sca_exemption_type == o.sca_exemption_type &&
      sca_visa_merchant_id == o.sca_visa_merchant_id
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



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
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/openapi_client/models/additional_details.rb', line 357

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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/openapi_client/models/additional_details.rb', line 431

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/openapi_client/models/additional_details.rb', line 336

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


316
317
318
 
# File 'lib/openapi_client/models/additional_details.rb', line 316

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



322
323
324
 
# File 'lib/openapi_client/models/additional_details.rb', line 322

def hash
  [comments, invoice_number, purchase_order_number, operator_id, sales_system_id, ipg_deferred_auth, high_risk_purchase_indicator, receipts, sca_exemption_type, sca_visa_merchant_id].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



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

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

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

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

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

  pattern = Regexp.new(/^\S$|^\S.*\S$/)
  if !@operator_id.nil? && @operator_id !~ pattern
    invalid_properties.push("invalid value for \"operator_id\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/^\S$|^\S.*\S$/)
  if !@sales_system_id.nil? && @sales_system_id !~ pattern
    invalid_properties.push("invalid value for \"sales_system_id\", must conform to the pattern #{pattern}.")
  end

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



407
408
409
 
# File 'lib/openapi_client/models/additional_details.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/openapi_client/models/additional_details.rb', line 413

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



401
402
403
 
# File 'lib/openapi_client/models/additional_details.rb', line 401

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



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/openapi_client/models/additional_details.rb', line 203

def valid?
  return false if !@comments.nil? && @comments.to_s.length > 1024
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 48
  return false if !@purchase_order_number.nil? && @purchase_order_number.to_s.length > 128
  return false if !@operator_id.nil? && @operator_id.to_s.length > 35
  return false if !@operator_id.nil? && @operator_id !~ Regexp.new(/^\S$|^\S.*\S$/)
  return false if !@sales_system_id.nil? && @sales_system_id.to_s.length > 50
  return false if !@sales_system_id.nil? && @sales_system_id !~ Regexp.new(/^\S$|^\S.*\S$/)
  sca_exemption_type_validator = EnumAttributeValidator.new('String', ["Low Value Exemption", "TRA Exemption", "Trusted Merchant Exemption", "SCP Exemption", "Delegated Authentication"])
  return false unless sca_exemption_type_validator.valid?(@sca_exemption_type)
  return false if !@sca_visa_merchant_id.nil? && @sca_visa_merchant_id.to_s.length > 8
  true
end