files.com 1.1.113 → 1.1.115
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/README.md +3 -3
- data/_VERSION +1 -1
- data/docs/api_key.md +5 -5
- data/lib/files.com/models/api_key.rb +5 -5
- data/lib/files.com/version.rb +1 -1
- data/shared/normalization_for_comparison_test_data.json +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: 30d08c44cf76dc40af6da91c786166ace44b7cdc3f90da618ceea18d51ef8856
|
4
|
+
data.tar.gz: c3157dc9f0c8a813ff64cfd03f6a709c0ab4b29fa4384fb9c9c2749b2c8b4b51
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 23ec622064a33418d8ab643b1875e1e063e0be536f75131c3176ea6506b3ceabb36fc5641bc02c136f0f350aa5e985f6f7d301ea05a36cb0bbd769c826eb1e43
|
7
|
+
data.tar.gz: 341ec7627d24938c3863e3ee6f9dffd59182edac945710aba1fcf228b1d7fc73e9d1f1374fe738f8bc5450a309e79d0d56c872cb00461fbafff1e3e5b0e8812c
|
data/README.md
CHANGED
@@ -243,9 +243,9 @@ rescue for general `Files::Error` as a catch-all.
|
|
243
243
|
begin
|
244
244
|
session = Files::Session.create(username: "USERNAME", password: "BADPASSWORD")
|
245
245
|
rescue Files::NotAuthenticatedError => e
|
246
|
-
puts "An Authentication Error has
|
246
|
+
puts "An Authentication Error has occurred (#{e.class.to_s}): " + e.message
|
247
247
|
rescue Files::Error => e
|
248
|
-
puts "An Unknown Error has
|
248
|
+
puts "An Unknown Error has occurred (#{e.class.to_s}): " + e.message
|
249
249
|
end
|
250
250
|
```
|
251
251
|
|
@@ -253,7 +253,7 @@ end
|
|
253
253
|
|
254
254
|
#### SDK Errors
|
255
255
|
|
256
|
-
SDK errors are general errors that
|
256
|
+
SDK errors are general errors that occur within the SDK code. Each exception class inherits from a standard `Error` base class.
|
257
257
|
|
258
258
|
```ruby title="Example SDK Exception Class Inheritance Structure"
|
259
259
|
Files::APIConnectionError -> Files::Error -> StandardError
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.115
|
data/docs/api_key.md
CHANGED
@@ -27,7 +27,7 @@
|
|
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. 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).
|
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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
@@ -99,7 +99,7 @@ Files::ApiKey.create(
|
|
99
99
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
100
100
|
* `description` (string): User-supplied description of API key.
|
101
101
|
* `expires_at` (string): API Key expiration date
|
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).
|
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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
103
103
|
* `name` (string): Required - Internal name for the API Key. For your use.
|
104
104
|
* `path` (string): Folder path restriction for this API key.
|
105
105
|
|
@@ -120,7 +120,7 @@ Files::ApiKey.update_current(
|
|
120
120
|
|
121
121
|
* `expires_at` (string): API Key expiration date
|
122
122
|
* `name` (string): Internal name for the API Key. For your use.
|
123
|
-
* `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).
|
123
|
+
* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
124
124
|
|
125
125
|
|
126
126
|
---
|
@@ -141,7 +141,7 @@ Files::ApiKey.update(id,
|
|
141
141
|
* `id` (int64): Required - Api Key ID.
|
142
142
|
* `description` (string): User-supplied description of API key.
|
143
143
|
* `expires_at` (string): API Key expiration date
|
144
|
-
* `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).
|
144
|
+
* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
145
145
|
* `name` (string): Internal name for the API Key. For your use.
|
146
146
|
|
147
147
|
|
@@ -187,7 +187,7 @@ api_key.update(
|
|
187
187
|
* `id` (int64): Required - Api Key ID.
|
188
188
|
* `description` (string): User-supplied description of API key.
|
189
189
|
* `expires_at` (string): API Key expiration date
|
190
|
-
* `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).
|
190
|
+
* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
191
191
|
* `name` (string): Internal name for the API Key. For your use.
|
192
192
|
|
193
193
|
|
@@ -77,7 +77,7 @@ module Files
|
|
77
77
|
@attributes[:name] = value
|
78
78
|
end
|
79
79
|
|
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).
|
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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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
|
@@ -125,7 +125,7 @@ module Files
|
|
125
125
|
# Parameters:
|
126
126
|
# description - string - User-supplied description of API key.
|
127
127
|
# expires_at - string - API Key expiration date
|
128
|
-
# 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).
|
128
|
+
# 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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
129
129
|
# name - string - Internal name for the API Key. For your use.
|
130
130
|
def update(params = {})
|
131
131
|
params ||= {}
|
@@ -222,7 +222,7 @@ module Files
|
|
222
222
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
223
223
|
# description - string - User-supplied description of API key.
|
224
224
|
# expires_at - string - API Key expiration date
|
225
|
-
# 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).
|
225
|
+
# 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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
226
226
|
# name (required) - string - Internal name for the API Key. For your use.
|
227
227
|
# path - string - Folder path restriction for this API key.
|
228
228
|
def self.create(params = {}, options = {})
|
@@ -241,7 +241,7 @@ module Files
|
|
241
241
|
# Parameters:
|
242
242
|
# expires_at - string - API Key expiration date
|
243
243
|
# name - string - Internal name for the API Key. For your use.
|
244
|
-
# 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).
|
244
|
+
# 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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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.
|
245
245
|
def self.update_current(params = {}, options = {})
|
246
246
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
247
247
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
@@ -254,7 +254,7 @@ module Files
|
|
254
254
|
# Parameters:
|
255
255
|
# description - string - User-supplied description of API key.
|
256
256
|
# expires_at - string - API Key expiration date
|
257
|
-
# 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).
|
257
|
+
# 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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. 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
258
|
# name - string - Internal name for the API Key. For your use.
|
259
259
|
def self.update(id, params = {}, options = {})
|
260
260
|
params ||= {}
|
data/lib/files.com/version.rb
CHANGED
@@ -14,7 +14,7 @@
|
|
14
14
|
[ "a/b/c.txt\r", "a/b/c.txt" ],
|
15
15
|
[ " space_at_beginning", " space_at_beginning"],
|
16
16
|
[ "space_at_end ", "space_at_end"],
|
17
|
-
[ "tab\
|
17
|
+
[ "tab\tseparated", "tab\tseparated"],
|
18
18
|
[ "<title>hello</hello>", "<title>hello</hello>"],
|
19
19
|
[ "안녕하세요", "안녕하세요" ],
|
20
20
|
[ "こんにちは", "こんにちは" ],
|
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.115
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-08-
|
11
|
+
date: 2024-08-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|