Class: Knockapi::Resources::Audiences

Inherits:
Object
  • Object
show all
Defined in:
lib/knockapi/resources/audiences.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Audiences

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Audiences.

Parameters:



77
78
79
 
# File 'lib/knockapi/resources/audiences.rb', line 77

def initialize(client:)
  @client = client
end

Instance Method Details

#add_members(key, members:, request_options: {}) ⇒ nil

Adds one or more members to the specified audience.

Parameters:

Returns:

  • (nil)

See Also:



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/knockapi/resources/audiences.rb', line 19

def add_members(key, params)
  parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/audiences/%1$s/members", key],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#list_members(key, request_options: {}) ⇒ Knockapi::Models::AudienceListMembersResponse

Returns a paginated list of members for the specified audience.

Parameters:

Returns:

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/knockapi/resources/audiences.rb', line 41

def list_members(key, params = {})
  @client.request(
    method: :get,
    path: ["v1/audiences/%1$s/members", key],
    model: Knockapi::Models::AudienceListMembersResponse,
    options: params[:request_options]
  )
end

#remove_members(key, members:, request_options: {}) ⇒ nil

Removes one or more members from the specified audience.

Parameters:

Returns:

  • (nil)

See Also:



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/knockapi/resources/audiences.rb', line 63

def remove_members(key, params)
  parsed, options = Knockapi::AudienceRemoveMembersParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["v1/audiences/%1$s/members", key],
    body: parsed,
    model: NilClass,
    options: options
  )
end