files.com 1.2.320 → 1.2.321

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/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.320
1
+ 1.2.321
@@ -10,6 +10,9 @@
10
10
  "created_at": "2000-01-01T01:00:00Z",
11
11
  "expires_at": "2000-01-01T01:00:00Z",
12
12
  "key": "[key]",
13
+ "aws_style_credentials": true,
14
+ "aws_access_key_id": "[aws_access_key_id]",
15
+ "aws_secret_key": "[aws_secret_key]",
13
16
  "last_use_at": "2000-01-01T01:00:00Z",
14
17
  "name": "My Main API Key",
15
18
  "permission_set": "full",
@@ -25,6 +28,9 @@
25
28
  * `created_at` (date-time): Time which API Key was created
26
29
  * `expires_at` (date-time): API Key expiration date
27
30
  * `key` (string): API Key actual key string
31
+ * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
32
+ * `aws_access_key_id` (string): AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
33
+ * `aws_secret_key` (string): AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
28
34
  * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
29
35
  * `name` (string): Internal name for the API Key. For your use.
30
36
  * `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
@@ -89,6 +95,7 @@ await ApiKey.create({
89
95
  'expires_at': "2000-01-01T01:00:00Z",
90
96
  'permission_set': "full",
91
97
  'name': "My Main API Key",
98
+ 'aws_style_credentials': true,
92
99
  'path': "shared/docs",
93
100
  })
94
101
  ```
