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,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 SimilaritySettings
|
@@ -51,12 +53,17 @@ module TCAClient
|
|
51
53
|
}
|
52
54
|
end
|
53
55
|
|
56
|
+
# Returns all the JSON keys this model knows about
|
57
|
+
def self.acceptable_attributes
|
58
|
+
attribute_map.values
|
59
|
+
end
|
60
|
+
|
54
61
|
# Attribute type mapping.
|
55
62
|
def self.openapi_types
|
56
63
|
{
|
57
|
-
:'default_mode' => :'
|
58
|
-
:'modes' => :'
|
59
|
-
:'view_settings' => :'
|
64
|
+
:'default_mode' => :'String',
|
65
|
+
:'modes' => :'SimilaritySettingsModes',
|
66
|
+
:'view_settings' => :'SimilaritySettingsViewSettings'
|
60
67
|
}
|
61
68
|
end
|
62
69
|
|
@@ -65,7 +72,7 @@ module TCAClient
|
|
65
72
|
Set.new([
|
66
73
|
])
|
67
74
|
end
|
68
|
-
|
75
|
+
|
69
76
|
# Initializes the object
|
70
77
|
# @param [Hash] attributes Model attributes in the form of hash
|
71
78
|
def initialize(attributes = {})
|
@@ -104,7 +111,7 @@ module TCAClient
|
|
104
111
|
# Check to see if the all the properties in the model are valid
|
105
112
|
# @return true if the model is valid
|
106
113
|
def valid?
|
107
|
-
default_mode_validator = EnumAttributeValidator.new('
|
114
|
+
default_mode_validator = EnumAttributeValidator.new('String', ["match_overview", "all_sources"])
|
108
115
|
return false unless default_mode_validator.valid?(@default_mode)
|
109
116
|
true
|
110
117
|
end
|
@@ -112,7 +119,7 @@ module TCAClient
|
|
112
119
|
# Custom attribute writer method checking allowed values (enum).
|
113
120
|
# @param [Object] default_mode Object to be assigned
|
114
121
|
def default_mode=(default_mode)
|
115
|
-
validator = EnumAttributeValidator.new('
|
122
|
+
validator = EnumAttributeValidator.new('String', ["match_overview", "all_sources"])
|
116
123
|
unless validator.valid?(default_mode)
|
117
124
|
fail ArgumentError, "invalid value for \"default_mode\", must be one of #{validator.allowable_values}."
|
118
125
|
end
|
@@ -153,8 +160,11 @@ module TCAClient
|
|
153
160
|
# @return [Object] Returns the model itself
|
154
161
|
def build_from_hash(attributes)
|
155
162
|
return nil unless attributes.is_a?(Hash)
|
163
|
+
attributes = attributes.transform_keys(&:to_sym)
|
156
164
|
self.class.openapi_types.each_pair do |key, type|
|
157
|
-
if
|
165
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
166
|
+
self.send("#{key}=", nil)
|
167
|
+
elsif type =~ /\AArray<(.*)>/i
|
158
168
|
# check to ensure the input is an array given that the attribute
|
159
169
|
# is documented as an array but the input is not
|
160
170
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -162,8 +172,6 @@ module TCAClient
|
|
162
172
|
end
|
163
173
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
164
174
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
165
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
166
|
-
self.send("#{key}=", nil)
|
167
175
|
end
|
168
176
|
end
|
169
177
|
|
@@ -176,8 +184,8 @@ module TCAClient
|
|
176
184
|
# @return [Object] Deserialized data
|
177
185
|
def _deserialize(type, value)
|
178
186
|
case type.to_sym
|
179
|
-
when :
|
180
|
-
|
187
|
+
when :Time
|
188
|
+
Time.parse(value)
|
181
189
|
when :Date
|
182
190
|
Date.parse(value)
|
183
191
|
when :String
|
@@ -207,7 +215,9 @@ module TCAClient
|
|
207
215
|
end
|
208
216
|
end
|
209
217
|
else # model
|
210
|
-
|
218
|
+
# models (e.g. Pet) or oneOf
|
219
|
+
klass = TCAClient.const_get(type)
|
220
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
211
221
|
end
|
212
222
|
end
|
213
223
|
|
@@ -255,5 +265,8 @@ module TCAClient
|
|
255
265
|
else
|
256
266
|
value
|
257
267
|
end
|
258
|
-
end
|
268
|
+
end
|
269
|
+
|
270
|
+
end
|
271
|
+
|
259
272
|
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 SimilaritySettingsModes
|
@@ -27,11 +29,16 @@ module TCAClient
|
|
27
29
|
}
|
28
30
|
end
|
29
31
|
|
32
|
+
# Returns all the JSON keys this model knows about
|
33
|
+
def self.acceptable_attributes
|
34
|
+
attribute_map.values
|
35
|
+
end
|
36
|
+
|
30
37
|
# Attribute type mapping.
|
31
38
|
def self.openapi_types
|
32
39
|
{
|
33
|
-
:'match_overview' => :'
|
34
|
-
:'all_sources' => :'
|
40
|
+
:'match_overview' => :'Boolean',
|
41
|
+
:'all_sources' => :'Boolean'
|
35
42
|
}
|
36
43
|
end
|
37
44
|
|
@@ -40,7 +47,7 @@ module TCAClient
|
|
40
47
|
Set.new([
|
41
48
|
])
|
42
49
|
end
|
43
|
-
|
50
|
+
|
44
51
|
# Initializes the object
|
45
52
|
# @param [Hash] attributes Model attributes in the form of hash
|
46
53
|
def initialize(attributes = {})
|
@@ -111,8 +118,11 @@ module TCAClient
|
|
111
118
|
# @return [Object] Returns the model itself
|
112
119
|
def build_from_hash(attributes)
|
113
120
|
return nil unless attributes.is_a?(Hash)
|
121
|
+
attributes = attributes.transform_keys(&:to_sym)
|
114
122
|
self.class.openapi_types.each_pair do |key, type|
|
115
|
-
if
|
123
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
124
|
+
self.send("#{key}=", nil)
|
125
|
+
elsif type =~ /\AArray<(.*)>/i
|
116
126
|
# check to ensure the input is an array given that the attribute
|
117
127
|
# is documented as an array but the input is not
|
118
128
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -120,8 +130,6 @@ module TCAClient
|
|
120
130
|
end
|
121
131
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
122
132
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
123
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
124
|
-
self.send("#{key}=", nil)
|
125
133
|
end
|
126
134
|
end
|
127
135
|
|
@@ -134,8 +142,8 @@ module TCAClient
|
|
134
142
|
# @return [Object] Deserialized data
|
135
143
|
def _deserialize(type, value)
|
136
144
|
case type.to_sym
|
137
|
-
when :
|
138
|
-
|
145
|
+
when :Time
|
146
|
+
Time.parse(value)
|
139
147
|
when :Date
|
140
148
|
Date.parse(value)
|
141
149
|
when :String
|
@@ -165,7 +173,9 @@ module TCAClient
|
|
165
173
|
end
|
166
174
|
end
|
167
175
|
else # model
|
168
|
-
|
176
|
+
# models (e.g. Pet) or oneOf
|
177
|
+
klass = TCAClient.const_get(type)
|
178
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
169
179
|
end
|
170
180
|
end
|
171
181
|
|
@@ -213,5 +223,8 @@ module TCAClient
|
|
213
223
|
else
|
214
224
|
value
|
215
225
|
end
|
216
|
-
end
|
226
|
+
end
|
227
|
+
|
228
|
+
end
|
229
|
+
|
217
230
|
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 SimilaritySettingsViewSettings
|
@@ -23,10 +25,15 @@ module TCAClient
|
|
23
25
|
}
|
24
26
|
end
|
25
27
|
|
28
|
+
# Returns all the JSON keys this model knows about
|
29
|
+
def self.acceptable_attributes
|
30
|
+
attribute_map.values
|
31
|
+
end
|
32
|
+
|
26
33
|
# Attribute type mapping.
|
27
34
|
def self.openapi_types
|
28
35
|
{
|
29
|
-
:'save_changes' => :'
|
36
|
+
:'save_changes' => :'Boolean'
|
30
37
|
}
|
31
38
|
end
|
32
39
|
|
@@ -35,7 +42,7 @@ module TCAClient
|
|
35
42
|
Set.new([
|
36
43
|
])
|
37
44
|
end
|
38
|
-
|
45
|
+
|
39
46
|
# Initializes the object
|
40
47
|
# @param [Hash] attributes Model attributes in the form of hash
|
41
48
|
def initialize(attributes = {})
|
@@ -101,8 +108,11 @@ module TCAClient
|
|
101
108
|
# @return [Object] Returns the model itself
|
102
109
|
def build_from_hash(attributes)
|
103
110
|
return nil unless attributes.is_a?(Hash)
|
111
|
+
attributes = attributes.transform_keys(&:to_sym)
|
104
112
|
self.class.openapi_types.each_pair do |key, type|
|
105
|
-
if
|
113
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
114
|
+
self.send("#{key}=", nil)
|
115
|
+
elsif type =~ /\AArray<(.*)>/i
|
106
116
|
# check to ensure the input is an array given that the attribute
|
107
117
|
# is documented as an array but the input is not
|
108
118
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -110,8 +120,6 @@ module TCAClient
|
|
110
120
|
end
|
111
121
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
112
122
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
113
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
114
|
-
self.send("#{key}=", nil)
|
115
123
|
end
|
116
124
|
end
|
117
125
|
|
@@ -124,8 +132,8 @@ module TCAClient
|
|
124
132
|
# @return [Object] Deserialized data
|
125
133
|
def _deserialize(type, value)
|
126
134
|
case type.to_sym
|
127
|
-
when :
|
128
|
-
|
135
|
+
when :Time
|
136
|
+
Time.parse(value)
|
129
137
|
when :Date
|
130
138
|
Date.parse(value)
|
131
139
|
when :String
|
@@ -155,7 +163,9 @@ module TCAClient
|
|
155
163
|
end
|
156
164
|
end
|
157
165
|
else # model
|
158
|
-
|
166
|
+
# models (e.g. Pet) or oneOf
|
167
|
+
klass = TCAClient.const_get(type)
|
168
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
159
169
|
end
|
160
170
|
end
|
161
171
|
|
@@ -203,5 +213,8 @@ module TCAClient
|
|
203
213
|
else
|
204
214
|
value
|
205
215
|
end
|
206
|
-
end
|
216
|
+
end
|
217
|
+
|
218
|
+
end
|
219
|
+
|
207
220
|
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 SimilarityViewSettings
|
@@ -71,22 +73,27 @@ module TCAClient
|
|
71
73
|
}
|
72
74
|
end
|
73
75
|
|
76
|
+
# Returns all the JSON keys this model knows about
|
77
|
+
def self.acceptable_attributes
|
78
|
+
attribute_map.values
|
79
|
+
end
|
80
|
+
|
74
81
|
# Attribute type mapping.
|
75
82
|
def self.openapi_types
|
76
83
|
{
|
77
|
-
:'exclude_quotes' => :'
|
78
|
-
:'exclude_bibliography' => :'
|
79
|
-
:'exclude_citations' => :'
|
80
|
-
:'exclude_abstract' => :'
|
81
|
-
:'exclude_methods' => :'
|
82
|
-
:'exclude_small_matches' => :'
|
83
|
-
:'exclude_internet' => :'
|
84
|
-
:'exclude_publications' => :'
|
85
|
-
:'exclude_crossref' => :'
|
86
|
-
:'exclude_crossref_posted_content' => :'
|
87
|
-
:'exclude_submitted_works' => :'
|
88
|
-
:'exclude_custom_sections' => :'
|
89
|
-
:'exclude_preprints' => :'
|
84
|
+
:'exclude_quotes' => :'Boolean',
|
85
|
+
:'exclude_bibliography' => :'Boolean',
|
86
|
+
:'exclude_citations' => :'Boolean',
|
87
|
+
:'exclude_abstract' => :'Boolean',
|
88
|
+
:'exclude_methods' => :'Boolean',
|
89
|
+
:'exclude_small_matches' => :'Integer',
|
90
|
+
:'exclude_internet' => :'Boolean',
|
91
|
+
:'exclude_publications' => :'Boolean',
|
92
|
+
:'exclude_crossref' => :'Boolean',
|
93
|
+
:'exclude_crossref_posted_content' => :'Boolean',
|
94
|
+
:'exclude_submitted_works' => :'Boolean',
|
95
|
+
:'exclude_custom_sections' => :'Boolean',
|
96
|
+
:'exclude_preprints' => :'Boolean'
|
90
97
|
}
|
91
98
|
end
|
92
99
|
|
@@ -95,7 +102,7 @@ module TCAClient
|
|
95
102
|
Set.new([
|
96
103
|
])
|
97
104
|
end
|
98
|
-
|
105
|
+
|
99
106
|
# Initializes the object
|
100
107
|
# @param [Hash] attributes Model attributes in the form of hash
|
101
108
|
def initialize(attributes = {})
|
@@ -221,8 +228,11 @@ module TCAClient
|
|
221
228
|
# @return [Object] Returns the model itself
|
222
229
|
def build_from_hash(attributes)
|
223
230
|
return nil unless attributes.is_a?(Hash)
|
231
|
+
attributes = attributes.transform_keys(&:to_sym)
|
224
232
|
self.class.openapi_types.each_pair do |key, type|
|
225
|
-
if
|
233
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
234
|
+
self.send("#{key}=", nil)
|
235
|
+
elsif type =~ /\AArray<(.*)>/i
|
226
236
|
# check to ensure the input is an array given that the attribute
|
227
237
|
# is documented as an array but the input is not
|
228
238
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -230,8 +240,6 @@ module TCAClient
|
|
230
240
|
end
|
231
241
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
232
242
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
233
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
234
|
-
self.send("#{key}=", nil)
|
235
243
|
end
|
236
244
|
end
|
237
245
|
|
@@ -244,8 +252,8 @@ module TCAClient
|
|
244
252
|
# @return [Object] Deserialized data
|
245
253
|
def _deserialize(type, value)
|
246
254
|
case type.to_sym
|
247
|
-
when :
|
248
|
-
|
255
|
+
when :Time
|
256
|
+
Time.parse(value)
|
249
257
|
when :Date
|
250
258
|
Date.parse(value)
|
251
259
|
when :String
|
@@ -275,7 +283,9 @@ module TCAClient
|
|
275
283
|
end
|
276
284
|
end
|
277
285
|
else # model
|
278
|
-
|
286
|
+
# models (e.g. Pet) or oneOf
|
287
|
+
klass = TCAClient.const_get(type)
|
288
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
279
289
|
end
|
280
290
|
end
|
281
291
|
|
@@ -323,5 +333,8 @@ module TCAClient
|
|
323
333
|
else
|
324
334
|
value
|
325
335
|
end
|
326
|
-
end
|
336
|
+
end
|
337
|
+
|
338
|
+
end
|
339
|
+
|
327
340
|
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 SimilarityViewerUrlResponse
|
@@ -23,10 +25,15 @@ module TCAClient
|
|
23
25
|
}
|
24
26
|
end
|
25
27
|
|
28
|
+
# Returns all the JSON keys this model knows about
|
29
|
+
def self.acceptable_attributes
|
30
|
+
attribute_map.values
|
31
|
+
end
|
32
|
+
|
26
33
|
# Attribute type mapping.
|
27
34
|
def self.openapi_types
|
28
35
|
{
|
29
|
-
:'viewer_url' => :'
|
36
|
+
:'viewer_url' => :'String'
|
30
37
|
}
|
31
38
|
end
|
32
39
|
|
@@ -35,7 +42,7 @@ module TCAClient
|
|
35
42
|
Set.new([
|
36
43
|
])
|
37
44
|
end
|
38
|
-
|
45
|
+
|
39
46
|
# Initializes the object
|
40
47
|
# @param [Hash] attributes Model attributes in the form of hash
|
41
48
|
def initialize(attributes = {})
|
@@ -101,8 +108,11 @@ module TCAClient
|
|
101
108
|
# @return [Object] Returns the model itself
|
102
109
|
def build_from_hash(attributes)
|
103
110
|
return nil unless attributes.is_a?(Hash)
|
111
|
+
attributes = attributes.transform_keys(&:to_sym)
|
104
112
|
self.class.openapi_types.each_pair do |key, type|
|
105
|
-
if
|
113
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
114
|
+
self.send("#{key}=", nil)
|
115
|
+
elsif type =~ /\AArray<(.*)>/i
|
106
116
|
# check to ensure the input is an array given that the attribute
|
107
117
|
# is documented as an array but the input is not
|
108
118
|
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
@@ -110,8 +120,6 @@ module TCAClient
|
|
110
120
|
end
|
111
121
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
112
122
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
113
|
-
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
114
|
-
self.send("#{key}=", nil)
|
115
123
|
end
|
116
124
|
end
|
117
125
|
|
@@ -124,8 +132,8 @@ module TCAClient
|
|
124
132
|
# @return [Object] Deserialized data
|
125
133
|
def _deserialize(type, value)
|
126
134
|
case type.to_sym
|
127
|
-
when :
|
128
|
-
|
135
|
+
when :Time
|
136
|
+
Time.parse(value)
|
129
137
|
when :Date
|
130
138
|
Date.parse(value)
|
131
139
|
when :String
|
@@ -155,7 +163,9 @@ module TCAClient
|
|
155
163
|
end
|
156
164
|
end
|
157
165
|
else # model
|
158
|
-
|
166
|
+
# models (e.g. Pet) or oneOf
|
167
|
+
klass = TCAClient.const_get(type)
|
168
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
159
169
|
end
|
160
170
|
end
|
161
171
|
|
@@ -203,5 +213,8 @@ module TCAClient
|
|
203
213
|
else
|
204
214
|
value
|
205
215
|
end
|
206
|
-
end
|
216
|
+
end
|
217
|
+
|
218
|
+
end
|
219
|
+
|
207
220
|
end
|