purecloudplatformclientv2 64.0.0 → 68.0.0

data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb

@@ -57,6 +57,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. Populate with expand=details
     attr_accessor :optional_days
 
@@ -108,6 +141,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',
@@ -155,6 +210,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',
@@ -298,6 +375,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')
         
         
@@ -413,6 +589,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
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -513,6 +738,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
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -586,6 +875,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 &&
@@ -604,7 +904,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, 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, metadata, agent_count, self_uri].hash
+      [id, 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, metadata, agent_count, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/work_plan_shift.rb

@@ -40,9 +40,18 @@ module PureCloud
     # Whether the latest stop time constraint for the shift is enabled
     attr_accessor :constrain_stop_time
 
+    # Whether the latest stop time constraint for the shift is enabled
+    attr_accessor :constrain_latest_stop_time
+
     # Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true
     attr_accessor :latest_stop_time_minutes_from_midnight
 
+    # Whether the earliest stop time constraint for the shift is enabled
+    attr_accessor :constrain_earliest_stop_time
+
+    # This is the earliest time a shift can end
+    attr_accessor :earliest_stop_time_minutes_from_midnight
+
     # Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true
     attr_accessor :start_increment_minutes
 
@@ -67,6 +76,18 @@ module PureCloud
     # Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true
     attr_accessor :maximum_contiguous_work_time_minutes
 
+    # Whether synchronization for agent is enabled
+    attr_accessor :synchronize_agents_schedules
+
+    # This constraint ensures that an agent starts each workday within a user-defined time threshold. Used if synchronizeAgentsSchedules == true
+    attr_accessor :synchronization_type
+
+    # Whether day off rule is enabled
+    attr_accessor :constrain_day_off
+
+    # The day off rule for agents to have next day off or previous day off. used if constrainDayOff = true
+    attr_accessor :day_off_rule
+
     # Activities configured for this shift
     attr_accessor :activities
 
@@ -94,8 +115,14 @@ module PureCloud
         
         :'constrain_stop_time' => :'constrainStopTime',
         
+        :'constrain_latest_stop_time' => :'constrainLatestStopTime',
+        
         :'latest_stop_time_minutes_from_midnight' => :'latestStopTimeMinutesFromMidnight',
         
+        :'constrain_earliest_stop_time' => :'constrainEarliestStopTime',
+        
+        :'earliest_stop_time_minutes_from_midnight' => :'earliestStopTimeMinutesFromMidnight',
+        
         :'start_increment_minutes' => :'startIncrementMinutes',
         
         :'flexible_paid_time' => :'flexiblePaidTime',
@@ -112,6 +139,14 @@ module PureCloud
         
         :'maximum_contiguous_work_time_minutes' => :'maximumContiguousWorkTimeMinutes',
         
+        :'synchronize_agents_schedules' => :'synchronizeAgentsSchedules',
+        
+        :'synchronization_type' => :'synchronizationType',
+        
+        :'constrain_day_off' => :'constrainDayOff',
+        
+        :'day_off_rule' => :'dayOffRule',
+        
         :'activities' => :'activities',
         
         :'id' => :'id',
@@ -139,8 +174,14 @@ module PureCloud
         
         :'constrain_stop_time' => :'BOOLEAN',
         
+        :'constrain_latest_stop_time' => :'BOOLEAN',
+        
         :'latest_stop_time_minutes_from_midnight' => :'Integer',
         
+        :'constrain_earliest_stop_time' => :'BOOLEAN',
+        
+        :'earliest_stop_time_minutes_from_midnight' => :'Integer',
+        
         :'start_increment_minutes' => :'Integer',
         
         :'flexible_paid_time' => :'BOOLEAN',
@@ -157,6 +198,14 @@ module PureCloud
         
         :'maximum_contiguous_work_time_minutes' => :'Integer',
         
+        :'synchronize_agents_schedules' => :'BOOLEAN',
+        
+        :'synchronization_type' => :'String',
+        
+        :'constrain_day_off' => :'BOOLEAN',
+        
+        :'day_off_rule' => :'String',
+        
         :'activities' => :'Array<WorkPlanActivity>',
         
         :'id' => :'String',
@@ -238,6 +287,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'constrainLatestStopTime')
+        
+        
+        self.constrain_latest_stop_time = attributes[:'constrainLatestStopTime']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'latestStopTimeMinutesFromMidnight')
         
         
@@ -247,6 +305,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'constrainEarliestStopTime')
+        
+        
+        self.constrain_earliest_stop_time = attributes[:'constrainEarliestStopTime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'earliestStopTimeMinutesFromMidnight')
+        
+        
+        self.earliest_stop_time_minutes_from_midnight = attributes[:'earliestStopTimeMinutesFromMidnight']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'startIncrementMinutes')
         
         
@@ -319,6 +395,42 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'synchronizeAgentsSchedules')
+        
+        
+        self.synchronize_agents_schedules = attributes[:'synchronizeAgentsSchedules']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'synchronizationType')
+        
+        
+        self.synchronization_type = attributes[:'synchronizationType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'constrainDayOff')
+        
+        
+        self.constrain_day_off = attributes[:'constrainDayOff']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dayOffRule')
+        
+        
+        self.day_off_rule = attributes[:'dayOffRule']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'activities')
         
         if (value = attributes[:'activities']).is_a?(Array)
