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 instance of microform on a 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



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
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.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?(:'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?(:'clientVersion')
    self.client_version = attributes[:'clientVersion']
  end

  if attributes.has_key?(:'checkoutApiInitialization')
    self.checkout_api_initialization = attributes[:'checkoutApiInitialization']
  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 - MAESTRO - MASTERCARD - AMEX - DISCOVER - DINERSCLUB - JCB - CUP - CARTESBANCAIRES - CARNET



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

def allowed_card_networks
  @allowed_card_networks
end

#checkout_api_initialization ⇒ Object

Returns the value of attribute checkout_api_initialization.



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

def checkout_api_initialization
  @checkout_api_initialization
end

#client_version ⇒ Object

Specify the version of Microform that you want to use.



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

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" ]



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

def target_origins
  @target_origins
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/generate_capture_context_request.rb', line 29

def self.attribute_map
  {
    :'target_origins' => :'targetOrigins',
    :'allowed_card_networks' => :'allowedCardNetworks',
    :'client_version' => :'clientVersion',
    :'checkout_api_initialization' => :'checkoutApiInitialization'
  }
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/generate_capture_context_request.rb', line 39

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'target_origins' => :'Array<String>',
    :'allowed_card_networks' => :'Array<String>',
    :'client_version' => :'String',
    :'checkout_api_initialization' => :'Microformv2sessionsCheckoutApiInitialization'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



102
103
104
105
106
107
108
109
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 102

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



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
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 147

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 213

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



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

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


113
114
115
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 113

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 119

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



89
90
91
92
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 89

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



193
194
195
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 193

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



199
200
201
202
203
204
205
206
207
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 199

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



187
188
189
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 187

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



96
97
98
 
# File 'lib/cybersource_rest_client/models/generate_capture_context_request.rb', line 96

def valid?
  true
end