files.com 1.0.120 → 1.0.125
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 +1 -4
- data/docs/app.md +1 -4
- data/docs/as2_key.md +1 -4
- data/docs/automation.md +35 -11
- data/docs/bandwidth_snapshot.md +1 -4
- data/docs/behavior.md +2 -8
- data/docs/bundle.md +11 -6
- data/docs/bundle_download.md +1 -4
- data/docs/bundle_recipient.md +1 -4
- data/docs/clickwrap.md +3 -5
- data/docs/dns_record.md +1 -4
- data/docs/external_event.md +1 -4
- data/docs/file_comment.md +1 -4
- data/docs/folder.md +1 -4
- data/docs/group.md +1 -4
- data/docs/group_user.md +1 -4
- data/docs/history.md +10 -30
- data/docs/history_export_result.md +1 -5
- data/docs/invoice.md +1 -4
- data/docs/ip_address.md +2 -8
- data/docs/lock.md +1 -4
- data/docs/message.md +1 -4
- data/docs/message_comment.md +1 -4
- data/docs/message_comment_reaction.md +1 -4
- data/docs/message_reaction.md +1 -4
- data/docs/notification.md +1 -4
- data/docs/payment.md +1 -4
- data/docs/permission.md +1 -4
- data/docs/project.md +1 -4
- data/docs/public_key.md +1 -4
- data/docs/remote_server.md +60 -4
- data/docs/request.md +2 -8
- data/docs/settings_change.md +1 -4
- data/docs/sso_strategy.md +5 -4
- data/docs/usage_daily_snapshot.md +1 -4
- data/docs/usage_snapshot.md +1 -4
- data/docs/user.md +1 -4
- data/docs/user_cipher_use.md +1 -4
- data/docs/user_request.md +1 -4
- data/lib/files.com/models/api_key.rb +2 -6
- data/lib/files.com/models/app.rb +2 -6
- data/lib/files.com/models/as2_key.rb +2 -6
- data/lib/files.com/models/automation.rb +34 -9
- data/lib/files.com/models/bandwidth_snapshot.rb +2 -6
- data/lib/files.com/models/behavior.rb +4 -12
- data/lib/files.com/models/bundle.rb +10 -6
- data/lib/files.com/models/bundle_download.rb +2 -6
- data/lib/files.com/models/bundle_recipient.rb +2 -6
- data/lib/files.com/models/clickwrap.rb +11 -15
- data/lib/files.com/models/dns_record.rb +2 -6
- data/lib/files.com/models/external_event.rb +2 -6
- data/lib/files.com/models/file_comment.rb +2 -6
- data/lib/files.com/models/folder.rb +2 -6
- data/lib/files.com/models/group.rb +2 -6
- data/lib/files.com/models/group_user.rb +2 -6
- data/lib/files.com/models/history.rb +10 -30
- data/lib/files.com/models/history_export_result.rb +2 -6
- data/lib/files.com/models/invoice.rb +2 -6
- data/lib/files.com/models/ip_address.rb +4 -12
- data/lib/files.com/models/lock.rb +2 -6
- data/lib/files.com/models/message.rb +2 -6
- data/lib/files.com/models/message_comment.rb +2 -6
- data/lib/files.com/models/message_comment_reaction.rb +2 -6
- data/lib/files.com/models/message_reaction.rb +2 -6
- data/lib/files.com/models/notification.rb +2 -6
- data/lib/files.com/models/payment.rb +2 -6
- data/lib/files.com/models/permission.rb +2 -6
- data/lib/files.com/models/project.rb +2 -6
- data/lib/files.com/models/public_key.rb +2 -6
- data/lib/files.com/models/remote_server.rb +99 -6
- data/lib/files.com/models/request.rb +4 -12
- data/lib/files.com/models/settings_change.rb +2 -6
- data/lib/files.com/models/sso_strategy.rb +12 -6
- data/lib/files.com/models/usage_daily_snapshot.rb +2 -6
- data/lib/files.com/models/usage_snapshot.rb +2 -6
- data/lib/files.com/models/user.rb +2 -6
- data/lib/files.com/models/user_cipher_use.rb +2 -6
- data/lib/files.com/models/user_request.rb +2 -6
- metadata +2 -2
data/docs/remote_server.md
CHANGED
@@ -67,6 +67,7 @@
|
|
67
67
|
* `aws_secret_key` (string): AWS secret key.
|
68
68
|
* `password` (string): Password if needed.
|
69
69
|
* `private_key` (string): Private key if needed.
|
70
|
+
* `ssl_certificate` (string): SSL client certificate.
|
70
71
|
* `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
|
71
72
|
* `wasabi_access_key` (string): Wasabi access key.
|
72
73
|
* `wasabi_secret_key` (string): Wasabi secret key.
|
@@ -83,17 +84,14 @@
|
|
83
84
|
|
84
85
|
```
|
85
86
|
Files::RemoteServer.list(
|
86
|
-
page: 1,
|
87
87
|
per_page: 1
|
88
88
|
)
|
89
89
|
```
|
90
90
|
|
91
91
|
### Parameters
|
92
92
|
|
93
|
-
* `
|
93
|
+
* `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.
|
94
94
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
95
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
96
|
-
* `cursor` (string): Send cursor 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.
|
97
95
|
|
98
96
|
|
99
97
|
---
|
@@ -109,6 +107,61 @@ Files::RemoteServer.find(id)
|
|
109
107
|
* `id` (int64): Required - Remote Server ID.
|
110
108
|
|
111
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
|
+
|
112
165
|
---
|
113
166
|
|
114
167
|
## Create Remote Server
|
@@ -148,6 +201,7 @@ Files::RemoteServer.create(
|
|
148
201
|
* `aws_secret_key` (string): AWS secret key.
|
149
202
|
* `password` (string): Password if needed.
|
150
203
|
* `private_key` (string): Private key if needed.
|
204
|
+
* `ssl_certificate` (string): SSL client certificate.
|
151
205
|
* `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
|
152
206
|
* `wasabi_access_key` (string): Wasabi access key.
|
153
207
|
* `wasabi_secret_key` (string): Wasabi secret key.
|
@@ -221,6 +275,7 @@ Files::RemoteServer.update(id,
|
|
221
275
|
* `aws_secret_key` (string): AWS secret key.
|
222
276
|
* `password` (string): Password if needed.
|
223
277
|
* `private_key` (string): Private key if needed.
|
278
|
+
* `ssl_certificate` (string): SSL client certificate.
|
224
279
|
* `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
|
225
280
|
* `wasabi_access_key` (string): Wasabi access key.
|
226
281
|
* `wasabi_secret_key` (string): Wasabi secret key.
|
@@ -309,6 +364,7 @@ remote_server.update(
|
|
309
364
|
* `aws_secret_key` (string): AWS secret key.
|
310
365
|
* `password` (string): Password if needed.
|
311
366
|
* `private_key` (string): Private key if needed.
|
367
|
+
* `ssl_certificate` (string): SSL client certificate.
|
312
368
|
* `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
|
313
369
|
* `wasabi_access_key` (string): Wasabi access key.
|
314
370
|
* `wasabi_secret_key` (string): Wasabi secret key.
|
data/docs/request.md
CHANGED
@@ -29,7 +29,6 @@
|
|
29
29
|
|
30
30
|
```
|
31
31
|
Files::Request.list(
|
32
|
-
page: 1,
|
33
32
|
per_page: 1,
|
34
33
|
mine: true
|
35
34
|
)
|
@@ -37,10 +36,8 @@ Files::Request.list(
|
|
37
36
|
|
38
37
|
### Parameters
|
39
38
|
|
40
|
-
* `
|
39
|
+
* `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.
|
41
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
42
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
43
|
-
* `cursor` (string): Send cursor 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
41
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `folder_id` or `destination`.
|
45
42
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
46
43
|
* `path` (string): Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
@@ -52,7 +49,6 @@ Files::Request.list(
|
|
52
49
|
|
53
50
|
```
|
54
51
|
Files::Request.get_folder(path,
|
55
|
-
page: 1,
|
56
52
|
per_page: 1,
|
57
53
|
mine: true
|
58
54
|
)
|
@@ -60,10 +56,8 @@ Files::Request.get_folder(path,
|
|
60
56
|
|
61
57
|
### Parameters
|
62
58
|
|
63
|
-
* `
|
59
|
+
* `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.
|
64
60
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
65
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
66
|
-
* `cursor` (string): Send cursor 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.
|
67
61
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `folder_id` or `destination`.
|
68
62
|
* `mine` (boolean): Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
69
63
|
* `path` (string): Required - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
data/docs/settings_change.md
CHANGED
@@ -21,17 +21,14 @@
|
|
21
21
|
|
22
22
|
```
|
23
23
|
Files::SettingsChange.list(
|
24
|
-
page: 1,
|
25
24
|
per_page: 1
|
26
25
|
)
|
27
26
|
```
|
28
27
|
|
29
28
|
### Parameters
|
30
29
|
|
31
|
-
* `
|
30
|
+
* `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.
|
32
31
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
33
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
34
|
-
* `cursor` (string): Send cursor 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.
|
35
32
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `api_key_id`, `created_at` or `user_id`.
|
36
33
|
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
|
37
34
|
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
|
data/docs/sso_strategy.md
CHANGED
@@ -19,6 +19,8 @@
|
|
19
19
|
"saml_provider_sso_target_url": "",
|
20
20
|
"scim_authentication_method": "",
|
21
21
|
"scim_username": "",
|
22
|
+
"scim_oauth_access_token": "",
|
23
|
+
"scim_oauth_access_token_expires_at": "",
|
22
24
|
"subdomain": "my-site",
|
23
25
|
"provision_users": true,
|
24
26
|
"provision_groups": true,
|
@@ -62,6 +64,8 @@
|
|
62
64
|
* `saml_provider_sso_target_url` (string): Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
63
65
|
* `scim_authentication_method` (string): SCIM authentication type.
|
64
66
|
* `scim_username` (string): SCIM username.
|
67
|
+
* `scim_oauth_access_token` (string): SCIM OAuth Access Token.
|
68
|
+
* `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
|
65
69
|
* `subdomain` (string): Subdomain
|
66
70
|
* `provision_users` (boolean): Auto-provision users?
|
67
71
|
* `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
|
@@ -97,17 +101,14 @@
|
|
97
101
|
|
98
102
|
```
|
99
103
|
Files::SsoStrategy.list(
|
100
|
-
page: 1,
|
101
104
|
per_page: 1
|
102
105
|
)
|
103
106
|
```
|
104
107
|
|
105
108
|
### Parameters
|
106
109
|
|
107
|
-
* `
|
110
|
+
* `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.
|
108
111
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
109
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
110
|
-
* `cursor` (string): Send cursor 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.
|
111
112
|
|
112
113
|
|
113
114
|
---
|
@@ -25,17 +25,14 @@
|
|
25
25
|
|
26
26
|
```
|
27
27
|
Files::UsageDailySnapshot.list(
|
28
|
-
page: 1,
|
29
28
|
per_page: 1
|
30
29
|
)
|
31
30
|
```
|
32
31
|
|
33
32
|
### Parameters
|
34
33
|
|
35
|
-
* `
|
34
|
+
* `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.
|
36
35
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
37
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
38
|
-
* `cursor` (string): Send cursor 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.
|
39
36
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `date` or `usage_snapshot_id`.
|
40
37
|
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
41
38
|
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
data/docs/usage_snapshot.md
CHANGED
@@ -41,14 +41,11 @@
|
|
41
41
|
|
42
42
|
```
|
43
43
|
Files::UsageSnapshot.list(
|
44
|
-
page: 1,
|
45
44
|
per_page: 1
|
46
45
|
)
|
47
46
|
```
|
48
47
|
|
49
48
|
### Parameters
|
50
49
|
|
51
|
-
* `
|
50
|
+
* `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.
|
52
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
53
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
54
|
-
* `cursor` (string): Send cursor 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.
|
data/docs/user.md
CHANGED
@@ -120,17 +120,14 @@
|
|
120
120
|
|
121
121
|
```
|
122
122
|
Files::User.list(
|
123
|
-
page: 1,
|
124
123
|
per_page: 1
|
125
124
|
)
|
126
125
|
```
|
127
126
|
|
128
127
|
### Parameters
|
129
128
|
|
130
|
-
* `
|
129
|
+
* `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.
|
131
130
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
132
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
133
|
-
* `cursor` (string): Send cursor 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.
|
134
131
|
* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `active`, `master_admin`, `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `username`, `company`, `name`, `notes`, `site_admin`, `receive_admin_alerts`, `allowed_ips`, `password_validity_days`, `ssl_required` or `not_site_admin`.
|
135
132
|
* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
|
136
133
|
* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `username`, `email`, `company`, `notes`, `site_admin`, `allowed_ips`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until` or `not_site_admin`.
|
data/docs/user_cipher_use.md
CHANGED
@@ -28,7 +28,6 @@
|
|
28
28
|
```
|
29
29
|
Files::UserCipherUse.list(
|
30
30
|
user_id: 1,
|
31
|
-
page: 1,
|
32
31
|
per_page: 1
|
33
32
|
)
|
34
33
|
```
|
@@ -36,7 +35,5 @@ Files::UserCipherUse.list(
|
|
36
35
|
### Parameters
|
37
36
|
|
38
37
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
39
|
-
* `
|
38
|
+
* `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.
|
40
39
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
41
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
42
|
-
* `cursor` (string): Send cursor 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.
|
data/docs/user_request.md
CHANGED
@@ -23,17 +23,14 @@
|
|
23
23
|
|
24
24
|
```
|
25
25
|
Files::UserRequest.list(
|
26
|
-
page: 1,
|
27
26
|
per_page: 1
|
28
27
|
)
|
29
28
|
```
|
30
29
|
|
31
30
|
### Parameters
|
32
31
|
|
33
|
-
* `
|
32
|
+
* `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.
|
34
33
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
35
|
-
* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
36
|
-
* `cursor` (string): Send cursor 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.
|
37
34
|
|
38
35
|
|
39
36
|
---
|
@@ -146,10 +146,8 @@ module Files
|
|
146
146
|
|
147
147
|
# Parameters:
|
148
148
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
149
|
-
#
|
149
|
+
# 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.
|
150
150
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
151
|
-
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
152
|
-
# cursor - string - Send cursor 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.
|
153
151
|
# sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `deleted_at` and `expires_at`.
|
154
152
|
# filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
|
155
153
|
# filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
|
@@ -159,10 +157,8 @@ module Files
|
|
159
157
|
# filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `expires_at`.
|
160
158
|
def self.list(params = {}, options = {})
|
161
159
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
162
|
-
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
163
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
164
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
165
160
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
161
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
166
162
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
167
163
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
168
164
|
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
data/lib/files.com/models/app.rb
CHANGED
@@ -75,10 +75,8 @@ module Files
|
|
75
75
|
end
|
76
76
|
|
77
77
|
# Parameters:
|
78
|
-
#
|
78
|
+
# 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.
|
79
79
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
80
|
-
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
81
|
-
# cursor - string - Send cursor 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.
|
82
80
|
# sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `name` and `app_type`.
|
83
81
|
# filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name` and `app_type`.
|
84
82
|
# filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name` and `app_type`.
|
@@ -87,10 +85,8 @@ module Files
|
|
87
85
|
# filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `name` and `app_type`.
|
88
86
|
# filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `name` and `app_type`.
|
89
87
|
def self.list(params = {}, options = {})
|
90
|
-
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
91
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
92
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
93
88
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
89
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
94
90
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
95
91
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
96
92
|
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
@@ -98,16 +98,12 @@ module Files
|
|
98
98
|
|
99
99
|
# Parameters:
|
100
100
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
|
-
#
|
101
|
+
# 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.
|
102
102
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
103
|
-
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
104
|
-
# cursor - string - Send cursor 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.
|
105
103
|
def self.list(params = {}, options = {})
|
106
104
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
107
|
-
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
108
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
109
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
110
105
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
106
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
111
107
|
|
112
108
|
List.new(As2Key, params) do
|
113
109
|
Api.send_request("/as2_keys", :get, params, options)
|
@@ -126,8 +126,26 @@ module Files
|
|
126
126
|
@attributes[:group_ids] = value
|
127
127
|
end
|
128
128
|
|
129
|
+
# string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
|
130
|
+
def trigger
|
131
|
+
@attributes[:trigger]
|
132
|
+
end
|
133
|
+
|
134
|
+
def trigger=(value)
|
135
|
+
@attributes[:trigger] = value
|
136
|
+
end
|
137
|
+
|
138
|
+
# object - Custom schedule description for when the automation should be run.
|
139
|
+
def schedule
|
140
|
+
@attributes[:schedule]
|
141
|
+
end
|
142
|
+
|
143
|
+
def schedule=(value)
|
144
|
+
@attributes[:schedule] = value
|
145
|
+
end
|
146
|
+
|
129
147
|
# Parameters:
|
130
|
-
# automation (required) - string -
|
148
|
+
# automation (required) - string - Automation type
|
131
149
|
# source - string - Source Path
|
132
150
|
# destination - string - Destination Path
|
133
151
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -136,6 +154,8 @@ module Files
|
|
136
154
|
# path - string - Path on which this Automation runs. Supports globs.
|
137
155
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
138
156
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
157
|
+
# schedule - object - Custom schedule for running this automation.
|
158
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
|
139
159
|
def update(params = {})
|
140
160
|
params ||= {}
|
141
161
|
params[:id] = @attributes[:id]
|
@@ -150,6 +170,7 @@ module Files
|
|
150
170
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
151
171
|
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
172
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
173
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
153
174
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
154
175
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
155
176
|
|
@@ -180,10 +201,8 @@ module Files
|
|
180
201
|
end
|
181
202
|
|
182
203
|
# Parameters:
|
183
|
-
#
|
204
|
+
# 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.
|
184
205
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
185
|
-
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
186
|
-
# cursor - string - Send cursor 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.
|
187
206
|
# sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id` and `automation`.
|
188
207
|
# filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `automation`.
|
189
208
|
# filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `automation`.
|
@@ -193,10 +212,8 @@ module Files
|
|
193
212
|
# filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `automation`.
|
194
213
|
# automation - string - DEPRECATED: Type of automation to filter by. Use `filter[automation]` instead.
|
195
214
|
def self.list(params = {}, options = {})
|
196
|
-
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
197
|
-
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
198
|
-
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
199
215
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
216
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
200
217
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
201
218
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
202
219
|
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
@@ -232,7 +249,7 @@ module Files
|
|
232
249
|
end
|
233
250
|
|
234
251
|
# Parameters:
|
235
|
-
# automation (required) - string -
|
252
|
+
# automation (required) - string - Automation type
|
236
253
|
# source - string - Source Path
|
237
254
|
# destination - string - Destination Path
|
238
255
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -241,6 +258,8 @@ module Files
|
|
241
258
|
# path - string - Path on which this Automation runs. Supports globs.
|
242
259
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
243
260
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
261
|
+
# schedule - object - Custom schedule for running this automation.
|
262
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
|
244
263
|
def self.create(params = {}, options = {})
|
245
264
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params.dig(:automation) and !params.dig(:automation).is_a?(String)
|
246
265
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params.dig(:source) and !params.dig(:source).is_a?(String)
|
@@ -251,6 +270,8 @@ module Files
|
|
251
270
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
252
271
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
253
272
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
273
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
274
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
254
275
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
255
276
|
|
256
277
|
response, options = Api.send_request("/automations", :post, params, options)
|
@@ -258,7 +279,7 @@ module Files
|
|
258
279
|
end
|
259
280
|
|
260
281
|
# Parameters:
|
261
|
-
# automation (required) - string -
|
282
|
+
# automation (required) - string - Automation type
|
262
283
|
# source - string - Source Path
|
263
284
|
# destination - string - Destination Path
|
264
285
|
# destination_replace_from - string - If set, this string in the destination path will be replaced with the value in `destination_replace_to`.
|
@@ -267,6 +288,8 @@ module Files
|
|
267
288
|
# path - string - Path on which this Automation runs. Supports globs.
|
268
289
|
# user_ids - string - A list of user IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
269
290
|
# group_ids - string - A list of group IDs the automation is associated with. If sent as a string, it should be comma-delimited.
|
291
|
+
# schedule - object - Custom schedule for running this automation.
|
292
|
+
# trigger - string - How this automation is triggered to run. One of: `realtime` or `custom_schedule`.
|
270
293
|
def self.update(id, params = {}, options = {})
|
271
294
|
params ||= {}
|
272
295
|
params[:id] = id
|
@@ -280,6 +303,8 @@ module Files
|
|
280
303
|
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
281
304
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params.dig(:user_ids) and !params.dig(:user_ids).is_a?(String)
|
282
305
|
raise InvalidParameterError.new("Bad parameter: group_ids must be an String") if params.dig(:group_ids) and !params.dig(:group_ids).is_a?(String)
|
306
|
+
raise InvalidParameterError.new("Bad parameter: schedule must be an Hash") if params.dig(:schedule) and !params.dig(:schedule).is_a?(Hash)
|
307
|
+
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params.dig(:trigger) and !params.dig(:trigger).is_a?(String)
|
283
308
|
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
284
309
|
raise MissingParameterError.new("Parameter missing: automation") unless params.dig(:automation)
|
285
310
|
|