files.com 1.1.590 → 1.1.591

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cf39733c9ef97a58941278c47cfb5edc5fd833d52307569c8d91f56d2cd8ea88
4
- data.tar.gz: 1e1b526c415d979225e1ef50eb79a974a894e54c402a28731c4a6a077342cef5
3
+ metadata.gz: d8ca6540e4b3def2c14e408668ce2f7dde2b49edcc0ba9bce630b03e51f6261f
4
+ data.tar.gz: d0ebbb323ec754b283fe82449a83ed7555cb5e2919d18512f8388c25c40608e8
5
5
  SHA512:
6
- metadata.gz: d13577f0632012df8e0e9d6887c0cad03e8dad62edec2bed718a3b629f0509f4af2d1b7e548e08a94e7dc5699c5fe398afed0354091e4504153c77e6fa82c4f2
7
- data.tar.gz: 15c1d60cc93065093307650e9ec1e98208096485596b55469f5864cfff4676ae0955f8e2251c92c0e253437285f71c8ffd4745c9c6c66e50a532456c3d063873
6
+ metadata.gz: 2a383c3eb911b443e5217a9c8081568f8631a341ff3abd153bf2ed981ade13ffd72cce6db117a37d64192328c1ae9a8c97000e2389a37939f6087138e5e7ffab
7
+ data.tar.gz: ee5bd26df86c3b68bb7aa41efc3bfb908fbfd2100b9d04d6389ff3033f42f2b381938bdced758e550cd16839d090df899524237caa293555d28cf428a82d7003
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.590
1
+ 1.1.591
data/docs/file_comment.md CHANGED
@@ -42,7 +42,7 @@ Files::FileComment.list_for(path)
42
42
 
43
43
  ```
44
44
  Files::FileComment.create(
45
- body: "body",
45
+ body: "What a great file!",
46
46
  path: "path"
47
47
  )
48
48
  ```
