Class: CyberSource::Upv1capturecontextsCheckoutApiInitialization

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

Overview

Use the [Digital Accept Checkout API](developer.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Checkout_API/Secure_Acceptance_Checkout_API.pdf) in conjunction with Unified Checkout to provide a cohesive PCI SAQ A embedded payment application within your merchant e-commerce page. The Digital Accept Checkout API provides access to payment processing and additional value-added services directly from the browser.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Upv1capturecontextsCheckoutApiInitialization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_key ⇒ Object

Returns the value of attribute access_key.



19
20
21
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 19

def access_key
  @access_key
end

#amount ⇒ Object

Returns the value of attribute amount.



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

def amount
  @amount
end

#currency ⇒ Object

Returns the value of attribute currency.



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

def currency
  @currency
end

#locale ⇒ Object

Returns the value of attribute locale.



31
32
33
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 31

def locale
  @locale
end

#override_custom_receipt_page ⇒ Object

Returns the value of attribute override_custom_receipt_page.



33
34
35
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 33

def override_custom_receipt_page
  @override_custom_receipt_page
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#reference_number ⇒ Object

Returns the value of attribute reference_number.



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

def reference_number
  @reference_number
end

#transaction_type ⇒ Object

Returns the value of attribute transaction_type.



25
26
27
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 25

def transaction_type
  @transaction_type
end

#transaction_uuid ⇒ Object

Returns the value of attribute transaction_uuid.



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

def transaction_uuid
  @transaction_uuid
end

#unsigned_field_names ⇒ Object

Returns the value of attribute unsigned_field_names.



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

def unsigned_field_names
  @unsigned_field_names
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
49
50
51
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 38

def self.attribute_map
  {
    :'profile_id' => :'profile_id',
    :'access_key' => :'access_key',
    :'reference_number' => :'reference_number',
    :'transaction_uuid' => :'transaction_uuid',
    :'transaction_type' => :'transaction_type',
    :'currency' => :'currency',
    :'amount' => :'amount',
    :'locale' => :'locale',
    :'override_custom_receipt_page' => :'override_custom_receipt_page',
    :'unsigned_field_names' => :'unsigned_field_names'
  }
end

.json_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 54

def self.json_map
  {
    :'profile_id' => :'profile_id',
    :'access_key' => :'access_key',
    :'reference_number' => :'reference_number',
    :'transaction_uuid' => :'transaction_uuid',
    :'transaction_type' => :'transaction_type',
    :'currency' => :'currency',
    :'amount' => :'amount',
    :'locale' => :'locale',
    :'override_custom_receipt_page' => :'override_custom_receipt_page',
    :'unsigned_field_names' => :'unsigned_field_names'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 70

def self.swagger_types
  {
    :'profile_id' => :'String',
    :'access_key' => :'String',
    :'reference_number' => :'String',
    :'transaction_uuid' => :'String',
    :'transaction_type' => :'String',
    :'currency' => :'String',
    :'amount' => :'String',
    :'locale' => :'String',
    :'override_custom_receipt_page' => :'String',
    :'unsigned_field_names' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
      access_key == o.access_key &&
      reference_number == o.reference_number &&
      transaction_uuid == o.transaction_uuid &&
      transaction_type == o.transaction_type &&
      currency == o.currency &&
      amount == o.amount &&
      locale == o.locale &&
      override_custom_receipt_page == o.override_custom_receipt_page &&
      unsigned_field_names == o.unsigned_field_names
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 200

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 266

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 179

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


166
167
168
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 172

def hash
  [profile_id, access_key, reference_number, transaction_uuid, transaction_type, currency, amount, locale, override_custom_receipt_page, unsigned_field_names].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



136
137
138
139
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 136

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



246
247
248
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 246

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 252

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



240
241
242
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 240

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



143
144
145
 
# File 'lib/cybersource_rest_client/models/upv1capturecontexts_checkout_api_initialization.rb', line 143

def valid?
  true
end