tca_client 1.0.0 → 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (148) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/docs/AddGroupAttachmentRequest.md +16 -4
  4. data/docs/AddGroupAttachmentResponse.md +14 -3
  5. data/docs/AggregateGroup.md +24 -8
  6. data/docs/AnnotationsSettings.md +18 -0
  7. data/docs/AuthorMetadataOverride.md +16 -4
  8. data/docs/EULAApi.md +166 -92
  9. data/docs/Error.md +16 -4
  10. data/docs/Eula.md +18 -5
  11. data/docs/EulaAcceptListItem.md +20 -6
  12. data/docs/EulaAcceptRequest.md +20 -6
  13. data/docs/EulaVersion.md +22 -7
  14. data/docs/FeaturesApi.md +41 -23
  15. data/docs/FeaturesEnabled.md +20 -6
  16. data/docs/FeaturesGenerationSettings.md +16 -4
  17. data/docs/FeaturesSimilarity.md +18 -5
  18. data/docs/FeaturesSimilarityViewSettings.md +38 -15
  19. data/docs/FeaturesTenant.md +14 -3
  20. data/docs/FeaturesViewerModes.md +16 -4
  21. data/docs/GenerateSimilarityPDF.md +18 -0
  22. data/docs/GetGroupAttachments200Response.md +18 -0
  23. data/docs/Group.md +18 -5
  24. data/docs/GroupAttachmentResponse.md +20 -6
  25. data/docs/GroupContext.md +18 -5
  26. data/docs/GroupsApi.md +321 -177
  27. data/docs/IndexApi.md +84 -44
  28. data/docs/IndexStateSettings.md +14 -3
  29. data/docs/IndexingSettings.md +14 -3
  30. data/docs/PDFStatusWebhookRequest.md +24 -0
  31. data/docs/PdfStatusResponse.md +14 -3
  32. data/docs/RateLimitError.md +16 -4
  33. data/docs/RequestPdfResponse.md +14 -3
  34. data/docs/Sidebar.md +14 -3
  35. data/docs/SimilarityApi.md +239 -129
  36. data/docs/SimilarityCompleteWebhookRequest.md +38 -0
  37. data/docs/SimilarityGenerationSettings.md +20 -6
  38. data/docs/SimilarityMetadata.md +32 -12
  39. data/docs/SimilarityMetadataAllOf.md +28 -0
  40. data/docs/SimilarityMetadataAllOfTopMatches.md +30 -0
  41. data/docs/SimilarityPutRequest.md +18 -5
  42. data/docs/SimilarityScoreData.md +20 -6
  43. data/docs/SimilaritySettings.md +18 -5
  44. data/docs/SimilaritySettingsModes.md +16 -4
  45. data/docs/SimilaritySettingsViewSettings.md +14 -3
  46. data/docs/SimilarityViewSettings.md +38 -15
  47. data/docs/SimilarityViewerUrlResponse.md +14 -3
  48. data/docs/SimilarityViewerUrlSettings.md +30 -10
  49. data/docs/SimpleSubmissionResponse.md +22 -2
  50. data/docs/SimpleSubmissionResponseAllOf.md +26 -0
  51. data/docs/Submission.md +34 -2
  52. data/docs/SubmissionAllOf.md +38 -0
  53. data/docs/SubmissionApi.md +203 -112
  54. data/docs/SubmissionBase.md +30 -11
  55. data/docs/SubmissionBaseMetadata.md +24 -8
  56. data/docs/SubmissionCompleteWebhookRequest.md +40 -0
  57. data/docs/SubmissionCompleteWebhookRequestAllOf.md +18 -0
  58. data/docs/SubmissionCompleteWebhookRequestAllOfMetadata.md +18 -0
  59. data/docs/SubmissionSizeError.md +16 -4
  60. data/docs/SuccessMessage.md +14 -3
  61. data/docs/Users.md +20 -6
  62. data/docs/ViewerPermissions.md +22 -7
  63. data/docs/Webhook.md +24 -6
  64. data/docs/WebhookAllOf.md +20 -0
  65. data/docs/WebhookApi.md +193 -103
  66. data/docs/WebhookBase.md +20 -6
  67. data/docs/WebhookPathRequest.md +16 -4
  68. data/docs/WebhookWithSecret.md +22 -6
  69. data/docs/WebhookWithSecretAllOf.md +18 -0
  70. data/lib/tca_client/api/eula_api.rb +96 -63
  71. data/lib/tca_client/api/features_api.rb +21 -12
  72. data/lib/tca_client/api/groups_api.rb +225 -155
  73. data/lib/tca_client/api/index_api.rb +46 -27
  74. data/lib/tca_client/api/similarity_api.rb +165 -104
  75. data/lib/tca_client/api/submission_api.rb +140 -97
  76. data/lib/tca_client/api/webhook_api.rb +120 -77
  77. data/lib/tca_client/api_client.rb +61 -57
  78. data/lib/tca_client/api_error.rb +4 -4
  79. data/lib/tca_client/configuration.rb +93 -13
  80. data/lib/tca_client/models/add_group_attachment_request.rb +50 -13
  81. data/lib/tca_client/models/add_group_attachment_response.rb +25 -12
  82. data/lib/tca_client/models/aggregate_group.rb +34 -21
  83. data/lib/tca_client/models/annotations_settings.rb +220 -0
  84. data/lib/tca_client/models/author_metadata_override.rb +26 -13
  85. data/lib/tca_client/models/error.rb +26 -13
  86. data/lib/tca_client/models/eula.rb +27 -14
  87. data/lib/tca_client/models/eula_accept_list_item.rb +28 -15
  88. data/lib/tca_client/models/eula_accept_request.rb +28 -15
  89. data/lib/tca_client/models/eula_version.rb +29 -16
  90. data/lib/tca_client/models/features_enabled.rb +28 -15
  91. data/lib/tca_client/models/features_generation_settings.rb +26 -13
  92. data/lib/tca_client/models/features_similarity.rb +27 -14
  93. data/lib/tca_client/models/features_similarity_view_settings.rb +37 -24
  94. data/lib/tca_client/models/features_tenant.rb +25 -12
  95. data/lib/tca_client/models/features_viewer_modes.rb +26 -13
  96. data/lib/tca_client/models/generate_similarity_pdf.rb +254 -0
  97. data/lib/tca_client/models/{inline_response_200.rb → get_group_attachments200_response.rb} +28 -15
  98. data/lib/tca_client/models/group.rb +29 -16
  99. data/lib/tca_client/models/group_attachment_response.rb +38 -17
  100. data/lib/tca_client/models/group_context.rb +27 -14
  101. data/lib/tca_client/models/index_state_settings.rb +25 -12
  102. data/lib/tca_client/models/indexing_settings.rb +25 -12
  103. data/lib/tca_client/models/pdf_status_response.rb +27 -14
  104. data/lib/tca_client/models/pdf_status_webhook_request.rb +283 -0
  105. data/lib/tca_client/models/rate_limit_error.rb +36 -20
  106. data/lib/tca_client/models/request_pdf_response.rb +25 -12
  107. data/lib/tca_client/models/sidebar.rb +27 -14
  108. data/lib/tca_client/models/similarity_complete_webhook_request.rb +366 -0
  109. data/lib/tca_client/models/similarity_generation_settings.rb +30 -17
  110. data/lib/tca_client/models/similarity_metadata.rb +45 -28
  111. data/lib/tca_client/models/similarity_metadata_all_of.rb +301 -0
  112. data/lib/tca_client/models/{similarity_metadata_top_matches.rb → similarity_metadata_all_of_top_matches.rb} +34 -21
  113. data/lib/tca_client/models/similarity_put_request.rb +27 -14
  114. data/lib/tca_client/models/similarity_score_data.rb +28 -15
  115. data/lib/tca_client/models/similarity_settings.rb +29 -16
  116. data/lib/tca_client/models/similarity_settings_modes.rb +26 -13
  117. data/lib/tca_client/models/similarity_settings_view_settings.rb +25 -12
  118. data/lib/tca_client/models/similarity_view_settings.rb +37 -24
  119. data/lib/tca_client/models/similarity_viewer_url_response.rb +25 -12
  120. data/lib/tca_client/models/similarity_viewer_url_settings.rb +46 -24
  121. data/lib/tca_client/models/simple_submission_response.rb +117 -13
  122. data/lib/tca_client/models/simple_submission_response_all_of.rb +294 -0
  123. data/lib/tca_client/models/submission.rb +191 -13
  124. data/lib/tca_client/models/submission_all_of.rb +368 -0
  125. data/lib/tca_client/models/submission_base.rb +82 -23
  126. data/lib/tca_client/models/submission_base_metadata.rb +30 -17
  127. data/lib/tca_client/models/submission_complete_webhook_request.rb +385 -0
  128. data/lib/tca_client/models/submission_complete_webhook_request_all_of.rb +219 -0
  129. data/lib/tca_client/models/submission_complete_webhook_request_all_of_metadata.rb +219 -0
  130. data/lib/tca_client/models/submission_size_error.rb +36 -20
  131. data/lib/tca_client/models/success_message.rb +25 -12
  132. data/lib/tca_client/models/users.rb +28 -15
  133. data/lib/tca_client/models/viewer_permissions.rb +29 -16
  134. data/lib/tca_client/models/webhook.rb +62 -16
  135. data/lib/tca_client/models/webhook_all_of.rb +235 -0
  136. data/lib/tca_client/models/webhook_base.rb +28 -15
  137. data/lib/tca_client/models/webhook_path_request.rb +26 -13
  138. data/lib/tca_client/models/webhook_with_secret.rb +52 -16
  139. data/lib/tca_client/models/webhook_with_secret_all_of.rb +225 -0
  140. data/lib/tca_client/version.rb +5 -4
  141. data/lib/tca_client.rb +18 -5
  142. data/spec/api/submission_api_spec.rb +2 -2
  143. data/tca_client-1.0.0.gem +0 -0
  144. data/tca_client-1.0.1.gem +0 -0
  145. data/tca_client.gemspec +7 -7
  146. metadata +44 -38
  147. data/docs/InlineResponse200.md +0 -7
  148. data/docs/SimilarityMetadataTopMatches.md +0 -13
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.0
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
- - Swagger-Codegen
8
- autorequire:
7
+ - OpenAPI-Generator
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-11-10 00:00:00.000000000 Z
11
+ date: 2023-04-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -31,45 +31,25 @@ dependencies:
31
31
  - !ruby/object:Gem::Version
