files.com 1.1.172 → 1.1.174

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: d8df37806e5e558cb102955bcc602c345a19c4114ef43e62f2c0275044b07011
4
- data.tar.gz: bb42bc3487b4e403a99ad3d2b9ef7d660a20bd775f2952f34cae779114446e70
3
+ metadata.gz: 47cb28b2c3b7de493a24cad001db22dbc10eec20d0ecba0d22b97ced7daaa92e
4
+ data.tar.gz: a8ccf28faca51b38c547fb54643c1f4ed4a31f39050716dc2290abb3b2197e1a
5
5
  SHA512:
6
- metadata.gz: 4cf6c501b535d63a8d90ff9633ec555efe729b97db1d48e5fca5b17feda8272d345d93c9d79ce91b604d61d6d7abff3f189259b30dc233b2fb8fc47ab672c43d
7
- data.tar.gz: 0b123b00603973aaf8bfd119b102ba5c835f7bfd7447660b8ab9aa5d23593c49ff89d3c45eb229016429aee588899ff9551f6fb853ccb073430b438e2424aca6
6
+ metadata.gz: 6b617976a274af570890b6235a74d63563e7c6c0cba7adbcc36f518b37b1cb3b1d208b319c37c4643c3f1632b3a4ccf826d5a1308e0824c74d3579cc50cf3d5a
7
+ data.tar.gz: 5cc1879bc1d6b64672bea9bdaf4ce72030391d454b117ac3ba6446dff7cc4bfc405279911c517e224dc395a3b0916f7d70dc121300a1b309764046d4d3f8bfff
data/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.1.172
1
+ 1.1.174
@@ -49,7 +49,7 @@ Files::BundleAction.list
49
49
 
50
50
  * `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.
51
51
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
- * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
52
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
53
53
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
54
54
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
55
55
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
data/docs/export.md ADDED
@@ -0,0 +1,50 @@
1
+ # Export
2
+
3
+ ## Example Export Object
4
+
5
+ ```
6
+ {
7
+ "id": 1,
8
+ "export_status": "example",
9
+ "export_type": "example",
10
+ "download_uri": "example"
11
+ }
12
+ ```
13
+
14
+ * `id` (int64): ID for this Export
15
+ * `export_status` (string): Status of the Export
16
+ * `export_type` (string): Type of data being exported
17
+ * `download_uri` (string): Link to download Export file.
18
+
19
+
20
+ ---
21
+
22
+ ## List Exports
23
+
24
+ ```
25
+ Files::Export.list(
26
+ user_id: 1
27
+ )
28
+ ```
29
+
30
+ ### Parameters
31
+
32
+ * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
33
+ * `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.
34
+ * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
35
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
36
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
37
+ * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
38
+
39
+
40
+ ---
41
+
42
+ ## Show Export
43
+
44
+ ```
45
+ Files::Export.find(id)
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ * `id` (int64): Required - Export ID.
@@ -7,6 +7,7 @@
7
7
  "id": 1,
8
8
  "protocol_cipher": "TLSv1.2; ECDHE-RSA-AES256-GCM-SHA384",
9
9
  "created_at": "2000-01-01T01:00:00Z",
10
+ "insecure": true,
10
11
  "interface": "restapi",
11
12
  "updated_at": "2000-01-01T01:00:00Z",
12
13
  "user_id": 1
@@ -16,6 +17,7 @@
16
17
  * `id` (int64): UserCipherUse ID
17
18
  * `protocol_cipher` (string): The protocol and cipher employed
18
19
  * `created_at` (date-time): The earliest recorded use of this combination of interface and protocol and cipher (for this user)
20
+ * `insecure` (boolean): Is this cipher considered insecure?
19
21
  * `interface` (string): The interface accessed
20
22
  * `updated_at` (date-time): The most recent use of this combination of interface and protocol and cipher (for this user)
21
23
  * `user_id` (int64): ID of the user who performed this access
@@ -42,7 +42,7 @@ module Files
42
42
  # Parameters:
43
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
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. Valid fields are .
45
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
46
46
  # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ created_at, bundle_id ]`, `[ created_at, bundle_registration_id ]`, `[ bundle_id, bundle_registration_id ]` or `[ created_at, bundle_id, bundle_registration_id ]`.
