files.com 1.0.229 → 1.0.233

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 64c6eb7553e0596fa681bb44f8e5b307aa5d674e50abef7246fabd2bcd420aa0
4
- data.tar.gz: f1c3505295d41a06fafc09114e4345a24a9bbb67042142dd85a715dc50d25204
3
+ metadata.gz: ede3aa7e5f1afefe4774eed468ad77c1644672e495be9b6bbd78d7fda1f7be4c
4
+ data.tar.gz: 36dc1586e89118de37d151e840dc153c105e323f990381735e8c6a1f60f3c7ff
5
5
  SHA512:
6
- metadata.gz: 43efd46067182e5734c44a21f6b70a06a53d377f0838157d28b1a52bb1c61011f9d5a5531346704d3fdd01c9854d1320bdc7bb404e0046ce2fac5a7f8e71332b
7
- data.tar.gz: d823c245d34aef45d3ba60888d93ba5c4e87919904b6a1242d88b1b24acf472fadcd1023ab586f7775f979894b31370333f3e881d22f9615b21ce0093950ab41
6
+ metadata.gz: 5aabdc3853c077deb4e73d9a750b4d405176b463d46bac52c38e4d274853441556deaec0268d4cbf2268fb36b2ad43066f11d0acd3be0dcd88f0c9f108f68bbc
7
+ data.tar.gz: 80afd6cad7c9d3db169410c97ad9e56937ebadc50f353fb21eda9fded43c2e50fcf184637d6dcd48bde9e54a0a3dc9bcded85378442bbd6988ac7368679eb42b
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.229
1
+ 1.0.233
data/docs/app.md CHANGED
@@ -58,9 +58,9 @@ Files::App.list(
58
58
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
59
59
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
60
60
  * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
61
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
62
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`.
63
- * `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`.
64
- * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
65
- * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
66
- * `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`.
61
+ * `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 ]`.
62
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
63
+ * `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 ]`.
64
+ * `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 ]`.
65
+ * `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 ]`.
66
+ * `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 ]`.
@@ -0,0 +1,55 @@
1
+ # As2IncomingMessage
2
+
3
+ ## Example As2IncomingMessage Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_partner_id": 1,
9
+ "uuid": "",
10
+ "content_type": "",
11
+ "http_headers": "",
12
+ "activity_log": "",
13
+ "processing_result": "",
14
+ "as2_to": "",
15
+ "as2_from": "",
16
+ "message_id": "",
17
+ "subject": "",
18
+ "body_size": "",
19
+ "attachment_filename": "",
20
+ "created_at": "2000-01-01T01:00:00Z"
21
+ }
22
+ ```
23
+
24
+ * `id` (int64): Id of the AS2 Partner.
25
+ * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
26
+ * `uuid` (string): UUID assigned to this message.
27
+ * `content_type` (string): Content Type header of the incoming message.
28
+ * `http_headers` (object): HTTP Headers sent with this message.
29
+ * `activity_log` (string): JSON Structure of the activity log.
30
+ * `processing_result` (string): Result of processing. Valid values: `unable_to_find_station`, `unable_to_find_partner`, `unable_to_validate_signature`, `decrypt_fail`, `file_save_fail`, `success`
31
+ * `as2_to` (string): AS2 TO header of message
32
+ * `as2_from` (string): AS2 FROM header of message
33
+ * `message_id` (string): AS2 Message Id
34
+ * `subject` (string): AS2 Subject Header
35
+ * `body_size` (string): Encrypted Payload Body Size
36
+ * `attachment_filename` (string): Filename of the file being received.
37
+ * `created_at` (date-time): Message creation date/time
38
+
39
+
40
+ ---
41
+
42
+ ## List As2 Incoming Messages
43
+
44
+ ```
45
+ Files::As2IncomingMessage.list(
46
+ per_page: 1,
47
+ as2_partner_id: 1
48
+ )
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
54
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
+ * `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
@@ -0,0 +1,49 @@
1
+ # As2OutgoingMessage
2
+
3
+ ## Example As2OutgoingMessage Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_partner_id": 1,
9
+ "uuid": "",
10
+ "http_headers": "",
11
+ "activity_log": "",
12
+ "processing_result": "",
13
+ "mic": "",
14
+ "message_id": "",
15
+ "body_size": "",
16
+ "attachment_filename": "",
17
+ "created_at": "2000-01-01T01:00:00Z"
18
+ }
19
+ ```
20
+
21
+ * `id` (int64): Id of the AS2 Partner.
22
+ * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
23
+ * `uuid` (string): UUID assigned to this message.
24
+ * `http_headers` (object): HTTP Headers sent with this message.
25
+ * `activity_log` (string): JSON Structure of the activity log.
26
+ * `processing_result` (string): Result of processing. Valid values: `send_failed`, `send_success`
27
+ * `mic` (string): AS2 Message Integrity Check
28
+ * `message_id` (string): AS2 Message Id
29
+ * `body_size` (string): Encrypted Payload Body Size
30
+ * `attachment_filename` (string): Filename of the file being sent.
31
+ * `created_at` (date-time): Message creation date/time
32
+
33
+
34
+ ---
35
+
36
+ ## List As2 Outgoing Messages
37
+
38
+ ```
39
+ Files::As2OutgoingMessage.list(
40
+ per_page: 1,
41
+ as2_partner_id: 1
42
+ )
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
48
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
49
+ * `as2_partner_id` (int64): As2 Partner ID. If provided, will return message specific to that partner.
@@ -0,0 +1,136 @@
1
+ # As2Partner
2
+
3
+ ## Example As2Partner Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "as2_station_id": 1,
9
+ "name": "AS2 Partner Name",
10
+ "uri": "",
11
+ "public_certificate_md5": ""
12
+ }
13
+ ```
14
+
15
+ * `id` (int64): Id of the AS2 Partner.
16
+ * `as2_station_id` (int64): Id of the AS2 Station associated with this partner.
17
+ * `name` (string): The partner's formal AS2 name.
18
+ * `uri` (string): Public URI for sending AS2 message to.
19
+ * `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
20
+ * `public_certificate` (string):
21
+
22
+
23
+ ---
24
+
25
+ ## List As2 Partners
26
+
27
+ ```
28
+ Files::As2Partner.list(
29
+ per_page: 1
30
+ )
31
+ ```
32
+
33
+ ### Parameters
34
+
35
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
36
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
37
+
38
+
39
+ ---
40
+
41
+ ## Show As2 Partner
42
+
43
+ ```
44
+ Files::As2Partner.find(id)
45
+ ```
46
+
47
+ ### Parameters
48
+
49
+ * `id` (int64): Required - As2 Partner ID.
50
+
51
+
52
+ ---
53
+
54
+ ## Create As2 Partner
55
+
56
+ ```
57
+ Files::As2Partner.create(
58
+ name: "name",
59
+ uri: "uri",
60
+ public_certificate: "public_certificate",
61
+ as2_station_id: 1
62
+ )
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ * `name` (string): Required - AS2 Name
68
+ * `uri` (string): Required - URL base for AS2 responses
69
+ * `public_certificate` (string): Required -
70
+ * `as2_station_id` (int64): Required - Id of As2Station for this partner
71
+
72
+
73
+ ---
74
+
75
+ ## Update As2 Partner
76
+
77
+ ```
78
+ Files::As2Partner.update(id,
79
+ name: "AS2 Partner Name"
80
+ )
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+ * `id` (int64): Required - As2 Partner ID.
86
+ * `name` (string): AS2 Name
87
+ * `uri` (string): URL base for AS2 responses
88
+ * `public_certificate` (string):
89
+
90
+
91
+ ---
92
+
93
+ ## Delete As2 Partner
94
+
95
+ ```
96
+ Files::As2Partner.delete(id)
97
+ ```
98
+
99
+ ### Parameters
100
+
101
+ * `id` (int64): Required - As2 Partner ID.
102
+
103
+
104
+ ---
105
+
106
+ ## Update As2 Partner
107
+
108
+ ```
109
+ as2_partner = Files::As2Partner.list.first
110
+
111
+ as2_partner.update(
112
+ name: "AS2 Partner Name"
113
+ )
114
+ ```
115
+
116
+ ### Parameters
117
+
118
+ * `id` (int64): Required - As2 Partner ID.
119
+ * `name` (string): AS2 Name
120
+ * `uri` (string): URL base for AS2 responses
121
+ * `public_certificate` (string):
122
+
123
+
124
+ ---
125
+
126
+ ## Delete As2 Partner
127
+
128
+ ```
129
+ as2_partner = Files::As2Partner.list.first
130
+
131
+ as2_partner.delete
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ * `id` (int64): Required - As2 Partner ID.
@@ -0,0 +1,148 @@
1
+ # As2Station
2
+
3
+ ## Example As2Station Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "name": "AS2 Station Name",
9
+ "uri": "",
10
+ "domain": "domain.test",
11
+ "public_certificate": "",
12
+ "public_certificate_md5": "",
13
+ "private_key_md5": ""
14
+ }
15
+ ```
16
+
17
+ * `id` (int64): Id of the AS2 Station.
18
+ * `name` (string): The station's formal AS2 name.
19
+ * `uri` (string): Public URI for sending AS2 message to.
20
+ * `domain` (string): The station's AS2 domain name.
21
+ * `public_certificate` (string): Public certificate used for message security.
22
+ * `public_certificate_md5` (string): MD5 hash of public certificate used for message security.
23
+ * `private_key_md5` (string): MD5 hash of private key used for message security.
24
+ * `private_key` (string):
25
+
26
+
27
+ ---
28
+
29
+ ## List As2 Stations
30
+
31
+ ```
32
+ Files::As2Station.list(
33
+ per_page: 1
34
+ )
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
40
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
+
42
+
43
+ ---
44
+
45
+ ## Show As2 Station
46
+
47
+ ```
48
+ Files::As2Station.find(id)
49
+ ```
50
+
51
+ ### Parameters
52
+
53
+ * `id` (int64): Required - As2 Station ID.
54
+
55
+
56
+ ---
57
+
58
+ ## Create As2 Station
59
+
60
+ ```
61
+ Files::As2Station.create(
62
+ name: "name",
63
+ domain: "domain",
64
+ uri: "uri",
65
+ public_certificate: "public_certificate",
66
+ private_key: "private_key"
67
+ )
68
+ ```
69
+
70
+ ### Parameters
71
+
72
+ * `name` (string): Required - AS2 Name
73
+ * `domain` (string): Required - AS2 Domain
74
+ * `uri` (string): Required - URL base for AS2 responses
75
+ * `public_certificate` (string): Required -
76
+ * `private_key` (string): Required -
77
+
78
+
79
+ ---
80
+
81
+ ## Update As2 Station
82
+
83
+ ```
84
+ Files::As2Station.update(id,
85
+ name: "AS2 Station Name",
86
+ domain: "domain.test"
87
+ )
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ * `id` (int64): Required - As2 Station ID.
93
+ * `name` (string): AS2 Name
94
+ * `domain` (string): AS2 Domain
95
+ * `uri` (string): URL base for AS2 responses
96
+ * `public_certificate` (string):
97
+ * `private_key` (string):
98
+
99
+
100
+ ---
101
+
102
+ ## Delete As2 Station
103
+
104
+ ```
105
+ Files::As2Station.delete(id)
106
+ ```
107
+
108
+ ### Parameters
109
+
110
+ * `id` (int64): Required - As2 Station ID.
111
+
112
+
113
+ ---
114
+
115
+ ## Update As2 Station
116
+
117
+ ```
118
+ as2_station = Files::As2Station.list.first
119
+
120
+ as2_station.update(
121
+ name: "AS2 Station Name",
122
+ domain: "domain.test"
123
+ )
124
+ ```
125
+
126
+ ### Parameters
127
+
128
+ * `id` (int64): Required - As2 Station ID.
129
+ * `name` (string): AS2 Name
130
+ * `domain` (string): AS2 Domain
131
+ * `uri` (string): URL base for AS2 responses
132
+ * `public_certificate` (string):
133
+ * `private_key` (string):
134
+
135
+
136
+ ---
137
+
138
+ ## Delete As2 Station
139
+
140
+ ```
141
+ as2_station = Files::As2Station.list.first
142
+
143
+ as2_station.delete
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ * `id` (int64): Required - As2 Station ID.
data/docs/automation.md CHANGED
@@ -40,7 +40,6 @@
40
40
  ],
41
41
  "webhook_url": "https://app.files.com/api/webhooks/abc123",
42
42
  "trigger_actions": "[ \"create\" ]",
43
- "trigger_action_path": "path/to/file/or/folder",
44
43
  "value": "{\"limit\": \"1\"}"
45
44
  }
46
45
  ```