32
32
  version: 1.0.1
33
33
  - !ruby/object:Gem::Dependency
34
- name: json
34
+ name: rspec
35
35
  requirement: !ruby/object:Gem::Requirement
36
36
  requirements:
37
- - - "~>"
38
- - !ruby/object:Gem::Version
39
- version: '2.1'
40
37
  - - ">="
41
38
  - !ruby/object:Gem::Version
42
- version: 2.1.0
43
- type: :runtime
44
- prerelease: false
45
- version_requirements: !ruby/object:Gem::Requirement
46
- requirements:
47
- - - "~>"
48
- - !ruby/object:Gem::Version
49
- version: '2.1'
50
- - - ">="
51
- - !ruby/object:Gem::Version
52
- version: 2.1.0
53
- - !ruby/object:Gem::Dependency
54
- name: rspec
55
- requirement: !ruby/object:Gem::Requirement
56
- requirements:
39
+ version: 3.6.0
57
40
  - - "~>"
58
41
  - !ruby/object:Gem::Version
59
42
  version: '3.6'
60
- - - ">="
61
- - !ruby/object:Gem::Version
62
- version: 3.6.0
63
43
  type: :development
64
44
  prerelease: false
65
45
  version_requirements: !ruby/object:Gem::Requirement
66
46
  requirements:
