Class: Plaid::ProcessorSignalEvaluateRequest

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

Overview

ProcessorSignalEvaluateRequest defines the request schema for ‘/processor/signal/evaluate`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProcessorSignalEvaluateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 106

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The transaction amount, in USD (e.g. ‘102.05`)



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

def amount
  @amount
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/processor_signal_evaluate_request.rb', line 20

def client_id
  @client_id
end

#client_transaction_id ⇒ Object

The unique ID that you would like to use to refer to this transaction. For your convenience mapping your internal data, you could use your internal ID/identifier for this transaction. The max length for this field is 36 characters.



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

def client_transaction_id
  @client_transaction_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 Items. Personally identifiable information, such as an email address or phone number, should not be used in the ‘client_user_id`.



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

def client_user_id
  @client_user_id
end

#default_payment_method ⇒ Object

The default ACH or non-ACH payment method to complete the transaction. ‘SAME_DAY_ACH`: Same Day ACH by NACHA. The debit transaction is processed and settled on the same day `STANDARD_ACH`: standard ACH by NACHA `MULTIPLE_PAYMENT_METHODS`: if there is no default debit rail or there are multiple payment methods Possible values: `SAME_DAY_ACH`, `STANDARD_ACH`, `MULTIPLE_PAYMENT_METHODS`



44
45
46
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 44

def default_payment_method
  @default_payment_method
end

#device ⇒ Object

Returns the value of attribute device.



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

def device
  @device
end

#is_recurring ⇒ Object

true if the ACH transaction is a recurring transaction; false otherwise



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

def is_recurring
  @is_recurring
end

#processor_token ⇒ Object

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: ‘processor-<environment>-<identifier>`



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

def processor_token
  @processor_token
end

#ruleset_key ⇒ Object

The key of the Ruleset to use for this transaction. You can configure a Ruleset using the Signal dashboard located within the Plaid Dashboard. If not provided, no Ruleset will be used. This feature is currently in closed beta; to request access, contact your account manager.



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

def ruleset_key
  @ruleset_key
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/processor_signal_evaluate_request.rb', line 23

def secret
  @secret
end

#user ⇒ Object

Returns the value of attribute user.



46
47
48
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 46

def user
  @user
end

#user_present ⇒ Object

‘true` if the end user is present while initiating the ACH transfer and the endpoint is being called; `false` otherwise (for example, when the ACH transfer is scheduled and the end user is not present, or you call this endpoint after the ACH transfer but before submitting the Nacha file for ACH processing).



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

def user_present
  @user_present
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 54

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'processor_token' => :'processor_token',
    :'client_transaction_id' => :'client_transaction_id',
    :'amount' => :'amount',
    :'user_present' => :'user_present',
    :'client_user_id' => :'client_user_id',
    :'is_recurring' => :'is_recurring',
    :'default_payment_method' => :'default_payment_method',
    :'user' => :'user',
    :'device' => :'device',
    :'ruleset_key' => :'ruleset_key'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



95
96
97
98
99
100
101
102
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 95

def self.openapi_nullable
  Set.new([
    :'user_present',
    :'is_recurring',
    :'default_payment_method',
    :'ruleset_key'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'processor_token' => :'String',
    :'client_transaction_id' => :'String',
    :'amount' => :'Float',
    :'user_present' => :'Boolean',
    :'client_user_id' => :'String',
    :'is_recurring' => :'Boolean',
    :'default_payment_method' => :'String',
    :'user' => :'SignalUser',
    :'device' => :'SignalDevice',
    :'ruleset_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      processor_token == o.processor_token &&
      client_transaction_id == o.client_transaction_id &&
      amount == o.amount &&
      user_present == o.user_present &&
      client_user_id == o.client_user_id &&
      is_recurring == o.is_recurring &&
      default_payment_method == o.default_payment_method &&
      user == o.user &&
      device == o.device &&
      ruleset_key == o.ruleset_key
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



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
327
328
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 291

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 362

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



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

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


247
248
249
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 253

def hash
  [client_id, secret, processor_token, client_transaction_id, amount, user_present, client_user_id, is_recurring, default_payment_method, user, device, ruleset_key].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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 170

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

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

  if @client_transaction_id.to_s.length > 36
    invalid_properties.push('invalid value for "client_transaction_id", the character length must be smaller than or equal to 36.')
  end

  if @client_transaction_id.to_s.length < 1
    invalid_properties.push('invalid value for "client_transaction_id", the character length must be great than or equal to 1.')
  end


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



338
339
340
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 338

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 344

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



332
333
334
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 332

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



198
199
200
201
202
203
204
205
 
# File 'lib/plaid/models/processor_signal_evaluate_request.rb', line 198

def valid?
  return false if @processor_token.nil?
  return false if @client_transaction_id.nil?
  return false if @client_transaction_id.to_s.length > 36
  return false if @client_transaction_id.to_s.length < 1
  return false if @amount.nil?
  true
end