tca_client 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/docs/SubmissionApi.md +9 -9
- data/lib/tca_client/api/submission_api.rb +9 -9
- data/lib/tca_client/models/group_attachment_response.rb +10 -2
- data/lib/tca_client/version.rb +1 -1
- data/spec/api/submission_api_spec.rb +2 -2
- data/tca_client-1.0.1.gem +0 -0
- data/tca_client-1.0.2.gem +0 -0
- metadata +14 -12
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9c62268259838107dddebb07d4fadcb27eea2b45a1eb618816aaca59a920839d
|
4
|
+
data.tar.gz: 1fdd3ed3f5119b62bd48ab91e1aa2cde48c29ea3856405a1c98cb8dcbf8d5b87
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5b9fdb156176170b32e2df28c9a8490bc8e2491c72c912c334fee68988ab6629aec4c89b581a85a6d4c477f86b83e87e85b9d07925979913da5c6edcc5034e77
|
7
|
+
data.tar.gz: 0d5d7f5b9a2879aef9a91bd8e967360eda34619d8ccf75885520919665d1786f06a9fdb842d20b7a94d64cd59911cb335e33de15767b4671d5c4da761fec2ef9
|
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
|
data/docs/SubmissionApi.md
CHANGED
@@ -6,7 +6,7 @@ All URIs are relative to *https://app-us.turnitin.com/api/v1*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_submission**](SubmissionApi.md#create_submission) | **POST** /submissions | Create a new Submission |
|
8
8
|
| [**delete_submission**](SubmissionApi.md#delete_submission) | **DELETE** /submissions/{id} | Deletes a submission and associated similarity report. |
|
9
|
-
| [**
|
9
|
+
| [**get_submission_details**](SubmissionApi.md#get_submission_details) | **GET** /submissions/{id} | Get Submission Details |
|
10
10
|
| [**recover_submission**](SubmissionApi.md#recover_submission) | **PUT** /submissions/{id}/recover | Recover a soft deleted submission |
|
11
11
|
| [**upload_submitted_file**](SubmissionApi.md#upload_submitted_file) | **PUT** /submissions/{id}/original | Upload Submitted File |
|
12
12
|
|
@@ -161,9 +161,9 @@ end
|
|
161
161
|
- **Accept**: application/json
|
162
162
|
|
163
163
|
|
164
|
-
##
|
164
|
+
## get_submission_details
|
165
165
|
|
166
|
-
> <Submission>
|
166
|
+
> <Submission> get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
167
167
|
|
168
168
|
Get Submission Details
|
169
169
|
|
@@ -187,28 +187,28 @@ id = 'id_example' # String | The Submission ID (returned upon a successful POST
|
|
187
187
|
|
188
188
|
begin
|
189
189
|
# Get Submission Details
|
190
|
-
result = api_instance.
|
190
|
+
result = api_instance.get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
191
191
|
p result
|
192
192
|
rescue TCAClient::ApiError => e
|
193
|
-
puts "Error when calling SubmissionApi->
|
193
|
+
puts "Error when calling SubmissionApi->get_submission_details: #{e}"
|
194
194
|
end
|
195
195
|
```
|
196
196
|
|
197
|
-
#### Using the
|
197
|
+
#### Using the get_submission_details_with_http_info variant
|
198
198
|
|
199
199
|
This returns an Array which contains the response data, status code and headers.
|
200
200
|
|
201
|
-
> <Array(<Submission>, Integer, Hash)>
|
201
|
+
> <Array(<Submission>, Integer, Hash)> get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
202
202
|
|
203
203
|
```ruby
|
204
204
|
begin
|
205
205
|
# Get Submission Details
|
206
|
-
data, status_code, headers = api_instance.
|
206
|
+
data, status_code, headers = api_instance.get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
|
207
207
|
p status_code # => 2xx
|
208
208
|
p headers # => { ... }
|
209
209
|
p data # => <Submission>
|
210
210
|
rescue TCAClient::ApiError => e
|
211
|
-
puts "Error when calling SubmissionApi->
|
211
|
+
puts "Error when calling SubmissionApi->get_submission_details_with_http_info: #{e}"
|
212
212
|
end
|
213
213
|
```
|
214
214
|
|
@@ -183,8 +183,8 @@ module TCAClient
|
|
183
183
|
# @param id [String] The Submission ID (returned upon a successful POST to /submissions)
|
184
184
|
# @param [Hash] opts the optional parameters
|
185
185
|
# @return [Submission]
|
186
|
-
def
|
187
|
-
data, _status_code, _headers =
|
186
|
+
def get_submission_details(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
|
187
|
+
data, _status_code, _headers = get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
|
188
188
|
data
|
189
189
|
end
|
190
190
|
|
@@ -194,21 +194,21 @@ module TCAClient
|
|
194
194
|
# @param id [String] The Submission ID (returned upon a successful POST to /submissions)
|
195
195
|
# @param [Hash] opts the optional parameters
|
196
196
|
# @return [Array<(Submission, Integer, Hash)>] Submission data, response status code and response headers
|
197
|
-
def
|
197
|
+
def get_submission_details_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
|
198
198
|
if @api_client.config.debugging
|
199
|
-
@api_client.config.logger.debug 'Calling API: SubmissionApi.
|
199
|
+
@api_client.config.logger.debug 'Calling API: SubmissionApi.get_submission_details ...'
|
200
200
|
end
|
201
201
|
# verify the required parameter 'x_turnitin_integration_name' is set
|
202
202
|
if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
|
203
|
-
fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SubmissionApi.
|
203
|
+
fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SubmissionApi.get_submission_details"
|
204
204
|
end
|
205
205
|
# verify the required parameter 'x_turnitin_integration_version' is set
|
206
206
|
if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
|
207
|
-
fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.
|
207
|
+
fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SubmissionApi.get_submission_details"
|
208
208
|
end
|
209
209
|
# verify the required parameter 'id' is set
|
210
210
|
if @api_client.config.client_side_validation && id.nil?
|
211
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.
|
211
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling SubmissionApi.get_submission_details"
|
212
212
|
end
|
213
213
|
# resource path
|
214
214
|
local_var_path = '/submissions/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
@@ -236,7 +236,7 @@ module TCAClient
|
|
236
236
|
auth_names = opts[:debug_auth_names] || ['api_key']
|
237
237
|
|
238
238
|
new_options = opts.merge(
|
239
|
-
:operation => :"SubmissionApi.
|
239
|
+
:operation => :"SubmissionApi.get_submission_details",
|
240
240
|
:header_params => header_params,
|
241
241
|
:query_params => query_params,
|
242
242
|
:form_params => form_params,
|
@@ -247,7 +247,7 @@ module TCAClient
|
|
247
247
|
|
248
248
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
249
249
|
if @api_client.config.debugging
|
250
|
-
@api_client.config.logger.debug "API called: SubmissionApi#
|
250
|
+
@api_client.config.logger.debug "API called: SubmissionApi#get_submission_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
251
251
|
end
|
252
252
|
return data, status_code, headers
|
253
253
|
end
|
@@ -28,6 +28,8 @@ module TCAClient
|
|
28
28
|
# template
|
29
29
|
attr_accessor :template
|
30
30
|
|
31
|
+
attr_accessor :error_code
|
32
|
+
|
31
33
|
class EnumAttributeValidator
|
32
34
|
attr_reader :datatype
|
33
35
|
attr_reader :allowable_values
|
@@ -56,7 +58,8 @@ module TCAClient
|
|
56
58
|
:'id' => :'id',
|
57
59
|
:'title' => :'title',
|
58
60
|
:'status' => :'status',
|
59
|
-
:'template' => :'template'
|
61
|
+
:'template' => :'template',
|
62
|
+
:'error_code' => :'error_code'
|
60
63
|
}
|
61
64
|
end
|
62
65
|
|
@@ -71,7 +74,8 @@ module TCAClient
|
|
71
74
|
:'id' => :'String',
|
72
75
|
:'title' => :'String',
|
73
76
|
:'status' => :'String',
|
74
|
-
:'template' => :'Boolean'
|
77
|
+
:'template' => :'Boolean',
|
78
|
+
:'error_code' => :'String'
|
75
79
|
}
|
76
80
|
end
|
77
81
|
|
@@ -111,6 +115,10 @@ module TCAClient
|
|
111
115
|
if attributes.key?(:'template')
|
112
116
|
self.template = attributes[:'template']
|
113
117
|
end
|
118
|
+
|
119
|
+
if attributes.key?(:'error_code')
|
120
|
+
self.template = attributes[:'error_code']
|
121
|
+
end
|
114
122
|
end
|
115
123
|
|
116
124
|
# Show invalid properties with the reasons. Usually used together with valid?
|
data/lib/tca_client/version.rb
CHANGED
@@ -58,14 +58,14 @@ describe 'SubmissionApi' do
|
|
58
58
|
end
|
59
59
|
end
|
60
60
|
|
61
|
-
# unit tests for
|
61
|
+
# unit tests for get_submission_details
|
62
62
|
# Get Submission Details
|
63
63
|
# @param x_turnitin_integration_name a human readable string representing the type of integration being used
|
64
64
|
# @param x_turnitin_integration_version the version of the integration platform being used
|
65
65
|
# @param id The Submission ID (returned upon a successful POST to /submissions)
|
66
66
|
# @param [Hash] opts the optional parameters
|
67
67
|
# @return [Submission]
|
68
|
-
describe '
|
68
|
+
describe 'get_submission_details test' do
|
69
69
|
it 'should work' do
|
70
70
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
71
|
end
|
Binary file
|
Binary file
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tca_client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenAPI-Generator
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-04-15 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -34,22 +34,22 @@ dependencies:
|
|
34
34
|
name: rspec
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
36
36
|
requirements:
|
37
|
-
- - "~>"
|
38
|
-
- !ruby/object:Gem::Version
|
39
|
-
version: '3.6'
|
40
37
|
- - ">="
|
41
38
|
- !ruby/object:Gem::Version
|
42
39
|
version: 3.6.0
|
40
|
+
- - "~>"
|
41
|
+
- !ruby/object:Gem::Version
|
42
|
+
version: '3.6'
|
43
43
|
type: :development
|
44
44
|
prerelease: false
|
45
45
|
version_requirements: !ruby/object:Gem::Requirement
|
46
46
|
requirements:
|
47
|
-
- - "~>"
|
48
|
-
- !ruby/object:Gem::Version
|
49
|
-
version: '3.6'
|
50
47
|
- - ">="
|
51
48
|
- !ruby/object:Gem::Version
|
52
49
|
version: 3.6.0
|
50
|
+
- - "~>"
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: '3.6'
|
53
53
|
description: 'Turnitin Core API (TCA) provides direct API access to the core functionality
|
54
54
|
provided by Turnitin. TCA supports file submission, similarity report generation,
|
55
55
|
group management, and visualization of report matches via Cloud Viewer or PDF download.
|
@@ -284,12 +284,14 @@ files:
|
|
284
284
|
- spec/models/webhook_with_secret_spec.rb
|
285
285
|
- spec/spec_helper.rb
|
286
286
|
- tca_client-1.0.0.gem
|
287
|
+
- tca_client-1.0.1.gem
|
288
|
+
- tca_client-1.0.2.gem
|
287
289
|
- tca_client.gemspec
|
288
290
|
homepage: https://openapi-generator.tech
|
289
291
|
licenses:
|
290
292
|
- Unlicense
|
291
293
|
metadata: {}
|
292
|
-
post_install_message:
|
294
|
+
post_install_message:
|
293
295
|
rdoc_options: []
|
294
296
|
require_paths:
|
295
297
|
- lib
|
@@ -304,8 +306,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
304
306
|
- !ruby/object:Gem::Version
|
305
307
|
version: '0'
|
306
308
|
requirements: []
|
307
|
-
rubygems_version: 3.3.
|
308
|
-
signing_key:
|
309
|
+
rubygems_version: 3.0.3.1
|
310
|
+
signing_key:
|
309
311
|
specification_version: 4
|
310
312
|
summary: Turnitin Core API Ruby Gem
|
311
313
|
test_files:
|