@@ -59,7 +59,7 @@ Files::FileComment.create(
59
59
 
60
60
  ```
61
61
  Files::FileComment.update(id,
62
- body: "body"
62
+ body: "What a great file!"
63
63
  )
64
64
  ```
65
65
 
@@ -90,7 +90,7 @@ Files::FileComment.delete(id)
90
90
  file_comment = Files::FileComment.list.first
91
91
 
92
92
  file_comment.update(
93
- body: "body"
93
+ body: "What a great file!"
94
94
  )
95
95
  ```
96
96
 
@@ -61,7 +61,7 @@ Files::MessageComment.find(id)
61
61
  ```
62
62
  Files::MessageComment.create(
63
63
  user_id: 1,
64
- body: "body"
64
+ body: "What a great idea, thank you!"
65
65
  )
66
66
  ```
67
67
 
@@ -77,7 +77,7 @@ Files::MessageComment.create(
77
77
 
78
78
  ```
79
79
  Files::MessageComment.update(id,
80
- body: "body"
80
+ body: "What a great idea, thank you!"
81
81
  )
82
82
  ```
83
83
 
@@ -108,7 +108,7 @@ Files::MessageComment.delete(id)
108
108
  message_comment = Files::MessageComment.find(id)
109
109
 
110
110
  message_comment.update(
111
- body: "body"
111
+ body: "What a great idea, thank you!"
112
112
  )
113
113
  ```
114
114
 
@@ -236,6 +236,8 @@ Files::SiemHttpDestination.send_test_entry(
236
236
  additional_headers: {"key":"example value"},
237
237
  sending_active: true,
238
238
  generic_payload_type: "example",
239
+ file_destination_path: "example",
240
+ file_format: "example",
239
241
  file_interval_minutes: 1,
240
242
  azure_dcr_immutable_id: "example",
241
243
  azure_stream_name: "example",
data/docs/sync.md CHANGED
@@ -14,6 +14,8 @@
14
14
  "dest_path": "example",
15
15
  "src_remote_server_id": 1,
16
16
  "dest_remote_server_id": 1,
17
+ "src_site_id": 1,
18
+ "dest_site_id": 1,
17
19
  "two_way": true,
18
20
  "keep_after_copy": true,
19
21
  "delete_empty_folders": true,
@@ -81,6 +83,8 @@
81
83
  * `dest_path` (string): Absolute destination path for the sync
82
84
  * `src_remote_server_id` (int64): Remote server ID for the source (if remote)
83
85
  * `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
86
+ * `src_site_id` (int64): Source site ID if syncing from a child or partner site
87
+ * `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
84
88
  * `two_way` (boolean): Is this a two-way sync?
85
89
  * `keep_after_copy` (boolean): Keep files after copying?
86
90
  * `delete_empty_folders` (boolean): Delete empty folders after sync?
@@ -136,48 +140,56 @@ Files::Sync.find(id)
136
140
 
137
141
  ```
138
142
  Files::Sync.create(
139
- name: "example",
143
+ delete_empty_folders: true,
140
144
  description: "example",
141
- src_path: "example",
142
145
  dest_path: "example",
143
- src_remote_server_id: 1,
144
146
  dest_remote_server_id: 1,
145
- keep_after_copy: false,
146
- delete_empty_folders: false,
147
- disabled: false,
148
- interval: "week",
149
- trigger: "example",
150
- trigger_file: "example",
147
+ dest_site_id: 1,
148
+ disabled: true,
149
+ exclude_patterns: ["example"],
151
150
  holiday_region: "us_dc",
152
- sync_interval_minutes: 1,
151
+ include_patterns: ["example"],
152
+ interval: "week",
153
+ keep_after_copy: true,
154
+ name: "example",
153
155
  recurring_day: 25,
154
- schedule_time_zone: "Eastern Time (US & Canada)",
155
156
  schedule_days_of_week: [0,2,4],
157
+ schedule_time_zone: "Eastern Time (US & Canada)",
156
158
  schedule_times_of_day: ["06:30","14:30"],
159
+ src_path: "example",
160
+ src_remote_server_id: 1,
161
+ src_site_id: 1,
162
+ sync_interval_minutes: 1,
163
+ trigger: "example",
164
+ trigger_file: "example",
157
165
  workspace_id: 1
158
166
  )
159
167
  ```
160
168
 
161
169
  ### Parameters
162
170
 
163
- * `name` (string): Name for this sync job
164
- * `description` (string): Description for this sync job
165
- * `src_path` (string): Absolute source path
166
- * `dest_path` (string): Absolute destination path
167
- * `src_remote_server_id` (int64): Remote server ID for the source
168
- * `dest_remote_server_id` (int64): Remote server ID for the destination
169
- * `keep_after_copy` (boolean): Keep files after copying?
170
171
  * `delete_empty_folders` (boolean): Delete empty folders after sync?
172
+ * `description` (string): Description for this sync job
173
+ * `dest_path` (string): Absolute destination path for the sync
174
+ * `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
175
+ * `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
171
176
  * `disabled` (boolean): Is this sync disabled?
172
- * `interval` (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`
173
- * `trigger` (string): Trigger type: daily, custom_schedule, or manual
174
- * `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.
177
+ * `exclude_patterns` (array(string)): Array of glob patterns to exclude
175
178
  * `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
176
- * `sync_interval_minutes` (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.
179
+ * `include_patterns` (array(string)): Array of glob patterns to include
180
+ * `interval` (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`
181
+ * `keep_after_copy` (boolean): Keep files after copying?
182
+ * `name` (string): Name for this sync job
177
183
  * `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`.
178
- * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
179
184
  * `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.
185
+ * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
180
186
  * `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.
187
+ * `src_path` (string): Absolute source path for the sync
188
+ * `src_remote_server_id` (int64): Remote server ID for the source (if remote)
189
+ * `src_site_id` (int64): Source site ID if syncing from a child or partner site
190
+ * `sync_interval_minutes` (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.
191
+ * `trigger` (string): Trigger type: daily, custom_schedule, or manual
192
+ * `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.
181
193
  * `workspace_id` (int64): Workspace ID this sync belongs to
182
194
 
183
195
 
@@ -213,48 +225,56 @@ Files::Sync.manual_run(id)
213
225
 
214
226
  ```
215
227
  Files::Sync.update(id,
216
- name: "example",
228
+ delete_empty_folders: true,
217
229
  description: "example",
218
- src_path: "example",
219
230
  dest_path: "example",
220
- src_remote_server_id: 1,
221
231
  dest_remote_server_id: 1,
222
- keep_after_copy: false,
223
- delete_empty_folders: false,
224
- disabled: false,
225
- interval: "week",
226
- trigger: "example",
227
- trigger_file: "example",
232
+ dest_site_id: 1,
233
+ disabled: true,
234
+ exclude_patterns: ["example"],
228
235
  holiday_region: "us_dc",
229
- sync_interval_minutes: 1,
236
+ include_patterns: ["example"],
237
+ interval: "week",
238
+ keep_after_copy: true,
239
+ name: "example",
230
240
  recurring_day: 25,
231
- schedule_time_zone: "Eastern Time (US & Canada)",
232
241
  schedule_days_of_week: [0,2,4],
233
- schedule_times_of_day: ["06:30","14:30"]
242
+ schedule_time_zone: "Eastern Time (US & Canada)",
243
+ schedule_times_of_day: ["06:30","14:30"],
244
+ src_path: "example",
245
+ src_remote_server_id: 1,
246
+ src_site_id: 1,
247
+ sync_interval_minutes: 1,
248
+ trigger: "example",
249
+ trigger_file: "example"
234
250
  )
235
251
  ```
236
252
 
237
253
  ### Parameters
238
254
 
239
255
  * `id` (int64): Required - Sync ID.
240
- * `name` (string): Name for this sync job
241
- * `description` (string): Description for this sync job
242
- * `src_path` (string): Absolute source path
243
- * `dest_path` (string): Absolute destination path
244
- * `src_remote_server_id` (int64): Remote server ID for the source
245
- * `dest_remote_server_id` (int64): Remote server ID for the destination
246
- * `keep_after_copy` (boolean): Keep files after copying?
247
256
  * `delete_empty_folders` (boolean): Delete empty folders after sync?
257
+ * `description` (string): Description for this sync job
258
+ * `dest_path` (string): Absolute destination path for the sync
259
+ * `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
260
+ * `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
248
261
  * `disabled` (boolean): Is this sync disabled?
249
- * `interval` (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`
250
- * `trigger` (string): Trigger type: daily, custom_schedule, or manual
251
- * `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.
262
+ * `exclude_patterns` (array(string)): Array of glob patterns to exclude
252
263
  * `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
253
- * `sync_interval_minutes` (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.
264
+ * `include_patterns` (array(string)): Array of glob patterns to include
265
+ * `interval` (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`
266
+ * `keep_after_copy` (boolean): Keep files after copying?
267
+ * `name` (string): Name for this sync job
254
268
  * `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`.
255
- * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
256
269
  * `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.
270
+ * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
257
271
  * `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.
272
+ * `src_path` (string): Absolute source path for the sync
273
+ * `src_remote_server_id` (int64): Remote server ID for the source (if remote)
274
+ * `src_site_id` (int64): Source site ID if syncing from a child or partner site
275
+ * `sync_interval_minutes` (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.
276
+ * `trigger` (string): Trigger type: daily, custom_schedule, or manual
277
+ * `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.
258
278
 
259
279
 
260
280
  ---
@@ -308,48 +328,56 @@ sync.manual_run
308
328
  sync = Files::Sync.find(id)
309
329
 
310
330
  sync.update(
311
- name: "example",
331
+ delete_empty_folders: true,
312
332
  description: "example",
313
- src_path: "example",
314
333
  dest_path: "example",
315
- src_remote_server_id: 1,
316
334
  dest_remote_server_id: 1,
317
- keep_after_copy: false,
318
- delete_empty_folders: false,
319
- disabled: false,
320
- interval: "week",
321
- trigger: "example",
322
- trigger_file: "example",
335
+ dest_site_id: 1,
336
+ disabled: true,
337
+ exclude_patterns: ["example"],
323
338
  holiday_region: "us_dc",
324
- sync_interval_minutes: 1,
339
+ include_patterns: ["example"],
340
+ interval: "week",
341
+ keep_after_copy: true,
342
+ name: "example",
325
343
  recurring_day: 25,
326
- schedule_time_zone: "Eastern Time (US & Canada)",
327
344
  schedule_days_of_week: [0,2,4],
328
- schedule_times_of_day: ["06:30","14:30"]
345
+ schedule_time_zone: "Eastern Time (US & Canada)",
346
+ schedule_times_of_day: ["06:30","14:30"],
347
+ src_path: "example",
348
+ src_remote_server_id: 1,
349
+ src_site_id: 1,
350
+ sync_interval_minutes: 1,
351
+ trigger: "example",
352
+ trigger_file: "example"
329
353
  )
330
354
  ```
331
355
 
332
356
  ### Parameters
333
357
 
334
358
  * `id` (int64): Required - Sync ID.
335
- * `name` (string): Name for this sync job
336
- * `description` (string): Description for this sync job
337
- * `src_path` (string): Absolute source path
338
- * `dest_path` (string): Absolute destination path
339
- * `src_remote_server_id` (int64): Remote server ID for the source
340
- * `dest_remote_server_id` (int64): Remote server ID for the destination
341
- * `keep_after_copy` (boolean): Keep files after copying?
342
359
  * `delete_empty_folders` (boolean): Delete empty folders after sync?
360
+ * `description` (string): Description for this sync job
361
+ * `dest_path` (string): Absolute destination path for the sync
362
+ * `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
363
+ * `dest_site_id` (int64): Destination site ID if syncing to a child or partner site
343
364
  * `disabled` (boolean): Is this sync disabled?
344
- * `interval` (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`
345
- * `trigger` (string): Trigger type: daily, custom_schedule, or manual
346
- * `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.
365
+ * `exclude_patterns` (array(string)): Array of glob patterns to exclude
347
366
  * `holiday_region` (string): If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
348
- * `sync_interval_minutes` (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.
367
+ * `include_patterns` (array(string)): Array of glob patterns to include
368
+ * `interval` (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`
369
+ * `keep_after_copy` (boolean): Keep files after copying?
370
+ * `name` (string): Name for this sync job
349
371
  * `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`.
350
- * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
351
372
  * `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.
373
+ * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
352
374
  * `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.
375
+ * `src_path` (string): Absolute source path for the sync
376
+ * `src_remote_server_id` (int64): Remote server ID for the source (if remote)
377
+ * `src_site_id` (int64): Source site ID if syncing from a child or partner site
378
+ * `sync_interval_minutes` (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.
379
+ * `trigger` (string): Trigger type: daily, custom_schedule, or manual
380
+ * `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.
353
381
 
354
382
 
355
383
  ---
@@ -99,6 +99,24 @@ module Files
99
99
  @attributes[:dest_remote_server_id] = value
100
100
  end
101
101
 
102
+ # int64 - Source site ID if syncing from a child or partner site
103
+ def src_site_id
104
+ @attributes[:src_site_id]
105
+ end
106
+
107
+ def src_site_id=(value)
108
+ @attributes[:src_site_id] = value
109
+ end
110
+
111
+ # int64 - Destination site ID if syncing to a child or partner site
112
+ def dest_site_id
113
+ @attributes[:dest_site_id]
114
+ end
115
+
116
+ def dest_site_id=(value)
117
+ @attributes[:dest_site_id] = value
118
+ end
119
+
102
120
  # boolean - Is this a two-way sync?
103
121
  def two_way
104
122
  @attributes[:two_way]
@@ -276,44 +294,52 @@ module Files
276
294
  end
277
295
 
278
296
  # Parameters:
279
- # name - string - Name for this sync job
280
- # description - string - Description for this sync job
281
- # src_path - string - Absolute source path
282
- # dest_path - string - Absolute destination path
283
- # src_remote_server_id - int64 - Remote server ID for the source
284
- # dest_remote_server_id - int64 - Remote server ID for the destination
285
- # keep_after_copy - boolean - Keep files after copying?
286
297
  # delete_empty_folders - boolean - Delete empty folders after sync?
298
+ # description - string - Description for this sync job
299
+ # dest_path - string - Absolute destination path for the sync
300
+ # dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
301
+ # dest_site_id - int64 - Destination site ID if syncing to a child or partner site
287
302
  # disabled - boolean - Is this sync disabled?
288
- # interval - 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`
289
- # trigger - string - Trigger type: daily, custom_schedule, or manual
290
- # 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.
303
+ # exclude_patterns - array(string) - Array of glob patterns to exclude
291
304
  # holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
292
- # sync_interval_minutes - 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.
305
+ # include_patterns - array(string) - Array of glob patterns to include
306
+ # interval - 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`
307
+ # keep_after_copy - boolean - Keep files after copying?
308
+ # name - string - Name for this sync job
293
309
  # 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`.
294
- # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
295
310
  # 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.
311
+ # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
296
312
  # 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.
313
+ # src_path - string - Absolute source path for the sync
314
+ # src_remote_server_id - int64 - Remote server ID for the source (if remote)
315
+ # src_site_id - int64 - Source site ID if syncing from a child or partner site
316
+ # sync_interval_minutes - 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.
317
+ # trigger - string - Trigger type: daily, custom_schedule, or manual
318
+ # 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.
297
319
  def update(params = {})
298
320
  params ||= {}
299
321
  params[:id] = @attributes[:id]
300
322
  raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
301
323
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
302
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
303
324
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
304
- raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
305
325
  raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
306
- 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)
307
326
  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)
308
- raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
309
- raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
310
- raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
327
+ raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
328
+ raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
311
329
  raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
312
- raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
330
+ raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
331
+ raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
332
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
313
333
  raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
314
- 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)
315
334
  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)
335
+ 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)
316
336
  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)
337
+ raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
338
+ 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)
339
+ raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
340
+ raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
341
+ raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
342
+ raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
317
343
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
318
344
 
319
345
  Api.send_request("/syncs/#{@attributes[:id]}", :patch, params, @options)
@@ -382,41 +408,49 @@ module Files
382
408
  end
383
409
 
384
410
  # Parameters:
385
- # name - string - Name for this sync job
386
- # description - string - Description for this sync job
387
- # src_path - string - Absolute source path
388
- # dest_path - string - Absolute destination path
389
- # src_remote_server_id - int64 - Remote server ID for the source
390
- # dest_remote_server_id - int64 - Remote server ID for the destination
391
- # keep_after_copy - boolean - Keep files after copying?
392
411
  # delete_empty_folders - boolean - Delete empty folders after sync?
412
+ # description - string - Description for this sync job
413
+ # dest_path - string - Absolute destination path for the sync
414
+ # dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
415
+ # dest_site_id - int64 - Destination site ID if syncing to a child or partner site
393
416
  # disabled - boolean - Is this sync disabled?
394
- # interval - 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`
395
- # trigger - string - Trigger type: daily, custom_schedule, or manual
396
- # 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.
417
+ # exclude_patterns - array(string) - Array of glob patterns to exclude
397
418
  # holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
398
- # sync_interval_minutes - 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.
419
+ # include_patterns - array(string) - Array of glob patterns to include
420
+ # interval - 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`
421
+ # keep_after_copy - boolean - Keep files after copying?
422
+ # name - string - Name for this sync job
399
423
  # 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`.
400
- # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
401
424
  # 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.
425
+ # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
402
426
  # 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.
427
+ # src_path - string - Absolute source path for the sync
428
+ # src_remote_server_id - int64 - Remote server ID for the source (if remote)
429
+ # src_site_id - int64 - Source site ID if syncing from a child or partner site
430
+ # sync_interval_minutes - 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.
431
+ # trigger - string - Trigger type: daily, custom_schedule, or manual
432
+ # 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.
403
433
  # workspace_id - int64 - Workspace ID this sync belongs to
404
434
  def self.create(params = {}, options = {})
405
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
406
435
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
407
- raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
408
436
  raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
409
- 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)
410
437
  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)
