files.com 1.1.704 → 1.1.705

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d662ce2e9a678c8cdf460d004d04f7fc252533bc815064bcda9da4b449a666
-  data.tar.gz: 51b66a5f5c5b1dd748a666b66b65b4fd43a46b1f926eb5ad5f65e8e5b1a2088d
+  metadata.gz: d8ca126a64fdb94a9719ce7e4f6aadc193ef25c896478f27bbbe65550a4fc55f
+  data.tar.gz: 2fa1cf2cbc7fa91d7710209d2a0311584e9bca2ff68047841d0a96da6b8fa918
 SHA512:
-  metadata.gz: 83b915157bb622c3ae50b21d2f52299c998d441c5e661d42f381bda15947acf73feab29701d2d3889bb35885d94cdf52ab6d367e2c6e46b106de56e6ee9d29b8
-  data.tar.gz: 50899c311cbdc45799e647a27d3de203960551a6b3c44da7b6c5b1d3f34e3d638ed54f2ec1ec4d59b374b58774a047132f273fc334ca2fc803df810d950802fe
+  metadata.gz: 938b9fe2aa351a7e978f851e52eabf7092dce64fac950ecd6c6330e46a8e2efa4f82722746fda43b1277eeb81e29b5e6fda612a1d2b4e17a9ef29140517093bb
+  data.tar.gz: c82855ff3a13b41459d754749e68f22fed27b8dde7b9c61f6aa47c22d5b75fdcf87366d44aa58493108d49fe86563370d9bc4f45af1e1e78217aa2dab4e3ce53

data/_VERSION

@@ -1 +1 @@
-1.1.704
+1.1.705

data/docs/ai_task.md

@@ -19,6 +19,7 @@
   ],
   "interval": "day",
   "recurring_day": 1,
