files.com 1.0.380 → 1.0.382

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90e0393954a3bdb486f0ba7137424bc6c4b765ffc609917fcd9584fc8cb72bf4
-  data.tar.gz: a6ecf4ece2af1a6ccd5c68e5eba506bbefe082c7e897875d8385115d80ec59ab
+  metadata.gz: b73b08e6d2cb006f35c66b507a340cabd3f2796b9183110d28ca788419cfab02
+  data.tar.gz: f00bf2b25e1d8a9f330424bfec1412b48a6f97117818815f852564987cbdcff2
 SHA512:
-  metadata.gz: 2a3f8cab57f8118edcbbee8f54bd7de003f84b90c2073f0f498eac5ba5f89838681a316e572e6682989b5d88f21fa189ee2c8887ac23d8c4262da37c359a7c8b
-  data.tar.gz: 563986d4c35a3be59409f916da88b25a2384400248c1fc23f56f59befc82453a91d82c06713e39c10a421ca5908cbc65d3482d04fa4f1d3ea2b2584e4ce8b13d
+  metadata.gz: a41ae7bf61fdd4b386de5bb12b5afff7f8104af64afc49551e9cd9e8cecb462756c922ec149bf4599061b8494a97cb5ac567d30e238663f8449932a0a94fe13e
+  data.tar.gz: 873f2993d9509e36893732af68788e273ca485e5e81e9fdbe9378273817a74ac10def73160a79c44224ee185b6703228182b0620e692028393ccdb052b31da7d

data/_VERSION

@@ -1 +1 @@
-1.0.380
+1.0.382

data/docs/gpg_key.md

