files.com 1.0.292 → 1.0.294

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8115c2369358407694bf69bca0a2a8235797b593cbc1952ea7fec64b4e0e2f1
-  data.tar.gz: 2f4e46a2a6f46d50463e654bfe5ed53b7c1f28e09d096d02a9519e71b3e2ca15
+  metadata.gz: cdaf110d3bd4999c4190b8ce6994037a0f12d7591b50f611b2059962f8591b04
+  data.tar.gz: 19bd25c8c5693b35ea942252128e1badb0f2bd9ce47265d6ff129e88213c38eb
 SHA512:
-  metadata.gz: ba9f975eac2087a1eaa58f4d428ea6d103e7b47f6d9d0e353973517330cdc4f3d2fb85a45818521c03e0e7ece2844ad9cdbb2ebc005225cce4f490d0b75b5ee3
-  data.tar.gz: 4e6ad9e2a68971eef9bd6dfe7455f2d8db35f46c74ac68d52c1e4cbae486948aec44c2b6a8421f12661343ed2f708fa4b817d98a918037a68940d10969d4e559
+  metadata.gz: 220ecfe32113cb98ff6f74a9a6953585da1e90434b79396bc071f970a48b56f3ae344dcc1570bc9aeef3dd2cdd917b834c912310b078633af397c76c50eec39d
+  data.tar.gz: e6597bb77b9b7894f101e92074d1f38900706637c73a0b90d78af9252ce2efb4a4160746585a0bfafa6d1212a6fd8ba35de5025ffccd63141200a2c94932c362

data/_VERSION

@@ -1 +1 @@
-1.0.292
+1.0.294

data/docs/sftp_host_key.md

@@ -0,0 +1,130 @@
+# SftpHostKey
+
+## Example SftpHostKey Object
+
+```
+{
+  "id": 1,
+  "name": "",
+  "fingerprint_md5": "",
+  "fingerprint_sha256": ""
+}
+```
+
+* `id` (int64): Sftp Host Key ID
+* `name` (string): The friendly name of this SFTP Host Key.
+* `fingerprint_md5` (string): MD5 Fingerpint of the public key
+* `fingerprint_sha256` (string): SHA256 Fingerpint of the public key
+* `private_key` (string): The private key data.
+
+
+---
+
+## List Sftp Host Keys
+
+```
+Files::SftpHostKey.list(
+  per_page: 1
+)
+```
+
+### 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).
+
+
+---
+
+## Show Sftp Host Key
+
+```
+Files::SftpHostKey.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sftp Host Key ID.
+
+
+---
+
+## Create Sftp Host Key
+
+```
+Files::SftpHostKey.create(
+  name: "", 
+  private_key: ""
+)
+```
+
+### Parameters
+
+* `name` (string): The friendly name of this SFTP Host Key.
+* `private_key` (string): The private key data.
+
+
+---
+
+## Update Sftp Host Key
+
+```
+Files::SftpHostKey.update(id, 
+  name: "", 
+  private_key: ""
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sftp Host Key ID.
+* `name` (string): The friendly name of this SFTP Host Key.
+* `private_key` (string): The private key data.
+
+
+---
+
+## Delete Sftp Host Key
+
+```
+Files::SftpHostKey.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sftp Host Key ID.
+
+
+---
+
+## Update Sftp Host Key
+
+```
+sftp_host_key = Files::SftpHostKey.list.first
+
+sftp_host_key.update(
+  name: "",
+  private_key: ""
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Sftp Host Key ID.
+* `name` (string): The friendly name of this SFTP Host Key.
+* `private_key` (string): The private key data.
+
+
+---
+
+## Delete Sftp Host Key
+
+```
+sftp_host_key = Files::SftpHostKey.list.first
+
+sftp_host_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Sftp Host Key ID.

data/lib/files.com/errors.rb

@@ -53,6 +53,7 @@ module Files
   class FolderMustNotBeAFileError < BadRequestError; end
   class InvalidBodyError < BadRequestError; end
   class InvalidCursorError < BadRequestError; end
+  class InvalidCursorTypeForSortError < BadRequestError; end
   class InvalidEtagsError < BadRequestError; end
   class InvalidFilterCombinationError < BadRequestError; end
   class InvalidFilterFieldError < BadRequestError; end

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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Files
+  class SftpHostKey
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Sftp Host Key ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - The friendly name of this SFTP Host Key.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - MD5 Fingerpint of the public key
+    def fingerprint_md5
+      @attributes[:fingerprint_md5]
+    end
+
+    def fingerprint_md5=(value)
+      @attributes[:fingerprint_md5] = value
+    end
+
+    # string - SHA256 Fingerpint of the public key
+    def fingerprint_sha256
+      @attributes[:fingerprint_sha256]
+    end
+
+    def fingerprint_sha256=(value)
+      @attributes[:fingerprint_sha256] = value
+    end
+
+    # string - The private key data.
+    def private_key
+      @attributes[:private_key]
+    end
+
+    def private_key=(value)
+      @attributes[:private_key] = value
+    end
+
+    # Parameters:
+    #   name - string - The friendly name of this SFTP Host Key.
+    #   private_key - string - The private key data.
+    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: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/sftp_host_keys/#{@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("/sftp_host_keys/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = SftpHostKey.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    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).
+    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(SftpHostKey, params) do
+        Api.send_request("/sftp_host_keys", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Sftp Host Key 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("/sftp_host_keys/#{params[:id]}", :get, params, options)
+      SftpHostKey.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name - string - The friendly name of this SFTP Host Key.
+    #   private_key - string - The private key data.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
+
+      response, options = Api.send_request("/sftp_host_keys", :post, params, options)
+      SftpHostKey.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - The friendly name of this SFTP Host Key.
+    #   private_key - string - The private key data.
+    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: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: private_key must be an String") if params[:private_key] and !params[:private_key].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/sftp_host_keys/#{params[:id]}", :patch, params, options)
+      SftpHostKey.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("/sftp_host_keys/#{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.rb

@@ -95,6 +95,7 @@ require "files.com/models/remote_server"
 require "files.com/models/request"
 require "files.com/models/session"
 require "files.com/models/settings_change"
+require "files.com/models/sftp_host_key"
 require "files.com/models/site"
 require "files.com/models/sso_strategy"
 require "files.com/models/status"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.292
+  version: 1.0.294
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -179,6 +179,7 @@ files:
 - docs/request.md
 - docs/session.md
 - docs/settings_change.md
+- docs/sftp_host_key.md
 - docs/site.md
 - docs/sso_strategy.md
 - docs/status.md
@@ -261,6 +262,7 @@ files:
 - lib/files.com/models/request.rb
 - lib/files.com/models/session.rb
 - lib/files.com/models/settings_change.rb
+- lib/files.com/models/sftp_host_key.rb
 - lib/files.com/models/site.rb
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb