Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs after release 3.14.0 #526

Merged
merged 1 commit into from
Mar 6, 2024
Merged

docs: Update docs after release 3.14.0 #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/collaboration-allowlist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ EXAMPLE
box collaboration-allowlist
```

_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/index.js)_
_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/index.js)_

## `box collaboration-allowlist:add DOMAIN`

Expand Down Expand Up @@ -79,7 +79,7 @@ EXAMPLE
box collaboration-allowlist:add example.com --direction outbound
```

_See code: [src/commands/collaboration-allowlist/add.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/add.js)_
_See code: [src/commands/collaboration-allowlist/add.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/add.js)_

## `box collaboration-allowlist:delete ID`

Expand Down Expand Up @@ -111,7 +111,7 @@ EXAMPLE
box collaboration-allowlist:delete 12345
```

_See code: [src/commands/collaboration-allowlist/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/delete.js)_
_See code: [src/commands/collaboration-allowlist/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/delete.js)_

## `box collaboration-allowlist:exemptions`

Expand Down Expand Up @@ -147,7 +147,7 @@ EXAMPLE
box collaboration-allowlist:exemptions
```

_See code: [src/commands/collaboration-allowlist/exemptions/index.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/exemptions/index.js)_
_See code: [src/commands/collaboration-allowlist/exemptions/index.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/exemptions/index.js)_

## `box collaboration-allowlist:exemptions:create USERID`

Expand Down Expand Up @@ -179,7 +179,7 @@ EXAMPLE
box collaboration-allowlist:exemptions:create 11111
```

_See code: [src/commands/collaboration-allowlist/exemptions/create.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/exemptions/create.js)_
_See code: [src/commands/collaboration-allowlist/exemptions/create.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/exemptions/create.js)_

## `box collaboration-allowlist:exemptions:delete ID`

Expand Down Expand Up @@ -211,7 +211,7 @@ EXAMPLE
box collaboration-allowlist:exemptions:delete 12345
```

_See code: [src/commands/collaboration-allowlist/exemptions/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/exemptions/delete.js)_
_See code: [src/commands/collaboration-allowlist/exemptions/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/exemptions/delete.js)_

## `box collaboration-allowlist:exemptions:get ID`

Expand Down Expand Up @@ -243,7 +243,7 @@ EXAMPLE
box collaboration-allowlist:exemptions:get 12345
```

_See code: [src/commands/collaboration-allowlist/exemptions/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/exemptions/get.js)_
_See code: [src/commands/collaboration-allowlist/exemptions/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/exemptions/get.js)_

## `box collaboration-allowlist:get ID`

Expand Down Expand Up @@ -275,4 +275,4 @@ EXAMPLE
box collaboration-allowlist:get 12345
```

_See code: [src/commands/collaboration-allowlist/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaboration-allowlist/get.js)_
_See code: [src/commands/collaboration-allowlist/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaboration-allowlist/get.js)_
10 changes: 5 additions & 5 deletions docs/collaborations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ EXAMPLE
box collaborations:create 22222 folder --role editor --user-id 33333
```

_See code: [src/commands/collaborations/create.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaborations/create.js)_
_See code: [src/commands/collaborations/create.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaborations/create.js)_

## `box collaborations:delete ID`

Expand Down Expand Up @@ -119,7 +119,7 @@ EXAMPLE
box collaborations:delete 12345
```

_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaborations/delete.js)_
_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaborations/delete.js)_

## `box collaborations:get ID`

Expand Down Expand Up @@ -151,7 +151,7 @@ EXAMPLE
box collaborations:get 12345
```

_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaborations/get.js)_
_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaborations/get.js)_

## `box collaborations:pending`

Expand Down Expand Up @@ -190,7 +190,7 @@ EXAMPLE
box collaborations:pending
```

_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaborations/pending.js)_
_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaborations/pending.js)_

## `box collaborations:update ID`

Expand Down Expand Up @@ -263,4 +263,4 @@ EXAMPLE
box collaborations:update 12345 --role viewer
```

_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collaborations/update.js)_
_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collaborations/update.js)_
8 changes: 4 additions & 4 deletions docs/collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ EXAMPLE
box collections
```

_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collections/index.js)_
_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collections/index.js)_

## `box collections:add ITEMTYPE ITEMID COLLECTIONID`

Expand Down Expand Up @@ -72,7 +72,7 @@ EXAMPLE
box collections:add file 11111 12345
```

_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collections/add.js)_
_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collections/add.js)_

## `box collections:items ID`

Expand Down Expand Up @@ -111,7 +111,7 @@ EXAMPLE
box collections:items 12345
```

_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collections/items.js)_
_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collections/items.js)_

## `box collections:remove ITEMTYPE ITEMID COLLECTIONID`

Expand Down Expand Up @@ -145,4 +145,4 @@ EXAMPLE
box collections:remove file 11111 12345
```

_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/collections/remove.js)_
_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/collections/remove.js)_
10 changes: 5 additions & 5 deletions docs/comments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ EXAMPLE
box comments:create 11111 --message "Thanks for the update!"
```

_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/comments/create.js)_
_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/comments/create.js)_

