Package com.courier.api.resources.profiles.types

Class WebhookProfile.Builder

java.lang.Object

com.courier.api.resources.profiles.types.WebhookProfile.Builder

All Implemented Interfaces:

WebhookProfile._FinalStage, WebhookProfile.UrlStage

Enclosing class:

WebhookProfile

public static final class WebhookProfile.Builder
extends java.lang.Object
implements WebhookProfile.UrlStage, WebhookProfile._FinalStage

Method Summary

Modifier and Type	Method	Description
WebhookProfile._FinalStage	authentication(WebhookAuthentication authentication)	Authentication configuration for the webhook request.
WebhookProfile._FinalStage	authentication(java.util.Optional<WebhookAuthentication> authentication)
WebhookProfile	build()
WebhookProfile.Builder	from(WebhookProfile other)
WebhookProfile._FinalStage	headers(java.util.Map<java.lang.String,java.lang.String> headers)	Custom headers to include in the webhook request.
WebhookProfile._FinalStage	headers(java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> headers)
WebhookProfile._FinalStage	method(WebhookMethod method)	The HTTP method to use for the webhook request.
WebhookProfile._FinalStage	method(java.util.Optional<WebhookMethod> method)
WebhookProfile._FinalStage	profile(WebhookProfileType profile)	Specifies what profile information is included in the request payload.
WebhookProfile._FinalStage	profile(java.util.Optional<WebhookProfileType> profile)
WebhookProfile._FinalStage	url(java.lang.String url)	The URL to send the webhook request to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public WebhookProfile.Builder from(WebhookProfile other)

Specified by:

from in interface WebhookProfile.UrlStage

url

public WebhookProfile._FinalStage url(java.lang.String url)

The URL to send the webhook request to.

Specified by:

url in interface WebhookProfile.UrlStage

Returns:

Reference to this so that method calls can be chained together.

profile

public WebhookProfile._FinalStage profile(WebhookProfileType profile)

Specifies what profile information is included in the request payload. Defaults to 'limited' if not specified.

Specified by:

profile in interface WebhookProfile._FinalStage

Returns:

Reference to this so that method calls can be chained together.

profile

public WebhookProfile._FinalStage profile(java.util.Optional<WebhookProfileType> profile)

Specified by:

profile in interface WebhookProfile._FinalStage

authentication

public WebhookProfile._FinalStage authentication(WebhookAuthentication authentication)

Authentication configuration for the webhook request.

Specified by:

authentication in interface WebhookProfile._FinalStage

Returns:

Reference to this so that method calls can be chained together.

authentication

public WebhookProfile._FinalStage authentication(java.util.Optional<WebhookAuthentication> authentication)

Specified by:

authentication in interface WebhookProfile._FinalStage

headers

public WebhookProfile._FinalStage headers(java.util.Map<java.lang.String,java.lang.String> headers)

Custom headers to include in the webhook request.

Specified by:

headers in interface WebhookProfile._FinalStage

Returns:

Reference to this so that method calls can be chained together.

headers

public WebhookProfile._FinalStage headers(java.util.Optional<java.util.Map<java.lang.String,java.lang.String>> headers)

Specified by:

headers in interface WebhookProfile._FinalStage

method

public WebhookProfile._FinalStage method(WebhookMethod method)

The HTTP method to use for the webhook request. Defaults to POST if not specified.

Specified by:

method in interface WebhookProfile._FinalStage

Returns:

Reference to this so that method calls can be chained together.

method

public WebhookProfile._FinalStage method(java.util.Optional<WebhookMethod> method)

Specified by:

method in interface WebhookProfile._FinalStage

build

public WebhookProfile build()

Specified by:

build in interface WebhookProfile._FinalStage