filescom-bundles

Files (1)

• SKILL.md

SKILL.md (first lines)

# filescom-bundles

A Bundle is the API/SDK term for the feature called Share Links in the web interface.
The API provides the full set of actions related to Share Links, including sending them via E-Mail.

Please note that we very closely monitor the E-Mailing feature and any abuse will result in disabling of your site.

All subcommands also accept the flags documented in [`CONTEXT.md`](../../CONTEXT.md) (`--api-key`, `--format`, `--workspace-id`, `--debug`, and the pagination flags `--cursor` / `--per-page` / `--max-pages` on `list`). Those are not repeated below.

## Commands

### `files-cli bundles list`

List Share Links.

| Flag | Type | Description |
| --- | --- | --- |
| `--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` | bool | If true, only list deleted Share Links. |

### `files-cli bundles find`

Show Share Link.

| Flag | Type | Description |
| --- | --- | --- |
| `--id` | int64 | Bundle ID. **Required.** |
| `--deleted` | bool | If true, show a deleted Share Link. |

### `files-cli bundles create`

Create Share Link.

| Flag | Type | Description |
| --- | --- | --- |
| `--user-id` | int64 | User ID.  Provide a value of `0` to operate the current session's user. |
| `--paths` | []string | A list of paths to include in this bundle. **Required.** |
| `--password` | string | Password for this bundle. |
| `--bypasses-site-expiration-rules` | bool | If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this. |
| `--form-field-set-id` | int64 | Id of Form Field Set to use with this bundle |
| `--create-snapshot` | bool | If true, create a snapshot of this bundle's contents. |
| `--dont-separate-submissions-by-folder` | bool | Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required. |
| `--expires-at` | datetime | Explicit Bundle expiration date/time. If not set, the site-wide expiration setting may apply. |
| `--finalize-snapshot` | bool | If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true. |
| `--max-uses` | int64 | Maximum number of times bundle can be accessed |
| `--group-id` | int64 | Owning group ID. If set, members of this group can view, edit, and share this Share Link. |
| `--internal-name` | string | Internal name for identifying this Share Link. |
| `--description` | string | Public description |
| `--note` | string | Bundle internal note |
| `--code` | string | Bundle code.  This code forms the end part of the Public URL. |
| `--path-template` | string | Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data. |
| `--path-template-time-zone` | string | Timezone to use when rendering timestamps in path templates. |
| `--permissions` | enum | Permissions that apply to Folders in this Share Link. One of: `read`, `write`, `read_write`, `full`, `none`, `preview_only`. |
| `--require-registration` | bool | 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` | bool | Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI? |
| `--send-one-time-password-to-recipient-at-registration` | bool | If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set. |
| `--send-email-receipt-to-uploader` | bool | Send delivery receipt to the uploader. Note: For writable share only |
| `--skip-email` | bool | BundleRegistrations can be saved without providing email? |
| `--skip-name` | bool | BundleRegistrations can be saved without providing name? |
| `--skip-company` | bool | BundleRegistrations can be saved without providing company? |
| `--start-access-on-date` | datetime | Date when share will start to be accessible. If `nil` access granted right after create. |
| `--snapshot-id` | int64 | ID of the snapshot containing this bundle's contents. |
| `--workspace-id` | int64 | Workspace ID. `0` means the default workspace. |
| `--watermark-attachment-file` | file | 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 |

### `files-cli bundles share`

Send email(s) with a link to bundle.

| Flag | Type | Description |
| --- | --- | --- |
| `--id` | int64 | Bundle ID. **Required.** |
| `--to` | []string | A list of email addresses to share this bundle with. Required unless `recipients` is used. |
| `--note` | string | Note to include in email. |
| `--recipients` | []object | A list of recipients to share this bundle with. Required unless `to` is used. |

### `files-cli bundles update`

Update Share Link.

| Flag | Type | Description |
| --- | --- | --- |
| `--id` | int64 | Bundle ID. **Required.** |
| `--paths` | []string | A list of paths to include in this bundle. |
| `--password` | string | Password for this bundle. |
| `--bypasses-site-expiration-rules` | bool | If true, this Share Link bypasses site-wide expiration rules. Only site admins may set this. |
| `--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. |
| `--create-snapshot` | bool | If true, create a snapshot of this bundle's contents. |
| `--description` | string | Public description |
| `--dont-separate-submissions-by-folder` | bool | Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required. |
| `--expires-at` | datetime | Explicit Bundle expiration date/time. If not set, the site-wide expiration setting may apply. |
| `--finalize-snapshot` | bool | If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true. |
| `--inbox-id` | int64 | ID of the associated inbox, if available. |
| `--max-uses` | int64 | Maximum number of times bundle can be accessed |
| `--group-id` | int64 | Owning group ID. If set, members of this group can view, edit, and share this Share Link. |
| `--internal-name` | string | Internal name for identifying this Share Link. |
| `--note` | string | Bundle internal note |
| `--path-template` | string | Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data. |
| `--path-template-time-zone` | string | Timezone to use when rendering timestamps in path templates. |
| `--permissions` | enum | Permissions that apply to Folders in this Share Link. One of: `read`, `write`, `read_write`, `full`, `none`, `preview_only`. |
| `--require-registration` | bool | Show a registration page that captures the downloader's name and email address? |
| `--require-share-recipient` | bool | Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI? |
| `--send-one-time-password-to-recipient-at-registration` | bool | If true, require_share_recipient bundles will send a one-time password to the recipient when they register. Cannot be enabled if the bundle has a password set. |
| `--send-email-receipt-to-uploader` | bool | Send delivery receipt to the uploader. Note: For writable share only |
| `--skip-company` | bool | BundleRegistrations can be saved without providing company? |
| `--start-access-on-date` | datetime | Date when share will start to be accessible. If `nil` access granted right after create. |
| `--skip-email` | bool | BundleRegistrations can be saved without providing email? |

From Files-com/files-cli, MIT.

More from Files-com/files-cli