class Plaid::UserPermissionRevokedWebhook

Overview

The USER_PERMISSION_REVOKED webhook may be fired when an end user has used either the my.plaid.com portal or the financial institution’s OAuth consent portal to revoke the permission that they previously granted to access an Item. This webhook is not guaranteed to always be fired upon consent revocation, since some institutions’ consent portals do not trigger this webhook. Once access to an Item has been revoked, it cannot be restored. If the user subsequently returns to your application, a new Item must be created for the user.

Included Modules

Defined in:

plaid/models/user_permission_revoked_webhook.cr

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, item_id : String | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil, error : PlaidError | Nil = nil) #

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


[View source]

Instance Method Detail

def ==(other : self) #

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


def environment : Plaid::WebhookEnvironmentValues | Nil #

[View source]
def environment=(new_value : Plaid::WebhookEnvironmentValues | Nil) #

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


[View source]
def error : PlaidError | Nil #

[View source]
def error=(new_value : PlaidError | Nil) #

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


[View source]
def error_present=(error_present : Bool) #

[View source]
def error_present? : Bool #

[View source]
def hash(hasher) #

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


def item_id : String | Nil #

[View source]
def item_id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def valid? : Bool #

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


[View source]
def webhook_code : String | Nil #

[View source]
def webhook_code=(new_value : String | Nil) #

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


[View source]
def webhook_type : String | Nil #

[View source]
def webhook_type=(new_value : String | Nil) #

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


[View source]