files.com 1.2.77 → 1.2.79
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/AccountLineItem.md +2 -2
- package/docs/models/Action.md +1 -1
- package/docs/models/ApiKey.md +2 -2
- package/docs/models/App.md +1 -1
- package/docs/models/As2Partner.md +2 -2
- package/docs/models/As2Station.md +2 -2
- package/docs/models/Automation.md +10 -10
- package/docs/models/Behavior.md +2 -2
- package/docs/models/Bundle.md +5 -5
- package/docs/models/BundleNotification.md +2 -2
- package/docs/models/Clickwrap.md +2 -2
- package/docs/models/Errors.md +2 -2
- package/docs/models/File.md +6 -12
- package/docs/models/FileComment.md +1 -1
- package/docs/models/FormField.md +1 -1
- package/docs/models/FormFieldSet.md +4 -4
- package/docs/models/GpgKey.md +2 -2
- package/docs/models/Group.md +2 -2
- package/docs/models/GroupUser.md +1 -1
- package/docs/models/History.md +1 -1
- package/docs/models/Invoice.md +2 -2
- package/docs/models/IpAddress.md +1 -1
- package/docs/models/Message.md +3 -3
- package/docs/models/MessageComment.md +3 -3
- package/docs/models/MessageCommentReaction.md +1 -1
- package/docs/models/MessageReaction.md +1 -1
- package/docs/models/Notification.md +5 -5
- package/docs/models/Payment.md +2 -2
- package/docs/models/Project.md +2 -2
- package/docs/models/PublicKey.md +2 -2
- package/docs/models/RemoteServer.md +3 -3
- package/docs/models/SettingsChange.md +1 -1
- package/docs/models/SftpHostKey.md +2 -2
- package/docs/models/ShareGroup.md +3 -3
- package/docs/models/Site.md +2 -2
- package/docs/models/Snapshot.md +3 -3
- package/docs/models/SsoStrategy.md +1 -1
- package/docs/models/Status.md +1 -1
- package/docs/models/Style.md +2 -4
- package/docs/models/User.md +6 -6
- package/docs/models/UserRequest.md +1 -1
- package/lib/Files.js +1 -1
- package/lib/models/AccountLineItem.js +2 -2
- package/lib/models/Action.js +1 -1
- package/lib/models/App.js +1 -1
- package/lib/models/Automation.js +7 -7
- package/lib/models/Bundle.js +2 -2
- package/lib/models/Errors.js +2 -2
- package/lib/models/FileComment.js +1 -1
- package/lib/models/FormField.js +1 -1
- package/lib/models/FormFieldSet.js +2 -2
- package/lib/models/GroupUser.js +1 -1
- package/lib/models/History.js +1 -1
- package/lib/models/Invoice.js +2 -2
- package/lib/models/IpAddress.js +1 -1
- package/lib/models/Message.js +1 -1
- package/lib/models/MessageComment.js +1 -1
- package/lib/models/Notification.js +3 -3
- package/lib/models/Payment.js +2 -2
- package/lib/models/SettingsChange.js +1 -1
- package/lib/models/ShareGroup.js +1 -1
- package/lib/models/Site.js +2 -2
- package/lib/models/Status.js +1 -1
- package/lib/models/User.js +1 -1
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/AccountLineItem.js +2 -2
- package/src/models/Action.js +1 -1
- package/src/models/App.js +1 -1
- package/src/models/Automation.js +7 -7
- package/src/models/Bundle.js +2 -2
- package/src/models/Errors.js +2 -2
- package/src/models/FileComment.js +1 -1
- package/src/models/FormField.js +1 -1
- package/src/models/FormFieldSet.js +2 -2
- package/src/models/GroupUser.js +1 -1
- package/src/models/History.js +1 -1
- package/src/models/Invoice.js +2 -2
- package/src/models/IpAddress.js +1 -1
- package/src/models/Message.js +1 -1
- package/src/models/MessageComment.js +1 -1
- package/src/models/Notification.js +3 -3
- package/src/models/Payment.js +2 -2
- package/src/models/SettingsChange.js +1 -1
- package/src/models/ShareGroup.js +1 -1
- package/src/models/Site.js +2 -2
- package/src/models/Status.js +1 -1
- package/src/models/User.js +1 -1
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.2.
|
1
|
+
1.2.79
|
@@ -44,9 +44,9 @@
|
|
44
44
|
* `created_at` (date-time): Line item created at
|
45
45
|
* `currency` (string): Line item currency
|
46
46
|
* `download_uri` (string): Line item download uri
|
47
|
-
* `invoice_line_items` (array): Associated invoice line items
|
47
|
+
* `invoice_line_items` (array(object)): Associated invoice line items
|
48
48
|
* `method` (string): Line item payment method
|
49
|
-
* `payment_line_items` (array): Associated payment line items
|
49
|
+
* `payment_line_items` (array(object)): Associated payment line items
|
50
50
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
51
51
|
* `payment_type` (string): Type of payment if applicable
|
52
52
|
* `site_name` (string): Site name this line item is for
|
package/docs/models/Action.md
CHANGED
@@ -29,7 +29,7 @@
|
|
29
29
|
* `display` (string): Friendly displayed output
|
30
30
|
* `ip` (string): IP Address that performed this action
|
31
31
|
* `source` (string): The source path for this action, if applicable
|
32
|
-
* `targets` (array): Targets
|
32
|
+
* `targets` (array(object)): Targets
|
33
33
|
* `user_id` (int64): User ID
|
34
34
|
* `username` (string): Username
|
35
35
|
* `action` (string): Type of action
|
package/docs/models/ApiKey.md
CHANGED
@@ -134,7 +134,7 @@ await ApiKey.deleteCurrent
|
|
134
134
|
## Update Api Key
|
135
135
|
|
136
136
|
```
|
137
|
-
const
|
137
|
+
const api_key = await ApiKey.find(id)
|
138
138
|
|
139
139
|
await api_key.update({
|
140
140
|
'description': "example",
|
@@ -176,7 +176,7 @@ await api_key.update({
|
|
176
176
|
## Delete Api Key
|
177
177
|
|
178
178
|
```
|
179
|
-
const
|
179
|
+
const api_key = await ApiKey.find(id)
|
180
180
|
|
181
181
|
await api_key.delete()
|
182
182
|
```
|
package/docs/models/App.md
CHANGED
@@ -46,7 +46,7 @@
|
|
46
46
|
* `name` (string): Name of the App
|
47
47
|
* `package_manager_install_command` (string): Package manager install command
|
48
48
|
* `remote_server_type` (string): Associated Remote Server type, if any
|
49
|
-
* `screenshot_list_urls` (array): Screenshots of the App
|
49
|
+
* `screenshot_list_urls` (array(string)): Screenshots of the App
|
50
50
|
* `sdk_installation_instructions_link` (string): Link to SDK installation instructions
|
51
51
|
* `short_description` (string): Short description of the App
|
52
52
|
* `sso_strategy_type` (string): Associated SSO Strategy type, if any
|
@@ -98,7 +98,7 @@ await As2Partner.create({
|
|
98
98
|
## Update As2 Partner
|
99
99
|
|
100
100
|
```
|
101
|
-
const
|
101
|
+
const as2_partner = await As2Partner.find(id)
|
102
102
|
|
103
103
|
await as2_partner.update({
|
104
104
|
'name': "AS2 Partner Name",
|
@@ -145,7 +145,7 @@ await as2_partner.update({
|
|
145
145
|
## Delete As2 Partner
|
146
146
|
|
147
147
|
```
|
148
|
-
const
|
148
|
+
const as2_partner = await As2Partner.find(id)
|
149
149
|
|
150
150
|
await as2_partner.delete()
|
151
151
|
```
|
@@ -91,7 +91,7 @@ await As2Station.create({
|
|
91
91
|
## Update As2 Station
|
92
92
|
|
93
93
|
```
|
94
|
-
const
|
94
|
+
const as2_station = await As2Station.find(id)
|
95
95
|
|
96
96
|
await as2_station.update({
|
97
97
|
'name': "AS2 Station Name",
|
@@ -131,7 +131,7 @@ await as2_station.update({
|
|
131
131
|
## Delete As2 Station
|
132
132
|
|
133
133
|
```
|
134
|
-
const
|
134
|
+
const as2_station = await As2Station.find(id)
|
135
135
|
|
136
136
|
await as2_station.delete()
|
137
137
|
```
|
@@ -68,10 +68,10 @@
|
|
68
68
|
* `description` (string): Description for the this Automation.
|
69
69
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
70
70
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
71
|
-
* `destinations` (array): Destination Paths
|
71
|
+
* `destinations` (array(string)): Destination Paths
|
72
72
|
* `disabled` (boolean): If true, this automation will not run.
|
73
73
|
* `flatten_destination_structure` (boolean): Normally copy and move automations that use globs will implicitly preserve the source folder structure in the destination. If this flag is `true`, the source folder structure will be flattened in the destination. This is useful for copying or moving files from multiple folders into a single destination folder.
|
74
|
-
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
74
|
+
* `group_ids` (array(int64)): IDs of Groups for the Automation (i.e. who to Request File from)
|
75
75
|
* `ignore_locked_folders` (boolean): If true, the Lock Folders behavior will be disregarded for automated actions.
|
76
76
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
77
77
|
* `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
|
@@ -82,15 +82,15 @@
|
|
82
82
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
83
83
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run in json format.
|
84
84
|
* `human_readable_schedule` (string): If trigger is `custom_schedule`, Human readable Custom schedule description for when the automation should be run.
|
85
|
-
* `schedule_days_of_week` (array): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
86
|
-
* `schedule_times_of_day` (array): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
|
85
|
+
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
86
|
+
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run. Times of day in HH:MM format.
|
87
87
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the automation should be run.
|
88
88
|
* `source` (string): Source Path
|
89
|
-
* `sync_ids` (array): IDs of remote sync folder behaviors to run by this Automation
|
90
|
-
* `trigger_actions` (array): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
89
|
+
* `sync_ids` (array(int64)): IDs of remote sync folder behaviors to run by this Automation
|
90
|
+
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, copy
|
91
91
|
* `trigger` (string): How this automation is triggered to run.
|
92
92
|
* `user_id` (int64): User ID of the Automation's creator.
|
93
|
-
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
93
|
+
* `user_ids` (array(int64)): IDs of Users for the Automation (i.e. who to Request File from)
|
94
94
|
* `value` (object): A Hash of attributes specific to the automation type.
|
95
95
|
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
96
96
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
@@ -201,7 +201,7 @@ await Automation.create({
|
|
201
201
|
## Manually run automation
|
202
202
|
|
203
203
|
```
|
204
|
-
const
|
204
|
+
const automation = await Automation.find(id)
|
205
205
|
|
206
206
|
await automation.manual_run()
|
207
207
|
```
|
@@ -216,7 +216,7 @@ await automation.manual_run()
|
|
216
216
|
## Update Automation
|
217
217
|
|
218
218
|
```
|
219
|
-
const
|
219
|
+
const automation = await Automation.find(id)
|
220
220
|
|
221
221
|
await automation.update({
|
222
222
|
'source': "source",
|
@@ -343,7 +343,7 @@ await automation.update({
|
|
343
343
|
## Delete Automation
|
344
344
|
|
345
345
|
```
|
346
|
-
const
|
346
|
+
const automation = await Automation.find(id)
|
347
347
|
|
348
348
|
await automation.delete()
|
349
349
|
```
|
package/docs/models/Behavior.md
CHANGED
@@ -143,7 +143,7 @@ await Behavior.webhookTest({
|
|
143
143
|
## Update Behavior
|
144
144
|
|
145
145
|
```
|
146
|
-
const
|
146
|
+
const behavior = await Behavior.find(id)
|
147
147
|
|
148
148
|
await behavior.update({
|
149
149
|
'value': "{\"method\": \"GET\"}",
|
@@ -193,7 +193,7 @@ await behavior.update({
|
|
193
193
|
## Delete Behavior
|
194
194
|
|
195
195
|
```
|
196
|
-
const
|
196
|
+
const behavior = await Behavior.find(id)
|
197
197
|
|
198
198
|
await behavior.delete()
|
199
199
|
```
|
package/docs/models/Bundle.md
CHANGED
@@ -123,8 +123,8 @@
|
|
123
123
|
* `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
124
124
|
* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
125
125
|
* `has_inbox` (boolean): Does this bundle have an associated inbox?
|
126
|
-
* `paths` (array): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
|
127
|
-
* `bundlepaths` (array): A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
|
126
|
+
* `paths` (array(string)): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
|
127
|
+
* `bundlepaths` (array(object)): A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.
|
128
128
|
* `password` (string): Password for this bundle.
|
129
129
|
* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
|
130
130
|
* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
|
@@ -240,7 +240,7 @@ await Bundle.create({
|
|
240
240
|
## Send email(s) with a link to bundle
|
241
241
|
|
242
242
|
```
|
243
|
-
const
|
243
|
+
const bundle = await Bundle.find(id)
|
244
244
|
|
245
245
|
await bundle.share({
|
246
246
|
'to': ["johndoe@gmail.com"],
|
@@ -262,7 +262,7 @@ await bundle.share({
|
|
262
262
|
## Update Bundle
|
263
263
|
|
264
264
|
```
|
265
|
-
const
|
265
|
+
const bundle = await Bundle.find(id)
|
266
266
|
|
267
267
|
await bundle.update({
|
268
268
|
'paths': ["file.txt"],
|
@@ -414,7 +414,7 @@ await bundle.update({
|
|
414
414
|
## Delete Bundle
|
415
415
|
|
416
416
|
```
|
417
|
-
const
|
417
|
+
const bundle = await Bundle.find(id)
|
418
418
|
|
419
419
|
await bundle.delete()
|
420
420
|
```
|
@@ -75,7 +75,7 @@ await BundleNotification.create({
|
|
75
75
|
## Update Bundle Notification
|
76
76
|
|
77
77
|
```
|
78
|
-
const
|
78
|
+
const bundle_notification = await BundleNotification.find(id)
|
79
79
|
|
80
80
|
await bundle_notification.update({
|
81
81
|
'notify_on_registration': true,
|
@@ -106,7 +106,7 @@ await bundle_notification.update({
|
|
106
106
|
## Delete Bundle Notification
|
107
107
|
|
108
108
|
```
|
109
|
-
const
|
109
|
+
const bundle_notification = await BundleNotification.find(id)
|
110
110
|
|
111
111
|
await bundle_notification.delete()
|
112
112
|
```
|
package/docs/models/Clickwrap.md
CHANGED
@@ -77,7 +77,7 @@ await Clickwrap.create({
|
|
77
77
|
## Update Clickwrap
|
78
78
|
|
79
79
|
```
|
80
|
-
const
|
80
|
+
const clickwrap = await Clickwrap.find(id)
|
81
81
|
|
82
82
|
await clickwrap.update({
|
83
83
|
'name': "Example Site NDA for Files.com Use",
|
@@ -115,7 +115,7 @@ await clickwrap.update({
|
|
115
115
|
## Delete Clickwrap
|
116
116
|
|
117
117
|
```
|
118
|
-
const
|
118
|
+
const clickwrap = await Clickwrap.find(id)
|
119
119
|
|
120
120
|
await clickwrap.delete()
|
121
121
|
```
|
package/docs/models/Errors.md
CHANGED
package/docs/models/File.md
CHANGED
@@ -150,8 +150,7 @@ await File.find(path, {
|
|
150
150
|
## Download file
|
151
151
|
|
152
152
|
```
|
153
|
-
const file =
|
154
|
-
file.path = myFilePath
|
153
|
+
const file = await File.find(path)
|
155
154
|
|
156
155
|
await file.download({
|
157
156
|
'with_previews': true,
|
@@ -220,8 +219,7 @@ await file.download({
|
|
220
219
|
## Update file/folder metadata
|
221
220
|
|
222
221
|
```
|
223
|
-
const file =
|
224
|
-
file.path = myFilePath
|
222
|
+
const file = await File.find(path)
|
225
223
|
|
226
224
|
await file.update({
|
227
225
|
'custom_metadata': {"key":"value"},
|
@@ -290,8 +288,7 @@ await file.update({
|
|
290
288
|
## Delete file/folder
|
291
289
|
|
292
290
|
```
|
293
|
-
const file =
|
294
|
-
file.path = myFilePath
|
291
|
+
const file = await File.find(path)
|
295
292
|
|
296
293
|
await file.delete({
|
297
294
|
'recursive': true,
|
@@ -309,8 +306,7 @@ await file.delete({
|
|
309
306
|
## Copy file/folder
|
310
307
|
|
311
308
|
```
|
312
|
-
const file =
|
313
|
-
file.path = myFilePath
|
309
|
+
const file = await File.find(path)
|
314
310
|
|
315
311
|
await file.copy({
|
316
312
|
'destination': "destination",
|
@@ -340,8 +336,7 @@ await file.copy({
|
|
340
336
|
## Move file/folder
|
341
337
|
|
342
338
|
```
|
343
|
-
const file =
|
344
|
-
file.path = myFilePath
|
339
|
+
const file = await File.find(path)
|
345
340
|
|
346
341
|
await file.move({
|
347
342
|
'destination': "destination",
|
@@ -369,8 +364,7 @@ await file.move({
|
|
369
364
|
## Begin file upload
|
370
365
|
|
371
366
|
```
|
372
|
-
const file =
|
373
|
-
file.path = myFilePath
|
367
|
+
const file = await File.find(path)
|
374
368
|
|
375
369
|
await file.begin_upload({
|
376
370
|
'mkdir_parents': true,
|
package/docs/models/FormField.md
CHANGED
@@ -24,6 +24,6 @@
|
|
24
24
|
* `required` (boolean): Is this a required field?
|
25
25
|
* `help_text` (string): Help text to be displayed
|
26
26
|
* `field_type` (string): Type of Field
|
27
|
-
* `options_for_select` (array): Options to display for radio and dropdown
|
27
|
+
* `options_for_select` (array(string)): Options to display for radio and dropdown
|
28
28
|
* `default_option` (string): Default option for radio and dropdown
|
29
29
|
* `form_field_set_id` (int64): Form field set id
|
@@ -36,8 +36,8 @@
|
|
36
36
|
|
37
37
|
* `id` (int64): Form field set id
|
38
38
|
* `title` (string): Title to be displayed
|
39
|
-
* `form_layout` (array): Layout of the form
|
40
|
-
* `form_fields` (array): Associated form fields
|
39
|
+
* `form_layout` (array(int64)): Layout of the form
|
40
|
+
* `form_fields` (array(object)): Associated form fields
|
41
41
|
* `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
|
42
42
|
* `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
|
43
43
|
* `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
|
@@ -104,7 +104,7 @@ await FormFieldSet.create({
|
|
104
104
|
## Update Form Field Set
|
105
105
|
|
106
106
|
```
|
107
|
-
const
|
107
|
+
const form_field_set = await FormFieldSet.find(id)
|
108
108
|
|
109
109
|
await form_field_set.update({
|
110
110
|
'title': "Sample Form Title",
|
@@ -163,7 +163,7 @@ await form_field_set.update({
|
|
163
163
|
## Delete Form Field Set
|
164
164
|
|
165
165
|
```
|
166
|
-
const
|
166
|
+
const form_field_set = await FormFieldSet.find(id)
|
167
167
|
|
168
168
|
await form_field_set.delete()
|
169
169
|
```
|
package/docs/models/GpgKey.md
CHANGED
@@ -82,7 +82,7 @@ await GpgKey.create({
|
|
82
82
|
## Update Gpg Key
|
83
83
|
|
84
84
|
```
|
85
|
-
const
|
85
|
+
const gpg_key = await GpgKey.find(id)
|
86
86
|
|
87
87
|
await gpg_key.update({
|
88
88
|
'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
|
@@ -119,7 +119,7 @@ await gpg_key.update({
|
|
119
119
|
## Delete Gpg Key
|
120
120
|
|
121
121
|
```
|
122
|
-
const
|
122
|
+
const gpg_key = await GpgKey.find(id)
|
123
123
|
|
124
124
|
await gpg_key.delete()
|
125
125
|
```
|
package/docs/models/Group.md
CHANGED
@@ -99,7 +99,7 @@ await Group.create({
|
|
99
99
|
## Update Group
|
100
100
|
|
101
101
|
```
|
102
|
-
const
|
102
|
+
const group = await Group.find(id)
|
103
103
|
|
104
104
|
await group.update({
|
105
105
|
'notes': "example",
|
@@ -150,7 +150,7 @@ await group.update({
|
|
150
150
|
## Delete Group
|
151
151
|
|
152
152
|
```
|
153
|
-
const
|
153
|
+
const group = await Group.find(id)
|
154
154
|
|
155
155
|
await group.delete()
|
156
156
|
```
|
package/docs/models/GroupUser.md
CHANGED
@@ -18,7 +18,7 @@
|
|
18
18
|
* `group_id` (int64): Group ID
|
19
19
|
* `user_id` (int64): User ID
|
20
20
|
* `admin` (boolean): Is this user an administrator of this group?
|
21
|
-
* `usernames` (array): A list of usernames for users in this group
|
21
|
+
* `usernames` (array(string)): A list of usernames for users in this group
|
22
22
|
* `id` (int64): Group User ID.
|
23
23
|
|
24
24
|
---
|
package/docs/models/History.md
CHANGED
@@ -29,7 +29,7 @@
|
|
29
29
|
* `display` (string): Friendly displayed output
|
30
30
|
* `ip` (string): IP Address that performed this action
|
31
31
|
* `source` (string): The source path for this action, if applicable
|
32
|
-
* `targets` (array): Targets
|
32
|
+
* `targets` (array(object)): Targets
|
33
33
|
* `user_id` (int64): User ID
|
34
34
|
* `username` (string): Username
|
35
35
|
* `action` (string): Type of action
|
package/docs/models/Invoice.md
CHANGED
@@ -44,9 +44,9 @@
|
|
44
44
|
* `created_at` (date-time): Line item created at
|
45
45
|
* `currency` (string): Line item currency
|
46
46
|
* `download_uri` (string): Line item download uri
|
47
|
-
* `invoice_line_items` (array): Associated invoice line items
|
47
|
+
* `invoice_line_items` (array(object)): Associated invoice line items
|
48
48
|
* `method` (string): Line item payment method
|
49
|
-
* `payment_line_items` (array): Associated payment line items
|
49
|
+
* `payment_line_items` (array(object)): Associated payment line items
|
50
50
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
51
51
|
* `payment_type` (string): Type of payment if applicable
|
52
52
|
* `site_name` (string): Site name this line item is for
|
package/docs/models/IpAddress.md
CHANGED
@@ -16,7 +16,7 @@
|
|
16
16
|
* `id` (string): Unique label for list; used by Zapier and other integrations.
|
17
17
|
* `associated_with` (string): The object that this public IP address list is associated with.
|
18
18
|
* `group_id` (int64): Group ID
|
19
|
-
* `ip_addresses` (array): A list of IP addresses.
|
19
|
+
* `ip_addresses` (array(string)): A list of IP addresses.
|
20
20
|
|
21
21
|
---
|
22
22
|
|
package/docs/models/Message.md
CHANGED
@@ -25,7 +25,7 @@
|
|
25
25
|
* `id` (int64): Message ID
|
26
26
|
* `subject` (string): Message subject.
|
27
27
|
* `body` (string): Message body.
|
28
|
-
* `comments` (array): Comments.
|
28
|
+
* `comments` (array(object)): Comments.
|
29
29
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
30
30
|
* `project_id` (int64): Project to which the message should be attached.
|
31
31
|
|
@@ -88,7 +88,7 @@ await Message.create({
|
|
88
88
|
## Update Message
|
89
89
|
|
90
90
|
```
|
91
|
-
const
|
91
|
+
const message = await Message.find(id)
|
92
92
|
|
93
93
|
await message.update({
|
94
94
|
'project_id': 1,
|
@@ -131,7 +131,7 @@ await message.update({
|
|
131
131
|
## Delete Message
|
132
132
|
|
133
133
|
```
|
134
|
-
const
|
134
|
+
const message = await Message.find(id)
|
135
135
|
|
136
136
|
await message.delete()
|
137
137
|
```
|
@@ -17,7 +17,7 @@
|
|
17
17
|
|
18
18
|
* `id` (int64): Message Comment ID
|
19
19
|
* `body` (string): Comment body.
|
20
|
-
* `reactions` (array): Reactions to this comment.
|
20
|
+
* `reactions` (array(object)): Reactions to this comment.
|
21
21
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
22
22
|
|
23
23
|
---
|
@@ -75,7 +75,7 @@ await MessageComment.create({
|
|
75
75
|
## Update Message Comment
|
76
76
|
|
77
77
|
```
|
78
|
-
const
|
78
|
+
const message_comment = await MessageComment.find(id)
|
79
79
|
|
80
80
|
await message_comment.update({
|
81
81
|
'body': "body",
|
@@ -107,7 +107,7 @@ await message_comment.update({
|
|
107
107
|
## Delete Message Comment
|
108
108
|
|
109
109
|
```
|
110
|
-
const
|
110
|
+
const message_comment = await MessageComment.find(id)
|
111
111
|
|
112
112
|
await message_comment.delete()
|
113
113
|
```
|
@@ -68,7 +68,7 @@ await MessageCommentReaction.create({
|
|
68
68
|
## Delete Message Comment Reaction
|
69
69
|
|
70
70
|
```
|
71
|
-
const
|
71
|
+
const message_comment_reaction = await MessageCommentReaction.find(id)
|
72
72
|
|
73
73
|
await message_comment_reaction.delete()
|
74
74
|
```
|
@@ -40,8 +40,8 @@
|
|
40
40
|
* `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
41
41
|
* `group_id` (int64): ID of Group to receive notifications
|
42
42
|
* `group_name` (string): Group name, if a Group ID is set
|
43
|
-
* `triggering_group_ids` (array): If set, will only notify on actions made by a member of one of the specified groups
|
44
|
-
* `triggering_user_ids` (array): If set, will onlynotify on actions made one of the specified users
|
43
|
+
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
44
|
+
* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
|
45
45
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
46
46
|
* `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
|
47
47
|
* `notify_on_copy` (boolean): Trigger on files copied to this path?
|
@@ -52,7 +52,7 @@
|
|
52
52
|
* `recursive` (boolean): Apply notification recursively? This will enable notifications for each subfolder.
|
53
53
|
* `send_interval` (string): The time interval that notifications are aggregated to
|
54
54
|
* `message` (string): Custom message to include in notification emails
|
55
|
-
* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to scope trigger
|
55
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
56
56
|
* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
|
57
57
|
* `unsubscribed_reason` (string): The reason that the user unsubscribed
|
58
58
|
* `user_id` (int64): Notification user ID
|
@@ -149,7 +149,7 @@ await Notification.create({
|
|
149
149
|
## Update Notification
|
150
150
|
|
151
151
|
```
|
152
|
-
const
|
152
|
+
const notification = await Notification.find(id)
|
153
153
|
|
154
154
|
await notification.update({
|
155
155
|
'notify_on_copy': true,
|
@@ -226,7 +226,7 @@ await notification.update({
|
|
226
226
|
## Delete Notification
|
227
227
|
|
228
228
|
```
|
229
|
-
const
|
229
|
+
const notification = await Notification.find(id)
|
230
230
|
|
231
231
|
await notification.delete()
|
232
232
|
```
|
package/docs/models/Payment.md
CHANGED
@@ -44,9 +44,9 @@
|
|
44
44
|
* `created_at` (date-time): Line item created at
|
45
45
|
* `currency` (string): Line item currency
|
46
46
|
* `download_uri` (string): Line item download uri
|
47
|
-
* `invoice_line_items` (array): Associated invoice line items
|
47
|
+
* `invoice_line_items` (array(object)): Associated invoice line items
|
48
48
|
* `method` (string): Line item payment method
|
49
|
-
* `payment_line_items` (array): Associated payment line items
|
49
|
+
* `payment_line_items` (array(object)): Associated payment line items
|
50
50
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
51
51
|
* `payment_type` (string): Type of payment if applicable
|
52
52
|
* `site_name` (string): Site name this line item is for
|
package/docs/models/Project.md
CHANGED
@@ -61,7 +61,7 @@ await Project.create({
|
|
61
61
|
## Update Project
|
62
62
|
|
63
63
|
```
|
64
|
-
const
|
64
|
+
const project = await Project.find(id)
|
65
65
|
|
66
66
|
await project.update({
|
67
67
|
'global_access': "global_access",
|
@@ -87,7 +87,7 @@ await project.update({
|
|
87
87
|
## Delete Project
|
88
88
|
|
89
89
|
```
|
90
|
-
const
|
90
|
+
const project = await Project.find(id)
|
91
91
|
|
92
92
|
await project.delete()
|
93
93
|
```
|
package/docs/models/PublicKey.md
CHANGED
@@ -78,7 +78,7 @@ await PublicKey.create({
|
|
78
78
|
## Update Public Key
|
79
79
|
|
80
80
|
```
|
81
|
-
const
|
81
|
+
const public_key = await PublicKey.find(id)
|
82
82
|
|
83
83
|
await public_key.update({
|
84
84
|
'title': "My Main Key",
|
@@ -109,7 +109,7 @@ await public_key.update({
|
|
109
109
|
## Delete Public Key
|
110
110
|
|
111
111
|
```
|
112
|
-
const
|
112
|
+
const public_key = await PublicKey.find(id)
|
113
113
|
|
114
114
|
await public_key.delete()
|
115
115
|
```
|
@@ -307,7 +307,7 @@ await RemoteServer.create({
|
|
307
307
|
## Post local changes, check in, and download configuration file (used by some Remote Server integrations, such as the Files.com Agent)
|
308
308
|
|
309
309
|
```
|
310
|
-
const
|
310
|
+
const remote_server = await RemoteServer.find(id)
|
311
311
|
|
312
312
|
await remote_server.configuration_file({
|
313
313
|
'api_token': "example",
|
@@ -375,7 +375,7 @@ await remote_server.configuration_file({
|
|
375
375
|
## Update Remote Server
|
376
376
|
|
377
377
|
```
|
378
|
-
const
|
378
|
+
const remote_server = await RemoteServer.find(id)
|
379
379
|
|
380
380
|
await remote_server.update({
|
381
381
|
'aws_access_key': "example",
|
@@ -563,7 +563,7 @@ await remote_server.update({
|
|
563
563
|
## Delete Remote Server
|
564
564
|
|
565
565
|
```
|
566
|
-
const
|
566
|
+
const remote_server = await RemoteServer.find(id)
|
567
567
|
|
568
568
|
await remote_server.delete()
|
569
569
|
```
|
@@ -15,7 +15,7 @@
|
|
15
15
|
}
|
16
16
|
```
|
17
17
|
|
18
|
-
* `changes` (array): Markdown-formatted change messages.
|
18
|
+
* `changes` (array(string)): Markdown-formatted change messages.
|
19
19
|
* `created_at` (date-time): The time this change was made
|
20
20
|
* `user_id` (int64): The user id responsible for this change
|
21
21
|
* `api_key_id` (int64): The api key id responsible for this change
|