Class: Plaid::BeaconAccountRiskEvaluateRequest

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

Overview

BeaconAccountRiskEvaluateRequest defines the request schema for ‘/v1/beacon/account_risk/risk/evaluate`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BeaconAccountRiskEvaluateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 108

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_token ⇒ Object

The access token associated with the Item data is being requested for.



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

def access_token
  @access_token
end

#client_evaluation_id ⇒ Object

Unique identifier of what you are looking to evaluate (account add, information change, etc.) to allow us to tie the activity to the decisions and possible fraud outcome sent via our feedback endpoints. You can use your internal request ID or similar.



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

def client_evaluation_id
  @client_evaluation_id
end

#client_id ⇒ Object

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.



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

def client_id
  @client_id
end

#client_user_id ⇒ Object

A unique ID that identifies the end user in your system. This ID is used to correlate requests by a user with multiple evaluations and/or multiple linked accounts. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.



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

def client_user_id
  @client_user_id
end

#device ⇒ Object

Returns the value of attribute device.



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

def device
  @device
end

#evaluate_time ⇒ Object

The time the event for evaluation has occurred. Populate this field for backfilling data. If you don’t populate this field, we’ll use the timestamp at the time of receipt. Use ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ).



41
42
43
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 41

def evaluate_time
  @evaluate_time
end

#evaluation_reason ⇒ Object

Returns the value of attribute evaluation_reason.



36
37
38
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 36

def evaluation_reason
  @evaluation_reason
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#secret ⇒ Object

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.



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

def secret
  @secret
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 66

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'access_token' => :'access_token',
    :'options' => :'options',
    :'client_user_id' => :'client_user_id',
    :'client_evaluation_id' => :'client_evaluation_id',
    :'evaluation_reason' => :'evaluation_reason',
    :'device' => :'device',
    :'evaluate_time' => :'evaluate_time'
  }
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



228
229
230
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 228

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 86

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'access_token' => :'String',
    :'options' => :'BeaconAccountRiskEvaluateRequestOptions',
    :'client_user_id' => :'String',
    :'client_evaluation_id' => :'String',
    :'evaluation_reason' => :'BeaconAccountRiskEvaluateEvaluationReason',
    :'device' => :'SignalDevice',
    :'evaluate_time' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      access_token == o.access_token &&
      options == o.options &&
      client_user_id == o.client_user_id &&
      client_evaluation_id == o.client_evaluation_id &&
      evaluation_reason == o.evaluation_reason &&
      device == o.device &&
      evaluate_time == o.evaluate_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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 259

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 330

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 235

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


215
216
217
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 221

def hash
  [client_id, secret, access_token, options, client_user_id, client_evaluation_id, evaluation_reason, device, evaluate_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



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

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

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



306
307
308
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 306

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 312

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



300
301
302
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 300

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



176
177
178
179
180
 
# File 'lib/plaid/models/beacon_account_risk_evaluate_request.rb', line 176

def valid?
  return false if !@client_user_id.nil? && @client_user_id.to_s.length > 36
  return false if !@client_user_id.nil? && @client_user_id.to_s.length < 1
  true
end