files.com 1.0.92

data/docs/preview.md

@@ -0,0 +1,19 @@
+# Preview
+
+## Example Preview Object
+
+```
+{
+  "id": 1,
+  "status": "complete",
+  "download_uri": "https://mysite.files.com/...",
+  "type": "complete",
+  "size": 1024
+}
+```
+
+* `id` (int64): Preview ID
+* `status` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
+* `download_uri` (string): Link to download preview
+* `type` (string): Preview status.  Can be invalid, not_generated, generating, complete, or file_too_large
+* `size` (int64): Preview size

data/docs/project.md

@@ -0,0 +1,121 @@
+# Project
+
+## Example Project Object
+
+```
+{
+  "id": 1,
+  "global_access": "none"
+}
+```
+
+* `id` (int64): Project ID
+* `global_access` (string): Global access settings
+
+
+---
+
+## List Projects
+
+```
+Files::Project.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+
+
+---
+
+## Show Project
+
+```
+Files::Project.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+
+
+---
+
+## Create Project
+
+```
+Files::Project.create(
+  global_access: "global_access"
+)
+```
+
+### Parameters
+
+* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.
+
+
+---
+
+## Update Project
+
+```
+Files::Project.update(id, 
+  global_access: "global_access"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.
+
+
+---
+
+## Delete Project
+
+```
+Files::Project.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+
+
+---
+
+## Update Project
+
+```
+project = Files::Project.list_for(path).first
+
+project.update(
+  global_access: "global_access"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.
+* `global_access` (string): Required - Global permissions.  Can be: `none`, `anyone_with_read`, `anyone_with_full`.
+
+
+---
+
+## Delete Project
+
+```
+project = Files::Project.list_for(path).first
+
+project.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Project ID.

data/docs/public_ip_address.md

@@ -0,0 +1,13 @@
+# PublicIpAddress
+
+## Example PublicIpAddress Object
+
+```
+{
+  "ip_address": "1.1.1.1",
+  "server_name": "server-1"
+}
+```
+
+* `ip_address` (string): The public IP address.
+* `server_name` (string): The name of the frontend server.

data/docs/public_key.md

@@ -0,0 +1,133 @@
+# PublicKey
+
+## Example PublicKey Object
+
+```
+{
+  "id": 1,
+  "title": "My public key",
+  "created_at": "2000-01-01T01:00:00Z",
+  "fingerprint": "43:51:43:a1:b5:fc:8b:b7:0a:3a:a9:b1:0f:66:73:a8"
+}
+```
+
+* `id` (int64): Public key ID
+* `title` (string): Public key title
+* `created_at` (date-time): Public key created at date/time
+* `fingerprint` (string): Public key fingerprint
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `public_key` (string): Actual contents of SSH key.
+
+
+---
+
+## List Public Keys
+
+```
+Files::PublicKey.list(
+  user_id: 1, 
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+
+
+---
+
+## Show Public Key
+
+```
+Files::PublicKey.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+
+
+---
+
+## Create Public Key
+
+```
+Files::PublicKey.create(
+  user_id: 1, 
+  title: "My Main Key", 
+  public_key: "public_key"
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `title` (string): Required - Internal reference for key.
+* `public_key` (string): Required - Actual contents of SSH key.
+
+
+---
+
+## Update Public Key
+
+```
+Files::PublicKey.update(id, 
+  title: "My Main Key"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+* `title` (string): Required - Internal reference for key.
+
+
+---
+
+## Delete Public Key
+
+```
+Files::PublicKey.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+
+
+---
+
+## Update Public Key
+
+```
+public_key = Files::PublicKey.list_for(path).first
+
+public_key.update(
+  title: "My Main Key"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.
+* `title` (string): Required - Internal reference for key.
+
+
+---
+
+## Delete Public Key
+
+```
+public_key = Files::PublicKey.list_for(path).first
+
+public_key.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Public Key ID.

data/docs/remote_server.md

@@ -0,0 +1,356 @@
+# RemoteServer
+
+## Example RemoteServer Object
+
+```
+{
+  "id": 1,
+  "authentication_method": "password",
+  "hostname": "remote-server.com",
+  "name": "My Remote server",
+  "port": 1,
+  "max_connections": 1,
+  "s3_bucket": "my-bucket",
+  "s3_region": "us-east-1",
+  "server_certificate": "[certificate]",
+  "server_host_key": "[public key]",
+  "server_type": "s3",
+  "ssl": "always",
+  "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": "us-west-1",
+  "wasabi_region": "my-bucket",
+  "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_container": "container-name"
+}
+```
+
+* `id` (int64): Remote server ID
+* `authentication_method` (string): Type of authentication method
+* `hostname` (string): Hostname or IP address
+* `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
+* `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 region
+* `wasabi_region` (string): Wasabi Bucket name
+* `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_container` (string): Azure Blob Storage Container name
+* `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.
+* `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.
+
+
+---
+
+## List Remote Servers
+
+```
+Files::RemoteServer.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
+
+
+---
+
+## Show Remote Server
+
+```
+Files::RemoteServer.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+
+
+---
+
+## Create Remote Server
+
+```
+Files::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: "[certificate]", 
+  server_host_key: "[public key]", 
+  server_type: "s3", 
+  ssl: "always", 
+  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: "us-west-1", 
+  wasabi_region: "my-bucket", 
+  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"
+)
+```
+
+### 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.
+* `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.
+* `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 region
+* `wasabi_region` (string): Wasabi Bucket name
+* `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
+
+
+---
+
+## Update Remote Server
+
+```
+Files::RemoteServer.update(id, 
+  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: "[certificate]", 
+  server_host_key: "[public key]", 
+  server_type: "s3", 
+  ssl: "always", 
+  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: "us-west-1", 
+  wasabi_region: "my-bucket", 
+  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"
+)
+```
+
+### 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.
+* `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.
+* `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 region
+* `wasabi_region` (string): Wasabi Bucket name
+* `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
+
+
+---
+
+## Delete Remote Server
+
+```
+Files::RemoteServer.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.
+
+
+---
+
+## Update Remote Server
+
+```
+remote_server = Files::RemoteServer.list_for(path).first
+
+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: "[certificate]",
+  server_host_key: "[public key]",
+  server_type: "s3",
+  ssl: "always",
+  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: "us-west-1",
+  wasabi_region: "my-bucket",
+  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"
+)
+```
+
+### 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.
+* `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.
+* `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 region
+* `wasabi_region` (string): Wasabi Bucket name
+* `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
+
+
+---
+
+## Delete Remote Server
+
+```
+remote_server = Files::RemoteServer.list_for(path).first
+
+remote_server.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Remote Server ID.