2.4.0

box · Aug 29, 2019 · 4fc83b4 · 4fc83b4
1 parent 1da63f9
commit 4fc83b4
Show file tree

Hide file tree

Showing 30 changed files with 673 additions and 178 deletions.
diff --git a/docs/collaboration-whitelist.md b/docs/collaboration-whitelist.md
@@ -33,9 +33,12 @@ OPTIONS
   --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-whitelist
 ```
 
-_See code: [src/commands/collaboration-whitelist/index.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/index.js)_
+_See code: [src/commands/collaboration-whitelist/index.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/index.js)_
 
 ## `box collaboration-whitelist:add DOMAIN`
 
@@ -62,9 +65,12 @@ OPTIONS
   --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-whitelist:add example.com --direction outbound
 ```
 
-_See code: [src/commands/collaboration-whitelist/add.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/add.js)_
+_See code: [src/commands/collaboration-whitelist/add.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/add.js)_
 
 ## `box collaboration-whitelist:delete ID`
 
@@ -90,9 +96,12 @@ OPTIONS
   --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-whitelist:delete 12345
 ```
 
-_See code: [src/commands/collaboration-whitelist/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/delete.js)_
+_See code: [src/commands/collaboration-whitelist/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/delete.js)_
 
 ## `box collaboration-whitelist:exemptions`
 
@@ -115,9 +124,12 @@ OPTIONS
   --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-whitelist:exemptions
 ```
 
-_See code: [src/commands/collaboration-whitelist/exemptions/index.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/exemptions/index.js)_
+_See code: [src/commands/collaboration-whitelist/exemptions/index.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/exemptions/index.js)_
 
 ## `box collaboration-whitelist:exemptions:create USERID`
 
@@ -143,9 +155,12 @@ OPTIONS
   --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-whitelist:exemptions:create 11111
 ```
 
-_See code: [src/commands/collaboration-whitelist/exemptions/create.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/exemptions/create.js)_
+_See code: [src/commands/collaboration-whitelist/exemptions/create.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/exemptions/create.js)_
 
 ## `box collaboration-whitelist:exemptions:delete ID`
 
@@ -171,9 +186,12 @@ OPTIONS
   --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-whitelist:exemptions:delete 12345
 ```
 
-_See code: [src/commands/collaboration-whitelist/exemptions/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/exemptions/delete.js)_
+_See code: [src/commands/collaboration-whitelist/exemptions/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/exemptions/delete.js)_
 
 ## `box collaboration-whitelist:exemptions:get ID`
 
@@ -199,9 +217,12 @@ OPTIONS
   --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-whitelist:exemptions:get 12345
 ```
 
-_See code: [src/commands/collaboration-whitelist/exemptions/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/exemptions/get.js)_
+_See code: [src/commands/collaboration-whitelist/exemptions/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/exemptions/get.js)_
 
 ## `box collaboration-whitelist:get ID`
 
@@ -227,6 +248,9 @@ OPTIONS
   --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-whitelist:get 12345
 ```
 
-_See code: [src/commands/collaboration-whitelist/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaboration-whitelist/get.js)_
+_See code: [src/commands/collaboration-whitelist/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaboration-whitelist/get.js)_
diff --git a/docs/collaborations.md b/docs/collaborations.md
@@ -36,9 +36,12 @@ OPTIONS
 ALIASES
   $ box files:collaborations:delete
   $ box folders:collaborations:delete
+
+EXAMPLE
+  box collaborations:delete 12345
 ```
 
-_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaborations/delete.js)_
+_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaborations/delete.js)_
 
 ## `box collaborations:get ID`
 
@@ -64,9 +67,12 @@ OPTIONS
   --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 collaborations:get 12345
 ```
 
-_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaborations/get.js)_
+_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaborations/get.js)_
 
 ## `box collaborations:pending`
 
@@ -92,9 +98,12 @@ OPTIONS
 
 ALIASES
   $ box collaborations:get-pending
+
+EXAMPLE
+  box collaborations:pending
 ```
 
-_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaborations/pending.js)_
+_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaborations/pending.js)_
 
 ## `box collaborations:update ID`
 
@@ -159,6 +168,9 @@ OPTIONS
 ALIASES
   $ box files:collaborations:update
   $ box folders:collaborations:update
+
+EXAMPLE
+  box collaborations:update 12345 --role viewer
 ```
 
-_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collaborations/update.js)_
+_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collaborations/update.js)_
diff --git a/docs/collections.md b/docs/collections.md
@@ -32,9 +32,12 @@ OPTIONS
 
 ALIASES
   $ box collections:list
+
+EXAMPLE
+  box collections
 ```
 
-_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collections/index.js)_
+_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collections/index.js)_
 
 ## `box collections:add ITEMTYPE ITEMID COLLECTIONID`
 
@@ -62,9 +65,12 @@ OPTIONS
   --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 collections:add file 11111 12345
 ```
 
