files.com 1.2.91 → 1.2.93

Sign up to get free protection for your applications and to get access to all the features.
package/_VERSION CHANGED
@@ -1 +1 @@
1
- 1.2.91
1
+ 1.2.93
@@ -31,11 +31,11 @@
31
31
  * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
32
32
  * `url` (string): URL for API host.
33
33
  * `user_id` (int64): User ID for the owner of this API Key. May be blank for Site-wide API Keys.
34
- * `path` (string): Folder path restriction for this api key.
34
+ * `path` (string): Folder path restriction for this API key.
35
35
 
36
36
  ---
37
37
 
38
- ## List Api Keys
38
+ ## List API Keys
39
39
 
40
40
  ```
41
41
  await ApiKey.list({
@@ -71,7 +71,7 @@ await ApiKey.findCurrent
71
71
 
72
72
  ---
73
73
 
74
- ## Show Api Key
74
+ ## Show API Key
75
75
 
76
76
  ```
77
77
  await ApiKey.find(id)
@@ -84,7 +84,7 @@ await ApiKey.find(id)
84
84
 
85
85
  ---
86
86
 
87
- ## Create Api Key
87
+ ## Create API Key
88
88
 
89
89
  ```
90
90
  await ApiKey.create({
@@ -105,7 +105,7 @@ await ApiKey.create({
105
105
  * `expires_at` (string): API Key expiration date
106
106
  * `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). 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.
107
107
  * `name` (string): Required - Internal name for the API Key. For your use.
108
- * `path` (string): Folder path restriction for this api key.
108
+ * `path` (string): Folder path restriction for this API key.
109
109
 
110
110
  ---
111
111
 
@@ -137,7 +137,7 @@ await ApiKey.deleteCurrent
137
137
 
138
138
  ---
139
139
 
140
- ## Update Api Key
140
+ ## Update API Key
141
141
 
142
142
  ```
143
143
  const api_key = await ApiKey.find(id)
@@ -179,7 +179,7 @@ await api_key.update({
179
179
 
180
180
  ---
181
181
 
182
- ## Delete Api Key
182
+ ## Delete API Key
183
183
 
184
184
  ```
185
185
  const api_key = await ApiKey.find(id)
@@ -46,7 +46,7 @@
46
46
 
47
47
  ---
48
48
 
49
- ## List Api Request Logs
49
+ ## List API Request Logs
50
50
 
51
51
  ```
52
52
  await ApiRequestLog.list({
@@ -84,7 +84,7 @@
84
84
 
85
85
  ---
86
86
 
87
- ## List As2 Incoming Messages
87
+ ## List AS2 Incoming Messages
88
88
 
89
89
  ```
