files.com 1.0.190 → 1.0.193

package/docs/models/RemoteServer.md

@@ -0,0 +1,385 @@
+# RemoteServer
+
+## Example RemoteServer Object
+
+```
+{
+  "id": 1,
+  "disabled": true,
+  "authentication_method": "password",
+  "hostname": "remote-server.com",
+  "remote_home_path": "/home/user1",
+  "name": "My Remote server",
+  "port": 1,
+  "max_connections": 1,
+  "s3_bucket": "my-bucket",
+  "s3_region": "us-east-1",
+  "aws_access_key": "",
+  "server_certificate": "require_match",
+  "server_host_key": "[public key]",
+  "server_type": "s3",
+  "ssl": "if_available",
+  "username": "user",
+  "google_cloud_storage_bucket": "my-bucket",
+  "google_cloud_storage_project_id": "my-project",
+  "backblaze_b2_s3_endpoint": "s3.us-west-001.backblazeb2.com",
+  "backblaze_b2_bucket": "my-bucket",
+  "wasabi_bucket": "my-bucket",
+  "wasabi_region": "us-west-1",
+  "wasabi_access_key": "",
+  "rackspace_username": "rackspaceuser",
+  "rackspace_region": "dfw",
+  "rackspace_container": "my-container",
+  "auth_setup_link": "auth/:provider",
+  "auth_status": "in_setup",
+  "auth_account_name": "me@example.com",
+  "one_drive_account_type": "personal",
+  "azure_blob_storage_account": "storage-account-name",
+  "azure_blob_storage_sas_token": "storage-sas-token",
+  "azure_blob_storage_container": "container-name",
+  "azure_files_storage_account": "storage-account-name",
+  "azure_files_storage_sas_token": "storage-sas-token",
+  "azure_files_storage_share_name": "share-name",
+  "s3_compatible_bucket": "my-bucket",
+  "s3_compatible_endpoint": "mys3platform.com",
+  "s3_compatible_region": "us-east-1",
+  "s3_compatible_access_key": "",
+  "enable_dedicated_ips": true
+}
+```
+
+* `id` (int64): Remote server ID
+* `disabled` (boolean): If true, this server has been disabled due to failures.  Make any change or set disabled to false to clear this flag.
+* `authentication_method` (string): Type of authentication method
+* `hostname` (string): Hostname or IP address
+* `remote_home_path` (string): Initial home folder on remote server
+* `name` (string): Internal name for your reference
+* `port` (int64): Port for remote server.  Not needed for S3.
+* `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
+* `s3_bucket` (string): S3 bucket name
+* `s3_region` (string): S3 region
+* `aws_access_key` (string): AWS Access Key.
+* `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
+* `server_type` (string): Remote server type.
+* `ssl` (string): Should we require SSL?
+* `username` (string): Remote server username.  Not needed for S3 buckets.
+* `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
+* `google_cloud_storage_project_id` (string): Google Cloud Project ID
+* `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
+* `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
+* `wasabi_bucket` (string): Wasabi Bucket name
+* `wasabi_region` (string): Wasabi region
+* `wasabi_access_key` (string): Wasabi access key.
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `auth_setup_link` (string): Returns link to login with an Oauth provider
+* `auth_status` (string): Either `in_setup` or `complete`
+* `auth_account_name` (string): Describes the authorized account
+* `one_drive_account_type` (string): Either personal or business_other account types
+* `azure_blob_storage_account` (string): Azure Blob Storage Account name
+* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `azure_blob_storage_container` (string): Azure Blob Storage Container name
+* `azure_files_storage_account` (string): Azure File Storage Account name
+* `azure_files_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `azure_files_storage_share_name` (string): Azure File Storage Share name
+* `s3_compatible_bucket` (string): S3-compatible Bucket name
+* `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `s3_compatible_region` (string): S3-compatible endpoint
+* `s3_compatible_access_key` (string): S3-compatible Access Key.
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
+* `aws_secret_key` (string): AWS secret key.
+* `password` (string): Password if needed.
+* `private_key` (string): Private key if needed.
+* `private_key_passphrase` (string): Passphrase for private key if needed.
+* `ssl_certificate` (string): SSL client certificate.
+* `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
+* `wasabi_secret_key` (string): Wasabi secret key.
+* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
+* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
+* `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
+* `azure_files_storage_access_key` (string): Azure File Storage access key.
+* `s3_compatible_secret_key` (string): S3-compatible secret key
+
+---
+
+## List Remote Servers
+
+```
+await RemoteServer.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+---
+
+## Show Remote Server
+
+```
+await RemoteServer.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+
+---
+
+## Create Remote Server
+
+```
+await RemoteServer.create({
+  'reset_authentication': true,
+  'hostname': "remote-server.com",
+  'name': "My Remote server",
+  'max_connections': 1,
+  'port': 1,
+  's3_bucket': "my-bucket",
+  's3_region': "us-east-1",
+  'server_certificate': "require_match",
+  'server_host_key': "[public key]",
+  'server_type': "s3",
+  'ssl': "if_available",
+  'username': "user",
+  'google_cloud_storage_bucket': "my-bucket",
+  'google_cloud_storage_project_id': "my-project",
+  'backblaze_b2_bucket': "my-bucket",
+  'backblaze_b2_s3_endpoint': "s3.us-west-001.backblazeb2.com",
+  'wasabi_bucket': "my-bucket",
+  'wasabi_region': "us-west-1",
+  'rackspace_username': "rackspaceuser",
+  'rackspace_region': "dfw",
+  'rackspace_container': "my-container",
+  'one_drive_account_type': "personal",
+  'azure_blob_storage_account': "storage-account-name",
+  'azure_blob_storage_container': "container-name",
+  'azure_blob_storage_sas_token': "storage-sas-token",
+  'azure_files_storage_account': "storage-account-name",
+  'azure_files_storage_share_name': "share-name",
+  'azure_files_storage_sas_token': "storage-sas-token",
+  's3_compatible_bucket': "my-bucket",
+  's3_compatible_endpoint': "mys3platform.com",
+  's3_compatible_region': "us-east-1",
+  'enable_dedicated_ips': true,
+})
+```
+
+
+### Parameters
+
+* `aws_access_key` (string): AWS Access Key.
+* `aws_secret_key` (string): AWS secret key.
+* `password` (string): Password if needed.
+* `private_key` (string): Private key if needed.
+* `private_key_passphrase` (string): Passphrase for private key if needed.
+* `ssl_certificate` (string): SSL client certificate.
+* `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
+* `wasabi_access_key` (string): Wasabi access key.
+* `wasabi_secret_key` (string): Wasabi secret key.
+* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
+* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
+* `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
+* `azure_files_storage_access_key` (string): Azure File Storage access key.
+* `hostname` (string): Hostname or IP address
+* `name` (string): Internal name for your reference
+* `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
+* `port` (int64): Port for remote server.  Not needed for S3.
+* `s3_bucket` (string): S3 bucket name
+* `s3_region` (string): S3 region
+* `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
+* `server_type` (string): Remote server type.
+* `ssl` (string): Should we require SSL?
+* `username` (string): Remote server username.  Not needed for S3 buckets.
+* `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
+* `google_cloud_storage_project_id` (string): Google Cloud Project ID
+* `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
+* `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
+* `wasabi_bucket` (string): Wasabi Bucket name
+* `wasabi_region` (string): Wasabi region
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `one_drive_account_type` (string): Either personal or business_other account types
+* `azure_blob_storage_account` (string): Azure Blob Storage Account name
+* `azure_blob_storage_container` (string): Azure Blob Storage Container name
+* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `azure_files_storage_account` (string): Azure File Storage Account name
+* `azure_files_storage_share_name` (string): Azure File Storage Share name
+* `azure_files_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `s3_compatible_bucket` (string): S3-compatible Bucket name
+* `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `s3_compatible_region` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
+* `s3_compatible_access_key` (string): S3-compatible Access Key.
+* `s3_compatible_secret_key` (string): S3-compatible secret key
+
+---
+
+## Update Remote Server
+
+```
+const [remote_server] = await RemoteServer.list()
+
+await remote_server.update({
+  'reset_authentication': true,
+  'hostname': "remote-server.com",
+  'name': "My Remote server",
+  'max_connections': 1,
+  'port': 1,
+  's3_bucket': "my-bucket",
+  's3_region': "us-east-1",
+  'server_certificate': "require_match",
+  'server_host_key': "[public key]",
+  'server_type': "s3",
+  'ssl': "if_available",
+  'username': "user",
+  'google_cloud_storage_bucket': "my-bucket",
+  'google_cloud_storage_project_id': "my-project",
+  'backblaze_b2_bucket': "my-bucket",
+  'backblaze_b2_s3_endpoint': "s3.us-west-001.backblazeb2.com",
+  'wasabi_bucket': "my-bucket",
+  'wasabi_region': "us-west-1",
+  'rackspace_username': "rackspaceuser",
+  'rackspace_region': "dfw",
+  'rackspace_container': "my-container",
+  'one_drive_account_type': "personal",
+  'azure_blob_storage_account': "storage-account-name",
+  'azure_blob_storage_container': "container-name",
+  'azure_blob_storage_sas_token': "storage-sas-token",
+  'azure_files_storage_account': "storage-account-name",
+  'azure_files_storage_share_name': "share-name",
+  'azure_files_storage_sas_token': "storage-sas-token",
+  's3_compatible_bucket': "my-bucket",
+  's3_compatible_endpoint': "mys3platform.com",
+  's3_compatible_region': "us-east-1",
+  'enable_dedicated_ips': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+* `aws_access_key` (string): AWS Access Key.
+* `aws_secret_key` (string): AWS secret key.
+* `password` (string): Password if needed.
+* `private_key` (string): Private key if needed.
+* `private_key_passphrase` (string): Passphrase for private key if needed.
+* `ssl_certificate` (string): SSL client certificate.
+* `google_cloud_storage_credentials_json` (string): A JSON file that contains the private key. To generate see https://cloud.google.com/storage/docs/json_api/v1/how-tos/authorizing#APIKey
+* `wasabi_access_key` (string): Wasabi access key.
+* `wasabi_secret_key` (string): Wasabi secret key.
+* `backblaze_b2_key_id` (string): Backblaze B2 Cloud Storage keyID.
+* `backblaze_b2_application_key` (string): Backblaze B2 Cloud Storage applicationKey.
+* `rackspace_api_key` (string): Rackspace API key from the Rackspace Cloud Control Panel.
+* `reset_authentication` (boolean): Reset authenticated account
+* `azure_blob_storage_access_key` (string): Azure Blob Storage secret key.
+* `azure_files_storage_access_key` (string): Azure File Storage access key.
+* `hostname` (string): Hostname or IP address
+* `name` (string): Internal name for your reference
+* `max_connections` (int64): Max number of parallel connections.  Ignored for S3 connections (we will parallelize these as much as possible).
+* `port` (int64): Port for remote server.  Not needed for S3.
+* `s3_bucket` (string): S3 bucket name
+* `s3_region` (string): S3 region
+* `server_certificate` (string): Remote server certificate
+* `server_host_key` (string): Remote server SSH Host Key. If provided, we will require that the server host key matches the provided key. Uses OpenSSH format similar to what would go into ~/.ssh/known_hosts
+* `server_type` (string): Remote server type.
+* `ssl` (string): Should we require SSL?
+* `username` (string): Remote server username.  Not needed for S3 buckets.
+* `google_cloud_storage_bucket` (string): Google Cloud Storage bucket name
+* `google_cloud_storage_project_id` (string): Google Cloud Project ID
+* `backblaze_b2_bucket` (string): Backblaze B2 Cloud Storage Bucket name
+* `backblaze_b2_s3_endpoint` (string): Backblaze B2 Cloud Storage S3 Endpoint
+* `wasabi_bucket` (string): Wasabi Bucket name
+* `wasabi_region` (string): Wasabi region
+* `rackspace_username` (string): Rackspace username used to login to the Rackspace Cloud Control Panel.
+* `rackspace_region` (string): Three letter airport code for Rackspace region. See https://support.rackspace.com/how-to/about-regions/
+* `rackspace_container` (string): The name of the container (top level directory) where files will sync.
+* `one_drive_account_type` (string): Either personal or business_other account types
+* `azure_blob_storage_account` (string): Azure Blob Storage Account name
+* `azure_blob_storage_container` (string): Azure Blob Storage Container name
+* `azure_blob_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `azure_files_storage_account` (string): Azure File Storage Account name
+* `azure_files_storage_share_name` (string): Azure File Storage Share name
+* `azure_files_storage_sas_token` (string): Shared Access Signature (SAS) token
+* `s3_compatible_bucket` (string): S3-compatible Bucket name
+* `s3_compatible_endpoint` (string): S3-compatible endpoint
+* `s3_compatible_region` (string): S3-compatible endpoint
+* `enable_dedicated_ips` (boolean): `true` if remote server only accepts connections from dedicated IPs
+* `s3_compatible_access_key` (string): S3-compatible Access Key.
+* `s3_compatible_secret_key` (string): S3-compatible secret key
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "disabled": true,
+  "authentication_method": "password",
+  "hostname": "remote-server.com",
+  "remote_home_path": "/home/user1",
+  "name": "My Remote server",
+  "port": 1,
+  "max_connections": 1,
+  "s3_bucket": "my-bucket",
+  "s3_region": "us-east-1",
+  "aws_access_key": "",
+  "server_certificate": "require_match",
+  "server_host_key": "[public key]",
+  "server_type": "s3",
+  "ssl": "if_available",
+  "username": "user",
+  "google_cloud_storage_bucket": "my-bucket",
+  "google_cloud_storage_project_id": "my-project",
+  "backblaze_b2_s3_endpoint": "s3.us-west-001.backblazeb2.com",
+  "backblaze_b2_bucket": "my-bucket",
+  "wasabi_bucket": "my-bucket",
+  "wasabi_region": "us-west-1",
+  "wasabi_access_key": "",
+  "rackspace_username": "rackspaceuser",
+  "rackspace_region": "dfw",
+  "rackspace_container": "my-container",
+  "auth_setup_link": "auth/:provider",
+  "auth_status": "in_setup",
+  "auth_account_name": "me@example.com",
+  "one_drive_account_type": "personal",
+  "azure_blob_storage_account": "storage-account-name",
+  "azure_blob_storage_sas_token": "storage-sas-token",
+  "azure_blob_storage_container": "container-name",
+  "azure_files_storage_account": "storage-account-name",
+  "azure_files_storage_sas_token": "storage-sas-token",
+  "azure_files_storage_share_name": "share-name",
+  "s3_compatible_bucket": "my-bucket",
+  "s3_compatible_endpoint": "mys3platform.com",
+  "s3_compatible_region": "us-east-1",
+  "s3_compatible_access_key": "",
+  "enable_dedicated_ips": true
+}
+```
+
+---
+
+## Delete Remote Server
+
+```
+const [remote_server] = await RemoteServer.list()
+
+await remote_server.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+

