purecloudplatformclientv2 84.0.0 → 88.0.0

data/lib/purecloudplatformclientv2/api/recording_api.rb

@@ -374,6 +374,7 @@ module PureCloud
     # @option opts [String] :format_id The desired media format. (default to WEBM)
     # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
     # @option opts [String] :file_name the name of the downloaded fileName
+    # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
     # @return [Recording]
     def get_conversation_recording(conversation_id, recording_id, opts = {})
       data, _status_code, _headers = get_conversation_recording_with_http_info(conversation_id, recording_id, opts)
@@ -388,6 +389,7 @@ module PureCloud
     # @option opts [String] :format_id The desired media format.
     # @option opts [BOOLEAN] :download requesting a download format of the recording
     # @option opts [String] :file_name the name of the downloaded fileName
+    # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
     # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
     def get_conversation_recording_with_http_info(conversation_id, recording_id, opts = {})
       if @api_client.config.debugging
@@ -430,6 +432,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       # resource path
@@ -440,6 +448,7 @@ module PureCloud
       query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
       query_params[:'download'] = opts[:'download'] if opts[:'download']
       query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
+      query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
 
       # header parameters
       header_params = {}
@@ -931,6 +940,7 @@ module PureCloud
     # @option opts [String] :format_id The desired media format. (default to WEBM)
     # @option opts [BOOLEAN] :download requesting a download format of the recording (default to false)
     # @option opts [String] :file_name the name of the downloaded fileName
+    # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
     # @return [Recording]
     def get_orphanrecording_media(orphan_id, opts = {})
       data, _status_code, _headers = get_orphanrecording_media_with_http_info(orphan_id, opts)
@@ -944,6 +954,7 @@ module PureCloud
     # @option opts [String] :format_id The desired media format.
     # @option opts [BOOLEAN] :download requesting a download format of the recording
     # @option opts [String] :file_name the name of the downloaded fileName
+    # @option opts [String] :locale The locale for the requested file when downloading, as an ISO 639-1 code
     # @return [Array<(Recording, Fixnum, Hash)>] Recording data, response status code and response headers
     def get_orphanrecording_media_with_http_info(orphan_id, opts = {})
       if @api_client.config.debugging
@@ -978,6 +989,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       # resource path
@@ -988,6 +1005,7 @@ module PureCloud
       query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
       query_params[:'download'] = opts[:'download'] if opts[:'download']
       query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
+      query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
 
       # header parameters
       header_params = {}
@@ -2927,8 +2945,8 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Execute the recording bulk job
-    # 
+    # Execute the recording bulk job.
+    # A job must be executed by the same user whom originally created the job.  In addition, the user must have permission to update the recording's retention.
     # @param job_id jobId
     # @param body query
     # @param [Hash] opts the optional parameters
@@ -2938,8 +2956,8 @@ module PureCloud
       return data
     end
 
-    # Execute the recording bulk job
-    # 
+    # Execute the recording bulk job.
+    # A job must be executed by the same user whom originally created the job.  In addition, the user must have permission to update the recording&#39;s retention.
     # @param job_id jobId
     # @param body query
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/routing_api.rb

@@ -501,6 +501,70 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete an Address by Id for SMS
+    # 
+    # @param address_id Address ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_routing_sms_address(address_id, opts = {})
+      delete_routing_sms_address_with_http_info(address_id, opts)
+      return nil
+    end
+
+    # Delete an Address by Id for SMS
+    # 
+    # @param address_id Address ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_routing_sms_address_with_http_info(address_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_sms_address ..."
+      end
+      
+      
+      # verify the required parameter 'address_id' is set
+      fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.delete_routing_sms_address" if address_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/routing/sms/addresses/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_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 = nil
+      
+      auth_names = ['PureCloud OAuth']
+      data, status_code, headers = @api_client.call_api(:DELETE, 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: RoutingApi#delete_routing_sms_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a phone number provisioned for SMS.
     # 
     # @param address_id Address ID
@@ -3723,6 +3787,81 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update domain settings
+    # 
+    # @param domain_id domain ID
+    # @param body Domain settings
+    # @param [Hash] opts the optional parameters
+    # @return [InboundDomain]
+    def patch_routing_email_domain(domain_id, body, opts = {})
+      data, _status_code, _headers = patch_routing_email_domain_with_http_info(domain_id, body, opts)
+      return data
+    end
+
+    # Update domain settings
+    # 
+    # @param domain_id domain ID
+    # @param body Domain settings
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InboundDomain, Fixnum, Hash)>] InboundDomain data, response status code and response headers
+    def patch_routing_email_domain_with_http_info(domain_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.patch_routing_email_domain ..."
+      end
+      
+      
+      # verify the required parameter 'domain_id' is set
+      fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.patch_routing_email_domain" if domain_id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_routing_email_domain" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_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 OAuth']
+      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 => 'InboundDomain')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#patch_routing_email_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update the ring number OR joined status for a User in a Queue
     # 
     # @param queue_id Queue ID
