files.com 1.0.365 → 1.0.366

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ace3140b5ce13e28448dedf936266019cde545b3fd8437efaa7f931047708b4
-  data.tar.gz: dd7528b965f5d55d7b759b4e06cbbb475caf2e7ab5653ec45f98016dfba8382e
+  metadata.gz: 60e6271fa87da5e823cd6fd1c56d41d0b74202af205ddc4e2c808d4db8e0200a
+  data.tar.gz: a997581f3e868a63df1323df5ebf464a68b1d8fe00de292cec640c86e6d62699
 SHA512:
-  metadata.gz: bd8c186691ed36e8b0e81858acacfb1cfea62886dc5bd0fa295b5ab31be2038cad54e9bb60997505a9178f6c654cdb9b42b4b82f25dcc8c3341c14a8e161f14f
-  data.tar.gz: 0cd73d1989f8a3d3efdd0471473809c7e8af82ba0325d7cdefa437a98a888615f3a4ecaedbeab7ee31e0417e2c77d12ee4e4d57bc2a699f64687b50a82ebce5b
+  metadata.gz: 7c048322210e606a7af4c61b3def08e405bfe71949ba6f7ec90730514f236cf39a8382e36e692cf1d45996373c197ab023f4cd082b41c9fe6bf25b87a31be6a0
+  data.tar.gz: 15eeaa41c0597ba716254833a37f58b83780fb7d2c09191c7d973135b617fa75e7bfed66046b36ebf436d0b64e5c24ca84d719406c8f9ebc819c822d01b2cee0

data/_VERSION

@@ -1 +1 @@
-1.0.365
+1.0.366

data/docs/email_incoming_message.md

@@ -0,0 +1,44 @@
+# EmailIncomingMessage
+
+## Example EmailIncomingMessage Object
+
+```
+{
+  "id": 1,
+  "inbox_id": 1,
+  "sender": "example",
+  "status": "success",
+  "message": "example",
+  "created_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Id of the Email Incoming Message
+* `inbox_id` (int64): Id of the Inbox associated with this message
+* `sender` (string): Sender of the email
+* `status` (string): Status of the message
+* `message` (string): Message describing the failure
+* `created_at` (date-time): Message creation date/time
+
+
+---
+
+## List Email Incoming Messages
+
+```
+Files::EmailIncomingMessage.list(
+  per_page: 1
+)
+```
+
+### 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 (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, 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 `sender`.
+* `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`.

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Files
+  class EmailIncomingMessage
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Id of the Email Incoming Message
+    def id
+      @attributes[:id]
+    end
+
+    # int64 - Id of the Inbox associated with this message
+    def inbox_id
+      @attributes[:inbox_id]
+    end
+
+    # string - Sender of the email
+    def sender
+      @attributes[:sender]
+    end
+
+    # string - Status of the message
+    def status
+      @attributes[:status]
+    end
+
+    # string - Message describing the failure
+    def message
+      @attributes[:message]
+    end
+
+    # date-time - Message creation 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 (e.g. `sort_by[created_at]=desc`). Valid fields are `created_at`, `sender`, `status` or `inbox_id`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `inbox_id`, `sender` or `status`. Valid field combinations are `[ sender, created_at ]`, `[ status, created_at ]`, `[ inbox_id, created_at ]`, `[ inbox_id, status, created_at ]` or `[ inbox_id, status, sender, 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 `sender`.
+    #   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(EmailIncomingMessage, params) do
+        Api.send_request("/email_incoming_messages", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+  end
+end

data/lib/files.com.rb

@@ -55,6 +55,7 @@ require "files.com/models/bundle_recipient"
 require "files.com/models/bundle_registration"
 require "files.com/models/clickwrap"
 require "files.com/models/dns_record"
+require "files.com/models/email_incoming_message"
 require "files.com/models/errors"
 require "files.com/models/external_event"
 require "files.com/models/file"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.365
+  version: 1.0.366
 platform: ruby
 authors:
 - files.com
@@ -137,6 +137,7 @@ files:
 - docs/bundle_registration.md
 - docs/clickwrap.md
 - docs/dns_record.md
+- docs/email_incoming_message.md
 - docs/errors.md
 - docs/external_event.md
 - docs/file.md
@@ -225,6 +226,7 @@ files:
 - lib/files.com/models/clickwrap.rb
 - lib/files.com/models/dir.rb
 - lib/files.com/models/dns_record.rb
+- lib/files.com/models/email_incoming_message.rb
 - lib/files.com/models/errors.rb
 - lib/files.com/models/external_event.rb
 - lib/files.com/models/file.rb