diff --git a/docs/hubs.md b/docs/hubs.md index 08ebb75e..19752626 100644 --- a/docs/hubs.md +++ b/docs/hubs.md @@ -4,6 +4,13 @@ List Box Hubs for the current user * [`box hubs`](#box-hubs) +* [`box hubs:collaborations ID`](#box-hubscollaborations-id) +* [`box hubs:collaborations:add ID`](#box-hubscollaborationsadd-id) +* [`box hubs:collaborations:create ID`](#box-hubscollaborationscreate-id) +* [`box hubs:collaborations:delete ID`](#box-hubscollaborationsdelete-id) +* [`box hubs:collaborations:get ID`](#box-hubscollaborationsget-id) +* [`box hubs:collaborations:list ID`](#box-hubscollaborationslist-id) +* [`box hubs:collaborations:update ID`](#box-hubscollaborationsupdate-id) * [`box hubs:copy ID`](#box-hubscopy-id) * [`box hubs:create TITLE`](#box-hubscreate-title) * [`box hubs:delete ID`](#box-hubsdelete-id) @@ -71,6 +78,302 @@ EXAMPLES _See code: [src/commands/hubs/index.js](https://github.com/box/boxcli/blob/v4.7.0/src/commands/hubs/index.js)_ +## `box hubs:collaborations ID` + +List collaborations for a Box Hub + +``` +USAGE + $ box hubs:collaborations ID [-t ] [--as-user ] [--no-color] [--json | --csv] [-s | --save-to-file-path + ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--max-items ] + +ARGUMENTS + ID ID of the Box Hub + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -s, --save Save report to default reports folder on disk + -t, --token= Provide a token to perform this call + -v, --verbose Show verbose output, which can be helpful for debugging + -y, --yes Automatically respond yes to all confirmation prompts + --as-user= Provide an ID for a user + --bulk-file-path= File path to bulk .csv or .json objects + --csv Output formatted CSV + --fields= Comma separated list of fields to show + --json Output formatted JSON + --max-items= A value that indicates the maximum number of results to return. This only specifies a + maximum boundary and will not guarantee the minimum number of results returned. When + the max-items (x) is greater than 1000, then the maximum ceil(x/1000) requests will + be made. + --no-color Turn off colors for logging + --save-to-file-path= Override default file path to save report + +DESCRIPTION + List collaborations for a Box Hub + +ALIASES + $ box hubs:collaborations:list + +EXAMPLES + $ box hubs:collaborations 12345 + + $ box hubs:collaborations 12345 --max-items 50 +``` + +_See code: [src/commands/hubs/collaborations/index.js](https://github.com/box/boxcli/blob/v4.7.0/src/commands/hubs/collaborations/index.js)_ + +## `box hubs:collaborations:add ID` + +Adds a collaboration with a specific role for a single user or a single group to a Box Hub. Collaborations can be created using email address, user IDs, or group IDs + +``` +USAGE + $ box hubs:collaborations:add ID -r editor|viewer|co-owner [-t ] [--as-user ] [--no-color] [--json | --csv] + [-s | --save-to-file-path ] [--fields ] [--bulk-file-path ] [-h] [-v] [-y] [-q] [--user-id + | --group-id | --login ] + +ARGUMENTS + ID ID of the Box Hub + +FLAGS + -h, --help Show CLI help + -q, --quiet Suppress any non-error output to stderr + -r, --role=