files.com 1.0.143 → 1.0.148

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: 8357dce4d4dada928ca826660bac6882f99f35f1db3ff7ece5d3296a4a577657
4
- data.tar.gz: 05e573ac5bb3dddb2fd226cab1faaedd239550f2e2bc5df95aad21732e367586
3
+ metadata.gz: 91969c32f2739e80ba36afcb84573c5356fea023cec6640609365e2c50c81a52
4
+ data.tar.gz: dcd7764d961cef3ed70baa4e066a1c1162886e4d1ac1f73ae4deb3564ac4d662
5
5
  SHA512:
6
- metadata.gz: 9cf2790c508c69d7147185ae01b0583f846131544fa5ddf43b01a9f2c2dbef3854bc6eb9d270dd6e7f3add7635c0551e8c82c58025822f928a091b2e2e2e4f80
7
- data.tar.gz: '079ba9392f094c1c2dfa8a9bc5cb2641d34450258c8a0ef93058d1c63c769fddcfc71700d681c547f84800aa1b26ed0be711bbb450a9030a0e6ecf3d8a98fc8f'
6
+ metadata.gz: 6726b3c67fc2d344f824717033a344b0b1e24fdf42d49666d7ca26d6b566656e5d2f1d7bce39082395b0c6d07572ae6bf9b697424b6887e9845b24ebf4cf8536
7
+ data.tar.gz: 4097f21d68b4d49e2f9d180ac37f927c7902abde37abe1a81a8597e009a3cdb10d0fb5df4746b107728a46f7cecef9bca28b097d2301e4e50f1953a73dfdde85
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.143
1
+ 1.0.148
data/docs/automation.md CHANGED
@@ -23,6 +23,9 @@
23
23
  },
24
24
  "source": "",
25
25
  "destination": "",
26
+ "destinations": [
27
+ "destination"
28
+ ],
26
29
  "destination_replace_from": "",
27
30
  "destination_replace_to": "",
28
31
  "path": "",
@@ -49,7 +52,8 @@
49
52
  * `next_process_on` (string): If trigger is `daily`, date this automation will next run.
50
53
  * `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
51
54
  * `source` (string): Source Path
52
- * `destination` (string): Destination Path
55
+ * `destination` (string): DEPRECATED: Destination Path
56
+ * `destinations` (string): Destination Path
53
57
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
54
58
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
55
59
  * `path` (string): Path on which this Automation runs. Supports globs. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
@@ -109,6 +113,7 @@ Files::Automation.create(
109
113
  automation: "create_folder",
110
114
  source: "source",
111
115
  destination: "destination",
116
+ destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
112
117
  interval: "year",
113
118
  user_ids: [1,2],
114
119
  group_ids: [1,2],
@@ -124,7 +129,8 @@ Files::Automation.create(
124
129
 
125
130
  * `automation` (string): Required - Automation type
126
131
  * `source` (string): Source Path
127
- * `destination` (string): Destination Path
132
+ * `destination` (string): DEPRECATED: Destination Path
133
+ * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
128
134
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
129
135
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
130
136
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -147,6 +153,7 @@ Files::Automation.update(id,
147
153
  automation: "create_folder",
148
154
  source: "source",
149
155
  destination: "destination",
156
+ destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
150
157
  interval: "year",
151
158
  user_ids: [1,2],
152
159
  group_ids: [1,2],
@@ -163,7 +170,8 @@ Files::Automation.update(id,
163
170
  * `id` (int64): Required - Automation ID.
164
171
  * `automation` (string): Required - Automation type
165
172
  * `source` (string): Source Path
166
- * `destination` (string): Destination Path
173
+ * `destination` (string): DEPRECATED: Destination Path
174
+ * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
167
175
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
168
176
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
169
177
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -201,6 +209,7 @@ automation.update(
201
209
  automation: "create_folder",
202
210
  source: "source",
203
211
  destination: "destination",
212
+ destinations: "[\"folder_a/file_a.txt\", {\"folder_path\":\"folder_b\", \"file_path\":\"file_b.txt\"}, {\"folder_path\":\"folder_c\"}]",
204
213
  interval: "year",
205
214
  user_ids: [1,2],
206
215
  group_ids: [1,2],
@@ -217,7 +226,8 @@ automation.update(
217
226
  * `id` (int64): Required - Automation ID.
218
227
  * `automation` (string): Required - Automation type
219
228
  * `source` (string): Source Path
220
- * `destination` (string): Destination Path
229
+ * `destination` (string): DEPRECATED: Destination Path
230
+ * `destinations` (array(string)): A list of String destination paths or Hash of folder_path and optional file_path.
221
231
  * `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