## `box comments:delete ID`

Expand Down Expand Up @@ -75,7 +75,7 @@ EXAMPLE
box comments:delete 12345
```

_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/comments/delete.js)_
_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/comments/delete.js)_

## `box comments:get ID`

Expand Down Expand Up @@ -107,7 +107,7 @@ EXAMPLE
box comments:get 12345
```

_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/comments/get.js)_
_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/comments/get.js)_

## `box comments:reply ID`

Expand Down Expand Up @@ -143,7 +143,7 @@ EXAMPLE
box comments:reply 12345 --message "No problem!"
```

_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/comments/reply.js)_
_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/comments/reply.js)_

## `box comments:update ID`

Expand Down Expand Up @@ -177,4 +177,4 @@ EXAMPLE
box comments:update 12345 --message "Thank you for the update!"
```

_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/comments/update.js)_
_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/comments/update.js)_
14 changes: 7 additions & 7 deletions docs/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ OPTIONS
Set this new environment as your current environment
```

_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/add.js)_
_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/add.js)_

## `box configure:environments:delete [NAME]`

Expand All @@ -75,7 +75,7 @@ OPTIONS
--no-color Turn off colors for logging
```

_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/delete.js)_
_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/delete.js)_

## `box configure:environments:get`

Expand All @@ -94,7 +94,7 @@ OPTIONS
--no-color Turn off colors for logging
```

_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/get.js)_
_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/get.js)_

## `box configure:environments:set-current [NAME]`

Expand All @@ -117,7 +117,7 @@ ALIASES
$ box configure:environments:select
```

_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/set-current.js)_
_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/set-current.js)_

## `box configure:environments:switch-user [USERID]`

Expand Down Expand Up @@ -147,7 +147,7 @@ OPTIONS
--save-to-file-path=save-to-file-path Override default file path to save report
```

_See code: [src/commands/configure/environments/switch-user.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/switch-user.js)_
_See code: [src/commands/configure/environments/switch-user.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/switch-user.js)_

## `box configure:environments:update [NAME]`

Expand Down Expand Up @@ -181,7 +181,7 @@ OPTIONS
be stored for each Box environment
```

_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/environments/update.js)_
_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/environments/update.js)_

## `box configure:settings`

Expand Down Expand Up @@ -213,4 +213,4 @@ OPTIONS
--reports-folder-path=reports-folder-path Set folder path for the reports folder
```

_See code: [src/commands/configure/settings.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/configure/settings.js)_
_See code: [src/commands/configure/settings.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/configure/settings.js)_
6 changes: 3 additions & 3 deletions docs/device-pins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ EXAMPLE
box device-pins
```

_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/device-pins/index.js)_
_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/device-pins/index.js)_

## `box device-pins:delete ID`

Expand Down Expand Up @@ -74,7 +74,7 @@ EXAMPLE
box device-pins:delete 12345
```

_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/device-pins/delete.js)_
_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/device-pins/delete.js)_

## `box device-pins:get ID`

Expand Down Expand Up @@ -106,4 +106,4 @@ EXAMPLE
box device-pins:get 12345
```

_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/device-pins/get.js)_
_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/device-pins/get.js)_
4 changes: 2 additions & 2 deletions docs/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ EXAMPLES
box events --enterprise --created-after 2019-01-01
```

_See code: [src/commands/events/index.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/events/index.js)_
_See code: [src/commands/events/index.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/events/index.js)_

## `box events:poll`

Expand Down Expand Up @@ -140,4 +140,4 @@ OPTIONS
shorthand syntax 00t, like 05w for 5 weeks. If not used, defaults to now
```

_See code: [src/commands/events/poll.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/events/poll.js)_
_See code: [src/commands/events/poll.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/events/poll.js)_
8 changes: 4 additions & 4 deletions docs/file-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ EXAMPLE
box file-requests:copy 22222 44444
```

_See code: [src/commands/file-requests/copy.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/file-requests/copy.js)_
_See code: [src/commands/file-requests/copy.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/file-requests/copy.js)_

## `box file-requests:delete ID`

Expand Down Expand Up @@ -87,7 +87,7 @@ EXAMPLE
box file-requests:delete 12345
```

_See code: [src/commands/file-requests/delete.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/file-requests/delete.js)_
_See code: [src/commands/file-requests/delete.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/file-requests/delete.js)_

## `box file-requests:get ID`

Expand Down Expand Up @@ -119,7 +119,7 @@ EXAMPLE
box file-requests:get 12345
```

_See code: [src/commands/file-requests/get.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/file-requests/get.js)_
_See code: [src/commands/file-requests/get.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/file-requests/get.js)_

## `box file-requests:update ID`

Expand Down Expand Up @@ -170,4 +170,4 @@ EXAMPLE
box file-requests:update 12345 --description "New file request description!"
```

_See code: [src/commands/file-requests/update.js](https://github.com/box/boxcli/blob/v3.13.0/src/commands/file-requests/update.js)_
_See code: [src/commands/file-requests/update.js](https://github.com/box/boxcli/blob/v3.14.0/src/commands/file-requests/update.js)_
Loading
Loading