tca_client 1.0.0 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/docs/AddGroupAttachmentRequest.md +16 -4
- data/docs/AddGroupAttachmentResponse.md +14 -3
- data/docs/AggregateGroup.md +24 -8
- data/docs/AnnotationsSettings.md +18 -0
- data/docs/AuthorMetadataOverride.md +16 -4
- data/docs/EULAApi.md +166 -92
- data/docs/Error.md +16 -4
- data/docs/Eula.md +18 -5
- data/docs/EulaAcceptListItem.md +20 -6
- data/docs/EulaAcceptRequest.md +20 -6
- data/docs/EulaVersion.md +22 -7
- data/docs/FeaturesApi.md +41 -23
- data/docs/FeaturesEnabled.md +20 -6
- data/docs/FeaturesGenerationSettings.md +16 -4
- data/docs/FeaturesSimilarity.md +18 -5
- data/docs/FeaturesSimilarityViewSettings.md +38 -15
- data/docs/FeaturesTenant.md +14 -3
- data/docs/FeaturesViewerModes.md +16 -4
- data/docs/GenerateSimilarityPDF.md +18 -0
- data/docs/GetGroupAttachments200Response.md +18 -0
- data/docs/Group.md +18 -5
- data/docs/GroupAttachmentResponse.md +20 -6
- data/docs/GroupContext.md +18 -5
- data/docs/GroupsApi.md +321 -177
- data/docs/IndexApi.md +84 -44
- data/docs/IndexStateSettings.md +14 -3
- data/docs/IndexingSettings.md +14 -3
- data/docs/PDFStatusWebhookRequest.md +24 -0
- data/docs/PdfStatusResponse.md +14 -3
- data/docs/RateLimitError.md +16 -4
- data/docs/RequestPdfResponse.md +14 -3
- data/docs/Sidebar.md +14 -3
- data/docs/SimilarityApi.md +239 -129
- data/docs/SimilarityCompleteWebhookRequest.md +38 -0
- data/docs/SimilarityGenerationSettings.md +20 -6
- data/docs/SimilarityMetadata.md +32 -12
- data/docs/SimilarityMetadataAllOf.md +28 -0
- data/docs/SimilarityMetadataAllOfTopMatches.md +30 -0
- data/docs/SimilarityPutRequest.md +18 -5
- data/docs/SimilarityScoreData.md +20 -6
- data/docs/SimilaritySettings.md +18 -5
- data/docs/SimilaritySettingsModes.md +16 -4
- data/docs/SimilaritySettingsViewSettings.md +14 -3
- data/docs/SimilarityViewSettings.md +38 -15
- data/docs/SimilarityViewerUrlResponse.md +14 -3
- data/docs/SimilarityViewerUrlSettings.md +30 -10
- data/docs/SimpleSubmissionResponse.md +22 -2
- data/docs/SimpleSubmissionResponseAllOf.md +26 -0
- data/docs/Submission.md +34 -2
- data/docs/SubmissionAllOf.md +38 -0
- data/docs/SubmissionApi.md +203 -112
- data/docs/SubmissionBase.md +30 -11
- data/docs/SubmissionBaseMetadata.md +24 -8
- data/docs/SubmissionCompleteWebhookRequest.md +40 -0
- data/docs/SubmissionCompleteWebhookRequestAllOf.md +18 -0
- data/docs/SubmissionCompleteWebhookRequestAllOfMetadata.md +18 -0
- data/docs/SubmissionSizeError.md +16 -4
- data/docs/SuccessMessage.md +14 -3
- data/docs/Users.md +20 -6
- data/docs/ViewerPermissions.md +22 -7
- data/docs/Webhook.md +24 -6
- data/docs/WebhookAllOf.md +20 -0
- data/docs/WebhookApi.md +193 -103
- data/docs/WebhookBase.md +20 -6
- data/docs/WebhookPathRequest.md +16 -4
- data/docs/WebhookWithSecret.md +22 -6
- data/docs/WebhookWithSecretAllOf.md +18 -0
- data/lib/tca_client/api/eula_api.rb +96 -63
- data/lib/tca_client/api/features_api.rb +21 -12
- data/lib/tca_client/api/groups_api.rb +225 -155
- data/lib/tca_client/api/index_api.rb +46 -27
- data/lib/tca_client/api/similarity_api.rb +165 -104
- data/lib/tca_client/api/submission_api.rb +140 -97
- data/lib/tca_client/api/webhook_api.rb +120 -77
- data/lib/tca_client/api_client.rb +61 -57
- data/lib/tca_client/api_error.rb +4 -4
- data/lib/tca_client/configuration.rb +93 -13
- data/lib/tca_client/models/add_group_attachment_request.rb +50 -13
- data/lib/tca_client/models/add_group_attachment_response.rb +25 -12
- data/lib/tca_client/models/aggregate_group.rb +34 -21
- data/lib/tca_client/models/annotations_settings.rb +220 -0
- data/lib/tca_client/models/author_metadata_override.rb +26 -13
- data/lib/tca_client/models/error.rb +26 -13
- data/lib/tca_client/models/eula.rb +27 -14
- data/lib/tca_client/models/eula_accept_list_item.rb +28 -15
- data/lib/tca_client/models/eula_accept_request.rb +28 -15
- data/lib/tca_client/models/eula_version.rb +29 -16
- data/lib/tca_client/models/features_enabled.rb +28 -15
- data/lib/tca_client/models/features_generation_settings.rb +26 -13
- data/lib/tca_client/models/features_similarity.rb +27 -14
- data/lib/tca_client/models/features_similarity_view_settings.rb +37 -24
- data/lib/tca_client/models/features_tenant.rb +25 -12
- data/lib/tca_client/models/features_viewer_modes.rb +26 -13
- data/lib/tca_client/models/generate_similarity_pdf.rb +254 -0
- data/lib/tca_client/models/{inline_response_200.rb → get_group_attachments200_response.rb} +28 -15
- data/lib/tca_client/models/group.rb +29 -16
- data/lib/tca_client/models/group_attachment_response.rb +38 -17
- data/lib/tca_client/models/group_context.rb +27 -14
- data/lib/tca_client/models/index_state_settings.rb +25 -12
- data/lib/tca_client/models/indexing_settings.rb +25 -12
- data/lib/tca_client/models/pdf_status_response.rb +27 -14
- data/lib/tca_client/models/pdf_status_webhook_request.rb +283 -0
- data/lib/tca_client/models/rate_limit_error.rb +36 -20
- data/lib/tca_client/models/request_pdf_response.rb +25 -12
- data/lib/tca_client/models/sidebar.rb +27 -14
- data/lib/tca_client/models/similarity_complete_webhook_request.rb +366 -0
- data/lib/tca_client/models/similarity_generation_settings.rb +30 -17
- data/lib/tca_client/models/similarity_metadata.rb +45 -28
- data/lib/tca_client/models/similarity_metadata_all_of.rb +301 -0
- data/lib/tca_client/models/{similarity_metadata_top_matches.rb → similarity_metadata_all_of_top_matches.rb} +34 -21
- data/lib/tca_client/models/similarity_put_request.rb +27 -14
- data/lib/tca_client/models/similarity_score_data.rb +28 -15
- data/lib/tca_client/models/similarity_settings.rb +29 -16
- data/lib/tca_client/models/similarity_settings_modes.rb +26 -13
- data/lib/tca_client/models/similarity_settings_view_settings.rb +25 -12
- data/lib/tca_client/models/similarity_view_settings.rb +37 -24
- data/lib/tca_client/models/similarity_viewer_url_response.rb +25 -12
- data/lib/tca_client/models/similarity_viewer_url_settings.rb +46 -24
- data/lib/tca_client/models/simple_submission_response.rb +117 -13
- data/lib/tca_client/models/simple_submission_response_all_of.rb +294 -0
- data/lib/tca_client/models/submission.rb +191 -13
- data/lib/tca_client/models/submission_all_of.rb +368 -0
- data/lib/tca_client/models/submission_base.rb +82 -23
- data/lib/tca_client/models/submission_base_metadata.rb +30 -17
- data/lib/tca_client/models/submission_complete_webhook_request.rb +385 -0
- data/lib/tca_client/models/submission_complete_webhook_request_all_of.rb +219 -0
- data/lib/tca_client/models/submission_complete_webhook_request_all_of_metadata.rb +219 -0
- data/lib/tca_client/models/submission_size_error.rb +36 -20
- data/lib/tca_client/models/success_message.rb +25 -12
- data/lib/tca_client/models/users.rb +28 -15
- data/lib/tca_client/models/viewer_permissions.rb +29 -16
- data/lib/tca_client/models/webhook.rb +62 -16
- data/lib/tca_client/models/webhook_all_of.rb +235 -0
- data/lib/tca_client/models/webhook_base.rb +28 -15
- data/lib/tca_client/models/webhook_path_request.rb +26 -13
- data/lib/tca_client/models/webhook_with_secret.rb +52 -16
- data/lib/tca_client/models/webhook_with_secret_all_of.rb +225 -0
- data/lib/tca_client/version.rb +5 -4
- data/lib/tca_client.rb +18 -5
- data/spec/api/submission_api_spec.rb +2 -2
- data/tca_client-1.0.0.gem +0 -0
- data/tca_client-1.0.1.gem +0 -0
- data/tca_client.gemspec +7 -7
- metadata +44 -38
- data/docs/InlineResponse200.md +0 -7
- data/docs/SimilarityMetadataTopMatches.md +0 -13
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 45d8a3dec0bd30cb7794cca5a5291c45279a0612a77406b0dc6a823b964c3ca7
|
4
|
+
data.tar.gz: bb939c88ac52e0096f750a57104df4c28ea380d3cd615af6461cbb4677180f3c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '08db6bcf25067961b55448ca3515e63f39691833a1cec5052c78534b7ead9cb4aebf0bea9c1e2321b0641543d516d5bc89a41d35b17748081a40bfe6c84dba9e'
|
7
|
+
data.tar.gz: 502cf3ad4d3e75bbea7e008379ad0ccca2b596470b447d24289d63d00f8ab21ffb5fce84c9274f9e6f26fe899c6a1b9bc5b0db62d743b0989d9331a9209e5370
|
data/README.md
CHANGED
@@ -606,10 +606,10 @@ id = 'id_example' # String | The Submission ID (returned upon a successful POST
|
|
606
606
|
|
607
607
|
begin
|
608
608
|
#Get Submission Details
|
609
|
-
result = api_instance.
|
609
|
+
result = api_instance.get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
610
610
|
p result
|
611
611
|
rescue TCAClient::ApiError => e
|
612
|
-
puts "Exception when calling SubmissionApi->
|
612
|
+
puts "Exception when calling SubmissionApi->get_submission_details: #{e}"
|
613
613
|
end
|
614
614
|
# Setup authorization
|
615
615
|
TCAClient.configure do |config|
|
@@ -791,7 +791,7 @@ Class | Method | HTTP request | Description
|
|
791
791
|
*TCAClient::SimilarityApi* | [**request_similarity_report_pdf**](docs/SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id
|
792
792
|
*TCAClient::SubmissionApi* | [**create_submission**](docs/SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission
|
793
793
|
*TCAClient::SubmissionApi* | [**delete_submission**](docs/SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report.
|
794
|
-
*TCAClient::SubmissionApi* | [**
|
794
|
+
*TCAClient::SubmissionApi* | [**get_submission_details**](docs/SubmissionApi.md#get_submission_details) | **GET** /submissions/{id} | Get Submission Details
|
795
795
|
*TCAClient::SubmissionApi* | [**recover_submission**](docs/SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission
|
796
796
|
*TCAClient::SubmissionApi* | [**upload_submitted_file**](docs/SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File
|
797
797
|
*TCAClient::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete Webhook endpoint
|
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::AddGroupAttachmentRequest
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **title** | **String** | Attachment title | [optional] |
|
8
|
+
| **template** | **Boolean** | template | [optional][default to false] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::AddGroupAttachmentRequest.new(
|
16
|
+
title: My Template Attachment,
|
17
|
+
template: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
@@ -1,7 +1,18 @@
|
|
1
1
|
# TCAClient::AddGroupAttachmentResponse
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Attachment uuid | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::AddGroupAttachmentResponse.new(
|
15
|
+
id: 768f4633-d4c5-3ba0-8814-caaf421c8985
|
16
|
+
)
|
17
|
+
```
|
7
18
|
|
data/docs/AggregateGroup.md
CHANGED
@@ -1,12 +1,28 @@
|
|
1
1
|
# TCAClient::AggregateGroup
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | (required) | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **type** | **String** | | [optional] |
|
10
|
+
| **group_context** | [**GroupContext**](GroupContext.md) | | [optional] |
|
11
|
+
| **due_date** | **Date** | due date for the group | [optional] |
|
12
|
+
| **report_generation** | **String** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'tca_client'
|
18
|
+
|
19
|
+
instance = TCAClient::AggregateGroup.new(
|
20
|
+
id: null,
|
21
|
+
name: null,
|
22
|
+
type: null,
|
23
|
+
group_context: null,
|
24
|
+
due_date: null,
|
25
|
+
report_generation: null
|
26
|
+
)
|
27
|
+
```
|
12
28
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TCAClient::AnnotationsSettings
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **enabled** | **Boolean** | Used to enable annotations | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::AnnotationsSettings.new(
|
15
|
+
enabled: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::AuthorMetadataOverride
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **given_name** | **String** | Given or first name of submission author | [optional] |
|
8
|
+
| **family_name** | **String** | Family or last name of submission author | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::AuthorMetadataOverride.new(
|
16
|
+
given_name: null,
|
17
|
+
family_name: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
data/docs/EULAApi.md
CHANGED
@@ -1,55 +1,75 @@
|
|
1
1
|
# TCAClient::EULAApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://app-us.turnitin.com/api/v1*
|
4
4
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
|
7
|
-
[**eula_version_id_accept_post**](EULAApi.md#eula_version_id_accept_post) | **POST** /eula/{version_id}/accept | Accepts a particular EULA version on behalf of an external user
|
8
|
-
[**eula_version_id_accept_user_id_get**](EULAApi.md#eula_version_id_accept_user_id_get) | **GET** /eula/{version_id}/accept/{user_id} | Queries the acceptences of a particular EULA version on behalf of an external user
|
9
|
-
[**eula_version_id_get**](EULAApi.md#eula_version_id_get) | **GET** /eula/{version_id} | Gets information about a particular EULA version
|
10
|
-
[**eula_version_id_view_get**](EULAApi.md#eula_version_id_view_get) | **GET** /eula/{version_id}/view | Gets the text of a particular EULA version
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**eula_version_id_accept_post**](EULAApi.md#eula_version_id_accept_post) | **POST** /eula/{version_id}/accept | Accepts a particular EULA version on behalf of an external user |
|
8
|
+
| [**eula_version_id_accept_user_id_get**](EULAApi.md#eula_version_id_accept_user_id_get) | **GET** /eula/{version_id}/accept/{user_id} | Queries the acceptences of a particular EULA version on behalf of an external user |
|
9
|
+
| [**eula_version_id_get**](EULAApi.md#eula_version_id_get) | **GET** /eula/{version_id} | Gets information about a particular EULA version |
|
10
|
+
| [**eula_version_id_view_get**](EULAApi.md#eula_version_id_view_get) | **GET** /eula/{version_id}/view | Gets the text of a particular EULA version |
|
11
11
|
|
12
|
-
|
13
|
-
|
12
|
+
|
13
|
+
## eula_version_id_accept_post
|
14
|
+
|
15
|
+
> <EulaAcceptListItem> eula_version_id_accept_post(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data)
|
14
16
|
|
15
17
|
Accepts a particular EULA version on behalf of an external user
|
16
18
|
|
17
|
-
###
|
19
|
+
### Examples
|
20
|
+
|
18
21
|
```ruby
|
19
|
-
|
22
|
+
require 'time'
|
20
23
|
require 'tca_client'
|
21
24
|
# setup authorization
|
22
25
|
TCAClient.configure do |config|
|
23
26
|
# Configure API key authorization: api_key
|
24
|
-
config.api_key['
|
27
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
25
28
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
-
#config.api_key_prefix['
|
29
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
27
30
|
end
|
28
31
|
|
29
32
|
api_instance = TCAClient::EULAApi.new
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
33
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
34
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
35
|
+
version_id = 'latest' # String | The EULA version ID (or `latest`)
|
36
|
+
data = TCAClient::EulaAcceptRequest.new # EulaAcceptRequest |
|
35
37
|
|
36
38
|
begin
|
37
|
-
#Accepts a particular EULA version on behalf of an external user
|
38
|
-
result = api_instance.eula_version_id_accept_post(
|
39
|
+
# Accepts a particular EULA version on behalf of an external user
|
40
|
+
result = api_instance.eula_version_id_accept_post(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data)
|
39
41
|
p result
|
40
42
|
rescue TCAClient::ApiError => e
|
41
|
-
puts "
|
43
|
+
puts "Error when calling EULAApi->eula_version_id_accept_post: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the eula_version_id_accept_post_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<EulaAcceptListItem>, Integer, Hash)> eula_version_id_accept_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Accepts a particular EULA version on behalf of an external user
|
56
|
+
data, status_code, headers = api_instance.eula_version_id_accept_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <EulaAcceptListItem>
|
60
|
+
rescue TCAClient::ApiError => e
|
61
|
+
puts "Error when calling EULAApi->eula_version_id_accept_post_with_http_info: #{e}"
|
42
62
|
end
|
43
63
|
```
|
44
64
|
|
45
65
|
### Parameters
|
46
66
|
|
47
|
-
Name | Type | Description
|
48
|
-
|
49
|
-
**
|
50
|
-
**
|
51
|
-
**
|
52
|
-
**
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
70
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
71
|
+
| **version_id** | **String** | The EULA version ID (or `latest`) | |
|
72
|
+
| **data** | [**EulaAcceptRequest**](EulaAcceptRequest.md) | | |
|
53
73
|
|
54
74
|
### Return type
|
55
75
|
|
@@ -61,52 +81,70 @@ Name | Type | Description | Notes
|
|
61
81
|
|
62
82
|
### HTTP request headers
|
63
83
|
|
64
|
-
|
65
|
-
|
84
|
+
- **Content-Type**: application/json
|
85
|
+
- **Accept**: application/json
|
66
86
|
|
67
87
|
|
88
|
+
## eula_version_id_accept_user_id_get
|
68
89
|
|
69
|
-
|
70
|
-
> Array<EulaAcceptListItem> eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
|
90
|
+
> <Array<EulaAcceptListItem>> eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
|
71
91
|
|
72
92
|
Queries the acceptences of a particular EULA version on behalf of an external user
|
73
93
|
|
74
|
-
###
|
94
|
+
### Examples
|
95
|
+
|
75
96
|
```ruby
|
76
|
-
|
97
|
+
require 'time'
|
77
98
|
require 'tca_client'
|
78
99
|
# setup authorization
|
79
100
|
TCAClient.configure do |config|
|
80
101
|
# Configure API key authorization: api_key
|
81
|
-
config.api_key['
|
102
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
82
103
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
83
|
-
#config.api_key_prefix['
|
104
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
84
105
|
end
|
85
106
|
|
86
107
|
api_instance = TCAClient::EULAApi.new
|
87
|
-
x_turnitin_integration_name = '
|
88
|
-
x_turnitin_integration_version = '
|
89
|
-
version_id = '
|
108
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
109
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
110
|
+
version_id = 'latest' # String | The EULA version ID (or `latest`)
|
90
111
|
user_id = 'user_id_example' # String | The user associated with the EULA status
|
91
112
|
|
92
|
-
|
93
113
|
begin
|
94
|
-
#Queries the acceptences of a particular EULA version on behalf of an external user
|
114
|
+
# Queries the acceptences of a particular EULA version on behalf of an external user
|
95
115
|
result = api_instance.eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
|
96
116
|
p result
|
97
117
|
rescue TCAClient::ApiError => e
|
98
|
-
puts "
|
118
|
+
puts "Error when calling EULAApi->eula_version_id_accept_user_id_get: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
#### Using the eula_version_id_accept_user_id_get_with_http_info variant
|
123
|
+
|
124
|
+
This returns an Array which contains the response data, status code and headers.
|
125
|
+
|
126
|
+
> <Array(<Array<EulaAcceptListItem>>, Integer, Hash)> eula_version_id_accept_user_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
begin
|
130
|
+
# Queries the acceptences of a particular EULA version on behalf of an external user
|
131
|
+
data, status_code, headers = api_instance.eula_version_id_accept_user_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id)
|
132
|
+
p status_code # => 2xx
|
133
|
+
p headers # => { ... }
|
134
|
+
p data # => <Array<EulaAcceptListItem>>
|
135
|
+
rescue TCAClient::ApiError => e
|
136
|
+
puts "Error when calling EULAApi->eula_version_id_accept_user_id_get_with_http_info: #{e}"
|
99
137
|
end
|
100
138
|
```
|
101
139
|
|
102
140
|
### Parameters
|
103
141
|
|
104
|
-
Name | Type | Description
|
105
|
-
|
106
|
-
**x_turnitin_integration_name** | **String
|
107
|
-
**x_turnitin_integration_version** | **String
|
108
|
-
**version_id** | **String
|
109
|
-
**user_id** | **String
|
142
|
+
| Name | Type | Description | Notes |
|
143
|
+
| ---- | ---- | ----------- | ----- |
|
144
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
145
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
146
|
+
| **version_id** | **String** | The EULA version ID (or `latest`) | |
|
147
|
+
| **user_id** | **String** | The user associated with the EULA status | |
|
110
148
|
|
111
149
|
### Return type
|
112
150
|
|
@@ -118,53 +156,72 @@ Name | Type | Description | Notes
|
|
118
156
|
|
119
157
|
### HTTP request headers
|
120
158
|
|
121
|
-
|
122
|
-
|
159
|
+
- **Content-Type**: Not defined
|
160
|
+
- **Accept**: application/json
|
123
161
|
|
124
162
|
|
163
|
+
## eula_version_id_get
|
125
164
|
|
126
|
-
|
127
|
-
> EulaVersion eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
165
|
+
> <EulaVersion> eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
128
166
|
|
129
167
|
Gets information about a particular EULA version
|
130
168
|
|
131
|
-
###
|
169
|
+
### Examples
|
170
|
+
|
132
171
|
```ruby
|
133
|
-
|
172
|
+
require 'time'
|
134
173
|
require 'tca_client'
|
135
174
|
# setup authorization
|
136
175
|
TCAClient.configure do |config|
|
137
176
|
# Configure API key authorization: api_key
|
138
|
-
config.api_key['
|
177
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
139
178
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
140
|
-
#config.api_key_prefix['
|
179
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
141
180
|
end
|
142
181
|
|
143
182
|
api_instance = TCAClient::EULAApi.new
|
144
|
-
x_turnitin_integration_name = '
|
145
|
-
x_turnitin_integration_version = '
|
146
|
-
version_id = '
|
147
|
-
opts = {
|
148
|
-
lang: '
|
183
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
184
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
185
|
+
version_id = 'latest' # String | The EULA version ID (or `latest`)
|
186
|
+
opts = {
|
187
|
+
lang: 'en-US' # String | The desired language of the specified EULA version
|
149
188
|
}
|
150
189
|
|
151
190
|
begin
|
152
|
-
#Gets information about a particular EULA version
|
191
|
+
# Gets information about a particular EULA version
|
153
192
|
result = api_instance.eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
154
193
|
p result
|
155
194
|
rescue TCAClient::ApiError => e
|
156
|
-
puts "
|
195
|
+
puts "Error when calling EULAApi->eula_version_id_get: #{e}"
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
#### Using the eula_version_id_get_with_http_info variant
|
200
|
+
|
201
|
+
This returns an Array which contains the response data, status code and headers.
|
202
|
+
|
203
|
+
> <Array(<EulaVersion>, Integer, Hash)> eula_version_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
begin
|
207
|
+
# Gets information about a particular EULA version
|
208
|
+
data, status_code, headers = api_instance.eula_version_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
209
|
+
p status_code # => 2xx
|
210
|
+
p headers # => { ... }
|
211
|
+
p data # => <EulaVersion>
|
212
|
+
rescue TCAClient::ApiError => e
|
213
|
+
puts "Error when calling EULAApi->eula_version_id_get_with_http_info: #{e}"
|
157
214
|
end
|
158
215
|
```
|
159
216
|
|
160
217
|
### Parameters
|
161
218
|
|
162
|
-
Name | Type | Description
|
163
|
-
|
164
|
-
**x_turnitin_integration_name** | **String
|
165
|
-
**x_turnitin_integration_version** | **String
|
166
|
-
**version_id** | **String
|
167
|
-
**lang** | **String
|
219
|
+
| Name | Type | Description | Notes |
|
220
|
+
| ---- | ---- | ----------- | ----- |
|
221
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
222
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
223
|
+
| **version_id** | **String** | The EULA version ID (or `latest`) | |
|
224
|
+
| **lang** | **String** | The desired language of the specified EULA version | [optional] |
|
168
225
|
|
169
226
|
### Return type
|
170
227
|
|
@@ -176,53 +233,72 @@ Name | Type | Description | Notes
|
|
176
233
|
|
177
234
|
### HTTP request headers
|
178
235
|
|
179
|
-
|
180
|
-
|
236
|
+
- **Content-Type**: Not defined
|
237
|
+
- **Accept**: application/json
|
181
238
|
|
182
239
|
|
240
|
+
## eula_version_id_view_get
|
183
241
|
|
184
|
-
# **eula_version_id_view_get**
|
185
242
|
> String eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
186
243
|
|
187
244
|
Gets the text of a particular EULA version
|
188
245
|
|
189
|
-
###
|
246
|
+
### Examples
|
247
|
+
|
190
248
|
```ruby
|
191
|
-
|
249
|
+
require 'time'
|
192
250
|
require 'tca_client'
|
193
251
|
# setup authorization
|
194
252
|
TCAClient.configure do |config|
|
195
253
|
# Configure API key authorization: api_key
|
196
|
-
config.api_key['
|
254
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
197
255
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
198
|
-
#config.api_key_prefix['
|
256
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
199
257
|
end
|
200
258
|
|
201
259
|
api_instance = TCAClient::EULAApi.new
|
202
|
-
x_turnitin_integration_name = '
|
203
|
-
x_turnitin_integration_version = '
|
204
|
-
version_id = '
|
205
|
-
opts = {
|
206
|
-
lang: '
|
260
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
261
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
262
|
+
version_id = 'latest' # String | The EULA version ID (or `latest`)
|
263
|
+
opts = {
|
264
|
+
lang: 'en-US' # String | The desired language of the specified EULA version
|
207
265
|
}
|
208
266
|
|
209
267
|
begin
|
210
|
-
#Gets the text of a particular EULA version
|
268
|
+
# Gets the text of a particular EULA version
|
211
269
|
result = api_instance.eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
212
270
|
p result
|
213
271
|
rescue TCAClient::ApiError => e
|
214
|
-
puts "
|
272
|
+
puts "Error when calling EULAApi->eula_version_id_view_get: #{e}"
|
273
|
+
end
|
274
|
+
```
|
275
|
+
|
276
|
+
#### Using the eula_version_id_view_get_with_http_info variant
|
277
|
+
|
278
|
+
This returns an Array which contains the response data, status code and headers.
|
279
|
+
|
280
|
+
> <Array(String, Integer, Hash)> eula_version_id_view_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
281
|
+
|
282
|
+
```ruby
|
283
|
+
begin
|
284
|
+
# Gets the text of a particular EULA version
|
285
|
+
data, status_code, headers = api_instance.eula_version_id_view_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
|
286
|
+
p status_code # => 2xx
|
287
|
+
p headers # => { ... }
|
288
|
+
p data # => String
|
289
|
+
rescue TCAClient::ApiError => e
|
290
|
+
puts "Error when calling EULAApi->eula_version_id_view_get_with_http_info: #{e}"
|
215
291
|
end
|
216
292
|
```
|
217
293
|
|
218
294
|
### Parameters
|
219
295
|
|
220
|
-
Name | Type | Description
|
221
|
-
|
222
|
-
**x_turnitin_integration_name** | **String
|
223
|
-
**x_turnitin_integration_version** | **String
|
224
|
-
**version_id** | **String
|
225
|
-
**lang** | **String
|
296
|
+
| Name | Type | Description | Notes |
|
297
|
+
| ---- | ---- | ----------- | ----- |
|
298
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
299
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
300
|
+
| **version_id** | **String** | The EULA version ID (or `latest`) | |
|
301
|
+
| **lang** | **String** | The desired language of the specified EULA version | [optional] |
|
226
302
|
|
227
303
|
### Return type
|
228
304
|
|
@@ -234,8 +310,6 @@ Name | Type | Description | Notes
|
|
234
310
|
|
235
311
|
### HTTP request headers
|
236
312
|
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
313
|
+
- **Content-Type**: Not defined
|
314
|
+
- **Accept**: text/plain; charset=utf-8, application/html
|
241
315
|
|
data/docs/Error.md
CHANGED
@@ -1,8 +1,20 @@
|
|
1
1
|
# TCAClient::Error
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | an HTTP Response JobStatus Code | [optional] |
|
8
|
+
| **message** | **String** | A message explaining what happened | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'tca_client'
|
14
|
+
|
15
|
+
instance = TCAClient::Error.new(
|
16
|
+
status: null,
|
17
|
+
message: null
|
18
|
+
)
|
19
|
+
```
|
8
20
|
|
data/docs/Eula.md
CHANGED
@@ -1,9 +1,22 @@
|
|
1
1
|
# TCAClient::Eula
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **accepted_timestamp** | **Time** | The timestamp marking when the EULA was accepted | [optional] |
|
8
|
+
| **language** | **String** | The language code for which language instance of the EULA version was accepted | [optional] |
|
9
|
+
| **version** | **String** | The unique name of the EULA Version | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'tca_client'
|
15
|
+
|
16
|
+
instance = TCAClient::Eula.new(
|
17
|
+
accepted_timestamp: null,
|
18
|
+
language: en-US,
|
19
|
+
version: latest
|
20
|
+
)
|
21
|
+
```
|
9
22
|
|
data/docs/EulaAcceptListItem.md
CHANGED
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::EulaAcceptListItem
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user_id** | **String** | The unique id of the user in the external system | [optional] |
|
8
|
+
| **accepted_timestamp** | **Time** | The timestamp marking when the EULA was accepted | [optional] |
|
9
|
+
| **language** | **String** | The language code for which language instance of the EULA version was accepted | [optional] |
|
10
|
+
| **version** | **String** | The unique name of the EULA Version | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::EulaAcceptListItem.new(
|
18
|
+
user_id: null,
|
19
|
+
accepted_timestamp: null,
|
20
|
+
language: null,
|
21
|
+
version: null
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|