files.com 1.2.15 → 1.2.16
Sign up to get free protection for your applications and to get access to all the features.
- package/_VERSION +1 -1
- package/docs/models/AutomationRun.md +8 -0
- package/docs/models/Notification.md +29 -29
- package/lib/Files.js +1 -1
- package/lib/models/AutomationRun.js +16 -0
- package/lib/models/Notification.js +29 -29
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/AutomationRun.js +12 -0
- package/src/models/Notification.js +29 -29
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.2.
|
1
|
+
1.2.16
|
@@ -8,7 +8,11 @@
|
|
8
8
|
"automation_id": 1,
|
9
9
|
"completed_at": "2000-01-01T01:00:00Z",
|
10
10
|
"created_at": "2000-01-01T01:00:00Z",
|
11
|
+
"runtime": "2000-01-01T01:00:00Z",
|
11
12
|
"status": "success",
|
13
|
+
"run_stage": "planning",
|
14
|
+
"successful_operations": 1,
|
15
|
+
"failed_operations": 1,
|
12
16
|
"status_messages_url": "https://www.example.com/log_file.txt"
|
13
17
|
}
|
14
18
|
```
|
@@ -17,7 +21,11 @@
|
|
17
21
|
* `automation_id` (int64): ID of the associated Automation.
|
18
22
|
* `completed_at` (date-time): Automation run completion/failure date/time.
|
19
23
|
* `created_at` (date-time): Automation run start date/time.
|
24
|
+
* `runtime` (date-time): Automation run runtime.
|
20
25
|
* `status` (string): The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
|
26
|
+
* `run_stage` (string): The stage currently being executed in the execution environment. One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
|
27
|
+
* `successful_operations` (int64): Count of successful operations.
|
28
|
+
* `failed_operations` (int64): Count of failed operations.
|
21
29
|
* `status_messages_url` (string): Link to status messages log file.
|
22
30
|
|
23
31
|
---
|
@@ -38,21 +38,21 @@
|
|
38
38
|
|
39
39
|
* `id` (int64): Notification ID
|
40
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.
|
41
|
-
* `group_id` (int64):
|
42
|
-
* `group_name` (string): Group name if
|
43
|
-
* `triggering_group_ids` (array):
|
44
|
-
* `triggering_user_ids` (array):
|
41
|
+
* `group_id` (int64): ID of Group to receive notifications
|
42
|
+
* `group_name` (string): Group name, if a Group ID is set
|
43
|
+
* `triggering_group_ids` (array): If set, will only notify on actions made by a member of one of the specified groups
|
44
|
+
* `triggering_user_ids` (array): If set, will onlynotify on actions made one of the specified users
|
45
45
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
46
|
-
* `notify_user_actions` (boolean):
|
47
|
-
* `notify_on_copy` (boolean):
|
48
|
-
* `notify_on_delete` (boolean):
|
49
|
-
* `notify_on_download` (boolean):
|
50
|
-
* `notify_on_move` (boolean):
|
51
|
-
* `notify_on_upload` (boolean):
|
52
|
-
* `recursive` (boolean):
|
46
|
+
* `notify_user_actions` (boolean): If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
|
47
|
+
* `notify_on_copy` (boolean): Trigger on files copied to this path?
|
48
|
+
* `notify_on_delete` (boolean): Trigger on files deleted in this path?
|
49
|
+
* `notify_on_download` (boolean): Trigger on files downloaded in this path?
|
50
|
+
* `notify_on_move` (boolean): Trigger on files moved to this path?
|
51
|
+
* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
|
52
|
+
* `recursive` (boolean): Apply notification recursively? This will enable notifications for each subfolder.
|
53
53
|
* `send_interval` (string): The time interval that notifications are aggregated to
|
54
|
-
* `message` (string): Custom message to include in notification emails
|
55
|
-
* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to
|
54
|
+
* `message` (string): Custom message to include in notification emails
|
55
|
+
* `triggering_filenames` (array): Array of filenames (possibly with wildcards) to scope trigger
|
56
56
|
* `unsubscribed` (boolean): Is the user unsubscribed from this notification?
|
57
57
|
* `unsubscribed_reason` (string): The reason that the user unsubscribed
|
58
58
|
* `user_id` (int64): Notification user ID
|
@@ -128,17 +128,17 @@ await Notification.create({
|
|
128
128
|
|
129
129
|
* `user_id` (int64): The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
130
130
|
* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
131
|
-
* `notify_on_delete` (boolean):
|
132
|
-
* `notify_on_download` (boolean):
|
133
|
-
* `notify_on_move` (boolean):
|
134
|
-
* `notify_on_upload` (boolean):
|
131
|
+
* `notify_on_delete` (boolean): Trigger on files deleted in this path?
|
132
|
+
* `notify_on_download` (boolean): Trigger on files downloaded in this path?
|
133
|
+
* `notify_on_move` (boolean): Trigger on files moved to this path?
|
134
|
+
* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
|
135
135
|
* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
|
136
136
|
* `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
|
137
137
|
* `send_interval` (string): The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
138
|
-
* `message` (string): Custom message to include in notification emails
|
139
|
-
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to
|
140
|
-
* `triggering_group_ids` (array(int64)):
|
141
|
-
* `triggering_user_ids` (array(int64)):
|
138
|
+
* `message` (string): Custom message to include in notification emails
|
139
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
140
|
+
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
141
|
+
* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
|
142
142
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
143
143
|
* `group_id` (int64): The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
144
144
|
* `path` (string): Path
|
@@ -172,17 +172,17 @@ await notification.update({
|
|
172
172
|
|
173
173
|
* `id` (int64): Required - Notification ID.
|
174
174
|
* `notify_on_copy` (boolean): If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
175
|
-
* `notify_on_delete` (boolean):
|
176
|
-
* `notify_on_download` (boolean):
|
177
|
-
* `notify_on_move` (boolean):
|
178
|
-
* `notify_on_upload` (boolean):
|
175
|
+
* `notify_on_delete` (boolean): Trigger on files deleted in this path?
|
176
|
+
* `notify_on_download` (boolean): Trigger on files downloaded in this path?
|
177
|
+
* `notify_on_move` (boolean): Trigger on files moved to this path?
|
178
|
+
* `notify_on_upload` (boolean): Trigger on files created/uploaded/updated/changed in this path?
|
179
179
|
* `notify_user_actions` (boolean): If `true` actions initiated by the user will still result in a notification
|
180
180
|
* `recursive` (boolean): If `true`, enable notifications for each subfolder in this path
|
181
181
|
* `send_interval` (string): The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
182
|
-
* `message` (string): Custom message to include in notification emails
|
183
|
-
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to
|
184
|
-
* `triggering_group_ids` (array(int64)):
|
185
|
-
* `triggering_user_ids` (array(int64)):
|
182
|
+
* `message` (string): Custom message to include in notification emails
|
183
|
+
* `triggering_filenames` (array(string)): Array of filenames (possibly with wildcards) to scope trigger
|
184
|
+
* `triggering_group_ids` (array(int64)): If set, will only notify on actions made by a member of one of the specified groups
|
185
|
+
* `triggering_user_ids` (array(int64)): If set, will onlynotify on actions made one of the specified users
|
186
186
|
* `trigger_by_share_recipients` (boolean): Notify when actions are performed by a share recipient?
|
187
187
|
|
188
188
|
### Example Response
|
package/lib/Files.js
CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
|
|
11
11
|
var apiKey;
|
12
12
|
var baseUrl = 'https://app.files.com';
|
13
13
|
var sessionId = null;
|
14
|
-
var version = '1.2.
|
14
|
+
var version = '1.2.16';
|
15
15
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
16
16
|
var logLevel = _Logger.LogLevel.INFO;
|
17
17
|
var debugRequest = false;
|
@@ -49,10 +49,26 @@ var AutomationRun = /*#__PURE__*/(0, _createClass2.default)(function AutomationR
|
|
49
49
|
(0, _defineProperty2.default)(this, "getCreatedAt", function () {
|
50
50
|
return _this.attributes.created_at;
|
51
51
|
});
|
52
|
+
// date-time # Automation run runtime.
|
53
|
+
(0, _defineProperty2.default)(this, "getRuntime", function () {
|
54
|
+
return _this.attributes.runtime;
|
55
|
+
});
|
52
56
|
// string # The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
|
53
57
|
(0, _defineProperty2.default)(this, "getStatus", function () {
|
54
58
|
return _this.attributes.status;
|
55
59
|
});
|
60
|
+
// string # The stage currently being executed in the execution environment. One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
|
61
|
+
(0, _defineProperty2.default)(this, "getRunStage", function () {
|
62
|
+
return _this.attributes.run_stage;
|
63
|
+
});
|
64
|
+
// int64 # Count of successful operations.
|
65
|
+
(0, _defineProperty2.default)(this, "getSuccessfulOperations", function () {
|
66
|
+
return _this.attributes.successful_operations;
|
67
|
+
});
|
68
|
+
// int64 # Count of failed operations.
|
69
|
+
(0, _defineProperty2.default)(this, "getFailedOperations", function () {
|
70
|
+
return _this.attributes.failed_operations;
|
71
|
+
});
|
56
72
|
// string # Link to status messages log file.
|
57
73
|
(0, _defineProperty2.default)(this, "getStatusMessagesUrl", function () {
|
58
74
|
return _this.attributes.status_messages_url;
|
@@ -47,28 +47,28 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
47
47
|
(0, _defineProperty2.default)(this, "setPath", function (value) {
|
48
48
|
_this.attributes.path = value;
|
49
49
|
});
|
50
|
-
// int64 #
|
50
|
+
// int64 # ID of Group to receive notifications
|
51
51
|
(0, _defineProperty2.default)(this, "getGroupId", function () {
|
52
52
|
return _this.attributes.group_id;
|
53
53
|
});
|
54
54
|
(0, _defineProperty2.default)(this, "setGroupId", function (value) {
|
55
55
|
_this.attributes.group_id = value;
|
56
56
|
});
|
57
|
-
// string # Group name if
|
57
|
+
// string # Group name, if a Group ID is set
|
58
58
|
(0, _defineProperty2.default)(this, "getGroupName", function () {
|
59
59
|
return _this.attributes.group_name;
|
60
60
|
});
|
61
61
|
(0, _defineProperty2.default)(this, "setGroupName", function (value) {
|
62
62
|
_this.attributes.group_name = value;
|
63
63
|
});
|
64
|
-
// array #
|
64
|
+
// array # If set, will only notify on actions made by a member of one of the specified groups
|
65
65
|
(0, _defineProperty2.default)(this, "getTriggeringGroupIds", function () {
|
66
66
|
return _this.attributes.triggering_group_ids;
|
67
67
|
});
|
68
68
|
(0, _defineProperty2.default)(this, "setTriggeringGroupIds", function (value) {
|
69
69
|
_this.attributes.triggering_group_ids = value;
|
70
70
|
});
|
71
|
-
// array #
|
71
|
+
// array # If set, will onlynotify on actions made one of the specified users
|
72
72
|
(0, _defineProperty2.default)(this, "getTriggeringUserIds", function () {
|
73
73
|
return _this.attributes.triggering_user_ids;
|
74
74
|
});
|
@@ -82,49 +82,49 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
82
82
|
(0, _defineProperty2.default)(this, "setTriggerByShareRecipients", function (value) {
|
83
83
|
_this.attributes.trigger_by_share_recipients = value;
|
84
84
|
});
|
85
|
-
// boolean #
|
85
|
+
// boolean # If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
|
86
86
|
(0, _defineProperty2.default)(this, "getNotifyUserActions", function () {
|
87
87
|
return _this.attributes.notify_user_actions;
|
88
88
|
});
|
89
89
|
(0, _defineProperty2.default)(this, "setNotifyUserActions", function (value) {
|
90
90
|
_this.attributes.notify_user_actions = value;
|
91
91
|
});
|
92
|
-
// boolean #
|
92
|
+
// boolean # Trigger on files copied to this path?
|
93
93
|
(0, _defineProperty2.default)(this, "getNotifyOnCopy", function () {
|
94
94
|
return _this.attributes.notify_on_copy;
|
95
95
|
});
|
96
96
|
(0, _defineProperty2.default)(this, "setNotifyOnCopy", function (value) {
|
97
97
|
_this.attributes.notify_on_copy = value;
|
98
98
|
});
|
99
|
-
// boolean #
|
99
|
+
// boolean # Trigger on files deleted in this path?
|
100
100
|
(0, _defineProperty2.default)(this, "getNotifyOnDelete", function () {
|
101
101
|
return _this.attributes.notify_on_delete;
|
102
102
|
});
|
103
103
|
(0, _defineProperty2.default)(this, "setNotifyOnDelete", function (value) {
|
104
104
|
_this.attributes.notify_on_delete = value;
|
105
105
|
});
|
106
|
-
// boolean #
|
106
|
+
// boolean # Trigger on files downloaded in this path?
|
107
107
|
(0, _defineProperty2.default)(this, "getNotifyOnDownload", function () {
|
108
108
|
return _this.attributes.notify_on_download;
|
109
109
|
});
|
110
110
|
(0, _defineProperty2.default)(this, "setNotifyOnDownload", function (value) {
|
111
111
|
_this.attributes.notify_on_download = value;
|
112
112
|
});
|
113
|
-
// boolean #
|
113
|
+
// boolean # Trigger on files moved to this path?
|
114
114
|
(0, _defineProperty2.default)(this, "getNotifyOnMove", function () {
|
115
115
|
return _this.attributes.notify_on_move;
|
116
116
|
});
|
117
117
|
(0, _defineProperty2.default)(this, "setNotifyOnMove", function (value) {
|
118
118
|
_this.attributes.notify_on_move = value;
|
119
119
|
});
|
120
|
-
// boolean #
|
120
|
+
// boolean # Trigger on files created/uploaded/updated/changed in this path?
|
121
121
|
(0, _defineProperty2.default)(this, "getNotifyOnUpload", function () {
|
122
122
|
return _this.attributes.notify_on_upload;
|
123
123
|
});
|
124
124
|
(0, _defineProperty2.default)(this, "setNotifyOnUpload", function (value) {
|
125
125
|
_this.attributes.notify_on_upload = value;
|
126
126
|
});
|
127
|
-
// boolean #
|
127
|
+
// boolean # Apply notification recursively? This will enable notifications for each subfolder.
|
128
128
|
(0, _defineProperty2.default)(this, "getRecursive", function () {
|
129
129
|
return _this.attributes.recursive;
|
130
130
|
});
|
@@ -138,14 +138,14 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
138
138
|
(0, _defineProperty2.default)(this, "setSendInterval", function (value) {
|
139
139
|
_this.attributes.send_interval = value;
|
140
140
|
});
|
141
|
-
// string # Custom message to include in notification emails
|
141
|
+
// string # Custom message to include in notification emails
|
142
142
|
(0, _defineProperty2.default)(this, "getMessage", function () {
|
143
143
|
return _this.attributes.message;
|
144
144
|
});
|
145
145
|
(0, _defineProperty2.default)(this, "setMessage", function (value) {
|
146
146
|
_this.attributes.message = value;
|
147
147
|
});
|
148
|
-
// array # Array of filenames (possibly with wildcards) to
|
148
|
+
// array # Array of filenames (possibly with wildcards) to scope trigger
|
149
149
|
(0, _defineProperty2.default)(this, "getTriggeringFilenames", function () {
|
150
150
|
return _this.attributes.triggering_filenames;
|
151
151
|
});
|
@@ -189,17 +189,17 @@ var Notification = /*#__PURE__*/(0, _createClass2.default)(function Notification
|
|
189
189
|
});
|
190
190
|
// Parameters:
|
191
191
|
// notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
192
|
-
// notify_on_delete - boolean -
|
193
|
-
// notify_on_download - boolean -
|
194
|
-
// notify_on_move - boolean -
|
195
|
-
// notify_on_upload - boolean -
|
192
|
+
// notify_on_delete - boolean - Trigger on files deleted in this path?
|
193
|
+
// notify_on_download - boolean - Trigger on files downloaded in this path?
|
194
|
+
// notify_on_move - boolean - Trigger on files moved to this path?
|
195
|
+
// notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
|
196
196
|
// notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
197
197
|
// recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
198
198
|
// send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
199
|
-
// message - string - Custom message to include in notification emails
|
200
|
-
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to
|
201
|
-
// triggering_group_ids - array(int64) -
|
202
|
-
// triggering_user_ids - array(int64) -
|
199
|
+
// message - string - Custom message to include in notification emails
|
200
|
+
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
201
|
+
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
202
|
+
// triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
|
203
203
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
204
204
|
(0, _defineProperty2.default)(this, "update", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
|
205
205
|
var params,
|
@@ -501,17 +501,17 @@ _Notification = Notification;
|
|
501
501
|
// Parameters:
|
502
502
|
// user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
503
503
|
// notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
504
|
-
// notify_on_delete - boolean -
|
505
|
-
// notify_on_download - boolean -
|
506
|
-
// notify_on_move - boolean -
|
507
|
-
// notify_on_upload - boolean -
|
504
|
+
// notify_on_delete - boolean - Trigger on files deleted in this path?
|
505
|
+
// notify_on_download - boolean - Trigger on files downloaded in this path?
|
506
|
+
// notify_on_move - boolean - Trigger on files moved to this path?
|
507
|
+
// notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
|
508
508
|
// notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
509
509
|
// recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
510
510
|
// send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
511
|
-
// message - string - Custom message to include in notification emails
|
512
|
-
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to
|
513
|
-
// triggering_group_ids - array(int64) -
|
514
|
-
// triggering_user_ids - array(int64) -
|
511
|
+
// message - string - Custom message to include in notification emails
|
512
|
+
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
513
|
+
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
514
|
+
// triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
|
515
515
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
516
516
|
// group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
517
517
|
// path - string - Path
|
package/package.json
CHANGED
package/src/Files.js
CHANGED
@@ -40,9 +40,21 @@ class AutomationRun {
|
|
40
40
|
// date-time # Automation run start date/time.
|
41
41
|
getCreatedAt = () => this.attributes.created_at
|
42
42
|
|
43
|
+
// date-time # Automation run runtime.
|
44
|
+
getRuntime = () => this.attributes.runtime
|
45
|
+
|
43
46
|
// string # The success status of the AutomationRun. One of `running`, `success`, `partial_failure`, or `failure`.
|
44
47
|
getStatus = () => this.attributes.status
|
45
48
|
|
49
|
+
// string # The stage currently being executed in the execution environment. One of `queued_for_planning`, `planning`, `queued_for_execution`, `executing`, or `finished`.
|
50
|
+
getRunStage = () => this.attributes.run_stage
|
51
|
+
|
52
|
+
// int64 # Count of successful operations.
|
53
|
+
getSuccessfulOperations = () => this.attributes.successful_operations
|
54
|
+
|
55
|
+
// int64 # Count of failed operations.
|
56
|
+
getFailedOperations = () => this.attributes.failed_operations
|
57
|
+
|
46
58
|
// string # Link to status messages log file.
|
47
59
|
getStatusMessagesUrl = () => this.attributes.status_messages_url
|
48
60
|
|
@@ -42,28 +42,28 @@ class Notification {
|
|
42
42
|
this.attributes.path = value
|
43
43
|
}
|
44
44
|
|
45
|
-
// int64 #
|
45
|
+
// int64 # ID of Group to receive notifications
|
46
46
|
getGroupId = () => this.attributes.group_id
|
47
47
|
|
48
48
|
setGroupId = value => {
|
49
49
|
this.attributes.group_id = value
|
50
50
|
}
|
51
51
|
|
52
|
-
// string # Group name if
|
52
|
+
// string # Group name, if a Group ID is set
|
53
53
|
getGroupName = () => this.attributes.group_name
|
54
54
|
|
55
55
|
setGroupName = value => {
|
56
56
|
this.attributes.group_name = value
|
57
57
|
}
|
58
58
|
|
59
|
-
// array #
|
59
|
+
// array # If set, will only notify on actions made by a member of one of the specified groups
|
60
60
|
getTriggeringGroupIds = () => this.attributes.triggering_group_ids
|
61
61
|
|
62
62
|
setTriggeringGroupIds = value => {
|
63
63
|
this.attributes.triggering_group_ids = value
|
64
64
|
}
|
65
65
|
|
66
|
-
// array #
|
66
|
+
// array # If set, will onlynotify on actions made one of the specified users
|
67
67
|
getTriggeringUserIds = () => this.attributes.triggering_user_ids
|
68
68
|
|
69
69
|
setTriggeringUserIds = value => {
|
@@ -77,49 +77,49 @@ class Notification {
|
|
77
77
|
this.attributes.trigger_by_share_recipients = value
|
78
78
|
}
|
79
79
|
|
80
|
-
// boolean #
|
80
|
+
// boolean # If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
|
81
81
|
getNotifyUserActions = () => this.attributes.notify_user_actions
|
82
82
|
|
83
83
|
setNotifyUserActions = value => {
|
84
84
|
this.attributes.notify_user_actions = value
|
85
85
|
}
|
86
86
|
|
87
|
-
// boolean #
|
87
|
+
// boolean # Trigger on files copied to this path?
|
88
88
|
getNotifyOnCopy = () => this.attributes.notify_on_copy
|
89
89
|
|
90
90
|
setNotifyOnCopy = value => {
|
91
91
|
this.attributes.notify_on_copy = value
|
92
92
|
}
|
93
93
|
|
94
|
-
// boolean #
|
94
|
+
// boolean # Trigger on files deleted in this path?
|
95
95
|
getNotifyOnDelete = () => this.attributes.notify_on_delete
|
96
96
|
|
97
97
|
setNotifyOnDelete = value => {
|
98
98
|
this.attributes.notify_on_delete = value
|
99
99
|
}
|
100
100
|
|
101
|
-
// boolean #
|
101
|
+
// boolean # Trigger on files downloaded in this path?
|
102
102
|
getNotifyOnDownload = () => this.attributes.notify_on_download
|
103
103
|
|
104
104
|
setNotifyOnDownload = value => {
|
105
105
|
this.attributes.notify_on_download = value
|
106
106
|
}
|
107
107
|
|
108
|
-
// boolean #
|
108
|
+
// boolean # Trigger on files moved to this path?
|
109
109
|
getNotifyOnMove = () => this.attributes.notify_on_move
|
110
110
|
|
111
111
|
setNotifyOnMove = value => {
|
112
112
|
this.attributes.notify_on_move = value
|
113
113
|
}
|
114
114
|
|
115
|
-
// boolean #
|
115
|
+
// boolean # Trigger on files created/uploaded/updated/changed in this path?
|
116
116
|
getNotifyOnUpload = () => this.attributes.notify_on_upload
|
117
117
|
|
118
118
|
setNotifyOnUpload = value => {
|
119
119
|
this.attributes.notify_on_upload = value
|
120
120
|
}
|
121
121
|
|
122
|
-
// boolean #
|
122
|
+
// boolean # Apply notification recursively? This will enable notifications for each subfolder.
|
123
123
|
getRecursive = () => this.attributes.recursive
|
124
124
|
|
125
125
|
setRecursive = value => {
|
@@ -133,14 +133,14 @@ class Notification {
|
|
133
133
|
this.attributes.send_interval = value
|
134
134
|
}
|
135
135
|
|
136
|
-
// string # Custom message to include in notification emails
|
136
|
+
// string # Custom message to include in notification emails
|
137
137
|
getMessage = () => this.attributes.message
|
138
138
|
|
139
139
|
setMessage = value => {
|
140
140
|
this.attributes.message = value
|
141
141
|
}
|
142
142
|
|
143
|
-
// array # Array of filenames (possibly with wildcards) to
|
143
|
+
// array # Array of filenames (possibly with wildcards) to scope trigger
|
144
144
|
getTriggeringFilenames = () => this.attributes.triggering_filenames
|
145
145
|
|
146
146
|
setTriggeringFilenames = value => {
|
@@ -184,17 +184,17 @@ class Notification {
|
|
184
184
|
|
185
185
|
// Parameters:
|
186
186
|
// notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
187
|
-
// notify_on_delete - boolean -
|
188
|
-
// notify_on_download - boolean -
|
189
|
-
// notify_on_move - boolean -
|
190
|
-
// notify_on_upload - boolean -
|
187
|
+
// notify_on_delete - boolean - Trigger on files deleted in this path?
|
188
|
+
// notify_on_download - boolean - Trigger on files downloaded in this path?
|
189
|
+
// notify_on_move - boolean - Trigger on files moved to this path?
|
190
|
+
// notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
|
191
191
|
// notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
192
192
|
// recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
193
193
|
// send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
194
|
-
// message - string - Custom message to include in notification emails
|
195
|
-
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to
|
196
|
-
// triggering_group_ids - array(int64) -
|
197
|
-
// triggering_user_ids - array(int64) -
|
194
|
+
// message - string - Custom message to include in notification emails
|
195
|
+
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
196
|
+
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
197
|
+
// triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
|
198
198
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
199
199
|
update = async (params = {}) => {
|
200
200
|
if (!this.attributes.id) {
|
@@ -350,17 +350,17 @@ class Notification {
|
|
350
350
|
// Parameters:
|
351
351
|
// user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
352
352
|
// notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
353
|
-
// notify_on_delete - boolean -
|
354
|
-
// notify_on_download - boolean -
|
355
|
-
// notify_on_move - boolean -
|
356
|
-
// notify_on_upload - boolean -
|
353
|
+
// notify_on_delete - boolean - Trigger on files deleted in this path?
|
354
|
+
// notify_on_download - boolean - Trigger on files downloaded in this path?
|
355
|
+
// notify_on_move - boolean - Trigger on files moved to this path?
|
356
|
+
// notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
|
357
357
|
// notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
358
358
|
// recursive - boolean - If `true`, enable notifications for each subfolder in this path
|
359
359
|
// send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
360
|
-
// message - string - Custom message to include in notification emails
|
361
|
-
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to
|
362
|
-
// triggering_group_ids - array(int64) -
|
363
|
-
// triggering_user_ids - array(int64) -
|
360
|
+
// message - string - Custom message to include in notification emails
|
361
|
+
// triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
|
362
|
+
// triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
|
363
|
+
// triggering_user_ids - array(int64) - If set, will onlynotify on actions made one of the specified users
|
364
364
|
// trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
|
365
365
|
// group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
366
366
|
// path - string - Path
|