Class: TCAClient::IndexApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IndexApi

Returns a new instance of IndexApi.



19
20
21
 
# File 'lib/tca_client/api/index_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tca_client/api/index_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_index_status(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ IndexStateSettings

Return index state of submission

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

    The Submission ID (returned upon a successful POST to /submissions)

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/tca_client/api/index_api.rb', line 28

def get_index_status(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = get_index_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#get_index_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(IndexStateSettings, Integer, Hash)>

Return index state of submission

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

    The Submission ID (returned upon a successful POST to /submissions)

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

    the optional parameters

Returns:

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

    IndexStateSettings data, response status code and response headers



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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tca_client/api/index_api.rb', line 39

def get_index_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndexApi.get_index_status ...'
  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 IndexApi.get_index_status"
  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 IndexApi.get_index_status"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IndexApi.get_index_status"
  end
  # resource path
  local_var_path = '/submissions/{id}/index'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IndexStateSettings'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"IndexApi.get_index_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#get_index_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ IndexStateSettings

Index and return index state of submission

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

    The Submission ID (returned upon a successful POST to /submissions)

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

    the optional parameters

Options Hash (opts):

  • :asynchronous (Boolean) —

    asynchronous request

Returns:



104
105
106
107
 
# File 'lib/tca_client/api/index_api.rb', line 104

def index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = index_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#index_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(IndexStateSettings, Integer, Hash)>

Index and return index state of submission

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

    The Submission ID (returned upon a successful POST to /submissions)

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

    the optional parameters

Options Hash (opts):

  • :asynchronous (Boolean) —

    asynchronous request

Returns:

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

    IndexStateSettings data, response status code and response headers



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/tca_client/api/index_api.rb', line 116

def index_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndexApi.index_submission ...'
  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 IndexApi.index_submission"
  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 IndexApi.index_submission"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling IndexApi.index_submission"
  end
  # resource path
  local_var_path = '/submissions/{id}/index'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'asynchronous'] = opts[:'asynchronous'] if !opts[:'asynchronous'].nil?

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IndexStateSettings'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"IndexApi.index_submission",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndexApi#index_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end