purecloudplatformclientv2 88.0.0 → 89.0.0

data/docs/WrapupCodeEntityListing.md

@@ -12,9 +12,9 @@ title: WrapupCodeEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **first_uri** | **String** |  | [optional] |
+| **previous_uri** | **String** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
-| **previous_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}

data/lib/purecloudplatformclientv2.rb

@@ -87,6 +87,9 @@ require 'purecloudplatformclientv2/models/analytics_user_details_query_response'
 require 'purecloudplatformclientv2/models/analytics_user_presence_record'
 require 'purecloudplatformclientv2/models/annotation'
 require 'purecloudplatformclientv2/models/answer_option'
+require 'purecloudplatformclientv2/models/api_usage_query'
+require 'purecloudplatformclientv2/models/api_usage_query_result'
+require 'purecloudplatformclientv2/models/api_usage_row'
 require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client'
 require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification'
 require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_home_organization'
@@ -138,11 +141,15 @@ require 'purecloudplatformclientv2/models/audit_facet'
 require 'purecloudplatformclientv2/models/audit_filter'
 require 'purecloudplatformclientv2/models/audit_log_message'
 require 'purecloudplatformclientv2/models/audit_message'
+require 'purecloudplatformclientv2/models/audit_query_entity'
 require 'purecloudplatformclientv2/models/audit_query_execution_results_response'
 require 'purecloudplatformclientv2/models/audit_query_execution_status_response'
 require 'purecloudplatformclientv2/models/audit_query_filter'
 require 'purecloudplatformclientv2/models/audit_query_request'
 require 'purecloudplatformclientv2/models/audit_query_response'
+require 'purecloudplatformclientv2/models/audit_query_service'
+require 'purecloudplatformclientv2/models/audit_query_service_mapping'
+require 'purecloudplatformclientv2/models/audit_query_sort'
 require 'purecloudplatformclientv2/models/audit_search_result'
 require 'purecloudplatformclientv2/models/audit_user'
 require 'purecloudplatformclientv2/models/authz_division'
@@ -883,6 +890,8 @@ require 'purecloudplatformclientv2/models/flow_diagnostic_info'
 require 'purecloudplatformclientv2/models/flow_division_view'
 require 'purecloudplatformclientv2/models/flow_division_view_entity_listing'
 require 'purecloudplatformclientv2/models/flow_entity_listing'
+require 'purecloudplatformclientv2/models/flow_execution_launch_request'
+require 'purecloudplatformclientv2/models/flow_execution_launch_response'
 require 'purecloudplatformclientv2/models/flow_observation_data_container'
 require 'purecloudplatformclientv2/models/flow_observation_query'
 require 'purecloudplatformclientv2/models/flow_observation_query_clause'
@@ -891,6 +900,7 @@ require 'purecloudplatformclientv2/models/flow_observation_query_predicate'
 require 'purecloudplatformclientv2/models/flow_observation_query_response'
 require 'purecloudplatformclientv2/models/flow_outcome'
 require 'purecloudplatformclientv2/models/flow_outcome_listing'
+require 'purecloudplatformclientv2/models/flow_runtime_execution'
 require 'purecloudplatformclientv2/models/flow_version'
 require 'purecloudplatformclientv2/models/flow_version_entity_listing'
 require 'purecloudplatformclientv2/models/forecast_abandon_rate_response'
@@ -913,6 +923,7 @@ require 'purecloudplatformclientv2/models/gkn_documentation_search_request'
 require 'purecloudplatformclientv2/models/gkn_documentation_search_response'
 require 'purecloudplatformclientv2/models/g_suite'
 require 'purecloudplatformclientv2/models/generate_bu_forecast_request'
+require 'purecloudplatformclientv2/models/generic_saml'
 require 'purecloudplatformclientv2/models/geolocation'
 require 'purecloudplatformclientv2/models/geolocation_event_geolocation'
 require 'purecloudplatformclientv2/models/geolocation_settings'
@@ -973,6 +984,7 @@ require 'purecloudplatformclientv2/models/interaction_stats_rule'
 require 'purecloudplatformclientv2/models/interaction_stats_rule_container'
 require 'purecloudplatformclientv2/models/intraday_performance_prediction_data'
 require 'purecloudplatformclientv2/models/intraday_planning_group_request'
+require 'purecloudplatformclientv2/models/ip_address_authentication'
 require 'purecloudplatformclientv2/models/ip_address_range'
 require 'purecloudplatformclientv2/models/ip_address_range_listing'
 require 'purecloudplatformclientv2/models/item_validation_limits'
@@ -1793,6 +1805,7 @@ require 'purecloudplatformclientv2/models/update_user'
 require 'purecloudplatformclientv2/models/upload_url_request'
 require 'purecloudplatformclientv2/models/upload_url_response'
 require 'purecloudplatformclientv2/models/usage'
+require 'purecloudplatformclientv2/models/usage_execution_result'
 require 'purecloudplatformclientv2/models/usage_item'
 require 'purecloudplatformclientv2/models/user'
 require 'purecloudplatformclientv2/models/user_action_category'
@@ -2085,6 +2098,7 @@ require 'purecloudplatformclientv2/api/telephony_api'
 require 'purecloudplatformclientv2/api/telephony_providers_edge_api'
 require 'purecloudplatformclientv2/api/tokens_api'
 require 'purecloudplatformclientv2/api/uploads_api'
