files.com 1.1.650 → 1.1.651

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7dde18d343e9bf8a8538ccfb34491976a3db43de79ce6589d686767c75316bd
-  data.tar.gz: 7d82c5763649255e9817bca9f5c06a6936615ab76e2dd3e160b2d86ece0f61a5
+  metadata.gz: 8564cc68092dabc88ac19623420dda160c04d5647b1ec5d9410fa317ce64057a
+  data.tar.gz: 2cc0bbfa760bbccdf14d4aee45da8f3d2ed2c653387400f5b1f82bbedea0c501
 SHA512:
-  metadata.gz: b83595592c9e9e3ac15367209f141970cd60c28a6c7dd78756a82adb027e70e2b026aadaf0c66398c9a82be5b4ab31c5479447496e129b0eb5ec76449caec23a
-  data.tar.gz: 3350a714101aa458812fd311a8899040484d16b2d4393cfce4cd445230e87866a783e37cc0f945d288e72fcbc37d278d7a879834c2b34e6e47f4ade1f1a3d1f3
+  metadata.gz: 036bbd87171d4d8c1a52fa11c8ce13396090a675ea5388e2732057ee018d7ecd045643f68d8b1396e10269a41b33a29a5a43c3722a817312f451c32f1ace7972
+  data.tar.gz: 4e663811a724db8d42b2fb095421873f82aa0e76c63e05c6220835ea8cca784cbf18c10ee2cf29f50a0f054e389ff4f9de3fa292c475751e5949aa2315acff0a

data/_VERSION

@@ -1 +1 @@
-1.1.650
+1.1.651

data/docs/file.md

