Class: Plaid::ClientProvidedTransaction

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

Overview

A client-provided transaction for Plaid to enrich.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientProvidedTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
184
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_subtype ⇒ Object

The account subtype associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](plaid.com/docs/api/accounts#account-type-schema).



32
33
34
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 32

def 
  @account_subtype
end

#account_type ⇒ Object

The account type associated with the transaction. For a full list of valid types and subtypes, see the [Account schema](plaid.com/docs/api/accounts#account-type-schema).



29
30
31
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 29

def 
  @account_type
end

#amount ⇒ Object

The absolute value of the transaction (>= 0). When testing Enrich, note that ‘amount` data should be realistic. Unrealistic or inaccurate `amount` data may result in reduced quality output.



38
39
40
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 38

def amount
  @amount
end

#client_account_id ⇒ Object

A unique account id used to group transactions for a given account, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_account_id.



26
27
28
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 26

def 
  @client_account_id
end

#client_user_id ⇒ Object

A unique user id used to group transactions for a given user, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.



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

def client_user_id
  @client_user_id
end

#date_posted ⇒ Object

The date the transaction posted, in [ISO 8601](wikipedia.org/wiki/ISO_8601) (YYYY-MM-DD) format.



51
52
53
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 51

def date_posted
  @date_posted
end

#description ⇒ Object

The raw description of the transaction. If you have location data in available an unstructured format, it may be appended to the ‘description` field.



35
36
37
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 35

def description
  @description
end

#direction ⇒ Object

Returns the value of attribute direction.



40
41
42
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 40

def direction
  @direction
end

#id ⇒ Object

A unique ID for the transaction used to help you tie data back to your systems.



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

def id
  @id
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the transaction e.g. USD.



43
44
45
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 43

def iso_currency_code
  @iso_currency_code
end

#location ⇒ Object

Returns the value of attribute location.



45
46
47
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 45

def location
  @location
end

#mcc ⇒ Object

Merchant category codes (MCCs) are four-digit numbers that describe a merchant’s primary business activities.



48
49
50
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 48

def mcc
  @mcc
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'client_user_id' => :'client_user_id',
    :'client_account_id' => :'client_account_id',
    :'account_type' => :'account_type',
    :'account_subtype' => :'account_subtype',
    :'description' => :'description',
    :'amount' => :'amount',
    :'direction' => :'direction',
    :'iso_currency_code' => :'iso_currency_code',
    :'location' => :'location',
    :'mcc' => :'mcc',
    :'date_posted' => :'date_posted'
  }
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



258
259
260
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 117

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'String',
    :'client_user_id' => :'String',
    :'client_account_id' => :'String',
    :'account_type' => :'String',
    :'account_subtype' => :'String',
    :'description' => :'String',
    :'amount' => :'Float',
    :'direction' => :'EnrichTransactionDirection',
    :'iso_currency_code' => :'String',
    :'location' => :'ClientProvidedTransactionLocation',
    :'mcc' => :'String',
    :'date_posted' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      client_user_id == o.client_user_id &&
       == o. &&
       == o. &&
       == o. &&
      description == o.description &&
      amount == o.amount &&
      direction == o.direction &&
      iso_currency_code == o.iso_currency_code &&
      location == o.location &&
      mcc == o.mcc &&
      date_posted == o.date_posted
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 289

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 360

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 265

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 251

def hash
  [id, client_user_id, , , , description, amount, direction, iso_currency_code, location, mcc, date_posted].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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 188

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

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

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

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

  if @iso_currency_code.nil?
    invalid_properties.push('invalid value for "iso_currency_code", iso_currency_code cannot be nil.')
  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



336
337
338
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 336

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 342

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

Returns:

  • (String) —

    String presentation of the object



330
331
332
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 330

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



215
216
217
218
219
220
221
222
 
# File 'lib/plaid/models/client_provided_transaction.rb', line 215

def valid?
  return false if @id.nil?
  return false if @description.nil?
  return false if @amount.nil?
  return false if @direction.nil?
  return false if @iso_currency_code.nil?
  true
end