Updating to reflect the latest changes in the TCA API

Author: tiipghci

README.md

@@ -31,8 +31,8 @@ Integration Scopes (you can create a new one, or add keys to existing)
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 1.0.226
-- Package version: 1.0.226
+- API version: 1.0.228
+- Package version: 1.0.228
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation

docs/SimilaritySettings.md

@@ -4,7 +4,19 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**defaultMode** | **String** | default similarity mode when viewing a report; set to either match_overview or all_sources | [optional] 
 **modes** | [**SimilaritySettingsModes**](SimilaritySettingsModes.md) |  | [optional] 
 **viewSettings** | [**SimilaritySettingsViewSettings**](SimilaritySettingsViewSettings.md) |  | [optional] 
 
 
+
+## Enum: DefaultModeEnum
+
+
+* `match_overview` (value: `"match_overview"`)
+
+* `all_sources` (value: `"all_sources"`)
+
+
+
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "turnitin_core_api",
-  "version": "1.0.226",
+  "version": "1.0.228",
   "description": "Turnitin_Core_API__TCA_provides_direct_API_access_to_the_core_functionality_provided_by_Turnitin__TCA_supports_file_submission_similarity_report_generation_group_management_and_visualization_of_report_matches_via_Cloud_Viewer_or_PDF_download_Below_is_the_full_flow_to_successfully_set_up_an_integration_scope_an_API_Key_and_make_calls_to_TCA__Integration_Scope_and_API_Key_management_is_done_via_the_Admin_Console_UI_by_logging_in_as_an_admin_user__For_more_details_go_to_our__developer_portal_documentation_page_https__developers_turnitin_com_docs__Integration_Scope_and_API_Key_ManagementTCA_API_calls_must_provide_an_API_Key_for_authentication_so_you_must_first_have_at_least_one_integration_scope_associated_with_at_least_one_API_Key_to_use_TCA__Admin_Console_UIFirst_login_to_Admin_Console_UI_as_an_Admin_user_with_permission_to_create_Integration_Scopes_under_a_tenant_that_is_licensed_to_use_the_TCA_productIntegration_Scopes__you_can_create_a_new_one_or_add_keys_to_existing___Click_Integrations_in_the_side_bar_____Add_Integration_at_top_the_top_of_the_page____Enter_a_name____Add_Button__API_Keys___Click_Integrations_in_the_side_bar____Create_API_Key_Button_next_to_a_given_Integration_Scope_____Enter_a_name____click_Create_and_View_button___Copy_Save_the_key_manually_or_click_save_to_clipboard_button_to_copy_it__this_is_the_only_time_it_will_show_TCA_Flow____Register_a_webhook____Create_a_submission____Upload_a_file_for_the_submission____Wait_for_the_submission_upload_to_process______If_you_registered_a_webhook_a_callback_will_be_sent_to_it_when_upload_is_complete______The_status_of_the_submission_will_also_update_to_COMPLETE____Request_a_Similarity_Report____Wait_for_similarity_report_to_process______If_you_registered_a_webhook_a_callback_will_be_sent_to_it_when_report_is_complete______The_status_of_the_report_will_also_be_updated_to_COMPLETE____Request_a_URL_with_parameters_to_view_the_Similarity_Report",
   "license": "Unlicense",
   "main": "dist/index.js",

src/ApiClient.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,7 +17,7 @@ import querystring from "querystring";
 
 /**
 * @module ApiClient
-* @version 1.0.226
+* @version 1.0.228
 */
 
 /**
@@ -55,7 +55,7 @@ class ApiClient {
          * @default {}
          */
         this.defaultHeaders = {
-            'User-Agent': 'OpenAPI-Generator/1.0.226/Javascript'
+            'User-Agent': 'OpenAPI-Generator/1.0.228/Javascript'
         };
 
         /**

src/api/EULAApi.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ import RateLimitError from '../model/RateLimitError';
 /**
 * EULA service.
 * @module api/EULAApi
-* @version 1.0.226
+* @version 1.0.228
 */
 export default class EULAApi {
 

src/api/FeaturesApi.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,7 @@ import RateLimitError from '../model/RateLimitError';
 /**
 * Features service.
 * @module api/FeaturesApi
-* @version 1.0.226
+* @version 1.0.228
 */
 export default class FeaturesApi {
 

src/api/GroupsApi.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,7 @@ import SuccessMessage from '../model/SuccessMessage';
 /**
 * Groups service.
 * @module api/GroupsApi
-* @version 1.0.226
+* @version 1.0.228
 */
 export default class GroupsApi {
 

src/api/IndexApi.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,7 @@ import RateLimitError from '../model/RateLimitError';
 /**
 * Index service.
 * @module api/IndexApi
-* @version 1.0.226
+* @version 1.0.228
 */
 export default class IndexApi {
 

src/api/SimilarityApi.js

@@ -2,7 +2,7 @@
  * Turnitin Core API
  * Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing)    * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button   API Keys   * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope -->   Enter a name --> click `Create and View button`   * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show)  ## TCA Flow    *  Register a webhook   *  Create a submission   *  Upload a file for the submission   *  Wait for the submission upload to process      * If you registered a webhook, a callback will be sent to it when upload is complete      * The status of the *submission* will also update to `COMPLETE`   *  Request a Similarity Report   *  Wait for similarity report to process      * If you registered a webhook, a callback will be sent to it when report is complete      * The status of the *report* will also be updated to `COMPLETE`   *  Request a URL with parameters to view the Similarity Report 
  *
- * The version of the OpenAPI document: 1.0.226
+ * The version of the OpenAPI document: 1.0.228
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,7 @@ import SuccessMessage from '../model/SuccessMessage';
 /**
 * Similarity service.
 * @module api/SimilarityApi
-* @version 1.0.226
+* @version 1.0.228
 */
 export default class SimilarityApi {