files.com 1.0.122 → 1.0.127
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/automation.md +37 -12
- data/docs/bundle.md +4 -0
- data/docs/history_export.md +0 -5
- data/docs/remote_server.md +55 -0
- data/lib/files.com/models/automation.rb +50 -30
- data/lib/files.com/models/bundle.rb +4 -0
- data/lib/files.com/models/history_export.rb +0 -20
- data/lib/files.com/models/remote_server.rb +82 -0
- 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: 15dbc7abb6293b77a82d25bf3f994067c822ef00bee620936112530f03d621b2
|
4
|
+
data.tar.gz: 91ed6680ef400cfc4b9cd835b2683ea3491c46bddf8d0344c132f712d461f96a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 34da33211bf14a73e5e4e7d8cf4cd61881cd84270285c6396fa2822e1c5dbf3ad3438393affc2bff59a6664a5638e924d46a794033849cae4b8ca3c7bc986638
|
7
|
+
data.tar.gz: 1d69ae3c02058e92fb3deed3ab1f44fde463d80afaba73b6e59411f1bef18e441f7811ecc9025fa1cb21a4709e148b073526f083d6824bc71dfe532cc412db04
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.127
|
data/docs/automation.md
CHANGED
@@ -6,14 +6,26 @@
|
|
6
6
|
{
|
7
7
|
"id": 1,
|
8
8
|
"automation": "create_folder",
|
9
|
+
"trigger": "realtime",
|
10
|
+
"interval": "week",
|
11
|
+
"next_process_on": "2020-01-01",
|
12
|
+
"schedule": {
|
13
|
+
"days_of_week": [
|
14
|
+
0,
|
15
|
+
2,
|
16
|
+
4
|
17
|
+
],
|
18
|
+
"times_of_day": [
|
19
|
+
"6:30",
|
20
|
+
"14:30"
|
21
|
+
],
|
22
|
+
"time_zone": "Eastern Time (US & Canada)"
|
23
|
+
},
|
9
24
|
"source": "",
|
10
25
|
"destination": "",
|
11
26
|
"destination_replace_from": "",
|
12
27
|
"destination_replace_to": "",
|
13
|
-
"interval": "week",
|
14
|
-
"next_process_on": "2020-01-01",
|
15
28
|
"path": "",
|
16
|
-
"realtime": true,
|
17
29
|
"user_id": 1,
|
18
30
|
"user_ids": [
|
19
31
|
|
@@ -26,14 +38,15 @@
|
|
26
38
|
|
27
39
|
* `id` (int64): Automation ID
|
28
40
|
* `automation` (string): Automation type
|
41
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
42
|
+
* `interval` (string): If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
43
|
+
* `next_process_on` (string): If trigger is `daily`, date this automation will next run.
|
44
|
+
* `schedule` (object): If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
29
45
|
* `source` (string): Source Path
|
30
46
|
* `destination` (string): Destination Path
|
31
47
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
32
48
|
* `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.
|
33
|
-
* `interval` (string): How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
34
|
-
* `next_process_on` (string): Date this automation will next run.
|
35
49
|
* `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.
|
36
|
-
* `realtime` (boolean): Does this automation run in real time? This is a read-only property based on automation type.
|
37
50
|
* `user_id` (int64): User ID of the Automation's creator.
|
38
51
|
* `user_ids` (array): IDs of Users for the Automation (i.e. who to Request File from)
|
39
52
|
* `group_ids` (array): IDs of Groups for the Automation (i.e. who to Request File from)
|
@@ -86,13 +99,15 @@ Files::Automation.create(
|
|
86
99
|
automation: "create_folder",
|
87
100
|
source: "source",
|
88
101
|
destination: "destination",
|
89
|
-
interval: "year"
|
102
|
+
interval: "year",
|
103
|
+
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
104
|
+
trigger: "realtime"
|
90
105
|
)
|
91
106
|
```
|
92
107
|
|
93
108
|
### Parameters
|
94
109
|
|
95
|
-
* `automation` (string): Required -
|
110
|
+
* `automation` (string): Required - Automation type
|
96
111
|
* `source` (string): Source Path
|
97
112
|
* `destination` (string): Destination Path
|
98
113
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -101,6 +116,8 @@ Files::Automation.create(
|
|
101
116
|
* `path` (string): Path on which this Automation runs. Supports globs.
|
102
117
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
103
118
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
119
|
+
* `schedule` (object): Custom schedule for running this automation.
|
120
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
104
121
|
|
105
122
|
|
106
123
|
---
|
@@ -112,14 +129,16 @@ Files::Automation.update(id,
|
|
112
129
|
automation: "create_folder",
|
113
130
|
source: "source",
|
114
131
|
destination: "destination",
|
115
|
-
interval: "year"
|
132
|
+
interval: "year",
|
133
|
+
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
134
|
+
trigger: "realtime"
|
116
135
|
)
|
117
136
|
```
|
118
137
|
|
119
138
|
### Parameters
|
120
139
|
|
121
140
|
* `id` (int64): Required - Automation ID.
|
122
|
-
* `automation` (string): Required -
|
141
|
+
* `automation` (string): Required - Automation type
|
123
142
|
* `source` (string): Source Path
|
124
143
|
* `destination` (string): Destination Path
|
125
144
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -128,6 +147,8 @@ Files::Automation.update(id,
|
|
128
147
|
* `path` (string): Path on which this Automation runs. Supports globs.
|
129
148
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
130
149
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
150
|
+
* `schedule` (object): Custom schedule for running this automation.
|
151
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
131
152
|
|
132
153
|
|
133
154
|
---
|
@@ -154,14 +175,16 @@ automation.update(
|
|
154
175
|
automation: "create_folder",
|
155
176
|
source: "source",
|
156
177
|
destination: "destination",
|
157
|
-
interval: "year"
|
178
|
+
interval: "year",
|
179
|
+
schedule: "{\"days_of_week\": [ 0, 1, 3 ], \"times_of_day\": [ \"7:30\", \"11:30\" ], \"time_zone\": \"Eastern Time (US & Canada)\"}",
|
180
|
+
trigger: "realtime"
|
158
181
|
)
|
159
182
|
```
|
160
183
|
|
161
184
|
### Parameters
|
162
185
|
|
163
186
|
* `id` (int64): Required - Automation ID.
|
164
|
-
* `automation` (string): Required -
|
187
|
+
* `automation` (string): Required - Automation type
|
165
188
|
* `source` (string): Source Path
|
166
189
|
* `destination` (string): Destination Path
|
167
190
|
* `destination_replace_from` (string): If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -170,6 +193,8 @@ automation.update(
|
|
170
193
|
* `path` (string): Path on which this Automation runs. Supports globs.
|
171
194
|
* `user_ids` (string): A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
172
195
|
* `group_ids` (string): A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
196
|
+
* `schedule` (object): Custom schedule for running this automation.
|
197
|
+
* `trigger` (string): How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
173
198
|
|
174
199
|
|
175
200
|
---
|
data/docs/bundle.md
CHANGED
@@ -149,6 +149,7 @@ Files::Bundle.share(id,
|
|
149
149
|
|
150
150
|
```
|
151
151
|
Files::Bundle.update(id,
|
152
|
+
paths: ["file.txt"],
|
152
153
|
password: "Password",
|
153
154
|
clickwrap_id: 1,
|
154
155
|
code: "abc123",
|
@@ -165,6 +166,7 @@ Files::Bundle.update(id,
|
|
165
166
|
### Parameters
|
166
167
|
|
167
168
|
* `id` (int64): Required - Bundle ID.
|
169
|
+
* `paths` (array(string)): A list of paths to include in this bundle.
|
168
170
|
* `password` (string): Password for this bundle.
|
169
171
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
170
172
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
@@ -220,6 +222,7 @@ bundle.share(
|
|
220
222
|
bundle = Files::Bundle.list_for(path).first
|
221
223
|
|
222
224
|
bundle.update(
|
225
|
+
paths: ["file.txt"],
|
223
226
|
password: "Password",
|
224
227
|
clickwrap_id: 1,
|
225
228
|
code: "abc123",
|
@@ -236,6 +239,7 @@ bundle.update(
|
|
236
239
|
### Parameters
|
237
240
|
|
238
241
|
* `id` (int64): Required - Bundle ID.
|
242
|
+
* `paths` (array(string)): A list of paths to include in this bundle.
|
239
243
|
* `password` (string): Password for this bundle.
|
240
244
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
241
245
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
data/docs/history_export.md
CHANGED
@@ -7,8 +7,6 @@
|
|
7
7
|
"id": 1,
|
8
8
|
"start_at": "2000-01-01T01:00:00Z",
|
9
9
|
"end_at": "2000-01-01T01:00:00Z",
|
10
|
-
"export_as": "",
|
11
|
-
"file_export": true,
|
12
10
|
"status": "ready",
|
13
11
|
"query_action": "read",
|
14
12
|
"query_interface": "ftp",
|
@@ -36,8 +34,6 @@
|
|
36
34
|
* `id` (int64): History Export ID
|
37
35
|
* `start_at` (date-time): Start date/time of export range.
|
38
36
|
* `end_at` (date-time): End date/time of export range.
|
39
|
-
* `export_as` (string): Export format
|
40
|
-
* `file_export` (boolean): Is a file export, downloadable using the results_url
|
41
37
|
* `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
|
42
38
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
43
39
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`
|
@@ -111,7 +107,6 @@ Files::HistoryExport.create(
|
|
111
107
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
112
108
|
* `start_at` (string): Start date/time of export range.
|
113
109
|
* `end_at` (string): End date/time of export range.
|
114
|
-
* `export_as` (string): Export format
|
115
110
|
* `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
116
111
|
* `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`
|
117
112
|
* `query_user_id` (string): Return results that are actions performed by the user indiciated by this User ID
|
data/docs/remote_server.md
CHANGED
@@ -107,6 +107,61 @@ Files::RemoteServer.find(id)
|
|
107
107
|
* `id` (int64): Required - Remote Server ID.
|
108
108
|
|
109
109
|
|
110
|
+
---
|
111
|
+
|
112
|
+
## list_for_testing Remote Server
|
113
|
+
|
114
|
+
```
|
115
|
+
Files::RemoteServer.list_for_testing(
|
116
|
+
remote_server_id: 1,
|
117
|
+
reset_authentication: true,
|
118
|
+
max_connections: 1,
|
119
|
+
port: 1
|
120
|
+
)
|
121
|
+
```
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
* `remote_server_id` (int64): RemoteServer ID
|
126
|
+
* `root` (string): Remote path to list
|
127
|
+
* `aws_access_key` (string): AWS Access Key.
|
128
|
+
* `aws_secret_key` (string): AWS secret key.
|
129
|
+
* `password` (string): Password if needed.
|
130
|
+
* `private_key` (string): Private key if needed.
|
131
|
+
* `ssl_certificate` (string): SSL client certificate.
|
132
|
+
* `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
133
|
+
* `wasabi_access_key` (string): Wasabi access key.
|
134
|
+
* `wasabi_secret_key` (string): Wasabi secret key.
|
135
|
+
* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
|
136
|
+
* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
|
137
|
+
* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
|
138
|
+
* `reset_authentication` (boolean): Reset authenticated account
|
139
|
+
* `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
|
140
|
+
* `hostname` (string):
|
141
|
+
* `name` (string):
|
142
|
+
* `max_connections` (int64):
|
143
|
+
* `port` (int64):
|
144
|
+
* `s3_bucket` (string):
|
145
|
+
* `s3_region` (string):
|
146
|
+
* `server_certificate` (string):
|
147
|
+
* `server_host_key` (string):
|
148
|
+
* `server_type` (string):
|
149
|
+
* `ssl` (string):
|
150
|
+
* `username` (string):
|
151
|
+
* `google_cloud_storage_bucket` (string):
|
152
|
+
* `google_cloud_storage_project_id` (string):
|
153
|
+
* `backblaze_b2_bucket` (string):
|
154
|
+
* `backblaze_b2_s3_endpoint` (string):
|
155
|
+
* `wasabi_bucket` (string):
|
156
|
+
* `wasabi_region` (string):
|
157
|
+
* `rackspace_username` (string):
|
158
|
+
* `rackspace_region` (string):
|
159
|
+
* `rackspace_container` (string):
|
160
|
+
* `one_drive_account_type` (string):
|
161
|
+
* `azure_blob_storage_account` (string):
|
162
|
+
* `azure_blob_storage_container` (string):
|
163
|
+
|
164
|
+
|
110
165
|
---
|
111
166
|
|
112
167
|
## Create Remote Server
|
@@ -27,6 +27,42 @@ module Files
|
|
27
27
|
@attributes[:automation] = value
|
28
28
|
end
|
29
29
|
|
30
|
+
# string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
31
|
+
def trigger
|
32
|
+
@attributes[:trigger]
|
33
|
+
end
|
34
|
+
|
35
|
+
def trigger=(value)
|
36
|
+
@attributes[:trigger] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
# string - If trigger is `daily`, this specifies how often to run this automation. One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
40
|
+
def interval
|
41
|
+
@attributes[:interval]
|
42
|
+
end
|
43
|
+
|
44
|
+
def interval=(value)
|
45
|
+
@attributes[:interval] = value
|
46
|
+
end
|
47
|
+
|
48
|
+
# string - If trigger is `daily`, date this automation will next run.
|
49
|
+
def next_process_on
|
50
|
+
@attributes[:next_process_on]
|
51
|
+
end
|
52
|
+
|
53
|
+
def next_process_on=(value)
|
54
|
+
@attributes[:next_process_on] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# object - If trigger is `custom_schedule`, Custom schedule description for when the automation should be run.
|
58
|
+
def schedule
|
59
|
+
@attributes[:schedule]
|
60
|
+
end
|
61
|
+
|
62
|
+
def schedule=(value)
|
63
|
+
@attributes[:schedule] = value
|
64
|
+
end
|
65
|
+
|
30
66
|
# string - Source Path
|
31
67
|
def source
|
32
68
|
@attributes[:source]
|
@@ -63,24 +99,6 @@ module Files
|
|
63
99
|
@attributes[:destination_replace_to] = value
|
64
100
|
end
|
65
101
|
|
66
|
-
# string - How often to run this automation? One of: `day`, `week`, `week_end`, `month`, `month_end`, `quarter`, `quarter_end`, `year`, `year_end`
|
67
|
-
def interval
|
68
|
-
@attributes[:interval]
|
69
|
-
end
|
70
|
-
|
71
|
-
def interval=(value)
|
72
|
-
@attributes[:interval] = value
|
73
|
-
end
|
74
|
-
|
75
|
-
# string - Date this automation will next run.
|
76
|
-
def next_process_on
|
77
|
-
@attributes[:next_process_on]
|
78
|
-
end
|
79
|
-
|
80
|
-
def next_process_on=(value)
|
81
|
-
@attributes[:next_process_on] = value
|
82
|
-
end
|
83
|
-
|
84
102
|
# 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.
|
85
103
|
def path
|
86
104
|
@attributes[:path]
|
@@ -90,15 +108,6 @@ module Files
|
|
90
108
|
@attributes[:path] = value
|
91
109
|
end
|
92
110
|
|
93
|
-
# boolean - Does this automation run in real time? This is a read-only property based on automation type.
|
94
|
-
def realtime
|
95
|
-
@attributes[:realtime]
|
96
|
-
end
|
97
|
-
|
98
|
-
def realtime=(value)
|
99
|
-
@attributes[:realtime] = value
|
100
|
-
end
|
101
|
-
|
102
111
|
# int64 - User ID of the Automation's creator.
|
103
112
|
def user_id
|
104
113
|
@attributes[:user_id]
|
@@ -127,7 +136,7 @@ module Files
|
|
127
136
|
end
|
128
137
|
|
129
138
|
# Parameters:
|
130
|
-
# automation (required) - string -
|
139
|
+
# automation (required) - string - Automation type
|
131
140
|
# source - string - Source Path
|
132
141
|
# destination - string - Destination Path
|
133
142
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -136,6 +145,8 @@ module Files
|
|
136
145
|
# path - string - Path on which this Automation runs. Supports globs.
|
137
146
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
138
147
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
148
|
+
# schedule - object - Custom schedule for running this automation.
|
149
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
139
150
|
def update(params = {})
|
140
151
|
params ||= {}
|
141
152
|
params[:id] = @attributes[:id]
|
@@ -150,6 +161,7 @@ module Files
|
|
150
161
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
151
162
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
152
163
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
164
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
153
165
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
154
166
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
155
167
|
|
@@ -228,7 +240,7 @@ module Files
|
|
228
240
|
end
|
229
241
|
|
230
242
|
# Parameters:
|
231
|
-
# automation (required) - string -
|
243
|
+
# automation (required) - string - Automation type
|
232
244
|
# source - string - Source Path
|
233
245
|
# destination - string - Destination Path
|
234
246
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -237,6 +249,8 @@ module Files
|
|
237
249
|
# path - string - Path on which this Automation runs. Supports globs.
|
238
250
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
239
251
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
252
|
+
# schedule - object - Custom schedule for running this automation.
|
253
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
240
254
|
def self.create(params = {}, options = {})
|
241
255
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
242
256
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
|
@@ -247,6 +261,8 @@ module Files
|
|
247
261
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
248
262
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
249
263
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
264
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
265
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
250
266
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
251
267
|
|
252
268
|
response, options = Api.send_request("/automations", :post, params, options)
|
@@ -254,7 +270,7 @@ module Files
|
|
254
270
|
end
|
255
271
|
|
256
272
|
# Parameters:
|
257
|
-
# automation (required) - string -
|
273
|
+
# automation (required) - string - Automation type
|
258
274
|
# source - string - Source Path
|
259
275
|
# destination - string - Destination Path
|
260
276
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -263,6 +279,8 @@ module Files
|
|
263
279
|
# path - string - Path on which this Automation runs. Supports globs.
|
264
280
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
265
281
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
282
|
+
# schedule - object - Custom schedule for running this automation.
|
283
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime`, `daily`, `custom_schedule`, `webhook`, or `email`.
|
266
284
|
def self.update(id, params = {}, options = {})
|
267
285
|
params ||= {}
|
268
286
|
params[:id] = id
|
@@ -276,6 +294,8 @@ module Files
|
|
276
294
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
277
295
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
278
296
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
297
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
298
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
279
299
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
280
300
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
281
301
|
|
@@ -197,6 +197,7 @@ module Files
|
|
197
197
|
end
|
198
198
|
|
199
199
|
# Parameters:
|
200
|
+
# paths - array(string) - A list of paths to include in this bundle.
|
200
201
|
# password - string - Password for this bundle.
|
201
202
|
# clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
202
203
|
# code - string - Bundle code. This code forms the end part of the Public URL.
|
@@ -212,6 +213,7 @@ module Files
|
|
212
213
|
params[:id] = @attributes[:id]
|
213
214
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
214
215
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
216
|
+
raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
|
215
217
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
216
218
|
raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
|
217
219
|
raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
|
@@ -347,6 +349,7 @@ module Files
|
|
347
349
|
end
|
348
350
|
|
349
351
|
# Parameters:
|
352
|
+
# paths - array(string) - A list of paths to include in this bundle.
|
350
353
|
# password - string - Password for this bundle.
|
351
354
|
# clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
352
355
|
# code - string - Bundle code. This code forms the end part of the Public URL.
|
@@ -361,6 +364,7 @@ module Files
|
|
361
364
|
params ||= {}
|
362
365
|
params[:id] = id
|
363
366
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
367
|
+
raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
|
364
368
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
365
369
|
raise InvalidParameterError.new("Bad parameter: clickwrap_id must be an Integer") if params.dig(:clickwrap_id) and !params.dig(:clickwrap_id).is_a?(Integer)
|
366
370
|
raise InvalidParameterError.new("Bad parameter: code must be an String") if params.dig(:code) and !params.dig(:code).is_a?(String)
|
@@ -36,24 +36,6 @@ module Files
|
|
36
36
|
@attributes[:end_at] = value
|
37
37
|
end
|
38
38
|
|
39
|
-
# string - Export format
|
40
|
-
def export_as
|
41
|
-
@attributes[:export_as]
|
42
|
-
end
|
43
|
-
|
44
|
-
def export_as=(value)
|
45
|
-
@attributes[:export_as] = value
|
46
|
-
end
|
47
|
-
|
48
|
-
# boolean - Is a file export, downloadable using the results_url
|
49
|
-
def file_export
|
50
|
-
@attributes[:file_export]
|
51
|
-
end
|
52
|
-
|
53
|
-
def file_export=(value)
|
54
|
-
@attributes[:file_export] = value
|
55
|
-
end
|
56
|
-
|
57
39
|
# string - Status of export. Will be: `building`, `ready`, or `failed`
|
58
40
|
def status
|
59
41
|
@attributes[:status]
|
@@ -281,7 +263,6 @@ module Files
|
|
281
263
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
282
264
|
# start_at - string - Start date/time of export range.
|
283
265
|
# end_at - string - End date/time of export range.
|
284
|
-
# export_as - string - Export format
|
285
266
|
# query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
286
267
|
# query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`
|
287
268
|
# query_user_id - string - Return results that are actions performed by the user indiciated by this User ID
|
@@ -305,7 +286,6 @@ module Files
|
|
305
286
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
306
287
|
raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
|
307
288
|
raise InvalidParameterError.new("Bad parameter: end_at must be an String") if params.dig(:end_at) and !params.dig(:end_at).is_a?(String)
|
308
|
-
raise InvalidParameterError.new("Bad parameter: export_as must be an String") if params.dig(:export_as) and !params.dig(:export_as).is_a?(String)
|
309
289
|
raise InvalidParameterError.new("Bad parameter: query_action must be an String") if params.dig(:query_action) and !params.dig(:query_action).is_a?(String)
|
310
290
|
raise InvalidParameterError.new("Bad parameter: query_interface must be an String") if params.dig(:query_interface) and !params.dig(:query_interface).is_a?(String)
|
311
291
|
raise InvalidParameterError.new("Bad parameter: query_user_id must be an String") if params.dig(:query_user_id) and !params.dig(:query_user_id).is_a?(String)
|
@@ -515,6 +515,88 @@ module Files
|
|
515
515
|
find(id, params, options)
|
516
516
|
end
|
517
517
|
|
518
|
+
# Parameters:
|
519
|
+
# remote_server_id - int64 - RemoteServer ID
|
520
|
+
# root - string - Remote path to list
|
521
|
+
# aws_access_key - string - AWS Access Key.
|
522
|
+
# aws_secret_key - string - AWS secret key.
|
523
|
+
# password - string - Password if needed.
|
524
|
+
# private_key - string - Private key if needed.
|
525
|
+
# ssl_certificate - string - SSL client certificate.
|
526
|
+
# google_cloud_storage_credentials_json - string - A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
|
527
|
+
# wasabi_access_key - string - Wasabi access key.
|
528
|
+
# wasabi_secret_key - string - Wasabi secret key.
|
529
|
+
# backblaze_b2_key_id - string - Backblaze B2 Cloud Storage keyID.
|
530
|
+
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
531
|
+
# rackspace_api_key - string - Rackspace API key from the Rackspace Cloud Control Panel.
|
532
|
+
# reset_authentication - boolean - Reset authenticated account
|
533
|
+
# azure_blob_storage_access_key - string - Azure Blob Storage secret key.
|
534
|
+
# hostname - string
|
535
|
+
# name - string
|
536
|
+
# max_connections - int64
|
537
|
+
# port - int64
|
538
|
+
# s3_bucket - string
|
539
|
+
# s3_region - string
|
540
|
+
# server_certificate - string
|
541
|
+
# server_host_key - string
|
542
|
+
# server_type - string
|
543
|
+
# ssl - string
|
544
|
+
# username - string
|
545
|
+
# google_cloud_storage_bucket - string
|
546
|
+
# google_cloud_storage_project_id - string
|
547
|
+
# backblaze_b2_bucket - string
|
548
|
+
# backblaze_b2_s3_endpoint - string
|
549
|
+
# wasabi_bucket - string
|
550
|
+
# wasabi_region - string
|
551
|
+
# rackspace_username - string
|
552
|
+
# rackspace_region - string
|
553
|
+
# rackspace_container - string
|
554
|
+
# one_drive_account_type - string
|
555
|
+
# azure_blob_storage_account - string
|
556
|
+
# azure_blob_storage_container - string
|
557
|
+
def self.list_for_testing(params = {}, options = {})
|
558
|
+
raise InvalidParameterError.new("Bad parameter: remote_server_id must be an Integer") if params.dig(:remote_server_id) and !params.dig(:remote_server_id).is_a?(Integer)
|
559
|
+
raise InvalidParameterError.new("Bad parameter: root must be an String") if params.dig(:root) and !params.dig(:root).is_a?(String)
|
560
|
+
raise InvalidParameterError.new("Bad parameter: aws_access_key must be an String") if params.dig(:aws_access_key) and !params.dig(:aws_access_key).is_a?(String)
|
561
|
+
raise InvalidParameterError.new("Bad parameter: aws_secret_key must be an String") if params.dig(:aws_secret_key) and !params.dig(:aws_secret_key).is_a?(String)
|
562
|
+
raise InvalidParameterError.new("Bad parameter: password must be an String") if params.dig(:password) and !params.dig(:password).is_a?(String)
|
563
|
+
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params.dig(:private_key) and !params.dig(:private_key).is_a?(String)
|
564
|
+
raise InvalidParameterError.new("Bad parameter: ssl_certificate must be an String") if params.dig(:ssl_certificate) and !params.dig(:ssl_certificate).is_a?(String)
|
565
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_credentials_json must be an String") if params.dig(:google_cloud_storage_credentials_json) and !params.dig(:google_cloud_storage_credentials_json).is_a?(String)
|
566
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params.dig(:wasabi_access_key) and !params.dig(:wasabi_access_key).is_a?(String)
|
567
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params.dig(:wasabi_secret_key) and !params.dig(:wasabi_secret_key).is_a?(String)
|
568
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_key_id must be an String") if params.dig(:backblaze_b2_key_id) and !params.dig(:backblaze_b2_key_id).is_a?(String)
|
569
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_application_key must be an String") if params.dig(:backblaze_b2_application_key) and !params.dig(:backblaze_b2_application_key).is_a?(String)
|
570
|
+
raise InvalidParameterError.new("Bad parameter: rackspace_api_key must be an String") if params.dig(:rackspace_api_key) and !params.dig(:rackspace_api_key).is_a?(String)
|
571
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_access_key must be an String") if params.dig(:azure_blob_storage_access_key) and !params.dig(:azure_blob_storage_access_key).is_a?(String)
|
572
|
+
raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params.dig(:hostname) and !params.dig(:hostname).is_a?(String)
|
573
|
+
raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
|
574
|
+
raise InvalidParameterError.new("Bad parameter: max_connections must be an Integer") if params.dig(:max_connections) and !params.dig(:max_connections).is_a?(Integer)
|
575
|
+
raise InvalidParameterError.new("Bad parameter: port must be an Integer") if params.dig(:port) and !params.dig(:port).is_a?(Integer)
|
576
|
+
raise InvalidParameterError.new("Bad parameter: s3_bucket must be an String") if params.dig(:s3_bucket) and !params.dig(:s3_bucket).is_a?(String)
|
577
|
+
raise InvalidParameterError.new("Bad parameter: s3_region must be an String") if params.dig(:s3_region) and !params.dig(:s3_region).is_a?(String)
|
578
|
+
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if params.dig(:server_certificate) and !params.dig(:server_certificate).is_a?(String)
|
579
|
+
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if params.dig(:server_host_key) and !params.dig(:server_host_key).is_a?(String)
|
580
|
+
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params.dig(:server_type) and !params.dig(:server_type).is_a?(String)
|
581
|
+
raise InvalidParameterError.new("Bad parameter: ssl must be an String") if params.dig(:ssl) and !params.dig(:ssl).is_a?(String)
|
582
|
+
raise InvalidParameterError.new("Bad parameter: username must be an String") if params.dig(:username) and !params.dig(:username).is_a?(String)
|
583
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_bucket must be an String") if params.dig(:google_cloud_storage_bucket) and !params.dig(:google_cloud_storage_bucket).is_a?(String)
|
584
|
+
raise InvalidParameterError.new("Bad parameter: google_cloud_storage_project_id must be an String") if params.dig(:google_cloud_storage_project_id) and !params.dig(:google_cloud_storage_project_id).is_a?(String)
|
585
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_bucket must be an String") if params.dig(:backblaze_b2_bucket) and !params.dig(:backblaze_b2_bucket).is_a?(String)
|
586
|
+
raise InvalidParameterError.new("Bad parameter: backblaze_b2_s3_endpoint must be an String") if params.dig(:backblaze_b2_s3_endpoint) and !params.dig(:backblaze_b2_s3_endpoint).is_a?(String)
|
587
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params.dig(:wasabi_bucket) and !params.dig(:wasabi_bucket).is_a?(String)
|
588
|
+
raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params.dig(:wasabi_region) and !params.dig(:wasabi_region).is_a?(String)
|
589
|
+
raise InvalidParameterError.new("Bad parameter: rackspace_username must be an String") if params.dig(:rackspace_username) and !params.dig(:rackspace_username).is_a?(String)
|
590
|
+
raise InvalidParameterError.new("Bad parameter: rackspace_region must be an String") if params.dig(:rackspace_region) and !params.dig(:rackspace_region).is_a?(String)
|
591
|
+
raise InvalidParameterError.new("Bad parameter: rackspace_container must be an String") if params.dig(:rackspace_container) and !params.dig(:rackspace_container).is_a?(String)
|
592
|
+
raise InvalidParameterError.new("Bad parameter: one_drive_account_type must be an String") if params.dig(:one_drive_account_type) and !params.dig(:one_drive_account_type).is_a?(String)
|
593
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_account must be an String") if params.dig(:azure_blob_storage_account) and !params.dig(:azure_blob_storage_account).is_a?(String)
|
594
|
+
raise InvalidParameterError.new("Bad parameter: azure_blob_storage_container must be an String") if params.dig(:azure_blob_storage_container) and !params.dig(:azure_blob_storage_container).is_a?(String)
|
595
|
+
|
596
|
+
response, options = Api.send_request("/remote_servers/list_for_testing", :get, params, options)
|
597
|
+
File.new(response.data, options)
|
598
|
+
end
|
599
|
+
|
518
600
|
# Parameters:
|
519
601
|
# aws_access_key - string - AWS Access Key.
|
520
602
|
# aws_secret_key - string - AWS secret key.
|
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.127
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-12-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|