files.com 1.0.136 → 1.0.141

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a5ecd71f2dbb0a9fa290875fd7b2f524856356df9412b4ff926b3c99bf6c02a2
4
- data.tar.gz: 79c93ada3bcafca093215ca6a362b949df2e2b54f1028484c21b49cd7ddd6c18
3
+ metadata.gz: e18007e80b80d7134a99a39f14bb21e1c114ded4dc65c89bea3ffc4a7dbbb4e2
4
+ data.tar.gz: 18542673883f8c55a40e5b471dab9e2a59afeee4fd5daa63109e570880a64905
5
5
  SHA512:
6
- metadata.gz: e5c761d12b575de7b69525e3d7063407fe50db5283be180a459048ff988f05c834533ee5b3d6b780304ff9eaa2b2a45509882d6cf22de5ea237bffe5ccbf1ea5
7
- data.tar.gz: 79ab474f6a6c3f7623a1966b5a14cfb0db0eac3e0e659b807e282dffedab20c8983d2d2317ae274e7067f2afc2e5a6cfdeca85873a19d80c202a0c23528ba3cb
6
+ metadata.gz: c5cc76b1adaf8a682384e6d0a0e20d07ace6beaf575e762a5557d5e70aee3cf6a6b63d88258302aeed0371dd97c3ea13e65a8fb4ac81480d0ac1092c1bd6901a
7
+ data.tar.gz: 3e2ecd619d56c3ea1ea2c4e5beea857c9c6a093643d2ecc39fbfaff5a1b7bc181fb231841cd073c68fcff08ef4ba208d5cef1fc0c08954f943865dd3f5c8ebbe
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.136
1
+ 1.0.141
data/build.sh ADDED
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env bash
2
+
3
+ bundle install
4
+ bundle exec rubocop --ignore-parent-exclusion
5
+ bundle exec rspec
data/docs/app.md CHANGED
@@ -17,6 +17,8 @@
17
17
  "remote_server_type": "",
18
18
  "folder_behavior_type": "",
19
19
  "external_homepage_url": "",
20
+ "marketing_youtube_url": "",
21
+ "tutorial_youtube_url": "",
20
22
  "app_type": "",
21
23
  "featured": true
22
24
  }
@@ -33,6 +35,8 @@
33
35
  * `remote_server_type` (string): Associated Remote Server type, if any
34
36
  * `folder_behavior_type` (string): Associated Folder Behavior type, if any
35
37
  * `external_homepage_url` (string): Link to external homepage
38
+ * `marketing_youtube_url` (string): Marketing video page
39
+ * `tutorial_youtube_url` (string): Tutorial video page
36
40
  * `app_type` (string): The type of the App
37
41
  * `featured` (boolean): Is featured on the App listing?
38
42
 
data/docs/automation.md CHANGED
@@ -37,7 +37,8 @@
37
37
  ],
38
38
  "webhook_url": "https://app.files.com/api/webhooks/abc123",
39
39
  "trigger_actions": "[ \"create\" ]",
40
- "trigger_action_path": "path/to/file/or/folder"
40
+ "trigger_action_path": "path/to/file/or/folder",
41
+ "value": "{\"limit\": \"1\"}"
41
42
  }
42
43
  ```
43
44
 
@@ -58,6 +59,7 @@
58
59
  * `webhook_url` (string): If trigger is `webhook`, this is the URL of the webhook to trigger the Automation.
59
60
  * `trigger_actions` (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
60
61
  * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
62
+ * `value` (object): A Hash of attributes specific to the automation type.
61
63
 
62
64
 
63
65
  ---
@@ -113,7 +115,8 @@ Files::Automation.create(
113
115
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
114
116
  trigger: "realtime",
115
117
  trigger_actions: "[ \"create\" ]",
116
- trigger_action_path: "path/to/file/or/folder"
118
+ trigger_action_path: "path/to/file/or/folder",
119
+ value: "{\"limit\": \"1\"}"
117
120
  )
118
121
  ```
119
122
 
