Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 1.88 KB

README.md

File metadata and controls

59 lines (44 loc) · 1.88 KB

Courier Java SDK

The Courier Java SDK provides typed access to the Courier REST API from applications written in Java 8+. It uses builder-pattern request construction, OkHttp for transport, and returns strongly typed response objects.

Installation

Gradle

implementation("com.courier:courier-java:4.9.1")

Maven

<dependency>
  <groupId>com.courier</groupId>
  <artifactId>courier-java</artifactId>
  <version>4.9.1</version>
</dependency>

Quick Start

import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.core.JsonValue;
import com.courier.models.UserRecipient;
import com.courier.models.send.SendMessageParams;

CourierClient client = CourierOkHttpClient.fromEnv();

SendMessageParams params = SendMessageParams.builder()
    .message(SendMessageParams.Message.builder()
        .to(UserRecipient.builder().userId("your_user_id").build())
        .template("your_template_id")
        .data(SendMessageParams.Message.Data.builder()
            .putAdditionalProperty("foo", JsonValue.from("bar"))
            .build())
        .build())
    .build();

var response = client.send().message(params);
System.out.println(response.requestId());

The client reads COURIER_API_KEY from your environment (or courier.apiKey system property) automatically.

Documentation

Full documentation: courier.com/docs/sdk-libraries/java