Class: PCPServerSDK::CapturePaymentRequest

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

Overview

If the shopping cart is specified, a Capture is made with the amount of the shopping cart for the items that are specified.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CapturePaymentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
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
121
122
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 88

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

  if attributes.key?(:'is_final')
    self.is_final = attributes[:'is_final']
  else
    self.is_final = false
  end

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

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

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

Instance Attribute Details

#amount ⇒ Object

Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits). The amount can be lower than the amount that was authorized, but not higher. If left empty, the full amount will be captured and the request will be final. If the full amount is captured, the request will also be final.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 20

def amount
  @amount
end

#cancellation_reason ⇒ Object

Returns the value of attribute cancellation_reason.



25
26
27
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 25

def cancellation_reason
  @cancellation_reason
end

#delivery ⇒ Object

Returns the value of attribute delivery.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 29

def delivery
  @delivery
end

#is_final ⇒ Object

This property indicates whether this will be the final operation. If the full amount should not captured but the property is set to true, the remaining amount will automatically be cancelled.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 23

def is_final
  @is_final
end

#references ⇒ Object

Returns the value of attribute references.



27
28
29
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 27

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



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
247
248
249
250
251
252
253
254
255
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 218

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
    # 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
    # models (e.g. Pet) or oneOf
    klass = PCPServerSDK.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



65
66
67
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 54

def self.attribute_map
  {
    :'amount' => :'amount',
    :'is_final' => :'isFinal',
    :'cancellation_reason' => :'cancellationReason',
    :'references' => :'references',
    :'delivery' => :'delivery'
  }
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 194

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



81
82
83
84
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 70

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'is_final' => :'Boolean',
    :'cancellation_reason' => :'CancellationReason',
    :'references' => :'PaymentReferences',
    :'delivery' => :'DeliveryInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      is_final == o.is_final &&
      cancellation_reason == o.cancellation_reason &&
      references == o.references &&
      delivery == o.delivery
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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 289

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 187

def hash
  [amount, is_final, cancellation_reason, references, delivery].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



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 126

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@amount.nil? && @amount > 999999999999
    invalid_properties.push('invalid value for "amount", must be smaller than or equal to 999999999999.')
  end

  if !@amount.nil? && @amount < 1
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.')
  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



265
266
267
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 265

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 271

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



259
260
261
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 259

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



142
143
144
145
146
147
 
# File 'lib/PCP-server-Ruby-SDK/models/capture_payment_request.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@amount.nil? && @amount > 999999999999
  return false if !@amount.nil? && @amount < 1
  true
end