files.com 1.1.8 → 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 +1 -1
- data/lib/files.com/models/api_key.rb +5 -16
- data/lib/files.com/models/automation.rb +1 -1
- 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
@@ -88,7 +88,7 @@ Files::Automation.list(
|
|
88
88
|
|
89
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.
|
90
90
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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
|
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`.
|
92
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 ]`.
|
93
93
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
94
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`.
|
@@ -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
|
@@ -321,7 +321,7 @@ module Files
|
|
321
321
|
# Parameters:
|
322
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.
|
323
323
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
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
|
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`.
|
325
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 ]`.
|
326
326
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
327
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`.
|
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
|