Class: PCPServerSDK::Models::CaptureOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/capture_output.rb

Overview

Object containing Capture details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CaptureOutput

Initializes the object.

Parameters:

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

    Model attributes in the form of hash.



54
55
56
57
58
59
60
61
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
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 54

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

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

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

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

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

Instance Attribute Details

#amount_of_money ⇒ Object

Returns the value of attribute amount_of_money.



8
9
10
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 8

def amount_of_money
  @amount_of_money
end

#merchant_parameters ⇒ Object

It allows you to store additional parameters for the transaction in JSON format. This field must not contain any personal data.



11
12
13
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 11

def merchant_parameters
  @merchant_parameters
end

#payment_instructions ⇒ Object

Returns the value of attribute payment_instructions.



18
19
20
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 18

def payment_instructions
  @payment_instructions
end

#payment_method ⇒ Object

Payment method identifier used by our payment engine.



16
17
18
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 16

def payment_method
  @payment_method
end

#references ⇒ Object

Returns the value of attribute references.



13
14
15
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 13

def references
  @references
end

Class Method Details

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 137

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    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 = PCPServerSDK::Models.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about.



32
33
34
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 32

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 21

def self.attribute_map
  {
    :'amount_of_money' => :'amountOfMoney',
    :'merchant_parameters' => :'merchantParameters',
    :'references' => :'references',
    :'payment_method' => :'paymentMethod',
    :'payment_instructions' => :'paymentInstructions'
  }
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.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 115

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true.



48
49
50
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 48

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 37

def self.openapi_types
  {
    :'amount_of_money' => :'AmountOfMoney',
    :'merchant_parameters' => :'String',
    :'references' => :'PaymentReferences',
    :'payment_method' => :'String',
    :'payment_instructions' => :'PaymentInstructions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared.



90
91
92
93
94
95
96
97
98
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 90

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    amount_of_money == o.amount_of_money &&
    merchant_parameters == o.merchant_parameters &&
    references == o.references &&
    payment_method == o.payment_method &&
    payment_instructions == o.payment_instructions
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.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 206

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared.

Returns:

  • (Boolean)

See Also:

  • `==` method.


102
103
104
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 102

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code.



108
109
110
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 108

def hash
  [amount_of_money, merchant_parameters, references, payment_method, payment_instructions].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility).

Returns:

  • (Hash) —

    Returns the object in the form of hash.



182
183
184
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 182

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.



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 188

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



176
177
178
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_output.rb', line 176

def to_s
  to_hash.to_s
end