purecloudplatformclientv2 58.0.1 → 59.0.0

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -26,7 +26,7 @@ module PureCloud
 
     # Delete management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or 'mine' for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def delete_workforcemanagement_managementunit(mu_id, opts = {})
@@ -36,7 +36,7 @@ module PureCloud
 
     # Delete management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or 'mine' for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def delete_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
@@ -685,9 +685,9 @@ module PureCloud
 
     # Get management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand 
+    # @option opts [Array<String>] :expand 
     # @return [ManagementUnit]
     def get_workforcemanagement_managementunit(mu_id, opts = {})
       data, _status_code, _headers = get_workforcemanagement_managementunit_with_http_info(mu_id, opts)
@@ -696,9 +696,9 @@ module PureCloud
 
     # Get management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :expand 
+    # @option opts [Array<String>] :expand 
     # @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers
     def get_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
       if @api_client.config.debugging
@@ -716,10 +716,6 @@ module PureCloud
       
       
       
-      if opts[:'expand'] && !['settings'].include?(opts[:'expand'])
-        fail ArgumentError, 'invalid value for "expand", must be one of settings'
-      end
-      
       
       
       
@@ -728,7 +724,7 @@ module PureCloud
 
       # query parameters
       query_params = {}
-      query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
 
       # header parameters
       header_params = {}
@@ -1407,9 +1403,9 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get the settings for the requested management unit
+    # Get the settings for the requested management unit. Deprecated, use the GET management unit route instead
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [ManagementUnitSettings]
     def get_workforcemanagement_managementunit_settings(mu_id, opts = {})
@@ -1417,9 +1413,9 @@ module PureCloud
       return data
     end
 
-    # Get the settings for the requested management unit
+    # Get the settings for the requested management unit. Deprecated, use the GET management unit route instead
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ManagementUnitSettings, Fixnum, Hash)>] ManagementUnitSettings data, response status code and response headers
     def get_workforcemanagement_managementunit_settings_with_http_info(mu_id, opts = {})
@@ -2501,8 +2497,8 @@ module PureCloud
       
       
       
