files.com 1.0.149 → 1.0.154

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd795469d773a6bc190d054f7d487b3f0a7a934cb4e743beb76b1d9924dd0bf
-  data.tar.gz: d7905582db02d9a9fea04c5c68a0d9cc26ef8bb4509f6457236912143e5795cf
+  metadata.gz: '0967792b1162066ca96166b1997a60b73a734adf6bb2ef293434e39e2f8db5b3'
+  data.tar.gz: a355b8559f43c3df7df9b4a9dec34580c2f82354b74acf408d9b456ae0058d0d
 SHA512:
-  metadata.gz: fec91234ec2e70e0d59c87b2c13aa16e30df5484397d3cd303a3b27dd7494ea7b15b43444067177efb8e5f9746a1156b0a84dabd3fee444df6c3891856474172
-  data.tar.gz: 8cacc51b4d483ea38ca8d2ce44425848577c616477349a8c20830cc3e09db313103604ef051a10c76f752f99049985320e6c225680cceec02b9545f4ff2595a7
+  metadata.gz: bf29c59200ad503bf470b7a39491ab111c50d0ac52368d4425b4427b9e69fbd0449ac6c77d6ac484bc6bd6b06910e0c8c4e986e6398faffe4fba74b6731620c6
+  data.tar.gz: b9484b649c9cdfabb7924bae1421faaeabf867e5a5c4b0503a942d280c8ae400256d40e12d09d0bb9c20df6a3790481ddb7ee2b5d17eac3ca8651e710a252c9a

data/_VERSION

@@ -1 +1 @@
-1.0.149
+1.0.154

data/docs/api_key.md

@@ -61,17 +61,9 @@ Files::ApiKey.list(
 ## Show information about current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.find_current(
-  format: "", 
-  api_key: ""
-)
+Files::ApiKey.find_current
 ```
 
-### Parameters
-
-* `format` (string): 
-* `api_key` (object): 
-
 
 ---
 
@@ -153,17 +145,9 @@ Files::ApiKey.update(id,
 ## Delete current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.delete_current(
-  format: "", 
-  api_key: ""
-)
+Files::ApiKey.delete_current
 ```
 
-### 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,13 +74,5 @@ Files::Session.create(
 ## Delete user session (log out)
 
 ```
-Files::Session.delete(
-  format: "", 
-  session: ""
-)
+Files::Session.delete
 ```
-
-### Parameters
-
-* `format` (string): 
-* `session` (object): 

data/docs/site.md

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

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/errors.rb

@@ -175,6 +175,7 @@ module Files
   class ModelSaveErrorError < ProcessingFailureError; end
   class MultipartUploadsRequiredForRemotesError < ProcessingFailureError; end
   class MultipleProcessingErrorsError < ProcessingFailureError; end
+  class RecipientAlreadySharedError < ProcessingFailureError; end
   class RemoteServerErrorError < ProcessingFailureError; end
   class ResourceLockedError < ProcessingFailureError; end
   class SubfolderLockedError < ProcessingFailureError; end

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

@@ -176,13 +176,7 @@ 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
@@ -250,13 +244,7 @@ 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,13 +235,7 @@ 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,24 +574,12 @@ 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/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.149
+  version: 1.0.154
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-03-29 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