Class: Plaid::SignalEvaluateRequest
- Inherits:
-
Object
- Object
- Plaid::SignalEvaluateRequest
- Defined in:
- lib/plaid/models/signal_evaluate_request.rb
Overview
SignalEvaluateRequest defines the request schema for ‘/signal/evaluate`
Instance Attribute Summary collapse
-
#access_token ⇒ Object
The access token associated with the Item data is being requested for.
-
#account_id ⇒ Object
The Plaid ‘account_id` of the account that is the funding source for the proposed transaction.
-
#amount ⇒ Object
The transaction amount, in USD (e.g. ‘102.05`).
-
#client_id ⇒ Object
Your Plaid API ‘client_id`.
-
#client_transaction_id ⇒ Object
The unique ID that you would like to use to refer to this evaluation attempt - for example, a payment attempt ID.
-
#client_user_id ⇒ Object
A unique ID that identifies the end user in your system.
-
#default_payment_method ⇒ Object
The default ACH payment method to complete the transaction.
-
#device ⇒ Object
Returns the value of attribute device.
-
#is_recurring ⇒ Object
Use ‘true` if the ACH transaction is a part of recurring schedule (for example, a monthly repayment); `false` otherwise.
-
#risk_profile_key ⇒ Object
Specifying ‘risk_profile_key` is deprecated.
-
#ruleset_key ⇒ Object
The key of the ruleset to use for evaluating this transaction.
-
#secret ⇒ Object
Your Plaid API ‘secret`.
-
#user ⇒ Object
Returns the value of attribute user.
-
#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).
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SignalEvaluateRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ SignalEvaluateRequest
Initializes the object
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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 117 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::SignalEvaluateRequest` 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::SignalEvaluateRequest`. 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?(:'account_id') self.account_id = attributes[:'account_id'] 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?(:'risk_profile_key') self.risk_profile_key = attributes[:'risk_profile_key'] end if attributes.key?(:'ruleset_key') self.ruleset_key = attributes[:'ruleset_key'] 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/signal_evaluate_request.rb', line 26 def access_token @access_token end |
#account_id ⇒ Object
The Plaid ‘account_id` of the account that is the funding source for the proposed transaction. The `account_id` is returned in the `/accounts/get` endpoint as well as the [`onSuccess`](/docs/link/ios/#link-ios-onsuccess-linkSuccess-metadata-accounts-id) callback metadata. This will return an [`INVALID_ACCOUNT_ID`](/docs/errors/invalid-input/#invalid_account_id) error if the account has been removed at the bank or if the `account_id` is no longer valid.
29 30 31 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 29 def account_id @account_id end |
#amount ⇒ Object
The transaction amount, in USD (e.g. ‘102.05`)
35 36 37 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 35 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/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 evaluation attempt - for example, a payment attempt ID. You will use this later to debug this evaluation, and/or report an ACH return, etc. The max length for this field is 36 characters.
32 33 34 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 32 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`.
41 42 43 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 41 def client_user_id @client_user_id end |
#default_payment_method ⇒ Object
The default 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`
47 48 49 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 47 def default_payment_method @default_payment_method end |
#device ⇒ Object
Returns the value of attribute device.
51 52 53 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 51 def device @device end |
#is_recurring ⇒ Object
Use ‘true` if the ACH transaction is a part of recurring schedule (for example, a monthly repayment); `false` otherwise
44 45 46 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 44 def is_recurring @is_recurring end |
#risk_profile_key ⇒ Object
Specifying ‘risk_profile_key` is deprecated. Please provide `ruleset` instead.
54 55 56 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 54 def risk_profile_key @risk_profile_key end |
#ruleset_key ⇒ Object
The key of the ruleset to use for evaluating this transaction. You can configure a ruleset using the Signal dashboard located within the Plaid Dashboard. If not provided, no ruleset will be used.
57 58 59 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 57 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/signal_evaluate_request.rb', line 23 def secret @secret end |
#user ⇒ Object
Returns the value of attribute user.
49 50 51 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 49 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).
38 39 40 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 38 def user_present @user_present end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
80 81 82 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 80 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 60 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'access_token' => :'access_token', :'account_id' => :'account_id', :'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', :'risk_profile_key' => :'risk_profile_key', :'ruleset_key' => :'ruleset_key' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
286 287 288 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 286 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
105 106 107 108 109 110 111 112 113 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 105 def self.openapi_nullable Set.new([ :'user_present', :'is_recurring', :'default_payment_method', :'risk_profile_key', :'ruleset_key' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 85 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'access_token' => :'String', :'account_id' => :'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', :'risk_profile_key' => :'String', :'ruleset_key' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 252 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 && account_id == o.account_id && 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 && risk_profile_key == o.risk_profile_key && ruleset_key == o.ruleset_key end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 317 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
388 389 390 391 392 393 394 395 396 397 398 399 400 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 388 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
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 293 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
273 274 275 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 273 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
279 280 281 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 279 def hash [client_id, secret, access_token, account_id, client_transaction_id, amount, user_present, client_user_id, is_recurring, default_payment_method, user, device, risk_profile_key, ruleset_key].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 189 def list_invalid_properties invalid_properties = Array.new if @access_token.nil? invalid_properties.push('invalid value for "access_token", access_token cannot be nil.') end if @account_id.nil? invalid_properties.push('invalid value for "account_id", account_id 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)
364 365 366 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 364 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
370 371 372 373 374 375 376 377 378 379 380 381 382 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 370 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
358 359 360 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 358 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
221 222 223 224 225 226 227 228 229 |
# File 'lib/plaid/models/signal_evaluate_request.rb', line 221 def valid? return false if @access_token.nil? return false if @account_id.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 |