Class: CyberSource::V2paymentsMerchantInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/v2payments_merchant_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsMerchantInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 60

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

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

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

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

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

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

Instance Attribute Details

#card_acceptor_reference_number ⇒ Object

Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_ref_number field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



29
30
31
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 29

def card_acceptor_reference_number
  @card_acceptor_reference_number
end

#category_code ⇒ Object

Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



23
24
25
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 23

def category_code
  @category_code
end

#merchant_descriptor ⇒ Object

Returns the value of attribute merchant_descriptor.



17
18
19
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 17

def merchant_descriptor
  @merchant_descriptor
end

#sales_organization_id ⇒ Object

Company ID assigned to an independent sales organization. Get this value from Mastercard. For processor-specific information, see the sales_organization_ID field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



20
21
22
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 20

def sales_organization_id
  @sales_organization_id
end

#transaction_local_date_time ⇒ Object

Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the transaction_local_date_time field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ‘Format: YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds



32
33
34
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 32

def transaction_local_date_time
  @transaction_local_date_time
end

#vat_registration_number ⇒ Object

Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



26
27
28
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 26

def vat_registration_number
  @vat_registration_number
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 35

def self.attribute_map
  {
    :'merchant_descriptor' => :'merchantDescriptor',
    :'sales_organization_id' => :'salesOrganizationId',
    :'category_code' => :'categoryCode',
    :'vat_registration_number' => :'vatRegistrationNumber',
    :'card_acceptor_reference_number' => :'cardAcceptorReferenceNumber',
    :'transaction_local_date_time' => :'transactionLocalDateTime'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 47

def self.swagger_types
  {
    :'merchant_descriptor' => :'V2paymentsMerchantInformationMerchantDescriptor',
    :'sales_organization_id' => :'String',
    :'category_code' => :'Integer',
    :'vat_registration_number' => :'String',
    :'card_acceptor_reference_number' => :'String',
    :'transaction_local_date_time' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      merchant_descriptor == o.merchant_descriptor &&
      sales_organization_id == o.sales_organization_id &&
      category_code == o.category_code &&
      vat_registration_number == o.vat_registration_number &&
      card_acceptor_reference_number == o.card_acceptor_reference_number &&
      transaction_local_date_time == o.transaction_local_date_time
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



228
229
230
231
232
233
234
235
236
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
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 228

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 294

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 207

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


194
195
196
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 200

def hash
  [merchant_descriptor, sales_organization_id, category_code, vat_registration_number, card_acceptor_reference_number, transaction_local_date_time].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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 93

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

  if !@category_code.nil? && @category_code > 9999
    invalid_properties.push('invalid value for "category_code", must be smaller than or equal to 9999.')
  end

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

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

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



274
275
276
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 280

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



268
269
270
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 268

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



120
121
122
123
124
125
126
127
 
# File 'lib/cyberSource_client/models/v2payments_merchant_information.rb', line 120

def valid?
  return false if !@sales_organization_id.nil? && @sales_organization_id.to_s.length > 11
  return false if !@category_code.nil? && @category_code > 9999
  return false if !@vat_registration_number.nil? && @vat_registration_number.to_s.length > 21
  return false if !@card_acceptor_reference_number.nil? && @card_acceptor_reference_number.to_s.length > 25
  return false if !@transaction_local_date_time.nil? && @transaction_local_date_time.to_s.length > 14
  true
end