tca_client 1.0.0 → 1.0.2

data/docs/EulaAcceptRequest.md

@@ -1,10 +1,24 @@
 # 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The unique id of the user in the external system  | [optional] |
+| **accepted_timestamp** | **Time** | 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] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::EulaAcceptRequest.new(
+  user_id: null,
+  accepted_timestamp: null,
+  language: null,
+  version: null
+)
+```
 

data/docs/EulaVersion.md

@@ -1,11 +1,26 @@
 # 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The unique name of the EULA Version  | [optional] |
+| **valid_from** | **Time** | The starting date indicating when acceptence of this EULA is considered valid  | [optional] |
+| **valid_until** | **Time** | 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] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::EulaVersion.new(
+  version: null,
+  valid_from: null,
+  valid_until: null,
+  url: null,
+  available_languages: null
+)
+```
 

data/docs/FeaturesApi.md

@@ -1,48 +1,68 @@
 # TCAClient::FeaturesApi
 
-All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+All URIs are relative to *https://app-us.turnitin.com/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
+| 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)
+
+## 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
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = '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'
+  # config.api_key_prefix['api_key'] = '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
-
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 
 begin
-  #Get information about what features are allowed by the current license
+  # 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}"
+  puts "Error when calling FeaturesApi->features_enabled_get: #{e}"
+end
+```
+
+#### Using the features_enabled_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FeaturesEnabled>, Integer, Hash)> features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
+
+```ruby
+begin
+  # Get information about what features are allowed by the current license
+  data, status_code, headers = api_instance.features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FeaturesEnabled>
+rescue TCAClient::ApiError => e
+  puts "Error when calling FeaturesApi->features_enabled_get_with_http_info: #{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 | 
+| 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
 
@@ -54,8 +74,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/FeaturesEnabled.md

@@ -1,10 +1,24 @@
 # 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **similarity** | [**FeaturesSimilarity**](FeaturesSimilarity.md) |  | [optional] |
+| **tenant** | [**FeaturesTenant**](FeaturesTenant.md) |  | [optional] |
+| **product_name** | **String** |  | [optional] |
+| **access_options** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesEnabled.new(
+  similarity: null,
+  tenant: null,
+  product_name: null,
+  access_options: null
+)
+```
 

data/docs/FeaturesGenerationSettings.md

@@ -1,8 +1,20 @@
 # TCAClient::FeaturesGenerationSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**search_repositories** | **Array<String>** | List of repositories to search | [optional] 
-**submission_auto_excludes** | **BOOLEAN** |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_repositories** | **Array<String>** | List of repositories to search | [optional] |
+| **submission_auto_excludes** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesGenerationSettings.new(
+  search_repositories: null,
+  submission_auto_excludes: null
+)
+```
 

data/docs/FeaturesSimilarity.md

@@ -1,9 +1,22 @@
 # 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] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **viewer_modes** | [**FeaturesViewerModes**](FeaturesViewerModes.md) |  | [optional] |
+| **generation_settings** | [**FeaturesGenerationSettings**](FeaturesGenerationSettings.md) |  | [optional] |
+| **view_settings** | [**FeaturesSimilarityViewSettings**](FeaturesSimilarityViewSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesSimilarity.new(
+  viewer_modes: null,
+  generation_settings: null,
+  view_settings: null
+)
+```
 

data/docs/FeaturesSimilarityViewSettings.md

@@ -1,19 +1,42 @@
 # 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] 
+
+| 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] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesSimilarityViewSettings.new(
+  exclude_quotes: true,
+  exclude_bibliography: true,
+  exclude_citations: true,
+  exclude_abstract: true,
+  exclude_methods: true,
+  exclude_small_matches: true,
+  exclude_internet: true,
+  exclude_publications: true,
+  exclude_crossref: true,
+  exclude_crossref_posted_content: true,
+  exclude_submitted_works: true,
+  exclude_custom_sections: true,
+  exclude_preprints: true
+)
+```
 

data/docs/FeaturesTenant.md

@@ -1,7 +1,18 @@
 # TCAClient::FeaturesTenant
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**require_eula** | **BOOLEAN** | a flag indicating whether this tenant requires EULA checks to use this API | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **require_eula** | **Boolean** | a flag indicating whether this tenant requires EULA checks to use this API | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesTenant.new(
+  require_eula: null
+)
+```
 

data/docs/FeaturesViewerModes.md

@@ -1,8 +1,20 @@
 # TCAClient::FeaturesViewerModes
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**match_overview** | **BOOLEAN** |  | [optional] 
-**all_sources** | **BOOLEAN** |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_overview** | **Boolean** |  | [optional] |
+| **all_sources** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::FeaturesViewerModes.new(
+  match_overview: null,
+  all_sources: null
+)
+```
 

data/docs/GenerateSimilarityPDF.md

@@ -0,0 +1,18 @@
+# TCAClient::GenerateSimilarityPDF
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **locale** | **String** | two character locale language setting (e.g. 'en' or 'de') or full value | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::GenerateSimilarityPDF.new(
+  locale: null
+)
+```
+

data/docs/GetGroupAttachments200Response.md

@@ -0,0 +1,18 @@
+# TCAClient::GetGroupAttachments200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachments** | [**Array<GroupAttachmentResponse>**](GroupAttachmentResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::GetGroupAttachments200Response.new(
+  attachments: null
+)
+```
+

data/docs/Group.md

@@ -1,9 +1,22 @@
 # TCAClient::Group
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | (required)  | [optional] 
-**name** | **String** |  | [optional] 
-**type** | **String** |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | (required)  | [optional] |
+| **name** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::Group.new(
+  id: null,
+  name: null,
+  type: null
+)
+```
 

data/docs/GroupAttachmentResponse.md

@@ -1,10 +1,24 @@
 # TCAClient::GroupAttachmentResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | uuid | [optional] 
-**title** | **String** | title | [optional] 
-**status** | **String** | status | [optional] 
-**template** | **BOOLEAN** | template | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | uuid | [optional] |
+| **title** | **String** | title | [optional] |
+| **status** | **String** | status | [optional] |
+| **template** | **Boolean** | template | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::GroupAttachmentResponse.new(
+  id: 768f4633-d4c5-3ba0-8814-caaf421c8985,
+  title: History,
+  status: null,
+  template: null
+)
+```
 

data/docs/GroupContext.md

@@ -1,9 +1,22 @@
 # TCAClient::GroupContext
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | (required)  | [optional] 
-**name** | **String** |  | [optional] 
-**owners** | [**Array<Users>**](Users.md) |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | (required)  | [optional] |
+| **name** | **String** |  | [optional] |
+| **owners** | [**Array<Users>**](Users.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::GroupContext.new(
+  id: null,
+  name: null,
+  owners: null
+)
+```