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/SubmissionApi.md
CHANGED
@@ -1,54 +1,74 @@
|
|
1
1
|
# TCAClient::SubmissionApi
|
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
|
-
[**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission
|
8
|
-
[**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report.
|
9
|
-
[**get_submiddion_details**](SubmissionApi.md#get_submiddion_details) | **GET** /submissions/{id} | Get Submission Details
|
10
|
-
[**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission
|
11
|
-
[**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission |
|
8
|
+
| [**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report. |
|
9
|
+
| [**get_submiddion_details**](SubmissionApi.md#get_submiddion_details) | **GET** /submissions/{id} | Get Submission Details |
|
10
|
+
| [**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission |
|
11
|
+
| [**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File |
|
12
12
|
|
13
|
-
|
14
|
-
|
13
|
+
|
14
|
+
## create_submission
|
15
|
+
|
16
|
+
> <SimpleSubmissionResponse> create_submission(x_turnitin_integration_name, x_turnitin_integration_version, data)
|
15
17
|
|
16
18
|
Create a new Submission
|
17
19
|
|
18
|
-
###
|
20
|
+
### Examples
|
21
|
+
|
19
22
|
```ruby
|
20
|
-
|
23
|
+
require 'time'
|
21
24
|
require 'tca_client'
|
22
25
|
# setup authorization
|
23
26
|
TCAClient.configure do |config|
|
24
27
|
# Configure API key authorization: api_key
|
25
|
-
config.api_key['
|
28
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
26
29
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
-
#config.api_key_prefix['
|
30
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
28
31
|
end
|
29
32
|
|
30
33
|
api_instance = TCAClient::SubmissionApi.new
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
34
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
35
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
36
|
+
data = TCAClient::SubmissionBase.new # SubmissionBase |
|
35
37
|
|
36
38
|
begin
|
37
|
-
#Create a new Submission
|
38
|
-
result = api_instance.create_submission(
|
39
|
+
# Create a new Submission
|
40
|
+
result = api_instance.create_submission(x_turnitin_integration_name, x_turnitin_integration_version, data)
|
39
41
|
p result
|
40
42
|
rescue TCAClient::ApiError => e
|
41
|
-
puts "
|
43
|
+
puts "Error when calling SubmissionApi->create_submission: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the create_submission_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<SimpleSubmissionResponse>, Integer, Hash)> create_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Create a new Submission
|
56
|
+
data, status_code, headers = api_instance.create_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <SimpleSubmissionResponse>
|
60
|
+
rescue TCAClient::ApiError => e
|
61
|
+
puts "Error when calling SubmissionApi->create_submission_with_http_info: #{e}"
|
42
62
|
end
|
43
63
|
```
|
44
64
|
|
45
65
|
### Parameters
|
46
66
|
|
47
|
-
Name | Type | Description
|
48
|
-
|
49
|
-
**
|
50
|
-
**
|
51
|
-
**
|
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
|
+
| **data** | [**SubmissionBase**](SubmissionBase.md) | | |
|
52
72
|
|
53
73
|
### Return type
|
54
74
|
|
@@ -60,53 +80,72 @@ Name | Type | Description | Notes
|
|
60
80
|
|
61
81
|
### HTTP request headers
|
62
82
|
|
63
|
-
|
64
|
-
|
83
|
+
- **Content-Type**: application/json
|
84
|
+
- **Accept**: application/json
|
65
85
|
|
66
86
|
|
87
|
+
## delete_submission
|
67
88
|
|
68
|
-
|
69
|
-
> SuccessMessage delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
89
|
+
> <SuccessMessage> delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
70
90
|
|
71
91
|
Deletes a submission and associated similarity report.
|
72
92
|
|
73
|
-
###
|
93
|
+
### Examples
|
94
|
+
|
74
95
|
```ruby
|
75
|
-
|
96
|
+
require 'time'
|
76
97
|
require 'tca_client'
|
77
98
|
# setup authorization
|
78
99
|
TCAClient.configure do |config|
|
79
100
|
# Configure API key authorization: api_key
|
80
|
-
config.api_key['
|
101
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
81
102
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
82
|
-
#config.api_key_prefix['
|
103
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
83
104
|
end
|
84
105
|
|
85
106
|
api_instance = TCAClient::SubmissionApi.new
|
86
|
-
x_turnitin_integration_name = '
|
87
|
-
x_turnitin_integration_version = '
|
107
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
108
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
88
109
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
89
|
-
opts = {
|
90
|
-
hard: '
|
110
|
+
opts = {
|
111
|
+
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.
|
91
112
|
}
|
92
113
|
|
93
114
|
begin
|
94
|
-
#Deletes a submission and associated similarity report.
|
115
|
+
# Deletes a submission and associated similarity report.
|
95
116
|
result = api_instance.delete_submission(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
96
117
|
p result
|
97
118
|
rescue TCAClient::ApiError => e
|
98
|
-
puts "
|
119
|
+
puts "Error when calling SubmissionApi->delete_submission: #{e}"
|
120
|
+
end
|
121
|
+
```
|
122
|
+
|
123
|
+
#### Using the delete_submission_with_http_info variant
|
124
|
+
|
125
|
+
This returns an Array which contains the response data, status code and headers.
|
126
|
+
|
127
|
+
> <Array(<SuccessMessage>, Integer, Hash)> delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
128
|
+
|
129
|
+
```ruby
|
130
|
+
begin
|
131
|
+
# Deletes a submission and associated similarity report.
|
132
|
+
data, status_code, headers = api_instance.delete_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
133
|
+
p status_code # => 2xx
|
134
|
+
p headers # => { ... }
|
135
|
+
p data # => <SuccessMessage>
|
136
|
+
rescue TCAClient::ApiError => e
|
137
|
+
puts "Error when calling SubmissionApi->delete_submission_with_http_info: #{e}"
|
99
138
|
end
|
100
139
|
```
|
101
140
|
|
102
141
|
### Parameters
|
103
142
|
|
104
|
-
Name | Type | Description
|
105
|
-
|
106
|
-
**x_turnitin_integration_name** | **String
|
107
|
-
**x_turnitin_integration_version** | **String
|
108
|
-
**id** | **String
|
109
|
-
**hard** | **String
|
143
|
+
| Name | Type | Description | Notes |
|
144
|
+
| ---- | ---- | ----------- | ----- |
|
145
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
146
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
147
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
148
|
+
| **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'] |
|
110
149
|
|
111
150
|
### Return type
|
112
151
|
|
@@ -118,50 +157,68 @@ Name | Type | Description | Notes
|
|
118
157
|
|
119
158
|
### HTTP request headers
|
120
159
|
|
121
|
-
|
122
|
-
|
160
|
+
- **Content-Type**: Not defined
|
161
|
+
- **Accept**: application/json
|
123
162
|
|
124
163
|
|
164
|
+
## get_submiddion_details
|
125
165
|
|
126
|
-
|
127
|
-
> Submission get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
166
|
+
> <Submission> get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
128
167
|
|
129
168
|
Get Submission Details
|
130
169
|
|
131
|
-
###
|
170
|
+
### Examples
|
171
|
+
|
132
172
|
```ruby
|
133
|
-
|
173
|
+
require 'time'
|
134
174
|
require 'tca_client'
|
135
175
|
# setup authorization
|
136
176
|
TCAClient.configure do |config|
|
137
177
|
# Configure API key authorization: api_key
|
138
|
-
config.api_key['
|
178
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
139
179
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
140
|
-
#config.api_key_prefix['
|
180
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
141
181
|
end
|
142
182
|
|
143
183
|
api_instance = TCAClient::SubmissionApi.new
|
144
|
-
x_turnitin_integration_name = '
|
145
|
-
x_turnitin_integration_version = '
|
184
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
185
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
146
186
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
147
187
|
|
148
|
-
|
149
188
|
begin
|
150
|
-
#Get Submission Details
|
189
|
+
# Get Submission Details
|
151
190
|
result = api_instance.get_submiddion_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
152
191
|
p result
|
153
192
|
rescue TCAClient::ApiError => e
|
154
|
-
puts "
|
193
|
+
puts "Error when calling SubmissionApi->get_submiddion_details: #{e}"
|
194
|
+
end
|
195
|
+
```
|
196
|
+
|
197
|
+
#### Using the get_submiddion_details_with_http_info variant
|
198
|
+
|
199
|
+
This returns an Array which contains the response data, status code and headers.
|
200
|
+
|
201
|
+
> <Array(<Submission>, Integer, Hash)> get_submiddion_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
202
|
+
|
203
|
+
```ruby
|
204
|
+
begin
|
205
|
+
# Get Submission Details
|
206
|
+
data, status_code, headers = api_instance.get_submiddion_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
207
|
+
p status_code # => 2xx
|
208
|
+
p headers # => { ... }
|
209
|
+
p data # => <Submission>
|
210
|
+
rescue TCAClient::ApiError => e
|
211
|
+
puts "Error when calling SubmissionApi->get_submiddion_details_with_http_info: #{e}"
|
155
212
|
end
|
156
213
|
```
|
157
214
|
|
158
215
|
### Parameters
|
159
216
|
|
160
|
-
Name | Type | Description
|
161
|
-
|
162
|
-
**x_turnitin_integration_name** | **String
|
163
|
-
**x_turnitin_integration_version** | **String
|
164
|
-
**id** | **String
|
217
|
+
| Name | Type | Description | Notes |
|
218
|
+
| ---- | ---- | ----------- | ----- |
|
219
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
220
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
221
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
165
222
|
|
166
223
|
### Return type
|
167
224
|
|
@@ -173,50 +230,68 @@ Name | Type | Description | Notes
|
|
173
230
|
|
174
231
|
### HTTP request headers
|
175
232
|
|
176
|
-
|
177
|
-
|
233
|
+
- **Content-Type**: Not defined
|
234
|
+
- **Accept**: application/json
|
178
235
|
|
179
236
|
|
237
|
+
## recover_submission
|
180
238
|
|
181
|
-
|
182
|
-
> SimpleSubmissionResponse recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
239
|
+
> <SimpleSubmissionResponse> recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
183
240
|
|
184
241
|
Recover a soft deleted submission
|
185
242
|
|
186
|
-
###
|
243
|
+
### Examples
|
244
|
+
|
187
245
|
```ruby
|
188
|
-
|
246
|
+
require 'time'
|
189
247
|
require 'tca_client'
|
190
248
|
# setup authorization
|
191
249
|
TCAClient.configure do |config|
|
192
250
|
# Configure API key authorization: api_key
|
193
|
-
config.api_key['
|
251
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
194
252
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
195
|
-
#config.api_key_prefix['
|
253
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
196
254
|
end
|
197
255
|
|
198
256
|
api_instance = TCAClient::SubmissionApi.new
|
199
|
-
x_turnitin_integration_name = '
|
200
|
-
x_turnitin_integration_version = '
|
257
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
258
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
201
259
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
202
260
|
|
203
|
-
|
204
261
|
begin
|
205
|
-
#Recover a soft deleted submission
|
262
|
+
# Recover a soft deleted submission
|
206
263
|
result = api_instance.recover_submission(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
207
264
|
p result
|
208
265
|
rescue TCAClient::ApiError => e
|
209
|
-
puts "
|
266
|
+
puts "Error when calling SubmissionApi->recover_submission: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
#### Using the recover_submission_with_http_info variant
|
271
|
+
|
272
|
+
This returns an Array which contains the response data, status code and headers.
|
273
|
+
|
274
|
+
> <Array(<SimpleSubmissionResponse>, Integer, Hash)> recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
275
|
+
|
276
|
+
```ruby
|
277
|
+
begin
|
278
|
+
# Recover a soft deleted submission
|
279
|
+
data, status_code, headers = api_instance.recover_submission_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
280
|
+
p status_code # => 2xx
|
281
|
+
p headers # => { ... }
|
282
|
+
p data # => <SimpleSubmissionResponse>
|
283
|
+
rescue TCAClient::ApiError => e
|
284
|
+
puts "Error when calling SubmissionApi->recover_submission_with_http_info: #{e}"
|
210
285
|
end
|
211
286
|
```
|
212
287
|
|
213
288
|
### Parameters
|
214
289
|
|
215
|
-
Name | Type | Description
|
216
|
-
|
217
|
-
**x_turnitin_integration_name** | **String
|
218
|
-
**x_turnitin_integration_version** | **String
|
219
|
-
**id** | **String
|
290
|
+
| Name | Type | Description | Notes |
|
291
|
+
| ---- | ---- | ----------- | ----- |
|
292
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
293
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
294
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
220
295
|
|
221
296
|
### Return type
|
222
297
|
|
@@ -228,56 +303,74 @@ Name | Type | Description | Notes
|
|
228
303
|
|
229
304
|
### HTTP request headers
|
230
305
|
|
231
|
-
|
232
|
-
|
306
|
+
- **Content-Type**: Not defined
|
307
|
+
- **Accept**: application/json
|
233
308
|
|
234
309
|
|
310
|
+
## upload_submitted_file
|
235
311
|
|
236
|
-
|
237
|
-
> SuccessMessage upload_submitted_file(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_typecontent_dispositionid)
|
312
|
+
> <SuccessMessage> upload_submitted_file(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
|
238
313
|
|
239
314
|
Upload Submitted File
|
240
315
|
|
241
|
-
###
|
316
|
+
### Examples
|
317
|
+
|
242
318
|
```ruby
|
243
|
-
|
319
|
+
require 'time'
|
244
320
|
require 'tca_client'
|
245
321
|
# setup authorization
|
246
322
|
TCAClient.configure do |config|
|
247
323
|
# Configure API key authorization: api_key
|
248
|
-
config.api_key['
|
324
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
249
325
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
250
|
-
#config.api_key_prefix['
|
326
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
251
327
|
end
|
252
328
|
|
253
329
|
api_instance = TCAClient::SubmissionApi.new
|
254
|
-
|
255
|
-
|
256
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
257
|
-
content_type = 'content_type_example' # String | *Must be 'binary/octet-stream'
|
258
|
-
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
|
330
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
331
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
259
332
|
id = 'id_example' # String | The Submission ID (returned upon a successful POST to /submissions)
|
260
|
-
|
333
|
+
content_type = 'content_type_example' # String | *Must be 'binary/octet-stream'
|
334
|
+
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
|
335
|
+
file = { ... } # Object | the user's submitted file
|
261
336
|
|
262
337
|
begin
|
263
|
-
#Upload Submitted File
|
264
|
-
result = api_instance.upload_submitted_file(
|
338
|
+
# Upload Submitted File
|
339
|
+
result = api_instance.upload_submitted_file(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
|
265
340
|
p result
|
266
341
|
rescue TCAClient::ApiError => e
|
267
|
-
puts "
|
342
|
+
puts "Error when calling SubmissionApi->upload_submitted_file: #{e}"
|
343
|
+
end
|
344
|
+
```
|
345
|
+
|
346
|
+
#### Using the upload_submitted_file_with_http_info variant
|
347
|
+
|
348
|
+
This returns an Array which contains the response data, status code and headers.
|
349
|
+
|
350
|
+
> <Array(<SuccessMessage>, Integer, Hash)> upload_submitted_file_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, content_type, content_disposition, file)
|
351
|
+
|
352
|
+
```ruby
|
353
|
+
begin
|
354
|
+
# Upload Submitted File
|
355
|
+
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)
|
356
|
+
p status_code # => 2xx
|
357
|
+
p headers # => { ... }
|
358
|
+
p data # => <SuccessMessage>
|
359
|
+
rescue TCAClient::ApiError => e
|
360
|
+
puts "Error when calling SubmissionApi->upload_submitted_file_with_http_info: #{e}"
|
268
361
|
end
|
269
362
|
```
|
270
363
|
|
271
364
|
### Parameters
|
272
365
|
|
273
|
-
Name | Type | Description
|
274
|
-
|
275
|
-
**
|
276
|
-
**
|
277
|
-
**
|
278
|
-
**content_type** | **String
|
279
|
-
**content_disposition** | **String
|
280
|
-
**
|
366
|
+
| Name | Type | Description | Notes |
|
367
|
+
| ---- | ---- | ----------- | ----- |
|
368
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
369
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
370
|
+
| **id** | **String** | The Submission ID (returned upon a successful POST to /submissions) | |
|
371
|
+
| **content_type** | **String** | *Must be 'binary/octet-stream' | |
|
372
|
+
| **content_disposition** | **String** | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`. To support UTF-8 filenames, you must URL encode the header | |
|
373
|
+
| **file** | **Object** | the user's submitted file | |
|
281
374
|
|
282
375
|
### Return type
|
283
376
|
|
@@ -289,8 +382,6 @@ Name | Type | Description | Notes
|
|
289
382
|
|
290
383
|
### HTTP request headers
|
291
384
|
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
385
|
+
- **Content-Type**: binary/octet-stream
|
386
|
+
- **Accept**: application/json
|
296
387
|
|
data/docs/SubmissionBase.md
CHANGED
@@ -1,15 +1,34 @@
|
|
1
1
|
# TCAClient::SubmissionBase
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Object** | Submission id, optional field | [optional] |
|
8
|
+
| **owner** | **String** | ID of the owning user | [optional] |
|
9
|
+
| **owner_default_permission_set** | **String** | Default viewer permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] |
|
10
|
+
| **title** | **String** | the title of the submission | [optional] |
|
11
|
+
| **submitter** | **String** | (optional) ID of the submitting user, if different from the owning user | [optional] |
|
12
|
+
| **submitter_default_permission_set** | **String** | Default submitter permission set, accepts INSTRUCTOR, LEARNER, EDITOR, USER, APPLICANT, ADMINISTRATOR, UNDEFINED | [optional] |
|
13
|
+
| **eula** | [**Eula**](Eula.md) | | [optional] |
|
14
|
+
| **metadata** | [**SubmissionBaseMetadata**](SubmissionBaseMetadata.md) | | [optional] |
|
15
|
+
| **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] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'tca_client'
|
21
|
+
|
22
|
+
instance = TCAClient::SubmissionBase.new(
|
23
|
+
id: null,
|
24
|
+
owner: null,
|
25
|
+
owner_default_permission_set: null,
|
26
|
+
title: null,
|
27
|
+
submitter: null,
|
28
|
+
submitter_default_permission_set: null,
|
29
|
+
eula: null,
|
30
|
+
metadata: null,
|
31
|
+
extract_text_only: null
|
32
|
+
)
|
33
|
+
```
|
15
34
|
|
@@ -1,12 +1,28 @@
|
|
1
1
|
# TCAClient::SubmissionBaseMetadata
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **submitter** | [**Users**](Users.md) | | [optional] |
|
8
|
+
| **owners** | [**Array<Users>**](Users.md) | | [optional] |
|
9
|
+
| **group** | [**Group**](Group.md) | | [optional] |
|
10
|
+
| **group_context** | [**GroupContext**](GroupContext.md) | | [optional] |
|
11
|
+
| **original_submitted_time** | **Time** | Optional original submision date | [optional] |
|
12
|
+
| **custom** | **String** | custom metadata | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'tca_client'
|
18
|
+
|
19
|
+
instance = TCAClient::SubmissionBaseMetadata.new(
|
20
|
+
submitter: null,
|
21
|
+
owners: null,
|
22
|
+
group: null,
|
23
|
+
group_context: null,
|
24
|
+
original_submitted_time: null,
|
25
|
+
custom: {"Hello": "data"}
|
26
|
+
)
|
27
|
+
```
|
12
28
|
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# TCAClient::SubmissionCompleteWebhookRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **owner** | **String** | the owner of the submission | [optional] |
|
8
|
+
| **title** | **String** | the title of the submission | [optional] |
|
9
|
+
| **status** | **String** | the current status of the Submission | [optional] |
|
10
|
+
| **id** | **String** | the unique ID of the submission | [optional] |
|
11
|
+
| **content_type** | **String** | the content type of the submission | [optional] |
|
12
|
+
| **page_count** | **Integer** | the number of pages in the submission | [optional] |
|
13
|
+
| **word_count** | **Integer** | the number of words in the submission | [optional] |
|
14
|
+
| **character_count** | **Integer** | the number of characters in the submission | [optional] |
|
15
|
+
| **error_code** | **String** | an error code representing the type of error encountered (if applicable) | [optional] |
|
16
|
+
| **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] |
|
17
|
+
| **capabilities** | **Array<String>** | Set of capabilities available to the current submission | [optional] |
|
18
|
+
| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) | | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'tca_client'
|
24
|
+
|
25
|
+
instance = TCAClient::SubmissionCompleteWebhookRequest.new(
|
26
|
+
owner: null,
|
27
|
+
title: null,
|
28
|
+
status: null,
|
29
|
+
id: null,
|
30
|
+
content_type: null,
|
31
|
+
page_count: null,
|
32
|
+
word_count: null,
|
33
|
+
character_count: null,
|
34
|
+
error_code: null,
|
35
|
+
created_time: null,
|
36
|
+
capabilities: null,
|
37
|
+
metadata: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TCAClient::SubmissionCompleteWebhookRequestAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **metadata** | [**SubmissionCompleteWebhookRequestAllOfMetadata**](SubmissionCompleteWebhookRequestAllOfMetadata.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::SubmissionCompleteWebhookRequestAllOf.new(
|
15
|
+
metadata: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# TCAClient::SubmissionCompleteWebhookRequestAllOfMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **custom** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'tca_client'
|
13
|
+
|
14
|
+
instance = TCAClient::SubmissionCompleteWebhookRequestAllOfMetadata.new(
|
15
|
+
custom: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|