files.com 1.1.669 → 1.1.671

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

@@ -150,6 +150,15 @@ module Files
       path
     end
 
+    # int64 - File/Folder ID.  Used only for ExaVault compatibility API.  Do not use for other purposes, as this value will not always be set.
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
     # string - File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
     def path
       @attributes[:path]
@@ -159,6 +168,15 @@ module Files
       @attributes[:path] = value
     end
 
+    # string - File/Folder absolute path for Bundle Trusted Relay use
+    def path_absolute
+      @attributes[:path_absolute]
+    end
+
+    def path_absolute=(value)
+      @attributes[:path_absolute] = value
+    end
+
     # int64 - User ID of the User who created the file/folder
     def created_by_id
       @attributes[:created_by_id]
@@ -425,6 +443,42 @@ module Files
       @attributes[:is_locked] = value
     end
 
+    # int64 - Used for internal bandwidth tracking
+    def remote_server_id
+      @attributes[:remote_server_id]
+    end
+
+    def remote_server_id=(value)
+      @attributes[:remote_server_id] = value
+    end
+
+    # object - Used for internal url management
+    def headers
+      @attributes[:headers]
+    end
+
+    def headers=(value)
+      @attributes[:headers] = value
+    end
+
+    # array(string) - Used for internal url management
+    def socks_ips
+      @attributes[:socks_ips]
+    end
+
+    def socks_ips=(value)
+      @attributes[:socks_ips] = value
+    end
+
+    # string - For use with internal services and should also be with headers and socks_ips
+    def internal_download_uri
+      @attributes[:internal_download_uri]
+    end
+
+    def internal_download_uri=(value)
+      @attributes[:internal_download_uri] = value
+    end
+
     # string - Link to download file. Provided only in response to a download request.
     def download_uri
       @attributes[:download_uri]
@@ -470,6 +524,15 @@ module Files
       @attributes[:mkdir_parents] = value
     end
 
+    # string
+    def bundle_registration_code
+      @attributes[:bundle_registration_code]
+    end
+
+    def bundle_registration_code=(value)
+      @attributes[:bundle_registration_code] = value
+    end
+
     def save
       new_obj = Folder.create(path, @attributes, @options)
       @attributes = new_obj.attributes
@@ -480,6 +543,8 @@ module Files
     #   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 or the X-Files-Cursor-Prev header.
     #   per_page - int64 - Number of records to show per page.  (Max: 10000, 1,000 or less is recommended).
     #   path (required) - string - Path to operate on.
+    #   action - string - Action to take.  Can be `count`, `size`, `permissions`, or blank.
+    #   bundle_registration_code - string
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
     #   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
@@ -495,6 +560,8 @@ module Files
       raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: action must be an String") if params[:action] and !params[:action].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: preview_size must be an String") if params[:preview_size] and !params[:preview_size].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
       raise InvalidParameterError.new("Bad parameter: search must be an String") if params[:search] and !params[:search].is_a?(String)
@@ -512,11 +579,13 @@ module Files
     #   path (required) - string - Path to operate on.
     #   mkdir_parents - boolean - Create parent directories if they do not exist?
     #   provided_mtime - string - User provided modification time.
+    #   bundle_registration_code - string
     def self.create(path, params = {}, options = {})
       params ||= {}
       params[:path] = path
       raise InvalidParameterError.new("Bad parameter: path must be an String") if params[:path] and !params[:path].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: provided_mtime must be an String") if params[:provided_mtime] and !params[:provided_mtime].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: bundle_registration_code must be an String") if params[:bundle_registration_code] and !params[:bundle_registration_code].is_a?(String)
       raise MissingParameterError.new("Parameter missing: path") unless params[:path]
 
       response, options = Api.send_request("/folders/#{params[:path]}", :post, params, options)

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

@@ -197,6 +197,15 @@ module Files
       FormFieldSet.new(response.data, options)
     end
 
+    # Parameters:
+    #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+    def self.create_export(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
+
+      response, options = Api.send_request("/form_field_sets/create_export", :post, params, options)
+      Export.new(response.data, options)
+    end
+
     # Parameters:
     #   title - string - Title to be displayed
     #   workspace_id - int64 - Workspace ID

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

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+
+module Files
+  class FrontEndServer
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Private IP of the server.
+    def ip
+      @attributes[:ip]
+    end
+
+    def ip=(value)
+      @attributes[:ip] = value
+    end
+
+    # string - Public IP of the server.
+    def external_ip
+      @attributes[:external_ip]
+    end
+
+    def external_ip=(value)
+      @attributes[:external_ip] = value
+    end
+
+    # boolean - Flag to signal to other systems to use this config
+    def assigned
+      @attributes[:assigned]
+    end
+
+    def assigned=(value)
+      @attributes[:assigned] = value
+    end
+
+    # SslCertificate - SSL certificate information for the site associated with this IP, if available.
+    def site
+      @attributes[:site]
+    end
+
+    def site=(value)
+      @attributes[:site] = value
+    end
+
+    # boolean
+    def ftp_enabled
+      @attributes[:ftp_enabled]
+    end
+
+    def ftp_enabled=(value)
+      @attributes[:ftp_enabled] = value
+    end
+
+    # boolean
+    def sftp_enabled
+      @attributes[:sftp_enabled]
+    end
+
+    def sftp_enabled=(value)
+      @attributes[:sftp_enabled] = value
+    end
+
+    # string - Which SFTP host key to use.
+    def sftp_host_key_type
+      @attributes[:sftp_host_key_type]
+    end
+
+    def sftp_host_key_type=(value)
+      @attributes[:sftp_host_key_type] = value
+    end
+
+    # string - SFTP Host Key private key if using a custom key.
+    def sftp_host_key_private_key
+      @attributes[:sftp_host_key_private_key]
+    end
+
+    def sftp_host_key_private_key=(value)
+      @attributes[:sftp_host_key_private_key] = value
+    end
+
+    # int64 - Site Id
+    def site_id
+      @attributes[:site_id]
+    end
+
+    def site_id=(value)
+      @attributes[:site_id] = value
+    end
+
+    # string - A message to show users when they connect via FTP or SFTP.
+    def motd_text
+      @attributes[:motd_text]
+    end
+
+    def motd_text=(value)
+      @attributes[:motd_text] = value
+    end
+
+    # boolean - Show message to users connecting via FTP
+    def motd_use_for_ftp
+      @attributes[:motd_use_for_ftp]
+    end
+
+    def motd_use_for_ftp=(value)
+      @attributes[:motd_use_for_ftp] = value
+    end
+
+    # boolean - Show message to users connecting via SFTP
+    def motd_use_for_sftp
+      @attributes[:motd_use_for_sftp]
+    end
+
+    def motd_use_for_sftp=(value)
+      @attributes[:motd_use_for_sftp] = value
+    end
+
+    # array(object) - Active Custom Domains for the site associated with this IP, with their attached SSL certificate content.
+    def custom_domains
+      @attributes[:custom_domains]
+    end
+
+    def custom_domains=(value)
+      @attributes[:custom_domains] = value
+    end
+
+    # string - Pair type for General Use Public IPs
+    def pair_type
+      @attributes[:pair_type]
+    end
+
+    def pair_type=(value)
+      @attributes[:pair_type] = value
+    end
+
+    # string - Server's short name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Server's full hostname.
+    def hostname
+      @attributes[:hostname]
+    end
+
+    def hostname=(value)
+      @attributes[:hostname] = value
+    end
+
+    # string - Availability zone where this server lives.
+    def zone
+      @attributes[:zone]
+    end
+
+    def zone=(value)
+      @attributes[:zone] = value
+    end
+
+    # array(string) - An array of public and private ip address pairs.
+    def ips
+      @attributes[:ips]
+    end
+
+    def ips=(value)
+      @attributes[:ips] = value
+    end
+
+    # string - Primary Internal IP.
+    def primary_ip
+      @attributes[:primary_ip]
+    end
+
+    def primary_ip=(value)
+      @attributes[:primary_ip] = value
+    end
+
+    # string - Primary Public IP.
+    def primary_ip_public
+      @attributes[:primary_ip_public]
+    end
+
+    def primary_ip_public=(value)
+      @attributes[:primary_ip_public] = value
+    end
+
+    # string - Security Opt Out Internal IP.
+    def soo_ip
+      @attributes[:soo_ip]
+    end
+
+    def soo_ip=(value)
+      @attributes[:soo_ip] = value
+    end
+
+    # string - Security Opt Out Public IP.
+    def soo_ip_public
+      @attributes[:soo_ip_public]
+    end
+
+    def soo_ip_public=(value)
+      @attributes[:soo_ip_public] = value
+    end
+
+    # string - Exavault Internal IP.
+    def exavault_ip
+      @attributes[:exavault_ip]
+    end
+
+    def exavault_ip=(value)
+      @attributes[:exavault_ip] = value
+    end
+
+    # string - Exavault Public IP.
+    def exavault_ip_public
+      @attributes[:exavault_ip_public]
+    end
+
+    def exavault_ip_public=(value)
+      @attributes[:exavault_ip_public] = value
+    end
+
+    # string - Exavault Security Opt Out Internal IP.
+    def exavault_soo_ip
+      @attributes[:exavault_soo_ip]
+    end
+
+    def exavault_soo_ip=(value)
+      @attributes[:exavault_soo_ip] = value
+    end
+
+    # string - Exavault Security Opt Out Public IP.
+    def exavault_soo_ip_public
+      @attributes[:exavault_soo_ip_public]
+    end
+
+    def exavault_soo_ip_public=(value)
+      @attributes[:exavault_soo_ip_public] = value
+    end
+
+    # string - Smartfile Internal IP.
+    def smartfile_ip
+      @attributes[:smartfile_ip]
+    end
+
+    def smartfile_ip=(value)
+      @attributes[:smartfile_ip] = value
+    end
+
+    # string - Smartfile Public IP.
+    def smartfile_ip_public
+      @attributes[:smartfile_ip_public]
+    end
+
+    def smartfile_ip_public=(value)
+      @attributes[:smartfile_ip_public] = value
+    end
+
+    # string - Smartfile Security Opt Out Internal IP.
+    def smartfile_soo_ip
+      @attributes[:smartfile_soo_ip]
+    end
+
+    def smartfile_soo_ip=(value)
+      @attributes[:smartfile_soo_ip] = value
+    end
+
+    # string - Smartfile Security Opt Out Public IP.
+    def smartfile_soo_ip_public
+      @attributes[:smartfile_soo_ip_public]
+    end
+
+    def smartfile_soo_ip_public=(value)
+      @attributes[:smartfile_soo_ip_public] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The FrontEndServer object doesn't support updates.")
+      else
+        new_obj = FrontEndServer.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   name (required) - string - Server's short name.
+    #   hostname - string - Server's full hostname.
+    #   zone - string - Availability zone where this server lives.
+    #   ips - array(string) - An array of public and private ip address pairs.
+    #   ips[private_ip] (required) - array(string) - Private IP address associated with the server.
+    #   ips[public_ip] - array(string) - Public IP address associated with the server.
+    #   primary_ip - string - Primary Internal IP.
+    #   primary_ip_public - string - Primary Public IP.
+    #   soo_ip - string - Security Opt Out Internal IP.
+    #   soo_ip_public - string - Security Opt Out Public IP.
+    #   exavault_ip - string - Exavault Internal IP.
+    #   exavault_ip_public - string - Exavault Public IP.
+    #   exavault_soo_ip - string - Exavault Security Opt Out Internal IP.
+    #   exavault_soo_ip_public - string - Exavault Security Opt Out Public IP.
+    #   smartfile_ip - string - Smartfile Internal IP.
+    #   smartfile_ip_public - string - Smartfile Public IP.
+    #   smartfile_soo_ip - string - Smartfile Security Opt Out Internal IP.
+    #   smartfile_soo_ip_public - string - Smartfile Security Opt Out Public IP.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: hostname must be an String") if params[:hostname] and !params[:hostname].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: zone must be an String") if params[:zone] and !params[:zone].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: ips must be an Array") if params[:ips] and !params[:ips].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: primary_ip must be an String") if params[:primary_ip] and !params[:primary_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: primary_ip_public must be an String") if params[:primary_ip_public] and !params[:primary_ip_public].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: soo_ip must be an String") if params[:soo_ip] and !params[:soo_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: soo_ip_public must be an String") if params[:soo_ip_public] and !params[:soo_ip_public].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: exavault_ip must be an String") if params[:exavault_ip] and !params[:exavault_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: exavault_ip_public must be an String") if params[:exavault_ip_public] and !params[:exavault_ip_public].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: exavault_soo_ip must be an String") if params[:exavault_soo_ip] and !params[:exavault_soo_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: exavault_soo_ip_public must be an String") if params[:exavault_soo_ip_public] and !params[:exavault_soo_ip_public].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: smartfile_ip must be an String") if params[:smartfile_ip] and !params[:smartfile_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: smartfile_ip_public must be an String") if params[:smartfile_ip_public] and !params[:smartfile_ip_public].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: smartfile_soo_ip must be an String") if params[:smartfile_soo_ip] and !params[:smartfile_soo_ip].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: smartfile_soo_ip_public must be an String") if params[:smartfile_soo_ip_public] and !params[:smartfile_soo_ip_public].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+
+      response, options = Api.send_request("/front_end_servers", :post, params, options)
+      Ip.new(response.data, options)
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Files
+  class FrontendMetric
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # string - Statsd metric type
+    def metric_type
+      @attributes[:metric_type]
+    end
+
+    def metric_type=(value)
+      @attributes[:metric_type] = value
+    end
+
+    # string - Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
+    def subkey
+      @attributes[:subkey]
+    end
+
+    def subkey=(value)
+      @attributes[:subkey] = value
+    end
+
+    # int64 - For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.
+    def ms
+      @attributes[:ms]
+    end
+
+    def ms=(value)
+      @attributes[:ms] = value
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The FrontendMetric object doesn't support updates.")
+      else
+        new_obj = FrontendMetric.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   metric_type (required) - string - Statsd metric type.  Use `timing` to submit the amount of time something took, or `increment` to increment a counter
+    #   subkey (required) - string - Where in statsd to store the metric. The final key in statsd will be `files-react.[environment].[subkey]`
+    #   ms - int64 - For timing metrics, the number of milliseconds. Required if `metric_type` is `timing`.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: metric_type must be an String") if params[:metric_type] and !params[:metric_type].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: subkey must be an String") if params[:subkey] and !params[:subkey].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: ms must be an Integer") if params[:ms] and !params[:ms].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: metric_type") unless params[:metric_type]
+      raise MissingParameterError.new("Parameter missing: subkey") unless params[:subkey]
+
+      response, options = Api.send_request("/frontend_metrics", :post, params, options)
+      FrontendMetric.new(response.data, options)
+    end
+  end
+end