Knock.Objects (Knock v0.4.18)

View Source

Knock resources for accessing Objects

Summary

Types

An object reference is how we refer to a particular object in a collection

Functions

Adds subscriptions for all recipients passed as arguments

Builds an object reference, which can be used in workflow trigger calls.

Creates a bulk operation to create subscriptions for a set of recipients to a set of objects within the given collection.

Bulk deletes one or more objects in a collection.

Bulk upserts one or more objects in a collection.

Deletes the given object.

Delete subscriptions for recipients passed as arguments

Gets the given object.

Returns all of the users preference sets

Returns channel data for the given channel id.

Returns paginated messages for the given object

Returns the preference set for the user.

Returns paginated schedules for the given object

Returns paginated subscriptions for the given object as recipient

Returns paginated list of objects for a collection

Returns paginated subscriptions for the given object

Upserts the given object in the collection with the attrs provided.

Upserts channel data for the given channel id.

Sets an entire preference set for the user. Will overwrite any existing data.

Unsets the channel data for the given channel id.

Types

ref()

@type ref() :: %{id: :string, collection: :string}

An object reference is how we refer to a particular object in a collection

Functions

add_subscriptions(client, collection, id, params)

@spec add_subscriptions(Knock.Client.t(), String.t(), String.t(), map()) ::
  Knock.Api.response()

Adds subscriptions for all recipients passed as arguments

Expected properties:

  • recipients: list of recipients to create subscriptions for
  • properties: data to be stored at the subscription level for each recipient

build_ref(collection, id)

@spec build_ref(String.t(), String.t()) :: ref()

Builds an object reference, which can be used in workflow trigger calls.

bulk_add_subscriptions(client, collection, subscriptions)

@spec bulk_add_subscriptions(Knock.Client.t(), String.t(), [map()]) ::
  Knock.Api.response()

Creates a bulk operation to create subscriptions for a set of recipients to a set of objects within the given collection.

Each entry in the provided subscriptions list should have the properties:

  • id: the id of an object for subscribing
  • recipients: a list of recipients to subscribe to the object
  • properties (optional): a map of properties to apply to each recipient subscription

bulk_delete(client, collection, object_ids)

@spec bulk_delete(Knock.Client.t(), String.t(), [String.t()]) :: Knock.Api.response()

Bulk deletes one or more objects in a collection.

bulk_set(client, collection, objects)

@spec bulk_set(Knock.Client.t(), String.t(), [map()]) :: Knock.Api.response()

Bulk upserts one or more objects in a collection.

delete(client, collection, id)

@spec delete(Knock.Client.t(), String.t(), String.t()) :: Knock.Api.response()

Deletes the given object.

delete_subscriptions(client, collection, id, params)

@spec delete_subscriptions(
  Knock.Client.t(),
  String.t(),
  String.t(),
  %{recipients: [String.t() | map()]}
) :: Knock.Api.response()

Delete subscriptions for recipients passed as arguments

Expected properties:

  • recipients: list of recipients to create subscriptions for

get(client, collection, id)

Gets the given object.

get_all_preferences(client, collection, id)

@spec get_all_preferences(Knock.Client.t(), String.t(), String.t()) ::
  Knock.Api.response()

Returns all of the users preference sets

get_channel_data(client, collection, id, channel_id)

@spec get_channel_data(Knock.Client.t(), String.t(), String.t(), String.t()) ::
  Knock.Api.response()

Returns channel data for the given channel id.

get_messages(client, collection, id, options \\ [])

@spec get_messages(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated messages for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- status: list of statuses to filter messages with

- tenant: tenant_id to filter messages with

- channel_id: channel_id to filter messages with

- source: workflow key to filter messages with

- trigger_data: trigger payload to filter messages with

get_preferences(client, collection, id, options \\ [])

@spec get_preferences(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns the preference set for the user.

get_schedules(client, collection, id, options \\ [])

@spec get_schedules(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated schedules for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- tenant: tenant_id to filter messages with

- workflow: workflow key to filter messages with

get_subscriptions(client, collection, id, options \\ [])

@spec get_subscriptions(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated subscriptions for the given object as recipient

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

list(client, collection, options \\ [])

Returns paginated list of objects for a collection

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

list_subscriptions(client, collection, id, options \\ [])

@spec list_subscriptions(Knock.Client.t(), String.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns paginated subscriptions for the given object

Available optional parameters:

#

- page_size: specify size of the page to be returned by the api. (max limit: 50)

- after: after cursor for pagination

- before: before cursor for pagination

- recipients: list of recipient identifiers to filter subscribers of the object

set(client, collection, id, attrs)

Upserts the given object in the collection with the attrs provided.

set_categories_preferences(client, collection, id, categories, options \\ [])

@spec set_categories_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  map(),
  Keyword.t()
) ::
  Knock.Api.response()

Sets the category preferences for the user.

set_category_preferences(client, collection, id, category_key, setting, options \\ [])

@spec set_category_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  map() | boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the category preference for the user.

set_channel_data(client, collection, id, channel_id, channel_data)

@spec set_channel_data(Knock.Client.t(), String.t(), String.t(), String.t(), map()) ::
  Knock.Api.response()

Upserts channel data for the given channel id.

set_channel_type_preferences(client, collection, id, channel_type, setting, options \\ [])

@spec set_channel_type_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the channel type preference for the user.

set_channel_types_preferences(client, collection, id, channel_types, options \\ [])

@spec set_channel_types_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  map(),
  Keyword.t()
) ::
  Knock.Api.response()

Sets the channel type preferences for the user.

set_preferences(client, collection, id, preferences, options \\ [])

@spec set_preferences(Knock.Client.t(), String.t(), String.t(), map(), Keyword.t()) ::
  Knock.Api.response()

Sets an entire preference set for the user. Will overwrite any existing data.

set_workflow_preferences(client, collection, id, workflow_key, setting, options \\ [])

@spec set_workflow_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  String.t(),
  map() | boolean(),
  Keyword.t()
) :: Knock.Api.response()

Sets the workflow preference for the user.

set_workflows_preferences(client, collection, id, workflows, options \\ [])

@spec set_workflows_preferences(
  Knock.Client.t(),
  String.t(),
  String.t(),
  map(),
  Keyword.t()
) ::
  Knock.Api.response()

Sets the workflow preferences for the user.

unset_channel_data(client, collection, id, channel_id)

@spec unset_channel_data(Knock.Client.t(), String.t(), String.t(), String.t()) ::
  Knock.Api.response()

Unsets the channel data for the given channel id.