Class: CyberSource::Ptsv2payoutsMerchantInformationMerchantDescriptor

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2payoutsMerchantInformationMerchantDescriptor

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

  if attributes.has_key?(:'address1')
    self.address1 = attributes[:'address1']
  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)



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

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.



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

def administrative_area
  @administrative_area
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)



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

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.



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

def country
  @country
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.



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

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.



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

def name
  @name
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.



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

def postal_code
  @postal_code
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.json_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 52

def self.json_map
  {
    :'name' => :'name',
    :'locality' => :'locality',
    :'country' => :'country',
    :'administrative_area' => :'administrative_area',
    :'postal_code' => :'postal_code',
    :'contact' => :'contact',
    :'address1' => :'address1'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 65

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 159

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



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
236
237
238
239
240
241
242
243
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 207

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 273

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



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

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


173
174
175
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 179

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



116
117
118
119
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 116

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



253
254
255
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 253

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 259

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



247
248
249
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 247

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



123
124
125
 
# File 'lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb', line 123

def valid?
  true
end