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
@@ -3,16 +3,24 @@
|
|
3
3
|
|
4
4
|
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.258
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.3.0-SNAPSHOT
|
7
10
|
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 3.0.35
|
10
11
|
=end
|
11
12
|
|
12
13
|
require 'date'
|
14
|
+
require 'time'
|
13
15
|
|
14
16
|
module TCAClient
|
15
17
|
class Webhook
|
18
|
+
# unique id of webhook
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
# RFC3339 timestamp of when this Webhook was initially created. This is the time at which the POST to /webhooks was made.
|
22
|
+
attr_accessor :created_time
|
23
|
+
|
16
24
|
# a human readable description of the webhook
|
17
25
|
attr_accessor :description
|
18
26
|
|
@@ -50,6 +58,8 @@ module TCAClient
|
|
50
58
|
# Attribute mapping from ruby-style variable name to JSON key.
|
51
59
|
def self.attribute_map
|
52
60
|
{
|
61
|
+
:'id' => :'id',
|
62
|
+
:'created_time' => :'created_time',
|
53
63
|
:'description' => :'description',
|
54
64
|
:'url' => :'url',
|
55
65
|
:'allow_insecure' => :'allow_insecure',
|
@@ -57,13 +67,20 @@ module TCAClient
|
|
57
67
|
}
|
58
68
|
end
|
59
69
|
|
70
|
+
# Returns all the JSON keys this model knows about
|
71
|
+
def self.acceptable_attributes
|
72
|
+
attribute_map.values
|
73
|
+
end
|
74
|
+
|
60
75
|
# Attribute type mapping.
|
61
76
|
def self.openapi_types
|
62
77
|
{
|
63
|
-
:'
|
64
|
-
:'
|
65
|
-
:'
|
66
|
-
:'
|
78
|
+
:'id' => :'String',
|
79
|
+
:'created_time' => :'Time',
|
80
|
+
:'description' => :'String',
|
81
|
+
:'url' => :'String',
|
82
|
+
:'allow_insecure' => :'Boolean',
|
83
|
+
:'event_types' => :'Array<String>'
|
67
84
|
}
|
68
85
|
end
|
69
86
|
|
@@ -72,7 +89,15 @@ module TCAClient
|
|
72
89
|
Set.new([
|
73
90
|
])
|
74
91
|
end
|
75
|
-
|
92
|
+
|
93
|
+
# List of class defined in allOf (OpenAPI v3)
|
94
|
+
def self.openapi_all_of
|
95
|
+
[
|
96
|
+
:'WebhookAllOf',
|
97
|
+
:'WebhookBase'
|
98
|
+
]
|
99
|
+
end
|
100
|
+
|
76
101
|
# Initializes the object
|
77
102
|
# @param [Hash] attributes Model attributes in the form of hash
|
78
103
|
def initialize(attributes = {})
|
@@ -88,6 +113,14 @@ module TCAClient
|
|
88
113
|
h[k.to_sym] = v
|
89
114
|
}
|
90
115
|
|
116
|
+
if attributes.key?(:'id')
|
117
|
+
self.id = attributes[:'id']
|
118
|
+
end
|
119
|
+
|
120
|
+
if attributes.key?(:'created_time')
|
121
|
+
self.created_time = attributes[:'created_time']
|
122
|
+
end
|
123
|
+
|
91
124
|
if attributes.key?(:'description')
|
92
125
|
self.description = attributes[:'description']
|
93
126
|
end
|
@@ -111,6 +144,10 @@ module TCAClient
|
|
111
144
|
# @return Array for valid properties with the reasons
|
112
145
|
def list_invalid_properties
|
113
146
|
invalid_properties = Array.new
|
147
|
+
if @id.nil?
|
148
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
149
|
+
end
|
150
|
+
|
114
151
|
if @url.nil?
|
115
152
|
invalid_properties.push('invalid value for "url", url cannot be nil.')
|
116
153
|
end
|
@@ -125,6 +162,7 @@ module TCAClient
|
|
125
162
|
# Check to see if the all the properties in the model are valid
|
126
163
|
# @return true if the model is valid
|
127
164
|
def valid?
|
165
|
+
return false if @id.nil?
|
128
166
|
return false if @url.nil?
|
129
167
|
return false if @event_types.nil?
|
130
168
|
true
|
@@ -135,6 +173,8 @@ module TCAClient
|
|
135
173
|
def ==(o)
|
136
174
|
return true if self.equal?(o)
|
137
175
|
self.class == o.class &&
|
176
|
+
id == o.id &&
|
177
|
+
created_time == o.created_time &&
|
138
178
|
description == o.description &&
|
139
179
|
url == o.url &&
|
140
180
|
allow_insecure == o.allow_insecure &&
|
@@ -150,7 +190,7 @@ module TCAClient
|
|
150
190
|
# Calculates hash code according to all attributes.
|
151
191
|
# @return [Integer] Hash code
|
152
192
|
def hash
|
153
|
-
[description, url, allow_insecure, event_types].hash
|
193
|
+
[id, created_time, description, url, allow_insecure, event_types].hash
|
154
194
|
end
|
155
195
|
|
156
196
|
# Builds the object from hash
|
@@ -165,8 +205,11 @@ module TCAClient
|
|
165
205
|
# @return [Object] Returns the model itself
|
166
206
|
def build_from_hash(attributes)
|
167
207
|
return nil unless attributes.is_a?(Hash)
|
208
|
+
attributes = attributes.transform_keys(&:to_sym)
|
168
209
|
self.class.openapi_types.each_pair do |key, type|
|
169
|
-
if
|
210
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
211
|
+
self.send("#{key}=", nil)
|
212
|
+
elsif type =~ /\AArray<(.*)>/i
|
170
213
|
# check to ensure the input is an array given that the attribute
|
171
214
|
# is documented as an array but the input is not
|
172
215
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -174,8 +217,6 @@ module TCAClient
|
|
174
217
|
end
|
175
218
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
176
219
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
177
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
178
|
-
self.send("#{key}=", nil)
|
179
220
|
end
|
180
221
|
end
|
181
222
|
|
@@ -188,8 +229,8 @@ module TCAClient
|
|
188
229
|
# @return [Object] Deserialized data
|
189
230
|
def _deserialize(type, value)
|
190
231
|
case type.to_sym
|
191
|
-
when :
|
192
|
-
|
232
|
+
when :Time
|
233
|
+
Time.parse(value)
|
193
234
|
when :Date
|
194
235
|
Date.parse(value)
|
195
236
|
when :String
|
@@ -219,7 +260,9 @@ module TCAClient
|
|
219
260
|
end
|
220
261
|
end
|
221
262
|
else # model
|
222
|
-
|
263
|
+
# models (e.g. Pet) or oneOf
|
264
|
+
klass = TCAClient.const_get(type)
|
265
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
223
266
|
end
|
224
267
|
end
|
225
268
|
|
@@ -267,5 +310,8 @@ module TCAClient
|
|
267
310
|
else
|
268
311
|
value
|
269
312
|
end
|
270
|
-
end
|
313
|
+
end
|
314
|
+
|
315
|
+
end
|
316
|
+
|
271
317
|
end
|
@@ -0,0 +1,235 @@
|
|
1
|
+
=begin
|
2
|
+
#Turnitin Core API
|
3
|
+
|
4
|
+
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.258
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module TCAClient
|
17
|
+
class WebhookAllOf
|
18
|
+
# unique id of webhook
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
# RFC3339 timestamp of when this Webhook was initially created. This is the time at which the POST to /webhooks was made.
|
22
|
+
attr_accessor :created_time
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'id' => :'id',
|
28
|
+
:'created_time' => :'created_time'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Returns all the JSON keys this model knows about
|
33
|
+
def self.acceptable_attributes
|
34
|
+
attribute_map.values
|
35
|
+
end
|
36
|
+
|
37
|
+
# Attribute type mapping.
|
38
|
+
def self.openapi_types
|
39
|
+
{
|
40
|
+
:'id' => :'String',
|
41
|
+
:'created_time' => :'Time'
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# List of attributes with nullable: true
|
46
|
+
def self.openapi_nullable
|
47
|
+
Set.new([
|
48
|
+
])
|
49
|
+
end
|
50
|
+
|
51
|
+
# Initializes the object
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
53
|
+
def initialize(attributes = {})
|
54
|
+
if (!attributes.is_a?(Hash))
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `TCAClient::WebhookAllOf` initialize method"
|
56
|
+
end
|
57
|
+
|
58
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
60
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
61
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `TCAClient::WebhookAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
62
|
+
end
|
63
|
+
h[k.to_sym] = v
|
64
|
+
}
|
65
|
+
|
66
|
+
if attributes.key?(:'id')
|
67
|
+
self.id = attributes[:'id']
|
68
|
+
end
|
69
|
+
|
70
|
+
if attributes.key?(:'created_time')
|
71
|
+
self.created_time = attributes[:'created_time']
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
76
|
+
# @return Array for valid properties with the reasons
|
77
|
+
def list_invalid_properties
|
78
|
+
invalid_properties = Array.new
|
79
|
+
if @id.nil?
|
80
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
81
|
+
end
|
82
|
+
|
83
|
+
invalid_properties
|
84
|
+
end
|
85
|
+
|
86
|
+
# Check to see if the all the properties in the model are valid
|
87
|
+
# @return true if the model is valid
|
88
|
+
def valid?
|
89
|
+
return false if @id.nil?
|
90
|
+
true
|
91
|
+
end
|
92
|
+
|
93
|
+
# Checks equality by comparing each attribute.
|
94
|
+
# @param [Object] Object to be compared
|
95
|
+
def ==(o)
|
96
|
+
return true if self.equal?(o)
|
97
|
+
self.class == o.class &&
|
98
|
+
id == o.id &&
|
99
|
+
created_time == o.created_time
|
100
|
+
end
|
101
|
+
|
102
|
+
# @see the `==` method
|
103
|
+
# @param [Object] Object to be compared
|
104
|
+
def eql?(o)
|
105
|
+
self == o
|
106
|
+
end
|
107
|
+
|
108
|
+
# Calculates hash code according to all attributes.
|
109
|
+
# @return [Integer] Hash code
|
110
|
+
def hash
|
111
|
+
[id, created_time].hash
|
112
|
+
end
|
113
|
+
|
114
|
+
# Builds the object from hash
|
115
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
116
|
+
# @return [Object] Returns the model itself
|
117
|
+
def self.build_from_hash(attributes)
|
118
|
+
new.build_from_hash(attributes)
|
119
|
+
end
|
120
|
+
|
121
|
+
# Builds the object from hash
|
122
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
123
|
+
# @return [Object] Returns the model itself
|
124
|
+
def build_from_hash(attributes)
|
125
|
+
return nil unless attributes.is_a?(Hash)
|
126
|
+
attributes = attributes.transform_keys(&:to_sym)
|
127
|
+
self.class.openapi_types.each_pair do |key, type|
|
128
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
129
|
+
self.send("#{key}=", nil)
|
130
|
+
elsif type =~ /\AArray<(.*)>/i
|
131
|
+
# check to ensure the input is an array given that the attribute
|
132
|
+
# is documented as an array but the input is not
|
133
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
134
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
135
|
+
end
|
136
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
137
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
138
|
+
end
|
139
|
+
end
|
140
|
+
|
141
|
+
self
|
142
|
+
end
|
143
|
+
|
144
|
+
# Deserializes the data based on type
|
145
|
+
# @param string type Data type
|
146
|
+
# @param string value Value to be deserialized
|
147
|
+
# @return [Object] Deserialized data
|
148
|
+
def _deserialize(type, value)
|
149
|
+
case type.to_sym
|
150
|
+
when :Time
|
151
|
+
Time.parse(value)
|
152
|
+
when :Date
|
153
|
+
Date.parse(value)
|
154
|
+
when :String
|
155
|
+
value.to_s
|
156
|
+
when :Integer
|
157
|
+
value.to_i
|
158
|
+
when :Float
|
159
|
+
value.to_f
|
160
|
+
when :Boolean
|
161
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
162
|
+
true
|
163
|
+
else
|
164
|
+
false
|
165
|
+
end
|
166
|
+
when :Object
|
167
|
+
# generic object (usually a Hash), return directly
|
168
|
+
value
|
169
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
170
|
+
inner_type = Regexp.last_match[:inner_type]
|
171
|
+
value.map { |v| _deserialize(inner_type, v) }
|
172
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
173
|
+
k_type = Regexp.last_match[:k_type]
|
174
|
+
v_type = Regexp.last_match[:v_type]
|
175
|
+
{}.tap do |hash|
|
176
|
+
value.each do |k, v|
|
177
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
178
|
+
end
|
179
|
+
end
|
180
|
+
else # model
|
181
|
+
# models (e.g. Pet) or oneOf
|
182
|
+
klass = TCAClient.const_get(type)
|
183
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
184
|
+
end
|
185
|
+
end
|
186
|
+
|
187
|
+
# Returns the string representation of the object
|
188
|
+
# @return [String] String presentation of the object
|
189
|
+
def to_s
|
190
|
+
to_hash.to_s
|
191
|
+
end
|
192
|
+
|
193
|
+
# to_body is an alias to to_hash (backward compatibility)
|
194
|
+
# @return [Hash] Returns the object in the form of hash
|
195
|
+
def to_body
|
196
|
+
to_hash
|
197
|
+
end
|
198
|
+
|
199
|
+
# Returns the object in the form of hash
|
200
|
+
# @return [Hash] Returns the object in the form of hash
|
201
|
+
def to_hash
|
202
|
+
hash = {}
|
203
|
+
self.class.attribute_map.each_pair do |attr, param|
|
204
|
+
value = self.send(attr)
|
205
|
+
if value.nil?
|
206
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
207
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
208
|
+
end
|
209
|
+
|
210
|
+
hash[param] = _to_hash(value)
|
211
|
+
end
|
212
|
+
hash
|
213
|
+
end
|
214
|
+
|
215
|
+
# Outputs non-array value in the form of hash
|
216
|
+
# For object, use to_hash. Otherwise, just return the value
|
217
|
+
# @param [Object] value Any valid value
|
218
|
+
# @return [Hash] Returns the value in the form of hash
|
219
|
+
def _to_hash(value)
|
220
|
+
if value.is_a?(Array)
|
221
|
+
value.compact.map { |v| _to_hash(v) }
|
222
|
+
elsif value.is_a?(Hash)
|
223
|
+
{}.tap do |hash|
|
224
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
225
|
+
end
|
226
|
+
elsif value.respond_to? :to_hash
|
227
|
+
value.to_hash
|
228
|
+
else
|
229
|
+
value
|
230
|
+
end
|
231
|
+
end
|
232
|
+
|
233
|
+
end
|
234
|
+
|
235
|
+
end
|
@@ -3,13 +3,15 @@
|
|
3
3
|
|
4
4
|
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.258
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.3.0-SNAPSHOT
|
7
10
|
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 3.0.35
|
10
11
|
=end
|
11
12
|
|
12
13
|
require 'date'
|
14
|
+
require 'time'
|
13
15
|
|
14
16
|
module TCAClient
|
15
17
|
class WebhookBase
|
@@ -57,13 +59,18 @@ module TCAClient
|
|
57
59
|
}
|
58
60
|
end
|
59
61
|
|
62
|
+
# Returns all the JSON keys this model knows about
|
63
|
+
def self.acceptable_attributes
|
64
|
+
attribute_map.values
|
65
|
+
end
|
66
|
+
|
60
67
|
# Attribute type mapping.
|
61
68
|
def self.openapi_types
|
62
69
|
{
|
63
|
-
:'description' => :'
|
64
|
-
:'url' => :'
|
65
|
-
:'allow_insecure' => :'
|
66
|
-
:'event_types' => :'
|
70
|
+
:'description' => :'String',
|
71
|
+
:'url' => :'String',
|
72
|
+
:'allow_insecure' => :'Boolean',
|
73
|
+
:'event_types' => :'Array<String>'
|
67
74
|
}
|
68
75
|
end
|
69
76
|
|
@@ -72,7 +79,7 @@ module TCAClient
|
|
72
79
|
Set.new([
|
73
80
|
])
|
74
81
|
end
|
75
|
-
|
82
|
+
|
76
83
|
# Initializes the object
|
77
84
|
# @param [Hash] attributes Model attributes in the form of hash
|
78
85
|
def initialize(attributes = {})
|
@@ -165,8 +172,11 @@ module TCAClient
|
|
165
172
|
# @return [Object] Returns the model itself
|
166
173
|
def build_from_hash(attributes)
|
167
174
|
return nil unless attributes.is_a?(Hash)
|
175
|
+
attributes = attributes.transform_keys(&:to_sym)
|
168
176
|
self.class.openapi_types.each_pair do |key, type|
|
169
|
-
if
|
177
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
178
|
+
self.send("#{key}=", nil)
|
179
|
+
elsif type =~ /\AArray<(.*)>/i
|
170
180
|
# check to ensure the input is an array given that the attribute
|
171
181
|
# is documented as an array but the input is not
|
172
182
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -174,8 +184,6 @@ module TCAClient
|
|
174
184
|
end
|
175
185
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
176
186
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
177
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
178
|
-
self.send("#{key}=", nil)
|
179
187
|
end
|
180
188
|
end
|
181
189
|
|
@@ -188,8 +196,8 @@ module TCAClient
|
|
188
196
|
# @return [Object] Deserialized data
|
189
197
|
def _deserialize(type, value)
|
190
198
|
case type.to_sym
|
191
|
-
when :
|
192
|
-
|
199
|
+
when :Time
|
200
|
+
Time.parse(value)
|
193
201
|
when :Date
|
194
202
|
Date.parse(value)
|
195
203
|
when :String
|
@@ -219,7 +227,9 @@ module TCAClient
|
|
219
227
|
end
|
220
228
|
end
|
221
229
|
else # model
|
222
|
-
|
230
|
+
# models (e.g. Pet) or oneOf
|
231
|
+
klass = TCAClient.const_get(type)
|
232
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
223
233
|
end
|
224
234
|
end
|
225
235
|
|
@@ -267,5 +277,8 @@ module TCAClient
|
|
267
277
|
else
|
268
278
|
value
|
269
279
|
end
|
270
|
-
end
|
280
|
+
end
|
281
|
+
|
282
|
+
end
|
283
|
+
|
271
284
|
end
|
@@ -3,13 +3,15 @@
|
|
3
3
|
|
4
4
|
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 1.0.258
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.3.0-SNAPSHOT
|
7
10
|
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 3.0.35
|
10
11
|
=end
|
11
12
|
|
12
13
|
require 'date'
|
14
|
+
require 'time'
|
13
15
|
|
14
16
|
module TCAClient
|
15
17
|
class WebhookPathRequest
|
@@ -49,11 +51,16 @@ module TCAClient
|
|
49
51
|
}
|
50
52
|
end
|
51
53
|
|
54
|
+
# Returns all the JSON keys this model knows about
|
55
|
+
def self.acceptable_attributes
|
56
|
+
attribute_map.values
|
57
|
+
end
|
58
|
+
|
52
59
|
# Attribute type mapping.
|
53
60
|
def self.openapi_types
|
54
61
|
{
|
55
|
-
:'description' => :'
|
56
|
-
:'event_types' => :'
|
62
|
+
:'description' => :'String',
|
63
|
+
:'event_types' => :'Array<String>'
|
57
64
|
}
|
58
65
|
end
|
59
66
|
|
@@ -62,7 +69,7 @@ module TCAClient
|
|
62
69
|
Set.new([
|
63
70
|
])
|
64
71
|
end
|
65
|
-
|
72
|
+
|
66
73
|
# Initializes the object
|
67
74
|
# @param [Hash] attributes Model attributes in the form of hash
|
68
75
|
def initialize(attributes = {})
|
@@ -140,8 +147,11 @@ module TCAClient
|
|
140
147
|
# @return [Object] Returns the model itself
|
141
148
|
def build_from_hash(attributes)
|
142
149
|
return nil unless attributes.is_a?(Hash)
|
150
|
+
attributes = attributes.transform_keys(&:to_sym)
|
143
151
|
self.class.openapi_types.each_pair do |key, type|
|
144
|
-
if
|
152
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
153
|
+
self.send("#{key}=", nil)
|
154
|
+
elsif type =~ /\AArray<(.*)>/i
|
145
155
|
# check to ensure the input is an array given that the attribute
|
146
156
|
# is documented as an array but the input is not
|
147
157
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -149,8 +159,6 @@ module TCAClient
|
|
149
159
|
end
|
150
160
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
151
161
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
152
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
153
|
-
self.send("#{key}=", nil)
|
154
162
|
end
|
155
163
|
end
|
156
164
|
|
@@ -163,8 +171,8 @@ module TCAClient
|
|
163
171
|
# @return [Object] Deserialized data
|
164
172
|
def _deserialize(type, value)
|
165
173
|
case type.to_sym
|
166
|
-
when :
|
167
|
-
|
174
|
+
when :Time
|
175
|
+
Time.parse(value)
|
168
176
|
when :Date
|
169
177
|
Date.parse(value)
|
170
178
|
when :String
|
@@ -194,7 +202,9 @@ module TCAClient
|
|
194
202
|
end
|
195
203
|
end
|
196
204
|
else # model
|
197
|
-
|
205
|
+
# models (e.g. Pet) or oneOf
|
206
|
+
klass = TCAClient.const_get(type)
|
207
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
198
208
|
end
|
199
209
|
end
|
200
210
|
|
@@ -242,5 +252,8 @@ module TCAClient
|
|
242
252
|
else
|
243
253
|
value
|
244
254
|
end
|
245
|
-
end
|
255
|
+
end
|
256
|
+
|
257
|
+
end
|
258
|
+
|
246
259
|
end
|