tca_client 1.0.0 → 1.0.2

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.
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
@@ -1,8 +1,20 @@
1
1
  # TCAClient::SubmissionSizeError
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **status** | **String** | an HTTP Response JobStatus Code | [optional]
7
- **message** | **String** | A message explaining what happened | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **status** | **String** | an HTTP Response JobStatus Code | [optional] |
8
+ | **message** | **String** | A message explaining what happened | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'tca_client'
14
+
15
+ instance = TCAClient::SubmissionSizeError.new(
16
+ status: null,
17
+ message: null
18
+ )
19
+ ```
8
20
 
@@ -1,7 +1,18 @@
1
1
  # TCAClient::SuccessMessage
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **message** | **String** | message indicating a successful PUT request | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | message indicating a successful PUT request | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'tca_client'
13
+
14
+ instance = TCAClient::SuccessMessage.new(
15
+ message: null
16
+ )
17
+ ```
7
18
 
data/docs/Users.md CHANGED
@@ -1,10 +1,24 @@
1
1
  # TCAClient::Users
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **id** | **String** | (required) | [optional]
7
- **family_name** | **String** | | [optional]
8
- **given_name** | **String** | | [optional]
9
- **email** | **String** | | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | (required) | [optional] |
8
+ | **family_name** | **String** | | [optional] |
9
+ | **given_name** | **String** | | [optional] |
10
+ | **email** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'tca_client'
16
+
17
+ instance = TCAClient::Users.new(
18
+ id: null,
19
+ family_name: null,
20
+ given_name: null,
21
+ email: null
22
+ )
23
+ ```
10
24
 
@@ -1,11 +1,26 @@
1
1
  # TCAClient::ViewerPermissions
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **may_view_submission_full_source** | **BOOLEAN** | Optional individual permission which override the default permission set. | [optional]
7
- **may_view_match_submission_info** | **BOOLEAN** | Optional individual permission which override the default permission set. | [optional]
8
- **may_view_flags_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional]
9
- **may_view_document_details_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional]
10
- **may_view_sections_exclusion_panel** | **BOOLEAN** | Optional individual permission which override the default permission set | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **may_view_submission_full_source** | **Boolean** | Optional individual permission which override the default permission set. | [optional] |
8
+ | **may_view_match_submission_info** | **Boolean** | Optional individual permission which override the default permission set. | [optional] |
9
+ | **may_view_flags_panel** | **Boolean** | Optional individual permission which override the default permission set | [optional] |
10
+ | **may_view_document_details_panel** | **Boolean** | Optional individual permission which override the default permission set | [optional] |
11
+ | **may_view_sections_exclusion_panel** | **Boolean** | Optional individual permission which override the default permission set | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'tca_client'
17
+
18
+ instance = TCAClient::ViewerPermissions.new(
19
+ may_view_submission_full_source: null,
20
+ may_view_match_submission_info: null,
21
+ may_view_flags_panel: null,
22
+ may_view_document_details_panel: null,
23
+ may_view_sections_exclusion_panel: null
24
+ )
25
+ ```
11
26
 
data/docs/Webhook.md CHANGED
@@ -1,10 +1,28 @@
1
1
  # TCAClient::Webhook
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **description** | **String** | a human readable description of the webhook | [optional]
7
- **url** | **String** | the URL to callback with events, this must be https unless (allow_insecure is true) |
8
- **allow_insecure** | **BOOLEAN** | if using an non https url, this must be set to true | [optional]
9
- **event_types** | **Array<String>** | an array of the types of callbacks that will be sent to this webhook |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | unique id of webhook | |
8
+ | **created_time** | **Time** | RFC3339 timestamp of when this Webhook was initially created. This is the time at which the POST to /webhooks was made. | [optional] |
9
+ | **description** | **String** | a human readable description of the webhook | [optional] |
10
+ | **url** | **String** | the URL to callback with events, this must be https unless (allow_insecure is true) | |
11
+ | **allow_insecure** | **Boolean** | if using an non https url, this must be set to true | [optional] |
12
+ | **event_types** | **Array<String>** | an array of the types of callbacks that will be sent to this webhook | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'tca_client'
18
+
19
+ instance = TCAClient::Webhook.new(
20
+ id: null,
21
+ created_time: null,
22
+ description: null,
23
+ url: null,
24
+ allow_insecure: null,
25
+ event_types: null
26
+ )
27
+ ```
10
28
 
@@ -0,0 +1,20 @@
1
+ # TCAClient::WebhookAllOf
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | unique id of webhook | |
8
+ | **created_time** | **Time** | RFC3339 timestamp of when this Webhook was initially created. This is the time at which the POST to /webhooks was made. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'tca_client'
14
+
15
+ instance = TCAClient::WebhookAllOf.new(
16
+ id: null,
17
+ created_time: null
18
+ )
19
+ ```
20
+
data/docs/WebhookApi.md CHANGED
@@ -1,53 +1,73 @@
1
1
  # TCAClient::WebhookApi
2
2
 
3
- All URIs are relative to *https://{tenantName}.{hostName}/api/v1*
3
+ All URIs are relative to *https://app-us.turnitin.com/api/v1*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete Webhook endpoint
8
- [**get_webhook**](WebhookApi.md#get_webhook) | **GET** /webhooks/{id} | Get Webhook endpoint info
9
- [**update_webhook**](WebhookApi.md#update_webhook) | **PATCH** /webhooks/{id} | Update Webhook endpoint info
10
- [**webhooks_get**](WebhookApi.md#webhooks_get) | **GET** /webhooks | List registered Webhook endpoints
11
- [**webhooks_post**](WebhookApi.md#webhooks_post) | **POST** /webhooks | Register a Webhook endpoint
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /webhooks/{id} | Delete Webhook endpoint |
8
+ | [**get_webhook**](WebhookApi.md#get_webhook) | **GET** /webhooks/{id} | Get Webhook endpoint info |
9
+ | [**update_webhook**](WebhookApi.md#update_webhook) | **PATCH** /webhooks/{id} | Update Webhook endpoint info |
10
+ | [**webhooks_get**](WebhookApi.md#webhooks_get) | **GET** /webhooks | List registered Webhook endpoints |
11
+ | [**webhooks_post**](WebhookApi.md#webhooks_post) | **POST** /webhooks | Register a Webhook endpoint |
12
+
13
+
14
+ ## delete_webhook
12
15
 
13
- # **delete_webhook**
14
16
  > delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
15
17
 
16
18
  Delete Webhook endpoint
17
19
 
18
- ### Example
20
+ ### Examples
21
+
19
22
  ```ruby
20
- # load the gem
23
+ require 'time'
21
24
  require 'tca_client'
22
25
  # setup authorization
23
26
  TCAClient.configure do |config|
24
27
  # Configure API key authorization: api_key
25
- config.api_key['Authorization'] = 'YOUR API KEY'
28
+ config.api_key['api_key'] = 'YOUR API KEY'
26
29
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
- #config.api_key_prefix['Authorization'] = 'Bearer'
30
+ # config.api_key_prefix['api_key'] = 'Bearer'
28
31
  end
29
32
 
30
33
  api_instance = TCAClient::WebhookApi.new
31
- x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
32
- x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
34
+ x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
35
+ x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
33
36
  id = 'id_example' # String |
34
37
 
35
-
36
38
  begin
37
- #Delete Webhook endpoint
39
+ # Delete Webhook endpoint
38
40
  api_instance.delete_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
39
41
  rescue TCAClient::ApiError => e
40
- puts "Exception when calling WebhookApi->delete_webhook: #{e}"
42
+ puts "Error when calling WebhookApi->delete_webhook: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the delete_webhook_with_http_info variant
47
+
48
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
49
+
50
+ > <Array(nil, Integer, Hash)> delete_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
51
+
52
+ ```ruby
53
+ begin
54
+ # Delete Webhook endpoint
55
+ data, status_code, headers = api_instance.delete_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => nil
59
+ rescue TCAClient::ApiError => e
60
+ puts "Error when calling WebhookApi->delete_webhook_with_http_info: #{e}"
41
61
  end
42
62
  ```
43
63
 
44
64
  ### Parameters
45
65
 
46
- Name | Type | Description | Notes
47
- ------------- | ------------- | ------------- | -------------
48
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used |
49
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used |
50
- **id** | **String**| |
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
69
+ | **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
70
+ | **id** | **String** | | |
51
71
 
52
72
  ### Return type
53
73
 
@@ -59,50 +79,68 @@ nil (empty response body)
59
79
 
60
80
  ### HTTP request headers
61
81
 
62
- - **Content-Type**: Not defined
63
- - **Accept**: application/json
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/json
64
84
 
65
85
 
86
+ ## get_webhook
66
87
 
67
- # **get_webhook**
68
- > Webhook get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
88
+ > <Webhook> get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
69
89
 
70
90
  Get Webhook endpoint info
71
91
 
72
- ### Example
92
+ ### Examples
93
+
73
94
  ```ruby
74
- # load the gem
95
+ require 'time'
75
96
  require 'tca_client'
76
97
  # setup authorization
77
98
  TCAClient.configure do |config|
78
99
  # Configure API key authorization: api_key
79
- config.api_key['Authorization'] = 'YOUR API KEY'
100
+ config.api_key['api_key'] = 'YOUR API KEY'
80
101
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
81
- #config.api_key_prefix['Authorization'] = 'Bearer'
102
+ # config.api_key_prefix['api_key'] = 'Bearer'
82
103
  end
83
104
 
84
105
  api_instance = TCAClient::WebhookApi.new
85
- x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
86
- x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
106
+ x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
107
+ x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
87
108
  id = 'id_example' # String |
88
109
 
89
-
90
110
  begin
91
- #Get Webhook endpoint info
111
+ # Get Webhook endpoint info
92
112
  result = api_instance.get_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id)
93
113
  p result
94
114
  rescue TCAClient::ApiError => e
95
- puts "Exception when calling WebhookApi->get_webhook: #{e}"
115
+ puts "Error when calling WebhookApi->get_webhook: #{e}"
116
+ end
117
+ ```
118
+
119
+ #### Using the get_webhook_with_http_info variant
120
+
121
+ This returns an Array which contains the response data, status code and headers.
122
+
123
+ > <Array(<Webhook>, Integer, Hash)> get_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
124
+
125
+ ```ruby
126
+ begin
127
+ # Get Webhook endpoint info
128
+ data, status_code, headers = api_instance.get_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id)
129
+ p status_code # => 2xx
130
+ p headers # => { ... }
131
+ p data # => <Webhook>
132
+ rescue TCAClient::ApiError => e
133
+ puts "Error when calling WebhookApi->get_webhook_with_http_info: #{e}"
96
134
  end
97
135
  ```
98
136
 
99
137
  ### Parameters
100
138
 
101
- Name | Type | Description | Notes
102
- ------------- | ------------- | ------------- | -------------
103
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used |
104
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used |
105
- **id** | **String**| |
139
+ | Name | Type | Description | Notes |
140
+ | ---- | ---- | ----------- | ----- |
141
+ | **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
142
+ | **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
143
+ | **id** | **String** | | |
106
144
 
107
145
  ### Return type
108
146
 
@@ -114,52 +152,70 @@ Name | Type | Description | Notes
114
152
 
115
153
  ### HTTP request headers
116
154
 
117
- - **Content-Type**: Not defined
118
- - **Accept**: application/json
155
+ - **Content-Type**: Not defined
156
+ - **Accept**: application/json
119
157
 
120
158
 
159
+ ## update_webhook
121
160
 
122
- # **update_webhook**
123
- > Webhook update_webhook(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
161
+ > <Webhook> update_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
124
162
 
125
163
  Update Webhook endpoint info
126
164
 
127
- ### Example
165
+ ### Examples
166
+
128
167
  ```ruby
129
- # load the gem
168
+ require 'time'
130
169
  require 'tca_client'
131
170
  # setup authorization
132
171
  TCAClient.configure do |config|
133
172
  # Configure API key authorization: api_key
134
- config.api_key['Authorization'] = 'YOUR API KEY'
173
+ config.api_key['api_key'] = 'YOUR API KEY'
135
174
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
136
- #config.api_key_prefix['Authorization'] = 'Bearer'
175
+ # config.api_key_prefix['api_key'] = 'Bearer'
137
176
  end
138
177
 
139
178
  api_instance = TCAClient::WebhookApi.new
140
- body = TCAClient::WebhookPathRequest.new # WebhookPathRequest |
141
- x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
142
- x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
179
+ x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
180
+ x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
143
181
  id = 'id_example' # String |
144
-
182
+ data = TCAClient::WebhookPathRequest.new({event_types: ['SUBMISSION_COMPLETE']}) # WebhookPathRequest |
145
183
 
146
184
  begin
147
- #Update Webhook endpoint info
148
- result = api_instance.update_webhook(bodyx_turnitin_integration_namex_turnitin_integration_versionid)
185
+ # Update Webhook endpoint info
186
+ result = api_instance.update_webhook(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
149
187
  p result
150
188
  rescue TCAClient::ApiError => e
151
- puts "Exception when calling WebhookApi->update_webhook: #{e}"
189
+ puts "Error when calling WebhookApi->update_webhook: #{e}"
190
+ end
191
+ ```
192
+
193
+ #### Using the update_webhook_with_http_info variant
194
+
195
+ This returns an Array which contains the response data, status code and headers.
196
+
197
+ > <Array(<Webhook>, Integer, Hash)> update_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
198
+
199
+ ```ruby
200
+ begin
201
+ # Update Webhook endpoint info
202
+ data, status_code, headers = api_instance.update_webhook_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data)
203
+ p status_code # => 2xx
204
+ p headers # => { ... }
205
+ p data # => <Webhook>
206
+ rescue TCAClient::ApiError => e
207
+ puts "Error when calling WebhookApi->update_webhook_with_http_info: #{e}"
152
208
  end
153
209
  ```
154
210
 
155
211
  ### Parameters
156
212
 
157
- Name | Type | Description | Notes
158
- ------------- | ------------- | ------------- | -------------
159
- **body** | [**WebhookPathRequest**](WebhookPathRequest.md)| |
160
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used |
161
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used |
162
- **id** | **String**| |
213
+ | Name | Type | Description | Notes |
214
+ | ---- | ---- | ----------- | ----- |
215
+ | **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
216
+ | **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
217
+ | **id** | **String** | | |
218
+ | **data** | [**WebhookPathRequest**](WebhookPathRequest.md) | | |
163
219
 
164
220
  ### Return type
165
221
 
@@ -171,48 +227,66 @@ Name | Type | Description | Notes
171
227
 
172
228
  ### HTTP request headers
173
229
 
174
- - **Content-Type**: application/json
175
- - **Accept**: application/json
230
+ - **Content-Type**: application/json
231
+ - **Accept**: application/json
176
232
 
177
233
 
234
+ ## webhooks_get
178
235
 
179
- # **webhooks_get**
180
- > Array&lt;Webhook&gt; webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version)
236
+ > <Array<Webhook>> webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version)
181
237
 
182
238
  List registered Webhook endpoints
183
239
 
184
- ### Example
240
+ ### Examples
241
+
185
242
  ```ruby
186
- # load the gem
243
+ require 'time'
187
244
  require 'tca_client'
188
245
  # setup authorization
189
246
  TCAClient.configure do |config|
190
247
  # Configure API key authorization: api_key
191
- config.api_key['Authorization'] = 'YOUR API KEY'
248
+ config.api_key['api_key'] = 'YOUR API KEY'
192
249
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
193
- #config.api_key_prefix['Authorization'] = 'Bearer'
250
+ # config.api_key_prefix['api_key'] = 'Bearer'
194
251
  end
195
252
 
196
253
  api_instance = TCAClient::WebhookApi.new
197
- x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
198
- x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
199
-
254
+ x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
255
+ x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
200
256
 
201
257
  begin
202
- #List registered Webhook endpoints
258
+ # List registered Webhook endpoints
203
259
  result = api_instance.webhooks_get(x_turnitin_integration_name, x_turnitin_integration_version)
204
260
  p result
205
261
  rescue TCAClient::ApiError => e
206
- puts "Exception when calling WebhookApi->webhooks_get: #{e}"
262
+ puts "Error when calling WebhookApi->webhooks_get: #{e}"
263
+ end
264
+ ```
265
+
266
+ #### Using the webhooks_get_with_http_info variant
267
+
268
+ This returns an Array which contains the response data, status code and headers.
269
+
270
+ > <Array(<Array<Webhook>>, Integer, Hash)> webhooks_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
271
+
272
+ ```ruby
273
+ begin
274
+ # List registered Webhook endpoints
275
+ data, status_code, headers = api_instance.webhooks_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version)
276
+ p status_code # => 2xx
277
+ p headers # => { ... }
278
+ p data # => <Array<Webhook>>
279
+ rescue TCAClient::ApiError => e
280
+ puts "Error when calling WebhookApi->webhooks_get_with_http_info: #{e}"
207
281
  end
208
282
  ```
209
283
 
210
284
  ### Parameters
211
285
 
212
- Name | Type | Description | Notes
213
- ------------- | ------------- | ------------- | -------------
214
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used |
215
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used |
286
+ | Name | Type | Description | Notes |
287
+ | ---- | ---- | ----------- | ----- |
288
+ | **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
289
+ | **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
216
290
 
217
291
  ### Return type
218
292
 
@@ -224,50 +298,68 @@ Name | Type | Description | Notes
224
298
 
225
299
  ### HTTP request headers
226
300
 
227
- - **Content-Type**: Not defined
228
- - **Accept**: application/json
301
+ - **Content-Type**: Not defined
302
+ - **Accept**: application/json
229
303
 
230
304
 
305
+ ## webhooks_post
231
306
 
232
- # **webhooks_post**
233
- > Webhook webhooks_post(bodyx_turnitin_integration_namex_turnitin_integration_version)
307
+ > <Webhook> webhooks_post(x_turnitin_integration_name, x_turnitin_integration_version, data)
234
308
 
235
309
  Register a Webhook endpoint
236
310
 
237
- ### Example
311
+ ### Examples
312
+
238
313
  ```ruby
239
- # load the gem
314
+ require 'time'
240
315
  require 'tca_client'
241
316
  # setup authorization
242
317
  TCAClient.configure do |config|
243
318
  # Configure API key authorization: api_key
244
- config.api_key['Authorization'] = 'YOUR API KEY'
319
+ config.api_key['api_key'] = 'YOUR API KEY'
245
320
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
246
- #config.api_key_prefix['Authorization'] = 'Bearer'
321
+ # config.api_key_prefix['api_key'] = 'Bearer'
247
322
  end
248
323
 
249
324
  api_instance = TCAClient::WebhookApi.new
250
- body = TCAClient::WebhookWithSecret.new # WebhookWithSecret |
251
- x_turnitin_integration_name = 'x_turnitin_integration_name_example' # String | a human readable string representing the type of integration being used
252
- x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
253
-
325
+ x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
326
+ x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
327
+ data = TCAClient::WebhookWithSecret.new({signing_secret: File.new('/path/to/some/file'), url: 'url_example', event_types: ['SUBMISSION_COMPLETE']}) # WebhookWithSecret |
254
328
 
255
329
  begin
256
- #Register a Webhook endpoint
257
- result = api_instance.webhooks_post(bodyx_turnitin_integration_namex_turnitin_integration_version)
330
+ # Register a Webhook endpoint
331
+ result = api_instance.webhooks_post(x_turnitin_integration_name, x_turnitin_integration_version, data)
258
332
  p result
259
333
  rescue TCAClient::ApiError => e
260
- puts "Exception when calling WebhookApi->webhooks_post: #{e}"
334
+ puts "Error when calling WebhookApi->webhooks_post: #{e}"
335
+ end
336
+ ```
337
+
338
+ #### Using the webhooks_post_with_http_info variant
339
+
340
+ This returns an Array which contains the response data, status code and headers.
341
+
342
+ > <Array(<Webhook>, Integer, Hash)> webhooks_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
343
+
344
+ ```ruby
345
+ begin
346
+ # Register a Webhook endpoint
347
+ data, status_code, headers = api_instance.webhooks_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, data)
348
+ p status_code # => 2xx
349
+ p headers # => { ... }
350
+ p data # => <Webhook>
351
+ rescue TCAClient::ApiError => e
352
+ puts "Error when calling WebhookApi->webhooks_post_with_http_info: #{e}"
261
353
  end
262
354
  ```
263
355
 
264
356
  ### Parameters
265
357
 
266
- Name | Type | Description | Notes
267
- ------------- | ------------- | ------------- | -------------
268
- **body** | [**WebhookWithSecret**](WebhookWithSecret.md)| |
269
- **x_turnitin_integration_name** | **String**| a human readable string representing the type of integration being used |
270
- **x_turnitin_integration_version** | **String**| the version of the integration platform being used |
358
+ | Name | Type | Description | Notes |
359
+ | ---- | ---- | ----------- | ----- |
360
+ | **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
361
+ | **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
362
+ | **data** | [**WebhookWithSecret**](WebhookWithSecret.md) | | |
271
363
 
272
364
  ### Return type
273
365
 
@@ -279,8 +371,6 @@ Name | Type | Description | Notes
279
371
 
280
372
  ### HTTP request headers
281
373
 
282
- - **Content-Type**: application/json
283
- - **Accept**: application/json
284
-
285
-
374
+ - **Content-Type**: application/json
375
+ - **Accept**: application/json
286
376