files.com 1.1.671 → 1.1.672

data/docs/account.md

@@ -1,155 +0,0 @@
-# Account
-
-## Example Account Object
-
-```
-{
-  "name": "account",
-  "address": "123 Main St",
-  "address_2": "Window 1",
-  "card_number": "xxxxxxxxxxxx1234",
-  "card_type": "Visa",
-  "city": "New York",
-  "company_name": "Action Verb",
-  "country": "US",
-  "created_at": "2000-01-01T01:00:00Z",
-  "currency": "USD",
-  "email": "john.doe@files.com",
-  "phone_number": "555-555-5555",
-  "processor_type": "Credit Card",
-  "state": "NY",
-  "zip": "00000",
-  "billing_frequency": 1
-}
-```
-
-* `name` (string): Account name
-* `address` (string): Account address
-* `address_2` (string): Account address 2
-* `card_number` (string): Account payment card number
-* `card_type` (string): Account payment card type
-* `city` (string): Account city
-* `company_name` (string): Account company name
-* `country` (string): Account country
-* `created_at` (date-time): Account creation date/time
-* `currency` (string): Account preferred currency
-* `email` (email): Account email address
-* `phone_number` (string): Account phone number
-* `processor_type` (string): Type of billing processor.  Can be PayPal, Credit Card, or Manual
-* `state` (string): Account state
-* `zip` (string): Account zipcode
-* `billing_frequency` (int64): Number of usage periods billed at once.  This value will either be 12 representing an annual account of 12 usage periods or 1 representing a monthly account.
-* `expiration_year` (string): Expiration year(4 digits).
-* `expiration_month` (string): Expiration month(2 digits).
-* `start_year` (string): Required for some cards(Switch / Solo).
-* `start_month` (string): Required for some cards(Switch / Solo).
-* `cvv` (string): 3 digit code on the back of the card.
-* `paypal_token` (string): Token for paying with paypal.
-* `paypal_payer_id` (string): Paypal payer ID for paying with paypal.
-* `plan_id` (int64): Plan ID to switch to immediately.
-* `create_account` (boolean): Create account without immediately charging the customer.  (i.e. let the trial complete first.)
-
-
----
-
-## Show current (billing) account information
-
-```
-Files::Account.get
-```
-
-
----
-
-## Upgrade current site to paid
-
-```
-Files::Account.create(
-  name: "account", 
-  company_name: "Action Verb", 
-  address: "123 Main St", 
-  address_2: "Window 1", 
-  city: "New York", 
-  state: "NY", 
-  zip: "00000", 
-  country: "US", 
-  email: "john.doe@files.com", 
-  phone_number: "555-555-5555", 
-  card_number: "xxxxxxxxxxxx1234", 
-  card_type: "Visa", 
-  plan_id: 1, 
-  billing_frequency: 1, 
-  currency: "USD", 
-  create_account: false
-)
-```
-
-### Parameters
-
-* `name` (string): Internal name.
-* `company_name` (string): Company name.
-* `address` (string): Address line 1.
-* `address_2` (string): Address line 2.
-* `city` (string): City.
-* `state` (string): State.
-* `zip` (string): Zipcode.
-* `country` (string): Country.
-* `email` (string): Email.
-* `phone_number` (string): Primary phone number.
-* `card_number` (string): Credit card number.
-* `card_type` (string): Credit card type.  Can be visa, master, maestro, solo, switch, american_express, or discover.
-* `expiration_year` (string): Expiration year(4 digits).
-* `expiration_month` (string): Expiration month(2 digits).
-* `start_year` (string): Required for some cards(Switch / Solo).
-* `start_month` (string): Required for some cards(Switch / Solo).
-* `cvv` (string): 3 digit code on the back of the card.
-* `paypal_token` (string): Token for paying with paypal.
-* `paypal_payer_id` (string): Paypal payer ID for paying with paypal.
-* `plan_id` (int64): Plan ID to switch to immediately.
-* `billing_frequency` (int64): The billing frequency, in months, for the site.  Must be 1 (monthly) or 12 (annual).
-* `currency` (string): Preferred currency for this account.
-* `create_account` (boolean): Create account without immediately charging the customer.  (i.e. let the trial complete first.)
-
-
----
-
-## Update account (billing) information
-
-```
-Files::Account.update(
-  name: "account", 
-  company_name: "Action Verb", 
-  address: "123 Main St", 
-  address_2: "Window 1", 
-  city: "New York", 
-  state: "NY", 
-  zip: "00000", 
-  country: "US", 
-  email: "john.doe@files.com", 
-  phone_number: "555-555-5555", 
-  card_number: "xxxxxxxxxxxx1234", 
-  card_type: "Visa"
-)
-```
-
-### Parameters
-
-* `name` (string): Internal name.
-* `company_name` (string): Company name.
-* `address` (string): Address line 1.
-* `address_2` (string): Address line 2.
-* `city` (string): City.
-* `state` (string): State.
-* `zip` (string): Zipcode.
-* `country` (string): Country.
-* `email` (string): Email.
-* `phone_number` (string): Primary phone number.
-* `card_number` (string): Credit card number.
-* `card_type` (string): Credit card type.  Can be visa, master, maestro, solo, switch, american_express, or discover.
-* `expiration_year` (string): Expiration year(4 digits).
-* `expiration_month` (string): Expiration month(2 digits).
-* `start_year` (string): Required for some cards(Switch / Solo).
-* `start_month` (string): Required for some cards(Switch / Solo).
-* `cvv` (string): 3 digit code on the back of the card.
-* `paypal_token` (string): Token for paying with paypal.
-* `paypal_payer_id` (string): Paypal payer ID for paying with paypal.

