Class: Plaid::TransactionCounterparty

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transaction_counterparty.rb

Overview

The counterparty, such as the merchant or financial institution, is extracted by Plaid from the raw description.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionCounterparty

Initializes the object



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionCounterparty` 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 `Plaid::TransactionCounterparty`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

Instance Attribute Details

#confidence_level ⇒ Object

A description of how confident we are that the provided counterparty is involved in the transaction. ‘VERY_HIGH`: We recognize this counterparty and we are more than 98% confident that it is involved in this transaction. `HIGH`: We recognize this counterparty and we are more than 90% confident that it is involved in this transaction. `MEDIUM`: We are moderately confident that this counterparty was involved in this transaction, but some details may differ from our records. `LOW`: We didn’t find a matching counterparty in our records, so we are returning a cleansed name parsed out of the request description. `UNKNOWN`: We don’t know the confidence level for this counterparty.



34
35
36
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 34

def confidence_level
  @confidence_level
end

#entity_id ⇒ Object

A unique, stable, Plaid-generated ID that maps to the counterparty.



23
24
25
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 23

def entity_id
  @entity_id
end

#logo_url ⇒ Object

The URL of a logo associated with the counterparty, if available. The logo will always be 100×100 pixel PNG file.



31
32
33
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 31

def logo_url
  @logo_url
end

#name ⇒ Object

The name of the counterparty, such as the merchant or the financial institution, as extracted by Plaid from the raw description.



20
21
22
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 20

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



25
26
27
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 25

def type
  @type
end

#website ⇒ Object

The website associated with the counterparty.



28
29
30
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 28

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 59

def self.attribute_map
  {
    :'name' => :'name',
    :'entity_id' => :'entity_id',
    :'type' => :'type',
    :'website' => :'website',
    :'logo_url' => :'logo_url',
    :'confidence_level' => :'confidence_level'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



188
189
190
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 188

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
92
93
94
95
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 88

def self.openapi_nullable
  Set.new([
    :'entity_id',
    :'website',
    :'logo_url',
    :'confidence_level'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 76

def self.openapi_types
  {
    :'name' => :'String',
    :'entity_id' => :'String',
    :'type' => :'CounterpartyType',
    :'website' => :'String',
    :'logo_url' => :'String',
    :'confidence_level' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      entity_id == o.entity_id &&
      type == o.type &&
      website == o.website &&
      logo_url == o.logo_url &&
      confidence_level == o.confidence_level
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
256
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 219

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : 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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 290

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 195

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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[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
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


175
176
177
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



181
182
183
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 181

def hash
  [name, entity_id, type, website, logo_url, confidence_level].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 139

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

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



266
267
268
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 266

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 272

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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



260
261
262
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 260

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



154
155
156
157
158
 
# File 'lib/plaid/models/transaction_counterparty.rb', line 154

def valid?
  return false if @name.nil?
  return false if @type.nil?
  true
end