files.com 1.1.580 → 1.1.581
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/bundle.md +9 -1
- data/docs/bundle_action.md +4 -1
- data/docs/bundle_download.md +4 -1
- data/docs/bundle_notification.md +4 -2
- data/docs/bundle_recipient.md +4 -2
- data/docs/bundle_registration.md +3 -1
- data/lib/files.com/models/bundle.rb +15 -0
- data/lib/files.com/models/bundle_action.rb +6 -1
- data/lib/files.com/models/bundle_download.rb +6 -1
- data/lib/files.com/models/bundle_notification.rb +10 -1
- data/lib/files.com/models/bundle_recipient.rb +10 -1
- data/lib/files.com/models/bundle_registration.rb +6 -1
- 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: c48201f3193bbdcf48190fededfeb7f24a33c88721998f538e96eeeace9c8aa1
|
|
4
|
+
data.tar.gz: 5270b772c58f7f9593427e9989044831c27cf79b5d8766ea8cf6c151c7efdcb4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5a5dc7f29e68c49c19df6efe9d77df85e7dd89f32bca2925602df776f1a80a7dd3daa7ac27ccfa95c1cd67a37d5e96bb8e055d0a8d409b3e91e5ad5f02dda668
|
|
7
|
+
data.tar.gz: 43b5843c26e5bfa76da66b54af1d20aaaa199d37dd247acb19a101b92eceaddf34b30a684dcfb3fe966e0064ad01125ae060232fcde47e76d6d37c60dbda4f48
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.581
|
data/docs/bundle.md
CHANGED
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"key": "example value"
|
|
76
76
|
},
|
|
77
77
|
"send_one_time_password_to_recipient_at_registration": true,
|
|
78
|
+
"workspace_id": 1,
|
|
78
79
|
"has_inbox": true,
|
|
79
80
|
"dont_allow_folders_in_uploads": true,
|
|
80
81
|
"paths": [
|
|
@@ -126,6 +127,7 @@
|
|
|
126
127
|
* `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,7 +208,8 @@ Files::Bundle.create(
|
|
|
206
208
|
skip_name: true,
|
|
207
209
|
skip_company: true,
|
|
208
210
|
start_access_on_date: "2000-01-01T01:00:00Z",
|
|
209
|
-
snapshot_id: 1
|
|
211
|
+
snapshot_id: 1,
|
|
212
|
+
workspace_id: 1
|
|
210
213
|
)
|
|
211
214
|
```
|
|
212
215
|
|
|
@@ -238,6 +241,7 @@ Files::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
|
|
|
@@ -291,6 +295,7 @@ Files::Bundle.update(id,
|
|
|
291
295
|
start_access_on_date: "2000-01-01T01:00:00Z",
|
|
292
296
|
skip_email: true,
|
|
293
297
|
skip_name: true,
|
|
298
|
+
workspace_id: 1,
|
|
294
299
|
user_id: 1,
|
|
295
300
|
watermark_attachment_delete: false
|
|
296
301
|
)
|
|
@@ -323,6 +328,7 @@ Files::Bundle.update(id,
|
|
|
323
328
|
* `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
|
|
324
329
|
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
|
325
330
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
|
331
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
326
332
|
* `user_id` (int64): The owning user id. Only site admins can set this.
|
|
327
333
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
|
328
334
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
|
@@ -395,6 +401,7 @@ bundle.update(
|
|
|
395
401
|
start_access_on_date: "2000-01-01T01:00:00Z",
|
|
396
402
|
skip_email: true,
|
|
397
403
|
skip_name: true,
|
|
404
|
+
workspace_id: 1,
|
|
398
405
|
user_id: 1,
|
|
399
406
|
watermark_attachment_delete: false
|
|
400
407
|
)
|
|
@@ -427,6 +434,7 @@ bundle.update(
|
|
|
427
434
|
* `start_access_on_date` (string): Date when share will start to be accessible. If `nil` access granted right after create.
|
|
428
435
|
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
|
429
436
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
|
437
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
430
438
|
* `user_id` (int64): The owning user id. Only site admins can set this.
|
|
431
439
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
|
432
440
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
data/docs/bundle_action.md
CHANGED
|
@@ -20,6 +20,7 @@
|
|
|
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",
|
|
@@ -27,6 +28,7 @@
|
|
|
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 @@ Files::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`
|
|
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`.
|
data/docs/bundle_download.md
CHANGED
|
@@ -19,10 +19,12 @@
|
|
|
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
|
```
|
|
@@ -30,6 +32,7 @@
|
|
|
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 @@ Files::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`.
|
data/docs/bundle_notification.md
CHANGED
|
@@ -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 @@ Files::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`.
|
|
40
42
|
|
|
41
43
|
|
data/docs/bundle_recipient.md
CHANGED
|
@@ -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 @@ Files::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.
|
|
44
46
|
|
data/docs/bundle_registration.md
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
"bundle_code": "example",
|
|
19
19
|
"bundle_id": 1,
|
|
20
20
|
"bundle_recipient_id": 1,
|
|
21
|
+
"workspace_id": 1,
|
|
21
22
|
"created_at": "2000-01-01T01:00:00Z"
|
|
22
23
|
}
|
|
23
24
|
```
|
|
@@ -34,6 +35,7 @@
|
|
|
34
35
|
* `bundle_code` (string): Bundle URL code
|
|
35
36
|
* `bundle_id` (int64): Id of associated bundle
|
|
36
37
|
* `bundle_recipient_id` (int64): Id of associated bundle recipient
|
|
38
|
+
* `workspace_id` (int64): Workspace ID. `0` means the default workspace.
|
|
37
39
|
* `created_at` (date-time): Registration creation date/time
|
|
38
40
|
|
|
39
41
|
|
|
@@ -53,5 +55,5 @@ Files::BundleRegistration.list(
|
|
|
53
55
|
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
54
56
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
55
57
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
56
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`
|
|
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`.
|
|
57
59
|
* `bundle_id` (int64): ID of the associated Bundle
|
|
@@ -338,6 +338,15 @@ module Files
|
|
|
338
338
|
@attributes[:send_one_time_password_to_recipient_at_registration] = value
|
|
339
339
|
end
|
|
340
340
|
|
|
341
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
342
|
+
def workspace_id
|
|
343
|
+
@attributes[:workspace_id]
|
|
344
|
+
end
|
|
345
|
+
|
|
346
|
+
def workspace_id=(value)
|
|
347
|
+
@attributes[:workspace_id] = value
|
|
348
|
+
end
|
|
349
|
+
|
|
341
350
|
# boolean - Does this bundle have an associated inbox?
|
|
342
351
|
def has_inbox
|
|
343
352
|
@attributes[:has_inbox]
|
|
@@ -472,6 +481,7 @@ module Files
|
|
|
472
481
|
# start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
|
|
473
482
|
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
|
474
483
|
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
|
484
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
475
485
|
# user_id - int64 - The owning user id. Only site admins can set this.
|
|
476
486
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
|
477
487
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
|
@@ -494,6 +504,7 @@ module Files
|
|
|
494
504
|
raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
|
|
495
505
|
raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
|
|
496
506
|
raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
|
|
507
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
497
508
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
498
509
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
499
510
|
|
|
@@ -601,6 +612,7 @@ module Files
|
|
|
601
612
|
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
|
602
613
|
# start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
|
|
603
614
|
# snapshot_id - int64 - ID of the snapshot containing this bundle's contents.
|
|
615
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
604
616
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
|
605
617
|
def self.create(params = {}, options = {})
|
|
606
618
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
@@ -619,6 +631,7 @@ module Files
|
|
|
619
631
|
raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
|
|
620
632
|
raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
|
|
621
633
|
raise InvalidParameterError.new("Bad parameter: snapshot_id must be an Integer") if params[:snapshot_id] and !params[:snapshot_id].is_a?(Integer)
|
|
634
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
622
635
|
raise MissingParameterError.new("Parameter missing: paths") unless params[:paths]
|
|
623
636
|
|
|
624
637
|
response, options = Api.send_request("/bundles", :post, params, options)
|
|
@@ -669,6 +682,7 @@ module Files
|
|
|
669
682
|
# start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create.
|
|
670
683
|
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
|
671
684
|
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
|
685
|
+
# workspace_id - int64 - Workspace ID. `0` means the default workspace.
|
|
672
686
|
# user_id - int64 - The owning user id. Only site admins can set this.
|
|
673
687
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
|
674
688
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
|
@@ -690,6 +704,7 @@ module Files
|
|
|
690
704
|
raise InvalidParameterError.new("Bad parameter: path_template_time_zone must be an String") if params[:path_template_time_zone] and !params[:path_template_time_zone].is_a?(String)
|
|
691
705
|
raise InvalidParameterError.new("Bad parameter: permissions must be an String") if params[:permissions] and !params[:permissions].is_a?(String)
|
|
692
706
|
raise InvalidParameterError.new("Bad parameter: start_access_on_date must be an String") if params[:start_access_on_date] and !params[:start_access_on_date].is_a?(String)
|
|
707
|
+
raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
|
|
693
708
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
694
709
|
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
|
695
710
|
|
|
@@ -44,6 +44,11 @@ module Files
|
|
|
44
44
|
@attributes[:bundle_registration_id]
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
48
|
+
def workspace_id
|
|
49
|
+
@attributes[:workspace_id]
|
|
50
|
+
end
|
|
51
|
+
|
|
47
52
|
# string - Name of the registrant who performed the action
|
|
48
53
|
def bundle_registration_name
|
|
49
54
|
@attributes[:bundle_registration_name]
|
|
@@ -63,7 +68,7 @@ module Files
|
|
|
63
68
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
64
69
|
# cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
65
70
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
66
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`
|
|
71
|
+
# 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`.
|
|
67
72
|
# 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 ]`.
|
|
68
73
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
69
74
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
@@ -24,6 +24,11 @@ module Files
|
|
|
24
24
|
@attributes[:path]
|
|
25
25
|
end
|
|
26
26
|
|
|
27
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
28
|
+
def workspace_id
|
|
29
|
+
@attributes[:workspace_id]
|
|
30
|
+
end
|
|
31
|
+
|
|
27
32
|
# date-time - Download date/time
|
|
28
33
|
def created_at
|
|
29
34
|
@attributes[:created_at]
|
|
@@ -32,7 +37,7 @@ module Files
|
|
|
32
37
|
# Parameters:
|
|
33
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.
|
|
34
39
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
35
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
|
|
40
|
+
# 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`.
|
|
36
41
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
|
|
37
42
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
38
43
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
@@ -54,6 +54,15 @@ module Files
|
|
|
54
54
|
@attributes[:notify_user_id] = value
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
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
|
# int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
58
67
|
def user_id
|
|
59
68
|
@attributes[:user_id]
|
|
@@ -106,7 +115,7 @@ module Files
|
|
|
106
115
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
107
116
|
# 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.
|
|
108
117
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
109
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
|
|
118
|
+
# 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`.
|
|
110
119
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
|
111
120
|
def self.list(params = {}, options = {})
|
|
112
121
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
@@ -54,6 +54,15 @@ module Files
|
|
|
54
54
|
@attributes[:sent_at] = value
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
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
|
# int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
58
67
|
def user_id
|
|
59
68
|
@attributes[:user_id]
|
|
@@ -96,7 +105,7 @@ module Files
|
|
|
96
105
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
97
106
|
# 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.
|
|
98
107
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
99
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are
|
|
108
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
|
|
100
109
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
|
|
101
110
|
# bundle_id (required) - int64 - List recipients for the bundle with this ID.
|
|
102
111
|
def self.list(params = {}, options = {})
|
|
@@ -69,6 +69,11 @@ module Files
|
|
|
69
69
|
@attributes[:bundle_recipient_id]
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
+
# int64 - Workspace ID. `0` means the default workspace.
|
|
73
|
+
def workspace_id
|
|
74
|
+
@attributes[:workspace_id]
|
|
75
|
+
end
|
|
76
|
+
|
|
72
77
|
# date-time - Registration creation date/time
|
|
73
78
|
def created_at
|
|
74
79
|
@attributes[:created_at]
|
|
@@ -78,7 +83,7 @@ module Files
|
|
|
78
83
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
|
79
84
|
# 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.
|
|
80
85
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
|
81
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`
|
|
86
|
+
# 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`.
|
|
82
87
|
# bundle_id - int64 - ID of the associated Bundle
|
|
83
88
|
def self.list(params = {}, options = {})
|
|
84
89
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
data/lib/files.com/version.rb
CHANGED