purecloudplatformclientv2 73.0.0 → 75.0.0

data/lib/purecloudplatformclientv2/api/quality_api.rb

@@ -909,7 +909,7 @@ module PureCloud
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [String] :recording_id id of the recording
-    # @option opts [String] :entity_type entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording (default to RECORDING)
+    # @option opts [String] :entity_type entity type options: Recording, Calibration, Evaluation, Annotation, Screen_Recording (default to Recording)
     # @return [QualityAuditPage]
     def get_quality_conversation_audits(conversation_id, opts = {})
       data, _status_code, _headers = get_quality_conversation_audits_with_http_info(conversation_id, opts)

data/lib/purecloudplatformclientv2/api/routing_api.rb

@@ -511,7 +511,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Delete utilization settings and revert to system defaults.
+    # Delete the organization-wide max utilization settings and revert to the system default.
     # 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -520,7 +520,7 @@ module PureCloud
       return nil
     end
 
-    # Delete utilization settings and revert to system defaults.
+    # Delete the organization-wide max utilization settings and revert to the system default.
     # 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -2977,7 +2977,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get the utilization settings.
+    # Get the organization-wide max utilization settings.
     # 
     # @param [Hash] opts the optional parameters
     # @return [Utilization]
@@ -2986,7 +2986,7 @@ module PureCloud
       return data
     end
 
-    # Get the utilization settings.
+    # Get the organization-wide max utilization settings.
     # 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers
@@ -3192,6 +3192,107 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get queues for user
+    # 
+    # @param user_id User 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)
+    # @option opts [BOOLEAN] :joined Is joined to the queue (default to true)
+    # @option opts [Array<String>] :division_id Division ID(s)
+    # @return [UserQueueEntityListing]
+    def get_user_queues(user_id, opts = {})
+      data, _status_code, _headers = get_user_queues_with_http_info(user_id, opts)
+      return data
+    end
+
+    # Get queues for user
+    # 
+    # @param user_id User ID
+    # @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
+    # @option opts [Array<String>] :division_id Division ID(s)
+    # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
+    def get_user_queues_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.get_user_queues ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_user_queues" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_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']
+      query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
+      query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud OAuth']
+      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 => 'UserQueueEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#get_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List routing language for user
     # 
     # @param user_id User ID
@@ -3608,6 +3709,175 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Join or unjoin a queue for a user
+    # 
+    # @param queue_id Queue ID
+    # @param user_id User ID
+    # @param body Queue Member
+    # @param [Hash] opts the optional parameters
+    # @return [UserQueue]
+    def patch_user_queue(queue_id, user_id, body, opts = {})
+      data, _status_code, _headers = patch_user_queue_with_http_info(queue_id, user_id, body, opts)
+      return data
+    end
+
+    # Join or unjoin a queue for a user
+    # 
+    # @param queue_id Queue ID
+    # @param user_id User ID
+    # @param body Queue Member
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UserQueue, Fixnum, Hash)>] UserQueue data, response status code and response headers
+    def patch_user_queue_with_http_info(queue_id, user_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_queue ..."
+      end
+      
+      
+      # verify the required parameter 'queue_id' is set
+      fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.patch_user_queue" if queue_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_queue" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_queue" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['PureCloud OAuth']
+      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 => 'UserQueue')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#patch_user_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Join or unjoin a set of queues for a user
+    # 
+    # @param user_id User ID
+    # @param body User Queues
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :division_id Division ID(s)
+    # @return [UserQueueEntityListing]
+    def patch_user_queues(user_id, body, opts = {})
+      data, _status_code, _headers = patch_user_queues_with_http_info(user_id, body, opts)
+      return data
+    end
+
+    # Join or unjoin a set of queues for a user
+    # 
+    # @param user_id User ID
+    # @param body User Queues
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :division_id Division ID(s)
+    # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
+    def patch_user_queues_with_http_info(user_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_queues ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_queues" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_queues" if body.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['PureCloud OAuth']
+      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 => 'UserQueueEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#patch_user_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update routing language proficiency or state.
     # 
     # @param user_id User ID
@@ -5122,7 +5392,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Update the utilization settings.
+    # Update the organization-wide max utilization settings.  Include only those media types requiring custom configuration.
     # 
     # @param body utilization
     # @param [Hash] opts the optional parameters
@@ -5132,7 +5402,7 @@ module PureCloud
       return data
     end
 
-    # Update the utilization settings.
+    # Update the organization-wide max utilization settings.  Include only those media types requiring custom configuration.
     # 
     # @param body utilization
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/utilities_api.rb

@@ -271,60 +271,5 @@ module PureCloud
       end
       return data, status_code, headers
     end
-
-    # Generate a JWT for use with common cloud.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [Token]
-    def post_gmsc_tokens(opts = {})
-      data, _status_code, _headers = post_gmsc_tokens_with_http_info(opts)
-      return data
-    end
-
-    # Generate a JWT for use with common cloud.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Token, Fixnum, Hash)>] Token data, response status code and response headers
-    def post_gmsc_tokens_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: UtilitiesApi.post_gmsc_tokens ..."
-      end
-      
-      # resource path
-      local_var_path = "/api/v2/gmsc/tokens".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-
-      # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-
-      # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = nil
-      
-      auth_names = ['PureCloud OAuth']
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'Token')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: UtilitiesApi#post_gmsc_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -2497,8 +2497,8 @@ module PureCloud
       
       
       
-      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnitActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'BuSchedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'BuShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
-        fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnitActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans'
+      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnitActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'BuIntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'BuSchedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'PlanningGroups', 'ShiftTrading', 'ShortTermForecasts', 'BuShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
+        fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnitActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans'
       end
       
       

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '73.0.0'
+      header_params['purecloud-sdk'] = '75.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -30,10 +30,10 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :last_uri
-
     attr_accessor :next_uri
 
+    attr_accessor :last_uri
+
     attr_accessor :previous_uri
 
     attr_accessor :page_count
@@ -54,10 +54,10 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'last_uri' => :'lastUri',
-        
         :'next_uri' => :'nextUri',
         
+        :'last_uri' => :'lastUri',
+        
         :'previous_uri' => :'previousUri',
         
         :'page_count' => :'pageCount'
@@ -81,10 +81,10 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'last_uri' => :'String',
-        
         :'next_uri' => :'String',
         
+        :'last_uri' => :'String',
+        
         :'previous_uri' => :'String',
         
         :'page_count' => :'Integer'
@@ -157,19 +157,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -312,8 +312,8 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          last_uri == o.last_uri &&
           next_uri == o.next_uri &&
+          last_uri == o.last_uri &&
           previous_uri == o.previous_uri &&
           page_count == o.page_count
     end
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, first_uri, self_uri, last_uri, next_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, next_uri, last_uri, previous_uri, page_count].hash
     end
 
     # build the object from hash