files.com 1.0.190 → 1.0.193

package/docs/models/Bundle.md

@@ -0,0 +1,330 @@
+# Bundle
+
+## Example Bundle Object
+
+```
+{
+  "code": "abc123",
+  "url": "https://subdomain.files.com/f/12345678",
+  "description": "The public description of the bundle.",
+  "password_protected": true,
+  "preview_only": true,
+  "require_registration": true,
+  "require_share_recipient": 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
+  },
+  "skip_name": true,
+  "skip_email": true,
+  "skip_company": true,
+  "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,
+  "watermark_attachment": {
+    "name": "My logo",
+    "uri": "https://mysite.files.com/.../my_image.png"
+  },
+  "watermark_value": "",
+  "has_inbox": true,
+  "paths": [
+    "file.txt"
+  ]
+}
+```
+
+* `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?
+* `preview_only` (boolean): Restrict users to previewing files only?
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `clickwrap_body` (string): Legal text that must be agreed to prior to accessing Bundle.
+* `form_field_set` (FormFieldSet): Custom Form to use
+* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
+* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
+* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
+* `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.
+* `watermark_attachment` (Image): Preview watermark image applied to all bundle items.
+* `watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
+* `has_inbox` (boolean): Does this bundle have an associated inbox?
+* `paths` (array): A list of paths in this bundle
+* `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
+* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
+
+---
+
+## List Bundles
+
+```
+await Bundle.list({
+  'user_id': 1,
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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 `created_at` and `code`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `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 to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to 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 to the supplied value. Valid fields are `created_at`.
+
+---
+
+## Show Bundle
+
+```
+await Bundle.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+
+---
+
+## Create Bundle
+
+```
+await Bundle.create({
+  'user_id': 1,
+  'paths': ["file.txt"],
+  'password': "Password",
+  'form_field_set_id': 1,
+  '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",
+  'preview_only': true,
+  'require_registration': true,
+  'clickwrap_id': 1,
+  'inbox_id': 1,
+  'require_share_recipient': true,
+  'skip_email': true,
+  'skip_name': true,
+  'skip_company': true,
+})
+```
+
+
+### 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.
+* `form_field_set_id` (int64): Id of Form Field Set to use with 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.
+* `preview_only` (boolean): Restrict users to previewing files only?
+* `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.
+* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
+* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
+* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
+
+---
+
+## Send email(s) with a link to bundle
+
+```
+const [bundle] = await Bundle.list()
+
+await bundle.share({
+  'to': ["johndoe@gmail.com"],
+  'note': "Just a note.",
+  'recipients': [{"name":"John Doe","company":"Acme Ltd","recipient":"johndoe@gmail.com"}],
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `to` (array(string)): A list of email addresses to share this bundle with. Required unless `recipients` is used.
+* `note` (string): Note to include in email.
+* `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
+
+
+---
+
+## Update Bundle
+
+```
+const [bundle] = await Bundle.list()
+
+await bundle.update({
+  'paths': ["file.txt"],
+  'password': "Password",
+  'form_field_set_id': 1,
+  'clickwrap_id': 1,
+  'code': "abc123",
+  'description': "The public description of the bundle.",
+  'expires_at': "2000-01-01T01:00:00Z",
+  'inbox_id': 1,
+  'max_uses': 1,
+  'note': "The internal note on the bundle.",
+  'preview_only': true,
+  'require_registration': true,
+  'require_share_recipient': true,
+  'skip_email': true,
+  'skip_name': true,
+  'skip_company': true,
+  'watermark_attachment_delete': true,
+})
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+* `paths` (array(string)): A list of paths to include in this bundle.
+* `password` (string): Password for this bundle.
+* `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
+* `clickwrap_id` (int64): ID of the clickwrap to use with this bundle.
+* `code` (string): Bundle code.  This code forms the end part of the Public URL.
+* `description` (string): Public description
+* `expires_at` (string): Bundle expiration date/time
+* `inbox_id` (int64): ID of the associated inbox, if available.
+* `max_uses` (int64): Maximum number of times bundle can be accessed
+* `note` (string): Bundle internal note
+* `preview_only` (boolean): Restrict users to previewing files only?
+* `require_registration` (boolean): Show a registration page that captures the downloader's name and email address?
+* `require_share_recipient` (boolean): Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
+* `skip_email` (boolean): BundleRegistrations can be saved without providing email?
+* `skip_name` (boolean): BundleRegistrations can be saved without providing name?
+* `skip_company` (boolean): BundleRegistrations can be saved without providing company?
+* `watermark_attachment_delete` (boolean): If true, will delete the file stored in watermark_attachment
+* `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
+
+### Example Response
+
+```json
+{
+  "code": "abc123",
+  "url": "https://subdomain.files.com/f/12345678",
+  "description": "The public description of the bundle.",
+  "password_protected": true,
+  "preview_only": true,
+  "require_registration": true,
+  "require_share_recipient": 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
+  },
+  "skip_name": true,
+  "skip_email": true,
+  "skip_company": true,
+  "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,
+  "watermark_attachment": {
+    "name": "My logo",
+    "uri": "https://mysite.files.com/.../my_image.png"
+  },
+  "watermark_value": "",
+  "has_inbox": true,
+  "paths": [
+    "file.txt"
+  ]
+}
+```
+
+---
+
+## Delete Bundle
+
+```
+const [bundle] = await Bundle.list()
+
+await bundle.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Bundle ID.
+

package/docs/models/BundleDownload.md

@@ -0,0 +1,44 @@
+# BundleDownload
+
+## Example BundleDownload Object
+
+```
+{
+  "bundle_registration": "",
+  "download_method": "file",
+  "path": "a/b/test.txt",
+  "created_at": "2020-01-01 00:00:00"
+}
+```
+
+* `bundle_registration` (BundleRegistration): 
+* `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
+
+```
+await BundleDownload.list({
+  'per_page': 1,
+  'bundle_id': 1,
+  'bundle_registration_id': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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 `created_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `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 to the supplied value. Valid fields are `created_at`.
+* `filter_like` (object): If set, return records where the specified field is equal to 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 to the supplied value. Valid fields are `created_at`.
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): BundleRegistration ID

package/docs/models/BundleRecipient.md

@@ -0,0 +1,76 @@
+# BundleRecipient
+
+## Example BundleRecipient Object
+
+```
+{
+  "company": "Acme Inc.",
+  "name": "John Doe",
+  "note": "Some note.",
+  "recipient": "john.doe@example.com",
+  "sent_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `company` (string): The recipient's company.
+* `name` (string): The recipient's name.
+* `note` (string): A note sent to the recipient with the bundle.
+* `recipient` (string): The recipient's email address.
+* `sent_at` (date-time): When the Bundle was shared with this recipient.
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `bundle_id` (int64): Bundle to share.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
+
+---
+
+## List Bundle Recipients
+
+```
+await BundleRecipient.list({
+  'user_id': 1,
+  'per_page': 1,
+  'bundle_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `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 `has_registrations`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `has_registrations`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_like` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `has_registrations`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal to the supplied value. Valid fields are `has_registrations`.
+* `bundle_id` (int64): Required - List recipients for the bundle with this ID.
+
+---
+
+## Create Bundle Recipient
+
+```
+await BundleRecipient.create({
+  'user_id': 1,
+  'bundle_id': 1,
+  'recipient': "johndoe@gmail.com",
+  'name': "John Smith",
+  'company': "Acme Ltd",
+  'note': "Just a note.",
+  'share_after_create': true,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `bundle_id` (int64): Required - Bundle to share.
+* `recipient` (string): Required - Email addresses to share this bundle with.
+* `name` (string): Name of recipient.
+* `company` (string): Company of recipient.
+* `note` (string): Note to include in email.
+* `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.

package/docs/models/BundleRegistration.md

@@ -0,0 +1,53 @@
+# BundleRegistration
+
+## Example BundleRegistration Object
+
+```
+{
+  "code": "abc123",
+  "name": "account",
+  "company": "Action Verb",
+  "email": "john.doe@files.com",
+  "ip": "10.1.1.1",
+  "inbox_code": "abc123",
+  "clickwrap_body": "",
+  "form_field_set_id": 1,
+  "form_field_data": "",
+  "bundle_code": "",
+  "bundle_id": 1,
+  "bundle_recipient_id": 1
+}
+```
+
+* `code` (string): Registration cookie code
+* `name` (string): Registrant name
+* `company` (string): Registrant company name
+* `email` (string): Registrant email address
+* `ip` (string): Registrant IP Address
+* `inbox_code` (string): InboxRegistration cookie code, if there is an associated InboxRegistration
+* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
+* `form_field_set_id` (int64): Id of associated form field set
+* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
+* `bundle_code` (string): Bundle URL code
+* `bundle_id` (int64): Id of associated bundle
+* `bundle_recipient_id` (int64): Id of associated bundle recipient
+
+---
+
+## List Bundle Registrations
+
+```
+await BundleRegistration.list({
+  'user_id': 1,
+  'per_page': 1,
+  'bundle_id': 1,
+})
+```
+
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `bundle_id` (int64): ID of the associated Bundle

package/docs/models/Clickwrap.md

@@ -0,0 +1,120 @@
+# Clickwrap
+
+## Example Clickwrap Object
+
+```
+{
+  "id": 1,
+  "name": "Example Site NDA for Files.com Use",
+  "body": "[Legal body text]",
+  "use_with_users": "",
+  "use_with_bundles": "",
+  "use_with_inboxes": ""
+}
+```
+
+* `id` (int64): 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_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?
+
+---
+
+## List Clickwraps
+
+```
+await Clickwrap.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+---
+
+## Show Clickwrap
+
+```
+await Clickwrap.find(id)
+```
+
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+
+---
+
+## Create Clickwrap
+
+```
+await 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
+
+```
+const [clickwrap] = await Clickwrap.list()
+
+await 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.
+
+### Example Response
+
+```json
+{
+  "id": 1,
+  "name": "Example Site NDA for Files.com Use",
+  "body": "[Legal body text]",
+  "use_with_users": "",
+  "use_with_bundles": "",
+  "use_with_inboxes": ""
+}
+```
+
+---
+
+## Delete Clickwrap
+
+```
+const [clickwrap] = await Clickwrap.list()
+
+await clickwrap.delete()
+```
+
+### Parameters
+
+* `id` (int64): Required - Clickwrap ID.
+

package/docs/models/DnsRecord.md

@@ -0,0 +1,33 @@
+# 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
+
+```
+await DnsRecord.list({
+  'per_page': 1,
+})
+```
+
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  Send a cursor value to resume an existing list from the point at which you left off.  Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).

package/docs/models/Errors.md

@@ -0,0 +1,17 @@
+# Errors
+
+## Example Errors Object
+
+```
+{
+  "fields": [
+
+  ],
+  "messages": [
+
+  ]
+}
+```
+
+* `fields` (array): A list of fields where errors occur
+* `messages` (array): A list of error messages