com.siftscience

Class SiftClient

java.lang.Object

com.siftscience.SiftClient

public class SiftClient
extends java.lang.Object

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();

Constructor Summary

Constructors

Constructor and Description
SiftClient(java.lang.String apiKey, java.lang.String accountId)
SiftClient(java.lang.String apiKey, java.lang.String accountId, okhttp3.HttpUrl baseUrl) Used for testing to stub the endpoint
SiftClient(java.lang.String apiKey, java.lang.String accountId, okhttp3.OkHttpClient okHttpClient)

Method Summary

Modifier and Type	Method and Description
ApplyDecisionRequest	buildRequest(ApplyDecisionFieldSet fields)
CreateMerchantRequest	buildRequest(CreateMerchantFieldSet fields)
DecisionStatusRequest	buildRequest(DecisionStatusFieldSet fields)
EventRequest	buildRequest(FieldSet fields)
GetDecisionsRequest	buildRequest(GetDecisionFieldSet fields)
GetMerchantRequest	buildRequest(GetMerchantFieldSet fields)
GetMerchantsRequest	buildRequest(GetMerchantsFieldSet fields)
LabelRequest	buildRequest(LabelFieldSet fields)
ScoreRequest	buildRequest(ScoreFieldSet fields)
UnlabelRequest	buildRequest(UnlabelFieldSet fields)
UpdateMerchantRequest	buildRequest(UpdateMerchantFieldSet fields, java.lang.String merchantId)
UserScoreRequest	buildRequest(UserScoreFieldSet fields)
WorkflowStatusRequest	buildRequest(WorkflowStatusFieldSet fields)
java.lang.String	getAccountId()
java.lang.String	getApiKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiftClient

public SiftClient(java.lang.String apiKey,
                  java.lang.String accountId)

SiftClient

public SiftClient(java.lang.String apiKey,
                  java.lang.String accountId,
                  okhttp3.OkHttpClient okHttpClient)

SiftClient

public SiftClient(java.lang.String apiKey,
                  java.lang.String accountId,
                  okhttp3.HttpUrl baseUrl)

Used for testing to stub the endpoint

Parameters:

apiKey -

accountId -

baseUrl -

Method Detail

getApiKey

public java.lang.String getApiKey()

getAccountId

public java.lang.String getAccountId()

buildRequest

public EventRequest buildRequest(FieldSet fields)

buildRequest

public ApplyDecisionRequest buildRequest(ApplyDecisionFieldSet fields)

buildRequest

public GetDecisionsRequest buildRequest(GetDecisionFieldSet fields)

buildRequest

public DecisionStatusRequest buildRequest(DecisionStatusFieldSet fields)

buildRequest

public LabelRequest buildRequest(LabelFieldSet fields)

buildRequest

public UnlabelRequest buildRequest(UnlabelFieldSet fields)

buildRequest

public ScoreRequest buildRequest(ScoreFieldSet fields)

buildRequest

public UserScoreRequest buildRequest(UserScoreFieldSet fields)

buildRequest

public WorkflowStatusRequest buildRequest(WorkflowStatusFieldSet fields)

buildRequest

public GetMerchantsRequest buildRequest(GetMerchantsFieldSet fields)

buildRequest

public GetMerchantRequest buildRequest(GetMerchantFieldSet fields)

buildRequest

public CreateMerchantRequest buildRequest(CreateMerchantFieldSet fields)

buildRequest

public UpdateMerchantRequest buildRequest(UpdateMerchantFieldSet fields,
                                          java.lang.String merchantId)