@@ -268,6 +268,56 @@ Files::File.move(path,
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
 
 
+---
+
+## Decrypt a GPG-encrypted file and save it to a destination path
+
+```
+Files::File.gpg_decrypt(path, 
+  destination: "destination", 
+  gpg_key_partner_id: 1, 
+  use_all_private_keys: false, 
+  ignore_mdc_error: false, 
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Destination file path for the decrypted file.
+* `gpg_key_ids` (array(int64)): GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+* `gpg_key_partner_id` (int64): Partner ID whose GPG keys should be used for decryption.
+* `use_all_private_keys` (boolean): Use every accessible private GPG key in the source workspace for decryption.
+* `ignore_mdc_error` (boolean): Ignore errors from the MDC (modification detection code) check.
+* `overwrite` (boolean): Overwrite existing file in the destination?
+
+
+---
+
+## Encrypt a file with GPG and save it to a destination path
+
+```
+Files::File.gpg_encrypt(path, 
+  destination: "destination", 
+  gpg_key_partner_id: 1, 
+  signing_key_id: 1, 
+  armor: false, 
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Destination file path for the encrypted file.
+* `gpg_key_ids` (array(int64)): GPG Key IDs to encrypt with.
+* `gpg_key_partner_id` (int64): Partner ID whose GPG keys should be used for encryption.
+* `signing_key_id` (int64): Optional GPG Key ID to sign with.
+* `armor` (boolean): Output ASCII-armored encrypted data.
+* `overwrite` (boolean): Overwrite existing file in the destination?
+
+
 ---
 
 ## Extract a ZIP file to a destination folder
@@ -457,6 +507,60 @@ file.move(
 * `overwrite` (boolean): Overwrite existing file(s) in the destination?
 
 
+---
+
+## Decrypt a GPG-encrypted file and save it to a destination path
+
+```
+file = Files::File.find(path)
+
+file.gpg_decrypt(
+  destination: "destination",
+  gpg_key_partner_id: 1,
+  use_all_private_keys: false,
+  ignore_mdc_error: false,
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Destination file path for the decrypted file.
+* `gpg_key_ids` (array(int64)): GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+* `gpg_key_partner_id` (int64): Partner ID whose GPG keys should be used for decryption.
+* `use_all_private_keys` (boolean): Use every accessible private GPG key in the source workspace for decryption.
+* `ignore_mdc_error` (boolean): Ignore errors from the MDC (modification detection code) check.
+* `overwrite` (boolean): Overwrite existing file in the destination?
+
+
+---
+
+## Encrypt a file with GPG and save it to a destination path
+
+```
+file = Files::File.find(path)
+
+file.gpg_encrypt(
+  destination: "destination",
+  gpg_key_partner_id: 1,
+  signing_key_id: 1,
+  armor: false,
+  overwrite: false
+)
+```
+
+### Parameters
+
+* `path` (string): Required - Path to operate on.
+* `destination` (string): Required - Destination file path for the encrypted file.
+* `gpg_key_ids` (array(int64)): GPG Key IDs to encrypt with.
+* `gpg_key_partner_id` (int64): Partner ID whose GPG keys should be used for encryption.
+* `signing_key_id` (int64): Optional GPG Key ID to sign with.
+* `armor` (boolean): Output ASCII-armored encrypted data.
+* `overwrite` (boolean): Overwrite existing file in the destination?
+
+
 ---
 
 ## Extract a ZIP file to a destination folder

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

@@ -1075,6 +1075,53 @@ module Files
       Api.send_request("/file_actions/move/#{@attributes[:path]}", :post, params, @options)
     end
 
+    # Decrypt a GPG-encrypted file and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the decrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for decryption.
+    #   use_all_private_keys - boolean - Use every accessible private GPG key in the source workspace for decryption.
+    #   ignore_mdc_error - boolean - Ignore errors from the MDC (modification detection code) check.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def gpg_decrypt(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_ids must be an Array") if params[:gpg_key_ids] and !params[:gpg_key_ids].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_partner_id must be an Integer") if params[:gpg_key_partner_id] and !params[:gpg_key_partner_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      Api.send_request("/file_actions/gpg_decrypt/#{@attributes[:path]}", :post, params, @options)
+    end
+
+    # Encrypt a file with GPG and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the encrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to encrypt with.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for encryption.
+    #   signing_key_id - int64 - Optional GPG Key ID to sign with.
+    #   armor - boolean - Output ASCII-armored encrypted data.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def gpg_encrypt(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_ids must be an Array") if params[:gpg_key_ids] and !params[:gpg_key_ids].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_partner_id must be an Integer") if params[:gpg_key_partner_id] and !params[:gpg_key_partner_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: signing_key_id must be an Integer") if params[:signing_key_id] and !params[:signing_key_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      Api.send_request("/file_actions/gpg_encrypt/#{@attributes[:path]}", :post, params, @options)
+    end
+
     # Extract a ZIP file to a destination folder
     #
     # Parameters:
@@ -1284,6 +1331,53 @@ module Files
       FileAction.new(response.data, options)
     end
 
+    # Decrypt a GPG-encrypted file and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the decrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to decrypt with. If omitted, every accessible private GPG key in the source workspace is used.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for decryption.
+    #   use_all_private_keys - boolean - Use every accessible private GPG key in the source workspace for decryption.
+    #   ignore_mdc_error - boolean - Ignore errors from the MDC (modification detection code) check.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def self.gpg_decrypt(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_ids must be an Array") if params[:gpg_key_ids] and !params[:gpg_key_ids].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_partner_id must be an Integer") if params[:gpg_key_partner_id] and !params[:gpg_key_partner_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      response, options = Api.send_request("/file_actions/gpg_decrypt/#{params[:path]}", :post, params, options)
+      FileAction.new(response.data, options)
+    end
+
+    # Encrypt a file with GPG and save it to a destination path
+    #
+    # Parameters:
+    #   destination (required) - string - Destination file path for the encrypted file.
+    #   gpg_key_ids - array(int64) - GPG Key IDs to encrypt with.
+    #   gpg_key_partner_id - int64 - Partner ID whose GPG keys should be used for encryption.
+    #   signing_key_id - int64 - Optional GPG Key ID to sign with.
+    #   armor - boolean - Output ASCII-armored encrypted data.
+    #   overwrite - boolean - Overwrite existing file in the destination?
+    def self.gpg_encrypt(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: destination must be an String") if params[:destination] and !params[:destination].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_ids must be an Array") if params[:gpg_key_ids] and !params[:gpg_key_ids].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: gpg_key_partner_id must be an Integer") if params[:gpg_key_partner_id] and !params[:gpg_key_partner_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: signing_key_id must be an Integer") if params[:signing_key_id] and !params[:signing_key_id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: path") unless params[:path]
+      raise MissingParameterError.new("Parameter missing: destination") unless params[:destination]
+
+      response, options = Api.send_request("/file_actions/gpg_encrypt/#{params[:path]}", :post, params, options)
+      FileAction.new(response.data, options)
+    end
+
     # Extract a ZIP file to a destination folder
     #
     # Parameters:

data/lib/files.com/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.650
+  version: 1.1.651
 platform: ruby
 authors:
 - files.com