411
- raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
412
- raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
413
- raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
438
+ raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
439
+ raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
414
440
  raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
415
- raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
441
+ raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
442
+ raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
443
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
416
444
  raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
417
- 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)
418
445
  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)
446
+ 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)
419
447
  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)
448
+ raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
449
+ 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)
450
+ raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
451
+ raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
452
+ raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
453
+ raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
420
454
  raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
421
455
 
422
456
  response, options = Api.send_request("/syncs", :post, params, options)
@@ -446,43 +480,51 @@ module Files
446
480
  end
447
481
 
448
482
  # Parameters:
449
- # name - string - Name for this sync job
450
- # description - string - Description for this sync job
451
- # src_path - string - Absolute source path
452
- # dest_path - string - Absolute destination path
453
- # src_remote_server_id - int64 - Remote server ID for the source
454
- # dest_remote_server_id - int64 - Remote server ID for the destination
455
- # keep_after_copy - boolean - Keep files after copying?
456
483
  # delete_empty_folders - boolean - Delete empty folders after sync?
484
+ # description - string - Description for this sync job
485
+ # dest_path - string - Absolute destination path for the sync
486
+ # dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
487
+ # dest_site_id - int64 - Destination site ID if syncing to a child or partner site
457
488
  # disabled - boolean - Is this sync disabled?
