Class JourneyCreateParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class JourneyCreateParams implements Params
Create a journey. Defaults to
DRAFTstate; passstate: "PUBLISHED"to publish on create. Send nodes are not allowed onPOST. The standard flow is: create the journey shell here, add notification templates withPOST /journeys/{templateId}/templates, then wire them into the journey withPUT /journeys/{templateId}. CallPOST /journeys/{templateId}/publishto publish a draft after the fact.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJourneyCreateParams.BuilderA builder for JourneyCreateParams.
-
Method Summary
Modifier and Type Method Description final CreateJourneyRequestcreateJourneyRequest()Request body for creating a journey. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final JourneyCreateParams.BuildertoBuilder()final CreateJourneyRequest_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static JourneyCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of JourneyCreateParams. -
-
Method Detail
-
createJourneyRequest
final CreateJourneyRequest createJourneyRequest()
Request body for creating a journey.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final JourneyCreateParams.Builder toBuilder()
-
_body
final CreateJourneyRequest _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static JourneyCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of JourneyCreateParams.
The following fields are required:
.createJourneyRequest()
-
-
-
-