Class: OpenapiClient::SoftDescriptor

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/soft_descriptor.rb

Overview

Identifying information about a merchant which appears on buyer’s credit/debit card statements.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SoftDescriptor

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 51

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SoftDescriptor` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SoftDescriptor`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'dynamic_merchant_name')
    self.dynamic_merchant_name = attributes[:'dynamic_merchant_name']
  end

  if attributes.key?(:'customer_service_number')
    self.customer_service_number = attributes[:'customer_service_number']
  end

  if attributes.key?(:'mcc')
    self.mcc = attributes[:'mcc']
  end

  if attributes.key?(:'dynamic_address')
    self.dynamic_address = attributes[:'dynamic_address']
  end
end

Instance Attribute Details

#customer_service_number ⇒ Object

Customer service phone number information that is passed to the issuer (it may appear on the cardholder’s statement) or if merchant wants to pass information that differs from the information stored on our master File.



22
23
24
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 22

def customer_service_number
  @customer_service_number
end

#dynamic_address ⇒ Object

Returns the value of attribute dynamic_address.



27
28
29
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 27

def dynamic_address
  @dynamic_address
end

#dynamic_merchant_name ⇒ Object

Store "doing-business-as" name.



19
20
21
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 19

def dynamic_merchant_name
  @dynamic_merchant_name
end

#mcc ⇒ Object

The 4-digit merchant category code (MCC). The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction.



25
26
27
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 25

def mcc
  @mcc
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 30

def self.attribute_map
  {
    :'dynamic_merchant_name' => :'dynamicMerchantName',
    :'customer_service_number' => :'customerServiceNumber',
    :'mcc' => :'mcc',
    :'dynamic_address' => :'dynamicAddress'
  }
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



187
188
189
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 187

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 40

def self.openapi_types
  {
    :'dynamic_merchant_name' => :'String',
    :'customer_service_number' => :'String',
    :'mcc' => :'String',
    :'dynamic_address' => :'Address'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      dynamic_merchant_name == o.dynamic_merchant_name &&
      customer_service_number == o.customer_service_number &&
      mcc == o.mcc &&
      dynamic_address == o.dynamic_address
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



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
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 215

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 289

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 194

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


174
175
176
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 180

def hash
  [dynamic_merchant_name, customer_service_number, mcc, dynamic_address].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



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
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 83

def list_invalid_properties
  invalid_properties = Array.new
  if @dynamic_merchant_name.nil?
    invalid_properties.push('invalid value for "dynamic_merchant_name", dynamic_merchant_name cannot be nil.')
  end

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @dynamic_merchant_name !~ pattern
    invalid_properties.push("invalid value for \"dynamic_merchant_name\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/^[0-9]+$/)
  if !@customer_service_number.nil? && @customer_service_number !~ pattern
    invalid_properties.push("invalid value for \"customer_service_number\", must conform to the pattern #{pattern}.")
  end

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



265
266
267
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 265

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 271

def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = {}
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



259
260
261
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 259

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



112
113
114
115
116
117
118
119
 
# File 'lib/openapi_client/models/soft_descriptor.rb', line 112

def valid?
  return false if @dynamic_merchant_name.nil?
  return false if @dynamic_merchant_name !~ Regexp.new(/^(?!\s*$).+/)
  return false if !@customer_service_number.nil? && @customer_service_number.to_s.length > 10
  return false if !@customer_service_number.nil? && @customer_service_number !~ Regexp.new(/^[0-9]+$/)
  return false if !@mcc.nil? && @mcc.to_s.length > 4
  true
end