-_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collections/add.js)_
+_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collections/add.js)_
 
 ## `box collections:items ID`
 
@@ -90,9 +96,12 @@ OPTIONS
   --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 collections:items 12345
 ```
 
-_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collections/items.js)_
+_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collections/items.js)_
 
 ## `box collections:remove ITEMTYPE ITEMID COLLECTIONID`
 
@@ -120,6 +129,9 @@ OPTIONS
   --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 collections:remove file 11111 12345
 ```
 
-_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/collections/remove.js)_
+_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/collections/remove.js)_
diff --git a/docs/comments.md b/docs/comments.md
@@ -37,9 +37,12 @@ OPTIONS
 
   --tagged-message=tagged-message        The text of the comment, including @[userid:Username] somewhere in the message
                                          to mention the user
+
+EXAMPLE
+  box comments:create 11111 --message "Thanks for the update!"
 ```
 
-_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/comments/create.js)_
+_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/comments/create.js)_
 
 ## `box comments:delete ID`
 
@@ -65,9 +68,12 @@ OPTIONS
   --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 comments:delete 12345
 ```
 
-_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/comments/delete.js)_
+_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/comments/delete.js)_
 
 ## `box comments:get ID`
 
@@ -93,9 +99,12 @@ OPTIONS
   --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 comments:get 12345
 ```
 
-_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/comments/get.js)_
+_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/comments/get.js)_
 
 ## `box comments:reply ID`
 
@@ -125,9 +134,12 @@ OPTIONS
 
   --tagged-message=tagged-message        The text of the comment, including @[userid:Username] somewhere in the message
                                          to mention the user
+
+EXAMPLE
+  box comments:reply 12345 --message "No problem!"
 ```
 
-_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/comments/reply.js)_
+_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/comments/reply.js)_
 
 ## `box comments:update ID`
 
@@ -155,6 +167,9 @@ OPTIONS
   --no-color                             Turn off colors for logging
   --save-to-file-path=save-to-file-path  Override default file path to save report
   --tagged-message=tagged-message        The tagged text of the comment
+
+EXAMPLE
+  box comments:update 12345 --message "Thank you for the update!"
 ```
 
-_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/comments/update.js)_
+_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/comments/update.js)_
diff --git a/docs/configure.md b/docs/configure.md
@@ -31,7 +31,7 @@ OPTIONS
   --set-as-current                     Set this new environment as your current environment
 ```
 
-_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/configure/environments/add.js)_
+_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/add.js)_
 
 ## `box configure:environments:delete [NAME]`
 
@@ -50,7 +50,7 @@ OPTIONS
   --no-color     Turn off colors for logging
 ```
 
-_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/configure/environments/delete.js)_
+_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/delete.js)_
 
 ## `box configure:environments:get`
 
@@ -68,7 +68,7 @@ OPTIONS
   --no-color       Turn off colors for logging
 ```
 
-_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/configure/environments/get.js)_
+_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/get.js)_
 
 ## `box configure:environments:set-current [NAME]`
 
@@ -90,7 +90,7 @@ ALIASES
   $ box configure:environments:select
 ```
 
-_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/configure/environments/set-current.js)_
+_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/set-current.js)_
 
 ## `box configure:environments:switch-user [USERID]`
 
@@ -119,7 +119,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/v2.3.0/src/commands/configure/environments/switch-user.js)_
+_See code: [src/commands/configure/environments/switch-user.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/switch-user.js)_
 
 ## `box configure:environments:update [NAME]`
 
@@ -145,7 +145,7 @@ OPTIONS
                                        be stored for each Box environment
 ```
 
-_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/configure/environments/update.js)_
+_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/environments/update.js)_
 
 ## `box configure:settings`
 
@@ -165,4 +165,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/v2.3.0/src/commands/configure/settings.js)_
+_See code: [src/commands/configure/settings.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/configure/settings.js)_
diff --git a/docs/device-pins.md b/docs/device-pins.md
@@ -29,9 +29,12 @@ OPTIONS
   --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 device-pins
 ```
 
-_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/device-pins/index.js)_
+_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/device-pins/index.js)_
 
 ## `box device-pins:delete ID`
 
@@ -57,9 +60,12 @@ OPTIONS
   --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 device-pins:delete 12345
 ```
 
-_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/device-pins/delete.js)_
+_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/device-pins/delete.js)_
 
 ## `box device-pins:get ID`
 
@@ -85,6 +91,9 @@ OPTIONS
   --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 device-pins:get 12345
 ```
 
-_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v2.3.0/src/commands/device-pins/get.js)_
+_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v2.4.0/src/commands/device-pins/get.js)_