class PureCloud::IntegrationsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 23
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_integration(integration_id, opts = {}) click to toggle source

Delete integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @return [Integration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 32
def delete_integration(integration_id, opts = {})
  data, _status_code, _headers = delete_integration_with_http_info(integration_id, opts)
  return data
end
delete_integration_with_http_info(integration_id, opts = {}) click to toggle source

Delete integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 42
def delete_integration_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integration ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.delete_integration" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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,
    :return_type => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#delete_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_integrations_action(action_id, opts = {}) click to toggle source

Delete an Action

@param action_id actionId @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 97
def delete_integrations_action(action_id, opts = {})
  delete_integrations_action_with_http_info(action_id, opts)
  return nil
end
delete_integrations_action_draft(action_id, opts = {}) click to toggle source

Delete a Draft

@param action_id actionId @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 161
def delete_integrations_action_draft(action_id, opts = {})
  delete_integrations_action_draft_with_http_info(action_id, opts)
  return nil
end
delete_integrations_action_draft_with_http_info(action_id, opts = {}) click to toggle source

Delete a Draft

@param action_id actionId @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 171
def delete_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.delete_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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: IntegrationsApi#delete_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_integrations_action_with_http_info(action_id, opts = {}) click to toggle source

Delete an Action

@param action_id actionId @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 107
def delete_integrations_action_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_action ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.delete_integrations_action" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_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: IntegrationsApi#delete_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete_integrations_credential(credential_id, opts = {}) click to toggle source

Delete a set of credentials

@param credential_id Credential ID @param [Hash] opts the optional parameters @return [nil]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 225
def delete_integrations_credential(credential_id, opts = {})
  delete_integrations_credential_with_http_info(credential_id, opts)
  return nil
end
delete_integrations_credential_with_http_info(credential_id, opts = {}) click to toggle source

Delete a set of credentials

@param credential_id Credential ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 235
def delete_integrations_credential_with_http_info(credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_credential ..."
  end
  
  
  # verify the required parameter 'credential_id' is set
  fail ArgumentError, "Missing the required parameter 'credential_id' when calling IntegrationsApi.delete_integrations_credential" if credential_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials/{credentialId}".sub('{format}','json').sub('{' + 'credentialId' + '}', credential_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: IntegrationsApi#delete_integrations_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integration(integration_id, opts = {}) click to toggle source

Get integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Integration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 295
def get_integration(integration_id, opts = {})
  data, _status_code, _headers = get_integration_with_http_info(integration_id, opts)
  return data
end
get_integration_config_current(integration_id, opts = {}) click to toggle source

Get integration configuration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @return [IntegrationConfiguration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 408
def get_integration_config_current(integration_id, opts = {})
  data, _status_code, _headers = get_integration_config_current_with_http_info(integration_id, opts)
  return data
end
get_integration_config_current_with_http_info(integration_id, opts = {}) click to toggle source

Get integration configuration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @return [Array<(IntegrationConfiguration, Fixnum, Hash)>] IntegrationConfiguration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 418
def get_integration_config_current_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integration_config_current ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.get_integration_config_current" if integration_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/{integrationId}/config/current".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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 => 'IntegrationConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration_config_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integration_with_http_info(integration_id, opts = {}) click to toggle source

Get integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 311
def get_integration_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integration ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.get_integration" if integration_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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 => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations(opts = {}) click to toggle source

List integrations

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [IntegrationEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 478
def get_integrations(opts = {})
  data, _status_code, _headers = get_integrations_with_http_info(opts)
  return data
end
get_integrations_action(action_id, opts = {}) click to toggle source

Retrieves a single Action matching id.

@param action_id actionId @param [Hash] opts the optional parameters @option opts [String] :expand Indicates a field in the response which should be expanded. @option opts [BOOLEAN] :include_config Return config in response. (default to false) @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 584
def get_integrations_action(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_with_http_info(action_id, opts)
  return data
end
get_integrations_action_draft(action_id, opts = {}) click to toggle source

Retrieve a Draft

@param action_id actionId @param [Hash] opts the optional parameters @option opts [String] :expand Indicates a field in the response which should be expanded. @option opts [BOOLEAN] :include_config Return config in response. (default to false) @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 671
def get_integrations_action_draft(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_with_http_info(action_id, opts)
  return data
end
get_integrations_action_draft_schema(action_id, file_name, opts = {}) click to toggle source

Retrieve schema for a Draft based on filename.

@param action_id actionId @param file_name Name of schema file to be retrieved for this draft. @param [Hash] opts the optional parameters @return [JsonSchemaDocument]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 757
def get_integrations_action_draft_schema(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts)
  return data
end
get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts = {}) click to toggle source

Retrieve schema for a Draft based on filename.

@param action_id actionId @param file_name Name of schema file to be retrieved for this draft. @param [Hash] opts the optional parameters @return [Array<(JsonSchemaDocument, Fixnum, Hash)>] JsonSchemaDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 768
def get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_schema ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_schema" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_schema" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_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 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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_draft_template(action_id, file_name, opts = {}) click to toggle source

Retrieve templates for a Draft based on filename.

@param action_id actionId @param file_name Name of template file to be retrieved for this action draft. @param [Hash] opts the optional parameters @return [String]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 832
def get_integrations_action_draft_template(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_template_with_http_info(action_id, file_name, opts)
  return data
end
get_integrations_action_draft_template_with_http_info(action_id, file_name, opts = {}) click to toggle source

Retrieve templates for a Draft based on filename.

@param action_id actionId @param file_name Name of template file to be retrieved for this action draft. @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 843
def get_integrations_action_draft_template_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_template ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_template" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_template" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/plain']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_draft_validation(action_id, opts = {}) click to toggle source

Validate current Draft configuration.

@param action_id actionId @param [Hash] opts the optional parameters @return [DraftValidationResult]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 906
def get_integrations_action_draft_validation(action_id, opts = {})
  data, _status_code, _headers = get_integrations_action_draft_validation_with_http_info(action_id, opts)
  return data
end
get_integrations_action_draft_validation_with_http_info(action_id, opts = {}) click to toggle source

Validate current Draft configuration.

@param action_id actionId @param [Hash] opts the optional parameters @return [Array<(DraftValidationResult, Fixnum, Hash)>] DraftValidationResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 916
def get_integrations_action_draft_validation_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_validation ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_validation" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/validation".sub('{format}','json').sub('{' + 'actionId' + '}', action_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 => 'DraftValidationResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_draft_with_http_info(action_id, opts = {}) click to toggle source

Retrieve a Draft

@param action_id actionId @param [Hash] opts the optional parameters @option opts [String] :expand Indicates a field in the response which should be expanded. @option opts [BOOLEAN] :include_config Return config in response. @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 683
def get_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of contract'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'includeConfig'] = opts[:'include_config'] if opts[:'include_config']

  # 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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_schema(action_id, file_name, opts = {}) click to toggle source

Retrieve schema for an action based on filename.

@param action_id actionId @param file_name Name of schema file to be retrieved for this action. @param [Hash] opts the optional parameters @return [JsonSchemaDocument]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 972
def get_integrations_action_schema(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_schema_with_http_info(action_id, file_name, opts)
  return data
end
get_integrations_action_schema_with_http_info(action_id, file_name, opts = {}) click to toggle source

Retrieve schema for an action based on filename.

@param action_id actionId @param file_name Name of schema file to be retrieved for this action. @param [Hash] opts the optional parameters @return [Array<(JsonSchemaDocument, Fixnum, Hash)>] JsonSchemaDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 983
def get_integrations_action_schema_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_schema ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_schema" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_schema" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_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 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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_template(action_id, file_name, opts = {}) click to toggle source

Retrieve text of templates for an action based on filename.

@param action_id actionId @param file_name Name of template file to be retrieved for this action. @param [Hash] opts the optional parameters @return [String]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1047
def get_integrations_action_template(action_id, file_name, opts = {})
  data, _status_code, _headers = get_integrations_action_template_with_http_info(action_id, file_name, opts)
  return data
end
get_integrations_action_template_with_http_info(action_id, file_name, opts = {}) click to toggle source

Retrieve text of templates for an action based on filename.

@param action_id actionId @param file_name Name of template file to be retrieved for this action. @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1058
def get_integrations_action_template_with_http_info(action_id, file_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_template ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_template" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'file_name' is set
  fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_template" if file_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/plain']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_action_with_http_info(action_id, opts = {}) click to toggle source

Retrieves a single Action matching id.

@param action_id actionId @param [Hash] opts the optional parameters @option opts [String] :expand Indicates a field in the response which should be expanded. @option opts [BOOLEAN] :include_config Return config in response. @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 596
def get_integrations_action_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action" if action_id.nil?
  
  
  
  
  
  
  
  
  if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
    fail ArgumentError, 'invalid value for "expand", must be one of contract'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
  query_params[:'includeConfig'] = opts[:'include_config'] if opts[:'include_config']

  # 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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_actions(opts = {}) click to toggle source

Retrieves all actions associated with filters passed in via query param.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc) @option opts [String] :category Filter by category name @option opts [String] :name Filter by action name. Provide full or just the first part of name. @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false) @return [ActionEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1130
def get_integrations_actions(opts = {})
  data, _status_code, _headers = get_integrations_actions_with_http_info(opts)
  return data
end
get_integrations_actions_categories(opts = {}) click to toggle source

Retrieves all categories of available Actions

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc) @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @return [CategoryEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1284
def get_integrations_actions_categories(opts = {})
  data, _status_code, _headers = get_integrations_actions_categories_with_http_info(opts)
  return data
end
get_integrations_actions_categories_with_http_info(opts = {}) click to toggle source

Retrieves all categories of available Actions

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @return [Array<(CategoryEntityListing, Fixnum, Hash)>] CategoryEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1300
def get_integrations_actions_categories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_categories ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/categories".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']

  # 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 => 'CategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_actions_drafts(opts = {}) click to toggle source

Retrieves all action drafts associated with the filters passed in via query param.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. (default to asc) @option opts [String] :category Filter by category name @option opts [String] :name Filter by action name. Provide full or just the first part of name. @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false) @return [ActionEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1413
def get_integrations_actions_drafts(opts = {})
  data, _status_code, _headers = get_integrations_actions_drafts_with_http_info(opts)
  return data
end
get_integrations_actions_drafts_with_http_info(opts = {}) click to toggle source

Retrieves all action drafts associated with the filters passed in via query param.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. @option opts [String] :category Filter by category name @option opts [String] :name Filter by action name. Provide full or just the first part of name. @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1432
def get_integrations_actions_drafts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_drafts ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
    fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/drafts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']

  # 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 => 'ActionEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions_drafts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_actions_with_http_info(opts = {}) click to toggle source

Retrieves all actions associated with filters passed in via query param.

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :sort_by Root level field name to sort on. @option opts [String] :sort_order Direction to sort &#39;sortBy&#39; field. @option opts [String] :category Filter by category name @option opts [String] :name Filter by action name. Provide full or just the first part of name. @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. @option opts [String] :include_auth_actions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1149
def get_integrations_actions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ASC, DESC'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
    fail ArgumentError, 'invalid value for "secure", must be one of true, false'
  end
  
  
  
  
  
  
  
  if opts[:'include_auth_actions'] && !['true', 'false'].include?(opts[:'include_auth_actions'])
    fail ArgumentError, 'invalid value for "include_auth_actions", must be one of true, false'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
  query_params[:'includeAuthActions'] = opts[:'include_auth_actions'] if opts[:'include_auth_actions']

  # 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 => 'ActionEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_clientapps(opts = {}) click to toggle source

List permitted client app integrations for the logged in user

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [ClientAppEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1566
def get_integrations_clientapps(opts = {})
  data, _status_code, _headers = get_integrations_clientapps_with_http_info(opts)
  return data
end
get_integrations_clientapps_with_http_info(opts = {}) click to toggle source

List permitted client app integrations for the logged in user

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Array<(ClientAppEntityListing, Fixnum, Hash)>] ClientAppEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1581
def get_integrations_clientapps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_clientapps ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/clientapps".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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 => 'ClientAppEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_clientapps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_credential(credential_id, opts = {}) click to toggle source

Get a single credential with sensitive fields redacted

@param credential_id Credential ID @param [Hash] opts the optional parameters @return [Credential]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1670
def get_integrations_credential(credential_id, opts = {})
  data, _status_code, _headers = get_integrations_credential_with_http_info(credential_id, opts)
  return data
end
get_integrations_credential_with_http_info(credential_id, opts = {}) click to toggle source

Get a single credential with sensitive fields redacted

@param credential_id Credential ID @param [Hash] opts the optional parameters @return [Array<(Credential, Fixnum, Hash)>] Credential data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1680
def get_integrations_credential_with_http_info(credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_credential ..."
  end
  
  
  # verify the required parameter 'credential_id' is set
  fail ArgumentError, "Missing the required parameter 'credential_id' when calling IntegrationsApi.get_integrations_credential" if credential_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials/{credentialId}".sub('{format}','json').sub('{' + 'credentialId' + '}', credential_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 => 'Credential')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_credentials(opts = {}) click to toggle source

List multiple sets of credentials

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @return [CredentialInfoListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1736
def get_integrations_credentials(opts = {})
  data, _status_code, _headers = get_integrations_credentials_with_http_info(opts)
  return data
end
get_integrations_credentials_types(opts = {}) click to toggle source

List all credential types

@param [Hash] opts the optional parameters @return [CredentialTypeListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1807
def get_integrations_credentials_types(opts = {})
  data, _status_code, _headers = get_integrations_credentials_types_with_http_info(opts)
  return data
end
get_integrations_credentials_types_with_http_info(opts = {}) click to toggle source

List all credential types

@param [Hash] opts the optional parameters @return [Array<(CredentialTypeListing, Fixnum, Hash)>] CredentialTypeListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1816
def get_integrations_credentials_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_credentials_types ..."
  end
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials/types".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 => 'CredentialTypeListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_credentials_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_credentials_with_http_info(opts = {}) click to toggle source

List multiple sets of credentials

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @return [Array<(CredentialInfoListing, Fixnum, Hash)>] CredentialInfoListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1747
def get_integrations_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_credentials ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  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 => 'CredentialInfoListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_eventlog(opts = {}) click to toggle source

List all events

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size (default to 25) @option opts [Integer] :page_number Page number (default to 1) @option opts [String] :sort_by Sort by (default to timestamp) @option opts [String] :sort_order Order by (default to descending) @option opts [String] :entity_id Include only events with this entity ID @return [IntegrationEventEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1867
def get_integrations_eventlog(opts = {})
  data, _status_code, _headers = get_integrations_eventlog_with_http_info(opts)
  return data
end
get_integrations_eventlog_event_id(event_id, opts = {}) click to toggle source

Get a single event

@param event_id Event Id @param [Hash] opts the optional parameters @return [IntegrationEvent]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1963
def get_integrations_eventlog_event_id(event_id, opts = {})
  data, _status_code, _headers = get_integrations_eventlog_event_id_with_http_info(event_id, opts)
  return data
end
get_integrations_eventlog_event_id_with_http_info(event_id, opts = {}) click to toggle source

Get a single event

@param event_id Event Id @param [Hash] opts the optional parameters @return [Array<(IntegrationEvent, Fixnum, Hash)>] IntegrationEvent data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1973
def get_integrations_eventlog_event_id_with_http_info(event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_eventlog_event_id ..."
  end
  
  
  # verify the required parameter 'event_id' is set
  fail ArgumentError, "Missing the required parameter 'event_id' when calling IntegrationsApi.get_integrations_eventlog_event_id" if event_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/eventlog/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_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 => 'IntegrationEvent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_eventlog_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_eventlog_with_http_info(opts = {}) click to toggle source

List all events

@param [Hash] opts the optional parameters @option opts [Integer] :page_size Page size @option opts [Integer] :page_number Page number @option opts [String] :sort_by Sort by @option opts [String] :sort_order Order by @option opts [String] :entity_id Include only events with this entity ID @return [Array<(IntegrationEventEntityListing, Fixnum, Hash)>] IntegrationEventEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 1881
def get_integrations_eventlog_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_eventlog ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/eventlog".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'entityId'] = opts[:'entity_id'] if opts[:'entity_id']

  # 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 => 'IntegrationEventEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_eventlog\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_dialogflow_agent(agent_id, opts = {}) click to toggle source

Get details about a Dialogflow agent

@param agent_id The agent ID @param [Hash] opts the optional parameters @return [DialogflowAgent]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2028
def get_integrations_speech_dialogflow_agent(agent_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_dialogflow_agent_with_http_info(agent_id, opts)
  return data
end
get_integrations_speech_dialogflow_agent_with_http_info(agent_id, opts = {}) click to toggle source

Get details about a Dialogflow agent

@param agent_id The agent ID @param [Hash] opts the optional parameters @return [Array<(DialogflowAgent, Fixnum, Hash)>] DialogflowAgent data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2038
def get_integrations_speech_dialogflow_agent_with_http_info(agent_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_dialogflow_agent ..."
  end
  
  
  # verify the required parameter 'agent_id' is set
  fail ArgumentError, "Missing the required parameter 'agent_id' when calling IntegrationsApi.get_integrations_speech_dialogflow_agent" if agent_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/dialogflow/agents/{agentId}".sub('{format}','json').sub('{' + 'agentId' + '}', agent_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 => 'DialogflowAgent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_dialogflow_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_dialogflow_agents(opts = {}) click to toggle source

Get a list of Dialogflow agents in the customers' Google accounts

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @option opts [String] :name Filter on agent name @return [DialogflowAgentSummaryEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2095
def get_integrations_speech_dialogflow_agents(opts = {})
  data, _status_code, _headers = get_integrations_speech_dialogflow_agents_with_http_info(opts)
  return data
end
get_integrations_speech_dialogflow_agents_with_http_info(opts = {}) click to toggle source

Get a list of Dialogflow agents in the customers&#39; Google accounts

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @option opts [String] :name Filter on agent name @return [Array<(DialogflowAgentSummaryEntityListing, Fixnum, Hash)>] DialogflowAgentSummaryEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2107
def get_integrations_speech_dialogflow_agents_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_dialogflow_agents ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/dialogflow/agents".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # 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 => 'DialogflowAgentSummaryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_dialogflow_agents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_lex_bot_alias(alias_id, opts = {}) click to toggle source

Get details about a Lex bot alias

@param alias_id The alias ID @param [Hash] opts the optional parameters @return [LexBotAlias]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2175
def get_integrations_speech_lex_bot_alias(alias_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts)
  return data
end
get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts = {}) click to toggle source

Get details about a Lex bot alias

@param alias_id The alias ID @param [Hash] opts the optional parameters @return [Array<(LexBotAlias, Fixnum, Hash)>] LexBotAlias data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2185
def get_integrations_speech_lex_bot_alias_with_http_info(alias_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bot_alias ..."
  end
  
  
  # verify the required parameter 'alias_id' is set
  fail ArgumentError, "Missing the required parameter 'alias_id' when calling IntegrationsApi.get_integrations_speech_lex_bot_alias" if alias_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bot/alias/{aliasId}".sub('{format}','json').sub('{' + 'aliasId' + '}', alias_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 => 'LexBotAlias')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_lex_bot_alias\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts = {}) click to toggle source

Get a list of aliases for a bot in the customer's AWS accounts

@param bot_id The bot ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @option opts [String] :status Filter on alias status @option opts [String] :name Filter on alias name @return [LexBotAliasEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2244
def get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts)
  return data
end
get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts = {}) click to toggle source

Get a list of aliases for a bot in the customer&#39;s AWS accounts

@param bot_id The bot ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @option opts [String] :status Filter on alias status @option opts [String] :name Filter on alias name @return [Array<(LexBotAliasEntityListing, Fixnum, Hash)>] LexBotAliasEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2258
def get_integrations_speech_lex_bot_bot_id_aliases_with_http_info(bot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bot_bot_id_aliases ..."
  end
  
  
  # verify the required parameter 'bot_id' is set
  fail ArgumentError, "Missing the required parameter 'bot_id' when calling IntegrationsApi.get_integrations_speech_lex_bot_bot_id_aliases" if bot_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'status'] && !['READY', 'FAILED', 'BUILDING', 'NOT_BUILT'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of READY, FAILED, BUILDING, NOT_BUILT'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bot/{botId}/aliases".sub('{format}','json').sub('{' + 'botId' + '}', bot_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'status'] = opts[:'status'] if opts[:'status']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # 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 => 'LexBotAliasEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_lex_bot_bot_id_aliases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_lex_bots(opts = {}) click to toggle source

Get a list of Lex bots in the customers' AWS accounts

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @option opts [String] :name Filter on bot name @return [LexBotEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2347
def get_integrations_speech_lex_bots(opts = {})
  data, _status_code, _headers = get_integrations_speech_lex_bots_with_http_info(opts)
  return data
end
get_integrations_speech_lex_bots_with_http_info(opts = {}) click to toggle source

Get a list of Lex bots in the customers&#39; AWS accounts

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @option opts [String] :name Filter on bot name @return [Array<(LexBotEntityListing, Fixnum, Hash)>] LexBotEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2359
def get_integrations_speech_lex_bots_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_lex_bots ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/lex/bots".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # 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 => 'LexBotEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_lex_bots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_tts_engine(engine_id, opts = {}) click to toggle source

Get details about a TTS engine

@param engine_id The engine ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_voices Include voices for the engine (default to false) @return [TtsEngineEntity]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2428
def get_integrations_speech_tts_engine(engine_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_with_http_info(engine_id, opts)
  return data
end
get_integrations_speech_tts_engine_voice(engine_id, voice_id, opts = {}) click to toggle source

Get details about a specific voice for a TTS engine

@param engine_id The engine ID @param voice_id The voice ID @param [Hash] opts the optional parameters @return [TtsVoiceEntity]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2502
def get_integrations_speech_tts_engine_voice(engine_id, voice_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts)
  return data
end
get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts = {}) click to toggle source

Get details about a specific voice for a TTS engine

@param engine_id The engine ID @param voice_id The voice ID @param [Hash] opts the optional parameters @return [Array<(TtsVoiceEntity, Fixnum, Hash)>] TtsVoiceEntity data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2513
def get_integrations_speech_tts_engine_voice_with_http_info(engine_id, voice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine_voice ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voice" if engine_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'voice_id' is set
  fail ArgumentError, "Missing the required parameter 'voice_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voice" if voice_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s).sub('{' + 'voiceId' + '}', voice_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 => 'TtsVoiceEntity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_engine_voice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_tts_engine_voices(engine_id, opts = {}) click to toggle source

Get a list of voices for a TTS engine

@param engine_id The engine ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @return [TtsVoiceEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2578
def get_integrations_speech_tts_engine_voices(engine_id, opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts)
  return data
end
get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts = {}) click to toggle source

Get a list of voices for a TTS engine

@param engine_id The engine ID @param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @return [Array<(TtsVoiceEntityListing, Fixnum, Hash)>] TtsVoiceEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2590
def get_integrations_speech_tts_engine_voices_with_http_info(engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine_voices ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine_voices" if engine_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}/voices".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  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 => 'TtsVoiceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_engine_voices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_tts_engine_with_http_info(engine_id, opts = {}) click to toggle source

Get details about a TTS engine

@param engine_id The engine ID @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_voices Include voices for the engine @return [Array<(TtsEngineEntity, Fixnum, Hash)>] TtsEngineEntity data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2439
def get_integrations_speech_tts_engine_with_http_info(engine_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engine ..."
  end
  
  
  # verify the required parameter 'engine_id' is set
  fail ArgumentError, "Missing the required parameter 'engine_id' when calling IntegrationsApi.get_integrations_speech_tts_engine" if engine_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines/{engineId}".sub('{format}','json').sub('{' + 'engineId' + '}', engine_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeVoices'] = opts[:'include_voices'] if opts[:'include_voices']

  # 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 => 'TtsEngineEntity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_engine\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_tts_engines(opts = {}) click to toggle source

Get a list of TTS engines enabled for org

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number (default to 1) @option opts [Integer] :page_size Page size (default to 25) @option opts [BOOLEAN] :include_voices Include voices for the engine (default to false) @option opts [String] :name Filter on engine name @option opts [String] :language Filter on supported language. If includeVoices=true then the voices are also filtered. @return [TtsEngineEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2663
def get_integrations_speech_tts_engines(opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_engines_with_http_info(opts)
  return data
end
get_integrations_speech_tts_engines_with_http_info(opts = {}) click to toggle source

Get a list of TTS engines enabled for org

@param [Hash] opts the optional parameters @option opts [Integer] :page_number Page number @option opts [Integer] :page_size Page size @option opts [BOOLEAN] :include_voices Include voices for the engine @option opts [String] :name Filter on engine name @option opts [String] :language Filter on supported language. If includeVoices=true then the voices are also filtered. @return [Array<(TtsEngineEntityListing, Fixnum, Hash)>] TtsEngineEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2677
def get_integrations_speech_tts_engines_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_engines ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/engines".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'includeVoices'] = opts[:'include_voices'] if opts[:'include_voices']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'language'] = opts[:'language'] if opts[:'language']

  # 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 => 'TtsEngineEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_engines\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_speech_tts_settings(opts = {}) click to toggle source

Get TTS settings for an org

@param [Hash] opts the optional parameters @return [TtsSettings]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2758
def get_integrations_speech_tts_settings(opts = {})
  data, _status_code, _headers = get_integrations_speech_tts_settings_with_http_info(opts)
  return data
end
get_integrations_speech_tts_settings_with_http_info(opts = {}) click to toggle source

Get TTS settings for an org

@param [Hash] opts the optional parameters @return [Array<(TtsSettings, Fixnum, Hash)>] TtsSettings data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2767
def get_integrations_speech_tts_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_speech_tts_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/settings".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 => 'TtsSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_speech_tts_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_type(type_id, opts = {}) click to toggle source

Get integration type.

@param type_id Integration Type Id @param [Hash] opts the optional parameters @return [IntegrationType]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2814
def get_integrations_type(type_id, opts = {})
  data, _status_code, _headers = get_integrations_type_with_http_info(type_id, opts)
  return data
end
get_integrations_type_configschema(type_id, config_type, opts = {}) click to toggle source

Get properties config schema for an integration type.

@param type_id Integration Type Id @param config_type Config schema type @param [Hash] opts the optional parameters @return [JsonSchemaDocument]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2880
def get_integrations_type_configschema(type_id, config_type, opts = {})
  data, _status_code, _headers = get_integrations_type_configschema_with_http_info(type_id, config_type, opts)
  return data
end
get_integrations_type_configschema_with_http_info(type_id, config_type, opts = {}) click to toggle source

Get properties config schema for an integration type.

@param type_id Integration Type Id @param config_type Config schema type @param [Hash] opts the optional parameters @return [Array<(JsonSchemaDocument, Fixnum, Hash)>] JsonSchemaDocument data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2891
def get_integrations_type_configschema_with_http_info(type_id, config_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_type_configschema ..."
  end
  
  
  # verify the required parameter 'type_id' is set
  fail ArgumentError, "Missing the required parameter 'type_id' when calling IntegrationsApi.get_integrations_type_configschema" if type_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'config_type' is set
  fail ArgumentError, "Missing the required parameter 'config_type' when calling IntegrationsApi.get_integrations_type_configschema" if config_type.nil?
  
  # verify enum value
  unless ['properties', 'advanced'].include?(config_type)
    fail ArgumentError, "invalid value for 'config_type', must be one of properties, advanced"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/types/{typeId}/configschemas/{configType}".sub('{format}','json').sub('{' + 'typeId' + '}', type_id.to_s).sub('{' + 'configType' + '}', config_type.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 => 'JsonSchemaDocument')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_type_configschema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_type_with_http_info(type_id, opts = {}) click to toggle source

Get integration type.

@param type_id Integration Type Id @param [Hash] opts the optional parameters @return [Array<(IntegrationType, Fixnum, Hash)>] IntegrationType data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2824
def get_integrations_type_with_http_info(type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_type ..."
  end
  
  
  # verify the required parameter 'type_id' is set
  fail ArgumentError, "Missing the required parameter 'type_id' when calling IntegrationsApi.get_integrations_type" if type_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/types/{typeId}".sub('{format}','json').sub('{' + 'typeId' + '}', type_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 => 'IntegrationType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_types(opts = {}) click to toggle source

List integration types

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [IntegrationTypeEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2964
def get_integrations_types(opts = {})
  data, _status_code, _headers = get_integrations_types_with_http_info(opts)
  return data
end
get_integrations_types_with_http_info(opts = {}) click to toggle source

List integration types

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Array<(IntegrationTypeEntityListing, Fixnum, Hash)>] IntegrationTypeEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 2979
def get_integrations_types_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_types ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/types".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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 => 'IntegrationTypeEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_userapps(opts = {}) click to toggle source

List permitted user app integrations for the logged in user

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :app_host The type of UserApp to filter by @return [UserAppEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3074
def get_integrations_userapps(opts = {})
  data, _status_code, _headers = get_integrations_userapps_with_http_info(opts)
  return data
end
get_integrations_userapps_with_http_info(opts = {}) click to toggle source

List permitted user app integrations for the logged in user

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @option opts [String] :app_host The type of UserApp to filter by @return [Array<(UserAppEntityListing, Fixnum, Hash)>] UserAppEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3090
def get_integrations_userapps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_userapps ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/userapps".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
  query_params[:'appHost'] = opts[:'app_host'] if opts[:'app_host']

  # 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 => 'UserAppEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_userapps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_integrations_with_http_info(opts = {}) click to toggle source

List integrations

@param [Hash] opts the optional parameters @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Array<(IntegrationEntityListing, Fixnum, Hash)>] IntegrationEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 493
def get_integrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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 => 'IntegrationEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#get_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_integration(integration_id, opts = {}) click to toggle source

Update an integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [Integration] :body Integration Update @option opts [Integer] :page_size The total page size requested (default to 25) @option opts [Integer] :page_number The page number requested (default to 1) @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Integration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3193
def patch_integration(integration_id, opts = {})
  data, _status_code, _headers = patch_integration_with_http_info(integration_id, opts)
  return data
end
patch_integration_with_http_info(integration_id, opts = {}) click to toggle source

Update an integration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [Integration] :body Integration Update @option opts [Integer] :page_size The total page size requested @option opts [Integer] :page_number The page number requested @option opts [String] :sort_by variable name requested to sort by @option opts [Array<String>] :expand variable name requested by expand list @option opts [String] :next_page next page token @option opts [String] :previous_page Previous page token @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3210
def patch_integration_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integration ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.patch_integration" if integration_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/{integrationId}".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
  query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']

  # 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(: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 => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_integrations_action(action_id, body, opts = {}) click to toggle source

Patch an Action

@param action_id actionId @param body Input used to patch the Action. @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3314
def patch_integrations_action(action_id, body, opts = {})
  data, _status_code, _headers = patch_integrations_action_with_http_info(action_id, body, opts)
  return data
end
patch_integrations_action_draft(action_id, body, opts = {}) click to toggle source

Update an existing Draft

@param action_id actionId @param body Input used to patch the Action Draft. @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3389
def patch_integrations_action_draft(action_id, body, opts = {})
  data, _status_code, _headers = patch_integrations_action_draft_with_http_info(action_id, body, opts)
  return data
end
patch_integrations_action_draft_with_http_info(action_id, body, opts = {}) click to toggle source

Update an existing Draft

@param action_id actionId @param body Input used to patch the Action Draft. @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3400
def patch_integrations_action_draft_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action_draft" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
patch_integrations_action_with_http_info(action_id, body, opts = {}) click to toggle source

Patch an Action

@param action_id actionId @param body Input used to patch the Action. @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3325
def patch_integrations_action_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations(opts = {}) click to toggle source

Create an integration.

@param [Hash] opts the optional parameters @option opts [CreateIntegrationRequest] :body Integration @return [Integration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3463
def post_integrations(opts = {})
  data, _status_code, _headers = post_integrations_with_http_info(opts)
  return data
end
post_integrations_action_draft(action_id, opts = {}) click to toggle source

Create a new Draft from existing Action

@param action_id actionId @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3526
def post_integrations_action_draft(action_id, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_with_http_info(action_id, opts)
  return data
end
post_integrations_action_draft_publish(action_id, body, opts = {}) click to toggle source

Publish a Draft and make it the active Action configuration

@param action_id actionId @param body Input used to patch the Action. @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3592
def post_integrations_action_draft_publish(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_publish_with_http_info(action_id, body, opts)
  return data
end
post_integrations_action_draft_publish_with_http_info(action_id, body, opts = {}) click to toggle source

Publish a Draft and make it the active Action configuration

@param action_id actionId @param body Input used to patch the Action. @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3603
def post_integrations_action_draft_publish_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_publish ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_publish" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_publish" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/publish".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_action_draft_test(action_id, body, opts = {}) click to toggle source

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [TestExecutionResult]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3667
def post_integrations_action_draft_test(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_draft_test_with_http_info(action_id, body, opts)
  return data
end
post_integrations_action_draft_test_with_http_info(action_id, body, opts = {}) click to toggle source

Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [Array<(TestExecutionResult, Fixnum, Hash)>] TestExecutionResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3678
def post_integrations_action_draft_test_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_test ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_test" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_test" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'TestExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_action_draft_with_http_info(action_id, opts = {}) click to toggle source

Create a new Draft from existing Action

@param action_id actionId @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3536
def post_integrations_action_draft_with_http_info(action_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft" if action_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_action_execute(action_id, body, opts = {}) click to toggle source

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [Object]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3742
def post_integrations_action_execute(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_execute_with_http_info(action_id, body, opts)
  return data
end
post_integrations_action_execute_with_http_info(action_id, body, opts = {}) click to toggle source

Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3753
def post_integrations_action_execute_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_execute ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_execute" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_execute" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/execute".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_action_test(action_id, body, opts = {}) click to toggle source

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [TestExecutionResult]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3817
def post_integrations_action_test(action_id, body, opts = {})
  data, _status_code, _headers = post_integrations_action_test_with_http_info(action_id, body, opts)
  return data
end
post_integrations_action_test_with_http_info(action_id, body, opts = {}) click to toggle source

Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.

@param action_id actionId @param body Map of parameters used for variable substitution. @param [Hash] opts the optional parameters @return [Array<(TestExecutionResult, Fixnum, Hash)>] TestExecutionResult data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3828
def post_integrations_action_test_with_http_info(action_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_test ..."
  end
  
  
  # verify the required parameter 'action_id' is set
  fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_test" if action_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_test" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/{actionId}/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_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(: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 => 'TestExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_actions(body, opts = {}) click to toggle source

Create a new Action

@param body Input used to create Action. @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3891
def post_integrations_actions(body, opts = {})
  data, _status_code, _headers = post_integrations_actions_with_http_info(body, opts)
  return data
end
post_integrations_actions_drafts(body, opts = {}) click to toggle source

Create a new Draft

@param body Input used to create Action Draft. @param [Hash] opts the optional parameters @return [Action]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3956
def post_integrations_actions_drafts(body, opts = {})
  data, _status_code, _headers = post_integrations_actions_drafts_with_http_info(body, opts)
  return data
end
post_integrations_actions_drafts_with_http_info(body, opts = {}) click to toggle source

Create a new Draft

@param body Input used to create Action Draft. @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3966
def post_integrations_actions_drafts_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_actions_drafts ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_actions_drafts" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions/drafts".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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_actions_drafts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_actions_with_http_info(body, opts = {}) click to toggle source

Create a new Action

@param body Input used to create Action. @param [Hash] opts the optional parameters @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3901
def post_integrations_actions_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_actions ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_actions" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/actions".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 => 'Action')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_credentials(opts = {}) click to toggle source

Create a set of credentials

@param [Hash] opts the optional parameters @option opts [Credential] :body Credential @return [CredentialInfo]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4021
def post_integrations_credentials(opts = {})
  data, _status_code, _headers = post_integrations_credentials_with_http_info(opts)
  return data
end
post_integrations_credentials_with_http_info(opts = {}) click to toggle source

Create a set of credentials

@param [Hash] opts the optional parameters @option opts [Credential] :body Credential @return [Array<(CredentialInfo, Fixnum, Hash)>] CredentialInfo data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4031
def post_integrations_credentials_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_credentials ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials".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(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 => 'CredentialInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_with_http_info(opts = {}) click to toggle source

Create an integration.

@param [Hash] opts the optional parameters @option opts [CreateIntegrationRequest] :body Integration @return [Array<(Integration, Fixnum, Hash)>] Integration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 3473
def post_integrations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations".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(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 => 'Integration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_integrations_workforcemanagement_vendorconnection(opts = {}) click to toggle source

Add a vendor connection

@param [Hash] opts the optional parameters @option opts [VendorConnectionRequest] :body @return [UserActionCategoryEntityListing]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4084
def post_integrations_workforcemanagement_vendorconnection(opts = {})
  data, _status_code, _headers = post_integrations_workforcemanagement_vendorconnection_with_http_info(opts)
  return data
end
post_integrations_workforcemanagement_vendorconnection_with_http_info(opts = {}) click to toggle source

Add a vendor connection

@param [Hash] opts the optional parameters @option opts [VendorConnectionRequest] :body @return [Array<(UserActionCategoryEntityListing, Fixnum, Hash)>] UserActionCategoryEntityListing data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4094
def post_integrations_workforcemanagement_vendorconnection_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_workforcemanagement_vendorconnection ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/workforcemanagement/vendorconnection".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(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 => 'UserActionCategoryEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_workforcemanagement_vendorconnection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_integration_config_current(integration_id, opts = {}) click to toggle source

Update integration configuration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [IntegrationConfiguration] :body Integration Configuration @return [IntegrationConfiguration]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4148
def put_integration_config_current(integration_id, opts = {})
  data, _status_code, _headers = put_integration_config_current_with_http_info(integration_id, opts)
  return data
end
put_integration_config_current_with_http_info(integration_id, opts = {}) click to toggle source

Update integration configuration.

@param integration_id Integration Id @param [Hash] opts the optional parameters @option opts [IntegrationConfiguration] :body Integration Configuration @return [Array<(IntegrationConfiguration, Fixnum, Hash)>] IntegrationConfiguration data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4159
def put_integration_config_current_with_http_info(integration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.put_integration_config_current ..."
  end
  
  
  # verify the required parameter 'integration_id' is set
  fail ArgumentError, "Missing the required parameter 'integration_id' when calling IntegrationsApi.put_integration_config_current" if integration_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/{integrationId}/config/current".sub('{format}','json').sub('{' + 'integrationId' + '}', integration_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(: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 => 'IntegrationConfiguration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#put_integration_config_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_integrations_credential(credential_id, opts = {}) click to toggle source

Update a set of credentials

@param credential_id Credential ID @param [Hash] opts the optional parameters @option opts [Credential] :body Credential @return [CredentialInfo]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4221
def put_integrations_credential(credential_id, opts = {})
  data, _status_code, _headers = put_integrations_credential_with_http_info(credential_id, opts)
  return data
end
put_integrations_credential_with_http_info(credential_id, opts = {}) click to toggle source

Update a set of credentials

@param credential_id Credential ID @param [Hash] opts the optional parameters @option opts [Credential] :body Credential @return [Array<(CredentialInfo, Fixnum, Hash)>] CredentialInfo data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4232
def put_integrations_credential_with_http_info(credential_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.put_integrations_credential ..."
  end
  
  
  # verify the required parameter 'credential_id' is set
  fail ArgumentError, "Missing the required parameter 'credential_id' when calling IntegrationsApi.put_integrations_credential" if credential_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/credentials/{credentialId}".sub('{format}','json').sub('{' + 'credentialId' + '}', credential_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(: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 => 'CredentialInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#put_integrations_credential\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
put_integrations_speech_tts_settings(body, opts = {}) click to toggle source

Update TTS settings for an org

@param body Updated TtsSettings @param [Hash] opts the optional parameters @return [TtsSettings]

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4293
def put_integrations_speech_tts_settings(body, opts = {})
  data, _status_code, _headers = put_integrations_speech_tts_settings_with_http_info(body, opts)
  return data
end
put_integrations_speech_tts_settings_with_http_info(body, opts = {}) click to toggle source

Update TTS settings for an org

@param body Updated TtsSettings @param [Hash] opts the optional parameters @return [Array<(TtsSettings, Fixnum, Hash)>] TtsSettings data, response status code and response headers

# File lib/purecloudplatformclientv2/api/integrations_api.rb, line 4303
def put_integrations_speech_tts_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: IntegrationsApi.put_integrations_speech_tts_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.put_integrations_speech_tts_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/integrations/speech/tts/settings".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 => 'TtsSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationsApi#put_integrations_speech_tts_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end