tca_client 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddGroupAttachmentRequest.md

@@ -0,0 +1,8 @@
+# TCAClient::AddGroupAttachmentRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | Attachment title | [optional] 
+**template** | **BOOLEAN** | template | [optional] [default to false]
+

data/docs/AddGroupAttachmentResponse.md

@@ -0,0 +1,7 @@
+# TCAClient::AddGroupAttachmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Attachment uuid | [optional] 
+

data/docs/AggregateGroup.md

@@ -0,0 +1,12 @@
+# TCAClient::AggregateGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | (required)  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**group_context** | [**GroupContext**](GroupContext.md) |  | [optional] 
+**due_date** | **Date** | due date for the group | [optional] 
+**report_generation** | **String** |  | [optional] 
+

data/docs/AuthorMetadataOverride.md

@@ -0,0 +1,8 @@
+# TCAClient::AuthorMetadataOverride
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** | Given or first name of submission author | [optional] 
+**family_name** | **String** | Family or last name of submission author | [optional] 
+

data/docs/EULAApi.md

@@ -0,0 +1,241 @@
+# TCAClient::EULAApi
+
+All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**eula_version_id_accept_post**](EULAApi.md#eula_version_id_accept_post) | **POST** /eula/{version_id}/accept | Accepts a particular EULA version on behalf of an external user
+[**eula_version_id_accept_user_id_get**](EULAApi.md#eula_version_id_accept_user_id_get) | **GET** /eula/{version_id}/accept/{user_id} | Queries the acceptences of a particular EULA version on behalf of an external user
+[**eula_version_id_get**](EULAApi.md#eula_version_id_get) | **GET** /eula/{version_id} | Gets information about a particular EULA version
+[**eula_version_id_view_get**](EULAApi.md#eula_version_id_view_get) | **GET** /eula/{version_id}/view | Gets the text of a particular EULA version
+
+# **eula_version_id_accept_post**
+> EulaAcceptListItem eula_version_id_accept_post(bodyx_turnitin_integration_namex_turnitin_integration_versionversion_id)
+
+Accepts a particular EULA version on behalf of an external user
+
+### 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::EULAApi.new
+body = TCAClient::EulaAcceptRequest.new # EulaAcceptRequest | 
+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
+version_id = 'version_id_example' # String | The EULA version ID (or `latest`) 
+
+
+begin
+  #Accepts a particular EULA version on behalf of an external user
+  result = api_instance.eula_version_id_accept_post(bodyx_turnitin_integration_namex_turnitin_integration_versionversion_id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling EULAApi->eula_version_id_accept_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EulaAcceptRequest**](EulaAcceptRequest.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 | 
+ **version_id** | **String**| The EULA version ID (or `latest`)  | 
+
+### Return type
+
+[**EulaAcceptListItem**](EulaAcceptListItem.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **eula_version_id_accept_user_id_get**
+> Array<EulaAcceptListItem> eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
+
+Queries the acceptences of a particular EULA version on behalf of an external user
+
+### 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::EULAApi.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
+version_id = 'version_id_example' # String | The EULA version ID (or `latest`) 
+user_id = 'user_id_example' # String | The user associated with the EULA status 
+
+
+begin
+  #Queries the acceptences of a particular EULA version on behalf of an external user
+  result = api_instance.eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling EULAApi->eula_version_id_accept_user_id_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 | 
+ **version_id** | **String**| The EULA version ID (or `latest`)  | 
+ **user_id** | **String**| The user associated with the EULA status  | 
+
+### Return type
+
+[**Array<EulaAcceptListItem>**](EulaAcceptListItem.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **eula_version_id_get**
+> EulaVersion eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
+
+Gets information about a particular EULA version
+
+### 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::EULAApi.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
+version_id = 'version_id_example' # String | The EULA version ID (or `latest`) 
+opts = { 
+  lang: 'lang_example' # String | The desired language of the specified EULA version
+}
+
+begin
+  #Gets information about a particular EULA version
+  result = api_instance.eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling EULAApi->eula_version_id_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 | 
+ **version_id** | **String**| The EULA version ID (or `latest`)  | 
+ **lang** | **String**| The desired language of the specified EULA version | [optional] 
+
+### Return type
+
+[**EulaVersion**](EulaVersion.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **eula_version_id_view_get**
+> String eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
+
+Gets the text of a particular EULA version
+
+### 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::EULAApi.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
+version_id = 'version_id_example' # String | The EULA version ID (or `latest`) 
+opts = { 
+  lang: 'lang_example' # String | The desired language of the specified EULA version
+}
+
+begin
+  #Gets the text of a particular EULA version
+  result = api_instance.eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling EULAApi->eula_version_id_view_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 | 
+ **version_id** | **String**| The EULA version ID (or `latest`)  | 
+ **lang** | **String**| The desired language of the specified EULA version | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain; charset=utf-8, application/html
+
+
+

data/docs/Error.md

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

data/docs/Eula.md

@@ -0,0 +1,9 @@
+# TCAClient::Eula
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accepted_timestamp** | **DateTime** | The timestamp marking when the EULA was accepted  | [optional] 
+**language** | **String** | The language code for which language instance of the EULA version was accepted  | [optional] 
+**version** | **String** | The unique name of the EULA Version  | [optional] 
+

data/docs/EulaAcceptListItem.md

@@ -0,0 +1,10 @@
+# TCAClient::EulaAcceptListItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The unique id of the user in the external system  | [optional] 
+**accepted_timestamp** | **DateTime** | The timestamp marking when the EULA was accepted  | [optional] 
+**language** | **String** | The language code for which language instance of the EULA version was accepted  | [optional] 
+**version** | **String** | The unique name of the EULA Version  | [optional] 
+

data/docs/EulaAcceptRequest.md

@@ -0,0 +1,10 @@
+# TCAClient::EulaAcceptRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The unique id of the user in the external system  | [optional] 
+**accepted_timestamp** | **DateTime** | The timestamp marking when the EULA was accepted  | [optional] 
+**language** | **String** | The language code for which language instance of the EULA version was accepted  | [optional] 
+**version** | **String** | The unique name of the EULA Version  | [optional] 
+

data/docs/EulaVersion.md

@@ -0,0 +1,11 @@
+# TCAClient::EulaVersion
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **String** | The unique name of the EULA Version  | [optional] 
+**valid_from** | **DateTime** | The starting date indicating when acceptence of this EULA is considered valid  | [optional] 
+**valid_until** | **DateTime** | The ending date indicating when acceptence of this EULA is no longer valid  | [optional] 
+**url** | **String** | The url where the corresponding EULA page can be found  | [optional] 
+**available_languages** | **Array<String>** | The languages (instances) of this version. 21 language locales are currently supported.  | [optional] 
+

data/docs/FeaturesApi.md

@@ -0,0 +1,61 @@
+# TCAClient::FeaturesApi
+
+All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**features_enabled_get**](FeaturesApi.md#features_enabled_get) | **GET** /features-enabled | Get information about what features are allowed by the current license
+
+# **features_enabled_get**
+> FeaturesEnabled features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version)
+
+Get information about what features are allowed by the current license
+
+### 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::FeaturesApi.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
+  #Get information about what features are allowed by the current license
+  result = api_instance.features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version)
+  p result
+rescue TCAClient::ApiError => e
+  puts "Exception when calling FeaturesApi->features_enabled_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
+
+[**FeaturesEnabled**](FeaturesEnabled.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/FeaturesEnabled.md

@@ -0,0 +1,10 @@
+# TCAClient::FeaturesEnabled
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**similarity** | [**FeaturesSimilarity**](FeaturesSimilarity.md) |  | [optional] 
+**tenant** | [**FeaturesTenant**](FeaturesTenant.md) |  | [optional] 
+**product_name** | **String** |  | [optional] 
+**access_options** | **Array<String>** |  | [optional] 
+

data/docs/FeaturesGenerationSettings.md

@@ -0,0 +1,8 @@
+# TCAClient::FeaturesGenerationSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**search_repositories** | **Array<String>** | List of repositories to search | [optional] 
+**submission_auto_excludes** | **BOOLEAN** |  | [optional] 
+

data/docs/FeaturesSimilarity.md

@@ -0,0 +1,9 @@
+# TCAClient::FeaturesSimilarity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**viewer_modes** | [**FeaturesViewerModes**](FeaturesViewerModes.md) |  | [optional] 
+**generation_settings** | [**FeaturesGenerationSettings**](FeaturesGenerationSettings.md) |  | [optional] 
+**view_settings** | [**FeaturesSimilarityViewSettings**](FeaturesSimilarityViewSettings.md) |  | [optional] 
+

data/docs/FeaturesSimilarityViewSettings.md

@@ -0,0 +1,19 @@
+# TCAClient::FeaturesSimilarityViewSettings
+
+## 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** | **BOOLEAN** | 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/FeaturesTenant.md

@@ -0,0 +1,7 @@
+# TCAClient::FeaturesTenant
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**require_eula** | **BOOLEAN** | a flag indicating whether this tenant requires EULA checks to use this API | [optional] 
+

data/docs/FeaturesViewerModes.md

@@ -0,0 +1,8 @@
+# TCAClient::FeaturesViewerModes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**match_overview** | **BOOLEAN** |  | [optional] 
+**all_sources** | **BOOLEAN** |  | [optional] 
+

data/docs/Group.md

@@ -0,0 +1,9 @@
+# TCAClient::Group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | (required)  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+

data/docs/GroupAttachmentResponse.md

@@ -0,0 +1,10 @@
+# TCAClient::GroupAttachmentResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | uuid | [optional] 
+**title** | **String** | title | [optional] 
+**status** | **String** | status | [optional] 
+**template** | **BOOLEAN** | template | [optional] 
+

data/docs/GroupContext.md

@@ -0,0 +1,9 @@
+# TCAClient::GroupContext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | (required)  | [optional] 
+**name** | **String** |  | [optional] 
+**owners** | [**Array<Users>**](Users.md) |  | [optional] 
+