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.
- checksums.yaml +4 -4
- data/README.md +3 -3
- 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 +203 -112
- 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 +140 -97
- 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 +38 -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/spec/api/submission_api_spec.rb +2 -2
- data/tca_client-1.0.0.gem +0 -0
- data/tca_client-1.0.1.gem +0 -0
- data/tca_client.gemspec +7 -7
- metadata +44 -38
- data/docs/InlineResponse200.md +0 -7
- data/docs/SimilarityMetadataTopMatches.md +0 -13
data/docs/GroupsApi.md
CHANGED
|
@@ -1,59 +1,79 @@
|
|
|
1
1
|
# TCAClient::GroupsApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to *https://
|
|
4
|
-
|
|
5
|
-
Method | HTTP request | Description
|
|
6
|
-
|
|
7
|
-
[**add_group_attachment**](GroupsApi.md#add_group_attachment) | **POST** /groups/{group_id}/attachments | Add attachment to a group. will create a group if it does not exist.
|
|
8
|
-
[**delete_group_attachment**](GroupsApi.md#delete_group_attachment) | **DELETE** /groups/{group_id}/attachments/{attach_id} | Hard delete group attachment
|
|
9
|
-
[**get_group**](GroupsApi.md#get_group) | **GET** /groups/{group_id} | Get group, group context and group context owners info
|
|
10
|
-
[**get_group_attachment**](GroupsApi.md#get_group_attachment) | **GET** /groups/{group_id}/attachments/{attach_id} | Get group attachment
|
|
11
|
-
[**get_group_attachments**](GroupsApi.md#get_group_attachments) | **GET** /groups/{group_id}/attachments | Get all attachments
|
|
12
|
-
[**groups_group_id_put**](GroupsApi.md#groups_group_id_put) | **PUT** /groups/{group_id} | upsert group, group context and group context owners info
|
|
13
|
-
[**update_group_attachment**](GroupsApi.md#update_group_attachment) | **PATCH** /groups/{group_id}/attachments/{attach_id} | Patch a group attachment
|
|
14
|
-
[**upload_group_attachment**](GroupsApi.md#upload_group_attachment) | **PUT** /groups/{group_id}/attachments/{attach_id}/original | Upload Submitted File
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
3
|
+
All URIs are relative to *https://app-us.turnitin.com/api/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_group_attachment**](GroupsApi.md#add_group_attachment) | **POST** /groups/{group_id}/attachments | Add attachment to a group. will create a group if it does not exist. |
|
|
8
|
+
| [**delete_group_attachment**](GroupsApi.md#delete_group_attachment) | **DELETE** /groups/{group_id}/attachments/{attach_id} | Hard delete group attachment |
|
|
9
|
+
| [**get_group**](GroupsApi.md#get_group) | **GET** /groups/{group_id} | Get group, group context and group context owners info |
|
|
10
|
+
| [**get_group_attachment**](GroupsApi.md#get_group_attachment) | **GET** /groups/{group_id}/attachments/{attach_id} | Get group attachment |
|
|
11
|
+
| [**get_group_attachments**](GroupsApi.md#get_group_attachments) | **GET** /groups/{group_id}/attachments | Get all attachments |
|
|
12
|
+
| [**groups_group_id_put**](GroupsApi.md#groups_group_id_put) | **PUT** /groups/{group_id} | upsert group, group context and group context owners info |
|
|
13
|
+
| [**update_group_attachment**](GroupsApi.md#update_group_attachment) | **PATCH** /groups/{group_id}/attachments/{attach_id} | Patch a group attachment |
|
|
14
|
+
| [**upload_group_attachment**](GroupsApi.md#upload_group_attachment) | **PUT** /groups/{group_id}/attachments/{attach_id}/original | Upload Submitted File |
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## add_group_attachment
|
|
18
|
+
|
|
19
|
+
> <AddGroupAttachmentResponse> add_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
18
20
|
|
|
19
21
|
Add attachment to a group. will create a group if it does not exist.
|
|
20
22
|
|
|
21
|
-
###
|
|
23
|
+
### Examples
|
|
24
|
+
|
|
22
25
|
```ruby
|
|
23
|
-
|
|
26
|
+
require 'time'
|
|
24
27
|
require 'tca_client'
|
|
25
28
|
# setup authorization
|
|
26
29
|
TCAClient.configure do |config|
|
|
27
30
|
# Configure API key authorization: api_key
|
|
28
|
-
config.api_key['
|
|
31
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
29
32
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
30
|
-
#config.api_key_prefix['
|
|
33
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
31
34
|
end
|
|
32
35
|
|
|
33
36
|
api_instance = TCAClient::GroupsApi.new
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
|
37
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
38
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
37
39
|
group_id = 'group_id_example' # String | group_id
|
|
38
|
-
|
|
40
|
+
data = TCAClient::AddGroupAttachmentRequest.new # AddGroupAttachmentRequest |
|
|
39
41
|
|
|
40
42
|
begin
|
|
41
|
-
#Add attachment to a group. will create a group if it does not exist.
|
|
42
|
-
result = api_instance.add_group_attachment(
|
|
43
|
+
# Add attachment to a group. will create a group if it does not exist.
|
|
44
|
+
result = api_instance.add_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
43
45
|
p result
|
|
44
46
|
rescue TCAClient::ApiError => e
|
|
45
|
-
puts "
|
|
47
|
+
puts "Error when calling GroupsApi->add_group_attachment: #{e}"
|
|
48
|
+
end
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### Using the add_group_attachment_with_http_info variant
|
|
52
|
+
|
|
53
|
+
This returns an Array which contains the response data, status code and headers.
|
|
54
|
+
|
|
55
|
+
> <Array(<AddGroupAttachmentResponse>, Integer, Hash)> add_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
56
|
+
|
|
57
|
+
```ruby
|
|
58
|
+
begin
|
|
59
|
+
# Add attachment to a group. will create a group if it does not exist.
|
|
60
|
+
data, status_code, headers = api_instance.add_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
61
|
+
p status_code # => 2xx
|
|
62
|
+
p headers # => { ... }
|
|
63
|
+
p data # => <AddGroupAttachmentResponse>
|
|
64
|
+
rescue TCAClient::ApiError => e
|
|
65
|
+
puts "Error when calling GroupsApi->add_group_attachment_with_http_info: #{e}"
|
|
46
66
|
end
|
|
47
67
|
```
|
|
48
68
|
|
|
49
69
|
### Parameters
|
|
50
70
|
|
|
51
|
-
Name | Type | Description
|
|
52
|
-
|
|
53
|
-
**
|
|
54
|
-
**
|
|
55
|
-
**
|
|
56
|
-
**
|
|
71
|
+
| Name | Type | Description | Notes |
|
|
72
|
+
| ---- | ---- | ----------- | ----- |
|
|
73
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
74
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
75
|
+
| **group_id** | **String** | group_id | |
|
|
76
|
+
| **data** | [**AddGroupAttachmentRequest**](AddGroupAttachmentRequest.md) | | |
|
|
57
77
|
|
|
58
78
|
### Return type
|
|
59
79
|
|
|
@@ -65,51 +85,69 @@ Name | Type | Description | Notes
|
|
|
65
85
|
|
|
66
86
|
### HTTP request headers
|
|
67
87
|
|
|
68
|
-
|
|
69
|
-
|
|
88
|
+
- **Content-Type**: application/json
|
|
89
|
+
- **Accept**: application/json
|
|
70
90
|
|
|
71
91
|
|
|
92
|
+
## delete_group_attachment
|
|
72
93
|
|
|
73
|
-
# **delete_group_attachment**
|
|
74
94
|
> delete_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
75
95
|
|
|
76
96
|
Hard delete group attachment
|
|
77
97
|
|
|
78
|
-
###
|
|
98
|
+
### Examples
|
|
99
|
+
|
|
79
100
|
```ruby
|
|
80
|
-
|
|
101
|
+
require 'time'
|
|
81
102
|
require 'tca_client'
|
|
82
103
|
# setup authorization
|
|
83
104
|
TCAClient.configure do |config|
|
|
84
105
|
# Configure API key authorization: api_key
|
|
85
|
-
config.api_key['
|
|
106
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
86
107
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
87
|
-
#config.api_key_prefix['
|
|
108
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
88
109
|
end
|
|
89
110
|
|
|
90
111
|
api_instance = TCAClient::GroupsApi.new
|
|
91
|
-
x_turnitin_integration_name = '
|
|
92
|
-
x_turnitin_integration_version = '
|
|
112
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
113
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
93
114
|
group_id = 'group_id_example' # String | group_id
|
|
94
115
|
attach_id = 'attach_id_example' # String | The attachment ID (returned from a successful group attachment request)
|
|
95
116
|
|
|
96
|
-
|
|
97
117
|
begin
|
|
98
|
-
#Hard delete group attachment
|
|
118
|
+
# Hard delete group attachment
|
|
99
119
|
api_instance.delete_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
100
120
|
rescue TCAClient::ApiError => e
|
|
101
|
-
puts "
|
|
121
|
+
puts "Error when calling GroupsApi->delete_group_attachment: #{e}"
|
|
122
|
+
end
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### Using the delete_group_attachment_with_http_info variant
|
|
126
|
+
|
|
127
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
128
|
+
|
|
129
|
+
> <Array(nil, Integer, Hash)> delete_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
130
|
+
|
|
131
|
+
```ruby
|
|
132
|
+
begin
|
|
133
|
+
# Hard delete group attachment
|
|
134
|
+
data, status_code, headers = api_instance.delete_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
135
|
+
p status_code # => 2xx
|
|
136
|
+
p headers # => { ... }
|
|
137
|
+
p data # => nil
|
|
138
|
+
rescue TCAClient::ApiError => e
|
|
139
|
+
puts "Error when calling GroupsApi->delete_group_attachment_with_http_info: #{e}"
|
|
102
140
|
end
|
|
103
141
|
```
|
|
104
142
|
|
|
105
143
|
### Parameters
|
|
106
144
|
|
|
107
|
-
Name | Type | Description
|
|
108
|
-
|
|
109
|
-
**x_turnitin_integration_name** | **String
|
|
110
|
-
**x_turnitin_integration_version** | **String
|
|
111
|
-
**group_id** | **String
|
|
112
|
-
**attach_id** | **String
|
|
145
|
+
| Name | Type | Description | Notes |
|
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
|
147
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
148
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
149
|
+
| **group_id** | **String** | group_id | |
|
|
150
|
+
| **attach_id** | **String** | The attachment ID (returned from a successful group attachment request) | |
|
|
113
151
|
|
|
114
152
|
### Return type
|
|
115
153
|
|
|
@@ -121,50 +159,68 @@ nil (empty response body)
|
|
|
121
159
|
|
|
122
160
|
### HTTP request headers
|
|
123
161
|
|
|
124
|
-
|
|
125
|
-
|
|
162
|
+
- **Content-Type**: Not defined
|
|
163
|
+
- **Accept**: application/json
|
|
126
164
|
|
|
127
165
|
|
|
166
|
+
## get_group
|
|
128
167
|
|
|
129
|
-
|
|
130
|
-
> AggregateGroup get_group(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
168
|
+
> <AggregateGroup> get_group(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
131
169
|
|
|
132
170
|
Get group, group context and group context owners info
|
|
133
171
|
|
|
134
|
-
###
|
|
172
|
+
### Examples
|
|
173
|
+
|
|
135
174
|
```ruby
|
|
136
|
-
|
|
175
|
+
require 'time'
|
|
137
176
|
require 'tca_client'
|
|
138
177
|
# setup authorization
|
|
139
178
|
TCAClient.configure do |config|
|
|
140
179
|
# Configure API key authorization: api_key
|
|
141
|
-
config.api_key['
|
|
180
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
142
181
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
143
|
-
#config.api_key_prefix['
|
|
182
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
144
183
|
end
|
|
145
184
|
|
|
146
185
|
api_instance = TCAClient::GroupsApi.new
|
|
147
|
-
x_turnitin_integration_name = '
|
|
148
|
-
x_turnitin_integration_version = '
|
|
186
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
187
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
149
188
|
group_id = 'group_id_example' # String | group_id
|
|
150
189
|
|
|
151
|
-
|
|
152
190
|
begin
|
|
153
|
-
#Get group, group context and group context owners info
|
|
191
|
+
# Get group, group context and group context owners info
|
|
154
192
|
result = api_instance.get_group(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
155
193
|
p result
|
|
156
194
|
rescue TCAClient::ApiError => e
|
|
157
|
-
puts "
|
|
195
|
+
puts "Error when calling GroupsApi->get_group: #{e}"
|
|
196
|
+
end
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
#### Using the get_group_with_http_info variant
|
|
200
|
+
|
|
201
|
+
This returns an Array which contains the response data, status code and headers.
|
|
202
|
+
|
|
203
|
+
> <Array(<AggregateGroup>, Integer, Hash)> get_group_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
204
|
+
|
|
205
|
+
```ruby
|
|
206
|
+
begin
|
|
207
|
+
# Get group, group context and group context owners info
|
|
208
|
+
data, status_code, headers = api_instance.get_group_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
209
|
+
p status_code # => 2xx
|
|
210
|
+
p headers # => { ... }
|
|
211
|
+
p data # => <AggregateGroup>
|
|
212
|
+
rescue TCAClient::ApiError => e
|
|
213
|
+
puts "Error when calling GroupsApi->get_group_with_http_info: #{e}"
|
|
158
214
|
end
|
|
159
215
|
```
|
|
160
216
|
|
|
161
217
|
### Parameters
|
|
162
218
|
|
|
163
|
-
Name | Type | Description
|
|
164
|
-
|
|
165
|
-
**x_turnitin_integration_name** | **String
|
|
166
|
-
**x_turnitin_integration_version** | **String
|
|
167
|
-
**group_id** | **String
|
|
219
|
+
| Name | Type | Description | Notes |
|
|
220
|
+
| ---- | ---- | ----------- | ----- |
|
|
221
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
222
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
223
|
+
| **group_id** | **String** | group_id | |
|
|
168
224
|
|
|
169
225
|
### Return type
|
|
170
226
|
|
|
@@ -176,52 +232,70 @@ Name | Type | Description | Notes
|
|
|
176
232
|
|
|
177
233
|
### HTTP request headers
|
|
178
234
|
|
|
179
|
-
|
|
180
|
-
|
|
235
|
+
- **Content-Type**: Not defined
|
|
236
|
+
- **Accept**: application/json
|
|
181
237
|
|
|
182
238
|
|
|
239
|
+
## get_group_attachment
|
|
183
240
|
|
|
184
|
-
|
|
185
|
-
> GroupAttachmentResponse get_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
241
|
+
> <GroupAttachmentResponse> get_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
186
242
|
|
|
187
243
|
Get group attachment
|
|
188
244
|
|
|
189
|
-
###
|
|
245
|
+
### Examples
|
|
246
|
+
|
|
190
247
|
```ruby
|
|
191
|
-
|
|
248
|
+
require 'time'
|
|
192
249
|
require 'tca_client'
|
|
193
250
|
# setup authorization
|
|
194
251
|
TCAClient.configure do |config|
|
|
195
252
|
# Configure API key authorization: api_key
|
|
196
|
-
config.api_key['
|
|
253
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
197
254
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
198
|
-
#config.api_key_prefix['
|
|
255
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
199
256
|
end
|
|
200
257
|
|
|
201
258
|
api_instance = TCAClient::GroupsApi.new
|
|
202
|
-
x_turnitin_integration_name = '
|
|
203
|
-
x_turnitin_integration_version = '
|
|
259
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
260
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
204
261
|
group_id = 'group_id_example' # String | group_id
|
|
205
262
|
attach_id = 'attach_id_example' # String | The attachment ID (returned from a successful group attachment request)
|
|
206
263
|
|
|
207
|
-
|
|
208
264
|
begin
|
|
209
|
-
#Get group attachment
|
|
265
|
+
# Get group attachment
|
|
210
266
|
result = api_instance.get_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
211
267
|
p result
|
|
212
268
|
rescue TCAClient::ApiError => e
|
|
213
|
-
puts "
|
|
269
|
+
puts "Error when calling GroupsApi->get_group_attachment: #{e}"
|
|
270
|
+
end
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
#### Using the get_group_attachment_with_http_info variant
|
|
274
|
+
|
|
275
|
+
This returns an Array which contains the response data, status code and headers.
|
|
276
|
+
|
|
277
|
+
> <Array(<GroupAttachmentResponse>, Integer, Hash)> get_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
278
|
+
|
|
279
|
+
```ruby
|
|
280
|
+
begin
|
|
281
|
+
# Get group attachment
|
|
282
|
+
data, status_code, headers = api_instance.get_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id)
|
|
283
|
+
p status_code # => 2xx
|
|
284
|
+
p headers # => { ... }
|
|
285
|
+
p data # => <GroupAttachmentResponse>
|
|
286
|
+
rescue TCAClient::ApiError => e
|
|
287
|
+
puts "Error when calling GroupsApi->get_group_attachment_with_http_info: #{e}"
|
|
214
288
|
end
|
|
215
289
|
```
|
|
216
290
|
|
|
217
291
|
### Parameters
|
|
218
292
|
|
|
219
|
-
Name | Type | Description
|
|
220
|
-
|
|
221
|
-
**x_turnitin_integration_name** | **String
|
|
222
|
-
**x_turnitin_integration_version** | **String
|
|
223
|
-
**group_id** | **String
|
|
224
|
-
**attach_id** | **String
|
|
293
|
+
| Name | Type | Description | Notes |
|
|
294
|
+
| ---- | ---- | ----------- | ----- |
|
|
295
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
296
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
297
|
+
| **group_id** | **String** | group_id | |
|
|
298
|
+
| **attach_id** | **String** | The attachment ID (returned from a successful group attachment request) | |
|
|
225
299
|
|
|
226
300
|
### Return type
|
|
227
301
|
|
|
@@ -233,54 +307,72 @@ Name | Type | Description | Notes
|
|
|
233
307
|
|
|
234
308
|
### HTTP request headers
|
|
235
309
|
|
|
236
|
-
|
|
237
|
-
|
|
310
|
+
- **Content-Type**: Not defined
|
|
311
|
+
- **Accept**: application/json
|
|
238
312
|
|
|
239
313
|
|
|
314
|
+
## get_group_attachments
|
|
240
315
|
|
|
241
|
-
|
|
242
|
-
> InlineResponse200 get_group_attachments(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
316
|
+
> <GetGroupAttachments200Response> get_group_attachments(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
243
317
|
|
|
244
318
|
Get all attachments
|
|
245
319
|
|
|
246
|
-
###
|
|
320
|
+
### Examples
|
|
321
|
+
|
|
247
322
|
```ruby
|
|
248
|
-
|
|
323
|
+
require 'time'
|
|
249
324
|
require 'tca_client'
|
|
250
325
|
# setup authorization
|
|
251
326
|
TCAClient.configure do |config|
|
|
252
327
|
# Configure API key authorization: api_key
|
|
253
|
-
config.api_key['
|
|
328
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
254
329
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
255
|
-
#config.api_key_prefix['
|
|
330
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
256
331
|
end
|
|
257
332
|
|
|
258
333
|
api_instance = TCAClient::GroupsApi.new
|
|
259
|
-
x_turnitin_integration_name = '
|
|
260
|
-
x_turnitin_integration_version = '
|
|
334
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
335
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
261
336
|
group_id = 'group_id_example' # String | group_id
|
|
262
337
|
|
|
263
|
-
|
|
264
338
|
begin
|
|
265
|
-
#Get all attachments
|
|
339
|
+
# Get all attachments
|
|
266
340
|
result = api_instance.get_group_attachments(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
267
341
|
p result
|
|
268
342
|
rescue TCAClient::ApiError => e
|
|
269
|
-
puts "
|
|
343
|
+
puts "Error when calling GroupsApi->get_group_attachments: #{e}"
|
|
344
|
+
end
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
#### Using the get_group_attachments_with_http_info variant
|
|
348
|
+
|
|
349
|
+
This returns an Array which contains the response data, status code and headers.
|
|
350
|
+
|
|
351
|
+
> <Array(<GetGroupAttachments200Response>, Integer, Hash)> get_group_attachments_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
352
|
+
|
|
353
|
+
```ruby
|
|
354
|
+
begin
|
|
355
|
+
# Get all attachments
|
|
356
|
+
data, status_code, headers = api_instance.get_group_attachments_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id)
|
|
357
|
+
p status_code # => 2xx
|
|
358
|
+
p headers # => { ... }
|
|
359
|
+
p data # => <GetGroupAttachments200Response>
|
|
360
|
+
rescue TCAClient::ApiError => e
|
|
361
|
+
puts "Error when calling GroupsApi->get_group_attachments_with_http_info: #{e}"
|
|
270
362
|
end
|
|
271
363
|
```
|
|
272
364
|
|
|
273
365
|
### Parameters
|
|
274
366
|
|
|
275
|
-
Name | Type | Description
|
|
276
|
-
|
|
277
|
-
**x_turnitin_integration_name** | **String
|
|
278
|
-
**x_turnitin_integration_version** | **String
|
|
279
|
-
**group_id** | **String
|
|
367
|
+
| Name | Type | Description | Notes |
|
|
368
|
+
| ---- | ---- | ----------- | ----- |
|
|
369
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
370
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
371
|
+
| **group_id** | **String** | group_id | |
|
|
280
372
|
|
|
281
373
|
### Return type
|
|
282
374
|
|
|
283
|
-
[**
|
|
375
|
+
[**GetGroupAttachments200Response**](GetGroupAttachments200Response.md)
|
|
284
376
|
|
|
285
377
|
### Authorization
|
|
286
378
|
|
|
@@ -288,52 +380,70 @@ Name | Type | Description | Notes
|
|
|
288
380
|
|
|
289
381
|
### HTTP request headers
|
|
290
382
|
|
|
291
|
-
|
|
292
|
-
|
|
383
|
+
- **Content-Type**: Not defined
|
|
384
|
+
- **Accept**: application/json
|
|
293
385
|
|
|
294
386
|
|
|
387
|
+
## groups_group_id_put
|
|
295
388
|
|
|
296
|
-
|
|
297
|
-
> AggregateGroup groups_group_id_put(bodyx_turnitin_integration_namex_turnitin_integration_versiongroup_id)
|
|
389
|
+
> <AggregateGroup> groups_group_id_put(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
298
390
|
|
|
299
391
|
upsert group, group context and group context owners info
|
|
300
392
|
|
|
301
|
-
###
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
302
395
|
```ruby
|
|
303
|
-
|
|
396
|
+
require 'time'
|
|
304
397
|
require 'tca_client'
|
|
305
398
|
# setup authorization
|
|
306
399
|
TCAClient.configure do |config|
|
|
307
400
|
# Configure API key authorization: api_key
|
|
308
|
-
config.api_key['
|
|
401
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
309
402
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
310
|
-
#config.api_key_prefix['
|
|
403
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
311
404
|
end
|
|
312
405
|
|
|
313
406
|
api_instance = TCAClient::GroupsApi.new
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
|
407
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
408
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
317
409
|
group_id = 'group_id_example' # String | group_id
|
|
318
|
-
|
|
410
|
+
data = TCAClient::AggregateGroup.new # AggregateGroup |
|
|
319
411
|
|
|
320
412
|
begin
|
|
321
|
-
#upsert group, group context and group context owners info
|
|
322
|
-
result = api_instance.groups_group_id_put(
|
|
413
|
+
# upsert group, group context and group context owners info
|
|
414
|
+
result = api_instance.groups_group_id_put(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
323
415
|
p result
|
|
324
416
|
rescue TCAClient::ApiError => e
|
|
325
|
-
puts "
|
|
417
|
+
puts "Error when calling GroupsApi->groups_group_id_put: #{e}"
|
|
418
|
+
end
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
#### Using the groups_group_id_put_with_http_info variant
|
|
422
|
+
|
|
423
|
+
This returns an Array which contains the response data, status code and headers.
|
|
424
|
+
|
|
425
|
+
> <Array(<AggregateGroup>, Integer, Hash)> groups_group_id_put_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
426
|
+
|
|
427
|
+
```ruby
|
|
428
|
+
begin
|
|
429
|
+
# upsert group, group context and group context owners info
|
|
430
|
+
data, status_code, headers = api_instance.groups_group_id_put_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, data)
|
|
431
|
+
p status_code # => 2xx
|
|
432
|
+
p headers # => { ... }
|
|
433
|
+
p data # => <AggregateGroup>
|
|
434
|
+
rescue TCAClient::ApiError => e
|
|
435
|
+
puts "Error when calling GroupsApi->groups_group_id_put_with_http_info: #{e}"
|
|
326
436
|
end
|
|
327
437
|
```
|
|
328
438
|
|
|
329
439
|
### Parameters
|
|
330
440
|
|
|
331
|
-
Name | Type | Description
|
|
332
|
-
|
|
333
|
-
**
|
|
334
|
-
**
|
|
335
|
-
**
|
|
336
|
-
**
|
|
441
|
+
| Name | Type | Description | Notes |
|
|
442
|
+
| ---- | ---- | ----------- | ----- |
|
|
443
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
444
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
445
|
+
| **group_id** | **String** | group_id | |
|
|
446
|
+
| **data** | [**AggregateGroup**](AggregateGroup.md) | | |
|
|
337
447
|
|
|
338
448
|
### Return type
|
|
339
449
|
|
|
@@ -345,54 +455,72 @@ Name | Type | Description | Notes
|
|
|
345
455
|
|
|
346
456
|
### HTTP request headers
|
|
347
457
|
|
|
348
|
-
|
|
349
|
-
|
|
458
|
+
- **Content-Type**: application/json
|
|
459
|
+
- **Accept**: application/json
|
|
350
460
|
|
|
351
461
|
|
|
462
|
+
## update_group_attachment
|
|
352
463
|
|
|
353
|
-
|
|
354
|
-
> GroupAttachmentResponse update_group_attachment(bodyx_turnitin_integration_namex_turnitin_integration_versiongroup_idattach_id)
|
|
464
|
+
> <GroupAttachmentResponse> update_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, data)
|
|
355
465
|
|
|
356
466
|
Patch a group attachment
|
|
357
467
|
|
|
358
|
-
###
|
|
468
|
+
### Examples
|
|
469
|
+
|
|
359
470
|
```ruby
|
|
360
|
-
|
|
471
|
+
require 'time'
|
|
361
472
|
require 'tca_client'
|
|
362
473
|
# setup authorization
|
|
363
474
|
TCAClient.configure do |config|
|
|
364
475
|
# Configure API key authorization: api_key
|
|
365
|
-
config.api_key['
|
|
476
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
366
477
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
367
|
-
#config.api_key_prefix['
|
|
478
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
368
479
|
end
|
|
369
480
|
|
|
370
481
|
api_instance = TCAClient::GroupsApi.new
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
|
482
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
483
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
374
484
|
group_id = 'group_id_example' # String | group_id
|
|
375
485
|
attach_id = 'attach_id_example' # String | The attachment ID (returned from a successful group attachment request)
|
|
376
|
-
|
|
486
|
+
data = TCAClient::AddGroupAttachmentRequest.new # AddGroupAttachmentRequest |
|
|
377
487
|
|
|
378
488
|
begin
|
|
379
|
-
#Patch a group attachment
|
|
380
|
-
result = api_instance.update_group_attachment(
|
|
489
|
+
# Patch a group attachment
|
|
490
|
+
result = api_instance.update_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, data)
|
|
381
491
|
p result
|
|
382
492
|
rescue TCAClient::ApiError => e
|
|
383
|
-
puts "
|
|
493
|
+
puts "Error when calling GroupsApi->update_group_attachment: #{e}"
|
|
494
|
+
end
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
#### Using the update_group_attachment_with_http_info variant
|
|
498
|
+
|
|
499
|
+
This returns an Array which contains the response data, status code and headers.
|
|
500
|
+
|
|
501
|
+
> <Array(<GroupAttachmentResponse>, Integer, Hash)> update_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, data)
|
|
502
|
+
|
|
503
|
+
```ruby
|
|
504
|
+
begin
|
|
505
|
+
# Patch a group attachment
|
|
506
|
+
data, status_code, headers = api_instance.update_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, data)
|
|
507
|
+
p status_code # => 2xx
|
|
508
|
+
p headers # => { ... }
|
|
509
|
+
p data # => <GroupAttachmentResponse>
|
|
510
|
+
rescue TCAClient::ApiError => e
|
|
511
|
+
puts "Error when calling GroupsApi->update_group_attachment_with_http_info: #{e}"
|
|
384
512
|
end
|
|
385
513
|
```
|
|
386
514
|
|
|
387
515
|
### Parameters
|
|
388
516
|
|
|
389
|
-
Name | Type | Description
|
|
390
|
-
|
|
391
|
-
**
|
|
392
|
-
**
|
|
393
|
-
**
|
|
394
|
-
**
|
|
395
|
-
**
|
|
517
|
+
| Name | Type | Description | Notes |
|
|
518
|
+
| ---- | ---- | ----------- | ----- |
|
|
519
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
520
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
521
|
+
| **group_id** | **String** | group_id | |
|
|
522
|
+
| **attach_id** | **String** | The attachment ID (returned from a successful group attachment request) | |
|
|
523
|
+
| **data** | [**AddGroupAttachmentRequest**](AddGroupAttachmentRequest.md) | | |
|
|
396
524
|
|
|
397
525
|
### Return type
|
|
398
526
|
|
|
@@ -404,56 +532,74 @@ Name | Type | Description | Notes
|
|
|
404
532
|
|
|
405
533
|
### HTTP request headers
|
|
406
534
|
|
|
407
|
-
|
|
408
|
-
|
|
535
|
+
- **Content-Type**: application/json
|
|
536
|
+
- **Accept**: application/json
|
|
409
537
|
|
|
410
538
|
|
|
539
|
+
## upload_group_attachment
|
|
411
540
|
|
|
412
|
-
|
|
413
|
-
> SuccessMessage upload_group_attachment(bodyx_turnitin_integration_namex_turnitin_integration_versioncontent_dispositiongroup_idattach_id)
|
|
541
|
+
> <SuccessMessage> upload_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, content_disposition, file)
|
|
414
542
|
|
|
415
543
|
Upload Submitted File
|
|
416
544
|
|
|
417
|
-
###
|
|
545
|
+
### Examples
|
|
546
|
+
|
|
418
547
|
```ruby
|
|
419
|
-
|
|
548
|
+
require 'time'
|
|
420
549
|
require 'tca_client'
|
|
421
550
|
# setup authorization
|
|
422
551
|
TCAClient.configure do |config|
|
|
423
552
|
# Configure API key authorization: api_key
|
|
424
|
-
config.api_key['
|
|
553
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
425
554
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
426
|
-
#config.api_key_prefix['
|
|
555
|
+
# config.api_key_prefix['api_key'] = 'Bearer'
|
|
427
556
|
end
|
|
428
557
|
|
|
429
558
|
api_instance = TCAClient::GroupsApi.new
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
x_turnitin_integration_version = 'x_turnitin_integration_version_example' # String | the version of the integration platform being used
|
|
433
|
-
content_disposition = 'content_disposition_example' # String | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`
|
|
559
|
+
x_turnitin_integration_name = 'myintegration' # String | a human readable string representing the type of integration being used
|
|
560
|
+
x_turnitin_integration_version = 'v1.0.2' # String | the version of the integration platform being used
|
|
434
561
|
group_id = 'group_id_example' # String | The Group ID (required to already exist)
|
|
435
562
|
attach_id = 'attach_id_example' # String | The attachment ID (returned from a successful group attachment request)
|
|
436
|
-
|
|
563
|
+
content_disposition = 'inline; filename="MyFile.docx"' # String | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"`
|
|
564
|
+
file = { ... } # Object | the attachment file
|
|
437
565
|
|
|
438
566
|
begin
|
|
439
|
-
#Upload Submitted File
|
|
440
|
-
result = api_instance.upload_group_attachment(
|
|
567
|
+
# Upload Submitted File
|
|
568
|
+
result = api_instance.upload_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, content_disposition, file)
|
|
441
569
|
p result
|
|
442
570
|
rescue TCAClient::ApiError => e
|
|
443
|
-
puts "
|
|
571
|
+
puts "Error when calling GroupsApi->upload_group_attachment: #{e}"
|
|
572
|
+
end
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
#### Using the upload_group_attachment_with_http_info variant
|
|
576
|
+
|
|
577
|
+
This returns an Array which contains the response data, status code and headers.
|
|
578
|
+
|
|
579
|
+
> <Array(<SuccessMessage>, Integer, Hash)> upload_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, content_disposition, file)
|
|
580
|
+
|
|
581
|
+
```ruby
|
|
582
|
+
begin
|
|
583
|
+
# Upload Submitted File
|
|
584
|
+
data, status_code, headers = api_instance.upload_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, content_disposition, file)
|
|
585
|
+
p status_code # => 2xx
|
|
586
|
+
p headers # => { ... }
|
|
587
|
+
p data # => <SuccessMessage>
|
|
588
|
+
rescue TCAClient::ApiError => e
|
|
589
|
+
puts "Error when calling GroupsApi->upload_group_attachment_with_http_info: #{e}"
|
|
444
590
|
end
|
|
445
591
|
```
|
|
446
592
|
|
|
447
593
|
### Parameters
|
|
448
594
|
|
|
449
|
-
Name | Type | Description
|
|
450
|
-
|
|
451
|
-
**
|
|
452
|
-
**
|
|
453
|
-
**
|
|
454
|
-
**
|
|
455
|
-
**
|
|
456
|
-
**
|
|
595
|
+
| Name | Type | Description | Notes |
|
|
596
|
+
| ---- | ---- | ----------- | ----- |
|
|
597
|
+
| **x_turnitin_integration_name** | **String** | a human readable string representing the type of integration being used | |
|
|
598
|
+
| **x_turnitin_integration_version** | **String** | the version of the integration platform being used | |
|
|
599
|
+
| **group_id** | **String** | The Group ID (required to already exist) | |
|
|
600
|
+
| **attach_id** | **String** | The attachment ID (returned from a successful group attachment request) | |
|
|
601
|
+
| **content_disposition** | **String** | *must include the \"filename\" parameter, e.g. `inline; filename=\"MyFile.docx\"` | |
|
|
602
|
+
| **file** | **Object** | the attachment file | |
|
|
457
603
|
|
|
458
604
|
### Return type
|
|
459
605
|
|
|
@@ -465,8 +611,6 @@ Name | Type | Description | Notes
|
|
|
465
611
|
|
|
466
612
|
### HTTP request headers
|
|
467
613
|
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
614
|
+
- **Content-Type**: binary/octet-stream
|
|
615
|
+
- **Accept**: application/json
|
|
472
616
|
|