com.siftscience.SiftClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sift-java Show documentation
Sift Science Java API
The newest version!
package com.siftscience;

import com.siftscience.model.ApplyDecisionFieldSet;
import com.siftscience.model.DecisionStatusFieldSet;
import com.siftscience.model.GetDecisionFieldSet;
import com.siftscience.model.LabelFieldSet;
import com.siftscience.model.ScoreFieldSet;
import com.siftscience.model.UnlabelFieldSet;
import com.siftscience.model.UserScoreFieldSet;
import com.siftscience.model.WorkflowStatusFieldSet;
import com.siftscience.model.GetMerchantFieldSet;
import com.siftscience.model.CreateMerchantFieldSet;
import com.siftscience.model.UpdateMerchantFieldSet;
import com.siftscience.model.GetMerchantsFieldSet;
import com.siftscience.model.VerificationSendFieldSet;
import com.siftscience.model.VerificationResendFieldSet;
import com.siftscience.model.VerificationCheckFieldSet;
import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;

/**
 * Use a SiftClient to access all supported Sift Science APIs. It may be used concurrently from
 * different threads.
 *
 * Usage:
 *
 * SiftClient client = new SiftClient("YOUR_API_KEY");
 * EventRequest txEventRequest = client.buildRequest(
 *      new TransactionFieldSet()
 *              .setUserId("some_user_id")
 *              .setAmount(506790000L)
 *              .setCurrencyCode("USD")
 *              .setTransactionType("$sale")
 *              ... );
 * try {
 *      EventResponse txEventResponse = txEventRequest.send();
 * } catch (SiftException e) {
 *     ... handle validation and unexpected server errors.
 * }
 *
 * txEventResponse.isOk(); // true;
 * txEventResponse.getApiErrorMessage(); // "OK";
 *
 * FieldSet requestFields = txEventResponse.getRequestBody();
 * EventResponseBody responseFields = txEventResponse.getBody();
 *
 */
public class SiftClient {
    private final String accountId;
    private final String apiKey;
    private final HttpClient httpClient;
    private HttpUrl baseUrl = HttpUrl.parse("https://api.sift.com");

    public SiftClient(String apiKey, String accountId) {
        this(apiKey, accountId, new OkHttpClient());
    }

    public SiftClient(String apiKey, String accountId, OkHttpClient okHttpClient) {
        assertNotNull(apiKey, "API key must not be null");
        assertNotNull(okHttpClient, "Http Client must not be null");
        this.apiKey = apiKey;
        this.accountId = accountId;
        this.httpClient = new HttpClient(okHttpClient);
    }

    /**
     * Used for testing to stub the endpoint
     * @param apiKey
     * @param accountId
     * @param baseUrl
     */
    public SiftClient(String apiKey, String accountId, HttpUrl baseUrl) {
        this(apiKey, accountId, new OkHttpClient());
        this.baseUrl = baseUrl;
    }

    public SiftClient(String apiKey, String accountId, HttpUrl baseUrl, OkHttpClient okHttpClient) {
        this(apiKey, accountId, okHttpClient);
        this.baseUrl = baseUrl;
    }

    public String getApiKey() {
        return apiKey;
    }

    public String getAccountId() {
        return accountId;
    }

    public void enqueueRequests() {
        httpClient.enqueueRequests();
    }

    public EventRequest buildRequest(FieldSet fields) {
        setupApiKey(fields);
        return new EventRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public ApplyDecisionRequest buildRequest(ApplyDecisionFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new ApplyDecisionRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public GetDecisionsRequest buildRequest(GetDecisionFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new GetDecisionsRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public DecisionStatusRequest buildRequest(DecisionStatusFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new DecisionStatusRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public LabelRequest buildRequest(LabelFieldSet fields) {
        setupApiKey(fields);
        return new LabelRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public UnlabelRequest buildRequest(UnlabelFieldSet fields) {
        setupApiKey(fields);
        return new UnlabelRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public ScoreRequest buildRequest(ScoreFieldSet fields) {
        setupApiKey(fields);
        return new ScoreRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public UserScoreRequest buildRequest(UserScoreFieldSet fields) {
        setupApiKey(fields);
        return new UserScoreRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public WorkflowStatusRequest buildRequest(WorkflowStatusFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new WorkflowStatusRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public GetMerchantsRequest buildRequest(GetMerchantsFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new GetMerchantsRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public GetMerchantRequest buildRequest(GetMerchantFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new GetMerchantRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public CreateMerchantRequest buildRequest(CreateMerchantFieldSet fields) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new CreateMerchantRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public UpdateMerchantRequest buildRequest(UpdateMerchantFieldSet fields, String merchantId) {
        assertAccountIdIsNotNull();
        setupApiKey(fields);
        return new UpdateMerchantRequest(baseUrl, getAccountId(), httpClient, fields, merchantId);
    }

    public VerificationSendRequest buildRequest(VerificationSendFieldSet fields) {
        setupApiKey(fields);
        return new VerificationSendRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public VerificationResendRequest buildRequest(VerificationResendFieldSet fields) {
        setupApiKey(fields);
        return new VerificationResendRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    public VerificationCheckRequest buildRequest(VerificationCheckFieldSet fields) {
        setupApiKey(fields);
        return new VerificationCheckRequest(baseUrl, getAccountId(), httpClient, fields);
    }

    private void setupApiKey(FieldSet fields) {
        fields.setApiKey(getApiKey());
    }

    private void assertAccountIdIsNotNull() {
        assertNotNull(getAccountId(), "Account ID must not be null");
    }

    private void assertNotNull(Object value, String message) {
        if (value == null) {
            throw new IllegalArgumentException(message);
        }
    }
}