purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb

@@ -25,7 +25,7 @@ module PureCloud
     # The description of coaching appointment.
     attr_accessor :description
 
-    # The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_start
 
     # The duration of coaching appointment in minutes.
@@ -37,6 +37,9 @@ module PureCloud
     # IDs of documents associated with this coaching appointment.
     attr_accessor :document_ids
 
+    # The status of the coaching appointment.
+    attr_accessor :status
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,7 +54,9 @@ module PureCloud
         
         :'conversation_ids' => :'conversationIds',
         
-        :'document_ids' => :'documentIds'
+        :'document_ids' => :'documentIds',
+        
+        :'status' => :'status'
         
       }
     end
@@ -70,7 +75,9 @@ module PureCloud
         
         :'conversation_ids' => :'Array<String>',
         
-        :'document_ids' => :'Array<String>'
+        :'document_ids' => :'Array<String>',
+        
+        :'status' => :'String'
         
       }
     end
@@ -142,6 +149,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'status')
+        
+        
+        self.status = attributes[:'status']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -178,6 +194,15 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"]
+      if @status && !allowed_values.include?(@status)
+        return false
+      end
       
       
       
@@ -211,6 +236,20 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"]
+      if status && !allowed_values.include?(status)
+        fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
+      end
+      @status = status
+    end
+
     
     
     
@@ -224,7 +263,8 @@ module PureCloud
           date_start == o.date_start &&
           length_in_minutes == o.length_in_minutes &&
           conversation_ids == o.conversation_ids &&
-          document_ids == o.document_ids
+          document_ids == o.document_ids &&
+          status == o.status
     end
 
     # @see the `==` method
@@ -236,7 +276,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, description, date_start, length_in_minutes, conversation_ids, document_ids].hash
+      [name, description, date_start, length_in_minutes, conversation_ids, document_ids, status].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/user_routing_language.rb

@@ -17,20 +17,20 @@ Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
 require 'date'
 
 module PureCloud
-  # Represents an organization langauge assigned to a user. When assigning to a user specify the organization language id as the id.
+  # Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
   class UserRoutingLanguage
     # The globally unique identifier for the object.
     attr_accessor :id
 
     attr_accessor :name
 
-    # Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings.
+    # A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
     attr_accessor :proficiency
 
-    # Activate or deactivate this routing langauge.
+    # Activate or deactivate this routing language.
     attr_accessor :state
 
-    # URI to the organization language used by this user langauge.
+    # URI to the organization language used by this user language.
     attr_accessor :language_uri
 
     # The URI for this object

data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb

@@ -25,7 +25,7 @@ module PureCloud
     # Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings.
     attr_accessor :proficiency
 
-    # URI to the organization language used by this user langauge.
+    # URI to the organization language used by this user language.
     attr_accessor :language_uri
 
     # The URI for this object

data/lib/purecloudplatformclientv2/models/user_routing_skill.rb

@@ -24,7 +24,7 @@ module PureCloud
 
     attr_accessor :name
 
-    # Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings.
+    # A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
     attr_accessor :proficiency
 
     # Activate or deactivate this routing skill.

data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb

@@ -29,6 +29,9 @@ module PureCloud
     # The management unit to which this user belongs
     attr_accessor :management_unit
 
+    # The team to which this user belongs
+    attr_accessor :team
+
     # Activity for which the user is scheduled
     attr_accessor :scheduled_activity_category
 
@@ -83,6 +86,8 @@ module PureCloud
         
         :'management_unit' => :'managementUnit',
         
+        :'team' => :'team',
+        
         :'scheduled_activity_category' => :'scheduledActivityCategory',
         
         :'system_presence' => :'systemPresence',
@@ -126,6 +131,8 @@ module PureCloud
         
         :'management_unit' => :'ManagementUnit',
         
+        :'team' => :'Team',
+        
         :'scheduled_activity_category' => :'String',
         
         :'system_presence' => :'String',
@@ -202,6 +209,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'team')
+        
+        
+        self.team = attributes[:'team']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'scheduledActivityCategory')
         
         
@@ -360,6 +376,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -465,6 +485,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -603,6 +628,7 @@ module PureCloud
           name == o.name &&
           user == o.user &&
           management_unit == o.management_unit &&
+          team == o.team &&
           scheduled_activity_category == o.scheduled_activity_category &&
           system_presence == o.system_presence &&
           organization_secondary_presence_id == o.organization_secondary_presence_id &&
