app.knock.api.resources.ObjectsResource Maven / Gradle / Ivy
package app.knock.api.resources;
import app.knock.api.exception.KnockClientResourceException;
import app.knock.api.http.KnockHttp;
import app.knock.api.model.*;
import com.fasterxml.jackson.core.type.TypeReference;
import lombok.EqualsAndHashCode;
import lombok.Value;
import okhttp3.HttpUrl;
import okhttp3.Request;
import okhttp3.RequestBody;
import java.util.Map;
import java.util.*;
@Value
@EqualsAndHashCode(callSuper = false)
public class ObjectsResource {
private static final String BASE_RESOURCE_PATH = "v1/objects";
KnockHttp knockHttp;
HttpUrl buildListResource(String objectId, ObjectsResource.ListParams queryParams) {
HttpUrl.Builder urlBuilder = knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, objectId);
queryParams.addQueryParams(urlBuilder);
return urlBuilder.build();
}
HttpUrl objectUrl(String collection, String objectId) {
return knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, collection, objectId).build();
}
HttpUrl objectChannelDataUrl(String collection, String objectId, String channelId) {
return knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, collection, objectId, "channel_data", channelId).build();
}
HttpUrl objectMessagesUrl(String collection, String objectId, MessagesResource.QueryParams queryParams) {
HttpUrl.Builder urlBuilder = objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("messages");
queryParams.addQueryParams(urlBuilder);
return urlBuilder.build();
}
HttpUrl objectSchedulesUrl(String collection, String objectId, WorkflowsResource.SchedulesQueryParams queryParams) {
HttpUrl.Builder urlBuilder = objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("schedules");
queryParams.addQueryParams(urlBuilder);
return urlBuilder.build();
}
HttpUrl objectSubscriptionsUrl(String collection, String objectId) {
HttpUrl.Builder urlBuilder = objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("subscriptions");
return urlBuilder.build();
}
HttpUrl listObjectSubscriptionsUrl(String collection, String objectId, ListSubscriptionParams queryParams) {
HttpUrl.Builder urlBuilder = objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("subscriptions");
queryParams.addQueryParams(urlBuilder);
return urlBuilder.build();
}
HttpUrl objectPreferencesUrl(String collection, String objectId) {
return objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("preferences")
.build();
}
HttpUrl objectPreferenceUrl(String collection, String objectId, String preferenceId) {
return objectUrl(collection, objectId)
.newBuilder()
.addEncodedPathSegment("preferences")
.addEncodedPathSegment(preferenceId)
.build();
}
HttpUrl objectBulkSetUrl(String collection) {
return knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, collection, "bulk", "set").build();
}
HttpUrl objectBulkDeleteUrl(String collection) {
return knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, collection, "bulk", "delete").build();
}
HttpUrl objectBulkAddSubscriptionsUrl(String collection) {
return knockHttp.baseUrlBuilder(BASE_RESOURCE_PATH, collection, "bulk", "subscriptions", "add").build();
}
/**
* Retrieve a KnockObject
*
* @param collection
* @param objectId
* @throws KnockClientResourceException Unable able to retrieve KnockObject from the resource
* @return KnockObject
*/
public KnockObject get(String collection, String objectId) {
HttpUrl url = objectUrl(collection, objectId);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Retrieve paginated list of KnockObject
*
* @param collection
* @param queryParams
* @throws KnockClientResourceException Unable able to retrieve KnockObject from the resource
* @return KnockObject
*/
public CursorResult list(String collection, ListParams queryParams) {
HttpUrl url = buildListResource(collection, queryParams);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Set a map of properties for a specific Collection of a KnockObject.
*
* @param collection
* @param objectId
* @param properties
* @return
*/
public KnockObject set(String collection, String objectId, Map properties) {
HttpUrl url = objectUrl(collection, objectId);
RequestBody body = knockHttp.objectToJsonRequestBody(properties);
Request request = knockHttp.baseJsonRequest(url)
.put(body)
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Delete properties for a specific collection of a KnockObject
*
* @param collection
* @param objectId
*/
public void delete(String collection, String objectId) {
HttpUrl url = objectUrl(collection, objectId);
Request request = knockHttp.baseJsonRequest(url)
.delete()
.build();
knockHttp.execute(request);
}
/**
* Retrieve the ChannelData for a specific KnockObject Collection, and Channel.
*
* @param collection
* @param objectId
* @param channelId
* @return
*/
public ChannelData getChannelData(String collection, String objectId, String channelId) {
HttpUrl url = objectChannelDataUrl(collection, objectId, channelId);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Set a map of data for a specific KnockObject Collection, and Channel.
*
* @param collection
* @param objectId
* @param channelId
* @param data
* @return
*/
public ChannelData setChannelData(String collection, String objectId, String channelId, Map data) {
HttpUrl url = objectChannelDataUrl(collection, objectId, channelId);
RequestBody body = knockHttp.objectToJsonRequestBody(Collections.singletonMap("data", data));
Request request = knockHttp.baseJsonRequest(url)
.put(body)
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Delete any data for a specific KnockObject Collection, and Channel.
*
* @param collection
* @param objectId
* @param channelId
*/
public void unsetChannelData(String collection, String objectId, String channelId) {
HttpUrl url = objectChannelDataUrl(collection, objectId, channelId);
Request request = knockHttp.baseJsonRequest(url)
.delete()
.build();
knockHttp.execute(request);
}
/**
* Retrieve a CursorResult of KnockMessages for a specific KnockObject Collection.
*
* @param collection
* @param objectId
* @return
*/
public CursorResult getMessages(String collection, String objectId, MessagesResource.QueryParams queryParams) {
HttpUrl url = objectMessagesUrl(collection, objectId, queryParams);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Retrieve a CursorResult of Schedules for a specific KnockObject Collection.
*
* @param collection
* @param objectId
* @return
*/
public CursorResult getSchedules(String collection, String objectId, WorkflowsResource.SchedulesQueryParams queryParams) {
HttpUrl url = objectSchedulesUrl(collection, objectId, queryParams);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Retrieve a CursorResult of ObjectSubscriptions for a Knock Object.
*
* @param collection
* @param objectId
* @return cursor result of ObjectSubscription
*/
public CursorResult listSubscriptions(String collection, String objectId, ListSubscriptionParams queryParams) {
HttpUrl url = listObjectSubscriptionsUrl(collection, objectId, queryParams);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Retrieve a CursorResult of ObjectSubscriptions for a specific KnockObject as recipient.
*
* @param collection
* @param objectId
* @return cursor result of ObjectSubscription
*/
public CursorResult getSubscriptions(String collection, String objectId, ListSubscriptionParams queryParams) {
queryParams.mode("recipient");
HttpUrl url = listObjectSubscriptionsUrl(collection, objectId, queryParams);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Adds subscriptions to an object for recipients
*
* @param addSubscriptionsRequest Attributes for schedules creation
* @return List of created object subscriptions
* @throws KnockClientResourceException
*/
public List addSubscriptions(String collection, String objectId, AddSubscriptionsRequest addSubscriptionsRequest) {
HttpUrl url = objectSubscriptionsUrl(collection, objectId);
RequestBody body = knockHttp.objectToJsonRequestBody(addSubscriptionsRequest);
Request.Builder requestBuilder = knockHttp.baseJsonRequest(url)
.post(body);
Request request = requestBuilder.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Creates and returns a BulkOperation to create subscriptions for a set of recipients to a set of objects
* within the given collection.
*
* @param collection
* @param subscriptions
* @return a bulk operation
*/
public BulkOperation bulkAddSubscriptions(String collection, List subscriptions) {
HttpUrl url = objectBulkAddSubscriptionsUrl(collection);
RequestBody body = knockHttp.objectToJsonRequestBody(Collections.singletonMap("subscriptions", subscriptions));
Request request = knockHttp.baseJsonRequest(url).post(body).build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Adds subscriptions to an object for recipients
*
* @param deleteSubscriptionsRequest Attributes for schedules deletion
* @return List of deleted object subscriptions
* @throws KnockClientResourceException
*/
public List deleteSubscriptions(String collection, String objectId, DeleteSubscriptionsRequest deleteSubscriptionsRequest) {
HttpUrl url = objectSubscriptionsUrl(collection, objectId);
RequestBody body = knockHttp.objectToJsonRequestBody(deleteSubscriptionsRequest);
Request.Builder requestBuilder = knockHttp.baseJsonRequest(url)
.post(body);
Request request = requestBuilder.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Retrieve a list of PreferenceSets for a specific KnockObject Collection.
*
* @param collection
* @param objectId
* @return
*/
public List getPreferences(String collection, String objectId) {
HttpUrl url = objectPreferencesUrl(collection, objectId);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference>() {
});
}
/**
* Retrieve a specific PreferenceSet for a KnockObject Collection
*
* @param collection
* @param objectId
* @param preferenceId
* @return
*/
public PreferenceSet getPreferencesById(String collection, String objectId, String preferenceId) {
HttpUrl url = objectPreferenceUrl(collection, objectId, preferenceId);
Request request = knockHttp.baseJsonRequest(url)
.get()
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Set preferences for a specific PreferenceSet on a KnockObject Collection.
*
* @param collection
* @param objectId
* @param preferenceId
* @param preferenceSetRequest
* @return
*/
public PreferenceSet setPreferences(String collection, String objectId, String preferenceId, PreferenceSetRequest preferenceSetRequest) {
HttpUrl url = objectPreferenceUrl(collection, objectId, preferenceId);
Request request = knockHttp.baseJsonRequest(url)
.put(knockHttp.objectToJsonRequestBody(preferenceSetRequest))
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Bulk sets up to 100 objects at a time within a collection, returning an asynchronous BulkOperation that can
* be used to monitor the progress of the operation.
*
* Each object map in the objects list must have a key of 'id' that has a non-null string value.
*
* @param collection
* @param objects
* @return a bulk operation
*/
public BulkOperation bulkSetInCollection(String collection, List> objects) {
objects.stream()
.filter(object -> object.get("id") != null)
.findAny()
.orElseThrow(() -> new IllegalArgumentException("All object maps in the objects list must have a key of 'id' with a non-null string value."));
HttpUrl url = objectBulkSetUrl(collection);
Request request = knockHttp.baseJsonRequest(url)
.post(knockHttp.objectToJsonRequestBody(Collections.singletonMap("objects", objects)))
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
/**
* Bulk deletes up to 100 objects at a time within a collection, returning an asynchronous BulkOperation
* that can be used to monitor the progress of the operation.
*
* @param collection
* @param object_ids
* @return a bulk operation
*/
public BulkOperation bulkDeleteInCollection(String collection, List object_ids) {
HttpUrl url = objectBulkDeleteUrl(collection);
Request request = knockHttp.baseJsonRequest(url)
.post(knockHttp.objectToJsonRequestBody(Collections.singletonMap("object_ids", object_ids)))
.build();
return knockHttp.executeWithResponseType(request, new TypeReference() {
});
}
@Value
@EqualsAndHashCode(callSuper = false)
public static class ListParams {
private final Map params = new HashMap<>();
public void pageSize(Integer pageSize) {
params.put("page_size", pageSize);
}
public void after(String after) {
params.put("after", after);
}
public void before(String before) {
params.put("before", before);
}
public void addQueryParams(HttpUrl.Builder uriBuilder) {
params.entrySet()
.stream()
.sorted(Map.Entry.comparingByKey())
.forEach(entry -> uriBuilder.addQueryParameter(entry.getKey(), entry.getValue().toString()));
}
}
@Value
@EqualsAndHashCode(callSuper = false)
public static class ListSubscriptionParams {
private final Map params = new HashMap<>();
public void pageSize(Integer pageSize) {
params.put("page_size", pageSize);
}
public void after(String after) {
params.put("after", after);
}
public void before(String before) {
params.put("before", before);
}
public void mode(String mode) {
params.put("mode", mode);
}
public void addQueryParams(HttpUrl.Builder uriBuilder) {
params.entrySet()
.stream()
.sorted(Map.Entry.comparingByKey())
.forEach(entry -> uriBuilder.addQueryParameter(entry.getKey(), entry.getValue().toString()));
}
}
}