@@ -62,7 +61,6 @@
62
61
  * `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
63
62
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
64
63
  * `trigger_actions` (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
65
- * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
66
64
  * `value` (object): A Hash of attributes specific to the automation type.
67
65
  * `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
68
66
 
@@ -120,7 +118,6 @@ Files::Automation.create(
120
118
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
121
119
  trigger: "realtime",
122
120
  trigger_actions: "[ \"create\" ]",
123
- trigger_action_path: "path/to/file/or/folder",
124
121
  value: "{\"limit\": \"1\"}"
125
122
  )
126
123
  ```
@@ -142,7 +139,6 @@ Files::Automation.create(
142
139
  * `name` (string): Name for this automation.
143
140
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
144
141
  * `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
145
- * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
146
142
  * `value` (object): A Hash of attributes specific to the automation type.
147
143
 
148
144
 
@@ -161,7 +157,6 @@ Files::Automation.update(id,
161
157
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
162
158
  trigger: "realtime",
163
159
  trigger_actions: "[ \"create\" ]",
164
- trigger_action_path: "path/to/file/or/folder",
165
160
  value: "{\"limit\": \"1\"}"
166
161
  )
167
162
  ```
@@ -184,7 +179,6 @@ Files::Automation.update(id,
184
179
  * `name` (string): Name for this automation.
185
180
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
186
181
  * `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
