files.com 1.1.671 → 1.1.672

data/docs/public_inbox.md

@@ -1,121 +0,0 @@
-# PublicInbox
-
-## Example PublicInbox Object
-
-```
-{
-  "color_left": "#0066a7",
-  "color_link": "#d34f5d",
-  "color_text": "#0066a7",
-  "color_top": "#000000",
-  "color_top_text": "#ffffff",
-  "title": "example",
-  "description": "My inbox",
-  "help_text": "If you need any help submitting your application, please call our front desk.",
-  "key": "application-form",
-  "show_on_login_page": true,
-  "has_password": true,
-  "require_registration": true,
-  "dont_allow_folders_in_uploads": true,
-  "clickwrap_body": "[Legal text]",
-  "form_field_set": {
-    "id": 1,
-    "title": "Sample Form Title",
-    "form_layout": [
-      1,
-      2,
-      3,
-      4
-    ],
-    "form_fields": [
-      {
-        "id": 1,
-        "label": "Sample Label",
-        "required": true,
-        "help_text": "Help Text",
-        "field_type": "text",
-        "options_for_select": [
-          "red",
-          "green",
-          "blue"
-        ],
-        "default_option": "red",
-        "form_field_set_id": 1
-      }
-    ],
-    "skip_name": true,
-    "skip_email": true,
-    "skip_company": true,
-    "in_use": true
-  },
-  "require_logout": true,
-  "logo": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
-  "logo_click_href": "https://www.example.com",
-  "thumbnail": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  }
-}
-```
-
-* `color_left` (string): Page link and button color
-* `color_link` (string): Top bar link color
-* `color_text` (string): Page link and button color
-* `color_top` (string): Top bar background color
-* `color_top_text` (string): Top bar text color
-* `title` (string): Inbox title
-* `description` (string): User description
-* `help_text` (string): Text that will be shown to the users on the Inbox.  Use this field to provide custom instructions.
-* `key` (string): Unique key for inbox
-* `show_on_login_page` (boolean): Show this inbox on site login page?
-* `has_password` (boolean): Is this inbox password protected?
-* `require_registration` (boolean): Does this inbox require registration?
-* `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
-* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Inbox.
-* `form_field_set` (FormFieldSet): Custom Form to use
-* `require_logout` (boolean): If true, we will hide the 'Remember Me' box on the Inbox registration page, requiring that the user logout and log back in every time they visit the page.
-* `logo` (Image): Custom logo for Inbox folder
-* `logo_click_href` (string): URL to open when a public visitor clicks the custom logo
-* `thumbnail` (Image): Custom logo thumbnail for Inbox folder
-
-
----
-
-## List Public Inboxes
-
-```
-Files::PublicInbox.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 Public Inbox
-
-```
-Files::PublicInbox.get_key(key, 
-  recipient_code: "abc123"
-)
-```
-
-### Parameters
-
-* `key` (string): Required - Unique key for inbox
-* `recipient_code` (string): Inbox recipient code
-
-
----
-
-## Create an export CSV of Public Inbox resources
-
-```
-Files::PublicInbox.create_export
-```

data/docs/public_url.md

@@ -1,59 +0,0 @@
-# PublicUrl
-
-## Example PublicUrl Object
-
-```
-{
-  "http-code": 1,
-  "type": "not-found/file-not-found",
-  "http_headers": "example",
-  "body": "example",
-  "download_uri": "example",
-  "internal_download_uri": "example",
-  "redirect": "example",
-  "mime_type": "example",
-  "site_id": 1,
-  "remote_server_id": 1,
-  "headers": {
-    "key": "example value"
-  },
-  "socks_ips": [
-    "example"
-  ],
-  "true_path": "example",
-  "cache_for_seconds": 1
-}
-```
-
-* `http-code` (int64): Response HTTP code
-* `type` (string): A short string representing which error happened, if any
-* `http_headers` (object): Headers to include with the response
-* `body` (string): Body of the response, if a folder listing was requested
-* `download_uri` (string): Signed URL allowing access to the requested file
-* `internal_download_uri` (string): For use with internal services and should also be with headers and socks_ips
-* `redirect` (string): URL where this request should be redirected, if necessary
-* `mime_type` (string): Used for response content-type
-* `site_id` (int64): Site id
-* `remote_server_id` (int64): Used for internal bandwidth tracking
-* `headers` (object): Used for internal url management
-* `socks_ips` (array(string)): Used for internal url management
-* `true_path` (string): The actual path of the file or folder being accessed. Used for caching.
-* `cache_for_seconds` (int64): Indicates how long the response should be cached, in seconds.
-* `hostname` (string): Hostname used to request the publicly shared resource.
-* `path` (string): Path of the resource being requested.
-
-
----
-
-## Fetch a public download URL for a publicly hosted resource
-
-```
-Files::PublicUrl.create(path, 
-  hostname: "hostname"
-)
-```
-
-### Parameters
-
-* `hostname` (string): Required - Hostname used to request the publicly shared resource.
-* `path` (string): Required - Path of the resource being requested.

