files.com 1.0.226 → 1.0.227

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d1b6fdac362dd92d13bfa8f5d8a1d3346a67ae0a385e2c0fca9a0448ed680ec
-  data.tar.gz: c4c0b860dbfde6c79ea9bfb90a52483d46dee36ae8e17b938139ffdc44816561
+  metadata.gz: 3d64dbb3481c10c0da18250e033695bc9c910bb7f74b88d6a72fc23fb4dd7551
+  data.tar.gz: 91282bbe6e0c52c8e1734d6c44e09181a3a66227a086161387fd2034927df6bb
 SHA512:
-  metadata.gz: c9c601e41a40c1c52a65fc804022a0affb1adf08386c314ab2f6a69aa219c6faaccb4a4e0d528ddc44f3580cd693cf43d99b1ab13980e3189c5912ab861d957a
-  data.tar.gz: 7daae4e406dc7251c6af60db38d5141bdf94bdd35c6463137de2761314944d67912e06258336bea9220d7b478ed16b964e03e63da9f54ab858bb3a2608691b77
+  metadata.gz: 989d8f6afaac864f66c5cd9f47e1fdad660cae79876f7b1b8d18b23b6fe8a06cc5779b9d586c3452a15e102d766be183870ebf40fb6e45375a5166cbeaecdaf2
+  data.tar.gz: 7d79478717a8dbf4840860da25d5dea6fcf4e3004924ad3981639b7a83343718f9b4c9195865796735965ae80bd896d862ce9c89d769908818e853f007451fb8

data/_VERSION

@@ -1 +1 @@
-1.0.226
+1.0.227

data/docs/behavior.md

@@ -24,6 +24,7 @@
 * `description` (string): Description for this behavior.
 * `value` (object): Settings for this behavior.  See the section above for an example value to provide here.  Formatting is different for each Behavior type.  May be sent as nested JSON or a single JSON-encoded string.  If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
 * `attachment_file` (file): Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
+* `attachment_delete` (boolean): If true, will delete the file stored in attachment
 
 
 ---
