files.com 1.1.56 → 1.1.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06206d38352b8d75a30e741ee42b7d7fd7afab5a545211e6f3aa0efca68bc80a
-  data.tar.gz: 7ab65c0f981cc20b520ef8dccbde4dfc797ed184132e12cceaad15a8503e8599
+  metadata.gz: 5dde98ae311fbb3b01f7a48e1c0545e50464d76bea70589a63ba31f394a74e19
+  data.tar.gz: 5d3b87c42c1e07d007159d7bf78ce4321801d3aa8eb1b9fbe0e6120648992aef
 SHA512:
-  metadata.gz: '08d81ef69bda43a0714983cc4750761d7b771c1d7885bcdb2d9622fdc291ecf953461f9025961d9fd267f4bcf320e4f246e220911dfe2669f03b69d5168d6ec5'
-  data.tar.gz: 5b59ec3732526c2fd8ce325fae5eb7cc0ac591ab15c0027fcc45197267ecea23024a8377fae977435816f3c8095d7834b7d2af448ba6fb4e140c4c0c222529a4
+  metadata.gz: 805f4aa11e7c9d3df220ccbfb1512a4b0697bebcb1dfdb3b6a3a18939dd9d286fdfb76224f441611a7e0b2eb83247cbb112311748e81e67c2407f9462eef5f33
+  data.tar.gz: a68b1b42510a1a8d700cd33d00c9dcc6a24329dbba77db191ffe6efdf294e9f9d8220ce5e3f00a756970197e06234a5270c86889034db9edbfe290fe571b0ea8

data/_VERSION

@@ -1 +1 @@
-1.1.56
+1.1.57

data/docs/bundle_action.md

@@ -0,0 +1,58 @@
+# BundleAction
+
+## Example BundleAction Object
+
+```
+{
+  "action": "create",
+  "bundle_registration": {
+    "code": "abc123",
+    "name": "account",
+    "company": "Action Verb",
+    "email": "john.doe@files.com",
+    "ip": "10.1.1.1",
+    "inbox_code": "abc123",
+    "clickwrap_body": "example",
+    "form_field_set_id": 1,
+    "form_field_data": {
+      "key": "example value"
+    },
+    "bundle_code": "example",
+    "bundle_id": 1,
+    "bundle_recipient_id": 1,
+    "created_at": "2000-01-01T01:00:00Z"
+  },
+  "when": "2000-01-01T01:00:00Z",
+  "destination": "/to_path",
+  "path": "",
+  "source": "/from_path"
+}
+```
+
+* `action` (string): Type of action
+* `bundle_registration` (BundleRegistration): Object that contains bundle registration information
+* `when` (date-time): Action occurrence date/time
+* `destination` (string): The destination path for this bundle action, if applicable
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `source` (string): The source path for this bundle action, if applicable
+
+
+---
+
+## List Bundle Actions
+
+```
+Files::BundleAction.list(
+  per_page: 1, 
+  bundle_id: 1, 
+  bundle_registration_id: 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).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): BundleRegistration ID

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleAction
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Type of action
+    def action
+      @attributes[:action]
+    end
+
+    # BundleRegistration - Object that contains bundle registration information
+    def bundle_registration
+      @attributes[:bundle_registration]
+    end
+
+    # date-time - Action occurrence date/time
+    def when
+      @attributes[:when]
+    end
+
+    # string - The destination path for this bundle action, if applicable
+    def destination
+      @attributes[:destination]
+    end
+
+    # string - Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+    def path
+      @attributes[:path]
+    end
+
+    # string - The source path for this bundle action, if applicable
+    def source
+      @attributes[:source]
+    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).
+    #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction (e.g. `sort_by[bundle_registration_id]=desc`). Valid fields are `bundle_registration_id` and `created_at`.
+    #   bundle_id - int64 - Bundle ID
+    #   bundle_registration_id - int64 - BundleRegistration ID
+    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)
+      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: bundle_id must be an Integer") if params[:bundle_id] and !params[:bundle_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: bundle_registration_id must be an Integer") if params[:bundle_registration_id] and !params[:bundle_registration_id].is_a?(Integer)
+
+      List.new(BundleAction, params) do
+        Api.send_request("/bundle_actions", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

data/lib/files.com/version.rb

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

data/lib/files.com.rb

@@ -51,6 +51,7 @@ require "files.com/models/automation_run"
 require "files.com/models/bandwidth_snapshot"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
+require "files.com/models/bundle_action"
 require "files.com/models/bundle_download"
 require "files.com/models/bundle_notification"
 require "files.com/models/bundle_path"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.56
+  version: 1.1.57
 platform: ruby
 authors:
 - files.com
@@ -133,6 +133,7 @@ files:
 - docs/bandwidth_snapshot.md
 - docs/behavior.md
 - docs/bundle.md
+- docs/bundle_action.md
 - docs/bundle_download.md
 - docs/bundle_notification.md
 - docs/bundle_path.md
@@ -230,6 +231,7 @@ files:
 - lib/files.com/models/bandwidth_snapshot.rb
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
+- lib/files.com/models/bundle_action.rb
 - lib/files.com/models/bundle_download.rb
 - lib/files.com/models/bundle_notification.rb
 - lib/files.com/models/bundle_path.rb