Constructor Detail

Method Detail

• withRawResponse

   abstract ObjectServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• bulk

   abstract BulkServiceAsync bulk()

• list

   CompletableFuture<ObjectListPageAsync> list(String collection)

  Returns a paginated list of objects from the specified collection. Optionally includes preference data for the objects.

• list

   CompletableFuture<ObjectListPageAsync> list(String collection, ObjectListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ObjectListPageAsync> list(String collection, ObjectListParams params)

• list

   abstract CompletableFuture<ObjectListPageAsync> list(ObjectListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ObjectListPageAsync> list(ObjectListParams params)

• list

   CompletableFuture<ObjectListPageAsync> list(String collection, RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(String collection, String id)

  Permanently removes an object from the specified collection. This operation cannot be undone.

• delete

   CompletableFuture<String> delete(String collection, String id, ObjectDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(String collection, String id, ObjectDeleteParams params)

• delete

   abstract CompletableFuture<String> delete(ObjectDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<String> delete(ObjectDeleteParams params)

• delete

   CompletableFuture<String> delete(String collection, String id, RequestOptions requestOptions)

• addSubscriptions

   CompletableFuture<List<Subscription>> addSubscriptions(String collection, String objectId, ObjectAddSubscriptionsParams params)

  Add subscriptions for an object. If a subscription already exists, it will be updated. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the recipient.

• addSubscriptions

   CompletableFuture<List<Subscription>> addSubscriptions(String collection, String objectId, ObjectAddSubscriptionsParams params, RequestOptions requestOptions)

• addSubscriptions

   CompletableFuture<List<Subscription>> addSubscriptions(ObjectAddSubscriptionsParams params)

• addSubscriptions

   abstract CompletableFuture<List<Subscription>> addSubscriptions(ObjectAddSubscriptionsParams params, RequestOptions requestOptions)

• deleteSubscriptions

   CompletableFuture<List<Subscription>> deleteSubscriptions(String collection, String objectId, ObjectDeleteSubscriptionsParams params)

  Delete subscriptions for the specified recipients from an object. Returns the list of deleted subscriptions.

• deleteSubscriptions

   CompletableFuture<List<Subscription>> deleteSubscriptions(String collection, String objectId, ObjectDeleteSubscriptionsParams params, RequestOptions requestOptions)

• deleteSubscriptions

   CompletableFuture<List<Subscription>> deleteSubscriptions(ObjectDeleteSubscriptionsParams params)

• deleteSubscriptions

   abstract CompletableFuture<List<Subscription>> deleteSubscriptions(ObjectDeleteSubscriptionsParams params, RequestOptions requestOptions)

• get

   CompletableFuture<Object> get(String collection, String id)

  Retrieves a specific object by its ID from the specified collection. Returns the object with all its properties.

• get

   CompletableFuture<Object> get(String collection, String id, ObjectGetParams params, RequestOptions requestOptions)

• get

   CompletableFuture<Object> get(String collection, String id, ObjectGetParams params)

• get

   abstract CompletableFuture<Object> get(ObjectGetParams params, RequestOptions requestOptions)

• get

   CompletableFuture<Object> get(ObjectGetParams params)

• get

   CompletableFuture<Object> get(String collection, String id, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String collection, String objectId, String channelId)

  Returns the channel data for the specified object and channel.

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String collection, String objectId, String channelId, ObjectGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String collection, String objectId, String channelId, ObjectGetChannelDataParams params)

• getChannelData

   abstract CompletableFuture<ChannelData> getChannelData(ObjectGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(ObjectGetChannelDataParams params)

• getChannelData

   CompletableFuture<ChannelData> getChannelData(String collection, String objectId, String channelId, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String collection, String objectId, String id)

  Returns the preference set for the specified object and preference set id.

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String collection, String objectId, String id, ObjectGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String collection, String objectId, String id, ObjectGetPreferencesParams params)

• getPreferences

   abstract CompletableFuture<PreferenceSet> getPreferences(ObjectGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(ObjectGetPreferencesParams params)

• getPreferences

   CompletableFuture<PreferenceSet> getPreferences(String collection, String objectId, String id, RequestOptions requestOptions)

• listMessages

   CompletableFuture<ObjectListMessagesPageAsync> listMessages(String collection, String id)

  Returns a paginated list of messages for a specific object in the given collection. Allows filtering by message status and provides various sorting options.

• listMessages

   CompletableFuture<ObjectListMessagesPageAsync> listMessages(String collection, String id, ObjectListMessagesParams params, RequestOptions requestOptions)

• listMessages

   CompletableFuture<ObjectListMessagesPageAsync> listMessages(String collection, String id, ObjectListMessagesParams params)

• listMessages

   abstract CompletableFuture<ObjectListMessagesPageAsync> listMessages(ObjectListMessagesParams params, RequestOptions requestOptions)

• listMessages

   CompletableFuture<ObjectListMessagesPageAsync> listMessages(ObjectListMessagesParams params)

• listMessages

   CompletableFuture<ObjectListMessagesPageAsync> listMessages(String collection, String id, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String collection, String objectId)

  Returns a paginated list of preference sets for the specified object.

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String collection, String objectId, ObjectListPreferencesParams params, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String collection, String objectId, ObjectListPreferencesParams params)

• listPreferences

   abstract CompletableFuture<List<PreferenceSet>> listPreferences(ObjectListPreferencesParams params, RequestOptions requestOptions)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(ObjectListPreferencesParams params)

• listPreferences

   CompletableFuture<List<PreferenceSet>> listPreferences(String collection, String objectId, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(String collection, String id)

  Returns a paginated list of schedules for an object.

• listSchedules

   CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(String collection, String id, ObjectListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(String collection, String id, ObjectListSchedulesParams params)

• listSchedules

   abstract CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(ObjectListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(ObjectListSchedulesParams params)

• listSchedules

   CompletableFuture<ObjectListSchedulesPageAsync> listSchedules(String collection, String id, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(String collection, String objectId)

  List subscriptions for an object. Either list the recipients that subscribe to the provided object, or list the objects that the provided object is subscribed to. Determined by the mode query parameter.

• listSubscriptions

   CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(String collection, String objectId, ObjectListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(String collection, String objectId, ObjectListSubscriptionsParams params)

• listSubscriptions

   abstract CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(ObjectListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(ObjectListSubscriptionsParams params)

• listSubscriptions

   CompletableFuture<ObjectListSubscriptionsPageAsync> listSubscriptions(String collection, String objectId, RequestOptions requestOptions)

• set

   CompletableFuture<Object> set(String collection, String id)

  Creates a new object or updates an existing one in the specified collection. This operation is used to identify objects with their properties, as well as optional preferences and channel data.

• set

   CompletableFuture<Object> set(String collection, String id, ObjectSetParams params, RequestOptions requestOptions)

• set

   CompletableFuture<Object> set(String collection, String id, ObjectSetParams params)

• set

   abstract CompletableFuture<Object> set(ObjectSetParams params, RequestOptions requestOptions)

• set

   CompletableFuture<Object> set(ObjectSetParams params)

• set

   CompletableFuture<Object> set(String collection, String id, RequestOptions requestOptions)

• setChannelData

   CompletableFuture<ChannelData> setChannelData(String collection, String objectId, String channelId, ObjectSetChannelDataParams params)

  Sets the channel data for the specified object and channel. If no object exists in the current environment for the given collection and object_id, Knock will create the object as part of this request.

• setChannelData

   CompletableFuture<ChannelData> setChannelData(String collection, String objectId, String channelId, ObjectSetChannelDataParams params, RequestOptions requestOptions)

• setChannelData

   CompletableFuture<ChannelData> setChannelData(ObjectSetChannelDataParams params)

• setChannelData

   abstract CompletableFuture<ChannelData> setChannelData(ObjectSetChannelDataParams params, RequestOptions requestOptions)

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(String collection, String objectId, String id, ObjectSetPreferencesParams params)

  Sets preferences within the given preference set. This is a destructive operation and will replace any existing preferences with the preferences given. If no object exists in the current environment for the given :collection and :object_id, Knock will create the object as part of this request. The preference set :id can be either default or a tenant.id. Learn more about /preferences/tenant-preferences.

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(String collection, String objectId, String id, ObjectSetPreferencesParams params, RequestOptions requestOptions)

• setPreferences

   CompletableFuture<PreferenceSet> setPreferences(ObjectSetPreferencesParams params)

• setPreferences

   abstract CompletableFuture<PreferenceSet> setPreferences(ObjectSetPreferencesParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String collection, String objectId, String channelId)

  Unsets the channel data for the specified object and channel.

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String collection, String objectId, String channelId, ObjectUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String collection, String objectId, String channelId, ObjectUnsetChannelDataParams params)

• unsetChannelData

   abstract CompletableFuture<String> unsetChannelData(ObjectUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(ObjectUnsetChannelDataParams params)

• unsetChannelData

   CompletableFuture<String> unsetChannelData(String collection, String objectId, String channelId, RequestOptions requestOptions)