purecloudplatformclientv2 32.0.0 → 33.0.0

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -962,7 +962,7 @@ module PureCloud
     # @option opts [Integer] :page_size The total page size requested (default to 25)
     # @option opts [Integer] :page_number The page number requested (default to 1)
     # @option opts [String] :sort_by variable name requested to sort by
-    # @option opts [Array<Object>] :expand variable name requested by expand list
+    # @option opts [Array<String>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (default to false)
@@ -979,7 +979,7 @@ module PureCloud
     # @option opts [Integer] :page_size The total page size requested
     # @option opts [Integer] :page_number The page number requested
     # @option opts [String] :sort_by variable name requested to sort by
-    # @option opts [Array<Object>] :expand variable name requested by expand list
+    # @option opts [Array<String>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [BOOLEAN] :has_conversation Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
@@ -1278,7 +1278,7 @@ module PureCloud
     # @option opts [Integer] :page_size The total page size requested (default to 25)
     # @option opts [Integer] :page_number The page number requested (default to 1)
     # @option opts [String] :sort_by variable name requested to sort by
-    # @option opts [Array<Object>] :expand variable name requested by expand list
+    # @option opts [Array<String>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [String] :name the policy name - used for filtering results in searches.
@@ -1297,7 +1297,7 @@ module PureCloud
     # @option opts [Integer] :page_size The total page size requested
     # @option opts [Integer] :page_number The page number requested
     # @option opts [String] :sort_by variable name requested to sort by
-    # @option opts [Array<Object>] :expand variable name requested by expand list
+    # @option opts [Array<String>] :expand variable name requested by expand list
     # @option opts [String] :next_page next page token
     # @option opts [String] :previous_page Previous page token
     # @option opts [String] :name the policy name - used for filtering results in searches.

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -92,7 +92,7 @@ module PureCloud
 
     # Get activity codes
     # 
-    # @param mu_id The muId 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 [ActivityCodeContainer]
     def get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
@@ -102,7 +102,7 @@ module PureCloud
 
     # Get activity codes
     # 
-    # @param mu_id The muId 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<(ActivityCodeContainer, Fixnum, Hash)>] ActivityCodeContainer data, response status code and response headers
     def get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
@@ -231,25 +231,25 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get a time off request by id
+    # Get a time off request
     # 
-    # @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 muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param time_off_request_id Time Off Request Id
     # @param [Hash] opts the optional parameters
-    # @return [TimeOffRequest]
+    # @return [TimeOffRequestResponse]
     def get_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
       data, _status_code, _headers = get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
       return data
     end
 
-    # Get a time off request by id
+    # Get a time off request
     # 
-    # @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 muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param time_off_request_id Time Off Request Id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(TimeOffRequest, Fixnum, Hash)>] TimeOffRequest data, response status code and response headers
+    # @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers
     def get_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: WorkforceManagementApi.get_workforcemanagement_managementunit_user_timeoffrequest ..."
@@ -309,16 +309,16 @@ module PureCloud
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'TimeOffRequest')
+        :return_type => 'TimeOffRequestResponse')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: WorkforceManagementApi#get_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get a list of time off requests for any user
+    # Get a list of time off requests for a given user
     # 
-    # @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 muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
@@ -328,9 +328,9 @@ module PureCloud
       return data
     end
 
-    # Get a list of time off requests for any user
+    # Get a list of time off requests for a given user
     # 
-    # @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 muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days
@@ -551,9 +551,102 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Create a new activity code
+    # Update a time off request
     # 
     # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param user_id The id of the user the requested time off request belongs to
