files.com 1.1.431 → 1.1.432
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 +10 -2
- data/docs/automation_run.md +3 -1
- data/docs/behavior.md +3 -3
- data/docs/bundle.md +1 -1
- data/docs/gpg_key.md +14 -1
- data/docs/group.md +11 -3
- data/docs/remote_server.md +1 -1
- data/docs/remote_server_credential.md +10 -1
- data/docs/sync.md +14 -5
- data/docs/sync_run.md +4 -2
- data/docs/workspace.md +120 -0
- data/lib/files.com/models/automation.rb +17 -2
- data/lib/files.com/models/automation_run.rb +6 -1
- data/lib/files.com/models/behavior.rb +7 -8
- data/lib/files.com/models/bundle.rb +1 -1
- data/lib/files.com/models/gpg_key.rb +26 -1
- data/lib/files.com/models/group.rb +17 -2
- data/lib/files.com/models/remote_server.rb +1 -1
- data/lib/files.com/models/remote_server_credential.rb +18 -1
- data/lib/files.com/models/sync.rb +17 -2
- data/lib/files.com/models/sync_run.rb +7 -2
- data/lib/files.com/models/workspace.rb +144 -0
- data/lib/files.com/version.rb +1 -1
- data/lib/files.com.rb +1 -0
- metadata +3 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '0281c00f92ae40eca7e74e997831bb7879d06bc738e183c4b3cfbb3cc5929098'
|
|
4
|
+
data.tar.gz: 603596e6aab5c23e23565d93c401f90ef82c846b929a62a9195c5c26d1b019f7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7671f996918220deb4bf5961bb19da52e3e0852853102fddc3afe374264ee677c976e42b3f4acd8430541d15f4d209a0a25e908b9d8c27c7fb73afb6ea6daeb8
|
|
7
|
+
data.tar.gz: 79fe347de58a5415262c1de4b0b2a2f7bdfbd5ccb0436d7dc4a5f8997b07fd64513e51dc0eabd4644e226d539f7f28a0c097a77e626c0f850f143d508c84d8be
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.432
|
data/docs/automation.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
8
9
|
"always_serialize_jobs": true,
|
|
9
10
|
"always_overwrite_size_matching_files": true,
|
|
10
11
|
"automation": "create_folder",
|
|
@@ -96,6 +97,7 @@
|
|
|
96
97
|
```
|
|
97
98
|
|
|
98
99
|
* `id` (int64): Automation ID
|
|
100
|
+
* `workspace_id` (int64): Workspace ID
|
|
99
101
|
* `always_serialize_jobs` (boolean): Ordinarily, we will allow automation runs to run in parallel for non-scheduled automations. If this flag is `true` we will force automation runs to be serialized (run one at a time, one after another). This can resolve some issues with race conditions on remote systems at the cost of some performance.
|
|
100
102
|
* `always_overwrite_size_matching_files` (boolean): Ordinarily, files with identical size in the source and destination will be skipped from copy operations to prevent wasted transfer. If this flag is `true` we will overwrite the destination file always. Note that this may cause large amounts of wasted transfer usage. This setting has no effect unless `overwrite_files` is also set to `true`.
|
|
101
103
|
* `automation` (string): Automation type
|
|
@@ -149,8 +151,8 @@ Files::Automation.list
|
|
|
149
151
|
|
|
150
152
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
151
153
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
152
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `
|
|
153
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ automation, disabled ]`, `[ automation, last_modified_at ]`
|
|
154
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name`, `automation`, `last_modified_at` or `disabled`.
|
|
155
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled`, `last_modified_at`, `workspace_id` or `automation`. Valid field combinations are `[ disabled, last_modified_at ]`, `[ workspace_id, disabled ]`, `[ disabled, automation ]`, `[ workspace_id, last_modified_at ]`, `[ automation, last_modified_at ]`, `[ workspace_id, automation ]`, `[ workspace_id, disabled, last_modified_at ]`, `[ disabled, automation, last_modified_at ]`, `[ workspace_id, disabled, automation ]`, `[ workspace_id, automation, last_modified_at ]` or `[ workspace_id, disabled, automation, last_modified_at ]`.
|
|
154
156
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `last_modified_at`.
|
|
155
157
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `last_modified_at`.
|
|
156
158
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `last_modified_at`.
|
|
@@ -208,6 +210,7 @@ Files::Automation.create(
|
|
|
208
210
|
trigger_actions: ["create"],
|
|
209
211
|
value: {"limit":"1"},
|
|
210
212
|
recurring_day: 25,
|
|
213
|
+
workspace_id: 0,
|
|
211
214
|
automation: "create_folder"
|
|
212
215
|
)
|
|
213
216
|
```
|
|
@@ -246,6 +249,7 @@ Files::Automation.create(
|
|
|
246
249
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
247
250
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
248
251
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
252
|
+
* `workspace_id` (int64): Workspace ID
|
|
249
253
|
* `automation` (string): Required - Automation type
|
|
250
254
|
|
|
251
255
|
|
|
@@ -300,6 +304,7 @@ Files::Automation.update(id,
|
|
|
300
304
|
trigger_actions: ["create"],
|
|
301
305
|
value: {"limit":"1"},
|
|
302
306
|
recurring_day: 25,
|
|
307
|
+
workspace_id: 0,
|
|
303
308
|
automation: "create_folder"
|
|
304
309
|
)
|
|
305
310
|
```
|
|
@@ -339,6 +344,7 @@ Files::Automation.update(id,
|
|
|
339
344
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
340
345
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
341
346
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
347
|
+
* `workspace_id` (int64): Workspace ID
|
|
342
348
|
* `automation` (string): Automation type
|
|
343
349
|
|
|
344
350
|
|
|
@@ -410,6 +416,7 @@ automation.update(
|
|
|
410
416
|
trigger_actions: ["create"],
|
|
411
417
|
value: {"limit":"1"},
|
|
412
418
|
recurring_day: 25,
|
|
419
|
+
workspace_id: 0,
|
|
413
420
|
automation: "create_folder"
|
|
414
421
|
)
|
|
415
422
|
```
|
|
@@ -449,6 +456,7 @@ automation.update(
|
|
|
449
456
|
* `trigger_actions` (array(string)): If trigger is `action`, this is the list of action types on which to trigger the automation. Valid actions are create, read, update, destroy, move, archived_delete, copy
|
|
450
457
|
* `value` (object): A Hash of attributes specific to the automation type.
|
|
451
458
|
* `recurring_day` (int64): If trigger type is `daily`, this specifies a day number to run in one of the supported intervals: `week`, `month`, `quarter`, `year`.
|
|
459
|
+
* `workspace_id` (int64): Workspace ID
|
|
452
460
|
* `automation` (string): Automation type
|
|
453
461
|
|
|
454
462
|
|
data/docs/automation_run.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
8
|
"automation_id": 1,
|
|
9
|
+
"workspace_id": 1,
|
|
9
10
|
"completed_at": "2000-01-01T01:00:00Z",
|
|
10
11
|
"created_at": "2000-01-01T01:00:00Z",
|
|
11
12
|
"retry_at": "2000-01-01T01:00:00Z",
|
|
@@ -22,6 +23,7 @@
|
|
|
22
23
|
|
|
23
24
|
* `id` (int64): ID.
|
|
24
25
|
* `automation_id` (int64): ID of the associated Automation.
|
|
26
|
+
* `workspace_id` (int64): Workspace ID.
|
|
25
27
|
* `completed_at` (date-time): Automation run completion/failure date/time.
|
|
26
28
|
* `created_at` (date-time): Automation run start date/time.
|
|
27
29
|
* `retry_at` (date-time): If set, this automation will be retried at this date/time due to `failure` or `partial_failure`.
|
|
@@ -52,7 +54,7 @@ Files::AutomationRun.list(
|
|
|
52
54
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
53
55
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
54
56
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
|
|
55
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`
|
|
57
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id` or `automation_id`. Valid field combinations are `[ workspace_id, status ]`, `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, status ]`.
|
|
56
58
|
* `automation_id` (int64): Required - ID of the associated Automation.
|
|
57
59
|
|
|
58
60
|
|
data/docs/behavior.md
CHANGED
|
@@ -98,7 +98,7 @@ Files::Behavior.create(
|
|
|
98
98
|
|
|
99
99
|
### Parameters
|
|
100
100
|
|
|
101
|
-
* `value` (
|
|
101
|
+
* `value` (object): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
102
102
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
103
103
|
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
104
104
|
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
|
@@ -150,7 +150,7 @@ Files::Behavior.update(id,
|
|
|
150
150
|
### Parameters
|
|
151
151
|
|
|
152
152
|
* `id` (int64): Required - Behavior ID.
|
|
153
|
-
* `value` (
|
|
153
|
+
* `value` (object): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
154
154
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
155
155
|
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
156
156
|
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
|
@@ -192,7 +192,7 @@ behavior.update(
|
|
|
192
192
|
### Parameters
|
|
193
193
|
|
|
194
194
|
* `id` (int64): Required - Behavior ID.
|
|
195
|
-
* `value` (
|
|
195
|
+
* `value` (object): This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior.
|
|
196
196
|
* `attachment_file` (file): Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
|
|
197
197
|
* `disable_parent_folder_behavior` (boolean): If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree.
|
|
198
198
|
* `recursive` (boolean): If `true`, behavior is treated as recursive, meaning that it impacts child folders as well.
|
data/docs/bundle.md
CHANGED
|
@@ -152,7 +152,7 @@ Files::Bundle.list(
|
|
|
152
152
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
153
153
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
154
154
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
|
|
155
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id,
|
|
155
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
|
|
156
156
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
157
157
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
|
|
158
158
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
|
data/docs/gpg_key.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
8
9
|
"expires_at": "2000-01-01T01:00:00Z",
|
|
9
10
|
"name": "key name",
|
|
10
11
|
"partner_id": 1,
|
|
@@ -19,6 +20,7 @@
|
|
|
19
20
|
```
|
|
20
21
|
|
|
21
22
|
* `id` (int64): GPG key ID.
|
|
23
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace).
|
|
22
24
|
* `expires_at` (date-time): GPG key expiration date.
|
|
23
25
|
* `name` (string): GPG key name.
|
|
24
26
|
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
@@ -53,7 +55,12 @@ Files::GpgKey.list(
|
|
|
53
55
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
54
56
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
55
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
56
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`
|
|
58
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `name` or `expires_at`.
|
|
59
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `partner_id` or `expires_at`. Valid field combinations are `[ workspace_id, expires_at ]`.
|
|
60
|
+
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `expires_at`.
|
|
61
|
+
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `expires_at`.
|
|
62
|
+
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `expires_at`.
|
|
63
|
+
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `expires_at`.
|
|
57
64
|
|
|
58
65
|
|
|
59
66
|
---
|
|
@@ -77,6 +84,7 @@ Files::GpgKey.find(id)
|
|
|
77
84
|
Files::GpgKey.create(
|
|
78
85
|
user_id: 1,
|
|
79
86
|
partner_id: 1,
|
|
87
|
+
workspace_id: 0,
|
|
80
88
|
name: "key name",
|
|
81
89
|
generate_expires_at: "2025-06-19 12:00:00",
|
|
82
90
|
generate_keypair: false,
|
|
@@ -89,6 +97,7 @@ Files::GpgKey.create(
|
|
|
89
97
|
|
|
90
98
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
91
99
|
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
100
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace).
|
|
92
101
|
* `public_key` (string): The GPG public key
|
|
93
102
|
* `private_key` (string): The GPG private key
|
|
94
103
|
* `private_key_password` (string): The GPG private key password
|
|
@@ -106,6 +115,7 @@ Files::GpgKey.create(
|
|
|
106
115
|
```
|
|
107
116
|
Files::GpgKey.update(id,
|
|
108
117
|
partner_id: 1,
|
|
118
|
+
workspace_id: 0,
|
|
109
119
|
name: "key name"
|
|
110
120
|
)
|
|
111
121
|
```
|
|
@@ -114,6 +124,7 @@ Files::GpgKey.update(id,
|
|
|
114
124
|
|
|
115
125
|
* `id` (int64): Required - Gpg Key ID.
|
|
116
126
|
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
127
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace).
|
|
117
128
|
* `public_key` (string): The GPG public key
|
|
118
129
|
* `private_key` (string): The GPG private key
|
|
119
130
|
* `private_key_password` (string): The GPG private key password
|
|
@@ -142,6 +153,7 @@ gpg_key = Files::GpgKey.find(id)
|
|
|
142
153
|
|
|
143
154
|
gpg_key.update(
|
|
144
155
|
partner_id: 1,
|
|
156
|
+
workspace_id: 0,
|
|
145
157
|
name: "key name"
|
|
146
158
|
)
|
|
147
159
|
```
|
|
@@ -150,6 +162,7 @@ gpg_key.update(
|
|
|
150
162
|
|
|
151
163
|
* `id` (int64): Required - Gpg Key ID.
|
|
152
164
|
* `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
|
|
165
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace).
|
|
153
166
|
* `public_key` (string): The GPG public key
|
|
154
167
|
* `private_key` (string): The GPG private key
|
|
155
168
|
* `private_key_password` (string): The GPG private key password
|
data/docs/group.md
CHANGED
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
"sftp_permission": true,
|
|
16
16
|
"dav_permission": true,
|
|
17
17
|
"restapi_permission": true,
|
|
18
|
-
"site_id": 1
|
|
18
|
+
"site_id": 1,
|
|
19
|
+
"workspace_id": 1
|
|
19
20
|
}
|
|
20
21
|
```
|
|
21
22
|
|
|
@@ -31,6 +32,7 @@
|
|
|
31
32
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
32
33
|
* `restapi_permission` (boolean): If true, users in this group can use the REST API to login. This will override a false value of `restapi_permission` on the user level.
|
|
33
34
|
* `site_id` (int64): Site ID
|
|
35
|
+
* `workspace_id` (int64): Workspace ID
|
|
34
36
|
|
|
35
37
|
|
|
36
38
|
---
|
|
@@ -47,8 +49,8 @@ Files::Group.list(
|
|
|
47
49
|
|
|
48
50
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
49
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
50
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`
|
|
51
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
|
52
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id` or `name`.
|
|
53
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name` and `workspace_id`. Valid field combinations are `[ workspace_id, name ]`.
|
|
52
54
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
53
55
|
* `ids` (string): Comma-separated list of group ids to include in results.
|
|
54
56
|
* `include_parent_site_groups` (boolean): Include groups from the parent site.
|
|
@@ -76,6 +78,7 @@ Files::Group.create(
|
|
|
76
78
|
notes: "example",
|
|
77
79
|
user_ids: "1",
|
|
78
80
|
admin_ids: "1",
|
|
81
|
+
workspace_id: 0,
|
|
79
82
|
ftp_permission: true,
|
|
80
83
|
sftp_permission: true,
|
|
81
84
|
dav_permission: true,
|
|
@@ -90,6 +93,7 @@ Files::Group.create(
|
|
|
90
93
|
* `notes` (string): Group notes.
|
|
91
94
|
* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
|
|
92
95
|
* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
96
|
+
* `workspace_id` (int64): Workspace ID
|
|
93
97
|
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
94
98
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
95
99
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
@@ -107,6 +111,7 @@ Files::Group.update(id,
|
|
|
107
111
|
notes: "example",
|
|
108
112
|
user_ids: "1",
|
|
109
113
|
admin_ids: "1",
|
|
114
|
+
workspace_id: 0,
|
|
110
115
|
ftp_permission: true,
|
|
111
116
|
sftp_permission: true,
|
|
112
117
|
dav_permission: true,
|
|
@@ -122,6 +127,7 @@ Files::Group.update(id,
|
|
|
122
127
|
* `notes` (string): Group notes.
|
|
123
128
|
* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
|
|
124
129
|
* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
130
|
+
* `workspace_id` (int64): Workspace ID
|
|
125
131
|
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
126
132
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
127
133
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
|
@@ -154,6 +160,7 @@ group.update(
|
|
|
154
160
|
notes: "example",
|
|
155
161
|
user_ids: "1",
|
|
156
162
|
admin_ids: "1",
|
|
163
|
+
workspace_id: 0,
|
|
157
164
|
ftp_permission: true,
|
|
158
165
|
sftp_permission: true,
|
|
159
166
|
dav_permission: true,
|
|
@@ -169,6 +176,7 @@ group.update(
|
|
|
169
176
|
* `notes` (string): Group notes.
|
|
170
177
|
* `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
|
|
171
178
|
* `admin_ids` (string): A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
179
|
+
* `workspace_id` (int64): Workspace ID
|
|
172
180
|
* `ftp_permission` (boolean): If true, users in this group can use FTP to login. This will override a false value of `ftp_permission` on the user level.
|
|
173
181
|
* `sftp_permission` (boolean): If true, users in this group can use SFTP to login. This will override a false value of `sftp_permission` on the user level.
|
|
174
182
|
* `dav_permission` (boolean): If true, users in this group can use WebDAV to login. This will override a false value of `dav_permission` on the user level.
|
data/docs/remote_server.md
CHANGED
|
@@ -163,7 +163,7 @@ Files::RemoteServer.list
|
|
|
163
163
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
164
164
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
165
165
|
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`.
|
|
166
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[
|
|
166
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`, `server_type`, `workspace_id`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ server_type, name ]`, `[ workspace_id, name ]`, `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]`, `[ linode_bucket, name ]`, `[ workspace_id, server_type ]` or `[ workspace_id, server_type, name ]`.
|
|
167
167
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`, `backblaze_b2_bucket`, `google_cloud_storage_bucket`, `wasabi_bucket`, `s3_bucket`, `azure_blob_storage_container`, `azure_files_storage_share_name`, `s3_compatible_bucket`, `filebase_bucket`, `cloudflare_bucket` or `linode_bucket`. Valid field combinations are `[ backblaze_b2_bucket, name ]`, `[ google_cloud_storage_bucket, name ]`, `[ wasabi_bucket, name ]`, `[ s3_bucket, name ]`, `[ azure_blob_storage_container, name ]`, `[ azure_files_storage_share_name, name ]`, `[ s3_compatible_bucket, name ]`, `[ filebase_bucket, name ]`, `[ cloudflare_bucket, name ]` or `[ linode_bucket, name ]`.
|
|
168
168
|
|
|
169
169
|
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
8
9
|
"name": "My Credential",
|
|
9
10
|
"description": "More information or notes about this credential.",
|
|
10
11
|
"server_type": "s3",
|
|
@@ -22,6 +23,7 @@
|
|
|
22
23
|
```
|
|
23
24
|
|
|
24
25
|
* `id` (int64): Remote Server Credential ID
|
|
26
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
25
27
|
* `name` (string): Internal name for your reference
|
|
26
28
|
* `description` (string): Internal description for your reference
|
|
27
29
|
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -66,7 +68,8 @@ Files::RemoteServerCredential.list
|
|
|
66
68
|
|
|
67
69
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
68
70
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
69
|
-
* `
|
|
71
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `id`.
|
|
72
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id` and `name`. Valid field combinations are `[ workspace_id, name ]`.
|
|
70
73
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
71
74
|
|
|
72
75
|
|
|
@@ -89,6 +92,7 @@ Files::RemoteServerCredential.find(id)
|
|
|
89
92
|
|
|
90
93
|
```
|
|
91
94
|
Files::RemoteServerCredential.create(
|
|
95
|
+
workspace_id: 0,
|
|
92
96
|
name: "My Credential",
|
|
93
97
|
description: "More information or notes about this credential.",
|
|
94
98
|
server_type: "s3",
|
|
@@ -107,6 +111,7 @@ Files::RemoteServerCredential.create(
|
|
|
107
111
|
|
|
108
112
|
### Parameters
|
|
109
113
|
|
|
114
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
110
115
|
* `name` (string): Internal name for your reference
|
|
111
116
|
* `description` (string): Internal description for your reference
|
|
112
117
|
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -145,6 +150,7 @@ Files::RemoteServerCredential.create(
|
|
|
145
150
|
|
|
146
151
|
```
|
|
147
152
|
Files::RemoteServerCredential.update(id,
|
|
153
|
+
workspace_id: 0,
|
|
148
154
|
name: "My Credential",
|
|
149
155
|
description: "More information or notes about this credential.",
|
|
150
156
|
server_type: "s3",
|
|
@@ -164,6 +170,7 @@ Files::RemoteServerCredential.update(id,
|
|
|
164
170
|
### Parameters
|
|
165
171
|
|
|
166
172
|
* `id` (int64): Required - Remote Server Credential ID.
|
|
173
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
167
174
|
* `name` (string): Internal name for your reference
|
|
168
175
|
* `description` (string): Internal description for your reference
|
|
169
176
|
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -217,6 +224,7 @@ Files::RemoteServerCredential.delete(id)
|
|
|
217
224
|
remote_server_credential = Files::RemoteServerCredential.find(id)
|
|
218
225
|
|
|
219
226
|
remote_server_credential.update(
|
|
227
|
+
workspace_id: 0,
|
|
220
228
|
name: "My Credential",
|
|
221
229
|
description: "More information or notes about this credential.",
|
|
222
230
|
server_type: "s3",
|
|
@@ -236,6 +244,7 @@ remote_server_credential.update(
|
|
|
236
244
|
### Parameters
|
|
237
245
|
|
|
238
246
|
* `id` (int64): Required - Remote Server Credential ID.
|
|
247
|
+
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
239
248
|
* `name` (string): Internal name for your reference
|
|
240
249
|
* `description` (string): Internal description for your reference
|
|
241
250
|
* `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
data/docs/sync.md
CHANGED
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
"name": "example",
|
|
9
9
|
"description": "example",
|
|
10
10
|
"site_id": 1,
|
|
11
|
+
"workspace_id": 1,
|
|
11
12
|
"user_id": 1,
|
|
12
13
|
"src_path": "example",
|
|
13
14
|
"dest_path": "example",
|
|
@@ -59,6 +60,7 @@
|
|
|
59
60
|
"log_url": "https://www.example.com/log_file.txt",
|
|
60
61
|
"runtime": 1.0,
|
|
61
62
|
"site_id": 1,
|
|
63
|
+
"workspace_id": 1,
|
|
62
64
|
"src_remote_server_type": "example",
|
|
63
65
|
"status": "example",
|
|
64
66
|
"successful_files": 1,
|
|
@@ -73,6 +75,7 @@
|
|
|
73
75
|
* `name` (string): Name for this sync job
|
|
74
76
|
* `description` (string): Description for this sync job
|
|
75
77
|
* `site_id` (int64): Site ID this sync belongs to
|
|
78
|
+
* `workspace_id` (int64): Workspace ID this sync belongs to
|
|
76
79
|
* `user_id` (int64): User who created or owns this sync
|
|
77
80
|
* `src_path` (string): Absolute source path for the sync
|
|
78
81
|
* `dest_path` (string): Absolute destination path for the sync
|
|
@@ -110,8 +113,8 @@ Files::Sync.list
|
|
|
110
113
|
|
|
111
114
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
112
115
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
113
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`.
|
|
114
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `src_remote_server_id`
|
|
116
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id` and `workspace_id`.
|
|
117
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`, `disabled`, `src_remote_server_id` or `dest_remote_server_id`. Valid field combinations are `[ workspace_id, disabled ]`, `[ workspace_id, src_remote_server_id ]`, `[ workspace_id, dest_remote_server_id ]`, `[ disabled, src_remote_server_id ]`, `[ disabled, dest_remote_server_id ]`, `[ workspace_id, disabled, src_remote_server_id ]` or `[ workspace_id, disabled, dest_remote_server_id ]`.
|
|
115
118
|
|
|
116
119
|
|
|
117
120
|
---
|
|
@@ -150,7 +153,8 @@ Files::Sync.create(
|
|
|
150
153
|
recurring_day: 25,
|
|
151
154
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
152
155
|
schedule_days_of_week: [0,2,4],
|
|
153
|
-
schedule_times_of_day: ["06:30","14:30"]
|
|
156
|
+
schedule_times_of_day: ["06:30","14:30"],
|
|
157
|
+
workspace_id: 1
|
|
154
158
|
)
|
|
155
159
|
```
|
|
156
160
|
|
|
@@ -174,6 +178,7 @@ Files::Sync.create(
|
|
|
174
178
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
175
179
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
176
180
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
181
|
+
* `workspace_id` (int64): Workspace ID this sync belongs to
|
|
177
182
|
|
|
178
183
|
|
|
179
184
|
---
|
|
@@ -225,7 +230,8 @@ Files::Sync.update(id,
|
|
|
225
230
|
recurring_day: 25,
|
|
226
231
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
227
232
|
schedule_days_of_week: [0,2,4],
|
|
228
|
-
schedule_times_of_day: ["06:30","14:30"]
|
|
233
|
+
schedule_times_of_day: ["06:30","14:30"],
|
|
234
|
+
workspace_id: 1
|
|
229
235
|
)
|
|
230
236
|
```
|
|
231
237
|
|
|
@@ -250,6 +256,7 @@ Files::Sync.update(id,
|
|
|
250
256
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
251
257
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
252
258
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
259
|
+
* `workspace_id` (int64): Workspace ID this sync belongs to
|
|
253
260
|
|
|
254
261
|
|
|
255
262
|
---
|
|
@@ -320,7 +327,8 @@ sync.update(
|
|
|
320
327
|
recurring_day: 25,
|
|
321
328
|
schedule_time_zone: "Eastern Time (US & Canada)",
|
|
322
329
|
schedule_days_of_week: [0,2,4],
|
|
323
|
-
schedule_times_of_day: ["06:30","14:30"]
|
|
330
|
+
schedule_times_of_day: ["06:30","14:30"],
|
|
331
|
+
workspace_id: 1
|
|
324
332
|
)
|
|
325
333
|
```
|
|
326
334
|
|
|
@@ -345,6 +353,7 @@ sync.update(
|
|
|
345
353
|
* `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
346
354
|
* `schedule_days_of_week` (array(int64)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. 0-based days of the week. 0 is Sunday, 1 is Monday, etc.
|
|
347
355
|
* `schedule_times_of_day` (array(string)): If trigger is `custom_schedule`, Custom schedule description for when the sync should be run. Times of day in HH:MM format.
|
|
356
|
+
* `workspace_id` (int64): Workspace ID this sync belongs to
|
|
348
357
|
|
|
349
358
|
|
|
350
359
|
---
|
data/docs/sync_run.md
CHANGED
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
"log_url": "https://www.example.com/log_file.txt",
|
|
22
22
|
"runtime": 1.0,
|
|
23
23
|
"site_id": 1,
|
|
24
|
+
"workspace_id": 1,
|
|
24
25
|
"src_remote_server_type": "example",
|
|
25
26
|
"status": "example",
|
|
26
27
|
"successful_files": 1,
|
|
@@ -45,6 +46,7 @@
|
|
|
45
46
|
* `log_url` (string): Link to external log file.
|
|
46
47
|
* `runtime` (double): Total runtime in seconds
|
|
47
48
|
* `site_id` (int64): Site ID
|
|
49
|
+
* `workspace_id` (int64): Workspace ID
|
|
48
50
|
* `src_remote_server_type` (string): Source remote server type, if any
|
|
49
51
|
* `status` (string): Status of the sync run (success, failure, partial_failure, in_progress, skipped)
|
|
50
52
|
* `successful_files` (int64): Number of files successfully synced
|
|
@@ -68,8 +70,8 @@ Files::SyncRun.list(
|
|
|
68
70
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
69
71
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
70
72
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
71
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `sync_id`, `created_at` or `status`.
|
|
72
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]` or `[ sync_id, status, created_at ]`.
|
|
73
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id`, `sync_id`, `created_at` or `status`.
|
|
74
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status`, `dry_run`, `workspace_id`, `src_remote_server_type`, `dest_remote_server_type` or `sync_id`. Valid field combinations are `[ status, created_at ]`, `[ workspace_id, created_at ]`, `[ src_remote_server_type, created_at ]`, `[ dest_remote_server_type, created_at ]`, `[ sync_id, created_at ]`, `[ workspace_id, status ]`, `[ src_remote_server_type, status ]`, `[ dest_remote_server_type, status ]`, `[ sync_id, status ]`, `[ workspace_id, src_remote_server_type ]`, `[ workspace_id, dest_remote_server_type ]`, `[ workspace_id, sync_id ]`, `[ workspace_id, status, created_at ]`, `[ src_remote_server_type, status, created_at ]`, `[ dest_remote_server_type, status, created_at ]`, `[ sync_id, status, created_at ]`, `[ workspace_id, src_remote_server_type, created_at ]`, `[ workspace_id, dest_remote_server_type, created_at ]`, `[ workspace_id, sync_id, created_at ]`, `[ workspace_id, src_remote_server_type, status ]`, `[ workspace_id, dest_remote_server_type, status ]`, `[ workspace_id, sync_id, status ]`, `[ workspace_id, src_remote_server_type, status, created_at ]`, `[ workspace_id, dest_remote_server_type, status, created_at ]` or `[ workspace_id, sync_id, status, created_at ]`.
|
|
73
75
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
74
76
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
75
77
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
data/docs/workspace.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# Workspace
|
|
2
|
+
|
|
3
|
+
## Example Workspace Object
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
{
|
|
7
|
+
"id": 1,
|
|
8
|
+
"name": "Project Alpha"
|
|
9
|
+
}
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
* `id` (int64): Workspace ID
|
|
13
|
+
* `name` (string): Workspace name
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## List Workspaces
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
Files::Workspace.list
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
### Parameters
|
|
25
|
+
|
|
26
|
+
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
27
|
+
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
28
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
|
|
29
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `name`.
|
|
30
|
+
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `name`.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Show Workspace
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
Files::Workspace.find(id)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
* `id` (int64): Required - Workspace ID.
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Create Workspace
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
Files::Workspace.create(
|
|
52
|
+
name: "Project Alpha"
|
|
53
|
+
)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
* `name` (string): Workspace name
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## Update Workspace
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
Files::Workspace.update(id,
|
|
67
|
+
name: "Project Alpha"
|
|
68
|
+
)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
|
|
73
|
+
* `id` (int64): Required - Workspace ID.
|
|
74
|
+
* `name` (string): Workspace name
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Delete Workspace
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
Files::Workspace.delete(id)
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
* `id` (int64): Required - Workspace ID.
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## Update Workspace
|
|
93
|
+
|
|
94
|
+
```
|
|
95
|
+
workspace = Files::Workspace.find(id)
|
|
96
|
+
|
|
97
|
+
workspace.update(
|
|
98
|
+
name: "Project Alpha"
|
|
99
|
+
)
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
* `id` (int64): Required - Workspace ID.
|
|
105
|
+
* `name` (string): Workspace name
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Delete Workspace
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
workspace = Files::Workspace.find(id)
|
|
114
|
+
|
|
115
|
+
workspace.delete
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Parameters
|
|
119
|
+
|
|
120
|
+
* `id` (int64): Required - Workspace ID.
|