files.com 1.2.118 → 1.2.120
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.
- package/README.md +12 -10
- package/_VERSION +1 -1
- package/docs/models/ExternalEvent.md +4 -2
- package/lib/Files.js +1 -1
- package/lib/models/ExternalEvent.js +9 -2
- package/package.json +1 -1
- package/src/Files.js +1 -1
- package/src/models/ExternalEvent.js +9 -2
package/README.md
CHANGED
@@ -5,11 +5,19 @@ 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 JavaScript SDK provides convenient access to
|
8
|
+
The Files.com JavaScript SDK provides convenient access to all aspects of Files.com from applications written in JavaScript.
|
9
|
+
|
10
|
+
This includes 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
|
+
### JavaScript is a Core Focus at Files.com
|
13
|
+
|
14
|
+
This SDK is used internally by serveral Files.com integrations that we maintain, and we work hard to ensure that it is always up to date and performant.
|
15
|
+
|
16
|
+
It is also a very popular choice for Files.com customers looking to integrate with Files.com.
|
9
17
|
|
10
18
|
### Installation
|
11
19
|
|
12
|
-
To install the package
|
20
|
+
To install the package, use `yarn` or `npm`:
|
13
21
|
|
14
22
|
```shell
|
15
23
|
yarn add files.com
|
@@ -27,11 +35,6 @@ npm install files.com
|
|
27
35
|
|
28
36
|
```js
|
29
37
|
import Files from "files.com/lib/Files.js";
|
30
|
-
|
31
|
-
// Set the client to your site subdomain if your site is configured to disable global acceleration.
|
32
|
-
// Otherwise, don't change this setting for production.
|
33
|
-
// For dev/CI, you can point this to the mock server.
|
34
|
-
Files.setBaseUrl("https://MY-SUBDOMAIN.files.com");
|
35
38
|
```
|
36
39
|
|
37
40
|
##### `require()` vs. `import`
|
@@ -52,10 +55,9 @@ Explore the [files-sdk-javascript](https://github.com/Files-com/files-sdk-javasc
|
|
52
55
|
|
53
56
|
### Getting Support
|
54
57
|
|
55
|
-
The Files.com team
|
56
|
-
may face.
|
58
|
+
The Files.com Support team provides official support for all of our official Files.com integration tools.
|
57
59
|
|
58
|
-
|
60
|
+
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.
|
59
61
|
|
60
62
|
## Authentication
|
61
63
|
|
package/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.2.
|
1
|
+
1.2.120
|
@@ -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 @@ await 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`.
|
package/lib/Files.js
CHANGED
@@ -11,7 +11,7 @@ var endpointPrefix = '/api/rest/v1';
|
|
11
11
|
var apiKey;
|
12
12
|
var baseUrl = 'https://app.files.com';
|
13
13
|
var sessionId = null;
|
14
|
-
var version = '1.2.
|
14
|
+
var version = '1.2.120';
|
15
15
|
var userAgent = "Files.com JavaScript SDK v".concat(version);
|
16
16
|
var logLevel = _Logger.LogLevel.INFO;
|
17
17
|
var debugRequest = false;
|
@@ -79,6 +79,13 @@ var ExternalEvent = /*#__PURE__*/(0, _createClass2.default)(function ExternalEve
|
|
79
79
|
(0, _defineProperty2.default)(this, "setFolderBehaviorId", function (value) {
|
80
80
|
_this.attributes.folder_behavior_id = value;
|
81
81
|
});
|
82
|
+
// int64 # SIEM HTTP Destination ID.
|
83
|
+
(0, _defineProperty2.default)(this, "getSiemHttpDestinationId", function () {
|
84
|
+
return _this.attributes.siem_http_destination_id;
|
85
|
+
});
|
86
|
+
(0, _defineProperty2.default)(this, "setSiemHttpDestinationId", function (value) {
|
87
|
+
_this.attributes.siem_http_destination_id = value;
|
88
|
+
});
|
82
89
|
// int64 # For sync events, the number of files handled successfully.
|
83
90
|
(0, _defineProperty2.default)(this, "getSuccessfulFiles", function () {
|
84
91
|
return _this.attributes.successful_files;
|
@@ -161,8 +168,8 @@ _ExternalEvent = ExternalEvent;
|
|
161
168
|
// Parameters:
|
162
169
|
// 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.
|
163
170
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
164
|
-
// 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`.
|
165
|
-
// 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 `
|
171
|
+
// 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`.
|
172
|
+
// 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 ]`.
|
166
173
|
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
167
174
|
// filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
168
175
|
// filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
|
package/package.json
CHANGED
package/src/Files.js
CHANGED
@@ -73,6 +73,13 @@ class ExternalEvent {
|
|
73
73
|
this.attributes.folder_behavior_id = value
|
74
74
|
}
|
75
75
|
|
76
|
+
// int64 # SIEM HTTP Destination ID.
|
77
|
+
getSiemHttpDestinationId = () => this.attributes.siem_http_destination_id
|
78
|
+
|
79
|
+
setSiemHttpDestinationId = value => {
|
80
|
+
this.attributes.siem_http_destination_id = value
|
81
|
+
}
|
82
|
+
|
76
83
|
// int64 # For sync events, the number of files handled successfully.
|
77
84
|
getSuccessfulFiles = () => this.attributes.successful_files
|
78
85
|
|
@@ -128,8 +135,8 @@ class ExternalEvent {
|
|
128
135
|
// Parameters:
|
129
136
|
// 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.
|
130
137
|
// per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
131
|
-
// 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`.
|
132
|
-
// 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 `
|
138
|
+
// 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`.
|
139
|
+
// 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 ]`.
|
133
140
|
// filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
134
141
|
// filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
135
142
|
// filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `remote_server_type`.
|