purecloudplatformclientv2 14.0.0 → 14.1.0

data/docs/VoicemailMessage.md

@@ -24,6 +24,7 @@ title: VoicemailMessage
 | **queue** | [**Queue**](Queue.html) | The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group | [optional] |
 | **copied_from** | [**VoicemailCopyRecord**](VoicemailCopyRecord.html) | Represents where this voicemail message was copied from | [optional] |
 | **copied_to** | [**Array<VoicemailCopyRecord>**](VoicemailCopyRecord.html) | Represents where this voicemail has been copied to | [optional] |
+| **retention_policy** | [**VoicemailRetentionPolicy**](VoicemailRetentionPolicy.html) | The retention policy for this voicemail | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/VoicemailRetentionPolicy.md

@@ -0,0 +1,14 @@
+---
+title: VoicemailRetentionPolicy
+---
+## PureCloud::VoicemailRetentionPolicy
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **voicemail_retention_policy_type** | **String** | The retention policy type | [optional] |
+| **number_of_days** | **Integer** | If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL | [optional] |
+{: class="table table-striped"}
+
+

data/lib/purecloudplatformclientv2.rb

@@ -572,6 +572,7 @@ require 'purecloudplatformclientv2/models/library_entity_listing'
 require 'purecloudplatformclientv2/models/license_assignment_request'
 require 'purecloudplatformclientv2/models/license_batch_assignment_request'
 require 'purecloudplatformclientv2/models/license_definition'
+require 'purecloudplatformclientv2/models/license_org_toggle'
 require 'purecloudplatformclientv2/models/license_organization'
 require 'purecloudplatformclientv2/models/license_update_status'
 require 'purecloudplatformclientv2/models/license_user'
@@ -962,6 +963,7 @@ require 'purecloudplatformclientv2/models/voicemail_message'
 require 'purecloudplatformclientv2/models/voicemail_message_entity_listing'
 require 'purecloudplatformclientv2/models/voicemail_message_notification'
 require 'purecloudplatformclientv2/models/voicemail_organization_policy'
+require 'purecloudplatformclientv2/models/voicemail_retention_policy'
 require 'purecloudplatformclientv2/models/voicemail_search_criteria'
 require 'purecloudplatformclientv2/models/voicemail_search_request'
 require 'purecloudplatformclientv2/models/voicemail_user_policy'

data/lib/purecloudplatformclientv2/api/license_api.rb

@@ -199,6 +199,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get PureCloud license feature toggle value.
+    # 
+    # @param feature_name featureName
+    # @param [Hash] opts the optional parameters
+    # @return [LicenseOrgToggle]
+    def get_license_toggle(feature_name, opts = {})
+      data, _status_code, _headers = get_license_toggle_with_http_info(feature_name, opts)
+      return data
+    end
+
+    # Get PureCloud license feature toggle value.
+    # 
+    # @param feature_name featureName
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LicenseOrgToggle, Fixnum, Hash)>] LicenseOrgToggle data, response status code and response headers
+    def get_license_toggle_with_http_info(feature_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: LicenseApi.get_license_toggle ..."
+      end
+      
+      
+      # verify the required parameter 'feature_name' is set
+      fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.get_license_toggle" if feature_name.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'LicenseOrgToggle')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LicenseApi#get_license_toggle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get licenses for specified user.
     # 
     # @param user_id ID
@@ -327,6 +392,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Switch PureCloud license feature toggle value.
+    # 
+    # @param feature_name featureName
+    # @param [Hash] opts the optional parameters
+    # @return [LicenseOrgToggle]
+    def post_license_toggle(feature_name, opts = {})
+      data, _status_code, _headers = post_license_toggle_with_http_info(feature_name, opts)
+      return data
+    end
+
+    # Switch PureCloud license feature toggle value.
+    # 
+    # @param feature_name featureName
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LicenseOrgToggle, Fixnum, Hash)>] LicenseOrgToggle data, response status code and response headers
+    def post_license_toggle_with_http_info(feature_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: LicenseApi.post_license_toggle ..."
+      end
+      
+      
+      # verify the required parameter 'feature_name' is set
+      fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.post_license_toggle" if feature_name.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.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 = nil
+      
+      auth_names = ['PureCloud Auth']
+      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 => 'LicenseOrgToggle')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LicenseApi#post_license_toggle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Fetch user licenses in a batch.
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -2691,7 +2691,7 @@ module PureCloud
     # Update an OutOfOffice
     # 
     # @param user_id User ID
-    # @param body The updated UserPresence
+    # @param body The updated OutOffOffice
     # @param [Hash] opts the optional parameters
     # @return [OutOfOffice]
     def put_user_outofoffice(user_id, body, opts = {})
@@ -2702,7 +2702,7 @@ module PureCloud
     # Update an OutOfOffice
     # 
     # @param user_id User ID
-    # @param body The updated UserPresence
+    # @param body The updated OutOffOffice
     # @param [Hash] opts the optional parameters
     # @return [Array<(OutOfOffice, Fixnum, Hash)>] OutOfOffice data, response status code and response headers
     def put_user_outofoffice_with_http_info(user_id, body, opts = {})

