files.com 1.1.433 → 1.1.435

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e1092ad2ad188de3535a717224d3d42c85d5b760375b0fa1d605787c49e8a092
4
- data.tar.gz: ebe93287ffbda30fac54b04c445ad0f9b5506628edd62d667593e5087e39f1e5
3
+ metadata.gz: 8bd20db2ca2673aa76eb8fa7de7e46a65e5ad6eeaaab749ede4b7db1e999a74f
4
+ data.tar.gz: abddb1c48f990b5f6bdc686d4926aa99b0fcbc39e4b56e77900f54a4f2537ce0
5
5
  SHA512:
6
- metadata.gz: 3a4996fab8c6c1f0f9385ab699d129e9978913349135f6db8fc1237f2ba035d3d1a7fd4b22cd78ec364a66f49b84de0a4fcf16e800d6250dd54a57fcb50ac9e6
7
- data.tar.gz: 2490c6214a9fd6cad4d938eaf9400dc1c1fd3718aa5febb2d000c1fcdf8ac45b192ad54d32d4a515bd010913219b1fd94e2c3cfddaf18db227d3c50102319350
6
+ metadata.gz: 6c76557831998d1c2dc989bb52d710b991d7856eb7fd8874cf389865c332fff161f7868c18409f872ea44b82c81614891438abe7f100e7294248afd25e18bc7c
7
+ data.tar.gz: a3712a2fa6c81f3ffa06a1fdd57b573a49ae0ce67f56587d46415a8d597e9b5f43afc0cd8731065c70991b904334d3f4eaefac6d5e5aa1414784478eed53e963
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.433
1
+ 1.1.435
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "workspace_id": 1,
8
9
  "as2_partner_id": 1,
9
10
  "as2_station_id": 1,
10
11
  "uuid": "example",
@@ -46,6 +47,7 @@
46
47
  ```
47
48
 
48
49
  * `id` (int64): Id of the AS2 Partner.
50
+ * `workspace_id` (int64): ID of the Workspace associated with this AS2 Incoming Message.
49
51
  * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
50
52
  * `as2_station_id` (int64): Id of the AS2 Station associated with this message.
51
53
  * `uuid` (string): UUID assigned to this message.
@@ -93,8 +95,8 @@ Files::As2IncomingMessage.list
93
95
 
94
96
  * `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.
95
97
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
96
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `as2_partner_id`.
97
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]` and `[ as2_partner_id, created_at ]`.
98
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `as2_partner_id`.
99
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
98
100
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
99
101
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
100
102
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "workspace_id": 1,
8
9
  "as2_partner_id": 1,
9
10
  "as2_station_id": 1,
10
11
  "uuid": "example",
@@ -42,6 +43,7 @@
42
43
  ```
43
44
 
44
45
  * `id` (int64): Id of the AS2 Partner.
46
+ * `workspace_id` (int64): ID of the Workspace associated with this AS2 Outgoing Message.
45
47
  * `as2_partner_id` (int64): Id of the AS2 Partner associated with this message.
46
48
  * `as2_station_id` (int64): Id of the AS2 Station associated with this message.
47
49
  * `uuid` (string): UUID assigned to this message.
@@ -85,8 +87,8 @@ Files::As2OutgoingMessage.list
85
87
 
86
88
  * `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.
87
89
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
88
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at` and `as2_partner_id`.
89
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]` and `[ as2_partner_id, created_at ]`.
90
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `as2_partner_id`.
91
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `as2_station_id`, `workspace_id` or `as2_partner_id`. Valid field combinations are `[ as2_station_id, created_at ]`, `[ workspace_id, created_at ]`, `[ as2_partner_id, created_at ]`, `[ workspace_id, as2_station_id ]`, `[ workspace_id, as2_partner_id ]`, `[ workspace_id, as2_station_id, created_at ]` or `[ workspace_id, as2_partner_id, created_at ]`.
90
92
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
91
93
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
92
94
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
data/docs/as2_partner.md CHANGED
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "workspace_id": 1,
8
9
  "as2_station_id": 1,
9
10
  "name": "AS2 Partner Name",
10
11
  "uri": "example",
@@ -29,6 +30,7 @@
29
30
  ```
30
31
 
31
32
  * `id` (int64): ID of the AS2 Partner.
33
+ * `workspace_id` (int64): ID of the Workspace associated with this AS2 Partner.
32
34
  * `as2_station_id` (int64): ID of the AS2 Station associated with this partner.
