From 5ea4cb82294188dd30563ef9cea2c8e0b76bbfae Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Thu, 10 Nov 2022 15:42:10 +0100 Subject: [PATCH 1/5] feat: Add `id` and `type` field to shared-links:create response (#427) * feat: Add `id` and `type` field to shared-links:create response --- package-lock.json | 12 +- package.json | 2 +- src/commands/files/share.js | 2 +- src/commands/folders/share.js | 2 +- src/commands/shared-links/create.js | 4 +- src/modules/shared-links.js | 2 +- test/commands/files.test.js | 8 +- test/commands/folders.test.js | 6 +- test/commands/shared-links.test.js | 8 +- .../files/put_files_id_shared_link.json | 64 +---------- .../folders/put_folders_id_shared_link.json | 107 ------------------ test/fixtures/output/files_share_json.txt | 30 ++--- test/fixtures/output/files_share_yaml.txt | 31 ++--- test/fixtures/output/folders_share_json.txt | 28 +++-- test/fixtures/output/folders_share_yaml.txt | 29 ++--- 15 files changed, 90 insertions(+), 245 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1d301e3c..99b3ed51 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1197,9 +1197,9 @@ }, "dependencies": { "tslib": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.0.tgz", - "integrity": "sha512-d6xOpEDfsi2CZVlPQzGeux8XMwLT9hssAsaPYExaQMuYskwb+x1x7J371tWlbBdWHroy99KnVB6qIkUbs5X3UQ==" + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.4.1.tgz", + "integrity": "sha512-tGyy4dAjRIEwI7BzsB0lynWgOpfqjUdq91XXAlIWD2OwKBH7oCl/GZG/HT4BOHrTlPMOASlMQ7veyTqpmRcrNA==" } } }, @@ -1356,9 +1356,9 @@ } }, "box-node-sdk": { - "version": "2.7.1", - "resolved": "https://registry.npmjs.org/box-node-sdk/-/box-node-sdk-2.7.1.tgz", - "integrity": "sha512-pU2RNm4Kb20+InHccbgTZPoNBaRZ81QLGtaHVNHjD/Vdop2wTUI6djv2Xma4D+zgX+pL7tbPpP1TVwhcWLIX/g==", + "version": "2.7.2", + "resolved": "https://registry.npmjs.org/box-node-sdk/-/box-node-sdk-2.7.2.tgz", + "integrity": "sha512-OxIGk3PDmW6p1skEZR2lJXzalGotfb8+BUJ2faQzhyvlX+wLxct1ffjFH8y43ffhi0BK0+HbjYMUJssbyAiyAg==", "requires": { "@types/bluebird": "^3.5.35", "@types/node": "^15.3.1", diff --git a/package.json b/package.json index d8737592..aa4de002 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ "@oclif/plugin-help": "^2.2.1", "@oclif/plugin-not-found": "^1.2.0", "archiver": "^3.0.0", - "box-node-sdk": "^2.7.1", + "box-node-sdk": "^2.7.2", "chalk": "^2.4.1", "cli-progress": "^2.1.0", "csv": "^3.1.0", diff --git a/src/commands/files/share.js b/src/commands/files/share.js index 6ed93944..d4b35b76 100644 --- a/src/commands/files/share.js +++ b/src/commands/files/share.js @@ -16,7 +16,7 @@ class FilesShareCommand extends BoxCommand { let sharedLinksModule = new SharedLinksModule(this.client); let updatedItem = await sharedLinksModule.createSharedLink(args, flags); - await this.output(updatedItem.shared_link); + await this.output(updatedItem); } } diff --git a/src/commands/folders/share.js b/src/commands/folders/share.js index 9e5f7e37..0270c06d 100644 --- a/src/commands/folders/share.js +++ b/src/commands/folders/share.js @@ -16,7 +16,7 @@ class FoldersShareCommand extends BoxCommand { let sharedLinksModule = new SharedLinksModule(this.client); let updatedItem = await sharedLinksModule.createSharedLink(args, flags); - await this.output(updatedItem.shared_link); + await this.output(updatedItem); } } diff --git a/src/commands/shared-links/create.js b/src/commands/shared-links/create.js index 5da27393..3fc1b3bb 100644 --- a/src/commands/shared-links/create.js +++ b/src/commands/shared-links/create.js @@ -7,10 +7,10 @@ const SharedLinksModule = require('../../modules/shared-links'); class SharedLinksCreateCommand extends BoxCommand { async run() { const { flags, args } = this.parse(SharedLinksCreateCommand); - + let sharedLinksModule = new SharedLinksModule(this.client); let updatedItem = await sharedLinksModule.createSharedLink(args, flags); - await this.output(updatedItem.shared_link); + await this.output(updatedItem); } } diff --git a/src/modules/shared-links.js b/src/modules/shared-links.js index 2b61e567..5784bd38 100644 --- a/src/modules/shared-links.js +++ b/src/modules/shared-links.js @@ -22,7 +22,7 @@ class SharedLinksModule { * @returns {Promise} A promise resolving to the updated item object */ createSharedLink(args, flags) { - let updates = { shared_link: { permissions: {} } }; + let updates = { shared_link: { permissions: {} }, fields: 'shared_link' }; if (flags.access) { updates.shared_link.access = flags.access; diff --git a/test/commands/files.test.js b/test/commands/files.test.js index b2b7f336..f7473b49 100644 --- a/test/commands/files.test.js +++ b/test/commands/files.test.js @@ -1120,7 +1120,7 @@ describe('Files', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/files/${fileId}`, sharedLinkBody) + .put(`/2.0/files/${fileId}?fields=shared_link`, sharedLinkBody) .reply(200, createSharedLinkFixture) ) .stdout() @@ -1140,7 +1140,7 @@ describe('Files', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/files/${fileId}`, sharedLinkBody) + .put(`/2.0/files/${fileId}?fields=shared_link`, sharedLinkBody) .reply(200, createSharedLinkFixture) ) .stdout() @@ -1159,7 +1159,7 @@ describe('Files', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/files/${fileId}`, { + .put(`/2.0/files/${fileId}?fields=shared_link`, { shared_link: { permissions: {}, unshared_at: unsharedDate, @@ -1181,7 +1181,7 @@ describe('Files', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/files/${fileId}`, { + .put(`/2.0/files/${fileId}?fields=shared_link`, { shared_link: { permissions: {}, unshared_at: unsharedDate, diff --git a/test/commands/folders.test.js b/test/commands/folders.test.js index 91ce6a8c..2450a20e 100644 --- a/test/commands/folders.test.js +++ b/test/commands/folders.test.js @@ -908,7 +908,7 @@ describe('Folders', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/folders/${folderId}`, sharedLinkBody) + .put(`/2.0/folders/${folderId}?fields=shared_link`, sharedLinkBody) .reply(200, createSharedLinkFixture) ) .stdout() @@ -927,7 +927,7 @@ describe('Folders', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/folders/${folderId}`, sharedLinkBody) + .put(`/2.0/folders/${folderId}?fields=shared_link`, sharedLinkBody) .reply(200, createSharedLinkFixture) ) .stdout() @@ -945,7 +945,7 @@ describe('Folders', () => { test .nock(TEST_API_ROOT, api => api - .put(`/2.0/folders/${folderId}`, { + .put(`/2.0/folders/${folderId}?fields=shared_link`, { shared_link: { permissions: {}, unshared_at: unshareDate, diff --git a/test/commands/shared-links.test.js b/test/commands/shared-links.test.js index 86f90b18..a9c0b9ce 100644 --- a/test/commands/shared-links.test.js +++ b/test/commands/shared-links.test.js @@ -65,7 +65,7 @@ describe('Shared-Links', () => { test .nock(TEST_API_ROOT, (api) => api - .put(`/2.0/files/${fileId}`, fileSharedLinkBody) + .put(`/2.0/files/${fileId}?fields=shared_link`, fileSharedLinkBody) .reply(200, createFileSharedLinkFixture) ) .stdout() @@ -84,7 +84,7 @@ describe('Shared-Links', () => { test .nock(TEST_API_ROOT, (api) => api - .put(`/2.0/files/${fileId}`, fileSharedLinkBody) + .put(`/2.0/files/${fileId}?fields=shared_link`, fileSharedLinkBody) .reply(200, createFileSharedLinkFixture) ) .stdout() @@ -117,7 +117,7 @@ describe('Shared-Links', () => { test .nock(TEST_API_ROOT, (api) => api - .put(`/2.0/folders/${folderId}`, folderSharedLinkBody) + .put(`/2.0/folders/${folderId}?fields=shared_link`, folderSharedLinkBody) .reply(200, createFolderSharedLinkFixture) ) .stdout() @@ -138,7 +138,7 @@ describe('Shared-Links', () => { test .nock(TEST_API_ROOT, (api) => api - .put(`/2.0/folders/${folderId}`, folderSharedLinkBody) + .put(`/2.0/folders/${folderId}?fields=shared_link`, folderSharedLinkBody) .reply(200, createFolderSharedLinkFixture) ) .stdout() diff --git a/test/fixtures/files/put_files_id_shared_link.json b/test/fixtures/files/put_files_id_shared_link.json index 84d3c5a6..b5ca5b7e 100644 --- a/test/fixtures/files/put_files_id_shared_link.json +++ b/test/fixtures/files/put_files_id_shared_link.json @@ -1,60 +1,6 @@ { "type": "file", "id": "1234567890", - "file_version": { - "type": "file_version", - "id": "11223344556677", - "sha1": "97b3dbba6eab7ad0f058240744c8636b7c7bea93" - }, - "sequence_id": "1", - "etag": "1", - "sha1": "97b3dbba6eab7ad0f058240744c8636b7c7bea93", - "name": "Puppy.png", - "description": "", - "size": 106833, - "path_collection": { - "total_count": 2, - "entries": [ - { - "type": "folder", - "id": "0", - "sequence_id": null, - "etag": null, - "name": "All Files" - }, - { - "type": "folder", - "id": "987654321", - "sequence_id": "0", - "etag": "0", - "name": "Collaborated Folder" - } - ] - }, - "created_at": "2016-11-16T22:01:44-08:00", - "modified_at": "2016-11-16T22:01:51-08:00", - "trashed_at": null, - "purged_at": null, - "content_created_at": "2016-10-29T18:33:50-07:00", - "content_modified_at": "2016-10-29T18:33:50-07:00", - "created_by": { - "type": "user", - "id": "1357924680", - "name": "Owner", - "login": "owner@example.com" - }, - "modified_by": { - "type": "user", - "id": "1357924680", - "name": "Owner", - "login": "owner@example.com" - }, - "owned_by": { - "type": "user", - "id": "1357924680", - "name": "Owner", - "login": "owner@example.com" - }, "shared_link": { "url": "https://blosserdemoaccount.box.com/s/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p", "download_url": "https://blosserdemoaccount.box.com/shared/static/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p.png", @@ -70,13 +16,5 @@ "can_preview": true, "can_edit": true } - }, - "parent": { - "type": "folder", - "id": "987654321", - "sequence_id": "0", - "etag": "0", - "name": "Collaborated Folder" - }, - "item_status": "active" + } } diff --git a/test/fixtures/folders/put_folders_id_shared_link.json b/test/fixtures/folders/put_folders_id_shared_link.json index f338fa0b..834d3f15 100644 --- a/test/fixtures/folders/put_folders_id_shared_link.json +++ b/test/fixtures/folders/put_folders_id_shared_link.json @@ -1,39 +1,6 @@ { "type": "folder", "id": "0", - "sequence_id": null, - "etag": null, - "name": "All Files", - "created_at": null, - "modified_at": null, - "description": "", - "size": 8183737, - "path_collection": { - "total_count": 0, - "entries": [] - }, - "created_by": { - "type": "user", - "id": "", - "name": "", - "login": "" - }, - "modified_by": { - "type": "user", - "id": "33333", - "name": "Test User", - "login": "testuser@example.com" - }, - "trashed_at": null, - "purged_at": null, - "content_created_at": null, - "content_modified_at": null, - "owned_by": { - "type": "user", - "id": "33333", - "name": "Test User", - "login": "testuser@example.com" - }, "shared_link": { "url": "https://blosserdemoaccount.box.com/s/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p", "download_url": "https://blosserdemoaccount.box.com/shared/static/7mcmdlavtye5o5i0ue8xmtwh2sx5bv8p.png", @@ -48,79 +15,5 @@ "can_download": true, "can_preview": true } - }, - "folder_upload_email": null, - "parent": null, - "item_status": "active", - "item_collection": { - "total_count": 6, - "entries": [ - { - "type": "folder", - "id": "44444", - "sequence_id": "1", - "etag": "1", - "name": "Collab Folder" - }, - { - "type": "folder", - "id": "55555", - "sequence_id": "0", - "etag": "0", - "name": "Copied Folder" - }, - { - "type": "folder", - "id": "66666", - "sequence_id": "0", - "etag": "0", - "name": "SDK Test Folder" - }, - { - "type": "folder", - "id": "77777", - "sequence_id": "1", - "etag": "1", - "name": "Test Folder" - }, - { - "type": "file", - "id": "88888", - "file_version": { - "type": "file_version", - "id": "888880", - "sha1": "6afc05eae22e994f1c7dd48e58f8895dd9028223" - }, - "sequence_id": "0", - "etag": "0", - "sha1": "6afc05eae22e994f1c7dd48e58f8895dd9028223", - "name": "Copied file.txt" - }, - { - "type": "file", - "id": "99999", - "file_version": { - "type": "file_version", - "id": "999990", - "sha1": "97cc02de7c356f94e3beeb1e0c63f78a6edb01fd" - }, - "sequence_id": "9", - "etag": "9", - "sha1": "97cc02de7c356f94e3beeb1e0c63f78a6edb01fd", - "name": "test file.txt" - } - ], - "offset": 0, - "limit": 100, - "order": [ - { - "by": "type", - "direction": "ASC" - }, - { - "by": "name", - "direction": "ASC" - } - ] } } diff --git a/test/fixtures/output/files_share_json.txt b/test/fixtures/output/files_share_json.txt index 47809f4f..b5ca5b7e 100644 --- a/test/fixtures/output/files_share_json.txt +++ b/test/fixtures/output/files_share_json.txt @@ -1,16 +1,20 @@ { - "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 + "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 + } } } diff --git a/test/fixtures/output/files_share_yaml.txt b/test/fixtures/output/files_share_yaml.txt index 62063e3e..6f7980dd 100644 --- a/test/fixtures/output/files_share_yaml.txt +++ b/test/fixtures/output/files_share_yaml.txt @@ -1,14 +1,17 @@ -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 +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 diff --git a/test/fixtures/output/folders_share_json.txt b/test/fixtures/output/folders_share_json.txt index 107b6e09..834d3f15 100644 --- a/test/fixtures/output/folders_share_json.txt +++ b/test/fixtures/output/folders_share_json.txt @@ -1,15 +1,19 @@ { - "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 + "type": "folder", + "id": "0", + "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 + } } } diff --git a/test/fixtures/output/folders_share_yaml.txt b/test/fixtures/output/folders_share_yaml.txt index 4219a6fe..c2f3a4a9 100644 --- a/test/fixtures/output/folders_share_yaml.txt +++ b/test/fixtures/output/folders_share_yaml.txt @@ -1,13 +1,16 @@ -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 +Type: folder +ID: '0' +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 From db824ef0b4111810b7902896062c950ef9ac01b3 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Fri, 18 Nov 2022 10:13:07 +0100 Subject: [PATCH 2/5] feat: Add fields disposition_at field for files under retention (#429) --- src/commands/files/update.js | 5 +++++ src/commands/shared-links/create.js | 2 +- test/commands/files.test.js | 22 +++++++++++++++++++++- 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/src/commands/files/update.js b/src/commands/files/update.js index 988824bf..d64f0e53 100644 --- a/src/commands/files/update.js +++ b/src/commands/files/update.js @@ -22,6 +22,10 @@ class FileUpdateCommand extends BoxCommand { updates.etag = flags.etag; } + if (flags['disposition-at']) { + updates.disposition_at = flags['disposition-at']; + } + let updatedFile = await this.client.files.update(args.id, updates); await this.output(updatedFile); } @@ -37,6 +41,7 @@ FileUpdateCommand.flags = { description: flags.string({ description: 'New description for the file' }), tags: flags.string({ description: 'Set tags on the file, specified as comma-separated tags' }), etag: flags.string({ description: 'Only apply updates if the ETag value matches' }), + 'disposition-at': flags.string({ description: 'The retention expiration timestamp for the given file. This date cannot be shortened once set on a file'}) }; FileUpdateCommand.args = [ diff --git a/src/commands/shared-links/create.js b/src/commands/shared-links/create.js index 3fc1b3bb..4e3931d9 100644 --- a/src/commands/shared-links/create.js +++ b/src/commands/shared-links/create.js @@ -7,7 +7,7 @@ const SharedLinksModule = require('../../modules/shared-links'); class SharedLinksCreateCommand extends BoxCommand { async run() { const { flags, args } = this.parse(SharedLinksCreateCommand); - + let sharedLinksModule = new SharedLinksModule(this.client); let updatedItem = await sharedLinksModule.createSharedLink(args, flags); await this.output(updatedItem); diff --git a/test/commands/files.test.js b/test/commands/files.test.js index f7473b49..5f95e7af 100644 --- a/test/commands/files.test.js +++ b/test/commands/files.test.js @@ -1469,7 +1469,8 @@ describe('Files', () => { description = 'New description', tags = 'foo,bar', fixture = getFixture('files/put_files_id'), - yamlOutput = getFixture('output/files_rename_yaml.txt'); + yamlOutput = getFixture('output/files_rename_yaml.txt'), + dispositionAt = '2025-12-09T04:07:18-08:00'; test .nock(TEST_API_ROOT, api => api @@ -1554,6 +1555,25 @@ describe('Files', () => { let msg = 'Unexpected API Response [412 Precondition Failed | 1wne91fxf8871ide] precondition_failed - The resource has been modified. Please retrieve the resource again and retry'; assert.equal(ctx.stderr, `${msg}${os.EOL}`); }); + + test + .nock(TEST_API_ROOT, api => api + .put(`/2.0/files/${fileID}`, { + disposition_at: dispositionAt + }) + .reply(200, fixture) + ) + .stdout() + .command([ + 'files:update', + fileID, + `--disposition-at=${dispositionAt}`, + '--json', + '--token=test', + ]) + .it('shoud update disposition_at property of a file', ctx => { + assert.equal(ctx.stdout, fixture); + }); }); describe('files:versions:upload', () => { From 9ada74b09eb5aa0e09881946a4f7f30e2d68e037 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Mon, 21 Nov 2022 18:35:17 +0100 Subject: [PATCH 3/5] fix: Fix `event:poll` polling-interval (#430) --- src/commands/events/poll.js | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/commands/events/poll.js b/src/commands/events/poll.js index 34858371..16fea9f8 100644 --- a/src/commands/events/poll.js +++ b/src/commands/events/poll.js @@ -20,7 +20,11 @@ class EventsPollCommand extends BoxCommand { options.endDate = flags['end-date']; } if (flags['polling-interval']) { - options.pollingInterval = flags['polling-interval']; + if (flags.enterprise) { + options.pollingInterval = flags['polling-interval']; + } else { + options.fetchInterval = flags['polling-interval'] * 1000; + } } await this.output('Polling started...'); @@ -56,7 +60,10 @@ EventsPollCommand.flags = { description: 'Return enterprise events that occured before this time. Use a timestamp or shorthand syntax 00t, like 05w for 5 weeks.', parse: input => BoxCommand.normalizeDateString(input), }), - 'polling-interval': flags.string({ description: 'Number of seconds to wait before polling for new events. Default is 60 seconds.' }) + 'polling-interval': flags.string({ + description: 'Number of seconds to wait before polling for new events. Default is 60 seconds.', + parse: input => parseInt(input, 10), + }) }; From cd7b15787669326edd30d77984f3da4be084c586 Mon Sep 17 00:00:00 2001 From: box-sdk-build <94016436+box-sdk-build@users.noreply.github.com> Date: Tue, 22 Nov 2022 15:55:47 +0100 Subject: [PATCH 4/5] chore: release 3.6.0 (#432) --- CHANGELOG.md | 12 ++++++++++++ package-lock.json | 2 +- package.json | 2 +- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ae253394..17fad847 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [3.6.0](https://github.com/box/boxcli/compare/v3.5.0...v3.6.0) (2022-11-22) + + +### New Features and Enhancements + +* Add `id` and `type` field to shared-links:create response ([#427](https://github.com/box/boxcli/issues/427)) ([5ea4cb8](https://github.com/box/boxcli/commit/5ea4cb82294188dd30563ef9cea2c8e0b76bbfae)) +* Add fields disposition_at field for files under retention ([#429](https://github.com/box/boxcli/issues/429)) ([db824ef](https://github.com/box/boxcli/commit/db824ef0b4111810b7902896062c950ef9ac01b3)) + +### Bug Fixes + +* Fix `event:poll` polling-interval ([#430](https://github.com/box/boxcli/issues/430)) ([9ada74b](https://github.com/box/boxcli/commit/9ada74b09eb5aa0e09881946a4f7f30e2d68e037)) + ## [3.5.0](https://github.com/box/boxcli/compare/v3.4.0...v3.5.0) (2022-11-02) diff --git a/package-lock.json b/package-lock.json index 99b3ed51..d71d438b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@box/cli", - "version": "3.5.0", + "version": "3.6.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index aa4de002..80dc88aa 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "upload", "download" ], - "version": "3.5.0", + "version": "3.6.0", "author": "Box ", "license": "Apache-2.0", "main": "src/index.js", From ef37c2afe0aea06546c4c84a3df3d543f9c080f4 Mon Sep 17 00:00:00 2001 From: Minh Nguyen Cong Date: Tue, 22 Nov 2022 16:29:58 +0100 Subject: [PATCH 5/5] 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)_