data/docs/action_webhook_failure.md

@@ -1,28 +0,0 @@
-
-
----
-
-## Retry Action Webhook Failure
-
-```
-Files::ActionWebhookFailure.retry(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Action Webhook Failure ID.
-
-
----
-
-## Retry Action Webhook Failure
-
-```
-action_webhook_failure = Files::ActionWebhookFailure.new
-
-action_webhook_failure.retry
-```
-
-### Parameters
-
-* `id` (int64): Required - Action Webhook Failure ID.

data/docs/agent_proxy_identity.md

@@ -1,49 +0,0 @@
-# AgentProxyIdentity
-
-## Example AgentProxyIdentity Object
-
-```
-{
-  "peer_id": "example",
-  "endpoints": [
-    {
-      "multiaddr": "example"
-    }
-  ]
-}
-```
-
-* `peer_id` (string): Libp2p peer ID for this identity candidate.
-* `endpoints` (array(object)): Protocol-specific endpoints for this peer ID.
-
-
----
-
-## Resolve Files Agent Proxy identities by public IPv4 address
-
-```
-Files::AgentProxyIdentity.lookup(
-  ips: "ips"
-)
-```
-
-### Parameters
-
-* `ips` (array(string)): Required - One or more public IPv4 addresses to resolve
-
-
----
-
-## Report the currently active agent proxy peer ID for a proxy private IP
-
-```
-Files::AgentProxyIdentity.report(
-  private_ip: "private_ip", 
-  peer_id: "peer_id"
-)
-```
-
-### Parameters
-
-* `private_ip` (string): Required - Proxy private IPv4 address
-* `peer_id` (string): Required - Libp2p peer ID currently served by the proxy

data/docs/agent_proxy_identity_endpoint.md

@@ -1,11 +0,0 @@
-# AgentProxyIdentityEndpoint
-
-## Example AgentProxyIdentityEndpoint Object
-
-```
-{
-  "multiaddr": "example"
-}
-```
-
-* `multiaddr` (string): Canonical libp2p multiaddr for this proxy identity endpoint.

data/docs/agent_proxy_identity_result.md

@@ -1,24 +0,0 @@
-# AgentProxyIdentityResult
-
-## Example AgentProxyIdentityResult Object
-
-```
-{
-  "ip": "example",
-  "status": "example",
-  "identities": [
-    {
-      "peer_id": "example",
-      "endpoints": [
-        {
-          "multiaddr": "example"
-        }
-      ]
-    }
-  ]
-}
-```
-
-* `ip` (string): Requested public IPv4 address.
-* `status` (string): Lookup status for the requested IP.
-* `identities` (array(object)): Ordered identity candidates for this IP during rotation.

data/docs/agent_v2_auth.md

@@ -1,17 +0,0 @@
-# AgentV2Auth
-
-## Example AgentV2Auth Object
-
-```
-{
-  "id": 1,
-  "nonce": "example",
-  "status": "example",
-  "site_id": 1
-}
-```
-
-* `id` (int64): Agent ID
-* `nonce` (string): authentication nonce
-* `status` (string): in_setup: waiting for signed_nonce, complete: authorization approved
-* `site_id` (int64): Agent's site ID

data/docs/announcement.md

@@ -1,57 +0,0 @@
-# Announcement
-
-## Example Announcement Object
-
-```
-{
-  "id": 1,
-  "headline": "Files.com Now Supports In-App Announcements!",
-  "body": "This is the body.",
-  "button_text": "View Blog Post",
-  "button_url": "https://www.files.com/blog/",
-  "html_body": "<p>This is the HTML version of the body.</p>",
-  "label": "New Feature",
-  "label_color": "#000000",
-  "publish_at": "2000-01-01T01:00:00Z",
-  "slug": "new-feature"
-}
-```
-
-* `id` (int64): Announcement Id
-* `headline` (string): Announcement headline
-* `body` (string): Announcement body
-* `button_text` (string): Text to go on the CTA button
-* `button_url` (string): URL to link to when CTA button is clicked
-* `html_body` (string): Body converted to HTML
-* `label` (string): Text for a label that can be added to the announcement
-* `label_color` (string): Color for label on announcement
-* `publish_at` (date-time): When was this announcement published?
-* `slug` (string): URL slug for announcement
-
-
----
-
-## List in-app announcements that are shown in the header of the UI
-
-```
-Files::Announcement.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).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .
-
-
----
-
-## List in-app announcements that are shown in the header of the UI
-
-```
-Files::Announcement.create_export
-```
-
-### Parameters
-
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are .

data/docs/blog_post.md

@@ -1,57 +0,0 @@
-# BlogPost
-
-## Example BlogPost Object
-
-```
-{
-  "id": 1,
-  "title": "example",
-  "content": "example",
-  "link": "2000-01-01T01:00:00Z",
-  "published_at": "2000-01-01T01:00:00Z"
-}
-```
-
-* `id` (int64): Blog Post ID
-* `title` (string): Blog Post's Title
-* `content` (string): Blog Post's Content
-* `link` (date-time): Blog Post's Permanent Link
-* `published_at` (date-time): Blog Post's Published Date
-
-
----
-
-## Show the most recent blog posts from the Files.com blog
-
-```
-Files::BlogPost.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).
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `published_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `published_at`.
-* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `published_at`.
-* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `published_at`.
-* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `published_at`.
-* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `published_at`.
-
-
----
-
-## Show the most recent blog posts from the Files.com blog
-
-```
-Files::BlogPost.create_export
-```
-
-### Parameters
-
-* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `published_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `published_at`.
-* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `published_at`.
-* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `published_at`.
-* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `published_at`.
-* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `published_at`.

data/docs/bundle_recipient_registration.md

@@ -1,39 +0,0 @@
-# BundleRecipientRegistration
-
-## Example BundleRecipientRegistration Object
-
-```
-{
-  "code": "example",
-  "bundle_registration_code": "example",
-  "recipient": "example",
-  "name": "example",
-  "company": "example",
-  "password_emailed": true,
-  "inbox_code": "abc123"
-}
-```
-
-* `code` (string): The bundle recipient registration code. Use this to register for the bundle.
-* `bundle_registration_code` (string): If the recipient has already registered for this bundle, this is their registration code to get the bundle contents.
-* `recipient` (string): The recipient's email address.
-* `name` (string): The recipient's name.
-* `company` (string): The recipient's company.
-* `password_emailed` (boolean): Whether a one-time password was emailed to the recipient.
-* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
-* `bundle_recipient_code` (string): Bundle recipient code
-
-
----
-
-## Create Bundle Recipient Registration
-
-```
-Files::BundleRecipientRegistration.create(
-  bundle_recipient_code: "bundle_recipient_code"
-)
-```
-
-### Parameters
-
-* `bundle_recipient_code` (string): Required - Bundle recipient code

data/docs/certificate.md

@@ -1,258 +0,0 @@
-# Certificate
-
-## Example Certificate Object
-
-```
-{
-  "id": 1,
-  "name": "My Certificate",
-  "certificate": "[certificate]",
-  "created_at": "2000-01-01T01:00:00Z",
-  "display_status": "Available",
-  "domains": [
-
-  ],
-  "expires_at": "2000-01-01T01:00:00Z",
-  "brick_managed": true,
-  "intermediates": "[certificates]",
-  "ip_addresses": [
-
-  ],
-  "issuer": "example",
-  "key_type": "RSA-4096",
-  "request": "[CSR]",
-  "status": "Available",
-  "subject": "my-custom-domain.com"
-}
-```
-
-* `id` (int64): Certificate ID
-* `name` (string): Descriptive name of certificate
-* `certificate` (string): Full text of SSL certificate
-* `created_at` (date-time): Certificate created at
-* `display_status` (string): Certificate status. (One of `Request Generated`, `New`, `Active`, `Active/Expired`, `Expired`, or `Available`)
-* `domains` (array(string)): Domains on this certificate other than files.com domains
-* `expires_at` (date-time): Certificate expiration date/time
-* `brick_managed` (boolean): Is this certificate automatically managed and renewed by Files.com?
-* `intermediates` (string): Intermediate certificates
-* `ip_addresses` (array(string)): A list of IP addresses associated with this SSL Certificate
-* `issuer` (string): X509 issuer
-* `key_type` (string): Type of key
-* `request` (string): Certificate signing request text
-* `status` (string): Certificate status (Request Generated, New, Active, Active/Expired, Expired, or Available)
-* `subject` (string): X509 Subject name
-* `certificate_domain` (string): Domain for certificate.
-* `certificate_extra_domains` (array(string)): Additional domains for the certificate CSR.
-* `certificate_country` (string): Country.
-* `certificate_state_or_province` (string): State or province.
-* `certificate_city_or_locale` (string): City or locale.
-* `certificate_company_name` (string): Company name.
-* `csr_ou1` (string): Department name or organization unit 1
-* `csr_ou2` (string): Department name or organization unit 2
-* `csr_ou3` (string): Department name or organization unit 3
-* `certificate_email_address` (string): Email address for the certificate owner.
-* `private_key` (string): Certificate private key.
-* `password` (string): Certificate password.
-
-
----
-
-## List Certificates
-
-```
-Files::Certificate.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).
-
-
----
-
-## Show Certificate
-
-```
-Files::Certificate.find(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-
-
----
-
-## Create CSR or import existing SSL Certificate
-
-```
-Files::Certificate.create(
-  name: "Name", 
-  certificate_domain: "domain.com", 
-  certificate_extra_domains: ["www.domain.com"], 
-  key_type: "RSA-4096", 
-  certificate: "[certificate]", 
-  intermediates: "[certificates]"
-)
-```
-
-### Parameters
-
-* `name` (string): Required - Internal name of the SSL certificate.
-* `certificate_domain` (string): Domain for certificate.
-* `certificate_extra_domains` (array(string)): Additional domains for the certificate CSR.
-* `certificate_country` (string): Country.
-* `certificate_state_or_province` (string): State or province.
-* `certificate_city_or_locale` (string): City or locale.
-* `certificate_company_name` (string): Company name.
-* `csr_ou1` (string): Department name or organization unit 1
-* `csr_ou2` (string): Department name or organization unit 2
-* `csr_ou3` (string): Department name or organization unit 3
-* `certificate_email_address` (string): Email address for the certificate owner.
-* `key_type` (string): Any supported key type.  Defaults to `RSA-4096`.
-* `certificate` (string): The certificate.  PEM or PKCS7 formats accepted.
-* `private_key` (string): Certificate private key.
-* `password` (string): Certificate password.
-* `intermediates` (string): Intermediate certificates.  PEM or PKCS7 formats accepted.
-
-
----
-
-## Deactivate SSL Certificate
-
-```
-Files::Certificate.deactivate(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-
-
----
-
-## Activate SSL Certificate
-
-```
-Files::Certificate.activate(id, 
-  replace_cert: ""
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-* `replace_cert` (string): Leave blank or set to `any` to replace any currently active certificate, if applicable.  Set to `new_ips` to activate this certificate as an additional certificate on your Site by allocating a new set of Dedicated IPs (may require a Plan upgrade).  Set to the ID of a currently active certificate to replace that certificate on its set of dedicated IPs.
-
-
----
-
-## Create an export CSV of Certificate resources
-
-```
-Files::Certificate.create_export
-```
-
-
----
-
-## Update Certificate
-
-```
-Files::Certificate.update(id, 
-  name: "My Certificate", 
-  intermediates: "[certificates]", 
-  certificate: "[certificate]"
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-* `name` (string): Internal certificate name.
-* `intermediates` (string): Any intermediate certificates.  PEM or PKCS7 formats accepted.
-* `certificate` (string): The certificate.  PEM or PKCS7 formats accepted.
-
-
----
-
-## Delete Certificate
-
-```
-Files::Certificate.delete(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-
-
----
-
-## Deactivate SSL Certificate
-
-```
-certificate = Files::Certificate.find(id)
-
-certificate.deactivate
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-
-
----
-
-## Activate SSL Certificate
-
-```
-certificate = Files::Certificate.find(id)
-
-certificate.activate(
-  replace_cert: ""
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-* `replace_cert` (string): Leave blank or set to `any` to replace any currently active certificate, if applicable.  Set to `new_ips` to activate this certificate as an additional certificate on your Site by allocating a new set of Dedicated IPs (may require a Plan upgrade).  Set to the ID of a currently active certificate to replace that certificate on its set of dedicated IPs.
-
-
----
-
-## Update Certificate
-
-```
-certificate = Files::Certificate.find(id)
-
-certificate.update(
-  name: "My Certificate",
-  intermediates: "[certificates]",
-  certificate: "[certificate]"
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.
-* `name` (string): Internal certificate name.
-* `intermediates` (string): Any intermediate certificates.  PEM or PKCS7 formats accepted.
-* `certificate` (string): The certificate.  PEM or PKCS7 formats accepted.
-
-
----
-
-## Delete Certificate
-
-```
-certificate = Files::Certificate.find(id)
-
-certificate.delete
-```
-
-### Parameters
-
-* `id` (int64): Required - Certificate ID.