files.com 1.0.138 → 1.0.143

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ee93992620b1a364ee05b7064f7c180b10c10a44f343ef0d946c1c489538cd10
4
- data.tar.gz: 2e13bdb3dde8aa1907ecab9e3ee0954a19b5e20fef0fc636a9859eacd8b183a2
3
+ metadata.gz: 8357dce4d4dada928ca826660bac6882f99f35f1db3ff7ece5d3296a4a577657
4
+ data.tar.gz: 05e573ac5bb3dddb2fd226cab1faaedd239550f2e2bc5df95aad21732e367586
5
5
  SHA512:
6
- metadata.gz: de65d0ca807e2d162205891478013b969e99b2c8cba34731eb967364bcf4d949f0ccec766517d4104c0a429c3257bab0e495b5b4eb395f1df68626ced81a463f
7
- data.tar.gz: cf26395290eb7d9b7cf7f6b7155ff0d807f0da21c675120191c0ba702efefb5c52261314c63635709eedb947f29170621d1337496cdf8ae087e4e1496299e473
6
+ metadata.gz: 9cf2790c508c69d7147185ae01b0583f846131544fa5ddf43b01a9f2c2dbef3854bc6eb9d270dd6e7f3add7635c0551e8c82c58025822f928a091b2e2e2e4f80
7
+ data.tar.gz: '079ba9392f094c1c2dfa8a9bc5cb2641d34450258c8a0ef93058d1c63c769fddcfc71700d681c547f84800aa1b26ed0be711bbb450a9030a0e6ecf3d8a98fc8f'
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.138
1
+ 1.0.143
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).
@@ -56,10 +56,6 @@ module Files
56
56
  end
57
57
  end
58
58
 
59
- class ProcessingPendingError < APIError; end
60
-
61
- class AccountInBadStandingError < APIError; end
62
- class AccountOverdueError < AccountInBadStandingError; end
63
59
 
64
60
  class BadRequestError < APIError; end
65
61
  class AttachmentTooLargeError < BadRequestError; end
@@ -68,42 +64,40 @@ module Files
68
64
  class DatetimeParseError < BadRequestError; end
69
65
  class DestinationSameError < BadRequestError; end
70
66
  class FolderMustNotBeAFileError < BadRequestError; end
67
+ class InvalidCursorError < BadRequestError; end
71
68
  class InvalidFilterCombinationError < BadRequestError; end
72
69
  class InvalidFilterFieldError < BadRequestError; end
73
70
  class InvalidInputEncodingError < BadRequestError; end
74
71
  class InvalidInterfaceError < BadRequestError; end
75
- class InvalidOauthError < BadRequestError; end
76
72
  class InvalidOauthProviderError < BadRequestError; end
77
73
  class InvalidReturnToUrlError < BadRequestError; end
78
74
  class InvalidUploadOffsetError < BadRequestError; end
79
- class InvalidUsernameOrPasswordError < BadRequestError; end
75
+ class NoValidInputParamsError < BadRequestError; end
80
76
  class OperationOnNonScimResourceError < BadRequestError; end
77
+ class ReauthenticationNeededFieldsError < BadRequestError; end
78
+ class RequestParamPathCannotHaveTrailingWhitespaceError < BadRequestError; end
79
+ class RequestParamsContainInvalidCharacterError < BadRequestError; end
80
+ class RequestParamsInvalidError < BadRequestError; end
81
+ class RequestParamsRequiredError < BadRequestError; end
82
+ class UnsupportedCurrencyError < BadRequestError; end
81
83
  class UnsupportedHttpResponseFormatError < BadRequestError; end
82
84
  class UnsupportedMediaTypeError < BadRequestError; end
83
85
  class UserIdInvalidError < BadRequestError; end
84
86
  class UserIdOnUserEndpointError < BadRequestError; end
85
87
  class UserRequiredError < BadRequestError; end
86
88
 
