purecloudplatformclientv2 64.0.1 → 69.0.0

data/lib/purecloudplatformclientv2/models/create_work_plan.rb

@@ -55,6 +55,39 @@ module PureCloud
     # Maximum number days in a week allowed to be scheduled for this work plan
     attr_accessor :maximum_days
 
+    # The day of the week for which the weekend starts, such as Saturday
+    attr_accessor :start_day_of_weekend
+
+    # Minimum amount of consecutive time off per week that agents who are assigned this work plan are allowed to have off
+    attr_accessor :minimum_consecutive_time_off_per_week_minutes
+
+    # Whether to constrain the maximum consecutive working weekends
+    attr_accessor :constrain_maximum_consecutive_working_weekends
+
+    # The maximum number of consecutive weekends that agents who are assigned to this work plan are allowed to work
+    attr_accessor :maximum_consecutive_working_weekends
+
+    # The minimum number of days that agents assigned to a work plan must work per week
+    attr_accessor :minimum_working_days_per_week
+
+    # The maximum number of consecutive days that agents assigned to this work plan are allowed to work
+    attr_accessor :maximum_consecutive_working_days
+
+    # The time period in minutes for the duration between the start times of two consecutive working days
+    attr_accessor :minimum_shift_start_distance_minutes
+
+    # Minimum days off in the planning period
+    attr_accessor :minimum_days_off_per_planning_period
+
+    # Maximum days off in the planning period
+    attr_accessor :maximum_days_off_per_planning_period
+
+    # Minimum paid hours in the planning period
+    attr_accessor :minimum_paid_hours_per_planning_period
+
+    # Maximum paid hours in the planning period
+    attr_accessor :maximum_paid_hours_per_planning_period
+
     # Optional days to schedule for this work plan
     attr_accessor :optional_days
 
@@ -95,6 +128,28 @@ module PureCloud
         
         :'maximum_days' => :'maximumDays',
         
+        :'start_day_of_weekend' => :'startDayOfWeekend',
+        
+        :'minimum_consecutive_time_off_per_week_minutes' => :'minimumConsecutiveTimeOffPerWeekMinutes',
+        
+        :'constrain_maximum_consecutive_working_weekends' => :'constrainMaximumConsecutiveWorkingWeekends',
+        
+        :'maximum_consecutive_working_weekends' => :'maximumConsecutiveWorkingWeekends',
+        
+        :'minimum_working_days_per_week' => :'minimumWorkingDaysPerWeek',
+        
+        :'maximum_consecutive_working_days' => :'maximumConsecutiveWorkingDays',
+        
+        :'minimum_shift_start_distance_minutes' => :'minimumShiftStartDistanceMinutes',
+        
+        :'minimum_days_off_per_planning_period' => :'minimumDaysOffPerPlanningPeriod',
+        
+        :'maximum_days_off_per_planning_period' => :'maximumDaysOffPerPlanningPeriod',
+        
+        :'minimum_paid_hours_per_planning_period' => :'minimumPaidHoursPerPlanningPeriod',
+        
+        :'maximum_paid_hours_per_planning_period' => :'maximumPaidHoursPerPlanningPeriod',
+        
         :'optional_days' => :'optionalDays',
         
         :'shift_start_variances' => :'shiftStartVariances',
@@ -134,6 +189,28 @@ module PureCloud
         
         :'maximum_days' => :'Integer',
         
+        :'start_day_of_weekend' => :'String',
+        
+        :'minimum_consecutive_time_off_per_week_minutes' => :'Integer',
+        
+        :'constrain_maximum_consecutive_working_weekends' => :'BOOLEAN',
+        
+        :'maximum_consecutive_working_weekends' => :'Integer',
+        
+        :'minimum_working_days_per_week' => :'Integer',
+        
+        :'maximum_consecutive_working_days' => :'Integer',
+        
+        :'minimum_shift_start_distance_minutes' => :'Integer',
+        
+        :'minimum_days_off_per_planning_period' => :'Integer',
+        
+        :'maximum_days_off_per_planning_period' => :'Integer',
+        
+        :'minimum_paid_hours_per_planning_period' => :'Integer',
+        
+        :'maximum_paid_hours_per_planning_period' => :'Integer',
+        
         :'optional_days' => :'SetWrapperDayOfWeek',
         
         :'shift_start_variances' => :'ListWrapperShiftStartVariance',
@@ -262,6 +339,105 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'startDayOfWeekend')
+        
+        
+        self.start_day_of_weekend = attributes[:'startDayOfWeekend']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumConsecutiveTimeOffPerWeekMinutes')
+        
+        
+        self.minimum_consecutive_time_off_per_week_minutes = attributes[:'minimumConsecutiveTimeOffPerWeekMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'constrainMaximumConsecutiveWorkingWeekends')
+        
+        
+        self.constrain_maximum_consecutive_working_weekends = attributes[:'constrainMaximumConsecutiveWorkingWeekends']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'maximumConsecutiveWorkingWeekends')
+        
+        
+        self.maximum_consecutive_working_weekends = attributes[:'maximumConsecutiveWorkingWeekends']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumWorkingDaysPerWeek')
+        
+        
+        self.minimum_working_days_per_week = attributes[:'minimumWorkingDaysPerWeek']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'maximumConsecutiveWorkingDays')
+        
+        
+        self.maximum_consecutive_working_days = attributes[:'maximumConsecutiveWorkingDays']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumShiftStartDistanceMinutes')
+        
+        
+        self.minimum_shift_start_distance_minutes = attributes[:'minimumShiftStartDistanceMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumDaysOffPerPlanningPeriod')
+        
+        
+        self.minimum_days_off_per_planning_period = attributes[:'minimumDaysOffPerPlanningPeriod']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'maximumDaysOffPerPlanningPeriod')
+        
+        
+        self.maximum_days_off_per_planning_period = attributes[:'maximumDaysOffPerPlanningPeriod']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumPaidHoursPerPlanningPeriod')
+        
+        
+        self.minimum_paid_hours_per_planning_period = attributes[:'minimumPaidHoursPerPlanningPeriod']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'maximumPaidHoursPerPlanningPeriod')
+        
+        
+        self.maximum_paid_hours_per_planning_period = attributes[:'maximumPaidHoursPerPlanningPeriod']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'optionalDays')
         
         
@@ -351,6 +527,55 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
+      if @start_day_of_weekend && !allowed_values.include?(@start_day_of_weekend)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -429,6 +654,70 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] start_day_of_weekend Object to be assigned
+    def start_day_of_weekend=(start_day_of_weekend)
+      allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
+      if start_day_of_weekend && !allowed_values.include?(start_day_of_weekend)
+        fail ArgumentError, "invalid value for 'start_day_of_weekend', must be one of #{allowed_values}."
+      end
+      @start_day_of_weekend = start_day_of_weekend
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -486,6 +775,17 @@ module PureCloud
           constrain_minimum_time_between_shifts == o.constrain_minimum_time_between_shifts &&
           minimum_time_between_shifts_minutes == o.minimum_time_between_shifts_minutes &&
           maximum_days == o.maximum_days &&
+          start_day_of_weekend == o.start_day_of_weekend &&
+          minimum_consecutive_time_off_per_week_minutes == o.minimum_consecutive_time_off_per_week_minutes &&
+          constrain_maximum_consecutive_working_weekends == o.constrain_maximum_consecutive_working_weekends &&
+          maximum_consecutive_working_weekends == o.maximum_consecutive_working_weekends &&
+          minimum_working_days_per_week == o.minimum_working_days_per_week &&
+          maximum_consecutive_working_days == o.maximum_consecutive_working_days &&
+          minimum_shift_start_distance_minutes == o.minimum_shift_start_distance_minutes &&
+          minimum_days_off_per_planning_period == o.minimum_days_off_per_planning_period &&
+          maximum_days_off_per_planning_period == o.maximum_days_off_per_planning_period &&
+          minimum_paid_hours_per_planning_period == o.minimum_paid_hours_per_planning_period &&
+          maximum_paid_hours_per_planning_period == o.maximum_paid_hours_per_planning_period &&
           optional_days == o.optional_days &&
           shift_start_variances == o.shift_start_variances &&
           shifts == o.shifts &&
