Class: TCAClient::FeaturesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tca_client/api/features_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FeaturesApi

Returns a new instance of FeaturesApi.



16
17
18
 
# File 'lib/tca_client/api/features_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/tca_client/api/features_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version, opts = {}) ⇒ FeaturesEnabled

Get information about what features are allowed by the current license

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

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

    the optional parameters

Returns:



24
25
26
27
 
# File 'lib/tca_client/api/features_api.rb', line 24

def features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
  data, _status_code, _headers = features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, opts)
  data
end

#features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, opts = {}) ⇒ Array<(FeaturesEnabled, Integer, Hash)>

Get information about what features are allowed by the current license

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

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

    the optional parameters

Returns:

  • (Array<(FeaturesEnabled, Integer, Hash)>) —

    FeaturesEnabled data, response status code and response headers



34
35
36
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
72
73
74
75
76
77
78
79
80
 
# File 'lib/tca_client/api/features_api.rb', line 34

def features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FeaturesApi.features_enabled_get ...'
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling FeaturesApi.features_enabled_get"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling FeaturesApi.features_enabled_get"
  end
  # resource path
  local_var_path = '/features-enabled'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'FeaturesEnabled' 

  auth_names = opts[:auth_names] || ['api_key']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FeaturesApi#features_enabled_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end