files.com 1.0.247 → 1.0.249
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/RemoteServer.md +16 -2
- package/lib/models/AccountLineItem.js +14 -0
- package/lib/models/Action.js +13 -0
- package/lib/models/ActionNotificationExport.js +27 -0
- package/lib/models/ActionNotificationExportResult.js +15 -0
- package/lib/models/ActionWebhookFailure.js +1 -0
- package/lib/models/ApiKey.js +42 -0
- package/lib/models/App.js +26 -0
- package/lib/models/As2IncomingMessage.js +46 -0
- package/lib/models/As2OutgoingMessage.js +42 -0
- package/lib/models/As2Partner.js +29 -0
- package/lib/models/As2Station.js +31 -0
- package/lib/models/Auto.js +1 -0
- package/lib/models/Automation.js +72 -0
- package/lib/models/AutomationRun.js +20 -0
- package/lib/models/BandwidthSnapshot.js +19 -0
- package/lib/models/Behavior.js +57 -0
- package/lib/models/Bundle.js +98 -0
- package/lib/models/BundleDownload.js +16 -0
- package/lib/models/BundleNotification.js +20 -0
- package/lib/models/BundleRecipient.js +28 -0
- package/lib/models/BundleRegistration.js +18 -0
- package/lib/models/Clickwrap.js +23 -0
- package/lib/models/DnsRecord.js +7 -0
- package/lib/models/Errors.js +2 -0
- package/lib/models/ExternalEvent.js +26 -0
- package/lib/models/File.js +88 -0
- package/lib/models/FileAction.js +2 -0
- package/lib/models/FileComment.js +13 -0
- package/lib/models/FileCommentReaction.js +8 -0
- package/lib/models/FileMigration.js +11 -0
- package/lib/models/FileUploadPart.js +15 -0
- package/lib/models/Folder.js +33 -0
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -0
- package/lib/models/Group.js +29 -0
- package/lib/models/GroupUser.js +22 -0
- package/lib/models/History.js +57 -0
- package/lib/models/HistoryExport.js +51 -0
- package/lib/models/HistoryExportResult.js +29 -0
- package/lib/models/Image.js +2 -0
- package/lib/models/InboxRecipient.js +28 -0
- package/lib/models/InboxRegistration.js +15 -0
- package/lib/models/InboxUpload.js +15 -0
- package/lib/models/Invoice.js +19 -0
- package/lib/models/InvoiceLineItem.js +9 -0
- package/lib/models/IpAddress.js +13 -0
- package/lib/models/Lock.js +25 -0
- package/lib/models/Message.js +22 -0
- package/lib/models/MessageComment.js +16 -0
- package/lib/models/MessageCommentReaction.js +13 -0
- package/lib/models/MessageReaction.js +13 -0
- package/lib/models/Notification.js +70 -0
- package/lib/models/Payment.js +19 -0
- package/lib/models/PaymentLineItem.js +4 -0
- package/lib/models/Permission.js +29 -0
- package/lib/models/Preview.js +5 -0
- package/lib/models/Priority.js +6 -0
- package/lib/models/Project.js +11 -0
- package/lib/models/PublicIpAddress.js +4 -0
- package/lib/models/PublicKey.js +18 -0
- package/lib/models/RemoteBandwidthSnapshot.js +15 -0
- package/lib/models/RemoteServer.js +253 -11
- package/lib/models/RemoteServerConfigurationFile.js +12 -0
- package/lib/models/Request.js +25 -0
- package/lib/models/Session.js +13 -0
- package/lib/models/SettingsChange.js +15 -0
- package/lib/models/SftpHostKey.js +16 -0
- package/lib/models/Site.js +276 -0
- package/lib/models/SsoStrategy.js +49 -0
- package/lib/models/Status.js +7 -0
- package/lib/models/Style.js +9 -0
- package/lib/models/UsageDailySnapshot.js +21 -0
- package/lib/models/UsageSnapshot.js +18 -0
- package/lib/models/User.js +183 -0
- package/lib/models/UserCipherUse.js +10 -0
- package/lib/models/UserRequest.js +13 -0
- package/lib/models/WebhookTest.js +24 -0
- package/package.json +1 -1
- package/src/models/RemoteServer.js +41 -0
package/lib/models/Clickwrap.js
CHANGED
@@ -31,42 +31,54 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Clickwrap ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
40
42
|
(0, _defineProperty2.default)(this, "getName", function () {
|
41
43
|
return _this.attributes.name;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setName", function (value) {
|
44
46
|
_this.attributes.name = value;
|
45
47
|
});
|
48
|
+
// string # Body text of Clickwrap (supports Markdown formatting).
|
46
49
|
(0, _defineProperty2.default)(this, "getBody", function () {
|
47
50
|
return _this.attributes.body;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setBody", function (value) {
|
50
53
|
_this.attributes.body = value;
|
51
54
|
});
|
55
|
+
// string # Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
|
52
56
|
(0, _defineProperty2.default)(this, "getUseWithUsers", function () {
|
53
57
|
return _this.attributes.use_with_users;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setUseWithUsers", function (value) {
|
56
60
|
_this.attributes.use_with_users = value;
|
57
61
|
});
|
62
|
+
// string # Use this Clickwrap for Bundles?
|
58
63
|
(0, _defineProperty2.default)(this, "getUseWithBundles", function () {
|
59
64
|
return _this.attributes.use_with_bundles;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setUseWithBundles", function (value) {
|
62
67
|
_this.attributes.use_with_bundles = value;
|
63
68
|
});
|
69
|
+
// string # Use this Clickwrap for Inboxes?
|
64
70
|
(0, _defineProperty2.default)(this, "getUseWithInboxes", function () {
|
65
71
|
return _this.attributes.use_with_inboxes;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setUseWithInboxes", function (value) {
|
68
74
|
_this.attributes.use_with_inboxes = value;
|
69
75
|
});
|
76
|
+
// Parameters:
|
77
|
+
// name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
78
|
+
// body - string - Body text of Clickwrap (supports Markdown formatting).
|
79
|
+
// use_with_bundles - string - Use this Clickwrap for Bundles?
|
80
|
+
// use_with_inboxes - string - Use this Clickwrap for Inboxes?
|
81
|
+
// use_with_users - string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
|
70
82
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
71
83
|
var params,
|
72
84
|
response,
|
@@ -227,6 +239,9 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
|
|
227
239
|
});
|
228
240
|
this.options = _objectSpread({}, options);
|
229
241
|
});
|
242
|
+
// Parameters:
|
243
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
244
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
230
245
|
(0, _defineProperty2.default)(Clickwrap, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
231
246
|
var _response$data;
|
232
247
|
var params,
|
@@ -268,6 +283,8 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
|
|
268
283
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
269
284
|
return Clickwrap.list(params, options);
|
270
285
|
});
|
286
|
+
// Parameters:
|
287
|
+
// id (required) - int64 - Clickwrap ID.
|
271
288
|
(0, _defineProperty2.default)(Clickwrap, "find", /*#__PURE__*/function () {
|
272
289
|
var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
|
273
290
|
var params,
|
@@ -318,6 +335,12 @@ var Clickwrap = /*#__PURE__*/(0, _createClass2.default)(function Clickwrap() {
|
|
318
335
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
319
336
|
return Clickwrap.find(id, params, options);
|
320
337
|
});
|
338
|
+
// Parameters:
|
339
|
+
// name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
340
|
+
// body - string - Body text of Clickwrap (supports Markdown formatting).
|
341
|
+
// use_with_bundles - string - Use this Clickwrap for Bundles?
|
342
|
+
// use_with_inboxes - string - Use this Clickwrap for Inboxes?
|
343
|
+
// use_with_users - string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
|
321
344
|
(0, _defineProperty2.default)(Clickwrap, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
|
322
345
|
var params,
|
323
346
|
options,
|
package/lib/models/DnsRecord.js
CHANGED
@@ -31,15 +31,19 @@ var DnsRecord = /*#__PURE__*/(0, _createClass2.default)(function DnsRecord() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// string # Unique label for DNS record; used by Zapier and other integrations.
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
38
|
+
// string # DNS record domain name
|
37
39
|
(0, _defineProperty2.default)(this, "getDomain", function () {
|
38
40
|
return _this.attributes.domain;
|
39
41
|
});
|
42
|
+
// string # DNS record type
|
40
43
|
(0, _defineProperty2.default)(this, "getRrtype", function () {
|
41
44
|
return _this.attributes.rrtype;
|
42
45
|
});
|
46
|
+
// string # DNS record value
|
43
47
|
(0, _defineProperty2.default)(this, "getValue", function () {
|
44
48
|
return _this.attributes.value;
|
45
49
|
});
|
@@ -56,6 +60,9 @@ var DnsRecord = /*#__PURE__*/(0, _createClass2.default)(function DnsRecord() {
|
|
56
60
|
});
|
57
61
|
this.options = _objectSpread({}, options);
|
58
62
|
});
|
63
|
+
// Parameters:
|
64
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
65
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
59
66
|
(0, _defineProperty2.default)(DnsRecord, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
60
67
|
var _response$data;
|
61
68
|
var params,
|
package/lib/models/Errors.js
CHANGED
@@ -29,9 +29,11 @@ var Errors = /*#__PURE__*/(0, _createClass2.default)(function Errors() {
|
|
29
29
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
30
30
|
return !!_this.attributes.id;
|
31
31
|
});
|
32
|
+
// array # A list of fields where errors occur
|
32
33
|
(0, _defineProperty2.default)(this, "getFields", function () {
|
33
34
|
return _this.attributes.fields;
|
34
35
|
});
|
36
|
+
// array # A list of error messages
|
35
37
|
(0, _defineProperty2.default)(this, "getMessages", function () {
|
36
38
|
return _this.attributes.messages;
|
37
39
|
});
|
@@ -31,63 +31,74 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Event ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Type of event being recorded.
|
40
42
|
(0, _defineProperty2.default)(this, "getEventType", function () {
|
41
43
|
return _this.attributes.event_type;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setEventType", function (value) {
|
44
46
|
_this.attributes.event_type = value;
|
45
47
|
});
|
48
|
+
// string # Status of event.
|
46
49
|
(0, _defineProperty2.default)(this, "getStatus", function () {
|
47
50
|
return _this.attributes.status;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setStatus", function (value) {
|
50
53
|
_this.attributes.status = value;
|
51
54
|
});
|
55
|
+
// string # Event body
|
52
56
|
(0, _defineProperty2.default)(this, "getBody", function () {
|
53
57
|
return _this.attributes.body;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setBody", function (value) {
|
56
60
|
_this.attributes.body = value;
|
57
61
|
});
|
62
|
+
// date-time # External event create date/time
|
58
63
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
59
64
|
return _this.attributes.created_at;
|
60
65
|
});
|
66
|
+
// string # Link to log file.
|
61
67
|
(0, _defineProperty2.default)(this, "getBodyUrl", function () {
|
62
68
|
return _this.attributes.body_url;
|
63
69
|
});
|
64
70
|
(0, _defineProperty2.default)(this, "setBodyUrl", function (value) {
|
65
71
|
_this.attributes.body_url = value;
|
66
72
|
});
|
73
|
+
// int64 # Folder Behavior ID
|
67
74
|
(0, _defineProperty2.default)(this, "getFolderBehaviorId", function () {
|
68
75
|
return _this.attributes.folder_behavior_id;
|
69
76
|
});
|
70
77
|
(0, _defineProperty2.default)(this, "setFolderBehaviorId", function (value) {
|
71
78
|
_this.attributes.folder_behavior_id = value;
|
72
79
|
});
|
80
|
+
// int64 # For sync events, the number of files handled successfully.
|
73
81
|
(0, _defineProperty2.default)(this, "getSuccessfulFiles", function () {
|
74
82
|
return _this.attributes.successful_files;
|
75
83
|
});
|
76
84
|
(0, _defineProperty2.default)(this, "setSuccessfulFiles", function (value) {
|
77
85
|
_this.attributes.successful_files = value;
|
78
86
|
});
|
87
|
+
// int64 # For sync events, the number of files that encountered errors.
|
79
88
|
(0, _defineProperty2.default)(this, "getErroredFiles", function () {
|
80
89
|
return _this.attributes.errored_files;
|
81
90
|
});
|
82
91
|
(0, _defineProperty2.default)(this, "setErroredFiles", function (value) {
|
83
92
|
_this.attributes.errored_files = value;
|
84
93
|
});
|
94
|
+
// int64 # For sync events, the total number of bytes synced.
|
85
95
|
(0, _defineProperty2.default)(this, "getBytesSynced", function () {
|
86
96
|
return _this.attributes.bytes_synced;
|
87
97
|
});
|
88
98
|
(0, _defineProperty2.default)(this, "setBytesSynced", function (value) {
|
89
99
|
_this.attributes.bytes_synced = value;
|
90
100
|
});
|
101
|
+
// string # Associated Remote Server type, if any
|
91
102
|
(0, _defineProperty2.default)(this, "getRemoteServerType", function () {
|
92
103
|
return _this.attributes.remote_server_type;
|
93
104
|
});
|
@@ -116,6 +127,16 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
|
|
116
127
|
});
|
117
128
|
this.options = _objectSpread({}, options);
|
118
129
|
});
|
130
|
+
// Parameters:
|
131
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
132
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
133
|
+
// sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
|
134
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
135
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
136
|
+
// filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
137
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
138
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
139
|
+
// filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
119
140
|
(0, _defineProperty2.default)(ExternalEvent, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
120
141
|
var _response$data;
|
121
142
|
var params,
|
@@ -157,6 +178,8 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
|
|
157
178
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
158
179
|
return ExternalEvent.list(params, options);
|
159
180
|
});
|
181
|
+
// Parameters:
|
182
|
+
// id (required) - int64 - External Event ID.
|
160
183
|
(0, _defineProperty2.default)(ExternalEvent, "find", /*#__PURE__*/function () {
|
161
184
|
var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(id) {
|
162
185
|
var params,
|
@@ -207,6 +230,9 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
|
|
207
230
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
208
231
|
return ExternalEvent.find(id, params, options);
|
209
232
|
});
|
233
|
+
// Parameters:
|
234
|
+
// status (required) - string - Status of event.
|
235
|
+
// body (required) - string - Event body
|
210
236
|
(0, _defineProperty2.default)(ExternalEvent, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
211
237
|
var params,
|
212
238
|
options,
|
package/lib/models/File.js
CHANGED
@@ -137,165 +137,199 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
137
137
|
return _ref4.apply(this, arguments);
|
138
138
|
};
|
139
139
|
}());
|
140
|
+
// string # File/Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
140
141
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
141
142
|
return _this.attributes.path;
|
142
143
|
});
|
143
144
|
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
144
145
|
_this.attributes.path = value;
|
145
146
|
});
|
147
|
+
// string # File/Folder display name
|
146
148
|
(0, _defineProperty2.default)(this, "getDisplayName", function () {
|
147
149
|
return _this.attributes.display_name;
|
148
150
|
});
|
149
151
|
(0, _defineProperty2.default)(this, "setDisplayName", function (value) {
|
150
152
|
_this.attributes.display_name = value;
|
151
153
|
});
|
154
|
+
// string # Type: `directory` or `file`.
|
152
155
|
(0, _defineProperty2.default)(this, "getType", function () {
|
153
156
|
return _this.attributes.type;
|
154
157
|
});
|
155
158
|
(0, _defineProperty2.default)(this, "setType", function (value) {
|
156
159
|
_this.attributes.type = value;
|
157
160
|
});
|
161
|
+
// int64 # File/Folder size
|
158
162
|
(0, _defineProperty2.default)(this, "getSize", function () {
|
159
163
|
return _this.attributes.size;
|
160
164
|
});
|
161
165
|
(0, _defineProperty2.default)(this, "setSize", function (value) {
|
162
166
|
_this.attributes.size = value;
|
163
167
|
});
|
168
|
+
// date-time # File created date/time
|
164
169
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
165
170
|
return _this.attributes.created_at;
|
166
171
|
});
|
172
|
+
// date-time # File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
|
167
173
|
(0, _defineProperty2.default)(this, "getMtime", function () {
|
168
174
|
return _this.attributes.mtime;
|
169
175
|
});
|
170
176
|
(0, _defineProperty2.default)(this, "setMtime", function (value) {
|
171
177
|
_this.attributes.mtime = value;
|
172
178
|
});
|
179
|
+
// date-time # File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.
|
173
180
|
(0, _defineProperty2.default)(this, "getProvidedMtime", function () {
|
174
181
|
return _this.attributes.provided_mtime;
|
175
182
|
});
|
176
183
|
(0, _defineProperty2.default)(this, "setProvidedMtime", function (value) {
|
177
184
|
_this.attributes.provided_mtime = value;
|
178
185
|
});
|
186
|
+
// string # File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
179
187
|
(0, _defineProperty2.default)(this, "getCrc32", function () {
|
180
188
|
return _this.attributes.crc32;
|
181
189
|
});
|
182
190
|
(0, _defineProperty2.default)(this, "setCrc32", function (value) {
|
183
191
|
_this.attributes.crc32 = value;
|
184
192
|
});
|
193
|
+
// string # File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
185
194
|
(0, _defineProperty2.default)(this, "getMd5", function () {
|
186
195
|
return _this.attributes.md5;
|
187
196
|
});
|
188
197
|
(0, _defineProperty2.default)(this, "setMd5", function (value) {
|
189
198
|
_this.attributes.md5 = value;
|
190
199
|
});
|
200
|
+
// string # MIME Type. This is determined by the filename extension and is not stored separately internally.
|
191
201
|
(0, _defineProperty2.default)(this, "getMimeType", function () {
|
192
202
|
return _this.attributes.mime_type;
|
193
203
|
});
|
194
204
|
(0, _defineProperty2.default)(this, "setMimeType", function (value) {
|
195
205
|
_this.attributes.mime_type = value;
|
196
206
|
});
|
207
|
+
// string # Region location
|
197
208
|
(0, _defineProperty2.default)(this, "getRegion", function () {
|
198
209
|
return _this.attributes.region;
|
199
210
|
});
|
200
211
|
(0, _defineProperty2.default)(this, "setRegion", function (value) {
|
201
212
|
_this.attributes.region = value;
|
202
213
|
});
|
214
|
+
// string # A short string representing the current user's permissions. Can be `r`,`w`,`d`, `l` or any combination
|
203
215
|
(0, _defineProperty2.default)(this, "getPermissions", function () {
|
204
216
|
return _this.attributes.permissions;
|
205
217
|
});
|
206
218
|
(0, _defineProperty2.default)(this, "setPermissions", function (value) {
|
207
219
|
_this.attributes.permissions = value;
|
208
220
|
});
|
221
|
+
// boolean # Are subfolders locked and unable to be modified?
|
209
222
|
(0, _defineProperty2.default)(this, "getSubfoldersLocked", function () {
|
210
223
|
return _this.attributes.subfolders_locked;
|
211
224
|
});
|
212
225
|
(0, _defineProperty2.default)(this, "setSubfoldersLocked", function (value) {
|
213
226
|
_this.attributes.subfolders_locked = value;
|
214
227
|
});
|
228
|
+
// boolean # Is this folder locked and unable to be modified?
|
215
229
|
(0, _defineProperty2.default)(this, "getIsLocked", function () {
|
216
230
|
return _this.attributes.is_locked;
|
217
231
|
});
|
218
232
|
(0, _defineProperty2.default)(this, "setIsLocked", function (value) {
|
219
233
|
_this.attributes.is_locked = value;
|
220
234
|
});
|
235
|
+
// string # Link to download file. Provided only in response to a download request.
|
221
236
|
(0, _defineProperty2.default)(this, "getDownloadUri", function () {
|
222
237
|
return _this.attributes.download_uri;
|
223
238
|
});
|
224
239
|
(0, _defineProperty2.default)(this, "setDownloadUri", function (value) {
|
225
240
|
_this.attributes.download_uri = value;
|
226
241
|
});
|
242
|
+
// string # Bookmark/priority color of file/folder
|
227
243
|
(0, _defineProperty2.default)(this, "getPriorityColor", function () {
|
228
244
|
return _this.attributes.priority_color;
|
229
245
|
});
|
230
246
|
(0, _defineProperty2.default)(this, "setPriorityColor", function (value) {
|
231
247
|
_this.attributes.priority_color = value;
|
232
248
|
});
|
249
|
+
// int64 # File preview ID
|
233
250
|
(0, _defineProperty2.default)(this, "getPreviewId", function () {
|
234
251
|
return _this.attributes.preview_id;
|
235
252
|
});
|
236
253
|
(0, _defineProperty2.default)(this, "setPreviewId", function (value) {
|
237
254
|
_this.attributes.preview_id = value;
|
238
255
|
});
|
256
|
+
// Preview # File preview
|
239
257
|
(0, _defineProperty2.default)(this, "getPreview", function () {
|
240
258
|
return _this.attributes.preview;
|
241
259
|
});
|
242
260
|
(0, _defineProperty2.default)(this, "setPreview", function (value) {
|
243
261
|
_this.attributes.preview = value;
|
244
262
|
});
|
263
|
+
// string # The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
245
264
|
(0, _defineProperty2.default)(this, "getAction", function () {
|
246
265
|
return _this.attributes.action;
|
247
266
|
});
|
248
267
|
(0, _defineProperty2.default)(this, "setAction", function (value) {
|
249
268
|
_this.attributes.action = value;
|
250
269
|
});
|
270
|
+
// int64 # Length of file.
|
251
271
|
(0, _defineProperty2.default)(this, "getLength", function () {
|
252
272
|
return _this.attributes.length;
|
253
273
|
});
|
254
274
|
(0, _defineProperty2.default)(this, "setLength", function (value) {
|
255
275
|
_this.attributes.length = value;
|
256
276
|
});
|
277
|
+
// boolean # Create parent directories if they do not exist?
|
257
278
|
(0, _defineProperty2.default)(this, "getMkdirParents", function () {
|
258
279
|
return _this.attributes.mkdir_parents;
|
259
280
|
});
|
260
281
|
(0, _defineProperty2.default)(this, "setMkdirParents", function (value) {
|
261
282
|
_this.attributes.mkdir_parents = value;
|
262
283
|
});
|
284
|
+
// int64 # Part if uploading a part.
|
263
285
|
(0, _defineProperty2.default)(this, "getPart", function () {
|
264
286
|
return _this.attributes.part;
|
265
287
|
});
|
266
288
|
(0, _defineProperty2.default)(this, "setPart", function (value) {
|
267
289
|
_this.attributes.part = value;
|
268
290
|
});
|
291
|
+
// int64 # How many parts to fetch?
|
269
292
|
(0, _defineProperty2.default)(this, "getParts", function () {
|
270
293
|
return _this.attributes.parts;
|
271
294
|
});
|
272
295
|
(0, _defineProperty2.default)(this, "setParts", function (value) {
|
273
296
|
_this.attributes.parts = value;
|
274
297
|
});
|
298
|
+
// string #
|
275
299
|
(0, _defineProperty2.default)(this, "getRef", function () {
|
276
300
|
return _this.attributes.ref;
|
277
301
|
});
|
278
302
|
(0, _defineProperty2.default)(this, "setRef", function (value) {
|
279
303
|
_this.attributes.ref = value;
|
280
304
|
});
|
305
|
+
// int64 # File byte offset to restart from.
|
281
306
|
(0, _defineProperty2.default)(this, "getRestart", function () {
|
282
307
|
return _this.attributes.restart;
|
283
308
|
});
|
284
309
|
(0, _defineProperty2.default)(this, "setRestart", function (value) {
|
285
310
|
_this.attributes.restart = value;
|
286
311
|
});
|
312
|
+
// string # If copying folder, copy just the structure?
|
287
313
|
(0, _defineProperty2.default)(this, "getStructure", function () {
|
288
314
|
return _this.attributes.structure;
|
289
315
|
});
|
290
316
|
(0, _defineProperty2.default)(this, "setStructure", function (value) {
|
291
317
|
_this.attributes.structure = value;
|
292
318
|
});
|
319
|
+
// boolean # Allow file rename instead of overwrite?
|
293
320
|
(0, _defineProperty2.default)(this, "getWithRename", function () {
|
294
321
|
return _this.attributes.with_rename;
|
295
322
|
});
|
296
323
|
(0, _defineProperty2.default)(this, "setWithRename", function (value) {
|
297
324
|
_this.attributes.with_rename = value;
|
298
325
|
});
|
326
|
+
// Download file
|
327
|
+
//
|
328
|
+
// Parameters:
|
329
|
+
// action - string - Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
|
330
|
+
// preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
331
|
+
// with_previews - boolean - Include file preview information?
|
332
|
+
// with_priority_color - boolean - Include file priority color information?
|
299
333
|
(0, _defineProperty2.default)(this, "download", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
|
300
334
|
var params,
|
301
335
|
response,
|
@@ -360,6 +394,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
360
394
|
}
|
361
395
|
}, _callee5);
|
362
396
|
})));
|
397
|
+
// Parameters:
|
398
|
+
// provided_mtime - string - Modified time of file.
|
399
|
+
// priority_color - string - Priority/Bookmark color of file.
|
363
400
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
|
364
401
|
var params,
|
365
402
|
response,
|
@@ -424,6 +461,8 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
424
461
|
}
|
425
462
|
}, _callee6);
|
426
463
|
})));
|
464
|
+
// Parameters:
|
465
|
+
// recursive - boolean - If true, will recursively delete folers. Otherwise, will error on non-empty folders.
|
427
466
|
(0, _defineProperty2.default)(this, "delete", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
|
428
467
|
var params,
|
429
468
|
response,
|
@@ -480,6 +519,11 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
480
519
|
var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
|
481
520
|
return _this.delete(params);
|
482
521
|
});
|
522
|
+
// Copy file/folder
|
523
|
+
//
|
524
|
+
// Parameters:
|
525
|
+
// destination (required) - string - Copy destination path.
|
526
|
+
// structure - boolean - Copy structure only?
|
483
527
|
(0, _defineProperty2.default)(this, "copy", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee8() {
|
484
528
|
var params,
|
485
529
|
response,
|
@@ -552,6 +596,10 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
552
596
|
}
|
553
597
|
}, _callee8);
|
554
598
|
})));
|
599
|
+
// Move file/folder
|
600
|
+
//
|
601
|
+
// Parameters:
|
602
|
+
// destination (required) - string - Move destination path.
|
555
603
|
(0, _defineProperty2.default)(this, "move", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9() {
|
556
604
|
var params,
|
557
605
|
response,
|
@@ -624,6 +672,16 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
624
672
|
}
|
625
673
|
}, _callee9);
|
626
674
|
})));
|
675
|
+
// Begin file upload
|
676
|
+
//
|
677
|
+
// Parameters:
|
678
|
+
// mkdir_parents - boolean - Create parent directories if they do not exist?
|
679
|
+
// part - int64 - Part if uploading a part.
|
680
|
+
// parts - int64 - How many parts to fetch?
|
681
|
+
// ref - string -
|
682
|
+
// restart - int64 - File byte offset to restart from.
|
683
|
+
// size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting).
|
684
|
+
// with_rename - boolean - Allow file rename instead of overwrite?
|
627
685
|
(0, _defineProperty2.default)(this, "beginUpload", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10() {
|
628
686
|
var _response$data;
|
629
687
|
var params,
|
@@ -818,6 +876,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
818
876
|
return _ref15.apply(this, arguments);
|
819
877
|
};
|
820
878
|
}());
|
879
|
+
/**
|
880
|
+
* @note see File.copy() for list of supported params
|
881
|
+
*/
|
821
882
|
(0, _defineProperty2.default)(File, "uploadStream", /*#__PURE__*/function () {
|
822
883
|
var _ref16 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee16(destinationPath, readableStream, params, options) {
|
823
884
|
var firstFileUploadPart, file;
|
@@ -949,6 +1010,10 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
949
1010
|
return _ref16.apply(this, arguments);
|
950
1011
|
};
|
951
1012
|
}());
|
1013
|
+
/**
|
1014
|
+
* data - string, Buffer, Stream, any object implementing Symbol.iterator or Symbol.asyncIterator
|
1015
|
+
* @note see File.copy() for list of supported params
|
1016
|
+
*/
|
952
1017
|
(0, _defineProperty2.default)(File, "uploadData", /*#__PURE__*/function () {
|
953
1018
|
var _ref19 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee17(destinationPath, data, params, options) {
|
954
1019
|
return _regenerator.default.wrap(function _callee17$(_context17) {
|
@@ -971,6 +1036,9 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
971
1036
|
return _ref19.apply(this, arguments);
|
972
1037
|
};
|
973
1038
|
}());
|
1039
|
+
/**
|
1040
|
+
* @note see File.copy() for list of supported params
|
1041
|
+
*/
|
974
1042
|
(0, _defineProperty2.default)(File, "uploadFile", /*#__PURE__*/function () {
|
975
1043
|
var _ref20 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee18(destinationPath, sourceFilePath, params, options) {
|
976
1044
|
var _require3, openDiskFileReadStream, stream;
|
@@ -996,6 +1064,21 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
996
1064
|
return _ref20.apply(this, arguments);
|
997
1065
|
};
|
998
1066
|
}());
|
1067
|
+
// Parameters:
|
1068
|
+
// path (required) - string - Path to operate on.
|
1069
|
+
// action - string - The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
1070
|
+
// etags[etag] (required) - array(string) - etag identifier.
|
1071
|
+
// etags[part] (required) - array(int64) - Part number.
|
1072
|
+
// length - int64 - Length of file.
|
1073
|
+
// mkdir_parents - boolean - Create parent directories if they do not exist?
|
1074
|
+
// part - int64 - Part if uploading a part.
|
1075
|
+
// parts - int64 - How many parts to fetch?
|
1076
|
+
// provided_mtime - string - User provided modification time.
|
1077
|
+
// ref - string -
|
1078
|
+
// restart - int64 - File byte offset to restart from.
|
1079
|
+
// size - int64 - Size of file.
|
1080
|
+
// structure - string - If copying folder, copy just the structure?
|
1081
|
+
// with_rename - boolean - Allow file rename instead of overwrite?
|
999
1082
|
(0, _defineProperty2.default)(File, "create", /*#__PURE__*/function () {
|
1000
1083
|
var _ref21 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee19(path) {
|
1001
1084
|
var params,
|
@@ -1095,6 +1178,11 @@ var File = /*#__PURE__*/(0, _createClass2.default)(function File() {
|
|
1095
1178
|
return _ref21.apply(this, arguments);
|
1096
1179
|
};
|
1097
1180
|
}());
|
1181
|
+
// Parameters:
|
1182
|
+
// path (required) - string - Path to operate on.
|
1183
|
+
// preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
1184
|
+
// with_previews - boolean - Include file preview information?
|
1185
|
+
// with_priority_color - boolean - Include file priority color information?
|
1098
1186
|
(0, _defineProperty2.default)(File, "find", /*#__PURE__*/function () {
|
1099
1187
|
var _ref22 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee20(path) {
|
1100
1188
|
var params,
|
package/lib/models/FileAction.js
CHANGED
@@ -29,9 +29,11 @@ var FileAction = /*#__PURE__*/(0, _createClass2.default)(function FileAction() {
|
|
29
29
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
30
30
|
return !!_this.attributes.path;
|
31
31
|
});
|
32
|
+
// string # Status of file operation.
|
32
33
|
(0, _defineProperty2.default)(this, "getStatus", function () {
|
33
34
|
return _this.attributes.status;
|
34
35
|
});
|
36
|
+
// int64 # If status is pending, this is the id of the FileMigration to check for status updates.
|
35
37
|
(0, _defineProperty2.default)(this, "getFileMigrationId", function () {
|
36
38
|
return _this.attributes.file_migration_id;
|
37
39
|
});
|
@@ -31,30 +31,36 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # File Comment ID
|
34
35
|
(0, _defineProperty2.default)(this, "getId", function () {
|
35
36
|
return _this.attributes.id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
38
39
|
_this.attributes.id = value;
|
39
40
|
});
|
41
|
+
// string # Comment body.
|
40
42
|
(0, _defineProperty2.default)(this, "getBody", function () {
|
41
43
|
return _this.attributes.body;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setBody", function (value) {
|
44
46
|
_this.attributes.body = value;
|
45
47
|
});
|
48
|
+
// array # Reactions to this comment.
|
46
49
|
(0, _defineProperty2.default)(this, "getReactions", function () {
|
47
50
|
return _this.attributes.reactions;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setReactions", function (value) {
|
50
53
|
_this.attributes.reactions = value;
|
51
54
|
});
|
55
|
+
// string # File path.
|
52
56
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
53
57
|
return _this.attributes.path;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
56
60
|
_this.attributes.path = value;
|
57
61
|
});
|
62
|
+
// Parameters:
|
63
|
+
// body (required) - string - Comment body.
|
58
64
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
59
65
|
var params,
|
60
66
|
response,
|
@@ -205,6 +211,10 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
|
|
205
211
|
});
|
206
212
|
this.options = _objectSpread({}, options);
|
207
213
|
});
|
214
|
+
// Parameters:
|
215
|
+
// cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
216
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
217
|
+
// path (required) - string - Path to operate on.
|
208
218
|
(0, _defineProperty2.default)(FileComment, "listFor", /*#__PURE__*/function () {
|
209
219
|
var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(path) {
|
210
220
|
var _response$data;
|
@@ -265,6 +275,9 @@ var FileComment = /*#__PURE__*/(0, _createClass2.default)(function FileComment()
|
|
265
275
|
return _ref5.apply(this, arguments);
|
266
276
|
};
|
267
277
|
}());
|
278
|
+
// Parameters:
|
279
|
+
// body (required) - string - Comment body.
|
280
|
+
// path (required) - string - File path.
|
268
281
|
(0, _defineProperty2.default)(FileComment, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
|
269
282
|
var params,
|
270
283
|
options,
|