files.com 1.0.339 → 1.0.341

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c9903f39779bdd4ee071f3e20bad03cc6f637658496651ad275fbf9f2e84294
-  data.tar.gz: f63f18f6335b363a7a146174362d867dd471963ed94ac7afc346e41b0de15451
+  metadata.gz: 42facb096cac23769533241c08e783056751f132a0a1d5021da0e2f35f8d7d36
+  data.tar.gz: 3d160c69bcf1af9966be73e4f62706045af6fa903f948623b63354ddf3a73881
 SHA512:
-  metadata.gz: 726f0afe2a22250d49f1755cf138f9df1cea98c712f7d37e47d2ded8580482fd39995b379c96c957c3b953daad61d73a9cb78b6a0c34012002d19d33abbee05f
-  data.tar.gz: 953ba4283f48d1ebf207ef2633d83703dbc8f7d1047047dc8ba653e370f2c990536ff2d51e6df6d26e2fb28f960ae7933cc4d7d86c552e78dd9cf386fada6d74
+  metadata.gz: 8092f446d0281ad11b4d6541d162dd06dcd9a7be8fb1ffcd7635c25b2617394cf3bad31c89471bbf4f9865369238857544245c3fbf517ce9b2a523bbef436dab
+  data.tar.gz: 9b89571030ea82226be5cf6e719c139a5cf9eaac1ec693b43b1c876ef1632bb21410fe80bc0fa8cbcdff20e135c93398c9a1b290905921f4992f2a7d26c5ad69

data/_VERSION

@@ -1 +1 @@
-1.0.339
+1.0.341

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/folder.md

@@ -77,6 +77,7 @@ Files::Folder.list_for(path,
 * `path` (string): Required - Path to operate on.
 * `filter` (string): If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+* `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
 * `search` (string): If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
 * `search_all` (boolean): Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the UI.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `with_previews` (boolean): Include file previews?

data/docs/snapshot.md

@@ -0,0 +1,97 @@
+# Snapshot
+
+* `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/folder.rb

@@ -328,6 +328,7 @@ module Files
     #   path (required) - string - Path to operate on.
     #   filter - string - If specified, will filter folders/files list by this string.  Wildcards of `*` and `?` are acceptable here.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
+    #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
     #   search - string - If `search_all` is `true`, provide the search string here.  Otherwise, this parameter acts like an alias of `filter`.
     #   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the UI.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   with_previews - boolean - Include file previews?
@@ -340,6 +341,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: filter must be an String") if params[:filter] and !params[:filter].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: search must be an String") if params[:search] and !params[:search].is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params[:path]
 

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Files
+  class Snapshot
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    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)
+
+      response, _options = Api.send_request("/snapshots", :get, params, options)
+      response.data
+    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)
+      response.data
+    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)
+      response.data
+    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)
+      response.data
+    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.339
+  version: 1.0.341
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 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