Constructor Detail

Method Detail

• withRawResponse

   abstract ObjectService.WithRawResponse withRawResponse()

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

• bulk

   abstract BulkService bulk()

• list

   ObjectListPage list(String collection)

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

• list

   ObjectListPage list(String collection, ObjectListParams params, RequestOptions requestOptions)

• list

   ObjectListPage list(String collection, ObjectListParams params)

• list

   abstract ObjectListPage list(ObjectListParams params, RequestOptions requestOptions)

• list

   ObjectListPage list(ObjectListParams params)

• list

   ObjectListPage list(String collection, RequestOptions requestOptions)

• delete

   String delete(String collection, String id)

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

• delete

   String delete(String collection, String id, ObjectDeleteParams params, RequestOptions requestOptions)

• delete

   String delete(String collection, String id, ObjectDeleteParams params)

• delete

   abstract String delete(ObjectDeleteParams params, RequestOptions requestOptions)

• delete

   String delete(ObjectDeleteParams params)

• delete

   String delete(String collection, String id, RequestOptions requestOptions)

• addSubscriptions

   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

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

• addSubscriptions

   List<Subscription> addSubscriptions(ObjectAddSubscriptionsParams params)

• addSubscriptions

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

• deleteSubscriptions

   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

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

• deleteSubscriptions

   List<Subscription> deleteSubscriptions(ObjectDeleteSubscriptionsParams params)

• deleteSubscriptions

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

• get

   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

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

• get

   Object get(String collection, String id, ObjectGetParams params)

• get

   abstract Object get(ObjectGetParams params, RequestOptions requestOptions)

• get

   Object get(ObjectGetParams params)

• get

   Object get(String collection, String id, RequestOptions requestOptions)

• getChannelData

   ChannelData getChannelData(String collection, String objectId, String channelId)

  Returns the channel data for the specified object and channel.

• getChannelData

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

• getChannelData

   ChannelData getChannelData(String collection, String objectId, String channelId, ObjectGetChannelDataParams params)

• getChannelData

   abstract ChannelData getChannelData(ObjectGetChannelDataParams params, RequestOptions requestOptions)

• getChannelData

   ChannelData getChannelData(ObjectGetChannelDataParams params)

• getChannelData

   ChannelData getChannelData(String collection, String objectId, String channelId, RequestOptions requestOptions)

• getPreferences

   PreferenceSet getPreferences(String collection, String objectId, String id)

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

• getPreferences

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

• getPreferences

   PreferenceSet getPreferences(String collection, String objectId, String id, ObjectGetPreferencesParams params)

• getPreferences

   abstract PreferenceSet getPreferences(ObjectGetPreferencesParams params, RequestOptions requestOptions)

• getPreferences

   PreferenceSet getPreferences(ObjectGetPreferencesParams params)

• getPreferences

   PreferenceSet getPreferences(String collection, String objectId, String id, RequestOptions requestOptions)

• listMessages

   ObjectListMessagesPage 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

   ObjectListMessagesPage listMessages(String collection, String id, ObjectListMessagesParams params, RequestOptions requestOptions)

• listMessages

   ObjectListMessagesPage listMessages(String collection, String id, ObjectListMessagesParams params)

• listMessages

   abstract ObjectListMessagesPage listMessages(ObjectListMessagesParams params, RequestOptions requestOptions)

• listMessages

   ObjectListMessagesPage listMessages(ObjectListMessagesParams params)

• listMessages

   ObjectListMessagesPage listMessages(String collection, String id, RequestOptions requestOptions)

• listPreferences

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

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

• listPreferences

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

• listPreferences

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

• listPreferences

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

• listPreferences

   List<PreferenceSet> listPreferences(ObjectListPreferencesParams params)

• listPreferences

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

• listSchedules

   ObjectListSchedulesPage listSchedules(String collection, String id)

  Returns a paginated list of schedules for an object.

• listSchedules

   ObjectListSchedulesPage listSchedules(String collection, String id, ObjectListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   ObjectListSchedulesPage listSchedules(String collection, String id, ObjectListSchedulesParams params)

• listSchedules

   abstract ObjectListSchedulesPage listSchedules(ObjectListSchedulesParams params, RequestOptions requestOptions)

• listSchedules

   ObjectListSchedulesPage listSchedules(ObjectListSchedulesParams params)

• listSchedules

   ObjectListSchedulesPage listSchedules(String collection, String id, RequestOptions requestOptions)

• listSubscriptions

   ObjectListSubscriptionsPage 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

   ObjectListSubscriptionsPage listSubscriptions(String collection, String objectId, ObjectListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   ObjectListSubscriptionsPage listSubscriptions(String collection, String objectId, ObjectListSubscriptionsParams params)

• listSubscriptions

   abstract ObjectListSubscriptionsPage listSubscriptions(ObjectListSubscriptionsParams params, RequestOptions requestOptions)

• listSubscriptions

   ObjectListSubscriptionsPage listSubscriptions(ObjectListSubscriptionsParams params)

• listSubscriptions

   ObjectListSubscriptionsPage listSubscriptions(String collection, String objectId, RequestOptions requestOptions)

• set

   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

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

• set

   Object set(String collection, String id, ObjectSetParams params)

• set

   abstract Object set(ObjectSetParams params, RequestOptions requestOptions)

• set

   Object set(ObjectSetParams params)

• set

   Object set(String collection, String id, RequestOptions requestOptions)

• setChannelData

   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

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

• setChannelData

   ChannelData setChannelData(ObjectSetChannelDataParams params)

• setChannelData

   abstract ChannelData setChannelData(ObjectSetChannelDataParams params, RequestOptions requestOptions)

• setPreferences

   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

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

• setPreferences

   PreferenceSet setPreferences(ObjectSetPreferencesParams params)

• setPreferences

   abstract PreferenceSet setPreferences(ObjectSetPreferencesParams params, RequestOptions requestOptions)

• unsetChannelData

   String unsetChannelData(String collection, String objectId, String channelId)

  Unsets the channel data for the specified object and channel.

• unsetChannelData

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

• unsetChannelData

   String unsetChannelData(String collection, String objectId, String channelId, ObjectUnsetChannelDataParams params)

• unsetChannelData

   abstract String unsetChannelData(ObjectUnsetChannelDataParams params, RequestOptions requestOptions)

• unsetChannelData

   String unsetChannelData(ObjectUnsetChannelDataParams params)

• unsetChannelData

   String unsetChannelData(String collection, String objectId, String channelId, RequestOptions requestOptions)