187
- * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
188
182
  * `value` (object): A Hash of attributes specific to the automation type.
189
183
 
190
184
 
@@ -218,7 +212,6 @@ automation.update(
218
212
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
219
213
  trigger: "realtime",
220
214
  trigger_actions: "[ \"create\" ]",
221
- trigger_action_path: "path/to/file/or/folder",
222
215
  value: "{\"limit\": \"1\"}"
223
216
  )
224
217
  ```
@@ -241,7 +234,6 @@ automation.update(
241
234
  * `name` (string): Name for this automation.
242
235
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
243
236
  * `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
244
- * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
245
237
  * `value` (object): A Hash of attributes specific to the automation type.
246
238
 
247
239
 
@@ -46,12 +46,12 @@ Files::ExternalEvent.list(
46
46
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
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`.
50
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
51
- * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
52
- * `filter_like` (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`.
53
- * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
54
- * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `folder_behavior_id`.
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`, `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 ]`.
51
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `created_at`, `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 ]`.
52
+ * `filter_like` (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 ]`.
53
+ * `filter_lt` (object): If set, return records where the specified field is less than 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 ]`.
54
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `created_at`, `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 ]`.
55
55
 
56
56
 
57
57
  ---
data/docs/folder.md CHANGED
@@ -67,7 +67,7 @@ Files::Folder.list_for(path,
67
67
 
68
68
  ### Parameters
69
69
 
70
- * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor header.
70
+ * `cursor` (string): Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
71
71
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
72
72
  * `path` (string): Required - Path to operate on.
73
73
  * `filter` (string): If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
@@ -38,7 +38,7 @@
38
38
  * `end_at` (date-time): End date/time of export range.
39
39
  * `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
40
40
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
41
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
41
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
42
42
  * `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
43
43
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
44
44
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -110,7 +110,7 @@ Files::HistoryExport.create(
110
110
  * `start_at` (string): Start date/time of export range.
111
111
  * `end_at` (string): End date/time of export range.
112
112
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
113
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
113
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
114
114
  * `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
115
115
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
116
116
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -43,7 +43,7 @@
43
43
  * `username` (string): Username of the user that performed the action
44
44
  * `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
45
45
  * `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`
46
- * `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`
46
+ * `interface` (string): Inteface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`
47
47
  * `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
48
48
  * `target_name` (string): Name of the User, Group or other object with a name related to this action
49
49
  * `target_permission` (string): Permission level of the action
data/docs/permission.md CHANGED
@@ -43,12 +43,12 @@ Files::Permission.list(
43
43
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
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[last_login_at]=desc). Valid fields are `group_id`, `path`, `user_id` or `permission`.
46
- * `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`.
47
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
48
- * `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`.
49
- * `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`.
50
- * `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`.
51
- * `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`.
46
+ * `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 ]`.
47
+ * `filter_gt` (object): If set, return records where the specified field is greater than 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_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 ]`.
49
+ * `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 ]`.
50
+ * `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 ]`.
51
+ * `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 ]`.
52
52
  * `path` (string): DEPRECATED: Permission path. If provided, will scope permissions to this path. Use `filter[path]` instead.
