files.com 1.0.217 → 1.0.219

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/_VERSION +1 -1
  2. package/docs/models/AccountLineItem.md +3 -19
  3. package/docs/models/ActionNotificationExport.md +1 -1
  4. package/docs/models/ApiKey.md +4 -2
  5. package/docs/models/App.md +17 -15
  6. package/docs/models/As2IncomingMessage.md +29 -25
  7. package/docs/models/As2OutgoingMessage.md +24 -20
  8. package/docs/models/As2Partner.md +15 -14
  9. package/docs/models/As2Station.md +18 -18
  10. package/docs/models/Automation.md +28 -40
  11. package/docs/models/Behavior.md +17 -12
  12. package/docs/models/Bundle.md +8 -66
  13. package/docs/models/BundleDownload.md +2 -2
  14. package/docs/models/BundleRegistration.md +5 -3
  15. package/docs/models/Clickwrap.md +12 -6
  16. package/docs/models/DnsRecord.md +1 -1
  17. package/docs/models/ExternalEvent.md +7 -7
  18. package/docs/models/File.md +16 -28
  19. package/docs/models/FileAction.md +1 -1
  20. package/docs/models/FileComment.md +2 -8
  21. package/docs/models/FileUploadPart.md +11 -5
  22. package/docs/models/Folder.md +1 -7
  23. package/docs/models/FormFieldSet.md +4 -30
  24. package/docs/models/Group.md +6 -4
  25. package/docs/models/GroupUser.md +2 -2
  26. package/docs/models/HistoryExport.md +1 -1
  27. package/docs/models/InboxRegistration.md +5 -3
  28. package/docs/models/InboxUpload.md +2 -2
  29. package/docs/models/Invoice.md +3 -19
  30. package/docs/models/Lock.md +1 -1
  31. package/docs/models/Message.md +2 -20
  32. package/docs/models/MessageComment.md +2 -8
  33. package/docs/models/Notification.md +4 -4
  34. package/docs/models/Payment.md +3 -19
  35. package/docs/models/Permission.md +4 -2
  36. package/docs/models/PublicIpAddress.md +2 -2
  37. package/docs/models/RemoteServer.md +12 -6
  38. package/docs/models/Request.md +6 -5
  39. package/docs/models/SettingsChange.md +1 -1
  40. package/docs/models/SftpHostKey.md +8 -10
  41. package/docs/models/Site.md +47 -114
  42. package/docs/models/SsoStrategy.md +12 -12
  43. package/docs/models/Status.md +4 -11
  44. package/docs/models/Style.md +4 -4
  45. package/docs/models/UsageDailySnapshot.md +11 -9
  46. package/docs/models/UsageSnapshot.md +3 -1
  47. package/docs/models/User.md +16 -12
  48. package/docs/models/UserRequest.md +1 -1
  49. package/docs/models/WebhookTest.md +4 -4
  50. package/lib/models/Site.js +104 -87
  51. package/package.json +1 -1
  52. package/src/models/Site.js +16 -0
@@ -10,10 +10,12 @@
10
10
  "email": "john.doe@files.com",
11
11
  "ip": "10.1.1.1",
12
12
  "inbox_code": "abc123",
13
- "clickwrap_body": "",
13
+ "clickwrap_body": "example",
14
14
  "form_field_set_id": 1,
15
- "form_field_data": "",
16
- "bundle_code": "",
15
+ "form_field_data": {
16
+ "key": "example value"
17
+ },
18
+ "bundle_code": "example",
17
19
  "bundle_id": 1,
18
20
  "bundle_recipient_id": 1
19
21
  }
@@ -7,9 +7,9 @@
7
7
  "id": 1,
8
8
  "name": "Example Site NDA for Files.com Use",
9
9
  "body": "[Legal body text]",
10
- "use_with_users": "",
11
- "use_with_bundles": "",
12
- "use_with_inboxes": ""
10
+ "use_with_users": "example",
11
+ "use_with_bundles": "example",
12
+ "use_with_inboxes": "example"
13
13
  }
14
14
  ```
15
15
 
@@ -57,6 +57,9 @@ await Clickwrap.find(id)
57
57
  await Clickwrap.create({
58
58
  'name': "Example Site NDA for Files.com Use",
59
59
  'body': "[Legal body text]",
60
+ 'use_with_bundles': "example",
61
+ 'use_with_inboxes': "example",
62
+ 'use_with_users': "example",
60
63
  })
61
64
  ```
62
65
 
