files.com 1.1.266 → 1.1.268

data/docs/site.md

@@ -68,6 +68,7 @@
   "desktop_app_session_ip_pinning": true,
   "desktop_app_session_lifetime": 1,
   "legacy_checksums_mode": true,
+  "migrate_remote_server_sync_to_sync": true,
   "mobile_app": true,
   "mobile_app_session_ip_pinning": true,
   "mobile_app_session_lifetime": 1,
@@ -358,6 +359,7 @@
 * `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
 * `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
 * `legacy_checksums_mode` (boolean): Use legacy checksums mode?
+* `migrate_remote_server_sync_to_sync` (boolean): If true, we will migrate all remote server syncs to the new Sync model.
 * `mobile_app` (boolean): Is the mobile app enabled?
 * `mobile_app_session_ip_pinning` (boolean): Is mobile app session IP pinning enabled?
 * `mobile_app_session_lifetime` (int64): Mobile app session lifetime (in hours)
@@ -540,6 +542,7 @@ Files::Site.update(
   calculate_file_checksums_sha1: false, 
   calculate_file_checksums_sha256: false, 
   legacy_checksums_mode: false, 
+  migrate_remote_server_sync_to_sync: false, 
   session_expiry: 1.0, 
   ssl_required: false, 
   tls_disabled: false, 
@@ -699,6 +702,7 @@ Files::Site.update(
 * `calculate_file_checksums_sha1` (boolean): Calculate SHA1 checksums for files?
 * `calculate_file_checksums_sha256` (boolean): Calculate SHA256 checksums for files?
 * `legacy_checksums_mode` (boolean): Use legacy checksums mode?
+* `migrate_remote_server_sync_to_sync` (boolean): If true, we will migrate all remote server syncs to the new Sync model.
 * `session_expiry` (double): Session expiry in hours
 * `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
 * `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.

data/docs/sync.md

@@ -0,0 +1,275 @@
+# Sync
+
+## Example Sync Object
+
+```
+{
+  "id": 1,
+  "name": "example",
+  "description": "example",
+  "site_id": 1,
+  "user_id": 1,
+  "src_path": "example",
+  "dest_path": "example",
+  "src_remote_server_id": 1,
+  "dest_remote_server_id": 1,
+  "two_way": true,
+  "keep_after_copy": true,
+  "delete_empty_folders": true,
+  "disabled": true,
+  "interval": "week",
+  "trigger": "example",
+  "trigger_file": "example",
+  "include_patterns": "example",
+  "exclude_patterns": "example",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z",
+  "sync_interval_minutes": 1,
+  "recurring_day": 25,
+  "schedule_days_of_week": [
+    0,
+    2,
+    4
+  ],
+  "schedule_times_of_day": [
+    "06:30",
+    "14:30"
+  ],
+  "schedule_time_zone": "Eastern Time (US & Canada)"
+}
+```
+
+* `id` (int64): Sync ID
+* `name` (string): Name for this sync job
+* `description` (string): Description for this sync job
+* `site_id` (int64): Site ID this sync belongs to
+* `user_id` (int64): User who created or owns this sync
+* `src_path` (string): Absolute source path for the sync
+* `dest_path` (string): Absolute destination path for the sync
+* `src_remote_server_id` (int64): Remote server ID for the source (if remote)
+* `dest_remote_server_id` (int64): Remote server ID for the destination (if remote)
+* `two_way` (boolean): Is this a two-way sync?
+* `keep_after_copy` (boolean): Keep files after copying?
+* `delete_empty_folders` (boolean): Delete empty folders after sync?
+* `disabled` (boolean): Is this sync disabled?
+* `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`
+* `trigger` (string): Trigger type: daily, custom_schedule, or manual
+* `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.
+* `include_patterns` (array(array)): Array of glob patterns to include
+* `exclude_patterns` (array(array)): Array of glob patterns to exclude
+* `created_at` (date-time): When this sync was created
+* `updated_at` (date-time): When this sync was last updated
+* `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.
+* `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`.
+* `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.
+* `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.
+* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+
+
+---
+
+## List Syncs
+
+```
+Files::Sync.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+
+---
+
+## Show Sync
+
+```
+Files::Sync.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync ID.
+
+
+---
+
+## Create Sync
+
+```
+Files::Sync.create(
+  name: "example", 
+  description: "example", 
+  src_path: "example", 
+  dest_path: "example", 
+  src_remote_server_id: 1, 
+  dest_remote_server_id: 1, 
+  two_way: false, 
+  keep_after_copy: false, 
+  delete_empty_folders: false, 
+  disabled: false, 
+  interval: 1, 
+  trigger: "example", 
+  trigger_file: "example", 
+  recurring_day: 25, 
+  schedule_time_zone: "Eastern Time (US & Canada)", 
+  schedule_days_of_week: [0,2,4], 
+  schedule_times_of_day: ["06:30","14:30"]
+)
+```
+
+### Parameters
+
+* `name` (string): Name for this sync job
+* `description` (string): Description for this sync job
+* `src_path` (string): Absolute source path
+* `dest_path` (string): Absolute destination path
+* `src_remote_server_id` (int64): Remote server ID for the source
+* `dest_remote_server_id` (int64): Remote server ID for the destination
+* `two_way` (boolean): Is this a two-way sync?
+* `keep_after_copy` (boolean): Keep files after copying?
+* `delete_empty_folders` (boolean): Delete empty folders after sync?
+* `disabled` (boolean): Is this sync disabled?
+* `interval` (int64): Interval in minutes for sync (if scheduled)
+* `trigger` (string): Trigger type: daily, custom_schedule, or manual
+* `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.
+* `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`.
+* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+* `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.
+* `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.
+
+
+---
+
+## Migrate Legacy Syncs to Syncs
+
+```
+Files::Sync.create_migrate_to
+```
+
+
+---
+
+## Update Sync
+
+```
+Files::Sync.update(id, 
+  name: "example", 
+  description: "example", 
+  src_path: "example", 
+  dest_path: "example", 
+  src_remote_server_id: 1, 
+  dest_remote_server_id: 1, 
+  two_way: false, 
+  keep_after_copy: false, 
+  delete_empty_folders: false, 
+  disabled: false, 
+  interval: 1, 
+  trigger: "example", 
+  trigger_file: "example", 
+  recurring_day: 25, 
+  schedule_time_zone: "Eastern Time (US & Canada)", 
+  schedule_days_of_week: [0,2,4], 
+  schedule_times_of_day: ["06:30","14:30"]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync ID.
+* `name` (string): Name for this sync job
+* `description` (string): Description for this sync job
+* `src_path` (string): Absolute source path
+* `dest_path` (string): Absolute destination path
+* `src_remote_server_id` (int64): Remote server ID for the source
+* `dest_remote_server_id` (int64): Remote server ID for the destination
+* `two_way` (boolean): Is this a two-way sync?
+* `keep_after_copy` (boolean): Keep files after copying?
+* `delete_empty_folders` (boolean): Delete empty folders after sync?
+* `disabled` (boolean): Is this sync disabled?
+* `interval` (int64): Interval in minutes for sync (if scheduled)
+* `trigger` (string): Trigger type: daily, custom_schedule, or manual
+* `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.
+* `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`.
+* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+* `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.
+* `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.
+
+
+---
+
+## Delete Sync
+
+```
+Files::Sync.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync ID.
+
+
+---
+
+## Update Sync
+
+```
+sync = Files::Sync.find(id)
+
+sync.update(
+  name: "example",
+  description: "example",
+  src_path: "example",
+  dest_path: "example",
+  src_remote_server_id: 1,
+  dest_remote_server_id: 1,
+  two_way: false,
+  keep_after_copy: false,
+  delete_empty_folders: false,
+  disabled: false,
+  interval: 1,
+  trigger: "example",
+  trigger_file: "example",
+  recurring_day: 25,
+  schedule_time_zone: "Eastern Time (US & Canada)",
+  schedule_days_of_week: [0,2,4],
+  schedule_times_of_day: ["06:30","14:30"]
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync ID.
+* `name` (string): Name for this sync job
+* `description` (string): Description for this sync job
+* `src_path` (string): Absolute source path
+* `dest_path` (string): Absolute destination path
+* `src_remote_server_id` (int64): Remote server ID for the source
+* `dest_remote_server_id` (int64): Remote server ID for the destination
+* `two_way` (boolean): Is this a two-way sync?
+* `keep_after_copy` (boolean): Keep files after copying?
+* `delete_empty_folders` (boolean): Delete empty folders after sync?
+* `disabled` (boolean): Is this sync disabled?
+* `interval` (int64): Interval in minutes for sync (if scheduled)
+* `trigger` (string): Trigger type: daily, custom_schedule, or manual
+* `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.
+* `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`.
+* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+* `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.
+* `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.
+
+
+---
+
+## Delete Sync
+
+```
+sync = Files::Sync.find(id)
+
+sync.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync ID.

data/docs/sync_log.md

@@ -13,11 +13,12 @@
   "path": "example",
   "size": 1,
   "file_type": "example",
-  "status": "example"
+  "status": "example",
+  "created_at": "2000-01-01T01:00:00Z"
 }
 ```
 
-* `timestamp` (date-time): Start Time of Action
+* `timestamp` (date-time): Start Time of Action. Deprecrated: Use created_at.
 * `sync_id` (int64): Sync ID
 * `external_event_id` (int64): External Event ID
 * `error_type` (string): Error type, if applicable
@@ -27,6 +28,7 @@
 * `size` (int64): File size
 * `file_type` (string): File type
 * `status` (string): Status
+* `created_at` (date-time): Start Time of Action
 
 
 ---
@@ -41,5 +43,9 @@ Files::SyncLog.list
 
 * `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.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `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 `sync_id`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ external_event_id ]`, `[ operation ]`, `[ status ]`, `[ sync_id ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ status, sync_id ]`, `[ 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, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, status, sync_id ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, status, sync_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, status, sync_id ]`, `[ operation, status, sync_id ]`, `[ 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, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, operation, status, sync_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ 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, status, sync_id ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, sync_id ]` or `[ end_date, external_event_id, operation, status, sync_id ]`.
-* `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 ]`, `[ start_date, end_date ]`, `[ start_date, external_event_id ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, sync_id ]`, `[ end_date, external_event_id ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, sync_id ]`, `[ external_event_id, operation ]`, `[ external_event_id, status ]`, `[ external_event_id, sync_id ]`, `[ operation, status ]`, `[ operation, sync_id ]`, `[ status, sync_id ]`, `[ 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, external_event_id, operation ]`, `[ start_date, external_event_id, status ]`, `[ start_date, external_event_id, sync_id ]`, `[ start_date, operation, status ]`, `[ start_date, operation, sync_id ]`, `[ start_date, status, sync_id ]`, `[ end_date, external_event_id, operation ]`, `[ end_date, external_event_id, status ]`, `[ end_date, external_event_id, sync_id ]`, `[ end_date, operation, status ]`, `[ end_date, operation, sync_id ]`, `[ end_date, status, sync_id ]`, `[ external_event_id, operation, status ]`, `[ external_event_id, operation, sync_id ]`, `[ external_event_id, status, sync_id ]`, `[ operation, status, sync_id ]`, `[ 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, operation, status ]`, `[ start_date, end_date, operation, sync_id ]`, `[ start_date, end_date, status, sync_id ]`, `[ start_date, external_event_id, operation, status ]`, `[ start_date, external_event_id, operation, sync_id ]`, `[ start_date, external_event_id, status, sync_id ]`, `[ start_date, operation, status, sync_id ]`, `[ end_date, external_event_id, operation, status ]`, `[ end_date, external_event_id, operation, sync_id ]`, `[ end_date, external_event_id, status, sync_id ]`, `[ end_date, operation, status, sync_id ]`, `[ external_event_id, operation, status, sync_id ]`, `[ 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, status, sync_id ]`, `[ start_date, end_date, operation, status, sync_id ]`, `[ start_date, external_event_id, operation, status, sync_id ]` or `[ end_date, external_event_id, operation, status, sync_id ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.
+* `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 ]`.

data/docs/sync_run.md

@@ -0,0 +1,81 @@
+# SyncRun
+
+## Example SyncRun Object
+
+```
+{
+  "id": 1,
+  "sync_id": 1,
+  "site_id": 1,
+  "status": "example",
+  "remote_server_type": "example",
+  "body": "example",
+  "event_errors": "example",
+  "bytes_synced": 1,
+  "compared_files": 1,
+  "compared_folders": 1,
+  "errored_files": 1,
+  "successful_files": 1,
+  "runtime": "example",
+  "s3_body_path": "example",
+  "s3_internal_body_path": "example",
+  "completed_at": "2000-01-01T01:00:00Z",
+  "notified": true,
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): SyncRun ID
+* `sync_id` (int64): ID of the Sync this run belongs to
+* `site_id` (int64): Site ID
+* `status` (string): Status of the sync run (success, failure, partial_failure, in_progress, skipped)
+* `remote_server_type` (string): Type of remote server used, if any
+* `body` (string): Log or summary body for this run
+* `event_errors` (array(array)): Array of errors encountered during the run
+* `bytes_synced` (int64): Total bytes synced in this run
+* `compared_files` (int64): Number of files compared
+* `compared_folders` (int64): Number of folders compared
+* `errored_files` (int64): Number of files that errored
+* `successful_files` (int64): Number of files successfully synced
+* `runtime` (float): Total runtime in seconds
+* `s3_body_path` (string): S3 path to the main log file
+* `s3_internal_body_path` (string): S3 path to the internal log file
+* `completed_at` (date-time): When this run was completed
+* `notified` (boolean): Whether notifications were sent for this run
+* `created_at` (date-time): When this run was created
+* `updated_at` (date-time): When this run was last updated
+
+
+---
+
+## List Sync Runs
+
+```
+Files::SyncRun.list(
+  user_id: 1, 
+  sync_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `sync_id`, `created_at` or `status`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status` and `sync_id`. Valid field combinations are `[ sync_id, status ]`.
+* `sync_id` (int64): Required - ID of the Sync this run belongs to
+
+
+---
+
+## Show Sync Run
+
+```
+Files::SyncRun.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sync Run ID.