files.com 1.1.254 → 1.1.256

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3974055c632b326ea859daaf03104aa9b6d227771e50bf66e2a95c61e4dadb93
-  data.tar.gz: acd9ec08e008f20cb50975aa1998a1aa25e778f15c3df61935d591c2ad9422e9
+  metadata.gz: 93026386c22bffe0c652b27d9bc0a69afff00876c210d65706ff30f1da69ba1c
+  data.tar.gz: 78a166a01106d098d6a0131aa9e85c7751bbac0447f1cd2316f019958300ae86
 SHA512:
-  metadata.gz: 78288326d35c1f0236daaa107b1d020780122d0434b6fb487fc789720d0a90ae38911811b8f406da0dd34faf9763749dfa8ff950115e00d80402538da47f2776
-  data.tar.gz: 5100483123b00f4abade43f0dce6eb58955596f9ced5b33c0e2f7ee2c281fe1d1c4c7262320eb403bfba2ff98f54e4a49d2c94c46b01ec033626b366b3acbe44
+  metadata.gz: 75ffc5d9dd5bda8c2f3b20ebe33022c48c3222071e22d8b8891cb361f86b33523a0062c74f3458f3b3f15efdedc03f8c76c4feeb869a0e147cc82f42804b4cf7
+  data.tar.gz: aa2837e605b7dfd84a3b4eacc708e6f267b5c18fbf12b2248598ff8e7d4998b52231912b3cd32d8ade5ee8281c95a305f526f7afa1ef995663aa79d131e6de43

data/_VERSION

@@ -1 +1 @@
-1.1.254
+1.1.256

data/docs/user_lifecycle_rule.md

@@ -0,0 +1,148 @@
+# 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
+
+
+---
+
+## Update User Lifecycle Rule
+
+```
+Files::UserLifecycleRule.update(id, 
+  authentication_method: "password", 
+  inactivity_days: 12, 
+  include_site_admins: true, 
+  include_folder_admins: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.
+* `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.
+
+
+---
+
+## Update User Lifecycle Rule
+
+```
+user_lifecycle_rule = Files::UserLifecycleRule.find(id)
+
+user_lifecycle_rule.update(
+  authentication_method: "password",
+  inactivity_days: 12,
+  include_site_admins: true,
+  include_folder_admins: true
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.
+* `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
+
+```
+user_lifecycle_rule = Files::UserLifecycleRule.find(id)
+
+user_lifecycle_rule.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - User Lifecycle Rule ID.

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

@@ -0,0 +1,210 @@
+# 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
+
+    # 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 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 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: id") unless params[:id]
+      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]
+
+      Api.send_request("/user_lifecycle_rules/#{@attributes[:id]}", :patch, params, @options)
+    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]
+        new_obj = update(@attributes)
+      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
+
+    # 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.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 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: id") unless params[:id]
+      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/#{params[:id]}", :patch, 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.254"
+  VERSION = "1.1.256"
 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.254
+  version: 1.1.256
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-05-16 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