files.com 1.0.313 → 1.0.315
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/bundle.md +12 -4
- data/docs/bundle_notification.md +42 -0
- data/docs/bundle_registration.md +3 -1
- data/docs/inbox_registration.md +3 -1
- data/docs/site.md +2 -0
- data/lib/files.com/models/bundle.rb +14 -2
- data/lib/files.com/models/bundle_notification.rb +37 -1
- data/lib/files.com/models/bundle_registration.rb +5 -0
- data/lib/files.com/models/inbox_registration.rb +5 -0
- data/lib/files.com/models/site.rb +5 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3e57fafa3fb08c3d5836b0fe7995b6d9e0092067aadc5a13abef94c7e94314ed
|
4
|
+
data.tar.gz: 2164c89175e797ef8c11397e68b7774a8a3294fd7c8fa5b332561052b806459b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c0a8cb3788c3ea9a3b99930acc711fc886103f9fbc30ecd729f0921219266ae872eca40d7bb7dfc6a17cb20c7b2020bec185f438514438a880e2b0306d866a72
|
7
|
+
data.tar.gz: f3f25a2873b204f9524a0851f745cfce737ccfecc8996af2467b5a2c0cffad1e13e453a06e9564c0a0e901d5493f907a03f17d461e5d95147f6666a0dd496b86
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.315
|
data/docs/bundle.md
CHANGED
@@ -24,6 +24,7 @@
|
|
24
24
|
"max_uses": 1,
|
25
25
|
"note": "The internal note on the bundle.",
|
26
26
|
"path_template": "{{name}}_{{ip}}",
|
27
|
+
"send_email_receipt_to_uploader": true,
|
27
28
|
"user_id": 1,
|
28
29
|
"username": "user",
|
29
30
|
"clickwrap_id": 1,
|
@@ -59,6 +60,7 @@
|
|
59
60
|
* `max_uses` (int64): Maximum number of times bundle can be accessed
|
60
61
|
* `note` (string): Bundle internal note
|
61
62
|
* `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
|
63
|
+
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
62
64
|
* `user_id` (int64): Bundle creator user ID
|
63
65
|
* `username` (string): Bundle creator username
|
64
66
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
@@ -134,6 +136,7 @@ Files::Bundle.create(
|
|
134
136
|
clickwrap_id: 1,
|
135
137
|
inbox_id: 1,
|
136
138
|
require_share_recipient: true,
|
139
|
+
send_email_receipt_to_uploader: true,
|
137
140
|
skip_email: true,
|
138
141
|
skip_name: true,
|
139
142
|
skip_company: true
|
@@ -159,6 +162,7 @@ Files::Bundle.create(
|
|
159
162
|
* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
|
160
163
|
* `inbox_id` (int64): ID of the associated inbox, if available.
|
161
164
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
165
|
+
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
162
166
|
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
163
167
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
164
168
|
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
@@ -207,9 +211,10 @@ Files::Bundle.update(id,
|
|
207
211
|
preview_only: true,
|
208
212
|
require_registration: true,
|
209
213
|
require_share_recipient: true,
|
214
|
+
send_email_receipt_to_uploader: true,
|
215
|
+
skip_company: true,
|
210
216
|
skip_email: true,
|
211
217
|
skip_name: true,
|
212
|
-
skip_company: true,
|
213
218
|
watermark_attachment_delete: true
|
214
219
|
)
|
215
220
|
```
|
@@ -233,9 +238,10 @@ Files::Bundle.update(id,
|
|
233
238
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
234
239
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
235
240
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
241
|
+
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
242
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
236
243
|
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
237
244
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
238
|
-
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
239
245
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
240
246
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
241
247
|
|
@@ -299,9 +305,10 @@ bundle.update(
|
|
299
305
|
preview_only: true,
|
300
306
|
require_registration: true,
|
301
307
|
require_share_recipient: true,
|
308
|
+
send_email_receipt_to_uploader: true,
|
309
|
+
skip_company: true,
|
302
310
|
skip_email: true,
|
303
311
|
skip_name: true,
|
304
|
-
skip_company: true,
|
305
312
|
watermark_attachment_delete: true
|
306
313
|
)
|
307
314
|
```
|
@@ -325,9 +332,10 @@ bundle.update(
|
|
325
332
|
* `preview_only` (boolean): Restrict users to previewing files only?
|
326
333
|
* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
|
327
334
|
* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
335
|
+
* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
|
336
|
+
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
328
337
|
* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
|
329
338
|
* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
|
330
|
-
* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
|
331
339
|
* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
|
332
340
|
* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
|
333
341
|
|
data/docs/bundle_notification.md
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
"bundle_id": 1,
|
8
8
|
"id": 1,
|
9
9
|
"notify_on_registration": true,
|
10
|
+
"notify_on_upload": true,
|
10
11
|
"user_id": 1
|
11
12
|
}
|
12
13
|
```
|
@@ -14,6 +15,7 @@
|
|
14
15
|
* `bundle_id` (int64): Bundle ID to notify on
|
15
16
|
* `id` (int64): Bundle Notification ID
|
16
17
|
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
18
|
+
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
17
19
|
* `user_id` (int64): The id of the user to notify.
|
18
20
|
|
19
21
|
|
@@ -58,6 +60,7 @@ Files::BundleNotification.find(id)
|
|
58
60
|
Files::BundleNotification.create(
|
59
61
|
user_id: 1,
|
60
62
|
notify_on_registration: true,
|
63
|
+
notify_on_upload: true,
|
61
64
|
bundle_id: 1
|
62
65
|
)
|
63
66
|
```
|
@@ -66,9 +69,28 @@ Files::BundleNotification.create(
|
|
66
69
|
|
67
70
|
* `user_id` (int64): Required - The id of the user to notify.
|
68
71
|
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
72
|
+
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
69
73
|
* `bundle_id` (int64): Required - Bundle ID to notify on
|
70
74
|
|
71
75
|
|
76
|
+
---
|
77
|
+
|
78
|
+
## Update Bundle Notification
|
79
|
+
|
80
|
+
```
|
81
|
+
Files::BundleNotification.update(id,
|
82
|
+
notify_on_registration: true,
|
83
|
+
notify_on_upload: true
|
84
|
+
)
|
85
|
+
```
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
* `id` (int64): Required - Bundle Notification ID.
|
90
|
+
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
91
|
+
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
92
|
+
|
93
|
+
|
72
94
|
---
|
73
95
|
|
74
96
|
## Delete Bundle Notification
|
@@ -82,6 +104,26 @@ Files::BundleNotification.delete(id)
|
|
82
104
|
* `id` (int64): Required - Bundle Notification ID.
|
83
105
|
|
84
106
|
|
107
|
+
---
|
108
|
+
|
109
|
+
## Update Bundle Notification
|
110
|
+
|
111
|
+
```
|
112
|
+
bundle_notification = Files::BundleNotification.list.first
|
113
|
+
|
114
|
+
bundle_notification.update(
|
115
|
+
notify_on_registration: true,
|
116
|
+
notify_on_upload: true
|
117
|
+
)
|
118
|
+
```
|
119
|
+
|
120
|
+
### Parameters
|
121
|
+
|
122
|
+
* `id` (int64): Required - Bundle Notification ID.
|
123
|
+
* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
|
124
|
+
* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
|
125
|
+
|
126
|
+
|
85
127
|
---
|
86
128
|
|
87
129
|
## Delete Bundle Notification
|
data/docs/bundle_registration.md
CHANGED
@@ -17,7 +17,8 @@
|
|
17
17
|
},
|
18
18
|
"bundle_code": "example",
|
19
19
|
"bundle_id": 1,
|
20
|
-
"bundle_recipient_id": 1
|
20
|
+
"bundle_recipient_id": 1,
|
21
|
+
"created_at": "2000-01-01T01:00:00Z"
|
21
22
|
}
|
22
23
|
```
|
23
24
|
|
@@ -33,6 +34,7 @@
|
|
33
34
|
* `bundle_code` (string): Bundle URL code
|
34
35
|
* `bundle_id` (int64): Id of associated bundle
|
35
36
|
* `bundle_recipient_id` (int64): Id of associated bundle recipient
|
37
|
+
* `created_at` (date-time): Registration creation date/time
|
36
38
|
|
37
39
|
|
38
40
|
---
|
data/docs/inbox_registration.md
CHANGED
@@ -15,7 +15,8 @@
|
|
15
15
|
},
|
16
16
|
"inbox_id": 1,
|
17
17
|
"inbox_recipient_id": 1,
|
18
|
-
"inbox_title": "example"
|
18
|
+
"inbox_title": "example",
|
19
|
+
"created_at": "2000-01-01T01:00:00Z"
|
19
20
|
}
|
20
21
|
```
|
21
22
|
|
@@ -29,6 +30,7 @@
|
|
29
30
|
* `inbox_id` (int64): Id of associated inbox
|
30
31
|
* `inbox_recipient_id` (int64): Id of associated inbox recipient
|
31
32
|
* `inbox_title` (string): Title of associated inbox
|
33
|
+
* `created_at` (date-time): Registration creation date/time
|
32
34
|
|
33
35
|
|
34
36
|
---
|
data/docs/site.md
CHANGED
@@ -124,6 +124,7 @@
|
|
124
124
|
"smtp_port": 25,
|
125
125
|
"smtp_username": "mail",
|
126
126
|
"session_expiry": 6.0,
|
127
|
+
"session_expiry_minutes": 360,
|
127
128
|
"ssl_required": true,
|
128
129
|
"subdomain": "mysite",
|
129
130
|
"switch_to_plan_date": "2000-01-01T01:00:00Z",
|
@@ -267,6 +268,7 @@
|
|
267
268
|
* `smtp_port` (int64): SMTP server port
|
268
269
|
* `smtp_username` (string): SMTP server username
|
269
270
|
* `session_expiry` (double): Session expiry in hours
|
271
|
+
* `session_expiry_minutes` (int64): Session expiry in minutes
|
270
272
|
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
271
273
|
* `subdomain` (string): Site subdomain
|
272
274
|
* `switch_to_plan_date` (date-time): If switching plans, when does the new plan take effect?
|
@@ -185,6 +185,15 @@ module Files
|
|
185
185
|
@attributes[:path_template] = value
|
186
186
|
end
|
187
187
|
|
188
|
+
# boolean - Send delivery receipt to the uploader. Note: For writable share only
|
189
|
+
def send_email_receipt_to_uploader
|
190
|
+
@attributes[:send_email_receipt_to_uploader]
|
191
|
+
end
|
192
|
+
|
193
|
+
def send_email_receipt_to_uploader=(value)
|
194
|
+
@attributes[:send_email_receipt_to_uploader] = value
|
195
|
+
end
|
196
|
+
|
188
197
|
# int64 - Bundle creator user ID
|
189
198
|
def user_id
|
190
199
|
@attributes[:user_id]
|
@@ -329,9 +338,10 @@ module Files
|
|
329
338
|
# preview_only - boolean - Restrict users to previewing files only?
|
330
339
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
331
340
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
341
|
+
# send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
|
342
|
+
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
332
343
|
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
333
344
|
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
334
|
-
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
335
345
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
336
346
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
337
347
|
def update(params = {})
|
@@ -445,6 +455,7 @@ module Files
|
|
445
455
|
# clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
|
446
456
|
# inbox_id - int64 - ID of the associated inbox, if available.
|
447
457
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
458
|
+
# send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
|
448
459
|
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
449
460
|
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
450
461
|
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
@@ -505,9 +516,10 @@ module Files
|
|
505
516
|
# preview_only - boolean - Restrict users to previewing files only?
|
506
517
|
# require_registration - boolean - Show a registration page that captures the downloader's name and email address?
|
507
518
|
# require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
|
519
|
+
# send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
|
520
|
+
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
508
521
|
# skip_email - boolean - BundleRegistrations can be saved without providing email?
|
509
522
|
# skip_name - boolean - BundleRegistrations can be saved without providing name?
|
510
|
-
# skip_company - boolean - BundleRegistrations can be saved without providing company?
|
511
523
|
# watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
|
512
524
|
# watermark_attachment_file - file - Preview watermark image applied to all bundle items.
|
513
525
|
def self.update(id, params = {}, options = {})
|
@@ -36,6 +36,15 @@ module Files
|
|
36
36
|
@attributes[:notify_on_registration] = value
|
37
37
|
end
|
38
38
|
|
39
|
+
# boolean - Triggers bundle notification when a upload action occurs for it.
|
40
|
+
def notify_on_upload
|
41
|
+
@attributes[:notify_on_upload]
|
42
|
+
end
|
43
|
+
|
44
|
+
def notify_on_upload=(value)
|
45
|
+
@attributes[:notify_on_upload] = value
|
46
|
+
end
|
47
|
+
|
39
48
|
# int64 - The id of the user to notify.
|
40
49
|
def user_id
|
41
50
|
@attributes[:user_id]
|
@@ -45,6 +54,19 @@ module Files
|
|
45
54
|
@attributes[:user_id] = value
|
46
55
|
end
|
47
56
|
|
57
|
+
# Parameters:
|
58
|
+
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
59
|
+
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
60
|
+
def update(params = {})
|
61
|
+
params ||= {}
|
62
|
+
params[:id] = @attributes[:id]
|
63
|
+
raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
|
64
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
65
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
66
|
+
|
67
|
+
Api.send_request("/bundle_notifications/#{@attributes[:id]}", :patch, params, @options)
|
68
|
+
end
|
69
|
+
|
48
70
|
def delete(params = {})
|
49
71
|
params ||= {}
|
50
72
|
params[:id] = @attributes[:id]
|
@@ -61,7 +83,7 @@ module Files
|
|
61
83
|
|
62
84
|
def save
|
63
85
|
if @attributes[:id]
|
64
|
-
|
86
|
+
update(@attributes)
|
65
87
|
else
|
66
88
|
new_obj = BundleNotification.create(@attributes, @options)
|
67
89
|
@attributes = new_obj.attributes
|
@@ -107,6 +129,7 @@ module Files
|
|
107
129
|
# Parameters:
|
108
130
|
# user_id (required) - int64 - The id of the user to notify.
|
109
131
|
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
132
|
+
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
110
133
|
# bundle_id (required) - int64 - Bundle ID to notify on
|
111
134
|
def self.create(params = {}, options = {})
|
112
135
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
|
@@ -118,6 +141,19 @@ module Files
|
|
118
141
|
BundleNotification.new(response.data, options)
|
119
142
|
end
|
120
143
|
|
144
|
+
# Parameters:
|
145
|
+
# notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
|
146
|
+
# notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
|
147
|
+
def self.update(id, params = {}, options = {})
|
148
|
+
params ||= {}
|
149
|
+
params[:id] = id
|
150
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
|
151
|
+
raise MissingParameterError.new("Parameter missing: id") unless params[:id]
|
152
|
+
|
153
|
+
response, options = Api.send_request("/bundle_notifications/#{params[:id]}", :patch, params, options)
|
154
|
+
BundleNotification.new(response.data, options)
|
155
|
+
end
|
156
|
+
|
121
157
|
def self.delete(id, params = {}, options = {})
|
122
158
|
params ||= {}
|
123
159
|
params[:id] = id
|
@@ -69,6 +69,11 @@ module Files
|
|
69
69
|
@attributes[:bundle_recipient_id]
|
70
70
|
end
|
71
71
|
|
72
|
+
# date-time - Registration creation date/time
|
73
|
+
def created_at
|
74
|
+
@attributes[:created_at]
|
75
|
+
end
|
76
|
+
|
72
77
|
# Parameters:
|
73
78
|
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
74
79
|
# cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
@@ -59,6 +59,11 @@ module Files
|
|
59
59
|
@attributes[:inbox_title]
|
60
60
|
end
|
61
61
|
|
62
|
+
# date-time - Registration creation date/time
|
63
|
+
def created_at
|
64
|
+
@attributes[:created_at]
|
65
|
+
end
|
66
|
+
|
62
67
|
# Parameters:
|
63
68
|
# cursor - string - Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
|
64
69
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
@@ -599,6 +599,11 @@ module Files
|
|
599
599
|
@attributes[:session_expiry]
|
600
600
|
end
|
601
601
|
|
602
|
+
# int64 - Session expiry in minutes
|
603
|
+
def session_expiry_minutes
|
604
|
+
@attributes[:session_expiry_minutes]
|
605
|
+
end
|
606
|
+
|
602
607
|
# boolean - Is SSL required? Disabling this is insecure.
|
603
608
|
def ssl_required
|
604
609
|
@attributes[:ssl_required]
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: files.com
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.315
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- files.com
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-12-
|
11
|
+
date: 2022-12-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|