Class: CyberSource::GenerateCaptureContextRequest

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

Overview

This is a server-to-server API request to generate the capture context that can be used to initiate an instance of Microform on an acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateCaptureContextRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 66

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

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

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

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

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

Instance Attribute Details

#allowed_card_networks ⇒ Object

The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK Important: - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.



24
25
26
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 24

def allowed_card_networks
  @allowed_card_networks
end

#allowed_payment_types ⇒ Object

The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK 



27
28
29
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 27

def allowed_payment_types
  @allowed_payment_types
end

#client_version ⇒ Object

Specify the version of Microform that you want to use.



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

def client_version
  @client_version
end

#target_origins ⇒ Object

The [target origin](developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use hostname (unless you use localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - example.com - subdomain.example.com - example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ "example.com", "basket.example.com", "ecom.example.com" ]
You can supply up to nine origins within the targetOrigins field for nested iframes. If the list of origins exceeds five ensure that you: - Compare the list of origins in the v2/sessions targetOrigins field against the location.ancestorOrigins of the browser. - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Microform from loading and display a client-side error message.



21
22
23
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 21

def target_origins
  @target_origins
end

#transient_token_response_options ⇒ Object

Returns the value of attribute transient_token_response_options.



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

def transient_token_response_options
  @transient_token_response_options
end

Class Method Details

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
40
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 32

def self.attribute_map
  {
    :'client_version' => :'clientVersion',
    :'target_origins' => :'targetOrigins',
    :'allowed_card_networks' => :'allowedCardNetworks',
    :'allowed_payment_types' => :'allowedPaymentTypes',
    :'transient_token_response_options' => :'transientTokenResponseOptions'
  }
end

.json_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 43

def self.json_map
  {
    :'client_version' => :'client_version',
    :'target_origins' => :'target_origins',
    :'allowed_card_networks' => :'allowed_card_networks',
    :'allowed_payment_types' => :'allowed_payment_types',
    :'transient_token_response_options' => :'transient_token_response_options'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 54

def self.swagger_types
  {
    :'client_version' => :'String',
    :'target_origins' => :'Array<String>',
    :'allowed_card_networks' => :'Array<String>',
    :'allowed_payment_types' => :'Array<String>',
    :'transient_token_response_options' => :'Microformv2sessionsTransientTokenResponseOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



114
115
116
117
118
119
120
121
122
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 114

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_version == o.client_version &&
      target_origins == o.target_origins &&
      allowed_card_networks == o.allowed_card_networks &&
      allowed_payment_types == o.allowed_payment_types &&
      transient_token_response_options == o.transient_token_response_options
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



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
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 160

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



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 226

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 139

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


126
127
128
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 126

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 132

def hash
  [client_version, target_origins, allowed_card_networks, allowed_payment_types, transient_token_response_options].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



101
102
103
104
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 101

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



206
207
208
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 206

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



212
213
214
215
216
217
218
219
220
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 212

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



200
201
202
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 200

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



108
109
110
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 108

def valid?
  true
end