Constructor Detail

Method Detail

• withRawResponse

   abstract JourneyServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract JourneyServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• templates

   abstract TemplateServiceAsync templates()

• create

   CompletableFuture<JourneyResponse> create(JourneyCreateParams params)

  Create a journey. Defaults to DRAFT state; pass state: "PUBLISHED" to publish on create. Send nodes are not allowed on POST. The standard flow is: create the journey shell here, add notification templates with POST /journeys/{templateId}/templates, then wire them into the journey with PUT /journeys/{templateId}. Call POST /journeys/{templateId}/publish to publish a draft after the fact.

• create

   abstract CompletableFuture<JourneyResponse> create(JourneyCreateParams params, RequestOptions requestOptions)

• create

   CompletableFuture<JourneyResponse> create(CreateJourneyRequest createJourneyRequest, RequestOptions requestOptions)

• create

   CompletableFuture<JourneyResponse> create(CreateJourneyRequest createJourneyRequest)

• retrieve

   CompletableFuture<JourneyResponse> retrieve(String templateId)

  Fetch a journey by id. Pass ?version=draft (default published) to retrieve the working draft, or ?version=vN to retrieve a historical version.

• retrieve

   CompletableFuture<JourneyResponse> retrieve(String templateId, JourneyRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<JourneyResponse> retrieve(String templateId, JourneyRetrieveParams params)

• retrieve

   abstract CompletableFuture<JourneyResponse> retrieve(JourneyRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<JourneyResponse> retrieve(JourneyRetrieveParams params)

• retrieve

   CompletableFuture<JourneyResponse> retrieve(String templateId, RequestOptions requestOptions)

• list

   CompletableFuture<JourneysListResponse> list()

  Get the list of journeys.

• list

   abstract CompletableFuture<JourneysListResponse> list(JourneyListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<JourneysListResponse> list(JourneyListParams params)

• list

   CompletableFuture<JourneysListResponse> list(RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(String templateId)

  Archive a journey. Archived journeys cannot be invoked. Existing journey runs continue to completion.

• archive

   CompletableFuture<Void> archive(String templateId, JourneyArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(String templateId, JourneyArchiveParams params)

• archive

   abstract CompletableFuture<Void> archive(JourneyArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(JourneyArchiveParams params)

• archive

   CompletableFuture<Void> archive(String templateId, RequestOptions requestOptions)

• invoke

   CompletableFuture<JourneysInvokeResponse> invoke(String templateId, JourneyInvokeParams params)

  Invoke a journey by id or alias to start a new run. The response includes a runId identifying the run.

• invoke

   CompletableFuture<JourneysInvokeResponse> invoke(String templateId, JourneyInvokeParams params, RequestOptions requestOptions)

• invoke

   CompletableFuture<JourneysInvokeResponse> invoke(JourneyInvokeParams params)

• invoke

   abstract CompletableFuture<JourneysInvokeResponse> invoke(JourneyInvokeParams params, RequestOptions requestOptions)

• listVersions

   CompletableFuture<JourneyVersionsListResponse> listVersions(String templateId)

  List published versions of a journey, ordered most recent first.

• listVersions

   CompletableFuture<JourneyVersionsListResponse> listVersions(String templateId, JourneyListVersionsParams params, RequestOptions requestOptions)

• listVersions

   CompletableFuture<JourneyVersionsListResponse> listVersions(String templateId, JourneyListVersionsParams params)

• listVersions

   abstract CompletableFuture<JourneyVersionsListResponse> listVersions(JourneyListVersionsParams params, RequestOptions requestOptions)

• listVersions

   CompletableFuture<JourneyVersionsListResponse> listVersions(JourneyListVersionsParams params)

• listVersions

   CompletableFuture<JourneyVersionsListResponse> listVersions(String templateId, RequestOptions requestOptions)

• publish

   CompletableFuture<JourneyResponse> publish(String templateId)

  Publish the current draft as a new version. Body is optional; pass { "version": "vN" } to roll back to a prior version instead. Returns 404 if the journey has no draft to publish.

• publish

   CompletableFuture<JourneyResponse> publish(String templateId, JourneyPublishParams params, RequestOptions requestOptions)

• publish

   CompletableFuture<JourneyResponse> publish(String templateId, JourneyPublishParams params)

• publish

   abstract CompletableFuture<JourneyResponse> publish(JourneyPublishParams params, RequestOptions requestOptions)

• publish

   CompletableFuture<JourneyResponse> publish(JourneyPublishParams params)

• publish

   CompletableFuture<JourneyResponse> publish(String templateId, RequestOptions requestOptions)

• replace

   CompletableFuture<JourneyResponse> replace(String templateId, JourneyReplaceParams params)

  Replace the journey draft. Updates the working draft only; call POST /journeys/{templateId}/publish to make it live, or pass state: "PUBLISHED" in this request to publish immediately. Send-node template ids must already exist and be scoped to this journey, and node ids must not be claimed by another journey.

• replace

   CompletableFuture<JourneyResponse> replace(String templateId, JourneyReplaceParams params, RequestOptions requestOptions)

• replace

   CompletableFuture<JourneyResponse> replace(JourneyReplaceParams params)

• replace

   abstract CompletableFuture<JourneyResponse> replace(JourneyReplaceParams params, RequestOptions requestOptions)