files.com 1.1.7 → 1.1.9
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/api_key.md +6 -9
- data/docs/automation.md +39 -31
- data/lib/files.com/models/api_key.rb +5 -16
- data/lib/files.com/models/automation.rb +92 -80
- 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: 8df9fad40306ccfb67d356f32bb67d43cdbca987440ef2d60b405b514a6a6f1b
|
|
4
|
+
data.tar.gz: c46f17aba1e349f9574860df87afa580a68c2c961b9bc2d520c758eed57a0d59
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 66a46039dd1fcdae9df1694d536a72386572cada3f47bbb30e54178a13c11dc62b2df7e0dbcf0ab8fc4191dceedc3782d464726fe9b55a2919ec30e1ba2aab94
|
|
7
|
+
data.tar.gz: f031f4f1199c155d2d7001bdafb6f6f44afc1db7c1a2578f94cd1a4b12153d4bb447faf7384291f413198d590a7d7d73fe1ae9834533c308d177a6a42a685757
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.9
|
data/docs/api_key.md
CHANGED
|
@@ -27,11 +27,10 @@
|
|
|
27
27
|
* `key` (string): API Key actual key string
|
|
28
28
|
* `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
|
|
29
29
|
* `name` (string): Internal name for the API Key. For your use.
|
|
30
|
-
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
30
|
+
* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
31
31
|
* `platform` (string): If this API key represents a Desktop app, what platform was it created on?
|
|
32
32
|
* `url` (string): URL for API host.
|
|
33
33
|
* `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
|
|
34
|
-
* `path` (string): Folder path restriction for this api key.
|
|
35
34
|
|
|
36
35
|
|
|
37
36
|
---
|
|
@@ -90,8 +89,7 @@ Files::ApiKey.create(
|
|
|
90
89
|
name: "My Main API Key",
|
|
91
90
|
description: "example",
|
|
92
91
|
expires_at: "2000-01-01T01:00:00Z",
|
|
93
|
-
permission_set: "full"
|
|
94
|
-
path: "shared/docs"
|
|
92
|
+
permission_set: "full"
|
|
95
93
|
)
|
|
96
94
|
```
|
|
97
95
|
|
|
@@ -101,8 +99,7 @@ Files::ApiKey.create(
|
|
|
101
99
|
* `name` (string): Internal name for the API Key. For your use.
|
|
102
100
|
* `description` (string): User-supplied description of API key.
|
|
103
101
|
* `expires_at` (string): API Key expiration date
|
|
104
|
-
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
105
|
-
* `path` (string): Folder path restriction for this api key.
|
|
102
|
+
* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
106
103
|
|
|
107
104
|
|
|
108
105
|
---
|
|
@@ -121,7 +118,7 @@ Files::ApiKey.update_current(
|
|
|
121
118
|
|
|
122
119
|
* `expires_at` (string): API Key expiration date
|
|
123
120
|
* `name` (string): Internal name for the API Key. For your use.
|
|
124
|
-
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
121
|
+
* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
125
122
|
|
|
126
123
|
|
|
127
124
|
---
|
|
@@ -143,7 +140,7 @@ Files::ApiKey.update(id,
|
|
|
143
140
|
* `name` (string): Internal name for the API Key. For your use.
|
|
144
141
|
* `description` (string): User-supplied description of API key.
|
|
145
142
|
* `expires_at` (string): API Key expiration date
|
|
146
|
-
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
143
|
+
* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
147
144
|
|
|
148
145
|
|
|
149
146
|
---
|
|
@@ -189,7 +186,7 @@ api_key.update(
|
|
|
189
186
|
* `name` (string): Internal name for the API Key. For your use.
|
|
190
187
|
* `description` (string): User-supplied description of API key.
|
|
191
188
|
* `expires_at` (string): API Key expiration date
|
|
192
|
-
* `permission_set` (string): Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
189
|
+
* `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
193
190
|
|
|
194
191
|
|
|
195
192
|
---
|
data/docs/automation.md
CHANGED
|
@@ -5,69 +5,71 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"always_overwrite_size_matching_files": true,
|
|
8
9
|
"automation": "create_folder",
|
|
9
10
|
"deleted": true,
|
|
11
|
+
"description": "example",
|
|
12
|
+
"destination_replace_from": "example",
|
|
13
|
+
"destination_replace_to": "example",
|
|
14
|
+
"destinations": [
|
|
15
|
+
"destination"
|
|
16
|
+
],
|
|
10
17
|
"disabled": true,
|
|
11
|
-
"
|
|
18
|
+
"group_ids": [
|
|
19
|
+
1,
|
|
20
|
+
2
|
|
21
|
+
],
|
|
12
22
|
"interval": "week",
|
|
13
23
|
"last_modified_at": "2000-01-01T01:00:00Z",
|
|
14
24
|
"name": "example",
|
|
25
|
+
"path": "example",
|
|
26
|
+
"recurring_day": 25,
|
|
15
27
|
"schedule": "example",
|
|
16
28
|
"source": "example",
|
|
17
|
-
"destinations": [
|
|
18
|
-
"destination"
|
|
19
|
-
],
|
|
20
|
-
"destination_replace_from": "example",
|
|
21
|
-
"destination_replace_to": "example",
|
|
22
|
-
"description": "example",
|
|
23
|
-
"recurring_day": 25,
|
|
24
|
-
"path": "example",
|
|
25
|
-
"user_id": 1,
|
|
26
29
|
"sync_ids": [
|
|
27
30
|
1,
|
|
28
31
|
2
|
|
29
32
|
],
|
|
30
|
-
"
|
|
31
|
-
|
|
32
|
-
2
|
|
33
|
+
"trigger_actions": [
|
|
34
|
+
"create"
|
|
33
35
|
],
|
|
34
|
-
"
|
|
36
|
+
"trigger": "daily",
|
|
37
|
+
"user_id": 1,
|
|
38
|
+
"user_ids": [
|
|
35
39
|
1,
|
|
36
40
|
2
|
|
37
41
|
],
|
|
38
|
-
"webhook_url": "https://app.files.com/api/webhooks/abc123",
|
|
39
|
-
"trigger_actions": [
|
|
40
|
-
"create"
|
|
41
|
-
],
|
|
42
42
|
"value": {
|
|
43
43
|
"limit": "1"
|
|
44
|
-
}
|
|
44
|
+
},
|
|
45
|
+
"webhook_url": "https://app.files.com/api/webhooks/abc123"
|
|
45
46
|
}
|
|
46
47
|
```
|
|
47
48
|
|
|
48
49
|
* `id` (int64): Automation ID
|
|
50
|
+
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
49
51
|
* `automation` (string): Automation type
|
|
50
52
|
* `deleted` (boolean): Indicates if the automation has been deleted.
|
|
53
|
+
* `description` (string): Description for the this Automation.
|
|
54
|
+
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
|
55
|
+
* `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.
|
|
56
|
+
* `destinations` (array): Destination Paths
|
|
51
57
|
* `disabled` (boolean): If true, this automation will not run.
|
|
52
|
-
* `
|
|
58
|
+
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
|
53
59
|
* `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`
|
|
54
60
|
* `last_modified_at` (date-time): Time when automation was last modified. Does not change for name or description updates.
|
|
55
61
|
* `name` (string): Name for this automation.
|
|
62
|
+
* `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
63
|
+
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
56
64
|
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
|
57
65
|
* `source` (string): Source Path
|
|
58
|
-
* `destinations` (array): Destination Paths
|
|
59
|
-
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
|
60
|
-
* `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.
|
|
61
|
-
* `description` (string): Description for the this Automation.
|
|
62
|
-
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
63
|
-
* `path` (string): Path on which this Automation runs. Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
64
|
-
* `user_id` (int64): User ID of the Automation's creator.
|
|
65
66
|
* `sync_ids` (array): IDs of remote sync folder behaviors to run by this Automation
|
|
66
|
-
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
|
67
|
-
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
|
68
|
-
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
|
69
67
|
* `trigger_actions` (array): 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
|
|
68
|
+
* `trigger` (string): How this automation is triggered to run.
|
|
69
|
+
* `user_id` (int64): User ID of the Automation's creator.
|
|
70
|
+
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
|
70
71
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
72
|
+
* `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
|
71
73
|
* `destination` (string): DEPRECATED: Destination Path. Use `destinations` instead.
|
|
72
74
|
|
|
73
75
|
|
|
@@ -86,7 +88,7 @@ Files::Automation.list(
|
|
|
86
88
|
|
|
87
89
|
* `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.
|
|
88
90
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
89
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled
|
|
91
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled` or `last_modified_at`.
|
|
90
92
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
|
91
93
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
|
92
94
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
@@ -124,6 +126,7 @@ Files::Automation.create(
|
|
|
124
126
|
user_ids: [1,2],
|
|
125
127
|
group_ids: [1,2],
|
|
126
128
|
schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
|
|
129
|
+
always_overwrite_size_matching_files: true,
|
|
127
130
|
description: "example",
|
|
128
131
|
disabled: true,
|
|
129
132
|
name: "example",
|
|
@@ -148,6 +151,7 @@ Files::Automation.create(
|
|
|
148
151
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
149
152
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
150
153
|
* `schedule` (object): Custom schedule for running this automation.
|
|
154
|
+
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
151
155
|
* `description` (string): Description for the this Automation.
|
|
152
156
|
* `disabled` (boolean): If true, this automation will not run.
|
|
153
157
|
* `name` (string): Name for this automation.
|
|
@@ -187,6 +191,7 @@ Files::Automation.update(id,
|
|
|
187
191
|
user_ids: [1,2],
|
|
188
192
|
group_ids: [1,2],
|
|
189
193
|
schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
|
|
194
|
+
always_overwrite_size_matching_files: true,
|
|
190
195
|
description: "example",
|
|
191
196
|
disabled: true,
|
|
192
197
|
name: "example",
|
|
@@ -212,6 +217,7 @@ Files::Automation.update(id,
|
|
|
212
217
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
213
218
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
214
219
|
* `schedule` (object): Custom schedule for running this automation.
|
|
220
|
+
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
215
221
|
* `description` (string): Description for the this Automation.
|
|
216
222
|
* `disabled` (boolean): If true, this automation will not run.
|
|
217
223
|
* `name` (string): Name for this automation.
|
|
@@ -268,6 +274,7 @@ automation.update(
|
|
|
268
274
|
user_ids: [1,2],
|
|
269
275
|
group_ids: [1,2],
|
|
270
276
|
schedule: {"days_of_week":[0,1,3],"times_of_day":["7:30","11:30"],"time_zone":"Eastern Time (US & Canada)"},
|
|
277
|
+
always_overwrite_size_matching_files: true,
|
|
271
278
|
description: "example",
|
|
272
279
|
disabled: true,
|
|
273
280
|
name: "example",
|
|
@@ -293,6 +300,7 @@ automation.update(
|
|
|
293
300
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
294
301
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
295
302
|
* `schedule` (object): Custom schedule for running this automation.
|
|
303
|
+
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
296
304
|
* `description` (string): Description for the this Automation.
|
|
297
305
|
* `disabled` (boolean): If true, this automation will not run.
|
|
298
306
|
* `name` (string): Name for this automation.
|
|
@@ -77,7 +77,7 @@ module Files
|
|
|
77
77
|
@attributes[:name] = value
|
|
78
78
|
end
|
|
79
79
|
|
|
80
|
-
# string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
80
|
+
# string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
81
81
|
def permission_set
|
|
82
82
|
@attributes[:permission_set]
|
|
83
83
|
end
|
|
@@ -113,20 +113,11 @@ module Files
|
|
|
113
113
|
@attributes[:user_id] = value
|
|
114
114
|
end
|
|
115
115
|
|
|
116
|
-
# string - Folder path restriction for this api key.
|
|
117
|
-
def path
|
|
118
|
-
@attributes[:path]
|
|
119
|
-
end
|
|
120
|
-
|
|
121
|
-
def path=(value)
|
|
122
|
-
@attributes[:path] = value
|
|
123
|
-
end
|
|
124
|
-
|
|
125
116
|
# Parameters:
|
|
126
117
|
# name - string - Internal name for the API Key. For your use.
|
|
127
118
|
# description - string - User-supplied description of API key.
|
|
128
119
|
# expires_at - string - API Key expiration date
|
|
129
|
-
# permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
120
|
+
# permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
130
121
|
def update(params = {})
|
|
131
122
|
params ||= {}
|
|
132
123
|
params[:id] = @attributes[:id]
|
|
@@ -223,15 +214,13 @@ module Files
|
|
|
223
214
|
# name - string - Internal name for the API Key. For your use.
|
|
224
215
|
# description - string - User-supplied description of API key.
|
|
225
216
|
# expires_at - string - API Key expiration date
|
|
226
|
-
# permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
227
|
-
# path - string - Folder path restriction for this api key.
|
|
217
|
+
# permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
228
218
|
def self.create(params = {}, options = {})
|
|
229
219
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
230
220
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
231
221
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
232
222
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
233
223
|
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
234
|
-
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
235
224
|
|
|
236
225
|
response, options = Api.send_request("/api_keys", :post, params, options)
|
|
237
226
|
ApiKey.new(response.data, options)
|
|
@@ -240,7 +229,7 @@ module Files
|
|
|
240
229
|
# Parameters:
|
|
241
230
|
# expires_at - string - API Key expiration date
|
|
242
231
|
# name - string - Internal name for the API Key. For your use.
|
|
243
|
-
# permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
232
|
+
# permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
244
233
|
def self.update_current(params = {}, options = {})
|
|
245
234
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
246
235
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
@@ -254,7 +243,7 @@ module Files
|
|
|
254
243
|
# name - string - Internal name for the API Key. For your use.
|
|
255
244
|
# description - string - User-supplied description of API key.
|
|
256
245
|
# expires_at - string - API Key expiration date
|
|
257
|
-
# permission_set - string - Permissions for this API Key. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
246
|
+
# permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
|
|
258
247
|
def self.update(id, params = {}, options = {})
|
|
259
248
|
params ||= {}
|
|
260
249
|
params[:id] = id
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
22
|
+
def always_overwrite_size_matching_files
|
|
23
|
+
@attributes[:always_overwrite_size_matching_files]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def always_overwrite_size_matching_files=(value)
|
|
27
|
+
@attributes[:always_overwrite_size_matching_files] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# string - Automation type
|
|
22
31
|
def automation
|
|
23
32
|
@attributes[:automation]
|
|
@@ -36,6 +45,42 @@ module Files
|
|
|
36
45
|
@attributes[:deleted] = value
|
|
37
46
|
end
|
|
38
47
|
|
|
48
|
+
# string - Description for the this Automation.
|
|
49
|
+
def description
|
|
50
|
+
@attributes[:description]
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
def description=(value)
|
|
54
|
+
@attributes[:description] = value
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
# string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
|
58
|
+
def destination_replace_from
|
|
59
|
+
@attributes[:destination_replace_from]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def destination_replace_from=(value)
|
|
63
|
+
@attributes[:destination_replace_from] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
66
|
+
# string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
67
|
+
def destination_replace_to
|
|
68
|
+
@attributes[:destination_replace_to]
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
def destination_replace_to=(value)
|
|
72
|
+
@attributes[:destination_replace_to] = value
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# array - Destination Paths
|
|
76
|
+
def destinations
|
|
77
|
+
@attributes[:destinations]
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def destinations=(value)
|
|
81
|
+
@attributes[:destinations] = value
|
|
82
|
+
end
|
|
83
|
+
|
|
39
84
|
# boolean - If true, this automation will not run.
|
|
40
85
|
def disabled
|
|
41
86
|
@attributes[:disabled]
|
|
@@ -45,13 +90,13 @@ module Files
|
|
|
45
90
|
@attributes[:disabled] = value
|
|
46
91
|
end
|
|
47
92
|
|
|
48
|
-
#
|
|
49
|
-
def
|
|
50
|
-
@attributes[:
|
|
93
|
+
# array - IDs of Groups for the Automation (i.e. who to Request File from)
|
|
94
|
+
def group_ids
|
|
95
|
+
@attributes[:group_ids]
|
|
51
96
|
end
|
|
52
97
|
|
|
53
|
-
def
|
|
54
|
-
@attributes[:
|
|
98
|
+
def group_ids=(value)
|
|
99
|
+
@attributes[:group_ids] = value
|
|
55
100
|
end
|
|
56
101
|
|
|
57
102
|
# 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`
|
|
@@ -81,6 +126,24 @@ module Files
|
|
|
81
126
|
@attributes[:name] = value
|
|
82
127
|
end
|
|
83
128
|
|
|
129
|
+
# string - Path on which this Automation runs. Supports globs, except on remote mounts. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
|
130
|
+
def path
|
|
131
|
+
@attributes[:path]
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def path=(value)
|
|
135
|
+
@attributes[:path] = value
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# int64 - If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
139
|
+
def recurring_day
|
|
140
|
+
@attributes[:recurring_day]
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
def recurring_day=(value)
|
|
144
|
+
@attributes[:recurring_day] = value
|
|
145
|
+
end
|
|
146
|
+
|
|
84
147
|
# object - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
|
85
148
|
def schedule
|
|
86
149
|
@attributes[:schedule]
|
|
@@ -99,58 +162,31 @@ module Files
|
|
|
99
162
|
@attributes[:source] = value
|
|
100
163
|
end
|
|
101
164
|
|
|
102
|
-
# array -
|
|
103
|
-
def
|
|
104
|
-
@attributes[:
|
|
105
|
-
end
|
|
106
|
-
|
|
107
|
-
def destinations=(value)
|
|
108
|
-
@attributes[:destinations] = value
|
|
109
|
-
end
|
|
110
|
-
|
|
111
|
-
# string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
|
112
|
-
def destination_replace_from
|
|
113
|
-
@attributes[:destination_replace_from]
|
|
114
|
-
end
|
|
115
|
-
|
|
116
|
-
def destination_replace_from=(value)
|
|
117
|
-
@attributes[:destination_replace_from] = value
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
# string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
|
|
121
|
-
def destination_replace_to
|
|
122
|
-
@attributes[:destination_replace_to]
|
|
123
|
-
end
|
|
124
|
-
|
|
125
|
-
def destination_replace_to=(value)
|
|
126
|
-
@attributes[:destination_replace_to] = value
|
|
127
|
-
end
|
|
128
|
-
|
|
129
|
-
# string - Description for the this Automation.
|
|
130
|
-
def description
|
|
131
|
-
@attributes[:description]
|
|
165
|
+
# array - IDs of remote sync folder behaviors to run by this Automation
|
|
166
|
+
def sync_ids
|
|
167
|
+
@attributes[:sync_ids]
|
|
132
168
|
end
|
|
133
169
|
|
|
134
|
-
def
|
|
135
|
-
@attributes[:
|
|
170
|
+
def sync_ids=(value)
|
|
171
|
+
@attributes[:sync_ids] = value
|
|
136
172
|
end
|
|
137
173
|
|
|
138
|
-
#
|
|
139
|
-
def
|
|
140
|
-
@attributes[:
|
|
174
|
+
# array - 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
|
|
175
|
+
def trigger_actions
|
|
176
|
+
@attributes[:trigger_actions]
|
|
141
177
|
end
|
|
142
178
|
|
|
143
|
-
def
|
|
144
|
-
@attributes[:
|
|
179
|
+
def trigger_actions=(value)
|
|
180
|
+
@attributes[:trigger_actions] = value
|
|
145
181
|
end
|
|
146
182
|
|
|
147
|
-
# string -
|
|
148
|
-
def
|
|
149
|
-
@attributes[:
|
|
183
|
+
# string - How this automation is triggered to run.
|
|
184
|
+
def trigger
|
|
185
|
+
@attributes[:trigger]
|
|
150
186
|
end
|
|
151
187
|
|
|
152
|
-
def
|
|
153
|
-
@attributes[:
|
|
188
|
+
def trigger=(value)
|
|
189
|
+
@attributes[:trigger] = value
|
|
154
190
|
end
|
|
155
191
|
|
|
156
192
|
# int64 - User ID of the Automation's creator.
|
|
@@ -162,15 +198,6 @@ module Files
|
|
|
162
198
|
@attributes[:user_id] = value
|
|
163
199
|
end
|
|
164
200
|
|
|
165
|
-
# array - IDs of remote sync folder behaviors to run by this Automation
|
|
166
|
-
def sync_ids
|
|
167
|
-
@attributes[:sync_ids]
|
|
168
|
-
end
|
|
169
|
-
|
|
170
|
-
def sync_ids=(value)
|
|
171
|
-
@attributes[:sync_ids] = value
|
|
172
|
-
end
|
|
173
|
-
|
|
174
201
|
# array - IDs of Users for the Automation (i.e. who to Request File from)
|
|
175
202
|
def user_ids
|
|
176
203
|
@attributes[:user_ids]
|
|
@@ -180,13 +207,13 @@ module Files
|
|
|
180
207
|
@attributes[:user_ids] = value
|
|
181
208
|
end
|
|
182
209
|
|
|
183
|
-
#
|
|
184
|
-
def
|
|
185
|
-
@attributes[:
|
|
210
|
+
# object - A Hash of attributes specific to the automation type.
|
|
211
|
+
def value
|
|
212
|
+
@attributes[:value]
|
|
186
213
|
end
|
|
187
214
|
|
|
188
|
-
def
|
|
189
|
-
@attributes[:
|
|
215
|
+
def value=(value)
|
|
216
|
+
@attributes[:value] = value
|
|
190
217
|
end
|
|
191
218
|
|
|
192
219
|
# string - If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
|
|
@@ -198,24 +225,6 @@ module Files
|
|
|
198
225
|
@attributes[:webhook_url] = value
|
|
199
226
|
end
|
|
200
227
|
|
|
201
|
-
# array - 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
|
|
202
|
-
def trigger_actions
|
|
203
|
-
@attributes[:trigger_actions]
|
|
204
|
-
end
|
|
205
|
-
|
|
206
|
-
def trigger_actions=(value)
|
|
207
|
-
@attributes[:trigger_actions] = value
|
|
208
|
-
end
|
|
209
|
-
|
|
210
|
-
# object - A Hash of attributes specific to the automation type.
|
|
211
|
-
def value
|
|
212
|
-
@attributes[:value]
|
|
213
|
-
end
|
|
214
|
-
|
|
215
|
-
def value=(value)
|
|
216
|
-
@attributes[:value] = value
|
|
217
|
-
end
|
|
218
|
-
|
|
219
228
|
# string - DEPRECATED: Destination Path. Use `destinations` instead.
|
|
220
229
|
def destination
|
|
221
230
|
@attributes[:destination]
|
|
@@ -248,6 +257,7 @@ module Files
|
|
|
248
257
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
249
258
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
250
259
|
# schedule - object - Custom schedule for running this automation.
|
|
260
|
+
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
251
261
|
# description - string - Description for the this Automation.
|
|
252
262
|
# disabled - boolean - If true, this automation will not run.
|
|
253
263
|
# name - string - Name for this automation.
|
|
@@ -311,7 +321,7 @@ module Files
|
|
|
311
321
|
# Parameters:
|
|
312
322
|
# 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.
|
|
313
323
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
314
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled
|
|
324
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[automation]=desc`). Valid fields are `automation`, `disabled` or `last_modified_at`.
|
|
315
325
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ automation, disabled ]` and `[ disabled, automation ]`.
|
|
316
326
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
|
317
327
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
@@ -365,6 +375,7 @@ module Files
|
|
|
365
375
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
366
376
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
367
377
|
# schedule - object - Custom schedule for running this automation.
|
|
378
|
+
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
368
379
|
# description - string - Description for the this Automation.
|
|
369
380
|
# disabled - boolean - If true, this automation will not run.
|
|
370
381
|
# name - string - Name for this automation.
|
|
@@ -421,6 +432,7 @@ module Files
|
|
|
421
432
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
422
433
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
|
423
434
|
# schedule - object - Custom schedule for running this automation.
|
|
435
|
+
# always_overwrite_size_matching_files - boolean - Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage.
|
|
424
436
|
# description - string - Description for the this Automation.
|
|
425
437
|
# disabled - boolean - If true, this automation will not run.
|
|
426
438
|
# name - string - Name for this automation.
|
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.9
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- files.com
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-12-
|
|
11
|
+
date: 2023-12-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|