Class: ModerationAPI::Resources::Queue

Inherits:
Object
  • Object
show all
Defined in:
lib/moderation_api/resources/queue.rb,
lib/moderation_api/resources/queue/items.rb

Defined Under Namespace

Classes: Items

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Queue

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 Queue.

Parameters:



58
59
60
61
 
# File 'lib/moderation_api/resources/queue.rb', line 58

def initialize(client:)
  @client = client
  @items = ModerationAPI::Resources::Queue::Items.new(client: client)
end

Instance Attribute Details

#items ⇒ ModerationAPI::Resources::Queue::Items (readonly)

Returns:



7
8
9
 
# File 'lib/moderation_api/resources/queue.rb', line 7

def items
  @items
end

Instance Method Details

#get_stats(id, within_days: nil, request_options: {}) ⇒ ModerationAPI::Models::QueueGetStatsResponse

Get detailed statistics about a moderation queue including review times, action counts, and trends

Parameters:

  • id (String) —

    The queue ID

  • within_days (String) —

    Number of days to analyze statistics for

  • request_options (ModerationAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/moderation_api/resources/queue.rb', line 43

def get_stats(id, params = {})
  parsed, options = ModerationAPI::QueueGetStatsParams.dump_request(params)
  query = ModerationAPI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["queue/%1$s/stats", id],
    query: query.transform_keys(within_days: "withinDays"),
    model: ModerationAPI::Models::QueueGetStatsResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModerationAPI::Models::QueueRetrieveResponse

Get a queue

Parameters:

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/moderation_api/resources/queue.rb', line 20

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["queue/%1$s", id],
    model: ModerationAPI::Models::QueueRetrieveResponse,
    options: params[:request_options]
  )
end