files.com 1.0.309 → 1.0.311

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9886b13b98ac876358ccd85138f6c84a1214f97a34e69a6bbf1f7d35c6331d3
-  data.tar.gz: ebc93bc1fe74de6f75afc8bd33cfc3c81622a72ade67e2e56cdc7456dbbd8178
+  metadata.gz: 603f738d47c3d761d19a66df997aa7e7b46dc0d93f908239b8445f6713749c97
+  data.tar.gz: d8e1775860d4c4f0a5407f41f8bcf0a5199d614624cb675f3e2c2e5a5d705821
 SHA512:
-  metadata.gz: e4cab9cf85e598f96212646f5726b250928351fab4eeb882c248b58b9584369d0589f25f8543659d199cf7ce5065ac6e14e882f4ba47f8280302bd4227c8c474
-  data.tar.gz: 066f28504469069ac18f54c7f557d2fb40d103e8a7a88de8d9dc122400e2655cf70f0d2f080c25ff284a544f2b43237f2432cc112433dc813c93ccd94b796300
+  metadata.gz: 863b75de449d8ef4ca227e0c64f827a447f1b2ad59a6b4c0acb165d7719c0a228f9b5591fafca7e3f5c18d2f143364d92028ca55fbdb4f5f81786ef8a1dc1307
+  data.tar.gz: 989a9e5a0a0a85f22d83de4e1104318308ad3b38c8952da808acd7e441d6d15fedbab836b76dfcabc75d245618a0be7fc353e1f7858e938627de3c29c46fe652

data/_VERSION

@@ -1 +1 @@
-1.0.309
+1.0.311

data/docs/bundle_notification.md

@@ -0,0 +1,97 @@
+# BundleNotification
+
+## Example BundleNotification Object
+
+```
+{
+  "bundle_id": 1,
+  "id": 1,
+  "notify_on_registration": true,
+  "user_id": 1
+}
+```
+
+* `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.
+* `user_id` (int64): The id of the user to notify.
+
+
+---
+
+## List Bundle Notifications
+
+```
+Files::BundleNotification.list(
+  user_id: 1, 
+  per_page: 1, 
+  bundle_id: 1
+)
+```
+
+### 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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `bundle_id` (int64): Bundle ID to notify on
+
+
+---
+
+## Show Bundle Notification
+
+```
+Files::BundleNotification.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+
+
+---
+
+## Create Bundle Notification
+
+```
+Files::BundleNotification.create(
+  user_id: 1, 
+  notify_on_registration: true, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `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.
+* `bundle_id` (int64): Required - Bundle ID to notify on
+
+
+---
+
+## Delete Bundle Notification
+
+```
+Files::BundleNotification.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.
+
+
+---
+
+## Delete Bundle Notification
+
+```
+bundle_notification = Files::BundleNotification.list.first
+
+bundle_notification.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle Notification ID.

data/docs/site.md

@@ -16,10 +16,12 @@
   "allowed_countries": "US,DE",
   "allowed_ips": "example",
   "ask_about_overwrites": true,
+  "bundle_activity_notifications": "never",
   "bundle_expiration": 1,
   "bundle_password_required": true,
   "bundle_registration_notifications": "never",
   "bundle_require_share_recipient": true,
