files.com 1.0.147 → 1.0.152

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff882920d191b3e5b7735eac44e2c0cf49de08d38bd7de88599d162f387e15a
-  data.tar.gz: ba1b8f635412dd1347ae7888f7786cec95f7a51dca98407834e40dc2be6ab9bf
+  metadata.gz: 80890845ebda55975f177b54c85c82f1ed106086e750eded6907488daf879cce
+  data.tar.gz: bf99ca9501f9813393e23dba23a54acdedaf70528f6d24bc3fa6a94adcda7757
 SHA512:
-  metadata.gz: d9a30e50de3d17daa4268f3dd1b488a85c130490f8c1255e0662715a604d23d2b164c7ba3821b83248b53bf0504f7d54dc2e9eafbfb6d7be8d8a83f7a2ea75ce
-  data.tar.gz: 70d58ca954bd501b98412cadac8eb78de9442f0c03cd53f37acc0ad3dcf313ac34cb466bfdfc7927dc02b75104b81eb11dff0931f4a28ed0682eeaf4c321846a
+  metadata.gz: 9cc02ddb3685c4ccb7c980ba891f171c354dfd0f122fd2779d02d7259bd7a96b661a84f01e06e617d8637475c4daa35b4513795a58b0f9a269f3f2f782fbd6a3
+  data.tar.gz: 5c499037e94937095e8a52b0811398a341b81dd8f3cbd33ed7345b30028403060043faea5692be969388d1923a3c8ff1d34f1ff03c122684fcebe5cfb0b3e8cc

data/_VERSION

@@ -1 +1 @@
-1.0.147
+1.0.152

data/docs/api_key.md

@@ -61,9 +61,17 @@ Files::ApiKey.list(
 ## Show information about current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.find_current
+Files::ApiKey.find_current(
+  format: "", 
+  api_key: ""
+)
 ```
 
+### Parameters
+
+* `format` (string): 
+* `api_key` (object): 
+
 
 ---
 
@@ -145,9 +153,17 @@ Files::ApiKey.update(id,
 ## Delete current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.delete_current
+Files::ApiKey.delete_current(
+  format: "", 
+  api_key: ""
+)
 ```
 
+### Parameters
+
+* `format` (string): 
+* `api_key` (object): 
+
 
 ---
 

data/docs/bundle.md

@@ -35,7 +35,10 @@
         "default_option": "red",
         "form_field_set_id": 1
       }
-    ]
+    ],
+    "skip_name": true,
+    "skip_email": true,
+    "skip_company": true
   },
   "id": 1,
   "created_at": "2000-01-01T01:00:00Z",

data/docs/form_field_set.md

@@ -27,7 +27,10 @@
       "default_option": "red",
       "form_field_set_id": 1
     }
-  ]
+  ],
+  "skip_name": true,
+  "skip_email": true,
+  "skip_company": true
 }
 ```
 
@@ -35,6 +38,9 @@
 * `title` (string): Title to be displayed
 * `form_layout` (int64): Layout of the form
 * `form_fields` (array): Associated form fields
+* `skip_name` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
+* `skip_email` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
+* `skip_company` (boolean): Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 
 
@@ -77,6 +83,9 @@ Files::FormFieldSet.find(id)
 Files::FormFieldSet.create(
   user_id: 1, 
   title: "Sample Form Title", 
+  skip_email: true, 
+  skip_name: true, 
+  skip_company: true, 
   form_fields: [{"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
 )
 ```