@@ -101,6 +108,7 @@ await ApiKey.create({
101
108
  * `expires_at` (string): API Key expiration date
102
109
  * `permission_set` (string): Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
103
110
  * `name` (string): Required - Internal name for the API Key. For your use.
111
+ * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
104
112
  * `path` (string): Folder path restriction for `office_integration` permission set API keys.
105
113
 
106
114
  ---
@@ -164,6 +172,9 @@ await api_key.update({
164
172
  "created_at": "2000-01-01T01:00:00Z",
165
173
  "expires_at": "2000-01-01T01:00:00Z",
166
174
  "key": "[key]",
175
+ "aws_style_credentials": true,
176
+ "aws_access_key_id": "[aws_access_key_id]",
177
+ "aws_secret_key": "[aws_secret_key]",
167
178
  "last_use_at": "2000-01-01T01:00:00Z",
168
179
  "name": "My Main API Key",
169
180
  "permission_set": "full",
@@ -38,7 +38,7 @@
38
38
  * `end_at` (date-time): End date/time of export range.
39
39
  * `status` (string): Status of export. Will be: `building`, `ready`, or `failed`
40
40
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
41
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
41
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
42
42
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
43
43
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
44
44
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -110,7 +110,7 @@ await HistoryExport.create({
110
110
  * `start_at` (string): Start date/time of export range.
111
111
  * `end_at` (string): End date/time of export range.
112
112
  * `query_action` (string): Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
113
- * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
113
+ * `query_interface` (string): Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
114
114
  * `query_user_id` (string): Return results that are actions performed by the user indicated by this User ID
115
115
  * `query_file_id` (string): Return results that are file actions related to the file indicated by this File ID
116
116
  * `query_parent_id` (string): Return results that are file actions inside the parent folder specified by this folder ID
@@ -48,7 +48,7 @@
48
48
  * `user_is_from_parent_site` (boolean): true if this change was performed by a user on a parent site.
49
49
  * `action` (string): What action was taken. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
50
50
  * `failure_type` (string): The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
51
- * `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
51
+ * `interface` (string): Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
52
52
  * `target_id` (int64): ID of the object (such as Users, or API Keys) on which the action was taken
53
53
  * `target_name` (string): Name of the User, Group or other object with a name related to this action
54
54
  * `target_permission` (string): Permission level of the action
@@ -162,6 +162,7 @@
162
162
  "session": {
163
163
  "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
164
164
  "language": "en",
165
+ "aws_secret_key": "example",
165
166
  "login_token": "@tok-randomcode",
166
167
  "login_token_domain": "https://mysite.files.com",
167
168
  "max_dir_listing_size": 1,
package/lib/Files.js CHANGED
@@ -12,7 +12,7 @@ var apiKey;
12
12
  var baseUrl = 'https://app.files.com';
13
13
  var sessionId = null;
14
14
  var language = null;
15
- var version = '1.2.320';
15
+ var version = '1.2.321';
16
16
  var userAgent = "Files.com JavaScript SDK v".concat(version);
17
17
  var logLevel = _Logger.LogLevel.INFO;
18
18
  var debugRequest = false;
@@ -71,6 +71,27 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
71
71
  (0, _defineProperty2.default)(this, "setKey", function (value) {
72
72
  _this.attributes.key = value;
73
73
  });
74
+ // boolean # If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
75
+ (0, _defineProperty2.default)(this, "getAwsStyleCredentials", function () {
76
+ return _this.attributes.aws_style_credentials;
77
+ });
78
+ (0, _defineProperty2.default)(this, "setAwsStyleCredentials", function (value) {
79
+ _this.attributes.aws_style_credentials = value;
80
+ });
81
+ // string # AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
82
+ (0, _defineProperty2.default)(this, "getAwsAccessKeyId", function () {
83
+ return _this.attributes.aws_access_key_id;
84
+ });
85
+ (0, _defineProperty2.default)(this, "setAwsAccessKeyId", function (value) {
86
+ _this.attributes.aws_access_key_id = value;
87
+ });
88
+ // string # AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
89
+ (0, _defineProperty2.default)(this, "getAwsSecretKey", function () {
90
+ return _this.attributes.aws_secret_key;
91
+ });
92
+ (0, _defineProperty2.default)(this, "setAwsSecretKey", function (value) {
93
+ _this.attributes.aws_secret_key = value;
94
+ });
74
95
  // date-time # API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
75
96
  (0, _defineProperty2.default)(this, "getLastUseAt", function () {
76
97
  return _this.attributes.last_use_at;
@@ -429,6 +450,7 @@ _ApiKey = ApiKey;
429
450
  // expires_at - string - API Key expiration date
430
451
  // permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
431
452
  // name (required) - string - Internal name for the API Key. For your use.
453
+ // aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
432
454
  // path - string - Folder path restriction for `office_integration` permission set API keys.
433
455
  (0, _defineProperty2.default)(ApiKey, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee7() {
434
456
  var params,
@@ -74,7 +74,7 @@ var HistoryExport = /*#__PURE__*/(0, _createClass2.default)(function HistoryExpo
74
74
  (0, _defineProperty2.default)(this, "setQueryAction", function (value) {
75
75
  _this.attributes.query_action = value;
76
76
  });
77
- // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
77
+ // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
78
78
  (0, _defineProperty2.default)(this, "getQueryInterface", function () {
79
79
  return _this.attributes.query_interface;
80
80
  });
@@ -308,7 +308,7 @@ _HistoryExport = HistoryExport;
308
308
  // start_at - string - Start date/time of export range.
309
309
  // end_at - string - End date/time of export range.
310
310
  // query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
311
- // query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
311
+ // query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
312
312
  // query_user_id - string - Return results that are actions performed by the user indicated by this User ID
313
313
  // query_file_id - string - Return results that are file actions related to the file indicated by this File ID
314
314
  // query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
@@ -92,7 +92,7 @@ var HistoryExportResult = /*#__PURE__*/(0, _createClass2.default)(function Histo
92
92
  (0, _defineProperty2.default)(this, "getFailureType", function () {
93
93
  return _this.attributes.failure_type;
94
94
  });
95
- // string # Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
95
+ // string # Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
96
96
  (0, _defineProperty2.default)(this, "getInterface", function () {
97
97
  return _this.attributes.interface;
98
98
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.2.320",
3
+ "version": "1.2.321",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
package/src/Files.js CHANGED
@@ -6,7 +6,7 @@ let apiKey
6
6
  let baseUrl = 'https://app.files.com'
7
7
  let sessionId = null
8
8
  let language = null
9
- const version = '1.2.320'
9
+ const version = '1.2.321'
10
10
  let userAgent = `Files.com JavaScript SDK v${version}`
11
11
 
12
12
  let logLevel = LogLevel.INFO
@@ -66,6 +66,27 @@ class ApiKey {
66
66
  this.attributes.key = value
67
67
  }
68
68
 
69
+ // boolean # If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
70
+ getAwsStyleCredentials = () => this.attributes.aws_style_credentials
71
+
72
+ setAwsStyleCredentials = value => {
73
+ this.attributes.aws_style_credentials = value
74
+ }
75
+
76
+ // string # AWS Access Key ID to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
77
+ getAwsAccessKeyId = () => this.attributes.aws_access_key_id
78
+
79
+ setAwsAccessKeyId = value => {
80
+ this.attributes.aws_access_key_id = value
81
+ }
82
+
83
+ // string # AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
84
+ getAwsSecretKey = () => this.attributes.aws_secret_key
85
+
86
+ setAwsSecretKey = value => {
87
+ this.attributes.aws_secret_key = value
88
+ }
89
+
69
90
  // date-time # API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
70
91
  getLastUseAt = () => this.attributes.last_use_at
71
92
 
@@ -271,6 +292,7 @@ class ApiKey {
271
292
  // expires_at - string - API Key expiration date
272
293
  // permission_set - string - Permissions for this API Key. It must be full for site-wide API Keys. Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges. If you have ideas for permission sets, please let us know.
273
294
  // name (required) - string - Internal name for the API Key. For your use.
295
+ // aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
274
296
  // path - string - Folder path restriction for `office_integration` permission set API keys.
275
297
  static create = async (params = {}, options = {}) => {
276
298
  if (!params.name) {
@@ -70,7 +70,7 @@ class HistoryExport {
70
70
  this.attributes.query_action = value
71
71
  }
72
72
 
73
- // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
73
+ // string # Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
74
74
  getQueryInterface = () => this.attributes.query_interface
75
75
 
76
76
  setQueryInterface = value => {
@@ -250,7 +250,7 @@ class HistoryExport {
250
250
  // start_at - string - Start date/time of export range.
251
251
  // end_at - string - End date/time of export range.
252
252
  // query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`, `archived_delete`
253
- // query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
253
+ // query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
254
254
  // query_user_id - string - Return results that are actions performed by the user indicated by this User ID
255
255
  // query_file_id - string - Return results that are file actions related to the file indicated by this File ID
256
256
  // query_parent_id - string - Return results that are file actions inside the parent folder specified by this folder ID
@@ -73,7 +73,7 @@ class HistoryExportResult {
73
73
  // string # The type of login failure, if applicable. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`, `country_mismatch`, `insecure_ftp`, `insecure_cipher`, `rate_limited`
74
74
  getFailureType = () => this.attributes.failure_type
75
75
 
76
- // string # Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`
76
+ // string # Interface through which the action was taken. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`, `office`, `mobile`, `as2`, `inbound_email`, `remote`, `inbound_s3`
77
77
  getInterface = () => this.attributes.interface
78
78
 
79
79
  // int64 # ID of the object (such as Users, or API Keys) on which the action was taken