Class: CyberSource::Ptsv2paymentsProcessingInformationCaptureOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsProcessingInformationCaptureOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 78

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

  if attributes.has_key?(:'totalCaptureCount')
    self.total_capture_count = attributes[:'totalCaptureCount']
  end

  if attributes.has_key?(:'dateToCapture')
    self.date_to_capture = attributes[:'dateToCapture']
  end

  if attributes.has_key?(:'isFinal')
    self.is_final = attributes[:'isFinal']
  end

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

  if attributes.has_key?(:'reconciliationId')
    self.reconciliation_id = attributes[:'reconciliationId']
  end

  if attributes.has_key?(:'reconciliationIdAlternate')
    self.reconciliation_id_alternate = attributes[:'reconciliationIdAlternate']
  end
end

Instance Attribute Details

#capture_sequence_number ⇒ Object

Capture number when requesting multiple partial captures for one authorization. Used along with ‘totalCaptureCount` to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber_ = 2`, and - `totalCaptureCount = 5`



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 17

def capture_sequence_number
  @capture_sequence_number
end

#date_to_capture ⇒ Object

Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet. Format: ‘MMDD` #### Used by Authorization Optional field.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 23

def date_to_capture
  @date_to_capture
end

#is_final ⇒ Object

Indicates whether to release the authorization hold on the remaining funds. Possible Values: - ‘true` - `false`



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 26

def is_final
  @is_final
end

#notes ⇒ Object

An informational note about this settlement. Appears in both the payer’s transaction history and the emails that the payer receives.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 29

def notes
  @notes
end

#reconciliation_id ⇒ Object

Used for authbill request when capture field equals true



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 32

def reconciliation_id
  @reconciliation_id
end

#reconciliation_id_alternate ⇒ Object

Used by Nike merchant to send 12 digit order number



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 35

def reconciliation_id_alternate
  @reconciliation_id_alternate
end

#total_capture_count ⇒ Object

Total number of captures when requesting multiple partial captures for one payment. Used along with ‘captureSequenceNumber` field to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - `captureSequenceNumber = 2`, and - `totalCaptureCount = 5`



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 20

def total_capture_count
  @total_capture_count
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 38

def self.attribute_map
  {
    :'capture_sequence_number' => :'captureSequenceNumber',
    :'total_capture_count' => :'totalCaptureCount',
    :'date_to_capture' => :'dateToCapture',
    :'is_final' => :'isFinal',
    :'notes' => :'notes',
    :'reconciliation_id' => :'reconciliationId',
    :'reconciliation_id_alternate' => :'reconciliationIdAlternate'
  }
end

.json_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 51

def self.json_map
  {
    :'capture_sequence_number' => :'capture_sequence_number',
    :'total_capture_count' => :'total_capture_count',
    :'date_to_capture' => :'date_to_capture',
    :'is_final' => :'is_final',
    :'notes' => :'notes',
    :'reconciliation_id' => :'reconciliation_id',
    :'reconciliation_id_alternate' => :'reconciliation_id_alternate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 64

def self.swagger_types
  {
    :'capture_sequence_number' => :'Integer',
    :'total_capture_count' => :'Integer',
    :'date_to_capture' => :'String',
    :'is_final' => :'String',
    :'notes' => :'String',
    :'reconciliation_id' => :'String',
    :'reconciliation_id_alternate' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      capture_sequence_number == o.capture_sequence_number &&
      total_capture_count == o.total_capture_count &&
      date_to_capture == o.date_to_capture &&
      is_final == o.is_final &&
      notes == o.notes &&
      reconciliation_id == o.reconciliation_id &&
      reconciliation_id_alternate == o.reconciliation_id_alternate
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



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 218

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 284

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 197

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 the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


184
185
186
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 190

def hash
  [capture_sequence_number, total_capture_count, date_to_capture, is_final, notes, reconciliation_id, reconciliation_id_alternate].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



115
116
117
118
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  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



264
265
266
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 270

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



258
259
260
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 258

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



122
123
124
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb', line 122

def valid?
  true
end