tca_client 1.0.0

data/docs/SimilarityApi.md

@@ -0,0 +1,351 @@
+# TCAClient::SimilarityApi
+
+All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**download_similarity_report_pdf**](SimilarityApi.md#download_similarity_report_pdf) | **GET** /submissions/{id}/similarity/pdf/{pdf_id} | GET download pdf
+[**get_similarity_report_pdf_status**](SimilarityApi.md#get_similarity_report_pdf_status) | **GET** /submissions/{id}/similarity/pdf/{pdf_id}/status | GET pdf download status
+[**get_similarity_report_results**](SimilarityApi.md#get_similarity_report_results) | **GET** /submissions/{id}/similarity | Get Similarity Report Results
+[**get_similarity_report_url**](SimilarityApi.md#get_similarity_report_url) | **POST** /submissions/{id}/viewer-url | Returns a URL to access Cloud Viewer
+[**request_similarity_report**](SimilarityApi.md#request_similarity_report) | **PUT** /submissions/{id}/similarity | Request Similarity Report generation
+[**request_similarity_report_pdf**](SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id
+
+# **download_similarity_report_pdf**
+> String download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+
+GET download pdf
+
+### 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::SimilarityApi.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) 
+pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) 
+
+
+begin
+  #GET download pdf
+  result = api_instance.download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->download_similarity_report_pdf: #{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)  | 
+ **pdf_id** | **String**| The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/pdf, application/json
+
+
+
+# **get_similarity_report_pdf_status**
+> PdfStatusResponse get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+
+GET pdf download status
+
+### 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::SimilarityApi.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) 
+pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) 
+
+
+begin
+  #GET pdf download status
+  result = api_instance.get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->get_similarity_report_pdf_status: #{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)  | 
+ **pdf_id** | **String**| The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  | 
+
+### Return type
+
+[**PdfStatusResponse**](PdfStatusResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_similarity_report_results**
+> SimilarityMetadata get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Get Similarity Report Results
+
+### 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::SimilarityApi.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 Similarity Report Results
+  result = api_instance.get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->get_similarity_report_results: #{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
+
+[**SimilarityMetadata**](SimilarityMetadata.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_similarity_report_url**
+> SimilarityViewerUrlResponse get_similarity_report_url(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+
+Returns a URL to access Cloud Viewer
+
+### 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::SimilarityApi.new
+body = TCAClient::SimilarityViewerUrlSettings.new # SimilarityViewerUrlSettings | 
+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
+  #Returns a URL to access Cloud Viewer
+  result = api_instance.get_similarity_report_url(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->get_similarity_report_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SimilarityViewerUrlSettings**](SimilarityViewerUrlSettings.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**| The Submission ID (returned upon a successful POST to /submissions)  | 
+
+### Return type
+
+[**SimilarityViewerUrlResponse**](SimilarityViewerUrlResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **request_similarity_report**
+> SuccessMessage request_similarity_report(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+
+Request Similarity Report generation
+
+### 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::SimilarityApi.new
+body = TCAClient::SimilarityPutRequest.new # SimilarityPutRequest | 
+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
+  #Request Similarity Report generation
+  result = api_instance.request_similarity_report(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->request_similarity_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SimilarityPutRequest**](SimilarityPutRequest.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**| 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**: application/json
+ - **Accept**: application/json
+
+
+
+# **request_similarity_report_pdf**
+> RequestPdfResponse request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+Request Pdf download and returns the Pdf Id
+
+### 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::SimilarityApi.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
+  #Request Pdf download and returns the Pdf Id
+  result = api_instance.request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling SimilarityApi->request_similarity_report_pdf: #{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
+
+[**RequestPdfResponse**](RequestPdfResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/SimilarityGenerationSettings.md

@@ -0,0 +1,10 @@
+# TCAClient::SimilarityGenerationSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**search_repositories** | **Array<String>** | List of repositories to search | 
+**submission_auto_excludes** | **Array<String>** | List of submission IDs to exclude from report | [optional] 
+**auto_exclude_self_matching_scope** | **String** | self matching submissions to exclude from report | [optional] 
+**priority** | **BOOLEAN** | Priority level of report generation | [optional] 
+

data/docs/SimilarityMetadata.md

@@ -0,0 +1,16 @@
+# TCAClient::SimilarityMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**overall_match_percentage** | **Integer** | Represents the percentage match against all sources | 
+**internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] 
+**publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] 
+**submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] 
+**submission_id** | **String** |  | 
+**status** | **String** | possible values PENDING, COMPLETE | 
+**time_generated** | **String** | Time the report finished generating.  If not set the report has not finished generating | 
+**time_requested** | **String** | Time the report was requested | 
+**top_matches** | [**Array<SimilarityMetadataTopMatches>**](SimilarityMetadataTopMatches.md) | Top matches | 
+**top_source_largest_matched_word_count** | **Integer** | Largest individual matched word count, 0 if there isn't a match to this submission. | 
+

data/docs/SimilarityMetadataTopMatches.md

@@ -0,0 +1,13 @@
+# TCAClient::SimilarityMetadataTopMatches
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Source name | [optional] 
+**percentage** | [**BigDecimal**](BigDecimal.md) | Match percentage | [optional] 
+**submission_id** | **String** | Matching submission id | [optional] 
+**source_type** | **String** | Matching submission source type (INTERNET, PUBLICATION, SUBMITTED_WORK) | [optional] 
+**matched_word_count_total** | [**BigDecimal**](BigDecimal.md) | number of matching words | [optional] 
+**submitted_date** | **String** | date match was submitted | [optional] 
+**institution_name** | **String** | intitution name for matched SUBMITTED_WORK types | [optional] 
+

data/docs/SimilarityPutRequest.md

@@ -0,0 +1,9 @@
+# TCAClient::SimilarityPutRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indexing_settings** | [**IndexingSettings**](IndexingSettings.md) |  | [optional] 
+**generation_settings** | [**SimilarityGenerationSettings**](SimilarityGenerationSettings.md) |  | 
+**view_settings** | [**SimilarityViewSettings**](SimilarityViewSettings.md) |  | [optional] 
+

data/docs/SimilarityScoreData.md

@@ -0,0 +1,10 @@
+# TCAClient::SimilarityScoreData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**overall_match_percentage** | **Integer** | Represents the percentage match against all sources | 
+**internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] 
+**publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] 
+**submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] 
+

data/docs/SimilaritySettings.md

@@ -0,0 +1,9 @@
+# TCAClient::SimilaritySettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_mode** | **String** | default similarity mode when viewing a report; set to either match_overview or all_sources | [optional] 
+**modes** | [**SimilaritySettingsModes**](SimilaritySettingsModes.md) |  | [optional] 
+**view_settings** | [**SimilaritySettingsViewSettings**](SimilaritySettingsViewSettings.md) |  | [optional] 
+

data/docs/SimilaritySettingsModes.md

@@ -0,0 +1,8 @@
+# TCAClient::SimilaritySettingsModes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**match_overview** | **BOOLEAN** | Used to enable use of the match overview mode in the viewer | [optional] 
+**all_sources** | **BOOLEAN** | Used to enable use of the all sources mode in the viewer | [optional] 
+

data/docs/SimilaritySettingsViewSettings.md

@@ -0,0 +1,7 @@
+# TCAClient::SimilaritySettingsViewSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**save_changes** | **BOOLEAN** | Used to enable save changes in the Viewer and trigger SIMILARITY_UPDATED webhook callback | [optional] 
+

data/docs/SimilarityViewSettings.md

@@ -0,0 +1,19 @@
+# TCAClient::SimilarityViewSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclude_quotes** | **BOOLEAN** | If set to true, text in quotes will not count as similar content  | [optional] 
+**exclude_bibliography** | **BOOLEAN** | If set to true, text in a bibliography section will not count as similar content  | [optional] 
+**exclude_citations** | **BOOLEAN** | If set to true, text in citations will not count as similar content  | [optional] 
+**exclude_abstract** | **BOOLEAN** | If set to true, text in the abstract section of the submission will not count as similar content  | [optional] 
+**exclude_methods** | **BOOLEAN** | If set to true, text in the method section of the submission will not count as similar content  | [optional] 
+**exclude_small_matches** | **Integer** | If set, similarity matches that match less than the specified amount of words will not count as similar content  | [optional] 
+**exclude_internet** | **BOOLEAN** | If set to true, text matched to the internet collection will not count as similar content  | [optional] 
+**exclude_publications** | **BOOLEAN** | If set to true, text matched to the publications collection will not count as similar content  | [optional] 
+**exclude_crossref** | **BOOLEAN** | If set to true, text matched to the Crossref collection will not count as similar content  | [optional] 
+**exclude_crossref_posted_content** | **BOOLEAN** | If set to true, text matched to the Crossref Posted Content collection will not count as similar content  | [optional] 
+**exclude_submitted_works** | **BOOLEAN** | If set to true, text matched to the submitted works collection will not count as similar content calculated as if submitted work was not part of the paper  | [optional] 
+**exclude_custom_sections** | **BOOLEAN** | If set to true, text matched to the custom sections defined in the admin settings will not count as similar content calculated as if section was not part of the paper  | [optional] 
+**exclude_preprints** | **BOOLEAN** | If set to true, it will exclude preprints. A preprint is a version of a scholarly or scientific paper that precedes formal peer review and publication in a peer-reviewed scholarly or scientific journal.  | [optional] 
+

data/docs/SimilarityViewerUrlResponse.md

@@ -0,0 +1,7 @@
+# TCAClient::SimilarityViewerUrlResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**viewer_url** | **String** | URL to be used to access Cloud Viewer visualization of similarity report matches | [optional] 
+

data/docs/SimilarityViewerUrlSettings.md

@@ -0,0 +1,14 @@
+# TCAClient::SimilarityViewerUrlSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author_metadata_override** | [**AuthorMetadataOverride**](AuthorMetadataOverride.md) |  | [optional] 
+**viewer_user_id** | **String** | viewer's user ID | [optional] 
+**locale** | **String** | two character locale language setting (e.g. 'en' or 'de') or full value | [optional] 
+**viewer_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] 
+**viewer_permissions** | [**ViewerPermissions**](ViewerPermissions.md) |  | [optional] 
+**eula** | [**Eula**](Eula.md) |  | [optional] 
+**sidebar** | [**Sidebar**](Sidebar.md) |  | [optional] 
+**similarity** | [**SimilaritySettings**](SimilaritySettings.md) |  | [optional] 
+

data/docs/SimpleSubmissionResponse.md

@@ -0,0 +1,6 @@
+# TCAClient::SimpleSubmissionResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/Submission.md

@@ -0,0 +1,6 @@
+# TCAClient::Submission
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+