@@ -628,7 +654,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, user, management_unit, scheduled_activity_category, system_presence, organization_secondary_presence_id, routing_status, actual_activity_category, is_out_of_office, adherence_state, impact, time_of_adherence_change, presence_update_time, active_queues, active_queues_modified_time, removed_from_management_unit, self_uri].hash
+      [id, name, user, management_unit, team, scheduled_activity_category, system_presence, organization_secondary_presence_id, routing_status, actual_activity_category, is_out_of_office, adherence_state, impact, time_of_adherence_change, presence_update_time, active_queues, active_queues_modified_time, removed_from_management_unit, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/user_search_request.rb

@@ -38,6 +38,12 @@ module PureCloud
 
     attr_accessor :query
 
+    # Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
+    attr_accessor :integration_presence_source
+
+    # Enforce view permission on request
+    attr_accessor :enforce_permissions
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -54,7 +60,11 @@ module PureCloud
         
         :'expand' => :'expand',
         
-        :'query' => :'query'
+        :'query' => :'query',
+        
+        :'integration_presence_source' => :'integrationPresenceSource',
+        
+        :'enforce_permissions' => :'enforcePermissions'
         
       }
     end
@@ -75,7 +85,11 @@ module PureCloud
         
         :'expand' => :'Array<String>',
         
-        :'query' => :'Array<UserSearchCriteria>'
+        :'query' => :'Array<UserSearchCriteria>',
+        
+        :'integration_presence_source' => :'String',
+        
+        :'enforce_permissions' => :'BOOLEAN'
         
       }
     end
@@ -158,6 +172,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'integrationPresenceSource')
+        
+        
+        self.integration_presence_source = attributes[:'integrationPresenceSource']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'enforcePermissions')
+        
+        
+        self.enforce_permissions = attributes[:'enforcePermissions']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,6 +231,19 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["MicrosoftTeams", "ZoomPhone"]
+      if @integration_presence_source && !allowed_values.include?(@integration_presence_source)
+        return false
+      end
       
       
       
@@ -245,6 +290,25 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] integration_presence_source Object to be assigned
+    def integration_presence_source=(integration_presence_source)
+      allowed_values = ["MicrosoftTeams", "ZoomPhone"]
+      if integration_presence_source && !allowed_values.include?(integration_presence_source)
+        fail ArgumentError, "invalid value for 'integration_presence_source', must be one of #{allowed_values}."
+      end
+      @integration_presence_source = integration_presence_source
+    end
+
     
     
     
@@ -264,7 +328,9 @@ module PureCloud
           page_number == o.page_number &&
           sort == o.sort &&
           expand == o.expand &&
-          query == o.query
+          query == o.query &&
+          integration_presence_source == o.integration_presence_source &&
+          enforce_permissions == o.enforce_permissions
     end
 
     # @see the `==` method
@@ -276,7 +342,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [sort_order, sort_by, page_size, page_number, sort, expand, query].hash
+      [sort_order, sort_by, page_size, page_number, sort, expand, query, integration_presence_source, enforce_permissions].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/video.rb

@@ -66,6 +66,9 @@ module PureCloud
     # Call wrap up or disposition data.
     attr_accessor :wrapup
 
+    # After-call work for the communication.
+    attr_accessor :after_call_work
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -100,7 +103,9 @@ module PureCloud
         
         :'_self' => :'self',
         
-        :'wrapup' => :'wrapup'
+        :'wrapup' => :'wrapup',
+        
+        :'after_call_work' => :'afterCallWork'
         
       }
     end
@@ -139,7 +144,9 @@ module PureCloud
         
         :'_self' => :'Address',
         
-        :'wrapup' => :'Wrapup'
+        :'wrapup' => :'Wrapup',
+        
+        :'after_call_work' => :'AfterCallWork'
         
       }
     end
@@ -299,6 +306,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'afterCallWork')
+        
+        
+        self.after_call_work = attributes[:'afterCallWork']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -383,6 +399,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
       
       
@@ -483,6 +503,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -509,7 +534,8 @@ module PureCloud
           peer_id == o.peer_id &&
           msids == o.msids &&
           _self == o._self &&
-          wrapup == o.wrapup
+          wrapup == o.wrapup &&
+          after_call_work == o.after_call_work
     end
 
     # @see the `==` method
@@ -521,7 +547,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [state, id, context, audio_muted, video_muted, sharing_screen, peer_count, disconnect_type, start_alerting_time, connected_time, disconnected_time, provider, peer_id, msids, _self, wrapup].hash
+      [state, id, context, audio_muted, video_muted, sharing_screen, peer_count, disconnect_type, start_alerting_time, connected_time, disconnected_time, provider, peer_id, msids, _self, wrapup, after_call_work].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/view_filter.rb

@@ -258,6 +258,12 @@ module PureCloud
     # An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
     attr_accessor :callback_interval
 
+    # A list of routing types used
+    attr_accessor :used_routing_types
+
+    # A list of routing types requested
+    attr_accessor :requested_routing_types
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -420,7 +426,11 @@ module PureCloud
         
         :'callback_number_list' => :'callbackNumberList',
         
