files.com 1.0.198 → 1.0.202
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/automation.md +10 -0
- data/docs/behavior.md +10 -0
- data/docs/inbox_registration.md +1 -1
- data/docs/user.md +4 -0
- data/lib/files.com/errors.rb +2 -0
- data/lib/files.com/models/automation.rb +30 -0
- data/lib/files.com/models/behavior.rb +30 -0
- data/lib/files.com/models/inbox_registration.rb +1 -2
- data/lib/files.com/models/user.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: 240a6c056c1b310e0b6f4330117431670a03a2c7e72b9b034bf4e4d9b29b4118
|
|
4
|
+
data.tar.gz: 4f6bd2e27ca0b9826a878d1b179f90e4c2e646b78647f539518b111f7fe27c3c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 57b0ec1859a56969c3d7f37e249eadfa0bec69a7a4e9c2bc872af49b12743c9ffffa9380d1ef6b2ea04077a67260d9147f7bf315b836c9c8bc42482f8621ef8c
|
|
7
|
+
data.tar.gz: 53d45d0726ac6453e25532e738656de9dd5f87600241725714a29ccaee3b1938fea4671ac55cd8232de559987b830d42de505ddf3ce6b2dea408e7f1bae8d559
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.202
|
data/docs/automation.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"automation": "create_folder",
|
|
9
9
|
"trigger": "realtime",
|
|
10
10
|
"interval": "week",
|
|
11
|
+
"name": "",
|
|
11
12
|
"schedule": {
|
|
12
13
|
"days_of_week": [
|
|
13
14
|
0,
|
|
@@ -26,6 +27,7 @@
|
|
|
26
27
|
],
|
|
27
28
|
"destination_replace_from": "",
|
|
28
29
|
"destination_replace_to": "",
|
|
30
|
+
"description": "",
|
|
29
31
|
"path": "",
|
|
30
32
|
"user_id": 1,
|
|
31
33
|
"user_ids": [
|
|
@@ -47,11 +49,13 @@
|
|
|
47
49
|
* `automation` (string): Automation type
|
|
48
50
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
49
51
|
* `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`
|
|
52
|
+
* `name` (string): Name for this automation.
|
|
50
53
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
|
51
54
|
* `source` (string): Source Path
|
|
52
55
|
* `destinations` (string): Destination Path
|
|
53
56
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
|
54
57
|
* `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
58
|
+
* `description` (string): Description for the this Automation.
|
|
55
59
|
* `path` (string): Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
56
60
|
* `user_id` (int64): User ID of the Automation's creator.
|
|
57
61
|
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
|
@@ -134,6 +138,8 @@ Files::Automation.create(
|
|
|
134
138
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
135
139
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
136
140
|
* `schedule` (object): Custom schedule for running this automation.
|
|
141
|
+
* `description` (string): Description for the this Automation.
|
|
142
|
+
* `name` (string): Name for this automation.
|
|
137
143
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
138
144
|
* `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
|
|
139
145
|
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
@@ -174,6 +180,8 @@ Files::Automation.update(id,
|
|
|
174
180
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
175
181
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
176
182
|
* `schedule` (object): Custom schedule for running this automation.
|
|
183
|
+
* `description` (string): Description for the this Automation.
|
|
184
|
+
* `name` (string): Name for this automation.
|
|
177
185
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
178
186
|
* `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
|
|
179
187
|
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
@@ -229,6 +237,8 @@ automation.update(
|
|
|
229
237
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
230
238
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
231
239
|
* `schedule` (object): Custom schedule for running this automation.
|
|
240
|
+
* `description` (string): Description for the this Automation.
|
|
241
|
+
* `name` (string): Name for this automation.
|
|
232
242
|
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
233
243
|
* `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
|
|
234
244
|
* `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
|
data/docs/behavior.md
CHANGED
|
@@ -8,6 +8,8 @@
|
|
|
8
8
|
"path": "",
|
|
9
9
|
"attachment_url": "",
|
|
10
10
|
"behavior": "webhook",
|
|
11
|
+
"name": "",
|
|
12
|
+
"description": "",
|
|
11
13
|
"value": {
|
|
12
14
|
"method": "GET"
|
|
13
15
|
}
|
|
@@ -18,6 +20,8 @@
|
|
|
18
20
|
* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
19
21
|
* `attachment_url` (string): URL for attached file
|
|
20
22
|
* `behavior` (string): Behavior type.
|
|
23
|
+
* `name` (string): Name for this behavior.
|
|
24
|
+
* `description` (string): Description for this behavior.
|
|
21
25
|
* `value` (object): Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
|
|
22
26
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
23
27
|
|
|
@@ -103,6 +107,8 @@ Files::Behavior.create(
|
|
|
103
107
|
|
|
104
108
|
* `value` (string): The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
105
109
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
110
|
+
* `name` (string): Name for this behavior.
|
|
111
|
+
* `description` (string): Description for this behavior.
|
|
106
112
|
* `path` (string): Required - Folder behaviors path.
|
|
107
113
|
* `behavior` (string): Required - Behavior type.
|
|
108
114
|
|
|
@@ -148,6 +154,8 @@ Files::Behavior.update(id,
|
|
|
148
154
|
* `id` (int64): Required - Behavior ID.
|
|
149
155
|
* `value` (string): The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
150
156
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
157
|
+
* `name` (string): Name for this behavior.
|
|
158
|
+
* `description` (string): Description for this behavior.
|
|
151
159
|
* `behavior` (string): Behavior type.
|
|
152
160
|
* `path` (string): Folder behaviors path.
|
|
153
161
|
|
|
@@ -183,6 +191,8 @@ behavior.update(
|
|
|
183
191
|
* `id` (int64): Required - Behavior ID.
|
|
184
192
|
* `value` (string): The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
185
193
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
194
|
+
* `name` (string): Name for this behavior.
|
|
195
|
+
* `description` (string): Description for this behavior.
|
|
186
196
|
* `behavior` (string): Behavior type.
|
|
187
197
|
* `path` (string): Folder behaviors path.
|
|
188
198
|
|
data/docs/inbox_registration.md
CHANGED
|
@@ -38,4 +38,4 @@ Files::InboxRegistration.list(
|
|
|
38
38
|
|
|
39
39
|
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
|
|
40
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
41
|
-
* `folder_behavior_id` (int64):
|
|
41
|
+
* `folder_behavior_id` (int64): ID of the associated Inbox.
|
data/docs/user.md
CHANGED
|
@@ -109,6 +109,7 @@
|
|
|
109
109
|
* `change_password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
|
|
110
110
|
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
111
111
|
* `group_id` (int64): Group ID to associate this user with.
|
|
112
|
+
* `imported_password_hash` (string): Pre-calculated hash of the user's password.
|
|
112
113
|
* `password` (string): User password.
|
|
113
114
|
* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
114
115
|
* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
|
|
@@ -213,6 +214,7 @@ Files::User.create(
|
|
|
213
214
|
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
214
215
|
* `group_id` (int64): Group ID to associate this user with.
|
|
215
216
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
|
217
|
+
* `imported_password_hash` (string): Pre-calculated hash of the user's password.
|
|
216
218
|
* `password` (string): User password.
|
|
217
219
|
* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
218
220
|
* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
|
|
@@ -344,6 +346,7 @@ Files::User.update(id,
|
|
|
344
346
|
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
345
347
|
* `group_id` (int64): Group ID to associate this user with.
|
|
346
348
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
|
349
|
+
* `imported_password_hash` (string): Pre-calculated hash of the user's password.
|
|
347
350
|
* `password` (string): User password.
|
|
348
351
|
* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
349
352
|
* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
|
|
@@ -496,6 +499,7 @@ user.update(
|
|
|
496
499
|
* `grant_permission` (string): Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
497
500
|
* `group_id` (int64): Group ID to associate this user with.
|
|
498
501
|
* `group_ids` (string): A list of group ids to associate this user with. Comma delimited.
|
|
502
|
+
* `imported_password_hash` (string): Pre-calculated hash of the user's password.
|
|
499
503
|
* `password` (string): User password.
|
|
500
504
|
* `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
501
505
|
* `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
|
data/lib/files.com/errors.rb
CHANGED
|
@@ -119,6 +119,7 @@ module Files
|
|
|
119
119
|
class ContactAdminForPasswordChangeHelpError < NotAuthorizedError; end
|
|
120
120
|
class FolderAdminOrBillingPermissionRequiredError < NotAuthorizedError; end
|
|
121
121
|
class FolderAdminPermissionRequiredError < NotAuthorizedError; end
|
|
122
|
+
class FullPermissionRequiredError < NotAuthorizedError; end
|
|
122
123
|
class HistoryPermissionRequiredError < NotAuthorizedError; end
|
|
123
124
|
class InsufficientPermissionForParamsError < NotAuthorizedError; end
|
|
124
125
|
class MustAuthenticateWithApiKeyError < NotAuthorizedError; end
|
|
@@ -134,6 +135,7 @@ module Files
|
|
|
134
135
|
class ReauthenticationNeededActionError < NotAuthorizedError; end
|
|
135
136
|
class SelfManagedRequiredError < NotAuthorizedError; end
|
|
136
137
|
class SiteAdminRequiredError < NotAuthorizedError; end
|
|
138
|
+
class SiteFilesAreImmutableError < NotAuthorizedError; end
|
|
137
139
|
class TwoFactorAuthenticationRequiredError < NotAuthorizedError; end
|
|
138
140
|
class UserIdWithoutSiteAdminError < NotAuthorizedError; end
|
|
139
141
|
class WritePermissionRequiredError < NotAuthorizedError; end
|
|
@@ -45,6 +45,15 @@ module Files
|
|
|
45
45
|
@attributes[:interval] = value
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
+
# string - Name for this automation.
|
|
49
|
+
def name
|
|
50
|
+
@attributes[:name]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def name=(value)
|
|
54
|
+
@attributes[:name] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
48
57
|
# object - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
|
49
58
|
def schedule
|
|
50
59
|
@attributes[:schedule]
|
|
@@ -90,6 +99,15 @@ module Files
|
|
|
90
99
|
@attributes[:destination_replace_to] = value
|
|
91
100
|
end
|
|
92
101
|
|
|
102
|
+
# string - Description for the this Automation.
|
|
103
|
+
def description
|
|
104
|
+
@attributes[:description]
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
def description=(value)
|
|
108
|
+
@attributes[:description] = value
|
|
109
|
+
end
|
|
110
|
+
|
|
93
111
|
# string - Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
94
112
|
def path
|
|
95
113
|
@attributes[:path]
|
|
@@ -183,6 +201,8 @@ module Files
|
|
|
183
201
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
184
202
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
185
203
|
# schedule - object - Custom schedule for running this automation.
|
|
204
|
+
# description - string - Description for the this Automation.
|
|
205
|
+
# name - string - Name for this automation.
|
|
186
206
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
187
207
|
# 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
208
|
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
@@ -202,6 +222,8 @@ module Files
|
|
|
202
222
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
|
203
223
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
|
204
224
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
225
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
226
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
205
227
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
206
228
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
207
229
|
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
@@ -294,6 +316,8 @@ module Files
|
|
|
294
316
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
295
317
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
296
318
|
# schedule - object - Custom schedule for running this automation.
|
|
319
|
+
# description - string - Description for the this Automation.
|
|
320
|
+
# name - string - Name for this automation.
|
|
297
321
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
298
322
|
# 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
|
|
299
323
|
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
@@ -310,6 +334,8 @@ module Files
|
|
|
310
334
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
|
311
335
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
312
336
|
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
|
337
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
338
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
313
339
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
314
340
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
315
341
|
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
@@ -332,6 +358,8 @@ module Files
|
|
|
332
358
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
333
359
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
334
360
|
# schedule - object - Custom schedule for running this automation.
|
|
361
|
+
# description - string - Description for the this Automation.
|
|
362
|
+
# name - string - Name for this automation.
|
|
335
363
|
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
|
|
336
364
|
# 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
|
|
337
365
|
# trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
|
|
@@ -351,6 +379,8 @@ module Files
|
|
|
351
379
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
|
352
380
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
353
381
|
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
|
382
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
383
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
354
384
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
|
355
385
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
|
|
356
386
|
raise InvalidParameterError.new("Bad parameter: trigger_action_path must be an String") if params.dig(:trigger_action_path) and !params.dig(:trigger_action_path).is_a?(String)
|
|
@@ -45,6 +45,24 @@ module Files
|
|
|
45
45
|
@attributes[:behavior] = value
|
|
46
46
|
end
|
|
47
47
|
|
|
48
|
+
# string - Name for this behavior.
|
|
49
|
+
def name
|
|
50
|
+
@attributes[:name]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def name=(value)
|
|
54
|
+
@attributes[:name] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - Description for this behavior.
|
|
58
|
+
def description
|
|
59
|
+
@attributes[:description]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def description=(value)
|
|
63
|
+
@attributes[:description] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
48
66
|
# object - Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
|
|
49
67
|
def value
|
|
50
68
|
@attributes[:value]
|
|
@@ -66,6 +84,8 @@ module Files
|
|
|
66
84
|
# Parameters:
|
|
67
85
|
# value - string - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
68
86
|
# attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
87
|
+
# name - string - Name for this behavior.
|
|
88
|
+
# description - string - Description for this behavior.
|
|
69
89
|
# behavior - string - Behavior type.
|
|
70
90
|
# path - string - Folder behaviors path.
|
|
71
91
|
def update(params = {})
|
|
@@ -74,6 +94,8 @@ module Files
|
|
|
74
94
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
75
95
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
|
76
96
|
raise InvalidParameterError.new("Bad parameter: value must be an String") if params.dig(:value) and !params.dig(:value).is_a?(String)
|
|
97
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
98
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
77
99
|
raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
|
|
78
100
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
|
79
101
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
@@ -190,10 +212,14 @@ module Files
|
|
|
190
212
|
# Parameters:
|
|
191
213
|
# value - string - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
192
214
|
# attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
215
|
+
# name - string - Name for this behavior.
|
|
216
|
+
# description - string - Description for this behavior.
|
|
193
217
|
# path (required) - string - Folder behaviors path.
|
|
194
218
|
# behavior (required) - string - Behavior type.
|
|
195
219
|
def self.create(params = {}, options = {})
|
|
196
220
|
raise InvalidParameterError.new("Bad parameter: value must be an String") if params.dig(:value) and !params.dig(:value).is_a?(String)
|
|
221
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
222
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
197
223
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
|
198
224
|
raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
|
|
199
225
|
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
|
@@ -226,6 +252,8 @@ module Files
|
|
|
226
252
|
# Parameters:
|
|
227
253
|
# value - string - The value of the folder behavior. Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
|
|
228
254
|
# attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
|
|
255
|
+
# name - string - Name for this behavior.
|
|
256
|
+
# description - string - Description for this behavior.
|
|
229
257
|
# behavior - string - Behavior type.
|
|
230
258
|
# path - string - Folder behaviors path.
|
|
231
259
|
def self.update(id, params = {}, options = {})
|
|
@@ -233,6 +261,8 @@ module Files
|
|
|
233
261
|
params[:id] = id
|
|
234
262
|
raise InvalidParameterError.new("Bad parameter: id must be one of String, Integer, Hash") if params.dig(:id) and [ String, Integer, Hash ].none? { |klass| params.dig(:id).is_a?(klass) }
|
|
235
263
|
raise InvalidParameterError.new("Bad parameter: value must be an String") if params.dig(:value) and !params.dig(:value).is_a?(String)
|
|
264
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
|
265
|
+
raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
|
|
236
266
|
raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
|
|
237
267
|
raise InvalidParameterError.new("Bad parameter: path must be one of String, Integer, Hash") if params.dig(:path) and [ String, Integer, Hash ].none? { |klass| params.dig(:path).is_a?(klass) }
|
|
238
268
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
|
@@ -47,12 +47,11 @@ module Files
|
|
|
47
47
|
# Parameters:
|
|
48
48
|
# 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 the X-Files-Cursor-Next header.
|
|
49
49
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
50
|
-
# folder_behavior_id
|
|
50
|
+
# folder_behavior_id - int64 - ID of the associated Inbox.
|
|
51
51
|
def self.list(params = {}, options = {})
|
|
52
52
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
|
53
53
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
|
54
54
|
raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params.dig(:folder_behavior_id) and !params.dig(:folder_behavior_id).is_a?(Integer)
|
|
55
|
-
raise MissingParameterError.new("Parameter missing: folder_behavior_id") unless params.dig(:folder_behavior_id)
|
|
56
55
|
|
|
57
56
|
List.new(InboxRegistration, params) do
|
|
58
57
|
Api.send_request("/inbox_registrations", :get, params, options)
|
|
@@ -482,6 +482,15 @@ module Files
|
|
|
482
482
|
@attributes[:group_id] = value
|
|
483
483
|
end
|
|
484
484
|
|
|
485
|
+
# string - Pre-calculated hash of the user's password.
|
|
486
|
+
def imported_password_hash
|
|
487
|
+
@attributes[:imported_password_hash]
|
|
488
|
+
end
|
|
489
|
+
|
|
490
|
+
def imported_password_hash=(value)
|
|
491
|
+
@attributes[:imported_password_hash] = value
|
|
492
|
+
end
|
|
493
|
+
|
|
485
494
|
# string - User password.
|
|
486
495
|
def password
|
|
487
496
|
@attributes[:password]
|
|
@@ -551,6 +560,7 @@ module Files
|
|
|
551
560
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
552
561
|
# group_id - int64 - Group ID to associate this user with.
|
|
553
562
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
|
563
|
+
# imported_password_hash - string - Pre-calculated hash of the user's password.
|
|
554
564
|
# password - string - User password.
|
|
555
565
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
556
566
|
# announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
|
|
@@ -597,6 +607,7 @@ module Files
|
|
|
597
607
|
raise InvalidParameterError.new("Bad parameter: grant_permission must be an String") if params.dig(:grant_permission) and !params.dig(:grant_permission).is_a?(String)
|
|
598
608
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
|
|
599
609
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
610
|
+
raise InvalidParameterError.new("Bad parameter: imported_password_hash must be an String") if params.dig(:imported_password_hash) and !params.dig(:imported_password_hash).is_a?(String)
|
|
600
611
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
|
601
612
|
raise InvalidParameterError.new("Bad parameter: password_confirmation must be an String") if params.dig(:password_confirmation) and !params.dig(:password_confirmation).is_a?(String)
|
|
602
613
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params.dig(:allowed_ips) and !params.dig(:allowed_ips).is_a?(String)
|
|
@@ -709,6 +720,7 @@ module Files
|
|
|
709
720
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
710
721
|
# group_id - int64 - Group ID to associate this user with.
|
|
711
722
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
|
723
|
+
# imported_password_hash - string - Pre-calculated hash of the user's password.
|
|
712
724
|
# password - string - User password.
|
|
713
725
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
714
726
|
# announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
|
|
@@ -751,6 +763,7 @@ module Files
|
|
|
751
763
|
raise InvalidParameterError.new("Bad parameter: grant_permission must be an String") if params.dig(:grant_permission) and !params.dig(:grant_permission).is_a?(String)
|
|
752
764
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
|
|
753
765
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
766
|
+
raise InvalidParameterError.new("Bad parameter: imported_password_hash must be an String") if params.dig(:imported_password_hash) and !params.dig(:imported_password_hash).is_a?(String)
|
|
754
767
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
|
755
768
|
raise InvalidParameterError.new("Bad parameter: password_confirmation must be an String") if params.dig(:password_confirmation) and !params.dig(:password_confirmation).is_a?(String)
|
|
756
769
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params.dig(:allowed_ips) and !params.dig(:allowed_ips).is_a?(String)
|
|
@@ -816,6 +829,7 @@ module Files
|
|
|
816
829
|
# grant_permission - string - Permission to grant on the user root. Can be blank or `full`, `read`, `write`, `list`, or `history`.
|
|
817
830
|
# group_id - int64 - Group ID to associate this user with.
|
|
818
831
|
# group_ids - string - A list of group ids to associate this user with. Comma delimited.
|
|
832
|
+
# imported_password_hash - string - Pre-calculated hash of the user's password.
|
|
819
833
|
# password - string - User password.
|
|
820
834
|
# password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
|
|
821
835
|
# announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
|
|
@@ -861,6 +875,7 @@ module Files
|
|
|
861
875
|
raise InvalidParameterError.new("Bad parameter: grant_permission must be an String") if params.dig(:grant_permission) and !params.dig(:grant_permission).is_a?(String)
|
|
862
876
|
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
|
|
863
877
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
|
878
|
+
raise InvalidParameterError.new("Bad parameter: imported_password_hash must be an String") if params.dig(:imported_password_hash) and !params.dig(:imported_password_hash).is_a?(String)
|
|
864
879
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
|
865
880
|
raise InvalidParameterError.new("Bad parameter: password_confirmation must be an String") if params.dig(:password_confirmation) and !params.dig(:password_confirmation).is_a?(String)
|
|
866
881
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params.dig(:allowed_ips) and !params.dig(:allowed_ips).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.202
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-08-
|
|
11
|
+
date: 2021-08-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|