files.com 1.0.197 → 1.0.200
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 +24 -20
- package/docs/models/App.md +1 -1
- package/docs/models/Automation.md +18 -10
- package/docs/models/Bundle.md +39 -28
- package/docs/models/File.md +4 -0
- package/docs/models/FileComment.md +13 -9
- package/docs/models/Folder.md +2 -0
- package/docs/models/FormField.md +1 -1
- package/docs/models/FormFieldSet.md +36 -32
- package/docs/models/Group.md +13 -25
- package/docs/models/Invoice.md +24 -20
- package/docs/models/InvoiceLineItem.md +1 -1
- package/docs/models/Message.md +21 -13
- package/docs/models/MessageComment.md +13 -9
- package/docs/models/Notification.md +2 -2
- package/docs/models/Payment.md +24 -20
- package/docs/models/RemoteServer.md +10 -0
- package/docs/models/SettingsChange.md +1 -1
- package/docs/models/Site.md +8 -0
- package/docs/models/Status.md +9 -7
- package/docs/models/UsageDailySnapshot.md +1 -1
- package/lib/models/Bundle.js +37 -15
- package/lib/models/File.js +3 -0
- package/lib/models/Folder.js +3 -0
- package/lib/models/RemoteServer.js +12 -0
- package/lib/models/Site.js +6 -0
- package/package.json +1 -1
- package/src/models/AccountLineItem.js +2 -2
- package/src/models/App.js +1 -1
- package/src/models/Automation.js +2 -2
- package/src/models/Bundle.js +16 -0
- package/src/models/File.js +3 -0
- package/src/models/FileComment.js +1 -1
- package/src/models/Folder.js +3 -0
- package/src/models/FormField.js +1 -1
- package/src/models/FormFieldSet.js +2 -2
- package/src/models/Group.js +3 -3
- package/src/models/Invoice.js +2 -2
- package/src/models/Message.js +1 -1
- package/src/models/MessageComment.js +1 -1
- package/src/models/Notification.js +2 -2
- package/src/models/Payment.js +2 -2
- package/src/models/RemoteServer.js +16 -0
- package/src/models/SettingsChange.js +1 -1
- package/src/models/Site.js +8 -0
- package/src/models/Status.js +1 -1
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.200
|
@@ -10,25 +10,29 @@
|
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
|
-
"invoice_line_items":
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
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
|
+
}
|
25
|
+
],
|
24
26
|
"method": "paypal",
|
25
|
-
"payment_line_items":
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
27
|
+
"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
|
+
}
|
35
|
+
],
|
32
36
|
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
33
37
|
"payment_type": "",
|
34
38
|
"site_name": "My Site",
|
@@ -43,9 +47,9 @@
|
|
43
47
|
* `created_at` (date-time): Line item created at
|
44
48
|
* `currency` (string): Line item currency
|
45
49
|
* `download_uri` (string): Line item download uri
|
46
|
-
* `invoice_line_items` (
|
50
|
+
* `invoice_line_items` (array): Associated invoice line items
|
47
51
|
* `method` (string): Line item payment method
|
48
|
-
* `payment_line_items` (
|
52
|
+
* `payment_line_items` (array): Associated payment line items
|
49
53
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
54
|
* `payment_type` (string): Type of payment if applicable
|
51
55
|
* `site_name` (string): Site name this line item is for
|
package/docs/models/App.md
CHANGED
@@ -31,7 +31,7 @@
|
|
31
31
|
* `documentation_links` (object): Collection of named links to documentation
|
32
32
|
* `icon_url` (string): App icon
|
33
33
|
* `logo_url` (string): Full size logo for the App
|
34
|
-
* `screenshot_list_urls` (
|
34
|
+
* `screenshot_list_urls` (array): Screenshots of the App
|
35
35
|
* `logo_thumbnail_url` (string): Logo thumbnail for the App
|
36
36
|
* `sso_strategy_type` (string): Associated SSO Strategy type, if any
|
37
37
|
* `remote_server_type` (string): Associated Remote Server type, if any
|
@@ -42,8 +42,12 @@
|
|
42
42
|
2
|
43
43
|
],
|
44
44
|
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
45
|
-
"trigger_actions":
|
46
|
-
|
45
|
+
"trigger_actions": [
|
46
|
+
"create"
|
47
|
+
],
|
48
|
+
"value": {
|
49
|
+
"limit": "1"
|
50
|
+
}
|
47
51
|
}
|
48
52
|
```
|
49
53
|
|
@@ -57,7 +61,7 @@
|
|
57
61
|
* `name` (string): Name for this automation.
|
58
62
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
59
63
|
* `source` (string): Source Path
|
60
|
-
* `destinations` (
|
64
|
+
* `destinations` (array): Destination Path
|
61
65
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
62
66
|
* `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.
|
63
67
|
* `description` (string): Description for the this Automation.
|
@@ -66,7 +70,7 @@
|
|
66
70
|
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
67
71
|
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
68
72
|
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
69
|
-
* `trigger_actions` (
|
73
|
+
* `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
|
70
74
|
* `value` (object): A Hash of attributes specific to the automation type.
|
71
75
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
72
76
|
|
@@ -124,8 +128,8 @@ await Automation.create({
|
|
124
128
|
'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
125
129
|
'disabled': true,
|
126
130
|
'trigger': "realtime",
|
127
|
-
'trigger_actions':
|
128
|
-
'value':
|
131
|
+
'trigger_actions': ["create"],
|
132
|
+
'value': {"limit":"1"},
|
129
133
|
'automation': "create_folder",
|
130
134
|
})
|
131
135
|
```
|
@@ -167,8 +171,8 @@ await automation.update({
|
|
167
171
|
'schedule': "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
168
172
|
'disabled': true,
|
169
173
|
'trigger': "realtime",
|
170
|
-
'trigger_actions':
|
171
|
-
'value':
|
174
|
+
'trigger_actions': ["create"],
|
175
|
+
'value': {"limit":"1"},
|
172
176
|
'automation': "create_folder",
|
173
177
|
})
|
174
178
|
```
|
@@ -236,8 +240,12 @@ await automation.update({
|
|
236
240
|
2
|
237
241
|
],
|
238
242
|
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
239
|
-
"trigger_actions":
|
240
|
-
|
243
|
+
"trigger_actions": [
|
244
|
+
"create"
|
245
|
+
],
|
246
|
+
"value": {
|
247
|
+
"limit": "1"
|
248
|
+
}
|
241
249
|
}
|
242
250
|
```
|
243
251
|
|
package/docs/models/Bundle.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
"url": "https://subdomain.files.com/f/12345678",
|
9
9
|
"description": "The public description of the bundle.",
|
10
10
|
"password_protected": true,
|
11
|
+
"permissions": "read",
|
11
12
|
"preview_only": true,
|
12
13
|
"require_registration": true,
|
13
14
|
"require_share_recipient": true,
|
@@ -21,20 +22,22 @@
|
|
21
22
|
3,
|
22
23
|
4
|
23
24
|
],
|
24
|
-
"form_fields":
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
"
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
25
|
+
"form_fields": [
|
26
|
+
{
|
27
|
+
"id": 1,
|
28
|
+
"label": "Sample Label",
|
29
|
+
"required": true,
|
30
|
+
"help_text": "Help Text",
|
31
|
+
"field_type": "text",
|
32
|
+
"options_for_select": [
|
33
|
+
"red",
|
34
|
+
"green",
|
35
|
+
"blue"
|
36
|
+
],
|
37
|
+
"default_option": "red",
|
38
|
+
"form_field_set_id": 1
|
39
|
+
}
|
40
|
+
],
|
38
41
|
"skip_name": true,
|
39
42
|
"skip_email": true,
|
40
43
|
"skip_company": true
|
@@ -67,6 +70,7 @@
|
|
67
70
|
* `url` (string): Public URL of Share Link
|
68
71
|
* `description` (string): Public description
|
69
72
|
* `password_protected` (boolean): Is this bundle password protected?
|
73
|
+
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
70
74
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
71
75
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
72
76
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
@@ -146,6 +150,7 @@ await Bundle.create({
|
|
146
150
|
'description': "The public description of the bundle.",
|
147
151
|
'note': "The internal note on the bundle.",
|
148
152
|
'code': "abc123",
|
153
|
+
'permissions': "read",
|
149
154
|
'preview_only': true,
|
150
155
|
'require_registration': true,
|
151
156
|
'clickwrap_id': 1,
|
@@ -169,6 +174,7 @@ await Bundle.create({
|
|
169
174
|
* `description` (string): Public description
|
170
175
|
* `note` (string): Bundle internal note
|
171
176
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
177
|
+
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
172
178
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
173
179
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
174
180
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
@@ -219,6 +225,7 @@ await bundle.update({
|
|
219
225
|
'inbox_id': 1,
|
220
226
|
'max_uses': 1,
|
221
227
|
'note': "The internal note on the bundle.",
|
228
|
+
'permissions': "read",
|
222
229
|
'preview_only': true,
|
223
230
|
'require_registration': true,
|
224
231
|
'require_share_recipient': true,
|
@@ -242,6 +249,7 @@ await bundle.update({
|
|
242
249
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
243
250
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
244
251
|
* `note` (string): Bundle internal note
|
252
|
+
* `permissions` (string): Permissions that apply to Folders in this Share Link.
|
245
253
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
246
254
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
247
255
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
@@ -259,6 +267,7 @@ await bundle.update({
|
|
259
267
|
"url": "https://subdomain.files.com/f/12345678",
|
260
268
|
"description": "The public description of the bundle.",
|
261
269
|
"password_protected": true,
|
270
|
+
"permissions": "read",
|
262
271
|
"preview_only": true,
|
263
272
|
"require_registration": true,
|
264
273
|
"require_share_recipient": true,
|
@@ -272,20 +281,22 @@ await bundle.update({
|
|
272
281
|
3,
|
273
282
|
4
|
274
283
|
],
|
275
|
-
"form_fields":
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
"
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
284
|
+
"form_fields": [
|
285
|
+
{
|
286
|
+
"id": 1,
|
287
|
+
"label": "Sample Label",
|
288
|
+
"required": true,
|
289
|
+
"help_text": "Help Text",
|
290
|
+
"field_type": "text",
|
291
|
+
"options_for_select": [
|
292
|
+
"red",
|
293
|
+
"green",
|
294
|
+
"blue"
|
295
|
+
],
|
296
|
+
"default_option": "red",
|
297
|
+
"form_field_set_id": 1
|
298
|
+
}
|
299
|
+
],
|
289
300
|
"skip_name": true,
|
290
301
|
"skip_email": true,
|
291
302
|
"skip_company": true
|
package/docs/models/File.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
"display_name": "file.txt",
|
9
9
|
"type": "file",
|
10
10
|
"size": 1024,
|
11
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
12
|
"mtime": "2000-01-01T01:00:00Z",
|
12
13
|
"provided_mtime": "2000-01-01T01:00:00Z",
|
13
14
|
"crc32": "70976923",
|
@@ -33,6 +34,7 @@
|
|
33
34
|
* `display_name` (string): File/Folder display name
|
34
35
|
* `type` (string): Type: `directory` or `file`.
|
35
36
|
* `size` (int64): File/Folder size
|
37
|
+
* `created_at` (date-time): File created date/time
|
36
38
|
* `mtime` (date-time): File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
|
37
39
|
* `provided_mtime` (date-time): File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.
|
38
40
|
* `crc32` (string): File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
@@ -139,6 +141,7 @@ await file.download({
|
|
139
141
|
"display_name": "file.txt",
|
140
142
|
"type": "file",
|
141
143
|
"size": 1024,
|
144
|
+
"created_at": "2000-01-01T01:00:00Z",
|
142
145
|
"mtime": "2000-01-01T01:00:00Z",
|
143
146
|
"provided_mtime": "2000-01-01T01:00:00Z",
|
144
147
|
"crc32": "70976923",
|
@@ -188,6 +191,7 @@ await file.update({
|
|
188
191
|
"display_name": "file.txt",
|
189
192
|
"type": "file",
|
190
193
|
"size": 1024,
|
194
|
+
"created_at": "2000-01-01T01:00:00Z",
|
191
195
|
"mtime": "2000-01-01T01:00:00Z",
|
192
196
|
"provided_mtime": "2000-01-01T01:00:00Z",
|
193
197
|
"crc32": "70976923",
|
@@ -6,16 +6,18 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"body": "What a great file!",
|
9
|
-
"reactions":
|
10
|
-
|
11
|
-
|
12
|
-
|
9
|
+
"reactions": [
|
10
|
+
{
|
11
|
+
"id": 1,
|
12
|
+
"emoji": "👍"
|
13
|
+
}
|
14
|
+
]
|
13
15
|
}
|
14
16
|
```
|
15
17
|
|
16
18
|
* `id` (int64): File Comment ID
|
17
19
|
* `body` (string): Comment body.
|
18
|
-
* `reactions` (
|
20
|
+
* `reactions` (array): Reactions to this comment.
|
19
21
|
* `path` (string): File path.
|
20
22
|
|
21
23
|
---
|
@@ -75,10 +77,12 @@ await file_comment.update({
|
|
75
77
|
{
|
76
78
|
"id": 1,
|
77
79
|
"body": "What a great file!",
|
78
|
-
"reactions":
|
79
|
-
|
80
|
-
|
81
|
-
|
80
|
+
"reactions": [
|
81
|
+
{
|
82
|
+
"id": 1,
|
83
|
+
"emoji": "👍"
|
84
|
+
}
|
85
|
+
]
|
82
86
|
}
|
83
87
|
```
|
84
88
|
|
package/docs/models/Folder.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
"display_name": "file.txt",
|
9
9
|
"type": "file",
|
10
10
|
"size": 1024,
|
11
|
+
"created_at": "2000-01-01T01:00:00Z",
|
11
12
|
"mtime": "2000-01-01T01:00:00Z",
|
12
13
|
"provided_mtime": "2000-01-01T01:00:00Z",
|
13
14
|
"crc32": "70976923",
|
@@ -33,6 +34,7 @@
|
|
33
34
|
* `display_name` (string): File/Folder display name
|
34
35
|
* `type` (string): Type: `directory` or `file`.
|
35
36
|
* `size` (int64): File/Folder size
|
37
|
+
* `created_at` (date-time): File created date/time
|
36
38
|
* `mtime` (date-time): File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
|
37
39
|
* `provided_mtime` (date-time): File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop<->Cloud syncing to preserve modified at times.
|
38
40
|
* `crc32` (string): File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
|
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` (
|
27
|
+
* `options_for_select` (array): 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
|
@@ -12,20 +12,22 @@
|
|
12
12
|
3,
|
13
13
|
4
|
14
14
|
],
|
15
|
-
"form_fields":
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
"
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
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
|
+
}
|
30
|
+
],
|
29
31
|
"skip_name": true,
|
30
32
|
"skip_email": true,
|
31
33
|
"skip_company": true
|
@@ -34,8 +36,8 @@
|
|
34
36
|
|
35
37
|
* `id` (int64): Form field set id
|
36
38
|
* `title` (string): Title to be displayed
|
37
|
-
* `form_layout` (
|
38
|
-
* `form_fields` (
|
39
|
+
* `form_layout` (array): Layout of the form
|
40
|
+
* `form_fields` (array): Associated form fields
|
39
41
|
* `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
|
40
42
|
* `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
|
41
43
|
* `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
|
@@ -83,7 +85,7 @@ await FormFieldSet.create({
|
|
83
85
|
'skip_email': true,
|
84
86
|
'skip_name': true,
|
85
87
|
'skip_company': true,
|
86
|
-
'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},
|
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}],
|
87
89
|
})
|
88
90
|
```
|
89
91
|
|
@@ -109,7 +111,7 @@ await form_field_set.update({
|
|
109
111
|
'skip_email': true,
|
110
112
|
'skip_name': true,
|
111
113
|
'skip_company': true,
|
112
|
-
'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},
|
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}],
|
113
115
|
})
|
114
116
|
```
|
115
117
|
|
@@ -134,20 +136,22 @@ await form_field_set.update({
|
|
134
136
|
3,
|
135
137
|
4
|
136
138
|
],
|
137
|
-
"form_fields":
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
"
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
139
|
+
"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
|
+
}
|
154
|
+
],
|
151
155
|
"skip_name": true,
|
152
156
|
"skip_email": true,
|
153
157
|
"skip_company": true
|
package/docs/models/Group.md
CHANGED
@@ -6,25 +6,19 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"name": "owners",
|
9
|
-
"admin_ids":
|
10
|
-
1
|
11
|
-
],
|
9
|
+
"admin_ids": "1",
|
12
10
|
"notes": "",
|
13
|
-
"user_ids":
|
14
|
-
|
15
|
-
],
|
16
|
-
"usernames": [
|
17
|
-
"user"
|
18
|
-
]
|
11
|
+
"user_ids": "1",
|
12
|
+
"usernames": "user"
|
19
13
|
}
|
20
14
|
```
|
21
15
|
|
22
16
|
* `id` (int64): Group ID
|
23
17
|
* `name` (string): Group name
|
24
|
-
* `admin_ids` (string):
|
18
|
+
* `admin_ids` (string): Comma-delimited list of user IDs who are group administrators (separated by commas)
|
25
19
|
* `notes` (string): Notes about this group
|
26
|
-
* `user_ids` (
|
27
|
-
* `usernames` (
|
20
|
+
* `user_ids` (string): Comma-delimited list of user IDs who belong to this group (separated by commas)
|
21
|
+
* `usernames` (string): Comma-delimited list of usernames who belong to this group (separated by commas)
|
28
22
|
|
29
23
|
---
|
30
24
|
|
@@ -70,8 +64,8 @@ await Group.find(id)
|
|
70
64
|
```
|
71
65
|
await Group.create({
|
72
66
|
'name': "owners",
|
73
|
-
'user_ids':
|
74
|
-
'admin_ids':
|
67
|
+
'user_ids': "1",
|
68
|
+
'admin_ids': "1",
|
75
69
|
})
|
76
70
|
```
|
77
71
|
|
@@ -92,8 +86,8 @@ const [group] = await Group.list()
|
|
92
86
|
|
93
87
|
await group.update({
|
94
88
|
'name': "owners",
|
95
|
-
'user_ids':
|
96
|
-
'admin_ids':
|
89
|
+
'user_ids': "1",
|
90
|
+
'admin_ids': "1",
|
97
91
|
})
|
98
92
|
```
|
99
93
|
|
@@ -111,16 +105,10 @@ await group.update({
|
|
111
105
|
{
|
112
106
|
"id": 1,
|
113
107
|
"name": "owners",
|
114
|
-
"admin_ids":
|
115
|
-
1
|
116
|
-
],
|
108
|
+
"admin_ids": "1",
|
117
109
|
"notes": "",
|
118
|
-
"user_ids":
|
119
|
-
|
120
|
-
],
|
121
|
-
"usernames": [
|
122
|
-
"user"
|
123
|
-
]
|
110
|
+
"user_ids": "1",
|
111
|
+
"usernames": "user"
|
124
112
|
}
|
125
113
|
```
|
126
114
|
|
package/docs/models/Invoice.md
CHANGED
@@ -10,25 +10,29 @@
|
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
11
|
"currency": "USD",
|
12
12
|
"download_uri": "https://url...",
|
13
|
-
"invoice_line_items":
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
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
|
+
}
|
25
|
+
],
|
24
26
|
"method": "paypal",
|
25
|
-
"payment_line_items":
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
27
|
+
"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
|
+
}
|
35
|
+
],
|
32
36
|
"payment_reversed_at": "2000-01-01T01:00:00Z",
|
33
37
|
"payment_type": "",
|
34
38
|
"site_name": "My Site",
|
@@ -43,9 +47,9 @@
|
|
43
47
|
* `created_at` (date-time): Line item created at
|
44
48
|
* `currency` (string): Line item currency
|
45
49
|
* `download_uri` (string): Line item download uri
|
46
|
-
* `invoice_line_items` (
|
50
|
+
* `invoice_line_items` (array): Associated invoice line items
|
47
51
|
* `method` (string): Line item payment method
|
48
|
-
* `payment_line_items` (
|
52
|
+
* `payment_line_items` (array): Associated payment line items
|
49
53
|
* `payment_reversed_at` (date-time): Date/time payment was reversed if applicable
|
50
54
|
* `payment_type` (string): Type of payment if applicable
|
51
55
|
* `site_name` (string): Site name this line item is for
|