files.com 1.1.671 → 1.1.672

data/docs/ip_abuse_entry.md

@@ -1,47 +0,0 @@
-# IpAbuseEntry
-
-* `ip` (string): 
-* `list` (string): 
-* `hostname` (string): 
-* `reason` (string): 
-
-
----
-
-## List IP Abuse Entries
-
-```
-Files::IpAbuseEntry.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 IP Abuse Entry
-
-```
-Files::IpAbuseEntry.create(
-  ip: "ip"
-)
-```
-
-### Parameters
-
-* `ip` (string): Required - 
-* `list` (string): 
-* `hostname` (string): 
-* `reason` (string): 
-
-
----
-
-## Create an export CSV of IP Abuse Entry resources
-
-```
-Files::IpAbuseEntry.create_export
-```

data/docs/label.md

@@ -1,9 +0,0 @@
-
-
----
-
-## Get Label
-
-```
-Files::Label.list
-```

data/docs/lead.md

@@ -1,161 +0,0 @@
-# Lead
-
-## Example Lead Object
-
-```
-{
-  "id": 1,
-  "code": "abc123",
-  "name": "account",
-  "address": "123 Main St",
-  "address_2": "Window 1",
-  "city": "New York",
-  "company_name": "Action Verb",
-  "contact_name": "John Doe",
-  "country": "US",
-  "currency": "USD",
-  "email": "john.doe@files.com",
-  "language": "en",
-  "phone_number": "555-555-5555",
-  "state": "NY",
-  "zip": "00000",
-  "lead_level": "mql",
-  "signup_page_split_test_group": "control"
-}
-```
-
-* `id` (int64): Lead ID
-* `code` (string): Lead Cookie Code
-* `name` (string): Lead name
-* `address` (string): Lead address
-* `address_2` (string): Lead address 2
-* `city` (string): Lead city
-* `company_name` (string): Lead company name
-* `contact_name` (string): Contact name at the company
-* `country` (string): Lead country
-* `currency` (string): Lead preferred currency
-* `email` (string): Lead email address
-* `language` (string): Lead preferred language
-* `phone_number` (string): Lead phone number
-* `state` (string): Lead state
-* `zip` (string): Lead zipcode
-* `lead_level` (string): Quality score of the lead
-* `signup_page_split_test_group` (string): Signup page split test group
-* `recaptcha_token` (string): 
-* `form_name` (string): Signup form name
-* `lead_source` (string): Source of the lead
-* `opportunity_comment` (string): Opportunity comment
-* `opportunity_type` (string): Type of opportunity to create
-* `gclid` (string): Google Adwords Click ID
-* `original_brand` (string): Brand: `files`, `exavault` or `mover`
-* `utm_campaign` (string): Marketing tracking - campaign
-* `utm_content` (string): Marketing tracking - content
-* `utm_domain` (string): Marketing tracking - domain
-* `utm_medium` (string): Marketing tracking - medium
-* `utm_source` (string): Marketing tracking - source
-* `utm_term` (string): Marketing tracking - term
-* `time_zone` (string): Time zone, as returned by Javascript
-* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)
-
-
----
-
-## Create Lead
-
-```
-Files::Lead.create(
-  name: "account", 
-  address: "123 Main St", 
-  address_2: "Window 1", 
-  city: "New York", 
-  contact_name: "John Doe", 
-  currency: "USD", 
-  email: "john.doe@files.com", 
-  language: "en", 
-  phone_number: "555-555-5555", 
-  state: "NY", 
-  zip: "00000", 
-  time_zone_offset: 1
-)
-```
-
-### Parameters
-
-* `recaptcha_token` (string): 
-* `name` (string): Lead name
-* `address` (string): Lead address
-* `address_2` (string): Lead address 2
-* `city` (string): Lead city
-* `contact_name` (string): Contact name at the company
-* `currency` (string): Lead preferred currency
-* `email` (string): Lead email address
-* `language` (string): Lead preferred language
-* `phone_number` (string): Lead phone number
-* `state` (string): Lead state
-* `zip` (string): Lead zipcode
-* `form_name` (string): Signup form name
-* `lead_source` (string): Source of the lead
-* `opportunity_comment` (string): Opportunity comment
-* `opportunity_type` (string): Type of opportunity to create
-* `gclid` (string): Google Adwords Click ID
-* `original_brand` (string): Brand: `files`, `exavault` or `mover`
-* `utm_campaign` (string): Marketing tracking - campaign
-* `utm_content` (string): Marketing tracking - content
-* `utm_domain` (string): Marketing tracking - domain
-* `utm_medium` (string): Marketing tracking - medium
-* `utm_source` (string): Marketing tracking - source
-* `utm_term` (string): Marketing tracking - term
-* `time_zone` (string): Time zone, as returned by Javascript
-* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)
-
-
----
-
-## Update Lead
-
-```
-Files::Lead.update(code, 
-  name: "account", 
-  address: "123 Main St", 
-  address_2: "Window 1", 
-  city: "New York", 
-  contact_name: "John Doe", 
-  currency: "USD", 
-  email: "john.doe@files.com", 
-  language: "en", 
-  phone_number: "555-555-5555", 
-  state: "NY", 
-  zip: "00000", 
-  time_zone_offset: 1
-)
-```
-
-### Parameters
-
-* `code` (string): Required - Lead lookup code.
-* `recaptcha_token` (string): 
-* `name` (string): Lead name
-* `address` (string): Lead address
-* `address_2` (string): Lead address 2
-* `city` (string): Lead city
-* `contact_name` (string): Contact name at the company
-* `currency` (string): Lead preferred currency
-* `email` (string): Lead email address
-* `language` (string): Lead preferred language
-* `phone_number` (string): Lead phone number
-* `state` (string): Lead state
-* `zip` (string): Lead zipcode
-* `form_name` (string): Signup form name
-* `lead_source` (string): Source of the lead
-* `opportunity_comment` (string): Opportunity comment
-* `opportunity_type` (string): Type of opportunity to create
-* `gclid` (string): Google Adwords Click ID
-* `original_brand` (string): Brand: `files`, `exavault` or `mover`
-* `utm_campaign` (string): Marketing tracking - campaign
-* `utm_content` (string): Marketing tracking - content
-* `utm_domain` (string): Marketing tracking - domain
-* `utm_medium` (string): Marketing tracking - medium
-* `utm_source` (string): Marketing tracking - source
-* `utm_term` (string): Marketing tracking - term
-* `time_zone` (string): Time zone, as returned by Javascript
-* `time_zone_offset` (int64): Time zone offset (integer from -12 to 12)

data/docs/monitoring_stat.md

@@ -1,38 +0,0 @@
-# MonitoringStat
-
-## Example MonitoringStat Object
-
-```
-{
-  "alerts": [
-    "example"
-  ],
-  "info": "example"
-}
-```
-
-* `alerts` (array(string)): 
-* `info` (object): 
-
-
----
-
-## List Monitoring Stats
-
-```
-Files::MonitoringStat.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 Monitoring Stat resources
-
-```
-Files::MonitoringStat.create_export
-```

data/docs/monitoring_stats.md

@@ -1,15 +0,0 @@
-# MonitoringStats
-
-## Example MonitoringStats Object
-
-```
-{
-  "alerts": [
-    "example"
-  ],
-  "info": "example"
-}
-```
-
-* `alerts` (array(string)): 
-* `info` (object): 

data/docs/mover_package.md

@@ -1,68 +0,0 @@
-# MoverPackage
-
-## Example MoverPackage Object
-
-```
-{
-  "id": 1,
-  "prepaid_bytes": 1,
-  "prepaid_expire_in_days": 1,
-  "price": "1.0"
-}
-```
-
-* `id` (int64): Mover package ID
-* `prepaid_bytes` (int64): Total prepaid bytes included in this package
-* `prepaid_expire_in_days` (int64): Number of days this package is valid for after purchase
-* `price` (decimal): Price of this mover package in the site's currency
-
-
----
-
-## List Mover Packages
-
-```
-Files::MoverPackage.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).
-
-
----
-
-## Purchase a Mover package for the current site
-
-```
-Files::MoverPackage.purchase(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Mover Package ID.
-
-
----
-
-## Create an export CSV of Mover Package resources
-
-```
-Files::MoverPackage.create_export
-```
-
-
----
-
-## Purchase a Mover package for the current site
-
-```
-mover_package = Files::MoverPackage.list.first
-
-mover_package.purchase
-```
-
-### Parameters
-
-* `id` (int64): Required - Mover Package ID.

data/docs/nps_response.md

@@ -1,75 +0,0 @@
-# NpsResponse
-
-## Example NpsResponse Object
-
-```
-{
-  "id": 1,
-  "next_step": "example"
-}
-```
-
-* `id` (int64): NPS response id
-* `next_step` (string): 
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `score` (int64): NPS score
-* `skipped` (boolean): NPS skipped
-* `comment` (string): NPS comment
-* `contact_me` (boolean): NPS contact_me
-
-
----
-
-## Create Nps Response
-
-```
-Files::NpsResponse.create(
-  user_id: 1, 
-  score: 1, 
-  skipped: false
-)
-```
-
-### Parameters
-
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `score` (int64): NPS score
-* `skipped` (boolean): NPS skipped
-
-
----
-
-## Update Nps Response
-
-```
-Files::NpsResponse.update(id, 
-  comment: "comment", 
-  contact_me: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Nps Response ID.
-* `comment` (string): Required - NPS comment
-* `contact_me` (boolean): NPS contact_me
-
-
----
-
-## Update Nps Response
-
-```
-nps_response = Files::NpsResponse.new
-
-nps_response.update(
-  comment: "comment",
-  contact_me: false
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Nps Response ID.
-* `comment` (string): Required - NPS comment
-* `contact_me` (boolean): NPS contact_me

data/docs/oauth_redirect.md

@@ -1,11 +0,0 @@
-# OauthRedirect
-
-## Example OauthRedirect Object
-
-```
-{
-  "redirect_uri": "https://provider.com/redirect..."
-}
-```
-
-* `redirect_uri` (string): Redirect URL

data/docs/paired_api_key.md

@@ -1,19 +0,0 @@
-# PairedApiKey
-
-## Example PairedApiKey Object
-
-```
-{
-  "server": "mysite.files.com",
-  "username": "@api-1",
-  "password": "",
-  "user_username": "my_user",
-  "nickname": "my_user @ mysite.files.com"
-}
-```
-
-* `server` (string): Site URL
-* `username` (string): Paired API key username
-* `password` (string): Paired API key password
-* `user_username` (string): Unique nickname for this API key
-* `nickname` (string): Unique nickname for this API key

data/docs/paypal_express_info.md

@@ -1,31 +0,0 @@
-# PaypalExpressInfo
-
-## Example PaypalExpressInfo Object
-
-```
-{
-  "billing_email": "john.doe@files.com",
-  "billing_company_name": "Action Verb",
-  "billing_address": "123 Main St",
-  "billing_address_2": "Door 1",
-  "billing_city": "New York",
-  "billing_state": "NY",
-  "billing_country": "US",
-  "billing_zip": "000000",
-  "billing_name": "John Doe",
-  "billing_phone": "555-555-5555",
-  "paypal_payer_id": "example"
-}
-```
-
-* `billing_email` (email): Paypal billing email
-* `billing_company_name` (string): Paypal billing company name
-* `billing_address` (string): Paypal billing address
-* `billing_address_2` (string): Paypal billing address 2
-* `billing_city` (string): Paypal billing city
-* `billing_state` (string): Paypal billing state
-* `billing_country` (string): Paypal billing country
-* `billing_zip` (string): Paypal billing zipcode
-* `billing_name` (string): Paypal billing name
-* `billing_phone` (string): Paypal billing phone
-* `paypal_payer_id` (string): Paypal payer ID

data/docs/paypal_express_url.md

@@ -1,11 +0,0 @@
-# PaypalExpressUrl
-
-## Example PaypalExpressUrl Object
-
-```
-{
-  "redirect_to": "https://www.paypal.com/..."
-}
-```
-
-* `redirect_to` (string): Redirect link

data/docs/plan.md

@@ -1,107 +0,0 @@
-# Plan
-
-## Example Plan Object
-
-```
-{
-  "id": 1,
-  "activation_cost": "10.0",
-  "addon_description": "FTP/SFTP/WebDAV addon",
-  "annually": "2988.0",
-  "annually_addon": "2988.0",
-  "automation_and_sync_flow_overage_cost": "25.0",
-  "automation_and_sync_flows": 2,
-  "child_sites": 1,
-  "currency": "USD",
-  "dedicated_ip": true,
-  "dedicated_ips": 1,
-  "domain_count": 1,
-  "feature_bundle_eca": true,
-  "feature_bundle_power": true,
-  "feature_bundle_premier": true,
-  "feature_bundle_starter": true,
-  "monthly": "249.0",
-  "monthly_addon": "249.0",
-  "name": "Power",
-  "outbound_connections": 1,
-  "preview_page_limit": 100,
-  "regions_included": 2,
-  "remote_sync_interval": 1,
-  "signup_page_marketing_text": "example",
-  "system_users": 1,
-  "staging_sites": 1,
-  "transformation_and_ai_credit_overage_cost_per_million": "0.1",
-  "transformation_and_ai_credits": 1,
-  "trial_days": 30,
-  "user_cost": "5.0",
-  "usage_cost": "0.1",
-  "usage_included": 1,
-  "users": 1
-}
-```
-
-* `id` (int64): Plan ID
-* `activation_cost` (decimal): Activation cost (upfront)
-* `addon_description` (string): Description of add on charges
-* `annually` (string): Price annually
-* `annually_addon` (string): Addons price annually
-* `automation_and_sync_flow_overage_cost` (string): Cost per additional automation and sync flow
-* `automation_and_sync_flows` (int64): Number of automation and sync flows included. 0 means unlimited.
-* `child_sites` (int64): Number of child sites available
-* `currency` (string): Currency
-* `dedicated_ip` (boolean): Offers dedicated ip?
-* `dedicated_ips` (int64): Number of dedicated IPs
-* `domain_count` (int64): Number of custom domains
-* `feature_bundle_eca` (boolean): Does this plan include the ECA feature bundle?
-* `feature_bundle_power` (boolean): Does this plan include the Power feature bundle?
-* `feature_bundle_premier` (boolean): Does this plan include the Enterprise feature bundle?
-* `feature_bundle_starter` (boolean): Does this plan include the Starter feature bundle?
-* `monthly` (string): Price monthly
-* `monthly_addon` (string): Addons price monthly
-* `name` (string): Plan name
-* `outbound_connections` (int64): Number of outbound connections
-* `preview_page_limit` (int64): Number of previews available
-* `regions_included` (int64): Number of storage regions included
-* `remote_sync_interval` (int64): Number of minutes between remote sync
-* `signup_page_marketing_text` (string): Additional marketing text to show on signup page
-* `system_users` (int64): # of System Users included.  0 means that system users are included in the normal user quota.
-* `staging_sites` (int64): Number of child sites available
-* `transformation_and_ai_credit_overage_cost_per_million` (string): Cost per million additional transformation and AI credits
-* `transformation_and_ai_credits` (int64): Transformation and AI credits included
-* `trial_days` (int64): # of trial days included. Values of 0 or less mean no trial is offered.
-* `user_cost` (string): Cost per additional user
-* `usage_cost` (string): Usage cost per GB of overage
-* `usage_included` (int64): Usage included per month, in GB
-* `users` (int64): # of users included.  0 or -1 mean unlimited.
-
-
----
-
-## List Plans
-
-```
-Files::Plan.list(
-  currency: "USD"
-)
-```
-
-### 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).
-* `currency` (string): Currency.
-
-
----
-
-## Create an export CSV of Plan resources
-
-```
-Files::Plan.create_export(
-  currency: ""
-)
-```
-
-### Parameters
-
-* `currency` (string): Currency.

data/docs/public_hosting_session_pairing.md

@@ -1,15 +0,0 @@
-# PublicHostingSessionPairing
-
-## Example PublicHostingSessionPairing Object
-
-```
-{
-  "pairing_key": "example",
-  "redirect_uri": "example",
-  "expires_at": "2000-01-01T01:00:00Z"
-}
-```
-
-* `pairing_key` (string): One-time pairing key for the Public Hosting session
-* `redirect_uri` (string): Public Hosting URL that exchanges the pairing key for a Public Hosting session cookie
-* `expires_at` (date-time): When the pairing key expires