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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/openapi_client/models/additional_details.rb', line 47

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

#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

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/openapi_client/models/additional_details.rb', line 28

def self.attribute_map
  {
    :'comments' => :'comments',
    :'invoice_number' => :'invoiceNumber',
    :'purchase_order_number' => :'purchaseOrderNumber'
  }
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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
 
# File 'lib/openapi_client/models/additional_details.rb', line 133

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



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
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/openapi_client/models/additional_details.rb', line 184

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



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

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/openapi_client/models/additional_details.rb', line 163

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


143
144
145
 
# File 'lib/openapi_client/models/additional_details.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'lib/openapi_client/models/additional_details.rb', line 149

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



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

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

  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



229
230
231
 
# File 'lib/openapi_client/models/additional_details.rb', line 229

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



235
236
237
238
239
240
241
242
243
 
# File 'lib/openapi_client/models/additional_details.rb', line 235

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



223
224
225
 
# File 'lib/openapi_client/models/additional_details.rb', line 223

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



94
95
96
97
98
99
 
# File 'lib/openapi_client/models/additional_details.rb', line 94

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