Class: CyberSource::Upv1capturecontextsCompleteMandate

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

Overview

The completeMandate object is designed to provide instructions for orchestrating payment services. Unified Checkout is capable of orchestrating a number of services on your behalf.
By providing this field in the capture context Unified Checkout will initiate services on your behalf from the browser, simplifying your integration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upv1capturecontextsCompleteMandate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 60

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

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

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

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

Instance Attribute Details

#consumer_authentication ⇒ Object

Configure Unified Checkout to determine whether Consumer Authentication is invoked during service orchestration. Possible values: - True - False
Setting this value to True will attempt to perform authentication using the Payer Authentication Service. Setting this value to False (or not provided) indicates that you do not wish to perform authentication using the Payer Authentication Service.



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

def consumer_authentication
  @consumer_authentication
end

#decision_manager ⇒ Object

Configure Unified Checkout to determine whether Decision Manager is invoked during service orchestration. Possible values: - True - False
Setting this value to True indicates that device fingerprinting will be executed to add additional information for risk service Setting this value to False (or not provided) indicates that you do not wish to run device fingerprinting and skip decision manager services.



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

def decision_manager
  @decision_manager
end

#tms ⇒ Object

Returns the value of attribute tms.



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

def tms
  @tms
end

#type ⇒ Object

This field is used to indicate how a payment should be processed. Possible values: - AUTH: Use this value when you want to authorize a payment within Unified Checkout without capturing it immediately. Payment types that initiate an immediate transfer of funds are NOT allowed. If a capture context request includes a payment type incompatible with this mode, a 400 error will be returned. A merchant would need to perform their own capture via API where applicable.
- CAPTURE: Use this value when you want to perform a sale within Unified Checkout and capture the payment immediately during the transaction. Note: Some payment types may return a PENDING status, requiring an additional status check call to determine the final outcome of the payment.
- PREFER_AUTH: Use this value to offer multiple alternative payment options during the Unified Checkout experience. This option authorizes the payment without immediate capture, where available. It will perform a "CAPTURE" where an "AUTH" is not allowed by the payment type. Transactions can be AUTHORIZED, CAPTURED, or PENDING. If an "AUTH" is performed, a merchant would need to perform their own capture via API where applicable.



18
19
20
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 29

def self.attribute_map
  {
    :'type' => :'type',
    :'tms' => :'tms',
    :'decision_manager' => :'decisionManager',
    :'consumer_authentication' => :'consumerAuthentication'
  }
end

.json_map ⇒ Object

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



39
40
41
42
43
44
45
46
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 39

def self.json_map
  {
    :'type' => :'type',
    :'tms' => :'tms',
    :'decision_manager' => :'decision_manager',
    :'consumer_authentication' => :'consumer_authentication'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 49

def self.swagger_types
  {
    :'type' => :'String',
    :'tms' => :'Upv1capturecontextsCompleteMandateTms',
    :'decision_manager' => :'BOOLEAN',
    :'consumer_authentication' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 104

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      tms == o.tms &&
      decision_manager == o.decision_manager &&
      consumer_authentication == o.consumer_authentication
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 149

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 215

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 128

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 121

def hash
  [type, tms, decision_manager, consumer_authentication].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



85
86
87
88
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 85

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



195
196
197
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 195

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



201
202
203
204
205
206
207
208
209
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 201

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



189
190
191
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 189

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



92
93
94
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb', line 92

def valid?
  true
end