222
232
  * `destination_replace_to` (string): If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
223
233
  * `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -21,3 +21,23 @@
21
21
  * `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
22
22
  * `form_field_set_id` (int64): Id of associated form field set
23
23
  * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
24
+
25
+
26
+ ---
27
+
28
+ ## List Bundle Registrations
29
+
30
+ ```
31
+ Files::BundleRegistration.list(
32
+ user_id: 1,
33
+ per_page: 1,
34
+ bundle_id: 1
35
+ )
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
41
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
42
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
43
+ * `bundle_id` (int64): Required - ID of the associated Bundle
@@ -19,3 +19,21 @@
19
19
  * `email` (string): Registrant email address
20
20
  * `form_field_set_id` (int64): Id of associated form field set
21
21
  * `form_field_data` (string): Data for form field set with form field ids as keys and user data as values
22
+
23
+
24
+ ---
25
+
26
+ ## List Inbox Registrations
27
+
28
+ ```
29
+ Files::InboxRegistration.list(
30
+ per_page: 1,
31
+ folder_behavior_id: 1
32
+ )
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ * `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
38
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
39
+ * `folder_behavior_id` (int64): Required - ID of the associated Inbox.
@@ -64,7 +64,9 @@ module Files
64
64
  class DatetimeParseError < BadRequestError; end
65
65
  class DestinationSameError < BadRequestError; end
66
66
  class FolderMustNotBeAFileError < BadRequestError; end
67
+ class InvalidBodyError < BadRequestError; end
67
68
  class InvalidCursorError < BadRequestError; end
69
+ class InvalidEtagsError < BadRequestError; end
68
70
  class InvalidFilterCombinationError < BadRequestError; end
69
71
  class InvalidFilterFieldError < BadRequestError; end
70
72
  class InvalidInputEncodingError < BadRequestError; end
@@ -72,8 +74,12 @@ module Files
72
74
  class InvalidOauthProviderError < BadRequestError; end
73
75
  class InvalidReturnToUrlError < BadRequestError; end
74
76
  class InvalidUploadOffsetError < BadRequestError; end
77
+ class InvalidUploadPartGapError < BadRequestError; end
78
+ class InvalidUploadPartSizeError < BadRequestError; end
79
+ class MethodNotAllowedError < BadRequestError; end
75
80
  class NoValidInputParamsError < BadRequestError; end
76
81
  class OperationOnNonScimResourceError < BadRequestError; end
82
+ class PartNumberTooLargeError < BadRequestError; end
77
83
  class ReauthenticationNeededFieldsError < BadRequestError; end
78
84
  class RequestParamPathCannotHaveTrailingWhitespaceError < BadRequestError; end
79
85
  class RequestParamsContainInvalidCharacterError < BadRequestError; end
@@ -106,6 +112,7 @@ module Files
106
112
  class ApiKeyOnlyForDesktopAppError < NotAuthorizedError; end
107
113
  class ApiKeyOnlyForOfficeIntegrationError < NotAuthorizedError; end
108
114
  class BillingPermissionRequiredError < NotAuthorizedError; end
115
+ class BundleMaximumUsesReachedError < NotAuthorizedError; end
109
116
  class CannotLoginWhileUsingKeyError < NotAuthorizedError; end
110
117
  class CantActForOtherUserError < NotAuthorizedError; end
111
118
  class ContactAdminForPasswordChangeHelpError < NotAuthorizedError; end
@@ -147,23 +154,32 @@ module Files
147
154
 
148
155
  class ProcessingFailureError < APIError; end
149
156
  class DestinationExistsError < ProcessingFailureError; end
157
+ class DestinationFolderLimitedError < ProcessingFailureError; end
150
158
  class DestinationParentConflictError < ProcessingFailureError; end
151
159
  class DestinationParentDoesNotExistError < ProcessingFailureError; end
160
+ class ExpiredPublicKeyError < ProcessingFailureError; end
152
161
  class FailedToChangePasswordError < ProcessingFailureError; end
153
162
  class FileLockedError < ProcessingFailureError; end
154
163
  class FileNotUploadedError < ProcessingFailureError; end
155
164
  class FilePendingProcessingError < ProcessingFailureError; end
165
+ class FileUploadedToWrongRegionError < ProcessingFailureError; end
156
166
  class FolderLockedError < ProcessingFailureError; end
157
167
  class FolderNotEmptyError < ProcessingFailureError; end
158
168
  class HistoryExportFailureError < ProcessingFailureError; end
159
169
  class HistoryExportNotReadyError < ProcessingFailureError; end
160
170
  class HistoryUnavailableError < ProcessingFailureError; end
161
171
  class InvalidBundleCodeError < ProcessingFailureError; end
172
+ class InvalidFileTypeError < ProcessingFailureError; end
173
+ class InvalidFilenameError < ProcessingFailureError; end
174
+ class InvalidRangeError < ProcessingFailureError; end
162
175
  class ModelSaveErrorError < ProcessingFailureError; end
176
+ class MultipartUploadsRequiredForRemotesError < ProcessingFailureError; end
177
+ class MultipleProcessingErrorsError < ProcessingFailureError; end
163
178
  class RemoteServerErrorError < ProcessingFailureError; end
164
179
  class ResourceLockedError < ProcessingFailureError; end
165
180
  class SubfolderLockedError < ProcessingFailureError; end
166
181
  class TwoFactorAuthenticationCodeAlreadySentError < ProcessingFailureError; end
182
+ class UpdatesNotAllowedForRemotesError < ProcessingFailureError; end
167
183
 
168
184
  class RateLimitedError < APIError; end
169
185
  class ReauthenticationRateLimitedError < RateLimitedError; end
@@ -72,7 +72,7 @@ module Files
72
72
  @attributes[:source] = value
73
73
  end
74
74
 
75
- # string - Destination Path
75
+ # string - DEPRECATED: Destination Path
76
76
  def destination
77
77
  @attributes[:destination]
78
78
  end
@@ -81,6 +81,15 @@ module Files
81
81
  @attributes[:destination] = value
82
82
  end
83
83
 
84
+ # string - Destination Path
85
+ def destinations
86
+ @attributes[:destinations]
87
+ end
88
+
89
+ def destinations=(value)
90
+ @attributes[:destinations] = value
91
+ end
92
+
84
93
  # string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
85
94
  def destination_replace_from
86
95
  @attributes[:destination_replace_from]
@@ -174,7 +183,8 @@ module Files
174
183
  # Parameters:
175
184
  # automation (required) - string - Automation type
176
185
  # source - string - Source Path
177
- # destination - string - Destination Path
186
+ # destination - string - DEPRECATED: Destination Path
187
+ # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
178
188
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
179
189
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
180
190
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -194,6 +204,7 @@ module Files
194
204
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
195
205
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
196
206
  raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
207
+ raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
197
208
  raise InvalidParameterError.new("Bad parameter: destination_replace_from must be an String") if params.dig(:destination_replace_from) and !params.dig(:destination_replace_from).is_a?(String)
198
209
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params.dig(:destination_replace_to) and !params.dig(:destination_replace_to).is_a?(String)
199
210
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params.dig(:interval) and !params.dig(:interval).is_a?(String)
@@ -283,7 +294,8 @@ module Files
283
294
  # Parameters:
284
295
  # automation (required) - string - Automation type
285
296
  # source - string - Source Path
286
- # destination - string - Destination Path
297
+ # destination - string - DEPRECATED: Destination Path
298
+ # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
287
299
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
288
300
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
289
301
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -299,6 +311,7 @@ module Files
299
311
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
300
312
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
301
313
  raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
314
+ raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
302
315
  raise InvalidParameterError.new("Bad parameter: destination_replace_from must be an String") if params.dig(:destination_replace_from) and !params.dig(:destination_replace_from).is_a?(String)
303
316
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params.dig(:destination_replace_to) and !params.dig(:destination_replace_to).is_a?(String)
304
317
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params.dig(:interval) and !params.dig(:interval).is_a?(String)
@@ -319,7 +332,8 @@ module Files
319
332
  # Parameters:
320
333
  # automation (required) - string - Automation type
321
334
  # source - string - Source Path
322
- # destination - string - Destination Path
335
+ # destination - string - DEPRECATED: Destination Path
336
+ # destinations - array(string) - A list of String destination paths or Hash of folder_path and optional file_path.
323
337
  # destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
324
338
  # destination_replace_to - string - If set, this string will replace the value `destination_replace_from` in the destination filename. You can use special patterns here.
325
339
  # interval - string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
@@ -338,6 +352,7 @@ module Files
338
352
  raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
339
353
  raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
340
354
  raise InvalidParameterError.new("Bad parameter: destination must be an String") if params.dig(:destination) and !params.dig(:destination).is_a?(String)
355
+ raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params.dig(:destinations) and !params.dig(:destinations).is_a?(Array)
341
356
  raise InvalidParameterError.new("Bad parameter: destination_replace_from must be an String") if params.dig(:destination_replace_from) and !params.dig(:destination_replace_from).is_a?(String)
342
357
  raise InvalidParameterError.new("Bad parameter: destination_replace_to must be an String") if params.dig(:destination_replace_to) and !params.dig(:destination_replace_to).is_a?(String)
343
358
  raise InvalidParameterError.new("Bad parameter: interval must be an String") if params.dig(:interval) and !params.dig(:interval).is_a?(String)
@@ -43,5 +43,26 @@ module Files
43
43
  def form_field_data
44
44
  @attributes[:form_field_data]
45
45
  end
46
+
47
+ # Parameters:
48
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
49
+ # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
50
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
+ # bundle_id (required) - int64 - ID of the associated Bundle
52
+ def self.list(params = {}, options = {})
53
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
54
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
55
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
56
+ raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
57
+ raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
58
+
59
+ List.new(BundleRegistration, params) do
60
+ Api.send_request("/bundle_registrations", :get, params, options)
61
+ end
62
+ end
63
+
64
+ def self.all(params = {}, options = {})
65
+ list(params, options)
66
+ end
46
67
  end
47
68
  end
@@ -38,5 +38,24 @@ module Files
38
38
  def form_field_data
39
39
  @attributes[:form_field_data]
40
40
  end
41
+
42
+ # Parameters:
43
+ # cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header.
44
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
+ # folder_behavior_id (required) - int64 - ID of the associated Inbox.
46
+ def self.list(params = {}, options = {})
47
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
48
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
49
+ raise InvalidParameterError.new("Bad parameter: folder_behavior_id must be an Integer") if params.dig(:folder_behavior_id) and !params.dig(:folder_behavior_id).is_a?(Integer)
50
+ raise MissingParameterError.new("Parameter missing: folder_behavior_id") unless params.dig(:folder_behavior_id)
51
+
52
+ List.new(InboxRegistration, params) do
53
+ Api.send_request("/inbox_registrations", :get, params, options)
54
+ end
55
+ end
56
+
57
+ def self.all(params = {}, options = {})
58
+ list(params, options)
59
+ end
41
60
  end
42
61
  end
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.143
4
+ version: 1.0.148
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-27 00:00:00.000000000 Z
11
+ date: 2021-03-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable