files.com 1.1.621 → 1.1.623

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Files
+  class EventDeliveryAttempt
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Event Delivery Attempt ID
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - Event Record ID
+    def event_record_id
+      @attributes[:event_record_id]
+    end
+
+    # int64 - Event Subscription ID
+    def event_subscription_id
+      @attributes[:event_subscription_id]
+    end
+
+    # int64 - Event Target ID
+    def event_target_id
+      @attributes[:event_target_id]
+    end
+
+    # int64 - Workspace ID. 0 means the default workspace or site-wide.
+    def workspace_id
+      @attributes[:workspace_id]
+    end
+
+    # string - Delivery status.
+    def status
+      @attributes[:status]
+    end
+
+    # int64 - Number of delivery attempts made.
+    def attempt_number
+      @attributes[:attempt_number]
+    end
+
+    # int64 - HTTP response code, if applicable.
+    def response_code
+      @attributes[:response_code]
+    end
+
+    # string - Delivery error message, if applicable.
+    def error_message
+      @attributes[:error_message]
+    end
+
+    # string - Delivery response body, if applicable.
+    def response_body
+      @attributes[:response_body]
+    end
+
+    # int64 - Delivery latency in milliseconds.
+    def latency_ms
+      @attributes[:latency_ms]
+    end
+
+    # date-time - Successful delivery date/time.
+    def delivered_at
+      @attributes[:delivered_at]
+    end
+
+    # date-time - Most recent attempt date/time.
+    def last_attempted_at
+      @attributes[:last_attempted_at]
+    end
+
+    # date-time - Next scheduled attempt date/time.
+    def next_attempt_at
+      @attributes[:next_attempt_at]
+    end
+
+    # date-time - Delivery Attempt create date/time.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   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. Valid fields are `status`, `event_record_id`, `event_target_id` or `workspace_id`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `status`, `workspace_id`, `event_record_id` or `event_target_id`. Valid field combinations are `[ workspace_id, status ]`, `[ workspace_id, event_record_id ]` or `[ workspace_id, event_target_id ]`.
+    def self.list(params = {}, options = {})
+      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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+
+      List.new(EventDeliveryAttempt, params) do
+        Api.send_request("/event_delivery_attempts", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Event Delivery Attempt ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/event_delivery_attempts/#{params[:id]}", :get, params, options)
+      EventDeliveryAttempt.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Files
+  class EventRecord
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Event Record ID
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - Workspace ID. 0 means the default workspace or site-wide.
+    def workspace_id
+      @attributes[:workspace_id]
+    end
+
+    # string - Stable event UUID.
+    def event_uuid
+      @attributes[:event_uuid]
+    end
+
+    # string - Versioned event type string.
+    def event_type
+      @attributes[:event_type]
+    end
+
+    # string - Event severity.
+    def severity
+      @attributes[:severity]
+    end
+
+    # string - Source record type.
+    def source_type
+      @attributes[:source_type]
+    end
+
+    # int64 - Source record ID.
+    def source_id
+      @attributes[:source_id]
+    end
+
+    # date-time - Event occurrence date/time.
+    def occurred_at
+      @attributes[:occurred_at]
+    end
+
+    # string - Human-readable event title.
+    def human_title
+      @attributes[:human_title]
+    end
+
+    # string - Human-readable event summary.
+    def human_summary
+      @attributes[:human_summary]
+    end
+
+    # array(object) - Human-readable event detail fields.
+    def human_fields
+      @attributes[:human_fields]
+    end
+
+    # object - Actor associated with the event.
+    def actor
+      @attributes[:actor]
+    end
+
+    # array(object) - Resources associated with the event.
+    def resources
+      @attributes[:resources]
+    end
+
+    # object - Event payload.
+    def payload
+      @attributes[:payload]
+    end
+
+    # date-time - Event Record create date/time.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   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. Valid fields are `event_type`, `created_at` or `workspace_id`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type` or `workspace_id`. Valid field combinations are `[ event_type, created_at ]`, `[ workspace_id, created_at ]`, `[ workspace_id, event_type ]` or `[ workspace_id, event_type, created_at ]`.
+    #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+    #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+    #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `event_type`.
+    #   filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+    #   filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
+    def self.list(params = {}, options = {})
+      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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
+
+      List.new(EventRecord, params) do
+        Api.send_request("/event_records", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Event Record ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/event_records/#{params[:id]}", :get, params, options)
+      EventRecord.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+  end
+end

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

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+
+module Files
+  class EventSubscription
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Event Subscription ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # int64 - Event Channel ID
+    def event_channel_id
+      @attributes[:event_channel_id]
+    end
+
+    def event_channel_id=(value)
+      @attributes[:event_channel_id] = value
+    end
+
+    # int64 - Workspace ID. 0 means the default workspace or site-wide.
+    def workspace_id
+      @attributes[:workspace_id]
+    end
+
+    def workspace_id=(value)
+      @attributes[:workspace_id] = value
+    end
+
+    # boolean - If true, this default-workspace subscription applies to events from all workspaces.
+    def apply_to_all_workspaces
+      @attributes[:apply_to_all_workspaces]
+    end
+
+    def apply_to_all_workspaces=(value)
+      @attributes[:apply_to_all_workspaces] = value
+    end
+
+    # string - Event Subscription name.
+    def name
+      @attributes[:name]
+    end
+
+    def name=(value)
+      @attributes[:name] = value
+    end
+
+    # boolean - Whether this Event Subscription can dispatch events.
+    def enabled
+      @attributes[:enabled]
+    end
+
+    def enabled=(value)
+      @attributes[:enabled] = value
+    end
+
+    # array(string) - Event type strings matched by this subscription. Blank means all event types.
+    def event_types
+      @attributes[:event_types]
+    end
+
+    def event_types=(value)
+      @attributes[:event_types] = value
+    end
+
+    # object - Structured event payload filter.
+    def filter
+      @attributes[:filter]
+    end
+
+    def filter=(value)
+      @attributes[:filter] = value
+    end
+
+    # object - Event Subscription delivery policy.
+    def delivery_policy
+      @attributes[:delivery_policy]
+    end
+
+    def delivery_policy=(value)
+      @attributes[:delivery_policy] = value
+    end
+
+    # array(int64) - Event Target IDs this subscription sends to.
+    def event_target_ids
+      @attributes[:event_target_ids]
+    end
+
+    def event_target_ids=(value)
+      @attributes[:event_target_ids] = value
+    end
+
+    # date-time - Event Subscription create date/time.
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - Event Subscription update date/time.
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # Parameters:
+    #   event_channel_id - int64 - Event Channel ID
+    #   workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
+    #   apply_to_all_workspaces - boolean - If true, this default-workspace subscription applies to events from all workspaces.
+    #   name - string - Event Subscription name.
+    #   enabled - boolean - Whether this Event Subscription can dispatch events.
+    #   event_types - array(string) - Event type strings matched by this subscription. Blank means all event types.
+    #   filter - object - Structured event payload filter.
+    #   delivery_policy - object - Event Subscription delivery policy.
+    #   event_target_ids - array(int64) - Event Target IDs this subscription sends to.
+    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[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: event_channel_id must be an Integer") if params[:event_channel_id] and !params[:event_channel_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: event_types must be an Array") if params[:event_types] and !params[:event_types].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: event_target_ids must be an Array") if params[:event_target_ids] and !params[:event_target_ids].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/event_subscriptions/#{@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[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/event_subscriptions/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+      nil
+    end
+
+    def save
+      if @attributes[:id]
+        new_obj = update(@attributes)
+      else
+        new_obj = EventSubscription.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   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. Valid fields are `enabled`, `event_channel_id` or `workspace_id`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `enabled`, `event_channel_id` or `workspace_id`. Valid field combinations are `[ enabled, event_channel_id ]`, `[ workspace_id, enabled ]` or `[ workspace_id, enabled, event_channel_id ]`.
+    def self.list(params = {}, options = {})
+      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: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+
+      List.new(EventSubscription, params) do
+        Api.send_request("/event_subscriptions", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   id (required) - int64 - Event Subscription ID.
+    def self.find(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/event_subscriptions/#{params[:id]}", :get, params, options)
+      EventSubscription.new(response.data, options)
+    end
+
+    def self.get(id, params = {}, options = {})
+      find(id, params, options)
+    end
+
+    # Parameters:
+    #   event_channel_id - int64 - Event Channel ID
+    #   workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
+    #   apply_to_all_workspaces - boolean - If true, this default-workspace subscription applies to events from all workspaces.
+    #   name (required) - string - Event Subscription name.
+    #   enabled - boolean - Whether this Event Subscription can dispatch events.
+    #   event_types - array(string) - Event type strings matched by this subscription. Blank means all event types.
+    #   filter - object - Structured event payload filter.
+    #   delivery_policy - object - Event Subscription delivery policy.
+    #   event_target_ids - array(int64) - Event Target IDs this subscription sends to.
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: event_channel_id must be an Integer") if params[:event_channel_id] and !params[:event_channel_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: event_types must be an Array") if params[:event_types] and !params[:event_types].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: delivery_policy must be an Hash") if params[:delivery_policy] and !params[:delivery_policy].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: event_target_ids must be an Array") if params[:event_target_ids] and !params[:event_target_ids].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: name") unless params[:name]
+
+      response, options = Api.send_request("/event_subscriptions", :post, params, options)
+      EventSubscription.new(response.data, options)
+    end
+
+    # Parameters:
+    #   event_channel_id - int64 - Event Channel ID
+    #   workspace_id - int64 - Workspace ID. 0 means the default workspace or site-wide.
+    #   apply_to_all_workspaces - boolean - If true, this default-workspace subscription applies to events from all workspaces.
+    #   name - string - Event Subscription name.
+    #   enabled - boolean - Whether this Event Subscription can dispatch events.
+    #   event_types - array(string) - Event type strings matched by this subscription. Blank means all event types.
+    #   filter - object - Structured event payload filter.
+    #   delivery_policy - object - Event Subscription delivery policy.
+    #   event_target_ids - array(int64) - Event Target IDs this subscription sends to.
+    def self.update(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: event_channel_id must be an Integer") if params[:event_channel_id] and !params[:event_channel_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: workspace_id must be an Integer") if params[:workspace_id] and !params[:workspace_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: event_types must be an Array") if params[:event_types] and !params[:event_types].is_a?(Array)
+      raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: delivery_policy must be an Hash") if params[:delivery_policy] and !params[:delivery_policy].is_a?(Hash)
+      raise InvalidParameterError.new("Bad parameter: event_target_ids must be an Array") if params[:event_target_ids] and !params[:event_target_ids].is_a?(Array)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      response, options = Api.send_request("/event_subscriptions/#{params[:id]}", :patch, params, options)
+      EventSubscription.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[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/event_subscriptions/#{params[:id]}", :delete, params, options)
+      nil
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+      nil
+    end
+  end
+end