-      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'ShiftTrading', 'ShortTermForecasts', 'TimeOffRequests', 'WorkPlans'].include?(opts[:'feature'])
-        fail ArgumentError, 'invalid value for "feature", must be one of AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BusinessUnits, HistoricalAdherence, IntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, ServiceGoalGroups, ServiceGoalTemplates, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans'
+      if opts[:'feature'] && !['AgentSchedule', 'AgentTimeOffRequest', 'ActivityCodes', 'Agents', 'BusinessUnitActivityCodes', 'BusinessUnits', 'HistoricalAdherence', 'IntradayMonitoring', 'ManagementUnits', 'RealTimeAdherence', 'Schedules', 'ServiceGoalGroups', 'ServiceGoalTemplates', 'ShiftTrading', 'ShortTermForecasts', '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, ServiceGoalGroups, ServiceGoalTemplates, ShiftTrading, ShortTermForecasts, TimeOffRequests, WorkPlans'
       end
       
       
@@ -2924,6 +2920,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update the requested management unit
+    # 
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateManagementUnitRequest] :body body
+    # @return [ManagementUnit]
+    def patch_workforcemanagement_managementunit(mu_id, opts = {})
+      data, _status_code, _headers = patch_workforcemanagement_managementunit_with_http_info(mu_id, opts)
+      return data
+    end
+
+    # Update the requested management unit
+    # 
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateManagementUnitRequest] :body body
+    # @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers
+    def patch_workforcemanagement_managementunit_with_http_info(mu_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit ..."
+      end
+      
+      
+      # verify the required parameter 'mu_id' is set
+      fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit" if mu_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_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(opts[:'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 => 'ManagementUnit')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an activity code
     # 
     # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
@@ -3173,9 +3242,9 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Patch the settings for the requested management unit
+    # Update the settings for the requested management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [ManagementUnitSettings] :body config
     # @return [ManagementUnitSettings]
@@ -3184,9 +3253,9 @@ module PureCloud
       return data
     end
 
-    # Patch the settings for the requested management unit
+    # Update the settings for the requested management unit
     # 
-    # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [ManagementUnitSettings] :body config
     # @return [Array<(ManagementUnitSettings, Fixnum, Hash)>] ManagementUnitSettings data, response status code and response headers
@@ -3888,6 +3957,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Move the requested management unit to a new business unit
+    # Returns status 200 if the management unit is already in the requested business unit
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [MoveManagementUnitRequest] :body body
+    # @return [MoveManagementUnitResponse]
+    def post_workforcemanagement_managementunit_move(mu_id, opts = {})
+      data, _status_code, _headers = post_workforcemanagement_managementunit_move_with_http_info(mu_id, opts)
+      return data
+    end
+
+    # Move the requested management unit to a new business unit
+    # Returns status 200 if the management unit is already in the requested business unit
+    # @param mu_id The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param [Hash] opts the optional parameters
+    # @option opts [MoveManagementUnitRequest] :body body
+    # @return [Array<(MoveManagementUnitResponse, Fixnum, Hash)>] MoveManagementUnitResponse data, response status code and response headers
+    def post_workforcemanagement_managementunit_move_with_http_info(mu_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi.post_workforcemanagement_managementunit_move ..."
+      end
+      
+      
+      # verify the required parameter 'mu_id' is set
+      fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.post_workforcemanagement_managementunit_move" if mu_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/move".sub('{format}','json').sub('{' + 'muId' + '}', mu_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(opts[:'body'])
+      
+      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 => 'MoveManagementUnitResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#post_workforcemanagement_managementunit_move\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Query published schedules for given given time range for set of users
     # 
     # @param mu_id The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.

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'] = '58.0.1'
+      header_params['purecloud-sdk'] = '59.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 :next_uri
-
     attr_accessor :previous_uri
 
+    attr_accessor :next_uri
+
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -54,10 +54,10 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'previous_uri' => :'previousUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -81,10 +81,10 @@ module PureCloud
         
         :'self_uri' => :'String',
         
-        :'next_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
+        :'next_uri' => :'String',
+        
         :'last_uri' => :'String',
         
         :'page_count' => :'Integer'
@@ -157,19 +157,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -312,8 +312,8 @@ module PureCloud
           total == o.total &&
           first_uri == o.first_uri &&
           self_uri == o.self_uri &&
-          next_uri == o.next_uri &&
           previous_uri == o.previous_uri &&
+          next_uri == o.next_uri &&
           last_uri == o.last_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, next_uri, previous_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, self_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb}

@@ -17,7 +17,7 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  class Skill
+  class AddressableEntityRef
     attr_accessor :id
 
     attr_accessor :self_uri

data/lib/purecloudplatformclientv2/models/agent.rb

@@ -18,17 +18,14 @@ require 'date'
 
 module PureCloud
   class Agent
-    attr_accessor :id
-
-    attr_accessor :self_uri
+    # The current stage for this agent
+    attr_accessor :stage
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'id' => :'id',
-        
-        :'self_uri' => :'selfUri'
+        :'stage' => :'stage'
         
       }
     end
@@ -37,9 +34,7 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'id' => :'String',
-        
-        :'self_uri' => :'String'
+        :'stage' => :'String'
         
       }
     end
@@ -53,19 +48,10 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
-      if attributes.has_key?(:'id')
-        
-        
-        self.id = attributes[:'id']
-        
-      
-      end
-
-      
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'stage')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.stage = attributes[:'stage']
         
       
       end
@@ -90,10 +76,6 @@ module PureCloud
       
       
       
-      
-      
-      
-      
     end
 
     
@@ -102,18 +84,12 @@ module PureCloud
     
     
     
-    
-    
-    
-    
-    
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          self_uri == o.self_uri
+          stage == o.stage
     end
 
     # @see the `==` method
@@ -125,7 +101,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, self_uri].hash
+      [stage].hash
     end
 
     # build the object from hash