tca_client 1.0.0

data/docs/SubmissionApi.md

@@ -0,0 +1,296 @@
+# TCAClient::SubmissionApi
+
+All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission
+[**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report.
+[**get_submiddion_details**](SubmissionApi.md#get_submiddion_details) | **GET** /submissions/{id} | Get Submission Details
+[**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission
+[**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File
+
+# **create_submission**
+> SimpleSubmissionResponse create_submission(bodyx_turnitin_integration_namex_turnitin_integration_version)
+
+Create a new Submission
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::SubmissionApi.new
+body = TCAClient::SubmissionBase.new # SubmissionBase | 
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+
+
+begin
+  #Create a new Submission
+  result = api_instance.create_submission(bodyx_turnitin_integration_namex_turnitin_integration_version)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SubmissionApi->create_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SubmissionBase**](SubmissionBase.md)|  | 
+ **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 | 
+
+### Return type
+
+[**SimpleSubmissionResponse**](SimpleSubmissionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_submission**
+> SuccessMessage delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+
+Deletes a submission and associated similarity report.
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::SubmissionApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
+opts = { 
+  hard: 'false' # String | Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered. 
+}
+
+begin
+  #Deletes a submission and associated similarity report.
+  result = api_instance.delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SubmissionApi->delete_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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)  | 
+ **hard** | **String**| Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered.  | [optional] [default to false]
+
+### Return type
+
+[**SuccessMessage**](SuccessMessage.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_submiddion_details**
+> Submission get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Get Submission Details
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::SubmissionApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
+
+
+begin
+  #Get Submission Details
+  result = api_instance.get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SubmissionApi->get_submiddion_details: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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)  | 
+
+### Return type
+
+[**Submission**](Submission.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **recover_submission**
+> SimpleSubmissionResponse recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Recover a soft deleted submission
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::SubmissionApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
+
+
+begin
+  #Recover a soft deleted submission
+  result = api_instance.recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SubmissionApi->recover_submission: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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)  | 
+
+### Return type
+
+[**SimpleSubmissionResponse**](SimpleSubmissionResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **upload_submitted_file**
+> SuccessMessage upload_submitted_file(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_typecontent_dispositionid)
+
+Upload Submitted File
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::SubmissionApi.new
+body = nil # Object | the user's submitted file
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+content_type = 'content_type_example' # String | *Must be 'binary/octet-stream' 
+content_disposition = 'content_disposition_example' # String | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`. To support UTF-8 filenames, you must URL encode the header 
+id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
+
+
+begin
+  #Upload Submitted File
+  result = api_instance.upload_submitted_file(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_typecontent_dispositionid)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SubmissionApi->upload_submitted_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Object**](Object.md)| the user's submitted file | 
+ **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 | 
+ **content_type** | **String**| *Must be 'binary/octet-stream'  | 
+ **content_disposition** | **String**| *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`. To support UTF-8 filenames, you must URL encode the header  | 
+ **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
+
+### Return type
+
+[**SuccessMessage**](SuccessMessage.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: binary/octet-stream
+ - **Accept**: application/json
+
+
+

data/docs/SubmissionBase.md

@@ -0,0 +1,15 @@
+# TCAClient::SubmissionBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | [****](.md) | Submission id, optional field | [optional] 
+**owner** | **String** | ID of the owning user | [optional] 
+**owner_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] 
+**title** | **String** | the title of the submission | [optional] 
+**submitter** | **String** | (optional) ID of the submitting user, if different from the owning user | [optional] 
+**submitter_default_permission_set** | **String** | Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] 
+**eula** | [**Eula**](Eula.md) |  | [optional] 
+**metadata** | [**SubmissionBaseMetadata**](SubmissionBaseMetadata.md) |  | [optional] 
+**extract_text_only** | **BOOLEAN** | (optional) indicates if the submission should be treated as a text only submission. A text only submission cannot generate full reports or be viewed in the viewer, but can use the index only endpoint to be indexed | [optional] 
+

data/docs/SubmissionBaseMetadata.md

@@ -0,0 +1,12 @@
+# TCAClient::SubmissionBaseMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**submitter** | [**Users**](Users.md) |  | [optional] 
+**owners** | [**Array<Users>**](Users.md) |  | [optional] 
+**group** | [**Group**](Group.md) |  | [optional] 
+**group_context** | [**GroupContext**](GroupContext.md) |  | [optional] 
+**original_submitted_time** | **DateTime** | Optional original submision date | [optional] 
+**custom** | **String** | custom metadata | [optional] 
+

data/docs/SubmissionSizeError.md

@@ -0,0 +1,8 @@
+# TCAClient::SubmissionSizeError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | an HTTP Response JobStatus Code | [optional] 
+**message** | **String** | A message explaining what happened | [optional] 
+

data/docs/SuccessMessage.md

@@ -0,0 +1,7 @@
+# TCAClient::SuccessMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | message indicating a successful PUT request | [optional] 
+

data/docs/Users.md

@@ -0,0 +1,10 @@
+# TCAClient::Users
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | (required)  | [optional] 
+**family_name** | **String** |  | [optional] 
+**given_name** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+

data/docs/ViewerPermissions.md

@@ -0,0 +1,11 @@
+# TCAClient::ViewerPermissions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**may_view_submission_full_source** | **BOOLEAN** | Optional individual permission which override the default permission set. | [optional] 
+**may_view_match_submission_info** | **BOOLEAN** | Optional individual permission which override the default permission set. | [optional] 
+**may_view_flags_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional] 
+**may_view_document_details_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional] 
+**may_view_sections_exclusion_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional] 
+

data/docs/Webhook.md

@@ -0,0 +1,10 @@
+# TCAClient::Webhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | a human readable description of the webhook | [optional] 
+**url** | **String** | the URL to callback with events, this must be https unless (allow_insecure is true) | 
+**allow_insecure** | **BOOLEAN** | if using an non https url, this must be set to true | [optional] 
+**event_types** | **Array<String>** | an array of the types of callbacks that will be sent to this webhook | 
+

data/docs/WebhookApi.md

@@ -0,0 +1,286 @@
+# TCAClient::WebhookApi
+
+All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete Webhook endpoint
+[**get_webhook**](WebhookApi.md#get_webhook) | **GET** /webhooks/{id} | Get Webhook endpoint info
+[**update_webhook**](WebhookApi.md#update_webhook) | **PATCH** /webhooks/{id} | Update Webhook endpoint info
+[**webhooks_get**](WebhookApi.md#webhooks_get) | **GET** /webhooks | List registered Webhook endpoints
+[**webhooks_post**](WebhookApi.md#webhooks_post) | **POST** /webhooks | Register a Webhook endpoint
+
+# **delete_webhook**
+> delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Delete Webhook endpoint
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::WebhookApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | 
+
+
+begin
+  #Delete Webhook endpoint
+  api_instance.delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
+rescue TCAClient::ApiError => e
+  puts "Exception when calling WebhookApi->delete_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_webhook**
+> Webhook get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Get Webhook endpoint info
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::WebhookApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | 
+
+
+begin
+  #Get Webhook endpoint info
+  result = api_instance.get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling WebhookApi->get_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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**|  | 
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_webhook**
+> Webhook update_webhook(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+
+Update Webhook endpoint info
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::WebhookApi.new
+body = TCAClient::WebhookPathRequest.new # WebhookPathRequest | 
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+id = 'id_example' # String | 
+
+
+begin
+  #Update Webhook endpoint info
+  result = api_instance.update_webhook(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling WebhookApi->update_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**WebhookPathRequest**](WebhookPathRequest.md)|  | 
+ **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**|  | 
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **webhooks_get**
+> Array<Webhook> webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version)
+
+List registered Webhook endpoints
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::WebhookApi.new
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+
+
+begin
+  #List registered Webhook endpoints
+  result = api_instance.webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling WebhookApi->webhooks_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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 | 
+
+### Return type
+
+[**Array<Webhook>**](Webhook.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **webhooks_post**
+> Webhook webhooks_post(bodyx_turnitin_integration_namex_turnitin_integration_version)
+
+Register a Webhook endpoint
+
+### Example
+```ruby
+# load the gem
+require 'tca_client'
+# setup authorization
+TCAClient.configure do |config|
+  # Configure API key authorization: api_key
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = TCAClient::WebhookApi.new
+body = TCAClient::WebhookWithSecret.new # WebhookWithSecret | 
+x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+
+
+begin
+  #Register a Webhook endpoint
+  result = api_instance.webhooks_post(bodyx_turnitin_integration_namex_turnitin_integration_version)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling WebhookApi->webhooks_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**WebhookWithSecret**](WebhookWithSecret.md)|  | 
+ **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 | 
+
+### Return type
+
+[**Webhook**](Webhook.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/WebhookBase.md

@@ -0,0 +1,10 @@
+# TCAClient::WebhookBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | a human readable description of the webhook | [optional] 
+**url** | **String** | the URL to callback with events, this must be https unless (allow_insecure is true) | 
+**allow_insecure** | **BOOLEAN** | if using an non https url, this must be set to true | [optional] 
+**event_types** | **Array<String>** | an array of the types of callbacks that will be sent to this webhook | 
+

data/docs/WebhookPathRequest.md

@@ -0,0 +1,8 @@
+# TCAClient::WebhookPathRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | a human readable description of the webhook | [optional] 
+**event_types** | **Array<String>** | an array of the types of callbacks that will be sent to this webhook | 
+