purecloudplatformclientv2 83.0.0 → 84.0.0

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -5649,7 +5649,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
     # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.
-    # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts they will not be called until a campaign recycle; False means that updated contacts will be re-queued, according to the 'priority' parameter.
+    # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter.
     # @return [Array<DialerContact>]
     def post_outbound_contactlist_contacts(contact_list_id, body, opts = {})
       data, _status_code, _headers = post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts)
@@ -5663,7 +5663,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :priority Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
     # @option opts [BOOLEAN] :clear_system_data Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t.
-    # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts they will not be called until a campaign recycle; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter.
+    # @option opts [BOOLEAN] :do_not_queue Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter.
     # @return [Array<(Array<DialerContact>, Fixnum, Hash)>] Array<DialerContact> data, response status code and response headers
     def post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {})
       if @api_client.config.debugging

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -2609,6 +2609,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a list of conversations with protected recordings
+    # 
+    # @param body conversationIds
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AddressableEntityRef>]
+    def post_recordings_deletionprotection(body, opts = {})
+      data, _status_code, _headers = post_recordings_deletionprotection_with_http_info(body, opts)
+      return data
+    end
+
+    # Get a list of conversations with protected recordings
+    # 
+    # @param body conversationIds
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AddressableEntityRef>, Fixnum, Hash)>] Array<AddressableEntityRef> data, response status code and response headers
+    def post_recordings_deletionprotection_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi.post_recordings_deletionprotection ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling RecordingApi.post_recordings_deletionprotection" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
+
+      # 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(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 => 'Array<AddressableEntityRef>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordingApi#post_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates the retention records on a recording.
     # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.
     # @param conversation_id Conversation ID
@@ -3216,5 +3281,76 @@ module PureCloud
       end
       return data, status_code, headers
     end
+
+    # Apply or revoke recording protection for conversations
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission) (default to true)
+    # @option opts [ConversationDeletionProtectionQuery] :body 
+    # @return [nil]
+    def put_recordings_deletionprotection(opts = {})
+      put_recordings_deletionprotection_with_http_info(opts)
+      return nil
+    end
+
+    # Apply or revoke recording protection for conversations
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :protect Check for apply, uncheck for revoke (each action requires the respective permission)
+    # @option opts [ConversationDeletionProtectionQuery] :body 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def put_recordings_deletionprotection_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RecordingApi.put_recordings_deletionprotection ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/recordings/deletionprotection".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'protect'] = opts[:'protect'] if opts[:'protect']
+
+      # 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(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RecordingApi#put_recordings_deletionprotection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -5491,7 +5491,7 @@ module PureCloud
     end
 
     # Add a management unit
-    # 
+    # It may take a minute or two for a new management unit to be available for api operations
     # @param [Hash] opts the optional parameters
     # @option opts [CreateManagementUnitApiRequest] :body body
     # @return [ManagementUnit]
@@ -5501,7 +5501,7 @@ module PureCloud
     end
 
     # Add a management unit
-    # 
+    # It may take a minute or two for a new management unit to be available for api operations
     # @param [Hash] opts the optional parameters
     # @option opts [CreateManagementUnitApiRequest] :body body
     # @return [Array<(ManagementUnit, Fixnum, Hash)>] ManagementUnit data, response status code and response headers

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

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -28,13 +28,13 @@ module PureCloud
 
     attr_accessor :first_uri
 
-    attr_accessor :self_uri
-
-    attr_accessor :next_uri
+    attr_accessor :previous_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :previous_uri
+    attr_accessor :self_uri
+
+    attr_accessor :next_uri
 
     attr_accessor :page_count
 
@@ -52,13 +52,13 @@ module PureCloud
         
         :'first_uri' => :'firstUri',
         
-        :'self_uri' => :'selfUri',
-        
-        :'next_uri' => :'nextUri',
+        :'previous_uri' => :'previousUri',
         
         :'last_uri' => :'lastUri',
         
-        :'previous_uri' => :'previousUri',
+        :'self_uri' => :'selfUri',
+        
+        :'next_uri' => :'nextUri',
         
         :'page_count' => :'pageCount'
         
@@ -79,13 +79,13 @@ module PureCloud
         
         :'first_uri' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'next_uri' => :'String',
+        :'previous_uri' => :'String',
         
         :'last_uri' => :'String',
         
-        :'previous_uri' => :'String',
+        :'self_uri' => :'String',
+        
+        :'next_uri' => :'String',
         
         :'page_count' => :'Integer'
         