90
90
  await As2IncomingMessage.list({
@@ -76,7 +76,7 @@
76
76
 
77
77
  ---
78
78
 
79
- ## List As2 Outgoing Messages
79
+ ## List AS2 Outgoing Messages
80
80
 
81
81
  ```
82
82
  await As2OutgoingMessage.list({
@@ -42,7 +42,7 @@
42
42
 
43
43
  ---
44
44
 
45
- ## List As2 Partners
45
+ ## List AS2 Partners
46
46
 
47
47
  ```
48
48
  await As2Partner.list({
@@ -61,7 +61,7 @@ await As2Partner.list({
61
61
 
62
62
  ---
63
63
 
64
- ## Show As2 Partner
64
+ ## Show AS2 Partner
65
65
 
66
66
  ```
67
67
  await As2Partner.find(id)
@@ -74,7 +74,7 @@ await As2Partner.find(id)
74
74
 
75
75
  ---
76
76
 
77
- ## Create As2 Partner
77
+ ## Create AS2 Partner
78
78
 
79
79
  ```
80
80
  await As2Partner.create({
@@ -104,7 +104,7 @@ await As2Partner.create({
104
104
 
105
105
  ---
106
106
 
107
- ## Update As2 Partner
107
+ ## Update AS2 Partner
108
108
 
109
109
  ```
110
110
  const as2_partner = await As2Partner.find(id)
@@ -155,7 +155,7 @@ await as2_partner.update({
155
155
 
156
156
  ---
157
157
 
158
- ## Delete As2 Partner
158
+ ## Delete AS2 Partner
159
159
 
160
160
  ```
161
161
  const as2_partner = await As2Partner.find(id)
@@ -39,7 +39,7 @@
39
39
 
40
40
  ---
41
41
 
42
- ## List As2 Stations
42
+ ## List AS2 Stations
43
43
 
44
44
  ```
45
45
  await As2Station.list({
@@ -58,7 +58,7 @@ await As2Station.list({
58
58
 
59
59
  ---
60
60
 
61
- ## Show As2 Station
61
+ ## Show AS2 Station
62
62
 
63
63
  ```
64
64
  await As2Station.find(id)
@@ -71,7 +71,7 @@ await As2Station.find(id)
71
71
 
72
72
  ---
73
73
 
74
- ## Create As2 Station
74
+ ## Create AS2 Station
75
75
 
76
76
  ```
77
77
  await As2Station.create({
@@ -91,7 +91,7 @@ await As2Station.create({
91
91
 
92
92
  ---
93
93
 
94
- ## Update As2 Station
94
+ ## Update AS2 Station
95
95
 
96
96
  ```
97
97
  const as2_station = await As2Station.find(id)
@@ -131,7 +131,7 @@ await as2_station.update({
131
131
 
132
132
  ---
133
133
 
134
- ## Delete As2 Station
134
+ ## Delete AS2 Station
135
135
 
136
136
  ```
137
137
  const as2_station = await As2Station.find(id)
@@ -32,7 +32,7 @@
32
32
 
33
33
  ---
34
34
 
35
- ## List Exavault Api Request Logs
35
+ ## List Exavault API Request Logs
36
36
 
37
37
  ```
38
38
  await ExavaultApiRequestLog.list({
@@ -46,7 +46,7 @@
46
46
 
47
47
  ---
48
48
 
49
- ## List Ftp Action Logs
49
+ ## List FTP Action Logs
50
50
 
51
51
  ```
52
52
  await FtpActionLog.list({
@@ -24,7 +24,7 @@
24
24
 
25
25
  ---
26
26
 
27
- ## List Gpg Keys
27
+ ## List GPG Keys
28
28
 
29
29
  ```
30
30
  await GpgKey.list({
@@ -46,7 +46,7 @@ await GpgKey.list({
46
46
 
47
47
  ---
48
48
 
49
- ## Show Gpg Key
49
+ ## Show GPG Key
50
50
 
51
51
  ```
52
52
  await GpgKey.find(id)
@@ -59,7 +59,7 @@ await GpgKey.find(id)
59
59
 
60
60
  ---
61
61
 
62
- ## Create Gpg Key
62
+ ## Create GPG Key
63
63
 
64
64
  ```
65
65
  await GpgKey.create({
@@ -82,7 +82,7 @@ await GpgKey.create({
82
82
 
83
83
  ---
84
84
 
85
- ## Update Gpg Key
85
+ ## Update GPG Key
86
86
 
87
87
  ```
88
88
  const gpg_key = await GpgKey.find(id)
@@ -119,7 +119,7 @@ await gpg_key.update({
119
119
 
120
120
  ---
121
121
 
122
- ## Delete Gpg Key
122
+ ## Delete GPG Key
123
123
 
124
124
  ```
125
125
  const gpg_key = await GpgKey.find(id)
@@ -18,7 +18,7 @@
18
18
  * `changes` (array(string)): Markdown-formatted change messages.
19
19
  * `created_at` (date-time): The time this change was made
20
20
  * `user_id` (int64): The user id responsible for this change
21
- * `api_key_id` (int64): The api key id responsible for this change
21
+ * `api_key_id` (int64): The API key id responsible for this change
22
22
  * `user_is_files_support` (boolean): true if this change was performed by Files.com support.
23
23
  * `username` (string): The username of the user responsible for this change
24
24
 
@@ -50,7 +50,7 @@
50
50
 
51
51
  ---
52
52
 
53
- ## List Sftp Action Logs
53
+ ## List SFTP Action Logs
54
54
 
55
55
  ```
56
56
  await SftpActionLog.list({
@@ -19,7 +19,7 @@
19
19
 
20
20
  ---
21
21
 
22
- ## List Sftp Host Keys
22
+ ## List SFTP Host Keys
23
23
 
24
24
  ```
25
25
  await SftpHostKey.list({
@@ -38,7 +38,7 @@ await SftpHostKey.list({
38
38
 
39
39
  ---
40
40
 
41
- ## Show Sftp Host Key
41
+ ## Show SFTP Host Key
42
42
 
43
43
  ```
44
44
  await SftpHostKey.find(id)
@@ -51,7 +51,7 @@ await SftpHostKey.find(id)
51
51
 
52
52
  ---
53
53
 
54
- ## Create Sftp Host Key
54
+ ## Create SFTP Host Key
55
55
 
56
56
  ```
57
57
  await SftpHostKey.create({
@@ -67,7 +67,7 @@ await SftpHostKey.create({
67
67
 
68
68
  ---
69
69
 
70
- ## Update Sftp Host Key
70
+ ## Update SFTP Host Key
71
71
 
72
72
  ```
73
73
  const sftp_host_key = await SftpHostKey.find(id)
@@ -96,7 +96,7 @@ await sftp_host_key.update({
96
96
 
97
97
  ---
98
98
 
99
- ## Delete Sftp Host Key
99
+ ## Delete SFTP Host Key
100
100
 
101
101
  ```
102
102
  const sftp_host_key = await SftpHostKey.find(id)
@@ -34,6 +34,7 @@
34
34
  "bundle_registration_notifications": "never",
35
35
  "bundle_require_registration": true,
36
36
  "bundle_require_share_recipient": true,
37
+ "bundle_require_note": true,
37
38
  "bundle_upload_receipt_notifications": "never",
38
39
  "bundle_watermark_attachment": {
39
40
  "name": "My logo",
@@ -308,6 +309,7 @@
308
309
  * `bundle_registration_notifications` (string): Do Bundle owners receive registration notification?
309
310
  * `bundle_require_registration` (boolean): Do Bundles require registration?
310
311
  * `bundle_require_share_recipient` (boolean): Do Bundles require recipients for sharing?
312
+ * `bundle_require_note` (boolean): Do Bundles require internal notes?
311
313
  * `bundle_upload_receipt_notifications` (string): Do Bundle uploaders receive upload confirmation notifications?
312
314
  * `bundle_watermark_attachment` (Image): Preview watermark image applied to all bundle items.
313
315
  * `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
@@ -501,6 +503,7 @@ await Site.update({
501
503
  'motd_use_for_ftp': true,
502
504
  'motd_use_for_sftp': true,
503
505
  'additional_text_file_types': ["example"],
506
+ 'bundle_require_note': true,
504
507
  'session_expiry': 1.0,
505
508
  'ssl_required': true,
506
509
  'tls_disabled': true,
@@ -652,6 +655,7 @@ await Site.update({
652
655
  * `motd_use_for_sftp` (boolean): Show message to users connecting via SFTP
653
656
  * `left_navigation_visibility` (object): Visibility settings for account navigation
654
657
  * `additional_text_file_types` (array(string)): Additional extensions that are considered text files
658
+ * `bundle_require_note` (boolean): Do Bundles require internal notes?
655
659
  * `session_expiry` (double): Session expiry in hours
656
660
  * `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
657
661
  * `tls_disabled` (boolean): DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
@@ -102,7 +102,7 @@
102
102
 
103
103
  ---
104
104
 
105
- ## List Sso Strategies
105
+ ## List SSO Strategies
106
106
 
107
107
  ```
108
108
  await SsoStrategy.list({
@@ -121,7 +121,7 @@ await SsoStrategy.list({
121
121
 
122
122
  ---
123
123
 
124
- ## Show Sso Strategy
124
+ ## Show SSO Strategy
125
125
 
126
126
  ```
127
127
  await SsoStrategy.find(id)
@@ -76,7 +76,7 @@
76
76
  * `admin_group_ids` (array(int64)): List of group IDs of which this user is an administrator
77
77
  * `allowed_ips` (string): A list of allowed IPs if applicable. Newline delimited
78
78
  * `attachments_permission` (boolean): If `true`, the user can user create Bundles (aka Share Links). Use the bundle permission instead.
79
- * `api_keys_count` (int64): Number of api keys associated with this user
79
+ * `api_keys_count` (int64): Number of API keys associated with this user
80
80
  * `authenticate_until` (date-time): Scheduled Date/Time at which user will be deactivated
81
81
  * `authentication_method` (string): How is this user authenticated?
82
82
  * `avatar_url` (string): URL holding the user's avatar
@@ -42,7 +42,7 @@
42
42
 
43
43
  ---
44
44
 
45
- ## List Web Dav Action Logs
45
+ ## List WebDAV Action Logs
46
46
 
47
47
  ```
48
48
  await WebDavActionLog.list({
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.91';
14
+ var version = '1.2.93';
15
15
  var userAgent = "Files.com JavaScript SDK v".concat(version);
16
16
  var logLevel = _Logger.LogLevel.INFO;
17
17
  var debugRequest = false;
@@ -114,7 +114,7 @@ var ApiKey = /*#__PURE__*/(0, _createClass2.default)(function ApiKey() {
114
114
  (0, _defineProperty2.default)(this, "setUserId", function (value) {
115
115
  _this.attributes.user_id = value;
116
116
  });
117
- // string # Folder path restriction for this api key.
117
+ // string # Folder path restriction for this API key.
118
118
  (0, _defineProperty2.default)(this, "getPath", function () {
119
119
  return _this.attributes.path;
120
120
  });
@@ -444,7 +444,7 @@ _ApiKey = ApiKey;
444
444
  // expires_at - string - API Key expiration date
445
445
  // 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). 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.
446
446
  // name (required) - string - Internal name for the API Key. For your use.
447
- // path - string - Folder path restriction for this api key.
447
+ // path - string - Folder path restriction for this API key.
448
448
  (0, _defineProperty2.default)(ApiKey, "create", /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7() {
449
449
  var params,
450
450
  options,
@@ -45,7 +45,7 @@ var SettingsChange = /*#__PURE__*/(0, _createClass2.default)(function SettingsCh
45
45
  (0, _defineProperty2.default)(this, "getUserId", function () {
46
46
  return _this.attributes.user_id;
47
47
  });
48
- // int64 # The api key id responsible for this change
48
+ // int64 # The API key id responsible for this change
49
49
  (0, _defineProperty2.default)(this, "getApiKeyId", function () {
50
50
  return _this.attributes.api_key_id;
51
51
  });
@@ -137,6 +137,10 @@ var Site = /*#__PURE__*/(0, _createClass2.default)(function Site() {
137
137
  (0, _defineProperty2.default)(this, "getBundleRequireShareRecipient", function () {
138
138
  return _this.attributes.bundle_require_share_recipient;
139
139
  });
140
+ // boolean # Do Bundles require internal notes?
141
+ (0, _defineProperty2.default)(this, "getBundleRequireNote", function () {
142
+ return _this.attributes.bundle_require_note;
143
+ });
140
144
  // string # Do Bundle uploaders receive upload confirmation notifications?
141
145
  (0, _defineProperty2.default)(this, "getBundleUploadReceiptNotifications", function () {
142
146
  return _this.attributes.bundle_upload_receipt_notifications;
@@ -763,6 +767,7 @@ _Site = Site;
763
767
  // motd_use_for_sftp - boolean - Show message to users connecting via SFTP
764
768
  // left_navigation_visibility - object - Visibility settings for account navigation
765
769
  // additional_text_file_types - array(string) - Additional extensions that are considered text files
770
+ // bundle_require_note - boolean - Do Bundles require internal notes?
766
771
  // session_expiry - double - Session expiry in hours
767
772
  // ssl_required - boolean - Is SSL required? Disabling this is insecure.
768
773
  // tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
@@ -68,7 +68,7 @@ var User = /*#__PURE__*/(0, _createClass2.default)(function User() {
68
68
  (0, _defineProperty2.default)(this, "setAttachmentsPermission", function (value) {
69
69
  _this.attributes.attachments_permission = value;
70
70
  });
71
- // int64 # Number of api keys associated with this user
71
+ // int64 # Number of API keys associated with this user
72
72
  (0, _defineProperty2.default)(this, "getApiKeysCount", function () {
73
73
  return _this.attributes.api_keys_count;
74
74
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "files.com",
3
- "version": "1.2.91",
3
+ "version": "1.2.93",
4
4
  "description": "Files.com SDK for JavaScript",
5
5
  "keywords": [
6
6
  "files.com",
package/src/Files.js CHANGED
@@ -5,7 +5,7 @@ const endpointPrefix = '/api/rest/v1'
5
5
  let apiKey
6
6
  let baseUrl = 'https://app.files.com'
7
7
  let sessionId = null
8
- const version = '1.2.91'
8
+ const version = '1.2.93'
9
9
  let userAgent = `Files.com JavaScript SDK v${version}`
10
10
 
11
11
  let logLevel = LogLevel.INFO
@@ -108,7 +108,7 @@ class ApiKey {
108
108
  this.attributes.user_id = value
109
109
  }
110
110
 
111
- // string # Folder path restriction for this api key.
111
+ // string # Folder path restriction for this API key.
112
112
  getPath = () => this.attributes.path
113
113
 
114
114
  setPath = value => {
@@ -281,7 +281,7 @@ class ApiKey {
281
281
  // expires_at - string - API Key expiration date
282
282
  // 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). 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.
283
283
  // name (required) - string - Internal name for the API Key. For your use.
284
- // path - string - Folder path restriction for this api key.
284
+ // path - string - Folder path restriction for this API key.
285
285
  static create = async (params = {}, options = {}) => {
286
286
  if (!params.name) {
287
287
  throw new errors.MissingParameterError('Parameter missing: name')
@@ -37,7 +37,7 @@ class SettingsChange {
37
37
  // int64 # The user id responsible for this change
38
38
  getUserId = () => this.attributes.user_id
39
39
 
40
- // int64 # The api key id responsible for this change
40
+ // int64 # The API key id responsible for this change
41
41
  getApiKeyId = () => this.attributes.api_key_id
42
42
 
43
43
  // boolean # true if this change was performed by Files.com support.
@@ -106,6 +106,9 @@ class Site {
106
106
  // boolean # Do Bundles require recipients for sharing?
107
107
  getBundleRequireShareRecipient = () => this.attributes.bundle_require_share_recipient
108
108
 
109
+ // boolean # Do Bundles require internal notes?
110
+ getBundleRequireNote = () => this.attributes.bundle_require_note
111
+
109
112
  // string # Do Bundle uploaders receive upload confirmation notifications?
110
113
  getBundleUploadReceiptNotifications = () => this.attributes.bundle_upload_receipt_notifications
111
114
 
@@ -557,6 +560,7 @@ class Site {
557
560
  // motd_use_for_sftp - boolean - Show message to users connecting via SFTP
558
561
  // left_navigation_visibility - object - Visibility settings for account navigation
559
562
  // additional_text_file_types - array(string) - Additional extensions that are considered text files
563
+ // bundle_require_note - boolean - Do Bundles require internal notes?
560
564
  // session_expiry - double - Session expiry in hours
561
565
  // ssl_required - boolean - Is SSL required? Disabling this is insecure.
562
566
  // tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site. We intend to remove this capability entirely in early 2024. If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
@@ -63,7 +63,7 @@ class User {
63
63
  this.attributes.attachments_permission = value
64
64
  }
65
65
 
66
- // int64 # Number of api keys associated with this user
66
+ // int64 # Number of API keys associated with this user
67
67
  getApiKeysCount = () => this.attributes.api_keys_count
68
68
 
69
69
  setApiKeysCount = value => {