files.com 1.2.316 → 1.2.318

package/_VERSION

@@ -1 +1 @@
-1.2.316
+1.2.318

package/docs/models/Partner.md

@@ -0,0 +1,132 @@
+# Partner
+
+## Example Partner Object
+
+```
+{
+  "allow_bypassing_2fa_policies": true,
+  "allow_credential_changes": true,
+  "allow_user_creation": true,
+  "id": 1,
+  "name": "Acme Corp",
+  "notes": "This is a note about the partner.",
+  "root_folder": "/AcmeCorp"
+}
+```
+
+* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
+* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+* `allow_user_creation` (boolean): Allow Partner Admins to create users.
+* `id` (int64): The unique ID of the Partner.
+* `name` (string): The name of the Partner.
+* `notes` (string): Notes about this Partner.
+* `root_folder` (string): The root folder path for this Partner.
+
+---
+
+## List Partners
+
+```
+await Partner.list
+```
+
+
+### Parameters
+
+* `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.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`.
+
+---
+
+## Show Partner
+
+```
+await Partner.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Partner ID.
+
+---
+
+## Create Partner
+
+```
+await Partner.create({
+  'allow_bypassing_2fa_policies': false,
+  'allow_credential_changes': false,
+  'allow_user_creation': false,
+  'name': "Acme Corp",
+  'notes': "This is a note about the partner.",
+  'root_folder': "/AcmeCorp",
+})
+```
+
+
+### Parameters
+
+* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
+* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+* `allow_user_creation` (boolean): Allow Partner Admins to create users.
+* `name` (string): The name of the Partner.
+* `notes` (string): Notes about this Partner.
+* `root_folder` (string): The root folder path for this Partner.
+
+---
+
+## Update Partner
+
+```
+const partner = await Partner.find(id)
+
+await partner.update({
+  'allow_bypassing_2fa_policies': false,
+  'allow_credential_changes': false,
+  'allow_user_creation': false,
+  'name': "Acme Corp",
+  'notes': "This is a note about the partner.",
+  'root_folder': "/AcmeCorp",
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner ID.
+* `allow_bypassing_2fa_policies` (boolean): Allow users created under this Partner to bypass Two-Factor Authentication policies.
+* `allow_credential_changes` (boolean): Allow Partner Admins to change or reset credentials for users belonging to this Partner.
+* `allow_user_creation` (boolean): Allow Partner Admins to create users.
+* `name` (string): The name of the Partner.
+* `notes` (string): Notes about this Partner.
+* `root_folder` (string): The root folder path for this Partner.
+
+### Example Response
+
+```json
+{
+  "allow_bypassing_2fa_policies": true,
+  "allow_credential_changes": true,
+  "allow_user_creation": true,
+  "id": 1,
+  "name": "Acme Corp",
+  "notes": "This is a note about the partner.",
+  "root_folder": "/AcmeCorp"
+}
+```
+
+---
+
+## Delete Partner
+
+```
+const partner = await Partner.find(id)
+
+await partner.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner ID.
+

package/docs/models/Permission.md

@@ -10,6 +10,7 @@
   "username": "user",
   "group_id": 1,
   "group_name": "example",
+  "partner_id": 1,
   "permission": "full",
   "recursive": true,
   "site_id": 1
@@ -22,6 +23,7 @@
 * `username` (string): Username (if applicable)
 * `group_id` (int64): Group ID
 * `group_name` (string): Group name (if applicable)
+* `partner_id` (int64): Partner ID (if applicable)
 * `permission` (string): Permission type.  See the table referenced in the documentation for an explanation of each permission.
 * `recursive` (boolean): Recursive: does this permission apply to subfolders?
 * `site_id` (int64): Site ID
@@ -35,6 +37,7 @@ await Permission.list({
   'path': "example",
   'include_groups': false,
   'group_id': 1,
+  'partner_id': 1,
   'user_id': 1,
 })
 ```
@@ -44,12 +47,13 @@ await Permission.list({
 
 * `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.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id` or `id`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]` or `[ user_id, group_id, path ]`.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `site_id`, `group_id`, `path`, `user_id`, `partner_id` or `id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `group_id`, `partner_id` or `user_id`. Valid field combinations are `[ group_id, path ]`, `[ partner_id, path ]`, `[ user_id, path ]`, `[ user_id, group_id ]`, `[ user_id, group_id, path ]`, `[ user_id, group_id, partner_id ]` or `[ user_id, group_id, partner_id, path ]`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
 * `path` (string): Permission path.  If provided, will scope all permissions(including upward) to this path.
 * `include_groups` (boolean): If searching by user or group, also include user's permissions that are inherited from its groups?
 * `group_id` (string): 
+* `partner_id` (string): 
 * `user_id` (string): 
 
 ---
@@ -62,6 +66,7 @@ await Permission.create({
   'group_id': 1,
   'permission': "full",
   'recursive': false,
+  'partner_id': 1,
   'user_id': 1,
   'username': "user",
   'group_name': "example",
@@ -76,6 +81,7 @@ await Permission.create({
 * `group_id` (int64): Group ID. Provide `group_name` or `group_id`
 * `permission` (string): Permission type.  Can be `admin`, `full`, `readonly`, `writeonly`, `list`, or `history`
 * `recursive` (boolean): Apply to subfolders recursively?
+* `partner_id` (int64): Partner ID if this Permission belongs to a partner.
 * `user_id` (int64): User ID.  Provide `username` or `user_id`
 * `username` (string): User username.  Provide `username` or `user_id`
 * `group_name` (string): Group name.  Provide `group_name` or `group_id`

package/docs/models/Site.md

@@ -237,6 +237,7 @@
     "disabled": true,
     "disabled_expired_or_inactive": true,
     "email": "john.doe@files.com",
+    "filesystem_layout": "site_root",
     "first_login_at": "2000-01-01T01:00:00Z",
     "ftp_permission": true,
     "group_ids": "example",
@@ -258,6 +259,7 @@
     "notes": "Internal notes on this user.",
     "notification_daily_send_time": 18,
     "office_integration_enabled": true,
+    "partner_id": 1,
     "password_set_at": "2000-01-01T01:00:00Z",
     "password_validity_days": 1,
     "public_keys_count": 1,

package/docs/models/SsoStrategy.md

@@ -20,7 +20,7 @@
   "scim_username": "example",
   "scim_oauth_access_token": "example",
   "scim_oauth_access_token_expires_at": "example",
-  "subdomain": "my-site",
+  "subdomain": "",
   "provision_users": true,
   "provision_groups": true,
   "deprovision_users": true,
@@ -41,6 +41,7 @@
   "provision_time_zone": "Eastern Time (US & Canada)",
   "provision_company": "ACME Corp.",
   "provision_require_2fa": "always_require",
+  "provision_filesystem_layout": "integration_centric",
   "provider_identifier": "",
   "ldap_base_dn": "example",
   "ldap_domain": "mysite.com",
@@ -71,7 +72,7 @@
 * `scim_username` (string): SCIM username.
 * `scim_oauth_access_token` (string): SCIM OAuth Access Token.
 * `scim_oauth_access_token_expires_at` (string): SCIM OAuth Access Token Expiration Time.
-* `subdomain` (string): Subdomain
+* `subdomain` (string): Subdomain or domain name for your auth provider.   Example: `https://[subdomain].okta.com/`
 * `provision_users` (boolean): Auto-provision users?
 * `provision_groups` (boolean): Auto-provision group membership based on group memberships on the SSO side?
 * `deprovision_users` (boolean): Auto-deprovision users?
@@ -92,6 +93,7 @@
 * `provision_time_zone` (string): Default time zone for auto provisioned users.
 * `provision_company` (string): Default company for auto provisioned users.
 * `provision_require_2fa` (string): 2FA required setting for auto provisioned users.
+* `provision_filesystem_layout` (string): File System layout to use for auto provisioned users.
 * `provider_identifier` (string): URL-friendly, unique identifier for Azure SAML configuration
 * `ldap_base_dn` (string): Base DN for looking up users in LDAP server
 * `ldap_domain` (string): Domain name that will be appended to LDAP usernames

package/docs/models/User.md

@@ -24,6 +24,7 @@
   "disabled": true,
   "disabled_expired_or_inactive": true,
   "email": "john.doe@files.com",
+  "filesystem_layout": "site_root",
   "first_login_at": "2000-01-01T01:00:00Z",
   "ftp_permission": true,
   "group_ids": "example",
@@ -45,6 +46,7 @@
   "notes": "Internal notes on this user.",
   "notification_daily_send_time": 18,
   "office_integration_enabled": true,
+  "partner_id": 1,
   "password_set_at": "2000-01-01T01:00:00Z",
   "password_validity_days": 1,
   "public_keys_count": 1,
@@ -93,6 +95,7 @@
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
 * `disabled_expired_or_inactive` (boolean): Computed property that returns true if user disabled or expired or inactive.
 * `email` (email): User email address
+* `filesystem_layout` (string): File system layout
 * `first_login_at` (date-time): User's first login time
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
 * `group_ids` (string): Comma-separated list of group IDs of which this user is a member
@@ -114,6 +117,7 @@
 * `notes` (string): Any internal notes on the user
 * `notification_daily_send_time` (int64): Hour of the day at which daily notifications should be sent. Can be in range 0 to 23
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `partner_id` (int64): Partner ID if this user belongs to a Partner
 * `password_set_at` (date-time): Last time the user's password was set
 * `password_validity_days` (int64): Number of days to allow user to use the same password
 * `public_keys_count` (int64): Number of public keys associated with this user
@@ -212,6 +216,7 @@ await User.create({
   'bypass_site_allowed_ips': false,
   'dav_permission': true,
   'disabled': true,
+  'filesystem_layout': "site_root",
   'ftp_permission': true,
   'header_text': "User-specific message.",
   'language': "en",
@@ -220,6 +225,7 @@ await User.create({
   'company': "ACME Corp.",
   'notes': "Internal notes on this user.",
   'office_integration_enabled': true,
+  'partner_id': 1,
   'password_validity_days': 1,
   'readonly_site_admin': true,
   'receive_admin_alerts': true,
@@ -265,6 +271,7 @@ await User.create({
 * `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
+* `filesystem_layout` (string): File system layout
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
 * `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
@@ -273,6 +280,7 @@ await User.create({
 * `company` (string): User's company
 * `notes` (string): Any internal notes on the user
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `partner_id` (int64): Partner ID if this user belongs to a Partner
 * `password_validity_days` (int64): Number of days to allow user to use the same password
 * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -359,6 +367,7 @@ await user.update({
   'bypass_site_allowed_ips': false,
   'dav_permission': true,
   'disabled': true,
+  'filesystem_layout': "site_root",
   'ftp_permission': true,
   'header_text': "User-specific message.",
   'language': "en",
@@ -367,6 +376,7 @@ await user.update({
   'company': "ACME Corp.",
   'notes': "Internal notes on this user.",
   'office_integration_enabled': true,
+  'partner_id': 1,
   'password_validity_days': 1,
   'readonly_site_admin': true,
   'receive_admin_alerts': true,
@@ -413,6 +423,7 @@ await user.update({
 * `bypass_site_allowed_ips` (boolean): Allow this user to skip site-wide IP blacklists?
 * `dav_permission` (boolean): Can the user connect with WebDAV?
 * `disabled` (boolean): Is user disabled? Disabled users cannot log in, and do not count for billing purposes. Users can be automatically disabled after an inactivity period via a Site setting or schedule to be deactivated after specific date.
+* `filesystem_layout` (string): File system layout
 * `ftp_permission` (boolean): Can the user access with FTP/FTPS?
 * `header_text` (string): Text to display to the user in the header of the UI
 * `language` (string): Preferred language
@@ -421,6 +432,7 @@ await user.update({
 * `company` (string): User's company
 * `notes` (string): Any internal notes on the user
 * `office_integration_enabled` (boolean): Enable integration with Office for the web?
+* `partner_id` (int64): Partner ID if this user belongs to a Partner
 * `password_validity_days` (int64): Number of days to allow user to use the same password
 * `readonly_site_admin` (boolean): Is the user an allowed to view all (non-billing) site configuration for this site?
 * `receive_admin_alerts` (boolean): Should the user receive admin alerts such a certificate expiration notifications and overages?
@@ -465,6 +477,7 @@ await user.update({
   "disabled": true,
   "disabled_expired_or_inactive": true,
   "email": "john.doe@files.com",
+  "filesystem_layout": "site_root",
   "first_login_at": "2000-01-01T01:00:00Z",
   "ftp_permission": true,
   "group_ids": "example",
@@ -486,6 +499,7 @@ await user.update({
   "notes": "Internal notes on this user.",
   "notification_daily_send_time": 18,
   "office_integration_enabled": true,
+  "partner_id": 1,
   "password_set_at": "2000-01-01T01:00:00Z",
   "password_validity_days": 1,
   "public_keys_count": 1,

package/lib/Files.js

@@ -12,7 +12,7 @@ var apiKey;
 var baseUrl = 'https://app.files.com';
 var sessionId = null;
 var language = null;
-var version = '1.2.316';
+var version = '1.2.318';
 var userAgent = "Files.com JavaScript SDK v".concat(version);
 var logLevel = _Logger.LogLevel.INFO;
 var debugRequest = false;