@@ -148,37 +148,37 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -311,10 +311,10 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           first_uri == o.first_uri &&
+          previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
           self_uri == o.self_uri &&
           next_uri == o.next_uri &&
-          last_uri == o.last_uri &&
-          previous_uri == o.previous_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, last_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, previous_uri, last_uri, self_uri, next_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/adfs.rb

@@ -27,10 +27,10 @@ module PureCloud
 
     attr_accessor :certificate
 
-    attr_accessor :sso_target_uri
-
     attr_accessor :issuer_uri
 
+    attr_accessor :sso_target_uri
+
     attr_accessor :disabled
 
     # The URI for this object
@@ -48,10 +48,10 @@ module PureCloud
         
         :'certificate' => :'certificate',
         
-        :'sso_target_uri' => :'ssoTargetURI',
-        
         :'issuer_uri' => :'issuerURI',
         
+        :'sso_target_uri' => :'ssoTargetURI',
+        
         :'disabled' => :'disabled',
         
         :'self_uri' => :'selfUri'
@@ -71,10 +71,10 @@ module PureCloud
         
         :'certificate' => :'String',
         
-        :'sso_target_uri' => :'String',
-        
         :'issuer_uri' => :'String',
         
+        :'sso_target_uri' => :'String',
+        
         :'disabled' => :'BOOLEAN',
         
         :'self_uri' => :'String'
@@ -127,19 +127,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'ssoTargetURI')
+      if attributes.has_key?(:'issuerURI')
         
         
-        self.sso_target_uri = attributes[:'ssoTargetURI']
+        self.issuer_uri = attributes[:'issuerURI']
         
       
       end
 
       
-      if attributes.has_key?(:'issuerURI')
+      if attributes.has_key?(:'ssoTargetURI')
         
         
-        self.issuer_uri = attributes[:'issuerURI']
+        self.sso_target_uri = attributes[:'ssoTargetURI']
         
       
       end
@@ -262,8 +262,8 @@ module PureCloud
           name == o.name &&
           relying_party_identifier == o.relying_party_identifier &&
           certificate == o.certificate &&
-          sso_target_uri == o.sso_target_uri &&
           issuer_uri == o.issuer_uri &&
+          sso_target_uri == o.sso_target_uri &&
           disabled == o.disabled &&
           self_uri == o.self_uri
     end
@@ -277,7 +277,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, relying_party_identifier, certificate, sso_target_uri, issuer_uri, disabled, self_uri].hash
+      [id, name, relying_party_identifier, certificate, issuer_uri, sso_target_uri, disabled, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -28,13 +28,13 @@ module PureCloud
 
     attr_accessor :first_uri
 
-    attr_accessor :self_uri
-
-    attr_accessor :next_uri
+    attr_accessor :previous_uri
 
     attr_accessor :last_uri
 
-    attr_accessor :previous_uri
+    attr_accessor :self_uri
+
+    attr_accessor :next_uri
 
     attr_accessor :page_count
 
@@ -52,13 +52,13 @@ module PureCloud
         
         :'first_uri' => :'firstUri',
         
-        :'self_uri' => :'selfUri',
-        
-        :'next_uri' => :'nextUri',
+        :'previous_uri' => :'previousUri',
         
         :'last_uri' => :'lastUri',
         
-        :'previous_uri' => :'previousUri',
+        :'self_uri' => :'selfUri',
+        
+        :'next_uri' => :'nextUri',
         
         :'page_count' => :'pageCount'
         
@@ -79,13 +79,13 @@ module PureCloud
         
         :'first_uri' => :'String',
         
-        :'self_uri' => :'String',
-        
-        :'next_uri' => :'String',
+        :'previous_uri' => :'String',
         
         :'last_uri' => :'String',
         
-        :'previous_uri' => :'String',
+        :'self_uri' => :'String',
+        
+        :'next_uri' => :'String',
         
         :'page_count' => :'Integer'
         
@@ -148,37 +148,37 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'selfUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.self_uri = attributes[:'selfUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'selfUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.self_uri = attributes[:'selfUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
@@ -311,10 +311,10 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           first_uri == o.first_uri &&
+          previous_uri == o.previous_uri &&
+          last_uri == o.last_uri &&
           self_uri == o.self_uri &&
           next_uri == o.next_uri &&
-          last_uri == o.last_uri &&
-          previous_uri == o.previous_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, last_uri, previous_uri, page_count].hash
+      [entities, page_size, page_number, total, first_uri, previous_uri, last_uri, self_uri, next_uri, page_count].hash
     end
 
     # build the object from hash