47
47
  # filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
48
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`.
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Files
4
+ class Export
5
+ attr_reader :options, :attributes
6
+
7
+ def initialize(attributes = {}, options = {})
8
+ @attributes = attributes || {}
9
+ @options = options || {}
10
+ end
11
+
12
+ # int64 - ID for this Export
13
+ def id
14
+ @attributes[:id]
15
+ end
16
+
17
+ # string - Status of the Export
18
+ def export_status
19
+ @attributes[:export_status]
20
+ end
21
+
22
+ # string - Type of data being exported
23
+ def export_type
24
+ @attributes[:export_type]
25
+ end
26
+
27
+ # string - Link to download Export file.
28
+ def download_uri
29
+ @attributes[:download_uri]
30
+ end
31
+
32
+ # Parameters:
33
+ # user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
34
+ # 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.
35
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
36
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `export_status` and `export_type`.
37
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `export_status` and `export_type`.
38
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
39
+ def self.list(params = {}, options = {})
40
+ raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
41
+ raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
42
+ raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
43
+ raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params[:sort_by] and !params[:sort_by].is_a?(Hash)
44
+ raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params[:filter] and !params[:filter].is_a?(Hash)
45
+ raise InvalidParameterError.new("Bad parameter: filter_prefix must be an Hash") if params[:filter_prefix] and !params[:filter_prefix].is_a?(Hash)
46
+
47
+ List.new(Export, params) do
48
+ Api.send_request("/exports", :get, params, options)
49
+ end
50
+ end
51
+
52
+ def self.all(params = {}, options = {})
53
+ list(params, options)
54
+ end
55
+
56
+ # Parameters:
57
+ # id (required) - int64 - Export ID.
58
+ def self.find(id, params = {}, options = {})
59
+ params ||= {}
60
+ params[:id] = id
61
+ raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
62
+ raise MissingParameterError.new("Parameter missing: id") unless params[:id]
63
+
64
+ response, options = Api.send_request("/exports/#{params[:id]}", :get, params, options)
65
+ Export.new(response.data, options)
66
+ end
67
+
68
+ def self.get(id, params = {}, options = {})
69
+ find(id, params, options)
70
+ end
71
+ end
72
+ end
@@ -24,6 +24,11 @@ module Files
24
24
  @attributes[:created_at]
25
25
  end
26
26
 
27
+ # boolean - Is this cipher considered insecure?
28
+ def insecure
29
+ @attributes[:insecure]
30
+ end
31
+
27
32
  # string - The interface accessed
28
33
  def interface
29
34
  @attributes[:interface]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Files
4
- VERSION = "1.1.172"
4
+ VERSION = "1.1.174"
5
5
  end
data/lib/files.com.rb CHANGED
@@ -62,6 +62,7 @@ require "files.com/models/email_incoming_message"
62
62
  require "files.com/models/email_log"
63
63
  require "files.com/models/errors"
64
64
  require "files.com/models/exavault_api_request_log"
65
+ require "files.com/models/export"
65
66
  require "files.com/models/external_event"
66
67
  require "files.com/models/file"
67
68
  require "files.com/models/file_action"
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.1.172
4
+ version: 1.1.174
5
5
  platform: ruby
6
6
  authors:
7
7
  - files.com
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-05 00:00:00.000000000 Z
11
+ date: 2024-11-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -144,6 +144,7 @@ files:
144
144
  - docs/email_log.md
145
145
  - docs/errors.md
146
146
  - docs/exavault_api_request_log.md
147
+ - docs/export.md
147
148
  - docs/external_event.md
148
149
  - docs/file.md
149
150
  - docs/file_action.md
@@ -248,6 +249,7 @@ files:
248
249
  - lib/files.com/models/email_log.rb
249
250
  - lib/files.com/models/errors.rb
250
251
  - lib/files.com/models/exavault_api_request_log.rb
252
+ - lib/files.com/models/export.rb
251
253
  - lib/files.com/models/external_event.rb
252
254
  - lib/files.com/models/file.rb
253
255
  - lib/files.com/models/file_action.rb