files.com 1.0.92

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

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module Files
+  class SsoStrategy
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # array - SSO Protocol
+    def protocol
+      @attributes[:protocol]
+    end
+
+    # string - Provider name
+    def provider
+      @attributes[:provider]
+    end
+
+    # string - Custom label for the SSO provider on the login page.
+    def label
+      @attributes[:label]
+    end
+
+    # string - URL holding a custom logo for the SSO provider on the login page.
+    def logo_url
+      @attributes[:logo_url]
+    end
+
+    # int64 - ID
+    def id
+      @attributes[:id]
+    end
+
+    # string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
+    def saml_provider_cert_fingerprint
+      @attributes[:saml_provider_cert_fingerprint]
+    end
+
+    # string - Identity provider issuer url
+    def saml_provider_issuer_url
+      @attributes[:saml_provider_issuer_url]
+    end
+
+    # string - Metadata URL for the SAML identity provider
+    def saml_provider_metadata_url
+      @attributes[:saml_provider_metadata_url]
+    end
+
+    # string - Identity provider SLO endpoint
+    def saml_provider_slo_target_url
+      @attributes[:saml_provider_slo_target_url]
+    end
+
+    # string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
+    def saml_provider_sso_target_url
+      @attributes[:saml_provider_sso_target_url]
+    end
+
+    # string - SCIM authentication type.
+    def scim_authentication_method
+      @attributes[:scim_authentication_method]
+    end
+
+    # string - SCIM username.
+    def scim_username
+      @attributes[:scim_username]
+    end
+
+    # string - Subdomain
+    def subdomain
+      @attributes[:subdomain]
+    end
+
+    # boolean - Auto-provision users?
+    def provision_users
+      @attributes[:provision_users]
+    end
+
+    # boolean - Auto-provision group membership based on group memberships on the SSO side?
+    def provision_groups
+      @attributes[:provision_groups]
+    end
+
+    # boolean - Auto-deprovision users?
+    def deprovision_users
+      @attributes[:deprovision_users]
+    end
+
+    # boolean - Auto-deprovision group membership based on group memberships on the SSO side?
+    def deprovision_groups
+      @attributes[:deprovision_groups]
+    end
+
+    # string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
+    def provision_group_default
+      @attributes[:provision_group_default]
+    end
+
+    # string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
+    def provision_group_exclusion
+      @attributes[:provision_group_exclusion]
+    end
+
+    # string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
+    def provision_group_inclusion
+      @attributes[:provision_group_inclusion]
+    end
+
+    # string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
+    def provision_group_required
+      @attributes[:provision_group_required]
+    end
+
+    # boolean - Auto-provisioned users get Sharing permission?
+    def provision_attachments_permission
+      @attributes[:provision_attachments_permission]
+    end
+
+    # boolean - Auto-provisioned users get WebDAV permission?
+    def provision_dav_permission
+      @attributes[:provision_dav_permission]
+    end
+
+    # boolean - Auto-provisioned users get FTP permission?
+    def provision_ftp_permission
+      @attributes[:provision_ftp_permission]
+    end
+
+    # boolean - Auto-provisioned users get SFTP permission?
+    def provision_sftp_permission
+      @attributes[:provision_sftp_permission]
+    end
+
+    # string - Default time zone for auto provisioned users.
+    def provision_time_zone
+      @attributes[:provision_time_zone]
+    end
+
+    # string - Base DN for looking up users in LDAP server
+    def ldap_base_dn
+      @attributes[:ldap_base_dn]
+    end
+
+    # string - Domain name that will be appended to LDAP usernames
+    def ldap_domain
+      @attributes[:ldap_domain]
+    end
+
+    # boolean - Is strategy enabled?
+    def enabled
+      @attributes[:enabled]
+    end
+
+    # string - LDAP host
+    def ldap_host
+      @attributes[:ldap_host]
+    end
+
+    # string - LDAP backup host
+    def ldap_host_2
+      @attributes[:ldap_host_2]
+    end
+
+    # string - LDAP backup host
+    def ldap_host_3
+      @attributes[:ldap_host_3]
+    end
+
+    # int64 - LDAP port
+    def ldap_port
+      @attributes[:ldap_port]
+    end
+
+    # boolean - Use secure LDAP?
+    def ldap_secure
+      @attributes[:ldap_secure]
+    end
+
+    # string - Username for signing in to LDAP server.
+    def ldap_username
+      @attributes[:ldap_username]
+    end
+
+    # string - LDAP username field
+    def ldap_username_field
+      @attributes[:ldap_username_field]
+    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("/sso_strategies", :get, params, options)
+      response.data.map do |entity_data|
+        SsoStrategy.new(entity_data, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Sso Strategy 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("/sso_strategies/#{params[:id]}", :get, params, options)
+      SsoStrategy.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Files
+  class Status
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Status http code
+    def code
+      @attributes[:code]
+    end
+
+    # string - Error message
+    def message
+      @attributes[:message]
+    end
+
+    # string - Status message
+    def status
+      @attributes[:status]
+    end
+
+    # Additional data
+    def data
+      @attributes[:data]
+    end
+
+    # array - A list of api errors
+    def errors
+      @attributes[:errors]
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Files
+  class Style
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Style ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - 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]
+    end
+
+    def path=(value)
+      @attributes[:path] = value
+    end
+
+    # Logo
+    def logo
+      @attributes[:logo]
+    end
+
+    def logo=(value)
+      @attributes[:logo] = value
+    end
+
+    # Logo thumbnail
+    def thumbnail
+      @attributes[:thumbnail]
+    end
+
+    def thumbnail=(value)
+      @attributes[:thumbnail] = value
+    end
+
+    # file - Logo for custom branding.
+    def file
+      @attributes[:file]
+    end
+
+    def file=(value)
+      @attributes[:file] = value
+    end
+
+    # Parameters:
+    #   file (required) - file - Logo for custom branding.
+    def update(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)
+
+      Api.send_request("/styles/#{@attributes[:path]}", :patch, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:path] = @attributes[:path]
+      raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      Api.send_request("/styles/#{@attributes[:path]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      update(@attributes)
+    end
+
+    # Parameters:
+    #   path (required) - string - Style path.
+    def self.find(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      response, options = Api.send_request("/styles/#{params[:path]}", :get, params, options)
+      Style.new(response.data, options)
+    end
+
+    def self.get(path, params = {}, options = {})
+      find(path, params, options)
+    end
+
+    # Parameters:
+    #   file (required) - file - Logo for custom branding.
+    def self.update(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+      raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)
+
+      response, options = Api.send_request("/styles/#{params[:path]}", :patch, params, options)
+      Style.new(response.data, options)
+    end
+
+    def self.delete(path, params = {}, options = {})
+      params ||= {}
+      params[:path] = path
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
+
+      response, _options = Api.send_request("/styles/#{params[:path]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(path, params = {}, options = {})
+      delete(path, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Files
+  class UsageDailySnapshot
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - ID of the usage record
+    def id
+      @attributes[:id]
+    end
+
+    # date - The date of this usage record
+    def date
+      @attributes[:date]
+    end
+
+    # int64 - The quantity of storage held for this site
+    def current_storage
+      @attributes[:current_storage]
+    end
+
+    # array - Usage broken down by each top-level folder
+    def usage_by_top_level_dir
+      @attributes[:usage_by_top_level_dir]
+    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.
+    #   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.
+    #   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`, `date` or `usage_snapshot_id`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
+    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)
+      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: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
+
+      List.new(UsageDailySnapshot, params) do
+        Api.send_request("/usage_daily_snapshots", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end