87
- class InvalidParamsError < APIError; end
88
- class InvalidCursorError < InvalidParamsError; end
89
- class NoValidInputParamsError < InvalidParamsError; end
90
- class ReauthenticationNeededFieldsError < InvalidParamsError; end
91
- class RequestParamPathCannotHaveTrailingWhitespaceError < InvalidParamsError; end
92
- class RequestParamsContainInvalidCharacterError < InvalidParamsError; end
93
- class RequestParamsInvalidError < InvalidParamsError; end
94
- class RequestParamsRequiredError < InvalidParamsError; end
95
- class UnsupportedCurrencyError < InvalidParamsError; end
96
-
97
- class LockedError < APIError; end
98
- class FileLockedError < LockedError; end
99
- class FolderLockedError < LockedError; end
100
- class ResourceLockedError < LockedError; end
101
- class SubfolderLockedError < LockedError; end
102
-
103
89
  class NotAuthenticatedError < APIError; end
90
+ class AuthenticationRequiredError < NotAuthenticatedError; end
91
+ class BundleRegistrationCodeFailedError < NotAuthenticatedError; end
92
+ class InboxRegistrationCodeFailedError < NotAuthenticatedError; end
93
+ class InvalidCredentialsError < NotAuthenticatedError; end
94
+ class InvalidOauthError < NotAuthenticatedError; end
95
+ class InvalidOrExpiredCodeError < NotAuthenticatedError; end
96
+ class InvalidUsernameOrPasswordError < NotAuthenticatedError; end
97
+ class LockedOutError < NotAuthenticatedError; end
98
+ class LockoutRegionMismatchError < NotAuthenticatedError; end
104
99
  class OneTimePasswordIncorrectError < NotAuthenticatedError; end
105
100
  class TwoFactorAuthenticationErrorError < NotAuthenticatedError; end
106
- class TwoFactorAuthenticationRequiredError < NotAuthenticatedError; end
107
101
  class TwoFactorAuthenticationSetupExpiredError < NotAuthenticatedError; end
108
102
 
109
103
  class NotAuthorizedError < APIError; end
@@ -111,20 +105,17 @@ module Files
111
105
  class ApiKeyIsPathRestrictedError < NotAuthorizedError; end
112
106
  class ApiKeyOnlyForDesktopAppError < NotAuthorizedError; end
113
107
  class ApiKeyOnlyForOfficeIntegrationError < NotAuthorizedError; end
114
- class AuthenticationRequiredError < NotAuthorizedError; end
108
+ class BillingPermissionRequiredError < NotAuthorizedError; end
115
109
  class CannotLoginWhileUsingKeyError < NotAuthorizedError; end
116
110
  class CantActForOtherUserError < NotAuthorizedError; end
117
111
  class ContactAdminForPasswordChangeHelpError < NotAuthorizedError; end
118
- class FolderAdminOrBillingPermissionError < NotAuthorizedError; end
112
+ class FolderAdminOrBillingPermissionRequiredError < NotAuthorizedError; end
119
113
  class FolderAdminPermissionRequiredError < NotAuthorizedError; end
120
114
  class HistoryExportNonAdminsMustQueryByFolderOrPathError < NotAuthorizedError; end
121
115
  class HistoryPermissionRequiredError < NotAuthorizedError; end
122
116
  class InsufficientPermissionForParamsError < NotAuthorizedError; end
123
- class LockedOutError < NotAuthorizedError; end
124
- class LockoutRegionMismatchError < NotAuthorizedError; end
125
117
  class MustAuthenticateWithApiKeyError < NotAuthorizedError; end
126
118
  class NeedAdminPermissionForInboxError < NotAuthorizedError; end
127
- class NoBillingPermissionError < NotAuthorizedError; end
128
119
  class NotAllowedToCreateBundleError < NotAuthorizedError; end
129
120
  class PasswordChangeNotRequiredError < NotAuthorizedError; end
130
121
  class PasswordChangeRequiredError < NotAuthorizedError; end
@@ -134,7 +125,8 @@ module Files
134
125
  class ReauthenticationFailedFinalError < NotAuthorizedError; end
135
126
  class ReauthenticationNeededActionError < NotAuthorizedError; end
