files.com 1.0.92

data/docs/bundle.md

@@ -0,0 +1,252 @@
+# Bundle
+
+## Example Bundle Object
+
+```
+{
+  "code": "abc123",
+  "url": "https://subdomain.files.com/f/12345678",
+  "description": "The public description of the bundle.",
+  "password_protected": true,
+  "require_registration": true,
+  "clickwrap_body": "[Legal text]",
+  "id": 1,
+  "created_at": "2000-01-01T01:00:00Z",
+  "expires_at": "2000-01-01T01:00:00Z",
+  "max_uses": 1,
+  "note": "The internal note on the bundle.",
+  "user_id": 1,
+  "username": "user",
+  "clickwrap_id": 1,
+  "inbox_id": 1,
+  "paths": [
+
+  ]
+}
+```
+
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `url` (string): Public URL of Share Link
+* `description` (string): Public description
+* `password_protected` (boolean): Is this bundle password protected?
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
+* `id` (int64): Bundle ID
+* `created_at` (date-time): Bundle created at date/time
+* `expires_at` (date-time): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
+* `note` (string): Bundle internal note
+* `user_id` (int64): Bundle creator user ID
+* `username` (string): Bundle creator username
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
+* `paths` (array): A list of paths in this bundle
+* `password` (string): Password for this bundle.
+
+
+---
+
+## List Bundles
+
+```
+Files::Bundle.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.
+* `cursor` (string): Send cursor to resume an existing list from the point at which you left off.  Get a cursor from an existing list via the X-Files-Cursor-Next header.
+* `sort_by` (object): If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `created_at` or `code`.
+* `filter` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_gt` (object): If set, return records where the specifiied field is greater than the supplied value. Valid fields are `created_at`.
+* `filter_gteq` (object): If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specifiied field is equal to the supplied value. Valid fields are `created_at`.
+* `filter_lt` (object): If set, return records where the specifiied field is less than the supplied value. Valid fields are `created_at`.
+* `filter_lteq` (object): If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `created_at`.
+
+
+---
+
+## Show Bundle
+
+```
+Files::Bundle.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+
+
+---
+
+## Create Bundle
+
+```
+Files::Bundle.create(
+  user_id: 1, 
+  paths: ["file.txt"], 
+  password: "Password", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
+  code: "abc123", 
+  require_registration: true, 
+  clickwrap_id: 1, 
+  inbox_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `paths` (array(string)): Required - A list of paths to include in this bundle.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
+
+
+---
+
+## Send email(s) with a link to bundle
+
+```
+Files::Bundle.share(id, 
+  to: ["johndoe@gmail.com"], 
+  note: "Just a note."
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `to` (array(string)): Required - A list of email addresses to share this bundle with.
+* `note` (string): Note to include in email.
+
+
+---
+
+## Update Bundle
+
+```
+Files::Bundle.update(id, 
+  password: "Password", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  max_uses: 1, 
+  description: "The public description of the bundle.", 
+  note: "The internal note on the bundle.", 
+  code: "abc123", 
+  require_registration: true, 
+  clickwrap_id: 1, 
+  inbox_id: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
+
+
+---
+
+## Delete Bundle
+
+```
+Files::Bundle.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+
+
+---
+
+## Send email(s) with a link to bundle
+
+```
+bundle = Files::Bundle.list_for(path).first
+
+bundle.share(
+  to: ["johndoe@gmail.com"],
+  note: "Just a note."
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `to` (array(string)): Required - A list of email addresses to share this bundle with.
+* `note` (string): Note to include in email.
+
+
+---
+
+## Update Bundle
+
+```
+bundle = Files::Bundle.list_for(path).first
+
+bundle.update(
+  password: "Password",
+  expires_at: "2000-01-01T01:00:00Z",
+  max_uses: 1,
+  description: "The public description of the bundle.",
+  note: "The internal note on the bundle.",
+  code: "abc123",
+  require_registration: true,
+  clickwrap_id: 1,
+  inbox_id: 1
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `password` (string): Password for this bundle.
+* `expires_at` (string): Bundle expiration date/time
+* `max_uses` (int64): Maximum number of times bundle can be accessed
+* `description` (string): Public description
+* `note` (string): Bundle internal note
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `inbox_id` (int64): ID of the associated inbox, if available.
+
+
+---
+
+## Delete Bundle
+
+```
+bundle = Files::Bundle.list_for(path).first
+
+bundle.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.

data/docs/bundle_download.md

@@ -0,0 +1,35 @@
+# BundleDownload
+
+## Example BundleDownload Object
+
+```
+{
+  "download_method": "file",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `download_method` (string): Download method (file or full_zip)
+* `path` (string): Download path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
+* `created_at` (date-time): Download date/time
+
+
+---
+
+## List Bundle Downloads
+
+```
+Files::BundleDownload.list(
+  page: 1, 
+  per_page: 1, 
+  bundle_registration_id: 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.
+* `bundle_registration_id` (int64): Required - BundleRegistration ID

data/docs/clickwrap.md

@@ -0,0 +1,143 @@
+# Clickwrap
+
+## Example Clickwrap Object
+
+```
+{
+  "name": "Example Site NDA for Files.com Use",
+  "body": "[Legal body text]",
+  "use_with_users": "",
+  "use_with_bundles": "",
+  "use_with_inboxes": ""
+}
+```
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `id` (int64): Clickwrap ID.
+
+
+---
+
+## List Clickwraps
+
+```
+Files::Clickwrap.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 Clickwrap
+
+```
+Files::Clickwrap.find(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Create Clickwrap
+
+```
+Files::Clickwrap.create(
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Update Clickwrap
+
+```
+Files::Clickwrap.update(id, 
+  name: "Example Site NDA for Files.com Use", 
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+Files::Clickwrap.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+
+---
+
+## Update Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.update(
+  name: "Example Site NDA for Files.com Use",
+  body: "[Legal body text]"
+)
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+* `name` (string): Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
+* `body` (string): Body text of Clickwrap (supports Markdown formatting).
+* `use_with_bundles` (string): Use this Clickwrap for Bundles?
+* `use_with_inboxes` (string): Use this Clickwrap for Inboxes?
+* `use_with_users` (string): Use this Clickwrap for User Registrations?  Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.
+
+
+---
+
+## Delete Clickwrap
+
+```
+clickwrap = Files::Clickwrap.list_for(path).first
+
+clickwrap.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.

data/docs/dns_record.md

@@ -0,0 +1,35 @@
+# DnsRecord
+
+## Example DnsRecord Object
+
+```
+{
+  "id": "customdomain.com-CNAME-site.files.com",
+  "domain": "my-custom-domain.com",
+  "rrtype": "CNAME",
+  "value": "mysite.files.com"
+}
+```
+
+* `id` (string): Unique label for DNS record; used by Zapier and other integrations.
+* `domain` (string): DNS record domain name
+* `rrtype` (string): DNS record type
+* `value` (string): DNS record value
+
+
+---
+
+## Show site DNS configuration
+
+```
+Files::DnsRecord.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.