files.com 1.2.322 → 1.2.324

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.322
1
+ 1.2.324
@@ -137,7 +137,7 @@
137
137
 
138
138
  ---
139
139
 
140
- ## List Bundles
140
+ ## List Share Links
141
141
 
142
142
  ```
143
143
  await Bundle.list({
@@ -161,7 +161,7 @@ await Bundle.list({
161
161
 
162
162
  ---
163
163
 
164
- ## Show Bundle
164
+ ## Show Share Link
165
165
 
166
166
  ```
167
167
  await Bundle.find(id)
@@ -174,7 +174,7 @@ await Bundle.find(id)
174
174
 
175
175
  ---
176
176
 
177
- ## Create Bundle
177
+ ## Create Share Link
178
178
 
179
179
  ```
180
180
  await Bundle.create({
@@ -260,7 +260,7 @@ await bundle.share({
260
260
 
261
261
  ---
262
262
 
263
- ## Update Bundle
263
+ ## Update Share Link
264
264
 
265
265
  ```
266
266
  const bundle = await Bundle.find(id)
@@ -412,7 +412,7 @@ await bundle.update({
412
412
 
413
413
  ---
414
414
 
415
- ## Delete Bundle
415
+ ## Delete Share Link
416
416
 
417
417
  ```
418
418
  const bundle = await Bundle.find(id)
@@ -34,7 +34,7 @@
34
34
 
35
35
  ---
36
36
 
37
- ## List Bundle Downloads
37
+ ## List Share Link Downloads
38
38
 
39
39
  ```
40
40
  await BundleDownload.list({
@@ -21,7 +21,7 @@
21
21
 
22
22
  ---
23
23
 
24
- ## List Bundle Notifications
24
+ ## List Share Link Notifications
25
25
 
26
26
  ```
27
27
  await BundleNotification.list({
@@ -40,7 +40,7 @@ await BundleNotification.list({
40
40
 
41
41
  ---
42
42
 
43
- ## Show Bundle Notification
43
+ ## Show Share Link Notification
44
44
 
45
45
  ```
46
46
  await BundleNotification.find(id)
@@ -53,7 +53,7 @@ await BundleNotification.find(id)
53
53
 
54
54
  ---
55
55
 
56
- ## Create Bundle Notification
56
+ ## Create Share Link Notification
57
57
 
58
58
  ```
59
59
  await BundleNotification.create({
@@ -76,7 +76,7 @@ await BundleNotification.create({
76
76
 
77
77
  ---
78
78
 
79
- ## Update Bundle Notification
79
+ ## Update Share Link Notification
80
80
 
81
81
  ```
82
82
  const bundle_notification = await BundleNotification.find(id)
@@ -107,7 +107,7 @@ await bundle_notification.update({
107
107
 
108
108
  ---
109
109
 
110
- ## Delete Bundle Notification
110
+ ## Delete Share Link Notification
111
111
 
112
112
  ```
113
113
  const bundle_notification = await BundleNotification.find(id)
@@ -23,7 +23,7 @@
23
23
 
24
24
  ---
25
25
 
26
- ## List Bundle Recipients
26
+ ## List Share Link Recipients
27
27
 
28
28
  ```
29
29
  await BundleRecipient.list({
@@ -44,7 +44,7 @@ await BundleRecipient.list({
44
44
 
45
45
  ---
46
46
 
47
- ## Create Bundle Recipient
47
+ ## Create Share Link Recipient
48
48
 
49
49
  ```
50
50
  await BundleRecipient.create({
@@ -38,7 +38,7 @@
38
38
 
39
39
  ---
40
40
 
41
- ## List Bundle Registrations
41
+ ## List Share Link Registrations
42
42
 
43
43
  ```
44
44
  await BundleRegistration.list({
@@ -7,6 +7,7 @@
7
7
  "id": 1,
8
8
  "expires_at": "2000-01-01T01:00:00Z",
9
9
  "name": "key name",
10
+ "partner_id": 1,
10
11
  "user_id": 1,
11
12
  "public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
12
13
  "private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
@@ -19,7 +20,8 @@
19
20
  * `id` (int64): Your GPG key ID.
20
21
  * `expires_at` (date-time): Your GPG key expiration date.
21
22
  * `name` (string): Your GPG key name.
22
- * `user_id` (int64): GPG owner's user id
23
+ * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
24
+ * `user_id` (int64): User ID who owns this GPG Key, if applicable.
23
25
  * `public_key_md5` (string): MD5 hash of your GPG public key
24
26
  * `private_key_md5` (string): MD5 hash of your GPG private key.
25
27
  * `generated_public_key` (string): Your GPG public key
@@ -71,6 +73,7 @@ await GpgKey.find(id)
71
73
  ```
72
74
  await GpgKey.create({
73
75
  'user_id': 1,
76
+ 'partner_id': 1,
74
77
  'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
75
78
  'private_key': "ab236cfe4a195f0226bc2e674afdd6b0",
76
79
  'private_key_password': "[your GPG private key password]",
@@ -86,6 +89,7 @@ await GpgKey.create({
86
89
  ### Parameters
87
90
 
88
91
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
92
+ * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
89
93
  * `public_key` (string): MD5 hash of your GPG public key
90
94
  * `private_key` (string): MD5 hash of your GPG private key.
91
95
  * `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
@@ -103,6 +107,7 @@ await GpgKey.create({
103
107
  const gpg_key = await GpgKey.find(id)
104
108
 
105
109
  await gpg_key.update({
110
+ 'partner_id': 1,
106
111
  'public_key': "7f8bc1210b09b9ddf469e6b6b8920e76",
107
112
  'private_key': "ab236cfe4a195f0226bc2e674afdd6b0",
108
113
  'private_key_password': "[your GPG private key password]",
@@ -113,6 +118,7 @@ await gpg_key.update({
113
118
  ### Parameters
114
119
 
115
120
  * `id` (int64): Required - Gpg Key ID.
121
+ * `partner_id` (int64): Partner ID who owns this GPG Key, if applicable.
116
122
  * `public_key` (string): MD5 hash of your GPG public key
117
123
  * `private_key` (string): MD5 hash of your GPG private key.
118
124
  * `private_key_password` (string): Your GPG private key password. Only required for password protected keys.
@@ -125,6 +131,7 @@ await gpg_key.update({
125
131
  "id": 1,
126
132
  "expires_at": "2000-01-01T01:00:00Z",
127
133
  "name": "key name",
134
+ "partner_id": 1,
128
135
  "user_id": 1,
129
136
  "public_key_md5": "7f8bc1210b09b9ddf469e6b6b8920e76",
130
137
  "private_key_md5": "ab236cfe4a195f0226bc2e674afdd6b0",
@@ -10,7 +10,8 @@
10
10
  "id": 1,
11
11
  "name": "Acme Corp",
12
12
  "notes": "This is a note about the partner.",
13
- "root_folder": "/AcmeCorp"
13
+ "root_folder": "/AcmeCorp",
14
+ "tags": "example"
14
15
  }
15
16
  ```
16
17
 
@@ -21,6 +22,7 @@
21
22
  * `name` (string): The name of the Partner.
22
23
  * `notes` (string): Notes about this Partner.
23
24
  * `root_folder` (string): The root folder path for this Partner.
25
+ * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
24
26
 
25
27
  ---
26
28
 
@@ -56,24 +58,26 @@ await Partner.find(id)
56
58
 
57
59
  ```
58
60
  await Partner.create({
61
+ 'name': "Acme Corp",
59
62
  'allow_bypassing_2fa_policies': false,
60
63
  'allow_credential_changes': false,
61
64
  'allow_user_creation': false,
62
- 'name': "Acme Corp",
63
65
  'notes': "This is a note about the partner.",
64
66
  'root_folder': "/AcmeCorp",
67
+ 'tags': "example",
65
68
  })
66
69
  ```
67
70
 
68
71
 
69
72
  ### Parameters
70
73
 
74
+ * `name` (string): The name of the Partner.
71
75
  * `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
72
76
  * `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
73
77
  * `allow_user_creation` (boolean): Allow Partner Admins to create users.
74
- * `name` (string): The name of the Partner.
75
78
  * `notes` (string): Notes about this Partner.
76
79
  * `root_folder` (string): The root folder path for this Partner.
80
+ * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
77
81
 
78
82
  ---
79
83
 
@@ -83,24 +87,26 @@ await Partner.create({
83
87
  const partner = await Partner.find(id)
84
88
 
85
89
  await partner.update({
90
+ 'name': "Acme Corp",
86
91
  'allow_bypassing_2fa_policies': false,
87
92
  'allow_credential_changes': false,
88
93
  'allow_user_creation': false,
89
- 'name': "Acme Corp",
90
94
  'notes': "This is a note about the partner.",
91
95
  'root_folder': "/AcmeCorp",
96
+ 'tags': "example",
92
97
  })
93
98
  ```
94
99
 
95
100
  ### Parameters
96
101
 
97
102
  * `id` (int64): Required - Partner ID.
103
+ * `name` (string): The name of the Partner.
98
104
  * `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
99
105
  * `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
100
106
  * `allow_user_creation` (boolean): Allow Partner Admins to create users.
101
- * `name` (string): The name of the Partner.
102
107
  * `notes` (string): Notes about this Partner.
103
108
  * `root_folder` (string): The root folder path for this Partner.
109
+ * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
104
110
 
105
111
  ### Example Response
106
112
 
@@ -112,7 +118,8 @@ await partner.update({
112
118
  "id": 1,
113
119
  "name": "Acme Corp",
114
120
  "notes": "This is a note about the partner.",
115
- "root_folder": "/AcmeCorp"
121
+ "root_folder": "/AcmeCorp",
122
+ "tags": "example"
116
123
  }
117
124
  ```
118
125
 
@@ -11,6 +11,7 @@
11
11
  "group_id": 1,
12
12
  "group_name": "example",
13
13
  "partner_id": 1,
14
+ "partner_name": "Acme Corp.",
14
15
  "permission": "full",
15
16
  "recursive": true,
16
17
  "site_id": 1
@@ -24,6 +25,7 @@
24
25
  * `group_id` (int64): Group ID
25
26
  * `group_name` (string): Group name (if applicable)
26
27
  * `partner_id` (int64): Partner ID (if applicable)
28
+ * `partner_name` (string): Partner name (if applicable)
27
29
  * `permission` (string): Permission type. See the table referenced in the documentation for an explanation of each permission.
28
30
  * `recursive` (boolean): Recursive: does this permission apply to subfolders?
29
31
  * `site_id` (int64): Site ID
@@ -51,6 +51,7 @@ await PublicKey.list({
51
51
  * `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
52
52
  * `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.
53
53
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
54
+ * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `title`, `created_at` or `user_id`.
54
55
  * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`.
55
56
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
56
57
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
@@ -38,3 +38,16 @@ await ScimLog.list
38
38
  * `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.
39
39
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
40
40
  * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
41
+
42
+ ---
43
+
44
+ ## Show Scim Log
45
+
46
+ ```
47
+ await ScimLog.find(id)
48
+ ```
49
+
50
+
51
+ ### Parameters
52
+
53
+ * `id` (int64): Required - Scim Log ID.
@@ -282,6 +282,7 @@
282
282
  "sso_strategy_id": 1,
283
283
  "subscribe_to_newsletter": true,
284
284
  "externally_managed": true,
285
+ "tags": "example",
285
286
  "time_zone": "Pacific Time (US & Canada)",
286
287
  "type_of_2fa": "yubi",
287
288
  "type_of_2fa_for_display": "yubi",
@@ -68,6 +68,7 @@
68
68
  "sso_strategy_id": 1,
69
69
  "subscribe_to_newsletter": true,
70
70
  "externally_managed": true,
71
+ "tags": "example",
71
72
  "time_zone": "Pacific Time (US & Canada)",
72
73
  "type_of_2fa": "yubi",
73
74
  "type_of_2fa_for_display": "yubi",
@@ -140,6 +141,7 @@
140
141
  * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
141
142
  * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
142
143
  * `externally_managed` (boolean): Is this user managed by a SsoStrategy?
144
+ * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
143
145
  * `time_zone` (string): User time zone
144
146
  * `type_of_2fa` (string): Type(s) of 2FA methods in use, for programmatic use. Will be either `sms`, `totp`, `webauthn`, `yubi`, `email`, or multiple values sorted alphabetically and joined by an underscore. Does not specify whether user has more than one of a given method.
145
147
  * `type_of_2fa_for_display` (string): Type(s) of 2FA methods in use, formatted for displaying in the UI. Unlike `type_of_2fa`, this value will make clear when a user has more than 1 of the same type of method.
@@ -158,6 +160,7 @@
158
160
  * `password_confirmation` (string): Optional, but if provided, we will ensure that it matches the value sent in `password`.
159
161
  * `announcements_read` (boolean): Signifies that the user has read all the announcements in the UI.
160
162
  * `clear_2fa` (boolean): If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
163
+ * `convert_to_partner_user` (boolean): If true, convert this user to a partner user by assigning the partner_id provided.
161
164
 
162
165
  ---
163
166
 
@@ -175,7 +178,7 @@ await User.list({
175
178
  * `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.
176
179
  * `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
177
180
  * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `authenticate_until`, `email`, `last_desktop_login_at`, `last_login_at`, `name`, `company`, `password_validity_days`, `ssl_required`, `username`, `site_admin` or `disabled`.
178
- * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin` or `disabled`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
181
+ * `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `username`, `name`, `email`, `company`, `site_admin`, `password_validity_days`, `ssl_required`, `last_login_at`, `authenticate_until`, `not_site_admin`, `disabled` or `partner_id`. Valid field combinations are `[ site_admin, username ]`, `[ not_site_admin, username ]` or `[ company, name ]`.
179
182
  * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
180
183
  * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `password_validity_days`, `last_login_at` or `authenticate_until`.
181
184
  * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `username`, `name`, `email` or `company`. Valid field combinations are `[ company, name ]`.
@@ -243,6 +246,7 @@ await User.create({
243
246
  'sso_strategy_id': 1,
244
247
  'subscribe_to_newsletter': true,
245
248
  'require_2fa': "always_require",
249
+ 'tags': "example",
246
250
  'time_zone': "Pacific Time (US & Canada)",
247
251
  'user_root': "example",
248
252
  'user_home': "example",
@@ -299,6 +303,7 @@ await User.create({
299
303
  * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
300
304
  * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
301
305
  * `require_2fa` (string): 2FA required setting
306
+ * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
302
307
  * `time_zone` (string): User time zone
303
308
  * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
304
309
  * `user_home` (string): Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
@@ -396,11 +401,13 @@ await user.update({
396
401
  'sso_strategy_id': 1,
397
402
  'subscribe_to_newsletter': true,
398
403
  'require_2fa': "always_require",
404
+ 'tags': "example",
399
405
  'time_zone': "Pacific Time (US & Canada)",
400
406
  'user_root': "example",
401
407
  'user_home': "example",
402
408
  'username': "user",
403
409
  'clear_2fa': false,
410
+ 'convert_to_partner_user': false,
404
411
  })
405
412
  ```
406
413
 
@@ -453,11 +460,13 @@ await user.update({
453
460
  * `sso_strategy_id` (int64): SSO (Single Sign On) strategy ID for the user, if applicable.
454
461
  * `subscribe_to_newsletter` (boolean): Is the user subscribed to the newsletter?
455
462
  * `require_2fa` (string): 2FA required setting
463
+ * `tags` (string): Comma-separated list of Tags for this user. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
456
464
  * `time_zone` (string): User time zone
457
465
  * `user_root` (string): Root folder for FTP (and optionally SFTP if the appropriate site-wide setting is set). Note that this is not used for API, Desktop, or Web interface.
458
466
  * `user_home` (string): Home folder for FTP/SFTP. Note that this is not used for API, Desktop, or Web interface.
459
467
  * `username` (string): User's username
460
468
  * `clear_2fa` (boolean): If true when changing authentication_method from `password` to `sso`, remove all two-factor methods. Ignored in all other cases.
469
+ * `convert_to_partner_user` (boolean): If true, convert this user to a partner user by assigning the partner_id provided.
461
470
 
462
471
  ### Example Response
463
472
 
@@ -527,6 +536,7 @@ await user.update({
527
536
  "sso_strategy_id": 1,
528
537
  "subscribe_to_newsletter": true,
529
538
  "externally_managed": true,
539
+ "tags": "example",
530
540
  "time_zone": "Pacific Time (US & Canada)",
531
541
  "type_of_2fa": "yubi",
532
542
  "type_of_2fa_for_display": "yubi",
@@ -11,26 +11,30 @@
11
11
  2,
12
12
  3
13
13
  ],
14
+ "action": "disable",
14
15
  "inactivity_days": 12,
15
16
  "include_folder_admins": true,
16
17
  "include_site_admins": true,
17
- "action": "disable",
18
- "user_state": "inactive",
19
18
  "name": "password specific rules",
20
- "site_id": 1
19
+ "partner_tag": "guest",
20
+ "site_id": 1,
21
+ "user_state": "inactive",
22
+ "user_tag": "guest"
21
23
  }
22
24
  ```
23
25
 
24
26
  * `id` (int64): User Lifecycle Rule ID
25
- * `authentication_method` (string): User authentication method for the rule
27
+ * `authentication_method` (string): User authentication method for which the rule will apply.
26
28
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
27
- * `inactivity_days` (int64): Number of days of inactivity before the rule applies
28
- * `include_folder_admins` (boolean): Include folder admins in the rule
29
- * `include_site_admins` (boolean): Include site admins in the rule
30
29
  * `action` (string): Action to take on inactive users (disable or delete)
31
- * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
30
+ * `inactivity_days` (int64): Number of days of inactivity before the rule applies
31
+ * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
32
+ * `include_site_admins` (boolean): If true, the rule will apply to site admins.
32
33
  * `name` (string): User Lifecycle Rule name
34
+ * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
33
35
  * `site_id` (int64): Site ID
36
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
37
+ * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
34
38
 
35
39
  ---
36
40
 
@@ -45,6 +49,7 @@ await UserLifecycleRule.list
45
49
 
46
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.
47
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 `site_id`.
48
53
 
49
54
  ---
50
55
 
@@ -70,8 +75,10 @@ await UserLifecycleRule.create({
70
75
  'inactivity_days': 12,
71
76
  'include_site_admins': true,
72
77
  'include_folder_admins': true,
73
- 'user_state': "inactive",
74
78
  'name': "password specific rules",
79
+ 'partner_tag': "guest",
80
+ 'user_state': "inactive",
81
+ 'user_tag': "guest",
75
82
  })
76
83
  ```
77
84
 
@@ -79,13 +86,15 @@ await UserLifecycleRule.create({
79
86
  ### Parameters
80
87
 
81
88
  * `action` (string): Action to take on inactive users (disable or delete)
82
- * `authentication_method` (string): User authentication method for the rule
89
+ * `authentication_method` (string): User authentication method for which the rule will apply.
83
90
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
84
91
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
85
- * `include_site_admins` (boolean): Include site admins in the rule
86
- * `include_folder_admins` (boolean): Include folder admins in the rule
87
- * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
92
+ * `include_site_admins` (boolean): If true, the rule will apply to site admins.
93
+ * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
88
94
  * `name` (string): User Lifecycle Rule name
95
+ * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
96
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
97
+ * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
89
98
 
90
99
  ---
91
100
 
@@ -100,8 +109,10 @@ await user_lifecycle_rule.update({
100
109
  'inactivity_days': 12,
101
110
  'include_site_admins': true,
102
111
  'include_folder_admins': true,
103
- 'user_state': "inactive",
104
112
  'name': "password specific rules",
113
+ 'partner_tag': "guest",
114
+ 'user_state': "inactive",
115
+ 'user_tag': "guest",
105
116
  })
106
117
  ```
107
118
 
@@ -109,13 +120,15 @@ await user_lifecycle_rule.update({
109
120
 
110
121
  * `id` (int64): Required - User Lifecycle Rule ID.
111
122
  * `action` (string): Action to take on inactive users (disable or delete)
112
- * `authentication_method` (string): User authentication method for the rule
123
+ * `authentication_method` (string): User authentication method for which the rule will apply.
113
124
  * `group_ids` (array(int64)): Array of Group IDs to which the rule applies. If empty or not set, the rule applies to all users.
114
125
  * `inactivity_days` (int64): Number of days of inactivity before the rule applies
115
- * `include_site_admins` (boolean): Include site admins in the rule
116
- * `include_folder_admins` (boolean): Include folder admins in the rule
117
- * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
126
+ * `include_site_admins` (boolean): If true, the rule will apply to site admins.
127
+ * `include_folder_admins` (boolean): If true, the rule will apply to folder admins.
118
128
  * `name` (string): User Lifecycle Rule name
129
+ * `partner_tag` (string): If provided, only users belonging to Partners with this tag at the Partner level will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
130
+ * `user_state` (string): State of the users to apply the rule to (inactive or disabled)
131
+ * `user_tag` (string): If provided, only users with this tag will be affected by the rule. Tags must only contain lowercase letters, numbers, and hyphens.
119
132
 
120
133
  ### Example Response
121
134
 
@@ -128,13 +141,15 @@ await user_lifecycle_rule.update({
128
141
  2,
129
142
  3
130
143
  ],
144
+ "action": "disable",
131
145
  "inactivity_days": 12,
132
146
  "include_folder_admins": true,
133
147
  "include_site_admins": true,
134
- "action": "disable",
135
- "user_state": "inactive",
136
148
  "name": "password specific rules",
137
- "site_id": 1
149
+ "partner_tag": "guest",
150
+ "site_id": 1,
151
+ "user_state": "inactive",
152
+ "user_tag": "guest"
138
153
  }
139
154
  ```
140
155
 
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.322';
15
+ var version = '1.2.324';
16
16
  var userAgent = "Files.com JavaScript SDK v".concat(version);
17
17
  var logLevel = _Logger.LogLevel.INFO;
18
18
  var debugRequest = false;