class

Plaid::SandboxIncomeFireWebhookRequest

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

SandboxIncomeFireWebhookRequest defines the request schema for /sandbox/income/fire_webhook

Constants

ERROR_MESSAGE_FOR_VERIFICATION_STATUS = "invalid value for \"verification_status\", must be one of [VERIFICATION_STATUS_PROCESSING_COMPLETE, VERIFICATION_STATUS_PROCESSING_FAILED, VERIFICATION_STATUS_PENDING_APPROVAL]."

VALID_VALUES_FOR_VERIFICATION_STATUS = String.static_array("VERIFICATION_STATUS_PROCESSING_COMPLETE", "VERIFICATION_STATUS_PROCESSING_FAILED", "VERIFICATION_STATUS_PENDING_APPROVAL")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, item_id : String | Nil = nil, webhook : String | Nil = nil, webhook_code : Plaid::SandboxIncomeWebhookFireRequestWebhookCode | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, user_id : String | Nil = nil, verification_status : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

client_id

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.

client_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_id Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

item_id

The Item ID associated with the verification.

item_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] item_id Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

secret

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.

secret=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secret Object to be assigned

user_id

The Plaid user_id of the User associated with this webhook, warning, or error.

user_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] user_id Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

verification_status

VERIFICATION_STATUS_PROCESSING_COMPLETE: The income verification status processing has completed. If the user uploaded multiple documents, this webhook will fire when all documents have finished processing. Call the /income/verification/paystubs/get endpoint and check the document metadata to see which documents were successfully parsed. VERIFICATION_STATUS_PROCESSING_FAILED: A failure occurred when attempting to process the verification documentation. VERIFICATION_STATUS_PENDING_APPROVAL: (deprecated) The income verification has been sent to the user for review.

verification_status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] verification_status Object to be assigned

webhook

The URL to which the webhook should be sent.

webhook=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook Object to be assigned

webhook_code

webhook_code=(new_value : Plaid::SandboxIncomeWebhookFireRequestWebhookCode | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] webhook_code Object to be assigned