data/lib/purecloudplatformclientv2/api/voicemail_api.rb

@@ -24,8 +24,8 @@ module PureCloud
       @api_client = api_client
     end
 
-    # Delete a message.
-    # 
+    # Delete a voicemail message.
+    # A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -34,8 +34,8 @@ module PureCloud
       return nil
     end
 
-    # Delete a message.
-    # 
+    # Delete a voicemail message.
+    # A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -593,7 +593,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get message.
+    # Get a voicemail message
     # 
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
@@ -604,7 +604,7 @@ module PureCloud
       return data
     end
 
-    # Get message.
+    # Get a voicemail message
     # 
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
@@ -667,7 +667,7 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get media playback URI for this message
+    # Get media playback URI for this voicemail message
     # 
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
@@ -678,7 +678,7 @@ module PureCloud
       return data
     end
 
-    # Get media playback URI for this message
+    # Get media playback URI for this voicemail message
     # 
     # @param message_id Message ID
     # @param [Hash] opts the optional parameters
@@ -1153,6 +1153,81 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update a voicemail message
+    # A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
+    # @param message_id Message ID
+    # @param body VoicemailMessage
+    # @param [Hash] opts the optional parameters
+    # @return [VoicemailMessage]
+    def patch_voicemail_message(message_id, body, opts = {})
+      data, _status_code, _headers = patch_voicemail_message_with_http_info(message_id, body, opts)
+      return data
+    end
+
+    # Update a voicemail message
+    # A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
+    # @param message_id Message ID
+    # @param body VoicemailMessage
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VoicemailMessage, Fixnum, Hash)>] VoicemailMessage data, response status code and response headers
+    def patch_voicemail_message_with_http_info(message_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: VoicemailApi.patch_voicemail_message ..."
+      end
+      
+      
+      # verify the required parameter 'message_id' is set
+      fail ArgumentError, "Missing the required parameter 'message_id' when calling VoicemailApi.patch_voicemail_message" if message_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling VoicemailApi.patch_voicemail_message" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/voicemail/messages/{messageId}".sub('{format}','json').sub('{' + 'messageId' + '}', message_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(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 => 'VoicemailMessage')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: VoicemailApi#patch_voicemail_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a user's voicemail policy
     # 
     # @param user_id User ID
@@ -1356,8 +1431,8 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Update a message.
-    # 
+    # Update a voicemail message
+    # A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
     # @param message_id Message ID
     # @param body VoicemailMessage
     # @param [Hash] opts the optional parameters
@@ -1367,8 +1442,8 @@ module PureCloud
       return data
     end
 
-    # Update a message.
-    # 
+    # Update a voicemail message
+    # A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
     # @param message_id Message ID
     # @param body VoicemailMessage
     # @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'] = '14.0.0'
+      header_params['purecloud-sdk'] = '14.1.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/activity_code.rb

@@ -199,7 +199,7 @@ module PureCloud
       
       
       
-      allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable"]
+      allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
       if @category && !allowed_values.include?(@category)
         return false
       end
@@ -244,7 +244,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] category Object to be assigned
     def category=(category)
-      allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable"]
+      allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
       if category && !allowed_values.include?(category)
         fail ArgumentError, "invalid value for 'category', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/certificate_details.rb

@@ -34,10 +34,10 @@ module PureCloud
     # True if the certificate is expired, false otherwise.
     attr_accessor :expired
 
-    attr_accessor :signature_valid
-
     attr_accessor :valid
 
+    attr_accessor :signature_valid
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -52,9 +52,9 @@ module PureCloud
         
         :'expired' => :'expired',
         
-        :'signature_valid' => :'signatureValid',
+        :'valid' => :'valid',
         
-        :'valid' => :'valid'
+        :'signature_valid' => :'signatureValid'
         
       }
     end
@@ -73,9 +73,9 @@ module PureCloud
         
         :'expired' => :'BOOLEAN',
         
-        :'signature_valid' => :'BOOLEAN',
+        :'valid' => :'BOOLEAN',
         
-        :'valid' => :'BOOLEAN'
+        :'signature_valid' => :'BOOLEAN'
         
       }
     end
@@ -134,19 +134,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'signatureValid')
+      if attributes.has_key?(:'valid')
         
         
-        self.signature_valid = attributes[:'signatureValid']
+        self.valid = attributes[:'valid']
         
       
       end
 
       
-      if attributes.has_key?(:'valid')
+      if attributes.has_key?(:'signatureValid')
         
         
-        self.valid = attributes[:'valid']
+        self.signature_valid = attributes[:'signatureValid']
         
       
       end
@@ -243,8 +243,8 @@ module PureCloud
           expiration_date == o.expiration_date &&
           issue_date == o.issue_date &&
           expired == o.expired &&
-          signature_valid == o.signature_valid &&
-          valid == o.valid
+          valid == o.valid &&
+          signature_valid == o.signature_valid
     end
 
     # @see the `==` method
@@ -256,7 +256,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [issuer, subject, expiration_date, issue_date, expired, signature_valid, valid].hash
+      [issuer, subject, expiration_date, issue_date, expired, valid, signature_valid].hash
     end
 
     # build the object from hash