@@ -4491,6 +4630,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Tests the custom SMTP server integration connection set on this domain
+    # The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.
+    # @param domain_id domain ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [TestMessage] :body TestMessage
+    # @return [TestMessage]
+    def post_routing_email_domain_testconnection(domain_id, opts = {})
+      data, _status_code, _headers = post_routing_email_domain_testconnection_with_http_info(domain_id, opts)
+      return data
+    end
+
+    # Tests the custom SMTP server integration connection set on this domain
+    # The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.
+    # @param domain_id domain ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [TestMessage] :body TestMessage
+    # @return [Array<(TestMessage, Fixnum, Hash)>] TestMessage data, response status code and response headers
+    def post_routing_email_domain_testconnection_with_http_info(domain_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_email_domain_testconnection ..."
+      end
+      
+      
+      # verify the required parameter 'domain_id' is set
+      fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.post_routing_email_domain_testconnection" if domain_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/routing/email/domains/{domainId}/testconnection".sub('{format}','json').sub('{' + 'domainId' + '}', domain_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(opts[:'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 => 'TestMessage')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: RoutingApi#post_routing_email_domain_testconnection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a domain
     # 
     # @param body Domain

data/lib/purecloudplatformclientv2/api/scim_api.rb

@@ -837,7 +837,7 @@ module PureCloud
     # 
     # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
     # @return [ScimV2User]
@@ -850,7 +850,7 @@ module PureCloud
     # 
     # @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
     # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
@@ -930,7 +930,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
     # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
     # @return [ScimUserListResponse]
@@ -944,7 +944,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :start_index The 1-based index of the first query result.
     # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
     # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
@@ -1546,7 +1546,7 @@ module PureCloud
     # 
     # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
     # @return [ScimV2User]
@@ -1559,7 +1559,7 @@ module PureCloud
     # 
     # @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
     # @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
@@ -1639,7 +1639,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
     # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;. (default to 25)
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
     # @return [ScimUserListResponse]
@@ -1653,7 +1653,7 @@ module PureCloud
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :start_index The 1-based index of the first query result.
     # @option opts [Integer] :count The requested number of items per page. A value of 0 returns \&quot;totalResults\&quot;.
-    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes ant the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
+    # @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, and &#39;meta&#39; attributes. Use \&quot;attributes\&quot; to avoid expensive secondary calls for the default attributes.
     # @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes minus \&quot;excludedAttributes\&quot;. Use \&quot;excludedAttributes\&quot; to avoid expensive secondary calls for the default attributes. The &#39;id&#39;, &#39;userName&#39;, &#39;active&#39;, &#39;meta&#39; attributes  will always be present in output.
     # @option opts [String] :filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \&quot;id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\&quot;, \&quot;userName eq search@sample.org\&quot;, \&quot;manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\&quot;, \&quot;email eq search@sample.org\&quot;, \&quot;division eq divisionName\&quot;, \&quot;externalId eq 167844\&quot;, \&quot;active eq false\&quot;.
     # @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers

data/lib/purecloudplatformclientv2/api/search_api.rb

@@ -819,6 +819,79 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Search Documents
+    # 
+    # @param knowledge_base_id Knowledge base ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [KnowledgeSearchRequest] :body 
+    # @return [KnowledgeSearchResponse]
+    def post_knowledge_knowledgebase_search(knowledge_base_id, opts = {})
+      data, _status_code, _headers = post_knowledge_knowledgebase_search_with_http_info(knowledge_base_id, opts)
+      return data
+    end
+
+    # Search Documents
+    # 
+    # @param knowledge_base_id Knowledge base ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [KnowledgeSearchRequest] :body 
+    # @return [Array<(KnowledgeSearchResponse, Fixnum, Hash)>] KnowledgeSearchResponse data, response status code and response headers
+    def post_knowledge_knowledgebase_search_with_http_info(knowledge_base_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SearchApi.post_knowledge_knowledgebase_search ..."
+      end
+      
+      
+      # verify the required parameter 'knowledge_base_id' is set
+      fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling SearchApi.post_knowledge_knowledgebase_search" if knowledge_base_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search".sub('{format}','json').sub('{' + 'knowledgeBaseId' + '}', knowledge_base_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(opts[:'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 => 'KnowledgeSearchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SearchApi#post_knowledge_knowledgebase_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search locations
     # 
     # @param body Search request options