+require 'purecloudplatformclientv2/api/usage_api'
 require 'purecloudplatformclientv2/api/user_recordings_api'
 require 'purecloudplatformclientv2/api/users_api'
 require 'purecloudplatformclientv2/api/utilities_api'

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -4983,6 +4983,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get a flow execution's details. Flow execution details are available for several days after the flow is started.
+    # 
+    # @param flow_execution_id flow execution ID
+    # @param [Hash] opts the optional parameters
+    # @return [FlowRuntimeExecution]
+    def get_flows_execution(flow_execution_id, opts = {})
+      data, _status_code, _headers = get_flows_execution_with_http_info(flow_execution_id, opts)
+      return data
+    end
+
+    # Get a flow execution's details. Flow execution details are available for several days after the flow is started.
+    # 
+    # @param flow_execution_id flow execution ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FlowRuntimeExecution, Fixnum, Hash)>] FlowRuntimeExecution data, response status code and response headers
+    def get_flows_execution_with_http_info(flow_execution_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_execution ..."
+      end
+      
+      
+      # verify the required parameter 'flow_execution_id' is set
+      fail ArgumentError, "Missing the required parameter 'flow_execution_id' when calling ArchitectApi.get_flows_execution" if flow_execution_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/flows/executions/{flowExecutionId}".sub('{format}','json').sub('{' + 'flowExecutionId' + '}', flow_execution_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 => 'FlowRuntimeExecution')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ArchitectApi#get_flows_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a flow outcome
     # Returns a specified flow outcome
     # @param flow_outcome_id flow outcome ID
@@ -6659,6 +6724,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
+    # The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
+    # @param flow_launch_request 
+    # @param [Hash] opts the optional parameters
+    # @return [FlowExecutionLaunchResponse]
+    def post_flows_executions(flow_launch_request, opts = {})
+      data, _status_code, _headers = post_flows_executions_with_http_info(flow_launch_request, opts)
+      return data
+    end
+
+    # Launch an instance of a flow definition, for flow types that support it such as the &#39;workflow&#39; type.
+    # The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
+    # @param flow_launch_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FlowExecutionLaunchResponse, Fixnum, Hash)>] FlowExecutionLaunchResponse data, response status code and response headers
+    def post_flows_executions_with_http_info(flow_launch_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_executions ..."
+      end
+      
+      
+      # verify the required parameter 'flow_launch_request' is set
+      fail ArgumentError, "Missing the required parameter 'flow_launch_request' when calling ArchitectApi.post_flows_executions" if flow_launch_request.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/flows/executions".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(flow_launch_request)
+      
+      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 => 'FlowExecutionLaunchResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ArchitectApi#post_flows_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a flow outcome
     # Asynchronous.  Notification topic: v2.flows.outcomes.{flowOutcomeId}
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/audit_api.rb

@@ -24,6 +24,61 @@ module PureCloud
       @api_client = api_client
     end
 
+    # Get service mapping information used in audits.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [AuditQueryServiceMapping]
+    def get_audits_query_servicemapping(opts = {})
+      data, _status_code, _headers = get_audits_query_servicemapping_with_http_info(opts)
+      return data
+    end
+
+    # Get service mapping information used in audits.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AuditQueryServiceMapping, Fixnum, Hash)>] AuditQueryServiceMapping data, response status code and response headers
+    def get_audits_query_servicemapping_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_servicemapping ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/audits/query/servicemapping".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 = 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 => 'AuditQueryServiceMapping')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuditApi#get_audits_query_servicemapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get status of audit query execution
     # 
     # @param transaction_id Transaction ID

data/lib/purecloudplatformclientv2/api/identity_provider_api.rb

@@ -134,6 +134,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Delete Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Empty]
+    def delete_identityproviders_generic(opts = {})
+      data, _status_code, _headers = delete_identityproviders_generic_with_http_info(opts)
+      return data
+    end
+
+    # Delete Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
+    def delete_identityproviders_generic_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.delete_identityproviders_generic ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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 = 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,
+        :return_type => 'Empty')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#delete_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete G Suite Identity Provider
     # 
     # @param [Hash] opts the optional parameters
@@ -739,6 +794,61 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [GenericSAML]
+    def get_identityproviders_generic(opts = {})
+      data, _status_code, _headers = get_identityproviders_generic_with_http_info(opts)
+      return data
+    end
+
+    # Get Generic SAML Identity Provider
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GenericSAML, Fixnum, Hash)>] GenericSAML data, response status code and response headers
+    def get_identityproviders_generic_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.get_identityproviders_generic ..."
+      end
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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 = 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 => 'GenericSAML')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get G Suite Identity Provider
     # 
     # @param [Hash] opts the optional parameters
@@ -1309,6 +1419,71 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Update/Create Generic SAML Identity Provider
+    # 
+    # @param body Provider
+    # @param [Hash] opts the optional parameters
+    # @return [OAuthProvider]
+    def put_identityproviders_generic(body, opts = {})
+      data, _status_code, _headers = put_identityproviders_generic_with_http_info(body, opts)
+      return data
+    end
+
+    # Update/Create Generic SAML Identity Provider
+    # 
+    # @param body Provider
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OAuthProvider, Fixnum, Hash)>] OAuthProvider data, response status code and response headers
+    def put_identityproviders_generic_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: IdentityProviderApi.put_identityproviders_generic ..."
+      end
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling IdentityProviderApi.put_identityproviders_generic" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/identityproviders/generic".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(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OAuthProvider')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityProviderApi#put_identityproviders_generic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update/Create G Suite Identity Provider
     # 
     # @param body Provider