@@ -79,6 +82,9 @@ const [clickwrap] = await Clickwrap.list()
79
82
  await clickwrap.update({
80
83
  'name': "Example Site NDA for Files.com Use",
81
84
  'body': "[Legal body text]",
85
+ 'use_with_bundles': "example",
86
+ 'use_with_inboxes': "example",
87
+ 'use_with_users': "example",
82
88
  })
83
89
  ```
84
90
 
@@ -98,9 +104,9 @@ await clickwrap.update({
98
104
  "id": 1,
99
105
  "name": "Example Site NDA for Files.com Use",
100
106
  "body": "[Legal body text]",
101
- "use_with_users": "",
102
- "use_with_bundles": "",
103
- "use_with_inboxes": ""
107
+ "use_with_users": "example",
108
+ "use_with_bundles": "example",
109
+ "use_with_inboxes": "example"
104
110
  }
105
111
  ```
106
112
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
- "id": "customdomain.com-CNAME-site.files.com",
7
+ "id": "example",
8
8
  "domain": "my-custom-domain.com",
9
9
  "rrtype": "CNAME",
10
10
  "value": "mysite.files.com"
@@ -5,16 +5,16 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "event_type": "",
9
- "status": "",
10
- "body": "",
8
+ "event_type": "example",
9
+ "status": "example",
10
+ "body": "example",
11
11
  "created_at": "2000-01-01T01:00:00Z",
12
- "body_url": "",
12
+ "body_url": "example",
13
13
  "folder_behavior_id": 1,
14
14
  "successful_files": 1,
15
15
  "errored_files": 1,
16
16
  "bytes_synced": 1,
17
- "remote_server_type": ""
17
+ "remote_server_type": "example"
18
18
  }
19
19
  ```
20
20
 
@@ -72,8 +72,8 @@ await ExternalEvent.find(id)
72
72
 
73
73
  ```
74
74
  await ExternalEvent.create({
75
- 'status': "status",
76
- 'body': "body",
75
+ 'status': "example",
76
+ 'body': "example",
77
77
  })
78
78
  ```
79
79
 
@@ -20,13 +20,7 @@
20
20
  "download_uri": "https://mysite.files.com/...",
21
21
  "priority_color": "red",
22
22
  "preview_id": 1,
23
- "preview": {
24
- "id": 1,
25
- "status": "complete",
26
- "download_uri": "https://mysite.files.com/...",
27
- "type": "image",
28
- "size": "large"
29
- }
23
+ "preview": ""
30
24
  }
31
25
  ```
32
26
 