33
35
  * `name` (string): The partner's formal AS2 name.
34
36
  * `uri` (string): Public URI where we will send the AS2 messages (via HTTP/HTTPS).
@@ -62,8 +64,8 @@ Files::As2Partner.list
62
64
 
63
65
  * `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.
64
66
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
65
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `as2_station_id` and `name`.
66
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `as2_station_id`.
67
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `as2_station_id` or `name`.
68
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `as2_station_id` and `workspace_id`. Valid field combinations are `[ workspace_id, as2_station_id ]`.
67
69
 
68
70
 
69
71
  ---
data/docs/as2_station.md CHANGED
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "workspace_id": 1,
8
9
  "name": "AS2 Station Name",
9
10
  "uri": "example",
10
11
  "domain": "domain.test",
@@ -22,6 +23,7 @@
22
23
  ```
23
24
 
24
25
  * `id` (int64): Id of the AS2 Station.
26
+ * `workspace_id` (int64): ID of the Workspace associated with this AS2 Station.
25
27
  * `name` (string): The station's formal AS2 name.
26
28
  * `uri` (string): Public URI for sending AS2 message to.
27
29
  * `domain` (string): The station's AS2 domain name.
@@ -51,7 +53,8 @@ Files::As2Station.list
51
53
 
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
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
56
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
57
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
55
58
 
56
59
 
57
60
  ---
@@ -73,7 +76,8 @@ Files::As2Station.find(id)
73
76
 
74
77
  ```
75
78
  Files::As2Station.create(
76
- name: "name",
79
+ name: "AS2 Station Name",
80
+ workspace_id: 1,
77
81
  public_certificate: "public_certificate",
78
82
  private_key: "private_key"
79
83
  )
@@ -81,7 +85,8 @@ Files::As2Station.create(
81
85
 
82
86
  ### Parameters
83
87
 
84
- * `name` (string): Required - AS2 Name
88
+ * `name` (string): Required - The station's formal AS2 name.
89
+ * `workspace_id` (int64): ID of the Workspace associated with this AS2 Station.
85
90
  * `public_certificate` (string): Required -
86
91
  * `private_key` (string): Required -
87
92
  * `private_key_password` (string):
@@ -101,7 +106,7 @@ Files::As2Station.update(id,
101
106
  ### Parameters
102
107
 
103
108
  * `id` (int64): Required - As2 Station ID.
104
- * `name` (string): AS2 Name
109
+ * `name` (string): The station's formal AS2 name.
105
110
  * `public_certificate` (string):
106
111
  * `private_key` (string):
107
112
  * `private_key_password` (string):
@@ -136,7 +141,7 @@ as2_station.update(
136
141
  ### Parameters
137
142
 
138
143
  * `id` (int64): Required - As2 Station ID.
139
- * `name` (string): AS2 Name
144
+ * `name` (string): The station's formal AS2 name.
140
145
  * `public_certificate` (string):
141
146
  * `private_key` (string):
142
147
  * `private_key_password` (string):
data/docs/automation.md CHANGED
@@ -210,8 +210,8 @@ Files::Automation.create(
210
210
  trigger_actions: ["create"],
211
211
  value: {"limit":"1"},
212
212
  recurring_day: 25,
213
- workspace_id: 0,
214
- automation: "create_folder"
213
+ automation: "create_folder",
214
+ workspace_id: 0
215
215
  )
216
216
  ```
217
217
 
