Class: CyberSource::Ptsv2paymentsMerchantInformationMerchantDescriptor

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsMerchantInformationMerchantDescriptor

Initializes the object

Parameters:

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

    Model attributes in the form of hash



76
77
78
79
80
81
82
83
84
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 76

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

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

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of merchant’s address. For the descriptions, used-by information, data types, and lengths for these fields, see ‘merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def address1
  @address1
end

#administrative_area ⇒ Object

The state where the merchant is located. For the descriptions, used-by information, data types, and lengths for these fields, see the ‘merchant_descriptor_state` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def administrative_area
  @administrative_area
end

#alternate_name ⇒ Object

An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the ‘merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)–>



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

def alternate_name
  @alternate_name
end

#contact ⇒ Object

For the descriptions, used-by information, data types, and lengths for these fields, see ‘merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)–> Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13)



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

def contact
  @contact
end

#country ⇒ Object

Merchant’s country. For the descriptions, used-by information, data types, and lengths for these fields, see the ‘merchant_descriptor_country` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def country
  @country
end

#locality ⇒ Object

Merchant’s City. For the descriptions, used-by information, data types, and lengths for these fields, see the ‘merchant_descriptor_city` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def locality
  @locality
end

#name ⇒ Object

Merchant’s name. For more details about the merchant-related fields, see the ‘merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Note For Paymentech processor using Cybersource Payouts, the maximum data length is 22.



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

def name
  @name
end

#postal_code ⇒ Object

Merchant’s postal code. For the descriptions, used-by information, data types, and lengths for these fields, see the ‘merchant_descriptor_postal_code` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def postal_code
  @postal_code
end

#url ⇒ Object

Address of company’s website provided by merchant



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

def url
  @url
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/ptsv2payments_merchant_information_merchant_descriptor.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'alternate_name' => :'alternateName',
    :'contact' => :'contact',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea',
    :'url' => :'url'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'name' => :'String',
    :'alternate_name' => :'String',
    :'contact' => :'String',
    :'address1' => :'String',
    :'locality' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'administrative_area' => :'String',
    :'url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      alternate_name == o.alternate_name &&
      contact == o.contact &&
      address1 == o.address1 &&
      locality == o.locality &&
      country == o.country &&
      postal_code == o.postal_code &&
      administrative_area == o.administrative_area &&
      url == o.url
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 274

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 340

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 253

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [name, alternate_name, contact, address1, locality, country, postal_code, administrative_area, url].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if !@alternate_name.nil? && @alternate_name.to_s.length > 13
    invalid_properties.push('invalid value for "alternate_name", the character length must be smaller than or equal to 13.')
  end

  if !@contact.nil? && @contact.to_s.length > 14
    invalid_properties.push('invalid value for "contact", the character length must be smaller than or equal to 14.')
  end

  if !@address1.nil? && @address1.to_s.length > 60
    invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 60.')
  end

  if !@locality.nil? && @locality.to_s.length > 13
    invalid_properties.push('invalid value for "locality", the character length must be smaller than or equal to 13.')
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 14
    invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 14.')
  end

  if !@url.nil? && @url.to_s.length > 255
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 255.')
  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



320
321
322
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 320

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



326
327
328
329
330
331
332
333
334
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 326

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



314
315
316
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 314

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 152

def valid?
  return false if !@alternate_name.nil? && @alternate_name.to_s.length > 13
  return false if !@contact.nil? && @contact.to_s.length > 14
  return false if !@address1.nil? && @address1.to_s.length > 60
  return false if !@locality.nil? && @locality.to_s.length > 13
  return false if !@postal_code.nil? && @postal_code.to_s.length > 14
  return false if !@url.nil? && @url.to_s.length > 255
  true
end