files.com 1.0.127 → 1.0.128

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Files
+  class BundleRegistration
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Registration cookie code
+    def code
+      @attributes[:code]
+    end
+
+    # string - Registrant name
+    def name
+      @attributes[:name]
+    end
+
+    # string - Registrant company name
+    def company
+      @attributes[:company]
+    end
+
+    # string - Registrant email address
+    def email
+      @attributes[:email]
+    end
+
+    # string - InboxRegistration cookie code, if there is an associated InboxRegistration
+    def inbox_code
+      @attributes[:inbox_code]
+    end
+
+    # int64 - Id of associated form field set
+    def form_field_set_id
+      @attributes[:form_field_set_id]
+    end
+
+    # string - Data for form field set with form field ids as keys and user data as values
+    def form_field_data
+      @attributes[:form_field_data]
+    end
+  end
+end

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

@@ -32,7 +32,7 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  Send a cursor value 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.
     #   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[last_login_at]=desc). Valid fields are `remote_server_type`, `site_id`, `event_type`, `created_at` or `status`.
+    #   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 `remote_server_type`, `event_type`, `created_at` or `status`.
     #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
     #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.
     #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type` or `status`.

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

@@ -9,6 +9,16 @@ module Files
       @options = options || {}
     end
 
+    # string - Status of file operation. Possible values: completed, enqueued.
+    def status
+      @attributes[:status]
+    end
+
+    # int64 - If status is enqueued, this is the id of the FileMigration to check for status updates.
+    def file_migration_id
+      @attributes[:file_migration_id]
+    end
+
     # Copy file/folder
     #
     # Parameters:
@@ -78,8 +88,8 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
 
-      response, _options = Api.send_request("/file_actions/copy/#{params[:path]}", :post, params, options)
-      response.data
+      response, options = Api.send_request("/file_actions/copy/#{params[:path]}", :post, params, options)
+      FileAction.new(response.data, options)
     end
 
     # Move file/folder
@@ -94,8 +104,8 @@ module Files
       raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
       raise MissingParameterError.new("Parameter missing: destination") unless params.dig(:destination)
 