53
53
  * `group_id` (string): DEPRECATED: Group ID. If provided, will scope permissions to this group. Use `filter[group_id]` instead.`
54
54
  * `user_id` (string): DEPRECATED: User ID. If provided, will scope permissions to this user. Use `filter[user_id]` instead.`
@@ -34,9 +34,9 @@ Files::UsageDailySnapshot.list(
34
34
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
35
35
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
36
  * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `date` and `usage_snapshot_id`.
37
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
38
- * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
39
- * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
40
- * `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
41
- * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
42
- * `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`.
37
+ * `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 ]`.
38
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
39
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
40
+ * `filter_like` (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 ]`.
41
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`. Valid field combinations are `[ usage_snapshot_id, date ]`.
42
+ * `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 ]`.
data/docs/user.md CHANGED
@@ -132,12 +132,12 @@ Files::User.list(
132
132
  * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
133
133
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
134
134
  * `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `authenticate_until`, `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`.
135
- * `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`.
136
- * `filter_gt` (object): If set, return records where the specified field is greater than 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`.
137
- * `filter_gteq` (object): If set, return records where the specified field is greater than or 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`.
138
- * `filter_like` (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`.
139
- * `filter_lt` (object): If set, return records where the specified field is less than 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`.
140
- * `filter_lteq` (object): If set, return records where the specified field is less than or 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`.
135
+ * `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 ]`.
136
+ * `filter_gt` (object): If set, return records where the specified field is greater than 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 ]`.
137
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or 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 ]`.
138
+ * `filter_like` (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 ]`.
139
+ * `filter_lt` (object): If set, return records where the specified field is less than 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 ]`.
140
+ * `filter_lteq` (object): If set, return records where the specified field is less than or 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 ]`.
141
141
  * `ids` (string): comma-separated list of User IDs
142
142
  * `q[username]` (string): List users matching username.
143
143
  * `q[email]` (string): List users matching email.
@@ -161,6 +161,7 @@ module Files
161
161
  class DestinationFolderLimitedError < ProcessingFailureError; end
162
162
  class DestinationParentConflictError < ProcessingFailureError; end
163
163
  class DestinationParentDoesNotExistError < ProcessingFailureError; end
164
+ class ExpiredPrivateKeyError < ProcessingFailureError; end
164
165
  class ExpiredPublicKeyError < ProcessingFailureError; end
165
166
  class ExportFailureError < ProcessingFailureError; end
166
167
  class ExportNotReadyError < ProcessingFailureError; end
@@ -93,12 +93,12 @@ module Files
93
93
  # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
94
94
  # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
95
95
  # sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
96
- # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
97
- # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`.
98
- # 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`.
99
- # filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `app_type`.
100
- # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `name` and `app_type`.
101
- # 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`.
96
+ # 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 ]`.
97
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `name` and `app_type`. Valid field combinations are `[ name, app_type ]` and `[ app_type, name ]`.
98
+ # 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 ]`.
99
+ # 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 ]`.
100
+ # 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 ]`.
101
+ # 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 ]`.
102
102
  def self.list(params = {}, options = {})
103
103
  raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
104
104
  raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)