files.com 1.0.142 → 1.0.147
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 +2 -18
- data/docs/automation.md +14 -4
- data/docs/bundle_registration.md +20 -0
- data/docs/inbox_registration.md +18 -0
- data/docs/session.md +1 -9
- data/docs/site.md +2 -18
- data/lib/files.com/errors.rb +16 -1
- data/lib/files.com/models/api_key.rb +0 -12
- data/lib/files.com/models/automation.rb +19 -4
- data/lib/files.com/models/bundle_registration.rb +21 -0
- data/lib/files.com/models/inbox_registration.rb +19 -0
- data/lib/files.com/models/session.rb +0 -6
- data/lib/files.com/models/site.rb +0 -12
- 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: 5ff882920d191b3e5b7735eac44e2c0cf49de08d38bd7de88599d162f387e15a
|
|
4
|
+
data.tar.gz: ba1b8f635412dd1347ae7888f7786cec95f7a51dca98407834e40dc2be6ab9bf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d9a30e50de3d17daa4268f3dd1b488a85c130490f8c1255e0662715a604d23d2b164c7ba3821b83248b53bf0504f7d54dc2e9eafbfb6d7be8d8a83f7a2ea75ce
|
|
7
|
+
data.tar.gz: 70d58ca954bd501b98412cadac8eb78de9442f0c03cd53f37acc0ad3dcf313ac34cb466bfdfc7927dc02b75104b81eb11dff0931f4a28ed0682eeaf4c321846a
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.147
|
data/docs/api_key.md
CHANGED
|
@@ -61,17 +61,9 @@ Files::ApiKey.list(
|
|
|
61
61
|
## Show information about current API key. (Requires current API connection to be using an API key.)
|
|
62
62
|
|
|
63
63
|
```
|
|
64
|
-
Files::ApiKey.find_current
|
|
65
|
-
format: "",
|
|
66
|
-
api_key: ""
|
|
67
|
-
)
|
|
64
|
+
Files::ApiKey.find_current
|
|
68
65
|
```
|
|
69
66
|
|
|
70
|
-
### Parameters
|
|
71
|
-
|
|
72
|
-
* `format` (string):
|
|
73
|
-
* `api_key` (object):
|
|
74
|
-
|
|
75
67
|
|
|
76
68
|
---
|
|
77
69
|
|
|
@@ -153,17 +145,9 @@ Files::ApiKey.update(id,
|
|
|
153
145
|
## Delete current API key. (Requires current API connection to be using an API key.)
|
|
154
146
|
|
|
155
147
|
```
|
|
156
|
-
Files::ApiKey.delete_current
|
|
157
|
-
format: "",
|
|
158
|
-
api_key: ""
|
|
159
|
-
)
|
|
148
|
+
Files::ApiKey.delete_current
|
|
160
149
|
```
|
|
161
150
|
|
|
162
|
-
### Parameters
|
|
163
|
-
|
|
164
|
-
* `format` (string):
|
|
165
|
-
* `api_key` (object):
|
|
166
|
-
|
|
167
151
|
|
|
168
152
|
---
|
|
169
153
|
|
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`
|
data/docs/bundle_registration.md
CHANGED
|
@@ -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
|
data/docs/inbox_registration.md
CHANGED
|
@@ -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.
|
data/docs/session.md
CHANGED
data/docs/site.md
CHANGED
|
@@ -324,34 +324,18 @@
|
|
|
324
324
|
## Show site settings
|
|
325
325
|
|
|
326
326
|
```
|
|
327
|
-
Files::Site.get
|
|
328
|
-
format: "",
|
|
329
|
-
site: ""
|
|
330
|
-
)
|
|
327
|
+
Files::Site.get
|
|
331
328
|
```
|
|
332
329
|
|
|
333
|
-
### Parameters
|
|
334
|
-
|
|
335
|
-
* `format` (string):
|
|
336
|
-
* `site` (object):
|
|
337
|
-
|
|
338
330
|
|
|
339
331
|
---
|
|
340
332
|
|
|
341
333
|
## Get the most recent usage snapshot (usage data for billing purposes) for a Site
|
|
342
334
|
|
|
343
335
|
```
|
|
344
|
-
Files::Site.get_usage
|
|
345
|
-
format: "",
|
|
346
|
-
site: ""
|
|
347
|
-
)
|
|
336
|
+
Files::Site.get_usage
|
|
348
337
|
```
|
|
349
338
|
|
|
350
|
-
### Parameters
|
|
351
|
-
|
|
352
|
-
* `format` (string):
|
|
353
|
-
* `site` (object):
|
|
354
|
-
|
|
355
339
|
|
|
356
340
|
---
|
|
357
341
|
|
data/lib/files.com/errors.rb
CHANGED
|
@@ -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,24 +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
|
|
167
|
-
class
|
|
182
|
+
class UpdatesNotAllowedForRemotesError < ProcessingFailureError; end
|
|
168
183
|
|
|
169
184
|
class RateLimitedError < APIError; end
|
|
170
185
|
class ReauthenticationRateLimitedError < RateLimitedError; end
|
|
@@ -176,13 +176,7 @@ module Files
|
|
|
176
176
|
list(params, options)
|
|
177
177
|
end
|
|
178
178
|
|
|
179
|
-
# Parameters:
|
|
180
|
-
# format - string
|
|
181
|
-
# api_key - object
|
|
182
179
|
def self.find_current(params = {}, options = {})
|
|
183
|
-
raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
|
|
184
|
-
raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
|
|
185
|
-
|
|
186
180
|
response, options = Api.send_request("/api_key", :get, params, options)
|
|
187
181
|
ApiKey.new(response.data, options)
|
|
188
182
|
end
|
|
@@ -250,13 +244,7 @@ module Files
|
|
|
250
244
|
ApiKey.new(response.data, options)
|
|
251
245
|
end
|
|
252
246
|
|
|
253
|
-
# Parameters:
|
|
254
|
-
# format - string
|
|
255
|
-
# api_key - object
|
|
256
247
|
def self.delete_current(params = {}, options = {})
|
|
257
|
-
raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
|
|
258
|
-
raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
|
|
259
|
-
|
|
260
248
|
response, _options = Api.send_request("/api_key", :delete, params, options)
|
|
261
249
|
response.data
|
|
262
250
|
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
|
|
@@ -235,13 +235,7 @@ module Files
|
|
|
235
235
|
Session.new(response.data, options)
|
|
236
236
|
end
|
|
237
237
|
|
|
238
|
-
# Parameters:
|
|
239
|
-
# format - string
|
|
240
|
-
# session - object
|
|
241
238
|
def self.delete(params = {}, options = {})
|
|
242
|
-
raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
|
|
243
|
-
raise InvalidParameterError.new("Bad parameter: session must be an Hash") if params.dig(:session) and !params.dig(:session).is_a?(Hash)
|
|
244
|
-
|
|
245
239
|
response, _options = Api.send_request("/sessions", :delete, params, options)
|
|
246
240
|
response.data
|
|
247
241
|
end
|
|
@@ -574,24 +574,12 @@ module Files
|
|
|
574
574
|
@attributes[:disable_users_from_inactivity_period_days]
|
|
575
575
|
end
|
|
576
576
|
|
|
577
|
-
# Parameters:
|
|
578
|
-
# format - string
|
|
579
|
-
# site - object
|
|
580
577
|
def self.get(params = {}, options = {})
|
|
581
|
-
raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
|
|
582
|
-
raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
|
|
583
|
-
|
|
584
578
|
response, options = Api.send_request("/site", :get, params, options)
|
|
585
579
|
Site.new(response.data, options)
|
|
586
580
|
end
|
|
587
581
|
|
|
588
|
-
# Parameters:
|
|
589
|
-
# format - string
|
|
590
|
-
# site - object
|
|
591
582
|
def self.get_usage(params = {}, options = {})
|
|
592
|
-
raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
|
|
593
|
-
raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
|
|
594
|
-
|
|
595
583
|
response, options = Api.send_request("/site/usage", :get, params, options)
|
|
596
584
|
UsageSnapshot.new(response.data, options)
|
|
597
585
|
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.
|
|
4
|
+
version: 1.0.147
|
|
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-
|
|
11
|
+
date: 2021-03-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: addressable
|