files.com 1.1.670 → 1.1.671

data/docs/behavior.md

@@ -132,6 +132,20 @@ Files::Behavior.webhook_test(
 * `action` (string): Action for test body.
 
 
+---
+
+## Create an export CSV of Behavior resources
+
+```
+Files::Behavior.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `behavior`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `clickwrap_id`, `form_field_set_id`, `impacts_ui`, `remote_server_id` or `behavior`. Valid field combinations are `[ impacts_ui, behavior ]`.
+
+
 ---
 
 ## Update Behavior

data/docs/blog_post.md

@@ -0,0 +1,57 @@
+# 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.md

@@ -91,7 +91,8 @@
       "recursive": true,
       "path": "example"
     }
-  ]
+  ],
+  "site_id": 1
 }
 ```
 
@@ -142,6 +143,7 @@
 * `dont_allow_folders_in_uploads` (boolean): Should folder uploads be prevented?
 * `paths` (array(string)): A list of paths in this bundle.  For performance reasons, this is not provided when listing bundles.
 * `bundlepaths` (array(object)): A list of bundlepaths in this bundle.  For performance reasons, this is not provided when listing bundles.
+* `site_id` (int64): Site id
 * `password` (string): Password for this bundle.
 * `form_field_set_id` (int64): Id of Form Field Set to use with this bundle
 * `create_snapshot` (boolean): If true, create a snapshot of this bundle's contents.
@@ -192,6 +194,27 @@ Files::Bundle.find(id,
 * `deleted` (boolean): If true, show a deleted Share Link.
 
 
+---
+
+## Show public information for a Bundle
+
+```
+Files::Bundle.get_info(
+  code: "abc123", 
+  imported_from_file_ac: false, 
+  bundle_registration_code: "abc123", 
+  recipient_code: "abc123"
+)
+```
+
+### Parameters
+
+* `code` (string): Required - Bundle code
+* `imported_from_file_ac` (boolean): Is bundle imported from File.ac?
+* `bundle_registration_code` (string): Bundle registration cookie code
+* `recipient_code` (string): Bundle recipient code
+
+
 ---
 
 ## Create Share Link
@@ -266,6 +289,30 @@ Files::Bundle.create(
 * `watermark_attachment_file` (file): Preview watermark image applied to all bundle items.
 
 
+---
+
+## List Share Links
+
+```
+Files::Bundle.create_export(
+  user_id: 1, 
+  deleted: false
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code`, `group_id`, `user_id` or `bypasses_site_expiration_rules`. Valid field combinations are `[ group_id, expires_at ]` and `[ user_id, expires_at ]`.
+* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
+* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
+* `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.
+* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at` and `expires_at`.
+* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
+* `deleted` (boolean): If true, only list deleted Share Links.
+
+
 ---
 
 ## Send email(s) with a link to bundle
@@ -283,6 +330,7 @@ Files::Bundle.share(id,
 * `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.
+* `method` (string): The method to use, must be email or null
 * `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
 
 
@@ -393,6 +441,7 @@ bundle.share(
 * `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.
+* `method` (string): The method to use, must be email or null
 * `recipients` (array(object)): A list of recipients to share this bundle with. Required unless `to` is used.
 
 

data/docs/bundle_action.md

@@ -79,3 +79,28 @@ Files::BundleAction.list(
 * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
 * `bundle_id` (int64): Bundle ID
 * `bundle_registration_id` (int64): Bundle Registration ID
+
+
+---
+
+## Create an export CSV of Bundle Action resources
+
+```
+Files::BundleAction.create_export(
+  user_id: 1, 
+  bundle_id: 1, 
+  bundle_registration_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `created_at` or `bundle_registration_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `bundle_id` or `bundle_registration_id`. Valid field combinations are `[ bundle_id, created_at ]`, `[ bundle_registration_id, created_at ]`, `[ bundle_id, bundle_registration_id ]` or `[ bundle_id, bundle_registration_id, 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 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 the supplied value. Valid fields are `created_at`.
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): Bundle Registration ID

data/docs/bundle_download.md

@@ -59,3 +59,26 @@ Files::BundleDownload.list(
 * `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.
 * `bundle_id` (int64): Bundle ID
 * `bundle_registration_id` (int64): BundleRegistration ID
+
+
+---
+
+## List Share Link Downloads
+
+```
+Files::BundleDownload.create_export(
+  bundle_id: 1, 
+  bundle_registration_id: 1
+)
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `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 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 the supplied value. Valid fields are `created_at`.
+* `bundle_id` (int64): Bundle ID
+* `bundle_registration_id` (int64): BundleRegistration ID

data/docs/bundle_notification.md

@@ -81,6 +81,25 @@ Files::BundleNotification.create(
 * `notify_on_upload` (boolean): Triggers bundle notification when a upload action occurs for it.
 
 
+---
+
+## List Share Link Notifications
+
+```
+Files::BundleNotification.create_export(
+  user_id: 1, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id` and `bundle_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `bundle_id`.
+* `bundle_id` (int64): Bundle ID
+
+
 ---
 
 ## Update Share Link Notification

data/docs/bundle_recipient.md

@@ -21,6 +21,7 @@
 * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
 * `bundle_id` (int64): Bundle to share.
+* `method` (string): The method to use, must be email or null
 * `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
 
 
@@ -69,4 +70,24 @@ Files::BundleRecipient.create(
 * `name` (string): Name of recipient.
 * `company` (string): Company of recipient.
 * `note` (string): Note to include in email.
+* `method` (string): The method to use, must be email or null
 * `share_after_create` (boolean): Set to true to share the link with the recipient upon creation.
+
+
+---
+
+## List Share Link Recipients
+
+```
+Files::BundleRecipient.create_export(
+  user_id: 1, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`.
+* `bundle_id` (int64): Required - List recipients for the bundle with this ID.

data/docs/bundle_recipient_registration.md

@@ -0,0 +1,39 @@
+# 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/bundle_registration.md

@@ -37,6 +37,8 @@
 * `bundle_recipient_id` (int64): Id of associated bundle recipient
 * `workspace_id` (int64): Workspace ID. `0` means the default workspace.
 * `created_at` (date-time): Registration creation date/time
+* `bundle_recipient_registration_code` (string): Bundle recipient registration code
+* `password` (string): Public bundle password.
 
 
 ---
@@ -57,3 +59,62 @@ Files::BundleRegistration.list(
 * `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 `workspace_id`, `bundle_id` or `created_at`.
 * `bundle_id` (int64): ID of the associated Bundle
+
+
+---
+
+## Create Bundle Registration
+
+```
+Files::BundleRegistration.create(
+  password: "Password", 
+  company: "Action Verb", 
+  email: "john.doe@files.com", 
+  name: "account", 
+  bundle_code: "example"
+)
+```
+
+### Parameters
+
+* `bundle_recipient_registration_code` (string): Bundle recipient registration code
+* `password` (string): Public bundle password.
+* `company` (string): Registrant company name
+* `email` (string): Registrant email address
+* `name` (string): Registrant name
+* `bundle_code` (string): Required - Bundle URL code
+
+
+---
+
+## Update the last time any action happened in bundle under this registration
+
+```
+Files::BundleRegistration.last_activity(
+  bundle_registration_code: "abc123", 
+  upload_in_progress: true
+)
+```
+
+### Parameters
+
+* `bundle_registration_code` (string): Required - Bundle registration cookie code
+* `upload_in_progress` (boolean): Flag that indicates if current upload is going during this registration session
+
+
+---
+
+## List Share Link Registrations
+
+```
+Files::BundleRegistration.create_export(
+  user_id: 1, 
+  bundle_id: 1
+)
+```
+
+### Parameters
+
+* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `workspace_id`, `bundle_id` or `created_at`.
+* `bundle_id` (int64): ID of the associated Bundle

data/docs/certificate.md

@@ -0,0 +1,258 @@
+# 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.

data/docs/chat_session.md

@@ -57,3 +57,17 @@ Files::ChatSession.find(id)
 ### Parameters
 
 * `id` (string): Required - Chat Session ID.
+
+
+---
+
+## Create an export CSV of Chat Session resources
+
+```
+Files::ChatSession.create_export
+```
+
+### Parameters
+
+* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `id`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `ai_task_id`, `user_id` or `workspace_id`.