@@ -429,6 +541,44 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["ShiftStart", "ShiftStartAndPaidDuration"]
+      if @synchronization_type && !allowed_values.include?(@synchronization_type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["NextDayOff", "PreviousDayOff"]
+      if @day_off_rule && !allowed_values.include?(@day_off_rule)
+        return false
+      end
       
       
       
@@ -527,6 +677,59 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] synchronization_type Object to be assigned
+    def synchronization_type=(synchronization_type)
+      allowed_values = ["ShiftStart", "ShiftStartAndPaidDuration"]
+      if synchronization_type && !allowed_values.include?(synchronization_type)
+        fail ArgumentError, "invalid value for 'synchronization_type', must be one of #{allowed_values}."
+      end
+      @synchronization_type = synchronization_type
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] day_off_rule Object to be assigned
+    def day_off_rule=(day_off_rule)
+      allowed_values = ["NextDayOff", "PreviousDayOff"]
+      if day_off_rule && !allowed_values.include?(day_off_rule)
+        fail ArgumentError, "invalid value for 'day_off_rule', must be one of #{allowed_values}."
+      end
+      @day_off_rule = day_off_rule
+    end
+
+    
+    
+    
     
     
     
@@ -554,7 +757,10 @@ module PureCloud
           earliest_start_time_minutes_from_midnight == o.earliest_start_time_minutes_from_midnight &&
           latest_start_time_minutes_from_midnight == o.latest_start_time_minutes_from_midnight &&
           constrain_stop_time == o.constrain_stop_time &&
+          constrain_latest_stop_time == o.constrain_latest_stop_time &&
           latest_stop_time_minutes_from_midnight == o.latest_stop_time_minutes_from_midnight &&
+          constrain_earliest_stop_time == o.constrain_earliest_stop_time &&
+          earliest_stop_time_minutes_from_midnight == o.earliest_stop_time_minutes_from_midnight &&
           start_increment_minutes == o.start_increment_minutes &&
           flexible_paid_time == o.flexible_paid_time &&
           exact_paid_time_minutes == o.exact_paid_time_minutes &&
@@ -563,6 +769,10 @@ module PureCloud
           constrain_contiguous_work_time == o.constrain_contiguous_work_time &&
           minimum_contiguous_work_time_minutes == o.minimum_contiguous_work_time_minutes &&
           maximum_contiguous_work_time_minutes == o.maximum_contiguous_work_time_minutes &&
+          synchronize_agents_schedules == o.synchronize_agents_schedules &&
+          synchronization_type == o.synchronization_type &&
+          constrain_day_off == o.constrain_day_off &&
+          day_off_rule == o.day_off_rule &&
           activities == o.activities &&
           id == o.id &&
           delete == o.delete
@@ -577,7 +787,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, days, flexible_start_time, exact_start_time_minutes_from_midnight, earliest_start_time_minutes_from_midnight, latest_start_time_minutes_from_midnight, constrain_stop_time, latest_stop_time_minutes_from_midnight, start_increment_minutes, flexible_paid_time, exact_paid_time_minutes, minimum_paid_time_minutes, maximum_paid_time_minutes, constrain_contiguous_work_time, minimum_contiguous_work_time_minutes, maximum_contiguous_work_time_minutes, activities, id, delete].hash
+      [name, days, flexible_start_time, exact_start_time_minutes_from_midnight, earliest_start_time_minutes_from_midnight, latest_start_time_minutes_from_midnight, constrain_stop_time, constrain_latest_stop_time, latest_stop_time_minutes_from_midnight, constrain_earliest_stop_time, earliest_stop_time_minutes_from_midnight, start_increment_minutes, flexible_paid_time, exact_paid_time_minutes, minimum_paid_time_minutes, maximum_paid_time_minutes, constrain_contiguous_work_time, minimum_contiguous_work_time_minutes, maximum_contiguous_work_time_minutes, synchronize_agents_schedules, synchronization_type, constrain_day_off, day_off_rule, activities, id, delete].hash
     end
 
     # build the object from hash