136
127
  class SelfManagedRequiredError < NotAuthorizedError; end
137
- class UnauthorizedError < NotAuthorizedError; end
128
+ class SiteAdminRequiredError < NotAuthorizedError; end
129
+ class TwoFactorAuthenticationRequiredError < NotAuthorizedError; end
138
130
  class UserIdWithoutSiteAdminError < NotAuthorizedError; end
139
131
  class WritePermissionRequiredError < NotAuthorizedError; end
140
132
  class ZipDownloadIpMismatchError < NotAuthorizedError; end
@@ -147,7 +139,6 @@ module Files
147
139
  class FileUploadNotFoundError < NotFoundError; end
148
140
  class FolderNotFoundError < NotFoundError; end
149
141
  class GroupNotFoundError < NotFoundError; end
150
- class HistoryExportNotReadyError < NotFoundError; end
151
142
  class InboxNotFoundError < NotFoundError; end
152
143
  class NestedNotFoundError < NotFoundError; end
153
144
  class PlanNotFoundError < NotFoundError; end
@@ -155,22 +146,24 @@ module Files
155
146
  class UserNotFoundError < NotFoundError; end
156
147
 
157
148
  class ProcessingFailureError < APIError; end
158
- class BundleRegistrationCodeFailedError < ProcessingFailureError; end
159
149
  class DestinationExistsError < ProcessingFailureError; end
160
150
  class DestinationParentConflictError < ProcessingFailureError; end
161
151
  class DestinationParentDoesNotExistError < ProcessingFailureError; end
162
152
  class FailedToChangePasswordError < ProcessingFailureError; end
153
+ class FileLockedError < ProcessingFailureError; end
163
154
  class FileNotUploadedError < ProcessingFailureError; end
155
+ class FilePendingProcessingError < ProcessingFailureError; end
156
+ class FolderLockedError < ProcessingFailureError; end
164
157
  class FolderNotEmptyError < ProcessingFailureError; end
165
158
  class HistoryExportFailureError < ProcessingFailureError; end
159
+ class HistoryExportNotReadyError < ProcessingFailureError; end
166
160
  class HistoryUnavailableError < ProcessingFailureError; end
167
- class InboxRegistrationCodeFailedError < ProcessingFailureError; end
168
161
  class InvalidBundleCodeError < ProcessingFailureError; end
169
- class InvalidOrExpiredCodeError < ProcessingFailureError; end
170
162
  class ModelSaveErrorError < ProcessingFailureError; end
171
163
  class RemoteServerErrorError < ProcessingFailureError; end
164
+ class ResourceLockedError < ProcessingFailureError; end
165
+ class SubfolderLockedError < ProcessingFailureError; end
172
166
  class TwoFactorAuthenticationCodeAlreadySentError < ProcessingFailureError; end
173
- class UnprocessableEntityError < ProcessingFailureError; end
174
167
 
175
168
  class RateLimitedError < APIError; end
176
169
  class ReauthenticationRateLimitedError < RateLimitedError; end
@@ -179,8 +172,8 @@ module Files
179
172
 
180
173
  class SiteConfigurationError < APIError; end
181
174
  class AccountAlreadyExistsError < SiteConfigurationError; end
175
+ class AccountOverdueError < SiteConfigurationError; end
182
176
  class NoAccountForSiteError < SiteConfigurationError; end
183
- class SiteAdminRequiredError < SiteConfigurationError; end
184
177
  class SiteWasRemovedError < SiteConfigurationError; end
185
178
  class TrialExpiredError < SiteConfigurationError; end
186
179
  class TrialLockedError < SiteConfigurationError; end
@@ -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]
@@ -17,6 +17,11 @@ module Files
17
17
  read_io.content_length_promise.execute
18
18
  end
19
19
 
20
+ def close
21
+ super
22
+ read_io.content_length_promise.try_set(nil)
23
+ end
24
+
20
25
  protected
21
26
 
22
27
  attr_accessor :content_length
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.138
4
+ version: 1.0.143
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-02-11 00:00:00.000000000 Z
11
+ date: 2021-02-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable