files.com 1.1.639 → 1.1.640
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 +4 -4
- data/_VERSION +1 -1
- data/docs/notification.md +12 -4
- data/lib/files.com/models/notification.rb +17 -2
- data/lib/files.com/version.rb +1 -1
- 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: d5b93e0702af89d82c3e978f3561ff8248033bdfe2420b674fcb083dcb6ce7d9
|
|
4
|
+
data.tar.gz: 1842f1c449d99ba92f5c7b2eab8d1df04e92e09147311455fbd1e3a1d98c1781
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: a9622cb6c443901bc60c99c2eed881f8cab79f37de2fc8e167b165fc4f33f8c8854ab3b4171d968ff35934da01e6ae4ac8b2ccd592e300267f363e4eb9eecad1
|
|
7
|
+
data.tar.gz: d897f96c73ba1ce545a426b84c1333a5788d912ab84f34b3d9fe7418024381d56aee1785f78ef26154a4222113d864e2d2c4b22f4d86cb579dc8891293440837
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.640
|
data/docs/notification.md
CHANGED
|
@@ -35,6 +35,7 @@
|
|
|
35
35
|
"*.jpg",
|
|
36
36
|
"notify_file.txt"
|
|
37
37
|
],
|
|
38
|
+
"workspace_id": 1,
|
|
38
39
|
"unsubscribed": true,
|
|
39
40
|
"unsubscribed_reason": "example",
|
|
40
41
|
"user_id": 1,
|
|
@@ -63,6 +64,7 @@
|
|
|
63
64
|
* `subject` (string): Custom subject line to use for notification emails
|
|
64
65
|
* `message` (string): Custom message to include in notification emails
|
|
65
66
|
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
|
67
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
66
68
|
* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
|
|
67
69
|
* `unsubscribed_reason` (string): The reason that the user unsubscribed
|
|
68
70
|
* `user_id` (int64): Notification user ID
|
|
@@ -85,8 +87,8 @@ Files::Notification.list(
|
|
|
85
87
|
|
|
86
88
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
87
89
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
88
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `user_id` or `group_id`.
|
|
89
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`.
|
|
90
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path`, `user_id` or `group_id`.
|
|
91
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id`, `workspace_id` or `group_id`. Valid field combinations are `[ workspace_id, path ]`, `[ workspace_id, user_id ]`, `[ workspace_id, group_id ]` or `[ workspace_id, user_id, path ]`.
|
|
90
92
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
91
93
|
* `path` (string): Show notifications for this Path.
|
|
92
94
|
* `include_ancestors` (boolean): If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
|
|
@@ -127,6 +129,7 @@ Files::Notification.create(
|
|
|
127
129
|
triggering_group_ids: [1],
|
|
128
130
|
triggering_user_ids: [1],
|
|
129
131
|
trigger_by_share_recipients: true,
|
|
132
|
+
workspace_id: 1,
|
|
130
133
|
group_id: 1,
|
|
131
134
|
group_ids: [1],
|
|
132
135
|
username: "User"
|
|
@@ -150,6 +153,7 @@ Files::Notification.create(
|
|
|
150
153
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
|
151
154
|
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
|
152
155
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
156
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
153
157
|
* `group_id` (int64): The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
|
154
158
|
* `group_ids` (string): Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited.
|
|
155
159
|
* `path` (string): Path
|
|
@@ -175,7 +179,8 @@ Files::Notification.update(id,
|
|
|
175
179
|
triggering_filenames: ["*.jpg","notify_file.txt"],
|
|
176
180
|
triggering_group_ids: [1],
|
|
177
181
|
triggering_user_ids: [1],
|
|
178
|
-
trigger_by_share_recipients: true
|
|
182
|
+
trigger_by_share_recipients: true,
|
|
183
|
+
workspace_id: 1
|
|
179
184
|
)
|
|
180
185
|
```
|
|
181
186
|
|
|
@@ -196,6 +201,7 @@ Files::Notification.update(id,
|
|
|
196
201
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
|
197
202
|
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
|
198
203
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
204
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
199
205
|
|
|
200
206
|
|
|
201
207
|
---
|
|
@@ -232,7 +238,8 @@ notification.update(
|
|
|
232
238
|
triggering_filenames: ["*.jpg","notify_file.txt"],
|
|
233
239
|
triggering_group_ids: [1],
|
|
234
240
|
triggering_user_ids: [1],
|
|
235
|
-
trigger_by_share_recipients: true
|
|
241
|
+
trigger_by_share_recipients: true,
|
|
242
|
+
workspace_id: 1
|
|
236
243
|
)
|
|
237
244
|
```
|
|
238
245
|
|
|
@@ -253,6 +260,7 @@ notification.update(
|
|
|
253
260
|
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
|
254
261
|
* `triggering_user_ids` (array(int64)): If set, will only notify on actions made one of the specified users
|
|
255
262
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
|
263
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
256
264
|
|
|
257
265
|
|
|
258
266
|
---
|
|
@@ -189,6 +189,15 @@ module Files
|
|
|
189
189
|
@attributes[:triggering_filenames] = value
|
|
190
190
|
end
|
|
191
191
|
|
|
192
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
193
|
+
def workspace_id
|
|
194
|
+
@attributes[:workspace_id]
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
def workspace_id=(value)
|
|
198
|
+
@attributes[:workspace_id] = value
|
|
199
|
+
end
|
|
200
|
+
|
|
192
201
|
# boolean - Is the user unsubscribed from this notification?
|
|
193
202
|
def unsubscribed
|
|
194
203
|
@attributes[:unsubscribed]
|
|
@@ -249,6 +258,7 @@ module Files
|
|
|
249
258
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
|
250
259
|
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
|
251
260
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
261
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
252
262
|
def update(params = {})
|
|
253
263
|
params ||= {}
|
|
254
264
|
params[:id] = @attributes[:id]
|
|
@@ -260,6 +270,7 @@ module Files
|
|
|
260
270
|
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params[:triggering_filenames] and !params[:triggering_filenames].is_a?(Array)
|
|
261
271
|
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params[:triggering_group_ids] and !params[:triggering_group_ids].is_a?(Array)
|
|
262
272
|
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params[:triggering_user_ids] and !params[:triggering_user_ids].is_a?(Array)
|
|
273
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
263
274
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
264
275
|
|
|
265
276
|
Api.send_request("/notifications/#{@attributes[:id]}", :patch, params, @options)
|
|
@@ -294,8 +305,8 @@ module Files
|
|
|
294
305
|
# Parameters:
|
|
295
306
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
296
307
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
297
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `user_id` or `group_id`.
|
|
298
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`.
|
|
308
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `path`, `user_id` or `group_id`.
|
|
309
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id`, `workspace_id` or `group_id`. Valid field combinations are `[ workspace_id, path ]`, `[ workspace_id, user_id ]`, `[ workspace_id, group_id ]` or `[ workspace_id, user_id, path ]`.
|
|
299
310
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
|
|
300
311
|
# path - string - Show notifications for this Path.
|
|
301
312
|
# include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
|
|
@@ -350,6 +361,7 @@ module Files
|
|
|
350
361
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
|
351
362
|
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
|
352
363
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
364
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
353
365
|
# group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
|
354
366
|
# group_ids - string - Group IDs when the notification requires multiple groups. If sent as a string, it should be comma-delimited.
|
|
355
367
|
# path - string - Path
|
|
@@ -362,6 +374,7 @@ module Files
|
|
|
362
374
|
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params[:triggering_filenames] and !params[:triggering_filenames].is_a?(Array)
|
|
363
375
|
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params[:triggering_group_ids] and !params[:triggering_group_ids].is_a?(Array)
|
|
364
376
|
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params[:triggering_user_ids] and !params[:triggering_user_ids].is_a?(Array)
|
|
377
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
365
378
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
|
366
379
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params[:group_ids] and !params[:group_ids].is_a?(String)
|
|
367
380
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
@@ -386,6 +399,7 @@ module Files
|
|
|
386
399
|
# triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
|
387
400
|
# triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
|
|
388
401
|
# trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
|
402
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
389
403
|
def self.update(id, params = {}, options = {})
|
|
390
404
|
params ||= {}
|
|
391
405
|
params[:id] = id
|
|
@@ -396,6 +410,7 @@ module Files
|
|
|
396
410
|
raise InvalidParameterError.new("Bad parameter: triggering_filenames must be an Array") if params[:triggering_filenames] and !params[:triggering_filenames].is_a?(Array)
|
|
397
411
|
raise InvalidParameterError.new("Bad parameter: triggering_group_ids must be an Array") if params[:triggering_group_ids] and !params[:triggering_group_ids].is_a?(Array)
|
|
398
412
|
raise InvalidParameterError.new("Bad parameter: triggering_user_ids must be an Array") if params[:triggering_user_ids] and !params[:triggering_user_ids].is_a?(Array)
|
|
413
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
399
414
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
400
415
|
|
|
401
416
|
response, options = Api.send_request("/notifications/#{params[:id]}", :patch, params, options)
|
data/lib/files.com/version.rb
CHANGED
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.1.
|
|
4
|
+
version: 1.1.640
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-06-
|
|
11
|
+
date: 2026-06-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|