purecloudplatformclientv2 71.0.0 → 72.0.0

data/lib/purecloudplatformclientv2/api/analytics_api.rb

@@ -152,6 +152,70 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete/cancel an async request
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_analytics_users_details_job(job_id, opts = {})
+      delete_analytics_users_details_job_with_http_info(job_id, opts)
+      return nil
+    end
+
+    # Delete/cancel an async request
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_analytics_users_details_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.delete_analytics_users_details_job ..."
+      end
+      
+      
+      # verify the required parameter 'job_id' is set
+      fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.delete_analytics_users_details_job" if job_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_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: AnalyticsApi#delete_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a conversation by id
     # 
     # @param conversation_id conversationId
@@ -1102,6 +1166,145 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get status for async query for user details
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncQueryStatus]
+    def get_analytics_users_details_job(job_id, opts = {})
+      data, _status_code, _headers = get_analytics_users_details_job_with_http_info(job_id, opts)
+      return data
+    end
+
+    # Get status for async query for user details
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncQueryStatus, Fixnum, Hash)>] AsyncQueryStatus data, response status code and response headers
+    def get_analytics_users_details_job_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_users_details_job ..."
+      end
+      
+      
+      # verify the required parameter 'job_id' is set
+      fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_users_details_job" if job_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}".sub('{format}','json').sub('{' + 'jobId' + '}', job_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(: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 => 'AsyncQueryStatus')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_users_details_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch a page of results for an async query
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
+    # @return [AnalyticsUserDetailsAsyncQueryResponse]
+    def get_analytics_users_details_job_results(job_id, opts = {})
+      data, _status_code, _headers = get_analytics_users_details_job_results_with_http_info(job_id, opts)
+      return data
+    end
+
+    # Fetch a page of results for an async query
+    # 
+    # @param job_id jobId
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
+    # @return [Array<(AnalyticsUserDetailsAsyncQueryResponse, Fixnum, Hash)>] AnalyticsUserDetailsAsyncQueryResponse data, response status code and response headers
+    def get_analytics_users_details_job_results_with_http_info(job_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.get_analytics_users_details_job_results ..."
+      end
+      
+      
+      # verify the required parameter 'job_id' is set
+      fail ArgumentError, "Missing the required parameter 'job_id' when calling AnalyticsApi.get_analytics_users_details_job_results" if job_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/users/details/jobs/{jobId}/results".sub('{format}','json').sub('{' + 'jobId' + '}', job_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+
+      # 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(: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 => 'AnalyticsUserDetailsAsyncQueryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#get_analytics_users_details_job_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Index conversation properties
     # 
     # @param conversation_id conversationId
@@ -1957,6 +2160,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Query for user details asynchronously
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncQueryResponse]
+    def post_analytics_users_details_jobs(body, opts = {})
+      data, _status_code, _headers = post_analytics_users_details_jobs_with_http_info(body, opts)
+      return data
+    end
+
+    # Query for user details asynchronously
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncQueryResponse, Fixnum, Hash)>] AsyncQueryResponse data, response status code and response headers
+    def post_analytics_users_details_jobs_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsApi.post_analytics_users_details_jobs ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AnalyticsApi.post_analytics_users_details_jobs" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/analytics/users/details/jobs".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 => 'AsyncQueryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsApi#post_analytics_users_details_jobs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Query for user details
     # 
     # @param body query

data/lib/purecloudplatformclientv2/api/audit_api.rb

@@ -0,0 +1,240 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require "uri"
+
+module PureCloud
+  class AuditApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get status of audit query execution
+    # 
+    # @param transaction_id Transaction ID
+    # @param [Hash] opts the optional parameters
+    # @return [AuditQueryExecutionStatusResponse]
+    def get_audits_query_transaction_id(transaction_id, opts = {})
+      data, _status_code, _headers = get_audits_query_transaction_id_with_http_info(transaction_id, opts)
+      return data
+    end
+
+    # Get status of audit query execution
+    # 
+    # @param transaction_id Transaction ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuditQueryExecutionStatusResponse, Fixnum, Hash)>] AuditQueryExecutionStatusResponse data, response status code and response headers
+    def get_audits_query_transaction_id_with_http_info(transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_transaction_id ..."
+      end
+      
+      
+      # verify the required parameter 'transaction_id' is set
+      fail ArgumentError, "Missing the required parameter 'transaction_id' when calling AuditApi.get_audits_query_transaction_id" if transaction_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/audits/query/{transactionId}".sub('{format}','json').sub('{' + 'transactionId' + '}', transaction_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(: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 => 'AuditQueryExecutionStatusResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuditApi#get_audits_query_transaction_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get results of audit query
+    # 
+    # @param transaction_id Transaction ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @return [AuditQueryExecutionResultsResponse]
+    def get_audits_query_transaction_id_results(transaction_id, opts = {})
+      data, _status_code, _headers = get_audits_query_transaction_id_results_with_http_info(transaction_id, opts)
+      return data
+    end
+
+    # Get results of audit query
+    # 
+    # @param transaction_id Transaction ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor Indicates where to resume query results (not required for first page)
+    # @option opts [Integer] :page_size Page size
+    # @return [Array<(AuditQueryExecutionResultsResponse, Fixnum, Hash)>] AuditQueryExecutionResultsResponse data, response status code and response headers
+    def get_audits_query_transaction_id_results_with_http_info(transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_transaction_id_results ..."
+      end
+      
+      
+      # verify the required parameter 'transaction_id' is set
+      fail ArgumentError, "Missing the required parameter 'transaction_id' when calling AuditApi.get_audits_query_transaction_id_results" if transaction_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/audits/query/{transactionId}/results".sub('{format}','json').sub('{' + 'transactionId' + '}', transaction_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'cursor'] = opts[:'cursor'] if opts[:'cursor']
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+
+      # 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(: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 => 'AuditQueryExecutionResultsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuditApi#get_audits_query_transaction_id_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create audit query execution
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [AuditQueryExecutionStatusResponse]
+    def post_audits_query(body, opts = {})
+      data, _status_code, _headers = post_audits_query_with_http_info(body, opts)
+      return data
+    end
+
+    # Create audit query execution
+    # 
+    # @param body query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuditQueryExecutionStatusResponse, Fixnum, Hash)>] AuditQueryExecutionStatusResponse data, response status code and response headers
+    def post_audits_query_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuditApi.post_audits_query ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling AuditApi.post_audits_query" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/audits/query".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 => 'AuditQueryExecutionStatusResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuditApi#post_audits_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end