@@ -0,0 +1,151 @@
+# GpgKey
+
+## Example GpgKey Object
+
+```
+{
+  "id": 1,
+  "expires_at": "2000-01-01T01:00:00Z",
+  "name": "key name",
+  "user_id": 1,
+  "public_key": "7f8bc1210b09b9ddf469e6b6b8920e76",
+  "private_key": "ab236cfe4a195f0226bc2e674afdd6b0",
+  "private_key_password": "[your GPG private key password]"
+}
+```
+
+* `id` (int64): Your GPG key ID.
+* `expires_at` (date-time): Your GPG key expiration date.
+* `name` (string): Your GPG key name.
+* `user_id` (int64): GPG owner's user id
+* `public_key` (string): Your GPG public key
+* `private_key` (string): Your GPG private key.
+* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
+
+
+---
+
+## List Gpg Keys
+
+```
+Files::GpgKey.list(
+  user_id: 1, 
+  per_page: 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).
+
+
+---
+
+## Show Gpg Key
+
+```
+Files::GpgKey.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Gpg Key ID.
+
+
+---
+
+## Create Gpg Key
+
+```
+Files::GpgKey.create(
+  user_id: 1, 
+  name: "key name", 
+  public_key: "7f8bc1210b09b9ddf469e6b6b8920e76", 
+  private_key: "ab236cfe4a195f0226bc2e674afdd6b0", 
+  private_key_password: "[your GPG private key password]"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `name` (string): Required - Your GPG key name.
+* `public_key` (string): Your GPG public key
+* `private_key` (string): Your GPG private key.
+* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
+
+
+---
+
+## Update Gpg Key
+
+```
+Files::GpgKey.update(id, 
+  name: "key name", 
+  public_key: "7f8bc1210b09b9ddf469e6b6b8920e76", 
+  private_key: "ab236cfe4a195f0226bc2e674afdd6b0", 
+  private_key_password: "[your GPG private key password]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Gpg Key ID.
+* `name` (string): Required - Your GPG key name.
+* `public_key` (string): Your GPG public key
+* `private_key` (string): Your GPG private key.
+* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
+
+
+---
+
+## Delete Gpg Key
+
+```
+Files::GpgKey.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Gpg Key ID.
+
+
+---
+
+## Update Gpg Key
+
+```
+gpg_key = Files::GpgKey.list.first
+
+gpg_key.update(
+  name: "key name",
+  public_key: "7f8bc1210b09b9ddf469e6b6b8920e76",
+  private_key: "ab236cfe4a195f0226bc2e674afdd6b0",
+  private_key_password: "[your GPG private key password]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Gpg Key ID.
+* `name` (string): Required - Your GPG key name.
+* `public_key` (string): Your GPG public key
+* `private_key` (string): Your GPG private key.
+* `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
+
+
+---
+
+## Delete Gpg Key
+
+```
+gpg_key = Files::GpgKey.list.first
+
+gpg_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Gpg Key ID.

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

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module Files
+  class GpgKey
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Your GPG key ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # date-time - Your GPG key expiration date.
+    def expires_at
+      @attributes[:expires_at]
+    end
+
+    def expires_at=(value)
+      @attributes[:expires_at] = value
+    end
+
+    # string - Your GPG key name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # int64 - GPG owner's user id
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # string - Your GPG public key
+    def public_key
+      @attributes[:public_key]
+    end
+
+    def public_key=(value)
+      @attributes[:public_key] = value
+    end
+
+    # string - Your GPG private key.
+    def private_key
+      @attributes[:private_key]
+    end
+
+    def private_key=(value)
+      @attributes[:private_key] = value
+    end
+
+    # string - Your GPG private key password. Only required for password protected keys.
+    def private_key_password
+      @attributes[:private_key_password]
+    end
+
+    def private_key_password=(value)
+      @attributes[:private_key_password] = value
+    end
+
+    # Parameters:
+    #   name (required) - string - Your GPG key name.
+    #   public_key - string - Your GPG public key
+    #   private_key - string - Your GPG private key.
+    #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
+    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: public_key must be an String") if params[:public_key] and !params[:public_key].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 InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+
+      Api.send_request("/gpg_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("/gpg_keys/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = GpgKey.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    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).
+    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)
+
+      List.new(GpgKey, params) do
+        Api.send_request("/gpg_keys", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Gpg 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("/gpg_keys/#{params[:id]}", :get, params, options)
+      GpgKey.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   name (required) - string - Your GPG key name.
+    #   public_key - string - Your GPG public key
+    #   private_key - string - Your GPG private key.
+    #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
+    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: public_key must be an String") if params[:public_key] and !params[:public_key].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 InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+
+      response, options = Api.send_request("/gpg_keys", :post, params, options)
+      GpgKey.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name (required) - string - Your GPG key name.
+    #   public_key - string - Your GPG public key
+    #   private_key - string - Your GPG private key.
+    #   private_key_password - string - Your GPG private key password. Only required for password protected keys.
+    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: public_key must be an String") if params[:public_key] and !params[:public_key].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 InvalidParameterError.new("Bad parameter: private_key_password must be an String") if params[:private_key_password] and !params[:private_key_password].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+
+      response, options = Api.send_request("/gpg_keys/#{params[:id]}", :patch, params, options)
+      GpgKey.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("/gpg_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/version.rb

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

data/lib/files.com.rb

@@ -67,6 +67,7 @@ require "files.com/models/file_upload_part"
 require "files.com/models/folder"
 require "files.com/models/form_field"
 require "files.com/models/form_field_set"
+require "files.com/models/gpg_key"
 require "files.com/models/group"
 require "files.com/models/group_user"
 require "files.com/models/history"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.380
+  version: 1.0.382
 platform: ruby
 authors:
 - files.com
@@ -150,6 +150,7 @@ files:
 - docs/folder.md
 - docs/form_field.md
 - docs/form_field_set.md
+- docs/gpg_key.md
 - docs/group.md
 - docs/group_user.md
 - docs/history.md
@@ -239,6 +240,7 @@ files:
 - lib/files.com/models/folder.rb
 - lib/files.com/models/form_field.rb
 - lib/files.com/models/form_field_set.rb
+- lib/files.com/models/gpg_key.rb
 - lib/files.com/models/group.rb
 - lib/files.com/models/group_user.rb
 - lib/files.com/models/history.rb