files.com 1.1.433 → 1.1.434
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/as2_incoming_message.md +4 -2
- data/docs/as2_outgoing_message.md +4 -2
- data/docs/as2_partner.md +4 -2
- data/docs/as2_station.md +10 -5
- data/docs/automation.md +3 -7
- data/docs/gpg_key.md +2 -6
- data/docs/group.md +3 -7
- data/docs/partner.md +7 -2
- data/docs/public_key.md +4 -2
- data/docs/remote_server.md +8 -2
- data/docs/remote_server_credential.md +3 -7
- data/docs/site.md +1 -0
- data/docs/sync.md +2 -6
- data/docs/user.md +7 -3
- data/lib/files.com/models/as2_incoming_message.rb +7 -2
- data/lib/files.com/models/as2_outgoing_message.rb +7 -2
- data/lib/files.com/models/as2_partner.rb +11 -2
- data/lib/files.com/models/as2_station.rb +17 -4
- data/lib/files.com/models/automation.rb +2 -6
- data/lib/files.com/models/gpg_key.rb +2 -6
- data/lib/files.com/models/group.rb +2 -6
- data/lib/files.com/models/partner.rb +14 -1
- data/lib/files.com/models/public_key.rb +11 -2
- data/lib/files.com/models/remote_server.rb +21 -1
- data/lib/files.com/models/remote_server_credential.rb +2 -6
- data/lib/files.com/models/sync.rb +0 -4
- data/lib/files.com/models/user.rb +13 -2
- data/lib/files.com/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bbbc69437c5796b087678ef5a61af4139b2bb6879e5d7661c13586081a6c915a
|
|
4
|
+
data.tar.gz: 621495abc57f5c2469862d4d7e1cf5627f8d0f39a5fb4265860949539b148259
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2ec65b098b57ea5a6bfd8897c4e0f9be73cdfcffb51098a22d62500da1daef5b3738b805af9504b9e5474a1766e18bd3bda75e6ff82b044c4abcb0472354922c
|
|
7
|
+
data.tar.gz: 8a3f1f597dd830cdfdc00a51fdfafe47630c230bbe57545e71f0bb4ca0e5b268963f6f3f69e931cafef4bcb12d6ffad4398a3dcb18ca9dfff4f589f60500142f
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.434
|
|
@@ -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`
|
|
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 ]`
|
|
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`
|
|
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 ]`
|
|
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`
|
|
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: "
|
|
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
|
|
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
|
|
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
|
|
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
|
-
|
|
214
|
-
|
|
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
|
|
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 `
|
|
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`.
|
data/docs/remote_server.md
CHANGED
|
@@ -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
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`, `
|
|
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 `
|
|
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
|
---
|
|
@@ -14,6 +14,11 @@ module Files
|
|
|
14
14
|
@attributes[:id]
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
# int64 - ID of the Workspace associated with this AS2 Incoming Message.
|
|
18
|
+
def workspace_id
|
|
19
|
+
@attributes[:workspace_id]
|
|
20
|
+
end
|
|
21
|
+
|
|
17
22
|
# int64 - Id of the AS2 Partner associated with this message.
|
|
18
23
|
def as2_partner_id
|
|
19
24
|
@attributes[:as2_partner_id]
|
|
@@ -182,8 +187,8 @@ module Files
|
|
|
182
187
|
# Parameters:
|
|
183
188
|
# 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.
|
|
184
189
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
185
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`
|
|
186
|
-
# 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 ]`
|
|
190
|
+
# 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`.
|
|
191
|
+
# 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 ]`.
|
|
187
192
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
188
193
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
189
194
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
@@ -14,6 +14,11 @@ module Files
|
|
|
14
14
|
@attributes[:id]
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
+
# int64 - ID of the Workspace associated with this AS2 Outgoing Message.
|
|
18
|
+
def workspace_id
|
|
19
|
+
@attributes[:workspace_id]
|
|
20
|
+
end
|
|
21
|
+
|
|
17
22
|
# int64 - Id of the AS2 Partner associated with this message.
|
|
18
23
|
def as2_partner_id
|
|
19
24
|
@attributes[:as2_partner_id]
|
|
@@ -162,8 +167,8 @@ module Files
|
|
|
162
167
|
# Parameters:
|
|
163
168
|
# 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
169
|
# 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 `created_at`
|
|
166
|
-
# 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 ]`
|
|
170
|
+
# 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`.
|
|
171
|
+
# 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 ]`.
|
|
167
172
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
168
173
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
169
174
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - ID of the Workspace associated with this AS2 Partner.
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# int64 - ID of the AS2 Station associated with this partner.
|
|
22
31
|
def as2_station_id
|
|
23
32
|
@attributes[:as2_station_id]
|
|
@@ -249,8 +258,8 @@ module Files
|
|
|
249
258
|
# Parameters:
|
|
250
259
|
# 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.
|
|
251
260
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
252
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `as2_station_id`
|
|
253
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `as2_station_id`.
|
|
261
|
+
# 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`.
|
|
262
|
+
# 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 ]`.
|
|
254
263
|
def self.list(params = {}, options = {})
|
|
255
264
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
256
265
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - ID of the Workspace associated with this AS2 Station.
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# string - The station's formal AS2 name.
|
|
22
31
|
def name
|
|
23
32
|
@attributes[:name]
|
|
@@ -154,7 +163,7 @@ module Files
|
|
|
154
163
|
end
|
|
155
164
|
|
|
156
165
|
# Parameters:
|
|
157
|
-
# name - string - AS2
|
|
166
|
+
# name - string - The station's formal AS2 name.
|
|
158
167
|
# public_certificate - string
|
|
159
168
|
# private_key - string
|
|
160
169
|
# private_key_password - string
|
|
@@ -201,11 +210,13 @@ module Files
|
|
|
201
210
|
# Parameters:
|
|
202
211
|
# 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.
|
|
203
212
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
204
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
|
|
213
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
214
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
205
215
|
def self.list(params = {}, options = {})
|
|
206
216
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
207
217
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
208
218
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
219
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
209
220
|
|
|
210
221
|
List.new(As2Station, params) do
|
|
211
222
|
Api.send_request("/as2_stations", :get, params, options)
|
|
@@ -233,12 +244,14 @@ module Files
|
|
|
233
244
|
end
|
|
234
245
|
|
|
235
246
|
# Parameters:
|
|
236
|
-
# name (required) - string - AS2
|
|
247
|
+
# name (required) - string - The station's formal AS2 name.
|
|
248
|
+
# workspace_id - int64 - ID of the Workspace associated with this AS2 Station.
|
|
237
249
|
# public_certificate (required) - string
|
|
238
250
|
# private_key (required) - string
|
|
239
251
|
# private_key_password - string
|
|
240
252
|
def self.create(params = {}, options = {})
|
|
241
253
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
254
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
242
255
|
raise InvalidParameterError.new("Bad parameter: public_certificate must be an String") if params[:public_certificate] and !params[:public_certificate].is_a?(String)
|
|
243
256
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
244
257
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -251,7 +264,7 @@ module Files
|
|
|
251
264
|
end
|
|
252
265
|
|
|
253
266
|
# Parameters:
|
|
254
|
-
# name - string - AS2
|
|
267
|
+
# name - string - The station's formal AS2 name.
|
|
255
268
|
# public_certificate - string
|
|
256
269
|
# private_key - string
|
|
257
270
|
# private_key_password - string
|
|
@@ -422,7 +422,6 @@ module Files
|
|
|
422
422
|
# 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
|
|
423
423
|
# value - object - A Hash of attributes specific to the automation type.
|
|
424
424
|
# 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`.
|
|
425
|
-
# workspace_id - int64 - Workspace ID
|
|
426
425
|
# automation - string - Automation type
|
|
427
426
|
def update(params = {})
|
|
428
427
|
params ||= {}
|
|
@@ -453,7 +452,6 @@ module Files
|
|
|
453
452
|
raise InvalidParameterError.new("Bad parameter: trigger must be an String") if params[:trigger] and !params[:trigger].is_a?(String)
|
|
454
453
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
455
454
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
456
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
457
455
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
458
456
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
459
457
|
|
|
@@ -563,8 +561,8 @@ module Files
|
|
|
563
561
|
# 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
|
|
564
562
|
# value - object - A Hash of attributes specific to the automation type.
|
|
565
563
|
# 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`.
|
|
566
|
-
# workspace_id - int64 - Workspace ID
|
|
567
564
|
# automation (required) - string - Automation type
|
|
565
|
+
# workspace_id - int64 - Workspace ID
|
|
568
566
|
def self.create(params = {}, options = {})
|
|
569
567
|
raise InvalidParameterError.new("Bad parameter: source must be an String") if params[:source] and !params[:source].is_a?(String)
|
|
570
568
|
raise InvalidParameterError.new("Bad parameter: destinations must be an Array") if params[:destinations] and !params[:destinations].is_a?(Array)
|
|
@@ -591,8 +589,8 @@ module Files
|
|
|
591
589
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
592
590
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
593
591
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
594
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
595
592
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
593
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
596
594
|
raise MissingParameterError.new("Parameter missing: automation") unless params[:automation]
|
|
597
595
|
|
|
598
596
|
response, options = Api.send_request("/automations", :post, params, options)
|
|
@@ -643,7 +641,6 @@ module Files
|
|
|
643
641
|
# 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
|
|
644
642
|
# value - object - A Hash of attributes specific to the automation type.
|
|
645
643
|
# 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`.
|
|
646
|
-
# workspace_id - int64 - Workspace ID
|
|
647
644
|
# automation - string - Automation type
|
|
648
645
|
def self.update(id, params = {}, options = {})
|
|
649
646
|
params ||= {}
|
|
@@ -674,7 +671,6 @@ module Files
|
|
|
674
671
|
raise InvalidParameterError.new("Bad parameter: trigger_actions must be an Array") if params[:trigger_actions] and !params[:trigger_actions].is_a?(Array)
|
|
675
672
|
raise InvalidParameterError.new("Bad parameter: value must be an Hash") if params[:value] and !params[:value].is_a?(Hash)
|
|
676
673
|
raise InvalidParameterError.new("Bad parameter: recurring_day must be an Integer") if params[:recurring_day] and !params[:recurring_day].is_a?(Integer)
|
|
677
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
678
674
|
raise InvalidParameterError.new("Bad parameter: automation must be an String") if params[:automation] and !params[:automation].is_a?(String)
|
|
679
675
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
680
676
|
|
|
@@ -182,7 +182,6 @@ module Files
|
|
|
182
182
|
|
|
183
183
|
# Parameters:
|
|
184
184
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
185
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
186
185
|
# public_key - string - The GPG public key
|
|
187
186
|
# private_key - string - The GPG private key
|
|
188
187
|
# private_key_password - string - The GPG private key password
|
|
@@ -193,7 +192,6 @@ module Files
|
|
|
193
192
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
194
193
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
195
194
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
196
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
197
195
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
198
196
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
199
197
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -278,11 +276,11 @@ module Files
|
|
|
278
276
|
# Parameters:
|
|
279
277
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
280
278
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
281
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
282
279
|
# public_key - string - The GPG public key
|
|
283
280
|
# private_key - string - The GPG private key
|
|
284
281
|
# private_key_password - string - The GPG private key password
|
|
285
282
|
# name (required) - string - GPG key name.
|
|
283
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
286
284
|
# generate_expires_at - string - Expiration date of the key. Used for the generation of the key. Will be ignored if `generate_keypair` is false.
|
|
287
285
|
# generate_keypair - boolean - If true, generate a new GPG key pair. Can not be used with `public_key`/`private_key`
|
|
288
286
|
# 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.
|
|
@@ -290,11 +288,11 @@ module Files
|
|
|
290
288
|
def self.create(params = {}, options = {})
|
|
291
289
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
292
290
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
293
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
294
291
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
295
292
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
296
293
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
297
294
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
295
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
298
296
|
raise InvalidParameterError.new("Bad parameter: generate_expires_at must be an String") if params[:generate_expires_at] and !params[:generate_expires_at].is_a?(String)
|
|
299
297
|
raise InvalidParameterError.new("Bad parameter: generate_full_name must be an String") if params[:generate_full_name] and !params[:generate_full_name].is_a?(String)
|
|
300
298
|
raise InvalidParameterError.new("Bad parameter: generate_email must be an String") if params[:generate_email] and !params[:generate_email].is_a?(String)
|
|
@@ -306,7 +304,6 @@ module Files
|
|
|
306
304
|
|
|
307
305
|
# Parameters:
|
|
308
306
|
# partner_id - int64 - Partner ID who owns this GPG Key, if applicable.
|
|
309
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace).
|
|
310
307
|
# public_key - string - The GPG public key
|
|
311
308
|
# private_key - string - The GPG private key
|
|
312
309
|
# private_key_password - string - The GPG private key password
|
|
@@ -316,7 +313,6 @@ module Files
|
|
|
316
313
|
params[:id] = id
|
|
317
314
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
318
315
|
raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
|
|
319
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
320
316
|
raise InvalidParameterError.new("Bad parameter: public_key must be an String") if params[:public_key] and !params[:public_key].is_a?(String)
|
|
321
317
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
322
318
|
raise InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
|
|
@@ -130,7 +130,6 @@ module Files
|
|
|
130
130
|
# notes - string - Group notes.
|
|
131
131
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
132
132
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
133
|
-
# workspace_id - int64 - Workspace ID
|
|
134
133
|
# 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.
|
|
135
134
|
# 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.
|
|
136
135
|
# 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.
|
|
@@ -145,7 +144,6 @@ module Files
|
|
|
145
144
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
146
145
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
147
146
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
148
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
149
147
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
150
148
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
151
149
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -224,20 +222,20 @@ module Files
|
|
|
224
222
|
# notes - string - Group notes.
|
|
225
223
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
226
224
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
227
|
-
# workspace_id - int64 - Workspace ID
|
|
228
225
|
# 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.
|
|
229
226
|
# 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.
|
|
230
227
|
# 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.
|
|
231
228
|
# 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.
|
|
232
229
|
# allowed_ips - string - A list of allowed IPs if applicable. Newline delimited
|
|
233
230
|
# name (required) - string - Group name.
|
|
231
|
+
# workspace_id - int64 - Workspace ID
|
|
234
232
|
def self.create(params = {}, options = {})
|
|
235
233
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
236
234
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
237
235
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
238
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
239
236
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
240
237
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
238
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
241
239
|
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
|
242
240
|
|
|
243
241
|
response, options = Api.send_request("/groups", :post, params, options)
|
|
@@ -248,7 +246,6 @@ module Files
|
|
|
248
246
|
# notes - string - Group notes.
|
|
249
247
|
# user_ids - string - A list of user ids. If sent as a string, should be comma-delimited.
|
|
250
248
|
# admin_ids - string - A list of group admin user ids. If sent as a string, should be comma-delimited.
|
|
251
|
-
# workspace_id - int64 - Workspace ID
|
|
252
249
|
# 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.
|
|
253
250
|
# 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.
|
|
254
251
|
# 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.
|
|
@@ -262,7 +259,6 @@ module Files
|
|
|
262
259
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
263
260
|
raise InvalidParameterError.new("Bad parameter: user_ids must be an String") if params[:user_ids] and !params[:user_ids].is_a?(String)
|
|
264
261
|
raise InvalidParameterError.new("Bad parameter: admin_ids must be an String") if params[:admin_ids] and !params[:admin_ids].is_a?(String)
|
|
265
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
266
262
|
raise InvalidParameterError.new("Bad parameter: allowed_ips must be an String") if params[:allowed_ips] and !params[:allowed_ips].is_a?(String)
|
|
267
263
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
268
264
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
@@ -54,6 +54,15 @@ module Files
|
|
|
54
54
|
@attributes[:id] = value
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
+
# int64 - ID of the Workspace associated with this Partner.
|
|
58
|
+
def workspace_id
|
|
59
|
+
@attributes[:workspace_id]
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
def workspace_id=(value)
|
|
63
|
+
@attributes[:workspace_id] = value
|
|
64
|
+
end
|
|
65
|
+
|
|
57
66
|
# string - The name of the Partner.
|
|
58
67
|
def name
|
|
59
68
|
@attributes[:name]
|
|
@@ -160,11 +169,13 @@ module Files
|
|
|
160
169
|
# Parameters:
|
|
161
170
|
# 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.
|
|
162
171
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
163
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
|
|
172
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `name`.
|
|
173
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `workspace_id`.
|
|
164
174
|
def self.list(params = {}, options = {})
|
|
165
175
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
166
176
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
167
177
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
178
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
168
179
|
|
|
169
180
|
List.new(Partner, params) do
|
|
170
181
|
Api.send_request("/partners", :get, params, options)
|
|
@@ -200,11 +211,13 @@ module Files
|
|
|
200
211
|
# root_folder - string - The root folder path for this Partner.
|
|
201
212
|
# 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.
|
|
202
213
|
# name (required) - string - The name of the Partner.
|
|
214
|
+
# workspace_id - int64 - ID of the Workspace associated with this Partner.
|
|
203
215
|
def self.create(params = {}, options = {})
|
|
204
216
|
raise InvalidParameterError.new("Bad parameter: notes must be an String") if params[:notes] and !params[:notes].is_a?(String)
|
|
205
217
|
raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
|
|
206
218
|
raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
|
|
207
219
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
220
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
208
221
|
raise MissingParameterError.new("Parameter missing: name") unless params[:name]
|
|
209
222
|
|
|
210
223
|
response, options = Api.send_request("/partners", :post, params, options)
|
|
@@ -18,6 +18,15 @@ module Files
|
|
|
18
18
|
@attributes[:id] = value
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
+
# int64 - Workspace ID (0 for default workspace).
|
|
22
|
+
def workspace_id
|
|
23
|
+
@attributes[:workspace_id]
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def workspace_id=(value)
|
|
27
|
+
@attributes[:workspace_id] = value
|
|
28
|
+
end
|
|
29
|
+
|
|
21
30
|
# string - Public key title
|
|
22
31
|
def title
|
|
23
32
|
@attributes[:title]
|
|
@@ -193,8 +202,8 @@ module Files
|
|
|
193
202
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
194
203
|
# 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.
|
|
195
204
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
196
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `
|
|
197
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
|
205
|
+
# 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`.
|
|
206
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at` and `workspace_id`.
|
|
198
207
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
199
208
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
200
209
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
@@ -180,6 +180,15 @@ module Files
|
|
|
180
180
|
@attributes[:server_type] = value
|
|
181
181
|
end
|
|
182
182
|
|
|
183
|
+
# int64 - Workspace ID (0 for default workspace)
|
|
184
|
+
def workspace_id
|
|
185
|
+
@attributes[:workspace_id]
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
def workspace_id=(value)
|
|
189
|
+
@attributes[:workspace_id] = value
|
|
190
|
+
end
|
|
191
|
+
|
|
183
192
|
# string - Should we require SSL?
|
|
184
193
|
def ssl
|
|
185
194
|
@attributes[:ssl]
|
|
@@ -459,6 +468,15 @@ module Files
|
|
|
459
468
|
@attributes[:files_agent_latest_version] = value
|
|
460
469
|
end
|
|
461
470
|
|
|
471
|
+
# boolean - Files Agent supports receiving push updates
|
|
472
|
+
def files_agent_supports_push_updates
|
|
473
|
+
@attributes[:files_agent_supports_push_updates]
|
|
474
|
+
end
|
|
475
|
+
|
|
476
|
+
def files_agent_supports_push_updates=(value)
|
|
477
|
+
@attributes[:files_agent_supports_push_updates] = value
|
|
478
|
+
end
|
|
479
|
+
|
|
462
480
|
# int64 - Route traffic to outbound on a files-agent
|
|
463
481
|
def outbound_agent_id
|
|
464
482
|
@attributes[:outbound_agent_id]
|
|
@@ -948,7 +966,7 @@ module Files
|
|
|
948
966
|
# Parameters:
|
|
949
967
|
# 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.
|
|
950
968
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
951
|
-
# 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`.
|
|
969
|
+
# 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`.
|
|
952
970
|
# 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 ]`.
|
|
953
971
|
# 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 ]`.
|
|
954
972
|
def self.list(params = {}, options = {})
|
|
@@ -1065,6 +1083,7 @@ module Files
|
|
|
1065
1083
|
# wasabi_access_key - string - Wasabi: Access Key.
|
|
1066
1084
|
# wasabi_bucket - string - Wasabi: Bucket name
|
|
1067
1085
|
# wasabi_region - string - Wasabi: Region
|
|
1086
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
1068
1087
|
def self.create(params = {}, options = {})
|
|
1069
1088
|
raise InvalidParameterError.new("Bad parameter: password must be an String") if params[:password] and !params[:password].is_a?(String)
|
|
1070
1089
|
raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
|
|
@@ -1130,6 +1149,7 @@ module Files
|
|
|
1130
1149
|
raise InvalidParameterError.new("Bad parameter: wasabi_access_key must be an String") if params[:wasabi_access_key] and !params[:wasabi_access_key].is_a?(String)
|
|
1131
1150
|
raise InvalidParameterError.new("Bad parameter: wasabi_bucket must be an String") if params[:wasabi_bucket] and !params[:wasabi_bucket].is_a?(String)
|
|
1132
1151
|
raise InvalidParameterError.new("Bad parameter: wasabi_region must be an String") if params[:wasabi_region] and !params[:wasabi_region].is_a?(String)
|
|
1152
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
1133
1153
|
|
|
1134
1154
|
response, options = Api.send_request("/remote_servers", :post, params, options)
|
|
1135
1155
|
RemoteServer.new(response.data, options)
|
|
@@ -298,7 +298,6 @@ module Files
|
|
|
298
298
|
end
|
|
299
299
|
|
|
300
300
|
# Parameters:
|
|
301
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
302
301
|
# name - string - Internal name for your reference
|
|
303
302
|
# description - string - Internal description for your reference
|
|
304
303
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -334,7 +333,6 @@ module Files
|
|
|
334
333
|
params[:id] = @attributes[:id]
|
|
335
334
|
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
|
336
335
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
337
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
338
336
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
339
337
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
340
338
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -435,7 +433,6 @@ module Files
|
|
|
435
433
|
end
|
|
436
434
|
|
|
437
435
|
# Parameters:
|
|
438
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
439
436
|
# name - string - Internal name for your reference
|
|
440
437
|
# description - string - Internal description for your reference
|
|
441
438
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -466,8 +463,8 @@ module Files
|
|
|
466
463
|
# linode_secret_key - string - Linode: Secret Key
|
|
467
464
|
# s3_compatible_secret_key - string - S3-compatible: Secret Key
|
|
468
465
|
# wasabi_secret_key - string - Wasabi: Secret Key
|
|
466
|
+
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
469
467
|
def self.create(params = {}, options = {})
|
|
470
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
471
468
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
472
469
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
473
470
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -498,13 +495,13 @@ module Files
|
|
|
498
495
|
raise InvalidParameterError.new("Bad parameter: linode_secret_key must be an String") if params[:linode_secret_key] and !params[:linode_secret_key].is_a?(String)
|
|
499
496
|
raise InvalidParameterError.new("Bad parameter: s3_compatible_secret_key must be an String") if params[:s3_compatible_secret_key] and !params[:s3_compatible_secret_key].is_a?(String)
|
|
500
497
|
raise InvalidParameterError.new("Bad parameter: wasabi_secret_key must be an String") if params[:wasabi_secret_key] and !params[:wasabi_secret_key].is_a?(String)
|
|
498
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
501
499
|
|
|
502
500
|
response, options = Api.send_request("/remote_server_credentials", :post, params, options)
|
|
503
501
|
RemoteServerCredential.new(response.data, options)
|
|
504
502
|
end
|
|
505
503
|
|
|
506
504
|
# Parameters:
|
|
507
|
-
# workspace_id - int64 - Workspace ID (0 for default workspace)
|
|
508
505
|
# name - string - Internal name for your reference
|
|
509
506
|
# description - string - Internal description for your reference
|
|
510
507
|
# server_type - string - Remote server type. Remote Server Credentials are only valid for a single type of Remote Server.
|
|
@@ -539,7 +536,6 @@ module Files
|
|
|
539
536
|
params ||= {}
|
|
540
537
|
params[:id] = id
|
|
541
538
|
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
|
542
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
543
539
|
raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
|
|
544
540
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
545
541
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if params[:server_type] and !params[:server_type].is_a?(String)
|
|
@@ -294,7 +294,6 @@ module Files
|
|
|
294
294
|
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
295
295
|
# 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.
|
|
296
296
|
# 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.
|
|
297
|
-
# workspace_id - int64 - Workspace ID this sync belongs to
|
|
298
297
|
def update(params = {})
|
|
299
298
|
params ||= {}
|
|
300
299
|
params[:id] = @attributes[:id]
|
|
@@ -315,7 +314,6 @@ module Files
|
|
|
315
314
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
316
315
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
317
316
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
318
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
319
317
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
320
318
|
|
|
321
319
|
Api.send_request("/syncs/#{@attributes[:id]}", :patch, params, @options)
|
|
@@ -466,7 +464,6 @@ module Files
|
|
|
466
464
|
# schedule_time_zone - string - If trigger is `custom_schedule`, Custom schedule Time Zone for when the sync should be run.
|
|
467
465
|
# 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.
|
|
468
466
|
# 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.
|
|
469
|
-
# workspace_id - int64 - Workspace ID this sync belongs to
|
|
470
467
|
def self.update(id, params = {}, options = {})
|
|
471
468
|
params ||= {}
|
|
472
469
|
params[:id] = id
|
|
@@ -486,7 +483,6 @@ module Files
|
|
|
486
483
|
raise InvalidParameterError.new("Bad parameter: schedule_time_zone must be an String") if params[:schedule_time_zone] and !params[:schedule_time_zone].is_a?(String)
|
|
487
484
|
raise InvalidParameterError.new("Bad parameter: schedule_days_of_week must be an Array") if params[:schedule_days_of_week] and !params[:schedule_days_of_week].is_a?(Array)
|
|
488
485
|
raise InvalidParameterError.new("Bad parameter: schedule_times_of_day must be an Array") if params[:schedule_times_of_day] and !params[:schedule_times_of_day].is_a?(Array)
|
|
489
|
-
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
490
486
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
491
487
|
|
|
492
488
|
response, options = Api.send_request("/syncs/#{params[:id]}", :patch, params, options)
|
|
@@ -527,6 +527,15 @@ module Files
|
|
|
527
527
|
@attributes[:site_id] = value
|
|
528
528
|
end
|
|
529
529
|
|
|
530
|
+
# int64 - Workspace ID
|
|
531
|
+
def workspace_id
|
|
532
|
+
@attributes[:workspace_id]
|
|
533
|
+
end
|
|
534
|
+
|
|
535
|
+
def workspace_id=(value)
|
|
536
|
+
@attributes[:workspace_id] = value
|
|
537
|
+
end
|
|
538
|
+
|
|
530
539
|
# boolean - Skip Welcome page in the UI?
|
|
531
540
|
def skip_welcome_screen
|
|
532
541
|
@attributes[:skip_welcome_screen]
|
|
@@ -911,8 +920,8 @@ module Files
|
|
|
911
920
|
# Parameters:
|
|
912
921
|
# 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.
|
|
913
922
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
914
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `
|
|
915
|
-
# 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 `
|
|
923
|
+
# 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`.
|
|
924
|
+
# 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 ]`.
|
|
916
925
|
# 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`.
|
|
917
926
|
# 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`.
|
|
918
927
|
# 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 ]`.
|
|
@@ -1011,6 +1020,7 @@ module Files
|
|
|
1011
1020
|
# 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.
|
|
1012
1021
|
# user_home - string - Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
|
|
1013
1022
|
# username (required) - string - User's username
|
|
1023
|
+
# workspace_id - int64 - Workspace ID
|
|
1014
1024
|
def self.create(params = {}, options = {})
|
|
1015
1025
|
raise InvalidParameterError.new("Bad parameter: change_password must be an String") if params[:change_password] and !params[:change_password].is_a?(String)
|
|
1016
1026
|
raise InvalidParameterError.new("Bad parameter: change_password_confirmation must be an String") if params[:change_password_confirmation] and !params[:change_password_confirmation].is_a?(String)
|
|
@@ -1042,6 +1052,7 @@ module Files
|
|
|
1042
1052
|
raise InvalidParameterError.new("Bad parameter: user_root must be an String") if params[:user_root] and !params[:user_root].is_a?(String)
|
|
1043
1053
|
raise InvalidParameterError.new("Bad parameter: user_home must be an String") if params[:user_home] and !params[:user_home].is_a?(String)
|
|
1044
1054
|
raise InvalidParameterError.new("Bad parameter: username must be an String") if params[:username] and !params[:username].is_a?(String)
|
|
1055
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
1045
1056
|
raise MissingParameterError.new("Parameter missing: username") unless params[:username]
|
|
1046
1057
|
|
|
1047
1058
|
response, options = Api.send_request("/users", :post, params, options)
|
data/lib/files.com/version.rb
CHANGED