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/Bundle.js
CHANGED
@@ -31,201 +31,240 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// string # Bundle code. This code forms the end part of the Public URL.
|
34
35
|
(0, _defineProperty2.default)(this, "getCode", function () {
|
35
36
|
return _this.attributes.code;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setCode", function (value) {
|
38
39
|
_this.attributes.code = value;
|
39
40
|
});
|
41
|
+
// string # Public URL of Share Link
|
40
42
|
(0, _defineProperty2.default)(this, "getUrl", function () {
|
41
43
|
return _this.attributes.url;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setUrl", function (value) {
|
44
46
|
_this.attributes.url = value;
|
45
47
|
});
|
48
|
+
// string # Public description
|
46
49
|
(0, _defineProperty2.default)(this, "getDescription", function () {
|
47
50
|
return _this.attributes.description;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setDescription", function (value) {
|
50
53
|
_this.attributes.description = value;
|
51
54
|
});
|
55
|
+
// boolean # Is this bundle password protected?
|
52
56
|
(0, _defineProperty2.default)(this, "getPasswordProtected", function () {
|
53
57
|
return _this.attributes.password_protected;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setPasswordProtected", function (value) {
|
56
60
|
_this.attributes.password_protected = value;
|
57
61
|
});
|
62
|
+
// string # Permissions that apply to Folders in this Share Link.
|
58
63
|
(0, _defineProperty2.default)(this, "getPermissions", function () {
|
59
64
|
return _this.attributes.permissions;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setPermissions", function (value) {
|
62
67
|
_this.attributes.permissions = value;
|
63
68
|
});
|
69
|
+
// boolean # Restrict users to previewing files only?
|
64
70
|
(0, _defineProperty2.default)(this, "getPreviewOnly", function () {
|
65
71
|
return _this.attributes.preview_only;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setPreviewOnly", function (value) {
|
68
74
|
_this.attributes.preview_only = value;
|
69
75
|
});
|
76
|
+
// boolean # Show a registration page that captures the downloader's name and email address?
|
70
77
|
(0, _defineProperty2.default)(this, "getRequireRegistration", function () {
|
71
78
|
return _this.attributes.require_registration;
|
72
79
|
});
|
73
80
|
(0, _defineProperty2.default)(this, "setRequireRegistration", function (value) {
|
74
81
|
_this.attributes.require_registration = value;
|
75
82
|
});
|
83
|
+
// boolean # Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
76
84
|
(0, _defineProperty2.default)(this, "getRequireShareRecipient", function () {
|
77
85
|
return _this.attributes.require_share_recipient;
|
78
86
|
});
|
79
87
|
(0, _defineProperty2.default)(this, "setRequireShareRecipient", function (value) {
|
80
88
|
_this.attributes.require_share_recipient = value;
|
81
89
|
});
|
90
|
+
// string # Legal text that must be agreed to prior to accessing Bundle.
|
82
91
|
(0, _defineProperty2.default)(this, "getClickwrapBody", function () {
|
83
92
|
return _this.attributes.clickwrap_body;
|
84
93
|
});
|
85
94
|
(0, _defineProperty2.default)(this, "setClickwrapBody", function (value) {
|
86
95
|
_this.attributes.clickwrap_body = value;
|
87
96
|
});
|
97
|
+
// FormFieldSet # Custom Form to use
|
88
98
|
(0, _defineProperty2.default)(this, "getFormFieldSet", function () {
|
89
99
|
return _this.attributes.form_field_set;
|
90
100
|
});
|
91
101
|
(0, _defineProperty2.default)(this, "setFormFieldSet", function (value) {
|
92
102
|
_this.attributes.form_field_set = value;
|
93
103
|
});
|
104
|
+
// boolean # BundleRegistrations can be saved without providing name?
|
94
105
|
(0, _defineProperty2.default)(this, "getSkipName", function () {
|
95
106
|
return _this.attributes.skip_name;
|
96
107
|
});
|
97
108
|
(0, _defineProperty2.default)(this, "setSkipName", function (value) {
|
98
109
|
_this.attributes.skip_name = value;
|
99
110
|
});
|
111
|
+
// boolean # BundleRegistrations can be saved without providing email?
|
100
112
|
(0, _defineProperty2.default)(this, "getSkipEmail", function () {
|
101
113
|
return _this.attributes.skip_email;
|
102
114
|
});
|
103
115
|
(0, _defineProperty2.default)(this, "setSkipEmail", function (value) {
|
104
116
|
_this.attributes.skip_email = value;
|
105
117
|
});
|
118
|
+
// boolean # BundleRegistrations can be saved without providing company?
|
106
119
|
(0, _defineProperty2.default)(this, "getSkipCompany", function () {
|
107
120
|
return _this.attributes.skip_company;
|
108
121
|
});
|
109
122
|
(0, _defineProperty2.default)(this, "setSkipCompany", function (value) {
|
110
123
|
_this.attributes.skip_company = value;
|
111
124
|
});
|
125
|
+
// int64 # Bundle ID
|
112
126
|
(0, _defineProperty2.default)(this, "getId", function () {
|
113
127
|
return _this.attributes.id;
|
114
128
|
});
|
115
129
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
116
130
|
_this.attributes.id = value;
|
117
131
|
});
|
132
|
+
// date-time # Bundle created at date/time
|
118
133
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
119
134
|
return _this.attributes.created_at;
|
120
135
|
});
|
136
|
+
// boolean # Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
|
121
137
|
(0, _defineProperty2.default)(this, "getDontSeparateSubmissionsByFolder", function () {
|
122
138
|
return _this.attributes.dont_separate_submissions_by_folder;
|
123
139
|
});
|
124
140
|
(0, _defineProperty2.default)(this, "setDontSeparateSubmissionsByFolder", function (value) {
|
125
141
|
_this.attributes.dont_separate_submissions_by_folder = value;
|
126
142
|
});
|
143
|
+
// date-time # Bundle expiration date/time
|
127
144
|
(0, _defineProperty2.default)(this, "getExpiresAt", function () {
|
128
145
|
return _this.attributes.expires_at;
|
129
146
|
});
|
130
147
|
(0, _defineProperty2.default)(this, "setExpiresAt", function (value) {
|
131
148
|
_this.attributes.expires_at = value;
|
132
149
|
});
|
150
|
+
// int64 # Maximum number of times bundle can be accessed
|
133
151
|
(0, _defineProperty2.default)(this, "getMaxUses", function () {
|
134
152
|
return _this.attributes.max_uses;
|
135
153
|
});
|
136
154
|
(0, _defineProperty2.default)(this, "setMaxUses", function (value) {
|
137
155
|
_this.attributes.max_uses = value;
|
138
156
|
});
|
157
|
+
// string # Bundle internal note
|
139
158
|
(0, _defineProperty2.default)(this, "getNote", function () {
|
140
159
|
return _this.attributes.note;
|
141
160
|
});
|
142
161
|
(0, _defineProperty2.default)(this, "setNote", function (value) {
|
143
162
|
_this.attributes.note = value;
|
144
163
|
});
|
164
|
+
// string # Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
|
145
165
|
(0, _defineProperty2.default)(this, "getPathTemplate", function () {
|
146
166
|
return _this.attributes.path_template;
|
147
167
|
});
|
148
168
|
(0, _defineProperty2.default)(this, "setPathTemplate", function (value) {
|
149
169
|
_this.attributes.path_template = value;
|
150
170
|
});
|
171
|
+
// boolean # Send delivery receipt to the uploader. Note: For writable share only
|
151
172
|
(0, _defineProperty2.default)(this, "getSendEmailReceiptToUploader", function () {
|
152
173
|
return _this.attributes.send_email_receipt_to_uploader;
|
153
174
|
});
|
154
175
|
(0, _defineProperty2.default)(this, "setSendEmailReceiptToUploader", function (value) {
|
155
176
|
_this.attributes.send_email_receipt_to_uploader = value;
|
156
177
|
});
|
178
|
+
// int64 # Bundle creator user ID
|
157
179
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
158
180
|
return _this.attributes.user_id;
|
159
181
|
});
|
160
182
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
161
183
|
_this.attributes.user_id = value;
|
162
184
|
});
|
185
|
+
// string # Bundle creator username
|
163
186
|
(0, _defineProperty2.default)(this, "getUsername", function () {
|
164
187
|
return _this.attributes.username;
|
165
188
|
});
|
166
189
|
(0, _defineProperty2.default)(this, "setUsername", function (value) {
|
167
190
|
_this.attributes.username = value;
|
168
191
|
});
|
192
|
+
// int64 # ID of the clickwrap to use with this bundle.
|
169
193
|
(0, _defineProperty2.default)(this, "getClickwrapId", function () {
|
170
194
|
return _this.attributes.clickwrap_id;
|
171
195
|
});
|
172
196
|
(0, _defineProperty2.default)(this, "setClickwrapId", function (value) {
|
173
197
|
_this.attributes.clickwrap_id = value;
|
174
198
|
});
|
199
|
+
// int64 # ID of the associated inbox, if available.
|
175
200
|
(0, _defineProperty2.default)(this, "getInboxId", function () {
|
176
201
|
return _this.attributes.inbox_id;
|
177
202
|
});
|
178
203
|
(0, _defineProperty2.default)(this, "setInboxId", function (value) {
|
179
204
|
_this.attributes.inbox_id = value;
|
180
205
|
});
|
206
|
+
// Image # Preview watermark image applied to all bundle items.
|
181
207
|
(0, _defineProperty2.default)(this, "getWatermarkAttachment", function () {
|
182
208
|
return _this.attributes.watermark_attachment;
|
183
209
|
});
|
184
210
|
(0, _defineProperty2.default)(this, "setWatermarkAttachment", function (value) {
|
185
211
|
_this.attributes.watermark_attachment = value;
|
186
212
|
});
|
213
|
+
// object # Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
187
214
|
(0, _defineProperty2.default)(this, "getWatermarkValue", function () {
|
188
215
|
return _this.attributes.watermark_value;
|
189
216
|
});
|
190
217
|
(0, _defineProperty2.default)(this, "setWatermarkValue", function (value) {
|
191
218
|
_this.attributes.watermark_value = value;
|
192
219
|
});
|
220
|
+
// boolean # Does this bundle have an associated inbox?
|
193
221
|
(0, _defineProperty2.default)(this, "getHasInbox", function () {
|
194
222
|
return _this.attributes.has_inbox;
|
195
223
|
});
|
196
224
|
(0, _defineProperty2.default)(this, "setHasInbox", function (value) {
|
197
225
|
_this.attributes.has_inbox = value;
|
198
226
|
});
|
227
|
+
// array # A list of paths in this bundle
|
199
228
|
(0, _defineProperty2.default)(this, "getPaths", function () {
|
200
229
|
return _this.attributes.paths;
|
201
230
|
});
|
202
231
|
(0, _defineProperty2.default)(this, "setPaths", function (value) {
|
203
232
|
_this.attributes.paths = value;
|
204
233
|
});
|
234
|
+
// string # Password for this bundle.
|
205
235
|
(0, _defineProperty2.default)(this, "getPassword", function () {
|
206
236
|
return _this.attributes.password;
|
207
237
|
});
|
208
238
|
(0, _defineProperty2.default)(this, "setPassword", function (value) {
|
209
239
|
_this.attributes.password = value;
|
210
240
|
});
|
241
|
+
// int64 # Id of Form Field Set to use with this bundle
|
211
242
|
(0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
|
212
243
|
return _this.attributes.form_field_set_id;
|
213
244
|
});
|
214
245
|
(0, _defineProperty2.default)(this, "setFormFieldSetId", function (value) {
|
215
246
|
_this.attributes.form_field_set_id = value;
|
216
247
|
});
|
248
|
+
// file # Preview watermark image applied to all bundle items.
|
217
249
|
(0, _defineProperty2.default)(this, "getWatermarkAttachmentFile", function () {
|
218
250
|
return _this.attributes.watermark_attachment_file;
|
219
251
|
});
|
220
252
|
(0, _defineProperty2.default)(this, "setWatermarkAttachmentFile", function (value) {
|
221
253
|
_this.attributes.watermark_attachment_file = value;
|
222
254
|
});
|
255
|
+
// boolean # If true, will delete the file stored in watermark_attachment
|
223
256
|
(0, _defineProperty2.default)(this, "getWatermarkAttachmentDelete", function () {
|
224
257
|
return _this.attributes.watermark_attachment_delete;
|
225
258
|
});
|
226
259
|
(0, _defineProperty2.default)(this, "setWatermarkAttachmentDelete", function (value) {
|
227
260
|
_this.attributes.watermark_attachment_delete = value;
|
228
261
|
});
|
262
|
+
// Send email(s) with a link to bundle
|
263
|
+
//
|
264
|
+
// Parameters:
|
265
|
+
// to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used.
|
266
|
+
// note - string - Note to include in email.
|
267
|
+
// recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.
|
229
268
|
(0, _defineProperty2.default)(this, "share", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
230
269
|
var params,
|
231
270
|
response,
|
@@ -296,6 +335,29 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
|
|
296
335
|
}
|
297
336
|
}, _callee);
|
298
337
|
})));
|
338
|
+
// Parameters:
|
339
|
+
// paths - array(string) - A list of paths to include in this bundle.
|
340
|
+
// password - string - Password for this bundle.
|
341
|
+
// form_field_set_id - int64 - Id of Form Field Set to use with this bundle
|
342
|
+
// clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
343
|
+
// code - string - Bundle code. This code forms the end part of the Public URL.
|
344
|
+
// description - string - Public description
|
345
|
+
// dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
|
346
|
+
// expires_at - string - Bundle expiration date/time
|
347
|
+
// inbox_id - int64 - ID of the associated inbox, if available.
|
348
|
+
// max_uses - int64 - Maximum number of times bundle can be accessed
|
349
|
+
// note - string - Bundle internal note
|
350
|
+
// path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
|
351
|
+
// permissions - string - Permissions that apply to Folders in this Share Link.
|
352
|
+
// preview_only - boolean - Restrict users to previewing files only?
|
353
|
+
// require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
354
|
+
// require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
355
|
+
// send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
|
356
|
+
// skip_company - boolean - BundleRegistrations can be saved without providing company?
|
357
|
+
// skip_email - boolean - BundleRegistrations can be saved without providing email?
|
358
|
+
// skip_name - boolean - BundleRegistrations can be saved without providing name?
|
359
|
+
// watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
360
|
+
// watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
299
361
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
|
300
362
|
var params,
|
301
363
|
response,
|
@@ -498,6 +560,17 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
|
|
498
560
|
});
|
499
561
|
this.options = _objectSpread({}, options);
|
500
562
|
});
|
563
|
+
// Parameters:
|
564
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
565
|
+
// 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.
|
566
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
567
|
+
// 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 `created_at` and `code`.
|
568
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
569
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
570
|
+
// 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`.
|
571
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
572
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
573
|
+
// 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`.
|
501
574
|
(0, _defineProperty2.default)(Bundle, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4() {
|
502
575
|
var _response$data;
|
503
576
|
var params,
|
@@ -545,6 +618,8 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
|
|
545
618
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
546
619
|
return Bundle.list(params, options);
|
547
620
|
});
|
621
|
+
// Parameters:
|
622
|
+
// id (required) - int64 - Bundle ID.
|
548
623
|
(0, _defineProperty2.default)(Bundle, "find", /*#__PURE__*/function () {
|
549
624
|
var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(id) {
|
550
625
|
var params,
|
@@ -595,6 +670,29 @@ var Bundle = /*#__PURE__*/(0, _createClass2.default)(function Bundle() {
|
|
595
670
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
596
671
|
return Bundle.find(id, params, options);
|
597
672
|
});
|
673
|
+
// Parameters:
|
674
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
675
|
+
// paths (required) - array(string) - A list of paths to include in this bundle.
|
676
|
+
// password - string - Password for this bundle.
|
677
|
+
// form_field_set_id - int64 - Id of Form Field Set to use with this bundle
|
678
|
+
// dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
|
679
|
+
// expires_at - string - Bundle expiration date/time
|
680
|
+
// max_uses - int64 - Maximum number of times bundle can be accessed
|
681
|
+
// description - string - Public description
|
682
|
+
// note - string - Bundle internal note
|
683
|
+
// code - string - Bundle code. This code forms the end part of the Public URL.
|
684
|
+
// path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
|
685
|
+
// permissions - string - Permissions that apply to Folders in this Share Link.
|
686
|
+
// preview_only - boolean - Restrict users to previewing files only?
|
687
|
+
// require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
688
|
+
// clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
689
|
+
// inbox_id - int64 - ID of the associated inbox, if available.
|
690
|
+
// require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
691
|
+
// send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
|
692
|
+
// skip_email - boolean - BundleRegistrations can be saved without providing email?
|
693
|
+
// skip_name - boolean - BundleRegistrations can be saved without providing name?
|
694
|
+
// skip_company - boolean - BundleRegistrations can be saved without providing company?
|
695
|
+
// watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
598
696
|
(0, _defineProperty2.default)(Bundle, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6() {
|
599
697
|
var params,
|
600
698
|
options,
|
@@ -31,15 +31,19 @@ var BundleDownload = /*#__PURE__*/(0, _createClass2.default)(function BundleDown
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// BundleRegistration
|
34
35
|
(0, _defineProperty2.default)(this, "getBundleRegistration", function () {
|
35
36
|
return _this.attributes.bundle_registration;
|
36
37
|
});
|
38
|
+
// string # Download method (file or full_zip)
|
37
39
|
(0, _defineProperty2.default)(this, "getDownloadMethod", function () {
|
38
40
|
return _this.attributes.download_method;
|
39
41
|
});
|
42
|
+
// string # Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
40
43
|
(0, _defineProperty2.default)(this, "getPath", function () {
|
41
44
|
return _this.attributes.path;
|
42
45
|
});
|
46
|
+
// date-time # Download date/time
|
43
47
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
44
48
|
return _this.attributes.created_at;
|
45
49
|
});
|
@@ -56,6 +60,18 @@ var BundleDownload = /*#__PURE__*/(0, _createClass2.default)(function BundleDown
|
|
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).
|
66
|
+
// 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 `created_at`.
|
67
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
68
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
69
|
+
// 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`.
|
70
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
71
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
72
|
+
// 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`.
|
73
|
+
// bundle_id - int64 - Bundle ID
|
74
|
+
// bundle_registration_id - int64 - BundleRegistration ID
|
59
75
|
(0, _defineProperty2.default)(BundleDownload, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
60
76
|
var _response$data;
|
61
77
|
var params,
|
@@ -31,36 +31,44 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// int64 # Bundle ID to notify on
|
34
35
|
(0, _defineProperty2.default)(this, "getBundleId", function () {
|
35
36
|
return _this.attributes.bundle_id;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setBundleId", function (value) {
|
38
39
|
_this.attributes.bundle_id = value;
|
39
40
|
});
|
41
|
+
// int64 # Bundle Notification ID
|
40
42
|
(0, _defineProperty2.default)(this, "getId", function () {
|
41
43
|
return _this.attributes.id;
|
42
44
|
});
|
43
45
|
(0, _defineProperty2.default)(this, "setId", function (value) {
|
44
46
|
_this.attributes.id = value;
|
45
47
|
});
|
48
|
+
// boolean # Triggers bundle notification when a registration action occurs for it.
|
46
49
|
(0, _defineProperty2.default)(this, "getNotifyOnRegistration", function () {
|
47
50
|
return _this.attributes.notify_on_registration;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setNotifyOnRegistration", function (value) {
|
50
53
|
_this.attributes.notify_on_registration = value;
|
51
54
|
});
|
55
|
+
// boolean # Triggers bundle notification when a upload action occurs for it.
|
52
56
|
(0, _defineProperty2.default)(this, "getNotifyOnUpload", function () {
|
53
57
|
return _this.attributes.notify_on_upload;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setNotifyOnUpload", function (value) {
|
56
60
|
_this.attributes.notify_on_upload = value;
|
57
61
|
});
|
62
|
+
// int64 # The id of the user to notify.
|
58
63
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
59
64
|
return _this.attributes.user_id;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
62
67
|
_this.attributes.user_id = value;
|
63
68
|
});
|
69
|
+
// Parameters:
|
70
|
+
// notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
71
|
+
// notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
64
72
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
65
73
|
var params,
|
66
74
|
response,
|
@@ -191,6 +199,11 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
191
199
|
});
|
192
200
|
this.options = _objectSpread({}, options);
|
193
201
|
});
|
202
|
+
// Parameters:
|
203
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
204
|
+
// 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.
|
205
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
206
|
+
// bundle_id - int64 - Bundle ID to notify on
|
194
207
|
(0, _defineProperty2.default)(BundleNotification, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
|
195
208
|
var _response$data;
|
196
209
|
var params,
|
@@ -244,6 +257,8 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
244
257
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
245
258
|
return BundleNotification.list(params, options);
|
246
259
|
});
|
260
|
+
// Parameters:
|
261
|
+
// id (required) - int64 - Bundle Notification ID.
|
247
262
|
(0, _defineProperty2.default)(BundleNotification, "find", /*#__PURE__*/function () {
|
248
263
|
var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(id) {
|
249
264
|
var params,
|
@@ -294,6 +309,11 @@ var BundleNotification = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
294
309
|
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
|
295
310
|
return BundleNotification.find(id, params, options);
|
296
311
|
});
|
312
|
+
// Parameters:
|
313
|
+
// user_id - int64 - The id of the user to notify.
|
314
|
+
// notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
315
|
+
// notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
316
|
+
// bundle_id (required) - int64 - Bundle ID to notify on
|
297
317
|
(0, _defineProperty2.default)(BundleNotification, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5() {
|
298
318
|
var params,
|
299
319
|
options,
|
@@ -31,48 +31,56 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// string # The recipient's company.
|
34
35
|
(0, _defineProperty2.default)(this, "getCompany", function () {
|
35
36
|
return _this.attributes.company;
|
36
37
|
});
|
37
38
|
(0, _defineProperty2.default)(this, "setCompany", function (value) {
|
38
39
|
_this.attributes.company = value;
|
39
40
|
});
|
41
|
+
// string # The recipient's name.
|
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 # A note sent to the recipient with the bundle.
|
46
49
|
(0, _defineProperty2.default)(this, "getNote", function () {
|
47
50
|
return _this.attributes.note;
|
48
51
|
});
|
49
52
|
(0, _defineProperty2.default)(this, "setNote", function (value) {
|
50
53
|
_this.attributes.note = value;
|
51
54
|
});
|
55
|
+
// string # The recipient's email address.
|
52
56
|
(0, _defineProperty2.default)(this, "getRecipient", function () {
|
53
57
|
return _this.attributes.recipient;
|
54
58
|
});
|
55
59
|
(0, _defineProperty2.default)(this, "setRecipient", function (value) {
|
56
60
|
_this.attributes.recipient = value;
|
57
61
|
});
|
62
|
+
// date-time # When the Bundle was shared with this recipient.
|
58
63
|
(0, _defineProperty2.default)(this, "getSentAt", function () {
|
59
64
|
return _this.attributes.sent_at;
|
60
65
|
});
|
61
66
|
(0, _defineProperty2.default)(this, "setSentAt", function (value) {
|
62
67
|
_this.attributes.sent_at = value;
|
63
68
|
});
|
69
|
+
// int64 # User ID. Provide a value of `0` to operate the current session's user.
|
64
70
|
(0, _defineProperty2.default)(this, "getUserId", function () {
|
65
71
|
return _this.attributes.user_id;
|
66
72
|
});
|
67
73
|
(0, _defineProperty2.default)(this, "setUserId", function (value) {
|
68
74
|
_this.attributes.user_id = value;
|
69
75
|
});
|
76
|
+
// int64 # Bundle to share.
|
70
77
|
(0, _defineProperty2.default)(this, "getBundleId", function () {
|
71
78
|
return _this.attributes.bundle_id;
|
72
79
|
});
|
73
80
|
(0, _defineProperty2.default)(this, "setBundleId", function (value) {
|
74
81
|
_this.attributes.bundle_id = value;
|
75
82
|
});
|
83
|
+
// boolean # Set to true to share the link with the recipient upon creation.
|
76
84
|
(0, _defineProperty2.default)(this, "getShareAfterCreate", function () {
|
77
85
|
return _this.attributes.share_after_create;
|
78
86
|
});
|
@@ -101,6 +109,18 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
|
|
101
109
|
});
|
102
110
|
this.options = _objectSpread({}, options);
|
103
111
|
});
|
112
|
+
// Parameters:
|
113
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
114
|
+
// 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.
|
115
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
116
|
+
// 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 `has_registrations`.
|
117
|
+
// filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
118
|
+
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
|
119
|
+
// filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
|
120
|
+
// filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
121
|
+
// filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
|
122
|
+
// filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
|
123
|
+
// bundle_id (required) - int64 - List recipients for the bundle with this ID.
|
104
124
|
(0, _defineProperty2.default)(BundleRecipient, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
105
125
|
var _response$data;
|
106
126
|
var params,
|
@@ -160,6 +180,14 @@ var BundleRecipient = /*#__PURE__*/(0, _createClass2.default)(function BundleRec
|
|
160
180
|
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
161
181
|
return BundleRecipient.list(params, options);
|
162
182
|
});
|
183
|
+
// Parameters:
|
184
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
185
|
+
// bundle_id (required) - int64 - Bundle to share.
|
186
|
+
// recipient (required) - string - Email addresses to share this bundle with.
|
187
|
+
// name - string - Name of recipient.
|
188
|
+
// company - string - Company of recipient.
|
189
|
+
// note - string - Note to include in email.
|
190
|
+
// share_after_create - boolean - Set to true to share the link with the recipient upon creation.
|
163
191
|
(0, _defineProperty2.default)(BundleRecipient, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
|
164
192
|
var params,
|
165
193
|
options,
|
@@ -31,42 +31,55 @@ var BundleRegistration = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
31
31
|
(0, _defineProperty2.default)(this, "isLoaded", function () {
|
32
32
|
return !!_this.attributes.id;
|
33
33
|
});
|
34
|
+
// string # Registration cookie code
|
34
35
|
(0, _defineProperty2.default)(this, "getCode", function () {
|
35
36
|
return _this.attributes.code;
|
36
37
|
});
|
38
|
+
// string # Registrant name
|
37
39
|
(0, _defineProperty2.default)(this, "getName", function () {
|
38
40
|
return _this.attributes.name;
|
39
41
|
});
|
42
|
+
// string # Registrant company name
|
40
43
|
(0, _defineProperty2.default)(this, "getCompany", function () {
|
41
44
|
return _this.attributes.company;
|
42
45
|
});
|
46
|
+
// string # Registrant email address
|
43
47
|
(0, _defineProperty2.default)(this, "getEmail", function () {
|
44
48
|
return _this.attributes.email;
|
45
49
|
});
|
50
|
+
// string # Registrant IP Address
|
46
51
|
(0, _defineProperty2.default)(this, "getIp", function () {
|
47
52
|
return _this.attributes.ip;
|
48
53
|
});
|
54
|
+
// string # InboxRegistration cookie code, if there is an associated InboxRegistration
|
49
55
|
(0, _defineProperty2.default)(this, "getInboxCode", function () {
|
50
56
|
return _this.attributes.inbox_code;
|
51
57
|
});
|
58
|
+
// string # Clickwrap text that was shown to the registrant
|
52
59
|
(0, _defineProperty2.default)(this, "getClickwrapBody", function () {
|
53
60
|
return _this.attributes.clickwrap_body;
|
54
61
|
});
|
62
|
+
// int64 # Id of associated form field set
|
55
63
|
(0, _defineProperty2.default)(this, "getFormFieldSetId", function () {
|
56
64
|
return _this.attributes.form_field_set_id;
|
57
65
|
});
|
66
|
+
// object # Data for form field set with form field ids as keys and user data as values
|
58
67
|
(0, _defineProperty2.default)(this, "getFormFieldData", function () {
|
59
68
|
return _this.attributes.form_field_data;
|
60
69
|
});
|
70
|
+
// string # Bundle URL code
|
61
71
|
(0, _defineProperty2.default)(this, "getBundleCode", function () {
|
62
72
|
return _this.attributes.bundle_code;
|
63
73
|
});
|
74
|
+
// int64 # Id of associated bundle
|
64
75
|
(0, _defineProperty2.default)(this, "getBundleId", function () {
|
65
76
|
return _this.attributes.bundle_id;
|
66
77
|
});
|
78
|
+
// int64 # Id of associated bundle recipient
|
67
79
|
(0, _defineProperty2.default)(this, "getBundleRecipientId", function () {
|
68
80
|
return _this.attributes.bundle_recipient_id;
|
69
81
|
});
|
82
|
+
// date-time # Registration creation date/time
|
70
83
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
71
84
|
return _this.attributes.created_at;
|
72
85
|
});
|
@@ -83,6 +96,11 @@ var BundleRegistration = /*#__PURE__*/(0, _createClass2.default)(function Bundle
|
|
83
96
|
});
|
84
97
|
this.options = _objectSpread({}, options);
|
85
98
|
});
|
99
|
+
// Parameters:
|
100
|
+
// user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
|
+
// 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.
|
102
|
+
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
103
|
+
// bundle_id - int64 - ID of the associated Bundle
|
86
104
|
(0, _defineProperty2.default)(BundleRegistration, "list", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
87
105
|
var _response$data;
|
88
106
|
var params,
|