files.com 1.0.78 → 1.0.79

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a980877cfd1d13cd77d84319021702c5caa7bf8f74505756bf56bafce53aaad
-  data.tar.gz: 35bd639b7ccfa518f7f82ac6d78e602469b912d3410ac0eaea9a9eec7b412453
+  metadata.gz: 5d4c181cb97ed379aa31f30e0ed58a2d61ec8c8e7bddc4ec34dbcd2acda9445f
+  data.tar.gz: 633e26d621df9868a6d4020893a416f46fc93830e74f967224f1e304fe4f976a
 SHA512:
-  metadata.gz: 13e0d73c07f2664595c085a427ef1f6f29b86aec412d7229f07b4d2db91db5e750372c14a4e4e00f9dfd64e0d6478ca5903c2f45f859072bf08c40bed791be9a
-  data.tar.gz: a367d3a24b1d1c9edccd8e30dfffc65fd786edf9e5a799ec97456b1d503ec908bb44c8e87d23ef3119e213b101ca05dcaeba08146d0102d0087b8bf3307482a4
+  metadata.gz: 759cc4732208a1feba6206a4a6e43a2cb6ef720a40dfbb93e1fa7b1eb06538588965babe150b55ee980787d4366571db48f6493bb1207b91bae9447e60a5a525
+  data.tar.gz: 70bc236792070cbe2f7ae1536f10777792e936adb5df0224ea0cd9a85c53d5556b9761a731f883e0a4c501d9fc26d67163fb87a8adc2366a029bead99a320333

data/_VERSION

@@ -1 +1 @@
-1.0.78
+1.0.79

data/docs/site.md

@@ -106,6 +106,7 @@
   "user_lockout_lock_period": 1,
   "user_lockout_tries": 1,
   "user_lockout_within": 6,
+  "user_requests_enabled": true,
   "welcome_custom_text": "Welcome to my site!",
   "welcome_email_cc": "",
   "welcome_email_enabled": true,
@@ -217,6 +218,7 @@
 * `user_lockout_lock_period` (int64): How many hours to lock user out for failed password?
 * `user_lockout_tries` (int64): Number of login tries within `user_lockout_within` hours before users are locked out
 * `user_lockout_within` (int64): Number of hours for user lockout window
+* `user_requests_enabled` (boolean): Enable User Requests feature
 * `welcome_custom_text` (string): Custom text send in user welcome email
 * `welcome_email_cc` (email): Include this email in welcome emails if enabled
 * `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
@@ -298,6 +300,7 @@ Files::Site.update(
   non_sso_groups_allowed: true, 
   non_sso_users_allowed: true, 
   sharing_enabled: true, 
+  user_requests_enabled: true, 
   allowed_2fa_method_sms: true, 
   allowed_2fa_method_u2f: true, 
   allowed_2fa_method_totp: true, 
@@ -389,6 +392,7 @@ Files::Site.update(
 * `non_sso_groups_allowed` (boolean): If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
 * `non_sso_users_allowed` (boolean): If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
 * `sharing_enabled` (boolean): Allow bundle creation
+* `user_requests_enabled` (boolean): Enable User Requests feature
 * `allowed_2fa_method_sms` (boolean): Is SMS two factor authentication allowed?
 * `allowed_2fa_method_u2f` (boolean): Is U2F two factor authentication allowed?
 * `allowed_2fa_method_totp` (boolean): Is TOTP two factor authentication allowed?

data/docs/user_request.md

@@ -0,0 +1,93 @@
+# UserRequest
+
+## Example UserRequest Object
+
+```
+{
+  "name": "John Doe",
+  "email": "john.doe@files.com",
+  "details": "Changed Departments"
+}
+```
+
+* `name` (string): User's full name
+* `email` (email): User email address
+* `details` (string): Details of the user's request
+
+
+---
+
+## List User Requests
+
+```
+Files::UserRequest.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.
+
+
+---
+
+## Show User Request
+
+```
+Files::UserRequest.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Request ID.
+
+
+---
+
+## Create User Request
+
+```
+Files::UserRequest.create(
+  name: "name", 
+  email: "email", 
+  details: "details"
+)
+```
+
+### Parameters
+
+* `name` (string): Required - Name of user requested
+* `email` (string): Required - Email of user requested
+* `details` (string): Required - Details of the user request
+
+
+---
+
+## Delete User Request
+
+```
+Files::UserRequest.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - User Request ID.
+
+
+---
+
+## Delete User Request
+
+```
+user_request = Files::UserRequest.list_for(path).first
+
+user_request.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - User Request ID.

data/lib/files.com.rb

@@ -75,6 +75,7 @@ require "files.com/models/usage_daily_snapshot"
 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/dir"
 require "files.com/models/file_utils"

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

@@ -519,6 +519,11 @@ module Files
       @attributes[:user_lockout_within]
     end
 
+    # boolean - Enable User Requests feature
+    def user_requests_enabled
+      @attributes[:user_requests_enabled]
+    end
+
     # string - Custom text send in user welcome email
     def welcome_custom_text
       @attributes[:welcome_custom_text]
@@ -611,6 +616,7 @@ module Files
     #   non_sso_groups_allowed - boolean - If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
     #   non_sso_users_allowed - boolean - If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
     #   sharing_enabled - boolean - Allow bundle creation
+    #   user_requests_enabled - boolean - Enable User Requests feature
     #   allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
     #   allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
     #   allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Files
+  class UserRequest
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - User's full name
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # email - User email address
+    def email
+      @attributes[:email]
+    end
+
+    def email=(value)
+      @attributes[:email] = value
+    end
+
+    # string - Details of the user's request
+    def details
+      @attributes[:details]
+    end
+
+    def details=(value)
+      @attributes[:details] = value
+    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.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/user_requests/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The UserRequest object doesn't support updates.")
+      else
+        new_obj = UserRequest.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    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.
+    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)
+
+      response, options = Api.send_request("/user_requests", :get, params, options)
+      response.data.map do |entity_data|
+        UserRequest.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - User Request ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/user_requests/#{params[:id]}", :get, params, options)
+      UserRequest.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   name (required) - string - Name of user requested
+    #   email (required) - string - Email of user requested
+    #   details (required) - string - Details of the user request
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: email must be an String") if params.dig(:email) and !params.dig(:email).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: details must be an String") if params.dig(:details) and !params.dig(:details).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: name") unless params.dig(:name)
+      raise MissingParameterError.new("Parameter missing: email") unless params.dig(:email)
+      raise MissingParameterError.new("Parameter missing: details") unless params.dig(:details)
+
+      response, options = Api.send_request("/user_requests", :post, params, options)
+      UserRequest.new(response.data, options)
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, _options = Api.send_request("/user_requests/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, 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.78
+  version: 1.0.79
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -134,6 +134,7 @@ files:
 - docs/usage_snapshot.md
 - docs/user.md
 - docs/user_cipher_use.md
+- docs/user_request.md
 - files.com.gemspec
 - lib/files.com.rb
 - lib/files.com/api.rb
@@ -191,6 +192,7 @@ files:
 - lib/files.com/models/usage_snapshot.rb
 - lib/files.com/models/user.rb
 - lib/files.com/models/user_cipher_use.rb
+- lib/files.com/models/user_request.rb
 - lib/files.com/response.rb
 - lib/files.com/sizable_io.rb
 - lib/files.com/system_profiler.rb