tca_client 1.0.0 → 1.0.2

data/docs/SimilarityMetadata.md

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

data/docs/SimilarityMetadataAllOf.md

@@ -0,0 +1,28 @@
+# TCAClient::SimilarityMetadataAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submission_id** | **String** |  |  |
+| **status** | **String** | possible values PENDING, COMPLETE |  |
+| **time_generated** | **String** | Time the report finished generating.  If not set the report has not finished generating |  |
+| **time_requested** | **String** | Time the report was requested |  |
+| **top_matches** | [**Array<SimilarityMetadataAllOfTopMatches>**](SimilarityMetadataAllOfTopMatches.md) | Top matches |  |
+| **top_source_largest_matched_word_count** | **Integer** | Largest individual matched word count, 0 if there isn't a match to this submission. |  |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityMetadataAllOf.new(
+  submission_id: null,
+  status: null,
+  time_generated: null,
+  time_requested: null,
+  top_matches: null,
+  top_source_largest_matched_word_count: null
+)
+```
+

data/docs/SimilarityMetadataAllOfTopMatches.md

@@ -0,0 +1,30 @@
+# TCAClient::SimilarityMetadataAllOfTopMatches
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Source name | [optional] |
+| **percentage** | **Float** | Match percentage | [optional] |
+| **submission_id** | **String** | Matching submission id | [optional] |
+| **source_type** | **String** | Matching submission source type (INTERNET, PUBLICATION, SUBMITTED_WORK) | [optional] |
+| **matched_word_count_total** | **Float** | number of matching words | [optional] |
+| **submitted_date** | **String** | date match was submitted | [optional] |
+| **institution_name** | **String** | intitution name for matched SUBMITTED_WORK types | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityMetadataAllOfTopMatches.new(
+  name: null,
+  percentage: null,
+  submission_id: null,
+  source_type: null,
+  matched_word_count_total: null,
+  submitted_date: null,
+  institution_name: null
+)
+```
+

data/docs/SimilarityPutRequest.md

@@ -1,9 +1,22 @@
 # TCAClient::SimilarityPutRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**indexing_settings** | [**IndexingSettings**](IndexingSettings.md) |  | [optional] 
-**generation_settings** | [**SimilarityGenerationSettings**](SimilarityGenerationSettings.md) |  | 
-**view_settings** | [**SimilarityViewSettings**](SimilarityViewSettings.md) |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **indexing_settings** | [**IndexingSettings**](IndexingSettings.md) |  | [optional] |
+| **generation_settings** | [**SimilarityGenerationSettings**](SimilarityGenerationSettings.md) |  |  |
+| **view_settings** | [**SimilarityViewSettings**](SimilarityViewSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityPutRequest.new(
+  indexing_settings: null,
+  generation_settings: null,
+  view_settings: null
+)
+```
 

data/docs/SimilarityScoreData.md

@@ -1,10 +1,24 @@
 # TCAClient::SimilarityScoreData
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**overall_match_percentage** | **Integer** | Represents the percentage match against all sources | 
-**internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] 
-**publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] 
-**submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **overall_match_percentage** | **Integer** | Represents the percentage match against all sources |  |
+| **internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] |
+| **publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] |
+| **submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityScoreData.new(
+  overall_match_percentage: null,
+  internet_match_percentage: null,
+  publication_match_percentage: null,
+  submitted_works_match_percentage: null
+)
+```
 

data/docs/SimilaritySettings.md

@@ -1,9 +1,22 @@
 # TCAClient::SimilaritySettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**default_mode** | **String** | default similarity mode when viewing a report; set to either match_overview or all_sources | [optional] 
-**modes** | [**SimilaritySettingsModes**](SimilaritySettingsModes.md) |  | [optional] 
-**view_settings** | [**SimilaritySettingsViewSettings**](SimilaritySettingsViewSettings.md) |  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default_mode** | **String** | default similarity mode when viewing a report; set to either match_overview or all_sources | [optional] |
+| **modes** | [**SimilaritySettingsModes**](SimilaritySettingsModes.md) |  | [optional] |
+| **view_settings** | [**SimilaritySettingsViewSettings**](SimilaritySettingsViewSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilaritySettings.new(
+  default_mode: null,
+  modes: null,
+  view_settings: null
+)
+```
 

data/docs/SimilaritySettingsModes.md

@@ -1,8 +1,20 @@
 # TCAClient::SimilaritySettingsModes
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**match_overview** | **BOOLEAN** | Used to enable use of the match overview mode in the viewer | [optional] 
-**all_sources** | **BOOLEAN** | Used to enable use of the all sources mode in the viewer | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **match_overview** | **Boolean** | Used to enable use of the match overview mode in the viewer | [optional] |
+| **all_sources** | **Boolean** | Used to enable use of the all sources mode in the viewer | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilaritySettingsModes.new(
+  match_overview: null,
+  all_sources: null
+)
+```
 

data/docs/SimilaritySettingsViewSettings.md

@@ -1,7 +1,18 @@
 # TCAClient::SimilaritySettingsViewSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**save_changes** | **BOOLEAN** | Used to enable save changes in the Viewer and trigger SIMILARITY_UPDATED webhook callback | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_changes** | **Boolean** | Used to enable save changes in the Viewer and trigger SIMILARITY_UPDATED webhook callback | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilaritySettingsViewSettings.new(
+  save_changes: null
+)
+```
 

data/docs/SimilarityViewSettings.md

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

@@ -1,7 +1,18 @@
 # TCAClient::SimilarityViewerUrlResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**viewer_url** | **String** | URL to be used to access Cloud Viewer visualization of similarity report matches | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **viewer_url** | **String** | URL to be used to access Cloud Viewer visualization of similarity report matches | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityViewerUrlResponse.new(
+  viewer_url: null
+)
+```
 

data/docs/SimilarityViewerUrlSettings.md

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

data/docs/SimpleSubmissionResponse.md

@@ -1,6 +1,26 @@
 # TCAClient::SimpleSubmissionResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | the unique ID of the submission | [optional] |
+| **owner** | **String** | the owner of the submission | [optional] |
+| **title** | **String** | the title of the submission | [optional] |
+| **status** | **String** | the current status of the Submission | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimpleSubmissionResponse.new(
+  id: null,
+  owner: null,
+  title: null,
+  status: null,
+  created_time: null
+)
+```
 

data/docs/SimpleSubmissionResponseAllOf.md

@@ -0,0 +1,26 @@
+# TCAClient::SimpleSubmissionResponseAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | the unique ID of the submission | [optional] |
+| **owner** | **String** | the owner of the submission | [optional] |
+| **title** | **String** | the title of the submission | [optional] |
+| **status** | **String** | the current status of the Submission | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimpleSubmissionResponseAllOf.new(
+  id: null,
+  owner: null,
+  title: null,
+  status: null,
+  created_time: null
+)
+```
+

data/docs/Submission.md

@@ -1,6 +1,38 @@
 # TCAClient::Submission
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **owner** | **String** | the owner of the submission | [optional] |
+| **title** | **String** | the title of the submission | [optional] |
+| **status** | **String** | the current status of the Submission | [optional] |
+| **id** | **String** | the unique ID of the submission | [optional] |
+| **content_type** | **String** | the content type of the submission | [optional] |
+| **page_count** | **Integer** | the number of pages in the submission | [optional] |
+| **word_count** | **Integer** | the number of words in the submission | [optional] |
+| **character_count** | **Integer** | the number of characters in the submission | [optional] |
+| **error_code** | **String** | an error code representing the type of error encountered (if applicable)  | [optional] |
+| **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] |
+| **capabilities** | **Array<String>** | Set of capabilities available to the current submission | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::Submission.new(
+  owner: null,
+  title: null,
+  status: null,
+  id: null,
+  content_type: null,
+  page_count: null,
+  word_count: null,
+  character_count: null,
+  error_code: null,
+  created_time: null,
+  capabilities: null
+)
+```
 

data/docs/SubmissionAllOf.md

@@ -0,0 +1,38 @@
+# TCAClient::SubmissionAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **owner** | **String** | the owner of the submission | [optional] |
+| **title** | **String** | the title of the submission | [optional] |
+| **status** | **String** | the current status of the Submission | [optional] |
+| **id** | **String** | the unique ID of the submission | [optional] |
+| **content_type** | **String** | the content type of the submission | [optional] |
+| **page_count** | **Integer** | the number of pages in the submission | [optional] |
+| **word_count** | **Integer** | the number of words in the submission | [optional] |
+| **character_count** | **Integer** | the number of characters in the submission | [optional] |
+| **error_code** | **String** | an error code representing the type of error encountered (if applicable)  | [optional] |
+| **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] |
+| **capabilities** | **Array<String>** | Set of capabilities available to the current submission | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SubmissionAllOf.new(
+  owner: null,
+  title: null,
+  status: null,
+  id: null,
+  content_type: null,
+  page_count: null,
+  word_count: null,
+  character_count: null,
+  error_code: null,
+  created_time: null,
+  capabilities: null
+)
+```
+