data/docs/release.md

@@ -1,83 +0,0 @@
-# Release
-
-## Example Release Object
-
-```
-{
-  "version": "1.0.0",
-  "description": "The initial release of Files.com Desktop",
-  "native_release_packages": [
-    {
-      "package_link": "https://www.files.com/desktop/download",
-      "platform": "win32",
-      "architecture": "amd64",
-      "extension": "deb",
-      "sha256": "example"
-    }
-  ],
-  "title": "Files.com",
-  "product": "desktop_v4"
-}
-```
-
-* `version` (string): Native release version
-* `description` (string): Native release description
-* `native_release_packages` (array(object)): A list of native release packages
-* `title` (string): Native release title
-* `product` (string): Native release product
-* `version_major` (int64): 
-* `version_minor` (int64): 
-* `version_patch` (int64): 
-* `version_build` (int64): 
-* `oem` (string): 
-
-
----
-
-## Show information about the latest Desktop app release
-
-```
-Files::Release.get_latest(
-  product: "desktop_v6", 
-  platform: "win32", 
-  architecture: "amd64", 
-  ext: "exe"
-)
-```
-
-### Parameters
-
-* `product` (string): 
-* `platform` (string): 
-* `architecture` (string): 
-* `ext` (string): 
-
-
----
-
-## Create an application release
-
-```
-Files::Release.create(
-  title: "Files.com", 
-  description: "The initial release of Files.com Desktop", 
-  version_major: 1, 
-  version_minor: 1, 
-  version_patch: 1, 
-  version_build: 1, 
-  product: "desktop_v4", 
-  native_release_packages: [{"package_link":"https://www.files.com/desktop/download","platform":"win32","architecture":"amd64","extension":"deb","sha256":"example"}]
-)
-```
-
-### Parameters
-
-* `title` (string): 
-* `description` (string): 
-* `version_major` (int64): 
-* `version_minor` (int64): 
-* `version_patch` (int64): 
-* `version_build` (int64): 
-* `oem` (string): 
-* `product` (string): 
-* `native_release_packages` (array(object)): 

data/docs/release_package.md

@@ -1,19 +0,0 @@
-# ReleasePackage
-
-## Example ReleasePackage Object
-
-```
-{
-  "package_link": "https://www.files.com/desktop/download",
-  "platform": "win32",
-  "architecture": "amd64",
-  "extension": "deb",
-  "sha256": "example"
-}
-```
-
-* `package_link` (string): Link to the package
-* `platform` (string): Release platform
-* `architecture` (string): Release architecture
-* `extension` (string): Package file extension
-* `sha256` (string): SHA256 hash of the package

data/docs/revision.md

@@ -1,40 +0,0 @@
-# Revision
-
-## Example Revision Object
-
-```
-{
-  "current": "a1b2c3d4",
-  "prior": "f9e8d7c6",
-  "revision": "a1b2c3d4",
-  "up_to_date": true
-}
-```
-
-* `current` (string): The commit hash of the latest deployed revision.
-* `prior` (string): The commit hash of the previously deployed revision.
-* `revision` (string): The commit hash of the currently running revision.
-* `up_to_date` (boolean): True if the currently running revision is the latest deployed revision.
-
-
----
-
-## List Revisions
-
-```
-Files::Revision.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 Revision resources
-
-```
-Files::Revision.create_export
-```

data/docs/session_available_site.md

@@ -1,26 +0,0 @@
-# SessionAvailableSite
-
-## Example SessionAvailableSite Object
-
-```
-{
-  "id": 1,
-  "name": "My Site",
-  "domain": "my-custom-domain.com",
-  "subdomain": "mysite",
-  "logo": {
-    "name": "My logo",
-    "uri": "https://mysite.files.com/.../my_image.png"
-  },
-  "color2_top": "#000000",
-  "folder_permissions_groups_only": true
-}
-```
-
-* `id` (int64): Site Id
-* `name` (string): Site name
-* `domain` (string): Custom domain
-* `subdomain` (string): Site subdomain
-* `logo` (Image): Branded logo
-* `color2_top` (string): Top bar background color
-* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user).

data/docs/setting.md

@@ -1,33 +0,0 @@
-
-
----
-
-## List supported languages
-
-```
-Files::Setting.languages
-```
-
-
----
-
-## Show the site settings, which is a dump of a lot of information that pertains to the current site
-
-```
-Files::Setting.list
-```
-
-
----
-
-## Show the site settings for a specific domain
-
-```
-Files::Setting.get_domain(
-  domain: "actionverb"
-)
-```
-
-### Parameters
-
-* `domain` (string): Required -