Method: PureCloud::RoutingApi#patch_queues_queue_id_users_with_http_info

Defined in:
lib/purecloud/api/routing_api.rb

#patch_queues_queue_id_users_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMember, Fixnum, Hash)>

Join or unjoin a set of users for a queue

Parameters:

  • queue_id —

    Queue ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(QueueMember, Fixnum, Hash)>) —

    QueueMember data, response status code and response headers



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/purecloud/api/routing_api.rb', line 1543

def patch_queues_queue_id_users_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi#patch_queues_queue_id_users ..."
  end
  
  # verify the required parameter 'queue_id' is set
  fail "Missing the required parameter 'queue_id' when calling patch_queues_queue_id_users" if queue_id.nil?
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_queues_queue_id_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end