Class: WhiteLabelMachineName::TransactionCompletionRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionCompletionRequest

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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 62

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

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

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

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

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

Instance Attribute Details

#external_id ⇒ Object

The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 24

def external_id
  @external_id
end

#invoice_merchant_reference ⇒ Object

Returns the value of attribute invoice_merchant_reference.



27
28
29
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 27

def invoice_merchant_reference
  @invoice_merchant_reference
end

#last_completion ⇒ Object

The last completion flag indicates if this is the last completion. After the last completion is created no further completions can be issued.



30
31
32
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 30

def last_completion
  @last_completion
end

#line_items ⇒ Object

The line items which will be used to complete the transaction.



33
34
35
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 33

def line_items
  @line_items
end

#transaction_id ⇒ Object

The ID of the transaction which should be completed.



36
37
38
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 36

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 39

def self.attribute_map
  {
    :'external_id' => :'externalId',
    :'invoice_merchant_reference' => :'invoiceMerchantReference',
    :'last_completion' => :'lastCompletion',
    :'line_items' => :'lineItems',
    :'transaction_id' => :'transactionId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 50

def self.swagger_types
  {
    :'external_id' => :'String',
    :'invoice_merchant_reference' => :'String',
    :'last_completion' => :'BOOLEAN',
    :'line_items' => :'Array<CompletionLineItemCreate>',
    :'transaction_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
      invoice_merchant_reference == o.invoice_merchant_reference &&
      last_completion == o.last_completion &&
      line_items == o.line_items &&
      transaction_id == o.transaction_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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 210

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 276

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 189

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


176
177
178
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



182
183
184
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 182

def hash
  [external_id, invoice_merchant_reference, last_completion, line_items, transaction_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



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 93

def list_invalid_properties
  invalid_properties = Array.new
  if @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  end

  if @external_id.to_s.length > 100
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
  end

  if @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

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

  if @last_completion.nil?
    invalid_properties.push('invalid value for "last_completion", last_completion cannot be nil.')
  end

  if @transaction_id.nil?
    invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
  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



256
257
258
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 256

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



262
263
264
265
266
267
268
269
270
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 262

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



250
251
252
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 250

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



124
125
126
127
128
129
130
131
132
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/transaction_completion_request.rb', line 124

def valid?
  return false if @external_id.nil?
  return false if @external_id.to_s.length > 100
  return false if @external_id.to_s.length < 1
  return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
  return false if @last_completion.nil?
  return false if @transaction_id.nil?
  true
end