Package com.stripe.model
Class WebhookEndpoint
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.WebhookEndpoint
-
- All Implemented Interfaces:
HasId
,MetadataStore<WebhookEndpoint>
,StripeObjectInterface
public class WebhookEndpoint extends ApiResource implements HasId, MetadataStore<WebhookEndpoint>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description WebhookEndpoint()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
static WebhookEndpoint
create(WebhookEndpointCreateParams params)
A webhook endpoint must have aurl
and a list ofenabled_events
.static WebhookEndpoint
create(WebhookEndpointCreateParams params, RequestOptions options)
A webhook endpoint must have aurl
and a list ofenabled_events
.static WebhookEndpoint
create(java.util.Map<java.lang.String,java.lang.Object> params)
A webhook endpoint must have aurl
and a list ofenabled_events
.static WebhookEndpoint
create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
A webhook endpoint must have aurl
and a list ofenabled_events
.WebhookEndpoint
delete()
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.WebhookEndpoint
delete(RequestOptions options)
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.WebhookEndpoint
delete(java.util.Map<java.lang.String,java.lang.Object> params)
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.WebhookEndpoint
delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.boolean
equals(java.lang.Object o)
java.lang.String
getApiVersion()
The API version events are rendered as for this webhook endpoint.java.lang.String
getApplication()
The ID of the associated Connect application.java.lang.Long
getCreated()
Time at which the object was created.java.lang.Boolean
getDeleted()
Always true for a deleted object.java.lang.String
getDescription()
An optional description of what the webhook is used for.java.util.List<java.lang.String>
getEnabledEvents()
The list of events to enable for this endpoint.java.lang.String
getId()
Unique identifier for the object.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getObject()
String representing the object's type.java.lang.String
getSecret()
The endpoint's secret, used to generate webhook signatures.java.lang.String
getStatus()
The status of the webhook.java.lang.String
getUrl()
The URL of the webhook endpoint.int
hashCode()
static WebhookEndpointCollection
list(WebhookEndpointListParams params)
Returns a list of your webhook endpoints.static WebhookEndpointCollection
list(WebhookEndpointListParams params, RequestOptions options)
Returns a list of your webhook endpoints.static WebhookEndpointCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of your webhook endpoints.static WebhookEndpointCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of your webhook endpoints.static WebhookEndpoint
retrieve(java.lang.String webhookEndpoint)
Retrieves the webhook endpoint with the given ID.static WebhookEndpoint
retrieve(java.lang.String webhookEndpoint, RequestOptions options)
Retrieves the webhook endpoint with the given ID.static WebhookEndpoint
retrieve(java.lang.String webhookEndpoint, WebhookEndpointRetrieveParams params, RequestOptions options)
Retrieves the webhook endpoint with the given ID.static WebhookEndpoint
retrieve(java.lang.String webhookEndpoint, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the webhook endpoint with the given ID.void
setApiVersion(java.lang.String apiVersion)
The API version events are rendered as for this webhook endpoint.void
setApplication(java.lang.String application)
The ID of the associated Connect application.void
setCreated(java.lang.Long created)
Time at which the object was created.void
setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.void
setDescription(java.lang.String description)
An optional description of what the webhook is used for.void
setEnabledEvents(java.util.List<java.lang.String> enabledEvents)
The list of events to enable for this endpoint.void
setId(java.lang.String id)
Unique identifier for the object.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setObject(java.lang.String object)
String representing the object's type.void
setSecret(java.lang.String secret)
The endpoint's secret, used to generate webhook signatures.void
setStatus(java.lang.String status)
The status of the webhook.void
setUrl(java.lang.String url)
The URL of the webhook endpoint.WebhookEndpoint
update(WebhookEndpointUpdateParams params)
Updates the webhook endpoint.WebhookEndpoint
update(WebhookEndpointUpdateParams params, RequestOptions options)
Updates the webhook endpoint.WebhookEndpoint
update(java.util.Map<java.lang.String,java.lang.Object> params)
Updates the webhook endpoint.WebhookEndpoint
update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Updates the webhook endpoint.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
-
-
-
Method Detail
-
list
public static WebhookEndpointCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of your webhook endpoints.- Throws:
StripeException
-
list
public static WebhookEndpointCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of your webhook endpoints.- Throws:
StripeException
-
list
public static WebhookEndpointCollection list(WebhookEndpointListParams params) throws StripeException
Returns a list of your webhook endpoints.- Throws:
StripeException
-
list
public static WebhookEndpointCollection list(WebhookEndpointListParams params, RequestOptions options) throws StripeException
Returns a list of your webhook endpoints.- Throws:
StripeException
-
retrieve
public static WebhookEndpoint retrieve(java.lang.String webhookEndpoint) throws StripeException
Retrieves the webhook endpoint with the given ID.- Throws:
StripeException
-
retrieve
public static WebhookEndpoint retrieve(java.lang.String webhookEndpoint, RequestOptions options) throws StripeException
Retrieves the webhook endpoint with the given ID.- Throws:
StripeException
-
retrieve
public static WebhookEndpoint retrieve(java.lang.String webhookEndpoint, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the webhook endpoint with the given ID.- Throws:
StripeException
-
retrieve
public static WebhookEndpoint retrieve(java.lang.String webhookEndpoint, WebhookEndpointRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the webhook endpoint with the given ID.- Throws:
StripeException
-
create
public static WebhookEndpoint create(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
A webhook endpoint must have aurl
and a list ofenabled_events
. You may optionally specify the Booleanconnect
parameter. If set to true, then a Connect webhook endpoint that notifies the specifiedurl
about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specifiedurl
only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.- Throws:
StripeException
-
create
public static WebhookEndpoint create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
A webhook endpoint must have aurl
and a list ofenabled_events
. You may optionally specify the Booleanconnect
parameter. If set to true, then a Connect webhook endpoint that notifies the specifiedurl
about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specifiedurl
only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.- Throws:
StripeException
-
create
public static WebhookEndpoint create(WebhookEndpointCreateParams params) throws StripeException
A webhook endpoint must have aurl
and a list ofenabled_events
. You may optionally specify the Booleanconnect
parameter. If set to true, then a Connect webhook endpoint that notifies the specifiedurl
about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specifiedurl
only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.- Throws:
StripeException
-
create
public static WebhookEndpoint create(WebhookEndpointCreateParams params, RequestOptions options) throws StripeException
A webhook endpoint must have aurl
and a list ofenabled_events
. You may optionally specify the Booleanconnect
parameter. If set to true, then a Connect webhook endpoint that notifies the specifiedurl
about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specifiedurl
only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.- Throws:
StripeException
-
update
public WebhookEndpoint update(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Updates the webhook endpoint. You may edit theurl
, the list ofenabled_events
, and the status of your endpoint.- Specified by:
update
in interfaceMetadataStore<WebhookEndpoint>
- Throws:
StripeException
-
update
public WebhookEndpoint update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Updates the webhook endpoint. You may edit theurl
, the list ofenabled_events
, and the status of your endpoint.- Specified by:
update
in interfaceMetadataStore<WebhookEndpoint>
- Throws:
StripeException
-
update
public WebhookEndpoint update(WebhookEndpointUpdateParams params) throws StripeException
Updates the webhook endpoint. You may edit theurl
, the list ofenabled_events
, and the status of your endpoint.- Throws:
StripeException
-
update
public WebhookEndpoint update(WebhookEndpointUpdateParams params, RequestOptions options) throws StripeException
Updates the webhook endpoint. You may edit theurl
, the list ofenabled_events
, and the status of your endpoint.- Throws:
StripeException
-
delete
public WebhookEndpoint delete() throws StripeException
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.- Throws:
StripeException
-
delete
public WebhookEndpoint delete(RequestOptions options) throws StripeException
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.- Throws:
StripeException
-
delete
public WebhookEndpoint delete(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.- Throws:
StripeException
-
delete
public WebhookEndpoint delete(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.- Throws:
StripeException
-
getApiVersion
public java.lang.String getApiVersion()
The API version events are rendered as for this webhook endpoint.
-
getApplication
public java.lang.String getApplication()
The ID of the associated Connect application.
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getDeleted
public java.lang.Boolean getDeleted()
Always true for a deleted object.
-
getDescription
public java.lang.String getDescription()
An optional description of what the webhook is used for.
-
getEnabledEvents
public java.util.List<java.lang.String> getEnabledEvents()
The list of events to enable for this endpoint.['*']
indicates that all events are enabled, except those that require explicit selection.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
webhook_endpoint
.
-
getSecret
public java.lang.String getSecret()
The endpoint's secret, used to generate webhook signatures. Only returned at creation.
-
getStatus
public java.lang.String getStatus()
The status of the webhook. It can beenabled
ordisabled
.
-
getUrl
public java.lang.String getUrl()
The URL of the webhook endpoint.
-
setApiVersion
public void setApiVersion(java.lang.String apiVersion)
The API version events are rendered as for this webhook endpoint.
-
setApplication
public void setApplication(java.lang.String application)
The ID of the associated Connect application.
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setDeleted
public void setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.
-
setDescription
public void setDescription(java.lang.String description)
An optional description of what the webhook is used for.
-
setEnabledEvents
public void setEnabledEvents(java.util.List<java.lang.String> enabledEvents)
The list of events to enable for this endpoint.['*']
indicates that all events are enabled, except those that require explicit selection.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
webhook_endpoint
.
-
setSecret
public void setSecret(java.lang.String secret)
The endpoint's secret, used to generate webhook signatures. Only returned at creation.
-
setStatus
public void setStatus(java.lang.String status)
The status of the webhook. It can beenabled
ordisabled
.
-
setUrl
public void setUrl(java.lang.String url)
The URL of the webhook endpoint.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getId
public java.lang.String getId()
Unique identifier for the object.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.- Specified by:
getMetadata
in interfaceMetadataStore<WebhookEndpoint>
-
-