From 3931e0258c91cb1c818a57876dbee8284e312899 Mon Sep 17 00:00:00 2001 From: box-sdk-build Date: Tue, 28 Jan 2025 06:40:39 -0800 Subject: [PATCH 1/3] chore: release 4.0.0 --- CHANGELOG.md | 17 + docs/ai.md | 108 +- docs/autocomplete.md | 18 +- docs/collaboration-allowlist.md | 362 +++--- docs/collaborations.md | 414 ++++--- docs/collections.md | 214 ++-- docs/comments.md | 269 ++-- docs/configure.md | 237 ++-- docs/device-pins.md | 141 ++- docs/events.md | 206 +++- docs/file-requests.md | 224 ++-- docs/files.md | 1898 ++++++++++++++++++----------- docs/folders.md | 1605 +++++++++++++++--------- docs/groups.md | 873 ++++++++----- docs/help.md | 15 +- docs/integration-mappings.md | 258 ++-- docs/legal-hold-policies.md | 541 ++++---- docs/login.md | 28 +- docs/metadata-cascade-policies.md | 220 ++-- docs/metadata-query.md | 72 +- docs/metadata-templates.md | 413 ++++--- docs/oss.md | 17 +- docs/recent-items.md | 53 +- docs/request.md | 46 +- docs/retention-policies.md | 710 ++++++----- docs/search.md | 128 +- docs/shared-links.md | 197 +-- docs/sign-requests.md | 253 ++-- docs/sign-templates.md | 95 +- docs/storage-policies.md | 305 +++-- docs/tasks.md | 416 ++++--- docs/terms-of-service.md | 280 +++-- docs/tokens.md | 56 +- docs/trash.md | 226 ++-- docs/users.md | 1026 ++++++++++------ docs/version.md | 2 +- docs/watermarking.md | 126 +- docs/web-links.md | 223 ++-- docs/webhooks.md | 302 ++--- package-lock.json | 4 +- package.json | 2 +- 41 files changed, 7530 insertions(+), 5070 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 99957457..f3540f5b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,23 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [4.0.0](https://github.com/box/boxcli/compare/v3.16.0...v4.0.0) (2025-01-28) + + +### ⚠ BREAKING CHANGES + +* Drop support old Node version and integrate typescript SDK (#548) + +### New Features and Enhancements + +* Drop support old Node version and integrate typescript SDK ([#548](https://github.com/box/boxcli/issues/548)) ([22179ec](https://github.com/box/boxcli/commit/22179ecfc68b8dd315339ac204a7274d712d5a8e)) +* Incognito browser option for box login ([#561](https://github.com/box/boxcli/issues/561)) ([a666766](https://github.com/box/boxcli/commit/a6667664d6b43fd80de9e57482b0f4138efcd6cf)) +* Replace `@oclif/command` to `@oclif/core` library ([#553](https://github.com/box/boxcli/issues/553)) ([aed470b](https://github.com/box/boxcli/commit/aed470b22d28ed19040b4417e3143f3323b9a916)) + +### Bug Fixes + +* Respect using environment `defaultAsUserId` for CCG Auth and OAuth ([#554](https://github.com/box/boxcli/issues/554)) ([b3a691e](https://github.com/box/boxcli/commit/b3a691e8c886f7bb3a25ae8f7986f284a695f046)) + ## [3.16.0](https://github.com/box/boxcli/compare/v3.15.0...v3.16.0) (2024-11-25) diff --git a/docs/ai.md b/docs/ai.md index 42c56d9f..22296fb5 100644 --- a/docs/ai.md +++ b/docs/ai.md @@ -12,30 +12,34 @@ Sends an AI request to supported LLMs and returns an answer ``` USAGE - $ box ai:ask - -OPTIONS - -h, --help Show CLI help - -q, --quiet Suppress any non-error output to stderr - -s, --save Save report to default reports folder on disk - -t, --token=token Provide a token to perform this call - -v, --verbose Show verbose output, which can be helpful for debugging - -y, --yes Automatically respond yes to all confirmation prompts - --as-user=as-user Provide an ID for a user - --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects - --csv Output formatted CSV - --fields=fields Comma separated list of fields to show - --items=items (required) The items for the AI request - --json Output formatted JSON - --no-color Turn off colors for logging - --prompt=prompt (required) The prompt for the AI request - --save-to-file-path=save-to-file-path Override default file path to save report - -EXAMPLE - box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?" + $ box ai:ask --prompt --items ... [-t ] [--as-user ] [--no-color] [--json | + --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --items=... (required) The items for the AI request + --json Output formatted JSON + --no-color Turn off colors for logging + --prompt= (required) The prompt for the AI request + --save-to-file-path= Override default file path to save report + +DESCRIPTION + Sends an AI request to supported LLMs and returns an answer + +EXAMPLES + $ box ai:ask --items=id=12345,type=file --prompt "What is the status of this document?" ``` -_See code: [src/commands/ai/ask.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/ask.js)_ +_See code: [src/commands/ai/ask.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/ask.ts)_ ## `box ai:text-gen` @@ -43,36 +47,34 @@ Sends an AI request to supported LLMs and returns an answer specifically focused ``` USAGE - $ box ai:text-gen - -OPTIONS - -h, --help Show CLI help - -q, --quiet Suppress any non-error output to stderr - -s, --save Save report to default reports folder on disk - -t, --token=token Provide a token to perform this call - -v, --verbose Show verbose output, which can be helpful for debugging - -y, --yes Automatically respond yes to all confirmation prompts - --as-user=as-user Provide an ID for a user - --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects - --csv Output formatted CSV - --dialogue-history=dialogue-history The history of prompts and answers previously passed to the LLM. - --fields=fields Comma separated list of fields to show - - --items=items (required) The items to be processed by the LLM, often files. The array can - include exactly one element. - - --json Output formatted JSON - - --no-color Turn off colors for logging - - --prompt=prompt (required) The prompt for the AI request - - --save-to-file-path=save-to-file-path Override default file path to save report - -EXAMPLE - box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in - review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this - document?" + $ box ai:text-gen --items ... --prompt [-t ] [--as-user ] [--no-color] [--json | + --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] + [--dialogue-history ...] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --dialogue-history=... The history of prompts and answers previously passed to the LLM. + --fields= Comma separated list of fields to show + --items=... (required) The items to be processed by the LLM, often files. The array can include + exactly one element. + --json Output formatted JSON + --no-color Turn off colors for logging + --prompt= (required) The prompt for the AI request + --save-to-file-path= Override default file path to save report + +DESCRIPTION + Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text. + +EXAMPLES + $ box ai:text-gen --dialogue-history=prompt="What is the status of this document?",answer="It is in review",created-at="2024-07-09T11:29:46.835Z" --items=id=12345,type=file --prompt="What is the status of this document?" ``` -_See code: [src/commands/ai/text-gen.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/ai/text-gen.js)_ +_See code: [src/commands/ai/text-gen.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/ai/text-gen.ts)_ diff --git a/docs/autocomplete.md b/docs/autocomplete.md index 4dea1763..2b46ca88 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -7,23 +7,31 @@ Display autocomplete installation instructions ## `box autocomplete [SHELL]` -display autocomplete installation instructions +Display autocomplete installation instructions. ``` USAGE - $ box autocomplete [SHELL] + $ box autocomplete [SHELL] [-r] ARGUMENTS - SHELL shell type + SHELL (zsh|bash|powershell) Shell type -OPTIONS +FLAGS -r, --refresh-cache Refresh cache (ignores displaying instructions) +DESCRIPTION + Display autocomplete installation instructions. + EXAMPLES $ box autocomplete + $ box autocomplete bash + $ box autocomplete zsh + + $ box autocomplete powershell + $ box autocomplete --refresh-cache ``` -_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.0/src/commands/autocomplete/index.ts)_ +_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.18/src/commands/autocomplete/index.ts)_ diff --git a/docs/collaboration-allowlist.md b/docs/collaboration-allowlist.md index dfe88d58..01e015ec 100644 --- a/docs/collaboration-allowlist.md +++ b/docs/collaboration-allowlist.md @@ -18,35 +18,36 @@ List collaboration allowlist entries ``` USAGE + $ box collaboration-allowlist [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | --save-to-file-path + ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --json Output formatted JSON + --max-items= A value that indicates the maximum number of results to return. This only specifies a + maximum boundary and will not guarantee the minimum number of results returned. When + the max-items (x) is greater than 1000, then the maximum ceil(x/1000) requests will + be made. + --no-color Turn off colors for logging + --save-to-file-path= Override default file path to save report + +DESCRIPTION + List collaboration allowlist entries + +EXAMPLES $ box collaboration-allowlist - -OPTIONS - -h, --help Show CLI help - -q, --quiet Suppress any non-error output to stderr - -s, --save Save report to default reports folder on disk - -t, --token=token Provide a token to perform this call - -v, --verbose Show verbose output, which can be helpful for debugging - -y, --yes Automatically respond yes to all confirmation prompts - --as-user=as-user Provide an ID for a user - --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects - --csv Output formatted CSV - --fields=fields Comma separated list of fields to show - --json Output formatted JSON - - --max-items=max-items A value that indicates the maximum number of results to return. This only - specifies a maximum boundary and will not guarantee the minimum number of - results returned. When the max-items (x) is greater than 1000, then the maximum - ceil(x/1000) requests will be made. - - --no-color Turn off colors for logging - - --save-to-file-path=save-to-file-path Override default file path to save report - -EXAMPLE - box collaboration-allowlist ``` -_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.16.0/src/commands/collaboration-allowlist/index.js)_ +_See code: [src/commands/collaboration-allowlist/index.ts](https://github.com/box/boxcli/blob/v4.0.0/src/commands/collaboration-allowlist/index.ts)_ ## `box collaboration-allowlist:add DOMAIN` @@ -54,32 +55,38 @@ Add a collaboration allowlist entry ``` USAGE - $ box collaboration-allowlist:add DOMAIN + $ box collaboration-allowlist:add DOMAIN --direction inbound|outbound|both [-t ] [--as-user ] [--no-color] + [--json | --csv] [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] + [-q] ARGUMENTS DOMAIN Domain to add to allowlist (e.g. box.com) -OPTIONS - -h, --help Show CLI help - -q, --quiet Suppress any non-error output to stderr - -s, --save Save report to default reports folder on disk - -t, --token=token Provide a token to perform this call - -v, --verbose Show verbose output, which can be helpful for debugging - -y, --yes Automatically respond yes to all confirmation prompts - --as-user=as-user Provide an ID for a user - --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects - --csv Output formatted CSV - --direction=inbound|outbound|both (required) Direction to allowlist collaboration in - --fields=fields Comma separated list of fields to show - --json Output formatted JSON - --no-color Turn off colors for logging - --save-to-file-path=save-to-file-path Override default file path to save report - -EXAMPLE - box collaboration-allowlist:add example.com --direction outbound +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --direction=