Module: Knock::Messages

Extended by:
Base, Client
Defined in:
lib/knock/messages.rb

Overview

Methods for interacting with messages in Knock

Instance Attribute Summary

Attributes included from Base

#key

Class Method Summary collapse

Methods included from Client

client, delete_request, execute_request, get_request, handle_error_response, post_request, put_request, user_agent

Class Method Details

.get(id:) ⇒ Hash

Retrieves a Message

Parameters:

  • id (String) —

    The message id

Returns:

  • (Hash) —

    The Message



31
32
33
34
35
36
37
38
 
# File 'lib/knock/messages.rb', line 31

def get(id:)
  request = get_request(
    auth: true,
    path: "/v1/messages/#{id}"
  )

  execute_request(request: request)
end

.get_activities(id:, options: {}) ⇒ Hash

Get a Message's activities

Parameters:

  • id (String) —

    The message id

  • options (Hash) (defaults to: {}) —

    Options to pass to the paginated activities endpoint query

Returns:

  • (Hash) —

    Paginated Message's activities



60
61
62
63
64
65
66
67
68
 
# File 'lib/knock/messages.rb', line 60

def get_activities(id:, options: {})
  request = get_request(
    auth: true,
    path: "/v1/messages/#{id}/activities",
    params: options
  )

  execute_request(request: request)
end

.get_content(id:) ⇒ Hash

Get a Message's content

Parameters:

  • id (String) —

    The message id

Returns:

  • (Hash) —

    The Message content



45
46
47
48
49
50
51
52
 
# File 'lib/knock/messages.rb', line 45

def get_content(id:)
  request = get_request(
    auth: true,
    path: "/v1/messages/#{id}/content"
  )

  execute_request(request: request)
end

.get_events(id:, options: {}) ⇒ Hash

Get a Message's events

Parameters:

  • id (String) —

    The message id

  • options (Hash) (defaults to: {}) —

    Options to pass to the paginated events endpoint query

Returns:

  • (Hash) —

    Paginated Message's events



76
77
78
79
80
81
82
83
84
 
# File 'lib/knock/messages.rb', line 76

def get_events(id:, options: {})
  request = get_request(
    auth: true,
    path: "/v1/messages/#{id}/events",
    params: options
  )

  execute_request(request: request)
end

.list(options: {}) ⇒ Hash

Retrieves a paginated list of messages for the provided environment

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to the messages endpoint query

Returns:

  • (Hash) —

    Paginated list of Message records



16
17
18
19
20
21
22
23
24
 
# File 'lib/knock/messages.rb', line 16

def list(options: {})
  request = get_request(
    auth: true,
    path: "/v1/messages",
    params: options
  )

  execute_request(request: request)
end