Model

Class CreateWebhookRequest

java.lang.Object

Model.CreateWebhookRequest

public class CreateWebhookRequest
extends Object

CreateWebhookRequest

Constructor Summary

Constructors

Constructor and Description
CreateWebhookRequest()

Method Summary

Modifier and Type	Method and Description
CreateWebhookRequest	addEventTypesItem(String eventTypesItem)
CreateWebhookRequest	description(String description)
boolean	equals(Object o)
CreateWebhookRequest	eventTypes(List<String> eventTypes)
String	getDescription() Client friendly webhook description.
List<String>	getEventTypes() Array of the different events for a given product id.
String	getHealthCheckUrl() The client's health check endpoint (URL).
String	getName() Client friendly webhook name.
String	getNotificationScope() The webhook scope.
String	getOrganizationId() Organization Identifier (OrgId) or Merchant Identifier (MID).
String	getProductId() To see the valid productId and eventTypes, call the \"Create and Manage Webhooks - Retrieve a list of event types\" endpoint.
Notificationsubscriptionsv1webhooksRetryPolicy	getRetryPolicy() Get retryPolicy
Notificationsubscriptionsv1webhooksSecurityPolicy1	getSecurityPolicy() Get securityPolicy
String	getWebhookUrl() The client's endpoint (URL) to receive webhooks.
int	hashCode()
CreateWebhookRequest	healthCheckUrl(String healthCheckUrl)
CreateWebhookRequest	name(String name)
CreateWebhookRequest	notificationScope(String notificationScope)
CreateWebhookRequest	organizationId(String organizationId)
CreateWebhookRequest	productId(String productId)
CreateWebhookRequest	retryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy)
CreateWebhookRequest	securityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy)
void	setDescription(String description)
void	setEventTypes(List<String> eventTypes)
void	setHealthCheckUrl(String healthCheckUrl)
void	setName(String name)
void	setNotificationScope(String notificationScope)
void	setOrganizationId(String organizationId)
void	setProductId(String productId)
void	setRetryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy)
void	setSecurityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy)
void	setWebhookUrl(String webhookUrl)
String	toString()
CreateWebhookRequest	webhookUrl(String webhookUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateWebhookRequest

public CreateWebhookRequest()

Method Detail

name

public CreateWebhookRequest name(String name)

getName

public String getName()

Client friendly webhook name.

Returns:

name

setName

public void setName(String name)

description

public CreateWebhookRequest description(String description)

getDescription

public String getDescription()

Client friendly webhook description.

Returns:

description

setDescription

public void setDescription(String description)

organizationId

public CreateWebhookRequest organizationId(String organizationId)

getOrganizationId

public String getOrganizationId()

Organization Identifier (OrgId) or Merchant Identifier (MID).

Returns:

organizationId

setOrganizationId

public void setOrganizationId(String organizationId)

productId

public CreateWebhookRequest productId(String productId)

getProductId

public String getProductId()

To see the valid productId and eventTypes, call the \"Create and Manage Webhooks - Retrieve a list of event types\" endpoint.

Returns:

productId

setProductId

public void setProductId(String productId)

eventTypes

public CreateWebhookRequest eventTypes(List<String> eventTypes)

addEventTypesItem

public CreateWebhookRequest addEventTypesItem(String eventTypesItem)

getEventTypes

public List<String> getEventTypes()

Array of the different events for a given product id.

Returns:

eventTypes

setEventTypes

public void setEventTypes(List<String> eventTypes)

webhookUrl

public CreateWebhookRequest webhookUrl(String webhookUrl)

getWebhookUrl

public String getWebhookUrl()

The client's endpoint (URL) to receive webhooks.

Returns:

webhookUrl

setWebhookUrl

public void setWebhookUrl(String webhookUrl)

healthCheckUrl

public CreateWebhookRequest healthCheckUrl(String healthCheckUrl)

getHealthCheckUrl

public String getHealthCheckUrl()

The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. If the user does not provide the health check URL, it is the user's responsibility to re-activate the webhook if it is deactivated by calling the test endpoint.

Returns:

healthCheckUrl

setHealthCheckUrl

public void setHealthCheckUrl(String healthCheckUrl)

notificationScope

public CreateWebhookRequest notificationScope(String notificationScope)

getNotificationScope

public String getNotificationScope()

The webhook scope. 1. SELF The Webhook is used to deliver webhooks for only this Organization (or Merchant). 2. DESCENDANTS The Webhook is used to deliver webhooks for this Organization and its children. 3. CUSTOM The Webhook is used to deliver webhooks for the OrgIds (or MiDs) explicitly listed in scopeData field.

Returns:

notificationScope

setNotificationScope

public void setNotificationScope(String notificationScope)

retryPolicy

public CreateWebhookRequest retryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy)

getRetryPolicy

public Notificationsubscriptionsv1webhooksRetryPolicy getRetryPolicy()

Get retryPolicy

Returns:

retryPolicy

setRetryPolicy

public void setRetryPolicy(Notificationsubscriptionsv1webhooksRetryPolicy retryPolicy)

securityPolicy

public CreateWebhookRequest securityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy)

getSecurityPolicy

public Notificationsubscriptionsv1webhooksSecurityPolicy1 getSecurityPolicy()

Get securityPolicy

Returns:

securityPolicy

setSecurityPolicy

public void setSecurityPolicy(Notificationsubscriptionsv1webhooksSecurityPolicy1 securityPolicy)

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