seeuletter-java

Seeuletter.com Java wrapper is a simple but flexible wrapper for the Seeuletter.com API. See full Seeuletter.com documentation here. For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the Java wrapper.

Table of Contents

• Getting Started
  • Registration
  • Installation
  • Letters
  • Accounts
  • Invoices
• Example
• Testing

Getting Started

Here's a general overview of the Seeuletter services available, click through to read more.

Please read through the official API Documentation to get a complete sense of what to expect from each endpoint.

Registration

First, you will need to first create an account at Seeuletter.com and obtain your Test and Live API Keys.

Once you have created an account, you can access your API Keys from the API keys Panel.

Installation

Include the following in your pom.xml for Maven:

<dependencies>
  <dependency>
    <groupId>com.seeuletter</groupId>
    <artifactId>seeuletter-java</artifactId>
    <version>1.0.3</version>
  </dependency>
  ...
</dependencies>

Gradle:

compile 'com.seeuletter:seeuletter-java:1.0.3'

Initialization and Configuration

import com.seeuletter.Seeuletter;
import com.seeuletter.model.Address;
import com.seeuletter.model.Letter;
import com.seeuletter.net.SeeuletterResponse;


Seeuletter.init("yourApiKey");

You may optionally set an API version. This is useful for testing your code against new API versions before you upgrade.

import com.seeuletter.Seeuletter;
import com.seeuletter.model.Address;
import com.seeuletter.model.Letter;
import com.seeuletter.net.SeeuletterResponse;

Seeuletter.init("yourApiKey");

Letters

Create a new Letter

Seeuletter.init("YOUR API KEY");

final File file = new File(getClass().getClassLoader().getResource("local_file.pdf").getPath());

SeeuletterResponse<Letter> response = new Letter.RequestBuilder()
    .setTo(
        new Address.RequestBuilder()
            .setName("Seeuletter")
            .setLine1("25 passage dubail")
            .setCity("Paris")
            .setPostalCode("75010")
            .setCountry("France")
    )
    .setSourceFile(file, "file")
    .setPostageSpeed("D1")
    .setDescription("Sent with the Java Wrapper")
    .setBothSides(false)
    .setPostageType("prioritaire")
    .setColor("bw")
    .setVariables(variables)
    .setPdfMargin(5)
    .create();

Letter letter = response.getResponseBody();

System.out.println(letter);

Create a new LetterElectronic

Seeuletter.init("YOUR API KEY");

final File file = new File(getClass().getClassLoader().getResource("local_file.pdf").getPath());

SeeuletterResponse<LetterElectronic> responseElectronic = new LetterElectronic.RequestBuilder()
    .setTo(
        new Address.RequestBuilder()
            .setFirstName("Erlich")
            .setLastName("Dumas")
            .setEmail("seeuletter@example.com")
            .setStatus("individual")
    )
    .setPostageType("lre")
    .setSourceFile("<h1>Hello from {{website}}</h1>", "html")
    .setDescription("Sent Electronic with the Java Wrapper")
    .setContent("Please review the attached documents:")
    .setVariables(variables)
    .create();

LetterElectronic letterElectronic = responseElectronic.getResponseBody();

System.out.println(letterElectronic);

Get a specific letter

Seeuletter.init("YOUR API KEY");

SeeuletterResponse<Letter> response = Letter.retrieve("LETTER_ID");
Letter Letter = response.getResponseBody();

System.out.println(Letter);

Accounts

Create a new account for the company

Seeuletter.init("YOUR API KEY");

SeeuletterResponse<Account> response = new Account.RequestBuilder()
      .setEmail("msb.partner@example.com")
      .setName("Erlich Bachman")
      .setPhone("+33104050607")
      .setCompanyName("MSB Partner from Java Wrapper")
      .setAddressLine1("30 rue de rivoli")
      .setAddressLine2("")
      .setAddressCity("Paris")
      .setAddressCountry("France")
      .setAddressPostalCode("75004")
      .create();

Account account = response.getResponseBody();

System.out.println(response);

Update the account company email

Seeuletter.init("YOUR API KEY");

SeeuletterResponse<Account> responseUpdate = new Account.RequestBuilder()
      .setEmail("msb.partner3@example.com")
      .update("ACCOUNT COMPANY ID");

System.out.println(response);

Invoices

List all invoices for a company

Seeuletter.init("YOUR API KEY");

SeeuletterResponse<InvoiceCollection> response = Invoice.list();
InvoiceCollection accounts = response.getResponseBody();

System.out.println(response);

Retrieve a specific invoice

Seeuletter.init("YOUR API KEY");

SeeuletterResponse<Invoice> response = Invoice.retrieve("INVOICE ID");
Invoice invoice = response.getResponseBody();

System.out.println(response);

Example

We've provided examples in the seeuletter-java-examples/ package that has examples of how to use the seeuletter-java wrapper with some of our core endpoints.

Testing

You can run all tests with the command mvn test in the main directory.

=======================

Copyright © 2018 Seeuletter.com

Released under the MIT License, which can be found in the repository in LICENSE.txt.