From fa7c03a8dc7b80d11757ddfcecfef1d3db3cfe94 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Wed, 7 Dec 2022 15:05:01 +0100 Subject: [PATCH 1/7] feat: Add support for folder update collaborators --- src/commands/folders/update.js | 14 ++++++++++++++ test/commands/folders.test.js | 16 ++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/src/commands/folders/update.js b/src/commands/folders/update.js index 0c0102b0..bf2cc54c 100644 --- a/src/commands/folders/update.js +++ b/src/commands/folders/update.js @@ -11,6 +11,12 @@ class FoldersUpdateCommand extends BoxCommand { if (flags.name) { updates.name = flags.name; } + if (flags.hasOwnProperty('can-non-owners-invite') ) { + updates.can_non_owners_invite = flags['can-non-owners-invite']; + } + if (flags.hasOwnProperty('can-non-owners-view-collaborators')) { + updates.can_non_owners_view_collaborators = flags['can-non-owners-view-collaborators']; + } if (flags.hasOwnProperty('description')) { updates.description = flags.description; } @@ -48,6 +54,14 @@ FoldersUpdateCommand._endpoint = 'put_folders_id'; FoldersUpdateCommand.flags = { ...BoxCommand.flags, name: flags.string({ description: 'New name for folder' }), + 'can-non-owners-invite': flags.boolean({ + description: 'Specifies if users who are not the owner of the folder can invite new collaborators to the folder.', + allowNo: true + }), + 'can-non-owners-view-collaborators': flags.boolean({ + description: 'Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder.', + allowNo: true, + }), description: flags.string({ description: 'New description for folder' }), 'upload-email-access': flags.string({ description: 'Upload email access level', diff --git a/test/commands/folders.test.js b/test/commands/folders.test.js index 2450a20e..b8a09c2e 100644 --- a/test/commands/folders.test.js +++ b/test/commands/folders.test.js @@ -1300,6 +1300,22 @@ describe('Folders', () => { '--no-restrict-to-enterprise', {is_collaboration_restricted_to_enterprise: false} ], + 'can non owners invite flag': [ + '--can-non-owners-invite', + {can_non_owners_invite: true} + ], + 'no can non owners invite flag': [ + '--no-can-non-owners-invite', + {can_non_owners_invite: false} + ], + 'can non owners view collaborations flag': [ + '--can-non-owners-view-collaborators', + {can_non_owners_view_collaborators: true} + ], + 'no can non owners view collaborations flag': [ + '--no-can-non-owners-view-collaborators', + {can_non_owners_view_collaborators: false} + ], 'upload email access flag': [ '--upload-email-access=open', {folder_upload_email: {access: 'open'}} From 563422198496c1ba4cadd7e3f2ce8a01e328ceb9 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Tue, 22 Nov 2022 16:29:58 +0100 Subject: [PATCH 2/7] docs: Update docs after release 3.6.0 (#433) --- docs/collaboration-allowlist.md | 16 ++++---- docs/collaborations.md | 10 ++--- docs/collections.md | 8 ++-- docs/comments.md | 10 ++--- docs/configure.md | 14 +++---- docs/device-pins.md | 6 +-- docs/events.md | 4 +- docs/file-requests.md | 8 ++-- docs/files.md | 66 ++++++++++++++++++------------- docs/folders.md | 46 ++++++++++----------- docs/groups.md | 22 +++++------ docs/legal-hold-policies.md | 22 +++++------ docs/login.md | 2 +- docs/metadata-cascade-policies.md | 8 ++-- docs/metadata-query.md | 2 +- docs/metadata-templates.md | 12 +++--- docs/oss.md | 2 +- docs/recent-items.md | 2 +- docs/request.md | 2 +- docs/retention-policies.md | 24 +++++------ docs/search.md | 2 +- docs/shared-links.md | 6 +-- docs/sign-requests.md | 10 ++--- docs/storage-policies.md | 12 +++--- docs/tasks.md | 18 ++++----- docs/terms-of-service.md | 12 +++--- docs/tokens.md | 6 +-- docs/trash.md | 8 ++-- docs/users.md | 24 +++++------ docs/watermarking.md | 6 +-- docs/web-links.md | 10 ++--- docs/webhooks.md | 10 ++--- 32 files changed, 210 insertions(+), 200 deletions(-) diff --git a/docs/collaboration-allowlist.md b/docs/collaboration-allowlist.md index b4db8dcb..c7cf42a9 100644 --- a/docs/collaboration-allowlist.md +++ b/docs/collaboration-allowlist.md @@ -39,7 +39,7 @@ EXAMPLE box collaboration-allowlist ``` -_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/index.js)_ +_See code: [src/commands/collaboration-allowlist/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/index.js)_ ## `box collaboration-allowlist:add DOMAIN` @@ -72,7 +72,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.5.0/src/commands/collaboration-allowlist/add.js)_ +_See code: [src/commands/collaboration-allowlist/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/add.js)_ ## `box collaboration-allowlist:delete ID` @@ -104,7 +104,7 @@ EXAMPLE box collaboration-allowlist:delete 12345 ``` -_See code: [src/commands/collaboration-allowlist/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/delete.js)_ +_See code: [src/commands/collaboration-allowlist/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/delete.js)_ ## `box collaboration-allowlist:exemptions` @@ -133,7 +133,7 @@ EXAMPLE box collaboration-allowlist:exemptions ``` -_See code: [src/commands/collaboration-allowlist/exemptions/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/exemptions/index.js)_ +_See code: [src/commands/collaboration-allowlist/exemptions/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/exemptions/index.js)_ ## `box collaboration-allowlist:exemptions:create USERID` @@ -165,7 +165,7 @@ EXAMPLE box collaboration-allowlist:exemptions:create 11111 ``` -_See code: [src/commands/collaboration-allowlist/exemptions/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/exemptions/create.js)_ +_See code: [src/commands/collaboration-allowlist/exemptions/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/exemptions/create.js)_ ## `box collaboration-allowlist:exemptions:delete ID` @@ -197,7 +197,7 @@ EXAMPLE box collaboration-allowlist:exemptions:delete 12345 ``` -_See code: [src/commands/collaboration-allowlist/exemptions/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/exemptions/delete.js)_ +_See code: [src/commands/collaboration-allowlist/exemptions/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/exemptions/delete.js)_ ## `box collaboration-allowlist:exemptions:get ID` @@ -229,7 +229,7 @@ EXAMPLE box collaboration-allowlist:exemptions:get 12345 ``` -_See code: [src/commands/collaboration-allowlist/exemptions/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/exemptions/get.js)_ +_See code: [src/commands/collaboration-allowlist/exemptions/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/exemptions/get.js)_ ## `box collaboration-allowlist:get ID` @@ -261,4 +261,4 @@ EXAMPLE box collaboration-allowlist:get 12345 ``` -_See code: [src/commands/collaboration-allowlist/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaboration-allowlist/get.js)_ +_See code: [src/commands/collaboration-allowlist/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaboration-allowlist/get.js)_ diff --git a/docs/collaborations.md b/docs/collaborations.md index fad595a9..6a4a77ea 100644 --- a/docs/collaborations.md +++ b/docs/collaborations.md @@ -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.5.0/src/commands/collaborations/create.js)_ +_See code: [src/commands/collaborations/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaborations/create.js)_ ## `box collaborations:delete ID` @@ -119,7 +119,7 @@ EXAMPLE box collaborations:delete 12345 ``` -_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaborations/delete.js)_ +_See code: [src/commands/collaborations/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaborations/delete.js)_ ## `box collaborations:get ID` @@ -151,7 +151,7 @@ EXAMPLE box collaborations:get 12345 ``` -_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaborations/get.js)_ +_See code: [src/commands/collaborations/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaborations/get.js)_ ## `box collaborations:pending` @@ -183,7 +183,7 @@ EXAMPLE box collaborations:pending ``` -_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaborations/pending.js)_ +_See code: [src/commands/collaborations/pending.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaborations/pending.js)_ ## `box collaborations:update ID` @@ -256,4 +256,4 @@ EXAMPLE box collaborations:update 12345 --role viewer ``` -_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collaborations/update.js)_ +_See code: [src/commands/collaborations/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collaborations/update.js)_ diff --git a/docs/collections.md b/docs/collections.md index a4973278..2f5bf2a5 100644 --- a/docs/collections.md +++ b/docs/collections.md @@ -38,7 +38,7 @@ EXAMPLE box collections ``` -_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collections/index.js)_ +_See code: [src/commands/collections/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collections/index.js)_ ## `box collections:add ITEMTYPE ITEMID COLLECTIONID` @@ -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.5.0/src/commands/collections/add.js)_ +_See code: [src/commands/collections/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collections/add.js)_ ## `box collections:items ID` @@ -104,7 +104,7 @@ EXAMPLE box collections:items 12345 ``` -_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collections/items.js)_ +_See code: [src/commands/collections/items.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collections/items.js)_ ## `box collections:remove ITEMTYPE ITEMID COLLECTIONID` @@ -138,4 +138,4 @@ EXAMPLE box collections:remove file 11111 12345 ``` -_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/collections/remove.js)_ +_See code: [src/commands/collections/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/collections/remove.js)_ diff --git a/docs/comments.md b/docs/comments.md index f29ff0d7..9624bfaa 100644 --- a/docs/comments.md +++ b/docs/comments.md @@ -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.5.0/src/commands/comments/create.js)_ +_See code: [src/commands/comments/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/comments/create.js)_ ## `box comments:delete ID` @@ -75,7 +75,7 @@ EXAMPLE box comments:delete 12345 ``` -_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/comments/delete.js)_ +_See code: [src/commands/comments/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/comments/delete.js)_ ## `box comments:get ID` @@ -107,7 +107,7 @@ EXAMPLE box comments:get 12345 ``` -_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/comments/get.js)_ +_See code: [src/commands/comments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/comments/get.js)_ ## `box comments:reply ID` @@ -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.5.0/src/commands/comments/reply.js)_ +_See code: [src/commands/comments/reply.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/comments/reply.js)_ ## `box comments:update ID` @@ -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.5.0/src/commands/comments/update.js)_ +_See code: [src/commands/comments/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/comments/update.js)_ diff --git a/docs/configure.md b/docs/configure.md index bc69336e..279d0228 100644 --- a/docs/configure.md +++ b/docs/configure.md @@ -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.5.0/src/commands/configure/environments/add.js)_ +_See code: [src/commands/configure/environments/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/add.js)_ ## `box configure:environments:delete [NAME]` @@ -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.5.0/src/commands/configure/environments/delete.js)_ +_See code: [src/commands/configure/environments/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/delete.js)_ ## `box configure:environments:get` @@ -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.5.0/src/commands/configure/environments/get.js)_ +_See code: [src/commands/configure/environments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/get.js)_ ## `box configure:environments:set-current [NAME]` @@ -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.5.0/src/commands/configure/environments/set-current.js)_ +_See code: [src/commands/configure/environments/set-current.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/set-current.js)_ ## `box configure:environments:switch-user [USERID]` @@ -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.5.0/src/commands/configure/environments/switch-user.js)_ +_See code: [src/commands/configure/environments/switch-user.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/switch-user.js)_ ## `box configure:environments:update [NAME]` @@ -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.5.0/src/commands/configure/environments/update.js)_ +_See code: [src/commands/configure/environments/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/environments/update.js)_ ## `box configure:settings` @@ -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.5.0/src/commands/configure/settings.js)_ +_See code: [src/commands/configure/settings.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/configure/settings.js)_ diff --git a/docs/device-pins.md b/docs/device-pins.md index 74df39fe..1da34303 100644 --- a/docs/device-pins.md +++ b/docs/device-pins.md @@ -35,7 +35,7 @@ EXAMPLE box device-pins ``` -_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/device-pins/index.js)_ +_See code: [src/commands/device-pins/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/device-pins/index.js)_ ## `box device-pins:delete ID` @@ -67,7 +67,7 @@ EXAMPLE box device-pins:delete 12345 ``` -_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/device-pins/delete.js)_ +_See code: [src/commands/device-pins/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/device-pins/delete.js)_ ## `box device-pins:get ID` @@ -99,4 +99,4 @@ EXAMPLE box device-pins:get 12345 ``` -_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/device-pins/get.js)_ +_See code: [src/commands/device-pins/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/device-pins/get.js)_ diff --git a/docs/events.md b/docs/events.md index 22f68369..d3e59f2f 100644 --- a/docs/events.md +++ b/docs/events.md @@ -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.5.0/src/commands/events/index.js)_ +_See code: [src/commands/events/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/events/index.js)_ ## `box events:poll` @@ -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.5.0/src/commands/events/poll.js)_ +_See code: [src/commands/events/poll.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/events/poll.js)_ diff --git a/docs/file-requests.md b/docs/file-requests.md index 2bb8ee54..6c031f8f 100644 --- a/docs/file-requests.md +++ b/docs/file-requests.md @@ -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.5.0/src/commands/file-requests/copy.js)_ +_See code: [src/commands/file-requests/copy.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/file-requests/copy.js)_ ## `box file-requests:delete ID` @@ -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.5.0/src/commands/file-requests/delete.js)_ +_See code: [src/commands/file-requests/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/file-requests/delete.js)_ ## `box file-requests:get ID` @@ -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.5.0/src/commands/file-requests/get.js)_ +_See code: [src/commands/file-requests/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/file-requests/get.js)_ ## `box file-requests:update ID` @@ -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.5.0/src/commands/file-requests/update.js)_ +_See code: [src/commands/file-requests/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/file-requests/update.js)_ diff --git a/docs/files.md b/docs/files.md index 7db747be..554e5421 100644 --- a/docs/files.md +++ b/docs/files.md @@ -65,7 +65,7 @@ EXAMPLE box files:collaborations 11111 ``` -_See code: [src/commands/files/collaborations/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/collaborations/index.js)_ +_See code: [src/commands/files/collaborations/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/collaborations/index.js)_ ## `box files:collaborations:add ID` @@ -137,7 +137,7 @@ EXAMPLE box files:collaborations:add 11111 --role editor --user-id 22222 ``` -_See code: [src/commands/files/collaborations/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/collaborations/add.js)_ +_See code: [src/commands/files/collaborations/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/collaborations/add.js)_ ## `box files:comments ID` @@ -172,7 +172,7 @@ EXAMPLE box files:comments 11111 ``` -_See code: [src/commands/files/comments.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/comments.js)_ +_See code: [src/commands/files/comments.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/comments.js)_ ## `box files:copy ID PARENTID` @@ -208,7 +208,7 @@ EXAMPLE box files:copy 11111 22222 ``` -_See code: [src/commands/files/copy.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/copy.js)_ +_See code: [src/commands/files/copy.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/copy.js)_ ## `box files:delete ID` @@ -242,7 +242,7 @@ EXAMPLE box files:delete 11111 ``` -_See code: [src/commands/files/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/delete.js)_ +_See code: [src/commands/files/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/delete.js)_ ## `box files:download ID` @@ -279,7 +279,7 @@ EXAMPLE box files:download 11111 --destination /path/to/destinationFolder ``` -_See code: [src/commands/files/download.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/download.js)_ +_See code: [src/commands/files/download.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/download.js)_ ## `box files:get ID` @@ -311,7 +311,7 @@ EXAMPLE box files:get 11111 ``` -_See code: [src/commands/files/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/get.js)_ +_See code: [src/commands/files/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/get.js)_ ## `box files:lock ID` @@ -356,7 +356,7 @@ EXAMPLE box files:lock 11111 ``` -_See code: [src/commands/files/lock.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/lock.js)_ +_See code: [src/commands/files/lock.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/lock.js)_ ## `box files:metadata ID` @@ -391,7 +391,7 @@ EXAMPLE box files:metadata 11111 ``` -_See code: [src/commands/files/metadata/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/index.js)_ +_See code: [src/commands/files/metadata/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/index.js)_ ## `box files:metadata:add ID` @@ -437,7 +437,7 @@ EXAMPLE box files:metadata:add 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales ``` -_See code: [src/commands/files/metadata/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/add.js)_ +_See code: [src/commands/files/metadata/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/add.js)_ ## `box files:metadata:get ID` @@ -471,7 +471,7 @@ EXAMPLE box files:metadata:get 11111 --template-key employeeRecord ``` -_See code: [src/commands/files/metadata/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/get.js)_ +_See code: [src/commands/files/metadata/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/get.js)_ ## `box files:metadata:remove ID` @@ -508,7 +508,7 @@ EXAMPLE box files:metadata:remove 11111 --scope global --template-key properties ``` -_See code: [src/commands/files/metadata/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/remove.js)_ +_See code: [src/commands/files/metadata/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/remove.js)_ ## `box files:metadata:set ID` @@ -551,7 +551,7 @@ EXAMPLE box files:metadata:set 11111 --template-key employeeRecord --data "name=John Doe" --data department=Sales ``` -_See code: [src/commands/files/metadata/set.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/set.js)_ +_See code: [src/commands/files/metadata/set.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/set.js)_ ## `box files:metadata:update ID` @@ -614,7 +614,7 @@ EXAMPLE box files:metadata:update 11111 --template-key employeeRecord --replace department=Finance ``` -_See code: [src/commands/files/metadata/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/metadata/update.js)_ +_See code: [src/commands/files/metadata/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/metadata/update.js)_ ## `box files:move ID PARENTID` @@ -648,7 +648,7 @@ EXAMPLE box files:move 11111 22222 ``` -_See code: [src/commands/files/move.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/move.js)_ +_See code: [src/commands/files/move.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/move.js)_ ## `box files:rename ID NAME` @@ -683,7 +683,7 @@ EXAMPLE box files:rename 11111 "New File Name.pdf" ``` -_See code: [src/commands/files/rename.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/rename.js)_ +_See code: [src/commands/files/rename.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/rename.js)_ ## `box files:share ID` @@ -727,7 +727,7 @@ EXAMPLE box files:share 11111 --access company ``` -_See code: [src/commands/files/share.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/share.js)_ +_See code: [src/commands/files/share.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/share.js)_ ## `box files:tasks ID` @@ -762,7 +762,7 @@ EXAMPLE box files:tasks 11111 ``` -_See code: [src/commands/files/tasks/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/tasks/index.js)_ +_See code: [src/commands/files/tasks/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/tasks/index.js)_ ## `box files:unlock ID` @@ -794,7 +794,7 @@ EXAMPLE box files:unlock 11111 ``` -_See code: [src/commands/files/unlock.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/unlock.js)_ +_See code: [src/commands/files/unlock.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/unlock.js)_ ## `box files:unshare ID` @@ -829,7 +829,7 @@ EXAMPLE box files:unshare 11111 ``` -_See code: [src/commands/files/unshare.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/unshare.js)_ +_See code: [src/commands/files/unshare.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/unshare.js)_ ## `box files:update ID` @@ -853,19 +853,29 @@ OPTIONS --bulk-file-path=bulk-file-path File path to bulk .csv or .json objects --csv Output formatted CSV --description=description New description for the file + + --disposition-at=disposition-at The retention expiration timestamp for the given file. This date cannot be + shortened once set on a file + --etag=etag Only apply updates if the ETag value matches + --fields=fields Comma separated list of fields to show + --json Output formatted JSON + --name=name New name for the file + --no-color Turn off colors for logging + --save-to-file-path=save-to-file-path Override default file path to save report + --tags=tags Set tags on the file, specified as comma-separated tags EXAMPLE box files:update 11111 --name "New File Name.pdf" ``` -_See code: [src/commands/files/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/update.js)_ +_See code: [src/commands/files/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/update.js)_ ## `box files:upload PATH` @@ -921,7 +931,7 @@ EXAMPLE box files:upload /path/to/file.pdf --parent-id 22222 ``` -_See code: [src/commands/files/upload.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/upload.js)_ +_See code: [src/commands/files/upload.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/upload.js)_ ## `box files:versions FILEID` @@ -956,7 +966,7 @@ EXAMPLE box files:versions 11111 ``` -_See code: [src/commands/files/versions/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/versions/index.js)_ +_See code: [src/commands/files/versions/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/versions/index.js)_ ## `box files:versions:delete FILEID FILEVERSIONID` @@ -990,7 +1000,7 @@ EXAMPLE box files:versions:delete 11111 55555 ``` -_See code: [src/commands/files/versions/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/versions/delete.js)_ +_See code: [src/commands/files/versions/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/versions/delete.js)_ ## `box files:versions:download FILEID FILEVERSIONID` @@ -1027,7 +1037,7 @@ EXAMPLE box files:versions:download 11111 55555 ``` -_See code: [src/commands/files/versions/download.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/versions/download.js)_ +_See code: [src/commands/files/versions/download.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/versions/download.js)_ ## `box files:versions:promote FILEID FILEVERSIONID` @@ -1060,7 +1070,7 @@ EXAMPLE box files:versions:promote 11111 55555 ``` -_See code: [src/commands/files/versions/promote.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/versions/promote.js)_ +_See code: [src/commands/files/versions/promote.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/versions/promote.js)_ ## `box files:versions:upload FILEID PATH` @@ -1102,7 +1112,7 @@ EXAMPLE box files:versions:upload 11111 /path/to/file.pdf ``` -_See code: [src/commands/files/versions/upload.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/versions/upload.js)_ +_See code: [src/commands/files/versions/upload.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/versions/upload.js)_ ## `box files:zip NAME` @@ -1144,4 +1154,4 @@ EXAMPLE box files:zip sample_file.zip --item=file:12421 --item=folder:48291 ``` -_See code: [src/commands/files/zip.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/files/zip.js)_ +_See code: [src/commands/files/zip.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/files/zip.js)_ diff --git a/docs/folders.md b/docs/folders.md index 1a75482f..c0e378f4 100644 --- a/docs/folders.md +++ b/docs/folders.md @@ -60,7 +60,7 @@ EXAMPLE box folders:collaborations 22222 ``` -_See code: [src/commands/folders/collaborations/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/collaborations/index.js)_ +_See code: [src/commands/folders/collaborations/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/collaborations/index.js)_ ## `box folders:collaborations:add ID` @@ -132,7 +132,7 @@ EXAMPLE box folders:collaborations:add 22222 --role editor --user-id 33333 ``` -_See code: [src/commands/folders/collaborations/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/collaborations/add.js)_ +_See code: [src/commands/folders/collaborations/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/collaborations/add.js)_ ## `box folders:copy ID PARENTID` @@ -167,7 +167,7 @@ EXAMPLE box folders:copy 22222 44444 ``` -_See code: [src/commands/folders/copy.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/copy.js)_ +_See code: [src/commands/folders/copy.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/copy.js)_ ## `box folders:create PARENTID NAME` @@ -202,7 +202,7 @@ EXAMPLE box folders:create 22222 "New Subfolder" ``` -_See code: [src/commands/folders/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/create.js)_ +_See code: [src/commands/folders/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/create.js)_ ## `box folders:delete ID` @@ -237,7 +237,7 @@ EXAMPLE box folders:delete 22222 ``` -_See code: [src/commands/folders/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/delete.js)_ +_See code: [src/commands/folders/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/delete.js)_ ## `box folders:download ID` @@ -273,7 +273,7 @@ EXAMPLE box folders:download 22222 ``` -_See code: [src/commands/folders/download.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/download.js)_ +_See code: [src/commands/folders/download.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/download.js)_ ## `box folders:get ID` @@ -305,7 +305,7 @@ EXAMPLE box folders:get 22222 ``` -_See code: [src/commands/folders/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/get.js)_ +_See code: [src/commands/folders/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/get.js)_ ## `box folders:items ID` @@ -342,7 +342,7 @@ EXAMPLE box folders:items 22222 ``` -_See code: [src/commands/folders/items.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/items.js)_ +_See code: [src/commands/folders/items.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/items.js)_ ## `box folders:locks ID` @@ -377,7 +377,7 @@ EXAMPLE box folders:locks 22222 ``` -_See code: [src/commands/folders/locks/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/locks/index.js)_ +_See code: [src/commands/folders/locks/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/locks/index.js)_ ## `box folders:locks:create ID` @@ -409,7 +409,7 @@ EXAMPLE box folders:locks:create 22222 ``` -_See code: [src/commands/folders/locks/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/locks/create.js)_ +_See code: [src/commands/folders/locks/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/locks/create.js)_ ## `box folders:locks:delete ID` @@ -441,7 +441,7 @@ EXAMPLE box folders:locks:delete 22222 ``` -_See code: [src/commands/folders/locks/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/locks/delete.js)_ +_See code: [src/commands/folders/locks/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/locks/delete.js)_ ## `box folders:metadata ID` @@ -476,7 +476,7 @@ EXAMPLE box folders:metadata 22222 ``` -_See code: [src/commands/folders/metadata/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/index.js)_ +_See code: [src/commands/folders/metadata/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/index.js)_ ## `box folders:metadata:add ID` @@ -522,7 +522,7 @@ EXAMPLE box folders:metadata:add 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales ``` -_See code: [src/commands/folders/metadata/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/add.js)_ +_See code: [src/commands/folders/metadata/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/add.js)_ ## `box folders:metadata:get ID` @@ -556,7 +556,7 @@ EXAMPLE box folders:metadata:get 22222 --template-key employeeRecord ``` -_See code: [src/commands/folders/metadata/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/get.js)_ +_See code: [src/commands/folders/metadata/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/get.js)_ ## `box folders:metadata:remove ID` @@ -593,7 +593,7 @@ EXAMPLE box folders:metadata:remove 22222 --scope global --template-key properties ``` -_See code: [src/commands/folders/metadata/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/remove.js)_ +_See code: [src/commands/folders/metadata/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/remove.js)_ ## `box folders:metadata:set ID` @@ -636,7 +636,7 @@ EXAMPLE box folders:metadata:set 22222 --template-key employeeRecord --data "name=John Doe" --data department=Sales ``` -_See code: [src/commands/folders/metadata/set.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/set.js)_ +_See code: [src/commands/folders/metadata/set.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/set.js)_ ## `box folders:metadata:update ID` @@ -699,7 +699,7 @@ EXAMPLE box folders:metadata:update 22222 --template-key employeeRecord --replace department=Finance ``` -_See code: [src/commands/folders/metadata/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/metadata/update.js)_ +_See code: [src/commands/folders/metadata/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/metadata/update.js)_ ## `box folders:move ID PARENTID` @@ -733,7 +733,7 @@ EXAMPLE box folders:move 22222 44444 ``` -_See code: [src/commands/folders/move.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/move.js)_ +_See code: [src/commands/folders/move.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/move.js)_ ## `box folders:rename ID NAME` @@ -768,7 +768,7 @@ EXAMPLE box folders:rename 22222 "New Folder Name" ``` -_See code: [src/commands/folders/rename.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/rename.js)_ +_See code: [src/commands/folders/rename.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/rename.js)_ ## `box folders:share ID` @@ -811,7 +811,7 @@ EXAMPLE box folders:share 22222 --access company ``` -_See code: [src/commands/folders/share.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/share.js)_ +_See code: [src/commands/folders/share.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/share.js)_ ## `box folders:unshare ID` @@ -846,7 +846,7 @@ EXAMPLE box folders:unshare 22222 ``` -_See code: [src/commands/folders/unshare.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/unshare.js)_ +_See code: [src/commands/folders/unshare.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/unshare.js)_ ## `box folders:update ID` @@ -892,7 +892,7 @@ EXAMPLE box folders:update 22222 --name "New Folder Name" ``` -_See code: [src/commands/folders/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/update.js)_ +_See code: [src/commands/folders/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/update.js)_ ## `box folders:upload PATH` @@ -927,4 +927,4 @@ EXAMPLE box folders:upload /path/to/folder ``` -_See code: [src/commands/folders/upload.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/folders/upload.js)_ +_See code: [src/commands/folders/upload.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/folders/upload.js)_ diff --git a/docs/groups.md b/docs/groups.md index 34448513..ef87d431 100644 --- a/docs/groups.md +++ b/docs/groups.md @@ -46,7 +46,7 @@ EXAMPLE box groups ``` -_See code: [src/commands/groups/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/index.js)_ +_See code: [src/commands/groups/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/index.js)_ ## `box groups:collaborations ID` @@ -82,7 +82,7 @@ EXAMPLE box groups:collaborations 12345 ``` -_See code: [src/commands/groups/collaborations.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/collaborations.js)_ +_See code: [src/commands/groups/collaborations.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/collaborations.js)_ ## `box groups:create NAME` @@ -137,7 +137,7 @@ EXAMPLE box groups:create "US Employees" ``` -_See code: [src/commands/groups/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/create.js)_ +_See code: [src/commands/groups/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/create.js)_ ## `box groups:delete ID` @@ -169,7 +169,7 @@ EXAMPLE box groups:delete 12345 ``` -_See code: [src/commands/groups/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/delete.js)_ +_See code: [src/commands/groups/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/delete.js)_ ## `box groups:get ID` @@ -201,7 +201,7 @@ EXAMPLE box groups:get 12345 ``` -_See code: [src/commands/groups/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/get.js)_ +_See code: [src/commands/groups/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/get.js)_ ## `box groups:memberships ID` @@ -236,7 +236,7 @@ EXAMPLE box groups:memberships 12345 ``` -_See code: [src/commands/groups/memberships/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/memberships/index.js)_ +_See code: [src/commands/groups/memberships/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/memberships/index.js)_ ## `box groups:memberships:add USERID GROUPID` @@ -277,7 +277,7 @@ EXAMPLE box groups:memberships:add 33333 12345 ``` -_See code: [src/commands/groups/memberships/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/memberships/add.js)_ +_See code: [src/commands/groups/memberships/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/memberships/add.js)_ ## `box groups:memberships:get ID` @@ -312,7 +312,7 @@ EXAMPLE box groups:memberships:get 12345 ``` -_See code: [src/commands/groups/memberships/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/memberships/get.js)_ +_See code: [src/commands/groups/memberships/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/memberships/get.js)_ ## `box groups:memberships:remove ID` @@ -347,7 +347,7 @@ EXAMPLE box groups:memberships:remove 12345 ``` -_See code: [src/commands/groups/memberships/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/memberships/remove.js)_ +_See code: [src/commands/groups/memberships/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/memberships/remove.js)_ ## `box groups:memberships:update ID` @@ -387,7 +387,7 @@ EXAMPLE box groups:memberships:update ``` -_See code: [src/commands/groups/memberships/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/memberships/update.js)_ +_See code: [src/commands/groups/memberships/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/memberships/update.js)_ ## `box groups:update ID` @@ -441,4 +441,4 @@ EXAMPLE box groups:update 12345 --name "U.S. Employees" ``` -_See code: [src/commands/groups/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/groups/update.js)_ +_See code: [src/commands/groups/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/groups/update.js)_ diff --git a/docs/legal-hold-policies.md b/docs/legal-hold-policies.md index a2785952..bbafd214 100644 --- a/docs/legal-hold-policies.md +++ b/docs/legal-hold-policies.md @@ -43,7 +43,7 @@ EXAMPLE box legal-hold-policies ``` -_See code: [src/commands/legal-hold-policies/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/index.js)_ +_See code: [src/commands/legal-hold-policies/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/index.js)_ ## `box legal-hold-policies:assign POLICYID` @@ -77,7 +77,7 @@ EXAMPLE box legal-hold-policies:assign 99999 --assign-to-type folder --assign-to-id 22222 ``` -_See code: [src/commands/legal-hold-policies/assign.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/assign.js)_ +_See code: [src/commands/legal-hold-policies/assign.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/assign.js)_ ## `box legal-hold-policies:assignments ID` @@ -111,7 +111,7 @@ EXAMPLE box legal-hold-policies:assignments 99999 ``` -_See code: [src/commands/legal-hold-policies/assignments/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/assignments/index.js)_ +_See code: [src/commands/legal-hold-policies/assignments/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/assignments/index.js)_ ## `box legal-hold-policies:assignments:delete ID` @@ -143,7 +143,7 @@ EXAMPLE box legal-hold-policies:assignments:delete 99999 ``` -_See code: [src/commands/legal-hold-policies/assignments/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/assignments/delete.js)_ +_See code: [src/commands/legal-hold-policies/assignments/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/assignments/delete.js)_ ## `box legal-hold-policies:assignments:get ID` @@ -175,7 +175,7 @@ EXAMPLE box legal-hold-policies:assignments:get 99999 ``` -_See code: [src/commands/legal-hold-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/assignments/get.js)_ +_See code: [src/commands/legal-hold-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/assignments/get.js)_ ## `box legal-hold-policies:create POLICYNAME` @@ -222,7 +222,7 @@ EXAMPLE box legal-hold-policies:create "Class Action Suit" --ongoing ``` -_See code: [src/commands/legal-hold-policies/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/create.js)_ +_See code: [src/commands/legal-hold-policies/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/create.js)_ ## `box legal-hold-policies:delete ID` @@ -254,7 +254,7 @@ EXAMPLE box legal-hold-policies:delete 99999 ``` -_See code: [src/commands/legal-hold-policies/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/delete.js)_ +_See code: [src/commands/legal-hold-policies/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/delete.js)_ ## `box legal-hold-policies:file-version-holds ID` @@ -286,7 +286,7 @@ EXAMPLE box legal-hold-policies:file-version-holds 99999 ``` -_See code: [src/commands/legal-hold-policies/file-version-holds/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/file-version-holds/index.js)_ +_See code: [src/commands/legal-hold-policies/file-version-holds/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/file-version-holds/index.js)_ ## `box legal-hold-policies:file-version-holds:get ID` @@ -318,7 +318,7 @@ EXAMPLE box legal-hold-policies:file-version-holds:get 12345 ``` -_See code: [src/commands/legal-hold-policies/file-version-holds/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/file-version-holds/get.js)_ +_See code: [src/commands/legal-hold-policies/file-version-holds/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/file-version-holds/get.js)_ ## `box legal-hold-policies:get ID` @@ -350,7 +350,7 @@ EXAMPLE box legal-hold-policies:get 99999 ``` -_See code: [src/commands/legal-hold-policies/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/get.js)_ +_See code: [src/commands/legal-hold-policies/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/get.js)_ ## `box legal-hold-policies:update ID` @@ -385,4 +385,4 @@ EXAMPLE box legal-hold-policies:update 99999 --description "Files related to the ongoing class action suit" ``` -_See code: [src/commands/legal-hold-policies/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/legal-hold-policies/update.js)_ +_See code: [src/commands/legal-hold-policies/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/legal-hold-policies/update.js)_ diff --git a/docs/login.md b/docs/login.md index 42b8047b..503c8413 100644 --- a/docs/login.md +++ b/docs/login.md @@ -23,4 +23,4 @@ OPTIONS --no-color Turn off colors for logging ``` -_See code: [src/commands/login.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/login.js)_ +_See code: [src/commands/login.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/login.js)_ diff --git a/docs/metadata-cascade-policies.md b/docs/metadata-cascade-policies.md index 1a13f74a..7255021a 100644 --- a/docs/metadata-cascade-policies.md +++ b/docs/metadata-cascade-policies.md @@ -39,7 +39,7 @@ EXAMPLE box metadata-cascade-policies 22222 ``` -_See code: [src/commands/metadata-cascade-policies/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-cascade-policies/index.js)_ +_See code: [src/commands/metadata-cascade-policies/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-cascade-policies/index.js)_ ## `box metadata-cascade-policies:delete ID` @@ -71,7 +71,7 @@ EXAMPLE box metadata-cascade-policies:delete 12345 ``` -_See code: [src/commands/metadata-cascade-policies/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-cascade-policies/delete.js)_ +_See code: [src/commands/metadata-cascade-policies/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-cascade-policies/delete.js)_ ## `box metadata-cascade-policies:force-apply ID` @@ -104,7 +104,7 @@ EXAMPLE box metadata-cascade-policies:force-apply 12345 --conflict-resolution overwrite ``` -_See code: [src/commands/metadata-cascade-policies/force-apply.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-cascade-policies/force-apply.js)_ +_See code: [src/commands/metadata-cascade-policies/force-apply.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-cascade-policies/force-apply.js)_ ## `box metadata-cascade-policies:get ID` @@ -136,4 +136,4 @@ EXAMPLE box metadata-cascade-policies:get 12345 ``` -_See code: [src/commands/metadata-cascade-policies/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-cascade-policies/get.js)_ +_See code: [src/commands/metadata-cascade-policies/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-cascade-policies/get.js)_ diff --git a/docs/metadata-query.md b/docs/metadata-query.md index 109ac899..c88221e0 100644 --- a/docs/metadata-query.md +++ b/docs/metadata-query.md @@ -55,4 +55,4 @@ EXAMPLE created_at,metadata.enterprise_1234.contracts ``` -_See code: [src/commands/metadata-query.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-query.js)_ +_See code: [src/commands/metadata-query.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-query.js)_ diff --git a/docs/metadata-templates.md b/docs/metadata-templates.md index 6fdcdbe3..11bb660c 100644 --- a/docs/metadata-templates.md +++ b/docs/metadata-templates.md @@ -40,7 +40,7 @@ EXAMPLE box metadata-templates ``` -_See code: [src/commands/metadata-templates/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/index.js)_ +_See code: [src/commands/metadata-templates/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/index.js)_ ## `box metadata-templates:cascade TEMPLATEKEY` @@ -75,7 +75,7 @@ EXAMPLE box metadata-templates:cascade employeeRecord --folder 22222 ``` -_See code: [src/commands/metadata-templates/cascade.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/cascade.js)_ +_See code: [src/commands/metadata-templates/cascade.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/cascade.js)_ ## `box metadata-templates:create` @@ -120,7 +120,7 @@ EXAMPLE box metadata-templates:create --display-name "Employee Record" --string Name --enum Department --option Sales ``` -_See code: [src/commands/metadata-templates/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/create.js)_ +_See code: [src/commands/metadata-templates/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/create.js)_ ## `box metadata-templates:delete TEMPLATEKEY` @@ -153,7 +153,7 @@ EXAMPLE box metadata-templates:delete employeeRecord ``` -_See code: [src/commands/metadata-templates/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/delete.js)_ +_See code: [src/commands/metadata-templates/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/delete.js)_ ## `box metadata-templates:get TEMPLATEKEY` @@ -186,7 +186,7 @@ EXAMPLE box metadata-templates:get employeeRecord ``` -_See code: [src/commands/metadata-templates/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/get.js)_ +_See code: [src/commands/metadata-templates/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/get.js)_ ## `box metadata-templates:update TEMPLATEKEY` @@ -272,4 +272,4 @@ EXAMPLE box metadata-templates:update employeeRecord --hidden ``` -_See code: [src/commands/metadata-templates/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/metadata-templates/update.js)_ +_See code: [src/commands/metadata-templates/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/metadata-templates/update.js)_ diff --git a/docs/oss.md b/docs/oss.md index c0bac7af..e78d88d7 100644 --- a/docs/oss.md +++ b/docs/oss.md @@ -20,4 +20,4 @@ OPTIONS --no-color Turn off colors for logging ``` -_See code: [src/commands/oss.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/oss.js)_ +_See code: [src/commands/oss.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/oss.js)_ diff --git a/docs/recent-items.md b/docs/recent-items.md index 82f264b0..0ca4be72 100644 --- a/docs/recent-items.md +++ b/docs/recent-items.md @@ -32,4 +32,4 @@ EXAMPLE box recent-items ``` -_See code: [src/commands/recent-items.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/recent-items.js)_ +_See code: [src/commands/recent-items.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/recent-items.js)_ diff --git a/docs/request.md b/docs/request.md index cefd1b67..d8a854a5 100644 --- a/docs/request.md +++ b/docs/request.md @@ -36,4 +36,4 @@ OPTIONS --save-to-file-path=save-to-file-path Override default file path to save report ``` -_See code: [src/commands/request.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/request.js)_ +_See code: [src/commands/request.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/request.js)_ diff --git a/docs/retention-policies.md b/docs/retention-policies.md index b3f284a7..2c696df5 100644 --- a/docs/retention-policies.md +++ b/docs/retention-policies.md @@ -46,7 +46,7 @@ EXAMPLE box retention-policies ``` -_See code: [src/commands/retention-policies/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/index.js)_ +_See code: [src/commands/retention-policies/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/index.js)_ ## `box retention-policies:assign POLICYID` @@ -88,7 +88,7 @@ EXAMPLE box retention-policies:assign 12345 --assign-to-type folder --assign-to-id 22222 ``` -_See code: [src/commands/retention-policies/assign.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/assign.js)_ +_See code: [src/commands/retention-policies/assign.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/assign.js)_ ## `box retention-policies:assignments ID` @@ -121,7 +121,7 @@ EXAMPLE box retention-policies:assignments 12345 ``` -_See code: [src/commands/retention-policies/assignments/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/assignments/index.js)_ +_See code: [src/commands/retention-policies/assignments/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/assignments/index.js)_ ## `box retention-policies:assignments:get ID` @@ -153,7 +153,7 @@ EXAMPLE box retention-policies:assignments:get 1235 ``` -_See code: [src/commands/retention-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/assignments/get.js)_ +_See code: [src/commands/retention-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/assignments/get.js)_ ## `box retention-policies:assignments:remove ID` @@ -185,7 +185,7 @@ EXAMPLE box retention-policies:assignments:remove 1235 ``` -_See code: [src/commands/retention-policies/assignments/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/assignments/remove.js)_ +_See code: [src/commands/retention-policies/assignments/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/assignments/remove.js)_ ## `box retention-policies:create POLICYNAME` @@ -243,7 +243,7 @@ EXAMPLE --disposition-action permanently_delete ``` -_See code: [src/commands/retention-policies/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/create.js)_ +_See code: [src/commands/retention-policies/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/create.js)_ ## `box retention-policies:file-version-retentions` @@ -289,7 +289,7 @@ EXAMPLE box retention-policies:file-version-retentions ``` -_See code: [src/commands/retention-policies/file-version-retentions/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/file-version-retentions/index.js)_ +_See code: [src/commands/retention-policies/file-version-retentions/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/file-version-retentions/index.js)_ ## `box retention-policies:file-version-retentions:get ID` @@ -321,7 +321,7 @@ EXAMPLE box retention-policies:file-version-retentions:get 77777 ``` -_See code: [src/commands/retention-policies/file-version-retentions/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/file-version-retentions/get.js)_ +_See code: [src/commands/retention-policies/file-version-retentions/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/file-version-retentions/get.js)_ ## `box retention-policies:file-versions-under-retention:get ID` @@ -353,7 +353,7 @@ EXAMPLE box retention-policies:file-versions-under-retention:get 77777 ``` -_See code: [src/commands/retention-policies/file-versions-under-retention/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/file-versions-under-retention/get.js)_ +_See code: [src/commands/retention-policies/file-versions-under-retention/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/file-versions-under-retention/get.js)_ ## `box retention-policies:files-under-retention:get ID` @@ -385,7 +385,7 @@ EXAMPLE box retention-policies:files-under-retention:get 77777 ``` -_See code: [src/commands/retention-policies/files-under-retention/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/files-under-retention/get.js)_ +_See code: [src/commands/retention-policies/files-under-retention/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/files-under-retention/get.js)_ ## `box retention-policies:get ID` @@ -417,7 +417,7 @@ EXAMPLE box retention-policies:get 12345 ``` -_See code: [src/commands/retention-policies/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/get.js)_ +_See code: [src/commands/retention-policies/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/get.js)_ ## `box retention-policies:update ID` @@ -477,4 +477,4 @@ EXAMPLE box retention-policies:update 12345 ``` -_See code: [src/commands/retention-policies/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/retention-policies/update.js)_ +_See code: [src/commands/retention-policies/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/retention-policies/update.js)_ diff --git a/docs/search.md b/docs/search.md index 99e475e7..613a70ad 100644 --- a/docs/search.md +++ b/docs/search.md @@ -88,4 +88,4 @@ EXAMPLES box search --mdfilter "enterprise.employeeRecord.name=John Doe" ``` -_See code: [src/commands/search.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/search.js)_ +_See code: [src/commands/search.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/search.js)_ diff --git a/docs/shared-links.md b/docs/shared-links.md index 5bd8023d..0c9d083d 100644 --- a/docs/shared-links.md +++ b/docs/shared-links.md @@ -49,7 +49,7 @@ EXAMPLE box shared-links:create 22222 folder --access company ``` -_See code: [src/commands/shared-links/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/shared-links/create.js)_ +_See code: [src/commands/shared-links/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/shared-links/create.js)_ ## `box shared-links:delete ITEMID ITEMTYPE` @@ -82,7 +82,7 @@ EXAMPLE box shared-links:delete 22222 folder ``` -_See code: [src/commands/shared-links/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/shared-links/delete.js)_ +_See code: [src/commands/shared-links/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/shared-links/delete.js)_ ## `box shared-links:get URL` @@ -115,4 +115,4 @@ EXAMPLE box shared-links:get https://app.box.com/s/13ynxiqe3y4tup3j0yn4qairs5ebfxo3 ``` -_See code: [src/commands/shared-links/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/shared-links/get.js)_ +_See code: [src/commands/shared-links/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/shared-links/get.js)_ diff --git a/docs/sign-requests.md b/docs/sign-requests.md index 1775f542..151300fb 100644 --- a/docs/sign-requests.md +++ b/docs/sign-requests.md @@ -43,7 +43,7 @@ EXAMPLE box sign-requests ``` -_See code: [src/commands/sign-requests/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/sign-requests/index.js)_ +_See code: [src/commands/sign-requests/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/sign-requests/index.js)_ ## `box sign-requests:cancel ID` @@ -75,7 +75,7 @@ EXAMPLE box sign-requests:cancel 12345 ``` -_See code: [src/commands/sign-requests/cancel.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/sign-requests/cancel.js)_ +_See code: [src/commands/sign-requests/cancel.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/sign-requests/cancel.js)_ ## `box sign-requests:create` @@ -182,7 +182,7 @@ EXAMPLE id=1,value=Test ``` -_See code: [src/commands/sign-requests/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/sign-requests/create.js)_ +_See code: [src/commands/sign-requests/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/sign-requests/create.js)_ ## `box sign-requests:get ID` @@ -214,7 +214,7 @@ EXAMPLE box sign-requests:get 12345 ``` -_See code: [src/commands/sign-requests/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/sign-requests/get.js)_ +_See code: [src/commands/sign-requests/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/sign-requests/get.js)_ ## `box sign-requests:resend ID` @@ -246,4 +246,4 @@ EXAMPLE box sign-requests:resend 12345 ``` -_See code: [src/commands/sign-requests/resend.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/sign-requests/resend.js)_ +_See code: [src/commands/sign-requests/resend.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/sign-requests/resend.js)_ diff --git a/docs/storage-policies.md b/docs/storage-policies.md index 8b3b5bbf..e5d82503 100644 --- a/docs/storage-policies.md +++ b/docs/storage-policies.md @@ -40,7 +40,7 @@ EXAMPLE box storage-policies ``` -_See code: [src/commands/storage-policies/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/index.js)_ +_See code: [src/commands/storage-policies/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/index.js)_ ## `box storage-policies:assign STORAGEPOLICYID USERID` @@ -73,7 +73,7 @@ EXAMPLE box storage-policies:assign 12345 33333 ``` -_See code: [src/commands/storage-policies/assign.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/assign.js)_ +_See code: [src/commands/storage-policies/assign.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/assign.js)_ ## `box storage-policies:assignments:get ID` @@ -105,7 +105,7 @@ EXAMPLE box storage-policies:assignments:get 12345 ``` -_See code: [src/commands/storage-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/assignments/get.js)_ +_See code: [src/commands/storage-policies/assignments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/assignments/get.js)_ ## `box storage-policies:assignments:lookup ID` @@ -138,7 +138,7 @@ EXAMPLE box storage-policies:assignments:lookup 33333 ``` -_See code: [src/commands/storage-policies/assignments/lookup.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/assignments/lookup.js)_ +_See code: [src/commands/storage-policies/assignments/lookup.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/assignments/lookup.js)_ ## `box storage-policies:assignments:remove ID` @@ -170,7 +170,7 @@ EXAMPLE box storage-policies:assignments:remove 12345 ``` -_See code: [src/commands/storage-policies/assignments/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/assignments/remove.js)_ +_See code: [src/commands/storage-policies/assignments/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/assignments/remove.js)_ ## `box storage-policies:get ID` @@ -202,4 +202,4 @@ EXAMPLE box storage-policies:get 12345 ``` -_See code: [src/commands/storage-policies/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/storage-policies/get.js)_ +_See code: [src/commands/storage-policies/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/storage-policies/get.js)_ diff --git a/docs/tasks.md b/docs/tasks.md index d74c621c..afdf17ff 100644 --- a/docs/tasks.md +++ b/docs/tasks.md @@ -48,7 +48,7 @@ EXAMPLE box tasks:assign 88888 --assign-to-user-id 33333 ``` -_See code: [src/commands/tasks/assign.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/assign.js)_ +_See code: [src/commands/tasks/assign.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/assign.js)_ ## `box tasks:assignments ID` @@ -83,7 +83,7 @@ EXAMPLE box tasks:assignments 88888 ``` -_See code: [src/commands/tasks/assignments/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/assignments/index.js)_ +_See code: [src/commands/tasks/assignments/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/assignments/index.js)_ ## `box tasks:assignments:delete ID` @@ -118,7 +118,7 @@ EXAMPLE box tasks:assignments:delete 12345 ``` -_See code: [src/commands/tasks/assignments/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/assignments/delete.js)_ +_See code: [src/commands/tasks/assignments/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/assignments/delete.js)_ ## `box tasks:assignments:get ID` @@ -153,7 +153,7 @@ EXAMPLE box tasks:assignments:get 12345 ``` -_See code: [src/commands/tasks/assignments/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/assignments/get.js)_ +_See code: [src/commands/tasks/assignments/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/assignments/get.js)_ ## `box tasks:assignments:update ID` @@ -190,7 +190,7 @@ EXAMPLE box tasks:assignments:update 12345 --status approved ``` -_See code: [src/commands/tasks/assignments/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/assignments/update.js)_ +_See code: [src/commands/tasks/assignments/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/assignments/update.js)_ ## `box tasks:create FILEID` @@ -236,7 +236,7 @@ EXAMPLE box tasks:create 11111 --message "Please proofread this document" ``` -_See code: [src/commands/tasks/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/create.js)_ +_See code: [src/commands/tasks/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/create.js)_ ## `box tasks:delete ID` @@ -268,7 +268,7 @@ EXAMPLE box tasks:delete 88888 ``` -_See code: [src/commands/tasks/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/delete.js)_ +_See code: [src/commands/tasks/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/delete.js)_ ## `box tasks:get ID` @@ -300,7 +300,7 @@ EXAMPLE box tasks:get 88888 ``` -_See code: [src/commands/tasks/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/get.js)_ +_See code: [src/commands/tasks/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/get.js)_ ## `box tasks:update ID` @@ -344,4 +344,4 @@ EXAMPLE box tasks:update 88888 --due-at 1w ``` -_See code: [src/commands/tasks/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tasks/update.js)_ +_See code: [src/commands/tasks/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tasks/update.js)_ diff --git a/docs/terms-of-service.md b/docs/terms-of-service.md index db6dc48e..84240d0d 100644 --- a/docs/terms-of-service.md +++ b/docs/terms-of-service.md @@ -38,7 +38,7 @@ EXAMPLE box terms-of-service ``` -_See code: [src/commands/terms-of-service/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/index.js)_ +_See code: [src/commands/terms-of-service/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/index.js)_ ## `box terms-of-service:create` @@ -70,7 +70,7 @@ EXAMPLE box terms-of-service:create --type external --status enabled --text "By using this service, you agree to...." ``` -_See code: [src/commands/terms-of-service/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/create.js)_ +_See code: [src/commands/terms-of-service/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/create.js)_ ## `box terms-of-service:get ID` @@ -102,7 +102,7 @@ EXAMPLE box terms-of-service:get 55555 ``` -_See code: [src/commands/terms-of-service/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/get.js)_ +_See code: [src/commands/terms-of-service/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/get.js)_ ## `box terms-of-service:get-user-status TOSID` @@ -135,7 +135,7 @@ EXAMPLE box terms-of-service:get-user-status 55555 ``` -_See code: [src/commands/terms-of-service/get-user-status.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/get-user-status.js)_ +_See code: [src/commands/terms-of-service/get-user-status.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/get-user-status.js)_ ## `box terms-of-service:set-user-status ID` @@ -170,7 +170,7 @@ EXAMPLE box terms-of-service:set-user-status 55555 --accept ``` -_See code: [src/commands/terms-of-service/set-user-status.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/set-user-status.js)_ +_See code: [src/commands/terms-of-service/set-user-status.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/set-user-status.js)_ ## `box terms-of-service:update ID` @@ -204,4 +204,4 @@ EXAMPLE box terms-of-service:update 55555 --status disabled ``` -_See code: [src/commands/terms-of-service/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/terms-of-service/update.js)_ +_See code: [src/commands/terms-of-service/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/terms-of-service/update.js)_ diff --git a/docs/tokens.md b/docs/tokens.md index c1dc2320..838a6930 100644 --- a/docs/tokens.md +++ b/docs/tokens.md @@ -29,7 +29,7 @@ OPTIONS --no-color Turn off colors for logging ``` -_See code: [src/commands/tokens/exchange.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tokens/exchange.js)_ +_See code: [src/commands/tokens/exchange.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tokens/exchange.js)_ ## `box tokens:get` @@ -47,7 +47,7 @@ OPTIONS --no-color Turn off colors for logging ``` -_See code: [src/commands/tokens/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tokens/get.js)_ +_See code: [src/commands/tokens/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tokens/get.js)_ ## `box tokens:revoke TOKEN` @@ -67,4 +67,4 @@ OPTIONS --no-color Turn off colors for logging ``` -_See code: [src/commands/tokens/revoke.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/tokens/revoke.js)_ +_See code: [src/commands/tokens/revoke.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/tokens/revoke.js)_ diff --git a/docs/trash.md b/docs/trash.md index 5bce049e..b6a3cfa6 100644 --- a/docs/trash.md +++ b/docs/trash.md @@ -38,7 +38,7 @@ EXAMPLE box trash ``` -_See code: [src/commands/trash/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/trash/index.js)_ +_See code: [src/commands/trash/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/trash/index.js)_ ## `box trash:delete TYPE ID` @@ -71,7 +71,7 @@ EXAMPLE box trash:delete folder 22222 ``` -_See code: [src/commands/trash/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/trash/delete.js)_ +_See code: [src/commands/trash/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/trash/delete.js)_ ## `box trash:get TYPE ID` @@ -104,7 +104,7 @@ EXAMPLE box trash:get folder 22222 ``` -_See code: [src/commands/trash/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/trash/get.js)_ +_See code: [src/commands/trash/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/trash/get.js)_ ## `box trash:restore TYPE ID` @@ -142,4 +142,4 @@ EXAMPLE box trash:restore folder 22222 ``` -_See code: [src/commands/trash/restore.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/trash/restore.js)_ +_See code: [src/commands/trash/restore.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/trash/restore.js)_ diff --git a/docs/users.md b/docs/users.md index 3f18e92a..72bed82d 100644 --- a/docs/users.md +++ b/docs/users.md @@ -51,7 +51,7 @@ EXAMPLE box users ``` -_See code: [src/commands/users/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/index.js)_ +_See code: [src/commands/users/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/index.js)_ ## `box users:create NAME [LOGIN]` @@ -138,7 +138,7 @@ EXAMPLE box users:create "John Doe" jdoe@example.com ``` -_See code: [src/commands/users/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/create.js)_ +_See code: [src/commands/users/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/create.js)_ ## `box users:delete ID` @@ -172,7 +172,7 @@ EXAMPLE box users:delete 33333 ``` -_See code: [src/commands/users/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/delete.js)_ +_See code: [src/commands/users/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/delete.js)_ ## `box users:email-aliases USERID` @@ -207,7 +207,7 @@ EXAMPLE box users:email-aliases 33333 ``` -_See code: [src/commands/users/email-aliases/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/email-aliases/index.js)_ +_See code: [src/commands/users/email-aliases/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/email-aliases/index.js)_ ## `box users:email-aliases:add USERID EMAIL` @@ -251,7 +251,7 @@ EXAMPLE box users:email-aliases:add 33333 user+alias@example.com ``` -_See code: [src/commands/users/email-aliases/add.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/email-aliases/add.js)_ +_See code: [src/commands/users/email-aliases/add.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/email-aliases/add.js)_ ## `box users:email-aliases:remove USERID ALIASID` @@ -287,7 +287,7 @@ EXAMPLE box users:email-aliases:remove 33333 12345 ``` -_See code: [src/commands/users/email-aliases/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/email-aliases/remove.js)_ +_See code: [src/commands/users/email-aliases/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/email-aliases/remove.js)_ ## `box users:get [ID]` @@ -319,7 +319,7 @@ EXAMPLE box users:get 33333 ``` -_See code: [src/commands/users/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/get.js)_ +_See code: [src/commands/users/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/get.js)_ ## `box users:groups ID` @@ -354,7 +354,7 @@ EXAMPLE box users:groups 33333 ``` -_See code: [src/commands/users/groups.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/groups.js)_ +_See code: [src/commands/users/groups.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/groups.js)_ ## `box users:invite EMAIL ENTERPRISEID` @@ -390,7 +390,7 @@ EXAMPLE box users:invite user@example.com 12345 ``` -_See code: [src/commands/users/invite.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/invite.js)_ +_See code: [src/commands/users/invite.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/invite.js)_ ## `box users:search NAME` @@ -425,7 +425,7 @@ EXAMPLE box users:search "John Doe" ``` -_See code: [src/commands/users/search.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/search.js)_ +_See code: [src/commands/users/search.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/search.js)_ ## `box users:transfer-content USERID NEWUSERID` @@ -462,7 +462,7 @@ EXAMPLE box users:transfer-content 33333 44444 ``` -_See code: [src/commands/users/transfer-content.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/transfer-content.js)_ +_See code: [src/commands/users/transfer-content.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/transfer-content.js)_ ## `box users:update ID` @@ -554,4 +554,4 @@ EXAMPLE box users:update 33333 --status inactive ``` -_See code: [src/commands/users/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/users/update.js)_ +_See code: [src/commands/users/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/users/update.js)_ diff --git a/docs/watermarking.md b/docs/watermarking.md index 284e2538..a7f2e686 100644 --- a/docs/watermarking.md +++ b/docs/watermarking.md @@ -38,7 +38,7 @@ EXAMPLE box watermarking:apply folder 22222 ``` -_See code: [src/commands/watermarking/apply.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/watermarking/apply.js)_ +_See code: [src/commands/watermarking/apply.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/watermarking/apply.js)_ ## `box watermarking:get ITEMTYPE ITEMID` @@ -71,7 +71,7 @@ EXAMPLE box watermarking:get folder 22222 ``` -_See code: [src/commands/watermarking/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/watermarking/get.js)_ +_See code: [src/commands/watermarking/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/watermarking/get.js)_ ## `box watermarking:remove ITEMTYPE ITEMID` @@ -104,4 +104,4 @@ EXAMPLE box watermarking:remove folder 22222 ``` -_See code: [src/commands/watermarking/remove.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/watermarking/remove.js)_ +_See code: [src/commands/watermarking/remove.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/watermarking/remove.js)_ diff --git a/docs/web-links.md b/docs/web-links.md index 979731ee..9beef1fe 100644 --- a/docs/web-links.md +++ b/docs/web-links.md @@ -42,7 +42,7 @@ EXAMPLE box web-links:create http://example.com --parent-id 0 ``` -_See code: [src/commands/web-links/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/web-links/create.js)_ +_See code: [src/commands/web-links/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/web-links/create.js)_ ## `box web-links:delete ID` @@ -74,7 +74,7 @@ EXAMPLE box web-links:delete 12345 ``` -_See code: [src/commands/web-links/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/web-links/delete.js)_ +_See code: [src/commands/web-links/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/web-links/delete.js)_ ## `box web-links:get ID` @@ -106,7 +106,7 @@ EXAMPLE box web-links:get 12345 ``` -_See code: [src/commands/web-links/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/web-links/get.js)_ +_See code: [src/commands/web-links/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/web-links/get.js)_ ## `box web-links:move ID PARENTID` @@ -139,7 +139,7 @@ EXAMPLE box web-links:move 12345 22222 ``` -_See code: [src/commands/web-links/move.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/web-links/move.js)_ +_See code: [src/commands/web-links/move.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/web-links/move.js)_ ## `box web-links:update ID` @@ -174,4 +174,4 @@ EXAMPLE box web-links:update 12345 --name "Example Site" ``` -_See code: [src/commands/web-links/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/web-links/update.js)_ +_See code: [src/commands/web-links/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/web-links/update.js)_ diff --git a/docs/webhooks.md b/docs/webhooks.md index 4246101f..62425cff 100644 --- a/docs/webhooks.md +++ b/docs/webhooks.md @@ -39,7 +39,7 @@ EXAMPLE box webhooks ``` -_See code: [src/commands/webhooks/index.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/webhooks/index.js)_ +_See code: [src/commands/webhooks/index.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/webhooks/index.js)_ ## `box webhooks:create TARGETTYPE TARGETID` @@ -91,7 +91,7 @@ EXAMPLE box webhooks:create folder 22222 --triggers FILE.DELETED --address https://example.com/webhook/deletion ``` -_See code: [src/commands/webhooks/create.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/webhooks/create.js)_ +_See code: [src/commands/webhooks/create.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/webhooks/create.js)_ ## `box webhooks:delete ID` @@ -123,7 +123,7 @@ EXAMPLE box webhooks:delete 12345 ``` -_See code: [src/commands/webhooks/delete.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/webhooks/delete.js)_ +_See code: [src/commands/webhooks/delete.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/webhooks/delete.js)_ ## `box webhooks:get ID` @@ -155,7 +155,7 @@ EXAMPLE box webhooks:get 12345 ``` -_See code: [src/commands/webhooks/get.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/webhooks/get.js)_ +_See code: [src/commands/webhooks/get.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/webhooks/get.js)_ ## `box webhooks:update ID` @@ -204,4 +204,4 @@ EXAMPLE box webhooks:update 12345 --triggers FILE.DELETED,FOLDER.DELETED ``` -_See code: [src/commands/webhooks/update.js](https://github.com/box/boxcli/blob/v3.5.0/src/commands/webhooks/update.js)_ +_See code: [src/commands/webhooks/update.js](https://github.com/box/boxcli/blob/v3.6.0/src/commands/webhooks/update.js)_ From 3b23335061a5715acd4fd8a3f8733b78a5aa5107 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Tue, 22 Nov 2022 17:00:05 +0100 Subject: [PATCH 3/7] docs: Add documentation upgrade to version 3.6.0 (#434) --- UPGRADE.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 UPGRADE.md diff --git a/UPGRADE.md b/UPGRADE.md new file mode 100644 index 00000000..d29bc5cb --- /dev/null +++ b/UPGRADE.md @@ -0,0 +1,62 @@ +# Upgrade + +## Version 3.5.0 to 3.6.0 + +Make sure you are on the latest version 3.5.0. +In version 3.6.0, we introduced a change in response in theese following command: + +- `box files:share` +- `box files:shared-links:create` +- `box files:shared-links:update` +- `box folders:share` +- `box folders:shared-links:create` +- `box folders:shared-links:update` +- `box shared-links:create` + +The response will now return a `file` or `folder` object with `shared_link` property instead of a `shared_link` object. + +**Before:** +```json +{ + "url": "https://blosserdemoaccount.box.com/s/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p", + "download_url": "https://blosserdemoaccount.box.com/shared/static/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p.png", + "vanity_url": null, + "effective_access": "open", + "is_password_enabled": true, + "unshared_at": null, + "download_count": 0, + "preview_count": 0, + "access": "test", + "permissions": { + "can_download": true, + "can_preview": true, + "can_edit": true + } +} +``` + +**After:** +```json +{ + "type": "file", + "id": "1234567890", + "shared_link": { + "url": "https://blosserdemoaccount.box.com/s/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p", + "download_url": "https://blosserdemoaccount.box.com/shared/static/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p.png", + "vanity_url": null, + "effective_access": "open", + "is_password_enabled": true, + "unshared_at": null, + "download_count": 0, + "preview_count": 0, + "access": "test", + "permissions": { + "can_download": true, + "can_preview": true, + "can_edit": true + } + } +} +``` + +Please check if you are using any of the commands above, then update the usage to avoid any breaks. \ No newline at end of file From 1a0e719087923fd5bffac7c7d5f6f87ed12dcef5 Mon Sep 17 00:00:00 2001 From: Mateusz Woda Date: Mon, 28 Nov 2022 11:25:28 +0100 Subject: [PATCH 4/7] docs: add authentication documentation (#431) Co-authored-by: Artur Jankowski --- docs/authentication.md | 105 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 docs/authentication.md diff --git a/docs/authentication.md b/docs/authentication.md new file mode 100644 index 00000000..3769723b --- /dev/null +++ b/docs/authentication.md @@ -0,0 +1,105 @@ +Authentication +============== + +See the [OAuth 2 overview](https://developer.box.com/en/guides/authentication/) for a detailed +overview of how the Box API handles authentication. + +- [Ways to Authenticate](#ways-to-authenticate) + - [Developer Token](#developer-token) + - [Server Auth with JWT](#server-auth-with-jwt) + - [Server Auth with CCG](#server-auth-with-ccg) + - [Traditional 3-Legged OAuth2](#traditional-3-legged-oauth2) + +Ways to Authenticate +-------------------- + +### Developer Token + +The fastest way to get started using the API is with developer tokens. A +developer token is simply a short-lived access token that cannot be refreshed +and can only be used with your own account. Therefore, they're only useful for +testing an app and aren't suitable for production. You can obtain a developer +token from your application's +[developer console][dev-console] page. + +You can pass dev token to any cli command by using `--token` flag + +```bash +box users:get --token myToken +``` + +[dev-console]: https://app.box.com/developers/console + +### Server Auth with JWT + +Server auth allows your application to authenticate itself with the Box API +for a given enterprise. By default, your application has a +[Service Account](https://developer.box.com/en/guides/authentication/user-types/) +that represents it and can perform API calls. The Service Account is separate +from the Box accounts of the application developer and the enterprise admin of +any enterprise that has authorized the app — files stored in that account are +not accessible in any other account by default, and vice versa. + +If you generated your public and private keys automatically through the +[Box Developer Console][dev-console], you can use the JSON file created there +to configure the SDK and create an environment to make calls as the +Service Account: + +```bash +box configure:environments:add /path/to/file/config.json +``` + +Remember to set your current environment to the proper one + +```bash +box configure:environments:set-current +``` + +### Server Auth with CCG + +Server auth allows your application to authenticate itself with the Box API +for a given enterprise. +Client Credentials Grant (CCG) allows you to authenticate by providing `clientId` and `clientSecret` and `enterpriseId` of your app. +By default, your application has a +[Service Account](https://developer.box.com/en/guides/authentication/user-types/) +that represents it and can perform API calls. The Service Account is separate +from the Box accounts of the application developer and the enterprise admin of +any enterprise that has authorized the app — files stored in that account are +not accessible in any other account by default, and vice versa. + +Adding a CCG environment is a similar process to adding a JWT environment. However, you must manually create a configuration file. +This file should contain `clientID`, `clientSecret` and `enterpriseId`. You can find this information in the [Box Developer Console][dev-console]. + +Example configuration file: + +```json +{ + "boxAppSettings": { + "clientID": "myClientId", + "clientSecret": "mySecret" + }, + "enterpriseID": "myEnterpriseId" +} +``` + +Then create a new environment with `--ccg-auth` flag and point it to the configuration file + +```bash +box configure:environments:add /path/to/file/config.json --ccg-auth +``` + +Remember to set your current environment to the proper one + +```bash +box configure:environments:set-current +``` + +An environment for making calls as an App User or Managed User can be created just like a Service Account environment. You need to pass an additional `--ccg-user` flag with `userId` as the value + +```bash +box configure:environments:add /path/to/file/config.json --ccg-auth --ccg-user "USER_ID" +``` + +### Traditional 3-Legged OAuth2 + +Refer to the [OAuth Guide](https://developer.box.com/guides/cli/quick-start) if you want to use OAuth2. From 61c3c80d1a6c8b4e2d412e4051df9b132bdbc352 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 7 Dec 2022 09:27:13 +0100 Subject: [PATCH 5/7] chore: Bump minimatch from 3.0.4 to 3.1.2 (#428) Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2. - [Release notes](https://github.com/isaacs/minimatch/releases) - [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2) --- updated-dependencies: - dependency-name: minimatch dependency-type: indirect ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Artur Jankowski --- package-lock.json | 62 +++-------------------------------------------- 1 file changed, 3 insertions(+), 59 deletions(-) diff --git a/package-lock.json b/package-lock.json index d71d438b..7713319f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3882,15 +3882,6 @@ "once": "^1.3.0", "path-is-absolute": "^1.0.0" } - }, - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } } } }, @@ -4495,15 +4486,6 @@ "path-is-absolute": "^1.0.0" } }, - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, "path-key": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", @@ -5484,9 +5466,9 @@ "dev": true }, "minimatch": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", - "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", + "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", "requires": { "brace-expansion": "^1.1.7" } @@ -6138,15 +6120,6 @@ "semver": "^6.0.0" } }, - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, "p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -7480,15 +7453,6 @@ "universalify": "^0.1.0" } }, - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, "ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -8100,15 +8064,6 @@ "semver": "^6.0.0" } }, - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, "rimraf": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", @@ -8584,17 +8539,6 @@ "minimatch": "^3.1.1", "once": "^1.3.0", "path-is-absolute": "^1.0.0" - }, - "dependencies": { - "minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dev": true, - "requires": { - "brace-expansion": "^1.1.7" - } - } } } } From 08ea87e9dab8c1c153ceff7605932ce234c7a8f8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 7 Dec 2022 09:42:46 +0100 Subject: [PATCH 6/7] chore: Bump qs from 6.5.2 to 6.5.3 (#436) Bumps [qs](https://github.com/ljharb/qs) from 6.5.2 to 6.5.3. - [Release notes](https://github.com/ljharb/qs/releases) - [Changelog](https://github.com/ljharb/qs/blob/main/CHANGELOG.md) - [Commits](https://github.com/ljharb/qs/compare/v6.5.2...v6.5.3) --- updated-dependencies: - dependency-name: qs dependency-type: indirect ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Artur Jankowski --- package-lock.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7713319f..7a7e5809 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7496,9 +7496,9 @@ } }, "qs": { - "version": "6.5.2", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.2.tgz", - "integrity": "sha512-N5ZAX4/LxJmF+7wN74pUD6qAh9/wnvdQcjq9TZjevvXzSUo7bfmw91saqMjzGS2xq91/odN2dW/WOl7qQHNDGA==" + "version": "6.5.3", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.5.3.tgz", + "integrity": "sha512-qxXIEh4pCGfHICj1mAJQ2/2XVZkjCDTcEgfoSQxc/fYivUZxTkk7L3bDBJSoNrEzXI17oUO5Dp07ktqE5KzczA==" }, "queue-microtask": { "version": "1.2.3", From 95320fbe2a630a976539cee37ab5dcce2e6c9e24 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 7 Dec 2022 09:49:21 +0100 Subject: [PATCH 7/7] chore: Bump express from 4.17.2 to 4.17.3 (#437) Bumps [express](https://github.com/expressjs/express) from 4.17.2 to 4.17.3. - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/master/History.md) - [Commits](https://github.com/expressjs/express/compare/4.17.2...4.17.3) --- updated-dependencies: - dependency-name: express dependency-type: direct:production ... Signed-off-by: dependabot[bot] Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Artur Jankowski --- package-lock.json | 86 ++++++++++++++++++++++++++++------------------- 1 file changed, 51 insertions(+), 35 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7a7e5809..4d15dbac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -937,12 +937,12 @@ } }, "accepts": { - "version": "1.3.7", - "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.7.tgz", - "integrity": "sha512-Il80Qs2WjYlJIBNzNkK6KYqlVMTbZLXgHx2oT0pU/fjRHyEp+PEfEPY0R3WCwAGVOtauxh1hOxNgIf5bv7dQpA==", + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", "requires": { - "mime-types": "~2.1.24", - "negotiator": "0.6.2" + "mime-types": "~2.1.34", + "negotiator": "0.6.3" } }, "acorn": { @@ -1324,22 +1324,27 @@ "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==" }, "body-parser": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.1.tgz", - "integrity": "sha512-8ljfQi5eBk8EJfECMrgqNGWPEY5jWP+1IzkzkGdFFEwFQZZyaZ21UqdaHktgiMlH0xLHqIFtE/u2OYE5dOtViA==", + "version": "1.19.2", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.19.2.tgz", + "integrity": "sha512-SAAwOxgoCKMGs9uUAUFHygfLAyaniaoun6I8mFY9pRAJL9+Kec34aU+oIjDhTycub1jozEfEwx1W1IuOYxVSFw==", "requires": { - "bytes": "3.1.1", + "bytes": "3.1.2", "content-type": "~1.0.4", "debug": "2.6.9", "depd": "~1.1.2", "http-errors": "1.8.1", "iconv-lite": "0.4.24", "on-finished": "~2.3.0", - "qs": "6.9.6", - "raw-body": "2.4.2", + "qs": "6.9.7", + "raw-body": "2.4.3", "type-is": "~1.6.18" }, "dependencies": { + "bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==" + }, "debug": { "version": "2.6.9", "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", @@ -1349,9 +1354,20 @@ } }, "qs": { - "version": "6.9.6", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.6.tgz", - "integrity": "sha512-TIRk4aqYLNoJUbd+g2lEdz5kLWIuTMRagAXxl78Q0RiVjAOugHmeKNGdd3cwo/ktpf9aL9epCfFqWDEKysUlLQ==" + "version": "6.9.7", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.7.tgz", + "integrity": "sha512-IhMFgUmuNpyRfxA90umL7ByLlgRXu6tIfKPpF5TmcfRLlLCckfP/g3IQmju6jjpu+Hh8rA+2p6A27ZSPOOHdKw==" + }, + "raw-body": { + "version": "2.4.3", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.4.3.tgz", + "integrity": "sha512-UlTNLIcu0uzb4D2f4WltY6cVjLi+/jEN4lgEUj3E04tpMDpUlkBo/eSn6zou9hum2VMNpCCUone0O0WeJim07g==", + "requires": { + "bytes": "3.1.2", + "http-errors": "1.8.1", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + } } } }, @@ -2296,9 +2312,9 @@ } }, "cookie": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.1.tgz", - "integrity": "sha512-ZwrFkGJxUR3EIoXtO+yVE69Eb7KlixbaeAWfBQB9vVsNn/o+Yw69gBWSSDK825hQNdN+wF8zELf3dFNl/kxkUA==" + "version": "0.4.2", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.4.2.tgz", + "integrity": "sha512-aSWTXFzaKWkvHO1Ny/s+ePFpvKsPnjc551iI41v3ny/ow6tBG5Vd+FuqGNhh1LxOmVzOlGUriIlOaokOvhaStA==" }, "cookie-signature": { "version": "1.0.6", @@ -2576,7 +2592,7 @@ "destroy": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.0.4.tgz", - "integrity": "sha1-l4hXRCxEdJ5CBmE+N5RiBYJqvYA=" + "integrity": "sha512-3NdhDuEXnfun/z7x9GOElY49LoqVHoGScmOKwmxhsS8N5Y+Z8KyPPDnaSzqWgYt/ji4mqwfTS34Htrk0zPIXVg==" }, "detect-indent": { "version": "6.1.0", @@ -3110,16 +3126,16 @@ "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==" }, "express": { - "version": "4.17.2", - "resolved": "https://registry.npmjs.org/express/-/express-4.17.2.tgz", - "integrity": "sha512-oxlxJxcQlYwqPWKVJJtvQiwHgosH/LrLSPA+H4UxpyvSS6jC5aH+5MoHFM+KABgTOt0APue4w66Ha8jCUo9QGg==", + "version": "4.17.3", + "resolved": "https://registry.npmjs.org/express/-/express-4.17.3.tgz", + "integrity": "sha512-yuSQpz5I+Ch7gFrPCk4/c+dIBKlQUxtgwqzph132bsT6qhuzss6I8cLJQz7B3rFblzd6wtcI0ZbGltH/C4LjUg==", "requires": { - "accepts": "~1.3.7", + "accepts": "~1.3.8", "array-flatten": "1.1.1", - "body-parser": "1.19.1", + "body-parser": "1.19.2", "content-disposition": "0.5.4", "content-type": "~1.0.4", - "cookie": "0.4.1", + "cookie": "0.4.2", "cookie-signature": "1.0.6", "debug": "2.6.9", "depd": "~1.1.2", @@ -3134,7 +3150,7 @@ "parseurl": "~1.3.3", "path-to-regexp": "0.1.7", "proxy-addr": "~2.0.7", - "qs": "6.9.6", + "qs": "6.9.7", "range-parser": "~1.2.1", "safe-buffer": "5.2.1", "send": "0.17.2", @@ -3157,12 +3173,12 @@ "path-to-regexp": { "version": "0.1.7", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", - "integrity": "sha1-32BBeABfUi8V60SQ5yR6G/qmf4w=" + "integrity": "sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==" }, "qs": { - "version": "6.9.6", - "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.6.tgz", - "integrity": "sha512-TIRk4aqYLNoJUbd+g2lEdz5kLWIuTMRagAXxl78Q0RiVjAOugHmeKNGdd3cwo/ktpf9aL9epCfFqWDEKysUlLQ==" + "version": "6.9.7", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.9.7.tgz", + "integrity": "sha512-IhMFgUmuNpyRfxA90umL7ByLlgRXu6tIfKPpF5TmcfRLlLCckfP/g3IQmju6jjpu+Hh8rA+2p6A27ZSPOOHdKw==" }, "safe-buffer": { "version": "5.2.1", @@ -5740,7 +5756,7 @@ "ms": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" }, "multistream": { "version": "4.1.0", @@ -5787,9 +5803,9 @@ "dev": true }, "negotiator": { - "version": "0.6.2", - "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.2.tgz", - "integrity": "sha512-hZXc7K2e+PgeI1eDBe/10Ard4ekbfrrqG8Ep+8Jmf4JID2bNg7NvCPOZN+kfF574pFQI7mum2AUqDidoKqcTOw==" + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==" }, "neo-async": { "version": "2.6.2", @@ -6253,7 +6269,7 @@ "on-finished": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.3.0.tgz", - "integrity": "sha1-IPEzZIGwg811M3mSoWlxqi2QaUc=", + "integrity": "sha512-ikqdkGAAyf/X/gPhXGvfgAytDZtDbr+bkNUJ0N9h5MI/dmdgCs3l6hoHrcUv41sRKew3jIwrp4qQDXiK99Utww==", "requires": { "ee-first": "1.1.1" } @@ -7848,7 +7864,7 @@ "ms": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", - "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=" + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==" } } },