package/docs/models/Request.md

@@ -0,0 +1,97 @@
+# Request
+
+## Example Request Object
+
+```
+{
+  "id": 1,
+  "path": "",
+  "source": "",
+  "destination": "",
+  "automation_id": "",
+  "user_display_name": ""
+}
+```
+
+* `id` (int64): Request ID
+* `path` (string): Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `source` (string): Source filename, if applicable
+* `destination` (string): Destination filename
+* `automation_id` (string): ID of automation that created request
+* `user_display_name` (string): User making the request (if applicable)
+* `user_ids` (string): A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+
+---
+
+## List Requests
+
+```
+await Request.list({
+  'per_page': 1,
+  'mine': true,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
+* `mine` (boolean): Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+* `path` (string): Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+
+---
+
+## List Requests
+
+```
+await Request.getFolder(path, {
+  'per_page': 1,
+  'mine': true,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `destination`.
+* `mine` (boolean): Only show requests of the current user?  (Defaults to true if current user is not a site admin.)
+* `path` (string): Required - Path to show requests for.  If omitted, shows all paths. Send `/` to represent the root directory.
+
+---
+
+## Create Request
+
+```
+await Request.create({
+  'path': "path",
+  'destination': "destination",
+})
+```
+
+
+### Parameters
+
+* `path` (string): Required - Folder path on which to request the file.
+* `destination` (string): Required - Destination filename (without extension) to request.
+* `user_ids` (string): A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
+* `group_ids` (string): A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
+
+---
+
+## Delete Request
+
+```
+const [request] = await Request.list()
+
+await request.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Request ID.
+

package/docs/models/Session.md

@@ -0,0 +1,50 @@
+# Session
+
+## Example Session Object
+
+```
+{
+  "id": "60525f92e859c4c3d74cb02fd176b1525901b525",
+  "language": "en",
+  "read_only": true,
+  "sftp_insecure_ciphers": true
+}
+```
+
+* `id` (string): Session ID
+* `language` (string): Session language
+* `read_only` (boolean): Is this session read only?
+* `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.)
+* `username` (string): Username to sign in as
+* `password` (string): Password for sign in
+* `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
+
+---
+
+## Create user session (log in)
+
+```
+await Session.create({
+  'username': "username",
+  'password': "password",
+  'otp': "123456",
+})
+```
+
+
+### Parameters
+
+* `username` (string): Username to sign in as
+* `password` (string): Password for sign in
+* `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
+
+---
+
+## Delete user session (log out)
+
+```
+await Session.delete
+```
+

package/docs/models/SettingsChange.md

@@ -0,0 +1,44 @@
+# SettingsChange
+
+## Example SettingsChange Object
+
+```
+{
+  "changes": [
+    ""
+  ],
+  "created_at": "2000-01-01T01:00:00Z",
+  "user_id": 1,
+  "user_is_files_support": true,
+  "username": "some_user"
+}
+```
+
+* `changes` (string): Markdown-formatted change messages.
+* `created_at` (date-time): The time this change was made
+* `user_id` (int64): The user id responsible for this change
+* `user_is_files_support` (boolean): true if this change was performed by Files.com support.
+* `username` (string): The username of the user responsible for this change
+
+---
+
+## List Settings Changes
+
+```
+await SettingsChange.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `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 (e.g. sort_by[last_login_at]=desc). Valid fields are `api_key_id`, `created_at` or `user_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `api_key_id` and `user_id`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `api_key_id` and `user_id`.