files.com 1.0.188 → 1.0.191
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/Errors.md +186 -0
- package/docs/models/AccountLineItem.md +53 -0
- package/docs/models/Action.md +37 -0
- package/docs/models/ActionNotificationExport.md +82 -0
- package/docs/models/ActionNotificationExportResult.md +49 -0
- package/docs/models/ActionWebhookFailure.md +16 -0
- package/docs/models/ApiKey.md +183 -0
- package/docs/models/App.md +66 -0
- package/docs/models/As2IncomingMessage.md +104 -0
- package/docs/models/As2OutgoingMessage.md +96 -0
- package/docs/models/As2Partner.md +141 -0
- package/docs/models/As2Station.md +142 -0
- package/docs/models/Auto.md +11 -0
- package/docs/models/Automation.md +257 -0
- package/docs/models/AutomationRun.md +61 -0
- package/docs/models/BandwidthSnapshot.md +50 -0
- package/docs/models/Behavior.md +195 -0
- package/docs/models/Bundle.md +330 -0
- package/docs/models/BundleDownload.md +44 -0
- package/docs/models/BundleRecipient.md +76 -0
- package/docs/models/BundleRegistration.md +53 -0
- package/docs/models/Clickwrap.md +120 -0
- package/docs/models/DnsRecord.md +33 -0
- package/docs/models/Errors.md +17 -0
- package/docs/models/ExternalEvent.md +84 -0
- package/docs/models/File.md +339 -0
- package/docs/models/FileAction.md +13 -0
- package/docs/models/FileComment.md +98 -0
- package/docs/models/FileCommentReaction.md +50 -0
- package/docs/models/FileMigration.md +40 -0
- package/docs/models/FileUploadPart.md +39 -0
- package/docs/models/Folder.md +90 -0
- package/docs/models/FormField.md +29 -0
- package/docs/models/FormFieldSet.md +170 -0
- package/docs/models/Group.md +140 -0
- package/docs/models/GroupUser.md +116 -0
- package/docs/models/History.md +151 -0
- package/docs/models/HistoryExport.md +130 -0
- package/docs/models/HistoryExportResult.md +75 -0
- package/docs/models/Image.md +13 -0
- package/docs/models/InboxRecipient.md +76 -0
- package/docs/models/InboxRegistration.md +47 -0
- package/docs/models/InboxUpload.md +42 -0
- package/docs/models/Invoice.md +82 -0
- package/docs/models/InvoiceLineItem.md +27 -0
- package/docs/models/IpAddress.md +51 -0
- package/docs/models/Lock.md +92 -0
- package/docs/models/Message.md +134 -0
- package/docs/models/MessageComment.md +114 -0
- package/docs/models/MessageCommentReaction.md +79 -0
- package/docs/models/MessageReaction.md +79 -0
- package/docs/models/Notification.md +241 -0
- package/docs/models/Payment.md +82 -0
- package/docs/models/PaymentLineItem.md +19 -0
- package/docs/models/Permission.md +94 -0
- package/docs/models/Preview.md +19 -0
- package/docs/models/Priority.md +30 -0
- package/docs/models/Project.md +98 -0
- package/docs/models/PublicIpAddress.md +17 -0
- package/docs/models/PublicKey.md +112 -0
- package/docs/models/RemoteBandwidthSnapshot.md +42 -0
- package/docs/models/RemoteServer.md +385 -0
- package/docs/models/Request.md +97 -0
- package/docs/models/Session.md +50 -0
- package/docs/models/SettingsChange.md +44 -0
- package/docs/models/Site.md +607 -0
- package/docs/models/SsoStrategy.md +139 -0
- package/docs/models/Status.md +30 -0
- package/docs/models/Style.md +76 -0
- package/docs/models/UsageDailySnapshot.md +56 -0
- package/docs/models/UsageSnapshot.md +63 -0
- package/docs/models/User.md +465 -0
- package/docs/models/UserCipherUse.md +39 -0
- package/docs/models/UserRequest.md +80 -0
- package/docs/models/WebhookTest.md +59 -0
- package/lib/Api.js +12 -11
- package/lib/Errors.js +3126 -0
- package/lib/models/AccountLineItem.js +8 -0
- package/lib/models/Action.js +8 -0
- package/lib/models/ActionNotificationExport.js +21 -13
- package/lib/models/ActionNotificationExportResult.js +13 -5
- package/lib/models/ActionWebhookFailure.js +12 -4
- package/lib/models/ApiKey.js +33 -25
- package/lib/models/App.js +10 -2
- package/lib/models/As2IncomingMessage.js +11 -3
- package/lib/models/As2OutgoingMessage.js +11 -3
- package/lib/models/As2Partner.js +34 -26
- package/lib/models/As2Station.js +32 -24
- package/lib/models/Auto.js +8 -0
- package/lib/models/Automation.js +54 -60
- package/lib/models/AutomationRun.js +16 -8
- package/lib/models/BandwidthSnapshot.js +10 -2
- package/lib/models/Behavior.js +46 -38
- package/lib/models/Bundle.js +51 -43
- package/lib/models/BundleDownload.js +12 -4
- package/lib/models/BundleRecipient.js +22 -14
- package/lib/models/BundleRegistration.js +12 -4
- package/lib/models/Clickwrap.js +31 -23
- package/lib/models/DnsRecord.js +10 -2
- package/lib/models/Errors.js +8 -0
- package/lib/models/ExternalEvent.js +18 -10
- package/lib/models/File.js +68 -60
- package/lib/models/FileAction.js +8 -0
- package/lib/models/FileComment.js +27 -19
- package/lib/models/FileCommentReaction.js +18 -10
- package/lib/models/FileMigration.js +11 -3
- package/lib/models/FileUploadPart.js +8 -0
- package/lib/models/Folder.js +19 -11
- package/lib/models/FormField.js +8 -0
- package/lib/models/FormFieldSet.js +27 -19
- package/lib/models/Group.js +30 -22
- package/lib/models/GroupUser.js +32 -24
- package/lib/models/History.js +42 -34
- package/lib/models/HistoryExport.js +34 -26
- package/lib/models/HistoryExportResult.js +13 -5
- package/lib/models/Image.js +8 -0
- package/lib/models/InboxRecipient.js +22 -14
- package/lib/models/InboxRegistration.js +11 -3
- package/lib/models/InboxUpload.js +12 -4
- package/lib/models/Invoice.js +13 -5
- package/lib/models/InvoiceLineItem.js +8 -0
- package/lib/models/IpAddress.js +12 -4
- package/lib/models/Lock.js +24 -16
- package/lib/models/Message.js +37 -29
- package/lib/models/MessageComment.js +29 -21
- package/lib/models/MessageCommentReaction.js +24 -16
- package/lib/models/MessageReaction.js +24 -16
- package/lib/models/Notification.js +38 -30
- package/lib/models/Payment.js +13 -5
- package/lib/models/PaymentLineItem.js +8 -0
- package/lib/models/Permission.js +23 -15
- package/lib/models/Preview.js +8 -0
- package/lib/models/Priority.js +13 -5
- package/lib/models/Project.js +25 -17
- package/lib/models/PublicIpAddress.js +8 -0
- package/lib/models/PublicKey.js +29 -21
- package/lib/models/RemoteBandwidthSnapshot.js +10 -2
- package/lib/models/RemoteServer.js +226 -196
- package/lib/models/Request.js +27 -19
- package/lib/models/Session.js +13 -5
- package/lib/models/SettingsChange.js +10 -2
- package/lib/models/Site.js +65 -57
- package/lib/models/SsoStrategy.js +17 -9
- package/lib/models/Status.js +8 -0
- package/lib/models/Style.js +20 -12
- package/lib/models/UsageDailySnapshot.js +10 -2
- package/lib/models/UsageSnapshot.js +10 -2
- package/lib/models/User.js +85 -77
- package/lib/models/UserCipherUse.js +11 -3
- package/lib/models/UserRequest.js +24 -16
- package/lib/models/WebhookTest.js +16 -8
- package/package.json +1 -1
- package/src/Api.js +4 -8
- package/src/Errors.js +222 -0
- package/src/models/AccountLineItem.js +1 -0
- package/src/models/Action.js +1 -0
- package/src/models/ActionNotificationExport.js +14 -13
- package/src/models/ActionNotificationExportResult.js +6 -5
- package/src/models/ActionWebhookFailure.js +5 -4
- package/src/models/ApiKey.js +26 -25
- package/src/models/App.js +3 -2
- package/src/models/As2IncomingMessage.js +4 -3
- package/src/models/As2OutgoingMessage.js +4 -3
- package/src/models/As2Partner.js +27 -26
- package/src/models/As2Station.js +25 -24
- package/src/models/Auto.js +1 -0
- package/src/models/Automation.js +51 -62
- package/src/models/AutomationRun.js +9 -8
- package/src/models/BandwidthSnapshot.js +3 -2
- package/src/models/Behavior.js +39 -38
- package/src/models/Bundle.js +44 -43
- package/src/models/BundleDownload.js +5 -4
- package/src/models/BundleRecipient.js +15 -14
- package/src/models/BundleRegistration.js +5 -4
- package/src/models/Clickwrap.js +24 -23
- package/src/models/DnsRecord.js +3 -2
- package/src/models/Errors.js +1 -0
- package/src/models/ExternalEvent.js +11 -10
- package/src/models/File.js +61 -60
- package/src/models/FileAction.js +1 -0
- package/src/models/FileComment.js +20 -19
- package/src/models/FileCommentReaction.js +11 -10
- package/src/models/FileMigration.js +4 -3
- package/src/models/FileUploadPart.js +1 -0
- package/src/models/Folder.js +12 -11
- package/src/models/FormField.js +1 -0
- package/src/models/FormFieldSet.js +20 -19
- package/src/models/Group.js +23 -22
- package/src/models/GroupUser.js +25 -24
- package/src/models/History.js +35 -34
- package/src/models/HistoryExport.js +27 -26
- package/src/models/HistoryExportResult.js +6 -5
- package/src/models/Image.js +1 -0
- package/src/models/InboxRecipient.js +15 -14
- package/src/models/InboxRegistration.js +4 -3
- package/src/models/InboxUpload.js +5 -4
- package/src/models/Invoice.js +6 -5
- package/src/models/InvoiceLineItem.js +1 -0
- package/src/models/IpAddress.js +5 -4
- package/src/models/Lock.js +17 -16
- package/src/models/Message.js +30 -29
- package/src/models/MessageComment.js +22 -21
- package/src/models/MessageCommentReaction.js +17 -16
- package/src/models/MessageReaction.js +17 -16
- package/src/models/Notification.js +31 -30
- package/src/models/Payment.js +6 -5
- package/src/models/PaymentLineItem.js +1 -0
- package/src/models/Permission.js +16 -15
- package/src/models/Preview.js +3 -2
- package/src/models/Priority.js +6 -5
- package/src/models/Project.js +18 -17
- package/src/models/PublicIpAddress.js +1 -0
- package/src/models/PublicKey.js +22 -21
- package/src/models/RemoteBandwidthSnapshot.js +3 -2
- package/src/models/RemoteServer.js +120 -103
- package/src/models/Request.js +20 -19
- package/src/models/Session.js +6 -5
- package/src/models/SettingsChange.js +3 -2
- package/src/models/Site.js +58 -57
- package/src/models/SsoStrategy.js +10 -9
- package/src/models/Status.js +1 -0
- package/src/models/Style.js +13 -12
- package/src/models/UsageDailySnapshot.js +3 -2
- package/src/models/UsageSnapshot.js +3 -2
- package/src/models/User.js +78 -77
- package/src/models/UserCipherUse.js +4 -3
- package/src/models/UserRequest.js +17 -16
- package/src/models/WebhookTest.js +9 -8
- package/test/src/index.js +46 -0
@@ -0,0 +1,330 @@
|
|
1
|
+
# Bundle
|
2
|
+
|
3
|
+
## Example Bundle Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"code": "abc123",
|
8
|
+
"url": "https://subdomain.files.com/f/12345678",
|
9
|
+
"description": "The public description of the bundle.",
|
10
|
+
"password_protected": true,
|
11
|
+
"preview_only": true,
|
12
|
+
"require_registration": true,
|
13
|
+
"require_share_recipient": true,
|
14
|
+
"clickwrap_body": "[Legal text]",
|
15
|
+
"form_field_set": {
|
16
|
+
"id": 1,
|
17
|
+
"title": "Sample Form Title",
|
18
|
+
"form_layout": [
|
19
|
+
1,
|
20
|
+
2,
|
21
|
+
3,
|
22
|
+
4
|
23
|
+
],
|
24
|
+
"form_fields": {
|
25
|
+
"id": 1,
|
26
|
+
"label": "Sample Label",
|
27
|
+
"required": true,
|
28
|
+
"help_text": "Help Text",
|
29
|
+
"field_type": "text",
|
30
|
+
"options_for_select": [
|
31
|
+
"red",
|
32
|
+
"green",
|
33
|
+
"blue"
|
34
|
+
],
|
35
|
+
"default_option": "red",
|
36
|
+
"form_field_set_id": 1
|
37
|
+
},
|
38
|
+
"skip_name": true,
|
39
|
+
"skip_email": true,
|
40
|
+
"skip_company": true
|
41
|
+
},
|
42
|
+
"skip_name": true,
|
43
|
+
"skip_email": true,
|
44
|
+
"skip_company": true,
|
45
|
+
"id": 1,
|
46
|
+
"created_at": "2000-01-01T01:00:00Z",
|
47
|
+
"expires_at": "2000-01-01T01:00:00Z",
|
48
|
+
"max_uses": 1,
|
49
|
+
"note": "The internal note on the bundle.",
|
50
|
+
"user_id": 1,
|
51
|
+
"username": "user",
|
52
|
+
"clickwrap_id": 1,
|
53
|
+
"inbox_id": 1,
|
54
|
+
"watermark_attachment": {
|
55
|
+
"name": "My logo",
|
56
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
57
|
+
},
|
58
|
+
"watermark_value": "",
|
59
|
+
"has_inbox": true,
|
60
|
+
"paths": [
|
61
|
+
"file.txt"
|
62
|
+
]
|
63
|
+
}
|
64
|
+
```
|
65
|
+
|
66
|
+
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
67
|
+
* `url` (string): Public URL of Share Link
|
68
|
+
* `description` (string): Public description
|
69
|
+
* `password_protected` (boolean): Is this bundle password protected?
|
70
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
71
|
+
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
72
|
+
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
73
|
+
* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
|
74
|
+
* `form_field_set` (FormFieldSet): Custom Form to use
|
75
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
76
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
77
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
78
|
+
* `id` (int64): Bundle ID
|
79
|
+
* `created_at` (date-time): Bundle created at date/time
|
80
|
+
* `expires_at` (date-time): Bundle expiration date/time
|
81
|
+
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
82
|
+
* `note` (string): Bundle internal note
|
83
|
+
* `user_id` (int64): Bundle creator user ID
|
84
|
+
* `username` (string): Bundle creator username
|
85
|
+
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
86
|
+
* `inbox_id` (int64): ID of the associated inbox, if available.
|
87
|
+
* `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
88
|
+
* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
89
|
+
* `has_inbox` (boolean): Does this bundle have an associated inbox?
|
90
|
+
* `paths` (array): A list of paths in this bundle
|
91
|
+
* `password` (string): Password for this bundle.
|
92
|
+
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
93
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
94
|
+
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
95
|
+
|
96
|
+
---
|
97
|
+
|
98
|
+
## List Bundles
|
99
|
+
|
100
|
+
```
|
101
|
+
await Bundle.list({
|
102
|
+
'user_id': 1,
|
103
|
+
'per_page': 1,
|
104
|
+
})
|
105
|
+
```
|
106
|
+
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
111
|
+
* `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.
|
112
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
113
|
+
* `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`.
|
114
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
115
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
116
|
+
* `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`.
|
117
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
118
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
119
|
+
* `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`.
|
120
|
+
|
121
|
+
---
|
122
|
+
|
123
|
+
## Show Bundle
|
124
|
+
|
125
|
+
```
|
126
|
+
await Bundle.find(id)
|
127
|
+
```
|
128
|
+
|
129
|
+
|
130
|
+
### Parameters
|
131
|
+
|
132
|
+
* `id` (int64): Required - Bundle ID.
|
133
|
+
|
134
|
+
---
|
135
|
+
|
136
|
+
## Create Bundle
|
137
|
+
|
138
|
+
```
|
139
|
+
await Bundle.create({
|
140
|
+
'user_id': 1,
|
141
|
+
'paths': ["file.txt"],
|
142
|
+
'password': "Password",
|
143
|
+
'form_field_set_id': 1,
|
144
|
+
'expires_at': "2000-01-01T01:00:00Z",
|
145
|
+
'max_uses': 1,
|
146
|
+
'description': "The public description of the bundle.",
|
147
|
+
'note': "The internal note on the bundle.",
|
148
|
+
'code': "abc123",
|
149
|
+
'preview_only': true,
|
150
|
+
'require_registration': true,
|
151
|
+
'clickwrap_id': 1,
|
152
|
+
'inbox_id': 1,
|
153
|
+
'require_share_recipient': true,
|
154
|
+
'skip_email': true,
|
155
|
+
'skip_name': true,
|
156
|
+
'skip_company': true,
|
157
|
+
})
|
158
|
+
```
|
159
|
+
|
160
|
+
|
161
|
+
### Parameters
|
162
|
+
|
163
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
164
|
+
* `paths` (array(string)): Required - A list of paths to include in this bundle.
|
165
|
+
* `password` (string): Password for this bundle.
|
166
|
+
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
167
|
+
* `expires_at` (string): Bundle expiration date/time
|
168
|
+
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
169
|
+
* `description` (string): Public description
|
170
|
+
* `note` (string): Bundle internal note
|
171
|
+
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
172
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
173
|
+
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
174
|
+
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
175
|
+
* `inbox_id` (int64): ID of the associated inbox, if available.
|
176
|
+
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
177
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
178
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
179
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
180
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
181
|
+
|
182
|
+
---
|
183
|
+
|
184
|
+
## Send email(s) with a link to bundle
|
185
|
+
|
186
|
+
```
|
187
|
+
const [bundle] = await Bundle.list()
|
188
|
+
|
189
|
+
await bundle.share({
|
190
|
+
'to': ["johndoe@gmail.com"],
|
191
|
+
'note': "Just a note.",
|
192
|
+
'recipients': [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}],
|
193
|
+
})
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
* `id` (int64): Required - Bundle ID.
|
199
|
+
* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
|
200
|
+
* `note` (string): Note to include in email.
|
201
|
+
* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
|
202
|
+
|
203
|
+
|
204
|
+
---
|
205
|
+
|
206
|
+
## Update Bundle
|
207
|
+
|
208
|
+
```
|
209
|
+
const [bundle] = await Bundle.list()
|
210
|
+
|
211
|
+
await bundle.update({
|
212
|
+
'paths': ["file.txt"],
|
213
|
+
'password': "Password",
|
214
|
+
'form_field_set_id': 1,
|
215
|
+
'clickwrap_id': 1,
|
216
|
+
'code': "abc123",
|
217
|
+
'description': "The public description of the bundle.",
|
218
|
+
'expires_at': "2000-01-01T01:00:00Z",
|
219
|
+
'inbox_id': 1,
|
220
|
+
'max_uses': 1,
|
221
|
+
'note': "The internal note on the bundle.",
|
222
|
+
'preview_only': true,
|
223
|
+
'require_registration': true,
|
224
|
+
'require_share_recipient': true,
|
225
|
+
'skip_email': true,
|
226
|
+
'skip_name': true,
|
227
|
+
'skip_company': true,
|
228
|
+
'watermark_attachment_delete': true,
|
229
|
+
})
|
230
|
+
```
|
231
|
+
|
232
|
+
### Parameters
|
233
|
+
|
234
|
+
* `id` (int64): Required - Bundle ID.
|
235
|
+
* `paths` (array(string)): A list of paths to include in this bundle.
|
236
|
+
* `password` (string): Password for this bundle.
|
237
|
+
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
238
|
+
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
239
|
+
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
240
|
+
* `description` (string): Public description
|
241
|
+
* `expires_at` (string): Bundle expiration date/time
|
242
|
+
* `inbox_id` (int64): ID of the associated inbox, if available.
|
243
|
+
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
244
|
+
* `note` (string): Bundle internal note
|
245
|
+
* `preview_only` (boolean): Restrict users to previewing files only?
|
246
|
+
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
247
|
+
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
248
|
+
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
249
|
+
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
250
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
251
|
+
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
252
|
+
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
253
|
+
|
254
|
+
### Example Response
|
255
|
+
|
256
|
+
```json
|
257
|
+
{
|
258
|
+
"code": "abc123",
|
259
|
+
"url": "https://subdomain.files.com/f/12345678",
|
260
|
+
"description": "The public description of the bundle.",
|
261
|
+
"password_protected": true,
|
262
|
+
"preview_only": true,
|
263
|
+
"require_registration": true,
|
264
|
+
"require_share_recipient": true,
|
265
|
+
"clickwrap_body": "[Legal text]",
|
266
|
+
"form_field_set": {
|
267
|
+
"id": 1,
|
268
|
+
"title": "Sample Form Title",
|
269
|
+
"form_layout": [
|
270
|
+
1,
|
271
|
+
2,
|
272
|
+
3,
|
273
|
+
4
|
274
|
+
],
|
275
|
+
"form_fields": {
|
276
|
+
"id": 1,
|
277
|
+
"label": "Sample Label",
|
278
|
+
"required": true,
|
279
|
+
"help_text": "Help Text",
|
280
|
+
"field_type": "text",
|
281
|
+
"options_for_select": [
|
282
|
+
"red",
|
283
|
+
"green",
|
284
|
+
"blue"
|
285
|
+
],
|
286
|
+
"default_option": "red",
|
287
|
+
"form_field_set_id": 1
|
288
|
+
},
|
289
|
+
"skip_name": true,
|
290
|
+
"skip_email": true,
|
291
|
+
"skip_company": true
|
292
|
+
},
|
293
|
+
"skip_name": true,
|
294
|
+
"skip_email": true,
|
295
|
+
"skip_company": true,
|
296
|
+
"id": 1,
|
297
|
+
"created_at": "2000-01-01T01:00:00Z",
|
298
|
+
"expires_at": "2000-01-01T01:00:00Z",
|
299
|
+
"max_uses": 1,
|
300
|
+
"note": "The internal note on the bundle.",
|
301
|
+
"user_id": 1,
|
302
|
+
"username": "user",
|
303
|
+
"clickwrap_id": 1,
|
304
|
+
"inbox_id": 1,
|
305
|
+
"watermark_attachment": {
|
306
|
+
"name": "My logo",
|
307
|
+
"uri": "https://mysite.files.com/.../my_image.png"
|
308
|
+
},
|
309
|
+
"watermark_value": "",
|
310
|
+
"has_inbox": true,
|
311
|
+
"paths": [
|
312
|
+
"file.txt"
|
313
|
+
]
|
314
|
+
}
|
315
|
+
```
|
316
|
+
|
317
|
+
---
|
318
|
+
|
319
|
+
## Delete Bundle
|
320
|
+
|
321
|
+
```
|
322
|
+
const [bundle] = await Bundle.list()
|
323
|
+
|
324
|
+
await bundle.delete()
|
325
|
+
```
|
326
|
+
|
327
|
+
### Parameters
|
328
|
+
|
329
|
+
* `id` (int64): Required - Bundle ID.
|
330
|
+
|
@@ -0,0 +1,44 @@
|
|
1
|
+
# BundleDownload
|
2
|
+
|
3
|
+
## Example BundleDownload Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"bundle_registration": "",
|
8
|
+
"download_method": "file",
|
9
|
+
"path": "a/b/test.txt",
|
10
|
+
"created_at": "2020-01-01 00:00:00"
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `bundle_registration` (BundleRegistration):
|
15
|
+
* `download_method` (string): Download method (file or full_zip)
|
16
|
+
* `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
17
|
+
* `created_at` (date-time): Download date/time
|
18
|
+
|
19
|
+
---
|
20
|
+
|
21
|
+
## List Bundle Downloads
|
22
|
+
|
23
|
+
```
|
24
|
+
await BundleDownload.list({
|
25
|
+
'per_page': 1,
|
26
|
+
'bundle_id': 1,
|
27
|
+
'bundle_registration_id': 1,
|
28
|
+
})
|
29
|
+
```
|
30
|
+
|
31
|
+
|
32
|
+
### Parameters
|
33
|
+
|
34
|
+
* `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.
|
35
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
36
|
+
* `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`.
|
37
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
38
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
39
|
+
* `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`.
|
40
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
41
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
42
|
+
* `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`.
|
43
|
+
* `bundle_id` (int64): Bundle ID
|
44
|
+
* `bundle_registration_id` (int64): BundleRegistration ID
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# BundleRecipient
|
2
|
+
|
3
|
+
## Example BundleRecipient Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"company": "Acme Inc.",
|
8
|
+
"name": "John Doe",
|
9
|
+
"note": "Some note.",
|
10
|
+
"recipient": "john.doe@example.com",
|
11
|
+
"sent_at": "2000-01-01T01:00:00Z"
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
* `company` (string): The recipient's company.
|
16
|
+
* `name` (string): The recipient's name.
|
17
|
+
* `note` (string): A note sent to the recipient with the bundle.
|
18
|
+
* `recipient` (string): The recipient's email address.
|
19
|
+
* `sent_at` (date-time): When the Bundle was shared with this recipient.
|
20
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
21
|
+
* `bundle_id` (int64): Bundle to share.
|
22
|
+
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
23
|
+
|
24
|
+
---
|
25
|
+
|
26
|
+
## List Bundle Recipients
|
27
|
+
|
28
|
+
```
|
29
|
+
await BundleRecipient.list({
|
30
|
+
'user_id': 1,
|
31
|
+
'per_page': 1,
|
32
|
+
'bundle_id': 1,
|
33
|
+
})
|
34
|
+
```
|
35
|
+
|
36
|
+
|
37
|
+
### Parameters
|
38
|
+
|
39
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
40
|
+
* `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.
|
41
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
|
+
* `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`.
|
43
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
44
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
|
45
|
+
* `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`.
|
46
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
47
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
|
48
|
+
* `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`.
|
49
|
+
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
50
|
+
|
51
|
+
---
|
52
|
+
|
53
|
+
## Create Bundle Recipient
|
54
|
+
|
55
|
+
```
|
56
|
+
await BundleRecipient.create({
|
57
|
+
'user_id': 1,
|
58
|
+
'bundle_id': 1,
|
59
|
+
'recipient': "johndoe@gmail.com",
|
60
|
+
'name': "John Smith",
|
61
|
+
'company': "Acme Ltd",
|
62
|
+
'note': "Just a note.",
|
63
|
+
'share_after_create': true,
|
64
|
+
})
|
65
|
+
```
|
66
|
+
|
67
|
+
|
68
|
+
### Parameters
|
69
|
+
|
70
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
71
|
+
* `bundle_id` (int64): Required - Bundle to share.
|
72
|
+
* `recipient` (string): Required - Email addresses to share this bundle with.
|
73
|
+
* `name` (string): Name of recipient.
|
74
|
+
* `company` (string): Company of recipient.
|
75
|
+
* `note` (string): Note to include in email.
|
76
|
+
* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# BundleRegistration
|
2
|
+
|
3
|
+
## Example BundleRegistration Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"code": "abc123",
|
8
|
+
"name": "account",
|
9
|
+
"company": "Action Verb",
|
10
|
+
"email": "john.doe@files.com",
|
11
|
+
"ip": "10.1.1.1",
|
12
|
+
"inbox_code": "abc123",
|
13
|
+
"clickwrap_body": "",
|
14
|
+
"form_field_set_id": 1,
|
15
|
+
"form_field_data": "",
|
16
|
+
"bundle_code": "",
|
17
|
+
"bundle_id": 1,
|
18
|
+
"bundle_recipient_id": 1
|
19
|
+
}
|
20
|
+
```
|
21
|
+
|
22
|
+
* `code` (string): Registration cookie code
|
23
|
+
* `name` (string): Registrant name
|
24
|
+
* `company` (string): Registrant company name
|
25
|
+
* `email` (string): Registrant email address
|
26
|
+
* `ip` (string): Registrant IP Address
|
27
|
+
* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
|
28
|
+
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
|
29
|
+
* `form_field_set_id` (int64): Id of associated form field set
|
30
|
+
* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
|
31
|
+
* `bundle_code` (string): Bundle URL code
|
32
|
+
* `bundle_id` (int64): Id of associated bundle
|
33
|
+
* `bundle_recipient_id` (int64): Id of associated bundle recipient
|
34
|
+
|
35
|
+
---
|
36
|
+
|
37
|
+
## List Bundle Registrations
|
38
|
+
|
39
|
+
```
|
40
|
+
await BundleRegistration.list({
|
41
|
+
'user_id': 1,
|
42
|
+
'per_page': 1,
|
43
|
+
'bundle_id': 1,
|
44
|
+
})
|
45
|
+
```
|
46
|
+
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
51
|
+
* `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.
|
52
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
53
|
+
* `bundle_id` (int64): ID of the associated Bundle
|
@@ -0,0 +1,120 @@
|
|
1
|
+
# Clickwrap
|
2
|
+
|
3
|
+
## Example Clickwrap Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": 1,
|
8
|
+
"name": "Example Site NDA for Files.com Use",
|
9
|
+
"body": "[Legal body text]",
|
10
|
+
"use_with_users": "",
|
11
|
+
"use_with_bundles": "",
|
12
|
+
"use_with_inboxes": ""
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
* `id` (int64): Clickwrap ID
|
17
|
+
* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
18
|
+
* `body` (string): Body text of Clickwrap (supports Markdown formatting).
|
19
|
+
* `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.
|
20
|
+
* `use_with_bundles` (string): Use this Clickwrap for Bundles?
|
21
|
+
* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
|
22
|
+
|
23
|
+
---
|
24
|
+
|
25
|
+
## List Clickwraps
|
26
|
+
|
27
|
+
```
|
28
|
+
await Clickwrap.list({
|
29
|
+
'per_page': 1,
|
30
|
+
})
|
31
|
+
```
|
32
|
+
|
33
|
+
|
34
|
+
### Parameters
|
35
|
+
|
36
|
+
* `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.
|
37
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
|
+
|
39
|
+
---
|
40
|
+
|
41
|
+
## Show Clickwrap
|
42
|
+
|
43
|
+
```
|
44
|
+
await Clickwrap.find(id)
|
45
|
+
```
|
46
|
+
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
* `id` (int64): Required - Clickwrap ID.
|
51
|
+
|
52
|
+
---
|
53
|
+
|
54
|
+
## Create Clickwrap
|
55
|
+
|
56
|
+
```
|
57
|
+
await Clickwrap.create({
|
58
|
+
'name': "Example Site NDA for Files.com Use",
|
59
|
+
'body': "[Legal body text]",
|
60
|
+
})
|
61
|
+
```
|
62
|
+
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
67
|
+
* `body` (string): Body text of Clickwrap (supports Markdown formatting).
|
68
|
+
* `use_with_bundles` (string): Use this Clickwrap for Bundles?
|
69
|
+
* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
|
70
|
+
* `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.
|
71
|
+
|
72
|
+
---
|
73
|
+
|
74
|
+
## Update Clickwrap
|
75
|
+
|
76
|
+
```
|
77
|
+
const [clickwrap] = await Clickwrap.list()
|
78
|
+
|
79
|
+
await clickwrap.update({
|
80
|
+
'name': "Example Site NDA for Files.com Use",
|
81
|
+
'body': "[Legal body text]",
|
82
|
+
})
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
* `id` (int64): Required - Clickwrap ID.
|
88
|
+
* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
|
89
|
+
* `body` (string): Body text of Clickwrap (supports Markdown formatting).
|
90
|
+
* `use_with_bundles` (string): Use this Clickwrap for Bundles?
|
91
|
+
* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
|
92
|
+
* `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.
|
93
|
+
|
94
|
+
### Example Response
|
95
|
+
|
96
|
+
```json
|
97
|
+
{
|
98
|
+
"id": 1,
|
99
|
+
"name": "Example Site NDA for Files.com Use",
|
100
|
+
"body": "[Legal body text]",
|
101
|
+
"use_with_users": "",
|
102
|
+
"use_with_bundles": "",
|
103
|
+
"use_with_inboxes": ""
|
104
|
+
}
|
105
|
+
```
|
106
|
+
|
107
|
+
---
|
108
|
+
|
109
|
+
## Delete Clickwrap
|
110
|
+
|
111
|
+
```
|
112
|
+
const [clickwrap] = await Clickwrap.list()
|
113
|
+
|
114
|
+
await clickwrap.delete()
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
* `id` (int64): Required - Clickwrap ID.
|
120
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# DnsRecord
|
2
|
+
|
3
|
+
## Example DnsRecord Object
|
4
|
+
|
5
|
+
```
|
6
|
+
{
|
7
|
+
"id": "customdomain.com-CNAME-site.files.com",
|
8
|
+
"domain": "my-custom-domain.com",
|
9
|
+
"rrtype": "CNAME",
|
10
|
+
"value": "mysite.files.com"
|
11
|
+
}
|
12
|
+
```
|
13
|
+
|
14
|
+
* `id` (string): Unique label for DNS record; used by Zapier and other integrations.
|
15
|
+
* `domain` (string): DNS record domain name
|
16
|
+
* `rrtype` (string): DNS record type
|
17
|
+
* `value` (string): DNS record value
|
18
|
+
|
19
|
+
---
|
20
|
+
|
21
|
+
## Show site DNS configuration
|
22
|
+
|
23
|
+
```
|
24
|
+
await DnsRecord.list({
|
25
|
+
'per_page': 1,
|
26
|
+
})
|
27
|
+
```
|
28
|
+
|
29
|
+
|
30
|
+
### Parameters
|
31
|
+
|
32
|
+
* `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.
|
33
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|