Class: CyberSource::CardProcessingConfigCommonMerchantDescriptorInformation

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

Overview

A merchant descriptor is the line of copy that identifies transactions on a cardholder’s account activity and statement. If this information is not populated, the data will be retrieved from OMS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardProcessingConfigCommonMerchantDescriptorInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/card_processing_config_common_merchant_descriptor_information.rb', line 91

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

Applicable for American Express Direct (amexdirect), TSYS (tsys), RUPAY and Elavon Americas (elavonamericas) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>21</td><td>^+$</td></tr> </table>



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

def city
  @city
end

#country ⇒ Object

Applicable for Six (six), Elavon Americas (elavonamericas), TSYS (tsys) and American Express Direct (amexdirect) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>3</td><td>3</td><td>^+$</td></tr> </table>



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

def country
  @country
end

#country_of_origin ⇒ Object

Country Cf Origin of merchant is applicable for VPC Processors and is dependent on governmentControlled attribute.



42
43
44
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 42

def country_of_origin
  @country_of_origin
end

#name ⇒ Object

Applicable for TSYS (tsys), RUPAY, American Express Direct (amexdirect) and Elavon Americas (elavonamericas) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>38</td><td>^+$</td></tr> </table>



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

def name
  @name
end

#phone ⇒ Object

Applicable for RUPAY, Elavon Americas (elavonamericas), American Express Direct (amexdirect) and TSYS (tsys) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>20</td><td>^+$</td></tr> </table>



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

def phone
  @phone
end

#state ⇒ Object

Applicable for RUPAY, TSYS (tsys), Elavon Americas (elavonamericas) and American Express Direct (amexdirect) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>No</td><td>1</td><td>3</td><td>^+$</td></tr> </table>



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

def state
  @state
end

#street ⇒ Object

Applicable for American Express Direct (amexdirect), TSYS (tsys) and Elavon Americas (elavonamericas) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>38</td><td>^+$</td></tr> </table>



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

def street
  @street
end

#url ⇒ Object

Applicable for RUPAY and American Express Direct (amexdirect) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, hybrid</td><td>Yes</td><td>1</td><td>40</td><td>URL</td></tr> <tr><td>American Express Direct</td><td>cp</td><td>No</td><td>1</td><td>40</td><td>URL</td></tr> </table>



39
40
41
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 39

def url
  @url
end

#zip ⇒ Object

Applicable for Elavon Americas (elavonamericas), RUPAY, American Express Direct (amexdirect) and TSYS (tsys) processors. Validation details (for selected processors)… <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Min. Length</th><th>Max. Length</th><th>Regex</th></tr></thead> <tr><td>American Express Direct</td><td>cnp, cp, hybrid</td><td>Yes</td><td>1</td><td>15</td><td>^+$</td></tr> </table>



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

def zip
  @zip
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'city' => :'city',
    :'country' => :'country',
    :'phone' => :'phone',
    :'state' => :'state',
    :'street' => :'street',
    :'zip' => :'zip',
    :'url' => :'url',
    :'country_of_origin' => :'countryOfOrigin'
  }
end

.json_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 60

def self.json_map
  {
    :'name' => :'name',
    :'city' => :'city',
    :'country' => :'country',
    :'phone' => :'phone',
    :'state' => :'state',
    :'street' => :'street',
    :'zip' => :'zip',
    :'url' => :'url',
    :'country_of_origin' => :'country_of_origin'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 75

def self.swagger_types
  {
    :'name' => :'String',
    :'city' => :'String',
    :'country' => :'String',
    :'phone' => :'String',
    :'state' => :'String',
    :'street' => :'String',
    :'zip' => :'String',
    :'url' => :'String',
    :'country_of_origin' => :'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
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      city == o.city &&
      country == o.country &&
      phone == o.phone &&
      state == o.state &&
      street == o.street &&
      zip == o.zip &&
      url == o.url &&
      country_of_origin == o.country_of_origin
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



199
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
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 199

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



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

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



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

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


165
166
167
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 165

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 171

def hash
  [name, city, country, phone, state, street, zip, url, country_of_origin].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/card_processing_config_common_merchant_descriptor_information.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



245
246
247
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 245

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



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

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



239
240
241
 
# File 'lib/cybersource_rest_client/models/card_processing_config_common_merchant_descriptor_information.rb', line 239

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

def valid?
  true
end