67
- - - "~>"
68
- - !ruby/object:Gem::Version
69
- version: '3.6'
70
47
  - - ">="
71
48
  - !ruby/object:Gem::Version
72
49
  version: 3.6.0
50
+ - - "~>"
51
+ - !ruby/object:Gem::Version
52
+ version: '3.6'
73
53
  description: 'Turnitin Core API (TCA) provides direct API access to the core functionality
74
54
  provided by Turnitin. TCA supports file submission, similarity report generation,
75
55
  group management, and visualization of report matches via Cloud Viewer or PDF download.
@@ -107,6 +87,7 @@ files:
107
87
  - docs/AddGroupAttachmentRequest.md
108
88
  - docs/AddGroupAttachmentResponse.md
109
89
  - docs/AggregateGroup.md
90
+ - docs/AnnotationsSettings.md
110
91
  - docs/AuthorMetadataOverride.md
111
92
  - docs/EULAApi.md
112
93
  - docs/Error.md
@@ -121,6 +102,8 @@ files:
121
102
  - docs/FeaturesSimilarityViewSettings.md
122
103
  - docs/FeaturesTenant.md
123
104
  - docs/FeaturesViewerModes.md
105
+ - docs/GenerateSimilarityPDF.md
106
+ - docs/GetGroupAttachments200Response.md
124
107
  - docs/Group.md
125
108
  - docs/GroupAttachmentResponse.md