@@ -153,13 +147,7 @@ await file.download({
153
147
  "download_uri": "https://mysite.files.com/...",
154
148
  "priority_color": "red",
155
149
  "preview_id": 1,
156
- "preview": {
157
- "id": 1,
158
- "status": "complete",
159
- "download_uri": "https://mysite.files.com/...",
160
- "type": "image",
161
- "size": "large"
162
- }
150
+ "preview": ""
163
151
  }
164
152
  ```
165
153
 
@@ -203,13 +191,7 @@ await file.update({
203
191
  "download_uri": "https://mysite.files.com/...",
204
192
  "priority_color": "red",
205
193
  "preview_id": 1,
206
- "preview": {
207
- "id": 1,
208
- "status": "complete",
209
- "download_uri": "https://mysite.files.com/...",
210
- "type": "image",
211
- "size": "large"
212
- }
194
+ "preview": ""
213
195
  }
214
196
  ```
215
197
 
@@ -257,7 +239,7 @@ await file.copy({
257
239
  ```json
258
240
  {
259
241
  "status": "pending",
260
- "file_migration_id": "123"
242
+ "file_migration_id": 1
261
243
  }
262
244
  ```
263
245
 
@@ -284,7 +266,7 @@ await file.move({
284
266
  ```json
285
267
  {
286
268
  "status": "pending",
287
- "file_migration_id": "123"
269
+ "file_migration_id": 1
288
270
  }
289
271
  ```
290
272
 
@@ -323,21 +305,27 @@ await file.begin_upload({
323
305
  ```json
324
306
  [
325
307
  {
326
- "send": "",
308
+ "send": {
309
+ "key": "example value"
310
+ },
327
311
  "action": "multipart",
328
312
  "ask_about_overwrites": true,
329
313
  "available_parts": 1,
330
- "expires": "",
331
- "headers": "",
314
+ "expires": "example",
315
+ "headers": {
316
+ "key": "example value"
317
+ },
332
318
  "http_method": "PUT",
333
319
  "next_partsize": 1,
334
320
  "parallel_parts": true,
335
- "parameters": "{}",
321
+ "parameters": {
322
+ "key": "example value"
323
+ },
336
324
  "part_number": 1,
337
325
  "partsize": 1,
338
326
  "path": "",
339
327
  "ref": "upload-1",
340
- "upload_uri": ""
328
+ "upload_uri": "example"
341
329
  }
342
330
  ]
343
331
  ```
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "status": "pending",
8
- "file_migration_id": "123"
8
+ "file_migration_id": 1
9
9
  }
10
10
  ```
11
11
 
@@ -7,10 +7,7 @@
7
7
  "id": 1,
8
8
  "body": "What a great file!",
9
9
  "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
10
+ null
14
11
  ]
15
12
  }
16
13
  ```
@@ -78,10 +75,7 @@ await file_comment.update({
78
75
  "id": 1,
79
76
  "body": "What a great file!",
80
77
  "reactions": [
81
- {
82
- "id": 1,
83
- "emoji": "👍"
84
- }
78
+ null
85
79
  ]
86
80
  }
87
81
  ```
@@ -4,21 +4,27 @@
4
4
 
5
5
  ```
6
6
  {
7
- "send": "",
7
+ "send": {
8
+ "key": "example value"
9
+ },
8
10
  "action": "multipart",
9
11
  "ask_about_overwrites": true,
10
12
  "available_parts": 1,
11
- "expires": "",
12
- "headers": "",
13
+ "expires": "example",
14
+ "headers": {
15
+ "key": "example value"
16
+ },
13
17
  "http_method": "PUT",
14
18
  "next_partsize": 1,
15
19
  "parallel_parts": true,
16
- "parameters": "{}",
20
+ "parameters": {
21
+ "key": "example value"
22
+ },
17
23
  "part_number": 1,
18
24
  "partsize": 1,
19
25
  "path": "",
20
26
  "ref": "upload-1",
21
- "upload_uri": ""
27
+ "upload_uri": "example"
22
28
  }
23
29
  ```
24
30
 
@@ -20,13 +20,7 @@
20
20
  "download_uri": "https://mysite.files.com/...",
21
21
  "priority_color": "red",
22
22
  "preview_id": 1,
23
- "preview": {
24
- "id": 1,
25
- "status": "complete",
26
- "download_uri": "https://mysite.files.com/...",
27
- "type": "image",
28
- "size": "large"
29
- }
23
+ "preview": ""
30
24
  }
31
25
  ```
32
26
 
@@ -13,20 +13,7 @@
13
13
  4
14
14
  ],
15
15
  "form_fields": [
16
- {
17
- "id": 1,
18
- "label": "Sample Label",
19
- "required": true,
20
- "help_text": "Help Text",
21
- "field_type": "text",
22
- "options_for_select": [
23
- "red",
24
- "green",
25
- "blue"
26
- ],
27
- "default_option": "red",
28
- "form_field_set_id": 1
29
- }
16
+ null
30
17
  ],
31
18
  "skip_name": true,
32
19
  "skip_email": true,
@@ -85,7 +72,7 @@ await FormFieldSet.create({
85
72
  'skip_email': true,
86
73
  'skip_name': true,
87
74
  'skip_company': true,
88
- 'form_fields': [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}],
75
+ 'form_fields': [null],
89
76
  })
90
77
  ```
91
78
 
@@ -111,7 +98,7 @@ await form_field_set.update({
111
98
  'skip_email': true,
112
99
  'skip_name': true,
113
100
  'skip_company': true,
114
- 'form_fields': [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}],
101
+ 'form_fields': [null],
115
102
  })
116
103
  ```
117
104
 
@@ -137,20 +124,7 @@ await form_field_set.update({
137
124
  4
138
125
  ],
139
126
  "form_fields": [
140
- {
141
- "id": 1,
142
- "label": "Sample Label",
143
- "required": true,
144
- "help_text": "Help Text",
145
- "field_type": "text",
146
- "options_for_select": [
147
- "red",
148
- "green",
149
- "blue"
150
- ],
151
- "default_option": "red",
152
- "form_field_set_id": 1
153
- }
127
+ null
154
128
  ],
155
129
  "skip_name": true,
156
130
  "skip_email": true,
@@ -7,9 +7,9 @@
7
7
  "id": 1,
8
8
  "name": "owners",
9
9
  "admin_ids": "1",
10
- "notes": "",
10
+ "notes": "example",
11
11
  "user_ids": "1",
12
- "usernames": "user"
12
+ "usernames": "example"
13
13
  }
14
14
  ```
15
15
 
@@ -64,6 +64,7 @@ await Group.find(id)
64
64
  ```
65
65
  await Group.create({
66
66
  'name': "owners",
67
+ 'notes': "example",
67
68
  'user_ids': "1",
68
69
  'admin_ids': "1",
69
70
  })
@@ -86,6 +87,7 @@ const [group] = await Group.list()
86
87
 
87
88
  await group.update({
88
89
  'name': "owners",
90
+ 'notes': "example",
89
91
  'user_ids': "1",
90
92
  'admin_ids': "1",
91
93
  })
@@ -106,9 +108,9 @@ await group.update({
106
108
  "id": 1,
107
109
  "name": "owners",
108
110
  "admin_ids": "1",
109
- "notes": "",
111
+ "notes": "example",
110
112
  "user_ids": "1",
111
- "usernames": "user"
113
+ "usernames": "example"
112
114
  }
113
115
  ```
114
116
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ```
6
6
  {
7
- "group_name": "My Group",
7
+ "group_name": "example",
8
8
  "group_id": 1,
9
9
  "user_id": 1,
10
10
  "admin": true,
@@ -85,7 +85,7 @@ await group_user.update({
85
85
 
86
86
  ```json
87
87
  {
88
- "group_name": "My Group",
88
+ "group_name": "example",
89
89
  "group_id": 1,
90
90
  "user_id": 1,
91
91
  "admin": true,
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "history_version": "20201213.2",
8
+ "history_version": "example",
9
9
  "start_at": "2000-01-01T01:00:00Z",
10
10
  "end_at": "2000-01-01T01:00:00Z",
11
11
  "status": "ready",
@@ -8,12 +8,14 @@
8
8
  "name": "account",
9
9
  "company": "Action Verb",
10
10
  "email": "john.doe@files.com",
11
- "clickwrap_body": "",
11
+ "clickwrap_body": "example",
12
12
  "form_field_set_id": 1,
13
- "form_field_data": "",
13
+ "form_field_data": {
14
+ "key": "example value"
15
+ },
14
16
  "inbox_id": 1,
15
17
  "inbox_recipient_id": 1,
16
- "inbox_title": ""
18
+ "inbox_title": "example"
17
19
  }
18
20
  ```
19
21
 
@@ -4,9 +4,9 @@
4
4
 
5
5
  ```
6
6
  {
7
- "inbox_registration": "",
7
+ "inbox_registration": "example",
8
8
  "path": "a/b/test.txt",
9
- "created_at": "2020-01-01 00:00:00"
9
+ "created_at": "2000-01-01T01:00:00Z"
10
10
  }
11
11
  ```
12
12
 
@@ -11,30 +11,14 @@
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Premier",
23
- "site": "My site"
24
- }
14
+ null
25
15
  ],
26
16
  "method": "paypal",
27
17
  "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
18
+ null
35
19
  ],
36
20
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
- "payment_type": "",
21
+ "payment_type": "example",
38
22
  "site_name": "My Site",
39
23
  "type": "invoice",
40
24
  "updated_at": "2000-01-01T01:00:00Z"
@@ -5,7 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "path": "locked_file",
8
- "timeout": 43200,
8
+ "timeout": 1,
9
9
  "depth": "infinity",
10
10
  "recursive": true,
11
11
  "owner": "user",
@@ -8,16 +8,7 @@
8
8
  "subject": "Files.com Account Upgrade",
9
9
  "body": "We should upgrade our Files.com account!",
10
10
  "comments": [
11
- {
12
- "id": 1,
13
- "body": "What a great idea, thank you!",
14
- "reactions": [
15
- {
16
- "id": 1,
17
- "emoji": "👍"
18
- }
19
- ]
20
- }
11
+ null
21
12
  ]
22
13
  }
23
14
  ```
@@ -112,16 +103,7 @@ await message.update({
112
103
  "subject": "Files.com Account Upgrade",
113
104
  "body": "We should upgrade our Files.com account!",
114
105
  "comments": [
115
- {
116
- "id": 1,
117
- "body": "What a great idea, thank you!",
118
- "reactions": [
119
- {
120
- "id": 1,
121
- "emoji": "👍"
122
- }
123
- ]
124
- }
106
+ null
125
107
  ]
126
108
  }
127
109
  ```
@@ -7,10 +7,7 @@
7
7
  "id": 1,
8
8
  "body": "What a great idea, thank you!",
9
9
  "reactions": [
10
- {
11
- "id": 1,
12
- "emoji": "👍"
13
- }
10
+ null
14
11
  ]
15
12
  }
16
13
  ```
@@ -94,10 +91,7 @@ await message_comment.update({
94
91
  "id": 1,
95
92
  "body": "What a great idea, thank you!",
96
93
  "reactions": [
97
- {
98
- "id": 1,
99
- "emoji": "👍"
100
- }
94
+ null
101
95
  ]
102
96
  }
103
97
  ```
@@ -7,7 +7,7 @@
7
7
  "id": 1,
8
8
  "path": "",
9
9
  "group_id": 1,
10
- "group_name": "",
10
+ "group_name": "example",
11
11
  "triggering_group_ids": [
12
12
  1
13
13
  ],
@@ -29,7 +29,7 @@
29
29
  "notify_file.txt"
30
30
  ],
31
31
  "unsubscribed": true,
32
- "unsubscribed_reason": "",
32
+ "unsubscribed_reason": "example",
33
33
  "user_id": 1,
34
34
  "username": "User",
35
35
  "suppressed_email": true
@@ -196,7 +196,7 @@ await notification.update({
196
196
  "id": 1,
197
197
  "path": "",
198
198
  "group_id": 1,
199
- "group_name": "",
199
+ "group_name": "example",
200
200
  "triggering_group_ids": [
201
201
  1
202
202
  ],
@@ -218,7 +218,7 @@ await notification.update({
218
218
  "notify_file.txt"
219
219
  ],
220
220
  "unsubscribed": true,
221
- "unsubscribed_reason": "",
221
+ "unsubscribed_reason": "example",
222
222
  "user_id": 1,
223
223
  "username": "User",
224
224
  "suppressed_email": true
@@ -11,30 +11,14 @@
11
11
  "currency": "USD",
12
12
  "download_uri": "https://url...",
13
13
  "invoice_line_items": [
14
- {
15
- "amount": 1.0,
16
- "created_at": "2000-01-01T01:00:00Z",
17
- "description": "Service from 2019-01-01 through 2019-12-31",
18
- "type": "invoice",
19
- "service_end_at": "2000-01-01T01:00:00Z",
20
- "service_start_at": "2000-01-01T01:00:00Z",
21
- "updated_at": "2000-01-01T01:00:00Z",
22
- "plan": "Premier",
23
- "site": "My site"
24
- }
14
+ null
25
15
  ],
26
16
  "method": "paypal",
27
17
  "payment_line_items": [
28
- {
29
- "amount": 1.0,
30
- "created_at": "2000-01-01T01:00:00Z",
31
- "invoice_id": 1,
32
- "payment_id": 1,
33
- "updated_at": "2000-01-01T01:00:00Z"
34
- }
18
+ null
35
19
  ],
36
20
  "payment_reversed_at": "2000-01-01T01:00:00Z",
37
- "payment_type": "",
21
+ "payment_type": "example",
38
22
  "site_name": "My Site",
39
23
  "type": "invoice",
40
24
  "updated_at": "2000-01-01T01:00:00Z"
@@ -5,11 +5,11 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
- "path": "",
8
+ "path": "example",
9
9
  "user_id": 1,
10
10
  "username": "Sser",
11
11
  "group_id": 1,
12
- "group_name": "",
12
+ "group_name": "example",
13
13
  "permission": "full",
14
14
  "recursive": true
15
15
  }
@@ -31,6 +31,7 @@
31
31
  ```
32
32
  await Permission.list({
33
33
  'per_page': 1,
34
+ 'path': "example",
34
35
  'group_id': 1,
35
36
  'user_id': 1,
36
37
  'include_groups': true,
@@ -61,6 +62,7 @@ await Permission.list({
61
62
  ```
62
63
  await Permission.create({
63
64
  'group_id': 1,
65
+ 'path': "example",
64
66
  'permission': "full",
65
67
  'recursive': true,
66
68
  'user_id': 1,
@@ -6,8 +6,8 @@
6
6
  {
7
7
  "ip_address": "1.1.1.1",
8
8
  "server_name": "server-1",
9
- "ftp_enabled": "",
10
- "sftp_enabled": ""
9
+ "ftp_enabled": "example",
10
+ "sftp_enabled": "example"
11
11
  }
12
12
  ```
13
13