purecloud 0.49.1 → 0.50.1

data/lib/purecloud/api/routing_api.rb

@@ -947,6 +947,336 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get recent conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @return [CallConversationEntityListing]
+    def get_queues_queue_id_conversations(queue_id, opts = {})
+      data, status_code, headers = get_queues_queue_id_conversations_with_http_info(queue_id, opts)
+      return data
+    end
+
+    # Get recent conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(CallConversationEntityListing, Fixnum, Hash)>] CallConversationEntityListing data, response status code and response headers
+    def get_queues_queue_id_conversations_with_http_info(queue_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations ..."
+      end
+      
+      # verify the required parameter 'queue_id' is set
+      fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations" if queue_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/routing/queues/{queueId}/conversations".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CallConversationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get recent callback conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @return [CallbackConversationEntityListing]
+    def get_queues_queue_id_conversations_callbacks(queue_id, opts = {})
+      data, status_code, headers = get_queues_queue_id_conversations_callbacks_with_http_info(queue_id, opts)
+      return data
+    end
+
+    # Get recent callback conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(CallbackConversationEntityListing, Fixnum, Hash)>] CallbackConversationEntityListing data, response status code and response headers
+    def get_queues_queue_id_conversations_callbacks_with_http_info(queue_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_callbacks ..."
+      end
+      
+      # verify the required parameter 'queue_id' is set
+      fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_callbacks" if queue_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/routing/queues/{queueId}/conversations/callbacks".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CallbackConversationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_callbacks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get recent call conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @return [CallConversationEntityListing]
+    def get_queues_queue_id_conversations_calls(queue_id, opts = {})
+      data, status_code, headers = get_queues_queue_id_conversations_calls_with_http_info(queue_id, opts)
+      return data
+    end
+
+    # Get recent call conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(CallConversationEntityListing, Fixnum, Hash)>] CallConversationEntityListing data, response status code and response headers
+    def get_queues_queue_id_conversations_calls_with_http_info(queue_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_calls ..."
+      end
+      
+      # verify the required parameter 'queue_id' is set
+      fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_calls" if queue_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/routing/queues/{queueId}/conversations/calls".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CallConversationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get recent chat conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @return [ChatConversationEntityListing]
+    def get_queues_queue_id_conversations_chats(queue_id, opts = {})
+      data, status_code, headers = get_queues_queue_id_conversations_chats_with_http_info(queue_id, opts)
+      return data
+    end
+
+    # Get recent chat conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(ChatConversationEntityListing, Fixnum, Hash)>] ChatConversationEntityListing data, response status code and response headers
+    def get_queues_queue_id_conversations_chats_with_http_info(queue_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_chats ..."
+      end
+      
+      # verify the required parameter 'queue_id' is set
+      fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_chats" if queue_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/routing/queues/{queueId}/conversations/chats".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ChatConversationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_chats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get recent email conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @return [EmailConversationEntityListing]
+    def get_queues_queue_id_conversations_emails(queue_id, opts = {})
+      data, status_code, headers = get_queues_queue_id_conversations_emails_with_http_info(queue_id, opts)
+      return data
+    end
+
+    # Get recent email conversations that are still active
+    # 
+    # @param queue_id Queue ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(EmailConversationEntityListing, Fixnum, Hash)>] EmailConversationEntityListing data, response status code and response headers
+    def get_queues_queue_id_conversations_emails_with_http_info(queue_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi#get_queues_queue_id_conversations_emails ..."
+      end
+      
+      # verify the required parameter 'queue_id' is set
+      fail "Missing the required parameter 'queue_id' when calling get_queues_queue_id_conversations_emails" if queue_id.nil?
+      
+      # resource path
+      local_var_path = "/api/v2/routing/queues/{queueId}/conversations/emails".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'EmailConversationEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_queues_queue_id_conversations_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Estimated Wait Time
     # 
     # @param queue_id queueId

data/lib/purecloud/api/telephony_providers_edge_api.rb

@@ -1500,6 +1500,7 @@ module PureCloud
     # Retrieve a list of all configured logical interfaces from a specific edge.
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Field to expand in the response
     # @return [LogicalInterfaceEntityListing]
     def get_providers_edges_edge_id_logicalinterfaces(edge_id, opts = {})
       data, status_code, headers = get_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts)
@@ -1510,6 +1511,7 @@ module PureCloud
     # Retrieve a list of all configured logical interfaces from a specific edge.
     # @param edge_id Edge ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Field to expand in the response
     # @return [Array<(LogicalInterfaceEntityListing, Fixnum, Hash)>] LogicalInterfaceEntityListing data, response status code and response headers
     def get_providers_edges_edge_id_logicalinterfaces_with_http_info(edge_id, opts = {})
       if @api_client.config.debugging
@@ -1524,6 +1526,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
       header_params = {}
@@ -1561,6 +1564,7 @@ module PureCloud
     # @param edge_id Edge ID
     # @param interface_id Interface ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Field to expand in the response
     # @return [DomainLogicalInterface]
     def get_providers_edges_edge_id_logicalinterfaces_interface_id(edge_id, interface_id, opts = {})
       data, status_code, headers = get_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts)
@@ -1572,6 +1576,7 @@ module PureCloud
     # @param edge_id Edge ID
     # @param interface_id Interface ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Field to expand in the response
     # @return [Array<(DomainLogicalInterface, Fixnum, Hash)>] DomainLogicalInterface data, response status code and response headers
     def get_providers_edges_edge_id_logicalinterfaces_interface_id_with_http_info(edge_id, interface_id, opts = {})
       if @api_client.config.debugging
@@ -1589,6 +1594,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
       header_params = {}
@@ -2002,6 +2008,7 @@ module PureCloud
     # 
     # @param edge_group_id Edge group ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Fields to expand in the response
     # @return [EdgeGroup]
     def get_providers_edges_edgegroups_edgegroup_id(edge_group_id, opts = {})
       data, status_code, headers = get_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts)
@@ -2012,6 +2019,7 @@ module PureCloud
     # 
     # @param edge_group_id Edge group ID
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand Fields to expand in the response
     # @return [Array<(EdgeGroup, Fixnum, Hash)>] EdgeGroup data, response status code and response headers
     def get_providers_edges_edgegroups_edgegroup_id_with_http_info(edge_group_id, opts = {})
       if @api_client.config.debugging
@@ -2026,6 +2034,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
       header_params = {}
@@ -3205,6 +3214,7 @@ module PureCloud
     # @option opts [String] :web_rtc_user_id Filter by webRtcUser.id
     # @option opts [String] :phone_base_settings_id Filter by phoneBaseSettings.id
     # @option opts [String] :lines_logged_in_user_id Filter by lines.loggedInUser.id
+    # @option opts [String] :lines_default_for_user_id Filter by lines.defaultForUser.id
     # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
     # @option opts [String] :lines_id Filter by lines.id
     # @option opts [String] :lines_name Filter by lines.name
@@ -3227,6 +3237,7 @@ module PureCloud
     # @option opts [String] :web_rtc_user_id Filter by webRtcUser.id
     # @option opts [String] :phone_base_settings_id Filter by phoneBaseSettings.id
     # @option opts [String] :lines_logged_in_user_id Filter by lines.loggedInUser.id
+    # @option opts [String] :lines_default_for_user_id Filter by lines.defaultForUser.id
     # @option opts [String] :phone_hardware_id Filter by phone_hardwareId
     # @option opts [String] :lines_id Filter by lines.id
     # @option opts [String] :lines_name Filter by lines.name
@@ -3251,6 +3262,7 @@ module PureCloud
       query_params[:'webRtcUser.id'] = opts[:'web_rtc_user_id'] if opts[:'web_rtc_user_id']
       query_params[:'phoneBaseSettings.id'] = opts[:'phone_base_settings_id'] if opts[:'phone_base_settings_id']
       query_params[:'lines.loggedInUser.id'] = opts[:'lines_logged_in_user_id'] if opts[:'lines_logged_in_user_id']
+      query_params[:'lines.defaultForUser.id'] = opts[:'lines_default_for_user_id'] if opts[:'lines_default_for_user_id']
       query_params[:'phone_hardwareId'] = opts[:'phone_hardware_id'] if opts[:'phone_hardware_id']
       query_params[:'lines.id'] = opts[:'lines_id'] if opts[:'lines_id']
       query_params[:'lines.name'] = opts[:'lines_name'] if opts[:'lines_name']

data/lib/purecloud/api/users_api.rb

@@ -702,6 +702,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [BOOLEAN] :joined Is joined to the queue (default to true)
     # @return [UserQueueEntityListing]
     def get_user_id_queues(user_id, opts = {})
       data, status_code, headers = get_user_id_queues_with_http_info(user_id, opts)
@@ -714,6 +715,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
+    # @option opts [BOOLEAN] :joined Is joined to the queue
     # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
     def get_user_id_queues_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
@@ -730,6 +732,7 @@ module PureCloud
       query_params = {}
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
 
       # header parameters
       header_params = {}

data/lib/purecloud/api_client.rb

@@ -33,7 +33,7 @@ module PureCloud
 
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "PureCloud SDK/Ruby 0.49.1"
+      @user_agent = "PureCloud SDK/Ruby 0.50.1"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent