files.com 1.1.670 → 1.1.671

data/docs/sftp_host_key.md

@@ -61,6 +61,15 @@ Files::SftpHostKey.create(
 * `private_key` (string): The private key data.
 
 
+---
+
+## Create an export CSV of SFTP Host Key resources
+
+```
+Files::SftpHostKey.create_export
+```
+
+
 ---
 
 ## Update SFTP Host Key

data/docs/share_group.md

@@ -76,6 +76,21 @@ Files::ShareGroup.create(
 * `members` (array(object)): Required - A list of share group members.
 
 
+---
+
+## Create an export CSV of Share Group resources
+
+```
+Files::ShareGroup.create_export(
+  user_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+
+
 ---
 
 ## Update Share Group

data/docs/siem_http_destination.md

@@ -227,6 +227,15 @@ Files::SiemHttpDestination.create(
 * `destination_url` (string): Destination Url
 
 
+---
+
+## Create an export CSV of SIEM HTTP Destination resources
+
+```
+Files::SiemHttpDestination.create_export
+```
+
+
 ---
 
 ## send_test_entry SIEM HTTP Destination

data/docs/siem_http_destination_event.md

@@ -58,3 +58,21 @@ Files::SiemHttpDestinationEvent.find(id)
 ### Parameters
 
 * `id` (int64): Required - Siem Http Destination Event ID.
+
+
+---
+
+## Create an export CSV of SIEM HTTP Destination Event resources
+
+```
+Files::SiemHttpDestinationEvent.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`, `status` or `siem_http_destination_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `siem_http_destination_id` or `status`. Valid field combinations are `[ siem_http_destination_id, created_at ]`, `[ status, created_at ]`, `[ siem_http_destination_id, status ]` or `[ siem_http_destination_id, status, created_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

data/docs/site.md

@@ -543,6 +543,19 @@
 * `welcome_email_enabled` (boolean): Will the welcome email be sent to new users?
 * `welcome_screen` (string): Does the welcome screen appear?
 * `windows_mode_ftp` (boolean): Does FTP user Windows emulation mode?
+* `lead_cookie_code` (string): 
+* `recaptcha_token` (string): 
+* `username` (string): 
+* `password` (string): 
+* `utm_term` (string): 
+* `utm_source` (string): 
+* `utm_content` (string): 
+* `utm_medium` (string): 
+* `utm_campaign` (string): 
+* `utm_domain` (string): 
+* `gclid` (string): 
+* `plan_id` (int64): 
+* `brand` (string): 
 
 
 ---
@@ -563,6 +576,123 @@ Files::Site.get_usage
 ```
 
 
+---
+
+## Show plan that will be switched to in the future. (Populated if current plan is deprecated and no longer offered beyond the current billing period.)
+
+```
+Files::Site.get_switch_to_plan
+```
+
+
+---
+
+## Show the current billing plan of a site
+
+```
+Files::Site.get_plan(
+  currency: "USD"
+)
+```
+
+### Parameters
+
+* `currency` (string): Currency.
+
+
+---
+
+## Complete a PayPal subscription
+
+```
+Files::Site.get_paypal_express_info(
+  paypal_token: "[token]"
+)
+```
+
+### Parameters
+
+* `paypal_token` (string): Required - Billing token for use with paypal.
+
+
+---
+
+## Initiate a new PayPal subscription
+
+```
+Files::Site.get_paypal_express(
+  return_to_url: "https://app.files.com/...", 
+  plan_id: 1
+)
+```
+
+### Parameters
+
+* `return_to_url` (string): Required - URL that paypal express forwards the user to.
+* `plan_id` (int64): Plan ID to switch to.
+
+
+---
+
+## Apply a trial code to the current Mover site
+
+```
+Files::Site.mover_trial_code(
+  code: "TRIAL30"
+)
+```
+
+### Parameters
+
+* `code` (string): Required - Mover trial code to apply
+
+
+---
+
+## Create Site
+
+```
+Files::Site.create(
+  name: "Action Verb", 
+  email: "johndoe@gmail.com", 
+  lead_cookie_code: "lead_cookie_code", 
+  recaptcha_token: "recaptcha_token", 
+  reply_to_email: "customer-service@gmail.com", 
+  phone: "+18002868372", 
+  contact_name: "John Doe", 
+  username: "MyUsername", 
+  password: "MyNewPassword101", 
+  currency: "USD", 
+  language: "en", 
+  plan_id: 1, 
+  brand: "files"
+)
+```
+
+### Parameters
+
+* `name` (string): Required - 
+* `email` (string): Required - 
+* `lead_cookie_code` (string): Required - 
+* `recaptcha_token` (string): Required - 
+* `reply_to_email` (string): 
+* `phone` (string): 
+* `contact_name` (string): 
+* `username` (string): 
+* `password` (string): 
+* `currency` (string): 
+* `language` (string): 
+* `utm_term` (string): 
+* `utm_source` (string): 
+* `utm_content` (string): 
+* `utm_medium` (string): 
+* `utm_campaign` (string): 
+* `utm_domain` (string): 
+* `gclid` (string): 
+* `plan_id` (int64): 
+* `brand` (string): 
+
+
 ---
 
 ## Update Site Settings
@@ -929,3 +1059,52 @@ Files::Site.update(
 * `ldap_password_change_confirmation` (string): Confirm new LDAP password.
 * `redirect_old_subdomain` (boolean): If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
 * `smtp_password` (string): Password for SMTP server.
+
+
+---
+
+## Change the current billing plan for the site
+
+```
+Files::Site.update_plan(id, 
+  billing_frequency: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Plan ID.
+* `billing_frequency` (int64): The billing frequency for the site.  Must be 1 (monthly) or 12 (annual).
+
+
+---
+
+## Cancel site
+
+```
+Files::Site.delete(
+  reason: "Reason"
+)
+```
+
+### Parameters
+
+* `reason` (string): Reason the site was cancelled.
+
+
+---
+
+## Change the current billing plan for the site
+
+```
+site = Files::Site.find(id)
+
+site.update_plan(
+  billing_frequency: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Plan ID.
+* `billing_frequency` (int64): The billing frequency for the site.  Must be 1 (monthly) or 12 (annual).

data/docs/site_subdomain_redirect.md

@@ -45,6 +45,19 @@ Files::SiteSubdomainRedirect.find(id)
 * `id` (int64): Required - Site Subdomain Redirect ID.
 
 
+---
+
+## Create an export CSV of Site Subdomain Redirect resources
+
+```
+Files::SiteSubdomainRedirect.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
+
+
 ---
 
 ## Delete Site Subdomain Redirect

data/docs/snapshot.md

@@ -80,6 +80,15 @@ Files::Snapshot.finalize(id)
 * `id` (int64): Required - Snapshot ID.
 
 
+---
+
+## Create an export CSV of Snapshot resources
+
+```
+Files::Snapshot.create_export
+```
+
+
 ---
 
 ## Update Snapshot

data/docs/ssl_certificate.md

@@ -0,0 +1,37 @@
+# SslCertificate
+
+## Example SslCertificate Object
+
+```
+{
+  "name": "example",
+  "certificate": "example",
+  "private_key": "example",
+  "key": null,
+  "intermediates": "example",
+  "id": 1,
+  "domain_hsts_header": true,
+  "ftps_enabled": true,
+  "https_enabled": true,
+  "sftp_insecure_ciphers": true,
+  "tls_disabled": true,
+  "subdomain": "example",
+  "domains": [
+    "example"
+  ]
+}
+```
+
+* `name` (string): The name of the site associated with this SSL certificate.
+* `certificate` (string): The text of the certificate itself.
+* `private_key` (string): Private key used to generate the certificate.
+* `key` (object): Private key encrypted with our secret key.
+* `intermediates` (string): Intermediate certificates, if available.
+* `id` (int64): ID of the site associated with this certificate, including group id if available.
+* `domain_hsts_header` (boolean): True if a HSTS header should be rendered for the site
+* `ftps_enabled` (boolean): Whether or not this certificate can be used for FTPS.
+* `https_enabled` (boolean): Whether or not this certificate can be used for HTTPS. Always true.
+* `sftp_insecure_ciphers` (boolean): True if the site associated with this certificate has the "Allow Insecure SFTP Ciphers" feature turned on.
+* `tls_disabled` (boolean): True if the site associated with this certificate has the "Security Opt Out" feature turned on.
+* `subdomain` (string): Site subdomain.
+* `domains` (array(string)): Domains associated with this certificate.

data/docs/sso_event.md

@@ -71,3 +71,22 @@ Files::SsoEvent.find(id)
 ### Parameters
 
 * `id` (int64): Required - Sso Event ID.
+
+
+---
+
+## Create an export CSV of SSO Event resources
+
+```
+Files::SsoEvent.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`, `event_type`, `status` or `user_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `event_type`, `idp_uid`, `ip`, `provider`, `status`, `user_id` or `username`. Valid field combinations are `[ event_type, created_at ]`, `[ idp_uid, created_at ]`, `[ ip, created_at ]`, `[ provider, created_at ]`, `[ status, created_at ]`, `[ user_id, created_at ]`, `[ username, created_at ]`, `[ event_type, status ]`, `[ idp_uid, status ]`, `[ ip, status ]`, `[ provider, status ]`, `[ user_id, status ]`, `[ username, status ]`, `[ event_type, status, created_at ]`, `[ idp_uid, status, created_at ]`, `[ ip, status, created_at ]`, `[ provider, status, created_at ]`, `[ user_id, status, created_at ]` or `[ username, status, created_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `idp_uid`, `ip`, `provider` or `username`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.