tca_client 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/AddGroupAttachmentRequest.md +16 -4
- data/docs/AddGroupAttachmentResponse.md +14 -3
- data/docs/AggregateGroup.md +24 -8
- data/docs/AnnotationsSettings.md +18 -0
- data/docs/AuthorMetadataOverride.md +16 -4
- data/docs/EULAApi.md +166 -92
- data/docs/Error.md +16 -4
- data/docs/Eula.md +18 -5
- data/docs/EulaAcceptListItem.md +20 -6
- data/docs/EulaAcceptRequest.md +20 -6
- data/docs/EulaVersion.md +22 -7
- data/docs/FeaturesApi.md +41 -23
- data/docs/FeaturesEnabled.md +20 -6
- data/docs/FeaturesGenerationSettings.md +16 -4
- data/docs/FeaturesSimilarity.md +18 -5
- data/docs/FeaturesSimilarityViewSettings.md +38 -15
- data/docs/FeaturesTenant.md +14 -3
- data/docs/FeaturesViewerModes.md +16 -4
- data/docs/GenerateSimilarityPDF.md +18 -0
- data/docs/GetGroupAttachments200Response.md +18 -0
- data/docs/Group.md +18 -5
- data/docs/GroupAttachmentResponse.md +20 -6
- data/docs/GroupContext.md +18 -5
- data/docs/GroupsApi.md +321 -177
- data/docs/IndexApi.md +84 -44
- data/docs/IndexStateSettings.md +14 -3
- data/docs/IndexingSettings.md +14 -3
- data/docs/PDFStatusWebhookRequest.md +24 -0
- data/docs/PdfStatusResponse.md +14 -3
- data/docs/RateLimitError.md +16 -4
- data/docs/RequestPdfResponse.md +14 -3
- data/docs/Sidebar.md +14 -3
- data/docs/SimilarityApi.md +239 -129
- data/docs/SimilarityCompleteWebhookRequest.md +38 -0
- data/docs/SimilarityGenerationSettings.md +20 -6
- data/docs/SimilarityMetadata.md +32 -12
- data/docs/SimilarityMetadataAllOf.md +28 -0
- data/docs/SimilarityMetadataAllOfTopMatches.md +30 -0
- data/docs/SimilarityPutRequest.md +18 -5
- data/docs/SimilarityScoreData.md +20 -6
- data/docs/SimilaritySettings.md +18 -5
- data/docs/SimilaritySettingsModes.md +16 -4
- data/docs/SimilaritySettingsViewSettings.md +14 -3
- data/docs/SimilarityViewSettings.md +38 -15
- data/docs/SimilarityViewerUrlResponse.md +14 -3
- data/docs/SimilarityViewerUrlSettings.md +30 -10
- data/docs/SimpleSubmissionResponse.md +22 -2
- data/docs/SimpleSubmissionResponseAllOf.md +26 -0
- data/docs/Submission.md +34 -2
- data/docs/SubmissionAllOf.md +38 -0
- data/docs/SubmissionApi.md +202 -111
- data/docs/SubmissionBase.md +30 -11
- data/docs/SubmissionBaseMetadata.md +24 -8
- data/docs/SubmissionCompleteWebhookRequest.md +40 -0
- data/docs/SubmissionCompleteWebhookRequestAllOf.md +18 -0
- data/docs/SubmissionCompleteWebhookRequestAllOfMetadata.md +18 -0
- data/docs/SubmissionSizeError.md +16 -4
- data/docs/SuccessMessage.md +14 -3
- data/docs/Users.md +20 -6
- data/docs/ViewerPermissions.md +22 -7
- data/docs/Webhook.md +24 -6
- data/docs/WebhookAllOf.md +20 -0
- data/docs/WebhookApi.md +193 -103
- data/docs/WebhookBase.md +20 -6
- data/docs/WebhookPathRequest.md +16 -4
- data/docs/WebhookWithSecret.md +22 -6
- data/docs/WebhookWithSecretAllOf.md +18 -0
- data/lib/tca_client/api/eula_api.rb +96 -63
- data/lib/tca_client/api/features_api.rb +21 -12
- data/lib/tca_client/api/groups_api.rb +225 -155
- data/lib/tca_client/api/index_api.rb +46 -27
- data/lib/tca_client/api/similarity_api.rb +165 -104
- data/lib/tca_client/api/submission_api.rb +132 -89
- data/lib/tca_client/api/webhook_api.rb +120 -77
- data/lib/tca_client/api_client.rb +61 -57
- data/lib/tca_client/api_error.rb +4 -4
- data/lib/tca_client/configuration.rb +93 -13
- data/lib/tca_client/models/add_group_attachment_request.rb +50 -13
- data/lib/tca_client/models/add_group_attachment_response.rb +25 -12
- data/lib/tca_client/models/aggregate_group.rb +34 -21
- data/lib/tca_client/models/annotations_settings.rb +220 -0
- data/lib/tca_client/models/author_metadata_override.rb +26 -13
- data/lib/tca_client/models/error.rb +26 -13
- data/lib/tca_client/models/eula.rb +27 -14
- data/lib/tca_client/models/eula_accept_list_item.rb +28 -15
- data/lib/tca_client/models/eula_accept_request.rb +28 -15
- data/lib/tca_client/models/eula_version.rb +29 -16
- data/lib/tca_client/models/features_enabled.rb +28 -15
- data/lib/tca_client/models/features_generation_settings.rb +26 -13
- data/lib/tca_client/models/features_similarity.rb +27 -14
- data/lib/tca_client/models/features_similarity_view_settings.rb +37 -24
- data/lib/tca_client/models/features_tenant.rb +25 -12
- data/lib/tca_client/models/features_viewer_modes.rb +26 -13
- data/lib/tca_client/models/generate_similarity_pdf.rb +254 -0
- data/lib/tca_client/models/{inline_response_200.rb → get_group_attachments200_response.rb} +28 -15
- data/lib/tca_client/models/group.rb +29 -16
- data/lib/tca_client/models/group_attachment_response.rb +30 -17
- data/lib/tca_client/models/group_context.rb +27 -14
- data/lib/tca_client/models/index_state_settings.rb +25 -12
- data/lib/tca_client/models/indexing_settings.rb +25 -12
- data/lib/tca_client/models/pdf_status_response.rb +27 -14
- data/lib/tca_client/models/pdf_status_webhook_request.rb +283 -0
- data/lib/tca_client/models/rate_limit_error.rb +36 -20
- data/lib/tca_client/models/request_pdf_response.rb +25 -12
- data/lib/tca_client/models/sidebar.rb +27 -14
- data/lib/tca_client/models/similarity_complete_webhook_request.rb +366 -0
- data/lib/tca_client/models/similarity_generation_settings.rb +30 -17
- data/lib/tca_client/models/similarity_metadata.rb +45 -28
- data/lib/tca_client/models/similarity_metadata_all_of.rb +301 -0
- data/lib/tca_client/models/{similarity_metadata_top_matches.rb → similarity_metadata_all_of_top_matches.rb} +34 -21
- data/lib/tca_client/models/similarity_put_request.rb +27 -14
- data/lib/tca_client/models/similarity_score_data.rb +28 -15
- data/lib/tca_client/models/similarity_settings.rb +29 -16
- data/lib/tca_client/models/similarity_settings_modes.rb +26 -13
- data/lib/tca_client/models/similarity_settings_view_settings.rb +25 -12
- data/lib/tca_client/models/similarity_view_settings.rb +37 -24
- data/lib/tca_client/models/similarity_viewer_url_response.rb +25 -12
- data/lib/tca_client/models/similarity_viewer_url_settings.rb +46 -24
- data/lib/tca_client/models/simple_submission_response.rb +117 -13
- data/lib/tca_client/models/simple_submission_response_all_of.rb +294 -0
- data/lib/tca_client/models/submission.rb +191 -13
- data/lib/tca_client/models/submission_all_of.rb +368 -0
- data/lib/tca_client/models/submission_base.rb +82 -23
- data/lib/tca_client/models/submission_base_metadata.rb +30 -17
- data/lib/tca_client/models/submission_complete_webhook_request.rb +385 -0
- data/lib/tca_client/models/submission_complete_webhook_request_all_of.rb +219 -0
- data/lib/tca_client/models/submission_complete_webhook_request_all_of_metadata.rb +219 -0
- data/lib/tca_client/models/submission_size_error.rb +36 -20
- data/lib/tca_client/models/success_message.rb +25 -12
- data/lib/tca_client/models/users.rb +28 -15
- data/lib/tca_client/models/viewer_permissions.rb +29 -16
- data/lib/tca_client/models/webhook.rb +62 -16
- data/lib/tca_client/models/webhook_all_of.rb +235 -0
- data/lib/tca_client/models/webhook_base.rb +28 -15
- data/lib/tca_client/models/webhook_path_request.rb +26 -13
- data/lib/tca_client/models/webhook_with_secret.rb +52 -16
- data/lib/tca_client/models/webhook_with_secret_all_of.rb +225 -0
- data/lib/tca_client/version.rb +5 -4
- data/lib/tca_client.rb +18 -5
- data/tca_client-1.0.0.gem +0 -0
- data/tca_client.gemspec +7 -7
- metadata +34 -29
- data/docs/InlineResponse200.md +0 -7
- data/docs/SimilarityMetadataTopMatches.md +0 -13
data/docs/EulaAcceptRequest.md
CHANGED
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::EulaAcceptRequest
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user_id** | **String** | The unique id of the user in the external system | [optional] |
|
8
|
+
| **accepted_timestamp** | **Time** | The timestamp marking when the EULA was accepted | [optional] |
|
9
|
+
| **language** | **String** | The language code for which language instance of the EULA version was accepted | [optional] |
|
10
|
+
| **version** | **String** | The unique name of the EULA Version | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::EulaAcceptRequest.new(
|
18
|
+
user_id: null,
|
19
|
+
accepted_timestamp: null,
|
20
|
+
language: null,
|
21
|
+
version: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
data/docs/EulaVersion.md
CHANGED
@@ -1,11 +1,26 @@
|
|
1
1
|
# TCAClient::EulaVersion
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **version** | **String** | The unique name of the EULA Version | [optional] |
|
8
|
+
| **valid_from** | **Time** | The starting date indicating when acceptence of this EULA is considered valid | [optional] |
|
9
|
+
| **valid_until** | **Time** | The ending date indicating when acceptence of this EULA is no longer valid | [optional] |
|
10
|
+
| **url** | **String** | The url where the corresponding EULA page can be found | [optional] |
|
11
|
+
| **available_languages** | **Array<String>** | The languages (instances) of this version. 21 language locales are currently supported. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'tca_client'
|
17
|
+
|
18
|
+
instance = TCAClient::EulaVersion.new(
|
19
|
+
version: null,
|
20
|
+
valid_from: null,
|
21
|
+
valid_until: null,
|
22
|
+
url: null,
|
23
|
+
available_languages: null
|
24
|
+
)
|
25
|
+
```
|
11
26
|
|
data/docs/FeaturesApi.md
CHANGED
@@ -1,48 +1,68 @@
|
|
1
1
|
# TCAClient::FeaturesApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://app-us.turnitin.com/api/v1*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**features_enabled_get**](FeaturesApi.md#features_enabled_get) | **GET** /features-enabled | Get information about what features are allowed by the current license
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**features_enabled_get**](FeaturesApi.md#features_enabled_get) | **GET** /features-enabled | Get information about what features are allowed by the current license |
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
|
10
|
+
## features_enabled_get
|
11
|
+
|
12
|
+
> <FeaturesEnabled> features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version)
|
11
13
|
|
12
14
|
Get information about what features are allowed by the current license
|
13
15
|
|
14
|
-
###
|
16
|
+
### Examples
|
17
|
+
|
15
18
|
```ruby
|
16
|
-
|
19
|
+
require 'time'
|
17
20
|
require 'tca_client'
|
18
21
|
# setup authorization
|
19
22
|
TCAClient.configure do |config|
|
20
23
|
# Configure API key authorization: api_key
|
21
|
-
config.api_key['
|
24
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
22
25
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
23
|
-
#config.api_key_prefix['
|
26
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
24
27
|
end
|
25
28
|
|
26
29
|
api_instance = TCAClient::FeaturesApi.new
|
27
|
-
x_turnitin_integration_name = '
|
28
|
-
x_turnitin_integration_version = '
|
29
|
-
|
30
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
31
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
30
32
|
|
31
33
|
begin
|
32
|
-
#Get information about what features are allowed by the current license
|
34
|
+
# Get information about what features are allowed by the current license
|
33
35
|
result = api_instance.features_enabled_get(x_turnitin_integration_name, x_turnitin_integration_version)
|
34
36
|
p result
|
35
37
|
rescue TCAClient::ApiError => e
|
36
|
-
puts "
|
38
|
+
puts "Error when calling FeaturesApi->features_enabled_get: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the features_enabled_get_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<FeaturesEnabled>, Integer, Hash)> features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Get information about what features are allowed by the current license
|
51
|
+
data, status_code, headers = api_instance.features_enabled_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <FeaturesEnabled>
|
55
|
+
rescue TCAClient::ApiError => e
|
56
|
+
puts "Error when calling FeaturesApi->features_enabled_get_with_http_info: #{e}"
|
37
57
|
end
|
38
58
|
```
|
39
59
|
|
40
60
|
### Parameters
|
41
61
|
|
42
|
-
Name | Type | Description
|
43
|
-
|
44
|
-
**x_turnitin_integration_name** | **String
|
45
|
-
**x_turnitin_integration_version** | **String
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
65
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
46
66
|
|
47
67
|
### Return type
|
48
68
|
|
@@ -54,8 +74,6 @@ Name | Type | Description | Notes
|
|
54
74
|
|
55
75
|
### HTTP request headers
|
56
76
|
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
77
|
+
- **Content-Type**: Not defined
|
78
|
+
- **Accept**: application/json
|
61
79
|
|
data/docs/FeaturesEnabled.md
CHANGED
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::FeaturesEnabled
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **similarity** | [**FeaturesSimilarity**](FeaturesSimilarity.md) | | [optional] |
|
8
|
+
| **tenant** | [**FeaturesTenant**](FeaturesTenant.md) | | [optional] |
|
9
|
+
| **product_name** | **String** | | [optional] |
|
10
|
+
| **access_options** | **Array<String>** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::FeaturesEnabled.new(
|
18
|
+
similarity: null,
|
19
|
+
tenant: null,
|
20
|
+
product_name: null,
|
21
|
+
access_options: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::FeaturesGenerationSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **search_repositories** | **Array<String>** | List of repositories to search | [optional] |
|
8
|
+
| **submission_auto_excludes** | **Boolean** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::FeaturesGenerationSettings.new(
|
16
|
+
search_repositories: null,
|
17
|
+
submission_auto_excludes: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
data/docs/FeaturesSimilarity.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::FeaturesSimilarity
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **viewer_modes** | [**FeaturesViewerModes**](FeaturesViewerModes.md) | | [optional] |
|
8
|
+
| **generation_settings** | [**FeaturesGenerationSettings**](FeaturesGenerationSettings.md) | | [optional] |
|
9
|
+
| **view_settings** | [**FeaturesSimilarityViewSettings**](FeaturesSimilarityViewSettings.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::FeaturesSimilarity.new(
|
17
|
+
viewer_modes: null,
|
18
|
+
generation_settings: null,
|
19
|
+
view_settings: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
@@ -1,19 +1,42 @@
|
|
1
1
|
# TCAClient::FeaturesSimilarityViewSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **exclude_quotes** | **Boolean** | If set to true, text in quotes will not count as similar content | [optional] |
|
8
|
+
| **exclude_bibliography** | **Boolean** | If set to true, text in a bibliography section will not count as similar content | [optional] |
|
9
|
+
| **exclude_citations** | **Boolean** | If set to true, text in citations will not count as similar content | [optional] |
|
10
|
+
| **exclude_abstract** | **Boolean** | If set to true, text in the abstract section of the submission will not count as similar content | [optional] |
|
11
|
+
| **exclude_methods** | **Boolean** | If set to true, text in the method section of the submission will not count as similar content | [optional] |
|
12
|
+
| **exclude_small_matches** | **Boolean** | If set, similarity matches that match less than the specified amount of words will not count as similar content | [optional] |
|
13
|
+
| **exclude_internet** | **Boolean** | If set to true, text matched to the internet collection will not count as similar content | [optional] |
|
14
|
+
| **exclude_publications** | **Boolean** | If set to true, text matched to the publications collection will not count as similar content | [optional] |
|
15
|
+
| **exclude_crossref** | **Boolean** | If set to true, text matched to the Crossref collection will not count as similar content | [optional] |
|
16
|
+
| **exclude_crossref_posted_content** | **Boolean** | If set to true, text matched to the Crossref Posted Content collection will not count as similar content | [optional] |
|
17
|
+
| **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] |
|
18
|
+
| **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] |
|
19
|
+
| **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] |
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'tca_client'
|
25
|
+
|
26
|
+
instance = TCAClient::FeaturesSimilarityViewSettings.new(
|
27
|
+
exclude_quotes: true,
|
28
|
+
exclude_bibliography: true,
|
29
|
+
exclude_citations: true,
|
30
|
+
exclude_abstract: true,
|
31
|
+
exclude_methods: true,
|
32
|
+
exclude_small_matches: true,
|
33
|
+
exclude_internet: true,
|
34
|
+
exclude_publications: true,
|
35
|
+
exclude_crossref: true,
|
36
|
+
exclude_crossref_posted_content: true,
|
37
|
+
exclude_submitted_works: true,
|
38
|
+
exclude_custom_sections: true,
|
39
|
+
exclude_preprints: true
|
40
|
+
)
|
41
|
+
```
|
19
42
|
|
data/docs/FeaturesTenant.md
CHANGED
@@ -1,7 +1,18 @@
|
|
1
1
|
# TCAClient::FeaturesTenant
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **require_eula** | **Boolean** | a flag indicating whether this tenant requires EULA checks to use this API | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::FeaturesTenant.new(
|
15
|
+
require_eula: null
|
16
|
+
)
|
17
|
+
```
|
7
18
|
|
data/docs/FeaturesViewerModes.md
CHANGED
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::FeaturesViewerModes
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **match_overview** | **Boolean** | | [optional] |
|
8
|
+
| **all_sources** | **Boolean** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::FeaturesViewerModes.new(
|
16
|
+
match_overview: null,
|
17
|
+
all_sources: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TCAClient::GenerateSimilarityPDF
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **locale** | **String** | two character locale language setting (e.g. 'en' or 'de') or full value | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::GenerateSimilarityPDF.new(
|
15
|
+
locale: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TCAClient::GetGroupAttachments200Response
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **attachments** | [**Array<GroupAttachmentResponse>**](GroupAttachmentResponse.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::GetGroupAttachments200Response.new(
|
15
|
+
attachments: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/Group.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::Group
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | (required) | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **type** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::Group.new(
|
17
|
+
id: null,
|
18
|
+
name: null,
|
19
|
+
type: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::GroupAttachmentResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | uuid | [optional] |
|
8
|
+
| **title** | **String** | title | [optional] |
|
9
|
+
| **status** | **String** | status | [optional] |
|
10
|
+
| **template** | **Boolean** | template | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::GroupAttachmentResponse.new(
|
18
|
+
id: 768f4633-d4c5-3ba0-8814-caaf421c8985,
|
19
|
+
title: History,
|
20
|
+
status: null,
|
21
|
+
template: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
data/docs/GroupContext.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::GroupContext
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | (required) | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **owners** | [**Array<Users>**](Users.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::GroupContext.new(
|
17
|
+
id: null,
|
18
|
+
name: null,
|
19
|
+
owners: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|