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/SimilarityMetadata.md
CHANGED
@@ -1,16 +1,36 @@
|
|
1
1
|
# TCAClient::SimilarityMetadata
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **overall_match_percentage** | **Integer** | Represents the percentage match against all sources | |
|
8
|
+
| **internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] |
|
9
|
+
| **publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] |
|
10
|
+
| **submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] |
|
11
|
+
| **submission_id** | **String** | | |
|
12
|
+
| **status** | **String** | possible values PENDING, COMPLETE | |
|
13
|
+
| **time_generated** | **String** | Time the report finished generating. If not set the report has not finished generating | |
|
14
|
+
| **time_requested** | **String** | Time the report was requested | |
|
15
|
+
| **top_matches** | [**Array<SimilarityMetadataAllOfTopMatches>**](SimilarityMetadataAllOfTopMatches.md) | Top matches | |
|
16
|
+
| **top_source_largest_matched_word_count** | **Integer** | Largest individual matched word count, 0 if there isn't a match to this submission. | |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'tca_client'
|
22
|
+
|
23
|
+
instance = TCAClient::SimilarityMetadata.new(
|
24
|
+
overall_match_percentage: null,
|
25
|
+
internet_match_percentage: null,
|
26
|
+
publication_match_percentage: null,
|
27
|
+
submitted_works_match_percentage: null,
|
28
|
+
submission_id: null,
|
29
|
+
status: null,
|
30
|
+
time_generated: null,
|
31
|
+
time_requested: null,
|
32
|
+
top_matches: null,
|
33
|
+
top_source_largest_matched_word_count: null
|
34
|
+
)
|
35
|
+
```
|
16
36
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# TCAClient::SimilarityMetadataAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **submission_id** | **String** | | |
|
8
|
+
| **status** | **String** | possible values PENDING, COMPLETE | |
|
9
|
+
| **time_generated** | **String** | Time the report finished generating. If not set the report has not finished generating | |
|
10
|
+
| **time_requested** | **String** | Time the report was requested | |
|
11
|
+
| **top_matches** | [**Array<SimilarityMetadataAllOfTopMatches>**](SimilarityMetadataAllOfTopMatches.md) | Top matches | |
|
12
|
+
| **top_source_largest_matched_word_count** | **Integer** | Largest individual matched word count, 0 if there isn't a match to this submission. | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'tca_client'
|
18
|
+
|
19
|
+
instance = TCAClient::SimilarityMetadataAllOf.new(
|
20
|
+
submission_id: null,
|
21
|
+
status: null,
|
22
|
+
time_generated: null,
|
23
|
+
time_requested: null,
|
24
|
+
top_matches: null,
|
25
|
+
top_source_largest_matched_word_count: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# TCAClient::SimilarityMetadataAllOfTopMatches
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Source name | [optional] |
|
8
|
+
| **percentage** | **Float** | Match percentage | [optional] |
|
9
|
+
| **submission_id** | **String** | Matching submission id | [optional] |
|
10
|
+
| **source_type** | **String** | Matching submission source type (INTERNET, PUBLICATION, SUBMITTED_WORK) | [optional] |
|
11
|
+
| **matched_word_count_total** | **Float** | number of matching words | [optional] |
|
12
|
+
| **submitted_date** | **String** | date match was submitted | [optional] |
|
13
|
+
| **institution_name** | **String** | intitution name for matched SUBMITTED_WORK types | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'tca_client'
|
19
|
+
|
20
|
+
instance = TCAClient::SimilarityMetadataAllOfTopMatches.new(
|
21
|
+
name: null,
|
22
|
+
percentage: null,
|
23
|
+
submission_id: null,
|
24
|
+
source_type: null,
|
25
|
+
matched_word_count_total: null,
|
26
|
+
submitted_date: null,
|
27
|
+
institution_name: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::SimilarityPutRequest
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **indexing_settings** | [**IndexingSettings**](IndexingSettings.md) | | [optional] |
|
8
|
+
| **generation_settings** | [**SimilarityGenerationSettings**](SimilarityGenerationSettings.md) | | |
|
9
|
+
| **view_settings** | [**SimilarityViewSettings**](SimilarityViewSettings.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::SimilarityPutRequest.new(
|
17
|
+
indexing_settings: null,
|
18
|
+
generation_settings: null,
|
19
|
+
view_settings: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
data/docs/SimilarityScoreData.md
CHANGED
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::SimilarityScoreData
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **overall_match_percentage** | **Integer** | Represents the percentage match against all sources | |
|
8
|
+
| **internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] |
|
9
|
+
| **publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] |
|
10
|
+
| **submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::SimilarityScoreData.new(
|
18
|
+
overall_match_percentage: null,
|
19
|
+
internet_match_percentage: null,
|
20
|
+
publication_match_percentage: null,
|
21
|
+
submitted_works_match_percentage: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|
data/docs/SimilaritySettings.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::SimilaritySettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **default_mode** | **String** | default similarity mode when viewing a report; set to either match_overview or all_sources | [optional] |
|
8
|
+
| **modes** | [**SimilaritySettingsModes**](SimilaritySettingsModes.md) | | [optional] |
|
9
|
+
| **view_settings** | [**SimilaritySettingsViewSettings**](SimilaritySettingsViewSettings.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::SimilaritySettings.new(
|
17
|
+
default_mode: null,
|
18
|
+
modes: null,
|
19
|
+
view_settings: null
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::SimilaritySettingsModes
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **match_overview** | **Boolean** | Used to enable use of the match overview mode in the viewer | [optional] |
|
8
|
+
| **all_sources** | **Boolean** | Used to enable use of the all sources mode in the viewer | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::SimilaritySettingsModes.new(
|
16
|
+
match_overview: null,
|
17
|
+
all_sources: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
@@ -1,7 +1,18 @@
|
|
1
1
|
# TCAClient::SimilaritySettingsViewSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **save_changes** | **Boolean** | Used to enable save changes in the Viewer and trigger SIMILARITY_UPDATED webhook callback | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::SimilaritySettingsViewSettings.new(
|
15
|
+
save_changes: null
|
16
|
+
)
|
17
|
+
```
|
7
18
|
|
@@ -1,19 +1,42 @@
|
|
1
1
|
# TCAClient::SimilarityViewSettings
|
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** | **Integer** | 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::SimilarityViewSettings.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: 4,
|
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
|
|
@@ -1,7 +1,18 @@
|
|
1
1
|
# TCAClient::SimilarityViewerUrlResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **viewer_url** | **String** | URL to be used to access Cloud Viewer visualization of similarity report matches | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::SimilarityViewerUrlResponse.new(
|
15
|
+
viewer_url: null
|
16
|
+
)
|
17
|
+
```
|
7
18
|
|
@@ -1,14 +1,34 @@
|
|
1
1
|
# TCAClient::SimilarityViewerUrlSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **author_metadata_override** | [**AuthorMetadataOverride**](AuthorMetadataOverride.md) | | [optional] |
|
8
|
+
| **viewer_user_id** | **String** | viewer's user ID | [optional] |
|
9
|
+
| **locale** | **String** | two character locale language setting (e.g. 'en' or 'de') or full value | [optional] |
|
10
|
+
| **viewer_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] |
|
11
|
+
| **viewer_permissions** | [**ViewerPermissions**](ViewerPermissions.md) | | [optional] |
|
12
|
+
| **eula** | [**Eula**](Eula.md) | | [optional] |
|
13
|
+
| **sidebar** | [**Sidebar**](Sidebar.md) | | [optional] |
|
14
|
+
| **similarity** | [**SimilaritySettings**](SimilaritySettings.md) | | [optional] |
|
15
|
+
| **annotations** | [**AnnotationsSettings**](AnnotationsSettings.md) | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'tca_client'
|
21
|
+
|
22
|
+
instance = TCAClient::SimilarityViewerUrlSettings.new(
|
23
|
+
author_metadata_override: null,
|
24
|
+
viewer_user_id: null,
|
25
|
+
locale: null,
|
26
|
+
viewer_default_permission_set: null,
|
27
|
+
viewer_permissions: null,
|
28
|
+
eula: null,
|
29
|
+
sidebar: null,
|
30
|
+
similarity: null,
|
31
|
+
annotations: null
|
32
|
+
)
|
33
|
+
```
|
14
34
|
|
@@ -1,6 +1,26 @@
|
|
1
1
|
# TCAClient::SimpleSubmissionResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | the unique ID of the submission | [optional] |
|
8
|
+
| **owner** | **String** | the owner of the submission | [optional] |
|
9
|
+
| **title** | **String** | the title of the submission | [optional] |
|
10
|
+
| **status** | **String** | the current status of the Submission | [optional] |
|
11
|
+
| **created_time** | **Time** | RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'tca_client'
|
17
|
+
|
18
|
+
instance = TCAClient::SimpleSubmissionResponse.new(
|
19
|
+
id: null,
|
20
|
+
owner: null,
|
21
|
+
title: null,
|
22
|
+
status: null,
|
23
|
+
created_time: null
|
24
|
+
)
|
25
|
+
```
|
6
26
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# TCAClient::SimpleSubmissionResponseAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | the unique ID of the submission | [optional] |
|
8
|
+
| **owner** | **String** | the owner of the submission | [optional] |
|
9
|
+
| **title** | **String** | the title of the submission | [optional] |
|
10
|
+
| **status** | **String** | the current status of the Submission | [optional] |
|
11
|
+
| **created_time** | **Time** | RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'tca_client'
|
17
|
+
|
18
|
+
instance = TCAClient::SimpleSubmissionResponseAllOf.new(
|
19
|
+
id: null,
|
20
|
+
owner: null,
|
21
|
+
title: null,
|
22
|
+
status: null,
|
23
|
+
created_time: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Submission.md
CHANGED
@@ -1,6 +1,38 @@
|
|
1
1
|
# TCAClient::Submission
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **owner** | **String** | the owner of the submission | [optional] |
|
8
|
+
| **title** | **String** | the title of the submission | [optional] |
|
9
|
+
| **status** | **String** | the current status of the Submission | [optional] |
|
10
|
+
| **id** | **String** | the unique ID of the submission | [optional] |
|
11
|
+
| **content_type** | **String** | the content type of the submission | [optional] |
|
12
|
+
| **page_count** | **Integer** | the number of pages in the submission | [optional] |
|
13
|
+
| **word_count** | **Integer** | the number of words in the submission | [optional] |
|
14
|
+
| **character_count** | **Integer** | the number of characters in the submission | [optional] |
|
15
|
+
| **error_code** | **String** | an error code representing the type of error encountered (if applicable) | [optional] |
|
16
|
+
| **created_time** | **Time** | RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made. | [optional] |
|
17
|
+
| **capabilities** | **Array<String>** | Set of capabilities available to the current submission | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'tca_client'
|
23
|
+
|
24
|
+
instance = TCAClient::Submission.new(
|
25
|
+
owner: null,
|
26
|
+
title: null,
|
27
|
+
status: null,
|
28
|
+
id: null,
|
29
|
+
content_type: null,
|
30
|
+
page_count: null,
|
31
|
+
word_count: null,
|
32
|
+
character_count: null,
|
33
|
+
error_code: null,
|
34
|
+
created_time: null,
|
35
|
+
capabilities: null
|
36
|
+
)
|
37
|
+
```
|
6
38
|
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# TCAClient::SubmissionAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **owner** | **String** | the owner of the submission | [optional] |
|
8
|
+
| **title** | **String** | the title of the submission | [optional] |
|
9
|
+
| **status** | **String** | the current status of the Submission | [optional] |
|
10
|
+
| **id** | **String** | the unique ID of the submission | [optional] |
|
11
|
+
| **content_type** | **String** | the content type of the submission | [optional] |
|
12
|
+
| **page_count** | **Integer** | the number of pages in the submission | [optional] |
|
13
|
+
| **word_count** | **Integer** | the number of words in the submission | [optional] |
|
14
|
+
| **character_count** | **Integer** | the number of characters in the submission | [optional] |
|
15
|
+
| **error_code** | **String** | an error code representing the type of error encountered (if applicable) | [optional] |
|
16
|
+
| **created_time** | **Time** | RFC3339 timestamp of when this submission was initially created. This is the time at which the POST to /submissions was made. | [optional] |
|
17
|
+
| **capabilities** | **Array<String>** | Set of capabilities available to the current submission | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'tca_client'
|
23
|
+
|
24
|
+
instance = TCAClient::SubmissionAllOf.new(
|
25
|
+
owner: null,
|
26
|
+
title: null,
|
27
|
+
status: null,
|
28
|
+
id: null,
|
29
|
+
content_type: null,
|
30
|
+
page_count: null,
|
31
|
+
word_count: null,
|
32
|
+
character_count: null,
|
33
|
+
error_code: null,
|
34
|
+
created_time: null,
|
35
|
+
capabilities: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|