tca_client 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- 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 +202 -111
- 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 +132 -89
- 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 +30 -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/tca_client-1.0.0.gem +0 -0
- data/tca_client.gemspec +7 -7
- metadata +34 -29
- data/docs/InlineResponse200.md +0 -7
- data/docs/SimilarityMetadataTopMatches.md +0 -13
data/docs/SimilarityApi.md
CHANGED
@@ -1,61 +1,81 @@
|
|
1
1
|
# TCAClient::SimilarityApi
|
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
|
-
[**download_similarity_report_pdf**](SimilarityApi.md#download_similarity_report_pdf) | **GET** /submissions/{id}/similarity/pdf/{pdf_id} | GET download pdf
|
8
|
-
[**get_similarity_report_pdf_status**](SimilarityApi.md#get_similarity_report_pdf_status) | **GET** /submissions/{id}/similarity/pdf/{pdf_id}/status | GET pdf download status
|
9
|
-
[**get_similarity_report_results**](SimilarityApi.md#get_similarity_report_results) | **GET** /submissions/{id}/similarity | Get Similarity Report Results
|
10
|
-
[**get_similarity_report_url**](SimilarityApi.md#get_similarity_report_url) | **POST** /submissions/{id}/viewer-url | Returns a URL to access Cloud Viewer
|
11
|
-
[**request_similarity_report**](SimilarityApi.md#request_similarity_report) | **PUT** /submissions/{id}/similarity | Request Similarity Report generation
|
12
|
-
[**request_similarity_report_pdf**](SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**download_similarity_report_pdf**](SimilarityApi.md#download_similarity_report_pdf) | **GET** /submissions/{id}/similarity/pdf/{pdf_id} | GET download pdf |
|
8
|
+
| [**get_similarity_report_pdf_status**](SimilarityApi.md#get_similarity_report_pdf_status) | **GET** /submissions/{id}/similarity/pdf/{pdf_id}/status | GET pdf download status |
|
9
|
+
| [**get_similarity_report_results**](SimilarityApi.md#get_similarity_report_results) | **GET** /submissions/{id}/similarity | Get Similarity Report Results |
|
10
|
+
| [**get_similarity_report_url**](SimilarityApi.md#get_similarity_report_url) | **POST** /submissions/{id}/viewer-url | Returns a URL to access Cloud Viewer |
|
11
|
+
| [**request_similarity_report**](SimilarityApi.md#request_similarity_report) | **PUT** /submissions/{id}/similarity | Request Similarity Report generation |
|
12
|
+
| [**request_similarity_report_pdf**](SimilarityApi.md#request_similarity_report_pdf) | **POST** /submissions/{id}/similarity/pdf | Request Pdf download and returns the Pdf Id |
|
13
13
|
|
14
|
-
|
15
|
-
|
14
|
+
|
15
|
+
## download_similarity_report_pdf
|
16
|
+
|
17
|
+
> File download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
16
18
|
|
17
19
|
GET download pdf
|
18
20
|
|
19
|
-
###
|
21
|
+
### Examples
|
22
|
+
|
20
23
|
```ruby
|
21
|
-
|
24
|
+
require 'time'
|
22
25
|
require 'tca_client'
|
23
26
|
# setup authorization
|
24
27
|
TCAClient.configure do |config|
|
25
28
|
# Configure API key authorization: api_key
|
26
|
-
config.api_key['
|
29
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
27
30
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
-
#config.api_key_prefix['
|
31
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
29
32
|
end
|
30
33
|
|
31
34
|
api_instance = TCAClient::SimilarityApi.new
|
32
|
-
x_turnitin_integration_name = '
|
33
|
-
x_turnitin_integration_version = '
|
35
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
36
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
34
37
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
35
38
|
pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)
|
36
39
|
|
37
|
-
|
38
40
|
begin
|
39
|
-
#GET download pdf
|
41
|
+
# GET download pdf
|
40
42
|
result = api_instance.download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
41
43
|
p result
|
42
44
|
rescue TCAClient::ApiError => e
|
43
|
-
puts "
|
45
|
+
puts "Error when calling SimilarityApi->download_similarity_report_pdf: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the download_similarity_report_pdf_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(File, Integer, Hash)> download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# GET download pdf
|
58
|
+
data, status_code, headers = api_instance.download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => File
|
62
|
+
rescue TCAClient::ApiError => e
|
63
|
+
puts "Error when calling SimilarityApi->download_similarity_report_pdf_with_http_info: #{e}"
|
44
64
|
end
|
45
65
|
```
|
46
66
|
|
47
67
|
### Parameters
|
48
68
|
|
49
|
-
Name | Type | Description
|
50
|
-
|
51
|
-
**x_turnitin_integration_name** | **String
|
52
|
-
**x_turnitin_integration_version** | **String
|
53
|
-
**id** | **String
|
54
|
-
**pdf_id** | **String
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
72
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
73
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
74
|
+
| **pdf_id** | **String** | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) | |
|
55
75
|
|
56
76
|
### Return type
|
57
77
|
|
58
|
-
**
|
78
|
+
**File**
|
59
79
|
|
60
80
|
### Authorization
|
61
81
|
|
@@ -63,52 +83,70 @@ Name | Type | Description | Notes
|
|
63
83
|
|
64
84
|
### HTTP request headers
|
65
85
|
|
66
|
-
|
67
|
-
|
86
|
+
- **Content-Type**: Not defined
|
87
|
+
- **Accept**: application/pdf, application/json
|
68
88
|
|
69
89
|
|
90
|
+
## get_similarity_report_pdf_status
|
70
91
|
|
71
|
-
|
72
|
-
> PdfStatusResponse get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
92
|
+
> <PdfStatusResponse> get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
73
93
|
|
74
94
|
GET pdf download status
|
75
95
|
|
76
|
-
###
|
96
|
+
### Examples
|
97
|
+
|
77
98
|
```ruby
|
78
|
-
|
99
|
+
require 'time'
|
79
100
|
require 'tca_client'
|
80
101
|
# setup authorization
|
81
102
|
TCAClient.configure do |config|
|
82
103
|
# Configure API key authorization: api_key
|
83
|
-
config.api_key['
|
104
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
84
105
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
-
#config.api_key_prefix['
|
106
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
86
107
|
end
|
87
108
|
|
88
109
|
api_instance = TCAClient::SimilarityApi.new
|
89
|
-
x_turnitin_integration_name = '
|
90
|
-
x_turnitin_integration_version = '
|
110
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
111
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
91
112
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
92
113
|
pdf_id = 'pdf_id_example' # String | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf)
|
93
114
|
|
94
|
-
|
95
115
|
begin
|
96
|
-
#GET pdf download status
|
116
|
+
# GET pdf download status
|
97
117
|
result = api_instance.get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
98
118
|
p result
|
99
119
|
rescue TCAClient::ApiError => e
|
100
|
-
puts "
|
120
|
+
puts "Error when calling SimilarityApi->get_similarity_report_pdf_status: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
#### Using the get_similarity_report_pdf_status_with_http_info variant
|
125
|
+
|
126
|
+
This returns an Array which contains the response data, status code and headers.
|
127
|
+
|
128
|
+
> <Array(<PdfStatusResponse>, Integer, Hash)> get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id)
|
129
|
+
|
130
|
+
```ruby
|
131
|
+
begin
|
132
|
+
# GET pdf download status
|
133
|
+
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)
|
134
|
+
p status_code # => 2xx
|
135
|
+
p headers # => { ... }
|
136
|
+
p data # => <PdfStatusResponse>
|
137
|
+
rescue TCAClient::ApiError => e
|
138
|
+
puts "Error when calling SimilarityApi->get_similarity_report_pdf_status_with_http_info: #{e}"
|
101
139
|
end
|
102
140
|
```
|
103
141
|
|
104
142
|
### Parameters
|
105
143
|
|
106
|
-
Name | Type | Description
|
107
|
-
|
108
|
-
**x_turnitin_integration_name** | **String
|
109
|
-
**x_turnitin_integration_version** | **String
|
110
|
-
**id** | **String
|
111
|
-
**pdf_id** | **String
|
144
|
+
| Name | Type | Description | Notes |
|
145
|
+
| ---- | ---- | ----------- | ----- |
|
146
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
147
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
148
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
149
|
+
| **pdf_id** | **String** | The Pdf ID (returned upon a successful POST to /submissions/{submission_id}/similarity/pdf) | |
|
112
150
|
|
113
151
|
### Return type
|
114
152
|
|
@@ -120,50 +158,68 @@ Name | Type | Description | Notes
|
|
120
158
|
|
121
159
|
### HTTP request headers
|
122
160
|
|
123
|
-
|
124
|
-
|
161
|
+
- **Content-Type**: Not defined
|
162
|
+
- **Accept**: application/json
|
125
163
|
|
126
164
|
|
165
|
+
## get_similarity_report_results
|
127
166
|
|
128
|
-
|
129
|
-
> SimilarityMetadata get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
167
|
+
> <SimilarityMetadata> get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
130
168
|
|
131
169
|
Get Similarity Report Results
|
132
170
|
|
133
|
-
###
|
171
|
+
### Examples
|
172
|
+
|
134
173
|
```ruby
|
135
|
-
|
174
|
+
require 'time'
|
136
175
|
require 'tca_client'
|
137
176
|
# setup authorization
|
138
177
|
TCAClient.configure do |config|
|
139
178
|
# Configure API key authorization: api_key
|
140
|
-
config.api_key['
|
179
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
141
180
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
142
|
-
#config.api_key_prefix['
|
181
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
143
182
|
end
|
144
183
|
|
145
184
|
api_instance = TCAClient::SimilarityApi.new
|
146
|
-
x_turnitin_integration_name = '
|
147
|
-
x_turnitin_integration_version = '
|
185
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
186
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
148
187
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
149
188
|
|
150
|
-
|
151
189
|
begin
|
152
|
-
#Get Similarity Report Results
|
190
|
+
# Get Similarity Report Results
|
153
191
|
result = api_instance.get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
154
192
|
p result
|
155
193
|
rescue TCAClient::ApiError => e
|
156
|
-
puts "
|
194
|
+
puts "Error when calling SimilarityApi->get_similarity_report_results: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
#### Using the get_similarity_report_results_with_http_info variant
|
199
|
+
|
200
|
+
This returns an Array which contains the response data, status code and headers.
|
201
|
+
|
202
|
+
> <Array(<SimilarityMetadata>, Integer, Hash)> get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
begin
|
206
|
+
# Get Similarity Report Results
|
207
|
+
data, status_code, headers = api_instance.get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
208
|
+
p status_code # => 2xx
|
209
|
+
p headers # => { ... }
|
210
|
+
p data # => <SimilarityMetadata>
|
211
|
+
rescue TCAClient::ApiError => e
|
212
|
+
puts "Error when calling SimilarityApi->get_similarity_report_results_with_http_info: #{e}"
|
157
213
|
end
|
158
214
|
```
|
159
215
|
|
160
216
|
### Parameters
|
161
217
|
|
162
|
-
Name | Type | Description
|
163
|
-
|
164
|
-
**x_turnitin_integration_name** | **String
|
165
|
-
**x_turnitin_integration_version** | **String
|
166
|
-
**id** | **String
|
218
|
+
| Name | Type | Description | Notes |
|
219
|
+
| ---- | ---- | ----------- | ----- |
|
220
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
221
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
222
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
167
223
|
|
168
224
|
### Return type
|
169
225
|
|
@@ -175,52 +231,70 @@ Name | Type | Description | Notes
|
|
175
231
|
|
176
232
|
### HTTP request headers
|
177
233
|
|
178
|
-
|
179
|
-
|
234
|
+
- **Content-Type**: Not defined
|
235
|
+
- **Accept**: application/json
|
180
236
|
|
181
237
|
|
238
|
+
## get_similarity_report_url
|
182
239
|
|
183
|
-
|
184
|
-
> SimilarityViewerUrlResponse get_similarity_report_url(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
|
240
|
+
> <SimilarityViewerUrlResponse> get_similarity_report_url(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
185
241
|
|
186
242
|
Returns a URL to access Cloud Viewer
|
187
243
|
|
188
|
-
###
|
244
|
+
### Examples
|
245
|
+
|
189
246
|
```ruby
|
190
|
-
|
247
|
+
require 'time'
|
191
248
|
require 'tca_client'
|
192
249
|
# setup authorization
|
193
250
|
TCAClient.configure do |config|
|
194
251
|
# Configure API key authorization: api_key
|
195
|
-
config.api_key['
|
252
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
196
253
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
197
|
-
#config.api_key_prefix['
|
254
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
198
255
|
end
|
199
256
|
|
200
257
|
api_instance = TCAClient::SimilarityApi.new
|
201
|
-
|
202
|
-
|
203
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
258
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
259
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
204
260
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
205
|
-
|
261
|
+
data = TCAClient::SimilarityViewerUrlSettings.new # SimilarityViewerUrlSettings |
|
206
262
|
|
207
263
|
begin
|
208
|
-
#Returns a URL to access Cloud Viewer
|
209
|
-
result = api_instance.get_similarity_report_url(
|
264
|
+
# Returns a URL to access Cloud Viewer
|
265
|
+
result = api_instance.get_similarity_report_url(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
210
266
|
p result
|
211
267
|
rescue TCAClient::ApiError => e
|
212
|
-
puts "
|
268
|
+
puts "Error when calling SimilarityApi->get_similarity_report_url: #{e}"
|
269
|
+
end
|
270
|
+
```
|
271
|
+
|
272
|
+
#### Using the get_similarity_report_url_with_http_info variant
|
273
|
+
|
274
|
+
This returns an Array which contains the response data, status code and headers.
|
275
|
+
|
276
|
+
> <Array(<SimilarityViewerUrlResponse>, Integer, Hash)> get_similarity_report_url_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
277
|
+
|
278
|
+
```ruby
|
279
|
+
begin
|
280
|
+
# Returns a URL to access Cloud Viewer
|
281
|
+
data, status_code, headers = api_instance.get_similarity_report_url_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
282
|
+
p status_code # => 2xx
|
283
|
+
p headers # => { ... }
|
284
|
+
p data # => <SimilarityViewerUrlResponse>
|
285
|
+
rescue TCAClient::ApiError => e
|
286
|
+
puts "Error when calling SimilarityApi->get_similarity_report_url_with_http_info: #{e}"
|
213
287
|
end
|
214
288
|
```
|
215
289
|
|
216
290
|
### Parameters
|
217
291
|
|
218
|
-
Name | Type | Description
|
219
|
-
|
220
|
-
**
|
221
|
-
**
|
222
|
-
**
|
223
|
-
**
|
292
|
+
| Name | Type | Description | Notes |
|
293
|
+
| ---- | ---- | ----------- | ----- |
|
294
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
295
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
296
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
297
|
+
| **data** | [**SimilarityViewerUrlSettings**](SimilarityViewerUrlSettings.md) | | |
|
224
298
|
|
225
299
|
### Return type
|
226
300
|
|
@@ -232,52 +306,70 @@ Name | Type | Description | Notes
|
|
232
306
|
|
233
307
|
### HTTP request headers
|
234
308
|
|
235
|
-
|
236
|
-
|
309
|
+
- **Content-Type**: application/json
|
310
|
+
- **Accept**: application/json
|
237
311
|
|
238
312
|
|
313
|
+
## request_similarity_report
|
239
314
|
|
240
|
-
|
241
|
-
> SuccessMessage request_similarity_report(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
|
315
|
+
> <SuccessMessage> request_similarity_report(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
242
316
|
|
243
317
|
Request Similarity Report generation
|
244
318
|
|
245
|
-
###
|
319
|
+
### Examples
|
320
|
+
|
246
321
|
```ruby
|
247
|
-
|
322
|
+
require 'time'
|
248
323
|
require 'tca_client'
|
249
324
|
# setup authorization
|
250
325
|
TCAClient.configure do |config|
|
251
326
|
# Configure API key authorization: api_key
|
252
|
-
config.api_key['
|
327
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
253
328
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
254
|
-
#config.api_key_prefix['
|
329
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
255
330
|
end
|
256
331
|
|
257
332
|
api_instance = TCAClient::SimilarityApi.new
|
258
|
-
|
259
|
-
|
260
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
333
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
334
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
261
335
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
262
|
-
|
336
|
+
data = TCAClient::SimilarityPutRequest.new({generation_settings: TCAClient::SimilarityGenerationSettings.new({search_repositories: ['INTERNET']})}) # SimilarityPutRequest |
|
263
337
|
|
264
338
|
begin
|
265
|
-
#Request Similarity Report generation
|
266
|
-
result = api_instance.request_similarity_report(
|
339
|
+
# Request Similarity Report generation
|
340
|
+
result = api_instance.request_similarity_report(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
267
341
|
p result
|
268
342
|
rescue TCAClient::ApiError => e
|
269
|
-
puts "
|
343
|
+
puts "Error when calling SimilarityApi->request_similarity_report: #{e}"
|
344
|
+
end
|
345
|
+
```
|
346
|
+
|
347
|
+
#### Using the request_similarity_report_with_http_info variant
|
348
|
+
|
349
|
+
This returns an Array which contains the response data, status code and headers.
|
350
|
+
|
351
|
+
> <Array(<SuccessMessage>, Integer, Hash)> request_similarity_report_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
352
|
+
|
353
|
+
```ruby
|
354
|
+
begin
|
355
|
+
# Request Similarity Report generation
|
356
|
+
data, status_code, headers = api_instance.request_similarity_report_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
|
357
|
+
p status_code # => 2xx
|
358
|
+
p headers # => { ... }
|
359
|
+
p data # => <SuccessMessage>
|
360
|
+
rescue TCAClient::ApiError => e
|
361
|
+
puts "Error when calling SimilarityApi->request_similarity_report_with_http_info: #{e}"
|
270
362
|
end
|
271
363
|
```
|
272
364
|
|
273
365
|
### Parameters
|
274
366
|
|
275
|
-
Name | Type | Description
|
276
|
-
|
277
|
-
**
|
278
|
-
**
|
279
|
-
**
|
280
|
-
**
|
367
|
+
| Name | Type | Description | Notes |
|
368
|
+
| ---- | ---- | ----------- | ----- |
|
369
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
370
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
371
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
372
|
+
| **data** | [**SimilarityPutRequest**](SimilarityPutRequest.md) | | |
|
281
373
|
|
282
374
|
### Return type
|
283
375
|
|
@@ -289,50 +381,70 @@ Name | Type | Description | Notes
|
|
289
381
|
|
290
382
|
### HTTP request headers
|
291
383
|
|
292
|
-
|
293
|
-
|
384
|
+
- **Content-Type**: application/json
|
385
|
+
- **Accept**: application/json
|
294
386
|
|
295
387
|
|
388
|
+
## request_similarity_report_pdf
|
296
389
|
|
297
|
-
|
298
|
-
> RequestPdfResponse request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
390
|
+
> <RequestPdfResponse> request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
|
299
391
|
|
300
392
|
Request Pdf download and returns the Pdf Id
|
301
393
|
|
302
|
-
###
|
394
|
+
### Examples
|
395
|
+
|
303
396
|
```ruby
|
304
|
-
|
397
|
+
require 'time'
|
305
398
|
require 'tca_client'
|
306
399
|
# setup authorization
|
307
400
|
TCAClient.configure do |config|
|
308
401
|
# Configure API key authorization: api_key
|
309
|
-
config.api_key['
|
402
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
310
403
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
311
|
-
#config.api_key_prefix['
|
404
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
312
405
|
end
|
313
406
|
|
314
407
|
api_instance = TCAClient::SimilarityApi.new
|
315
|
-
x_turnitin_integration_name = '
|
316
|
-
x_turnitin_integration_version = '
|
408
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
409
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
317
410
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
318
|
-
|
411
|
+
generate_similarity_pdf = TCAClient::GenerateSimilarityPDF.new # GenerateSimilarityPDF |
|
319
412
|
|
320
413
|
begin
|
321
|
-
#Request Pdf download and returns the Pdf Id
|
322
|
-
result = api_instance.request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
414
|
+
# Request Pdf download and returns the Pdf Id
|
415
|
+
result = api_instance.request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
|
323
416
|
p result
|
324
417
|
rescue TCAClient::ApiError => e
|
325
|
-
puts "
|
418
|
+
puts "Error when calling SimilarityApi->request_similarity_report_pdf: #{e}"
|
419
|
+
end
|
420
|
+
```
|
421
|
+
|
422
|
+
#### Using the request_similarity_report_pdf_with_http_info variant
|
423
|
+
|
424
|
+
This returns an Array which contains the response data, status code and headers.
|
425
|
+
|
426
|
+
> <Array(<RequestPdfResponse>, Integer, Hash)> request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf)
|
427
|
+
|
428
|
+
```ruby
|
429
|
+
begin
|
430
|
+
# Request Pdf download and returns the Pdf Id
|
431
|
+
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)
|
432
|
+
p status_code # => 2xx
|
433
|
+
p headers # => { ... }
|
434
|
+
p data # => <RequestPdfResponse>
|
435
|
+
rescue TCAClient::ApiError => e
|
436
|
+
puts "Error when calling SimilarityApi->request_similarity_report_pdf_with_http_info: #{e}"
|
326
437
|
end
|
327
438
|
```
|
328
439
|
|
329
440
|
### Parameters
|
330
441
|
|
331
|
-
Name | Type | Description
|
332
|
-
|
333
|
-
**x_turnitin_integration_name** | **String
|
334
|
-
**x_turnitin_integration_version** | **String
|
335
|
-
**id** | **String
|
442
|
+
| Name | Type | Description | Notes |
|
443
|
+
| ---- | ---- | ----------- | ----- |
|
444
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
445
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
446
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
447
|
+
| **generate_similarity_pdf** | [**GenerateSimilarityPDF**](GenerateSimilarityPDF.md) | | |
|
336
448
|
|
337
449
|
### Return type
|
338
450
|
|
@@ -344,8 +456,6 @@ Name | Type | Description | Notes
|
|
344
456
|
|
345
457
|
### HTTP request headers
|
346
458
|
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
459
|
+
- **Content-Type**: application/json
|
460
|
+
- **Accept**: application/json
|
351
461
|
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# TCAClient::SimilarityCompleteWebhookRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **overall_match_percentage** | **Integer** | Represents the percentage match against all sources | |
|
8
|
+
| **internet_match_percentage** | **Integer** | Represents the percentage match against internet | [optional] |
|
9
|
+
| **publication_match_percentage** | **Integer** | Represents the percentage match against all publications | [optional] |
|
10
|
+
| **submitted_works_match_percentage** | **Integer** | Represents the percentage match against all submitted works | [optional] |
|
11
|
+
| **submission_id** | **String** | | |
|
12
|
+
| **status** | **String** | possible values PENDING, COMPLETE | |
|
13
|
+
| **time_generated** | **String** | Time the report finished generating. If not set the report has not finished generating | |
|
14
|
+
| **time_requested** | **String** | Time the report was requested | |
|
15
|
+
| **top_matches** | [**Array<SimilarityMetadataAllOfTopMatches>**](SimilarityMetadataAllOfTopMatches.md) | Top matches | |
|
16
|
+
| **top_source_largest_matched_word_count** | **Integer** | Largest individual matched word count, 0 if there isn't a match to this submission. | |
|
17
|
+
| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) | | [optional] |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'tca_client'
|
23
|
+
|
24
|
+
instance = TCAClient::SimilarityCompleteWebhookRequest.new(
|
25
|
+
overall_match_percentage: null,
|
26
|
+
internet_match_percentage: null,
|
27
|
+
publication_match_percentage: null,
|
28
|
+
submitted_works_match_percentage: null,
|
29
|
+
submission_id: null,
|
30
|
+
status: null,
|
31
|
+
time_generated: null,
|
32
|
+
time_requested: null,
|
33
|
+
top_matches: null,
|
34
|
+
top_source_largest_matched_word_count: null,
|
35
|
+
metadata: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -1,10 +1,24 @@
|
|
1
1
|
# TCAClient::SimilarityGenerationSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **search_repositories** | **Array<String>** | List of repositories to search | |
|
8
|
+
| **submission_auto_excludes** | **Array<String>** | List of submission IDs to exclude from report | [optional] |
|
9
|
+
| **auto_exclude_self_matching_scope** | **String** | self matching submissions to exclude from report | [optional] |
|
10
|
+
| **priority** | **Boolean** | Priority level of report generation | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'tca_client'
|
16
|
+
|
17
|
+
instance = TCAClient::SimilarityGenerationSettings.new(
|
18
|
+
search_repositories: null,
|
19
|
+
submission_auto_excludes: null,
|
20
|
+
auto_exclude_self_matching_scope: null,
|
21
|
+
priority: false
|
22
|
+
)
|
23
|
+
```
|
10
24
|
|