com.tapstream.sdk.ApiClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tapstream-core Show documentation

This library contains the building blocks for a Tapstream Java SDK

There is a newer version: 4.0.0

package com.tapstream.sdk;

import com.tapstream.sdk.wordofmouth.OfferApiResponse;
import com.tapstream.sdk.wordofmouth.RewardApiResponse;

import java.io.Closeable;

public interface ApiClient extends Closeable {

	/**
	 * Report the given event to Tapstream's analytics platform.
	 *
	 * @param e An Event object to be reported to Tapstream.
	 * @return An ApiFuture wrapping an EventApiResponse, from which the
	 *         HttpResponse can be obtained if necessary.
     */
    ApiFuture fireEvent(Event e);

	/**
	 * Queries Tapstream's timeline lookup API to get a list of historic hits
	 * and events associated with the current user. May be used to implement
	 * deep links. For more information please see
	 * Tapstream's documentation
	 * on the subject.
	 *
	 * @return An ApiFuture wrapping a TimelineApiResponse, from which a {@link org.json.JSONObject}
	 * 		can be parsed.
     */
    ApiFuture lookupTimeline();

	/**
	 * Queries Tapstream's timeline summary API to get a summary of the current user's timeline.
	 * May be used to more easily implement deferred deep links. For more information please see
	 * Tapstream's documentation
	 * on the subject.
	 *
	 * @return An ApiFuture wrapping a TimelineSummaryResponse, which provides a summary of the current
	 * 		user's timeline (in particular the latestDeeplink field).
     */
	ApiFuture getTimelineSummary();

	/**
	 * Queries the Word of Mouth API to retrieve an offer to be displayed to
	 * the current user, at the given insertion point.
	 *
	 * @param insertionPoint The string id for this insertion point that was
	 *                       configured in Tapstream's dashboard.
	 * @return An ApiFuture wrapping an OfferApiResponse
	 *
	 * 	 * {@code
	 *     Offer offer = apiClient
	 *         .getWordOfMouthOffer("my-insertion-point")
	 *         .get()
	 *         .getOffer();
	 * }
	 * 
     */
    ApiFuture getWordOfMouthOffer(final String insertionPoint);

	/**
	 * Queries the Word of Mouth API to retrieve a list of rewards associated
	 * with the current user.
	 *
	 * @return An ApiFuture wrapping a RewardApiResponse from which a
	 *          {@link java.util.List} can be obtained.
	 *
	 * 	 * {@code
	 *     List rewards = apiClient
	 *         .getWordOfMouthRewardList()
	 *         .get()
	 *         .getRewards();
	 * }
	 * 
	 */
	ApiFuture getWordOfMouthRewardList();
}