files.com 1.1.266 → 1.1.268
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/_VERSION +1 -1
- data/docs/api_request_log.md +10 -4
- data/docs/automation_log.md +10 -4
- data/docs/email_log.md +10 -4
- data/docs/exavault_api_request_log.md +10 -4
- data/docs/file_migration_log.md +10 -4
- data/docs/ftp_action_log.md +10 -4
- data/docs/outbound_connection_log.md +10 -4
- data/docs/public_hosting_request_log.md +10 -4
- data/docs/sftp_action_log.md +10 -4
- data/docs/site.md +4 -0
- data/docs/sync.md +275 -0
- data/docs/sync_log.md +10 -4
- data/docs/sync_run.md +81 -0
- data/docs/web_dav_action_log.md +10 -4
- data/lib/files.com/models/api_request_log.rb +16 -3
- data/lib/files.com/models/automation_log.rb +16 -3
- data/lib/files.com/models/email_log.rb +16 -3
- data/lib/files.com/models/exavault_api_request_log.rb +16 -3
- data/lib/files.com/models/file_migration_log.rb +16 -3
- data/lib/files.com/models/ftp_action_log.rb +16 -3
- data/lib/files.com/models/outbound_connection_log.rb +16 -3
- data/lib/files.com/models/public_hosting_request_log.rb +16 -3
- data/lib/files.com/models/sftp_action_log.rb +16 -3
- data/lib/files.com/models/site.rb +6 -0
- data/lib/files.com/models/sync.rb +426 -0
- data/lib/files.com/models/sync_log.rb +16 -3
- data/lib/files.com/models/sync_run.rb +148 -0
- data/lib/files.com/models/web_dav_action_log.rb +16 -3
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +2 -0
- metadata +6 -2
@@ -284,6 +284,11 @@ module Files
|
|
284
284
|
@attributes[:legacy_checksums_mode]
|
285
285
|
end
|
286
286
|
|
287
|
+
# boolean - If true, we will migrate all remote server syncs to the new Sync model.
|
288
|
+
def migrate_remote_server_sync_to_sync
|
289
|
+
@attributes[:migrate_remote_server_sync_to_sync]
|
290
|
+
end
|
291
|
+
|
287
292
|
# boolean - Is the mobile app enabled?
|
288
293
|
def mobile_app
|
289
294
|
@attributes[:mobile_app]
|
@@ -912,6 +917,7 @@ module Files
|
|
912
917
|
# calculate_file_checksums_sha1 - boolean - Calculate SHA1 checksums for files?
|
913
918
|
# calculate_file_checksums_sha256 - boolean - Calculate SHA256 checksums for files?
|
914
919
|
# legacy_checksums_mode - boolean - Use legacy checksums mode?
|
920
|
+
# migrate_remote_server_sync_to_sync - boolean - If true, we will migrate all remote server syncs to the new Sync model.
|
915
921
|
# session_expiry - double - Session expiry in hours
|
916
922
|
# ssl_required - boolean - Is SSL required? Disabling this is insecure.
|
917
923
|
# tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
|
@@ -0,0 +1,426 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class Sync
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - Sync ID
|
13
|
+
def id
|
14
|
+
@attributes[:id]
|
15
|
+
end
|
16
|
+
|
17
|
+
def id=(value)
|
18
|
+
@attributes[:id] = value
|
19
|
+
end
|
20
|
+
|
21
|
+
# string - Name for this sync job
|
22
|
+
def name
|
23
|
+
@attributes[:name]
|
24
|
+
end
|
25
|
+
|
26
|
+
def name=(value)
|
27
|
+
@attributes[:name] = value
|
28
|
+
end
|
29
|
+
|
30
|
+
# string - Description for this sync job
|
31
|
+
def description
|
32
|
+
@attributes[:description]
|
33
|
+
end
|
34
|
+
|
35
|
+
def description=(value)
|
36
|
+
@attributes[:description] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
# int64 - Site ID this sync belongs to
|
40
|
+
def site_id
|
41
|
+
@attributes[:site_id]
|
42
|
+
end
|
43
|
+
|
44
|
+
def site_id=(value)
|
45
|
+
@attributes[:site_id] = value
|
46
|
+
end
|
47
|
+
|
48
|
+
# int64 - User who created or owns this sync
|
49
|
+
def user_id
|
50
|
+
@attributes[:user_id]
|
51
|
+
end
|
52
|
+
|
53
|
+
def user_id=(value)
|
54
|
+
@attributes[:user_id] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - Absolute source path for the sync
|
58
|
+
def src_path
|
59
|
+
@attributes[:src_path]
|
60
|
+
end
|
61
|
+
|
62
|
+
def src_path=(value)
|
63
|
+
@attributes[:src_path] = value
|
64
|
+
end
|
65
|
+
|
66
|
+
# string - Absolute destination path for the sync
|
67
|
+
def dest_path
|
68
|
+
@attributes[:dest_path]
|
69
|
+
end
|
70
|
+
|
71
|
+
def dest_path=(value)
|
72
|
+
@attributes[:dest_path] = value
|
73
|
+
end
|
74
|
+
|
75
|
+
# int64 - Remote server ID for the source (if remote)
|
76
|
+
def src_remote_server_id
|
77
|
+
@attributes[:src_remote_server_id]
|
78
|
+
end
|
79
|
+
|
80
|
+
def src_remote_server_id=(value)
|
81
|
+
@attributes[:src_remote_server_id] = value
|
82
|
+
end
|
83
|
+
|
84
|
+
# int64 - Remote server ID for the destination (if remote)
|
85
|
+
def dest_remote_server_id
|
86
|
+
@attributes[:dest_remote_server_id]
|
87
|
+
end
|
88
|
+
|
89
|
+
def dest_remote_server_id=(value)
|
90
|
+
@attributes[:dest_remote_server_id] = value
|
91
|
+
end
|
92
|
+
|
93
|
+
# boolean - Is this a two-way sync?
|
94
|
+
def two_way
|
95
|
+
@attributes[:two_way]
|
96
|
+
end
|
97
|
+
|
98
|
+
def two_way=(value)
|
99
|
+
@attributes[:two_way] = value
|
100
|
+
end
|
101
|
+
|
102
|
+
# boolean - Keep files after copying?
|
103
|
+
def keep_after_copy
|
104
|
+
@attributes[:keep_after_copy]
|
105
|
+
end
|
106
|
+
|
107
|
+
def keep_after_copy=(value)
|
108
|
+
@attributes[:keep_after_copy] = value
|
109
|
+
end
|
110
|
+
|
111
|
+
# boolean - Delete empty folders after sync?
|
112
|
+
def delete_empty_folders
|
113
|
+
@attributes[:delete_empty_folders]
|
114
|
+
end
|
115
|
+
|
116
|
+
def delete_empty_folders=(value)
|
117
|
+
@attributes[:delete_empty_folders] = value
|
118
|
+
end
|
119
|
+
|
120
|
+
# boolean - Is this sync disabled?
|
121
|
+
def disabled
|
122
|
+
@attributes[:disabled]
|
123
|
+
end
|
124
|
+
|
125
|
+
def disabled=(value)
|
126
|
+
@attributes[:disabled] = value
|
127
|
+
end
|
128
|
+
|
129
|
+
# string - If trigger is `daily`, this specifies how often to run this sync. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
130
|
+
def interval
|
131
|
+
@attributes[:interval]
|
132
|
+
end
|
133
|
+
|
134
|
+
def interval=(value)
|
135
|
+
@attributes[:interval] = value
|
136
|
+
end
|
137
|
+
|
138
|
+
# string - Trigger type: daily, custom_schedule, or manual
|
139
|
+
def trigger
|
140
|
+
@attributes[:trigger]
|
141
|
+
end
|
142
|
+
|
143
|
+
def trigger=(value)
|
144
|
+
@attributes[:trigger] = value
|
145
|
+
end
|
146
|
+
|
147
|
+
# string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
148
|
+
def trigger_file
|
149
|
+
@attributes[:trigger_file]
|
150
|
+
end
|
151
|
+
|
152
|
+
def trigger_file=(value)
|
153
|
+
@attributes[:trigger_file] = value
|
154
|
+
end
|
155
|
+
|
156
|
+
# array(array) - Array of glob patterns to include
|
157
|
+
def include_patterns
|
158
|
+
@attributes[:include_patterns]
|
159
|
+
end
|
160
|
+
|
161
|
+
def include_patterns=(value)
|
162
|
+
@attributes[:include_patterns] = value
|
163
|
+
end
|
164
|
+
|
165
|
+
# array(array) - Array of glob patterns to exclude
|
166
|
+
def exclude_patterns
|
167
|
+
@attributes[:exclude_patterns]
|
168
|
+
end
|
169
|
+
|
170
|
+
def exclude_patterns=(value)
|
171
|
+
@attributes[:exclude_patterns] = value
|
172
|
+
end
|
173
|
+
|
174
|
+
# date-time - When this sync was created
|
175
|
+
def created_at
|
176
|
+
@attributes[:created_at]
|
177
|
+
end
|
178
|
+
|
179
|
+
# date-time - When this sync was last updated
|
180
|
+
def updated_at
|
181
|
+
@attributes[:updated_at]
|
182
|
+
end
|
183
|
+
|
184
|
+
# int64 - Frequency in minutes between syncs. If set, this value must be greater than or equal to the `remote_sync_interval` value for the site's plan. If left blank, the plan's `remote_sync_interval` will be used. This setting is only used if `trigger` is empty.
|
185
|
+
def sync_interval_minutes
|
186
|
+
@attributes[:sync_interval_minutes]
|
187
|
+
end
|
188
|
+
|
189
|
+
def sync_interval_minutes=(value)
|
190
|
+
@attributes[:sync_interval_minutes] = value
|
191
|
+
end
|
192
|
+
|
193
|
+
# int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
194
|
+
def recurring_day
|
195
|
+
@attributes[:recurring_day]
|
196
|
+
end
|
197
|
+
|
198
|
+
def recurring_day=(value)
|
199
|
+
@attributes[:recurring_day] = value
|
200
|
+
end
|
201
|
+
|
202
|
+
# array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
203
|
+
def schedule_days_of_week
|
204
|
+
@attributes[:schedule_days_of_week]
|
205
|
+
end
|
206
|
+
|
207
|
+
def schedule_days_of_week=(value)
|
208
|
+
@attributes[:schedule_days_of_week] = value
|
209
|
+
end
|
210
|
+
|
211
|
+
# array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
212
|
+
def schedule_times_of_day
|
213
|
+
@attributes[:schedule_times_of_day]
|
214
|
+
end
|
215
|
+
|
216
|
+
def schedule_times_of_day=(value)
|
217
|
+
@attributes[:schedule_times_of_day] = value
|
218
|
+
end
|
219
|
+
|
220
|
+
# string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
221
|
+
def schedule_time_zone
|
222
|
+
@attributes[:schedule_time_zone]
|
223
|
+
end
|
224
|
+
|
225
|
+
def schedule_time_zone=(value)
|
226
|
+
@attributes[:schedule_time_zone] = value
|
227
|
+
end
|
228
|
+
|
229
|
+
# Parameters:
|
230
|
+
# name - string - Name for this sync job
|
231
|
+
# description - string - Description for this sync job
|
232
|
+
# src_path - string - Absolute source path
|
233
|
+
# dest_path - string - Absolute destination path
|
234
|
+
# src_remote_server_id - int64 - Remote server ID for the source
|
235
|
+
# dest_remote_server_id - int64 - Remote server ID for the destination
|
236
|
+
# two_way - boolean - Is this a two-way sync?
|
237
|
+
# keep_after_copy - boolean - Keep files after copying?
|
238
|
+
# delete_empty_folders - boolean - Delete empty folders after sync?
|
239
|
+
# disabled - boolean - Is this sync disabled?
|
240
|
+
# interval - int64 - Interval in minutes for sync (if scheduled)
|
241
|
+
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
242
|
+
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
243
|
+
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
244
|
+
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
245
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
246
|
+
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
247
|
+
def update(params = {})
|
248
|
+
params ||= {}
|
249
|
+
params[:id] = @attributes[:id]
|
250
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
251
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
252
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
253
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
254
|
+
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
255
|
+
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
256
|
+
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
257
|
+
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
258
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
259
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
260
|
+
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
261
|
+
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
262
|
+
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)
|
263
|
+
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)
|
264
|
+
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)
|
265
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
266
|
+
|
267
|
+
Api.send_request("/syncs/#{@attributes[:id]}", :patch, params, @options)
|
268
|
+
end
|
269
|
+
|
270
|
+
def delete(params = {})
|
271
|
+
params ||= {}
|
272
|
+
params[:id] = @attributes[:id]
|
273
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
274
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
275
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
276
|
+
|
277
|
+
Api.send_request("/syncs/#{@attributes[:id]}", :delete, params, @options)
|
278
|
+
end
|
279
|
+
|
280
|
+
def destroy(params = {})
|
281
|
+
delete(params)
|
282
|
+
nil
|
283
|
+
end
|
284
|
+
|
285
|
+
def save
|
286
|
+
if @attributes[:id]
|
287
|
+
new_obj = update(@attributes)
|
288
|
+
else
|
289
|
+
new_obj = Sync.create(@attributes, @options)
|
290
|
+
end
|
291
|
+
|
292
|
+
@attributes = new_obj.attributes
|
293
|
+
true
|
294
|
+
end
|
295
|
+
|
296
|
+
# Parameters:
|
297
|
+
# 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.
|
298
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
299
|
+
def self.list(params = {}, options = {})
|
300
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
301
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
302
|
+
|
303
|
+
List.new(Sync, params) do
|
304
|
+
Api.send_request("/syncs", :get, params, options)
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
308
|
+
def self.all(params = {}, options = {})
|
309
|
+
list(params, options)
|
310
|
+
end
|
311
|
+
|
312
|
+
# Parameters:
|
313
|
+
# id (required) - int64 - Sync ID.
|
314
|
+
def self.find(id, params = {}, options = {})
|
315
|
+
params ||= {}
|
316
|
+
params[:id] = id
|
317
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
318
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
319
|
+
|
320
|
+
response, options = Api.send_request("/syncs/#{params[:id]}", :get, params, options)
|
321
|
+
Sync.new(response.data, options)
|
322
|
+
end
|
323
|
+
|
324
|
+
def self.get(id, params = {}, options = {})
|
325
|
+
find(id, params, options)
|
326
|
+
end
|
327
|
+
|
328
|
+
# Parameters:
|
329
|
+
# name - string - Name for this sync job
|
330
|
+
# description - string - Description for this sync job
|
331
|
+
# src_path - string - Absolute source path
|
332
|
+
# dest_path - string - Absolute destination path
|
333
|
+
# src_remote_server_id - int64 - Remote server ID for the source
|
334
|
+
# dest_remote_server_id - int64 - Remote server ID for the destination
|
335
|
+
# two_way - boolean - Is this a two-way sync?
|
336
|
+
# keep_after_copy - boolean - Keep files after copying?
|
337
|
+
# delete_empty_folders - boolean - Delete empty folders after sync?
|
338
|
+
# disabled - boolean - Is this sync disabled?
|
339
|
+
# interval - int64 - Interval in minutes for sync (if scheduled)
|
340
|
+
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
341
|
+
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
342
|
+
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
343
|
+
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
344
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
345
|
+
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
346
|
+
def self.create(params = {}, options = {})
|
347
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
348
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
349
|
+
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
350
|
+
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
351
|
+
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
352
|
+
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
353
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
354
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
355
|
+
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
356
|
+
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
357
|
+
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)
|
358
|
+
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)
|
359
|
+
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)
|
360
|
+
|
361
|
+
response, options = Api.send_request("/syncs", :post, params, options)
|
362
|
+
Sync.new(response.data, options)
|
363
|
+
end
|
364
|
+
|
365
|
+
def self.create_migrate_to(params = {}, options = {})
|
366
|
+
Api.send_request("/syncs/migrate_to_syncs", :post, params, options)
|
367
|
+
nil
|
368
|
+
end
|
369
|
+
|
370
|
+
# Parameters:
|
371
|
+
# name - string - Name for this sync job
|
372
|
+
# description - string - Description for this sync job
|
373
|
+
# src_path - string - Absolute source path
|
374
|
+
# dest_path - string - Absolute destination path
|
375
|
+
# src_remote_server_id - int64 - Remote server ID for the source
|
376
|
+
# dest_remote_server_id - int64 - Remote server ID for the destination
|
377
|
+
# two_way - boolean - Is this a two-way sync?
|
378
|
+
# keep_after_copy - boolean - Keep files after copying?
|
379
|
+
# delete_empty_folders - boolean - Delete empty folders after sync?
|
380
|
+
# disabled - boolean - Is this sync disabled?
|
381
|
+
# interval - int64 - Interval in minutes for sync (if scheduled)
|
382
|
+
# trigger - string - Trigger type: daily, custom_schedule, or manual
|
383
|
+
# trigger_file - string - Some MFT services request an empty file (known as a trigger file) to signal the sync is complete and they can begin further processing. If trigger_file is set, a zero-byte file will be sent at the end of the sync.
|
384
|
+
# recurring_day - int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
385
|
+
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
386
|
+
# schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
387
|
+
# schedule_times_of_day - array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
388
|
+
def self.update(id, params = {}, options = {})
|
389
|
+
params ||= {}
|
390
|
+
params[:id] = id
|
391
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
392
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
393
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
394
|
+
raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
|
395
|
+
raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
|
396
|
+
raise InvalidParameterError.new("Bad parameter: src_remote_server_id must be an Integer") if params[:src_remote_server_id] and !params[:src_remote_server_id].is_a?(Integer)
|
397
|
+
raise InvalidParameterError.new("Bad parameter: dest_remote_server_id must be an Integer") if params[:dest_remote_server_id] and !params[:dest_remote_server_id].is_a?(Integer)
|
398
|
+
raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
|
399
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
400
|
+
raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
|
401
|
+
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
402
|
+
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)
|
403
|
+
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)
|
404
|
+
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)
|
405
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
406
|
+
|
407
|
+
response, options = Api.send_request("/syncs/#{params[:id]}", :patch, params, options)
|
408
|
+
Sync.new(response.data, options)
|
409
|
+
end
|
410
|
+
|
411
|
+
def self.delete(id, params = {}, options = {})
|
412
|
+
params ||= {}
|
413
|
+
params[:id] = id
|
414
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
415
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
416
|
+
|
417
|
+
Api.send_request("/syncs/#{params[:id]}", :delete, params, options)
|
418
|
+
nil
|
419
|
+
end
|
420
|
+
|
421
|
+
def self.destroy(id, params = {}, options = {})
|
422
|
+
delete(id, params, options)
|
423
|
+
nil
|
424
|
+
end
|
425
|
+
end
|
426
|
+
end
|
@@ -9,7 +9,7 @@ module Files
|
|
9
9
|
@options = options || {}
|
10
10
|
end
|
11
11
|
|
12
|
-
# date-time - Start Time of Action
|
12
|
+
# date-time - Start Time of Action. Deprecrated: Use created_at.
|
13
13
|
def timestamp
|
14
14
|
@attributes[:timestamp]
|
15
15
|
end
|
@@ -59,16 +59,29 @@ module Files
|
|
59
59
|
@attributes[:status]
|
60
60
|
end
|
61
61
|
|
62
|
+
# date-time - Start Time of Action
|
63
|
+
def created_at
|
64
|
+
@attributes[:created_at]
|
65
|
+
end
|
66
|
+
|
62
67
|
# Parameters:
|
63
68
|
# 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.
|
64
69
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
65
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `external_event_id`, `operation`, `status` or `
|
66
|
-
#
|
70
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `external_event_id`, `operation`, `status`, `sync_id` or `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
71
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
72
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
73
|
+
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation` and `status`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
74
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
75
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ created_at ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ start_date, created_at ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ end_date, created_at ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ external_event_id, created_at ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ operation, created_at ]`, `[ status, sync_id ]`, `[ status, created_at ]`, `[ sync_id, created_at ]`, `[ start_date, end_date, external_event_id ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, sync_id ]`, `[ start_date, end_date, created_at ]`, `[ start_date, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, external_event_id, created_at ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, operation, created_at ]`, `[ start_date, status, sync_id ]`, `[ start_date, status, created_at ]`, `[ start_date, sync_id, created_at ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, external_event_id, created_at ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, operation, created_at ]`, `[ end_date, status, sync_id ]`, `[ end_date, status, created_at ]`, `[ end_date, sync_id, created_at ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, operation, created_at ]`, `[ external_event_id, status, sync_id ]`, `[ external_event_id, status, created_at ]`, `[ external_event_id, sync_id, created_at ]`, `[ operation, status, sync_id ]`, `[ operation, status, created_at ]`, `[ operation, sync_id, created_at ]`, `[ status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation ]`, `[ start_date, end_date, external_event_id, status ]`, `[ start_date, end_date, external_event_id, sync_id ]`, `[ start_date, end_date, external_event_id, created_at ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, operation, created_at ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, end_date, status, created_at ]`, `[ start_date, end_date, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, operation, created_at ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, external_event_id, status, created_at ]`, `[ start_date, external_event_id, sync_id, created_at ]`, `[ start_date, operation, status, sync_id ]`, `[ start_date, operation, status, created_at ]`, `[ start_date, operation, sync_id, created_at ]`, `[ start_date, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, operation, created_at ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, external_event_id, status, created_at ]`, `[ end_date, external_event_id, sync_id, created_at ]`, `[ end_date, operation, status, sync_id ]`, `[ end_date, operation, status, created_at ]`, `[ end_date, operation, sync_id, created_at ]`, `[ end_date, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id ]`, `[ external_event_id, operation, status, created_at ]`, `[ external_event_id, operation, sync_id, created_at ]`, `[ external_event_id, status, sync_id, created_at ]`, `[ operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status ]`, `[ start_date, end_date, external_event_id, operation, sync_id ]`, `[ start_date, end_date, external_event_id, operation, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id ]`, `[ start_date, end_date, external_event_id, status, created_at ]`, `[ start_date, end_date, external_event_id, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, end_date, operation, status, created_at ]`, `[ start_date, end_date, operation, sync_id, created_at ]`, `[ start_date, end_date, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, created_at ]`, `[ start_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, operation, status, sync_id, created_at ]`, `[ end_date, external_event_id, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status, created_at ]`, `[ end_date, external_event_id, operation, sync_id, created_at ]`, `[ end_date, external_event_id, status, sync_id, created_at ]`, `[ end_date, operation, status, sync_id, created_at ]`, `[ external_event_id, operation, status, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, operation, status, sync_id ]`, `[ start_date, end_date, external_event_id, operation, status, created_at ]`, `[ start_date, end_date, external_event_id, operation, sync_id, created_at ]`, `[ start_date, end_date, external_event_id, status, sync_id, created_at ]`, `[ start_date, end_date, operation, status, sync_id, created_at ]`, `[ start_date, external_event_id, operation, status, sync_id, created_at ]` or `[ end_date, external_event_id, operation, status, sync_id, created_at ]`.
|
67
76
|
def self.list(params = {}, options = {})
|
68
77
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
69
78
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
70
79
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
80
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
|
81
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
71
82
|
raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
|
83
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
84
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
72
85
|
|
73
86
|
List.new(SyncLog, params) do
|
74
87
|
Api.send_request("/sync_logs", :get, params, options)
|