files.com 1.0.340 → 1.0.342

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec11939bfc3ee2c6860a9148c5ecc3deca1fb063873dc534cc31ccaf7567ca8
-  data.tar.gz: acc5e793fe5420c1be00ecbda2cddae9231437382ea618d05de07dbbcaf2a3a7
+  metadata.gz: f7458797b6e16bae6a2cc875ce51e4260071662654c0409f1c4c6a2e52a13c6e
+  data.tar.gz: cd8927cc6fd7e377d235023f9619ddebd85c799cac5456349f168b2290eff83f
 SHA512:
-  metadata.gz: 53632b42d45e4cc1d95eb80bb8599f3b6ed70e4e86328e954be0f61ca1e349ac74268db4703aa51691237b23d1e5b8b8d5cc5424db5431f30b34e5be46d6e8c6
-  data.tar.gz: 9dd8fc4343873d0f1ab2cf51ffee31d6f046beeea228a6e5001c4009fbe80b28f669876e89454904b34210f2f3f1737dcbfeb6c0edfc24687d7eb4a5529eff46
+  metadata.gz: b5cf369b8c58189785b6cad2660067ca1a558cdf29468558e6ab790639511568ea1b292c8a6a958ae3f4453251737e77f1c60920722868ef26902d9048ceb548
+  data.tar.gz: 1e2e6db344b59a26fdbda10284151f02e9e9ba275c561b100b5136a02561bd87cdabf21c93586e5bab375edfe2a3219136a9527156227787178240dc39ac7dd5

data/_VERSION

@@ -1 +1 @@
-1.0.340
+1.0.342

data/docs/bundle.md

@@ -40,6 +40,7 @@
   "note": "The internal note on the bundle.",
   "path_template": "{{name}}_{{ip}}",
   "send_email_receipt_to_uploader": true,
+  "snapshot_id": 1,
   "user_id": 1,
   "username": "user",
   "clickwrap_id": 1,
@@ -76,6 +77,7 @@
 * `note` (string): Bundle internal note
 * `path_template` (string): Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, and any custom form data.
 * `send_email_receipt_to_uploader` (boolean): Send delivery receipt to the uploader. Note: For writable share only
+* `snapshot_id` (int64): ID of the snapshot containing this bundle's contents.
 * `user_id` (int64): Bundle creator user ID
 * `username` (string): Bundle creator username
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
@@ -86,6 +88,8 @@
 * `paths` (array): A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `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
 
@@ -137,8 +141,10 @@ Files::Bundle.create(
   paths: ["file.txt"], 
   password: "Password", 
   form_field_set_id: 1, 
+  create_snapshot: true, 
   dont_separate_submissions_by_folder: true, 
   expires_at: "2000-01-01T01:00:00Z", 
+  finalize_snapshot: true, 
   max_uses: 1, 
   description: "The public description of the bundle.", 
   note: "The internal note on the bundle.", 
@@ -163,8 +169,10 @@ Files::Bundle.create(
 * `paths` (array(string)): Required - A list of paths to include in this bundle.
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
 * `dont_separate_submissions_by_folder` (boolean): Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 * `expires_at` (string): Bundle expiration date/time
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `description` (string): Public description
 * `note` (string): Bundle internal note
@@ -214,9 +222,11 @@ Files::Bundle.update(id,
   form_field_set_id: 1, 
   clickwrap_id: 1, 
   code: "abc123", 
+  create_snapshot: true, 
   description: "The public description of the bundle.", 
   dont_separate_submissions_by_folder: true, 
   expires_at: "2000-01-01T01:00:00Z", 
+  finalize_snapshot: true, 
   inbox_id: 1, 
   max_uses: 1, 
   note: "The internal note on the bundle.", 
@@ -241,9 +251,11 @@ Files::Bundle.update(id,
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
 * `description` (string): Public description
 * `dont_separate_submissions_by_folder` (boolean): Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 * `expires_at` (string): Bundle expiration date/time
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note
@@ -308,9 +320,11 @@ bundle.update(
   form_field_set_id: 1,
   clickwrap_id: 1,
   code: "abc123",
+  create_snapshot: true,
   description: "The public description of the bundle.",
   dont_separate_submissions_by_folder: true,
   expires_at: "2000-01-01T01:00:00Z",
+  finalize_snapshot: true,
   inbox_id: 1,
   max_uses: 1,
   note: "The internal note on the bundle.",
@@ -335,9 +349,11 @@ bundle.update(
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
 * `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
 * `description` (string): Public description
 * `dont_separate_submissions_by_folder` (boolean): Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
 * `expires_at` (string): Bundle expiration date/time
+* `finalize_snapshot` (boolean): If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
 * `inbox_id` (int64): ID of the associated inbox, if available.
 * `max_uses` (int64): Maximum number of times bundle can be accessed
 * `note` (string): Bundle internal note

data/docs/snapshot.md