458
- # interval - 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`
459
- # trigger - string - Trigger type: daily, custom_schedule, or manual
460
- # 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.
489
+ # exclude_patterns - array(string) - Array of glob patterns to exclude
461
490
  # holiday_region - string - If trigger is `custom_schedule`, the sync will check if there is a formal, observed holiday for the region, and if so, it will not run.
462
- # sync_interval_minutes - 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.
491
+ # include_patterns - array(string) - Array of glob patterns to include
492
+ # interval - 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`
493
+ # keep_after_copy - boolean - Keep files after copying?
494
+ # name - string - Name for this sync job
463
495
  # 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`.
464
- # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
465
496
  # 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.
497
+ # schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
466
498
  # 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.
499
+ # src_path - string - Absolute source path for the sync
500
+ # src_remote_server_id - int64 - Remote server ID for the source (if remote)
501
+ # src_site_id - int64 - Source site ID if syncing from a child or partner site
502
+ # sync_interval_minutes - 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.
503
+ # trigger - string - Trigger type: daily, custom_schedule, or manual
504
+ # 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.
467
505
  def self.update(id, params = {}, options = {})
468
506
  params ||= {}
469
507
  params[:id] = id
470
508
  raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
471
- raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
472
509
  raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
473
- raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
474
510
  raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
