class PureCloud::UtilitiesApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

get_date(opts = {}) click to toggle source

Get the current system date/time

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

# File lib/purecloud/api/utilities_api.rb, line 31
def get_date(opts = {})
  data, status_code, headers = get_date_with_http_info(opts)
  return data
end
get_date_with_http_info(opts = {}) click to toggle source

Get the current system date/time

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

# File lib/purecloud/api/utilities_api.rb, line 40
def get_date_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi#get_date ..."
  end
  
  # resource path
  local_var_path = "/api/v2/date".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ServerDate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#get_date\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_timezones(opts = {}) click to toggle source

Get time zones list

@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) @return [TimeZoneEntityListing]

# File lib/purecloud/api/utilities_api.rb, line 88
def get_timezones(opts = {})
  data, status_code, headers = get_timezones_with_http_info(opts)
  return data
end
get_timezones_with_http_info(opts = {}) click to toggle source

Get time zones list

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

# File lib/purecloud/api/utilities_api.rb, line 99
def get_timezones_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi#get_timezones ..."
  end
  
  # resource path
  local_var_path = "/api/v2/timezones".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']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeZoneEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#get_timezones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_details(body, opts = {}) click to toggle source

Returns the information about an X509 PEM encoded certificate or certificate chain.

@param body Certificate @param [Hash] opts the optional parameters @return [ParsedCertificate]

# File lib/purecloud/api/utilities_api.rb, line 148
def post_details(body, opts = {})
  data, status_code, headers = post_details_with_http_info(body, opts)
  return data
end
post_details_with_http_info(body, opts = {}) click to toggle source

Returns the information about an X509 PEM encoded certificate or certificate chain.

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

# File lib/purecloud/api/utilities_api.rb, line 158
def post_details_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UtilitiesApi#post_details ..."
  end
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling post_details" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/certificate/details".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(: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 => 'ParsedCertificate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UtilitiesApi#post_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end