@@ -132,6 +135,7 @@ Files::Automation.create(
132
135
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
133
136
  * `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
134
137
  * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
138
+ * `value` (object): A Hash of attributes specific to the automation type.
135
139
 
136
140
 
137
141
  ---
@@ -149,7 +153,8 @@ Files::Automation.update(id,
149
153
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
150
154
  trigger: "realtime",
151
155
  trigger_actions: "[ \"create\" ]",
152
- trigger_action_path: "path/to/file/or/folder"
156
+ trigger_action_path: "path/to/file/or/folder",
157
+ value: "{\"limit\": \"1\"}"
153
158
  )
154
159
  ```
155
160
 
@@ -169,6 +174,7 @@ Files::Automation.update(id,
169
174
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
170
175
  * `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
171
176
  * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
177
+ * `value` (object): A Hash of attributes specific to the automation type.
172
178
 
173
179
 
174
180
  ---
@@ -201,7 +207,8 @@ automation.update(
201
207
  schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
202
208
  trigger: "realtime",
203
209
  trigger_actions: "[ \"create\" ]",
204
- trigger_action_path: "path/to/file/or/folder"
210
+ trigger_action_path: "path/to/file/or/folder",
211
+ value: "{\"limit\": \"1\"}"
205
212
  )
206
213
  ```
207
214
 
@@ -221,6 +228,7 @@ automation.update(
221
228
  * `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
222
229
  * `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
223
230
  * `trigger_action_path` (string): If trigger is `action`, this is the path to watch for the specified trigger actions.
231
+ * `value` (object): A Hash of attributes specific to the automation type.
224
232
 
225
233
 
226
234
  ---
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "history_version": "20201213.2",
8
9
  "start_at": "2000-01-01T01:00:00Z",
9
10
  "end_at": "2000-01-01T01:00:00Z",
10
11
  "status": "ready",
@@ -32,6 +33,7 @@
32
33
  ```
33
34
 
34
35
  * `id` (int64): History Export ID
36
+ * `history_version` (string): Version of the history for the export.
35
37
  * `start_at` (date-time): Start date/time of export range.
36
38
  * `end_at` (date-time): End date/time of export range.
37
39
  * `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
@@ -7,6 +7,7 @@
7
7
  "id": 1,
8
8
  "authentication_method": "password",
9
9
  "hostname": "remote-server.com",
10
+ "remote_home_path": "/home/user1",
10
11
  "name": "My Remote server",
11
12
  "port": 1,
12
13
  "max_connections": 1,
@@ -38,6 +39,7 @@
38
39
  * `id` (int64): Remote server ID
39
40
  * `authentication_method` (string): Type of authentication method
40
41
  * `hostname` (string): Hostname or IP address
42
+ * `remote_home_path` (string): Initial home folder on remote server
41
43
  * `name` (string): Internal name for your reference
42
44
  * `port` (int64): Port for remote server. Not needed for S3.
43
45
  * `max_connections` (int64): Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
data/docs/sso_strategy.md CHANGED
@@ -77,7 +77,7 @@
77
77
  * `provision_group_inclusion` (string): Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
78
78
  * `provision_group_required` (string): Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
79
79
  * `provision_site_admin_groups` (string): Comma-separated list of group names whose members will be created as Site Admins.
80
- * `provision_attachments_permission` (boolean): Auto-provisioned users get Sharing permission?
80
+ * `provision_attachments_permission` (boolean): DEPRECATED: Auto-provisioned users get Sharing permission. Use a Group with the Bundle permission instead.
81
81
  * `provision_dav_permission` (boolean): Auto-provisioned users get WebDAV permission?
82
82
  * `provision_ftp_permission` (boolean): Auto-provisioned users get FTP permission?
83
83
  * `provision_sftp_permission` (boolean): Auto-provisioned users get SFTP permission?
data/docs/user.md CHANGED
@@ -60,7 +60,7 @@
60
60
  * `username` (string): User's username
61
61
  * `admin_group_ids` (array): List of group IDs of which this user is an administrator
62
62
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
63
- * `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
63
+ * `attachments_permission` (boolean): DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
64
64
  * `api_keys_count` (int64): Number of api keys associated with this user
65
65
  * `authenticate_until` (date-time): Scheduled Date/Time at which user will be deactivated
66
66
  * `authentication_method` (string): How is this user authenticated?
@@ -217,7 +217,7 @@ Files::User.create(
217
217
  * `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
218
218
  * `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
219
219
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
220
- * `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
220
+ * `attachments_permission` (boolean): DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
221
221
  * `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
222
222
  * `authentication_method` (string): How is this user authenticated?
223
223
  * `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
@@ -348,7 +348,7 @@ Files::User.update(id,
348
348
  * `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
349
349
  * `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
350
350
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
351
- * `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
351
+ * `attachments_permission` (boolean): DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
352
352
  * `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
353
353
  * `authentication_method` (string): How is this user authenticated?
354
354
  * `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
@@ -500,7 +500,7 @@ user.update(
500
500
  * `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
501
501
  * `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
502
502
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
503
- * `attachments_permission` (boolean): Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
503
+ * `attachments_permission` (boolean): DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
504
504
  * `authenticate_until` (string): Scheduled Date/Time at which user will be deactivated
505
505
  * `authentication_method` (string): How is this user authenticated?
506
506
  * `billing_permission` (boolean): Allow this user to perform operations on the account, payments, and invoices?
@@ -85,6 +85,7 @@ module Files
85
85
  class UserRequiredError < BadRequestError; end
86
86
 
87
87
  class InvalidParamsError < APIError; end
88
+ class InvalidCursorError < InvalidParamsError; end
88
89
  class NoValidInputParamsError < InvalidParamsError; end
89
90
  class ReauthenticationNeededFieldsError < InvalidParamsError; end
90
91
  class RequestParamPathCannotHaveTrailingWhitespaceError < InvalidParamsError; end
@@ -64,6 +64,16 @@ module Files
64
64
  @attributes[:external_homepage_url]
65
65
  end
66
66
 
67
+ # string - Marketing video page
68
+ def marketing_youtube_url
69
+ @attributes[:marketing_youtube_url]
70
+ end
71
+
72
+ # string - Tutorial video page
73
+ def tutorial_youtube_url
74
+ @attributes[:tutorial_youtube_url]
75
+ end
76
+
67
77
  # string - The type of the App
68
78
  def app_type
69
79
  @attributes[:app_type]
@@ -162,6 +162,15 @@ module Files
162
162
  @attributes[:trigger_action_path] = value
163
163
  end
164
164
 
165
+ # object - A Hash of attributes specific to the automation type.
166
+ def value
167
+ @attributes[:value]
168
+ end
169
+
170
+ def value=(value)
171
+ @attributes[:value] = value
172
+ end
173
+
165
174
  # Parameters:
166
175
  # automation (required) - string - Automation type
167
176
  # source - string - Source Path
@@ -176,6 +185,7 @@ module Files
176
185
  # trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
177
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
178
187
  # trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
188
+ # value - object - A Hash of attributes specific to the automation type.
179
189
  def update(params = {})
180
190
  params ||= {}
181
191
  params[:id] = @attributes[:id]
@@ -284,6 +294,7 @@ module Files
284
294
  # trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
285
295
  # 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
286
296
  # trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
297
+ # value - object - A Hash of attributes specific to the automation type.
287
298
  def self.create(params = {}, options = {})
288
299
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
289
300
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
@@ -298,6 +309,7 @@ module Files
298
309
  raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
299
310
  raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
300
311
  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)
312
+ raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
301
313
  raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
302
314
 
303
315
  response, options = Api.send_request("/automations", :post, params, options)
@@ -318,6 +330,7 @@ module Files
318
330
  # trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, `email`, or `action`.
319
331
  # 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
320
332
  # trigger_action_path - string - If trigger is `action`, this is the path to watch for the specified trigger actions.
333
+ # value - object - A Hash of attributes specific to the automation type.
321
334
  def self.update(id, params = {}, options = {})
322
335
  params ||= {}
323
336
  params[:id] = id
@@ -335,6 +348,7 @@ module Files
335
348
  raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
336
349
  raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params.dig(:trigger_actions) and !params.dig(:trigger_actions).is_a?(Array)
337
350
  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)
351
+ raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params.dig(:value) and !params.dig(:value).is_a?(Hash)
338
352
  raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
339
353
  raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
340
354
 
@@ -18,6 +18,15 @@ module Files
18
18
  @attributes[:id] = value
19
19
  end
20
20
 
21
+ # string - Version of the history for the export.
22
+ def history_version
23
+ @attributes[:history_version]
24
+ end
25
+
26
+ def history_version=(value)
27
+ @attributes[:history_version] = value
28
+ end
29
+
21
30
  # date-time - Start date/time of export range.
22
31
  def start_at
23
32
  @attributes[:start_at]
@@ -36,6 +36,15 @@ module Files
36
36
  @attributes[:hostname] = value
37
37
  end
38
38
 
39
+ # string - Initial home folder on remote server
40
+ def remote_home_path
41
+ @attributes[:remote_home_path]
42
+ end
43
+
44
+ def remote_home_path=(value)
45
+ @attributes[:remote_home_path] = value
46
+ end
47
+
39
48
  # string - Internal name for your reference
40
49
  def name
41
50
  @attributes[:name]
@@ -139,7 +139,7 @@ module Files
139
139
  @attributes[:provision_site_admin_groups]
140
140
  end
141
141
 
142
- # boolean - Auto-provisioned users get Sharing permission?
142
+ # boolean - DEPRECATED: Auto-provisioned users get Sharing permission. Use a Group with the Bundle permission instead.
143
143
  def provision_attachments_permission
144
144
  @attributes[:provision_attachments_permission]
145
145
  end
@@ -45,7 +45,7 @@ module Files
45
45
  @attributes[:allowed_ips] = value
46
46
  end
47
47
 
48
- # boolean - Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
48
+ # boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
49
49
  def attachments_permission
50
50
  @attributes[:attachments_permission]
51
51
  end
@@ -555,7 +555,7 @@ module Files
555
555
  # password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
556
556
  # announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
557
557
  # allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
558
- # attachments_permission - boolean - Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
558
+ # attachments_permission - boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
559
559
  # authenticate_until - string - Scheduled Date/Time at which user will be deactivated
560
560
  # authentication_method - string - How is this user authenticated?
561
561
  # billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
@@ -713,7 +713,7 @@ module Files
713
713
  # password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
714
714
  # announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
715
715
  # allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
716
- # attachments_permission - boolean - Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
716
+ # attachments_permission - boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
717
717
  # authenticate_until - string - Scheduled Date/Time at which user will be deactivated
718
718
  # authentication_method - string - How is this user authenticated?
719
719
  # billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
@@ -820,7 +820,7 @@ module Files
820
820
  # password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
821
821
  # announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
822
822
  # allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
823
- # attachments_permission - boolean - Can the user create Bundles (aka Share Links)? This field will be aliased or renamed in the future to `bundles_permission`.
823
+ # attachments_permission - boolean - DEPRECATED: Can the user create Bundles (aka Share Links)? Use the bundle permission instead.
824
824
  # authenticate_until - string - Scheduled Date/Time at which user will be deactivated
825
825
  # authentication_method - string - How is this user authenticated?
826
826
  # billing_permission - boolean - Allow this user to perform operations on the account, payments, and invoices?
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.136
4
+ version: 1.0.141
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-01-28 00:00:00.000000000 Z
11
+ date: 2021-02-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -85,6 +85,7 @@ files:
85
85
  - _VERSION
86
86
  - bin/files
87
87
  - bin/files-console
88
+ - build.sh
88
89
  - docs/account_line_item.md
89
90
  - docs/action.md
90
91
  - docs/api_key.md