files.com 1.0.90

data/lib/files.com/errors.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Files
+  class Error < StandardError
+    attr_accessor :response
+
+    attr_reader :code
+    attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :http_status
+    attr_reader :json_body
+    attr_reader :message
+    attr_reader :request_id
+
+    def initialize(message = nil, http_status: nil, http_body: nil, json_body: nil, http_headers: nil, code: nil)
+      @message = message
+      @http_status = http_status
+      @http_body = http_body
+      @http_headers = http_headers || {}
+      @json_body = json_body
+      @code = code
+    end
+
+    def to_s
+      "#{@http_status.nil? ? "" : "[HTTP #{@http_status}] "}#{@message}"
+    end
+  end
+
+  class APIError < Error; end
+  class AuthenticationError < Error; end
+  class ConnectionError < Error; end
+  class InvalidRequestError < Error; end
+  class NotImplementedError < Error; end
+  class PermissionError < Error; end
+  class RateLimitError < Error; end
+  class TooManyRequestsError < Error; end
+  class ValidationError < Error; end
+
+  class InvalidParameterError < InvalidRequestError; end
+  class MissingParameterError < InvalidRequestError; end
+end

data/lib/files.com/list.rb

@@ -0,0 +1,95 @@
+module Files
+  class List
+    include Enumerable
+
+    def initialize(resource_wrapper, params, current_response = nil, current_options = nil, &request_page)
+      @resource_wrapper = resource_wrapper
+      @params = params
+      @current_response = current_response
+      @current_options = current_options
+      @request_page = request_page
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_page+.
+    def auto_paging_each
+      return enum_for(:auto_paging_each).lazy unless block_given?
+
+      loop do
+        page = next_page
+        break unless page.valid_response?
+
+        page.set_cursor
+
+        page.wrap_data do |data|
+          yield data
+        end
+        break if page.on_last_page?
+      end
+    end
+
+    # Iterates through each resource in the current page.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&block)
+      page = current_page
+      return [] unless page.valid_response?
+
+      page.set_cursor
+      page.wrap_data { |data| block.call data }
+    end
+
+    # Fetches the next page of resources (if there is one).
+    #
+    # This method will try to respect the per_page set. If none
+    # was given, the default per_page will be used.
+    def next_page
+      self.class.new(resource_wrapper, params, *request_page.call, &request_page)
+    end
+
+    protected
+
+    attr_reader :resource_wrapper,
+                :params,
+                :request_page
+
+    def current_page
+      @current_page ||= if @current_response and @current_options
+                          self
+                        else
+                          next_page
+                        end
+    end
+
+    def data
+      @current_response.data
+    end
+
+    def wrap_data
+      data.map do |object|
+        yield resource_wrapper.new(object, @current_options)
+      end
+    end
+
+    def set_cursor
+      params[:cursor] = @current_options[:client].cursor
+    end
+
+    def cursor
+      params[:cursor]
+    end
+
+    def valid_response?
+      @current_response.http_status == 200
+    end
+
+    def on_last_page?
+      !cursor or (data.count < params[:per_page])
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Files
+  class AccountLineItem
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Line item Id
+    def id
+      @attributes[:id]
+    end
+
+    # double - Line item amount
+    def amount
+      @attributes[:amount]
+    end
+
+    # double - Line item balance
+    def balance
+      @attributes[:balance]
+    end
+
+    # date-time - Line item created at
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # string - Line item currency
+    def currency
+      @attributes[:currency]
+    end
+
+    # string - Line item download uri
+    def download_uri
+      @attributes[:download_uri]
+    end
+
+    # array - Associated invoice line items
+    def invoice_line_items
+      @attributes[:invoice_line_items]
+    end
+
+    # string - Line item payment method
+    def method
+      @attributes[:method]
+    end
+
+    # array - Associated payment line items
+    def payment_line_items
+      @attributes[:payment_line_items]
+    end
+
+    # date-time - Date/time payment was reversed if applicable
+    def payment_reversed_at
+      @attributes[:payment_reversed_at]
+    end
+
+    # string - Type of payment if applicable
+    def payment_type
+      @attributes[:payment_type]
+    end
+
+    # string - Site name this line item is for
+    def site_name
+      @attributes[:site_name]
+    end
+
+    # string - Type of line item, either payment or invoice
+    def type
+      @attributes[:type]
+    end
+
+    # date-time - Line item updated at
+    def updated_at
+      @attributes[:updated_at]
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Files
+  class Action
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Action ID
+    def id
+      @attributes[:id]
+    end
+
+    # string - 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 - Action occurrence date/time
+    def when
+      @attributes[:when]
+    end
+
+    # string - The destination path for this action, if applicable
+    def destination
+      @attributes[:destination]
+    end
+
+    # string - Friendly displayed output
+    def display
+      @attributes[:display]
+    end
+
+    # string - IP Address that performed this action
+    def ip
+      @attributes[:ip]
+    end
+
+    # string - The source path for this action, if applicable
+    def source
+      @attributes[:source]
+    end
+
+    # array - Targets
+    def targets
+      @attributes[:targets]
+    end
+
+    # int64 - User ID
+    def user_id
+      @attributes[:user_id]
+    end
+
+    # string - Username
+    def username
+      @attributes[:username]
+    end
+
+    # string - Type of action
+    def action
+      @attributes[:action]
+    end
+
+    # string - Failure type.  If action was a user login or session failure, why did it fail?
+    def failure_type
+      @attributes[:failure_type]
+    end
+
+    # string - Interface on which this action occurred.
+    def interface
+      @attributes[:interface]
+    end
+  end
+end

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

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+module Files
+  class ApiKey
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - API Key ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # string - Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
+    def descriptive_label
+      @attributes[:descriptive_label]
+    end
+
+    def descriptive_label=(value)
+      @attributes[:descriptive_label] = value
+    end
+
+    # date-time - Time which API Key was created
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - API Key expiration date
+    def expires_at
+      @attributes[:expires_at]
+    end
+
+    def expires_at=(value)
+      @attributes[:expires_at] = value
+    end
+
+    # string - API Key actual key string
+    def key
+      @attributes[:key]
+    end
+
+    def key=(value)
+      @attributes[:key] = value
+    end
+
+    # date-time - API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
+    def last_use_at
+      @attributes[:last_use_at]
+    end
+
+    def last_use_at=(value)
+      @attributes[:last_use_at] = value
+    end
+
+    # string - Internal name for the API Key.  For your use.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # string - Folder path restriction for this api key. 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
+
+    # string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    def permission_set
+      @attributes[:permission_set]
+    end
+
+    def permission_set=(value)
+      @attributes[:permission_set] = value
+    end
+
+    # string - If this API key represents a Desktop app, what platform was it created on?
+    def platform
+      @attributes[:platform]
+    end
+
+    def platform=(value)
+      @attributes[:platform] = value
+    end
+
+    # int64 - User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
+    def user_id
+      @attributes[:user_id]
+    end
+
+    def user_id=(value)
+      @attributes[:user_id] = value
+    end
+
+    # Parameters:
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      Api.send_request("/api_keys/#{@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("/api_keys/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+    end
+
+    def save
+      if @attributes[:id]
+        update(@attributes)
+      else
+        new_obj = ApiKey.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.
+    #   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 `deleted_at` and `expires_at`.
+    #   filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
+    #   filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `expires_at`.
+    #   filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `expires_at`.
+    #   filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `expires_at`.
+    #   filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `expires_at`.
+    #   filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `expires_at`.
+    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: 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(ApiKey, params) do
+        Api.send_request("/api_keys", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    def self.find_current(params = {}, options = {})
+      response, options = Api.send_request("/api_key", :get, params, options)
+      ApiKey.new(response.data, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Api Key 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("/api_keys/#{params[:id]}", :get, params, options)
+      ApiKey.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.
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    #   path - string - Folder path restriction for this api key.
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
+
+      response, options = Api.send_request("/api_keys", :post, params, options)
+      ApiKey.new(response.data, options)
+    end
+
+    # Parameters:
+    #   expires_at - string - API Key expiration date
+    #   name - string - Internal name for the API Key.  For your use.
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    def self.update_current(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      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: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
+
+      response, options = Api.send_request("/api_key", :patch, params, options)
+      ApiKey.new(response.data, options)
+    end
+
+    # Parameters:
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    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: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
+      raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
+
+      response, options = Api.send_request("/api_keys/#{params[:id]}", :patch, params, options)
+      ApiKey.new(response.data, options)
+    end
+
+    def self.delete_current(params = {}, options = {})
+      response, _options = Api.send_request("/api_key", :delete, params, options)
+      response.data
+    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("/api_keys/#{params[:id]}", :delete, params, options)
+      response.data
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+    end
+  end
+end