Skip to content

Commit 8990da0

Browse files
[Bot] push changes from Files.com
1 parent 3f1a074 commit 8990da0

13 files changed

Lines changed: 40 additions & 40 deletions

File tree

_VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.517
1+
1.2.518

docs/models/Automation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,10 @@
123123
* `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.
124124
* `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.
125125
* `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.
127127
* `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.
130130
* `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.
131131
* `legacy_sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
132132
* `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 @@
136136
* `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
137137
* `value` (object): A Hash of attributes specific to the automation type.
138138
* `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.
140140

141141
---
142142

@@ -228,9 +228,9 @@ await Automation.create({
228228
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
229229
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
230230
* `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.
234234
* `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`.
235235
* `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.
236236
* `description` (string): Description for the this Automation.
@@ -325,9 +325,9 @@ await automation.update({
325325
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
326326
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
327327
* `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.
331331
* `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`.
332332
* `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.
333333
* `description` (string): Description for the this Automation.

docs/models/AutomationRun.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ await AutomationRun.list({
5454
* `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.
5555
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
5656
* `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 ]`.
5858
* `automation_id` (int64): Required - ID of the associated Automation.
5959

6060
---

docs/models/Bundle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ await Bundle.list({
154154
* `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.
155155
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
156156
* `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 ]`.
158158
* `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`.
159159
* `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`.
160160
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

lib/Files.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ var apiKey;
1212
var baseUrl = 'https://app.files.com';
1313
var sessionId = null;
1414
var language = null;
15-
var version = '1.2.517';
15+
var version = '1.2.518';
1616
var userAgent = "Files.com JavaScript SDK v".concat(version);
1717
var logLevel = _Logger.LogLevel.INFO;
1818
var debugRequest = false;

lib/models/Automation.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
221221
(0, _defineProperty2.default)(this, "setSchedule", function (value) {
222222
_this.attributes.schedule = value;
223223
});
224-
// string # If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
224+
// string # If trigger is `custom_schedule` or `daily` with times, Human readable schedule description for when the automation should be run.
225225
(0, _defineProperty2.default)(this, "getHumanReadableSchedule", function () {
226226
return _this.attributes.human_readable_schedule;
227227
});
@@ -235,14 +235,14 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
235235
(0, _defineProperty2.default)(this, "setScheduleDaysOfWeek", function (value) {
236236
_this.attributes.schedule_days_of_week = value;
237237
});
238-
// 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.
239239
(0, _defineProperty2.default)(this, "getScheduleTimesOfDay", function () {
240240
return _this.attributes.schedule_times_of_day;
241241
});
242242
(0, _defineProperty2.default)(this, "setScheduleTimesOfDay", function (value) {
243243
_this.attributes.schedule_times_of_day = value;
244244
});
245-
// string # If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
245+
// string # Time zone for scheduled times. If not set, times are interpreted as UTC.
246246
(0, _defineProperty2.default)(this, "getScheduleTimeZone", function () {
247247
return _this.attributes.schedule_time_zone;
248248
});
@@ -312,7 +312,7 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
312312
(0, _defineProperty2.default)(this, "setWebhookUrl", function (value) {
313313
_this.attributes.webhook_url = value;
314314
});
315-
// 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.
316316
(0, _defineProperty2.default)(this, "getHolidayRegion", function () {
317317
return _this.attributes.holiday_region;
318318
});
@@ -380,9 +380,9 @@ var Automation = /*#__PURE__*/(0, _createClass2.default)(function Automation() {
380380
// user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
381381
// group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
382382
// 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.
386386
// 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`.
387387
// 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.
388388
// description - string - Description for the this Automation.
@@ -812,9 +812,9 @@ _Automation = Automation;
812812
// user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
813813
// group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
814814
// 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.
818818
// 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`.
819819
// 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.
820820
// description - string - Description for the this Automation.

lib/models/AutomationRun.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ _AutomationRun = AutomationRun;
107107
// 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.
108108
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
109109
// 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 ]`.
111111
// automation_id (required) - int64 - ID of the associated Automation.
112112
(0, _defineProperty2.default)(AutomationRun, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee() {
113113
var _response$data;

0 commit comments

Comments
 (0)