+  "schedule_id": 1,
   "schedule_days_of_week": [
     1,
     3,
@@ -50,10 +51,11 @@
 * `trigger_actions` (array(string)): If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the AI Task.
 * `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 AI Task'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 scheduled AI Tasks.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the AI Task schedule.
 * `schedule_time_zone` (string): Time zone used by the AI Task schedule.
-* `holiday_region` (string): Optional holiday region used by scheduled AI Tasks.
+* `holiday_region` (string): Optional holiday region used by the AI Task schedule.
 * `human_readable_schedule` (string): Human-readable schedule description.
 * `last_run_at` (date-time): Most recent successful invocation time.
 * `master_admin_user_id` (int64): Master User ID used for AI Task invocations.
@@ -105,6 +107,7 @@ Files::AiTask.create(
   permission_set: "files_only", 
   prompt: "Summarize the uploaded file and identify follow-up actions.", 
   recurring_day: 1, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
   schedule_times_of_day: ["06:30"], 
@@ -119,16 +122,17 @@ Files::AiTask.create(
 
 * `description` (string): AI Task description.
 * `disabled` (boolean): If true, this AI Task will not run.
-* `holiday_region` (string): Optional holiday region used by scheduled AI Tasks.
+* `holiday_region` (string): Optional holiday region used by the AI Task schedule.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the AI Task.
 * `name` (string): Required - AI Task name.
 * `path` (string): Path scope used for action-triggered AI Tasks.
 * `permission_set` (string): Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
 * `prompt` (string): Required - Prompt sent when this AI Task is invoked.
 * `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 AI Task's schedule fields.
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
 * `schedule_time_zone` (string): Time zone used by the AI Task schedule.
-* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for scheduled AI Tasks.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the AI Task schedule.
 * `source` (string): Source glob used with `path` for action-triggered AI Tasks.
 * `trigger` (string): How this AI Task is triggered.
 * `trigger_actions` (array(string)): If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
@@ -163,6 +167,7 @@ Files::AiTask.update(id,
   permission_set: "files_only", 
   prompt: "Summarize the uploaded file and identify follow-up actions.", 
   recurring_day: 1, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
   schedule_times_of_day: ["06:30"], 
@@ -178,16 +183,17 @@ Files::AiTask.update(id,
 * `id` (int64): Required - Ai Task ID.
 * `description` (string): AI Task description.
 * `disabled` (boolean): If true, this AI Task will not run.
-* `holiday_region` (string): Optional holiday region used by scheduled AI Tasks.
+* `holiday_region` (string): Optional holiday region used by the AI Task schedule.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the AI Task.
 * `name` (string): AI Task name.
 * `path` (string): Path scope used for action-triggered AI Tasks.
 * `permission_set` (string): Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
 * `prompt` (string): Prompt sent when this AI Task is invoked.
 * `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 AI Task's schedule fields.
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
 * `schedule_time_zone` (string): Time zone used by the AI Task schedule.
-* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for scheduled AI Tasks.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the AI Task schedule.
 * `source` (string): Source glob used with `path` for action-triggered AI Tasks.
 * `trigger` (string): How this AI Task is triggered.
 * `trigger_actions` (array(string)): If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.
@@ -239,6 +245,7 @@ ai_task.update(
   permission_set: "files_only",
   prompt: "Summarize the uploaded file and identify follow-up actions.",
   recurring_day: 1,
+  schedule_id: 1,
   schedule_days_of_week: [1,3,5],
   schedule_time_zone: "Eastern Time (US & Canada)",
   schedule_times_of_day: ["06:30"],
@@ -254,16 +261,17 @@ ai_task.update(
 * `id` (int64): Required - Ai Task ID.
 * `description` (string): AI Task description.
 * `disabled` (boolean): If true, this AI Task will not run.
-* `holiday_region` (string): Optional holiday region used by scheduled AI Tasks.
+* `holiday_region` (string): Optional holiday region used by the AI Task schedule.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the AI Task.
 * `name` (string): AI Task name.
 * `path` (string): Path scope used for action-triggered AI Tasks.
 * `permission_set` (string): Permissions used by the internal API key for this AI Task. Valid values are `full` and `files_only`.
 * `prompt` (string): Prompt sent when this AI Task is invoked.
 * `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 AI Task's schedule fields.
 * `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, the 0-based weekdays used by the schedule.
 * `schedule_time_zone` (string): Time zone used by the AI Task schedule.
-* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for scheduled AI Tasks.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the AI Task schedule.
 * `source` (string): Source glob used with `path` for action-triggered AI Tasks.
 * `trigger` (string): How this AI Task is triggered.
 * `trigger_actions` (array(string)): If trigger is `action`, the file action types that invoke this AI Task. Valid actions are create, copy, move, archived_delete, update, read, destroy.

data/docs/automation.md

@@ -48,6 +48,7 @@
   "path_time_zone": "Eastern Time (US & Canada)",
   "version": 1,
   "recurring_day": 25,
+  "schedule_id": 1,
   "retry_on_failure_interval_in_minutes": 60,
   "retry_on_failure_number_of_attempts": 10,
   "schedule": {
@@ -126,13 +127,14 @@
 * `path_time_zone` (string): Timezone to use when rendering timestamps in paths.
 * `version` (int64): Current Automation v2 definition version.
 * `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 automation's schedule fields.
 * `retry_on_failure_interval_in_minutes` (int64): If the Automation fails, retry at this interval (in minutes).  Acceptable values are 5 through 1440 (one day).  Set to null to disable.
 * `retry_on_failure_number_of_attempts` (int64): If the Automation fails, retry at most this many times.  Maximum allowed value: 10.  Set to null to disable.
 * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
 * `human_readable_schedule` (string): If trigger is `custom_schedule` or `daily` with times, Human readable schedule description for when the automation should be run.
-* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0 is Sunday, 1 is Monday, etc.
 * `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). For `custom_schedule`, run at these times on specified days of week. For `daily`, run at these times on the scheduled interval date.
-* `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.
 * `source` (string): Source path/glob.  See Automation docs for exact description, but this is used to filter for files in the `path` to find files to operate on. Supports globs, except on remote mounts.
 * `legacy_sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
 * `sync_ids` (array(int64)): IDs of syncs to run by this Automation. This is the new way to specify syncs, and it is recommended to use this instead of `legacy_sync_ids`.
@@ -142,7 +144,7 @@
 * `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
 * `value` (object): A Hash of attributes specific to the automation type.
 * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
-* `holiday_region` (string): Skip automation if there is a formal, observed holiday for this region.
+* `holiday_region` (string): Skip the automation if there is a formal, observed holiday for this region.
 
 
 ---
@@ -203,6 +205,7 @@ Files::Automation.create(
   sync_ids: [1,2], 
   user_ids: [1,2], 
   group_ids: [1,2], 
+  schedule_id: 1, 
   schedule_days_of_week: [0,1,3], 
   schedule_times_of_day: ["7:30","11:30"], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
@@ -242,10 +245,11 @@ Files::Automation.create(
 * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
-* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
-* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` triggers. Optional for `daily` triggers - if not set, runs at midnight UTC.
-* `schedule_time_zone` (string): Time zone for scheduled times. Optional for both `custom_schedule` and `daily` triggers. If not set, times are interpreted as UTC.
-* `holiday_region` (string): Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
+* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
+* `schedule_time_zone` (string): Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
+* `holiday_region` (string): Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
 * `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
 * `always_serialize_jobs` (boolean): Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
 * `description` (string): Description for the this Automation.
@@ -313,6 +317,7 @@ Files::Automation.update(id,
   sync_ids: [1,2], 
   user_ids: [1,2], 
   group_ids: [1,2], 
+  schedule_id: 1, 
   schedule_days_of_week: [0,1,3], 
   schedule_times_of_day: ["7:30","11:30"], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
@@ -352,10 +357,11 @@ Files::Automation.update(id,
 * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
-* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
-* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` triggers. Optional for `daily` triggers - if not set, runs at midnight UTC.
-* `schedule_time_zone` (string): Time zone for scheduled times. Optional for both `custom_schedule` and `daily` triggers. If not set, times are interpreted as UTC.
-* `holiday_region` (string): Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
+* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
+* `schedule_time_zone` (string): Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
+* `holiday_region` (string): Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
 * `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
 * `always_serialize_jobs` (boolean): Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
 * `description` (string): Description for the this Automation.
@@ -441,6 +447,7 @@ automation.update(
   sync_ids: [1,2],
   user_ids: [1,2],
   group_ids: [1,2],
+  schedule_id: 1,
   schedule_days_of_week: [0,1,3],
   schedule_times_of_day: ["7:30","11:30"],
   schedule_time_zone: "Eastern Time (US & Canada)",
@@ -480,10 +487,11 @@ automation.update(
 * `sync_ids` (string): A list of sync IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
 * `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
-* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`. A list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
-* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` triggers. Optional for `daily` triggers - if not set, runs at midnight UTC.
-* `schedule_time_zone` (string): Time zone for scheduled times. Optional for both `custom_schedule` and `daily` triggers. If not set, times are interpreted as UTC.
-* `holiday_region` (string): Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
+* `schedule_id` (int64): If trigger is `custom_schedule`, the reusable Schedule used instead of the automation's schedule fields.
+* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule` without `schedule_id`, a list of days of the week to run this automation. 0 is Sunday, 1 is Monday, etc.
+* `schedule_times_of_day` (array(string)): Times of day to run in HH:MM format (24-hour). Required for `custom_schedule` without `schedule_id`. Optional for `daily` triggers; if not set, runs at midnight UTC.
+* `schedule_time_zone` (string): Time zone for schedule fields. Optional for `custom_schedule` without `schedule_id` and for `daily`. If not set, times are interpreted as UTC.
+* `holiday_region` (string): Skip automation on holidays in this region. Optional for `custom_schedule` without `schedule_id` and for `daily`.
 * `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer.  If this flag is `true` we will overwrite the destination file always.  Note that this may cause large amounts of wasted transfer usage.  This setting has no effect unless `overwrite_files` is also set to `true`.
 * `always_serialize_jobs` (boolean): Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
 * `description` (string): Description for the this Automation.

data/docs/expectation.md

@@ -16,6 +16,7 @@
   "trigger": "manual",
   "interval": "day",
   "recurring_day": 3,
+  "schedule_id": 1,
   "schedule_days_of_week": [
     1,
     3,
@@ -59,10 +60,11 @@
 * `trigger` (string): How this expectation opens windows.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
 * `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 Expectation'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 expectations.
-* `schedule_time_zone` (string): Time zone used by the expectation schedule.
-* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the Expectation schedule.
+* `schedule_time_zone` (string): Time zone used by the Expectation schedule.
+* `holiday_region` (string): Optional holiday region used by the Expectation schedule.
 * `lookback_interval` (int64): How many seconds before the due boundary the window starts.
 * `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
 * `inactivity_interval` (int64): How many quiet seconds are required before final closure.
@@ -120,6 +122,7 @@ Files::Expectation.create(
   trigger: "manual", 
   interval: "day", 
   recurring_day: 3, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_times_of_day: ["06:00"], 
   schedule_time_zone: "UTC", 
@@ -144,10 +147,11 @@ Files::Expectation.create(
 * `trigger` (string): How this expectation opens windows.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
 * `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 Expectation'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 expectations.
-* `schedule_time_zone` (string): Time zone used by the expectation schedule.
-* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the Expectation schedule.
+* `schedule_time_zone` (string): Time zone used by the Expectation schedule.
+* `holiday_region` (string): Optional holiday region used by the Expectation schedule.
 * `lookback_interval` (int64): How many seconds before the due boundary the window starts.
 * `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
 * `inactivity_interval` (int64): How many quiet seconds are required before final closure.
@@ -184,6 +188,7 @@ Files::Expectation.update(id,
   trigger: "manual", 
   interval: "day", 
   recurring_day: 3, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_times_of_day: ["06:00"], 
   schedule_time_zone: "UTC", 
@@ -209,10 +214,11 @@ Files::Expectation.update(id,
 * `trigger` (string): How this expectation opens windows.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
 * `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 Expectation'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 expectations.
-* `schedule_time_zone` (string): Time zone used by the expectation schedule.
-* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the Expectation schedule.
+* `schedule_time_zone` (string): Time zone used by the Expectation schedule.
+* `holiday_region` (string): Optional holiday region used by the Expectation schedule.
 * `lookback_interval` (int64): How many seconds before the due boundary the window starts.
 * `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
 * `inactivity_interval` (int64): How many quiet seconds are required before final closure.
@@ -266,6 +272,7 @@ expectation.update(
   trigger: "manual",
   interval: "day",
   recurring_day: 3,
+  schedule_id: 1,
   schedule_days_of_week: [1,3,5],
   schedule_times_of_day: ["06:00"],
   schedule_time_zone: "UTC",
@@ -291,10 +298,11 @@ expectation.update(
 * `trigger` (string): How this expectation opens windows.
 * `interval` (string): If trigger is `daily`, this specifies how often to run the expectation.
 * `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 Expectation'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 expectations.
-* `schedule_time_zone` (string): Time zone used by the expectation schedule.
-* `holiday_region` (string): Optional holiday region used by schedule-driven expectations.
+* `schedule_times_of_day` (array(string)): Times of day in HH:MM format for the Expectation schedule.
+* `schedule_time_zone` (string): Time zone used by the Expectation schedule.
+* `holiday_region` (string): Optional holiday region used by the Expectation schedule.
 * `lookback_interval` (int64): How many seconds before the due boundary the window starts.
 * `late_acceptance_interval` (int64): How many seconds a schedule-driven window may remain eligible to close as late.
 * `inactivity_interval` (int64): How many quiet seconds are required before final closure.

data/docs/schedule.md

@@ -0,0 +1,164 @@
+# Schedule
+
+## Example Schedule Object
+
+```
+{
+  "id": 1,
+  "name": "Weekday overnight",
+  "schedule_days_of_week": [
+    1,
+    2,
+    3,
+    4,
+    5
+  ],
+  "schedule_times_of_day": [
+    "01:00"
+  ],
+  "schedule_time_zone": "Eastern Time (US & Canada)",
+  "holiday_region": "us",
+  "human_readable_schedule": "Triggered every Monday, Tuesday, Wednesday, Thursday, Friday at 01:00 AM UTC TZ.",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Schedule ID.
+* `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.
+* `human_readable_schedule` (string): Human-readable Schedule description.
+* `created_at` (date-time): Creation time.
+* `updated_at` (date-time): Last update time.
+
+
+---
+
+## List Schedules
+
+```
+Files::Schedule.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: 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`.
+
+
+---
+
+## Show Schedule
+
+```
+Files::Schedule.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Schedule ID.
+
+
+---
+
+## Create Schedule
+
+```
+Files::Schedule.create(
+  name: "Weekday overnight", 
+  schedule_days_of_week: [1,2,3,4,5], 
+  schedule_times_of_day: ["01:00"], 
+  schedule_time_zone: "Eastern Time (US & Canada)", 
+  holiday_region: "us"
+)
+```
+
+### Parameters
+
+* `name` (string): Required - Schedule name.
+* `schedule_days_of_week` (array(int64)): Required - 0-based weekdays used by the Schedule. 0 is Sunday.
+* `schedule_times_of_day` (array(string)): Required - 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.
+
+
+---
+
+## Update Schedule
+
+```
+Files::Schedule.update(id, 
+  name: "Weekday overnight", 
+  schedule_days_of_week: [1,2,3,4,5], 
+  schedule_times_of_day: ["01:00"], 
+  schedule_time_zone: "Eastern Time (US & Canada)", 
+  holiday_region: "us"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Schedule ID.
+* `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.
+
+
+---
+
+## Delete Schedule
+
+```
+Files::Schedule.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Schedule ID.
+
+
+---
+
+## Update Schedule
+
+```
+schedule = Files::Schedule.find(id)
+
+schedule.update(
+  name: "Weekday overnight",
+  schedule_days_of_week: [1,2,3,4,5],
+  schedule_times_of_day: ["01:00"],
+  schedule_time_zone: "Eastern Time (US & Canada)",
+  holiday_region: "us"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Schedule ID.
+* `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.
+
+
+---
+
+## Delete Schedule
+
+```
+schedule = Files::Schedule.find(id)
+
+schedule.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Schedule ID.

data/docs/scheduled_export.md

@@ -16,6 +16,7 @@
   "trigger": "daily",
   "interval": "month",
   "recurring_day": 1,
+  "schedule_id": 1,
   "schedule_days_of_week": [
     1,
     3,
@@ -44,10 +45,11 @@
 * `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.
 * `human_readable_schedule` (string): Human-readable schedule description.
 * `last_run_at` (date-time): Most recent scheduled run time.
 * `last_export_id` (int64): Most recent Export ID created by this schedule.
@@ -99,6 +101,7 @@ Files::ScheduledExport.create(
   trigger: "daily", 
   interval: "month", 
   recurring_day: 1, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_times_of_day: ["06:30"], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
@@ -116,10 +119,11 @@ Files::ScheduledExport.create(
 * `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.
 
 
 ---
@@ -136,6 +140,7 @@ Files::ScheduledExport.update(id,
   trigger: "daily", 
   interval: "month", 
   recurring_day: 1, 
+  schedule_id: 1, 
   schedule_days_of_week: [1,3,5], 
   schedule_times_of_day: ["06:30"], 
   schedule_time_zone: "Eastern Time (US & Canada)", 
@@ -154,10 +159,11 @@ Files::ScheduledExport.update(id,
 * `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.
 
 
 ---
@@ -189,6 +195,7 @@ scheduled_export.update(
   trigger: "daily",
   interval: "month",
   recurring_day: 1,
+  schedule_id: 1,
   schedule_days_of_week: [1,3,5],
   schedule_times_of_day: ["06:30"],
   schedule_time_zone: "Eastern Time (US & Canada)",
@@ -207,10 +214,11 @@ scheduled_export.update(
 * `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.
 
 
 ---