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



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 120

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

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

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

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

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

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

Instance Attribute Details

#address1 ⇒ Object

First line of merchant’s address.



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

def address1
  @address1
end

#administrative_area ⇒ Object

The state where the merchant is located. #### PIN debit State code or region code for your business. Use the Use the [State, Province, and Territory Codes for the United States and Canada](developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase.



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

def administrative_area
  @administrative_area
end

#alternate_name ⇒ Object

An alternate name for the merchant.



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

def alternate_name
  @alternate_name
end

#contact ⇒ Object

Contact information for the merchant. Note These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13)



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

def contact
  @contact
end

#country ⇒ Object

Merchant’s country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note If your business is located in the U.S. or Canada and you include this field in a request, you must also include ‘merchantInformation.merchantDescriptor.administrativeArea`. Optional field for PIN debit credit or PIN debit purchase.



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

def country
  @country
end

#country_of_origin ⇒ Object

#### Visa Platform Connect This field will indicate merchant country of origin



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 47

def country_of_origin
  @country_of_origin
end

#customer_service_phone_number ⇒ Object

#### Visa Platform Connect Indicates customer service phone number of Merchant.



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 56

def customer_service_phone_number
  @customer_service_phone_number
end

#locality ⇒ Object

Merchant’s City. #### PIN debit City for your business location. This value might be displayed on the cardholder’s statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests.



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

def locality
  @locality
end

#name ⇒ Object

Your merchant name. Note For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder’s statement. When you include more than one consecutive space, extra spaces are removed. Note Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. Important This value must consist of English characters. Required for captures and credits.



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

def name
  @name
end

#phone ⇒ Object

Merchant phone as contact information for CNP transactions



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

def phone
  @phone
end

#postal_code ⇒ Object

Merchant’s postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder’s statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][4 digits] Example: ‘12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][alpha] [numeric][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. Important This value must consist of English characters. Note This field is supported only for businesses located in the U.S. or Canada. Important Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase.



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

def postal_code
  @postal_code
end

#store_id ⇒ Object

The identifier of the store.



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 50

def store_id
  @store_id
end

#store_name ⇒ Object

The name of the store.



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 53

def store_name
  @store_name
end

#url ⇒ Object

Address of company’s website provided by merchant



44
45
46
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 44

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'alternate_name' => :'alternateName',
    :'contact' => :'contact',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'country' => :'country',
    :'postal_code' => :'postalCode',
    :'administrative_area' => :'administrativeArea',
    :'phone' => :'phone',
    :'url' => :'url',
    :'country_of_origin' => :'countryOfOrigin',
    :'store_id' => :'storeId',
    :'store_name' => :'storeName',
    :'customer_service_phone_number' => :'customerServicePhoneNumber'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'name' => :'name',
    :'alternate_name' => :'alternate_name',
    :'contact' => :'contact',
    :'address1' => :'address1',
    :'locality' => :'locality',
    :'country' => :'country',
    :'postal_code' => :'postal_code',
    :'administrative_area' => :'administrative_area',
    :'phone' => :'phone',
    :'url' => :'url',
    :'country_of_origin' => :'country_of_origin',
    :'store_id' => :'store_id',
    :'store_name' => :'store_name',
    :'customer_service_phone_number' => :'customer_service_phone_number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 99

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 270

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 &&
      phone == o.phone &&
      url == o.url &&
      country_of_origin == o.country_of_origin &&
      store_id == o.store_id &&
      store_name == o.store_name &&
      customer_service_phone_number == o.customer_service_phone_number
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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 325

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



391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 391

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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 304

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


291
292
293
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



297
298
299
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 297

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



185
186
187
188
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 185

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



371
372
373
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 371

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



377
378
379
380
381
382
383
384
385
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 377

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



365
366
367
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 365

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



192
193
194
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb', line 192

def valid?
  true
end