files.com 1.0.253 → 1.0.255
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 +1 -0
- package/docs/models/ApiKey.md +2 -3
- package/docs/models/App.md +1 -5
- package/docs/models/As2IncomingMessage.md +2 -3
- package/docs/models/As2OutgoingMessage.md +2 -3
- package/docs/models/As2Partner.md +7 -0
- package/docs/models/Automation.md +7 -8
- package/docs/models/AutomationRun.md +0 -5
- package/docs/models/BandwidthSnapshot.md +2 -3
- package/docs/models/Behavior.md +3 -11
- package/docs/models/Bundle.md +2 -3
- package/docs/models/BundleDownload.md +2 -3
- package/docs/models/BundleNotification.md +3 -1
- package/docs/models/BundleRecipient.md +0 -5
- package/docs/models/ExternalEvent.md +5 -5
- package/docs/models/Group.md +1 -5
- package/docs/models/History.md +1 -5
- package/docs/models/InboxRecipient.md +0 -5
- package/docs/models/InboxUpload.md +2 -3
- package/docs/models/Notification.md +3 -7
- package/docs/models/Permission.md +1 -5
- package/docs/models/RemoteBandwidthSnapshot.md +2 -3
- package/docs/models/SettingsChange.md +3 -5
- package/docs/models/UsageDailySnapshot.md +4 -5
- package/docs/models/User.md +5 -5
- package/lib/Errors.js +713 -699
- package/lib/models/ApiKey.js +2 -3
- package/lib/models/App.js +1 -5
- package/lib/models/As2IncomingMessage.js +2 -3
- package/lib/models/As2OutgoingMessage.js +2 -3
- package/lib/models/As2Partner.js +9 -0
- package/lib/models/Automation.js +6 -7
- package/lib/models/AutomationRun.js +0 -5
- package/lib/models/BandwidthSnapshot.js +2 -3
- package/lib/models/Behavior.js +3 -11
- package/lib/models/Bundle.js +2 -3
- package/lib/models/BundleDownload.js +2 -3
- package/lib/models/BundleNotification.js +5 -3
- package/lib/models/BundleRecipient.js +0 -5
- package/lib/models/ExternalEvent.js +5 -5
- package/lib/models/Group.js +1 -5
- package/lib/models/History.js +1 -5
- package/lib/models/InboxRecipient.js +0 -5
- package/lib/models/InboxUpload.js +2 -3
- package/lib/models/Notification.js +5 -9
- package/lib/models/Permission.js +1 -5
- package/lib/models/RemoteBandwidthSnapshot.js +2 -3
- package/lib/models/SettingsChange.js +17 -8
- package/lib/models/UsageDailySnapshot.js +4 -5
- package/lib/models/User.js +5 -5
- package/package.json +1 -1
- package/src/Errors.js +1 -0
- package/src/models/ApiKey.js +2 -3
- package/src/models/App.js +1 -5
- package/src/models/As2IncomingMessage.js +2 -3
- package/src/models/As2OutgoingMessage.js +2 -3
- package/src/models/As2Partner.js +9 -0
- package/src/models/Automation.js +6 -7
- package/src/models/AutomationRun.js +0 -5
- package/src/models/BandwidthSnapshot.js +2 -3
- package/src/models/Behavior.js +3 -11
- package/src/models/Bundle.js +2 -3
- package/src/models/BundleDownload.js +2 -3
- package/src/models/BundleNotification.js +5 -3
- package/src/models/BundleRecipient.js +0 -5
- package/src/models/ExternalEvent.js +5 -5
- package/src/models/Group.js +1 -5
- package/src/models/History.js +1 -5
- package/src/models/InboxRecipient.js +0 -5
- package/src/models/InboxUpload.js +2 -3
- package/src/models/Notification.js +5 -9
- package/src/models/Permission.js +1 -5
- package/src/models/RemoteBandwidthSnapshot.js +2 -3
- package/src/models/SettingsChange.js +10 -5
- package/src/models/UsageDailySnapshot.js +4 -5
- package/src/models/User.js +5 -5
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.255
|
package/docs/Errors.md
CHANGED
@@ -60,6 +60,7 @@ These errors are derived from the error groups listed above.
|
|
60
60
|
### BadRequest_InvalidEtagsError
|
61
61
|
### BadRequest_InvalidFilterCombinationError
|
62
62
|
### BadRequest_InvalidFilterFieldError
|
63
|
+
### BadRequest_InvalidFilterParamError
|
63
64
|
### BadRequest_InvalidInputEncodingError
|
64
65
|
### BadRequest_InvalidInterfaceError
|
65
66
|
### BadRequest_InvalidOauthProviderError
|
package/docs/models/ApiKey.md
CHANGED
@@ -54,10 +54,9 @@ await ApiKey.list({
|
|
54
54
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[expires_at]=desc`). Valid fields are `expires_at`.
|
55
55
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
56
56
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
|
57
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
58
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `expires_at`.
|
57
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
|
59
58
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
|
60
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
59
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.
|
61
60
|
|
62
61
|
---
|
63
62
|
|
package/docs/models/App.md
CHANGED
@@ -61,8 +61,4 @@ await App.list({
|
|
61
61
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
62
62
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name` and `app_type`.
|
63
63
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
64
|
-
* `
|
65
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
66
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
67
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
68
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
|
64
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
@@ -101,8 +101,7 @@ await As2IncomingMessage.list({
|
|
101
101
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.
|
102
102
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
103
103
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
104
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
105
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
104
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
106
105
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
107
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
106
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
108
107
|
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
@@ -93,8 +93,7 @@ await As2OutgoingMessage.list({
|
|
93
93
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `as2_partner_id`.
|
94
94
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
95
95
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
96
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
97
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
96
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
98
97
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
99
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
98
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
100
99
|
* `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
|
@@ -9,6 +9,7 @@
|
|
9
9
|
"name": "AS2 Partner Name",
|
10
10
|
"uri": "example",
|
11
11
|
"server_certificate": "require_match",
|
12
|
+
"enable_dedicated_ips": true,
|
12
13
|
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
13
14
|
"public_certificate_md5": "example",
|
14
15
|
"public_certificate_subject": "example",
|
@@ -24,6 +25,7 @@
|
|
24
25
|
* `name` (string): The partner's formal AS2 name.
|
25
26
|
* `uri` (string): Public URI for sending AS2 message to.
|
26
27
|
* `server_certificate` (string): Remote server certificate security setting
|
28
|
+
* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
|
27
29
|
* `hex_public_certificate_serial` (string): Serial of public certificate used for message security in hex format.
|
28
30
|
* `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
|
29
31
|
* `public_certificate_subject` (string): Subject of public certificate used for message security.
|
@@ -73,6 +75,7 @@ await As2Partner.create({
|
|
73
75
|
'public_certificate': "public_certificate",
|
74
76
|
'as2_station_id': 1,
|
75
77
|
'server_certificate': "require_match",
|
78
|
+
'enable_dedicated_ips': true,
|
76
79
|
})
|
77
80
|
```
|
78
81
|
|
@@ -84,6 +87,7 @@ await As2Partner.create({
|
|
84
87
|
* `public_certificate` (string): Required -
|
85
88
|
* `as2_station_id` (int64): Required - Id of As2Station for this partner
|
86
89
|
* `server_certificate` (string): Remote server certificate security setting
|
90
|
+
* `enable_dedicated_ips` (boolean):
|
87
91
|
|
88
92
|
---
|
89
93
|
|
@@ -96,6 +100,7 @@ await as2_partner.update({
|
|
96
100
|
'name': "AS2 Partner Name",
|
97
101
|
'uri': "example",
|
98
102
|
'server_certificate': "require_match",
|
103
|
+
'enable_dedicated_ips': true,
|
99
104
|
})
|
100
105
|
```
|
101
106
|
|
@@ -106,6 +111,7 @@ await as2_partner.update({
|
|
106
111
|
* `uri` (string): URL base for AS2 responses
|
107
112
|
* `server_certificate` (string): Remote server certificate security setting
|
108
113
|
* `public_certificate` (string):
|
114
|
+
* `enable_dedicated_ips` (boolean):
|
109
115
|
|
110
116
|
### Example Response
|
111
117
|
|
@@ -116,6 +122,7 @@ await as2_partner.update({
|
|
116
122
|
"name": "AS2 Partner Name",
|
117
123
|
"uri": "example",
|
118
124
|
"server_certificate": "require_match",
|
125
|
+
"enable_dedicated_ips": true,
|
119
126
|
"hex_public_certificate_serial": "A5:EB:C1:95:DC:D8:2B:E7",
|
120
127
|
"public_certificate_md5": "example",
|
121
128
|
"public_certificate_subject": "example",
|
@@ -75,8 +75,8 @@
|
|
75
75
|
```
|
76
76
|
await Automation.list({
|
77
77
|
'per_page': 1,
|
78
|
-
'with_deleted': true,
|
79
78
|
'automation': "create_folder",
|
79
|
+
'with_deleted': true,
|
80
80
|
})
|
81
81
|
```
|
82
82
|
|
@@ -86,14 +86,13 @@ await Automation.list({
|
|
86
86
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
87
87
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
88
88
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled`, `last_modified_at` or `name`.
|
89
|
-
* `
|
90
|
-
* `
|
91
|
-
* `
|
92
|
-
* `
|
93
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `
|
94
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
89
|
+
* `automation` (string): If set, return records where the specified field is equal to the supplied value.
|
90
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
91
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
92
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
93
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
|
94
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `last_modified_at`.
|
95
95
|
* `with_deleted` (boolean): Set to true to include deleted automations in the results.
|
96
|
-
* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
97
96
|
|
98
97
|
---
|
99
98
|
|
@@ -40,11 +40,6 @@ await AutomationRun.list({
|
|
40
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
41
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `status`.
|
42
42
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
43
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `status`.
|
44
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `status`.
|
45
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`.
|
46
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `status`.
|
47
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `status`.
|
48
43
|
* `automation_id` (int64): Required - ID of the associated Automation.
|
49
44
|
|
50
45
|
---
|
@@ -44,7 +44,6 @@ await BandwidthSnapshot.list({
|
|
44
44
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
|
45
45
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
46
46
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
47
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
48
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
47
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
49
48
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
50
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
49
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
package/docs/models/Behavior.md
CHANGED
@@ -43,13 +43,9 @@ await Behavior.list({
|
|
43
43
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
44
44
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
45
45
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior`.
|
46
|
+
* `behavior` (string): If set, return records where the specified field is equal to the supplied value.
|
46
47
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
47
|
-
* `
|
48
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
49
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
50
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
51
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
52
|
-
* `behavior` (string): If set, only shows folder behaviors matching this behavior type.
|
48
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
53
49
|
|
54
50
|
---
|
55
51
|
|
@@ -82,11 +78,7 @@ await Behavior.listFor(path, {
|
|
82
78
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
83
79
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[behavior]=desc`). Valid fields are `behavior`.
|
84
80
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
85
|
-
* `
|
86
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `behavior`.
|
87
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `behavior`.
|
88
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `behavior`.
|
89
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `behavior`.
|
81
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
|
90
82
|
* `path` (string): Required - Path to operate on.
|
91
83
|
* `recursive` (string): Show behaviors above this path?
|
92
84
|
* `behavior` (string): DEPRECATED: If set only shows folder behaviors matching this behavior type. Use `filter[behavior]` instead.
|
package/docs/models/Bundle.md
CHANGED
@@ -94,10 +94,9 @@ await Bundle.list({
|
|
94
94
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at` and `code`.
|
95
95
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
96
96
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
97
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
98
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
97
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
99
98
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
100
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
99
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
101
100
|
|
102
101
|
---
|
103
102
|
|
@@ -36,9 +36,8 @@ await BundleDownload.list({
|
|
36
36
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
|
37
37
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
38
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
|
40
|
-
* `filter_like` (object): If set, return records where the specified field is equal to 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 the supplied value. Valid fields are `created_at`.
|
41
40
|
* `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
|
41
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
43
42
|
* `bundle_id` (int64): Bundle ID
|
44
43
|
* `bundle_registration_id` (int64): BundleRegistration ID
|
@@ -36,7 +36,9 @@ await BundleNotification.list({
|
|
36
36
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
37
37
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
38
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
39
|
-
* `
|
39
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_id]=desc`). Valid fields are `bundle_id`.
|
40
|
+
* `bundle_id` (string): If set, return records where the specified field is equal to the supplied value.
|
41
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
40
42
|
|
41
43
|
---
|
42
44
|
|
@@ -41,11 +41,6 @@ await BundleRecipient.list({
|
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
42
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
|
43
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
44
|
* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
|
50
45
|
|
51
46
|
---
|
@@ -47,11 +47,11 @@ await ExternalEvent.list({
|
|
47
47
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
48
48
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[remote_server_type]=desc`). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
|
49
49
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`. Valid field combinations are `[ event_type, status, created_at ]`, `[ event_type, created_at ]` or `[ status, created_at ]`.
|
50
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at
|
51
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
52
|
-
* `
|
53
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at
|
54
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
50
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
51
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
52
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
|
53
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
54
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
55
55
|
|
56
56
|
---
|
57
57
|
|
package/docs/models/Group.md
CHANGED
@@ -37,11 +37,7 @@ await Group.list({
|
|
37
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
38
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[name]=desc`). Valid fields are `name`.
|
39
39
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
40
|
-
* `
|
41
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `name`.
|
42
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
43
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name`.
|
44
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `name`.
|
40
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
45
41
|
* `ids` (string): Comma-separated list of group ids to include in results.
|
46
42
|
|
47
43
|
---
|
package/docs/models/History.md
CHANGED
@@ -144,8 +144,4 @@ await History.list({
|
|
144
144
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
145
145
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[path]=desc`). Valid fields are `path`, `folder`, `user_id` or `created_at`.
|
146
146
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
147
|
-
* `
|
148
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
149
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
150
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
151
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
|
147
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
@@ -41,11 +41,6 @@ await InboxRecipient.list({
|
|
41
41
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
42
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[has_registrations]=desc`). Valid fields are `has_registrations`.
|
43
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
44
|
* `inbox_id` (int64): Required - List recipients for the inbox with this ID.
|
50
45
|
|
51
46
|
---
|
@@ -34,9 +34,8 @@ await InboxUpload.list({
|
|
34
34
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`.
|
35
35
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
36
36
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
37
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
38
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
37
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
39
38
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
40
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
39
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
41
40
|
* `inbox_registration_id` (int64): InboxRegistration ID
|
42
41
|
* `inbox_id` (int64): Inbox ID
|
@@ -79,13 +79,9 @@ await Notification.list({
|
|
79
79
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
80
80
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
81
81
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[path]=desc`). Valid fields are `path`, `user_id` or `group_id`.
|
82
|
-
* `
|
83
|
-
* `
|
84
|
-
* `
|
85
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
86
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
87
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
|
88
|
-
* `group_id` (int64): DEPRECATED: Show notifications for this Group ID. Use `filter[group_id]` instead.
|
82
|
+
* `group_id` (string): If set, return records where the specified field is equal to the supplied value.
|
83
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`.
|
84
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
89
85
|
* `path` (string): Show notifications for this Path.
|
90
86
|
* `include_ancestors` (boolean): If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
|
91
87
|
|
@@ -45,11 +45,7 @@ await Permission.list({
|
|
45
45
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
46
46
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[group_id]=desc`). Valid fields are `group_id`, `path`, `user_id` or `permission`.
|
47
47
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
48
|
-
* `
|
49
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
50
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
51
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
52
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`. Valid field combinations are `[ group_id, path ]` and `[ user_id, path ]`.
|
48
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
53
49
|
* `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
|
54
50
|
* `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
|
55
51
|
* `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
|
@@ -36,7 +36,6 @@ await RemoteBandwidthSnapshot.list({
|
|
36
36
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[logged_at]=desc`). Valid fields are `logged_at`.
|
37
37
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
38
38
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `logged_at`.
|
39
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
40
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `logged_at`.
|
39
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `logged_at`.
|
41
40
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `logged_at`.
|
42
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
41
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `logged_at`.
|
@@ -27,6 +27,7 @@
|
|
27
27
|
```
|
28
28
|
await SettingsChange.list({
|
29
29
|
'per_page': 1,
|
30
|
+
'user_id': 1,
|
30
31
|
})
|
31
32
|
```
|
32
33
|
|
@@ -36,9 +37,6 @@ await SettingsChange.list({
|
|
36
37
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
37
38
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
38
39
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[api_key_id]=desc`). Valid fields are `api_key_id`, `created_at` or `user_id`.
|
40
|
+
* `api_key_id` (string): If set, return records where the specified field is equal to the supplied value.
|
41
|
+
* `user_id` (string): If set, return records where the specified field is equal to the supplied value.
|
39
42
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
40
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
|
41
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
42
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
43
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
|
44
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
@@ -49,8 +49,7 @@ await UsageDailySnapshot.list({
|
|
49
49
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
50
50
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[date]=desc`). Valid fields are `date` and `usage_snapshot_id`.
|
51
51
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
52
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date
|
53
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
54
|
-
* `
|
55
|
-
* `
|
56
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
|
52
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
|
53
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
|
54
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
|
55
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.
|
package/docs/models/User.md
CHANGED
@@ -155,11 +155,11 @@ await User.list({
|
|
155
155
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
156
156
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[authenticate_until]=desc`). Valid fields are `authenticate_until`, `active`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `site_admin`, `receive_admin_alerts`, `password_validity_days`, `ssl_required` or `not_site_admin`.
|
157
157
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`. Valid field combinations are `[ not_site_admin, username ]`.
|
158
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `
|
159
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal
|
160
|
-
* `
|
161
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `
|
162
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal
|
158
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
159
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
160
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `email` or `company`.
|
161
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
162
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
|
163
163
|
* `ids` (string): comma-separated list of User IDs
|
164
164
|
* `q[username]` (string): List users matching username.
|
165
165
|
* `q[email]` (string): List users matching email.
|