Class: CyberSource::MerchantRequest

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

Overview

Request object for registering a new merchant in the VMRS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MerchantRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acceptance_relationships ⇒ Object

List of acceptance network relationships



38
39
40
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 38

def acceptance_relationships
  @acceptance_relationships
end

#api_integrations ⇒ Object

Returns the value of attribute api_integrations.



45
46
47
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 45

def api_integrations
  @api_integrations
end

#cryptogram_type ⇒ Object

Authentication cryptogram type (defaults to DAVV) Possible values: - TAVV - DAVV



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

def cryptogram_type
  @cryptogram_type
end

#encryption_key ⇒ Object

Returns the value of attribute encryption_key.



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

def encryption_key
  @encryption_key
end

#indicator ⇒ Object

Transaction processing type Possible values: - TAP - ACG - BOTH



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

def indicator
  @indicator
end

#merchant_name ⇒ Object

Doing business as (DBA) name



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

def merchant_name
  @merchant_name
end

#merchant_url ⇒ Object

Base merchant URL (must use HTTPS)



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

def merchant_url
  @merchant_url
end

#payment_payload_type ⇒ Object

Credential delivery format (defaults to UNENCRYPTED) Possible values: - ENCRYPTED - UNENCRYPTED



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

def payment_payload_type
  @payment_payload_type
end

#protocol_interactions ⇒ Object

List of protocol configurations (ucp, acp, x402) with HTTPS URLs



41
42
43
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 41

def protocol_interactions
  @protocol_interactions
end

#vmid ⇒ Object

Visa Merchant ID — unique identifier



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

def vmid
  @vmid
end

#web_integrations ⇒ Object

Returns the value of attribute web_integrations.



43
44
45
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 43

def web_integrations
  @web_integrations
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 48

def self.attribute_map
  {
    :'merchant_name' => :'merchantName',
    :'merchant_url' => :'merchantUrl',
    :'vmid' => :'vmid',
    :'indicator' => :'indicator',
    :'cryptogram_type' => :'cryptogramType',
    :'payment_payload_type' => :'paymentPayloadType',
    :'encryption_key' => :'encryptionKey',
    :'acceptance_relationships' => :'acceptanceRelationships',
    :'protocol_interactions' => :'protocolInteractions',
    :'web_integrations' => :'webIntegrations',
    :'api_integrations' => :'apiIntegrations'
  }
end

.json_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 65

def self.json_map
  {
    :'merchant_name' => :'merchant_name',
    :'merchant_url' => :'merchant_url',
    :'vmid' => :'vmid',
    :'indicator' => :'indicator',
    :'cryptogram_type' => :'cryptogram_type',
    :'payment_payload_type' => :'payment_payload_type',
    :'encryption_key' => :'encryption_key',
    :'acceptance_relationships' => :'acceptance_relationships',
    :'protocol_interactions' => :'protocol_interactions',
    :'web_integrations' => :'web_integrations',
    :'api_integrations' => :'api_integrations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 82

def self.swagger_types
  {
    :'merchant_name' => :'String',
    :'merchant_url' => :'String',
    :'vmid' => :'String',
    :'indicator' => :'String',
    :'cryptogram_type' => :'String',
    :'payment_payload_type' => :'String',
    :'encryption_key' => :'Iccv1merchantsEncryptionKey',
    :'acceptance_relationships' => :'Array<String>',
    :'protocol_interactions' => :'Array<Iccv1merchantsProtocolInteractions>',
    :'web_integrations' => :'Iccv1merchantsWebIntegrations',
    :'api_integrations' => :'Iccv1merchantsApiIntegrations'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_name == o.merchant_name &&
      merchant_url == o.merchant_url &&
      vmid == o.vmid &&
      indicator == o.indicator &&
      cryptogram_type == o.cryptogram_type &&
      payment_payload_type == o.payment_payload_type &&
      encryption_key == o.encryption_key &&
      acceptance_relationships == o.acceptance_relationships &&
      protocol_interactions == o.protocol_interactions &&
      web_integrations == o.web_integrations &&
      api_integrations == o.api_integrations
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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 237

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 303

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 216

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


203
204
205
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



209
210
211
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 209

def hash
  [merchant_name, merchant_url, vmid, indicator, cryptogram_type, payment_payload_type, encryption_key, acceptance_relationships, protocol_interactions, web_integrations, api_integrations].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  if @merchant_name.nil?
    invalid_properties.push('invalid value for "merchant_name", merchant_name cannot be nil.')
  end

  if @merchant_url.nil?
    invalid_properties.push('invalid value for "merchant_url", merchant_url cannot be nil.')
  end

  if @indicator.nil?
    invalid_properties.push('invalid value for "indicator", indicator cannot be nil.')
  end

  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



283
284
285
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 283

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



289
290
291
292
293
294
295
296
297
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 289

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



277
278
279
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 277

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



176
177
178
179
180
181
 
# File 'lib/cybersource_rest_client/models/merchant_request.rb', line 176

def valid?
  return false if @merchant_name.nil?
  return false if @merchant_url.nil?
  return false if @indicator.nil?
  true
end