files.com 1.0.95 → 1.0.96

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5f76212030802af876083085e7dbf117080280c28defd1ccb0eb256cc22ebb
-  data.tar.gz: d542420f40b41fea8cb18d1d7e0b3cc1390134702c190d46a299a535542c21ac
+  metadata.gz: 485dc4c0f9287f1c84e8a1191309a20e544d8b12288a1ffb7976ede59b3f1dc2
+  data.tar.gz: 85edd613267d4a44d1da0649fce06d6f0df8eede638da01141a90a37b7886329
 SHA512:
-  metadata.gz: d8936aa2ae6ed35bee4ebab6486653c92ddf4bc6afdd00784a2d81c19809120a72853f085c087e4aeace4309c2d4cbb80069522755352a1819b0d740d60be9a4
-  data.tar.gz: 4764cac725ab63104b7eb866d2a1aa4933a02c5591908c45ba480f172647b49b516a670a7f2ed8107fe33eecbd17150cf534c9042db5e5abaf5879e84bfa4e40
+  metadata.gz: 72bd5d7f069551773584f482ac73de300d16025764e08d6f80a9e4a9584bbaf2cddb33e8a952a28b1909c2d333c23b2bedfc8f863e2b5e6f228fb796532e2dab
+  data.tar.gz: 11d4d37f6cf87b7e2335e323fc4c2e18de2f463e2b3056efcae22b20ac7fb1935cb53e6f708b61b9dd2a8f38a56512855171ed63b162ab26146b65ad408dc9f9

data/_VERSION

@@ -1 +1 @@
-1.0.95
+1.0.96

data/docs/bundle_recipient.md

@@ -0,0 +1,41 @@
+# BundleRecipient
+
+## Example BundleRecipient Object
+
+```
+{
+  "company": "Acme Inc.",
+  "name": "John Doe",
+  "note": "Some note.",
+  "recipient": "john.doe@example.com",
+  "sent_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `company` (string): The recipient's company.
+* `name` (string): The recipient's name.
+* `note` (string): A note sent to the recipient with the bundle.
+* `recipient` (string): The recipient's email address.
+* `sent_at` (date-time): When the Bundle was shared with this recipient.
+
+
+---
+
+## List Bundle Recipients
+
+```
+Files::BundleRecipient.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `bundle_id` (int64): Required - List recipients for the bundle with this ID.

data/docs/settings_change.md

@@ -0,0 +1,41 @@
+# SettingsChange
+
+## Example SettingsChange Object
+
+```
+{
+  "change_details": "{ domain: [\"olddomain.com', \"newdomain.com\"] }",
+  "created_at": "2000-01-01T01:00:00Z",
+  "user_id": 1
+}
+```
+
+* `change_details` (object): Specifics on what changed.
+* `created_at` (date-time): The time this change was made
+* `user_id` (int64): The user id responsible for this change
+
+
+---
+
+## List Settings Changes
+
+```
+Files::SettingsChange.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `api_key_id`, `created_at` or `user_id`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.

data/lib/files.com.rb

@@ -36,6 +36,7 @@ require "files.com/models/automation"
 require "files.com/models/behavior"
 require "files.com/models/bundle"
 require "files.com/models/bundle_download"
+require "files.com/models/bundle_recipient"
 require "files.com/models/clickwrap"
 require "files.com/models/dns_record"
 require "files.com/models/errors"
@@ -69,6 +70,7 @@ require "files.com/models/public_key"
 require "files.com/models/remote_server"
 require "files.com/models/request"
 require "files.com/models/session"
+require "files.com/models/settings_change"
 require "files.com/models/site"
 require "files.com/models/sso_strategy"
 require "files.com/models/status"

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleRecipient
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - The recipient's company.
+    def company
+      @attributes[:company]
+    end
+
+    # string - The recipient's name.
+    def name
+      @attributes[:name]
+    end
+
+    # string - A note sent to the recipient with the bundle.
+    def note
+      @attributes[:note]
+    end
+
+    # string - The recipient's email address.
+    def recipient
+      @attributes[:recipient]
+    end
+
+    # date-time - When the Bundle was shared with this recipient.
+    def sent_at
+      @attributes[:sent_at]
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+    #   bundle_id (required) - int64 - List recipients for the bundle with this ID.
+    def self.list(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: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: bundle_id must be an Integer") if params.dig(:bundle_id) and !params.dig(:bundle_id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: bundle_id") unless params.dig(:bundle_id)
+
+      response, options = Api.send_request("/bundle_recipients", :get, params, options)
+      response.data.map do |entity_data|
+        BundleRecipient.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Files
+  class SettingsChange
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # object - Specifics on what changed.
+    def change_details
+      @attributes[:change_details]
+    end
+
+    # date-time - The time this change was made
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # int64 - The user id responsible for this change
+    def user_id
+      @attributes[:user_id]
+    end
+
+    # Parameters:
+    #   page - int64 - Current page number.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+    #   cursor - string - Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+    #   sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `api_key_id`, `created_at` or `user_id`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
+
+      List.new(SettingsChange, params) do
+        Api.send_request("/settings_changes", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.95
+  version: 1.0.96
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-25 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -95,6 +95,7 @@ files:
 - docs/behavior.md
 - docs/bundle.md
 - docs/bundle_download.md
+- docs/bundle_recipient.md
 - docs/clickwrap.md
 - docs/dns_record.md
 - docs/errors.md
@@ -129,6 +130,7 @@ files:
 - docs/remote_server.md
 - docs/request.md
 - docs/session.md
+- docs/settings_change.md
 - docs/site.md
 - docs/sso_strategy.md
 - docs/status.md
@@ -154,6 +156,7 @@ files:
 - lib/files.com/models/behavior.rb
 - lib/files.com/models/bundle.rb
 - lib/files.com/models/bundle_download.rb
+- lib/files.com/models/bundle_recipient.rb
 - lib/files.com/models/clickwrap.rb
 - lib/files.com/models/dir.rb
 - lib/files.com/models/dns_record.rb
@@ -189,6 +192,7 @@ files:
 - lib/files.com/models/remote_server.rb
 - lib/files.com/models/request.rb
 - lib/files.com/models/session.rb
+- lib/files.com/models/settings_change.rb
 - lib/files.com/models/site.rb
 - lib/files.com/models/sso_strategy.rb
 - lib/files.com/models/status.rb