You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`watermark_attachment` (Image): Preview watermark image applied to all bundle items.
127
128
*`watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
128
129
*`send_one_time_password_to_recipient_at_registration` (boolean): If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set.
130
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
129
131
*`has_inbox` (boolean): Does this bundle have an associated inbox?
130
132
*`dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
131
133
*`paths` (array(string)): A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.
@@ -206,6 +208,7 @@ await Bundle.create({
206
208
'skip_company': true,
207
209
'start_access_on_date': "2000-01-01T01:00:00Z",
208
210
'snapshot_id': 1,
211
+
'workspace_id': 1,
209
212
})
210
213
```
211
214
@@ -238,6 +241,7 @@ await Bundle.create({
238
241
*`skip_company` (boolean): BundleRegistrations can be saved without providing company?
239
242
*`start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
240
243
*`snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
244
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
241
245
*`watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
242
246
243
247
---
@@ -294,6 +298,7 @@ await bundle.update({
294
298
'start_access_on_date': "2000-01-01T01:00:00Z",
295
299
'skip_email': true,
296
300
'skip_name': true,
301
+
'workspace_id': 1,
297
302
'user_id': 1,
298
303
'watermark_attachment_delete': false,
299
304
})
@@ -326,6 +331,7 @@ await bundle.update({
326
331
*`start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
327
332
*`skip_email` (boolean): BundleRegistrations can be saved without providing email?
328
333
*`skip_name` (boolean): BundleRegistrations can be saved without providing name?
334
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
329
335
*`user_id` (int64): The owning user id. Only site admins can set this.
330
336
*`watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
331
337
*`watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
Copy file name to clipboardExpand all lines: docs/models/BundleAction.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,13 +20,15 @@
20
20
"bundle_code": "example",
21
21
"bundle_id": 1,
22
22
"bundle_recipient_id": 1,
23
+
"workspace_id": 1,
23
24
"created_at": "2000-01-01T01:00:00Z"
24
25
},
25
26
"created_at": "2000-01-01T01:00:00Z",
26
27
"destination": "/to_path",
27
28
"path": "",
28
29
"source": "/from_path",
29
30
"bundle_registration_id": 1,
31
+
"workspace_id": 1,
30
32
"bundle_registration_name": "John Doe",
31
33
"bundle_registration_email": "john@example.com",
32
34
"bundle_registration_ip": "127.0.0.1"
@@ -40,6 +42,7 @@
40
42
*`path` (string): Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
41
43
*`source` (string): The source path for this bundle action, if applicable
42
44
*`bundle_registration_id` (int64): Identifier of the associated bundle registration
45
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
43
46
*`bundle_registration_name` (string): Name of the registrant who performed the action
44
47
*`bundle_registration_email` (string): Email of the registrant
45
48
*`bundle_registration_ip` (string): IP address of the registrant
@@ -60,7 +63,7 @@ await BundleAction.list({
60
63
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
61
64
*`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.
62
65
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
63
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`and`bundle_registration_id`.
66
+
*`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`bundle_registration_id`.
64
67
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, created_at ]`.
65
68
*`filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
66
69
*`filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
Copy file name to clipboardExpand all lines: docs/models/BundleDownload.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,17 +19,20 @@
19
19
"bundle_code": "example",
20
20
"bundle_id": 1,
21
21
"bundle_recipient_id": 1,
22
+
"workspace_id": 1,
22
23
"created_at": "2000-01-01T01:00:00Z"
23
24
},
24
25
"download_method": "file",
25
26
"path": "a/b/test.txt",
27
+
"workspace_id": 1,
26
28
"created_at": "2000-01-01T01:00:00Z"
27
29
}
28
30
```
29
31
30
32
*`bundle_registration` (BundleRegistration):
31
33
*`download_method` (string): Download method (file or full_zip)
32
34
*`path` (string): Download path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
35
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
33
36
*`created_at` (date-time): Download date/time
34
37
35
38
---
@@ -48,7 +51,7 @@ await BundleDownload.list({
48
51
49
52
*`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.
50
53
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
51
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
54
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `created_at`.
52
55
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
53
56
*`filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
54
57
*`filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
Copy file name to clipboardExpand all lines: docs/models/BundleNotification.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,8 @@
8
8
"id": 1,
9
9
"notify_on_registration": true,
10
10
"notify_on_upload": true,
11
-
"notify_user_id": 1
11
+
"notify_user_id": 1,
12
+
"workspace_id": 1
12
13
}
13
14
```
14
15
@@ -17,6 +18,7 @@
17
18
*`notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
18
19
*`notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
19
20
*`notify_user_id` (int64): The id of the user to notify.
21
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
20
22
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
23
22
24
---
@@ -35,7 +37,7 @@ await BundleNotification.list({
35
37
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
36
38
*`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.
37
39
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
40
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
39
41
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
Copy file name to clipboardExpand all lines: docs/models/BundleRecipient.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,8 @@
8
8
"name": "John Doe",
9
9
"note": "Some note.",
10
10
"recipient": "john.doe@example.com",
11
-
"sent_at": "2000-01-01T01:00:00Z"
11
+
"sent_at": "2000-01-01T01:00:00Z",
12
+
"workspace_id": 1
12
13
}
13
14
```
14
15
@@ -17,6 +18,7 @@
17
18
*`note` (string): A note sent to the recipient with the bundle.
18
19
*`recipient` (string): The recipient's email address.
19
20
*`sent_at` (date-time): When the Bundle was shared with this recipient.
21
+
*`workspace_id` (int64): Workspace ID. `0` means the default workspace.
20
22
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
21
23
*`bundle_id` (int64): Bundle to share.
22
24
*`share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
@@ -38,7 +40,7 @@ await BundleRecipient.list({
38
40
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
39
41
*`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.
40
42
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
41
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
43
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
42
44
*`filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
43
45
*`bundle_id` (int64): Required - List recipients for the bundle with this ID.
*`user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
54
56
*`cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
55
57
*`per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
56
-
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`and`created_at`.
58
+
*`sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id`or`created_at`.
thrownewerrors.InvalidParameterError("Bad parameter: start_access_on_date must be of type String, received ".concat((0,_utils.getType)(params.start_access_on_date)));
0 commit comments