files.com 1.1.424 → 1.1.425

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff9d0dbdb2cc77f3938548947015dc1a0820ace5e1fd64ed942ef92d596fced0
-  data.tar.gz: 000fd90843fdc3851939b7f7d94045a63de5d344b0a4bafbaacac32486ac4f73
+  metadata.gz: f1aa899b3ef24b3c97cda33710444c22587f077d9405bc428895fc4011525e09
+  data.tar.gz: ef47dd4fe033230135af5732e71b28901127ca63787b33185c9052daf82c9dac
 SHA512:
-  metadata.gz: 8a43f0f3835317077b3e46c45e9b382419cfc36360f5a45e75775549f412b02251266a9abdd9f0ba5ee6e67c1131268b9ba8505162ae7e6e57ee5c78dc756955
-  data.tar.gz: 95b20aecdb8d5a2f052487383fe344baca255f6e3fc760d1155f8b0b57327d0a92544bbf444624da49f85f08ab07ef1d02f9405e4928881303bdbe7c03a55d86
+  metadata.gz: 814c0379ba803494be7207df2e2efd19dd28849b22392434682cf10832431f874deb674ec28f643a31b7d9409b5bd03a810731d61c03f94627a4140bbe499019
+  data.tar.gz: 97dd1347352397df2f132456b73a2909d4f29b75a9af2b45ef957d58cf0ecc675e721bde1139f191d99e311ddf01dd49793a5c59ea169e19477d3e1ffa463d25

data/_VERSION

@@ -1 +1 @@
-1.1.424
+1.1.425

data/docs/key_lifecycle_rule.md

@@ -0,0 +1,134 @@
+# KeyLifecycleRule
+
+## Example KeyLifecycleRule Object
+
+```
+{
+  "id": 1,
+  "key_type": "gpg",
+  "inactivity_days": 12,
+  "name": "inactive gpg keys"
+}
+```
+
+* `id` (int64): Key Lifecycle Rule ID
+* `key_type` (string): Key type for which the rule will apply (gpg or ssh).
+* `inactivity_days` (int64): Number of days of inactivity before the rule applies.
+* `name` (string): Key Lifecycle Rule name
+
+
+---
+
+## List Key Lifecycle Rules
+
+```
+Files::KeyLifecycleRule.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).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+
+
+---
+
+## Show Key Lifecycle Rule
+
+```
+Files::KeyLifecycleRule.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Key Lifecycle Rule ID.
+
+
+---
+
+## Create Key Lifecycle Rule
+
+```
+Files::KeyLifecycleRule.create(
+  key_type: "gpg", 
+  inactivity_days: 12, 
+  name: "inactive gpg keys"
+)
+```
+
+### Parameters
+
+* `key_type` (string): Key type for which the rule will apply (gpg or ssh).
+* `inactivity_days` (int64): Number of days of inactivity before the rule applies.
+* `name` (string): Key Lifecycle Rule name
+
+
+---
+
+## Update Key Lifecycle Rule
+
+```
+Files::KeyLifecycleRule.update(id, 
+  key_type: "gpg", 
+  inactivity_days: 12, 
+  name: "inactive gpg keys"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Key Lifecycle Rule ID.
+* `key_type` (string): Key type for which the rule will apply (gpg or ssh).
+* `inactivity_days` (int64): Number of days of inactivity before the rule applies.
+* `name` (string): Key Lifecycle Rule name
+
+
+---
+
+## Delete Key Lifecycle Rule
+
+```
+Files::KeyLifecycleRule.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Key Lifecycle Rule ID.
+
+
+---
+
+## Update Key Lifecycle Rule
+
+```
+key_lifecycle_rule = Files::KeyLifecycleRule.find(id)
+
+key_lifecycle_rule.update(
+  key_type: "gpg",
+  inactivity_days: 12,
+  name: "inactive gpg keys"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Key Lifecycle Rule ID.
+* `key_type` (string): Key type for which the rule will apply (gpg or ssh).
+* `inactivity_days` (int64): Number of days of inactivity before the rule applies.
+* `name` (string): Key Lifecycle Rule name
+
+
+---
+
+## Delete Key Lifecycle Rule
+
+```
+key_lifecycle_rule = Files::KeyLifecycleRule.find(id)
+
+key_lifecycle_rule.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Key Lifecycle Rule ID.

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

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Files
+  class KeyLifecycleRule
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Key Lifecycle Rule ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Key type for which the rule will apply (gpg or ssh).
+    def key_type
+      @attributes[:key_type]
+    end
+
+    def key_type=(value)
+      @attributes[:key_type] = 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
+
+    # string - Key Lifecycle Rule name
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # Parameters:
+    #   key_type - string - Key type for which the rule will apply (gpg or ssh).
+    #   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+    #   name - string - Key Lifecycle Rule name
+    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: key_type must be an String") if params[:key_type] and !params[:key_type].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 InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/key_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("/key_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 = KeyLifecycleRule.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).
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
+    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)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+
+      List.new(KeyLifecycleRule, params) do
+        Api.send_request("/key_lifecycle_rules", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Key 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("/key_lifecycle_rules/#{params[:id]}", :get, params, options)
+      KeyLifecycleRule.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   key_type - string - Key type for which the rule will apply (gpg or ssh).
+    #   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+    #   name - string - Key Lifecycle Rule name
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: key_type must be an String") if params[:key_type] and !params[:key_type].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 InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+
+      response, options = Api.send_request("/key_lifecycle_rules", :post, params, options)
+      KeyLifecycleRule.new(response.data, options)
+    end
+
+    # Parameters:
+    #   key_type - string - Key type for which the rule will apply (gpg or ssh).
+    #   inactivity_days - int64 - Number of days of inactivity before the rule applies.
+    #   name - string - Key Lifecycle Rule name
+    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: key_type must be an String") if params[:key_type] and !params[:key_type].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 InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/key_lifecycle_rules/#{params[:id]}", :patch, params, options)
+      KeyLifecycleRule.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("/key_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.424"
+  VERSION = "1.1.425"
 end

data/lib/files.com.rb

@@ -91,6 +91,7 @@ require "files.com/models/inbox_upload"
 require "files.com/models/invoice"
 require "files.com/models/invoice_line_item"
 require "files.com/models/ip_address"
+require "files.com/models/key_lifecycle_rule"
 require "files.com/models/lock"
 require "files.com/models/message"
 require "files.com/models/message_comment"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.424
+  version: 1.1.425
 platform: ruby
 authors:
 - files.com
@@ -216,6 +216,7 @@ files:
 - docs/invoice.md
 - docs/invoice_line_item.md
 - docs/ip_address.md
+- docs/key_lifecycle_rule.md
 - docs/lock.md
 - docs/message.md
 - docs/message_comment.md
@@ -333,6 +334,7 @@ files:
 - lib/files.com/models/invoice.rb
 - lib/files.com/models/invoice_line_item.rb
 - lib/files.com/models/ip_address.rb
+- lib/files.com/models/key_lifecycle_rule.rb
 - lib/files.com/models/lock.rb
 - lib/files.com/models/message.rb
 - lib/files.com/models/message_comment.rb