-      response, _options = Api.send_request("/file_actions/move/#{params[:path]}", :post, params, options)
-      response.data
+      response, options = Api.send_request("/file_actions/move/#{params[:path]}", :post, params, options)
+      FileAction.new(response.data, options)
     end
 
     # Begin file upload

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Files
+  class FormField
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Form field id
+    def id
+      @attributes[:id]
+    end
+
+    # string - Label to be displayed
+    def label
+      @attributes[:label]
+    end
+
+    # boolean - Is this a required field?
+    def required
+      @attributes[:required]
+    end
+
+    # string - Help text to be displayed
+    def help_text
+      @attributes[:help_text]
+    end
+
+    # string - Type of Field
+    def field_type
+      @attributes[:field_type]
+    end
+
+    # string - Options to display for radio and dropdown
+    def options_for_select
+      @attributes[:options_for_select]
+    end
+
+    # string - Default option for radio and dropdown
+    def default_option
+      @attributes[:default_option]
+    end
+
+    # int64 - Form field set id
+    def form_field_set_id
+      @attributes[:form_field_set_id]
+    end
+  end
+end

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

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Files
+  class FormFieldSet
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Form field set id
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Title to be displayed
+    def title
+      @attributes[:title]
+    end
+
+    def title=(value)
+      @attributes[:title] = value
+    end
+
+    # int64 - Layout of the form
+    def form_layout
+      @attributes[:form_layout]
+    end
+
+    def form_layout=(value)
+      @attributes[:form_layout] = value
+    end
+
+    # array - Associated form fields
+    def form_fields
+      @attributes[:form_fields]
+    end
+
+    def form_fields=(value)
+      @attributes[:form_fields] = value
+    end
+
+    # int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # Parameters:
+    #   title - string - Title to be displayed
+    #   form_fields - array(object)
+    def update(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 InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/form_field_sets/#{@attributes[:id]}", :patch, params, @options)
+    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("/form_field_sets/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = FormFieldSet.create(@attributes, @options)
+        @attributes = new_obj.attributes
+      end
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   cursor - string - Used for pagination.  Send a cursor value 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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    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: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+
+      List.new(FormFieldSet, params) do
+        Api.send_request("/form_field_sets", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Form Field Set 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("/form_field_sets/#{params[:id]}", :get, params, options)
+      FormFieldSet.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    #   title - string - Title to be displayed
+    #   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)
+      raise InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)
+
+      response, options = Api.send_request("/form_field_sets", :post, params, options)
+      FormFieldSet.new(response.data, options)
+    end
+
+    # Parameters:
+    #   title - string - Title to be displayed
+    #   form_fields - array(object)
+    def self.update(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 InvalidParameterError.new("Bad parameter: title must be an String") if params.dig(:title) and !params.dig(:title).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: form_fields must be an Array") if params.dig(:form_fields) and !params.dig(:form_fields).is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/form_field_sets/#{params[:id]}", :patch, params, options)
+      FormFieldSet.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("/form_field_sets/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end

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

@@ -108,7 +108,7 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  Send a cursor value 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.
     #   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[last_login_at]=desc). Valid fields are `active`, `site_id` or `name`.
+    #   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 `name`.
     #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `name`.
     #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `name`.
     #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `name`.

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

@@ -175,7 +175,7 @@ module Files
     #   display - string - Display format. Leave blank or set to `full` or `parent`.
     #   cursor - string - Used for pagination.  Send a cursor value 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.
     #   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[last_login_at]=desc). Valid fields are `site_id`, `path`, `created_at`, `folder` or `user_id`.
+    #   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 `path`, `folder`, `user_id` or `created_at`.
     #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.
     #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `folder` or `path`.
     #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `folder` or `path`.

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Files
+  class InboxRegistration
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Registration cookie code
+    def code
+      @attributes[:code]
+    end
+
+    # string - Registrant name
+    def name
+      @attributes[:name]
+    end
+
+    # string - Registrant company name
+    def company
+      @attributes[:company]
+    end
+
+    # string - Registrant email address
+    def email
+      @attributes[:email]
+    end
+
+    # int64 - Id of associated form field set
+    def form_field_set_id
+      @attributes[:form_field_set_id]
+    end
+
+    # string - Data for form field set with form field ids as keys and user data as values
+    def form_field_data
+      @attributes[:form_field_data]
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Files
+  class InboxUpload
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    def inbox_registration
+      @attributes[:inbox_registration]
+    end
+
+    # string - Upload 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
+
+    # date-time - Upload date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  Send a cursor value 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.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    #   inbox_registration_id - int64 - InboxRegistration ID
+    #   inbox_id - int64 - Inbox ID
+    def self.list(params = {}, options = {})
+      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: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_registration_id must be an Integer") if params.dig(:inbox_registration_id) and !params.dig(:inbox_registration_id).is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: inbox_id must be an Integer") if params.dig(:inbox_id) and !params.dig(:inbox_id).is_a?(Integer)
+
+      List.new(InboxUpload, params) do
+        Api.send_request("/inbox_uploads", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

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

@@ -169,7 +169,7 @@ module Files
     #   user_id - int64 - DEPRECATED: Show notifications for this User ID. Use `filter[user_id]` instead.
     #   cursor - string - Used for pagination.  Send a cursor value 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.
     #   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[last_login_at]=desc). Valid fields are `site_id`, `path`, `user_id` or `group_id`.
+    #   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 `path`, `user_id` or `group_id`.
     #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.
     #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `user_id`, `group_id` or `path`.
     #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `user_id`, `group_id` or `path`.

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

@@ -107,7 +107,7 @@ module Files
     # Parameters:
     #   cursor - string - Used for pagination.  Send a cursor value 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.
     #   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[last_login_at]=desc). Valid fields are `deleted_at`, `group_id`, `path`, `user_id` or `permission`.
+    #   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 `group_id`, `path`, `user_id` or `permission`.
     #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.
     #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `group_id`, `user_id` or `path`.
     #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `group_id`, `user_id` or `path`.