Class: TCAClient::WebhookApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WebhookApi

Returns a new instance of WebhookApi.



16
17
18
 
# File 'lib/tca_client/api/webhook_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/webhook_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ nil

Delete Webhook endpoint

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

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

    the optional parameters

Returns:

  • (nil) 


25
26
27
28
 
# File 'lib/tca_client/api/webhook_api.rb', line 25

def delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  delete_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  nil
end

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

Delete Webhook endpoint

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
81
82
83
84
85
86
 
# File 'lib/tca_client/api/webhook_api.rb', line 36

def delete_webhook_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: WebhookApi.delete_webhook ...'
  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 WebhookApi.delete_webhook"
  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 WebhookApi.delete_webhook"
  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 WebhookApi.delete_webhook"
  end
  # resource path
  local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] 

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

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

#get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Webhook

Get Webhook endpoint info

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

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

    the optional parameters

Returns:



93
94
95
96
 
# File 'lib/tca_client/api/webhook_api.rb', line 93

def get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = get_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

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

Get Webhook endpoint info

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

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

    the optional parameters

Returns:

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

    Webhook data, response status code and response headers



104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/tca_client/api/webhook_api.rb', line 104

def get_webhook_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: WebhookApi.get_webhook ...'
  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 WebhookApi.get_webhook"
  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 WebhookApi.get_webhook"
  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 WebhookApi.get_webhook"
  end
  # resource path
  local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', 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[:body] 

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

  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: WebhookApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_webhook(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Webhook

Update Webhook endpoint info

Parameters:

  • body
  • 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

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/tca_client/api/webhook_api.rb', line 162

def update_webhook(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = update_webhook_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#update_webhook_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Update Webhook endpoint info

Parameters:

  • body
  • 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

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

    the optional parameters

Returns:

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

    Webhook data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/tca_client/api/webhook_api.rb', line 174

def update_webhook_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.update_webhook ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebhookApi.update_webhook"
  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 WebhookApi.update_webhook"
  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 WebhookApi.update_webhook"
  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 WebhookApi.update_webhook"
  end
  # resource path
  local_var_path = '/webhooks/{id}'.sub('{' + 'id' + '}', 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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] || @api_client.object_to_http_body(body) 

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

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

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

#webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version, opts = {}) ⇒ Array<Webhook>

List registered Webhook endpoints

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:



236
237
238
239
 
# File 'lib/tca_client/api/webhook_api.rb', line 236

def webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
  data, _status_code, _headers = webhooks_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, opts)
  data
end

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

List registered Webhook endpoints

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<(Array<Webhook>, Integer, Hash)>) —

    Array<Webhook> data, response status code and response headers



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/tca_client/api/webhook_api.rb', line 246

def webhooks_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: WebhookApi.webhooks_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 WebhookApi.webhooks_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 WebhookApi.webhooks_get"
  end
  # resource path
  local_var_path = '/webhooks'

  # 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] || 'Array<Webhook>' 

  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: WebhookApi#webhooks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhooks_post(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {}) ⇒ Webhook

Register a Webhook endpoint

Parameters:

  • body
  • 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:



299
300
301
302
 
# File 'lib/tca_client/api/webhook_api.rb', line 299

def webhooks_post(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
  data, _status_code, _headers = webhooks_post_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts)
  data
end

#webhooks_post_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>

Register a Webhook endpoint

Parameters:

  • body
  • 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<(Webhook, Integer, Hash)>) —

    Webhook data, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/tca_client/api/webhook_api.rb', line 310

def webhooks_post_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhookApi.webhooks_post ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling WebhookApi.webhooks_post"
  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 WebhookApi.webhooks_post"
  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 WebhookApi.webhooks_post"
  end
  # resource path
  local_var_path = '/webhooks'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['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] || @api_client.object_to_http_body(body) 

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

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

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