Knock.Messages (Knock v0.4.5) View Source

Knock resources for accessing messages

Link to this section Summary

Functions

Returns information about the message.

Returns a paginated response with message's activities.

Returns information about the message content.

Returns a paginated response with message's events.

Returns paginated messages for the provided environment

Link to this section Functions

Specs

Returns information about the message.

Link to this function

get_activities(client, message_id, options \\ [])

View Source

Specs

get_activities(Knock.Client.t(), String.t(), Keyword.t()) ::
  Knock.Api.response()

Returns a paginated response with message's activities.

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

Link to this function

get_content(client, message_id)

View Source

Specs

get_content(Knock.Client.t(), String.t()) :: Knock.Api.response()

Returns information about the message content.

Link to this function

get_events(client, message_id, options \\ [])

View Source

Specs

Returns a paginated response with message's events.

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

Link to this function

list(client, options \\ [])

View Source

Specs

Returns paginated messages for the provided environment

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