files.com 1.1.253 → 1.1.255

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 599685d24a0efdef000171470a72cb7a97ba73c5ecec5888be4af169a45ebaf4
-  data.tar.gz: 67d7bc89ca063b74f42d7184d11ede38adf0a5dd5e6c06a6bbef1e7847e50c35
+  metadata.gz: fa8f23cf49e5643257139825e9eec2f879cd2df43f255e8e87e6b1f1992cb4b2
+  data.tar.gz: 50c942f98356099c42e311f3944b498698718343a6d73ce427cb1f8cc98b28bb
 SHA512:
-  metadata.gz: 1e633d0eb115bf2dfa48571bc7eca2377112ccc54dd2d0ec3d5184a7bdf091ad1e86501eedf9f15ed293e7f486e0434904de6ecd2dbcfaac517d542610fa62ee
-  data.tar.gz: 38a0f5bd7b2e1791c5b93fac9b7d3abda19c4021498c9014e06eab0c59c86e30ba6e0c2968a1b68e1d765fb4fb1867c1a70145d67d0f1a11c27b7786d32a234f
+  metadata.gz: e8dd2ce19aa031eb49ad5ccc9fd56a40da41506f2da6f9035aafe40445d91a0d8a3a8a00d3168d80b1d969c988409ecea69976343c4b25f64738aa1e1df14bd2
+  data.tar.gz: 02a8201e3d81f0365ec52b843834bf2db748cfe2633a8c84763a2d211d55290ef2e89be885092b634c79d8a96e924ce8cca48f3fbdb356cbcd61f7e84477b61f

data/_VERSION

@@ -1 +1 @@
-1.1.253
+1.1.255

data/docs/bundle_notification.md

@@ -17,6 +17,7 @@
 * `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.
 * `notify_user_id` (int64): The id of the user to notify.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 
 ---
@@ -24,11 +25,14 @@
 ## List Bundle Notifications
 
 ```
