files.com 1.1.704 → 1.1.705

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

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module Files
+  class Schedule
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Schedule ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Schedule name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # array(int64) - 0-based weekdays used by the Schedule. 0 is Sunday.
+    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) - Times of day in HH:MM format (24-hour).
+    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 - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    def schedule_time_zone
+      @attributes[:schedule_time_zone]
+    end
+
+    def schedule_time_zone=(value)
+      @attributes[:schedule_time_zone] = value
+    end
+
+    # string - Optional holiday region on which linked resources do not run.
+    def holiday_region
+      @attributes[:holiday_region]
+    end
+
+    def holiday_region=(value)
+      @attributes[:holiday_region] = value
+    end
+
+    # string - Human-readable Schedule description.
+    def human_readable_schedule
+      @attributes[:human_readable_schedule]
+    end
+
+    def human_readable_schedule=(value)
+      @attributes[:human_readable_schedule] = value
+    end
+
+    # date-time - Creation time.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - Last update time.
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # Parameters:
+    #   name - string - Schedule name.
+    #   schedule_days_of_week - array(int64) - 0-based weekdays used by the Schedule. 0 is Sunday.
+    #   schedule_times_of_day - array(string) - Times of day in HH:MM format (24-hour).
+    #   schedule_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   holiday_region - string - Optional holiday region on which linked resources do not run.
+    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: 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 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: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/schedules/#{@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("/schedules/#{@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 = Schedule.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: 10000, 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 `name`.
+    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)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+
+      List.new(Schedule, params) do
+        Api.send_request("/schedules", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Schedule 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("/schedules/#{params[:id]}", :get, params, options)
+      Schedule.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name (required) - string - Schedule name.
+    #   schedule_days_of_week (required) - array(int64) - 0-based weekdays used by the Schedule. 0 is Sunday.
+    #   schedule_times_of_day (required) - array(string) - Times of day in HH:MM format (24-hour).
+    #   schedule_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   holiday_region - string - Optional holiday region on which linked resources do not run.
+    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: 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 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: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+      raise MissingParameterError.new("Parameter missing: schedule_days_of_week") unless params[:schedule_days_of_week]
+      raise MissingParameterError.new("Parameter missing: schedule_times_of_day") unless params[:schedule_times_of_day]
+
+      response, options = Api.send_request("/schedules", :post, params, options)
+      Schedule.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - Schedule name.
+    #   schedule_days_of_week - array(int64) - 0-based weekdays used by the Schedule. 0 is Sunday.
+    #   schedule_times_of_day - array(string) - Times of day in HH:MM format (24-hour).
+    #   schedule_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   holiday_region - string - Optional holiday region on which linked resources do not run.
+    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: 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 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: holiday_region must be an String") if params[:holiday_region] and !params[:holiday_region].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/schedules/#{params[:id]}", :patch, params, options)
+      Schedule.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("/schedules/#{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/scheduled_export.rb

@@ -99,6 +99,15 @@ module Files
       @attributes[:recurring_day] = value
     end
 
+    # int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
+    def schedule_id
+      @attributes[:schedule_id]
+    end
+
+    def schedule_id=(value)
+      @attributes[:schedule_id] = value
+    end
+
     # array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
     def schedule_days_of_week
       @attributes[:schedule_days_of_week]
@@ -108,7 +117,7 @@ module Files
       @attributes[:schedule_days_of_week] = value
     end
 
-    # array(string) - Times of day in HH:MM format for schedule-driven exports.
+    # array(string) - Times of day in HH:MM format for the scheduled export schedule.
     def schedule_times_of_day
       @attributes[:schedule_times_of_day]
     end
@@ -117,7 +126,7 @@ module Files
       @attributes[:schedule_times_of_day] = value
     end
 
-    # string - Time zone used by the scheduled export.
+    # string - Time zone used by the scheduled export schedule.
     def schedule_time_zone
       @attributes[:schedule_time_zone]
     end
@@ -126,7 +135,7 @@ module Files
       @attributes[:schedule_time_zone] = value
     end
 
-    # string - Optional holiday region used by schedule-driven exports.
+    # string - Optional holiday region used by the scheduled export schedule.
     def holiday_region
       @attributes[:holiday_region]
     end
@@ -181,10 +190,11 @@ module Files
     #   trigger - string - Schedule trigger type: `daily` or `custom_schedule`.
     #   interval - string - If trigger is `daily`, this specifies how often to run the scheduled export.
     #   recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
+    #   schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
     #   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
-    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule-driven exports.
-    #   schedule_time_zone - string - Time zone used by the scheduled export.
-    #   holiday_region - string - Optional holiday region used by schedule-driven exports.
+    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for the scheduled export schedule.
+    #   schedule_time_zone - string - Time zone used by the scheduled export schedule.
+    #   holiday_region - string - Optional holiday region used by the scheduled export schedule.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -196,6 +206,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
@@ -278,10 +289,11 @@ module Files
     #   trigger - string - Schedule trigger type: `daily` or `custom_schedule`.
     #   interval - string - If trigger is `daily`, this specifies how often to run the scheduled export.
     #   recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
+    #   schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
     #   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
-    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule-driven exports.
-    #   schedule_time_zone - string - Time zone used by the scheduled export.
-    #   holiday_region - string - Optional holiday region used by schedule-driven exports.
+    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for the scheduled export schedule.
+    #   schedule_time_zone - string - Time zone used by the scheduled export schedule.
+    #   holiday_region - string - Optional holiday region used by the scheduled export schedule.
     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: export_type must be an String") if params[:export_type] and !params[:export_type].is_a?(String)
@@ -290,6 +302,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
@@ -310,10 +323,11 @@ module Files
     #   trigger - string - Schedule trigger type: `daily` or `custom_schedule`.
     #   interval - string - If trigger is `daily`, this specifies how often to run the scheduled export.
     #   recurring_day - int64 - If trigger is `daily`, this selects the day number inside the chosen interval.
+    #   schedule_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the scheduled export's schedule fields.
     #   schedule_days_of_week - array(int64) - If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
-    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for schedule-driven exports.
-    #   schedule_time_zone - string - Time zone used by the scheduled export.
-    #   holiday_region - string - Optional holiday region used by schedule-driven exports.
+    #   schedule_times_of_day - array(string) - Times of day in HH:MM format for the scheduled export schedule.
+    #   schedule_time_zone - string - Time zone used by the scheduled export schedule.
+    #   holiday_region - string - Optional holiday region used by the scheduled export schedule.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -325,6 +339,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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 InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)

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

@@ -235,6 +235,15 @@ module Files
       @attributes[:recurring_day] = value
     end
 
+    # int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
+    def schedule_id
+      @attributes[:schedule_id]
+    end
+
+    def schedule_id=(value)
+      @attributes[:schedule_id] = 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]
@@ -253,7 +262,7 @@ module Files
       @attributes[:schedule_times_of_day] = value
     end
 
