Class: Knockapi::Resources::Audiences

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

Overview

An Audience is a segment of users.

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:



89
90
91
 
# File 'lib/knockapi/resources/audiences.rb', line 89

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::AudienceAddMembersParams for more details.

Adds one or more members to the specified audience.

Parameters:

Returns:

  • (nil)

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/knockapi/resources/audiences.rb', line 25

def add_members(key, params)
  query_params = [:create_audience]
  parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
  query = Knockapi::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: ["v1/audiences/%1$s/members", key],
    query: query,
    body: parsed.except(*query_params),
    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:



50
51
52
53
54
55
56
57
 
# File 'lib/knockapi/resources/audiences.rb', line 50

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

Some parameter documentations has been truncated, see Models::AudienceRemoveMembersParams for more details.

Removes one or more members from the specified audience.

Parameters:

Returns:

  • (nil)

See Also:



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/knockapi/resources/audiences.rb', line 75

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