@@ -0,0 +1,114 @@
+# Snapshot
+
+## Example Snapshot Object
+
+```
+{
+  "expires_at": "2000-01-01T01:00:00Z",
+  "finalized_at": "2000-01-01T01:00:00Z",
+  "name": "My Snapshot",
+  "user_id": 1,
+  "bundle_id": 1
+}
+```
+
+* `expires_at` (date-time): When the snapshot expires.
+* `finalized_at` (date-time): When the snapshot was finalized.
+* `name` (string): A name for the snapshot.
+* `user_id` (int64): The user that created this snapshot, if applicable.
+* `bundle_id` (int64): The bundle using this snapshot, if applicable.
+* `id` (int64): Snapshot ID.
+
+
+---
+
+## List Snapshots
+
+```
+Files::Snapshot.list(
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `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 Snapshot
+
+```
+Files::Snapshot.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+
+
+---
+
+## Create Snapshot
+
+```
+Files::Snapshot.create
+```
+
+
+---
+
+## Update Snapshot
+
+```
+Files::Snapshot.update(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+
+
+---
+
+## Delete Snapshot
+
+```
+Files::Snapshot.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+
+
+---
+
+## Update Snapshot
+
+```
+snapshot = Files::Snapshot.list.first
+
+snapshot.update
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.
+
+
+---
+
+## Delete Snapshot
+
+```
+snapshot = Files::Snapshot.list.first
+
+snapshot.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Snapshot ID.

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

@@ -194,6 +194,15 @@ module Files
       @attributes[:send_email_receipt_to_uploader] = value
     end
 
+    # int64 - ID of the snapshot containing this bundle's contents.
+    def snapshot_id
+      @attributes[:snapshot_id]
+    end
+
+    def snapshot_id=(value)
+      @attributes[:snapshot_id] = value
+    end
+
     # int64 - Bundle creator user ID
     def user_id
       @attributes[:user_id]
@@ -284,6 +293,24 @@ module Files
       @attributes[:form_field_set_id] = value
     end
 
+    # boolean - If true, create a snapshot of this bundle's contents.
+    def create_snapshot
+      @attributes[:create_snapshot]
+    end
+
+    def create_snapshot=(value)
+      @attributes[:create_snapshot] = value
+    end
+
+    # boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
+    def finalize_snapshot
+      @attributes[:finalize_snapshot]
+    end
+
+    def finalize_snapshot=(value)
+      @attributes[:finalize_snapshot] = value
+    end
+
     # file - Preview watermark image applied to all bundle items.
     def watermark_attachment_file
       @attributes[:watermark_attachment_file]
@@ -327,9 +354,11 @@ module Files
     #   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    #   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
     #   description - string - Public description
     #   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
     #   expires_at - string - Bundle expiration date/time
+    #   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   note - string - Bundle internal note
@@ -440,8 +469,10 @@ module Files
     #   paths (required) - array(string) - A list of paths to include in this bundle.
     #   password - string - Password for this bundle.
     #   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
+    #   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
     #   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
     #   expires_at - string - Bundle expiration date/time
+    #   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   description - string - Public description
     #   note - string - Bundle internal note
@@ -503,9 +534,11 @@ module Files
     #   form_field_set_id - int64 - Id of Form Field Set to use with this bundle
     #   clickwrap_id - int64 - ID of the clickwrap to use with this bundle.
     #   code - string - Bundle code.  This code forms the end part of the Public URL.
+    #   create_snapshot - boolean - If true, create a snapshot of this bundle's contents.
     #   description - string - Public description
     #   dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.
     #   expires_at - string - Bundle expiration date/time
+    #   finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.
     #   inbox_id - int64 - ID of the associated inbox, if available.
     #   max_uses - int64 - Maximum number of times bundle can be accessed
     #   note - string - Bundle internal note

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Files
+  class Snapshot
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # date-time - When the snapshot expires.
+    def expires_at
+      @attributes[:expires_at]
+    end
+
+    def expires_at=(value)
+      @attributes[:expires_at] = value
+    end
+
+    # date-time - When the snapshot was finalized.
+    def finalized_at
+      @attributes[:finalized_at]
+    end
+
+    def finalized_at=(value)
+      @attributes[:finalized_at] = value
+    end
+
+    # string - A name for the snapshot.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # int64 - The user that created this snapshot, if applicable.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # int64 - The bundle using this snapshot, if applicable.
+    def bundle_id
+      @attributes[:bundle_id]
+    end
+
+    def bundle_id=(value)
+      @attributes[:bundle_id] = value
+    end
+
+    # int64 - Snapshot ID.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    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 MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/snapshots/#{@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("/snapshots/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = Snapshot.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   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: 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(Snapshot, params) do
+        Api.send_request("/snapshots", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Snapshot 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("/snapshots/#{params[:id]}", :get, params, options)
+      Snapshot.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    def self.create(params = {}, options = {})
+      response, options = Api.send_request("/snapshots", :post, params, options)
+      Snapshot.new(response.data, options)
+    end
+
+    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 MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/snapshots/#{params[:id]}", :patch, params, options)
+      Snapshot.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("/snapshots/#{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

@@ -100,6 +100,7 @@ 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/snapshot"
 require "files.com/models/sso_strategy"
 require "files.com/models/status"
 require "files.com/models/style"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.340
+  version: 1.0.342
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -183,6 +183,7 @@ files:
 - docs/settings_change.md
 - docs/sftp_host_key.md
 - docs/site.md
+- docs/snapshot.md
 - docs/sso_strategy.md
 - docs/status.md
 - docs/style.md
@@ -268,6 +269,7 @@ files:
 - 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/snapshot.rb
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb
 - lib/files.com/models/style.rb