files.com 1.1.125 → 1.1.127
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +15 -7
- data/_VERSION +1 -1
- data/docs/external_event.md +4 -2
- data/lib/files.com/models/external_event.rb +11 -2
- data/lib/files.com/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ad13bd1bbe57402011868bb1f25681de53baa4313acb92f08e3427e8efffc094
|
4
|
+
data.tar.gz: d4c993993a26ec960fa40a430e1f837a7c7250624a587c6fc0062b7a63f7d4dc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 456b3d458e0e4fe35c1713d44790b7f464764e620f1987902e386d9da7a3c152bfe472db520e4f1fd6750b123630cde5673c4fbaf774bf004ec42c2603514a50
|
7
|
+
data.tar.gz: 704768a4b9901f476abed9a551f61e664d339a043e01bebb2684271a0db767d2ba0a8b24a57a126bc55275d19612d68c1e2b8b9c2c2c5ff2e1105baf12e589eb
|
data/README.md
CHANGED
@@ -5,16 +5,25 @@ The content included here should be enough to get started, but please visit our
|
|
5
5
|
|
6
6
|
## Introduction
|
7
7
|
|
8
|
-
The Files.com Ruby
|
8
|
+
The Files.com Ruby gem provides convenient access to all aspects of Files.com from applications written in the Ruby language.
|
9
|
+
|
10
|
+
Files.com customers use our Ruby gem for directly working with files and folders as well as performing management tasks such as adding/removing users, onboarding counterparties, retrieving information about automations and more.
|
11
|
+
|
12
|
+
### Files.com is a Ruby Shop
|
13
|
+
|
14
|
+
At Files.com, we use Ruby as a primary language all over the company. Our main server-side API is developed in Ruby, as are many of our microservices.
|
15
|
+
|
16
|
+
This Ruby gem is used directly in many internal projects at Files.com, including several of the integrations we maintain. You can expect the official Files.com Ruby gem to be highly performant and kept up to date at all times.
|
9
17
|
|
10
18
|
### Installation
|
11
19
|
|
12
|
-
To install the
|
20
|
+
To install the gem, simply use Rubygems:
|
13
21
|
|
14
22
|
```bash
|
15
23
|
gem install files.com
|
16
24
|
````
|
17
|
-
|
25
|
+
|
26
|
+
You can also use Bundler, by adding `files.com` to your app's `Gemfile`:
|
18
27
|
|
19
28
|
```ruby
|
20
29
|
gem 'files.com', '~> 1.0'
|
@@ -22,7 +31,7 @@ gem 'files.com', '~> 1.0'
|
|
22
31
|
|
23
32
|
### Requirements
|
24
33
|
|
25
|
-
|
34
|
+
The Files.com gem requires Ruby 3+.
|
26
35
|
|
27
36
|
Ruby 2.x is now considered end-of-life by the Ruby project. As a policy, Files.com does not support integrations which are considered end-of-life by their vendor.
|
28
37
|
|
@@ -30,10 +39,9 @@ Explore the [files-sdk-ruby](https://github.com/Files-com/files-sdk-ruby) code o
|
|
30
39
|
|
31
40
|
### Getting Support
|
32
41
|
|
33
|
-
The Files.com team
|
34
|
-
may face.
|
42
|
+
The Files.com Support team provides official support for all of our official Files.com integration tools.
|
35
43
|
|
36
|
-
|
44
|
+
To initiate a support conversation, you can send an [Authenticated Support Request](https://www.files.com/docs/overview/requesting-support) or simply send an E-Mail to support@files.com.
|
37
45
|
|
38
46
|
## Authentication
|
39
47
|
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.1.
|
1
|
+
1.1.127
|
data/docs/external_event.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
"created_at": "2000-01-01T01:00:00Z",
|
12
12
|
"body_url": "example",
|
13
13
|
"folder_behavior_id": 1,
|
14
|
+
"siem_http_destination_id": 1,
|
14
15
|
"successful_files": 1,
|
15
16
|
"errored_files": 1,
|
16
17
|
"bytes_synced": 1,
|
@@ -27,6 +28,7 @@
|
|
27
28
|
* `created_at` (date-time): External event create date/time
|
28
29
|
* `body_url` (string): Link to log file.
|
29
30
|
* `folder_behavior_id` (int64): Folder Behavior ID
|
31
|
+
* `siem_http_destination_id` (int64): SIEM HTTP Destination ID.
|
30
32
|
* `successful_files` (int64): For sync events, the number of files handled successfully.
|
31
33
|
* `errored_files` (int64): For sync events, the number of files that encountered errors.
|
32
34
|
* `bytes_synced` (int64): For sync events, the total number of bytes synced.
|
@@ -47,8 +49,8 @@ Files::ExternalEvent.list
|
|
47
49
|
|
48
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.
|
49
51
|
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
50
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
|
51
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `
|
52
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `event_type`, `created_at` or `status`.
|
53
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type, status ]`, `[ created_at, event_type ]` or `[ created_at, status ]`.
|
52
54
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
53
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`.
|
54
56
|
* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
|
@@ -68,6 +68,15 @@ module Files
|
|
68
68
|
@attributes[:folder_behavior_id] = value
|
69
69
|
end
|
70
70
|
|
71
|
+
# int64 - SIEM HTTP Destination ID.
|
72
|
+
def siem_http_destination_id
|
73
|
+
@attributes[:siem_http_destination_id]
|
74
|
+
end
|
75
|
+
|
76
|
+
def siem_http_destination_id=(value)
|
77
|
+
@attributes[:siem_http_destination_id] = value
|
78
|
+
end
|
79
|
+
|
71
80
|
# int64 - For sync events, the number of files handled successfully.
|
72
81
|
def successful_files
|
73
82
|
@attributes[:successful_files]
|
@@ -136,8 +145,8 @@ module Files
|
|
136
145
|
# Parameters:
|
137
146
|
# 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.
|
138
147
|
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
139
|
-
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `event_type`, `created_at` or `status`.
|
140
|
-
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status` or `
|
148
|
+
# sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `remote_server_type`, `site_id`, `folder_behavior_id`, `siem_http_destination_id`, `event_type`, `created_at` or `status`.
|
149
|
+
# filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `remote_server_type`, `status`, `folder_behavior_id` or `siem_http_destination_id`. Valid field combinations are `[ created_at, event_type, status ]`, `[ created_at, event_type ]` or `[ created_at, status ]`.
|
141
150
|
# filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
142
151
|
# filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
143
152
|
# filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
|
data/lib/files.com/version.rb
CHANGED
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.
|
4
|
+
version: 1.1.127
|
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
|
+
date: 2024-09-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: addressable
|