com.squareup.square.models

Class WebhookSubscription

java.lang.Object

com.squareup.square.models.WebhookSubscription

public class WebhookSubscription
extends Object

This is a model class for WebhookSubscription type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebhookSubscription.Builder Class to build instances of WebhookSubscription.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebhookSubscription(String id, io.apimatic.core.types.OptionalNullable<String> name, io.apimatic.core.types.OptionalNullable<Boolean> enabled, io.apimatic.core.types.OptionalNullable<List<String>> eventTypes, io.apimatic.core.types.OptionalNullable<String> notificationUrl, io.apimatic.core.types.OptionalNullable<String> apiVersion, String signatureKey, String createdAt, String updatedAt) Internal initialization constructor.
	WebhookSubscription(String id, String name, Boolean enabled, List<String> eventTypes, String notificationUrl, String apiVersion, String signatureKey, String createdAt, String updatedAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApiVersion() Getter for ApiVersion.
String	getCreatedAt() Getter for CreatedAt.
Boolean	getEnabled() Getter for Enabled.
List<String>	getEventTypes() Getter for EventTypes.
String	getId() Getter for Id.
String	getName() Getter for Name.
String	getNotificationUrl() Getter for NotificationUrl.
String	getSignatureKey() Getter for SignatureKey.
String	getUpdatedAt() Getter for UpdatedAt.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetApiVersion() Internal Getter for ApiVersion.
protected io.apimatic.core.types.OptionalNullable<Boolean>	internalGetEnabled() Internal Getter for Enabled.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetEventTypes() Internal Getter for EventTypes.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetName() Internal Getter for Name.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetNotificationUrl() Internal Getter for NotificationUrl.
WebhookSubscription.Builder	toBuilder() Builds a new WebhookSubscription.Builder object.
String	toString() Converts this WebhookSubscription into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookSubscription

public WebhookSubscription(String id,
                           String name,
                           Boolean enabled,
                           List<String> eventTypes,
                           String notificationUrl,
                           String apiVersion,
                           String signatureKey,
                           String createdAt,
                           String updatedAt)

Initialization constructor.

Parameters:

id - String value for id.

name - String value for name.

enabled - Boolean value for enabled.

eventTypes - List of String value for eventTypes.

notificationUrl - String value for notificationUrl.

apiVersion - String value for apiVersion.

signatureKey - String value for signatureKey.

createdAt - String value for createdAt.

updatedAt - String value for updatedAt.

WebhookSubscription

protected WebhookSubscription(String id,
                              io.apimatic.core.types.OptionalNullable<String> name,
                              io.apimatic.core.types.OptionalNullable<Boolean> enabled,
                              io.apimatic.core.types.OptionalNullable<List<String>> eventTypes,
                              io.apimatic.core.types.OptionalNullable<String> notificationUrl,
                              io.apimatic.core.types.OptionalNullable<String> apiVersion,
                              String signatureKey,
                              String createdAt,
                              String updatedAt)

Internal initialization constructor.

Method Detail

getId

public String getId()

Getter for Id. A Square-generated unique ID for the subscription.

Returns:

Returns the String

internalGetName

protected io.apimatic.core.types.OptionalNullable<String> internalGetName()

Internal Getter for Name. The name of this subscription.

Returns:

Returns the Internal String

getName

public String getName()

Getter for Name. The name of this subscription.

Returns:

Returns the String

internalGetEnabled

protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetEnabled()

Internal Getter for Enabled. Indicates whether the subscription is enabled (`true`) or not (`false`).

Returns:

Returns the Internal Boolean

getEnabled

public Boolean getEnabled()

Getter for Enabled. Indicates whether the subscription is enabled (`true`) or not (`false`).

Returns:

Returns the Boolean

internalGetEventTypes

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetEventTypes()

Internal Getter for EventTypes. The event types associated with this subscription.

Returns:

Returns the Internal List of String

getEventTypes

public List<String> getEventTypes()

Getter for EventTypes. The event types associated with this subscription.

Returns:

Returns the List of String

internalGetNotificationUrl

protected io.apimatic.core.types.OptionalNullable<String> internalGetNotificationUrl()

Internal Getter for NotificationUrl. The URL to which webhooks are sent.

Returns:

Returns the Internal String

getNotificationUrl

public String getNotificationUrl()

Getter for NotificationUrl. The URL to which webhooks are sent.

Returns:

Returns the String

internalGetApiVersion

protected io.apimatic.core.types.OptionalNullable<String> internalGetApiVersion()

Internal Getter for ApiVersion. The API version of the subscription. This field is optional for `CreateWebhookSubscription`. The value defaults to the API version used by the application.

Returns:

Returns the Internal String

getApiVersion

public String getApiVersion()

Getter for ApiVersion. The API version of the subscription. This field is optional for `CreateWebhookSubscription`. The value defaults to the API version used by the application.

Returns:

Returns the String

getSignatureKey

public String getSignatureKey()

Getter for SignatureKey. The Square-generated signature key used to validate the origin of the webhook event.

Returns:

Returns the String

getCreatedAt

public String getCreatedAt()

Getter for CreatedAt. The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".

Returns:

Returns the String

getUpdatedAt

public String getUpdatedAt()

Getter for UpdatedAt. The timestamp of when the subscription was last updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this WebhookSubscription into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public WebhookSubscription.Builder toBuilder()

Builds a new WebhookSubscription.Builder object. Creates the instance with the state of the current model.

Returns:

a new WebhookSubscription.Builder object