126
109
  - docs/GroupContext.md
@@ -128,15 +111,17 @@ files:
128
111
  - docs/IndexApi.md
129
112
  - docs/IndexStateSettings.md
130
113
  - docs/IndexingSettings.md
131
- - docs/InlineResponse200.md
114
+ - docs/PDFStatusWebhookRequest.md
132
115
  - docs/PdfStatusResponse.md
133
116
  - docs/RateLimitError.md
134
117
  - docs/RequestPdfResponse.md
135
118
  - docs/Sidebar.md
136
119
  - docs/SimilarityApi.md
120
+ - docs/SimilarityCompleteWebhookRequest.md
137
121
  - docs/SimilarityGenerationSettings.md
138
122
  - docs/SimilarityMetadata.md
139
- - docs/SimilarityMetadataTopMatches.md
123
+ - docs/SimilarityMetadataAllOf.md
124
+ - docs/SimilarityMetadataAllOfTopMatches.md
140
125
  - docs/SimilarityPutRequest.md
141
126
  - docs/SimilarityScoreData.md
142
127
  - docs/SimilaritySettings.md
@@ -146,19 +131,26 @@ files:
146
131
  - docs/SimilarityViewerUrlResponse.md
147
132
  - docs/SimilarityViewerUrlSettings.md
148
133
  - docs/SimpleSubmissionResponse.md
134
+ - docs/SimpleSubmissionResponseAllOf.md
149
135
  - docs/Submission.md
136
+ - docs/SubmissionAllOf.md
150
137
  - docs/SubmissionApi.md
151
138
  - docs/SubmissionBase.md
152
139
  - docs/SubmissionBaseMetadata.md
140
+ - docs/SubmissionCompleteWebhookRequest.md
141
+ - docs/SubmissionCompleteWebhookRequestAllOf.md
142
+ - docs/SubmissionCompleteWebhookRequestAllOfMetadata.md
153
143
  - docs/SubmissionSizeError.md
154
144
  - docs/SuccessMessage.md
155
145
  - docs/Users.md
156
146
  - docs/ViewerPermissions.md
157
147
  - docs/Webhook.md
148
+ - docs/WebhookAllOf.md
158
149
  - docs/WebhookApi.md
159
150
  - docs/WebhookBase.md
160
151
  - docs/WebhookPathRequest.md
161
152
  - docs/WebhookWithSecret.md
153
+ - docs/WebhookWithSecretAllOf.md
162
154
  - git_push.sh
163
155
  - lib/tca_client.rb
164
156
  - lib/tca_client/api/eula_api.rb
@@ -174,6 +166,7 @@ files:
174
166
  - lib/tca_client/models/add_group_attachment_request.rb
175
167
  - lib/tca_client/models/add_group_attachment_response.rb
176
168
  - lib/tca_client/models/aggregate_group.rb
169
+ - lib/tca_client/models/annotations_settings.rb
177
170
  - lib/tca_client/models/author_metadata_override.rb
178
171
  - lib/tca_client/models/error.rb
179
172
  - lib/tca_client/models/eula.rb
@@ -186,19 +179,23 @@ files:
186
179
  - lib/tca_client/models/features_similarity_view_settings.rb
187
180
  - lib/tca_client/models/features_tenant.rb
188
181
  - lib/tca_client/models/features_viewer_modes.rb
182
+ - lib/tca_client/models/generate_similarity_pdf.rb
183
+ - lib/tca_client/models/get_group_attachments200_response.rb
189
184
  - lib/tca_client/models/group.rb
190
185
  - lib/tca_client/models/group_attachment_response.rb
191
186
  - lib/tca_client/models/group_context.rb
192
187
  - lib/tca_client/models/index_state_settings.rb
193
188
  - lib/tca_client/models/indexing_settings.rb
194
- - lib/tca_client/models/inline_response_200.rb
195
189
  - lib/tca_client/models/pdf_status_response.rb
190
+ - lib/tca_client/models/pdf_status_webhook_request.rb
196
191
  - lib/tca_client/models/rate_limit_error.rb
197
192
  - lib/tca_client/models/request_pdf_response.rb
198
193
  - lib/tca_client/models/sidebar.rb
194
+ - lib/tca_client/models/similarity_complete_webhook_request.rb
199
195
  - lib/tca_client/models/similarity_generation_settings.rb
200
196
  - lib/tca_client/models/similarity_metadata.rb