-    # string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    # string - Time zone for the schedule. If not set, times are interpreted as UTC.
     def schedule_time_zone
       @attributes[:schedule_time_zone]
     end
@@ -262,7 +271,7 @@ module Files
       @attributes[:schedule_time_zone] = value
     end
 
-    # string - Skip sync if there is a formal, observed holiday for this region.
+    # string - Skip the sync if there is a formal, observed holiday for this region.
     def holiday_region
       @attributes[:holiday_region]
     end
@@ -309,14 +318,15 @@ module Files
     #   dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
     #   disabled - boolean - Is this sync disabled?
     #   exclude_patterns - array(string) - Array of glob patterns to exclude
-    #   holiday_region - string - Skip sync if there is a formal, observed holiday for this region.
+    #   holiday_region - string - Skip the sync if there is a formal, observed holiday for this region.
     #   include_patterns - array(string) - Array of glob patterns to include
     #   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`
     #   keep_after_copy - boolean - Keep files after copying?
     #   name - string - Name for this sync job
     #   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_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
     #   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_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   schedule_time_zone - string - Time zone for the schedule. If not set, times are interpreted as UTC.
     #   schedule_times_of_day - array(string) - Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
     #   src_path - string - Absolute source path for the sync
     #   src_remote_server_id - int64 - Remote server ID for the source (if remote)
