You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/models/Automation.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,10 +123,10 @@
123
123
*`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.
124
124
*`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.
125
125
*`schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
126
-
*`human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
126
+
*`human_readable_schedule` (string): If trigger is `custom_schedule` or `daily` with times, Human readable schedule description for when the automation should be run.
127
127
*`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.
128
-
*`schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
129
-
*`schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
128
+
*`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.
129
+
*`schedule_time_zone` (string): Time zone for scheduled times. If not set, times are interpreted as UTC.
130
130
*`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.
131
131
*`legacy_sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
132
132
*`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`.
@@ -136,7 +136,7 @@
136
136
*`user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
137
137
*`value` (object): A Hash of attributes specific to the automation type.
138
138
*`webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
139
-
*`holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
139
+
*`holiday_region` (string): Skip automation if there is a formal, observed holiday for this region.
140
140
141
141
---
142
142
@@ -228,9 +228,9 @@ await Automation.create({
228
228
*`user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
229
229
*`group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
230
230
*`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.
231
-
*`schedule_times_of_day` (array(string)): If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
232
-
*`schedule_time_zone` (string): If trigger is `custom_schedule`. Time zone for the schedule.
233
-
*`holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
231
+
*`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.
232
+
*`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.
233
+
*`holiday_region` (string): Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
234
234
*`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`.
235
235
*`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.
236
236
*`description` (string): Description for the this Automation.
@@ -325,9 +325,9 @@ await automation.update({
325
325
*`user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
326
326
*`group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
327
327
*`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.
328
-
*`schedule_times_of_day` (array(string)): If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
329
-
*`schedule_time_zone` (string): If trigger is `custom_schedule`. Time zone for the schedule.
330
-
*`holiday_region` (string): If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
328
+
*`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.
329
+
*`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.
330
+
*`holiday_region` (string): Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
331
331
*`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`.
332
332
*`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.
333
333
*`description` (string): Description for the this Automation.
Copy file name to clipboardExpand all lines: docs/models/AutomationRun.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ await AutomationRun.list({
54
54
*`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.
55
55
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
56
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
57
-
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
57
+
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
58
58
*`automation_id` (int64): Required - ID of the associated Automation.
Copy file name to clipboardExpand all lines: docs/models/Bundle.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,7 @@ await Bundle.list({
154
154
*`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.
155
155
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
156
156
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
157
-
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
157
+
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
158
158
*`filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
159
159
*`filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
160
160
*`filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
// array(string) # If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
238
+
// 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.
// string # If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
315
+
// string # Skip automation if there is a formal, observed holiday for this region.
// user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
381
381
// group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
382
382
// 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.
383
-
// schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
384
-
// schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
385
-
// holiday_region - string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
383
+
// 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.
384
+
// 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.
385
+
// holiday_region - string - Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
386
386
// 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`.
387
387
// 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.
388
388
// description - string - Description for the this Automation.
@@ -812,9 +812,9 @@ _Automation = Automation;
812
812
// user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
813
813
// group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
814
814
// 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.
815
-
// schedule_times_of_day - array(string) - If trigger is `custom_schedule`. A list of times of day to run this automation. 24-hour time format.
816
-
// schedule_time_zone - string - If trigger is `custom_schedule`. Time zone for the schedule.
817
-
// holiday_region - string - If trigger is `custom_schedule`, the Automation will check if there is a formal, observed holiday for the region, and if so, it will not run.
815
+
// 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.
816
+
// 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.
817
+
// holiday_region - string - Skip automation on holidays in this region. Optional for both `custom_schedule` and `daily` triggers.
818
818
// 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`.
819
819
// 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.
820
820
// description - string - Description for the this Automation.
// 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.
108
108
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
109
109
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
110
-
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
110
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
111
111
// automation_id (required) - int64 - ID of the associated Automation.
0 commit comments