201
- - lib/tca_client/models/similarity_metadata_top_matches.rb
197
+ - lib/tca_client/models/similarity_metadata_all_of.rb
198
+ - lib/tca_client/models/similarity_metadata_all_of_top_matches.rb
202
199
  - lib/tca_client/models/similarity_put_request.rb
203
200
  - lib/tca_client/models/similarity_score_data.rb
204
201
  - lib/tca_client/models/similarity_settings.rb
@@ -208,17 +205,24 @@ files:
208
205
  - lib/tca_client/models/similarity_viewer_url_response.rb
209
206
  - lib/tca_client/models/similarity_viewer_url_settings.rb
210
207
  - lib/tca_client/models/simple_submission_response.rb
208
+ - lib/tca_client/models/simple_submission_response_all_of.rb
211
209
  - lib/tca_client/models/submission.rb
210
+ - lib/tca_client/models/submission_all_of.rb
212
211
  - lib/tca_client/models/submission_base.rb
213
212
  - lib/tca_client/models/submission_base_metadata.rb
213
+ - lib/tca_client/models/submission_complete_webhook_request.rb
214
+ - lib/tca_client/models/submission_complete_webhook_request_all_of.rb
215
+ - lib/tca_client/models/submission_complete_webhook_request_all_of_metadata.rb
214
216
  - lib/tca_client/models/submission_size_error.rb
215
217
  - lib/tca_client/models/success_message.rb
216
218
  - lib/tca_client/models/users.rb
217
219
  - lib/tca_client/models/viewer_permissions.rb
218
220
  - lib/tca_client/models/webhook.rb
221
+ - lib/tca_client/models/webhook_all_of.rb
219
222
  - lib/tca_client/models/webhook_base.rb
220
223
  - lib/tca_client/models/webhook_path_request.rb
221
224
  - lib/tca_client/models/webhook_with_secret.rb
225
+ - lib/tca_client/models/webhook_with_secret_all_of.rb
222
226
  - lib/tca_client/version.rb
223
227
  - spec/api/eula_api_spec.rb
224
228
  - spec/api/features_api_spec.rb
@@ -279,12 +283,14 @@ files:
279
283
  - spec/models/webhook_spec.rb
280
284
  - spec/models/webhook_with_secret_spec.rb
281
285
  - spec/spec_helper.rb
286
+ - tca_client-1.0.0.gem
287
+ - tca_client-1.0.1.gem
282
288
  - tca_client.gemspec
283
- homepage: https://github.com/swagger-api/swagger-codegen
289
+ homepage: https://openapi-generator.tech
284
290
  licenses:
285
291
  - Unlicense
286
292
  metadata: {}
287
- post_install_message:
293
+ post_install_message:
288
294
  rdoc_options: []
289
295
  require_paths:
290
296
  - lib
@@ -292,15 +298,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
292
298
  requirements:
293
299
  - - ">="
294
300
  - !ruby/object:Gem::Version
295
- version: '1.9'
301
+ version: '2.7'
296
302
  required_rubygems_version: !ruby/object:Gem::Requirement
297
303
  requirements:
298
304
  - - ">="
299
305
  - !ruby/object:Gem::Version
300
306
  version: '0'
301
307
  requirements: []
302
- rubygems_version: 3.3.7
303
- signing_key:
308
+ rubygems_version: 3.0.3.1
309
+ signing_key:
304
310
  specification_version: 4
305
311
  summary: Turnitin Core API Ruby Gem
306
312
  test_files:
data/docs/InlineResponse200.md DELETED
@@ -1,7 +0,0 @@
1
- # TCAClient::InlineResponse200
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **attachments** | [**Array<GroupAttachmentResponse>**](GroupAttachmentResponse.md) | | [optional]
7
-
data/docs/SimilarityMetadataTopMatches.md DELETED
@@ -1,13 +0,0 @@
1
- # TCAClient::SimilarityMetadataTopMatches
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **name** | **String** | Source name | [optional]
7
- **percentage** | [**BigDecimal**](BigDecimal.md) | Match percentage | [optional]
8
- **submission_id** | **String** | Matching submission id | [optional]
9
- **source_type** | **String** | Matching submission source type (INTERNET, PUBLICATION, SUBMITTED_WORK) | [optional]
10
- **matched_word_count_total** | [**BigDecimal**](BigDecimal.md) | number of matching words | [optional]
11
- **submitted_date** | **String** | date match was submitted | [optional]
12
- **institution_name** | **String** | intitution name for matched SUBMITTED_WORK types | [optional]
13
-