files.com 1.1.633 → 1.1.634
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 +8 -0
- data/docs/bundle_action.md +5 -1
- data/docs/bundle_notification.md +3 -1
- data/docs/site.md +4 -0
- data/lib/files.com/models/bundle.rb +15 -0
- data/lib/files.com/models/bundle_action.rb +4 -0
- data/lib/files.com/models/bundle_notification.rb +2 -0
- data/lib/files.com/models/site.rb +6 -0
- 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: b76a3d791d7630005f0693bfa612019db8450967e71a51d5dcbc25490f69ceba
|
|
4
|
+
data.tar.gz: '058e298a21b0e09b89eba4c47f24a6fb7710bae4963a47b96f407193c0076181'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: dd3d6a587d2a9e278d6cdc9e93b0b5a3d6e9e1e6d3122f4e4b1aa8c67dd14f1f6744119c2e7155ff0c2e94cded1b2550202467971d32fcdd03784814cc1f1667
|
|
7
|
+
data.tar.gz: 0f9b592090c9fd6eab749a7574798c5b6f229e9689093491eb5a6fb838f781a6eb7bd8c048c95d7a02c95dd830ba74002e7e2d78fbd1db7e1ebd24c37c49899a
|
data/_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.1.
|
|
1
|
+
1.1.634
|
data/docs/bundle.md
CHANGED
|
@@ -66,6 +66,7 @@
|
|
|
66
66
|
"snapshot_id": 1,
|
|
67
67
|
"user_id": 1,
|
|
68
68
|
"username": "user",
|
|
69
|
+
"group_id": 1,
|
|
69
70
|
"clickwrap_id": 1,
|
|
70
71
|
"inbox_id": 1,
|
|
71
72
|
"watermark_attachment": {
|
|
@@ -124,6 +125,7 @@
|
|
|
124
125
|
* `snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
|
|
125
126
|
* `user_id` (int64): Bundle creator user ID
|
|
126
127
|
* `username` (string): Bundle creator username
|
|
128
|
+
* `group_id` (int64): Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
127
129
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
|
128
130
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
|
129
131
|
* `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
|
|
@@ -195,6 +197,7 @@ Files::Bundle.create(
|
|
|
195
197
|
expires_at: "2000-01-01T01:00:00Z",
|
|
196
198
|
finalize_snapshot: false,
|
|
197
199
|
max_uses: 1,
|
|
200
|
+
group_id: 1,
|
|
198
201
|
description: "The public description of the bundle.",
|
|
199
202
|
note: "The internal note on the bundle.",
|
|
200
203
|
code: "abc123",
|
|
@@ -228,6 +231,7 @@ Files::Bundle.create(
|
|
|
228
231
|
* `expires_at` (string): Bundle expiration date/time
|
|
229
232
|
* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
230
233
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
|
234
|
+
* `group_id` (int64): Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
231
235
|
* `description` (string): Public description
|
|
232
236
|
* `note` (string): Bundle internal note
|
|
233
237
|
* `code` (string): Bundle code. This code forms the end part of the Public URL.
|
|
@@ -288,6 +292,7 @@ Files::Bundle.update(id,
|
|
|
288
292
|
finalize_snapshot: false,
|
|
289
293
|
inbox_id: 1,
|
|
290
294
|
max_uses: 1,
|
|
295
|
+
group_id: 1,
|
|
291
296
|
note: "The internal note on the bundle.",
|
|
292
297
|
path_template: "{{name}}_{{ip}}",
|
|
293
298
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
|
@@ -322,6 +327,7 @@ Files::Bundle.update(id,
|
|
|
322
327
|
* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
323
328
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
|
324
329
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
|
330
|
+
* `group_id` (int64): Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
325
331
|
* `note` (string): Bundle internal note
|
|
326
332
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
|
327
333
|
* `path_template_time_zone` (string): Timezone to use when rendering timestamps in path templates.
|
|
@@ -396,6 +402,7 @@ bundle.update(
|
|
|
396
402
|
finalize_snapshot: false,
|
|
397
403
|
inbox_id: 1,
|
|
398
404
|
max_uses: 1,
|
|
405
|
+
group_id: 1,
|
|
399
406
|
note: "The internal note on the bundle.",
|
|
400
407
|
path_template: "{{name}}_{{ip}}",
|
|
401
408
|
path_template_time_zone: "Eastern Time (US & Canada)",
|
|
@@ -430,6 +437,7 @@ bundle.update(
|
|
|
430
437
|
* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
431
438
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
|
432
439
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
|
440
|
+
* `group_id` (int64): Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
433
441
|
* `note` (string): Bundle internal note
|
|
434
442
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
|
435
443
|
* `path_template_time_zone` (string): Timezone to use when rendering timestamps in path templates.
|
data/docs/bundle_action.md
CHANGED
|
@@ -60,7 +60,9 @@
|
|
|
60
60
|
|
|
61
61
|
```
|
|
62
62
|
Files::BundleAction.list(
|
|
63
|
-
user_id: 1
|
|
63
|
+
user_id: 1,
|
|
64
|
+
bundle_id: 1,
|
|
65
|
+
bundle_registration_id: 1
|
|
64
66
|
)
|
|
65
67
|
```
|
|
66
68
|
|
|
@@ -75,3 +77,5 @@ Files::BundleAction.list(
|
|
|
75
77
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
76
78
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
77
79
|
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
80
|
+
* `bundle_id` (int64): Bundle ID
|
|
81
|
+
* `bundle_registration_id` (int64): Bundle Registration ID
|
data/docs/bundle_notification.md
CHANGED
|
@@ -28,7 +28,8 @@
|
|
|
28
28
|
|
|
29
29
|
```
|
|
30
30
|
Files::BundleNotification.list(
|
|
31
|
-
user_id: 1
|
|
31
|
+
user_id: 1,
|
|
32
|
+
bundle_id: 1
|
|
32
33
|
)
|
|
33
34
|
```
|
|
34
35
|
|
|
@@ -39,6 +40,7 @@ Files::BundleNotification.list(
|
|
|
39
40
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
40
41
|
* `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`.
|
|
41
42
|
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
|
43
|
+
* `bundle_id` (int64): Bundle ID
|
|
42
44
|
|
|
43
45
|
|
|
44
46
|
---
|
data/docs/site.md
CHANGED
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
"bundle_expiration": 1,
|
|
40
40
|
"bundle_not_found_message": "example",
|
|
41
41
|
"bundle_password_required": true,
|
|
42
|
+
"bundles_default_owned_by_primary_group": true,
|
|
42
43
|
"bundle_recipient_blacklist_domains": [
|
|
43
44
|
"example"
|
|
44
45
|
],
|
|
@@ -373,6 +374,7 @@
|
|
|
373
374
|
* `bundle_expiration` (int64): Site-wide Bundle expiration in days
|
|
374
375
|
* `bundle_not_found_message` (string): Custom error message to show when bundle is not found.
|
|
375
376
|
* `bundle_password_required` (boolean): Do Bundles require password protection?
|
|
377
|
+
* `bundles_default_owned_by_primary_group` (boolean): If true, new Share Links created by a user with a primary group will default to that group as owner.
|
|
376
378
|
* `bundle_recipient_blacklist_domains` (array(string)): List of email domains to disallow when entering a Bundle/Inbox recipients
|
|
377
379
|
* `bundle_recipient_blacklist_free_email_domains` (boolean): Disallow free email domains for Bundle/Inbox recipients?
|
|
378
380
|
* `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
|
|
@@ -596,6 +598,7 @@ Files::Site.update(
|
|
|
596
598
|
additional_text_file_types: ["example"],
|
|
597
599
|
bundle_require_note: false,
|
|
598
600
|
bundle_send_shared_receipts: false,
|
|
601
|
+
bundles_default_owned_by_primary_group: false,
|
|
599
602
|
calculate_file_checksums_crc32: false,
|
|
600
603
|
calculate_file_checksums_md5: false,
|
|
601
604
|
calculate_file_checksums_sha1: false,
|
|
@@ -770,6 +773,7 @@ Files::Site.update(
|
|
|
770
773
|
* `additional_text_file_types` (array(string)): Additional extensions that are considered text files
|
|
771
774
|
* `bundle_require_note` (boolean): Do Bundles require internal notes?
|
|
772
775
|
* `bundle_send_shared_receipts` (boolean): Do Bundle creators receive receipts of invitations?
|
|
776
|
+
* `bundles_default_owned_by_primary_group` (boolean): If true, new Share Links created by a user with a primary group will default to that group as owner.
|
|
773
777
|
* `calculate_file_checksums_crc32` (boolean): Calculate CRC32 checksums for files?
|
|
774
778
|
* `calculate_file_checksums_md5` (boolean): Calculate MD5 checksums for files?
|
|
775
779
|
* `calculate_file_checksums_sha1` (boolean): Calculate SHA1 checksums for files?
|
|
@@ -302,6 +302,15 @@ module Files
|
|
|
302
302
|
@attributes[:username] = value
|
|
303
303
|
end
|
|
304
304
|
|
|
305
|
+
# int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
306
|
+
def group_id
|
|
307
|
+
@attributes[:group_id]
|
|
308
|
+
end
|
|
309
|
+
|
|
310
|
+
def group_id=(value)
|
|
311
|
+
@attributes[:group_id] = value
|
|
312
|
+
end
|
|
313
|
+
|
|
305
314
|
# int64 - ID of the clickwrap to use with this bundle.
|
|
306
315
|
def clickwrap_id
|
|
307
316
|
@attributes[:clickwrap_id]
|
|
@@ -479,6 +488,7 @@ module Files
|
|
|
479
488
|
# finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
480
489
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
|
481
490
|
# max_uses - int64 - Maximum number of times bundle can be accessed
|
|
491
|
+
# group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
482
492
|
# note - string - Bundle internal note
|
|
483
493
|
# path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
|
484
494
|
# path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
|
|
@@ -509,6 +519,7 @@ module Files
|
|
|
509
519
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
510
520
|
raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
|
|
511
521
|
raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params[:max_uses] and !params[:max_uses].is_a?(Integer)
|
|
522
|
+
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
|
512
523
|
raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
|
|
513
524
|
raise InvalidParameterError.new("Bad parameter: path_template must be an String") if params[:path_template] and !params[:path_template].is_a?(String)
|
|
514
525
|
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)
|
|
@@ -606,6 +617,7 @@ module Files
|
|
|
606
617
|
# expires_at - string - Bundle expiration date/time
|
|
607
618
|
# finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
608
619
|
# max_uses - int64 - Maximum number of times bundle can be accessed
|
|
620
|
+
# group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
609
621
|
# description - string - Public description
|
|
610
622
|
# note - string - Bundle internal note
|
|
611
623
|
# code - string - Bundle code. This code forms the end part of the Public URL.
|
|
@@ -632,6 +644,7 @@ module Files
|
|
|
632
644
|
raise InvalidParameterError.new("Bad parameter: form_field_set_id must be an Integer") if params[:form_field_set_id] and !params[:form_field_set_id].is_a?(Integer)
|
|
633
645
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
634
646
|
raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params[:max_uses] and !params[:max_uses].is_a?(Integer)
|
|
647
|
+
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
|
635
648
|
raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
|
|
636
649
|
raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
|
|
637
650
|
raise InvalidParameterError.new("Bad parameter: code must be an String") if params[:code] and !params[:code].is_a?(String)
|
|
@@ -682,6 +695,7 @@ module Files
|
|
|
682
695
|
# finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
|
|
683
696
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
|
684
697
|
# max_uses - int64 - Maximum number of times bundle can be accessed
|
|
698
|
+
# group_id - int64 - Owning group ID. If set, members of this group can view, edit, and share this Share Link.
|
|
685
699
|
# note - string - Bundle internal note
|
|
686
700
|
# path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.
|
|
687
701
|
# path_template_time_zone - string - Timezone to use when rendering timestamps in path templates.
|
|
@@ -711,6 +725,7 @@ module Files
|
|
|
711
725
|
raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
|
|
712
726
|
raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params[:inbox_id] and !params[:inbox_id].is_a?(Integer)
|
|
713
727
|
raise InvalidParameterError.new("Bad parameter: max_uses must be an Integer") if params[:max_uses] and !params[:max_uses].is_a?(Integer)
|
|
728
|
+
raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params[:group_id] and !params[:group_id].is_a?(Integer)
|
|
714
729
|
raise InvalidParameterError.new("Bad parameter: note must be an String") if params[:note] and !params[:note].is_a?(String)
|
|
715
730
|
raise InvalidParameterError.new("Bad parameter: path_template must be an String") if params[:path_template] and !params[:path_template].is_a?(String)
|
|
716
731
|
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)
|
|
@@ -84,6 +84,8 @@ module Files
|
|
|
84
84
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
85
85
|
# filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
86
86
|
# filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
|
|
87
|
+
# bundle_id - int64 - Bundle ID
|
|
88
|
+
# bundle_registration_id - int64 - Bundle Registration ID
|
|
87
89
|
def self.list(params = {}, options = {})
|
|
88
90
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
89
91
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
@@ -94,6 +96,8 @@ module Files
|
|
|
94
96
|
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
|
|
95
97
|
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
|
|
96
98
|
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
|
|
99
|
+
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
|
100
|
+
raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)
|
|
97
101
|
|
|
98
102
|
List.new(BundleAction, params) do
|
|
99
103
|
Api.send_request("/bundle_actions", :get, params, options)
|
|
@@ -117,12 +117,14 @@ module Files
|
|
|
117
117
|
# per_page - int64 - Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
118
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`.
|
|
119
119
|
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
|
|
120
|
+
# bundle_id - int64 - Bundle ID
|
|
120
121
|
def self.list(params = {}, options = {})
|
|
121
122
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
|
122
123
|
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
|
|
123
124
|
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
|
|
124
125
|
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
|
|
125
126
|
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
|
|
127
|
+
raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
|
|
126
128
|
|
|
127
129
|
List.new(BundleNotification, params) do
|
|
128
130
|
Api.send_request("/bundle_notifications", :get, params, options)
|
|
@@ -141,6 +141,11 @@ module Files
|
|
|
141
141
|
@attributes[:bundle_password_required]
|
|
142
142
|
end
|
|
143
143
|
|
|
144
|
+
# boolean - If true, new Share Links created by a user with a primary group will default to that group as owner.
|
|
145
|
+
def bundles_default_owned_by_primary_group
|
|
146
|
+
@attributes[:bundles_default_owned_by_primary_group]
|
|
147
|
+
end
|
|
148
|
+
|
|
144
149
|
# array(string) - List of email domains to disallow when entering a Bundle/Inbox recipients
|
|
145
150
|
def bundle_recipient_blacklist_domains
|
|
146
151
|
@attributes[:bundle_recipient_blacklist_domains]
|
|
@@ -989,6 +994,7 @@ module Files
|
|
|
989
994
|
# additional_text_file_types - array(string) - Additional extensions that are considered text files
|
|
990
995
|
# bundle_require_note - boolean - Do Bundles require internal notes?
|
|
991
996
|
# bundle_send_shared_receipts - boolean - Do Bundle creators receive receipts of invitations?
|
|
997
|
+
# bundles_default_owned_by_primary_group - boolean - If true, new Share Links created by a user with a primary group will default to that group as owner.
|
|
992
998
|
# calculate_file_checksums_crc32 - boolean - Calculate CRC32 checksums for files?
|
|
993
999
|
# calculate_file_checksums_md5 - boolean - Calculate MD5 checksums for files?
|
|
994
1000
|
# calculate_file_checksums_sha1 - boolean - Calculate SHA1 checksums for files?
|
data/lib/files.com/version.rb
CHANGED