Class: Plaid::SignalDecisionReportRequest

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

Overview

SignalDecisionReportRequest defines the request schema for ‘/signal/decision/report`

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignalDecisionReportRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_instantly_available ⇒ Object

The amount (in USD) made available to your customers instantly following the debit transaction. It could be a partial amount of the requested transaction (example: 102.05).



39
40
41
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 39

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

def client_id
  @client_id
end

#client_transaction_id ⇒ Object

Must be the same as the ‘client_transaction_id` supplied when calling `/signal/evaluate`



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

def client_transaction_id
  @client_transaction_id
end

#days_funds_on_hold ⇒ Object

The actual number of days (hold time) since the ACH debit transaction that you wait before making funds available to your customers. The holding time could affect the ACH return rate. For example, use 0 if you make funds available to your customers instantly or the same day following the debit transaction, or 1 if you make funds available the next day following the debit initialization.



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

def days_funds_on_hold
  @days_funds_on_hold
end

#decision_outcome ⇒ Object

Returns the value of attribute decision_outcome.



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

def decision_outcome
  @decision_outcome
end

#initiated ⇒ Object

‘true` if the ACH transaction was initiated, `false` otherwise. This field must be returned as a boolean. If formatted incorrectly, this will result in an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error.



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

def initiated
  @initiated
end

#payment_method ⇒ Object

Returns the value of attribute payment_method.



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

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

def secret
  @secret
end

#submitted_at ⇒ Object

The date the ACH debit was submitted to the bank for processing (in ISO 8601 format: ‘YYYY-MM-DDTHH:mm:ssZ`). This field should correspond to the attempt initiated after the `/signal/schedule` call.



42
43
44
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 42

def submitted_at
  @submitted_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



82
83
84
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 82

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'secret' => :'secret',
    :'client_transaction_id' => :'client_transaction_id',
    :'initiated' => :'initiated',
    :'days_funds_on_hold' => :'days_funds_on_hold',
    :'decision_outcome' => :'decision_outcome',
    :'payment_method' => :'payment_method',
    :'amount_instantly_available' => :'amount_instantly_available',
    :'submitted_at' => :'submitted_at'
  }
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



264
265
266
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 102

def self.openapi_nullable
  Set.new([
    :'days_funds_on_hold',
    :'decision_outcome',
    :'payment_method',
    :'amount_instantly_available',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'client_id' => :'String',
    :'secret' => :'String',
    :'client_transaction_id' => :'String',
    :'initiated' => :'Boolean',
    :'days_funds_on_hold' => :'Integer',
    :'decision_outcome' => :'SignalDecisionOutcome',
    :'payment_method' => :'SignalPaymentMethod',
    :'amount_instantly_available' => :'Float',
    :'submitted_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      secret == o.secret &&
      client_transaction_id == o.client_transaction_id &&
      initiated == o.initiated &&
      days_funds_on_hold == o.days_funds_on_hold &&
      decision_outcome == o.decision_outcome &&
      payment_method == o.payment_method &&
      amount_instantly_available == o.amount_instantly_available &&
      submitted_at == o.submitted_at
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



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
329
330
331
332
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 295

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 366

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 271

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 257

def hash
  [client_id, secret, client_transaction_id, initiated, days_funds_on_hold, decision_outcome, payment_method, amount_instantly_available, submitted_at].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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 165

def list_invalid_properties
  invalid_properties = Array.new
  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 @initiated.nil?
    invalid_properties.push('invalid value for "initiated", initiated cannot be nil.')
  end

  if !@days_funds_on_hold.nil? && @days_funds_on_hold < 0
    invalid_properties.push('invalid value for "days_funds_on_hold", must be greater than or equal to 0.')
  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



342
343
344
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 348

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



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

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



194
195
196
197
198
199
200
201
 
# File 'lib/plaid/models/signal_decision_report_request.rb', line 194

def valid?
  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 @initiated.nil?
  return false if !@days_funds_on_hold.nil? && @days_funds_on_hold < 0
  true
end