tca_client 1.0.0 → 1.0.1

data/docs/IndexApi.md

@@ -1,51 +1,71 @@
 # TCAClient::IndexApi
 
-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
-------------- | ------------- | -------------
-[**get_index_status**](IndexApi.md#get_index_status) | **GET** /submissions/{id}/index | Return index state of submission
-[**index_submission**](IndexApi.md#index_submission) | **PUT** /submissions/{id}/index | Index and return index state of submission
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_index_status**](IndexApi.md#get_index_status) | **GET** /submissions/{id}/index | Return index state of submission |
+| [**index_submission**](IndexApi.md#index_submission) | **PUT** /submissions/{id}/index | Index and return index state of submission |
 
-# **get_index_status**
-> IndexStateSettings get_index_status(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+## get_index_status
+
+> <IndexStateSettings> get_index_status(x_turnitin_integration_name, x_turnitin_integration_version, id)
 
 Return index state of submission
 
-### 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::IndexApi.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
-  #Return index state of submission
+  # Return index state of submission
   result = api_instance.get_index_status(x_turnitin_integration_name, x_turnitin_integration_version, id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling IndexApi->get_index_status: #{e}"
+  puts "Error when calling IndexApi->get_index_status: #{e}"
+end
+```
+
+#### Using the get_index_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IndexStateSettings>, Integer, Hash)> get_index_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+```ruby
+begin
+  # Return index state of submission
+  data, status_code, headers = api_instance.get_index_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IndexStateSettings>
+rescue TCAClient::ApiError => e
+  puts "Error when calling IndexApi->get_index_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)  | 
+| 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
 
@@ -57,50 +77,72 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## index_submission
 
-# **index_submission**
-> IndexStateSettings index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
+> <IndexStateSettings> index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
 
 Index and return index state of submission
 
-### 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::IndexApi.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) 
-
+opts = {
+  asynchronous: true # Boolean | asynchronous request
+}
 
 begin
-  #Index and return index state of submission
-  result = api_instance.index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  # Index and return index state of submission
+  result = api_instance.index_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling IndexApi->index_submission: #{e}"
+  puts "Error when calling IndexApi->index_submission: #{e}"
+end
+```
+
+#### Using the index_submission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IndexStateSettings>, Integer, Hash)> index_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+
+```ruby
+begin
+  # Index and return index state of submission
+  data, status_code, headers = api_instance.index_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IndexStateSettings>
+rescue TCAClient::ApiError => e
+  puts "Error when calling IndexApi->index_submission_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)  |  |
+| **asynchronous** | **Boolean** | asynchronous request | [optional] |
 
 ### Return type
 
@@ -112,8 +154,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/IndexStateSettings.md

@@ -1,7 +1,18 @@
 # TCAClient::IndexStateSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**is_indexed** | **BOOLEAN** | If true, is_indexed displays the index state of submission.  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_indexed** | **Boolean** | If true, is_indexed displays the index state of submission.  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::IndexStateSettings.new(
+  is_indexed: null
+)
+```
 

data/docs/IndexingSettings.md

@@ -1,7 +1,18 @@
 # TCAClient::IndexingSettings
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**add_to_index** | **BOOLEAN** | If set, the submission will be added to all valid node groups for future matching | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_to_index** | **Boolean** | If set, the submission will be added to all valid node groups for future matching | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::IndexingSettings.new(
+  add_to_index: null
+)
+```
 

data/docs/PDFStatusWebhookRequest.md

@@ -0,0 +1,24 @@
+# TCAClient::PDFStatusWebhookRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The requesting Pdf status | [optional] |
+| **id** | **String** | the PDF ID | [optional] |
+| **submission_id** | **String** | the associated submission ID | [optional] |
+| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::PDFStatusWebhookRequest.new(
+  status: null,
+  id: null,
+  submission_id: null,
+  metadata: null
+)
+```
+

data/docs/PdfStatusResponse.md

@@ -1,7 +1,18 @@
 # TCAClient::PdfStatusResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | The requesting Pdf status | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | The requesting Pdf status | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::PdfStatusResponse.new(
+  status: null
+)
+```
 

data/docs/RateLimitError.md

@@ -1,8 +1,20 @@
 # TCAClient::RateLimitError
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**status** | **String** | an HTTP Response JobStatus Code | [optional] 
-**message** | **String** | A message explaining what happened | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | an HTTP Response JobStatus Code | [optional] |
+| **message** | **String** | A message explaining what happened | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::RateLimitError.new(
+  status: null,
+  message: null
+)
+```
 

data/docs/RequestPdfResponse.md

@@ -1,7 +1,18 @@
 # TCAClient::RequestPdfResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Pdf ID | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Pdf ID | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::RequestPdfResponse.new(
+  id: null
+)
+```
 

data/docs/Sidebar.md

@@ -1,7 +1,18 @@
 # TCAClient::Sidebar
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**default_mode** | **String** | The default mode shown in the sidebar panel. The selected mode must be enabled in the tenant's license, request parameter, as well as the viewer's permission. The default mode is similarity.  | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default_mode** | **String** | The default mode shown in the sidebar panel. The selected mode must be enabled in the tenant's license, request parameter, as well as the viewer's permission. The default mode is similarity.  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::Sidebar.new(
+  default_mode: null
+)
+```