files.com 1.0.313 → 1.0.315

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9096f3a4675cf528626ed1fe2bfb2d8aba0491fde07e1618fe3a080398e76a
-  data.tar.gz: 97f15a52f7adf94a9b5090648e2db5f27db531067508cc25b5bb4210708803c0
+  metadata.gz: 3e57fafa3fb08c3d5836b0fe7995b6d9e0092067aadc5a13abef94c7e94314ed
+  data.tar.gz: 2164c89175e797ef8c11397e68b7774a8a3294fd7c8fa5b332561052b806459b
 SHA512:
-  metadata.gz: bc66b7f22dc575721fd6908d8c32dd6de23fe34909ea4a328be07ab24f3b99a846328ea62a08ffdbf68757865fdffcfa8638b3b1edcdfed74d689b301c7d7926
-  data.tar.gz: 26a455e104bbe824ec22eb7ffe0cfbb20b0de02c1735c75f29106084fcd25fe4861f8051aa0a8a936975d679bbdb166f2da2219d004a81ee3d34b8055fdb79a0
+  metadata.gz: c0a8cb3788c3ea9a3b99930acc711fc886103f9fbc30ecd729f0921219266ae872eca40d7bb7dfc6a17cb20c7b2020bec185f438514438a880e2b0306d866a72
+  data.tar.gz: f3f25a2873b204f9524a0851f745cfce737ccfecc8996af2467b5a2c0cffad1e13e453a06e9564c0a0e901d5493f907a03f17d461e5d95147f6666a0dd496b86

data/_VERSION

@@ -1 +1 @@
-1.0.313
+1.0.315

data/docs/bundle.md

@@ -24,6 +24,7 @@
   "max_uses": 1,
   "note": "The internal note on the bundle.",
   "path_template": "{{name}}_{{ip}}",
+  "send_email_receipt_to_uploader": true,
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,
@@ -59,6 +60,7 @@
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
 * `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
+* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
@@ -134,6 +136,7 @@ Files::Bundle.create(
   clickwrap_id: 1, 
   inbox_id: 1, 
   require_share_recipient: true, 
+  send_email_receipt_to_uploader: true, 
   skip_email: true, 
   skip_name: true, 
   skip_company: true
@@ -159,6 +162,7 @@ Files::Bundle.create(
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
 * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
 * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
 * `skip_company` (boolean): BundleRegistrations can be saved without providing company?
@@ -207,9 +211,10 @@ Files::Bundle.update(id,
   preview_only: true, 
   require_registration: true, 
   require_share_recipient: true, 
+  send_email_receipt_to_uploader: true, 
+  skip_company: true, 
   skip_email: true, 
   skip_name: true, 
-  skip_company: true, 
   watermark_attachment_delete: true
 )
 ```
@@ -233,9 +238,10 @@ Files::Bundle.update(id,
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
+* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
 * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
 * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
-* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
 * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
 * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 
@@ -299,9 +305,10 @@ bundle.update(
   preview_only: true,
   require_registration: true,
   require_share_recipient: true,
+  send_email_receipt_to_uploader: true,
+  skip_company: true,
   skip_email: true,
   skip_name: true,
-  skip_company: true,
   watermark_attachment_delete: true
 )
 ```
@@ -325,9 +332,10 @@ bundle.update(
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
+* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
 * `skip_email` (boolean): BundleRegistrations can be saved without providing email?
 * `skip_name` (boolean): BundleRegistrations can be saved without providing name?
-* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
 * `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
 * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 

data/docs/bundle_notification.md

@@ -7,6 +7,7 @@
   "bundle_id": 1,
   "id": 1,
   "notify_on_registration": true,
+  "notify_on_upload": true,
   "user_id": 1
 }
 ```
@@ -14,6 +15,7 @@
 * `bundle_id` (int64): Bundle ID to notify on
 * `id` (int64): Bundle Notification ID
 * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
 * `user_id` (int64): The id of the user to notify.
 
 
@@ -58,6 +60,7 @@ Files::BundleNotification.find(id)
 Files::BundleNotification.create(
   user_id: 1, 
   notify_on_registration: true, 
+  notify_on_upload: true, 
   bundle_id: 1
 )
 ```
@@ -66,9 +69,28 @@ Files::BundleNotification.create(
 
 * `user_id` (int64): Required - The id of the user to notify.
 * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
 * `bundle_id` (int64): Required - Bundle ID to notify on
 
 
+---
+
+## Update Bundle Notification
+
+```
+Files::BundleNotification.update(id, 
+  notify_on_registration: true, 
+  notify_on_upload: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
+
+
 ---
 
 ## Delete Bundle Notification
@@ -82,6 +104,26 @@ Files::BundleNotification.delete(id)
 * `id` (int64): Required - Bundle Notification ID.
 
 
+---
+
+## Update Bundle Notification
+
+```
+bundle_notification = Files::BundleNotification.list.first
+
+bundle_notification.update(
+  notify_on_registration: true,
+  notify_on_upload: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+* `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.
+* `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
+
+
 ---
 
 ## Delete Bundle Notification

data/docs/bundle_registration.md

@@ -17,7 +17,8 @@
   },
   "bundle_code": "example",
   "bundle_id": 1,
-  "bundle_recipient_id": 1
+  "bundle_recipient_id": 1,
+  "created_at": "2000-01-01T01:00:00Z"
 }
 ```
 
@@ -33,6 +34,7 @@
 * `bundle_code` (string): Bundle URL code
 * `bundle_id` (int64): Id of associated bundle
 * `bundle_recipient_id` (int64): Id of associated bundle recipient
+* `created_at` (date-time): Registration creation date/time
 
 
 ---

data/docs/inbox_registration.md

@@ -15,7 +15,8 @@
   },
   "inbox_id": 1,
   "inbox_recipient_id": 1,
-  "inbox_title": "example"
+  "inbox_title": "example",
+  "created_at": "2000-01-01T01:00:00Z"
 }
 ```
 
@@ -29,6 +30,7 @@
 * `inbox_id` (int64): Id of associated inbox
 * `inbox_recipient_id` (int64): Id of associated inbox recipient
 * `inbox_title` (string): Title of associated inbox
+* `created_at` (date-time): Registration creation date/time
 
 
 ---

data/docs/site.md

@@ -124,6 +124,7 @@
   "smtp_port": 25,
   "smtp_username": "mail",
   "session_expiry": 6.0,
+  "session_expiry_minutes": 360,
   "ssl_required": true,
   "subdomain": "mysite",
   "switch_to_plan_date": "2000-01-01T01:00:00Z",
@@ -267,6 +268,7 @@
 * `smtp_port` (int64): SMTP server port
 * `smtp_username` (string): SMTP server username
 * `session_expiry` (double): Session expiry in hours
+* `session_expiry_minutes` (int64): Session expiry in minutes
 * `ssl_required` (boolean): Is SSL required?  Disabling this is insecure.
 * `subdomain` (string): Site subdomain
 * `switch_to_plan_date` (date-time): If switching plans, when does the new plan take effect?

data/lib/files.com/models/bundle.rb

@@ -185,6 +185,15 @@ module Files
       @attributes[:path_template] = value
     end
 
+    # boolean - Send delivery receipt to the uploader. Note: For writable share only
+    def send_email_receipt_to_uploader
+      @attributes[:send_email_receipt_to_uploader]
+    end
+
+    def send_email_receipt_to_uploader=(value)
+      @attributes[:send_email_receipt_to_uploader] = value
+    end
+
     # int64 - Bundle creator user ID
     def user_id
       @attributes[:user_id]
@@ -329,9 +338,10 @@ module Files
     #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
+    #   skip_company - boolean - BundleRegistrations can be saved without providing company?
     #   skip_email - boolean - BundleRegistrations can be saved without providing email?
     #   skip_name - boolean - BundleRegistrations can be saved without providing name?
-    #   skip_company - boolean - BundleRegistrations can be saved without providing company?
     #   watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
     #   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
     def update(params = {})
@@ -445,6 +455,7 @@ module Files
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
     #   skip_email - boolean - BundleRegistrations can be saved without providing email?
     #   skip_name - boolean - BundleRegistrations can be saved without providing name?
     #   skip_company - boolean - BundleRegistrations can be saved without providing company?
@@ -505,9 +516,10 @@ module Files
     #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only
+    #   skip_company - boolean - BundleRegistrations can be saved without providing company?
     #   skip_email - boolean - BundleRegistrations can be saved without providing email?
     #   skip_name - boolean - BundleRegistrations can be saved without providing name?
-    #   skip_company - boolean - BundleRegistrations can be saved without providing company?
     #   watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
     #   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
     def self.update(id, params = {}, options = {})

data/lib/files.com/models/bundle_notification.rb

@@ -36,6 +36,15 @@ module Files
       @attributes[:notify_on_registration] = value
     end
 
+    # boolean - Triggers bundle notification when a upload action occurs for it.
+    def notify_on_upload
+      @attributes[:notify_on_upload]
+    end
+
+    def notify_on_upload=(value)
+      @attributes[:notify_on_upload] = value
+    end
+
     # int64 - The id of the user to notify.
     def user_id
       @attributes[:user_id]
@@ -45,6 +54,19 @@ module Files
       @attributes[:user_id] = value
     end
 
+    # Parameters:
+    #   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+    #   notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
+    def update(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/bundle_notifications/#{@attributes[:id]}", :patch, params, @options)
+    end
+
     def delete(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -61,7 +83,7 @@ module Files
 
     def save
       if @attributes[:id]
-        raise NotImplementedError.new("The BundleNotification object doesn't support updates.")
+        update(@attributes)
       else
         new_obj = BundleNotification.create(@attributes, @options)
         @attributes = new_obj.attributes
@@ -107,6 +129,7 @@ module Files
     # Parameters:
     #   user_id (required) - int64 - The id of the user to notify.
     #   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+    #   notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
     #   bundle_id (required) - int64 - Bundle ID to notify on
     def self.create(params = {}, options = {})
       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
       BundleNotification.new(response.data, options)
     end
 
+    # Parameters:
+    #   notify_on_registration - boolean - Triggers bundle notification when a registration action occurs for it.
+    #   notify_on_upload - boolean - Triggers bundle notification when a upload action occurs for it.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/bundle_notifications/#{params[:id]}", :patch, params, options)
+      BundleNotification.new(response.data, options)
+    end
+
     def self.delete(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

data/lib/files.com/models/bundle_registration.rb

@@ -69,6 +69,11 @@ module Files
       @attributes[:bundle_recipient_id]
     end
 
+    # date-time - Registration creation date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   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.

data/lib/files.com/models/inbox_registration.rb

@@ -59,6 +59,11 @@ module Files
       @attributes[:inbox_title]
     end
 
+    # date-time - Registration creation date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
     # Parameters:
     #   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.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

data/lib/files.com/models/site.rb

@@ -599,6 +599,11 @@ module Files
       @attributes[:session_expiry]
     end
 
+    # int64 - Session expiry in minutes
+    def session_expiry_minutes
+      @attributes[:session_expiry_minutes]
+    end
+
     # boolean - Is SSL required?  Disabling this is insecure.
     def ssl_required
       @attributes[:ssl_required]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.313
+  version: 1.0.315
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2022-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable