files.com 1.0.365 → 1.0.367

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3ace3140b5ce13e28448dedf936266019cde545b3fd8437efaa7f931047708b4
4
- data.tar.gz: dd7528b965f5d55d7b759b4e06cbbb475caf2e7ab5653ec45f98016dfba8382e
3
+ metadata.gz: 8ddcfcf490b9a20888328e22096cc90489b430dedf18776e9e72ef5eceaa5cdb
4
+ data.tar.gz: 3aad7657c70fcded2292fda110574f9fd8e1289436a2017010ef3e85fd98c896
5
5
  SHA512:
6
- metadata.gz: bd8c186691ed36e8b0e81858acacfb1cfea62886dc5bd0fa295b5ab31be2038cad54e9bb60997505a9178f6c654cdb9b42b4b82f25dcc8c3341c14a8e161f14f
7
- data.tar.gz: 0cd73d1989f8a3d3efdd0471473809c7e8af82ba0325d7cdefa437a98a888615f3a4ecaedbeab7ee31e0417e2c77d12ee4e4d57bc2a699f64687b50a82ebce5b
6
+ metadata.gz: bf00522be82311b4b71527dc63300536926cf9550ce1c78601304b8d26ed009b1fd578616dad51615b21f826925eb8bd44f33b2bf8487317a8cfd01b13709838
7
+ data.tar.gz: b0cffdc1e6c4acc91573ad11b4b0d5a5fcf8996e18a117988cf4d38664f2386ec718ac9444cae48a271365feece92e4b7d9bdf7426d3dfd0541c76016db92d9f
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.365
1
+ 1.0.367
@@ -0,0 +1,44 @@
1
+ # EmailIncomingMessage
2
+
3
+ ## Example EmailIncomingMessage Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "inbox_id": 1,
9
+ "sender": "example",
10
+ "status": "success",
11
+ "message": "example",
12
+ "created_at": "2000-01-01T01:00:00Z"
13
+ }
14
+ ```
15
+
16
+ * `id` (int64): Id of the Email Incoming Message
17
+ * `inbox_id` (int64): Id of the Inbox associated with this message
18
+ * `sender` (string): Sender of the email
19
+ * `status` (string): Status of the message
20
+ * `message` (string): Message describing the failure
21
+ * `created_at` (date-time): Message creation date/time
22
+
23
+
24
+ ---
25
+
26
+ ## List Email Incoming Messages
27
+
28
+ ```
29
+ Files::EmailIncomingMessage.list(
30
+ per_page: 1
31
+ )
32
+ ```
33
+
34
+ ### Parameters
35
+
36
+ * `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.
37
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
38
+ * `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`.
39
+ * `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 ]`.
40
+ * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
41
+ * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
42
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
43
+ * `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
44
+ * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
@@ -6,7 +6,7 @@
6
6
  {
7
7
  "id": 1,
8
8
  "created_at": 1,
9
- "created_at_iso8601": 1,
9
+ "created_at_iso8601": "example",
10
10
  "user_id": 1,
11
11
  "file_id": 1,
12
12
  "parent_id": 1,
@@ -33,7 +33,7 @@
33
33
 
34
34
  * `id` (int64): Action ID
35
35
  * `created_at` (int64): When the action happened
36
- * `created_at_iso8601` (int64): When the action happened, in ISO8601 format.
36
+ * `created_at_iso8601` (string): When the action happened, in ISO8601 format.
37
37
  * `user_id` (int64): User ID
38
38
  * `file_id` (int64): File ID related to the action
39
39
  * `parent_id` (int64): ID of the parent folder
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class EmailIncomingMessage
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - Id of the Email Incoming Message
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # int64 - Id of the Inbox associated with this message
18
+ def inbox_id
19
+ @attributes[:inbox_id]
20
+ end
21
+
22
+ # string - Sender of the email
23
+ def sender
24
+ @attributes[:sender]
25
+ end
26
+
27
+ # string - Status of the message
28
+ def status
29
+ @attributes[:status]
30
+ end
31
+
32
+ # string - Message describing the failure
33
+ def message
34
+ @attributes[:message]
35
+ end
36
+
37
+ # date-time - Message creation date/time
38
+ def created_at
39
+ @attributes[:created_at]
40
+ end
41
+
42
+ # Parameters:
43
+ # 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.
44
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
45
+ # 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`.
46
+ # 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 ]`.
47
+ # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
48
+ # filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
49
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `sender`.
50
+ # filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
51
+ # filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
52
+ def self.list(params = {}, options = {})
53
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
54
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
55
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
56
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
57
+ raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params[:filter_gt] and !params[:filter_gt].is_a?(Hash)
58
+ raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params[:filter_gteq] and !params[:filter_gteq].is_a?(Hash)
59
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
60
+ raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params[:filter_lt] and !params[:filter_lt].is_a?(Hash)
61
+ raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params[:filter_lteq] and !params[:filter_lteq].is_a?(Hash)
62
+
63
+ List.new(EmailIncomingMessage, params) do
64
+ Api.send_request("/email_incoming_messages", :get, params, options)
65
+ end
66
+ end
67
+
68
+ def self.all(params = {}, options = {})
69
+ list(params, options)
70
+ end
71
+ end
72
+ end
@@ -19,7 +19,7 @@ module Files
19
19
  @attributes[:created_at]
20
20
  end
21
21
 
22
- # int64 - When the action happened, in ISO8601 format.
22
+ # string - When the action happened, in ISO8601 format.
23
23
  def created_at_iso8601
24
24
  @attributes[:created_at_iso8601]
25
25
  end
data/lib/files.com.rb CHANGED
@@ -55,6 +55,7 @@ require "files.com/models/bundle_recipient"
55
55
  require "files.com/models/bundle_registration"
56
56
  require "files.com/models/clickwrap"
57
57
  require "files.com/models/dns_record"
58
+ require "files.com/models/email_incoming_message"
58
59
  require "files.com/models/errors"
59
60
  require "files.com/models/external_event"
60
61
  require "files.com/models/file"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: files.com
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.365
4
+ version: 1.0.367
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-07 00:00:00.000000000 Z
11
+ date: 2023-07-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -137,6 +137,7 @@ files:
137
137
  - docs/bundle_registration.md
138
138
  - docs/clickwrap.md
139
139
  - docs/dns_record.md
140
+ - docs/email_incoming_message.md
140
141
  - docs/errors.md
141
142
  - docs/external_event.md
142
143
  - docs/file.md
@@ -225,6 +226,7 @@ files:
225
226
  - lib/files.com/models/clickwrap.rb
226
227
  - lib/files.com/models/dir.rb
227
228
  - lib/files.com/models/dns_record.rb
229
+ - lib/files.com/models/email_incoming_message.rb
228
230
  - lib/files.com/models/errors.rb
229
231
  - lib/files.com/models/external_event.rb
230
232
  - lib/files.com/models/file.rb