files.com 1.1.670 → 1.1.671

data/docs/restore.md

@@ -96,3 +96,17 @@ Files::Restore.create(
 * `restore_in_place` (boolean): If true, we will restore the files in place (into their original paths). If false, we will create a new restoration folder in the root and restore files there.
 * `update_timestamps` (boolean): If true, we will update the last modified timestamp of restored files to today's date. If false, we might trigger File Expiration to delete the file again.
 * `workspace_id` (int64): Workspace ID for a workspace-scoped restore. `0` means the default site-wide scope.
+
+
+---
+
+## Create an export CSV of Restore resources
+
+```
+Files::Restore.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `restoration_type`.

data/docs/revision.md

@@ -0,0 +1,40 @@
+# Revision
+
+## Example Revision Object
+
+```
+{
+  "current": "a1b2c3d4",
+  "prior": "f9e8d7c6",
+  "revision": "a1b2c3d4",
+  "up_to_date": true
+}
+```
+
+* `current` (string): The commit hash of the latest deployed revision.
+* `prior` (string): The commit hash of the previously deployed revision.
+* `revision` (string): The commit hash of the currently running revision.
+* `up_to_date` (boolean): True if the currently running revision is the latest deployed revision.
+
+
+---
+
+## List Revisions
+
+```
+Files::Revision.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: 10000, 1,000 or less is recommended).
+
+
+---
+
+## Create an export CSV of Revision resources
+
+```
+Files::Revision.create_export
+```

data/docs/scheduled_export.md

@@ -122,6 +122,21 @@ Files::ScheduledExport.create(
 * `holiday_region` (string): Optional holiday region used by schedule-driven exports.
 
 
+---
+
+## Create an export CSV of Scheduled Export resources
+
+```
+Files::ScheduledExport.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `name`, `export_type` or `disabled`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `disabled` and `export_type`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `export_type`.
+
+
 ---
 
 ## Update Scheduled Export

data/docs/scim_log.md

@@ -51,3 +51,16 @@ Files::ScimLog.find(id)
 ### Parameters
 
 * `id` (int64): Required - Scim Log ID.
+
+
+---
+
+## Create an export CSV of Scim Log resources
+
+```
+Files::ScimLog.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.

data/docs/session.md

@@ -6,17 +6,86 @@
 {
   "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
   "language": "en",
+  "aws_secret_key": "example",
+  "ai_assistant_personality_id": 1,
+  "ai_assistant_personality_system_prompt": "example",
+  "login_token": "@tok-randomcode",
+  "login_token_domain": "https://mysite.files.com",
+  "default_workspace_id": 1,
+  "max_dir_listing_size": 1,
+  "multiple_regions": true,
   "read_only": true,
-  "sftp_insecure_ciphers": true
+  "root_path": "example",
+  "home_path": "example",
+  "sftp_insecure_ciphers": true,
+  "site_id": 1,
+  "ssl_required": true,
+  "timeout_at": "2000-01-01T01:00:00Z",
+  "trusted": true,
+  "two_factor_setup_needed": true,
+  "allowed_2fa_method_sms": true,
+  "allowed_2fa_method_totp": true,
+  "allowed_2fa_method_webauthn": true,
+  "allowed_2fa_method_yubi": true,
+  "calculate_file_checksums_crc32": true,
+  "calculate_file_checksums_md5": true,
+  "calculate_file_checksums_sha1": true,
+  "calculate_file_checksums_sha256": true,
+  "legacy_checksums_mode": true,
+  "finalize_partial_uploads": true,
+  "use_provided_modified_at": true,
+  "windows_mode_ftp": true,
+  "user_belongs_to_parent_site": true,
+  "impersonator_user_id": 1
 }
 ```
 
 * `id` (string): Session ID
 * `language` (string): Session language
+* `aws_secret_key` (string): AWS Secret Key for validating AWS-style signatures in the Inbound S3 endpoint.
+* `ai_assistant_personality_id` (int64): AI Assistant Personality ID for the in-app AI Assistant.
+* `ai_assistant_personality_system_prompt` (string): System prompt for the in-app AI Assistant.
+* `login_token` (string): Login token. If set, this token will allow your user to log in via browser at the domain in `login_token_domain`.
+* `login_token_domain` (string): Domain to use with `login_token`.
+* `default_workspace_id` (int64): Workspace ID the user should land in by default when more than one Workspace is available.
+* `max_dir_listing_size` (int64): Maximum number of files to retrieve per folder for a directory listing.  This is based on the user's plan.
+* `multiple_regions` (boolean): Can access multiple regions?
 * `read_only` (boolean): Is this session read only?
+* `root_path` (string): Root path to restrict the user's session to.
+* `home_path` (string): Initial path to start the user's session in.
 * `sftp_insecure_ciphers` (boolean): Are insecure SFTP ciphers allowed for this user? (If this is set to true, the site administrator has signaled that it is ok to use less secure SSH ciphers for this user.)
+* `site_id` (int64): Site ID
+* `ssl_required` (boolean): Is SSL required for this user?  (If so, ensure all your communications with this user use SSL.)
+* `timeout_at` (date-time): Session timeout datetime
+* `trusted` (boolean): Can this session tolerate IP and User-Agent mismatches?
+* `two_factor_setup_needed` (boolean): If true, this user needs to add a Two Factor Authentication method before performing any further actions.
+* `allowed_2fa_method_sms` (boolean): Sent only if 2FA setup is needed. Is SMS two factor authentication allowed?
+* `allowed_2fa_method_totp` (boolean): Sent only if 2FA setup is needed. Is TOTP two factor authentication allowed?
+* `allowed_2fa_method_webauthn` (boolean): Sent only if 2FA setup is needed. Is WebAuthn two factor authentication allowed?
+* `allowed_2fa_method_yubi` (boolean): Sent only if 2FA setup is needed. Is Yubikey two factor authentication allowed?
+* `calculate_file_checksums_crc32` (boolean): Calculate CRC32 checksum for incoming files?
+* `calculate_file_checksums_md5` (boolean): Calculate MD5 checksum for incoming files?
+* `calculate_file_checksums_sha1` (boolean): Calculate SHA1 checksum for incoming files?
+* `calculate_file_checksums_sha256` (boolean): Calculate SHA256 checksum for incoming files?
+* `legacy_checksums_mode` (boolean): Use legacy checksums mode?
+* `finalize_partial_uploads` (boolean): Finalize partial SFTP uploads?
+* `use_provided_modified_at` (boolean): Allow the user to provide file/folder modified at dates?  If false, the server will always use the current date/time.
+* `windows_mode_ftp` (boolean): Does this user want to use Windows line-ending emulation?  (CR vs CRLF)
+* `user_belongs_to_parent_site` (boolean): 
+* `impersonator_user_id` (int64): User ID of the Site Admin who initiated a Read-Only session impersonating this session's user
 * `username` (string): Username to sign in as
 * `password` (string): Password for sign in
+* `aws_access_key_id` (string): AWS Access Key ID for signing in with AWS credentials
+* `change_password` (string): 
+* `change_password_confirmation` (string): 
+* `interface` (string): 
+* `ssh_client_identification` (string): 
+* `locale` (string): 
+* `no_cookie` (boolean): 
+* `oauth_provider` (string): 
+* `oauth_label` (string): 
+* `oauth_code` (string): 
+* `oauth_state` (string): 
 * `otp` (string): If this user has a 2FA device, provide its OTP or code here.
 * `partial_session_id` (string): Identifier for a partially-completed login
 
@@ -29,6 +98,8 @@
 Files::Session.create(
   username: "username", 
   password: "password", 
+  aws_access_key_id: "AKIAIOSFODNN7EXAMPLE", 
+  no_cookie: false, 
   otp: "123456"
 )
 ```
@@ -37,10 +108,170 @@ Files::Session.create(
 
 * `username` (string): Username to sign in as
 * `password` (string): Password for sign in
+* `aws_access_key_id` (string): AWS Access Key ID for signing in with AWS credentials
+* `change_password` (string): 
+* `change_password_confirmation` (string): 
+* `interface` (string): 
+* `ssh_client_identification` (string): 
+* `locale` (string): 
+* `no_cookie` (boolean): 
+* `oauth_provider` (string): 
+* `oauth_label` (string): 
+* `oauth_code` (string): 
+* `oauth_state` (string): 
 * `otp` (string): If this user has a 2FA device, provide its OTP or code here.
 * `partial_session_id` (string): Identifier for a partially-completed login
 
 
+---
+
+## Login the current user to a child site
+
+```
+Files::Session.subdomain(
+  subdomain: "child_site"
+)
+```
+
+### Parameters
+
+* `subdomain` (string): Required - Site subdomain to login to
+
+
+---
+
+## Site Admins only: Create a read-only session representing another user
+
+```
+Files::Session.as_user(
+  user_id: "2"
+)
+```
+
+### Parameters
+
+* `user_id` (string): Required - User id to login as
+
+
+---
+
+## Create trusted session from an existing session
+
+```
+Files::Session.trusted(
+  session_id: "60525f92e859c4c3d74cb02fd176b1525901b525"
+)
+```
+
+### Parameters
+
+* `session_id` (string): Required - Session ID to convert to a trusted session
+
+
+---
+
+## Reset password given a password reset code
+
+```
+Files::Session.forgot_reset(
+  code: "abc123", 
+  password: "password", 
+  confirm_password: "password", 
+  interface: "web", 
+  locale: "en", 
+  otp: "123456"
+)
+```
+
+### Parameters
+
+* `code` (string): Required - 
+* `password` (string): Required - 
+* `confirm_password` (string): 
+* `interface` (string): 
+* `locale` (string): 
+* `otp` (string): 
+
+
+---
+
+## Validate password reset code
+
+```
+Files::Session.forgot_validate(
+  code: "abc123"
+)
+```
+
+### Parameters
+
+* `code` (string): Required - 
+
+
+---
+
+## Initiate a password reset process given an email address or username
+
+```
+Files::Session.forgot(
+  email: "johndoe@gmail.com"
+)
+```
+
+### Parameters
+
+* `email` (string): 
+* `username` (string): 
+* `username_or_email` (string): 
+
+
+---
+
+## Create Public Hosting session pairing key
+
+```
+Files::Session.public_hosting(
+  return_to: "return_to"
+)
+```
+
+### Parameters
+
+* `return_to` (string): Required - Public Hosting URL to return to after authentication
+
+
+---
+
+## Create long lived session (API Key) from Pairing Key
+
+```
+Files::Session.pairing_key(key)
+```
+
+### Parameters
+
+* `key` (string): Required - The pairing key to reserve for login.  Cannot be reused
+
+
+---
+
+## Begin new session via Oauth
+
+```
+Files::Session.oauth(
+  provider: "okta", 
+  label: "My Corporate SSO Provider"
+)
+```
+
+### Parameters
+
+* `provider` (string): Required - 
+* `label` (string): 
+* `state` (string): 
+* `host` (string): 
+
+
 ---
 
 ## Delete user session (log out)

data/docs/session_available_site.md

@@ -0,0 +1,26 @@
+# SessionAvailableSite
+
+## Example SessionAvailableSite Object
+
+```
+{
+  "id": 1,
+  "name": "My Site",
+  "domain": "my-custom-domain.com",
+  "subdomain": "mysite",
+  "logo": {
+    "name": "My logo",
+    "uri": "https://mysite.files.com/.../my_image.png"
+  },
+  "color2_top": "#000000",
+  "folder_permissions_groups_only": true
+}
+```
+
+* `id` (int64): Site Id
+* `name` (string): Site name
+* `domain` (string): Custom domain
+* `subdomain` (string): Site subdomain
+* `logo` (Image): Branded logo
+* `color2_top` (string): Top bar background color
+* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user).

data/docs/setting.md

@@ -0,0 +1,33 @@
+
+
+---
+
+## List supported languages
+
+```
+Files::Setting.languages
+```
+
+
+---
+
+## Show the site settings, which is a dump of a lot of information that pertains to the current site
+
+```
+Files::Setting.list
+```
+
+
+---
+
+## Show the site settings for a specific domain
+
+```
+Files::Setting.get_domain(
+  domain: "actionverb"
+)
+```
+
+### Parameters
+
+* `domain` (string): Required -