files.com 1.0.293 → 1.0.295

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7c1894e3c11ea836975ed21710a96b519e20d8ea2b3436afe55a86d66282dd
-  data.tar.gz: e05de7df9599f5d25e8a840a334ca3b1e85ab6099087432eceeb8b5e542d2eb5
+  metadata.gz: 82443d7ca9d90f9c75a2ffbec984dc28f875d9b2017d1ef4678da0bb53b31dfc
+  data.tar.gz: fcff7ee54c6248b30113e496d7a3d0216b39172d7d6b54bfcc1f5ce54d388e3b
 SHA512:
-  metadata.gz: c110a200edd32818fff150b93c38ef909cedd46425ec60130e4a8051457cbfe47d4306e87830f255274920bf7a85f498099f7dfcdf7a1e92ddd5c8f8ed77fbc6
-  data.tar.gz: b944c8e5639997f124b64e043eb79ba0d4e0d3369465e3eff44f19b4b9ada244b1d1f776efe01afbb735b15f5b4109ff555f4272779bb9773b11dc197f4d468b
+  metadata.gz: 914a9e15f726f4459e6ed2c353cdad5ce893aa4ad689d6d4fa303bf0e9cd7c00e43222f13d11540de3542a848193e208e85c2d4810c8f3eb81fc3f367b7d147b
+  data.tar.gz: 345a767395649169913f54f6cab4ada5e0118c085da8986181dba594c28e12f18f0fc97f3a4dd14f4ccb89190d5241399b3a633746919ede7ae283e8fbdfa973

data/_VERSION

@@ -1 +1 @@
-1.0.293
+1.0.295

data/docs/api_key.md

@@ -6,6 +6,7 @@
 {
   "id": 1,
   "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
+  "description": "",
   "created_at": "2000-01-01T01:00:00Z",
   "expires_at": "2000-01-01T01:00:00Z",
   "key": "[key]",
@@ -20,6 +21,7 @@
 
 * `id` (int64): API Key ID
 * `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
+* `description` (string): User-supplied description of API key.
 * `created_at` (date-time): Time which API Key was created
 * `expires_at` (date-time): API Key expiration date
 * `key` (string): API Key actual key string
@@ -96,6 +98,7 @@ Files::ApiKey.create(
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `name` (string): Internal name for the API Key.  For your use.
+* `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `path` (string): Folder path restriction for this api key.
@@ -136,6 +139,7 @@ Files::ApiKey.update(id,
 
 * `id` (int64): Required - Api Key ID.
 * `name` (string): Internal name for the API Key.  For your use.
+* `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
@@ -180,6 +184,7 @@ api_key.update(
 
 * `id` (int64): Required - Api Key ID.
 * `name` (string): Internal name for the API Key.  For your use.
+* `description` (string): User-supplied description of API key.
 * `expires_at` (string): API Key expiration date
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 

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/models/api_key.rb

@@ -27,6 +27,15 @@ module Files
       @attributes[:descriptive_label] = value
     end
 
+    # string - User-supplied description of API key.
+    def description
+      @attributes[:description]
+    end
+
+    def description=(value)
+      @attributes[:description] = value
+    end
+
     # date-time - Time which API Key was created
     def created_at
       @attributes[:created_at]
@@ -106,6 +115,7 @@ module Files
 
     # Parameters:
     #   name - string - Internal name for the API Key.  For your use.
+    #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
     #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def update(params = {})
@@ -114,6 +124,7 @@ module Files
       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: description must be an String") if params[:description] and !params[:description].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
@@ -200,12 +211,14 @@ module Files
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   name - string - Internal name for the API Key.  For your use.
+    #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
     #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     #   path - string - Folder path restriction for this api key.
     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: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: description must be an String") if params[:description] and !params[:description].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
@@ -229,6 +242,7 @@ module Files
 
     # Parameters:
     #   name - string - Internal name for the API Key.  For your use.
+    #   description - string - User-supplied description of API key.
     #   expires_at - string - API Key expiration date
     #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def self.update(id, params = {}, options = {})
@@ -236,6 +250,7 @@ module Files
       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: description must be an String") if params[:description] and !params[:description].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params[:permission_set] and !params[:permission_set].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]

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.293
+  version: 1.0.295
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-09-22 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