files.com 1.1.267 → 1.1.268

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b751a57b99cdab4b5cde0eb4faa82d33d4ce90b9f3bc24e8a97f321517d2d73
-  data.tar.gz: 3032c5f62e712734e40e123e3f1afdb0ff5761a7f2652a2f44337e64dee8d52e
+  metadata.gz: b433bf1d351c20cd04af853b765bee5b088ac190875f37586400b94ac0d95b6b
+  data.tar.gz: 1fd1bf08d017b6ca0c72e8c17cd33079cacb4fd4bce033dc2e56f9f8681e38ca
 SHA512:
-  metadata.gz: 0cf8517345c9c630bf36fdb6dd2a35925bc7f0bc904a93e67d4203daf4d8092b897d4d802b429c51bb6979841206407c033881de187ab7aed99e4a699c8c24fd
-  data.tar.gz: 62aab342eb95da45d402c74921b23460f7ab5fb5e4aefb14ec941f1d4f07b93aae304d2facb844f22fd43b60b0c516e15454da29a5bb69b212cb2c79357d8856
+  metadata.gz: ad2b7052c2eda5e359a055e81008090fa7ca51c1384e910f66150f1b9c3f16d9b22023b40e1632c08730c7526a91ae093393e36608c9548d9f30c73ad39ca2ca
+  data.tar.gz: 968b71fa49008619d34f22f3db9b30ff020606fe7a0d8fde9db2200c7138645a8fd64e8435a2c4ee49e3272ee3aa34b37a084d436e004e2b12b45e9118c3d091

data/_VERSION

@@ -1 +1 @@
-1.1.267
+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_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.

data/lib/files.com/models/site.rb

@@ -284,6 +284,11 @@ module Files
       @attributes[:legacy_checksums_mode]
     end
 
+    # boolean - If true, we will migrate all remote server syncs to the new Sync model.
+    def migrate_remote_server_sync_to_sync
+      @attributes[:migrate_remote_server_sync_to_sync]
+    end
+
     # boolean - Is the mobile app enabled?
     def mobile_app
       @attributes[:mobile_app]
@@ -912,6 +917,7 @@ module Files
     #   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/lib/files.com/models/sync.rb

@@ -0,0 +1,426 @@
+# frozen_string_literal: true
+
+module Files
+  class Sync
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Sync ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Name for this sync job
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Description for this sync job
+    def description
+      @attributes[:description]
+    end
+
+    def description=(value)
+      @attributes[:description] = value
+    end
+
+    # int64 - Site ID this sync belongs to
+    def site_id
+      @attributes[:site_id]
+    end
+
+    def site_id=(value)
+      @attributes[:site_id] = value
+    end
+
+    # int64 - User who created or owns this sync
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # string - Absolute source path for the sync
+    def src_path
+      @attributes[:src_path]
+    end
+
+    def src_path=(value)
+      @attributes[:src_path] = value
+    end
+
+    # string - Absolute destination path for the sync
+    def dest_path
+      @attributes[:dest_path]
+    end
+
+    def dest_path=(value)
+      @attributes[:dest_path] = value
+    end
+
+    # int64 - Remote server ID for the source (if remote)
+    def src_remote_server_id
+      @attributes[:src_remote_server_id]
+    end
+
+    def src_remote_server_id=(value)
+      @attributes[:src_remote_server_id] = value
+    end
+
+    # int64 - Remote server ID for the destination (if remote)
+    def dest_remote_server_id
+      @attributes[:dest_remote_server_id]
+    end
+
+    def dest_remote_server_id=(value)
+      @attributes[:dest_remote_server_id] = value
+    end
+
+    # boolean - Is this a two-way sync?
+    def two_way
+      @attributes[:two_way]
+    end
+
+    def two_way=(value)
+      @attributes[:two_way] = value
+    end
+
+    # boolean - Keep files after copying?
+    def keep_after_copy
+      @attributes[:keep_after_copy]
+    end
+
+    def keep_after_copy=(value)
+      @attributes[:keep_after_copy] = value
+    end
+
+    # boolean - Delete empty folders after sync?
+    def delete_empty_folders
+      @attributes[:delete_empty_folders]
+    end
+
+    def delete_empty_folders=(value)
+      @attributes[:delete_empty_folders] = value
+    end
+
+    # boolean - Is this sync disabled?
+    def disabled
+      @attributes[:disabled]
+    end
+
+    def disabled=(value)
+      @attributes[:disabled] = value
+    end
+
+    # 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`
+    def interval
+      @attributes[:interval]
+    end
+
+    def interval=(value)
+      @attributes[:interval] = value
+    end
+
+    # string - Trigger type: daily, custom_schedule, or manual
+    def trigger
+      @attributes[:trigger]
+    end
+
+    def trigger=(value)
+      @attributes[:trigger] = value
+    end
+
+    # 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.
+    def trigger_file
+      @attributes[:trigger_file]
+    end
+
+    def trigger_file=(value)
+      @attributes[:trigger_file] = value
+    end
+
+    # array(array) - Array of glob patterns to include
+    def include_patterns
+      @attributes[:include_patterns]
+    end
+
+    def include_patterns=(value)
+      @attributes[:include_patterns] = value
+    end
+
+    # array(array) - Array of glob patterns to exclude
+    def exclude_patterns
+      @attributes[:exclude_patterns]
+    end
+
+    def exclude_patterns=(value)
+      @attributes[:exclude_patterns] = value
+    end
+
+    # date-time - When this sync was created
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - When this sync was last updated
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # 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.
+    def sync_interval_minutes
+      @attributes[:sync_interval_minutes]
+    end
+
+    def sync_interval_minutes=(value)
+      @attributes[:sync_interval_minutes] = value
+    end
+
+    # int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
+    def recurring_day
+      @attributes[:recurring_day]
+    end
+
+    def recurring_day=(value)
+      @attributes[:recurring_day] = value
+    end
+
+    # 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.
+    def schedule_days_of_week
+      @attributes[:schedule_days_of_week]
+    end
+
+    def schedule_days_of_week=(value)
+      @attributes[:schedule_days_of_week] = value
+    end
+
+    # array(string) - If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
+    def schedule_times_of_day
+      @attributes[:schedule_times_of_day]
+    end
+
+    def schedule_times_of_day=(value)
+      @attributes[:schedule_times_of_day] = value
+    end
+
+    # string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
+    def schedule_time_zone
+      @attributes[:schedule_time_zone]
+    end
+
+    def schedule_time_zone=(value)
+      @attributes[:schedule_time_zone] = value
+    end
+
+    # 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.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
+      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)
+      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)
+      raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
+      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)
+      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)
+      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)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/syncs/#{@attributes[:id]}", :patch, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/syncs/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+      nil
+    end
+
+    def save
+      if @attributes[:id]
+        new_obj = update(@attributes)
+      else
+        new_obj = Sync.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # 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).
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+
+      List.new(Sync, params) do
+        Api.send_request("/syncs", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Sync ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/syncs/#{params[:id]}", :get, params, options)
+      Sync.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # 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.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
+      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)
+      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)
+      raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
+      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)
+      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)
+      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)
+
+      response, options = Api.send_request("/syncs", :post, params, options)
+      Sync.new(response.data, options)
+    end
+
+    def self.create_migrate_to(params = {}, options = {})
+      Api.send_request("/syncs/migrate_to_syncs", :post, params, options)
+      nil
+    end
+
+    # 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.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: src_path must be an String") if params[:src_path] and !params[:src_path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: dest_path must be an String") if params[:dest_path] and !params[:dest_path].is_a?(String)
+      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)
+      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)
+      raise InvalidParameterError.new("Bad parameter: interval must be an Integer") if params[:interval] and !params[:interval].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: trigger_file must be an String") if params[:trigger_file] and !params[:trigger_file].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
+      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)
+      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)
+      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)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/syncs/#{params[:id]}", :patch, params, options)
+      Sync.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/syncs/#{params[:id]}", :delete, params, options)
+      nil
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+      nil
+    end
+  end
+end