-Files::BundleNotification.list
+Files::BundleNotification.list(
+  user_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.  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.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
@@ -54,6 +58,7 @@ Files::BundleNotification.find(id)
 
 ```
 Files::BundleNotification.create(
+  user_id: 1, 
   bundle_id: 1, 
   notify_user_id: 1, 
   notify_on_registration: true, 
@@ -63,6 +68,7 @@ Files::BundleNotification.create(
 
 ### Parameters
 
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `bundle_id` (int64): Required - Bundle ID to notify on
 * `notify_user_id` (int64): The id of the user to notify.
 * `notify_on_registration` (boolean): Triggers bundle notification when a registration action occurs for it.

data/docs/bundle_recipient.md

@@ -17,6 +17,7 @@
 * `note` (string): A note sent to the recipient with the bundle.
 * `recipient` (string): The recipient's email address.
 * `sent_at` (date-time): When the Bundle was shared with this recipient.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `bundle_id` (int64): Bundle to share.
 * `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
 
@@ -27,12 +28,14 @@
 
 ```
 Files::BundleRecipient.list(
+  user_id: 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.  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.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
@@ -46,6 +49,7 @@ Files::BundleRecipient.list(
 
 ```
 Files::BundleRecipient.create(
+  user_id: 1, 
   bundle_id: 1, 
   recipient: "johndoe@gmail.com", 
   name: "John Smith", 
@@ -57,6 +61,7 @@ Files::BundleRecipient.create(
 
 ### Parameters
 
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `bundle_id` (int64): Required - Bundle to share.
 * `recipient` (string): Required - Email addresses to share this bundle with.
 * `name` (string): Name of recipient.

data/docs/user_lifecycle_rule.md

@@ -0,0 +1,100 @@
+# UserLifecycleRule
+
+## Example UserLifecycleRule Object
+
+```
+{
+  "id": 1,
+  "authentication_method": "password",
+  "inactivity_days": 12,
+  "include_folder_admins": true,
+  "include_site_admins": true,
+  "action": "disable",
+  "site_id": 1
+}
+```
+
+* `id` (int64): User Lifecycle Rule ID
+* `authentication_method` (string): User authentication method for the rule
+* `inactivity_days` (int64): Number of days of inactivity before the rule applies
+* `include_folder_admins` (boolean): Include folder admins in the rule
+* `include_site_admins` (boolean): Include site admins in the rule
+* `action` (string): Action to take on inactive users (disable or delete)
+* `site_id` (int64): Site ID
+
+
+---
+
+## List User Lifecycle Rules
+
+```
+Files::UserLifecycleRule.list
+```
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+
+---
+
+## Show User Lifecycle Rule
+
+```
+Files::UserLifecycleRule.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.
+
+
+---
+
+## Create User Lifecycle Rule
+
+```
+Files::UserLifecycleRule.create(
+  authentication_method: "password", 
+  inactivity_days: 12, 
+  include_site_admins: true, 
+  include_folder_admins: true
+)
+```
+
+### Parameters
+
+* `action` (string): Required - Action to take on inactive users (disable or delete)
+* `authentication_method` (string): Required - User authentication method for the rule
+* `inactivity_days` (int64): Required - Number of days of inactivity before the rule applies
+* `include_site_admins` (boolean): Include site admins in the rule
+* `include_folder_admins` (boolean): Include folder admins in the rule
+
+
+---
+
+## Delete User Lifecycle Rule
+
+```
+Files::UserLifecycleRule.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.
+
+
+---
+
+## Delete User Lifecycle Rule
+
+```
+user_lifecycle_rule = Files::UserLifecycleRule.find(id)
+
+user_lifecycle_rule.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.

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

@@ -54,6 +54,15 @@ module Files
       @attributes[:notify_user_id] = value
     end
 
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @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.
@@ -94,11 +103,13 @@ module Files
     end
 
     # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   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.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
     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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
@@ -130,11 +141,13 @@ module Files
     end
 
     # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   bundle_id (required) - int64 - Bundle ID to notify on
     #   notify_user_id - 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.
     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 InvalidParameterError.new("Bad parameter: notify_user_id must be an Integer") if params[:notify_user_id] and !params[:notify_user_id].is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: bundle_id") unless params[:bundle_id]

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

@@ -54,6 +54,15 @@ module Files
       @attributes[:sent_at] = value
     end
 
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
     # int64 - Bundle to share.
     def bundle_id
       @attributes[:bundle_id]
@@ -84,12 +93,14 @@ module Files
     end
 
     # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   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.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
     #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
     #   bundle_id (required) - int64 - List recipients for the bundle with this ID.
     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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
@@ -107,6 +118,7 @@ module Files
     end
 
     # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   bundle_id (required) - int64 - Bundle to share.
     #   recipient (required) - string - Email addresses to share this bundle with.
     #   name - string - Name of recipient.
@@ -114,6 +126,7 @@ module Files
     #   note - string - Note to include in email.
     #   share_after_create - boolean - Set to true to share the link with the recipient upon creation.
     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 InvalidParameterError.new("Bad parameter: recipient must be an String") if params[:recipient] and !params[:recipient].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Files
+  class UserLifecycleRule
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - User Lifecycle Rule ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - User authentication method for the rule
+    def authentication_method
+      @attributes[:authentication_method]
+    end
+
+    def authentication_method=(value)
+      @attributes[:authentication_method] = value
+    end
+
+    # int64 - Number of days of inactivity before the rule applies
+    def inactivity_days
+      @attributes[:inactivity_days]
+    end
+
+    def inactivity_days=(value)
+      @attributes[:inactivity_days] = value
+    end
+
+    # boolean - Include folder admins in the rule
+    def include_folder_admins
+      @attributes[:include_folder_admins]
+    end
+
+    def include_folder_admins=(value)
+      @attributes[:include_folder_admins] = value
+    end
+
+    # boolean - Include site admins in the rule
+    def include_site_admins
+      @attributes[:include_site_admins]
+    end
+
+    def include_site_admins=(value)
+      @attributes[:include_site_admins] = value
+    end
+
+    # string - Action to take on inactive users (disable or delete)
+    def action
+      @attributes[:action]
+    end
+
+    def action=(value)
+      @attributes[:action] = value
+    end
+
+    # int64 - Site ID
+    def site_id
+      @attributes[:site_id]
+    end
+
+    def site_id=(value)
+      @attributes[:site_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("/user_lifecycle_rules/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+      nil
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The UserLifecycleRule object doesn't support updates.")
+      else
+        new_obj = UserLifecycleRule.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    def self.list(params = {}, options = {})
+      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)
+
+      List.new(UserLifecycleRule, params) do
+        Api.send_request("/user_lifecycle_rules", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - User Lifecycle Rule 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("/user_lifecycle_rules/#{params[:id]}", :get, params, options)
+      UserLifecycleRule.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   action (required) - string - Action to take on inactive users (disable or delete)
+    #   authentication_method (required) - string - User authentication method for the rule
+    #   inactivity_days (required) - int64 - Number of days of inactivity before the rule applies
+    #   include_site_admins - boolean - Include site admins in the rule
+    #   include_folder_admins - boolean - Include folder admins in the rule
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: authentication_method must be an String") if params[:authentication_method] and !params[:authentication_method].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: inactivity_days must be an Integer") if params[:inactivity_days] and !params[:inactivity_days].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: action") unless params[:action]
+      raise MissingParameterError.new("Parameter missing: authentication_method") unless params[:authentication_method]
+      raise MissingParameterError.new("Parameter missing: inactivity_days") unless params[:inactivity_days]
+
+      response, options = Api.send_request("/user_lifecycle_rules", :post, params, options)
+      UserLifecycleRule.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]
+
+      Api.send_request("/user_lifecycle_rules/#{params[:id]}", :delete, params, options)
+      nil
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+      nil
+    end
+  end
+end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.253"
+  VERSION = "1.1.255"
 end

data/lib/files.com.rb

@@ -126,6 +126,7 @@ require "files.com/models/usage_daily_snapshot"
 require "files.com/models/usage_snapshot"
 require "files.com/models/user"
 require "files.com/models/user_cipher_use"
+require "files.com/models/user_lifecycle_rule"
 require "files.com/models/user_request"
 require "files.com/models/user_sftp_client_use"
 require "files.com/models/web_dav_action_log"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.253
+  version: 1.1.255
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-08 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -209,6 +209,7 @@ files:
 - docs/usage_snapshot.md
 - docs/user.md
 - docs/user_cipher_use.md
+- docs/user_lifecycle_rule.md
 - docs/user_request.md
 - docs/user_sftp_client_use.md
 - docs/web_dav_action_log.md
@@ -315,6 +316,7 @@ files:
 - lib/files.com/models/usage_snapshot.rb
 - lib/files.com/models/user.rb
 - lib/files.com/models/user_cipher_use.rb
+- lib/files.com/models/user_lifecycle_rule.rb
 - lib/files.com/models/user_request.rb
 - lib/files.com/models/user_sftp_client_use.rb
 - lib/files.com/models/web_dav_action_log.rb