files.com 1.1.93 → 1.1.95
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/action_notification_export_result.md +3 -0
- data/docs/api_key.md +8 -2
- data/docs/api_request_log.md +4 -1
- data/docs/app.md +4 -1
- data/docs/as2_incoming_message.md +3 -0
- data/docs/as2_outgoing_message.md +3 -0
- data/docs/as2_partner.md +56 -41
- data/docs/as2_station.md +4 -1
- data/docs/automation.md +21 -4
- data/docs/automation_log.md +4 -1
- data/docs/automation_run.md +3 -0
- data/docs/bandwidth_snapshot.md +4 -1
- data/docs/behavior.md +32 -25
- data/docs/bundle.md +5 -8
- data/docs/bundle_action.md +4 -0
- data/docs/bundle_download.md +3 -0
- data/docs/bundle_notification.md +4 -1
- data/docs/bundle_recipient.md +3 -0
- data/docs/bundle_registration.md +3 -0
- data/docs/clickwrap.md +4 -1
- data/docs/dns_record.md +4 -1
- data/docs/email_incoming_message.md +4 -1
- data/docs/email_log.md +4 -1
- data/docs/exavault_api_request_log.md +4 -1
- data/docs/external_event.md +4 -1
- data/docs/file_comment.md +4 -1
- data/docs/file_migration.md +1 -1
- data/docs/file_migration_log.md +4 -1
- data/docs/folder.md +2 -0
- data/docs/form_field_set.md +4 -1
- data/docs/ftp_action_log.md +4 -1
- data/docs/gpg_key.md +4 -1
- data/docs/group.md +4 -1
- data/docs/group_user.md +3 -0
- data/docs/history.md +25 -5
- data/docs/history_export_result.md +4 -0
- data/docs/inbox_recipient.md +3 -0
- data/docs/inbox_registration.md +3 -0
- data/docs/inbox_upload.md +3 -0
- data/docs/invoice.md +4 -1
- data/docs/ip_address.md +16 -4
- data/docs/lock.md +6 -3
- data/docs/message.md +3 -0
- data/docs/message_comment.md +3 -0
- data/docs/message_comment_reaction.md +3 -0
- data/docs/message_reaction.md +3 -0
- data/docs/notification.md +4 -1
- data/docs/outbound_connection_log.md +56 -0
- data/docs/payment.md +4 -1
- data/docs/permission.md +3 -0
- data/docs/priority.md +4 -1
- data/docs/project.md +4 -1
- data/docs/public_hosting_request_log.md +4 -1
- data/docs/public_key.md +4 -1
- data/docs/remote_bandwidth_snapshot.md +4 -1
- data/docs/remote_server.md +4 -1
- data/docs/request.md +6 -0
- data/docs/settings_change.md +4 -1
- data/docs/sftp_action_log.md +4 -1
- data/docs/sftp_host_key.md +4 -1
- data/docs/share_group.md +4 -1
- data/docs/snapshot.md +4 -1
- data/docs/sso_strategy.md +5 -2
- data/docs/sync_log.md +4 -1
- data/docs/usage_daily_snapshot.md +4 -1
- data/docs/usage_snapshot.md +4 -1
- data/docs/user.md +8 -5
- data/docs/user_cipher_use.md +4 -1
- data/docs/user_request.md +4 -1
- data/docs/web_dav_action_log.md +4 -1
- data/lib/files.com/models/action_notification_export_result.rb +4 -0
- data/lib/files.com/models/api_key.rb +15 -0
- data/lib/files.com/models/api_request_log.rb +4 -0
- data/lib/files.com/models/app.rb +4 -0
- data/lib/files.com/models/as2_incoming_message.rb +4 -0
- data/lib/files.com/models/as2_outgoing_message.rb +4 -0
- data/lib/files.com/models/as2_partner.rb +68 -34
- data/lib/files.com/models/as2_station.rb +4 -0
- data/lib/files.com/models/automation.rb +25 -4
- data/lib/files.com/models/automation_log.rb +4 -0
- data/lib/files.com/models/automation_run.rb +4 -0
- data/lib/files.com/models/bandwidth_snapshot.rb +4 -0
- data/lib/files.com/models/behavior.rb +32 -25
- data/lib/files.com/models/bundle.rb +5 -4
- data/lib/files.com/models/bundle_action.rb +4 -0
- data/lib/files.com/models/bundle_download.rb +4 -0
- data/lib/files.com/models/bundle_notification.rb +4 -0
- data/lib/files.com/models/bundle_recipient.rb +4 -0
- data/lib/files.com/models/bundle_registration.rb +4 -0
- data/lib/files.com/models/clickwrap.rb +4 -0
- data/lib/files.com/models/dns_record.rb +4 -0
- data/lib/files.com/models/email_incoming_message.rb +4 -0
- data/lib/files.com/models/email_log.rb +4 -0
- data/lib/files.com/models/exavault_api_request_log.rb +4 -0
- data/lib/files.com/models/external_event.rb +4 -0
- data/lib/files.com/models/file_comment.rb +4 -0
- data/lib/files.com/models/file_migration.rb +1 -1
- data/lib/files.com/models/file_migration_log.rb +4 -0
- data/lib/files.com/models/folder.rb +2 -0
- data/lib/files.com/models/form_field_set.rb +4 -0
- data/lib/files.com/models/ftp_action_log.rb +4 -0
- data/lib/files.com/models/gpg_key.rb +4 -0
- data/lib/files.com/models/group.rb +4 -0
- data/lib/files.com/models/group_user.rb +4 -0
- data/lib/files.com/models/history.rb +20 -0
- data/lib/files.com/models/history_export_result.rb +4 -0
- data/lib/files.com/models/inbox_recipient.rb +4 -0
- data/lib/files.com/models/inbox_registration.rb +4 -0
- data/lib/files.com/models/inbox_upload.rb +4 -0
- data/lib/files.com/models/invoice.rb +4 -0
- data/lib/files.com/models/ip_address.rb +16 -0
- data/lib/files.com/models/lock.rb +7 -3
- data/lib/files.com/models/message.rb +4 -0
- data/lib/files.com/models/message_comment.rb +4 -0
- data/lib/files.com/models/message_comment_reaction.rb +4 -0
- data/lib/files.com/models/message_reaction.rb +4 -0
- data/lib/files.com/models/notification.rb +5 -1
- data/lib/files.com/models/outbound_connection_log.rb +101 -0
- data/lib/files.com/models/payment.rb +4 -0
- data/lib/files.com/models/permission.rb +4 -0
- data/lib/files.com/models/priority.rb +4 -0
- data/lib/files.com/models/project.rb +4 -0
- data/lib/files.com/models/public_hosting_request_log.rb +4 -0
- data/lib/files.com/models/public_key.rb +4 -0
- data/lib/files.com/models/remote_bandwidth_snapshot.rb +4 -0
- data/lib/files.com/models/remote_server.rb +4 -0
- data/lib/files.com/models/request.rb +8 -0
- data/lib/files.com/models/settings_change.rb +4 -0
- data/lib/files.com/models/sftp_action_log.rb +4 -0
- data/lib/files.com/models/sftp_host_key.rb +4 -0
- data/lib/files.com/models/share_group.rb +4 -0
- data/lib/files.com/models/snapshot.rb +4 -0
- data/lib/files.com/models/sso_strategy.rb +5 -1
- data/lib/files.com/models/sync_log.rb +4 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +4 -0
- data/lib/files.com/models/usage_snapshot.rb +4 -0
- data/lib/files.com/models/user.rb +8 -4
- data/lib/files.com/models/user_cipher_use.rb +4 -0
- data/lib/files.com/models/user_request.rb +4 -0
- data/lib/files.com/models/web_dav_action_log.rb +4 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +4 -2
@@ -9,7 +9,7 @@ module Files
|
|
9
9
|
@options = options || {}
|
10
10
|
end
|
11
11
|
|
12
|
-
# int64 -
|
12
|
+
# int64 - ID of the AS2 Partner.
|
13
13
|
def id
|
14
14
|
@attributes[:id]
|
15
15
|
end
|
@@ -18,7 +18,7 @@ module Files
|
|
18
18
|
@attributes[:id] = value
|
19
19
|
end
|
20
20
|
|
21
|
-
# int64 -
|
21
|
+
# int64 - ID of the AS2 Station associated with this partner.
|
22
22
|
def as2_station_id
|
23
23
|
@attributes[:as2_station_id]
|
24
24
|
end
|
@@ -36,7 +36,7 @@ module Files
|
|
36
36
|
@attributes[:name] = value
|
37
37
|
end
|
38
38
|
|
39
|
-
# string - Public URI
|
39
|
+
# string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
|
40
40
|
def uri
|
41
41
|
@attributes[:uri]
|
42
42
|
end
|
@@ -45,7 +45,7 @@ module Files
|
|
45
45
|
@attributes[:uri] = value
|
46
46
|
end
|
47
47
|
|
48
|
-
# string -
|
48
|
+
# string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?
|
49
49
|
def server_certificate
|
50
50
|
@attributes[:server_certificate]
|
51
51
|
end
|
@@ -54,7 +54,16 @@ module Files
|
|
54
54
|
@attributes[:server_certificate] = value
|
55
55
|
end
|
56
56
|
|
57
|
-
# string -
|
57
|
+
# string - Username to send to server for HTTP Authentication.
|
58
|
+
def http_auth_username
|
59
|
+
@attributes[:http_auth_username]
|
60
|
+
end
|
61
|
+
|
62
|
+
def http_auth_username=(value)
|
63
|
+
@attributes[:http_auth_username] = value
|
64
|
+
end
|
65
|
+
|
66
|
+
# string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
|
58
67
|
def mdn_validation_level
|
59
68
|
@attributes[:mdn_validation_level]
|
60
69
|
end
|
@@ -63,7 +72,7 @@ module Files
|
|
63
72
|
@attributes[:mdn_validation_level] = value
|
64
73
|
end
|
65
74
|
|
66
|
-
# boolean - `true
|
75
|
+
# boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 PArtner.
|
67
76
|
def enable_dedicated_ips
|
68
77
|
@attributes[:enable_dedicated_ips]
|
69
78
|
end
|
@@ -135,7 +144,16 @@ module Files
|
|
135
144
|
@attributes[:public_certificate_not_after] = value
|
136
145
|
end
|
137
146
|
|
138
|
-
# string
|
147
|
+
# string - Password to send to server for HTTP Authentication.
|
148
|
+
def http_auth_password
|
149
|
+
@attributes[:http_auth_password]
|
150
|
+
end
|
151
|
+
|
152
|
+
def http_auth_password=(value)
|
153
|
+
@attributes[:http_auth_password] = value
|
154
|
+
end
|
155
|
+
|
156
|
+
# string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
|
139
157
|
def public_certificate
|
140
158
|
@attributes[:public_certificate]
|
141
159
|
end
|
@@ -145,21 +163,25 @@ module Files
|
|
145
163
|
end
|
146
164
|
|
147
165
|
# Parameters:
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
# mdn_validation_level - string - MDN
|
152
|
-
#
|
153
|
-
#
|
166
|
+
# enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 PArtner.
|
167
|
+
# http_auth_username - string - Username to send to server for HTTP Authentication.
|
168
|
+
# http_auth_password - string - Password to send to server for HTTP Authentication.
|
169
|
+
# mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
|
170
|
+
# server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?
|
171
|
+
# name - string - The partner's formal AS2 name.
|
172
|
+
# uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
|
173
|
+
# public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
|
154
174
|
def update(params = {})
|
155
175
|
params ||= {}
|
156
176
|
params[:id] = @attributes[:id]
|
157
177
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
158
178
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
179
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_username must be an String") if params[:http_auth_username] and !params[:http_auth_username].is_a?(String)
|
180
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_password must be an String") if params[:http_auth_password] and !params[:http_auth_password].is_a?(String)
|
181
|
+
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
182
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
159
183
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
160
184
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
|
161
|
-
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
162
|
-
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
163
185
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
|
164
186
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
165
187
|
|
@@ -195,9 +217,13 @@ module Files
|
|
195
217
|
# Parameters:
|
196
218
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
197
219
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
220
|
+
# action - string
|
221
|
+
# page - int64
|
198
222
|
def self.list(params = {}, options = {})
|
199
223
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
200
224
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
225
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
226
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
201
227
|
|
202
228
|
List.new(As2Partner, params) do
|
203
229
|
Api.send_request("/as2_partners", :get, params, options)
|
@@ -225,44 +251,52 @@ module Files
|
|
225
251
|
end
|
226
252
|
|
227
253
|
# Parameters:
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
# server_certificate - string -
|
233
|
-
#
|
234
|
-
#
|
254
|
+
# enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 PArtner.
|
255
|
+
# http_auth_username - string - Username to send to server for HTTP Authentication.
|
256
|
+
# http_auth_password - string - Password to send to server for HTTP Authentication.
|
257
|
+
# mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
|
258
|
+
# server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?
|
259
|
+
# as2_station_id (required) - int64 - ID of the AS2 Station associated with this partner.
|
260
|
+
# name (required) - string - The partner's formal AS2 name.
|
261
|
+
# uri (required) - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
|
262
|
+
# public_certificate (required) - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
|
235
263
|
def self.create(params = {}, options = {})
|
264
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_username must be an String") if params[:http_auth_username] and !params[:http_auth_username].is_a?(String)
|
265
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_password must be an String") if params[:http_auth_password] and !params[:http_auth_password].is_a?(String)
|
266
|
+
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
267
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
268
|
+
raise InvalidParameterError.new("Bad parameter: as2_station_id must be an Integer") if params[:as2_station_id] and !params[:as2_station_id].is_a?(Integer)
|
236
269
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
237
270
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
|
238
271
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
|
239
|
-
raise
|
240
|
-
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
241
|
-
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
272
|
+
raise MissingParameterError.new("Parameter missing: as2_station_id") unless params[:as2_station_id]
|
242
273
|
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
243
274
|
raise MissingParameterError.new("Parameter missing: uri") unless params[:uri]
|
244
275
|
raise MissingParameterError.new("Parameter missing: public_certificate") unless params[:public_certificate]
|
245
|
-
raise MissingParameterError.new("Parameter missing: as2_station_id") unless params[:as2_station_id]
|
246
276
|
|
247
277
|
response, options = Api.send_request("/as2_partners", :post, params, options)
|
248
278
|
As2Partner.new(response.data, options)
|
249
279
|
end
|
250
280
|
|
251
281
|
# Parameters:
|
252
|
-
#
|
253
|
-
#
|
254
|
-
#
|
255
|
-
# mdn_validation_level - string - MDN
|
256
|
-
#
|
257
|
-
#
|
282
|
+
# enable_dedicated_ips - boolean - If `true`, we will use your site's dedicated IPs for all outbound connections to this AS2 PArtner.
|
283
|
+
# http_auth_username - string - Username to send to server for HTTP Authentication.
|
284
|
+
# http_auth_password - string - Password to send to server for HTTP Authentication.
|
285
|
+
# mdn_validation_level - string - How should Files.com evaluate message transfer success based on a partner's MDN response? This setting does not affect MDN storage; all MDNs received from a partner are always stored. `none`: MDN is stored for informational purposes only, a successful HTTPS transfer is a successful AS2 transfer. `weak`: Inspect the MDN for MIC and Disposition only. `normal`: `weak` plus validate MDN signature matches body, `strict`: `normal` but do not allow signatures from self-signed or incorrectly purposed certificates.
|
286
|
+
# server_certificate - string - Should we require that the remote HTTP server have a valid SSL Certificate for HTTPS?
|
287
|
+
# name - string - The partner's formal AS2 name.
|
288
|
+
# uri - string - Public URI where we will send the AS2 messages (via HTTP/HTTPS).
|
289
|
+
# public_certificate - string - Public certificate for AS2 Partner. Note: This is the certificate for AS2 message security, not a certificate used for HTTPS authentication.
|
258
290
|
def self.update(id, params = {}, options = {})
|
259
291
|
params ||= {}
|
260
292
|
params[:id] = id
|
261
293
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
294
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_username must be an String") if params[:http_auth_username] and !params[:http_auth_username].is_a?(String)
|
295
|
+
raise InvalidParameterError.new("Bad parameter: http_auth_password must be an String") if params[:http_auth_password] and !params[:http_auth_password].is_a?(String)
|
296
|
+
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
297
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
262
298
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
263
299
|
raise InvalidParameterError.new("Bad parameter: uri must be an String") if params[:uri] and !params[:uri].is_a?(String)
|
264
|
-
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params[:server_certificate] and !params[:server_certificate].is_a?(String)
|
265
|
-
raise InvalidParameterError.new("Bad parameter: mdn_validation_level must be an String") if params[:mdn_validation_level] and !params[:mdn_validation_level].is_a?(String)
|
266
300
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
|
267
301
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
268
302
|
|
@@ -201,9 +201,13 @@ module Files
|
|
201
201
|
# Parameters:
|
202
202
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
203
203
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
204
|
+
# action - string
|
205
|
+
# page - int64
|
204
206
|
def self.list(params = {}, options = {})
|
205
207
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
206
208
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
209
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
210
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
207
211
|
|
208
212
|
List.new(As2Station, params) do
|
209
213
|
Api.send_request("/as2_stations", :get, params, options)
|
@@ -135,6 +135,15 @@ module Files
|
|
135
135
|
@attributes[:last_modified_at] = value
|
136
136
|
end
|
137
137
|
|
138
|
+
# boolean - If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
139
|
+
def legacy_folder_matching
|
140
|
+
@attributes[:legacy_folder_matching]
|
141
|
+
end
|
142
|
+
|
143
|
+
def legacy_folder_matching=(value)
|
144
|
+
@attributes[:legacy_folder_matching] = value
|
145
|
+
end
|
146
|
+
|
138
147
|
# string - Name for this automation.
|
139
148
|
def name
|
140
149
|
@attributes[:name]
|
@@ -297,7 +306,7 @@ module Files
|
|
297
306
|
@attributes[:webhook_url] = value
|
298
307
|
end
|
299
308
|
|
300
|
-
# string
|
309
|
+
# string
|
301
310
|
def destination
|
302
311
|
@attributes[:destination]
|
303
312
|
end
|
@@ -319,7 +328,7 @@ module Files
|
|
319
328
|
|
320
329
|
# Parameters:
|
321
330
|
# source - string - Source Path
|
322
|
-
# destination - string
|
331
|
+
# destination - string
|
323
332
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
324
333
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
325
334
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -328,6 +337,7 @@ module Files
|
|
328
337
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
329
338
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
330
339
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
340
|
+
# schedule - object
|
331
341
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
332
342
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
333
343
|
# schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -336,6 +346,7 @@ module Files
|
|
336
346
|
# disabled - boolean - If true, this automation will not run.
|
337
347
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
338
348
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
349
|
+
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
339
350
|
# name - string - Name for this automation.
|
340
351
|
# overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
341
352
|
# path_time_zone - string - Timezone to use when rendering timestamps in paths.
|
@@ -403,6 +414,8 @@ module Files
|
|
403
414
|
# Parameters:
|
404
415
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
405
416
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
417
|
+
# action - string
|
418
|
+
# page - int64
|
406
419
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled`, `last_modified_at` or `name`.
|
407
420
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
408
421
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
@@ -413,6 +426,8 @@ module Files
|
|
413
426
|
def self.list(params = {}, options = {})
|
414
427
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
415
428
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
429
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
430
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
416
431
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
417
432
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
418
433
|
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
@@ -447,7 +462,7 @@ module Files
|
|
447
462
|
|
448
463
|
# Parameters:
|
449
464
|
# source - string - Source Path
|
450
|
-
# destination - string
|
465
|
+
# destination - string
|
451
466
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
452
467
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
453
468
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -456,6 +471,7 @@ module Files
|
|
456
471
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
457
472
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
458
473
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
474
|
+
# schedule - object
|
459
475
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
460
476
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
461
477
|
# schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -464,6 +480,7 @@ module Files
|
|
464
480
|
# disabled - boolean - If true, this automation will not run.
|
465
481
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
466
482
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
483
|
+
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
467
484
|
# name - string - Name for this automation.
|
468
485
|
# overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
469
486
|
# path_time_zone - string - Timezone to use when rendering timestamps in paths.
|
@@ -483,6 +500,7 @@ module Files
|
|
483
500
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
484
501
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
485
502
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
503
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params[:schedule] and !params[:schedule].is_a?(Hash)
|
486
504
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
487
505
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
488
506
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
@@ -513,7 +531,7 @@ module Files
|
|
513
531
|
|
514
532
|
# Parameters:
|
515
533
|
# source - string - Source Path
|
516
|
-
# destination - string
|
534
|
+
# destination - string
|
517
535
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
518
536
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
519
537
|
# destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
@@ -522,6 +540,7 @@ module Files
|
|
522
540
|
# sync_ids - string - A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
523
541
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
524
542
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
543
|
+
# schedule - object
|
525
544
|
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
|
526
545
|
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
|
527
546
|
# schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
|
@@ -530,6 +549,7 @@ module Files
|
|
530
549
|
# disabled - boolean - If true, this automation will not run.
|
531
550
|
# flatten_destination_structure - boolean - Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
532
551
|
# ignore_locked_folders - boolean - If true, the Lock Folders behavior will be disregarded for automated actions.
|
552
|
+
# legacy_folder_matching - boolean - DEPRECATED: If `true`, use the legacy behavior for this automation, where it can operate on folders in addition to just files. This behavior no longer works and should not be used.
|
533
553
|
# name - string - Name for this automation.
|
534
554
|
# overwrite_files - boolean - If true, existing files will be overwritten with new files on Move/Copy automations. Note: by default files will not be overwritten if they appear to be the same file size as the newly incoming file. Use the `:always_overwrite_size_matching_files` option to override this.
|
535
555
|
# path_time_zone - string - Timezone to use when rendering timestamps in paths.
|
@@ -552,6 +572,7 @@ module Files
|
|
552
572
|
raise InvalidParameterError.new("Bad parameter: sync_ids must be an String") if params[:sync_ids] and !params[:sync_ids].is_a?(String)
|
553
573
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
554
574
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
575
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params[:schedule] and !params[:schedule].is_a?(Hash)
|
555
576
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
556
577
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
557
578
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
@@ -57,11 +57,15 @@ module Files
|
|
57
57
|
# Parameters:
|
58
58
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
59
59
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
60
|
+
# action - string
|
61
|
+
# page - int64
|
60
62
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `automation_id`, `automation_run_id`, `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
|
61
63
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `path` or `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ automation_id ]`, `[ automation_run_id ]`, `[ operation ]`, `[ path ]`, `[ status ]`, `[ start_date, end_date ]`, `[ start_date, automation_id ]`, `[ start_date, automation_run_id ]`, `[ start_date, operation ]`, `[ start_date, path ]`, `[ start_date, status ]`, `[ end_date, automation_id ]`, `[ end_date, automation_run_id ]`, `[ end_date, operation ]`, `[ end_date, path ]`, `[ end_date, status ]`, `[ automation_id, automation_run_id ]`, `[ automation_id, operation ]`, `[ automation_id, path ]`, `[ automation_id, status ]`, `[ automation_run_id, operation ]`, `[ automation_run_id, path ]`, `[ automation_run_id, status ]`, `[ operation, path ]`, `[ operation, status ]`, `[ path, status ]`, `[ start_date, end_date, automation_id ]`, `[ start_date, end_date, automation_run_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, status ]`, `[ start_date, automation_id, automation_run_id ]`, `[ start_date, automation_id, operation ]`, `[ start_date, automation_id, path ]`, `[ start_date, automation_id, status ]`, `[ start_date, automation_run_id, operation ]`, `[ start_date, automation_run_id, path ]`, `[ start_date, automation_run_id, status ]`, `[ start_date, operation, path ]`, `[ start_date, operation, status ]`, `[ start_date, path, status ]`, `[ end_date, automation_id, automation_run_id ]`, `[ end_date, automation_id, operation ]`, `[ end_date, automation_id, path ]`, `[ end_date, automation_id, status ]`, `[ end_date, automation_run_id, operation ]`, `[ end_date, automation_run_id, path ]`, `[ end_date, automation_run_id, status ]`, `[ end_date, operation, path ]`, `[ end_date, operation, status ]`, `[ end_date, path, status ]`, `[ automation_id, automation_run_id, operation ]`, `[ automation_id, automation_run_id, path ]`, `[ automation_id, automation_run_id, status ]`, `[ automation_id, operation, path ]`, `[ automation_id, operation, status ]`, `[ automation_id, path, status ]`, `[ automation_run_id, operation, path ]`, `[ automation_run_id, operation, status ]`, `[ automation_run_id, path, status ]`, `[ operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id ]`, `[ start_date, end_date, automation_id, operation ]`, `[ start_date, end_date, automation_id, path ]`, `[ start_date, end_date, automation_id, status ]`, `[ start_date, end_date, automation_run_id, operation ]`, `[ start_date, end_date, automation_run_id, path ]`, `[ start_date, end_date, automation_run_id, status ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, path, status ]`, `[ start_date, automation_id, automation_run_id, operation ]`, `[ start_date, automation_id, automation_run_id, path ]`, `[ start_date, automation_id, automation_run_id, status ]`, `[ start_date, automation_id, operation, path ]`, `[ start_date, automation_id, operation, status ]`, `[ start_date, automation_id, path, status ]`, `[ start_date, automation_run_id, operation, path ]`, `[ start_date, automation_run_id, operation, status ]`, `[ start_date, automation_run_id, path, status ]`, `[ start_date, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation ]`, `[ end_date, automation_id, automation_run_id, path ]`, `[ end_date, automation_id, automation_run_id, status ]`, `[ end_date, automation_id, operation, path ]`, `[ end_date, automation_id, operation, status ]`, `[ end_date, automation_id, path, status ]`, `[ end_date, automation_run_id, operation, path ]`, `[ end_date, automation_run_id, operation, status ]`, `[ end_date, automation_run_id, path, status ]`, `[ end_date, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path ]`, `[ automation_id, automation_run_id, operation, status ]`, `[ automation_id, automation_run_id, path, status ]`, `[ automation_id, operation, path, status ]`, `[ automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation ]`, `[ start_date, end_date, automation_id, automation_run_id, path ]`, `[ start_date, end_date, automation_id, automation_run_id, status ]`, `[ start_date, end_date, automation_id, operation, path ]`, `[ start_date, end_date, automation_id, operation, status ]`, `[ start_date, end_date, automation_id, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_run_id, path, status ]`, `[ start_date, end_date, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, automation_id, automation_run_id, path, status ]`, `[ start_date, automation_id, operation, path, status ]`, `[ start_date, automation_run_id, operation, path, status ]`, `[ end_date, automation_id, automation_run_id, operation, path ]`, `[ end_date, automation_id, automation_run_id, operation, status ]`, `[ end_date, automation_id, automation_run_id, path, status ]`, `[ end_date, automation_id, operation, path, status ]`, `[ end_date, automation_run_id, operation, path, status ]`, `[ automation_id, automation_run_id, operation, path, status ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, path ]`, `[ start_date, end_date, automation_id, automation_run_id, operation, status ]`, `[ start_date, end_date, automation_id, automation_run_id, path, status ]`, `[ start_date, end_date, automation_id, operation, path, status ]`, `[ start_date, end_date, automation_run_id, operation, path, status ]`, `[ start_date, automation_id, automation_run_id, operation, path, status ]` or `[ end_date, automation_id, automation_run_id, operation, path, status ]`.
|
62
64
|
def self.list(params = {}, options = {})
|
63
65
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
64
66
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
67
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
68
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
65
69
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
66
70
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
67
71
|
|
@@ -57,12 +57,16 @@ module Files
|
|
57
57
|
# Parameters:
|
58
58
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
59
59
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
60
|
+
# action - string
|
61
|
+
# page - int64
|
60
62
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation_id]=desc`). Valid fields are `automation_id`, `created_at` or `status`.
|
61
63
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `automation_id`. Valid field combinations are `[ automation_id, status ]`.
|
62
64
|
# automation_id (required) - int64 - ID of the associated Automation.
|
63
65
|
def self.list(params = {}, options = {})
|
64
66
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
65
67
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
68
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
69
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
66
70
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
67
71
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
68
72
|
raise InvalidParameterError.new("Bad parameter: automation_id must be an Integer") if params[:automation_id] and !params[:automation_id].is_a?(Integer)
|
@@ -57,6 +57,8 @@ module Files
|
|
57
57
|
# Parameters:
|
58
58
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
59
59
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
60
|
+
# action - string
|
61
|
+
# page - int64
|
60
62
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
|
61
63
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
62
64
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
@@ -66,6 +68,8 @@ module Files
|
|
66
68
|
def self.list(params = {}, options = {})
|
67
69
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
68
70
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
71
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
72
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
69
73
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
70
74
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
71
75
|
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
@@ -90,7 +90,7 @@ module Files
|
|
90
90
|
@attributes[:recursive] = value
|
91
91
|
end
|
92
92
|
|
93
|
-
# file - Certain behaviors may require a file, for instance, the
|
93
|
+
# file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
94
94
|
def attachment_file
|
95
95
|
@attributes[:attachment_file]
|
96
96
|
end
|
@@ -99,7 +99,7 @@ module Files
|
|
99
99
|
@attributes[:attachment_file] = value
|
100
100
|
end
|
101
101
|
|
102
|
-
# boolean - If true
|
102
|
+
# boolean - If `true`, delete the file stored in `attachment`.
|
103
103
|
def attachment_delete
|
104
104
|
@attributes[:attachment_delete]
|
105
105
|
end
|
@@ -109,13 +109,13 @@ module Files
|
|
109
109
|
end
|
110
110
|
|
111
111
|
# Parameters:
|
112
|
-
# value - string -
|
113
|
-
# attachment_file - file - Certain behaviors may require a file, for instance, the
|
114
|
-
# disable_parent_folder_behavior - boolean - If true
|
115
|
-
# recursive - boolean -
|
112
|
+
# value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
113
|
+
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
114
|
+
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
115
|
+
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
116
116
|
# name - string - Name for this behavior.
|
117
117
|
# description - string - Description for this behavior.
|
118
|
-
# attachment_delete - boolean - If true
|
118
|
+
# attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
|
119
119
|
def update(params = {})
|
120
120
|
params ||= {}
|
121
121
|
params[:id] = @attributes[:id]
|
@@ -158,12 +158,16 @@ module Files
|
|
158
158
|
# Parameters:
|
159
159
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
160
160
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
161
|
+
# action - string
|
162
|
+
# page - int64
|
161
163
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
|
162
164
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
|
163
165
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
164
166
|
def self.list(params = {}, options = {})
|
165
167
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
166
168
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
169
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
170
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
167
171
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
168
172
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
169
173
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
@@ -196,22 +200,25 @@ module Files
|
|
196
200
|
# Parameters:
|
197
201
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
198
202
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
203
|
+
# action - string
|
204
|
+
# page - int64
|
199
205
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior` and `impacts_ui`.
|
200
206
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`.
|
201
207
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
202
208
|
# path (required) - string - Path to operate on.
|
203
|
-
# ancestor_behaviors -
|
204
|
-
# behavior - string
|
209
|
+
# ancestor_behaviors - boolean - If `true`, behaviors above this path are shown.
|
210
|
+
# behavior - string
|
205
211
|
def self.list_for(path, params = {}, options = {})
|
206
212
|
params ||= {}
|
207
213
|
params[:path] = path
|
208
214
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
209
215
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
216
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
|
217
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params[:page] and !params[:page].is_a?(Integer)
|
210
218
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
211
219
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
212
220
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
213
221
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
214
|
-
raise InvalidParameterError.new("Bad parameter: ancestor_behaviors must be an String") if params[:ancestor_behaviors] and !params[:ancestor_behaviors].is_a?(String)
|
215
222
|
raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params[:behavior] and !params[:behavior].is_a?(String)
|
216
223
|
raise MissingParameterError.new("Parameter missing: path") unless params[:path]
|
217
224
|
|
@@ -221,13 +228,13 @@ module Files
|
|
221
228
|
end
|
222
229
|
|
223
230
|
# Parameters:
|
224
|
-
# value - string -
|
225
|
-
# attachment_file - file - Certain behaviors may require a file, for instance, the
|
226
|
-
# disable_parent_folder_behavior - boolean - If true
|
227
|
-
# recursive - boolean -
|
231
|
+
# value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
232
|
+
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
233
|
+
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
234
|
+
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
228
235
|
# name - string - Name for this behavior.
|
229
236
|
# description - string - Description for this behavior.
|
230
|
-
# path (required) - string -
|
237
|
+
# path (required) - string - Path where this behavior should apply.
|
231
238
|
# behavior (required) - string - Behavior type.
|
232
239
|
def self.create(params = {}, options = {})
|
233
240
|
raise InvalidParameterError.new("Bad parameter: value must be an String") if params[:value] and !params[:value].is_a?(String)
|
@@ -244,11 +251,11 @@ module Files
|
|
244
251
|
|
245
252
|
# Parameters:
|
246
253
|
# url (required) - string - URL for testing the webhook.
|
247
|
-
# method - string - HTTP method(GET or POST).
|
248
|
-
# encoding - string -
|
249
|
-
# headers - object - Additional request headers.
|
250
|
-
# body - object - Additional body parameters.
|
251
|
-
# action - string -
|
254
|
+
# method - string - HTTP request method (GET or POST).
|
255
|
+
# encoding - string - Encoding type for the webhook payload. Can be JSON, XML, or RAW (form data).
|
256
|
+
# headers - object - Additional request headers to send via HTTP.
|
257
|
+
# body - object - Additional body parameters to include in the webhook payload.
|
258
|
+
# action - string - Action for test body.
|
252
259
|
def self.webhook_test(params = {}, options = {})
|
253
260
|
raise InvalidParameterError.new("Bad parameter: url must be an String") if params[:url] and !params[:url].is_a?(String)
|
254
261
|
raise InvalidParameterError.new("Bad parameter: method must be an String") if params[:method] and !params[:method].is_a?(String)
|
@@ -263,13 +270,13 @@ module Files
|
|
263
270
|
end
|
264
271
|
|
265
272
|
# Parameters:
|
266
|
-
# value - string -
|
267
|
-
# attachment_file - file - Certain behaviors may require a file, for instance, the
|
268
|
-
# disable_parent_folder_behavior - boolean - If true
|
269
|
-
# recursive - boolean -
|
273
|
+
# value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
274
|
+
# attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
275
|
+
# disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
276
|
+
# recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
270
277
|
# name - string - Name for this behavior.
|
271
278
|
# description - string - Description for this behavior.
|
272
|
-
# attachment_delete - boolean - If true
|
279
|
+
# attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
|
273
280
|
def self.update(id, params = {}, options = {})
|
274
281
|
params ||= {}
|
275
282
|
params[:id] = id
|