tca_client 1.0.0 → 1.0.2

data/docs/SubmissionApi.md

@@ -1,54 +1,74 @@
 # TCAClient::SubmissionApi
 
-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
-------------- | ------------- | -------------
-[**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission
-[**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report.
-[**get_submiddion_details**](SubmissionApi.md#get_submiddion_details) | **GET** /submissions/{id} | Get Submission Details
-[**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission
-[**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission |
+| [**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report. |
+| [**get_submission_details**](SubmissionApi.md#get_submission_details) | **GET** /submissions/{id} | Get Submission Details |
+| [**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission |
+| [**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File |
 
-# **create_submission**
-> SimpleSubmissionResponse create_submission(bodyx_turnitin_integration_namex_turnitin_integration_version)
+
+## create_submission
+
+> <SimpleSubmissionResponse> create_submission(x_turnitin_integration_name, x_turnitin_integration_version, data)
 
 Create a new 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::SubmissionApi.new
-body = TCAClient::SubmissionBase.new # SubmissionBase | 
-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
+data = TCAClient::SubmissionBase.new # SubmissionBase | 
 
 begin
-  #Create a new Submission
-  result = api_instance.create_submission(bodyx_turnitin_integration_namex_turnitin_integration_version)
+  # Create a new Submission
+  result = api_instance.create_submission(x_turnitin_integration_name, x_turnitin_integration_version, data)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SubmissionApi->create_submission: #{e}"
+  puts "Error when calling SubmissionApi->create_submission: #{e}"
+end
+```
+
+#### Using the create_submission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimpleSubmissionResponse>, Integer, Hash)> create_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
+
+```ruby
+begin
+  # Create a new Submission
+  data, status_code, headers = api_instance.create_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimpleSubmissionResponse>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SubmissionApi->create_submission_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**SubmissionBase**](SubmissionBase.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 | 
+| 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 |  |
+| **data** | [**SubmissionBase**](SubmissionBase.md) |  |  |
 
 ### Return type
 
@@ -60,53 +80,72 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## delete_submission
 
-# **delete_submission**
-> SuccessMessage delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+> <SuccessMessage> delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
 
 Deletes a submission and associated similarity report.
 
-### 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::SubmissionApi.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 = { 
-  hard: 'false' # String | Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered. 
+opts = {
+  hard: 'hard_example' # String | Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered. 
 }
 
 begin
-  #Deletes a submission and associated similarity report.
+  # Deletes a submission and associated similarity report.
   result = api_instance.delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SubmissionApi->delete_submission: #{e}"
+  puts "Error when calling SubmissionApi->delete_submission: #{e}"
+end
+```
+
+#### Using the delete_submission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessMessage>, Integer, Hash)> delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+
+```ruby
+begin
+  # Deletes a submission and associated similarity report.
+  data, status_code, headers = api_instance.delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessMessage>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SubmissionApi->delete_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)  | 
- **hard** | **String**| Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered.  | [optional] [default to false]
+| 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)  |  |
+| **hard** | **String** | Accepts true or false indicating either hard or soft delete. A soft delete removes the associated submission report/index and changes the saved submission state to DELETED. A hard deletion completely removes the submission information from Panda and TCA and removes the associated report/index, which can not be recovered.  | [optional][default to &#39;false&#39;] |
 
 ### Return type
 
@@ -118,50 +157,68 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_submission_details
 
-# **get_submiddion_details**
-> Submission get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
+> <Submission> get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
 
 Get Submission Details
 
-### 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::SubmissionApi.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 Submission Details
-  result = api_instance.get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  # Get Submission Details
+  result = api_instance.get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SubmissionApi->get_submiddion_details: #{e}"
+  puts "Error when calling SubmissionApi->get_submission_details: #{e}"
+end
+```
+
+#### Using the get_submission_details_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Submission>, Integer, Hash)> get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+```ruby
+begin
+  # Get Submission Details
+  data, status_code, headers = api_instance.get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Submission>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SubmissionApi->get_submission_details_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
 
@@ -173,50 +230,68 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## recover_submission
 
-# **recover_submission**
-> SimpleSubmissionResponse recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
+> <SimpleSubmissionResponse> recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
 
 Recover a soft deleted 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::SubmissionApi.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
-  #Recover a soft deleted submission
+  # Recover a soft deleted submission
   result = api_instance.recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SubmissionApi->recover_submission: #{e}"
+  puts "Error when calling SubmissionApi->recover_submission: #{e}"
+end
+```
+
+#### Using the recover_submission_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimpleSubmissionResponse>, Integer, Hash)> recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+
+```ruby
+begin
+  # Recover a soft deleted submission
+  data, status_code, headers = api_instance.recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimpleSubmissionResponse>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SubmissionApi->recover_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)  |  |
 
 ### Return type
 
@@ -228,56 +303,74 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## upload_submitted_file
 
-# **upload_submitted_file**
-> SuccessMessage upload_submitted_file(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_typecontent_dispositionid)
+> <SuccessMessage> upload_submitted_file(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
 
 Upload Submitted File
 
-### 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::SubmissionApi.new
-body = nil # Object | the user's submitted file
-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
-content_type = 'content_type_example' # String | *Must be 'binary/octet-stream' 
-content_disposition = 'content_disposition_example' # String | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`. To support UTF-8 filenames, you must URL encode the header 
+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) 
-
+content_type = 'content_type_example' # String | *Must be 'binary/octet-stream' 
+content_disposition = 'inline; filename="MyFile.docx"' # String | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`. To support UTF-8 filenames, you must URL encode the header 
+file = { ... } # Object | the user's submitted file
 
 begin
-  #Upload Submitted File
-  result = api_instance.upload_submitted_file(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_typecontent_dispositionid)
+  # Upload Submitted File
+  result = api_instance.upload_submitted_file(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
   p result
 rescue TCAClient::ApiError => e
-  puts "Exception when calling SubmissionApi->upload_submitted_file: #{e}"
+  puts "Error when calling SubmissionApi->upload_submitted_file: #{e}"
+end
+```
+
+#### Using the upload_submitted_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessMessage>, Integer, Hash)> upload_submitted_file_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
+
+```ruby
+begin
+  # Upload Submitted File
+  data, status_code, headers = api_instance.upload_submitted_file_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessMessage>
+rescue TCAClient::ApiError => e
+  puts "Error when calling SubmissionApi->upload_submitted_file_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**Object**](Object.md)| the user&#x27;s submitted file | 
- **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 | 
- **content_type** | **String**| *Must be &#x27;binary/octet-stream&#x27;  | 
- **content_disposition** | **String**| *must include the \&quot;filename\&quot; parameter, e.g. &#x60;inline; filename&#x3D;\&quot;MyFile.docx\&quot;&#x60;. To support UTF-8 filenames, you must URL encode the header  | 
- **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)  |  |
+| **content_type** | **String** | *Must be &#39;binary/octet-stream&#39;  |  |
+| **content_disposition** | **String** | *must include the \&quot;filename\&quot; parameter, e.g. &#x60;inline; filename&#x3D;\&quot;MyFile.docx\&quot;&#x60;. To support UTF-8 filenames, you must URL encode the header  |  |
+| **file** | **Object** | the user&#39;s submitted file |  |
 
 ### Return type
 
@@ -289,8 +382,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: binary/octet-stream
- - **Accept**: application/json
-
-
+- **Content-Type**: binary/octet-stream
+- **Accept**: application/json
 

data/docs/SubmissionBase.md

@@ -1,15 +1,34 @@
 # TCAClient::SubmissionBase
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | [****](.md) | Submission id, optional field | [optional] 
-**owner** | **String** | ID of the owning user | [optional] 
-**owner_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] 
-**title** | **String** | the title of the submission | [optional] 
-**submitter** | **String** | (optional) ID of the submitting user, if different from the owning user | [optional] 
-**submitter_default_permission_set** | **String** | Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] 
-**eula** | [**Eula**](Eula.md) |  | [optional] 
-**metadata** | [**SubmissionBaseMetadata**](SubmissionBaseMetadata.md) |  | [optional] 
-**extract_text_only** | **BOOLEAN** | (optional) indicates if the submission should be treated as a text only submission. A text only submission cannot generate full reports or be viewed in the viewer, but can use the index only endpoint to be indexed | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Object** | Submission id, optional field | [optional] |
+| **owner** | **String** | ID of the owning user | [optional] |
+| **owner_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] |
+| **title** | **String** | the title of the submission | [optional] |
+| **submitter** | **String** | (optional) ID of the submitting user, if different from the owning user | [optional] |
+| **submitter_default_permission_set** | **String** | Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] |
+| **eula** | [**Eula**](Eula.md) |  | [optional] |
+| **metadata** | [**SubmissionBaseMetadata**](SubmissionBaseMetadata.md) |  | [optional] |
+| **extract_text_only** | **Boolean** | (optional) indicates if the submission should be treated as a text only submission. A text only submission cannot generate full reports or be viewed in the viewer, but can use the index only endpoint to be indexed | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SubmissionBase.new(
+  id: null,
+  owner: null,
+  owner_default_permission_set: null,
+  title: null,
+  submitter: null,
+  submitter_default_permission_set: null,
+  eula: null,
+  metadata: null,
+  extract_text_only: null
+)
+```
 

data/docs/SubmissionBaseMetadata.md

@@ -1,12 +1,28 @@
 # TCAClient::SubmissionBaseMetadata
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**submitter** | [**Users**](Users.md) |  | [optional] 
-**owners** | [**Array<Users>**](Users.md) |  | [optional] 
-**group** | [**Group**](Group.md) |  | [optional] 
-**group_context** | [**GroupContext**](GroupContext.md) |  | [optional] 
-**original_submitted_time** | **DateTime** | Optional original submision date | [optional] 
-**custom** | **String** | custom metadata | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submitter** | [**Users**](Users.md) |  | [optional] |
+| **owners** | [**Array<Users>**](Users.md) |  | [optional] |
+| **group** | [**Group**](Group.md) |  | [optional] |
+| **group_context** | [**GroupContext**](GroupContext.md) |  | [optional] |
+| **original_submitted_time** | **Time** | Optional original submision date | [optional] |
+| **custom** | **String** | custom metadata | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SubmissionBaseMetadata.new(
+  submitter: null,
+  owners: null,
+  group: null,
+  group_context: null,
+  original_submitted_time: null,
+  custom: {"Hello": "data"}
+)
+```
 

data/docs/SubmissionCompleteWebhookRequest.md

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

data/docs/SubmissionCompleteWebhookRequestAllOf.md

@@ -0,0 +1,18 @@
+# TCAClient::SubmissionCompleteWebhookRequestAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SubmissionCompleteWebhookRequestAllOf.new(
+  metadata: null
+)
+```
+

data/docs/SubmissionCompleteWebhookRequestAllOfMetadata.md

@@ -0,0 +1,18 @@
+# TCAClient::SubmissionCompleteWebhookRequestAllOfMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **custom** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'tca_client'
+
+instance = TCAClient::SubmissionCompleteWebhookRequestAllOfMetadata.new(
+  custom: null
+)
+```
+