@@ -85,6 +94,9 @@ Files::FormFieldSet.create(
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `title` (string): Title to be displayed
+* `skip_email` (boolean): Skip validating form email
+* `skip_name` (boolean): Skip validating form name
+* `skip_company` (boolean): Skip validating company
 * `form_fields` (array(object)): 
 
 
@@ -95,6 +107,9 @@ Files::FormFieldSet.create(
 ```
 Files::FormFieldSet.update(id, 
   title: "Sample Form Title", 
+  skip_email: true, 
+  skip_name: true, 
+  skip_company: true, 
   form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
 )
 ```
@@ -103,6 +118,9 @@ Files::FormFieldSet.update(id,
 
 * `id` (int64): Required - Form Field Set ID.
 * `title` (string): Title to be displayed
+* `skip_email` (boolean): Skip validating form email
+* `skip_name` (boolean): Skip validating form name
+* `skip_company` (boolean): Skip validating company
 * `form_fields` (array(object)): 
 
 
@@ -128,6 +146,9 @@ form_field_set = Files::FormFieldSet.list_for(path).first
 
 form_field_set.update(
   title: "Sample Form Title",
+  skip_email: true,
+  skip_name: true,
+  skip_company: true,
   form_fields: [{"id":1,"label":"Sample Label","required":true,"help_text":"Help Text","field_type":"text","options_for_select":["red","green","blue"],"default_option":"red","form_field_set_id":1}]
 )
 ```
@@ -136,6 +157,9 @@ form_field_set.update(
 
 * `id` (int64): Required - Form Field Set ID.
 * `title` (string): Title to be displayed
+* `skip_email` (boolean): Skip validating form email
+* `skip_name` (boolean): Skip validating form name
+* `skip_company` (boolean): Skip validating company
 * `form_fields` (array(object)): 
 
 

data/docs/group_user.md

@@ -42,6 +42,25 @@ Files::GroupUser.list(
 * `group_id` (int64): Group ID.  If provided, will return group_users of this group.
 
 
+---
+
+## Create Group User
+
+```
+Files::GroupUser.create(
+  group_id: 1, 
+  user_id: 1, 
+  admin: true
+)
+```
+
+### Parameters
+
+* `group_id` (int64): Required - Group ID to add user to.
+* `user_id` (int64): Required - User ID to add to group.
+* `admin` (boolean): Is the user a group administrator?
+
+
 ---
 
 ## Update Group User

data/docs/session.md

@@ -74,5 +74,13 @@ Files::Session.create(
 ## Delete user session (log out)
 
 ```
-Files::Session.delete
+Files::Session.delete(
+  format: "", 
+  session: ""
+)
 ```
+
+### Parameters
+
+* `format` (string): 
+* `session` (object): 

data/docs/site.md

@@ -324,18 +324,34 @@
 ## Show site settings
 
 ```
-Files::Site.get
+Files::Site.get(
+  format: "", 
+  site: ""
+)
 ```
 
+### Parameters
+
+* `format` (string): 
+* `site` (object): 
+
 
 ---
 
 ## Get the most recent usage snapshot (usage data for billing purposes) for a Site
 
 ```
-Files::Site.get_usage
+Files::Site.get_usage(
+  format: "", 
+  site: ""
+)
 ```
 
+### Parameters
+
+* `format` (string): 
+* `site` (object): 
+
 
 ---
 

data/docs/usage_snapshot.md

@@ -8,6 +8,7 @@
   "start_at": "2000-01-01T01:00:00Z",
   "end_at": "2000-01-01T01:00:00Z",
   "created_at": "2000-01-01T01:00:00Z",
+  "high_water_user_count": 1.0,
   "current_storage": 1.0,
   "high_water_storage": 1.0,
   "total_downloads": 1,
@@ -24,6 +25,7 @@
 * `start_at` (date-time): Site usage report start date/time
 * `end_at` (date-time): Site usage report end date/time
 * `created_at` (date-time): Site usage report created at date/time
+* `high_water_user_count` (double): Site usage report highest usage in time period
 * `current_storage` (double): Current site usage as of report
 * `high_water_storage` (double): Site usage report highest usage in time period
 * `total_downloads` (int64): Number of downloads in report time period

data/docs/webhook_test.md

@@ -0,0 +1,50 @@
+# WebhookTest
+
+## Example WebhookTest Object
+
+```
+{
+  "code": 200,
+  "message": "",
+  "status": "",
+  "data": "",
+  "success": true
+}
+```
+
+* `code` (int64): Status HTTP code
+* `message` (string): Error message
+* `status` (string): Status message
+* `data`: Additional data
+* `success` (boolean): The success status of the webhook test
+* `url` (string): URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body
+
+
+---
+
+## Create Webhook Test
+
+```
+Files::WebhookTest.create(
+  url: "https://www.site.com/...", 
+  method: "GET", 
+  encoding: "RAW", 
+  headers: "x-test-header => testvalue", 
+  body: "test-param => testvalue", 
+  action: "test"
+)
+```
+
+### Parameters
+
+* `url` (string): Required - URL for testing the webhook.
+* `method` (string): HTTP method(GET or POST).
+* `encoding` (string): HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+* `headers` (object): Additional request headers.
+* `body` (object): Additional body parameters.
+* `action` (string): action for test body

data/lib/files.com.rb

@@ -90,6 +90,7 @@ require "files.com/models/usage_snapshot"
 require "files.com/models/user"
 require "files.com/models/user_cipher_use"
 require "files.com/models/user_request"
+require "files.com/models/webhook_test"
 
 require "files.com/models/dir"
 require "files.com/models/file_utils"

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

@@ -176,7 +176,13 @@ module Files
       list(params, options)
     end
 
+    # Parameters:
+    #   format - string
+    #   api_key - object
     def self.find_current(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
+
       response, options = Api.send_request("/api_key", :get, params, options)
       ApiKey.new(response.data, options)
     end
@@ -244,7 +250,13 @@ module Files
       ApiKey.new(response.data, options)
     end
 
+    # Parameters:
+    #   format - string
+    #   api_key - object
     def self.delete_current(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: api_key must be an Hash") if params.dig(:api_key) and !params.dig(:api_key).is_a?(Hash)
+
       response, _options = Api.send_request("/api_key", :delete, params, options)
       response.data
     end

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

@@ -45,6 +45,33 @@ module Files
       @attributes[:form_fields] = value
     end
 
+    # boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
+    def skip_name
+      @attributes[:skip_name]
+    end
+
+    def skip_name=(value)
+      @attributes[:skip_name] = value
+    end
+
+    # boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
+    def skip_email
+      @attributes[:skip_email]
+    end
+
+    def skip_email=(value)
+      @attributes[:skip_email] = value
+    end
+
+    # boolean - Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
+    def skip_company
+      @attributes[:skip_company]
+    end
+
+    def skip_company=(value)
+      @attributes[:skip_company] = value
+    end
+
     # int64 - User ID.  Provide a value of `0` to operate the current session's user.
     def user_id
       @attributes[:user_id]
@@ -56,6 +83,9 @@ module Files
 
     # Parameters:
     #   title - string - Title to be displayed
+    #   skip_email - boolean - Skip validating form email
+    #   skip_name - boolean - Skip validating form name
+    #   skip_company - boolean - Skip validating company
     #   form_fields - array(object)
     def update(params = {})
       params ||= {}
@@ -129,6 +159,9 @@ module Files
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
     #   title - string - Title to be displayed
+    #   skip_email - boolean - Skip validating form email
+    #   skip_name - boolean - Skip validating form name
+    #   skip_company - boolean - Skip validating company
     #   form_fields - array(object)
     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)
@@ -141,6 +174,9 @@ module Files
 
     # Parameters:
     #   title - string - Title to be displayed
+    #   skip_email - boolean - Skip validating form email
+    #   skip_name - boolean - Skip validating form name
+    #   skip_company - boolean - Skip validating company
     #   form_fields - array(object)
     def self.update(id, params = {}, options = {})
       params ||= {}

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

@@ -103,7 +103,12 @@ module Files
     end
 
     def save
-      update(@attributes)
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = GroupUser.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
     end
 
     # Parameters:
@@ -126,6 +131,20 @@ module Files
       list(params, options)
     end
 
+    # Parameters:
+    #   group_id (required) - int64 - Group ID to add user to.
+    #   user_id (required) - int64 - User ID to add to group.
+    #   admin - boolean - Is the user a group administrator?
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: group_id must be an Integer") if params.dig(:group_id) and !params.dig(:group_id).is_a?(Integer)
+      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 MissingParameterError.new("Parameter missing: group_id") unless params.dig(:group_id)
+      raise MissingParameterError.new("Parameter missing: user_id") unless params.dig(:user_id)
+
+      response, options = Api.send_request("/group_users", :post, params, options)
+      GroupUser.new(response.data, options)
+    end
+
     # Parameters:
     #   group_id (required) - int64 - Group ID to add user to.
     #   user_id (required) - int64 - User ID to add to group.

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

@@ -235,7 +235,13 @@ module Files
       Session.new(response.data, options)
     end
 
+    # Parameters:
+    #   format - string
+    #   session - object
     def self.delete(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: session must be an Hash") if params.dig(:session) and !params.dig(:session).is_a?(Hash)
+
       response, _options = Api.send_request("/sessions", :delete, params, options)
       response.data
     end

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

@@ -574,12 +574,24 @@ module Files
       @attributes[:disable_users_from_inactivity_period_days]
     end
 
+    # Parameters:
+    #   format - string
+    #   site - object
     def self.get(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
+
       response, options = Api.send_request("/site", :get, params, options)
       Site.new(response.data, options)
     end
 
+    # Parameters:
+    #   format - string
+    #   site - object
     def self.get_usage(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: format must be an String") if params.dig(:format) and !params.dig(:format).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: site must be an Hash") if params.dig(:site) and !params.dig(:site).is_a?(Hash)
+
       response, options = Api.send_request("/site/usage", :get, params, options)
       UsageSnapshot.new(response.data, options)
     end

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

@@ -29,6 +29,11 @@ module Files
       @attributes[:created_at]
     end
 
+    # double - Site usage report highest usage in time period
+    def high_water_user_count
+      @attributes[:high_water_user_count]
+    end
+
     # double - Current site usage as of report
     def current_storage
       @attributes[:current_storage]

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Files
+  class WebhookTest
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Status HTTP code
+    def code
+      @attributes[:code]
+    end
+
+    def code=(value)
+      @attributes[:code] = value
+    end
+
+    # string - Error message
+    def message
+      @attributes[:message]
+    end
+
+    def message=(value)
+      @attributes[:message] = value
+    end
+
+    # string - Status message
+    def status
+      @attributes[:status]
+    end
+
+    def status=(value)
+      @attributes[:status] = value
+    end
+
+    # Additional data
+    def data
+      @attributes[:data]
+    end
+
+    def data=(value)
+      @attributes[:data] = value
+    end
+
+    # boolean - The success status of the webhook test
+    def success
+      @attributes[:success]
+    end
+
+    def success=(value)
+      @attributes[:success] = value
+    end
+
+    # string - URL for testing the webhook.
+    def url
+      @attributes[:url]
+    end
+
+    def url=(value)
+      @attributes[:url] = value
+    end
+
+    # string - HTTP method(GET or POST).
+    def method
+      @attributes[:method]
+    end
+
+    def method=(value)
+      @attributes[:method] = value
+    end
+
+    # string - HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+    def encoding
+      @attributes[:encoding]
+    end
+
+    def encoding=(value)
+      @attributes[:encoding] = value
+    end
+
+    # object - Additional request headers.
+    def headers
+      @attributes[:headers]
+    end
+
+    def headers=(value)
+      @attributes[:headers] = value
+    end
+
+    # object - Additional body parameters.
+    def body
+      @attributes[:body]
+    end
+
+    def body=(value)
+      @attributes[:body] = value
+    end
+
+    # string - action for test body
+    def action
+      @attributes[:action]
+    end
+
+    def action=(value)
+      @attributes[:action] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The WebhookTest object doesn't support updates.")
+      else
+        new_obj = WebhookTest.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   url (required) - string - URL for testing the webhook.
+    #   method - string - HTTP method(GET or POST).
+    #   encoding - string - HTTP encoding method.  Can be JSON, XML, or RAW (form data).
+    #   headers - object - Additional request headers.
+    #   body - object - Additional body parameters.
+    #   action - string - action for test body
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: url must be an String") if params.dig(:url) and !params.dig(:url).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: method must be an String") if params.dig(:method) and !params.dig(:method).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: encoding must be an String") if params.dig(:encoding) and !params.dig(:encoding).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: headers must be an Hash") if params.dig(:headers) and !params.dig(:headers).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: body must be an Hash") if params.dig(:body) and !params.dig(:body).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: url") unless params.dig(:url)
+
+      response, options = Api.send_request("/webhook_tests", :post, params, options)
+      WebhookTest.new(response.data, options)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.147
+  version: 1.0.152
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -150,6 +150,7 @@ files:
 - docs/user.md
 - docs/user_cipher_use.md
 - docs/user_request.md
+- docs/webhook_test.md
 - files.com.gemspec
 - lib/files.com.rb
 - lib/files.com/api.rb
@@ -221,6 +222,7 @@ files:
 - lib/files.com/models/user.rb
 - lib/files.com/models/user_cipher_use.rb
 - lib/files.com/models/user_request.rb
+- lib/files.com/models/webhook_test.rb
 - lib/files.com/response.rb
 - lib/files.com/sizable_io.rb
 - lib/files.com/system_profiler.rb