tca_client 1.0.0 → 1.0.2

data/docs/SimilarityApi.md

@@ -1,61 +1,81 @@
 # TCAClient::SimilarityApi
 
-All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
+All URIs are relative to *https://app-us.turnitin.com/api/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**download_similarity_report_pdf**](SimilarityApi.md#download_similarity_report_pdf) | **GET** /submissions/{id}/similarity/pdf/{pdf_id} | GET download pdf
-[**get_similarity_report_pdf_status**](SimilarityApi.md#get_similarity_report_pdf_status) | **GET** /submissions/{id}/similarity/pdf/{pdf_id}/status | GET pdf download status
-[**get_similarity_report_results**](SimilarityApi.md#get_similarity_report_results) | **GET** /submissions/{id}/similarity | Get Similarity Report Results
-[**get_similarity_report_url**](SimilarityApi.md#get_similarity_report_url) | **POST** /submissions/{id}/viewer-url | Returns a URL to access Cloud Viewer
-[**request_similarity_report**](SimilarityApi.md#request_similarity_report) | **PUT** /submissions/{id}/similarity | Request Similarity Report generation
-[**request_similarity_report_pdf**](SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**download_similarity_report_pdf**](SimilarityApi.md#download_similarity_report_pdf) | **GET** /submissions/{id}/similarity/pdf/{pdf_id} | GET download pdf |
+| [**get_similarity_report_pdf_status**](SimilarityApi.md#get_similarity_report_pdf_status) | **GET** /submissions/{id}/similarity/pdf/{pdf_id}/status | GET pdf download status |
+| [**get_similarity_report_results**](SimilarityApi.md#get_similarity_report_results) | **GET** /submissions/{id}/similarity | Get Similarity Report Results |
+| [**get_similarity_report_url**](SimilarityApi.md#get_similarity_report_url) | **POST** /submissions/{id}/viewer-url | Returns a URL to access Cloud Viewer |
+| [**request_similarity_report**](SimilarityApi.md#request_similarity_report) | **PUT** /submissions/{id}/similarity | Request Similarity Report generation |
+| [**request_similarity_report_pdf**](SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id |
 
-# **download_similarity_report_pdf**
-> String download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+
+## download_similarity_report_pdf
+
+> File download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
 
 GET download pdf
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
 pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) 
 
-
 begin
-  #GET download pdf
+  # GET download pdf
   result = api_instance.download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->download_similarity_report_pdf: #{e}"
+  puts "Error when calling SimilarityApi->download_similarity_report_pdf: #{e}"
+end
+```
+
+#### Using the download_similarity_report_pdf_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+
+```ruby
+begin
+  # GET download pdf
+  data, status_code, headers = api_instance.download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->download_similarity_report_pdf_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
- **pdf_id** | **String**| The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
+| **pdf_id** | **String** | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  |  |
 
 ### Return type
 
-**String**
+**File**
 
 ### Authorization
 
@@ -63,52 +83,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/pdf, application/json
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
 
 
+## get_similarity_report_pdf_status
 
-# **get_similarity_report_pdf_status**
-> PdfStatusResponse get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+> <PdfStatusResponse> get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
 
 GET pdf download status
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
 pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) 
 
-
 begin
-  #GET pdf download status
+  # GET pdf download status
   result = api_instance.get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->get_similarity_report_pdf_status: #{e}"
+  puts "Error when calling SimilarityApi->get_similarity_report_pdf_status: #{e}"
+end
+```
+
+#### Using the get_similarity_report_pdf_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PdfStatusResponse>, Integer, Hash)> get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+
+```ruby
+begin
+  # GET pdf download status
+  data, status_code, headers = api_instance.get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PdfStatusResponse>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->get_similarity_report_pdf_status_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
- **pdf_id** | **String**| The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
+| **pdf_id** | **String** | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)  |  |
 
 ### Return type
 
@@ -120,50 +158,68 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_similarity_report_results
 
-# **get_similarity_report_results**
-> SimilarityMetadata get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
+> <SimilarityMetadata> get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
 
 Get Similarity Report Results
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
 
-
 begin
-  #Get Similarity Report Results
+  # Get Similarity Report Results
   result = api_instance.get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->get_similarity_report_results: #{e}"
+  puts "Error when calling SimilarityApi->get_similarity_report_results: #{e}"
+end
+```
+
+#### Using the get_similarity_report_results_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimilarityMetadata>, Integer, Hash)> get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+```ruby
+begin
+  # Get Similarity Report Results
+  data, status_code, headers = api_instance.get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimilarityMetadata>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->get_similarity_report_results_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
 
 ### Return type
 
@@ -175,52 +231,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_similarity_report_url
 
-# **get_similarity_report_url**
-> SimilarityViewerUrlResponse get_similarity_report_url(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+> <SimilarityViewerUrlResponse> get_similarity_report_url(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
 
 Returns a URL to access Cloud Viewer
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-body = TCAClient::SimilarityViewerUrlSettings.new # SimilarityViewerUrlSettings | 
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
-
+data = TCAClient::SimilarityViewerUrlSettings.new # SimilarityViewerUrlSettings | 
 
 begin
-  #Returns a URL to access Cloud Viewer
-  result = api_instance.get_similarity_report_url(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+  # Returns a URL to access Cloud Viewer
+  result = api_instance.get_similarity_report_url(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->get_similarity_report_url: #{e}"
+  puts "Error when calling SimilarityApi->get_similarity_report_url: #{e}"
+end
+```
+
+#### Using the get_similarity_report_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimilarityViewerUrlResponse>, Integer, Hash)> get_similarity_report_url_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
+
+```ruby
+begin
+  # Returns a URL to access Cloud Viewer
+  data, status_code, headers = api_instance.get_similarity_report_url_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimilarityViewerUrlResponse>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->get_similarity_report_url_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**SimilarityViewerUrlSettings**](SimilarityViewerUrlSettings.md)|  | 
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
+| **data** | [**SimilarityViewerUrlSettings**](SimilarityViewerUrlSettings.md) |  |  |
 
 ### Return type
 
@@ -232,52 +306,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## request_similarity_report
 
-# **request_similarity_report**
-> SuccessMessage request_similarity_report(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+> <SuccessMessage> request_similarity_report(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
 
 Request Similarity Report generation
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-body = TCAClient::SimilarityPutRequest.new # SimilarityPutRequest | 
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
-
+data = TCAClient::SimilarityPutRequest.new({generation_settings: TCAClient::SimilarityGenerationSettings.new({search_repositories: ['INTERNET']})}) # SimilarityPutRequest | 
 
 begin
-  #Request Similarity Report generation
-  result = api_instance.request_similarity_report(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
+  # Request Similarity Report generation
+  result = api_instance.request_similarity_report(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->request_similarity_report: #{e}"
+  puts "Error when calling SimilarityApi->request_similarity_report: #{e}"
+end
+```
+
+#### Using the request_similarity_report_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessMessage>, Integer, Hash)> request_similarity_report_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
+
+```ruby
+begin
+  # Request Similarity Report generation
+  data, status_code, headers = api_instance.request_similarity_report_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessMessage>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->request_similarity_report_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**SimilarityPutRequest**](SimilarityPutRequest.md)|  | 
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
+| **data** | [**SimilarityPutRequest**](SimilarityPutRequest.md) |  |  |
 
 ### Return type
 
@@ -289,50 +381,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## request_similarity_report_pdf
 
-# **request_similarity_report_pdf**
-> RequestPdfResponse request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
+> <RequestPdfResponse> request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
 
 Request Pdf download and returns the Pdf Id
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'tca_client'
 # setup authorization
 TCAClient.configure do |config|
   # Configure API key authorization: api_key
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  config.api_key['api_key'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['api_key'] = 'Bearer'
 end
 
 api_instance = TCAClient::SimilarityApi.new
-x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
-x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
+x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
+x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
 id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions) 
-
+generate_similarity_pdf = TCAClient::GenerateSimilarityPDF.new # GenerateSimilarityPDF | 
 
 begin
-  #Request Pdf download and returns the Pdf Id
-  result = api_instance.request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  # Request Pdf download and returns the Pdf Id
+  result = api_instance.request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SimilarityApi->request_similarity_report_pdf: #{e}"
+  puts "Error when calling SimilarityApi->request_similarity_report_pdf: #{e}"
+end
+```
+
+#### Using the request_similarity_report_pdf_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RequestPdfResponse>, Integer, Hash)> request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
+
+```ruby
+begin
+  # Request Pdf download and returns the Pdf Id
+  data, status_code, headers = api_instance.request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RequestPdfResponse>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SimilarityApi->request_similarity_report_pdf_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used | 
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used | 
- **id** | **String**| The Submission ID (returned upon a successful POST to /submissions)  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used |  |
+| **x_turnitin_integration_version** | **String** | the version of the integration platform being used |  |
+| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions)  |  |
+| **generate_similarity_pdf** | [**GenerateSimilarityPDF**](GenerateSimilarityPDF.md) |  |  |
 
 ### Return type
 
@@ -344,8 +456,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/SimilarityCompleteWebhookRequest.md

@@ -0,0 +1,38 @@
+# TCAClient::SimilarityCompleteWebhookRequest
+
+## 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<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. |  |
+| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityCompleteWebhookRequest.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,
+  metadata: null
+)
+```
+

data/docs/SimilarityGenerationSettings.md

@@ -1,10 +1,24 @@
 # TCAClient::SimilarityGenerationSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**search_repositories** | **Array<String>** | List of repositories to search | 
-**submission_auto_excludes** | **Array<String>** | List of submission IDs to exclude from report | [optional] 
-**auto_exclude_self_matching_scope** | **String** | self matching submissions to exclude from report | [optional] 
-**priority** | **BOOLEAN** | Priority level of report generation | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_repositories** | **Array<String>** | List of repositories to search |  |
+| **submission_auto_excludes** | **Array<String>** | List of submission IDs to exclude from report | [optional] |
+| **auto_exclude_self_matching_scope** | **String** | self matching submissions to exclude from report | [optional] |
+| **priority** | **Boolean** | Priority level of report generation | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SimilarityGenerationSettings.new(
+  search_repositories: null,
+  submission_auto_excludes: null,
+  auto_exclude_self_matching_scope: null,
+  priority: false
+)
+```