@@ -338,6 +348,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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_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_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
@@ -420,14 +431,15 @@ module Files
     #   dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
     #   disabled - boolean - Is this sync disabled?
     #   exclude_patterns - array(string) - Array of glob patterns to exclude
-    #   holiday_region - string - Skip sync if there is a formal, observed holiday for this region.
+    #   holiday_region - string - Skip the sync if there is a formal, observed holiday for this region.
     #   include_patterns - array(string) - Array of glob patterns to include
     #   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`
     #   keep_after_copy - boolean - Keep files after copying?
     #   name - string - Name for this sync job
     #   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_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
     #   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_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   schedule_time_zone - string - Time zone for the schedule. If not set, times are interpreted as UTC.
     #   schedule_times_of_day - array(string) - Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
     #   src_path - string - Absolute source path for the sync
     #   src_remote_server_id - int64 - Remote server ID for the source (if remote)
@@ -446,6 +458,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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_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_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
@@ -489,14 +502,15 @@ module Files
     #   dest_remote_server_id - int64 - Remote server ID for the destination (if remote)
     #   disabled - boolean - Is this sync disabled?
     #   exclude_patterns - array(string) - Array of glob patterns to exclude
-    #   holiday_region - string - Skip sync if there is a formal, observed holiday for this region.
+    #   holiday_region - string - Skip the sync if there is a formal, observed holiday for this region.
     #   include_patterns - array(string) - Array of glob patterns to include
     #   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`
     #   keep_after_copy - boolean - Keep files after copying?
     #   name - string - Name for this sync job
     #   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_id - int64 - If trigger is `custom_schedule`, the reusable Schedule used instead of the sync's schedule fields.
     #   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_time_zone - string - Time zone for scheduled times. If not set, times are interpreted as UTC.
+    #   schedule_time_zone - string - Time zone for the schedule. If not set, times are interpreted as UTC.
     #   schedule_times_of_day - array(string) - Times of day to run in HH:MM format. For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
     #   src_path - string - Absolute source path for the sync
     #   src_remote_server_id - int64 - Remote server ID for the source (if remote)
@@ -517,6 +531,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: interval must be an String") if params[:interval] and !params[:interval].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].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_id must be an Integer") if params[:schedule_id] and !params[:schedule_id].is_a?(Integer)
       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_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_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)

data/lib/files.com/version.rb

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

data/lib/files.com.rb

@@ -142,6 +142,7 @@ require "files.com/models/remote_server_configuration_file"
 require "files.com/models/remote_server_credential"
 require "files.com/models/request"
 require "files.com/models/restore"
+require "files.com/models/schedule"
 require "files.com/models/scheduled_export"
 require "files.com/models/scim_log"
 require "files.com/models/secret"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.704
+  version: 1.1.705
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-08-05 00:00:00.000000000 Z
+date: 2026-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -281,6 +281,7 @@ files:
 - docs/remote_server_credential.md
 - docs/request.md
 - docs/restore.md
+- docs/schedule.md
 - docs/scheduled_export.md
 - docs/scim_log.md
 - docs/secret.md
@@ -435,6 +436,7 @@ files:
 - lib/files.com/models/remote_server_credential.rb
 - lib/files.com/models/request.rb
 - lib/files.com/models/restore.rb
+- lib/files.com/models/schedule.rb
 - lib/files.com/models/scheduled_export.rb
 - lib/files.com/models/scim_log.rb
 - lib/files.com/models/secret.rb