Constructor Detail

Method Detail

• withRawResponse

   abstract BulkServiceAsync.WithRawResponse withRawResponse()

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

• withOptions

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

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

  The original service is not modified.

• addUsers

   CompletableFuture<Void> addUsers(String jobId, BulkAddUsersParams params)

  Ingest user data into a Bulk Job.

  Important: For email-based bulk jobs, each user must include profile.email for provider routing to work correctly. The to.email field is not sufficient for email provider routing.

• addUsers

   CompletableFuture<Void> addUsers(String jobId, BulkAddUsersParams params, RequestOptions requestOptions)

• addUsers

   CompletableFuture<Void> addUsers(BulkAddUsersParams params)

• addUsers

   abstract CompletableFuture<Void> addUsers(BulkAddUsersParams params, RequestOptions requestOptions)

• createJob

   CompletableFuture<BulkCreateJobResponse> createJob(BulkCreateJobParams params)

  Creates a new bulk job for sending messages to multiple recipients.

  Required: message.event (event ID or notification ID)

  Optional (V2 format): message.template (notification ID) or message.content (Elemental content) can be provided to override the notification associated with the event.

• createJob

   abstract CompletableFuture<BulkCreateJobResponse> createJob(BulkCreateJobParams params, RequestOptions requestOptions)

• listUsers

   CompletableFuture<BulkListUsersResponse> listUsers(String jobId)

  Get Bulk Job Users

• listUsers

   CompletableFuture<BulkListUsersResponse> listUsers(String jobId, BulkListUsersParams params, RequestOptions requestOptions)

• listUsers

   CompletableFuture<BulkListUsersResponse> listUsers(String jobId, BulkListUsersParams params)

• listUsers

   abstract CompletableFuture<BulkListUsersResponse> listUsers(BulkListUsersParams params, RequestOptions requestOptions)

• listUsers

   CompletableFuture<BulkListUsersResponse> listUsers(BulkListUsersParams params)

• listUsers

   CompletableFuture<BulkListUsersResponse> listUsers(String jobId, RequestOptions requestOptions)

• retrieveJob

   CompletableFuture<BulkRetrieveJobResponse> retrieveJob(String jobId)

  Get a bulk job

• retrieveJob

   CompletableFuture<BulkRetrieveJobResponse> retrieveJob(String jobId, BulkRetrieveJobParams params, RequestOptions requestOptions)

• retrieveJob

   CompletableFuture<BulkRetrieveJobResponse> retrieveJob(String jobId, BulkRetrieveJobParams params)

• retrieveJob

   abstract CompletableFuture<BulkRetrieveJobResponse> retrieveJob(BulkRetrieveJobParams params, RequestOptions requestOptions)

• retrieveJob

   CompletableFuture<BulkRetrieveJobResponse> retrieveJob(BulkRetrieveJobParams params)

• retrieveJob

   CompletableFuture<BulkRetrieveJobResponse> retrieveJob(String jobId, RequestOptions requestOptions)

• runJob

   CompletableFuture<Void> runJob(String jobId)

  Run a bulk job

• runJob

   CompletableFuture<Void> runJob(String jobId, BulkRunJobParams params, RequestOptions requestOptions)

• runJob

   CompletableFuture<Void> runJob(String jobId, BulkRunJobParams params)

• runJob

   abstract CompletableFuture<Void> runJob(BulkRunJobParams params, RequestOptions requestOptions)

• runJob

   CompletableFuture<Void> runJob(BulkRunJobParams params)

• runJob

   CompletableFuture<Void> runJob(String jobId, RequestOptions requestOptions)