Skip to content

Commit 9e0e13d

Browse files
[Bot] push changes from Files.com
1 parent d0ada28 commit 9e0e13d

16 files changed

Lines changed: 707 additions & 225 deletions

_VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.526
1+
1.2.527

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`.

docs/models/File.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,25 @@ await File.find(path, {
154154

155155
---
156156

157+
## Create a ZIP from one or more paths and save it to a destination path
158+
159+
```
160+
await File.zip({
161+
'paths': "paths",
162+
'destination': "destination",
163+
'overwrite': false,
164+
})
165+
```
166+
167+
168+
### Parameters
169+
170+
* `paths` (array(string)): Required - Paths to include in the ZIP.
171+
* `destination` (string): Required - Destination file path for the ZIP.
172+
* `overwrite` (boolean): Overwrite existing file in the destination?
173+
174+
---
175+
157176
## Download File
158177

159178
```
@@ -312,6 +331,31 @@ await file.delete({
312331
* `recursive` (boolean): If true, will recursively delete folders. Otherwise, will error on non-empty folders.
313332

314333

334+
---
335+
336+
## List the contents of a ZIP file
337+
338+
```
339+
const file = await File.find(path)
340+
341+
await file.zip_list_contents()
342+
```
343+
344+
### Parameters
345+
346+
* `path` (string): Required - Path to operate on.
347+
348+
### Example Response
349+
350+
```json
351+
[
352+
{
353+
"path": "example",
354+
"size": 1
355+
}
356+
]
357+
```
358+
315359
---
316360

317361
## Copy File/Folder
@@ -372,6 +416,35 @@ await file.move({
372416

373417
---
374418

419+
## Extract a ZIP file to a destination folder
420+
421+
```
422+
const file = await File.find(path)
423+
424+
await file.unzip({
425+
'destination': "destination",
426+
'overwrite': false,
427+
})
428+
```
429+
430+
### Parameters
431+
432+
* `path` (string): Required - ZIP file path to extract.
433+
* `destination` (string): Required - Destination folder path for extracted files.
434+
* `filename` (string): Optional single entry filename to extract.
435+
* `overwrite` (boolean): Overwrite existing files in the destination?
436+
437+
### Example Response
438+
439+
```json
440+
{
441+
"status": "pending",
442+
"file_migration_id": 1
443+
}
444+
```
445+
446+
---
447+
375448
## Begin File Upload
376449

377450
```

docs/models/ZipListEntry.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ZipListEntry
2+
3+
## Example ZipListEntry Object
4+
5+
```
6+
{
7+
"path": "example",
8+
"size": 1
9+
}
10+
```
11+
12+
* `path` (string): Entry path inside the ZIP. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
13+
* `size` (int64): Uncompressed size in bytes.

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.526';
15+
var version = '1.2.527';
1616
var userAgent = "Files.com JavaScript SDK v".concat(version);
1717
var logLevel = _Logger.LogLevel.INFO;
1818
var debugRequest = false;

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;

lib/models/Bundle.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ _Bundle = Bundle;
699699
// 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.
700700
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
701701
// sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
702-
// 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 ]`.
702+
// 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 ]`.
703703
// 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`.
704704
// 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`.
705705
// filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

0 commit comments

Comments
 (0)