+    # @param time_off_request_id The id of the time off request to update
+    # @param [Hash] opts the optional parameters
+    # @option opts [AdminTimeOffRequestPatch] :body body
+    # @return [TimeOffRequestResponse]
+    def patch_workforcemanagement_managementunit_user_timeoffrequest(mu_id, user_id, time_off_request_id, opts = {})
+      data, _status_code, _headers = patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts)
+      return data
+    end
+
+    # Update a time off request
+    # 
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
+    # @param user_id The id of the user the requested time off request belongs to
+    # @param time_off_request_id The id of the time off request to update
+    # @param [Hash] opts the optional parameters
+    # @option opts [AdminTimeOffRequestPatch] :body body
+    # @return [Array<(TimeOffRequestResponse, Fixnum, Hash)>] TimeOffRequestResponse data, response status code and response headers
+    def patch_workforcemanagement_managementunit_user_timeoffrequest_with_http_info(mu_id, user_id, time_off_request_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest ..."
+      end
+      
+      
+      # verify the required parameter 'mu_id' is set
+      fail ArgumentError, "Missing the required parameter 'mu_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if mu_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'time_off_request_id' is set
+      fail ArgumentError, "Missing the required parameter 'time_off_request_id' when calling WorkforceManagementApi.patch_workforcemanagement_managementunit_user_timeoffrequest" if time_off_request_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/workforcemanagement/managementunits/{muId}/users/{userId}/timeoffrequests/{timeOffRequestId}".sub('{format}','json').sub('{' + 'muId' + '}', mu_id.to_s).sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'timeOffRequestId' + '}', time_off_request_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 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 => 'TimeOffRequestResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkforceManagementApi#patch_workforcemanagement_managementunit_user_timeoffrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new activity code
+    # 
+    # @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 [CreateActivityCodeRequest] :body body
     # @return [ActivityCode]
@@ -564,7 +657,7 @@ module PureCloud
 
     # Create a new activity code
     # 
-    # @param mu_id The muId 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 [CreateActivityCodeRequest] :body body
     # @return [Array<(ActivityCode, Fixnum, Hash)>] ActivityCode data, response status code and response headers
@@ -770,7 +863,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get user schedules within the given time range
+    # 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.
     # @param [Hash] opts the optional parameters
@@ -781,7 +874,7 @@ module PureCloud
       return data
     end
 
-    # Get user schedules within the given time range
+    # 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.
     # @param [Hash] opts the optional parameters

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'] = '32.0.0'
+      header_params['purecloud-sdk'] = '33.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

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

data/lib/purecloudplatformclientv2/models/{platform.rb → admin_time_off_request_patch.rb}

@@ -17,21 +17,45 @@ Terms of Service: https://developer.mypurecloud.com/tos
 require 'date'
 
 module PureCloud
-  # Represents the supported platforms for an AppFoundry listing
-  class Platform
-    # Name of the platform
-    attr_accessor :name
+  class AdminTimeOffRequestPatch
+    # The status of this time off request
+    attr_accessor :status
 
-    # Platform subcategories, eg, on-prem or cloud
-    attr_accessor :subcategories
+    # The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category
+    attr_accessor :activity_code_id
+
+    # Notes about the time off request
+    attr_accessor :notes
+
+    # A set of dates in yyyy-MM-dd format.  Should be interpreted in the management unit's configured time zone.
+    attr_accessor :full_day_management_unit_dates
+
+    # A set of start date-times in ISO-8601 format for partial day requests.
+    attr_accessor :partial_day_start_date_times
+
+    # The daily duration of this time off request in minutes
+    attr_accessor :daily_duration_minutes
+
+    # Version metadata for the time off request
+    attr_accessor :metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         
-        :'name' => :'name',
+        :'status' => :'status',
+        
+        :'activity_code_id' => :'activityCodeId',
+        
+        :'notes' => :'notes',
         
-        :'subcategories' => :'subcategories'
+        :'full_day_management_unit_dates' => :'fullDayManagementUnitDates',
+        
+        :'partial_day_start_date_times' => :'partialDayStartDateTimes',
+        
+        :'daily_duration_minutes' => :'dailyDurationMinutes',
+        
+        :'metadata' => :'metadata'
         
       }
     end
@@ -40,9 +64,19 @@ module PureCloud
     def self.swagger_types
       {
         
-        :'name' => :'String',
+        :'status' => :'String',
+        
+        :'activity_code_id' => :'String',
+        
+        :'notes' => :'String',
+        
+        :'full_day_management_unit_dates' => :'Array<String>',
         
-        :'subcategories' => :'Array<String>'
+        :'partial_day_start_date_times' => :'Array<DateTime>',
+        
+        :'daily_duration_minutes' => :'Integer',
+        
+        :'metadata' => :'WfmVersionedEntityMetadata'
         
       }
     end
@@ -56,19 +90,37 @@ module PureCloud
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       
-      if attributes.has_key?(:'name')
+      if attributes.has_key?(:'status')
+        
+        
+        self.status = attributes[:'status']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'activityCodeId')
+        
+        
+        self.activity_code_id = attributes[:'activityCodeId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'notes')
         
         
-        self.name = attributes[:'name']
+        self.notes = attributes[:'notes']
         
       
       end
 
       
-      if attributes.has_key?(:'subcategories')
+      if attributes.has_key?(:'fullDayManagementUnitDates')
         
-        if (value = attributes[:'subcategories']).is_a?(Array)
-          self.subcategories = value
+        if (value = attributes[:'fullDayManagementUnitDates']).is_a?(Array)
+          self.full_day_management_unit_dates = value
         end
         
         
@@ -76,6 +128,35 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'partialDayStartDateTimes')
+        
+        if (value = attributes[:'partialDayStartDateTimes']).is_a?(Array)
+          self.partial_day_start_date_times = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dailyDurationMinutes')
+        
+        
+        self.daily_duration_minutes = attributes[:'dailyDurationMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'metadata')
+        
+        
+        self.metadata = attributes[:'metadata']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -92,10 +173,11 @@ module PureCloud
     def valid?
       
       
-      if @name.nil?
+      
+      allowed_values = ["PENDING", "APPROVED", "DENIED"]
+      if @status && !allowed_values.include?(@status)
         return false
       end
-
       
       
       
@@ -104,8 +186,66 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if @metadata.nil?
+        return false
+      end
+
+      
+      
+      
+      
     end
 
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      allowed_values = ["PENDING", "APPROVED", "DENIED"]
+      if status && !allowed_values.include?(status)
+        fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
+      end
+      @status = status
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -122,8 +262,13 @@ module PureCloud
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
-          subcategories == o.subcategories
+          status == o.status &&
+          activity_code_id == o.activity_code_id &&
+          notes == o.notes &&
+          full_day_management_unit_dates == o.full_day_management_unit_dates &&
+          partial_day_start_date_times == o.partial_day_start_date_times &&
+          daily_duration_minutes == o.daily_duration_minutes &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -135,7 +280,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, subcategories].hash
+      [status, activity_code_id, notes, full_day_management_unit_dates, partial_day_start_date_times, daily_duration_minutes, metadata].hash
     end
 
     # build the object from hash