Class: Telnyx::Resources::Queues

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/queues.rb,
lib/telnyx/resources/queues/calls.rb

Overview

Queue commands operations

Defined Under Namespace

Classes: Calls

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Queues

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

Parameters:



128
129
130
131
 
# File 'lib/telnyx/resources/queues.rb', line 128

def initialize(client:)
  @client = client
  @calls = Telnyx::Resources::Queues::Calls.new(client: client)
end

Instance Attribute Details

#calls ⇒ Telnyx::Resources::Queues::Calls (readonly)

Queue commands operations

Returns:



9
10
11
 
# File 'lib/telnyx/resources/queues.rb', line 9

def calls
  @calls
end

Instance Method Details

#create(queue_name:, max_size: nil, request_options: {}) ⇒ Telnyx::Models::QueueCreateResponse

Create a new call queue.

Parameters:

  • queue_name (String) —

    The name of the queue. Must be between 1 and 255 characters.

  • max_size (Integer) —

    The maximum number of calls allowed in the queue.

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

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/telnyx/resources/queues.rb', line 24

def create(params)
  parsed, options = Telnyx::QueueCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "queues",
    body: parsed,
    model: Telnyx::Models::QueueCreateResponse,
    options: options
  )
end

#delete(queue_name, request_options: {}) ⇒ nil

Delete an existing call queue.

Parameters:

  • queue_name (String) —

    Uniquely identifies the queue by name

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

Returns:

  • (nil)

See Also:



116
117
118
119
120
121
122
123
 
# File 'lib/telnyx/resources/queues.rb', line 116

def delete(queue_name, params = {})
  @client.request(
    method: :delete,
    path: ["queues/%1$s", queue_name],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::Queue>

List all queues for the authenticated user.

Parameters:

  • page_number (Integer) —

    The page number to load

  • page_size (Integer) —

    The size of the page

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

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/telnyx/resources/queues.rb', line 92

def list(params = {})
  parsed, options = Telnyx::QueueListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "queues",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Queue,
    options: options
  )
end

#retrieve(queue_name, request_options: {}) ⇒ Telnyx::Models::QueueRetrieveResponse

Retrieve an existing call queue

Parameters:

  • queue_name (String) —

    Uniquely identifies the queue by name

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

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/telnyx/resources/queues.rb', line 46

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

#update(queue_name, max_size:, request_options: {}) ⇒ Telnyx::Models::QueueUpdateResponse

Update properties of an existing call queue.

Parameters:

  • queue_name (String) —

    Uniquely identifies the queue by name

  • max_size (Integer) —

    The maximum number of calls allowed in the queue.

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

Returns:

See Also:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/queues.rb', line 68

def update(queue_name, params)
  parsed, options = Telnyx::QueueUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["queues/%1$s", queue_name],
    body: parsed,
    model: Telnyx::Models::QueueUpdateResponse,
    options: options
  )
end