files.com 1.0.267 → 1.0.268
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/automation.md +25 -16
- data/docs/folder.md +1 -1
- data/docs/notification.md +74 -3
- data/docs/remote_server.md +8 -0
- data/lib/files.com/models/automation.rb +43 -15
- data/lib/files.com/models/folder.rb +1 -1
- data/lib/files.com/models/notification.rb +106 -1
- data/lib/files.com/models/remote_server.rb +15 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9aaac0a72187e07267bca7599b5d567712da481258f4290c62742117ead578c7
|
|
4
|
+
data.tar.gz: e72bfb5197f69b290ec8bc083612922835473508e7697634816908ee3fc0bf99
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 682919c9eb1833fbec37bc338c25bd5eca35803b7db2b5cdd372d92d8db2fa3e2b41a8ba3217d95b15937e2638cdf036cd769e7810d2164dfc14e3d0c8e8d6fc
|
|
7
|
+
data.tar.gz: 893d7cb79a3a60d3d4922dc74dd7324d203bf60663399e6c392612dc61f62713faf1ab7b7973072f4f2e013bfdf261405b06f87118cd8d5a0f47014f8ad84702
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.268
|
data/docs/automation.md
CHANGED
|
@@ -6,9 +6,11 @@
|
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
8
|
"automation": "create_folder",
|
|
9
|
+
"deleted": true,
|
|
9
10
|
"disabled": true,
|
|
10
11
|
"trigger": "realtime",
|
|
11
12
|
"interval": "week",
|
|
13
|
+
"last_modified_at": "2000-01-01T01:00:00Z",
|
|
12
14
|
"name": "",
|
|
13
15
|
"schedule": {
|
|
14
16
|
"days_of_week": [
|
|
@@ -47,9 +49,11 @@
|
|
|
47
49
|
|
|
48
50
|
* `id` (int64): Automation ID
|
|
49
51
|
* `automation` (string): Automation type
|
|
52
|
+
* `deleted` (boolean): Indicates if the automation has been deleted.
|
|
50
53
|
* `disabled` (boolean): If true, this automation will not run.
|
|
51
54
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
52
55
|
* `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
|
56
|
+
* `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
|
|
53
57
|
* `name` (string): Name for this automation.
|
|
54
58
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
|
55
59
|
* `source` (string): Source Path
|
|
@@ -65,6 +69,7 @@
|
|
|
65
69
|
* `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
|
|
66
70
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
67
71
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
72
|
+
* `cloned_from` (int64): Set to the ID of automation used a clone template. For
|
|
68
73
|
|
|
69
74
|
|
|
70
75
|
---
|
|
@@ -74,6 +79,7 @@
|
|
|
74
79
|
```
|
|
75
80
|
Files::Automation.list(
|
|
76
81
|
per_page: 1,
|
|
82
|
+
with_deleted: true,
|
|
77
83
|
automation: "create_folder"
|
|
78
84
|
)
|
|
79
85
|
```
|
|
@@ -82,13 +88,14 @@ Files::Automation.list(
|
|
|
82
88
|
|
|
83
89
|
* `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.
|
|
84
90
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
85
|
-
* `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 `automation`.
|
|
86
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
|
87
|
-
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`.
|
|
88
|
-
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`.
|
|
89
|
-
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
|
90
|
-
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`.
|
|
91
|
-
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`.
|
|
91
|
+
* `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 `automation`, `last_modified_at` or `disabled`.
|
|
92
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
93
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
94
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
95
|
+
* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
96
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
97
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
98
|
+
* `with_deleted` (boolean): Set to true to include deleted automations in the results.
|
|
92
99
|
* `automation` (string): DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
|
93
100
|
|
|
94
101
|
|
|
@@ -111,7 +118,6 @@ Files::Automation.find(id)
|
|
|
111
118
|
|
|
112
119
|
```
|
|
113
120
|
Files::Automation.create(
|
|
114
|
-
automation: "create_folder",
|
|
115
121
|
source: "source",
|
|
116
122
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
|
117
123
|
interval: "year",
|
|
@@ -121,13 +127,14 @@ Files::Automation.create(
|
|
|
121
127
|
disabled: true,
|
|
122
128
|
trigger: "realtime",
|
|
123
129
|
trigger_actions: "[ \"create\" ]",
|
|
124
|
-
value: "{\"limit\": \"1\"}"
|
|
130
|
+
value: "{\"limit\": \"1\"}",
|
|
131
|
+
automation: "create_folder",
|
|
132
|
+
cloned_from: 1
|
|
125
133
|
)
|
|
126
134
|
```
|
|
127
135
|
|
|
128
136
|
### Parameters
|
|
129
137
|
|
|
130
|
-
* `automation` (string): Required - Automation type
|
|
131
138
|
* `source` (string): Source Path
|
|
132
139
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
133
140
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -144,6 +151,8 @@ Files::Automation.create(
|
|
|
144
151
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
145
152
|
* `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
|
|
146
153
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
154
|
+
* `automation` (string): Required - Automation type
|
|
155
|
+
* `cloned_from` (int64): Set to the ID of automation used a clone template. For
|
|
147
156
|
|
|
148
157
|
|
|
149
158
|
---
|
|
@@ -152,7 +161,6 @@ Files::Automation.create(
|
|
|
152
161
|
|
|
153
162
|
```
|
|
154
163
|
Files::Automation.update(id,
|
|
155
|
-
automation: "create_folder",
|
|
156
164
|
source: "source",
|
|
157
165
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
|
158
166
|
interval: "year",
|
|
@@ -162,14 +170,14 @@ Files::Automation.update(id,
|
|
|
162
170
|
disabled: true,
|
|
163
171
|
trigger: "realtime",
|
|
164
172
|
trigger_actions: "[ \"create\" ]",
|
|
165
|
-
value: "{\"limit\": \"1\"}"
|
|
173
|
+
value: "{\"limit\": \"1\"}",
|
|
174
|
+
automation: "create_folder"
|
|
166
175
|
)
|
|
167
176
|
```
|
|
168
177
|
|
|
169
178
|
### Parameters
|
|
170
179
|
|
|
171
180
|
* `id` (int64): Required - Automation ID.
|
|
172
|
-
* `automation` (string): Required - Automation type
|
|
173
181
|
* `source` (string): Source Path
|
|
174
182
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
175
183
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -186,6 +194,7 @@ Files::Automation.update(id,
|
|
|
186
194
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
187
195
|
* `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
|
|
188
196
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
197
|
+
* `automation` (string): Automation type
|
|
189
198
|
|
|
190
199
|
|
|
191
200
|
---
|
|
@@ -209,7 +218,6 @@ Files::Automation.delete(id)
|
|
|
209
218
|
automation = Files::Automation.list.first
|
|
210
219
|
|
|
211
220
|
automation.update(
|
|
212
|
-
automation: "create_folder",
|
|
213
221
|
source: "source",
|
|
214
222
|
destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
|
|
215
223
|
interval: "year",
|
|
@@ -219,14 +227,14 @@ automation.update(
|
|
|
219
227
|
disabled: true,
|
|
220
228
|
trigger: "realtime",
|
|
221
229
|
trigger_actions: "[ \"create\" ]",
|
|
222
|
-
value: "{\"limit\": \"1\"}"
|
|
230
|
+
value: "{\"limit\": \"1\"}",
|
|
231
|
+
automation: "create_folder"
|
|
223
232
|
)
|
|
224
233
|
```
|
|
225
234
|
|
|
226
235
|
### Parameters
|
|
227
236
|
|
|
228
237
|
* `id` (int64): Required - Automation ID.
|
|
229
|
-
* `automation` (string): Required - Automation type
|
|
230
238
|
* `source` (string): Source Path
|
|
231
239
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
232
240
|
* `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -243,6 +251,7 @@ automation.update(
|
|
|
243
251
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
244
252
|
* `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
|
|
245
253
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
254
|
+
* `automation` (string): Automation type
|
|
246
255
|
|
|
247
256
|
|
|
248
257
|
---
|
data/docs/folder.md
CHANGED
|
@@ -74,7 +74,7 @@ Files::Folder.list_for(path,
|
|
|
74
74
|
* `filter` (string): If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
|
75
75
|
* `preview_size` (string): Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
76
76
|
* `search` (string): If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
|
|
77
|
-
* `search_all` (boolean): Search entire site?
|
|
77
|
+
* `search_all` (boolean): Search entire site? If set, we will ignore the folder path provided and search the entire site. This is the same API used by the search bar in the UI. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
|
|
78
78
|
* `with_previews` (boolean): Include file previews?
|
|
79
79
|
* `with_priority_color` (boolean): Include file priority color information?
|
|
80
80
|
|
data/docs/notification.md
CHANGED
|
@@ -8,11 +8,26 @@
|
|
|
8
8
|
"path": "",
|
|
9
9
|
"group_id": 1,
|
|
10
10
|
"group_name": "",
|
|
11
|
+
"triggering_group_ids": [
|
|
12
|
+
1
|
|
13
|
+
],
|
|
14
|
+
"triggering_user_ids": [
|
|
15
|
+
1
|
|
16
|
+
],
|
|
17
|
+
"trigger_by_share_recipients": true,
|
|
11
18
|
"notify_user_actions": true,
|
|
12
19
|
"notify_on_copy": true,
|
|
20
|
+
"notify_on_delete": true,
|
|
21
|
+
"notify_on_download": true,
|
|
22
|
+
"notify_on_move": true,
|
|
23
|
+
"notify_on_upload": true,
|
|
13
24
|
"recursive": true,
|
|
14
25
|
"send_interval": "fifteen_minutes",
|
|
15
26
|
"message": "custom notification email message",
|
|
27
|
+
"triggering_filenames": [
|
|
28
|
+
"*.jpg",
|
|
29
|
+
"notify_file.txt"
|
|
30
|
+
],
|
|
16
31
|
"unsubscribed": true,
|
|
17
32
|
"unsubscribed_reason": "",
|
|
18
33
|
"user_id": 1,
|
|
@@ -25,11 +40,19 @@
|
|
|
25
40
|
* `path` (string): Folder path to notify on This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
26
41
|
* `group_id` (int64): Notification group id
|
|
27
42
|
* `group_name` (string): Group name if applicable
|
|
43
|
+
* `triggering_group_ids` (int64): Only notify on actions made by a member of one of the specified groups
|
|
44
|
+
* `triggering_user_ids` (int64): Only notify on actions made one of the specified users
|
|
45
|
+
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
28
46
|
* `notify_user_actions` (boolean): Trigger notification on notification user actions?
|
|
29
|
-
* `notify_on_copy` (boolean): Triggers notification when
|
|
47
|
+
* `notify_on_copy` (boolean): Triggers notification when copying files to this path
|
|
48
|
+
* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
|
|
49
|
+
* `notify_on_download` (boolean): Triggers notification when downloading files from this path
|
|
50
|
+
* `notify_on_move` (boolean): Triggers notification when moving files to this path
|
|
51
|
+
* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
|
|
30
52
|
* `recursive` (boolean): Enable notifications for each subfolder in this path
|
|
31
53
|
* `send_interval` (string): The time interval that notifications are aggregated to
|
|
32
54
|
* `message` (string): Custom message to include in notification emails.
|
|
55
|
+
* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to match for action path
|
|
33
56
|
* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
|
|
34
57
|
* `unsubscribed_reason` (string): The reason that the user unsubscribed
|
|
35
58
|
* `user_id` (int64): Notification user ID
|
|
@@ -88,10 +111,18 @@ Files::Notification.find(id)
|
|
|
88
111
|
Files::Notification.create(
|
|
89
112
|
user_id: 1,
|
|
90
113
|
notify_on_copy: true,
|
|
114
|
+
notify_on_delete: true,
|
|
115
|
+
notify_on_download: true,
|
|
116
|
+
notify_on_move: true,
|
|
117
|
+
notify_on_upload: true,
|
|
91
118
|
notify_user_actions: true,
|
|
92
119
|
recursive: true,
|
|
93
120
|
send_interval: "daily",
|
|
94
121
|
message: "custom notification email message",
|
|
122
|
+
triggering_filenames: ["*.jpg","notify_file.txt"],
|
|
123
|
+
triggering_group_ids: [1],
|
|
124
|
+
triggering_user_ids: [1],
|
|
125
|
+
trigger_by_share_recipients: true,
|
|
95
126
|
group_id: 1,
|
|
96
127
|
username: "User"
|
|
97
128
|
)
|
|
@@ -101,10 +132,18 @@ Files::Notification.create(
|
|
|
101
132
|
|
|
102
133
|
* `user_id` (int64): The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
|
103
134
|
* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
135
|
+
* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
|
|
136
|
+
* `notify_on_download` (boolean): Triggers notification when downloading files from this path
|
|
137
|
+
* `notify_on_move` (boolean): Triggers notification when moving files to this path
|
|
138
|
+
* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
|
|
104
139
|
* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
|
|
105
140
|
* `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
|
|
106
141
|
* `send_interval` (string): The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
107
142
|
* `message` (string): Custom message to include in notification emails.
|
|
143
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to match for action path
|
|
144
|
+
* `triggering_group_ids` (array(int64)): Only notify on actions made by a member of one of the specified groups
|
|
145
|
+
* `triggering_user_ids` (array(int64)): Only notify on actions made one of the specified users
|
|
146
|
+
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
108
147
|
* `group_id` (int64): The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
|
109
148
|
* `path` (string): Path
|
|
110
149
|
* `username` (string): The username of the user to notify. Provide `user_id`, `username` or `group_id`.
|
|
@@ -117,10 +156,18 @@ Files::Notification.create(
|
|
|
117
156
|
```
|
|
118
157
|
Files::Notification.update(id,
|
|
119
158
|
notify_on_copy: true,
|
|
159
|
+
notify_on_delete: true,
|
|
160
|
+
notify_on_download: true,
|
|
161
|
+
notify_on_move: true,
|
|
162
|
+
notify_on_upload: true,
|
|
120
163
|
notify_user_actions: true,
|
|
121
164
|
recursive: true,
|
|
122
165
|
send_interval: "daily",
|
|
123
|
-
message: "custom notification email message"
|
|
166
|
+
message: "custom notification email message",
|
|
167
|
+
triggering_filenames: ["*.jpg","notify_file.txt"],
|
|
168
|
+
triggering_group_ids: [1],
|
|
169
|
+
triggering_user_ids: [1],
|
|
170
|
+
trigger_by_share_recipients: true
|
|
124
171
|
)
|
|
125
172
|
```
|
|
126
173
|
|
|
@@ -128,10 +175,18 @@ Files::Notification.update(id,
|
|
|
128
175
|
|
|
129
176
|
* `id` (int64): Required - Notification ID.
|
|
130
177
|
* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
178
|
+
* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
|
|
179
|
+
* `notify_on_download` (boolean): Triggers notification when downloading files from this path
|
|
180
|
+
* `notify_on_move` (boolean): Triggers notification when moving files to this path
|
|
181
|
+
* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
|
|
131
182
|
* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
|
|
132
183
|
* `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
|
|
133
184
|
* `send_interval` (string): The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
134
185
|
* `message` (string): Custom message to include in notification emails.
|
|
186
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to match for action path
|
|
187
|
+
* `triggering_group_ids` (array(int64)): Only notify on actions made by a member of one of the specified groups
|
|
188
|
+
* `triggering_user_ids` (array(int64)): Only notify on actions made one of the specified users
|
|
189
|
+
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
135
190
|
|
|
136
191
|
|
|
137
192
|
---
|
|
@@ -156,10 +211,18 @@ notification = Files::Notification.list.first
|
|
|
156
211
|
|
|
157
212
|
notification.update(
|
|
158
213
|
notify_on_copy: true,
|
|
214
|
+
notify_on_delete: true,
|
|
215
|
+
notify_on_download: true,
|
|
216
|
+
notify_on_move: true,
|
|
217
|
+
notify_on_upload: true,
|
|
159
218
|
notify_user_actions: true,
|
|
160
219
|
recursive: true,
|
|
161
220
|
send_interval: "daily",
|
|
162
|
-
message: "custom notification email message"
|
|
221
|
+
message: "custom notification email message",
|
|
222
|
+
triggering_filenames: ["*.jpg","notify_file.txt"],
|
|
223
|
+
triggering_group_ids: [1],
|
|
224
|
+
triggering_user_ids: [1],
|
|
225
|
+
trigger_by_share_recipients: true
|
|
163
226
|
)
|
|
164
227
|
```
|
|
165
228
|
|
|
@@ -167,10 +230,18 @@ notification.update(
|
|
|
167
230
|
|
|
168
231
|
* `id` (int64): Required - Notification ID.
|
|
169
232
|
* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
233
|
+
* `notify_on_delete` (boolean): Triggers notification when deleting files from this path
|
|
234
|
+
* `notify_on_download` (boolean): Triggers notification when downloading files from this path
|
|
235
|
+
* `notify_on_move` (boolean): Triggers notification when moving files to this path
|
|
236
|
+
* `notify_on_upload` (boolean): Triggers notification when uploading new files to this path
|
|
170
237
|
* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
|
|
171
238
|
* `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
|
|
172
239
|
* `send_interval` (string): The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
173
240
|
* `message` (string): Custom message to include in notification emails.
|
|
241
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to match for action path
|
|
242
|
+
* `triggering_group_ids` (array(int64)): Only notify on actions made by a member of one of the specified groups
|
|
243
|
+
* `triggering_user_ids` (array(int64)): Only notify on actions made one of the specified users
|
|
244
|
+
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
174
245
|
|
|
175
246
|
|
|
176
247
|
---
|
data/docs/remote_server.md
CHANGED
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
"auth_account_name": "me@example.com",
|
|
36
36
|
"one_drive_account_type": "personal",
|
|
37
37
|
"azure_blob_storage_account": "storage-account-name",
|
|
38
|
+
"azure_blob_storage_sas_token": "storage-sas-token",
|
|
38
39
|
"azure_blob_storage_container": "container-name",
|
|
39
40
|
"s3_compatible_bucket": "my-bucket",
|
|
40
41
|
"s3_compatible_endpoint": "mys3platform.com",
|
|
@@ -75,6 +76,7 @@
|
|
|
75
76
|
* `auth_account_name` (string): Describes the authorized account
|
|
76
77
|
* `one_drive_account_type` (string): Either personal or business_other account types
|
|
77
78
|
* `azure_blob_storage_account` (string): Azure Blob Storage Account name
|
|
79
|
+
* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
|
|
78
80
|
* `azure_blob_storage_container` (string): Azure Blob Storage Container name
|
|
79
81
|
* `s3_compatible_bucket` (string): S3-compatible Bucket name
|
|
80
82
|
* `s3_compatible_endpoint` (string): S3-compatible endpoint
|
|
@@ -154,6 +156,7 @@ Files::RemoteServer.create(
|
|
|
154
156
|
one_drive_account_type: "personal",
|
|
155
157
|
azure_blob_storage_account: "storage-account-name",
|
|
156
158
|
azure_blob_storage_container: "container-name",
|
|
159
|
+
azure_blob_storage_sas_token: "storage-sas-token",
|
|
157
160
|
s3_compatible_bucket: "my-bucket",
|
|
158
161
|
s3_compatible_endpoint: "mys3platform.com",
|
|
159
162
|
s3_compatible_region: "us-east-1",
|
|
@@ -199,6 +202,7 @@ Files::RemoteServer.create(
|
|
|
199
202
|
* `one_drive_account_type` (string): Either personal or business_other account types
|
|
200
203
|
* `azure_blob_storage_account` (string): Azure Blob Storage Account name
|
|
201
204
|
* `azure_blob_storage_container` (string): Azure Blob Storage Container name
|
|
205
|
+
* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
|
|
202
206
|
* `s3_compatible_bucket` (string): S3-compatible Bucket name
|
|
203
207
|
* `s3_compatible_endpoint` (string): S3-compatible endpoint
|
|
204
208
|
* `s3_compatible_region` (string): S3-compatible endpoint
|
|
@@ -237,6 +241,7 @@ Files::RemoteServer.update(id,
|
|
|
237
241
|
one_drive_account_type: "personal",
|
|
238
242
|
azure_blob_storage_account: "storage-account-name",
|
|
239
243
|
azure_blob_storage_container: "container-name",
|
|
244
|
+
azure_blob_storage_sas_token: "storage-sas-token",
|
|
240
245
|
s3_compatible_bucket: "my-bucket",
|
|
241
246
|
s3_compatible_endpoint: "mys3platform.com",
|
|
242
247
|
s3_compatible_region: "us-east-1",
|
|
@@ -283,6 +288,7 @@ Files::RemoteServer.update(id,
|
|
|
283
288
|
* `one_drive_account_type` (string): Either personal or business_other account types
|
|
284
289
|
* `azure_blob_storage_account` (string): Azure Blob Storage Account name
|
|
285
290
|
* `azure_blob_storage_container` (string): Azure Blob Storage Container name
|
|
291
|
+
* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
|
|
286
292
|
* `s3_compatible_bucket` (string): S3-compatible Bucket name
|
|
287
293
|
* `s3_compatible_endpoint` (string): S3-compatible endpoint
|
|
288
294
|
* `s3_compatible_region` (string): S3-compatible endpoint
|
|
@@ -336,6 +342,7 @@ remote_server.update(
|
|
|
336
342
|
one_drive_account_type: "personal",
|
|
337
343
|
azure_blob_storage_account: "storage-account-name",
|
|
338
344
|
azure_blob_storage_container: "container-name",
|
|
345
|
+
azure_blob_storage_sas_token: "storage-sas-token",
|
|
339
346
|
s3_compatible_bucket: "my-bucket",
|
|
340
347
|
s3_compatible_endpoint: "mys3platform.com",
|
|
341
348
|
s3_compatible_region: "us-east-1",
|
|
@@ -382,6 +389,7 @@ remote_server.update(
|
|
|
382
389
|
* `one_drive_account_type` (string): Either personal or business_other account types
|
|
383
390
|
* `azure_blob_storage_account` (string): Azure Blob Storage Account name
|
|
384
391
|
* `azure_blob_storage_container` (string): Azure Blob Storage Container name
|
|
392
|
+
* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
|
|
385
393
|
* `s3_compatible_bucket` (string): S3-compatible Bucket name
|
|
386
394
|
* `s3_compatible_endpoint` (string): S3-compatible endpoint
|
|
387
395
|
* `s3_compatible_region` (string): S3-compatible endpoint
|
|
@@ -27,6 +27,15 @@ module Files
|
|
|
27
27
|
@attributes[:automation] = value
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
+
# boolean - Indicates if the automation has been deleted.
|
|
31
|
+
def deleted
|
|
32
|
+
@attributes[:deleted]
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def deleted=(value)
|
|
36
|
+
@attributes[:deleted] = value
|
|
37
|
+
end
|
|
38
|
+
|
|
30
39
|
# boolean - If true, this automation will not run.
|
|
31
40
|
def disabled
|
|
32
41
|
@attributes[:disabled]
|
|
@@ -54,6 +63,15 @@ module Files
|
|
|
54
63
|
@attributes[:interval] = value
|
|
55
64
|
end
|
|
56
65
|
|
|
66
|
+
# date-time - Time when automation was last modified. Does not change for name or description updates.
|
|
67
|
+
def last_modified_at
|
|
68
|
+
@attributes[:last_modified_at]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def last_modified_at=(value)
|
|
72
|
+
@attributes[:last_modified_at] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
57
75
|
# string - Name for this automation.
|
|
58
76
|
def name
|
|
59
77
|
@attributes[:name]
|
|
@@ -189,8 +207,16 @@ module Files
|
|
|
189
207
|
@attributes[:destination] = value
|
|
190
208
|
end
|
|
191
209
|
|
|
210
|
+
# int64 - Set to the ID of automation used a clone template. For
|
|
211
|
+
def cloned_from
|
|
212
|
+
@attributes[:cloned_from]
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
def cloned_from=(value)
|
|
216
|
+
@attributes[:cloned_from] = value
|
|
217
|
+
end
|
|
218
|
+
|
|
192
219
|
# Parameters:
|
|
193
|
-
# automation (required) - string - Automation type
|
|
194
220
|
# source - string - Source Path
|
|
195
221
|
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
|
196
222
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -207,12 +233,12 @@ module Files
|
|
|
207
233
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
208
234
|
# 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
|
|
209
235
|
# value - object - A Hash of attributes specific to the automation type.
|
|
236
|
+
# automation - string - Automation type
|
|
210
237
|
def update(params = {})
|
|
211
238
|
params ||= {}
|
|
212
239
|
params[:id] = @attributes[:id]
|
|
213
240
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
214
241
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
|
215
|
-
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
216
242
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
|
|
217
243
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
|
|
218
244
|
raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
|
|
@@ -226,8 +252,8 @@ module Files
|
|
|
226
252
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
227
253
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
228
254
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
255
|
+
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
229
256
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
230
|
-
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
231
257
|
|
|
232
258
|
Api.send_request("/automations/#{@attributes[:id]}", :patch, params, @options)
|
|
233
259
|
end
|
|
@@ -258,13 +284,14 @@ module Files
|
|
|
258
284
|
# Parameters:
|
|
259
285
|
# 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.
|
|
260
286
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
261
|
-
# 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 `automation`.
|
|
262
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
|
263
|
-
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`.
|
|
264
|
-
# filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`.
|
|
265
|
-
# filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`.
|
|
266
|
-
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `automation`.
|
|
267
|
-
# filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`.
|
|
287
|
+
# 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 `automation`, `last_modified_at` or `disabled`.
|
|
288
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
289
|
+
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
290
|
+
# filter_gteq - object - If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
291
|
+
# filter_like - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
292
|
+
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
293
|
+
# filter_lteq - object - If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `automation`, `last_modified_at` or `disabled`. Valid field combinations are `[ disabled, automation ]`.
|
|
294
|
+
# with_deleted - boolean - Set to true to include deleted automations in the results.
|
|
268
295
|
# automation - string - DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
|
269
296
|
def self.list(params = {}, options = {})
|
|
270
297
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
|
@@ -304,7 +331,6 @@ module Files
|
|
|
304
331
|
end
|
|
305
332
|
|
|
306
333
|
# Parameters:
|
|
307
|
-
# automation (required) - string - Automation type
|
|
308
334
|
# source - string - Source Path
|
|
309
335
|
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
|
310
336
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -321,8 +347,9 @@ module Files
|
|
|
321
347
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
322
348
|
# 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
|
|
323
349
|
# value - object - A Hash of attributes specific to the automation type.
|
|
350
|
+
# automation (required) - string - Automation type
|
|
351
|
+
# cloned_from - int64 - Set to the ID of automation used a clone template. For
|
|
324
352
|
def self.create(params = {}, options = {})
|
|
325
|
-
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
326
353
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
|
|
327
354
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
|
|
328
355
|
raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
|
|
@@ -338,6 +365,8 @@ module Files
|
|
|
338
365
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
339
366
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
340
367
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
|
|
368
|
+
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
369
|
+
raise InvalidParameterError.new("Bad parameter: cloned_from must be an Integer") if params.dig(:cloned_from) and !params.dig(:cloned_from).is_a?(Integer)
|
|
341
370
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
342
371
|
|
|
343
372
|
response, options = Api.send_request("/automations", :post, params, options)
|
|
@@ -345,7 +374,6 @@ module Files
|
|
|
345
374
|
end
|
|
346
375
|
|
|
347
376
|
# Parameters:
|
|
348
|
-
# automation (required) - string - Automation type
|
|
349
377
|
# source - string - Source Path
|
|
350
378
|
# destination - string - DEPRECATED: Destination Path. Use `destinations` instead.
|
|
351
379
|
# destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
|
|
@@ -362,11 +390,11 @@ module Files
|
|
|
362
390
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
363
391
|
# 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
|
|
364
392
|
# value - object - A Hash of attributes specific to the automation type.
|
|
393
|
+
# automation - string - Automation type
|
|
365
394
|
def self.update(id, params = {}, options = {})
|
|
366
395
|
params ||= {}
|
|
367
396
|
params[:id] = id
|
|
368
397
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
|
369
|
-
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
370
398
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
|
|
371
399
|
raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
|
|
372
400
|
raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
|
|
@@ -382,8 +410,8 @@ module Files
|
|
|
382
410
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
383
411
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
384
412
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
|
|
413
|
+
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
|
385
414
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
386
|
-
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
|
387
415
|
|
|
388
416
|
response, options = Api.send_request("/automations/#{params[:id]}", :patch, params, options)
|
|
389
417
|
Automation.new(response.data, options)
|
|
@@ -315,7 +315,7 @@ module Files
|
|
|
315
315
|
# filter - string - If specified, will filter folders/files list by this string. Wildcards of `*` and `?` are acceptable here.
|
|
316
316
|
# preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`.
|
|
317
317
|
# search - string - If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`.
|
|
318
|
-
# search_all - boolean - Search entire site?
|
|
318
|
+
# search_all - boolean - Search entire site? If set, we will ignore the folder path provided and search the entire site. This is the same API used by the search bar in the UI. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
|
|
319
319
|
# with_previews - boolean - Include file previews?
|
|
320
320
|
# with_priority_color - boolean - Include file priority color information?
|
|
321
321
|
def self.list_for(path, params = {}, options = {})
|
|
@@ -45,6 +45,33 @@ module Files
|
|
|
45
45
|
@attributes[:group_name] = value
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
+
# int64 - Only notify on actions made by a member of one of the specified groups
|
|
49
|
+
def triggering_group_ids
|
|
50
|
+
@attributes[:triggering_group_ids]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def triggering_group_ids=(value)
|
|
54
|
+
@attributes[:triggering_group_ids] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# int64 - Only notify on actions made one of the specified users
|
|
58
|
+
def triggering_user_ids
|
|
59
|
+
@attributes[:triggering_user_ids]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def triggering_user_ids=(value)
|
|
63
|
+
@attributes[:triggering_user_ids] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# boolean - Notify when actions are performed by a share recipient?
|
|
67
|
+
def trigger_by_share_recipients
|
|
68
|
+
@attributes[:trigger_by_share_recipients]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def trigger_by_share_recipients=(value)
|
|
72
|
+
@attributes[:trigger_by_share_recipients] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
48
75
|
# boolean - Trigger notification on notification user actions?
|
|
49
76
|
def notify_user_actions
|
|
50
77
|
@attributes[:notify_user_actions]
|
|
@@ -54,7 +81,7 @@ module Files
|
|
|
54
81
|
@attributes[:notify_user_actions] = value
|
|
55
82
|
end
|
|
56
83
|
|
|
57
|
-
# boolean - Triggers notification when
|
|
84
|
+
# boolean - Triggers notification when copying files to this path
|
|
58
85
|
def notify_on_copy
|
|
59
86
|
@attributes[:notify_on_copy]
|
|
60
87
|
end
|
|
@@ -63,6 +90,42 @@ module Files
|
|
|
63
90
|
@attributes[:notify_on_copy] = value
|
|
64
91
|
end
|
|
65
92
|
|
|
93
|
+
# boolean - Triggers notification when deleting files from this path
|
|
94
|
+
def notify_on_delete
|
|
95
|
+
@attributes[:notify_on_delete]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
def notify_on_delete=(value)
|
|
99
|
+
@attributes[:notify_on_delete] = value
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
# boolean - Triggers notification when downloading files from this path
|
|
103
|
+
def notify_on_download
|
|
104
|
+
@attributes[:notify_on_download]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def notify_on_download=(value)
|
|
108
|
+
@attributes[:notify_on_download] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# boolean - Triggers notification when moving files to this path
|
|
112
|
+
def notify_on_move
|
|
113
|
+
@attributes[:notify_on_move]
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
def notify_on_move=(value)
|
|
117
|
+
@attributes[:notify_on_move] = value
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# boolean - Triggers notification when uploading new files to this path
|
|
121
|
+
def notify_on_upload
|
|
122
|
+
@attributes[:notify_on_upload]
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
def notify_on_upload=(value)
|
|
126
|
+
@attributes[:notify_on_upload] = value
|
|
127
|
+
end
|
|
128
|
+
|
|
66
129
|
# boolean - Enable notifications for each subfolder in this path
|
|
67
130
|
def recursive
|
|
68
131
|
@attributes[:recursive]
|
|
@@ -90,6 +153,15 @@ module Files
|
|
|
90
153
|
@attributes[:message] = value
|
|
91
154
|
end
|
|
92
155
|
|
|
156
|
+
# array - Array of filenames (possibly with wildcards) to match for action path
|
|
157
|
+
def triggering_filenames
|
|
158
|
+
@attributes[:triggering_filenames]
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
def triggering_filenames=(value)
|
|
162
|
+
@attributes[:triggering_filenames] = value
|
|
163
|
+
end
|
|
164
|
+
|
|
93
165
|
# boolean - Is the user unsubscribed from this notification?
|
|
94
166
|
def unsubscribed
|
|
95
167
|
@attributes[:unsubscribed]
|
|
@@ -137,10 +209,18 @@ module Files
|
|
|
137
209
|
|
|
138
210
|
# Parameters:
|
|
139
211
|
# notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
212
|
+
# notify_on_delete - boolean - Triggers notification when deleting files from this path
|
|
213
|
+
# notify_on_download - boolean - Triggers notification when downloading files from this path
|
|
214
|
+
# notify_on_move - boolean - Triggers notification when moving files to this path
|
|
215
|
+
# notify_on_upload - boolean - Triggers notification when uploading new files to this path
|
|
140
216
|
# notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
|
141
217
|
# recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
|
142
218
|
# send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
143
219
|
# message - string - Custom message to include in notification emails.
|
|
220
|
+
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
|
|
221
|
+
# triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
|
|
222
|
+
# triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
|
|
223
|
+
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
144
224
|
def update(params = {})
|
|
145
225
|
params ||= {}
|
|
146
226
|
params[:id] = @attributes[:id]
|
|
@@ -148,6 +228,9 @@ module Files
|
|
|
148
228
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
|
149
229
|
raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String)
|
|
150
230
|
raise InvalidParameterError.new("Bad parameter: message must be an String") if params.dig(:message) and !params.dig(:message).is_a?(String)
|
|
231
|
+
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params.dig(:triggering_filenames) and !params.dig(:triggering_filenames).is_a?(Array)
|
|
232
|
+
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params.dig(:triggering_group_ids) and !params.dig(:triggering_group_ids).is_a?(Array)
|
|
233
|
+
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params.dig(:triggering_user_ids) and !params.dig(:triggering_user_ids).is_a?(Array)
|
|
151
234
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
152
235
|
|
|
153
236
|
Api.send_request("/notifications/#{@attributes[:id]}", :patch, params, @options)
|
|
@@ -232,10 +315,18 @@ module Files
|
|
|
232
315
|
# Parameters:
|
|
233
316
|
# user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
|
234
317
|
# notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
318
|
+
# notify_on_delete - boolean - Triggers notification when deleting files from this path
|
|
319
|
+
# notify_on_download - boolean - Triggers notification when downloading files from this path
|
|
320
|
+
# notify_on_move - boolean - Triggers notification when moving files to this path
|
|
321
|
+
# notify_on_upload - boolean - Triggers notification when uploading new files to this path
|
|
235
322
|
# notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
|
236
323
|
# recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
|
237
324
|
# send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
238
325
|
# message - string - Custom message to include in notification emails.
|
|
326
|
+
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
|
|
327
|
+
# triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
|
|
328
|
+
# triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
|
|
329
|
+
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
239
330
|
# group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
|
240
331
|
# path - string - Path
|
|
241
332
|
# username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
|
|
@@ -243,6 +334,9 @@ module Files
|
|
|
243
334
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
|
244
335
|
raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String)
|
|
245
336
|
raise InvalidParameterError.new("Bad parameter: message must be an String") if params.dig(:message) and !params.dig(:message).is_a?(String)
|
|
337
|
+
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params.dig(:triggering_filenames) and !params.dig(:triggering_filenames).is_a?(Array)
|
|
338
|
+
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params.dig(:triggering_group_ids) and !params.dig(:triggering_group_ids).is_a?(Array)
|
|
339
|
+
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params.dig(:triggering_user_ids) and !params.dig(:triggering_user_ids).is_a?(Array)
|
|
246
340
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
|
|
247
341
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
|
248
342
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
|
|
@@ -253,16 +347,27 @@ module Files
|
|
|
253
347
|
|
|
254
348
|
# Parameters:
|
|
255
349
|
# notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
|
350
|
+
# notify_on_delete - boolean - Triggers notification when deleting files from this path
|
|
351
|
+
# notify_on_download - boolean - Triggers notification when downloading files from this path
|
|
352
|
+
# notify_on_move - boolean - Triggers notification when moving files to this path
|
|
353
|
+
# notify_on_upload - boolean - Triggers notification when uploading new files to this path
|
|
256
354
|
# notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
|
257
355
|
# recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
|
258
356
|
# send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
|
259
357
|
# message - string - Custom message to include in notification emails.
|
|
358
|
+
# triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to match for action path
|
|
359
|
+
# triggering_group_ids - array(int64) - Only notify on actions made by a member of one of the specified groups
|
|
360
|
+
# triggering_user_ids - array(int64) - Only notify on actions made one of the specified users
|
|
361
|
+
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
260
362
|
def self.update(id, params = {}, options = {})
|
|
261
363
|
params ||= {}
|
|
262
364
|
params[:id] = id
|
|
263
365
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
|
264
366
|
raise InvalidParameterError.new("Bad parameter: send_interval must be an String") if params.dig(:send_interval) and !params.dig(:send_interval).is_a?(String)
|
|
265
367
|
raise InvalidParameterError.new("Bad parameter: message must be an String") if params.dig(:message) and !params.dig(:message).is_a?(String)
|
|
368
|
+
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params.dig(:triggering_filenames) and !params.dig(:triggering_filenames).is_a?(Array)
|
|
369
|
+
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params.dig(:triggering_group_ids) and !params.dig(:triggering_group_ids).is_a?(Array)
|
|
370
|
+
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params.dig(:triggering_user_ids) and !params.dig(:triggering_user_ids).is_a?(Array)
|
|
266
371
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
267
372
|
|
|
268
373
|
response, options = Api.send_request("/notifications/#{params[:id]}", :patch, params, options)
|
|
@@ -288,6 +288,15 @@ module Files
|
|
|
288
288
|
@attributes[:azure_blob_storage_account] = value
|
|
289
289
|
end
|
|
290
290
|
|
|
291
|
+
# string - Shared Access Signature (SAS) token
|
|
292
|
+
def azure_blob_storage_sas_token
|
|
293
|
+
@attributes[:azure_blob_storage_sas_token]
|
|
294
|
+
end
|
|
295
|
+
|
|
296
|
+
def azure_blob_storage_sas_token=(value)
|
|
297
|
+
@attributes[:azure_blob_storage_sas_token] = value
|
|
298
|
+
end
|
|
299
|
+
|
|
291
300
|
# string - Azure Blob Storage Container name
|
|
292
301
|
def azure_blob_storage_container
|
|
293
302
|
@attributes[:azure_blob_storage_container]
|
|
@@ -487,6 +496,7 @@ module Files
|
|
|
487
496
|
# one_drive_account_type - string - Either personal or business_other account types
|
|
488
497
|
# azure_blob_storage_account - string - Azure Blob Storage Account name
|
|
489
498
|
# azure_blob_storage_container - string - Azure Blob Storage Container name
|
|
499
|
+
# azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
|
|
490
500
|
# s3_compatible_bucket - string - S3-compatible Bucket name
|
|
491
501
|
# s3_compatible_endpoint - string - S3-compatible endpoint
|
|
492
502
|
# s3_compatible_region - string - S3-compatible endpoint
|
|
@@ -533,6 +543,7 @@ module Files
|
|
|
533
543
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
|
|
534
544
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
|
|
535
545
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
|
|
546
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params.dig(:azure_blob_storage_sas_token) and !params.dig(:azure_blob_storage_sas_token).is_a?(String)
|
|
536
547
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
|
|
537
548
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
|
|
538
549
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
|
|
@@ -635,6 +646,7 @@ module Files
|
|
|
635
646
|
# one_drive_account_type - string - Either personal or business_other account types
|
|
636
647
|
# azure_blob_storage_account - string - Azure Blob Storage Account name
|
|
637
648
|
# azure_blob_storage_container - string - Azure Blob Storage Container name
|
|
649
|
+
# azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
|
|
638
650
|
# s3_compatible_bucket - string - S3-compatible Bucket name
|
|
639
651
|
# s3_compatible_endpoint - string - S3-compatible endpoint
|
|
640
652
|
# s3_compatible_region - string - S3-compatible endpoint
|
|
@@ -677,6 +689,7 @@ module Files
|
|
|
677
689
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
|
|
678
690
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
|
|
679
691
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
|
|
692
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params.dig(:azure_blob_storage_sas_token) and !params.dig(:azure_blob_storage_sas_token).is_a?(String)
|
|
680
693
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
|
|
681
694
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
|
|
682
695
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
|
|
@@ -724,6 +737,7 @@ module Files
|
|
|
724
737
|
# one_drive_account_type - string - Either personal or business_other account types
|
|
725
738
|
# azure_blob_storage_account - string - Azure Blob Storage Account name
|
|
726
739
|
# azure_blob_storage_container - string - Azure Blob Storage Container name
|
|
740
|
+
# azure_blob_storage_sas_token - string - Shared Access Signature (SAS) token
|
|
727
741
|
# s3_compatible_bucket - string - S3-compatible Bucket name
|
|
728
742
|
# s3_compatible_endpoint - string - S3-compatible endpoint
|
|
729
743
|
# s3_compatible_region - string - S3-compatible endpoint
|
|
@@ -769,6 +783,7 @@ module Files
|
|
|
769
783
|
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
|
|
770
784
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
|
|
771
785
|
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
|
|
786
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_sas_token must be an String") if params.dig(:azure_blob_storage_sas_token) and !params.dig(:azure_blob_storage_sas_token).is_a?(String)
|
|
772
787
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_bucket must be an String") if params.dig(:s3_compatible_bucket) and !params.dig(:s3_compatible_bucket).is_a?(String)
|
|
773
788
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_endpoint must be an String") if params.dig(:s3_compatible_endpoint) and !params.dig(:s3_compatible_endpoint).is_a?(String)
|
|
774
789
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_region must be an String") if params.dig(:s3_compatible_region) and !params.dig(:s3_compatible_region).is_a?(String)
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: files.com
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.0.
|
|
4
|
+
version: 1.0.268
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-05-
|
|
11
|
+
date: 2022-05-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|