com.plaid.client.model

Class UserPermissionRevokedWebhook

java.lang.Object

com.plaid.client.model.UserPermissionRevokedWebhook

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class UserPermissionRevokedWebhook
extends Object

The `USER_PERMISSION_REVOKED` webhook may be fired when an end user has used either the [my.plaid.com portal](https://my.plaid.com) 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_ENVIRONMENT
static String	SERIALIZED_NAME_ERROR
static String	SERIALIZED_NAME_ITEM_ID
static String	SERIALIZED_NAME_WEBHOOK_CODE
static String	SERIALIZED_NAME_WEBHOOK_TYPE

Constructor Summary

Constructors

Constructor and Description
UserPermissionRevokedWebhook()

Method Summary

Modifier and Type	Method and Description
UserPermissionRevokedWebhook	environment(WebhookEnvironmentValues environment)
boolean	equals(Object o)
UserPermissionRevokedWebhook	error(PlaidError error)
WebhookEnvironmentValues	getEnvironment() Get environment
PlaidError	getError() Get error
String	getItemId() The `item_id` of the Item associated with this webhook, warning, or error
String	getWebhookCode() `USER_PERMISSION_REVOKED`
String	getWebhookType() `ITEM`
int	hashCode()
UserPermissionRevokedWebhook	itemId(String itemId)
void	setEnvironment(WebhookEnvironmentValues environment)
void	setError(PlaidError error)
void	setItemId(String itemId)
void	setWebhookCode(String webhookCode)
void	setWebhookType(String webhookType)
String	toString()
UserPermissionRevokedWebhook	webhookCode(String webhookCode)
UserPermissionRevokedWebhook	webhookType(String webhookType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_WEBHOOK_TYPE

public static final String SERIALIZED_NAME_WEBHOOK_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_WEBHOOK_CODE

public static final String SERIALIZED_NAME_WEBHOOK_CODE

See Also:

Constant Field Values

SERIALIZED_NAME_ITEM_ID

public static final String SERIALIZED_NAME_ITEM_ID

See Also:

Constant Field Values

SERIALIZED_NAME_ERROR

public static final String SERIALIZED_NAME_ERROR

See Also:

Constant Field Values

SERIALIZED_NAME_ENVIRONMENT

public static final String SERIALIZED_NAME_ENVIRONMENT

See Also:

Constant Field Values

Constructor Detail

UserPermissionRevokedWebhook

public UserPermissionRevokedWebhook()

Method Detail

webhookType

public UserPermissionRevokedWebhook webhookType(String webhookType)

getWebhookType

public String getWebhookType()

`ITEM`

Returns:

webhookType

setWebhookType

public void setWebhookType(String webhookType)

webhookCode

public UserPermissionRevokedWebhook webhookCode(String webhookCode)

getWebhookCode

public String getWebhookCode()

`USER_PERMISSION_REVOKED`

Returns:

webhookCode

setWebhookCode

public void setWebhookCode(String webhookCode)

itemId

public UserPermissionRevokedWebhook itemId(String itemId)

getItemId

public String getItemId()

The `item_id` of the Item associated with this webhook, warning, or error

Returns:

itemId

setItemId

public void setItemId(String itemId)

error

public UserPermissionRevokedWebhook error(PlaidError error)

getError

@Nullable
public PlaidError getError()

Get error

Returns:

error

setError

public void setError(PlaidError error)

environment

public UserPermissionRevokedWebhook environment(WebhookEnvironmentValues environment)

getEnvironment

public WebhookEnvironmentValues getEnvironment()

Get environment

Returns:

environment

setEnvironment

public void setEnvironment(WebhookEnvironmentValues environment)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object