-        :'callback_interval' => :'callbackInterval'
+        :'callback_interval' => :'callbackInterval',
+        
+        :'used_routing_types' => :'usedRoutingTypes',
+        
+        :'requested_routing_types' => :'requestedRoutingTypes'
         
       }
     end
@@ -587,7 +597,11 @@ module PureCloud
         
         :'callback_number_list' => :'Array<String>',
         
-        :'callback_interval' => :'String'
+        :'callback_interval' => :'String',
+        
+        :'used_routing_types' => :'Array<String>',
+        
+        :'requested_routing_types' => :'Array<String>'
         
       }
     end
@@ -1437,6 +1451,28 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'usedRoutingTypes')
+        
+        if (value = attributes[:'usedRoutingTypes']).is_a?(Array)
+          self.used_routing_types = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'requestedRoutingTypes')
+        
+        if (value = attributes[:'requestedRoutingTypes']).is_a?(Array)
+          self.requested_routing_types = value
+        end
+        
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1763,6 +1799,14 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2164,6 +2208,16 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2259,7 +2313,9 @@ module PureCloud
           flow_out_types == o.flow_out_types &&
           provider_list == o.provider_list &&
           callback_number_list == o.callback_number_list &&
-          callback_interval == o.callback_interval
+          callback_interval == o.callback_interval &&
+          used_routing_types == o.used_routing_types &&
+          requested_routing_types == o.requested_routing_types
     end
 
     # @see the `==` method
@@ -2271,7 +2327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [media_types, queue_ids, skill_ids, skill_groups, language_ids, language_groups, directions, originating_directions, wrap_up_codes, dnis_list, session_dnis_list, filter_queues_by_user_ids, filter_users_by_queue_ids, user_ids, address_tos, address_froms, outbound_campaign_ids, outbound_contact_list_ids, contact_ids, external_contact_ids, external_org_ids, ani_list, durations_milliseconds, acd_durations_milliseconds, talk_durations_milliseconds, acw_durations_milliseconds, handle_durations_milliseconds, hold_durations_milliseconds, abandon_durations_milliseconds, evaluation_score, evaluation_critical_score, evaluation_form_ids, evaluated_agent_ids, evaluator_ids, transferred, abandoned, answered, message_types, division_ids, survey_form_ids, survey_total_score, survey_nps_score, mos, survey_question_group_score, survey_promoter_score, survey_form_context_ids, conversation_ids, sip_call_ids, is_ended, is_surveyed, survey_scores, promoter_scores, is_campaign, survey_statuses, conversation_properties, is_blind_transferred, is_consulted, is_consult_transferred, remote_participants, flow_ids, flow_outcome_ids, flow_outcome_values, flow_destination_types, flow_disconnect_reasons, flow_types, flow_entry_types, flow_entry_reasons, flow_versions, group_ids, has_journey_customer_id, has_journey_action_map_id, has_journey_visit_id, has_media, role_ids, reports_tos, location_ids, flow_out_types, provider_list, callback_number_list, callback_interval].hash
+      [media_types, queue_ids, skill_ids, skill_groups, language_ids, language_groups, directions, originating_directions, wrap_up_codes, dnis_list, session_dnis_list, filter_queues_by_user_ids, filter_users_by_queue_ids, user_ids, address_tos, address_froms, outbound_campaign_ids, outbound_contact_list_ids, contact_ids, external_contact_ids, external_org_ids, ani_list, durations_milliseconds, acd_durations_milliseconds, talk_durations_milliseconds, acw_durations_milliseconds, handle_durations_milliseconds, hold_durations_milliseconds, abandon_durations_milliseconds, evaluation_score, evaluation_critical_score, evaluation_form_ids, evaluated_agent_ids, evaluator_ids, transferred, abandoned, answered, message_types, division_ids, survey_form_ids, survey_total_score, survey_nps_score, mos, survey_question_group_score, survey_promoter_score, survey_form_context_ids, conversation_ids, sip_call_ids, is_ended, is_surveyed, survey_scores, promoter_scores, is_campaign, survey_statuses, conversation_properties, is_blind_transferred, is_consulted, is_consult_transferred, remote_participants, flow_ids, flow_outcome_ids, flow_outcome_values, flow_destination_types, flow_disconnect_reasons, flow_types, flow_entry_types, flow_entry_reasons, flow_versions, group_ids, has_journey_customer_id, has_journey_action_map_id, has_journey_visit_id, has_media, role_ids, reports_tos, location_ids, flow_out_types, provider_list, callback_number_list, callback_interval, used_routing_types, requested_routing_types].hash
     end
 
     # build the object from hash