files.com 1.1.449 → 1.1.450
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/api_key.md +3 -7
- data/docs/automation_run.md +1 -1
- data/lib/files.com/models/api_key.rb +2 -6
- data/lib/files.com/models/automation_run.rb +1 -1
- data/lib/files.com/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4c0f3a4a91abf6fe785359acd50d2ad8f87d3c76c8730a22098f8ef99b64f76e
|
|
4
|
+
data.tar.gz: 0ab6fb9555e2c094c27f42d7bf70524931ec496e9886f6320cbf620bf8035490
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 052b7b30fa6b1a4735eaf782ce5e6c2fe771e3b8238764d678c16c3cd8c6c5009ceb31ea104a8bdd7ef5adb7200f506c80932ab4ff3b37f27785681256f0f3ca
|
|
7
|
+
data.tar.gz: '0784c3fdc84bcb2eedc245026bf29e2e22729102a1dec0e915143bbbcf4909c035542a3b0372278411ba40a7c84b096280d8f5c9b3b4709985114d848665ed6a'
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.450
|
data/docs/api_key.md
CHANGED
|
@@ -94,10 +94,10 @@ Files::ApiKey.create(
|
|
|
94
94
|
user_id: 1,
|
|
95
95
|
description: "example",
|
|
96
96
|
expires_at: "2000-01-01T01:00:00Z",
|
|
97
|
-
permission_set: "full",
|
|
98
97
|
name: "My Main API Key",
|
|
99
98
|
aws_style_credentials: true,
|
|
100
|
-
path: "shared/docs"
|
|
99
|
+
path: "shared/docs",
|
|
100
|
+
permission_set: "full"
|
|
101
101
|
)
|
|
102
102
|
```
|
|
103
103
|
|
|
@@ -106,10 +106,10 @@ Files::ApiKey.create(
|
|
|
106
106
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
107
107
|
* `description` (string): User-supplied description of API key.
|
|
108
108
|
* `expires_at` (string): API Key expiration date
|
|
109
|
-
* `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.
|
|
110
109
|
* `name` (string): Required - Internal name for the API Key. For your use.
|
|
111
110
|
* `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
|
|
112
111
|
* `path` (string): Folder path restriction for `office_integration` permission set API keys.
|
|
112
|
+
* `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.
|
|
113
113
|
|
|
114
114
|
|
|
115
115
|
---
|
|
@@ -139,7 +139,6 @@ Files::ApiKey.update_current(
|
|
|
139
139
|
Files::ApiKey.update(id,
|
|
140
140
|
description: "example",
|
|
141
141
|
expires_at: "2000-01-01T01:00:00Z",
|
|
142
|
-
permission_set: "full",
|
|
143
142
|
name: "My Main API Key"
|
|
144
143
|
)
|
|
145
144
|
```
|
|
@@ -149,7 +148,6 @@ Files::ApiKey.update(id,
|
|
|
149
148
|
* `id` (int64): Required - Api Key ID.
|
|
150
149
|
* `description` (string): User-supplied description of API key.
|
|
151
150
|
* `expires_at` (string): API Key expiration date
|
|
152
|
-
* `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.
|
|
153
151
|
* `name` (string): Internal name for the API Key. For your use.
|
|
154
152
|
|
|
155
153
|
|
|
@@ -185,7 +183,6 @@ api_key = Files::ApiKey.find(id)
|
|
|
185
183
|
api_key.update(
|
|
186
184
|
description: "example",
|
|
187
185
|
expires_at: "2000-01-01T01:00:00Z",
|
|
188
|
-
permission_set: "full",
|
|
189
186
|
name: "My Main API Key"
|
|
190
187
|
)
|
|
191
188
|
```
|
|
@@ -195,7 +192,6 @@ api_key.update(
|
|
|
195
192
|
* `id` (int64): Required - Api Key ID.
|
|
196
193
|
* `description` (string): User-supplied description of API key.
|
|
197
194
|
* `expires_at` (string): API Key expiration date
|
|
198
|
-
* `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.
|
|
199
195
|
* `name` (string): Internal name for the API Key. For your use.
|
|
200
196
|
|
|
201
197
|
|
data/docs/automation_run.md
CHANGED
|
@@ -54,7 +54,7 @@ Files::AutomationRun.list(
|
|
|
54
54
|
* `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.
|
|
55
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
56
56
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
57
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[
|
|
57
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
58
58
|
* `automation_id` (int64): Required - ID of the associated Automation.
|
|
59
59
|
|
|
60
60
|
|
|
@@ -152,7 +152,6 @@ module Files
|
|
|
152
152
|
# Parameters:
|
|
153
153
|
# description - string - User-supplied description of API key.
|
|
154
154
|
# expires_at - string - API Key expiration date
|
|
155
|
-
# 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.
|
|
156
155
|
# name - string - Internal name for the API Key. For your use.
|
|
157
156
|
def update(params = {})
|
|
158
157
|
params ||= {}
|
|
@@ -161,7 +160,6 @@ module Files
|
|
|
161
160
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
162
161
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
163
162
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
164
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
165
163
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
166
164
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
167
165
|
|
|
@@ -249,17 +247,17 @@ module Files
|
|
|
249
247
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
250
248
|
# description - string - User-supplied description of API key.
|
|
251
249
|
# expires_at - string - API Key expiration date
|
|
252
|
-
# 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.
|
|
253
250
|
# name (required) - string - Internal name for the API Key. For your use.
|
|
254
251
|
# aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
|
|
255
252
|
# path - string - Folder path restriction for `office_integration` permission set API keys.
|
|
253
|
+
# 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.
|
|
256
254
|
def self.create(params = {}, options = {})
|
|
257
255
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
258
256
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
259
257
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
260
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
261
258
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
262
259
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
|
|
260
|
+
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
263
261
|
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
|
264
262
|
|
|
265
263
|
response, options = Api.send_request("/api_keys", :post, params, options)
|
|
@@ -282,7 +280,6 @@ module Files
|
|
|
282
280
|
# Parameters:
|
|
283
281
|
# description - string - User-supplied description of API key.
|
|
284
282
|
# expires_at - string - API Key expiration date
|
|
285
|
-
# 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.
|
|
286
283
|
# name - string - Internal name for the API Key. For your use.
|
|
287
284
|
def self.update(id, params = {}, options = {})
|
|
288
285
|
params ||= {}
|
|
@@ -290,7 +287,6 @@ module Files
|
|
|
290
287
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
291
288
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
292
289
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
293
|
-
raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
|
|
294
290
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
295
291
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
296
292
|
|
|
@@ -84,7 +84,7 @@ module Files
|
|
|
84
84
|
# 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.
|
|
85
85
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
86
86
|
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
87
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[
|
|
87
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
88
88
|
# automation_id (required) - int64 - ID of the associated Automation.
|
|
89
89
|
def self.list(params = {}, options = {})
|
|
90
90
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
data/lib/files.com/version.rb
CHANGED