@@ -249,8 +249,8 @@ Files::Automation.create(
249
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
250
250
  * `value` (object): A Hash of attributes specific to the automation type.
251
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
253
252
  * `automation` (string): Required - Automation type
253
+ * `workspace_id` (int64): Workspace ID
254
254
 
255
255
 
256
256
  ---
@@ -304,7 +304,6 @@ Files::Automation.update(id,
304
304
  trigger_actions: ["create"],
305
305
  value: {"limit":"1"},
306
306
  recurring_day: 25,
307
- workspace_id: 0,
308
307
  automation: "create_folder"
309
308
  )
310
309
  ```
@@ -344,7 +343,6 @@ Files::Automation.update(id,
344
343
  * `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
345
344
  * `value` (object): A Hash of attributes specific to the automation type.
346
345
  * `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
348
346
  * `automation` (string): Automation type
349
347
 
350
348
 
@@ -416,7 +414,6 @@ automation.update(
416
414
  trigger_actions: ["create"],
417
415
  value: {"limit":"1"},
418
416
  recurring_day: 25,
419
- workspace_id: 0,
420
417
  automation: "create_folder"
421
418
  )
422
419
  ```
@@ -456,7 +453,6 @@ automation.update(
456
453
  * `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
457
454
  * `value` (object): A Hash of attributes specific to the automation type.
458
455
  * `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
460
456
  * `automation` (string): Automation type
461
457
 
462
458
 
@@ -54,7 +54,7 @@ Files::AutomationRun.list(
54
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.
55
55
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
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`.
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 `[ automation_id, status ]`, `[ workspace_id, automation_id ]` or `[ workspace_id, automation_id, 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 ]`.
58
58
  * `automation_id` (int64): Required - ID of the associated Automation.
59
59
 
60
60
 
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, created_at ]` and `[ user_id, 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, 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
@@ -84,8 +84,8 @@ Files::GpgKey.find(id)
84
84
  Files::GpgKey.create(
85
85
  user_id: 1,
86
86
  partner_id: 1,
87
- workspace_id: 0,
88
87
  name: "key name",
88
+ workspace_id: 0,
89
89
  generate_expires_at: "2025-06-19 12:00:00",
90
90
  generate_keypair: false,
91
91
  generate_full_name: "John Doe",
@@ -97,11 +97,11 @@ Files::GpgKey.create(
97
97
 
98
98
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
99
99
  * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
100
- * `workspace_id` (int64): Workspace ID (0 for default workspace).
101
100
  * `public_key` (string): The GPG public key
102
101
  * `private_key` (string): The GPG private key
103
102
  * `private_key_password` (string): The GPG private key password
104
103
  * `name` (string): Required - GPG key name.
104
+ * `workspace_id` (int64): Workspace ID (0 for default workspace).
105
105
  * `generate_expires_at` (string): Expiration date of the key. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
106
106
  * `generate_keypair` (boolean): If true, generate a new GPG key pair. Can not be used with `public_key`/`private_key`
107
107
  * `generate_full_name` (string): Full name of the key owner. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
@@ -115,7 +115,6 @@ Files::GpgKey.create(
115
115
  ```
116
116
  Files::GpgKey.update(id,
117
117
  partner_id: 1,
118
- workspace_id: 0,
119
118
  name: "key name"
120
119
  )
121
120
  ```
@@ -124,7 +123,6 @@ Files::GpgKey.update(id,
124
123
 
125
124
  * `id` (int64): Required - Gpg Key ID.
126
125
  * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
127
- * `workspace_id` (int64): Workspace ID (0 for default workspace).
128
126
  * `public_key` (string): The GPG public key
129
127
  * `private_key` (string): The GPG private key
130
128
  * `private_key_password` (string): The GPG private key password
@@ -153,7 +151,6 @@ gpg_key = Files::GpgKey.find(id)
153
151
 
154
152
  gpg_key.update(
155
153
  partner_id: 1,
156
- workspace_id: 0,
157
154
  name: "key name"
158
155
  )
159
156
  ```
@@ -162,7 +159,6 @@ gpg_key.update(
162
159
 
163
160
  * `id` (int64): Required - Gpg Key ID.
164
161
  * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
165
- * `workspace_id` (int64): Workspace ID (0 for default workspace).
166
162
  * `public_key` (string): The GPG public key
167
163
  * `private_key` (string): The GPG private key
168
164
  * `private_key_password` (string): The GPG private key password
data/docs/group.md CHANGED
@@ -78,13 +78,13 @@ Files::Group.create(
78
78
  notes: "example",
79
79
  user_ids: "1",
80
80
  admin_ids: "1",
81
- workspace_id: 0,
82
81
  ftp_permission: true,
83
82
  sftp_permission: true,
84
83
  dav_permission: true,
85
84
  restapi_permission: true,
86
85
  allowed_ips: "10.0.0.0/8\n127.0.0.1",
87
- name: "name"
86
+ name: "name",
87
+ workspace_id: 0
88
88
  )
89
89
  ```
90
90
 
@@ -93,13 +93,13 @@ Files::Group.create(
93
93
  * `notes` (string): Group notes.
94
94
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
95
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
97
96
  * `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.
98
97
  * `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.
99
98
  * `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.
100
99
  * `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.
101
100
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
102
101
  * `name` (string): Required - Group name.
102
+ * `workspace_id` (int64): Workspace ID
103
103
 
104
104
 
105
105
  ---
@@ -111,7 +111,6 @@ Files::Group.update(id,
111
111
  notes: "example",
112
112
  user_ids: "1",
113
113
  admin_ids: "1",
114
- workspace_id: 0,
115
114
  ftp_permission: true,
116
115
  sftp_permission: true,
117
116
  dav_permission: true,
@@ -127,7 +126,6 @@ Files::Group.update(id,
127
126
  * `notes` (string): Group notes.
128
127
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
129
128
  * `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
131
129
  * `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.
132
130
  * `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.
133
131
  * `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.
@@ -160,7 +158,6 @@ group.update(
160
158
  notes: "example",
161
159
  user_ids: "1",
162
160
  admin_ids: "1",
163
- workspace_id: 0,
164
161
  ftp_permission: true,
165
162
  sftp_permission: true,
166
163
  dav_permission: true,
@@ -176,7 +173,6 @@ group.update(
176
173
  * `notes` (string): Group notes.
177
174
  * `user_ids` (string): A list of user ids. If sent as a string, should be comma-delimited.
178
175
  * `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
180
176
  * `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.
181
177
  * `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.
182
178
  * `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/partner.md CHANGED
@@ -9,6 +9,7 @@
9
9
  "allow_providing_gpg_keys": true,
10
10
  "allow_user_creation": true,
11
11
  "id": 1,
12
+ "workspace_id": 1,
12
13
  "name": "Acme Corp",
13
14
  "notes": "This is a note about the partner.",
14
15
  "partner_admin_ids": [
@@ -31,6 +32,7 @@
31
32
  * `allow_providing_gpg_keys` (boolean): Allow Partner Admins to provide GPG keys.
32
33
  * `allow_user_creation` (boolean): Allow Partner Admins to create users.
33
34
  * `id` (int64): The unique ID of the Partner.
35
+ * `workspace_id` (int64): ID of the Workspace associated with this Partner.
34
36
  * `name` (string): The name of the Partner.
35
37
  * `notes` (string): Notes about this Partner.
36
38
  * `partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
@@ -51,7 +53,8 @@ Files::Partner.list
51
53
 
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
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
56
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
57
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
55
58
 
56
59
 
57
60
  ---
@@ -80,7 +83,8 @@ Files::Partner.create(
80
83
  notes: "This is a note about the partner.",
81
84
  root_folder: "/AcmeCorp",
82
85
  tags: "example",
83
- name: "Acme Corp"
86
+ name: "Acme Corp",
87
+ workspace_id: 1
84
88
  )
85
89
  ```
86
90
 
@@ -94,6 +98,7 @@ Files::Partner.create(
94
98
  * `root_folder` (string): The root folder path for this Partner.
95
99
  * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
96
100
  * `name` (string): Required - The name of the Partner.
101
+ * `workspace_id` (int64): ID of the Workspace associated with this Partner.
97
102
 
98
103
 
99
104
  ---
data/docs/public_key.md CHANGED
@@ -5,6 +5,7 @@
5
5
  ```
6
6
  {
7
7
  "id": 1,
8
+ "workspace_id": 1,
8
9
  "title": "My public key",
9
10
  "created_at": "2000-01-01T01:00:00Z",
10
11
  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8",
@@ -19,6 +20,7 @@
19
20
  ```
20
21
 
21
22
  * `id` (int64): Public key ID
23
+ * `workspace_id` (int64): Workspace ID (0 for default workspace).
22
24
  * `title` (string): Public key title
23
25
  * `created_at` (date-time): Public key created at date/time
24
26
  * `fingerprint` (string): Public key fingerprint (MD5)
@@ -51,8 +53,8 @@ Files::PublicKey.list(
51
53
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
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
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `title`, `created_at` or `user_id`.
55
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
56
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `user_id`, `title` or `created_at`.
57
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `workspace_id`.
56
58
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
57
59
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
58
60
  * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
@@ -23,6 +23,7 @@
23
23
  "server_certificate": "require_match",
24
24
  "server_host_key": "[public key]",
25
25
  "server_type": "s3",
26
+ "workspace_id": 1,
26
27
  "ssl": "if_available",
27
28
  "username": "user",
28
29
  "google_cloud_storage_bucket": "my-bucket",
@@ -54,6 +55,7 @@
54
55
  "files_agent_version": "example",
55
56
  "files_agent_up_to_date": true,
56
57
  "files_agent_latest_version": "example",
58
+ "files_agent_supports_push_updates": true,
57
59
  "outbound_agent_id": 1,
58
60
  "filebase_bucket": "my-bucket",
59
61
  "filebase_access_key": "example",
@@ -87,6 +89,7 @@
87
89
  * `server_certificate` (string): Remote server certificate
88
90
  * `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
89
91
  * `server_type` (string): Remote server type.
92
+ * `workspace_id` (int64): Workspace ID (0 for default workspace)
90
93
  * `ssl` (string): Should we require SSL?
91
94
  * `username` (string): Remote server username.
92
95
  * `google_cloud_storage_bucket` (string): Google Cloud Storage: Bucket Name
@@ -118,6 +121,7 @@
118
121
  * `files_agent_version` (string): Files Agent version
119
122
  * `files_agent_up_to_date` (boolean): If true, the Files Agent is up to date.
120
123
  * `files_agent_latest_version` (string): Latest available Files Agent version
124
+ * `files_agent_supports_push_updates` (boolean): Files Agent supports receiving push updates
121
125
  * `outbound_agent_id` (int64): Route traffic to outbound on a files-agent
122
126
  * `filebase_bucket` (string): Filebase: Bucket name
123
127
  * `filebase_access_key` (string): Filebase: Access Key.
@@ -162,7 +166,7 @@ Files::RemoteServer.list
162
166
 
163
167
  * `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
168
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
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`.
169
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `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
170
  * `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
171
  * `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
172
 
@@ -249,7 +253,8 @@ Files::RemoteServer.create(
249
253
  username: "user",
250
254
  wasabi_access_key: "example",
251
255
  wasabi_bucket: "my-bucket",
252
- wasabi_region: "us-west-1"
256
+ wasabi_region: "us-west-1",
257
+ workspace_id: 0
253
258
  )
254
259
  ```
255
260
 
@@ -324,6 +329,7 @@ Files::RemoteServer.create(
324
329
  * `wasabi_access_key` (string): Wasabi: Access Key.
325
330
  * `wasabi_bucket` (string): Wasabi: Bucket name
326
331
  * `wasabi_region` (string): Wasabi: Region
332
+ * `workspace_id` (int64): Workspace ID (0 for default workspace)
327
333
 
328
334
 
329
335
  ---
@@ -92,7 +92,6 @@ Files::RemoteServerCredential.find(id)
92
92
 
93
93
  ```
94
94
  Files::RemoteServerCredential.create(
95
- workspace_id: 0,
96
95
  name: "My Credential",
97
96
  description: "More information or notes about this credential.",
98
97
  server_type: "s3",
@@ -105,13 +104,13 @@ Files::RemoteServerCredential.create(
105
104
  linode_access_key: "example",
106
105
  s3_compatible_access_key: "example",
107
106
  username: "user",
108
- wasabi_access_key: "example"
107
+ wasabi_access_key: "example",
108
+ workspace_id: 0
109
109
  )
110
110
  ```
111
111
 
112
112
  ### Parameters
113
113
 
114
- * `workspace_id` (int64): Workspace ID (0 for default workspace)
115
114
  * `name` (string): Internal name for your reference
116
115
  * `description` (string): Internal description for your reference
117
116
  * `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
@@ -142,6 +141,7 @@ Files::RemoteServerCredential.create(
142
141
  * `linode_secret_key` (string): Linode: Secret Key
143
142
  * `s3_compatible_secret_key` (string): S3-compatible: Secret Key
144
143
  * `wasabi_secret_key` (string): Wasabi: Secret Key
144
+ * `workspace_id` (int64): Workspace ID (0 for default workspace)
145
145
 
146
146
 
147
147
  ---
@@ -150,7 +150,6 @@ Files::RemoteServerCredential.create(
150
150
 
151
151
  ```
152
152
  Files::RemoteServerCredential.update(id,
153
- workspace_id: 0,
154
153
  name: "My Credential",
155
154
  description: "More information or notes about this credential.",
156
155
  server_type: "s3",
@@ -170,7 +169,6 @@ Files::RemoteServerCredential.update(id,
170
169
  ### Parameters
171
170
 
172
171
  * `id` (int64): Required - Remote Server Credential ID.
173
- * `workspace_id` (int64): Workspace ID (0 for default workspace)
174
172
  * `name` (string): Internal name for your reference
175
173
  * `description` (string): Internal description for your reference
176
174
  * `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
@@ -224,7 +222,6 @@ Files::RemoteServerCredential.delete(id)
224
222
  remote_server_credential = Files::RemoteServerCredential.find(id)
225
223
 
226
224
  remote_server_credential.update(
227
- workspace_id: 0,
228
225
  name: "My Credential",
229
226
  description: "More information or notes about this credential.",
230
227
  server_type: "s3",
@@ -244,7 +241,6 @@ remote_server_credential.update(
244
241
  ### Parameters
245
242
 
246
243
  * `id` (int64): Required - Remote Server Credential ID.
247
- * `workspace_id` (int64): Workspace ID (0 for default workspace)
248
244
  * `name` (string): Internal name for your reference
249
245
  * `description` (string): Internal description for your reference
250
246
  * `server_type` (string): Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
data/docs/site.md CHANGED
@@ -277,6 +277,7 @@
277
277
  "sftp_permission": true,
278
278
  "site_admin": true,
279
279
  "site_id": 1,
280
+ "workspace_id": 1,
280
281
  "skip_welcome_screen": true,
281
282
  "ssl_required": "always_require",
282
283
  "sso_strategy_id": 1,
data/docs/sync.md CHANGED
@@ -230,8 +230,7 @@ Files::Sync.update(id,
230
230
  recurring_day: 25,
231
231
  schedule_time_zone: "Eastern Time (US & Canada)",
232
232
  schedule_days_of_week: [0,2,4],
233
- schedule_times_of_day: ["06:30","14:30"],
234
- workspace_id: 1
233
+ schedule_times_of_day: ["06:30","14:30"]
235
234
  )
236
235
  ```
237
236
 
@@ -256,7 +255,6 @@ Files::Sync.update(id,
256
255
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
257
256
  * `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.
258
257
  * `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
260
258
 
261
259
 
262
260
  ---
@@ -327,8 +325,7 @@ sync.update(
327
325
  recurring_day: 25,
328
326
  schedule_time_zone: "Eastern Time (US & Canada)",
329
327
  schedule_days_of_week: [0,2,4],
330
- schedule_times_of_day: ["06:30","14:30"],
331
- workspace_id: 1
328
+ schedule_times_of_day: ["06:30","14:30"]
332
329
  )
333
330
  ```
334
331
 
@@ -353,7 +350,6 @@ sync.update(
353
350
  * `schedule_time_zone` (string): If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
354
351
  * `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.
355
352
  * `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
357
353
 
358
354
 
359
355
  ---
data/docs/user.md CHANGED
@@ -64,6 +64,7 @@
64
64
  "sftp_permission": true,
65
65
  "site_admin": true,
66
66
  "site_id": 1,
67
+ "workspace_id": 1,
67
68
  "skip_welcome_screen": true,
68
69
  "ssl_required": "always_require",
69
70
  "sso_strategy_id": 1,
@@ -138,6 +139,7 @@
138
139
  * `sftp_permission` (boolean): Can the user access with SFTP?
139
140
  * `site_admin` (boolean): Is the user an administrator for this site?
140
141
  * `site_id` (int64): Site ID
142
+ * `workspace_id` (int64): Workspace ID
141
143
  * `skip_welcome_screen` (boolean): Skip Welcome page in the UI?
142
144
  * `ssl_required` (string): SSL required setting
143
145
  * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
@@ -179,8 +181,8 @@ Files::User.list(
179
181
 
180
182
  * `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.
181
183
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
182
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
183
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
184
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `workspace_id`, `company`, `name`, `disabled`, `authenticate_until`, `username`, `email`, `last_desktop_login_at`, `last_login_at`, `site_admin`, `password_validity_days` or `ssl_required`.
185
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled`, `partner_id` or `workspace_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]`, `[ workspace_id, username ]`, `[ company, name ]`, `[ workspace_id, name ]`, `[ workspace_id, email ]`, `[ workspace_id, company ]`, `[ workspace_id, disabled ]`, `[ workspace_id, disabled, username ]` or `[ workspace_id, company, name ]`.
184
186
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
185
187
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
186
188
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
@@ -253,7 +255,8 @@ Files::User.create(
253
255
  time_zone: "Pacific Time (US & Canada)",
254
256
  user_root: "example",
255
257
  user_home: "example",
256
- username: "user"
258
+ username: "user",
259
+ workspace_id: 1
257
260
  )
258
261
  ```
259
262
 
@@ -310,6 +313,7 @@ Files::User.create(
310
313
  * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
311
314
  * `user_home` (string): Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
312
315
  * `username` (string): Required - User's username
316
+ * `workspace_id` (int64): Workspace ID
313
317
 
314
318
 
315
319
  ---