@@ -145,7 +146,8 @@ Files::Behavior.webhook_test(
 ```
 Files::Behavior.update(id, 
   value: "{\"method\": \"GET\"}", 
-  behavior: "webhook"
+  behavior: "webhook", 
+  attachment_delete: true
 )
 ```
 
@@ -158,6 +160,7 @@ Files::Behavior.update(id,
 * `description` (string): Description for this behavior.
 * `behavior` (string): Behavior type.
 * `path` (string): Folder behaviors path.
+* `attachment_delete` (boolean): If true, will delete the file stored in attachment
 
 
 ---
@@ -182,7 +185,8 @@ behavior = Files::Behavior.list.first
 
 behavior.update(
   value: "{\"method\": \"GET\"}",
-  behavior: "webhook"
+  behavior: "webhook",
+  attachment_delete: true
 )
 ```
 
@@ -195,6 +199,7 @@ behavior.update(
 * `description` (string): Description for this behavior.
 * `behavior` (string): Behavior type.
 * `path` (string): Folder behaviors path.
+* `attachment_delete` (boolean): If true, will delete the file stored in attachment
 
 
 ---

data/docs/bundle.md

@@ -48,6 +48,11 @@
   "username": "user",
   "clickwrap_id": 1,
   "inbox_id": 1,
+  "watermark_attachment": {
+    "name": "My logo",
+    "uri": "https://mysite.files.com/.../my_image.png"
+  },
+  "watermark_value": "",
   "has_inbox": true,
   "paths": [
     "file.txt"
@@ -73,10 +78,14 @@
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `inbox_id` (int64): ID of the associated inbox, if available.
+* `watermark_attachment`: Preview watermark image applied to all bundle items.
+* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
 * `has_inbox` (boolean): Does this bundle have an associated inbox?
 * `paths` (array): A list of paths in this bundle
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
+* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
 
 
 ---
@@ -156,6 +165,7 @@ Files::Bundle.create(
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 
 
 ---
@@ -196,7 +206,8 @@ Files::Bundle.update(id,
   note: "The internal note on the bundle.", 
   preview_only: true, 
   require_registration: true, 
-  require_share_recipient: true
+  require_share_recipient: true, 
+  watermark_attachment_delete: true
 )
 ```
 
@@ -216,6 +227,8 @@ Files::Bundle.update(id,
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 
 
 ---
@@ -273,7 +286,8 @@ bundle.update(
   note: "The internal note on the bundle.",
   preview_only: true,
   require_registration: true,
-  require_share_recipient: true
+  require_share_recipient: true,
+  watermark_attachment_delete: true
 )
 ```
 
@@ -293,6 +307,8 @@ bundle.update(
 * `preview_only` (boolean): Restrict users to previewing files only?
 * `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
 * `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 
 
 ---

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

@@ -81,6 +81,15 @@ module Files
       @attributes[:attachment_file] = value
     end
 
+    # boolean - If true, will delete the file stored in attachment
+    def attachment_delete
+      @attributes[:attachment_delete]
+    end
+
+    def attachment_delete=(value)
+      @attributes[:attachment_delete] = value
+    end
+
     # Parameters:
     #   value - string - The value of the folder behavior.  Can be a integer, array, or hash depending on the type of folder behavior. See The Behavior Types section for example values for each type of behavior.
     #   attachment_file - file - Certain behaviors may require a file, for instance, the "watermark" behavior requires a watermark image
@@ -88,6 +97,7 @@ module Files
     #   description - string - Description for this behavior.
     #   behavior - string - Behavior type.
     #   path - string - Folder behaviors path.
+    #   attachment_delete - boolean - If true, will delete the file stored in attachment
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -256,6 +266,7 @@ module Files
     #   description - string - Description for this behavior.
     #   behavior - string - Behavior type.
     #   path - string - Folder behaviors path.
+    #   attachment_delete - boolean - If true, will delete the file stored in attachment
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
@@ -264,7 +275,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: description must be an String") if params.dig(:description) and !params.dig(:description).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: behavior must be an String") if params.dig(:behavior) and !params.dig(:behavior).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: path must be one of String, Integer, Hash") if params.dig(:path) and [ String, Integer, Hash ].none? { |klass| params.dig(:path).is_a?(klass) }
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: attachment_delete must be one of String, Integer, Hash") if params.dig(:attachment_delete) and [ String, Integer, Hash ].none? { |klass| params.dig(:attachment_delete).is_a?(klass) }
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/behaviors/#{params[:id]}", :patch, params, options)

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

@@ -167,6 +167,24 @@ module Files
       @attributes[:inbox_id] = value
     end
 
+    # Preview watermark image applied to all bundle items.
+    def watermark_attachment
+      @attributes[:watermark_attachment]
+    end
+
+    def watermark_attachment=(value)
+      @attributes[:watermark_attachment] = value
+    end
+
+    # object - Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
+    def watermark_value
+      @attributes[:watermark_value]
+    end
+
+    def watermark_value=(value)
+      @attributes[:watermark_value] = value
+    end
+
     # boolean - Does this bundle have an associated inbox?
     def has_inbox
       @attributes[:has_inbox]
@@ -203,6 +221,24 @@ module Files
       @attributes[:form_field_set_id] = value
     end
 
+    # file - Preview watermark image applied to all bundle items.
+    def watermark_attachment_file
+      @attributes[:watermark_attachment_file]
+    end
+
+    def watermark_attachment_file=(value)
+      @attributes[:watermark_attachment_file] = value
+    end
+
+    # boolean - If true, will delete the file stored in watermark_attachment
+    def watermark_attachment_delete
+      @attributes[:watermark_attachment_delete]
+    end
+
+    def watermark_attachment_delete=(value)
+      @attributes[:watermark_attachment_delete] = value
+    end
+
     # Send email(s) with a link to bundle
     #
     # Parameters:
@@ -236,6 +272,8 @@ module Files
     #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
+    #   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
@@ -342,6 +380,7 @@ module Files
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: paths must be an Array") if params.dig(:paths) and !params.dig(:paths).is_a?(Array)
@@ -393,6 +432,8 @@ module Files
     #   preview_only - boolean - Restrict users to previewing files only?
     #   require_registration - boolean - Show a registration page that captures the downloader's name and email address?
     #   require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+    #   watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment
+    #   watermark_attachment_file - file - Preview watermark image applied to all bundle items.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.226
+  version: 1.0.227
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable