Class: RusticiSoftwareCloudV2::AboutApi

Inherits:
Object
  • Object
show all
Extended by:
Gem::Deprecate
Defined in:
lib/rustici_software_cloud_v2/api/about_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AboutApi

Returns a new instance of AboutApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/about_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/about_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_about(opts = {}) ⇒ AboutSchema

Get back the API version and Application name Get back the API version and application name. The return value for this method will never change. This method largely exists for API parity with our on-premise or Managed Hosting products, which may return different release numbers from this endpoint. For SCORM Cloud, this is effectively equal to the ‘/ping` resource.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/rustici_software_cloud_v2/api/about_api.rb', line 28

def get_about(opts = {})
  data, _status_code, _headers = get_about_with_http_info(opts)
  data
end

#get_about_with_http_info(opts = {}) ⇒ Array<(AboutSchema, Fixnum, Hash)>

Get back the API version and Application name Get back the API version and application name. The return value for this method will never change. This method largely exists for API parity with our on-premise or Managed Hosting products, which may return different release numbers from this endpoint. For SCORM Cloud, this is effectively equal to the &#x60;/ping&#x60; resource.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AboutSchema, Fixnum, Hash)>) —

    AboutSchema data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rustici_software_cloud_v2/api/about_api.rb', line 37

def get_about_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AboutApi.get_about ...'
  end
  # resource path
  local_var_path = '/about'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', '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 => 'AboutSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AboutApi#get_about\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end