@@ -501,7 +801,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, enabled, constrain_weekly_paid_time, flexible_weekly_paid_time, weekly_exact_paid_minutes, weekly_minimum_paid_minutes, weekly_maximum_paid_minutes, constrain_paid_time_granularity, paid_time_granularity_minutes, constrain_minimum_time_between_shifts, minimum_time_between_shifts_minutes, maximum_days, optional_days, shift_start_variances, shifts, agents].hash
+      [name, enabled, constrain_weekly_paid_time, flexible_weekly_paid_time, weekly_exact_paid_minutes, weekly_minimum_paid_minutes, weekly_maximum_paid_minutes, constrain_paid_time_granularity, paid_time_granularity_minutes, constrain_minimum_time_between_shifts, minimum_time_between_shifts_minutes, maximum_days, start_day_of_weekend, minimum_consecutive_time_off_per_week_minutes, constrain_maximum_consecutive_working_weekends, maximum_consecutive_working_weekends, minimum_working_days_per_week, maximum_consecutive_working_days, minimum_shift_start_distance_minutes, minimum_days_off_per_planning_period, maximum_days_off_per_planning_period, minimum_paid_hours_per_planning_period, maximum_paid_hours_per_planning_period, optional_days, shift_start_variances, shifts, agents].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb

@@ -52,6 +52,12 @@ module PureCloud
     # Whether the activity duration is counted towards contiguous work time
     attr_accessor :counts_as_contiguous_work_time
 
+    # The minimum duration between shift start and shift item (e.g., break or meal) start in minutes
+    attr_accessor :minimum_length_from_shift_start_minutes
+
+    # The minimum duration between shift item (e.g., break or meal) end and shift end in minutes
+    attr_accessor :minimum_length_from_shift_end_minutes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -76,7 +82,11 @@ module PureCloud
         
         :'counts_as_paid_time' => :'countsAsPaidTime',
         
-        :'counts_as_contiguous_work_time' => :'countsAsContiguousWorkTime'
+        :'counts_as_contiguous_work_time' => :'countsAsContiguousWorkTime',
+        
+        :'minimum_length_from_shift_start_minutes' => :'minimumLengthFromShiftStartMinutes',
+        
+        :'minimum_length_from_shift_end_minutes' => :'minimumLengthFromShiftEndMinutes'
         
       }
     end
@@ -105,7 +115,11 @@ module PureCloud
         
         :'counts_as_paid_time' => :'BOOLEAN',
         
-        :'counts_as_contiguous_work_time' => :'BOOLEAN'
+        :'counts_as_contiguous_work_time' => :'BOOLEAN',
+        
+        :'minimum_length_from_shift_start_minutes' => :'Integer',
+        
+        :'minimum_length_from_shift_end_minutes' => :'Integer'
         
       }
     end
@@ -218,6 +232,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'minimumLengthFromShiftStartMinutes')
+        
+        
+        self.minimum_length_from_shift_start_minutes = attributes[:'minimumLengthFromShiftStartMinutes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'minimumLengthFromShiftEndMinutes')
+        
+        
+        self.minimum_length_from_shift_end_minutes = attributes[:'minimumLengthFromShiftEndMinutes']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -268,6 +300,14 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -324,6 +364,16 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -350,7 +400,9 @@ module PureCloud
           exact_start_time_minutes == o.exact_start_time_minutes &&
           start_time_increment_minutes == o.start_time_increment_minutes &&
           counts_as_paid_time == o.counts_as_paid_time &&
-          counts_as_contiguous_work_time == o.counts_as_contiguous_work_time
+          counts_as_contiguous_work_time == o.counts_as_contiguous_work_time &&
+          minimum_length_from_shift_start_minutes == o.minimum_length_from_shift_start_minutes &&
+          minimum_length_from_shift_end_minutes == o.minimum_length_from_shift_end_minutes
     end
 
     # @see the `==` method
@@ -362,7 +414,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [activity_code_id, description, length_minutes, start_time_is_relative_to_shift_start, flexible_start_time, earliest_start_time_minutes, latest_start_time_minutes, exact_start_time_minutes, start_time_increment_minutes, counts_as_paid_time, counts_as_contiguous_work_time].hash
+      [activity_code_id, description, length_minutes, start_time_is_relative_to_shift_start, flexible_start_time, earliest_start_time_minutes, latest_start_time_minutes, exact_start_time_minutes, start_time_increment_minutes, counts_as_paid_time, counts_as_contiguous_work_time, minimum_length_from_shift_start_minutes, minimum_length_from_shift_end_minutes].hash
     end
 
     # build the object from hash