data/lib/files.com/models/sync_run.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Files
+  class SyncRun
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - SyncRun ID
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - ID of the Sync this run belongs to
+    def sync_id
+      @attributes[:sync_id]
+    end
+
+    # int64 - Site ID
+    def site_id
+      @attributes[:site_id]
+    end
+
+    # string - Status of the sync run (success, failure, partial_failure, in_progress, skipped)
+    def status
+      @attributes[:status]
+    end
+
+    # string - Type of remote server used, if any
+    def remote_server_type
+      @attributes[:remote_server_type]
+    end
+
+    # string - Log or summary body for this run
+    def body
+      @attributes[:body]
+    end
+
+    # array(array) - Array of errors encountered during the run
+    def event_errors
+      @attributes[:event_errors]
+    end
+
+    # int64 - Total bytes synced in this run
+    def bytes_synced
+      @attributes[:bytes_synced]
+    end
+
+    # int64 - Number of files compared
+    def compared_files
+      @attributes[:compared_files]
+    end
+
+    # int64 - Number of folders compared
+    def compared_folders
+      @attributes[:compared_folders]
+    end
+
+    # int64 - Number of files that errored
+    def errored_files
+      @attributes[:errored_files]
+    end
+
+    # int64 - Number of files successfully synced
+    def successful_files
+      @attributes[:successful_files]
+    end
+
+    # float - Total runtime in seconds
+    def runtime
+      @attributes[:runtime]
+    end
+
+    # string - S3 path to the main log file
+    def s3_body_path
+      @attributes[:s3_body_path]
+    end
+
+    # string - S3 path to the internal log file
+    def s3_internal_body_path
+      @attributes[:s3_internal_body_path]
+    end
+
+    # date-time - When this run was completed
+    def completed_at
+      @attributes[:completed_at]
+    end
+
+    # boolean - Whether notifications were sent for this run
+    def notified
+      @attributes[:notified]
+    end
+
+    # date-time - When this run was created
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - When this run was last updated
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # 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 (required) - int64 - ID of the Sync this run belongs to
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: sync_id must be an Integer") if params[:sync_id] and !params[:sync_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: sync_id") unless params[:sync_id]
+
+      List.new(SyncRun, params) do
+        Api.send_request("/sync_runs", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Sync Run ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/sync_runs/#{params[:id]}", :get, params, options)
+      SyncRun.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.267"
+  VERSION = "1.1.268"
 end

data/lib/files.com.rb

@@ -120,7 +120,9 @@ require "files.com/models/snapshot"
 require "files.com/models/sso_strategy"
 require "files.com/models/status"
 require "files.com/models/style"
+require "files.com/models/sync"
 require "files.com/models/sync_log"
+require "files.com/models/sync_run"
 require "files.com/models/usage_by_top_level_dir"
 require "files.com/models/usage_daily_snapshot"
 require "files.com/models/usage_snapshot"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.267
+  version: 1.1.268
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-09 00:00:00.000000000 Z
+date: 2025-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -203,7 +203,9 @@ files:
 - docs/sso_strategy.md
 - docs/status.md
 - docs/style.md
+- docs/sync.md
 - docs/sync_log.md
+- docs/sync_run.md
 - docs/usage_by_top_level_dir.md
 - docs/usage_daily_snapshot.md
 - docs/usage_snapshot.md
@@ -310,7 +312,9 @@ files:
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb
 - lib/files.com/models/style.rb
+- lib/files.com/models/sync.rb
 - lib/files.com/models/sync_log.rb
+- lib/files.com/models/sync_run.rb
 - lib/files.com/models/usage_by_top_level_dir.rb
 - lib/files.com/models/usage_daily_snapshot.rb
 - lib/files.com/models/usage_snapshot.rb