475
- 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)
476
511
  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)
477
- raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
478
- raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
479
- raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
512
+ raise InvalidParameterError.new("Bad parameter: dest_site_id must be an Integer") if params[:dest_site_id] and !params[:dest_site_id].is_a?(Integer)
513
+ raise InvalidParameterError.new("Bad parameter: exclude_patterns must be an Array") if params[:exclude_patterns] and !params[:exclude_patterns].is_a?(Array)
480
514
  raise InvalidParameterError.new("Bad parameter: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
481
- raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
515
+ raise InvalidParameterError.new("Bad parameter: include_patterns must be an Array") if params[:include_patterns] and !params[:include_patterns].is_a?(Array)
516
+ raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
517
+ raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
482
518
  raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
483
- 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)
484
519
  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)
520
+ 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)
485
521
  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)
522
+ raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
523
+ 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)
524
+ raise InvalidParameterError.new("Bad parameter: src_site_id must be an Integer") if params[:src_site_id] and !params[:src_site_id].is_a?(Integer)
525
+ raise InvalidParameterError.new("Bad parameter: sync_interval_minutes must be an Integer") if params[:sync_interval_minutes] and !params[:sync_interval_minutes].is_a?(Integer)
526
+ raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
527
+ raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
486
528
  raise MissingParameterError.new("Parameter missing: id") unless params[:id]
487
529
 
488
530
  response, options = Api.send_request("/syncs/#{params[:id]}", :patch, params, options)
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.590"
4
+ VERSION = "1.1.591"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.590
4
+ version: 1.1.591
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-31 00:00:00.000000000 Z
11
+ date: 2026-04-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable