Class: Telnyx::Resources::Texml::Accounts::Queues

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/texml/accounts/queues.rb,
sig/telnyx/resources/texml/accounts/queues.rbs

Overview

TeXML REST Commands

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:



169
170
171
 
# File 'lib/telnyx/resources/texml/accounts/queues.rb', line 169

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account_sid, friendly_name: nil, max_size: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::QueueResource

Creates a new queue resource for the account with the provided settings and returns it.

Parameters:

  • account_sid (String) —

    The id of the account the resource belongs to.

  • friendly_name (String) —

    A human readable name for the queue.

  • max_size (Integer) —

    The maximum size of the queue.

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

Returns:

See Also:



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

def create(, params = {})
  parsed, options = Telnyx::Texml::Accounts::QueueCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["texml/Accounts/%1$s/Queues", ],
    headers: {"content-type" => "application/x-www-form-urlencoded"},
    body: parsed,
    model: Telnyx::Texml::Accounts::QueueResource,
    options: options
  )
end

#delete(queue_sid, account_sid:, request_options: {}) ⇒ nil

Permanently deletes the specified queue resource from the account.

Parameters:

  • queue_sid (String) —

    The QueueSid that identifies the call queue.

  • account_sid (String) —

    The id of the account the resource belongs to.

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

Returns:

  • (nil)

See Also:



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/telnyx/resources/texml/accounts/queues.rb', line 152

def delete(queue_sid, params)
  parsed, options = Telnyx::Texml::Accounts::QueueDeleteParams.dump_request(params)
   =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["texml/Accounts/%1$s/Queues/%2$s", , queue_sid],
    model: NilClass,
    options: options
  )
end

#list(account_sid, date_created: nil, date_updated: nil, page: nil, page_size: nil, page_token: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultPaginationForQueues<Telnyx::Models::Texml::Accounts::QueueResource>

Some parameter documentations has been truncated, see Models::Texml::Accounts::QueueListParams for more details.

Returns a paginated list of queue resources for the account, with support for filtering by creation or update dates.

Parameters:

  • account_sid (String) —

    The id of the account the resource belongs to.

  • date_created (String) —

    Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also ac

  • date_updated (String) —

    Filters conferences by the time they were last updated. Expected format is YYYY-

  • page (Integer) —

    The number of the page to be displayed, zero-indexed, should be used in conjucti

  • page_size (Integer) —

    The number of records to be displayed on a page

  • page_token (String) —

    Used to request the next page of results.

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

Returns:

See Also:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/telnyx/resources/texml/accounts/queues.rb', line 120

def list(, params = {})
  parsed, options = Telnyx::Texml::Accounts::QueueListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["texml/Accounts/%1$s/Queues", ],
    query: query.transform_keys(
      date_created: "DateCreated",
      date_updated: "DateUpdated",
      page: "Page",
      page_size: "PageSize",
      page_token: "PageToken"
    ),
    page: Telnyx::Internal::DefaultPaginationForQueues,
    model: Telnyx::Texml::Accounts::QueueResource,
    options: options
  )
end

#retrieve(queue_sid, account_sid:, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::QueueResource

Returns a single queue resource for the account by its QueueSid.

Parameters:

  • queue_sid (String) —

    The QueueSid that identifies the call queue.

  • account_sid (String) —

    The id of the account the resource belongs to.

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

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/telnyx/resources/texml/accounts/queues.rb', line 50

def retrieve(queue_sid, params)
  parsed, options = Telnyx::Texml::Accounts::QueueRetrieveParams.dump_request(params)
   =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["texml/Accounts/%1$s/Queues/%2$s", , queue_sid],
    model: Telnyx::Texml::Accounts::QueueResource,
    options: options
  )
end

#update(queue_sid, account_sid:, max_size: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::QueueResource

Updates the specified queue resource's settings and returns the updated queue.

Parameters:

  • queue_sid (String) —

    Path param: The QueueSid that identifies the call queue.

  • account_sid (String) —

    Path param: The id of the account the resource belongs to.

  • max_size (Integer) —

    Body param: The maximum size of the queue.

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

Returns:

See Also:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/telnyx/resources/texml/accounts/queues.rb', line 79

def update(queue_sid, params)
  parsed, options = Telnyx::Texml::Accounts::QueueUpdateParams.dump_request(params)
   =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["texml/Accounts/%1$s/Queues/%2$s", , queue_sid],
    headers: {"content-type" => "application/x-www-form-urlencoded"},
    body: parsed,
    model: Telnyx::Texml::Accounts::QueueResource,
    options: options
  )
end