Class: CyberSource::GenerateUnifiedCheckoutCaptureContextRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateUnifiedCheckoutCaptureContextRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/generate_unified_checkout_capture_context_request.rb', line 85

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

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

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

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

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

Instance Attribute Details

#allowed_card_networksObject

Returns the value of attribute allowed_card_networks.



22
23
24
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 22

def allowed_card_networks
  @allowed_card_networks
end

#allowed_payment_typesObject

Returns the value of attribute allowed_payment_types.



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

def allowed_payment_types
  @allowed_payment_types
end

#capture_mandateObject

Returns the value of attribute capture_mandate.



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

def capture_mandate
  @capture_mandate
end

#checkout_api_initializationObject

Returns the value of attribute checkout_api_initialization.



36
37
38
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 36

def checkout_api_initialization
  @checkout_api_initialization
end

#client_versionObject

version number of Unified Checkout being used



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

def client_version
  @client_version
end

#countryObject

Country the purchase is originating from (e.g. country of the merchant). Use the two- character ISO Standard



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

def country
  @country
end

#localeObject

Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code



30
31
32
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 30

def locale
  @locale
end

#order_informationObject

Returns the value of attribute order_information.



34
35
36
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 34

def order_information
  @order_information
end

#target_originsObject

Returns the value of attribute target_origins.



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

def target_origins
  @target_origins
end

Class Method Details

.attribute_mapObject

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



39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 39

def self.attribute_map
  {
    :'target_origins' => :'targetOrigins',
    :'client_version' => :'clientVersion',
    :'allowed_card_networks' => :'allowedCardNetworks',
    :'allowed_payment_types' => :'allowedPaymentTypes',
    :'country' => :'country',
    :'locale' => :'locale',
    :'capture_mandate' => :'captureMandate',
    :'order_information' => :'orderInformation',
    :'checkout_api_initialization' => :'checkoutApiInitialization'
  }
end

.json_mapObject

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



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

def self.json_map
  {
    :'target_origins' => :'target_origins',
    :'client_version' => :'client_version',
    :'allowed_card_networks' => :'allowed_card_networks',
    :'allowed_payment_types' => :'allowed_payment_types',
    :'country' => :'country',
    :'locale' => :'locale',
    :'capture_mandate' => :'capture_mandate',
    :'order_information' => :'order_information',
    :'checkout_api_initialization' => :'checkout_api_initialization'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'target_origins' => :'Array<String>',
    :'client_version' => :'String',
    :'allowed_card_networks' => :'Array<String>',
    :'allowed_payment_types' => :'Array<String>',
    :'country' => :'String',
    :'locale' => :'String',
    :'capture_mandate' => :'Upv1capturecontextsCaptureMandate',
    :'order_information' => :'Upv1capturecontextsOrderInformation',
    :'checkout_api_initialization' => :'Upv1capturecontextsCheckoutApiInitialization'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 161

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



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
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 211

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



277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 277

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 190

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


177
178
179
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 177

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



183
184
185
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 183

def hash
  [target_origins, client_version, allowed_card_networks, allowed_payment_types, country, locale, capture_mandate, order_information, checkout_api_initialization].hash
end

#list_invalid_propertiesObject

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/generate_unified_checkout_capture_context_request.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



257
258
259
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 257

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



263
264
265
266
267
268
269
270
271
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 263

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



251
252
253
# File 'lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb', line 251

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/generate_unified_checkout_capture_context_request.rb', line 143

def valid?
  true
end