Class: OpenapiClient::AdditionalDetails

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

Overview

Merchant supplied tracking numbers.

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/openapi_client/models/additional_details.rb', line 62

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

#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

#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

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/openapi_client/models/additional_details.rb', line 37

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



238
239
240
 
# File 'lib/openapi_client/models/additional_details.rb', line 238

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openapi_client/models/additional_details.rb', line 49

def self.openapi_types
  {
    :'comments' => :'String',
    :'invoice_number' => :'String',
    :'purchase_order_number' => :'String',
    :'operator_id' => :'String',
    :'sales_system_id' => :'String',
    :'ipg_deferred_auth' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/openapi_client/models/additional_details.rb', line 266

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
    OpenapiClient.const_get(type).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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/openapi_client/models/additional_details.rb', line 331

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.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[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


225
226
227
 
# File 'lib/openapi_client/models/additional_details.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/openapi_client/models/additional_details.rb', line 231

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



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

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

  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



311
312
313
 
# File 'lib/openapi_client/models/additional_details.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/openapi_client/models/additional_details.rb', line 317

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



305
306
307
 
# File 'lib/openapi_client/models/additional_details.rb', line 305

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



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/openapi_client/models/additional_details.rb', line 139

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\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\S]*\S$/)
  true
end