+  "bundle_upload_receipt_notifications": "never",
   "bundle_watermark_attachment": "",
   "bundle_watermark_value": {
     "key": "example value"
@@ -159,10 +161,12 @@
 * `allowed_countries` (string): Comma seperated list of allowed Country codes
 * `allowed_ips` (string): List of allowed IP addresses
 * `ask_about_overwrites` (boolean): If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
+* `bundle_activity_notifications` (string): Do Bundle owners receive activity notifications?
 * `bundle_expiration` (int64): Site-wide Bundle expiration in days
 * `bundle_password_required` (boolean): Do Bundles require password protection?
 * `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
 * `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
+* `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
 * `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
 * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 * `color2_left` (string): Page link and button color
@@ -372,6 +376,8 @@ Files::Site.update(
   bundle_password_required: true, 
   bundle_require_share_recipient: true, 
   bundle_registration_notifications: "never", 
+  bundle_activity_notifications: "never", 
+  bundle_upload_receipt_notifications: "never", 
   password_requirements_apply_to_bundles: true, 
   opt_out_global: true, 
   use_provided_modified_at: true, 
@@ -497,6 +503,8 @@ Files::Site.update(
 * `bundle_password_required` (boolean): Do Bundles require password protection?
 * `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
 * `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
+* `bundle_activity_notifications` (string): Do Bundle owners receive activity notifications?
+* `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
 * `password_requirements_apply_to_bundles` (boolean): Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
 * `opt_out_global` (boolean): Use servers in the USA only?
 * `use_provided_modified_at` (boolean): Allow uploaders to set `provided_modified_at` for uploaded files?

data/docs/user.md

@@ -63,7 +63,9 @@
   "time_zone": "Pacific Time (US & Canada)",
   "type_of_2fa": "yubi",
   "updated_at": "2000-01-01T01:00:00Z",
-  "user_root": "example"
+  "user_root": "example",
+  "days_remaining_until_password_expire": "2000-01-01T01:00:00Z",
+  "password_expire_at": "2000-01-01T01:00:00Z"
 }
 ```
 
@@ -125,6 +127,8 @@
 * `type_of_2fa` (string): Type(s) of 2FA methods in use.  Will be either `sms`, `totp`, `u2f`, `yubi`, or multiple values sorted alphabetically and joined by an underscore.
 * `updated_at` (date-time): User record most recently updated at.  Note this may be incremented because of internal or external updates.
 * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set.)  Note that this is not used for API, Desktop, or Web interface.
+* `days_remaining_until_password_expire` (date-time): Number of days remaining until password expires
+* `password_expire_at` (date-time): Password expiration datetime
 * `avatar_file` (file): An image file for your user avatar.
 * `avatar_delete` (boolean): If true, the avatar will be deleted.
 * `change_password` (string): Used for changing a password on an existing user.

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

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleNotification
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Bundle ID to notify on
+    def bundle_id
+      @attributes[:bundle_id]
+    end
+
+    def bundle_id=(value)
+      @attributes[:bundle_id] = value
+    end
+
+    # int64 - Bundle Notification ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # boolean - Triggers bundle notification when a registration action occurs for it.
+    def notify_on_registration
+      @attributes[:notify_on_registration]
+    end
+
+    def notify_on_registration=(value)
+      @attributes[:notify_on_registration] = value
+    end
+
+    # int64 - The id of the user to notify.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    def delete(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]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The BundleNotification object doesn't support updates.")
+      else
+        new_obj = BundleNotification.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   bundle_id - int64 - Bundle ID to notify on
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
+
+      List.new(BundleNotification, params) do
+        Api.send_request("/bundle_notifications", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Bundle Notification ID.
+    def self.find(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]}", :get, params, options)
+      BundleNotification.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # 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.
+    #   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)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: user_id") unless params[:user_id]
+      raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]
+
+      response, options = Api.send_request("/bundle_notifications", :post, params, options)
+      BundleNotification.new(response.data, options)
+    end
+
+    def self.delete(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]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -69,6 +69,11 @@ module Files
       @attributes[:ask_about_overwrites]
     end
 
+    # string - Do Bundle owners receive activity notifications?
+    def bundle_activity_notifications
+      @attributes[:bundle_activity_notifications]
+    end
+
     # int64 - Site-wide Bundle expiration in days
     def bundle_expiration
       @attributes[:bundle_expiration]
@@ -89,6 +94,11 @@ module Files
       @attributes[:bundle_require_share_recipient]
     end
 
+    # string - Do Bundle uploaders receive upload confirmation notifications?
+    def bundle_upload_receipt_notifications
+      @attributes[:bundle_upload_receipt_notifications]
+    end
+
     # Image - Preview watermark image applied to all bundle items.
     def bundle_watermark_attachment
       @attributes[:bundle_watermark_attachment]
@@ -771,6 +781,8 @@ module Files
     #   bundle_password_required - boolean - Do Bundles require password protection?
     #   bundle_require_share_recipient - boolean - Do Bundles require recipients for sharing?
     #   bundle_registration_notifications - string - Do Bundle owners receive registration notification?
+    #   bundle_activity_notifications - string - Do Bundle owners receive activity notifications?
+    #   bundle_upload_receipt_notifications - string - Do Bundle uploaders receive upload confirmation notifications?
     #   password_requirements_apply_to_bundles - boolean - Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
     #   opt_out_global - boolean - Use servers in the USA only?
     #   use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
@@ -868,6 +880,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: password_validity_days must be an Integer") if params[:password_validity_days] and !params[:password_validity_days].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: password_min_length must be an Integer") if params[:password_min_length] and !params[:password_min_length].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: bundle_registration_notifications must be an String") if params[:bundle_registration_notifications] and !params[:bundle_registration_notifications].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: bundle_activity_notifications must be an String") if params[:bundle_activity_notifications] and !params[:bundle_activity_notifications].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: bundle_upload_receipt_notifications must be an String") if params[:bundle_upload_receipt_notifications] and !params[:bundle_upload_receipt_notifications].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: disable_users_from_inactivity_period_days must be an Integer") if params[:disable_users_from_inactivity_period_days] and !params[:disable_users_from_inactivity_period_days].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: sftp_host_key_type must be an String") if params[:sftp_host_key_type] and !params[:sftp_host_key_type].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: active_sftp_host_key_id must be an Integer") if params[:active_sftp_host_key_id] and !params[:active_sftp_host_key_id].is_a?(Integer)

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

@@ -523,6 +523,24 @@ module Files
       @attributes[:user_root] = value
     end
 
+    # date-time - Number of days remaining until password expires
+    def days_remaining_until_password_expire
+      @attributes[:days_remaining_until_password_expire]
+    end
+
+    def days_remaining_until_password_expire=(value)
+      @attributes[:days_remaining_until_password_expire] = value
+    end
+
+    # date-time - Password expiration datetime
+    def password_expire_at
+      @attributes[:password_expire_at]
+    end
+
+    def password_expire_at=(value)
+      @attributes[:password_expire_at] = value
+    end
+
     # file - An image file for your user avatar.
     def avatar_file
       @attributes[:avatar_file]

data/lib/files.com.rb

@@ -49,6 +49,7 @@ require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
 require "files.com/models/bundle_download"
+require "files.com/models/bundle_notification"
 require "files.com/models/bundle_recipient"
 require "files.com/models/bundle_registration"
 require "files.com/models/clickwrap"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.309
+  version: 1.0.311
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -132,6 +132,7 @@ files:
 - docs/behavior.md
 - docs/bundle.md
 - docs/bundle_download.md
+- docs/bundle_notification.md
 - docs/bundle_recipient.md
 - docs/bundle_registration.md
 - docs/clickwrap.md
@@ -215,6 +216,7 @@ files:
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
 - lib/files.com/models/bundle_download.rb
+- lib/files.com/models/bundle_notification.rb
 - lib/files.com/models/bundle_recipient.rb
 - lib/files.com/models/bundle_registration.rb
 - lib/files.com/models/clickwrap.rb