diff --git a/CHANGELOG.md b/CHANGELOG.md index 84ae1475..c6e9360c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,25 @@ 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.0.0](https://github.com/box/box-node-sdk/compare/v2.10.0...v3.0.0) (2023-05-23) + +The most important change in this release is **dropping support for Node versions below 12** and changing the **support environments from Node 12 to Node 16**. + +### Breaking Changes + +- Removed `use_index` usage. ([#812](https://github.com/box/box-node-sdk/pull/812)) ([d56799a](https://github.com/box/box-node-sdk/commit/d56799a61f42265d7785f99e92a449c58d125aef)) +- Removed deprecated `BoxClient.batch()` and `BoxClient.batchExec()` method. +- Removed deprecated `CollaborationWhitelist` class, use `CollaborationAllowlist` instead. +- Removed deprecated `CollaborationAllowlist.getWhitelistedDomain()` method, use `CollaborationAllowlist.getAllowlistedDomain()` instead. +- Removed deprecated `CollaborationAllowlist.getAllWhitelistedDomains()` method, use `CollaborationAllowlist.getAllAllowlistedDomains()` instead. +- Remove deprecated `Files.getThumbnail(fileID: string, options?: Record, callback?: Function)` method, use `Files.getRepresentationContent( fileID, representationType, options, callback)` instead. + +Migration details can be found [here](https://github.com/box/box-node-sdk/blob/v3.0.0/docs/upgrade/2.x.x%20to%203.x.x.md) + +### Dependency Upgrades +- Bumped `jsonwebtoken` from 8.5.1 to 9.0.0. ([#802](https://github.com/box/box-node-sdk/pull/802)) ([5b1d4e9](https://github.com/box/box-node-sdk/pull/828/commits/5b1d4e9ec557c14c1d27695733cc0bcae49061cb)) +- Bumped `vm2` from 3.9.11 to 3.9.19 ([#826](https://github.com/box/box-node-sdk/pull/826)) ([220df76](https://github.com/box/box-node-sdk/commit/220df765080bc27c91daed51ac46620f6bc8b9ed)) + ## [2.10.0](https://github.com/box/box-node-sdk/compare/v2.9.0...v2.10.0) (2023-05-11) diff --git a/README.md b/README.md index b931511e..72d5b7b4 100644 --- a/README.md +++ b/README.md @@ -241,7 +241,8 @@ We highly recommend upgrading to the latest SDK major release at the earliest co | Version | Supported Environments | State | First Release | EOL/Terminated | |---------|------------------------|-----------|---------------|----------------| -| 2 | Node.js >= 12 and <= 16| Supported | 29 Sep 2021 | TBD | +| 3 | Node.js >= 12 and <= 16| Supported | 23 May 2023 | TBD | +| 2 | Node.js >= 8 and <= 14 | Maintained | 29 Sep 2021 | 23 Jul 2023 | | 1 | | EOL | 28 Mar 2019 | 29 Sep 2021 | ## Questions, Bugs, and Feature Requests? diff --git a/docs/jsdoc/APIRequest.html b/docs/jsdoc/APIRequest.html index c1e41998..61ab4ace 100644 --- a/docs/jsdoc/APIRequest.html +++ b/docs/jsdoc/APIRequest.html @@ -338,7 +338,7 @@
Parameters:
Source:
@@ -392,6 +392,287 @@
Returns:
+

execute(callbackopt) → {void}

+ + + + + + +
+ Executes the request with the given options. If a callback is provided, we'll +handle the response via callbacks. Otherwise, the response will be streamed to +via the stream property. You can access this stream with the getResponseStream() +method. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
callback + + +APIRequest~Callback + + + + + + <optional>
+ + + + + + 		Callback for handling the response
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + + + + + + + + + + +

getResponseStream() → (nullable) {ReadableStream}

+ + + + + + +
+ Return the response read stream for a request. This will be undefined until +a stream-based request has been started. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ The response stream +
+ + + +
+
+ Type +
+
+ +ReadableStream + + +
+
+ + + + + + + + + + + + +

getResponseStream() → (nullable) {ReadableStream}

@@ -445,7 +726,7 @@

getR
Source:
@@ -513,13 +794,13 @@

Returns:

diff --git a/docs/jsdoc/APIRequestManager.html b/docs/jsdoc/APIRequestManager.html index 2fcb637a..ba645bd1 100644 --- a/docs/jsdoc/APIRequestManager.html +++ b/docs/jsdoc/APIRequestManager.html @@ -322,7 +322,7 @@
Parameters:
Source:
@@ -380,6 +380,324 @@
Returns:
+

makeRequest(options) → {Promise.<Response>}

+ + + + + + +
+ Make a request to the API, and get the response via callback. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + The request options
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the response object +
+ + + +
+
+ Type +
+
+ +Promise.<Response> + + +
+
+ + + + + + + + + + + + + +

makeStreamingRequest(options) → {Stream.Readable}

+ + + + + + +
+ Make a request to the API, and return a read stream for the response. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
options + + +Object + + + + The request options
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ The response stream +
+ + + +
+
+ Type +
+
+ +Stream.Readable + + +
+
+ + + + + + + + + + + + +

makeStreamingRequest(options) → {Stream.Readable}

@@ -481,7 +799,7 @@
Parameters:
Source:
@@ -549,13 +867,13 @@
Returns:

diff --git a/docs/jsdoc/AppAuthSession.html b/docs/jsdoc/AppAuthSession.html index 7ff73485..2f54a99c 100644 --- a/docs/jsdoc/AppAuthSession.html +++ b/docs/jsdoc/AppAuthSession.html @@ -226,7 +226,7 @@
Parameters:
-TokenStore +TokenStore @@ -617,7 +617,7 @@
Properties
Source:
@@ -675,7 +675,7 @@
Returns:
-

getAccessToken(optionsopt) → {Promise.<string>}

+

exchangeToken(scopes, resourceopt, optionsopt) → {Promise.<TokenInfo>}

@@ -683,10 +683,7 @@

getAcce
- Produces a valid, app auth access token. -Performs a refresh before returning if the current token is expired. If the current -token is considered stale but still valid, return the current token but initiate a -new refresh in the background. + Exchange the client access token for one with lower scope
@@ -722,6 +719,73 @@

Parameters:
+ + + scopes + + + + + +string +| + +Array.<string> + + + + + + + + + + + + + + + + + + The scope(s) requested for the new token + + + + + + + resource + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + The absolute URL of an API resource to scope the new token to + + + + options @@ -730,6 +794,60 @@
Parameters:
+Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tokenRequestOptions + + TokenRequestOptions @@ -754,6 +872,46 @@
Parameters:
actor + + +ActorParams + + + + + + <optional>
+ + + + + + 		Optional actor parameters for creating annotator tokens
+ + + + + @@ -791,7 +949,7 @@
Parameters:
Source:
@@ -820,7 +978,7 @@
Returns:
- Promise resolving to the access token + Promise resolving to the new token info
@@ -831,7 +989,7 @@
Returns:
-Promise.<string> +Promise.<TokenInfo>
@@ -849,7 +1007,7 @@
Returns:
-

handleExpiredTokensError(err) → {Promise.<Error>}

+

getAccessToken(optionsopt) → {Promise.<string>}

@@ -857,8 +1015,10 @@

- Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token -store (if present) before continuing. + Produces a valid, app auth access token. +Performs a refresh before returning if the current token is expired. If the current +token is considered stale but still valid, return the current token but initiate a +new refresh in the background. @@ -882,6 +1042,8 @@
Parameters:
Type + Attributes + @@ -894,24 +1056,33 @@
Parameters:
- err + options -Errors~ExpiredTokensError +TokenRequestOptions + + + <optional>
+ + + + + + + - An "expired tokens" error including information - about the request/response. + Sets optional behavior for the token grant @@ -952,7 +1123,7 @@
Parameters:
Source:
@@ -981,9 +1152,7 @@
Returns:
- Promise resolving to an error. This will - usually be the original response error, but could an error from trying to access the - token store as well. + Promise resolving to the access token
@@ -994,7 +1163,678 @@
Returns:
-Promise.<Error> +Promise.<string> + + +
+ + + + + + + + + + + + + + +

getAccessToken(optionsopt) → {Promise.<string>}

+ + + + + + +
+ Produces a valid, app auth access token. +Performs a refresh before returning if the current token is expired. If the current +token is considered stale but still valid, return the current token but initiate a +new refresh in the background. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the access token +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

handleExpiredTokensError(err) → {Promise.<Error>}

+ + + + + + +
+ Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token +store (if present) before continuing. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
err + + +Errors~ExpiredTokensError + + + + An "expired tokens" error including information + about the request/response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to an error. This will + usually be the original response error, but could an error from trying to access the + token store as well. +
+ + + +
+
+ Type +
+
+ +Promise.<Error> + + +
+
+ + + + + + + + + + + + + +

handleExpiredTokensError(err) → {Promise.<Error>}

+ + + + + + +
+ Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token +store (if present) before continuing. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
err + + +Errors~ExpiredTokensError + + + + An "expired tokens" error including information + about the request/response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to an error. This will + usually be the original response error, but could an error from trying to access the + token store as well. +
+ + + +
+
+ Type +
+
+ +Promise.<Error> + + +
+
+ + + + + + + + + + + + + +

revokeTokens(optionsopt) → {Promise}

+ + + + + + +
+ Revokes the app auth token used by this session, and clears the saved tokenInfo. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving if the revoke succeeds +
+ + + +
+
+ Type +
+
+ +Promise
@@ -1125,7 +1965,7 @@
Parameters:
Source:
@@ -1193,13 +2033,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/BasicSession.html b/docs/jsdoc/BasicSession.html index e4e2edd9..77cf8fcf 100644 --- a/docs/jsdoc/BasicSession.html +++ b/docs/jsdoc/BasicSession.html @@ -501,7 +501,7 @@
Properties
Source:
@@ -559,6 +559,449 @@
Returns:
+

exchangeToken(scopes, resourceopt, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Exchange the client access token for one with lower scope +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
scopes + + +string +| + +Array.<string> + + + + + + + + + + The scope(s) requested for the new token
resource + + +string + + + + + + <optional>
+ + + + + + 		The absolute URL of an API resource to scope the new token to
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tokenRequestOptions + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
actor + + +ActorParams + + + + + + <optional>
+ + + + + + 		Optional actor parameters for creating annotator tokens
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the new token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getAccessToken() → {Promise.<string>}

+ + + + + + +
+ Returns the clients access token. BasicSession never returns an error, since it doesn't +know the status of its own token. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the access token +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + +

getAccessToken() → {Promise.<string>}

@@ -612,7 +1055,7 @@

getAcce
Source:
@@ -783,7 +1226,178 @@

Parameters:
Source:
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving if the revoke succeeds +
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + + + + +

revokeTokens(optionsopt) → {Promise}

+ + + + + + +
+ Revokes the session's access token. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -851,13 +1465,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/BoxClient.html b/docs/jsdoc/BoxClient.html index f66bff36..2d3ff8eb 100644 --- a/docs/jsdoc/BoxClient.html +++ b/docs/jsdoc/BoxClient.html @@ -191,7 +191,7 @@
Parameters:
Source:
@@ -241,7 +241,7 @@

Members

-

(readonly) accessLevels :AccessLevel

+

(readonly) accessLevels :AccessLevel

@@ -257,7 +257,7 @@
Type:
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of device pins +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all device pin records for the current enterprise + +API Endpoint: '/enterprises/:enterpriseID/device_pinners' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional paramters, can be left null in many cases
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of device pins if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -909,13 +1592,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Enterprise.html b/docs/jsdoc/Enterprise.html index bfd0a37c..d3fa296d 100644 --- a/docs/jsdoc/Enterprise.html +++ b/docs/jsdoc/Enterprise.html @@ -622,7 +622,7 @@
Properties
Source:
@@ -680,7 +680,7 @@
Returns:
-

addUser(login, name, optionsopt, callbackopt) → {Promise.<Object>}

+

addAppUser(name, optionsopt, callbackopt) → {Promise.<Object>}

@@ -688,7 +688,7 @@

addUser - Create a new user in the current enterprise + Create a new app user in the current enterprise API Endpoint: '/users' Method: POST @@ -727,37 +727,6 @@
Parameters:
- - - login - - - - - -string - - - - - - - - - - - - - - - - - - The email address this user uses to login - - - - name @@ -845,13 +814,13 @@
Properties
- role + language -EnterpriseRole +string @@ -871,14 +840,14 @@
Properties
- This user’s enterprise role + The user's language - language + job_title @@ -904,20 +873,20 @@
Properties
- The user's language + The user’s job title - is_sync_enabled + phone -boolean +string @@ -937,14 +906,14 @@
Properties
- Whether or not this user can use Box Sync + The user’s phone number - job_title + address @@ -970,20 +939,20 @@
Properties
- The user’s job title + The user’s address - phone + space_amount -string +int @@ -1003,14 +972,14 @@
Properties
- The user’s phone number + The user’s total available storage space in bytes - address + timezone @@ -1036,20 +1005,27 @@
Properties
- The user’s address + The user's timezone + + + + + + + - space_amount + callback -int +function @@ -1069,86 +1045,161 @@
Properties
- The user’s total available storage space in bytes + Passed the created user if successful, error otherwise + + - - - tracking_codes - - - - -Array - - - - - - <optional>
- - +
- - - + - + - An array of key/value pairs set by the user’s admin - + - - - status - + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + - - - -EnterpriseUserStatus - - - - - - <optional>
- - - - - + +
Returns:
+ + +
+ A promise resolving to the created user +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + - The user's status - + +

addUser(login, name, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Create a new user in the current enterprise + +API Endpoint: '/users' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
can_see_managed_userslogin -boolean +string @@ -1157,8 +1208,6 @@
Properties
 - <optional>
- @@ -1168,14 +1217,14 @@
Properties
- 		Whether the user should be able to see other managed usersThe email address this user uses to login
timezonename @@ -1190,8 +1239,6 @@
Properties
 - <optional>
- @@ -1201,20 +1248,1196 @@
Properties
- 		The user's timezoneThe name of this user
is_exempt_from_device_limitsoptions -boolean +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
role + + +EnterpriseRole + + + + + + <optional>
+ + + + + + 		This user’s enterprise role
language + + +string + + + + + + <optional>
+ + + + + + 		The user's language
is_sync_enabled + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not this user can use Box Sync
job_title + + +string + + + + + + <optional>
+ + + + + + 		The user’s job title
phone + + +string + + + + + + <optional>
+ + + + + + 		The user’s phone number
address + + +string + + + + + + <optional>
+ + + + + + 		The user’s address
space_amount + + +int + + + + + + <optional>
+ + + + + + 		The user’s total available storage space in bytes
tracking_codes + + +Array + + + + + + <optional>
+ + + + + + 		An array of key/value pairs set by the user’s admin
status + + +EnterpriseUserStatus + + + + + + <optional>
+ + + + + + 		The user's status
can_see_managed_users + + +boolean + + + + + + <optional>
+ + + + + + 		Whether the user should be able to see other managed users
timezone + + +string + + + + + + <optional>
+ + + + + + 		The user's timezone
is_exempt_from_device_limits + + +boolean + + + + + + <optional>
+ + + + + + 		Whether to exempt this user from Enterprise device limits
is_exempt_from_login_verification + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not this user must use two-factor authentication
is_external_collab_restricted + + +boolean + + + + + + <optional>
+ + + + + + 		Whether the user is allowed to collaborate with users outside their enterprise
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the created user if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created user +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

addUser(login, name, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Create a new user in the current enterprise + +API Endpoint: '/users' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
login + + +string + + + + + + + + + + The email address this user uses to login
name + + +string + + + + + + + + + + The name of this user
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
role + + +EnterpriseRole + + + + + + <optional>
+ + + + + + 		This user’s enterprise role
language + + +string + + + + + + <optional>
+ + + + + + 		The user's language
is_sync_enabled + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not this user can use Box Sync
job_title + + +string + + + + + + <optional>
+ + + + + + 		The user’s job title
phone + + +string + + + + + + <optional>
+ + + + + + 		The user’s phone number
address + + +string + + + + + + <optional>
+ + + + + + 		The user’s address
space_amount + + +int + + + + + + <optional>
+ + + + + + 		The user’s total available storage space in bytes
tracking_codes + + +Array + + + + + + <optional>
+ + + + + + 		An array of key/value pairs set by the user’s admin
status + + +EnterpriseUserStatus + + + + + + <optional>
+ + + + + + 		The user's status
can_see_managed_users + + +boolean + + + + + + <optional>
+ + + + + + 		Whether the user should be able to see other managed users
timezone + + +string + + + + + + <optional>
+ + + + + + 		The user's timezone
is_exempt_from_device_limits + + +boolean @@ -1241,13 +2464,822 @@
Properties
is_exempt_from_login_verificationis_exempt_from_login_verification + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not this user must use two-factor authentication
is_external_collab_restricted + + +boolean + + + + + + <optional>
+ + + + + + 		Whether the user is allowed to collaborate with users outside their enterprise
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the created user if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created user +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUsers(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of users in the current enterprise + +API Endpoint: '/users' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
filter_term + + +string + + + + + + <optional>
+ + + + + + 		+ + Filter the results to only users starting with the filter_term in either the name or the login
limit + + +int + + + + + + <optional>
+ + + + + + 		+ + 100 + + The number of records to return
usemarker + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + + Whether or not to use marker-based pagination
marker + + +string + + + + + + <optional>
+ + + + + + 		+ + '' + + The marker for the page at which to start. Default is the first page
offset + + +int + + + + + + <optional>
+ + + + + + 		+ + 0 + + The record at which to start
user_type + + +EnterpriseUserType + + + + + + <optional>
+ + + + + + 		+ + managed + + The type of user to search for
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the list of users if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of users +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUsers(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of users in the current enterprise + +API Endpoint: '/users' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1809,7 +3973,7 @@
Properties
- + @@ -1850,7 +4014,7 @@
Properties
Source:
@@ -1879,7 +4043,7 @@
Returns:
- A promise resolving to the collection of users + A promise resolving to the invite object
@@ -1908,7 +4072,7 @@
Returns:
-

inviteUser(enterpriseID, email, callbackopt) → {Promise.<Object>}

+

transferUserContent(sourceUserID, destUserID, callbackopt) → {Promise.<Object>}

@@ -1916,10 +4080,10 @@

inviteUser<
- Invites a user to join the enterprise + Transfers all of a user's files into another user's account. -API Endpoint: '/invites' -Method: POST +API Endpoint: '/users/:sourceUserID/folders/0' +Method: PUT
@@ -1957,7 +4121,7 @@

Parameters:
- + + - + + @@ -2045,7 +4209,7 @@
Parameters:
- + @@ -2086,7 +4250,7 @@
Parameters:
Source:
@@ -2115,7 +4279,7 @@
Returns:
- A promise resolving to the invite object + A promise resolving to the folder containing the transferred content
@@ -2322,7 +4486,7 @@
Parameters:
Source:
@@ -2390,13 +4554,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseBase.html b/docs/jsdoc/EnterpriseBase.html index 6775ecd2..25397877 100644 --- a/docs/jsdoc/EnterpriseBase.html +++ b/docs/jsdoc/EnterpriseBase.html @@ -75,7 +75,7 @@

EnterpriseBase

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EnterpriseEventStream.html b/docs/jsdoc/EnterpriseEventStream.html index af9e27c3..151e62f8 100644 --- a/docs/jsdoc/EnterpriseEventStream.html +++ b/docs/jsdoc/EnterpriseEventStream.html @@ -562,7 +562,7 @@

getS
Source:
@@ -620,6 +620,222 @@

Returns:
+

getStreamPosition() → (nullable) {number}

+ + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ - Returns null if no events have been fetched from Box yet. +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + + + + + + + + + + +

getStreamState() → {Object}

+ + + + + + +
+ Get the stream state. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ - The stream state +
+ + + +
+
+ Type +
+
+ +Object + + +
+
+ + + + + + + + + + + + +

getStreamState() → {Object}

@@ -672,7 +888,7 @@

getStre
Source:
@@ -831,7 +1047,162 @@

Parameters:
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + + + + + + + + + + +

setStreamState(state) → {void}

+ + + + + + +
+ Set the stream state. +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1340,7 +3501,7 @@
Properties
- + @@ -1381,7 +3542,7 @@
Properties
Source:
@@ -1410,7 +3571,7 @@
Returns:
- A promise resolving to the created user + A promise resolving to the collection of users
@@ -1439,7 +3600,7 @@
Returns:
-

getUsers(optionsopt, callbackopt) → {Promise.<Object>}

+

inviteUser(enterpriseID, email, callbackopt) → {Promise.<Object>}

@@ -1447,10 +3608,10 @@

getUsers - Get a list of users in the current enterprise + Invites a user to join the enterprise -API Endpoint: '/users' -Method: GET +API Endpoint: '/invites' +Method: POST @@ -1460,64 +3621,10 @@

getUsersParameters:

- - -

NameTypeAttributesDefaultDescription
filter_term + + +string + + + + + + <optional>
+ + + + + + 		+ + Filter the results to only users starting with the filter_term in either the name or the login
limit -boolean +int @@ -1266,15 +3298,21 @@
Properties
+ 		+ + 100 + + Whether or not this user must use two-factor authenticationThe number of records to return
is_external_collab_restrictedusemarker @@ -1299,8 +3337,131 @@
Properties
+ 		+ + false + + Whether or not to use marker-based pagination
marker + + +string + + + + + + <optional>
+ + + + + + 		+ + '' + + Whether the user is allowed to collaborate with users outside their enterpriseThe marker for the page at which to start. Default is the first page
offset + + +int + + + + + + <optional>
+ + + + + + 		+ + 0 + + The record at which to start
user_type + + +EnterpriseUserType + + + + + + <optional>
+ + + + + + 		+ + managed + + The type of user to search for
Passed the created user if successful, error otherwisePassed the list of users if successful, error otherwise
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the invite object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + - - + + + +

inviteUser(enterpriseID, email, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Invites a user to join the enterprise + +API Endpoint: '/invites' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters, can be left null in most cases -
Properties
- - + +
Parameters:
+ + @@ -1532,8 +3639,6 @@
Properties
- - @@ -1544,7 +3649,7 @@
Properties
- + - - + - + - - + - + - - + + +
DefaultDescription
filter_termenterpriseID @@ -1559,8 +3664,6 @@
Properties
 - <optional>
- @@ -1569,25 +3672,21 @@
Properties
- 		- - Filter the results to only users starting with the filter_term in either the name or the loginThe ID of the enterprise to invite the user to
limitemail -int +string @@ -1596,8 +3695,6 @@
Properties
 - <optional>
- @@ -1606,27 +3703,21 @@
Properties
- 		- - 100 - - The number of records to returnThe email address of the user to invite
usemarkercallback -boolean +function @@ -1645,66 +3736,162 @@
Properties
- 		- - false - - Whether or not to use marker-based paginationPassed the invite object if successful, error otherwise
-
marker - - -string - - - - <optional>
- - +
- -
- - '' - - The marker for the page at which to start. Default is the first page
+ + + + + + + + + + + + + + + + + + - + - - + - + - - - - - - - -
NameTypeAttributesDescription
offsetenterpriseID -int +string @@ -1713,8 +3900,6 @@
Properties
 - <optional>
- @@ -1723,27 +3908,21 @@
Properties
- 		- - 0 - - The record at which to startThe ID of the enterprise to invite the user to
user_typeemail -EnterpriseUserType +string @@ -1752,8 +3931,6 @@
Properties
 - <optional>
- @@ -1762,21 +3939,8 @@
Properties
- 		- - managed - - The type of user to search for
- 		The email address of the user to invite
Passed the list of users if successful, error otherwisePassed the invite object if successful, error otherwise
enterpriseIDsourceUserID @@ -1981,14 +4145,14 @@
Parameters:
- 		The ID of the enterprise to invite the user toThe ID of the user whose files will be transferred
emaildestUserID @@ -2012,7 +4176,7 @@
Parameters:
- 		The email address of the user to inviteThe ID of the user to transfer the files to
Passed the invite object if successful, error otherwisePassed the new folder which contains all the files if successful, error otherwise
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
state + + +Object + + + + The stream state
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -895,13 +1266,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/EventStream.html b/docs/jsdoc/EventStream.html index 6a209c13..b8dba4e5 100644 --- a/docs/jsdoc/EventStream.html +++ b/docs/jsdoc/EventStream.html @@ -482,7 +482,7 @@

destroySource:
@@ -546,13 +546,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Events.html b/docs/jsdoc/Events.html index 18374cb6..18de215b 100644 --- a/docs/jsdoc/Events.html +++ b/docs/jsdoc/Events.html @@ -586,7 +586,7 @@
Properties
Source:
@@ -644,7 +644,7 @@
Returns:
-

getCurrentStreamPosition(callbackopt) → {Promise.<string>}

+

get(optionsopt, callbackopt) → {Promise.<Object>}

@@ -652,10 +652,22 @@

- Get the current stream position. + Get a chunk of events API Endpoint: '/events' Method: GET + +To get events from admin events stream you have to pick stream_type from `admin_logs` or `admin_logs_streaming`. +The `admin_logs` stream emphasis is on completeness over latency, +which means that Box will deliver admin events in chronological order and without duplicates, +but with higher latency. You can specify start and end time/dates. + +To monitor recent events that have been generated within Box across the enterprise use +`admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological +accuracy, which means that Box may return events more than once and out of chronological order. +Events are returned via the API around 12 seconds after they are processed by Box +(the 12 seconds buffer ensures that new events are not written after your cursor position). +Only two weeks of events are available via this feed, and you cannot set start and end time/dates. @@ -693,13 +705,13 @@
Parameters:
- callback + options -function +Object @@ -719,146 +731,9 @@
Parameters:
- Passed the current stream position if successful - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
- A promise resolving to the stream position -
- - - -
-
- Type -
-
- -Promise.<string> - - -
-
- - - - - - - - - - - - - -

getEnterpriseEventStream(optionsopt, callbackopt) → {Promise.<EnterpriseEventStream>}

- - - - - - -
- Create a stream of enterprise events. - -By default, the stream starts from the current time. -Pass 'startDate' to start from a specific time. -Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year). -Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds. -If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling). - -By default, stream pools `admin_logs` for events. The emphasis for this stream is on completeness over latency, -which means that Box will deliver admin events in chronological order and without duplicates, -but with higher latency. You can specify start and end time/dates. - -To monitor recent events that have been generated within Box across the enterprise use -`admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological -accuracy, which means that Box may return events more than once and out of chronological order. -Events are returned via the API around 12 seconds after they are processed by Box -(the 12 seconds buffer ensures that new events are not written after your cursor position). -Only two weeks of events are available via this feed, and you cannot set start and end time/dates. - -This method will only work with an API connection for an enterprise admin account -or service account with a manage enterprise properties. -
- - - - - - - - - -
Parameters:
- + Additional options for the request. Can be left null in most cases. +
Properties
+ @@ -884,13 +759,13 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
optionsstream_type -Object +string @@ -910,37 +785,48 @@
Parameters:
- 		Options -
Properties
+ 		From which stream events should be selected. + Possible values are `admin_logs` and `admin_logs_streaming`
created_after + +string - - - - - - - + + - - - + + - + - - - + + + + + + + + - - + + + + + + + + + + + + + + - + + + - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributes + + <optional>
+ - - 		DefaultDescription
The date to start from in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
streamPositioncreated_before @@ -965,25 +851,54 @@
Properties
- 		+ + The date to end at in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
event_type + + +string + + + + + + <optional>
+ + + + 		The stream position to start from (pass '0' for all past events)String of event types to return coma separated: for example 'DOWNLOAD,UPLOAD'
startDatelimit -string +number @@ -1001,20 +916,1614 @@
Properties
 - - Number of events to fetch per call
stream_position + + +string + + + + + + <optional>
+ + + + + + 		The stream position to start from (pass '0' for all past events)
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the current stream position if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of events +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCurrentStreamPosition(callbackopt) → {Promise.<string>}

+ + + + + + +
+ Get the current stream position. + +API Endpoint: '/events' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the current stream position if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the stream position +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

getCurrentStreamPosition(callbackopt) → {Promise.<string>}

+ + + + + + +
+ Get the current stream position. + +API Endpoint: '/events' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the current stream position if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the stream position +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

getEnterpriseEventStream(optionsopt, callbackopt) → {Promise.<EnterpriseEventStream>}

+ + + + + + +
+ Create a stream of enterprise events. + +By default, the stream starts from the current time. +Pass 'startDate' to start from a specific time. +Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year). +Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds. +If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling). + +By default, stream pools `admin_logs` for events. The emphasis for this stream is on completeness over latency, +which means that Box will deliver admin events in chronological order and without duplicates, +but with higher latency. You can specify start and end time/dates. + +To monitor recent events that have been generated within Box across the enterprise use +`admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological +accuracy, which means that Box may return events more than once and out of chronological order. +Events are returned via the API around 12 seconds after they are processed by Box +(the 12 seconds buffer ensures that new events are not written after your cursor position). +Only two weeks of events are available via this feed, and you cannot set start and end time/dates. + +This method will only work with an API connection for an enterprise admin account +or service account with a manage enterprise properties. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Options +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
streamPosition + + +string + + + + + + <optional>
+ + + + + + 		+ + The stream position to start from (pass '0' for all past events)
startDate + + +string + + + + + + <optional>
+ + + + + + 		+ + The date to start from
endDate + + +string + + + + + + <optional>
+ + + + + + 		+ + The date to end at
eventTypeFilter + + +Array.<EventType> + + + + + + <optional>
+ + + + + + 		+ + Array of event types to return
pollingInterval + + +int + + + + + + <optional>
+ + + + + + 		+ + 60 + + Polling interval (in seconds). Pass 0 for no polling.
chunkSize + + +int + + + + + + <optional>
+ + + + + + 		+ + 500 + + Number of events to fetch per call (max = 500)
streamType + + +string + + + + + + <optional>
+ + + + + + 		+ + From which stream events should be selected. + Possible values are `admin_logs` and `admin_logs_streaming`
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the events stream if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the enterprise event stream +
+ + + +
+
+ Type +
+
+ +Promise.<EnterpriseEventStream> + + +
+
+ + + + + + + + + + + + + +

getEnterpriseEventStream(optionsopt, callbackopt) → {Promise.<EnterpriseEventStream>}

+ + + + + + +
+ Create a stream of enterprise events. + +By default, the stream starts from the current time. +Pass 'startDate' to start from a specific time. +Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year). +Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds. +If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling). + +By default, stream pools `admin_logs` for events. The emphasis for this stream is on completeness over latency, +which means that Box will deliver admin events in chronological order and without duplicates, +but with higher latency. You can specify start and end time/dates. + +To monitor recent events that have been generated within Box across the enterprise use +`admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological +accuracy, which means that Box may return events more than once and out of chronological order. +Events are returned via the API around 12 seconds after they are processed by Box +(the 12 seconds buffer ensures that new events are not written after your cursor position). +Only two weeks of events are available via this feed, and you cannot set start and end time/dates. + +This method will only work with an API connection for an enterprise admin account +or service account with a manage enterprise properties. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Options +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
streamPosition + + +string + + + + + + <optional>
+ + + + + + 		+ + The stream position to start from (pass '0' for all past events)
startDate + + +string + + + + + + <optional>
+ + + + + + 		+ + The date to start from
endDate + + +string + + + + + + <optional>
+ + + + + + 		+ + The date to end at
eventTypeFilter + + +Array.<EventType> + + + + + + <optional>
+ + + + + + 		+ + Array of event types to return
pollingInterval + + +int + + + + + + <optional>
+ + + + + + 		+ + 60 + + Polling interval (in seconds). Pass 0 for no polling.
chunkSize + + +int + + + + + + <optional>
+ + + + + + 		+ + 500 + + Number of events to fetch per call (max = 500)
streamType + + +string + + + + + + <optional>
+ + + + + + 		+ + From which stream events should be selected. + Possible values are `admin_logs` and `admin_logs_streaming`
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the events stream if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the enterprise event stream +
+ + + +
+
+ Type +
+
+ +Promise.<EnterpriseEventStream> + + +
+
+ + + + + + + + + + + + + +

getEventStream(streamPositionopt, optionsopt, callbackopt) → {Promise.<EventStream>}

+ + + + + + +
+ Create a stream of events, using the long-poll API to wait for new events. + +API Endpoint: '/events' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + - - + + + + + + - + - - + - + - - - +
NameTypeAttributesThe date to start from
Description
endDatestreamPosition @@ -1039,25 +2548,21 @@
Properties
- 		- - The date to end atStarting stream position
eventTypeFilteroptions -Array.<EventType> +Object @@ -1076,19 +2581,38 @@
Properties
- 		+ + Optional parameters for the event stream +
Properties
- 		Array of event types to return
+ + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + @@ -1278,7 +2803,7 @@
Properties
Source:
@@ -1307,7 +2832,7 @@
Returns:
- A promise resolving to the enterprise event stream + A promise resolving to the event stream
@@ -1318,7 +2843,7 @@
Returns:
-Promise.<EnterpriseEventStream> +Promise.<EventStream>
@@ -1665,7 +3190,7 @@
Properties
Source:
@@ -1839,7 +3364,181 @@
Parameters:
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the long poll info +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getLongPollInfo(callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get information for long-polling until new events are available + +API Endpoint: '/events' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDefaultDescription
pollingIntervalretryDelay @@ -1115,19 +2639,19 @@
Properties
 - 60 + 1000 Polling interval (in seconds). Pass 0 for no polling.Number of ms to wait before retrying after an error
chunkSizededuplicationFilterSize @@ -1154,25 +2678,25 @@
Properties
 - 500 + 5000 Number of events to fetch per call (max = 500)Number of IDs to track for deduplication
streamTypefetchInterval -string +int @@ -1193,11 +2717,12 @@
Properties
 + 1000 + From which stream events should be selected. - Possible values are `admin_logs` and `admin_logs_streaming`Minimunm number of ms between calls for more events
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the long poll info if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -1907,13 +3606,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileBase.html b/docs/jsdoc/FileBase.html index a951416d..b8d678fa 100644 --- a/docs/jsdoc/FileBase.html +++ b/docs/jsdoc/FileBase.html @@ -76,7 +76,7 @@

FileBase

Source:
@@ -166,7 +166,7 @@
Type:
Source:
@@ -245,7 +245,7 @@
Type:
Source:
@@ -318,7 +318,7 @@
Type:
Source:
@@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileMini.html b/docs/jsdoc/FileMini.html index e9fa859d..6ce00100 100644 --- a/docs/jsdoc/FileMini.html +++ b/docs/jsdoc/FileMini.html @@ -75,7 +75,7 @@

FileMini

Source:
@@ -162,7 +162,7 @@
Type:
Source:
@@ -235,7 +235,7 @@
Type:
Source:
@@ -320,7 +320,7 @@
Type:
Source:
@@ -394,7 +394,7 @@
Type:
Source:
@@ -428,13 +428,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionBase.html b/docs/jsdoc/FileVersionBase.html index 8aa1bf11..f9b33f3b 100644 --- a/docs/jsdoc/FileVersionBase.html +++ b/docs/jsdoc/FileVersionBase.html @@ -76,7 +76,7 @@

FileVersionBase

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -237,7 +237,7 @@
Type:
Source:
@@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FileVersionMini.html b/docs/jsdoc/FileVersionMini.html index 7a0e2ad5..c4eabe6d 100644 --- a/docs/jsdoc/FileVersionMini.html +++ b/docs/jsdoc/FileVersionMini.html @@ -75,7 +75,7 @@

FileVersionMini

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -197,13 +197,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Files.html b/docs/jsdoc/Files.html index 65a8f39f..5e286739 100644 --- a/docs/jsdoc/Files.html +++ b/docs/jsdoc/Files.html @@ -246,7 +246,7 @@
Type:
Source:
@@ -421,7 +421,7 @@
Parameters:
Source:
@@ -479,7 +479,7 @@
Returns:
-

addMetadata(fileID, scope, template, data, callbackopt) → {Promise.<Object>}

+

abortUploadSession(sessionID, callbackopt) → {Promise.<void>}

@@ -487,11 +487,10 @@

addMetadat
- Adds metadata to a file. Metadata must either match a template schema or -be placed into the unstructured "properties" template in global scope. + Abort an upload session, discarding any chunks that were uploaded to it -API Endpoint: '/files/:fileID/metadata/:scope/:template' -Method: POST +API Endpoint: '/files/upload_sessions/:sessionID' +Method: DELETE
@@ -529,69 +528,7 @@

Parameters:
- fileID - - - - - -string - - - - - - - - - - - - - - - - - - The ID of the file to add metadata to - - - - - - - scope - - - - - -string - - - - - - - - - - - - - - - - - - The scope of the metadata template, e.g. "enterprise" - - - - - - - template + sessionID @@ -615,38 +552,7 @@
Parameters:
- The metadata template schema to add - - - - - - - data - - - - - -Object - - - - - - - - - - - - - - - - - - Key/value pairs tp add as metadata + The ID of the upload session to commit @@ -679,7 +585,7 @@
Parameters:
- Called with error if unsuccessful + Passed nothing if successful, error otherwise @@ -720,7 +626,7 @@
Parameters:
Source:
@@ -749,7 +655,7 @@
Returns:
- A promise resolving to the new metadata + A promise resolving to nothing
@@ -760,7 +666,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -778,7 +684,7 @@
Returns:
-

addToCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

+

addMetadata(fileID, scope, template, data, callbackopt) → {Promise.<Object>}

@@ -786,10 +692,11 @@

addToC
- Add a file to a given collection + Adds metadata to a file. Metadata must either match a template schema or +be placed into the unstructured "properties" template in global scope. -API Endpoint: '/files/:fileID' -Method: PUT +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: POST
@@ -851,14 +758,14 @@

Parameters:
- The file to add to the collection + The ID of the file to add metadata to - collectionID + scope @@ -882,7 +789,69 @@
Parameters:
- The collection to add the file to + The scope of the metadata template, e.g. "enterprise" + + + + + + + template + + + + + +string + + + + + + + + + + + + + + + + + + The metadata template schema to add + + + + + + + data + + + + + +Object + + + + + + + + + + + + + + + + + + Key/value pairs tp add as metadata @@ -915,7 +884,7 @@
Parameters:
- Passed the updated file if successful, error otherwise + Called with error if unsuccessful @@ -956,7 +925,7 @@
Parameters:
Source:
@@ -985,7 +954,7 @@
Returns:
- A promise resolving to the updated file object + A promise resolving to the new metadata
@@ -1014,7 +983,7 @@
Returns:
-

applyWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

addMetadata(fileID, scope, template, data, callbackopt) → {Promise.<Object>}

@@ -1022,10 +991,11 @@

applyWa
- Used to apply or update the watermark for a corresponding Box file. + Adds metadata to a file. Metadata must either match a template schema or +be placed into the unstructured "properties" template in global scope. -API Endpoint: '/files/:fileID/watermark' -Method: PUT +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: POST
@@ -1087,20 +1057,20 @@

Parameters:
- The Box ID of the file to update watermark for + The ID of the file to add metadata to - options + scope -Object +string @@ -1109,8 +1079,6 @@
Parameters:
- <optional>
- @@ -1120,20 +1088,20 @@
Parameters:
- Optional parameters, can be left null + The scope of the metadata template, e.g. "enterprise" - callback + template -function +string @@ -1142,8 +1110,6 @@
Parameters:
- <optional>
- @@ -1153,31 +1119,95 @@
Parameters:
- Passed the watermark information if successful, error otherwise + The metadata template schema to add - - + + + data + + + + +Object + + + + + -
+ - + + + - + - + Key/value pairs tp add as metadata + - + + + callback + - + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Called with error if unsuccessful + + + + + + + + + + + +
+ + + + + + + + + + + + @@ -1194,7 +1224,7 @@
Parameters:
Source:
@@ -1223,7 +1253,7 @@
Returns:
- A promise resolving to the watermark info + A promise resolving to the new metadata
@@ -1252,7 +1282,7 @@
Returns:
-

commitUploadSession(sessionID, fileHash, optionsopt, callbackopt) → {Promise.<Object>}

+

addToCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

@@ -1260,10 +1290,10 @@

co
- Commit an upload session after all parts have been uploaded, creating the new file + Add a file to a given collection -API Endpoint: '/files/upload_sessions/:sessionID/commit' -Method: POST +API Endpoint: '/files/:fileID' +Method: PUT
@@ -1301,7 +1331,7 @@

Parameters:
- sessionID + fileID @@ -1325,14 +1355,14 @@
Parameters:
- The ID of the upload session to commit + The file to add to the collection - fileHash + collectionID @@ -1356,20 +1386,20 @@
Parameters:
- The base64-encoded SHA-1 hash of the file being uploaded + The collection to add the file to - options + callback -Object +function @@ -1389,9 +1419,129 @@
Parameters:
- Optional parameters set on the created file, can be left null -
Properties
- + Passed the updated file if successful, error otherwise + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

addToCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Add a file to a given collection + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ @@ -1417,13 +1567,13 @@
Properties
- + + - + - - - - -
partsfileID -Array.<UploadPart> +string @@ -1432,8 +1582,6 @@
Properties
 - <optional>
- @@ -1443,14 +1591,14 @@
Properties
- 		The list of uploaded parts to be committed, will be fetched from the API otherwiseThe file to add to the collection
descriptioncollectionID @@ -1465,8 +1613,6 @@
Properties
 - <optional>
- @@ -1476,14 +1622,7 @@
Properties
- 		Optional description of the uploaded file.
- - + The collection to add the file to @@ -1516,7 +1655,7 @@
Properties
- Passed the new file information if successful + Passed the updated file if successful, error otherwise @@ -1557,7 +1696,7 @@
Properties
Source:
@@ -1586,7 +1725,7 @@
Returns:
- A promise resolving to the uploaded file object + A promise resolving to the updated file object
@@ -1615,7 +1754,7 @@
Returns:
-

copy(fileID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

+

applyWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1623,10 +1762,10 @@

copy - Copy a file into a new folder. + Used to apply or update the watermark for a corresponding Box file. -API Endpoint: '/files/:fileID/copy -Method: POST +API Endpoint: '/files/:fileID/watermark' +Method: PUT @@ -1688,20 +1827,20 @@
Parameters:
- The Box ID of the file being requested + The Box ID of the file to update watermark for - newParentID + options -string +Object @@ -1710,6 +1849,8 @@
Parameters:
+ <optional>
+ @@ -1719,20 +1860,20 @@
Parameters:
- The Box ID for the new parent folder. '0' to copy to All Files. + Optional parameters, can be left null - options + callback -Object +function @@ -1752,106 +1893,12 @@
Parameters:
- Optional parameters for the copy operation, can be left null in most cases -
Properties
- + Passed the watermark information if successful, error otherwise + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
name - - -string - - - - - - <optional>
- - - - - - 		A new name to use if there is an identically-named item in the new parent folder
- - - - - - - - - callback - - - - - -function - - - - - - - - - <optional>
- - - - - - - - - - - passed the new file info if call was successful - - - - - + + + @@ -1887,7 +1934,7 @@
Properties
Source:
@@ -1916,7 +1963,7 @@
Returns:
- A promise resolving to the new file object + A promise resolving to the watermark info
@@ -1945,7 +1992,7 @@
Returns:
-

createNewVersionUploadSession(fileID, size, callbackopt) → {Promise.<Object>}

+

applyWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1953,12 +2000,10 @@

- Creates a session used to upload a new version of a file in chunks. This -will first verify that the version can be created and then open a session for -uploading pieces of the file. + Used to apply or update the watermark for a corresponding Box file. -API Endpoint: '/files/:fileID/upload_sessions' -Method: POST +API Endpoint: '/files/:fileID/watermark' +Method: PUT @@ -2020,20 +2065,20 @@
Parameters:
- The ID of the file to upload a new version of + The Box ID of the file to update watermark for - size + options -int +Object @@ -2042,6 +2087,8 @@
Parameters:
+ <optional>
+ @@ -2051,7 +2098,7 @@
Parameters:
- The size of the file that will be uploaded + Optional parameters, can be left null @@ -2084,7 +2131,7 @@
Parameters:
- Passed the upload session info if successful + Passed the watermark information if successful, error otherwise @@ -2125,7 +2172,7 @@
Parameters:
Source:
@@ -2154,7 +2201,7 @@
Returns:
- A promise resolving to the new upload session object + A promise resolving to the watermark info
@@ -2183,7 +2230,7 @@
Returns:
-

createUploadSession(folderID, size, name, callbackopt) → {Promise.<Object>}

+

commitUploadSession(sessionID, fileHash, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2191,11 +2238,9 @@

cr
- Creates a session used to upload a new file in chunks.. This will first -verify that the file can be created and then open a session for uploading -pieces of the file. + Commit an upload session after all parts have been uploaded, creating the new file -API Endpoint: '/files/upload_sessions' +API Endpoint: '/files/upload_sessions/:sessionID/commit' Method: POST
@@ -2234,7 +2279,7 @@

Parameters:
- folderID + sessionID @@ -2258,20 +2303,20 @@
Parameters:
- The ID of the folder to upload the file to + The ID of the upload session to commit - size + fileHash -int +string @@ -2289,14 +2334,101 @@
Parameters:
- The size of the file that will be uploaded + The base64-encoded SHA-1 hash of the file being uploaded - name + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters set on the created file, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parts + + +Array.<UploadPart> + + + + + + <optional>
+ + + + + + 		The list of uploaded parts to be committed, will be fetched from the API otherwise
description @@ -2311,6 +2443,8 @@
Parameters:
 + <optional>
+ @@ -2320,7 +2454,14 @@
Parameters:
- 		The name of the file to be createdOptional description of the uploaded file.
+ + @@ -2353,7 +2494,7 @@
Parameters:
- Passed the upload session info if successful + Passed the new file information if successful @@ -2394,7 +2535,7 @@
Parameters:
Source:
@@ -2423,7 +2564,7 @@
Returns:
- A promise resolving to the new upload session object + A promise resolving to the uploaded file object
@@ -2452,7 +2593,7 @@
Returns:
-

createZip(name, items, callbackopt) → {Promise.<string>}

+

commitUploadSession(sessionID, fileHash, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2460,9 +2601,9 @@

createZip - Creates a zip of multiple files and folders. + Commit an upload session after all parts have been uploaded, creating the new file -API Endpoint: '/zip_downloads' +API Endpoint: '/files/upload_sessions/:sessionID/commit' Method: POST @@ -2501,13 +2642,13 @@
Parameters:
- name + sessionID -name +string @@ -2525,20 +2666,20 @@
Parameters:
- The name of the zip file to be created + The ID of the upload session to commit - items + fileHash -Array +string @@ -2556,20 +2697,20 @@
Parameters:
- Array of files or folders to be part of the created zip + The base64-encoded SHA-1 hash of the file being uploaded - callback + options -function +Object @@ -2589,7 +2730,134 @@
Parameters:
- Passed a zip information object + Optional parameters set on the created file, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parts + + +Array.<UploadPart> + + + + + + <optional>
+ + + + + + 		The list of uploaded parts to be committed, will be fetched from the API otherwise
description + + +string + + + + + + <optional>
+ + + + + + 		Optional description of the uploaded file.
+ + + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the new file information if successful @@ -2630,7 +2898,7 @@
Parameters:
Source:
@@ -2659,7 +2927,7 @@
Returns:
- A promise resolving to a zip information object + A promise resolving to the uploaded file object
@@ -2670,7 +2938,7 @@
Returns:
-Promise.<string> +Promise.<Object>
@@ -2688,7 +2956,7 @@
Returns:
-

delete(fileID, optionsopt, callbackopt) → {Promise.<void>}

+

copy(fileID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2696,10 +2964,10 @@

delete - Delete a given file. + Copy a file into a new folder. -API Endpoint: '/files/:fileID' -Method: DELETE +API Endpoint: '/files/:fileID/copy +Method: POST @@ -2761,7 +3029,38 @@
Parameters:
- Box ID of the file being requested + The Box ID of the file being requested + + + + + + + newParentID + + + + + +string + + + + + + + + + + + + + + + + + + The Box ID for the new parent folder. '0' to copy to All Files. @@ -2794,7 +3093,7 @@
Parameters:
- Optional parameters + Optional parameters for the copy operation, can be left null in most cases
Properties
@@ -2822,7 +3121,7 @@
Properties
- etag + name @@ -2848,7 +3147,7 @@
Properties
- Only delete the file if the etag value matches + A new name to use if there is an identically-named item in the new parent folder @@ -2888,7 +3187,7 @@
Properties
- Empty response body passed if successful. + passed the new file info if call was successful @@ -2929,7 +3228,7 @@
Properties
Source:
@@ -2958,7 +3257,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new file object
@@ -2969,7 +3268,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2987,7 +3286,7 @@
Returns:
-

deleteMetadata(fileID, scope, template, callbackopt) → {Promise.<void>}

+

copy(fileID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2995,10 +3294,10 @@

deleteM
- Deletes a metadata template from a file. + Copy a file into a new folder. -API Endpoint: '/files/:fileID/metadata/:scope/:template' -Method: DELETE +API Endpoint: '/files/:fileID/copy +Method: POST
@@ -3060,14 +3359,14 @@

Parameters:
- The ID of the file to remove metadata from + The Box ID of the file being requested - scope + newParentID @@ -3091,20 +3390,20 @@
Parameters:
- The scope of the metadata template + The Box ID for the new parent folder. '0' to copy to All Files. - template + options -string +Object @@ -3113,6 +3412,8 @@
Parameters:
+ <optional>
+ @@ -3122,20 +3423,41 @@
Parameters:
- The template to remove from the file - + Optional parameters for the copy operation, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + +
NameTypeAttributesDescription
callbackname -function +string @@ -3155,27 +3477,67 @@
Parameters:
- 		Called with nothing if successful, error otherwiseA new name to use if there is an identically-named item in the new parent folder
- - - - - -
+ + - + + + callback + - + + + +function - + + + + + + + + <optional>
+ + + + + + + + + + + passed the new file info if call was successful + + + + + + + + + + + +
+ + + + + + + + @@ -3196,7 +3558,7 @@
Parameters:
Source:
@@ -3225,7 +3587,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new file object
@@ -3236,7 +3598,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -3254,7 +3616,7 @@
Returns:
-

deletePermanently(fileID, optionsopt, callbackopt) → {Promise.<void>}

+

createNewVersionUploadSession(fileID, size, callbackopt) → {Promise.<Object>}

@@ -3262,10 +3624,12 @@

dele
- Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone. + Creates a session used to upload a new version of a file in chunks. This +will first verify that the version can be created and then open a session for +uploading pieces of the file. -API Endpoint: '/files/:fileID/trash' -Method: DELETE +API Endpoint: '/files/:fileID/upload_sessions' +Method: POST
@@ -3327,74 +3691,20 @@

Parameters:
- The ID of the file to remove metadata from + The ID of the file to upload a new version of - options - - - - - -Object - - - - - - - - - <optional>
- - - - - - - - - - - Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - -
NameTypeAttributesDescription
etagsize -string +int @@ -3403,8 +3713,6 @@
Properties
 - <optional>
- @@ -3414,14 +3722,7 @@
Properties
- 		Only delete the file if the etag matches
- - + The size of the file that will be uploaded @@ -3454,7 +3755,7 @@
Properties
- Called with nothing if successful, error otherwise + Passed the upload session info if successful @@ -3495,7 +3796,7 @@
Properties
Source:
@@ -3524,7 +3825,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new upload session object
@@ -3535,7 +3836,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -3553,7 +3854,7 @@
Returns:
-

deleteVersion(fileID, versionID, optionsopt, callbackopt) → {Promise.<void>}

+

createNewVersionUploadSession(fileID, size, callbackopt) → {Promise.<Object>}

@@ -3561,11 +3862,12 @@

deleteVe
- Discards a specific file version to the trash. Depending on the enterprise settings -for this user, the item will either be actually deleted from Box or moved to the trash. + Creates a session used to upload a new version of a file in chunks. This +will first verify that the version can be created and then open a session for +uploading pieces of the file. -API Endpoint: '/files/:fileID/version/:versionID' -Method: DELETE +API Endpoint: '/files/:fileID/upload_sessions' +Method: POST
@@ -3627,105 +3929,20 @@

Parameters:
- The file ID which old version will be moved to the trash or delete permanently - - - - - - - versionID - - - - - -string - - - - - - - - - - - - - - - - - - The ID of the version to move to the trash or delete permanently + The ID of the file to upload a new version of - options - - - - - -Object - - - - - - - - - <optional>
- - - - - - - - - - - Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - -
NameTypeAttributesDescription
etagsize -string +int @@ -3734,8 +3951,6 @@
Properties
 - <optional>
- @@ -3745,14 +3960,7 @@
Properties
- 		Only delete the version of the file etag matches
- - + The size of the file that will be uploaded @@ -3785,7 +3993,7 @@
Properties
- Empty response body, error otherwise + Passed the upload session info if successful @@ -3826,7 +4034,7 @@
Properties
Source:
@@ -3855,7 +4063,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new upload session object
@@ -3866,7 +4074,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -3884,7 +4092,7 @@
Returns:
-

downloadZip(name, items, stream, callbackopt) → {Promise.<Readable>}

+

createUploadSession(folderID, size, name, callbackopt) → {Promise.<Object>}

@@ -3892,10 +4100,12 @@

downloadZi
- Creates a zip of multiple files and folders and downloads it. + Creates a session used to upload a new file in chunks.. This will first +verify that the file can be created and then open a session for uploading +pieces of the file. -API Endpoint: '/zip_downloads' -Method: GET +API Endpoint: '/files/upload_sessions' +Method: POST
@@ -3933,13 +4143,13 @@

Parameters:
- name + folderID -name +string @@ -3957,20 +4167,20 @@
Parameters:
- The name of the zip file to be created + The ID of the folder to upload the file to - items + size -Array +int @@ -3988,20 +4198,20 @@
Parameters:
- Array of files or folders to be part of the created zip + The size of the file that will be uploaded - stream + name -Stream +string @@ -4019,7 +4229,7 @@
Parameters:
- Stream to pipe the readable stream of the zip file + The name of the file to be created @@ -4052,7 +4262,7 @@
Parameters:
- Passed a zip download status object + Passed the upload session info if successful @@ -4093,7 +4303,7 @@
Parameters:
Source:
@@ -4122,7 +4332,7 @@
Returns:
- A promise resolving to a zip download status object + A promise resolving to the new upload session object
@@ -4133,7 +4343,7 @@
Returns:
-Promise.<Readable> +Promise.<Object>
@@ -4151,7 +4361,7 @@
Returns:
-

get(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

createUploadSession(folderID, size, name, callbackopt) → {Promise.<Object>}

@@ -4159,10 +4369,12 @@

get - Requests a file object with the given ID. + Creates a session used to upload a new file in chunks.. This will first +verify that the file can be created and then open a session for uploading +pieces of the file. -API Endpoint: '/files/:fileID' -Method: GET +API Endpoint: '/files/upload_sessions' +Method: POST @@ -4200,7 +4412,7 @@
Parameters:
- fileID + folderID @@ -4224,20 +4436,20 @@
Parameters:
- Box ID of the file being requested + The ID of the folder to upload the file to - options + size -Object +int @@ -4246,7 +4458,36 @@
Parameters:
- <optional>
+ + + + + + + + + + The size of the file that will be uploaded + + + + + + + name + + + + + +string + + + + + + + @@ -4257,7 +4498,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + The name of the file to be created @@ -4290,7 +4531,7 @@
Parameters:
- Passed the file information if it was acquired successfully + Passed the upload session info if successful @@ -4331,7 +4572,7 @@
Parameters:
Source:
@@ -4360,7 +4601,7 @@
Returns:
- A promise resolving to the file object + A promise resolving to the new upload session object
@@ -4389,7 +4630,7 @@
Returns:
-

getAllMetadata(fileID, callbackopt) → {Promise.<Object>}

+

createZip(name, items, callbackopt) → {Promise.<string>}

@@ -4397,10 +4638,10 @@

getAllM
- Retrieves all metadata associated with a file. + Creates a zip of multiple files and folders. -API Endpoint: '/files/:fileID/metadata' -Method: GET +API Endpoint: '/zip_downloads' +Method: POST
@@ -4438,13 +4679,13 @@

Parameters:
- fileID + name -string +name @@ -4462,7 +4703,38 @@
Parameters:
- the ID of the file to get metadata for + The name of the zip file to be created + + + + + + + items + + + + + +Array + + + + + + + + + + + + + + + + + + Array of files or folders to be part of the created zip @@ -4495,7 +4767,7 @@
Parameters:
- called with an array of metadata when successful + Passed a zip information object @@ -4536,7 +4808,7 @@
Parameters:
Source:
@@ -4565,7 +4837,7 @@
Returns:
- A promise resolving to a collection of metadata on the file + A promise resolving to a zip information object
@@ -4576,7 +4848,7 @@
Returns:
-Promise.<Object> +Promise.<string>
@@ -4594,7 +4866,7 @@
Returns:
-

getChunkedUploader(folderID, size, name, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

+

createZip(name, items, callbackopt) → {Promise.<string>}

@@ -4602,10 +4874,9 @@

get
- Upload a file in chunks, which is generally faster and more reliable for -large files. + Creates a zip of multiple files and folders. -API Endpoint: '/files/upload_sessions' +API Endpoint: '/zip_downloads' Method: POST
@@ -4644,13 +4915,13 @@

Parameters:
- folderID + name -string +name @@ -4668,20 +4939,20 @@
Parameters:
- The ID of the folder to upload the file to + The name of the zip file to be created - size + items -int +Array @@ -4699,20 +4970,20 @@
Parameters:
- The size of the file that will be uploaded + Array of files or folders to be part of the created zip - name + callback -string +function @@ -4721,6 +4992,8 @@
Parameters:
+ <optional>
+ @@ -4730,120 +5003,168 @@
Parameters:
- The name of the file to be created + Passed a zip information object + + - - - file - - - - -Buffer -| -string -| -Readable - - +
- - - + - + - - - + - + - The file to upload - + - - - options - + - - - -Object + + - - + - - - - <optional>
- + - + - - - + +
Source:
+
+ - + - Optional parameters for the upload -
Properties
- + - - - - - - + + - - - - - - - - - - - - - - - + + + + + +
Returns:
+ + +
+ A promise resolving to a zip information object +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

delete(fileID, optionsopt, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a given file. + +API Endpoint: '/files/:fileID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
parallelism - - -int - -
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - - - - - + @@ -10298,7 +10713,7 @@
Parameters:
- + @@ -10339,7 +10754,7 @@
Parameters:
Source:
@@ -10368,7 +10783,7 @@
Returns:
- A promise resolving to the upload data + A promise resolving to the collection of comments
@@ -10397,7 +10812,7 @@
Returns:
-

preflightUploadNewFileVersion(fileID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+

getComments(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -10405,17 +10820,10 @@

- Get preflight information for a file version upload. Without any file data, -this will return an upload URL and token to be used when uploading the file. -Using this upload URL will allow for the fastest upload, and the one-time -token can be passed to a worker or other client to actually perform the -upload with. If file data (e.g. size, parent, name) is passed, it will be -validated as if the actual file were being uploaded. This enables checking -of preconditions such as name uniqueness and available storage space before -attempting a large file upload. + Gets the comments on a file. -API Endpoint: '/files/:fileID/content' -Method: OPTIONS +API Endpoint: '/files/:fileID/comments' +Method: GET @@ -10477,40 +10885,7 @@
Parameters:
-

- - - - - - - - - - - - - - - - - - + @@ -10576,7 +10951,7 @@
Parameters:
- + @@ -10617,7 +10992,7 @@
Parameters:
Source:
@@ -10646,7 +11021,7 @@
Returns:
- A promise resolving to the upload data + A promise resolving to the collection of comments
@@ -10675,7 +11050,7 @@
Returns:
-

promoteVersion(fileID, versionID, callbackopt) → {Promise.<Object>}

+

getDownloadURL(fileID, optionsopt, callbackopt) → {Promise.<string>}

@@ -10683,13 +11058,13 @@

promote
- If there are previous versions of this file, this method can be used to promote one of the older -versions to the top of the stack. This actually mints a copy of the old version and puts it on -the top of the versions stack. The file will have the exact same contents, the same SHA1/etag, -and the same name as the original. Other properties such as comments do not get updated to their former values. + Requests a download URL for a given file. -API Endpoint: '/files/:fileID/versions/current' -Method: POST +API Endpoint: '/files/:fileID/content' +Method: GET +Special Expected Responses: + 202 ACCEPTED - Download isn't available yet. Returns an error. + 302 FOUND - Download is available. A Download URL is returned.
@@ -10751,20 +11126,20 @@

Parameters:
- + - + + @@ -10815,7 +11192,7 @@
Parameters:
- + @@ -10856,7 +11233,7 @@
Parameters:
Source:
@@ -10885,7 +11262,7 @@
Returns:
- A promise resolving to the promoted file version + A promise resolving to the file's download URL
@@ -10896,7 +11273,7 @@
Returns:
-Promise.<Object> +Promise.<string>
@@ -10914,7 +11291,7 @@
Returns:
-

removeFromCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

+

getDownloadURL(fileID, optionsopt, callbackopt) → {Promise.<string>}

@@ -10922,10 +11299,13 @@

r
- Remove a file from a given collection + Requests a download URL for a given file. -API Endpoint: '/files/:fileID' -Method: PUT +API Endpoint: '/files/:fileID/content' +Method: GET +Special Expected Responses: + 202 ACCEPTED - Download isn't available yet. Returns an error. + 302 FOUND - Download is available. A Download URL is returned.
@@ -10987,20 +11367,20 @@

Parameters:
- + - + + @@ -11051,7 +11433,7 @@
Parameters:
- + @@ -11092,7 +11474,7 @@
Parameters:
Source:
@@ -11121,7 +11503,7 @@
Returns:
- A promise resolving to the updated file object + A promise resolving to the file's download URL
@@ -11132,7 +11514,7 @@
Returns:
-Promise.<Object> +Promise.<string>
@@ -11150,7 +11532,7 @@
Returns:
-

removeWatermark(fileID, callbackopt) → {Promise.<void>}

+ @@ -11158,10 +11540,11 @@

remove
- Used to remove the watermark for a corresponding Box file. + Used to retrieve an expiring URL for creating an embedded preview session. +The URL will expire after 60 seconds and the preview session will expire after 60 minutes. -API Endpoint: '/files/:fileID/watermark' -Method: DELETE +API Endpoint: '/files/:fileID?fields=expiring_embed_link' +Method: GET
@@ -11223,7 +11606,7 @@

Parameters:
- + @@ -11256,7 +11639,7 @@
Parameters:
- + @@ -11297,7 +11680,7 @@
Parameters:
Source:
@@ -11326,7 +11709,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the file embed link URL
@@ -11337,7 +11720,7 @@
Returns:
-Promise.<void> +Promise.<string>
@@ -11355,7 +11738,7 @@
Returns:
-

restoreFromTrash(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ @@ -11363,14 +11746,11 @@

resto
- Restores an item that has been moved to the trash. Default behavior is to -restore the item to the folder it was in before it was moved to the trash. -If that parent folder no longer exists or if there is now an item with the -same name in that parent folder, the new parent folder and/or new name will -need to be included in the request. + Used to retrieve an expiring URL for creating an embedded preview session. +The URL will expire after 60 seconds and the preview session will expire after 60 minutes. -API Endpoint: '/files/:fileID' -Method: POST +API Endpoint: '/files/:fileID?fields=expiring_embed_link' +Method: GET
@@ -11432,134 +11812,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + @@ -11592,7 +11845,7 @@
Properties
- + @@ -11633,7 +11886,7 @@
Properties
Source:
@@ -11662,7 +11915,7 @@
Returns:
- A promise resolving to the restored file object + A promise resolving to the file embed link URL
@@ -11673,7 +11926,7 @@
Returns:
-Promise.<Object> +Promise.<string>
@@ -11691,7 +11944,7 @@
Returns:
-

setMetadata(fileID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+

getMetadata(fileID, scope, template, callbackopt) → {Promise.<Object>}

@@ -11699,7 +11952,10 @@

setMetadat
- Sets metadata on a file, overwriting any metadata that exists for the provided keys. + Retrieve a single metadata template instance for a file. + +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: GET
@@ -11761,7 +12017,7 @@

Parameters:
- + @@ -11792,7 +12048,7 @@
Parameters:
- + @@ -11823,38 +12079,7 @@
Parameters:
- - - - - - - - - - - - - - - - - - - + @@ -11887,7 +12112,7 @@
Parameters:
- + @@ -11928,7 +12153,7 @@
Parameters:
Source:
@@ -11957,7 +12182,7 @@
Returns:
- A promise resolving to the updated metadata + A promise resolving to the metadata template
@@ -11986,7 +12211,7 @@
Returns:
-

unlock(fileID, callbackopt) → {Promise.<Object>}

+

getMetadata(fileID, scope, template, callbackopt) → {Promise.<Object>}

@@ -11994,10 +12219,10 @@

unlock - Unlocks a file. + Retrieve a single metadata template instance for a file. -API Endpoint: '/files/:fileID' - Method: PUT +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: GET @@ -12059,20 +12284,20 @@
Parameters:
-

+ - + + - -
NameTypeAttributesDescription
fileID - - <optional>
+string + + + + 		@@ -4854,20 +5175,20 @@
Properties
- 		The number of chunks to upload concurrentlyBox ID of the file being requested
retryIntervaloptions -int +Object @@ -4887,20 +5208,41 @@
Properties
- 		The amount of time to wait before retrying a failed chunk upload, in ms
Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + @@ -4960,7 +5302,7 @@
Properties
- + @@ -5001,7 +5343,7 @@
Properties
Source:
@@ -5030,7 +5372,7 @@
Returns:
- A promise resolving to the chunked uploader + A promise resolving to nothing
@@ -5041,7 +5383,7 @@
Returns:
-Promise.<ChunkedUploader> +Promise.<void>
@@ -5059,7 +5401,7 @@
Returns:
-

getCollaborations(fileID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

+

delete(fileID, optionsopt, callbackopt) → {Promise.<void>}

@@ -5067,10 +5409,10 @@

getC
- Requests collaborations on a given file. + Delete a given file. -API Endpoint: '/files/:fileID/collaborations' -Method: GET +API Endpoint: '/files/:fileID' +Method: DELETE
@@ -5165,7 +5507,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -5325,7 +5601,7 @@
Properties
- + @@ -5366,7 +5642,7 @@
Properties
Source:
@@ -5395,7 +5671,7 @@
Returns:
- A promise resolving to the collection of collaborations on the file + A promise resolving to nothing
@@ -5406,7 +5682,7 @@
Returns:
-Promise.<schemas.Collaborations> +Promise.<void>
@@ -5424,7 +5700,7 @@
Returns:
-

getComments(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

deleteMetadata(fileID, scope, template, callbackopt) → {Promise.<void>}

@@ -5432,10 +5708,10 @@

getComment
- Gets the comments on a file. + Deletes a metadata template from a file. -API Endpoint: '/files/:fileID/comments' -Method: GET +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: DELETE
@@ -5497,20 +5773,20 @@

Parameters:
- + - + + - + + + + + + + + + + + + + + + + + + + + @@ -5604,7 +5909,7 @@
Parameters:
Source:
@@ -5633,7 +5938,7 @@
Returns:
- A promise resolving to the collection of comments + A promise resolving to nothing
@@ -5644,7 +5949,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -5662,7 +5967,7 @@
Returns:
-

getDownloadURL(fileID, optionsopt, callbackopt) → {Promise.<string>}

+

deleteMetadata(fileID, scope, template, callbackopt) → {Promise.<void>}

@@ -5670,13 +5975,10 @@

getDown
- Requests a download URL for a given file. + Deletes a metadata template from a file. -API Endpoint: '/files/:fileID/content' -Method: GET -Special Expected Responses: - 202 ACCEPTED - Download isn't available yet. Returns an error. - 302 FOUND - Download is available. A Download URL is returned. +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: DELETE
@@ -5738,20 +6040,20 @@

Parameters:
- + - + + + + + + + + + + + + + + + + + + + + @@ -5804,7 +6135,7 @@
Parameters:
- + @@ -5845,7 +6176,7 @@
Parameters:
Source:
@@ -5874,7 +6205,7 @@
Returns:
- A promise resolving to the file's download URL + A promise resolving to nothing
@@ -5885,7 +6216,7 @@
Returns:
-Promise.<string> +Promise.<void>
@@ -5903,7 +6234,7 @@
Returns:
- +

deletePermanently(fileID, optionsopt, callbackopt) → {Promise.<void>}

@@ -5911,11 +6242,10 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + @@ -6010,7 +6434,7 @@
Parameters:
- + @@ -6051,7 +6475,7 @@
Parameters:
Source:
@@ -6080,7 +6504,7 @@
Returns:
- A promise resolving to the file embed link URL + A promise resolving to nothing
@@ -6091,7 +6515,7 @@
Returns:
-Promise.<string> +Promise.<void>
@@ -6109,7 +6533,7 @@
Returns:
-

getMetadata(fileID, scope, template, callbackopt) → {Promise.<Object>}

+

deletePermanently(fileID, optionsopt, callbackopt) → {Promise.<void>}

@@ -6117,10 +6541,10 @@

getMetadat
- Retrieve a single metadata template instance for a file. + Permanently deletes an item that is in the trash. The item will no longer exist in Box. This action cannot be undone. -API Endpoint: '/files/:fileID/metadata/:scope/:template' -Method: GET +API Endpoint: '/files/:fileID/trash' +Method: DELETE
@@ -6182,20 +6606,20 @@

Parameters:
- + - + - + - - + + + + + + + + + @@ -6318,7 +6774,7 @@
Parameters:
Source:
@@ -6347,7 +6803,7 @@
Returns:
- A promise resolving to the metadata template + A promise resolving to nothing
@@ -6358,7 +6814,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -6376,7 +6832,7 @@
Returns:
-

getNewVersionChunkedUploader(fileID, size, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

+

deleteVersion(fileID, versionID, optionsopt, callbackopt) → {Promise.<void>}

@@ -6384,11 +6840,11 @@

- Upload a new file version in chunks, which is generally faster and more -reliable for large files. + Discards a specific file version to the trash. Depending on the enterprise settings +for this user, the item will either be actually deleted from Box or moved to the trash. -API Endpoint: '/files/:fileID/upload_sessions' -Method: POST +API Endpoint: '/files/:fileID/version/:versionID' +Method: DELETE
@@ -6450,57 +6906,20 @@
Parameters:
-

- - - - - - - - - - - - - - - - - - + - + + @@ -6551,7 +6970,7 @@
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -6711,7 +7064,7 @@
Properties
- + @@ -6752,7 +7105,7 @@
Properties
Source:
@@ -6781,7 +7134,7 @@
Returns:
- A promise resolving to the chunked uploader + A promise resolving to nothing
@@ -6792,7 +7145,7 @@
Returns:
-Promise.<ChunkedUploader> +Promise.<void>
@@ -6810,7 +7163,7 @@
Returns:
-

getReadStream(fileID, optionsopt, callbackopt) → {Promise.<Readable>}

+

deleteVersion(fileID, versionID, optionsopt, callbackopt) → {Promise.<void>}

@@ -6818,13 +7171,11 @@

getReadS
- Requests a Readable Stream for the given file ID. + Discards a specific file version to the trash. Depending on the enterprise settings +for this user, the item will either be actually deleted from Box or moved to the trash. -API Endpoint: '/files/:fileID/content' -Method: GET -Special Expected Responses: - 202 ACCEPTED - Download isn't available yet. Returns an error. - 302 FOUND - Download is available. A Download stream is returned. +API Endpoint: '/files/:fileID/version/:versionID' +Method: DELETE
@@ -6886,20 +7237,20 @@

Parameters:
- + - + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileAttributesetag -Object +string @@ -4920,7 +5262,7 @@
Properties
- 		Attributes to set on the newly-uploaded fileOnly delete the file if the etag value matches
Passed the uploader if successfulEmpty response body passed if successful.
Additional options. Can be left null in most cases. + Optional parameters
Properties
@@ -5193,73 +5535,7 @@
Properties
limit - - -int - - - - - - <optional>
- - - - - - 		The maximum number of collaborations to return
offset - - -int - - - - - - <optional>
- - - - - - 		Paging parameter for the collaborations collection
fieldsetag @@ -5285,7 +5561,7 @@
Properties
- 		Comma-separated list of fields to return on the collaboration objectsOnly delete the file if the etag value matches
Passed the collaborations if successful, error otherwiseEmpty response body passed if successful.
Box file id of the fileThe ID of the file to remove metadata from
optionsscope -Object +string @@ -5519,8 +5795,6 @@
Parameters:
 - <optional>
- @@ -5530,20 +5804,20 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The scope of the metadata template
callbacktemplate -function +string @@ -5552,8 +5826,6 @@
Parameters:
 - <optional>
- @@ -5563,7 +5835,40 @@
Parameters:
- 		passed the file comments if they were successfully acquiredThe template to remove from the file
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with nothing if successful, error otherwise
Box ID of the file being requestedThe ID of the file to remove metadata from
optionsscope -Object +string @@ -5760,7 +6062,36 @@
Parameters:
 - <optional>
+ + + + + 		The scope of the metadata template
template + + +string + + + + @@ -5771,7 +6102,7 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The template to remove from the file
Passed the download URL if request was successful.Called with nothing if successful, error otherwise
The ID of the file to generate embed link forThe ID of the file to remove metadata from
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only delete the file if the etag matches
+ +
Passed with the embed link if successful, error otherwiseCalled with nothing if successful, error otherwise
The ID of the file to retrive the metadata ofThe ID of the file to remove metadata from
scopeoptions -string +Object @@ -6204,6 +6628,8 @@
Parameters:
 + <optional>
+ @@ -6213,14 +6639,35 @@
Parameters:
- 		The scope of the metadata template, e.g. "global"
Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + + +
NameTypeAttributesDescription
templateetag @@ -6235,6 +6682,8 @@
Parameters:
 + <optional>
+ @@ -6244,14 +6693,21 @@
Parameters:
- 		The metadata template to retrieveOnly delete the file if the etag matches
-
callback
callback @@ -6277,7 +6733,7 @@
Parameters:
- 		Passed the metadata template if successfulCalled with nothing if successful, error otherwise
The ID of the file to upload a new version of
size - - -int - - - - - - - - - - The size of the file that will be uploadedThe file ID which old version will be moved to the trash or delete permanently
fileversionID -Buffer -| - string -| - -Readable @@ -6518,7 +6937,7 @@
Parameters:
- 		The file to uploadThe ID of the version to move to the trash or delete permanently
Optional parameters for the upload + Optional parameters
Properties
@@ -6579,79 +6998,13 @@
Properties
parallelism - - -int - - - - - - <optional>
- - - - - - 		The number of chunks to upload concurrently
retryInterval - - -int - - - - - - <optional>
- - - - - - 		The amount of time to wait before retrying a failed chunk upload, in ms
fileAttributesetag -Object +string @@ -6671,7 +7024,7 @@
Properties
- 		Attributes to set on the updated file objectOnly delete the version of the file etag matches
Passed the uploader if successfulEmpty response body, error otherwise
Box ID of the file being requestedThe file ID which old version will be moved to the trash or delete permanently
optionsversionID -Object +string @@ -6908,8 +7259,6 @@
Parameters:
 - <optional>
- @@ -6919,41 +7268,20 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + - + + + + + - + + + - + - + + - + + + + - + - + + + - + - - - - - - - - - - - - - - - - - - - -
Returns:
- - -
- A promise resolving to the collection of file versions -
- - - -
-
- Type -
-
- -Promise.<Object> - - -
-
- - - - - - - - - - - - - -

getWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

- - - - - - -
- Used to retrieve the watermark for a corresponding Box file. - -API Endpoint: '/files/:fileID/watermark' -Method: GET -
- - - - - - - - - -
Parameters:
- + @@ -9450,7 +9745,7 @@
Parameters:
- + @@ -9491,7 +9786,7 @@
Parameters:
Source:
@@ -9520,7 +9815,7 @@
Returns:
- A promise resolving to the watermark info + A promise resolving to the chunked uploader
@@ -9531,7 +9826,7 @@
Returns:
-Promise.<Object> +Promise.<ChunkedUploader>
@@ -9549,7 +9844,7 @@
Returns:
-

lock(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

getCollaborations(fileID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

@@ -9557,10 +9852,10 @@

lock - Locks a file. + Requests collaborations on a given file. -API Endpoint: '/files/:fileID' -Method: PUT +API Endpoint: '/files/:fileID/collaborations' +Method: GET @@ -9622,7 +9917,7 @@
Parameters:
-

+ @@ -9655,7 +9950,7 @@
Parameters:
- - + + + + + + + + + + + + + + + + + + + + - + + @@ -9784,7 +10110,7 @@
Properties
- + @@ -9825,7 +10151,7 @@
Properties
Source:
@@ -9854,7 +10180,7 @@
Returns:
- A promise resolving to the locked file object + A promise resolving to the collection of collaborations on the file
@@ -9865,7 +10191,7 @@
Returns:
-Promise.<Object> +Promise.<schemas.Collaborations>
@@ -9883,7 +10209,7 @@
Returns:
-

move(fileID, newParentID, callbackopt) → {Promise.<Object>}

+

getCollaborations(fileID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

@@ -9891,10 +10217,10 @@

move - Move a file into a new parent folder. + Requests collaborations on a given file. -API Endpoint: '/files/:fileID' -Method: PUT +API Endpoint: '/files/:fileID/collaborations' +Method: GET @@ -9956,20 +10282,20 @@
Parameters:
-

+ - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
The ID of the version to move to the trash or delete permanently
versionoptions -string +Object @@ -6973,20 +7301,41 @@
Properties
- 		ID of the version of this file to download
Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + @@ -7046,7 +7395,7 @@
Properties
- + @@ -7087,7 +7436,7 @@
Properties
Source:
@@ -7116,7 +7465,7 @@
Returns:
- A promise resolving for the file stream + A promise resolving to nothing
@@ -7127,7 +7476,7 @@
Returns:
-Promise.<Readable> +Promise.<void>
@@ -7145,7 +7494,7 @@
Returns:
-

getRepresentationContent(fileID, representationType, optionsopt, callbackopt) → {Promise.<Readable>}

+

downloadZip(name, items, stream, callbackopt) → {Promise.<Readable>}

@@ -7153,10 +7502,10 @@

- Get the contents of a representation of a file, e.g, the binary content of an image or pdf. + Creates a zip of multiple files and folders and downloads it. -API Endpoint: '/files/:fileID?fields=representations' -Method : GET +API Endpoint: '/zip_downloads' +Method: GET @@ -7194,13 +7543,13 @@
Parameters:

- + + - + + - + - - - - - - - - + @@ -7376,7 +7662,7 @@
Properties
- + @@ -7417,7 +7703,7 @@
Properties
Source:
@@ -7446,7 +7732,7 @@
Returns:
- A promise resolving to a stream over the representation contents + A promise resolving to a zip download status object
@@ -7475,7 +7761,7 @@
Returns:
-

getRepresentationInfo(fileID, representationType, optionsopt, callbackopt) → {Promise.<Object>}

+

downloadZip(name, items, stream, callbackopt) → {Promise.<Readable>}

@@ -7483,10 +7769,10 @@

- Requests information for all representation objects generated for a specific Box file + Creates a zip of multiple files and folders and downloads it. -API Endpoint: '/files/:fileID?fields=representations' -Method : GET +API Endpoint: '/zip_downloads' +Method: GET
@@ -7524,13 +7810,13 @@

Parameters:
- + + - + + - - - - - - - - - - - - + @@ -7715,7 +7929,7 @@
Properties
- + @@ -7756,7 +7970,7 @@
Properties
Source:
@@ -7785,7 +7999,7 @@
Returns:
- A promise resolving to the representation response objects + A promise resolving to a zip download status object
@@ -7796,7 +8010,7 @@
Returns:
-Promise.<Object> +Promise.<Readable>
@@ -7814,7 +8028,7 @@
Returns:
-

getTasks(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

get(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -7822,9 +8036,9 @@

getTasks - Retrieves all of the tasks for given file. + Requests a file object with the given ID. -API Endpoint: '/files/:fileID/tasks' +API Endpoint: '/files/:fileID' Method: GET @@ -7887,7 +8101,7 @@
Parameters:
-

+ @@ -7953,7 +8167,7 @@
Parameters:
- + @@ -7994,7 +8208,7 @@
Parameters:
Source:
@@ -8023,7 +8237,7 @@
Returns:
- A promise resolving to a collections of tasks on the file + A promise resolving to the file object
@@ -8052,7 +8266,7 @@
Returns:
-

getThumbnail(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

get(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -8060,14 +8274,10 @@

getThumbn
- Requests a Thumbnail for a given file. + Requests a file object with the given ID. -API Endpoint: '/files/:fileID/thumbnail.png' +API Endpoint: '/files/:fileID' Method: GET -Special Expected Responses: - 200 OK - Thumbnail available. Returns a thumbnail file. - 202 ACCEPTED - Thumbnail isn't available yet. Returns a `location` URL for a generic placeholder thumbnail. - 302 FOUND - Unable to generate thumbnail. Returns a `location` URL for a generic placeholder thumbnail.
@@ -8195,7 +8405,7 @@

Parameters:
- + @@ -8224,8 +8434,6 @@
Parameters:
-
Deprecated:
  • use getRepresentationContent() instead
- @@ -8238,7 +8446,7 @@
Parameters:
Source:
@@ -8267,7 +8475,7 @@
Returns:
- A promise resolving to the thumbnail information + A promise resolving to the file object
@@ -8296,7 +8504,7 @@
Returns:
-

getTrashedFile(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAllMetadata(fileID, callbackopt) → {Promise.<Object>}

@@ -8304,9 +8512,9 @@

getTras
- Retrieves a file that has been moved to the trash. + Retrieves all metadata associated with a file. -API Endpoint: '/files/:fileID/trash' +API Endpoint: '/files/:fileID/metadata' Method: GET
@@ -8369,40 +8577,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + @@ -8435,7 +8610,7 @@
Parameters:
- + @@ -8476,7 +8651,7 @@
Parameters:
Source:
@@ -8505,7 +8680,7 @@
Returns:
- A promise resolving to the trashed file + A promise resolving to a collection of metadata on the file
@@ -8534,7 +8709,7 @@
Returns:
-

getUploadSession(sessionID, callbackopt) → {Promise.<Object>}

+

getAllMetadata(fileID, callbackopt) → {Promise.<Object>}

@@ -8542,10 +8717,9 @@

getUp
- Get the status of an upload session, e.g. whether or not is has started or -finished committing + Retrieves all metadata associated with a file. -API Endpoint: '/files/upload_sessions/:sessionID' +API Endpoint: '/files/:fileID/metadata' Method: GET
@@ -8584,7 +8758,7 @@

Parameters:
- + + @@ -8641,7 +8815,7 @@
Parameters:
- + @@ -8682,7 +8856,7 @@
Parameters:
Source:
@@ -8711,7 +8885,7 @@
Returns:
- A promise resolving to the upload session object + A promise resolving to a collection of metadata on the file
@@ -8740,7 +8914,7 @@
Returns:
-

getUploadSessionParts(sessionID, optionsopt, callbackopt) → {Promise.<Object>}

+

getChunkedUploader(folderID, size, name, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

@@ -8748,10 +8922,11 @@

- Get a list of all parts that have been uploaded to an upload session + Upload a file in chunks, which is generally faster and more reliable for +large files. -API Endpoint: '/files/upload_sessions/:sessionID/parts' -Method: GET +API Endpoint: '/files/upload_sessions' +Method: POST
@@ -8789,7 +8964,7 @@

Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -8846,7 +9120,7 @@
Parameters:
- - + + - + + + + + + + + + + + + + + + + + + + + @@ -8973,7 +9280,7 @@
Properties
- + @@ -9014,7 +9321,7 @@
Properties
Source:
@@ -9043,7 +9350,7 @@
Returns:
- A promise resolving to the collection of uploaded parts + A promise resolving to the chunked uploader
@@ -9054,7 +9361,7 @@
Returns:
-Promise.<Object> +Promise.<ChunkedUploader>
@@ -9072,7 +9379,7 @@
Returns:
-

getVersions(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

getChunkedUploader(folderID, size, name, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

@@ -9080,11 +9387,11 @@

getVersion
- If there are previous versions of this file, this method can be used to retrieve information -about the older versions. + Upload a file in chunks, which is generally faster and more reliable for +large files. -API Endpoint: '/files/:fileID/versions' -Method: GET +API Endpoint: '/files/upload_sessions' +Method: POST
@@ -9122,7 +9429,7 @@

Parameters:
- + + - + + - + + - -
NameTypeAttributesDescription
byteRangeetag -Array.<int> +string @@ -7006,7 +7355,7 @@
Properties
- 		starting and ending bytes of the file to read, e.g. [0, 99] to read the first 100 bytesOnly delete the version of the file etag matches
passed the readable stream if request was successfulEmpty response body, error otherwise
fileIDname -string +name @@ -7218,20 +7567,20 @@
Parameters:
- 		The file ID to get the representation ofThe name of the zip file to be created
representationTypeitems -string +Array @@ -7249,74 +7598,20 @@
Parameters:
- 		The X-Rep-Hints type to requestArray of files or folders to be part of the created zip
optionsstream -Object - - - - - - <optional>
- - - - - - 		Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
assetPath - - -string +Stream @@ -7325,8 +7620,6 @@
Properties
 - <optional>
- @@ -7336,14 +7629,7 @@
Properties
- 		Asset path for representations with multiple files
- - 		Stream to pipe the readable stream of the zip file
Passed a stream over the representation contents if successfulPassed a zip download status object
fileIDname -string +name @@ -7548,20 +7834,20 @@
Parameters:
- 		Box ID of the file being requestedThe name of the zip file to be created
representationTypeitems -client.files.representation +Array @@ -7579,77 +7865,20 @@
Parameters:
- 		The x-rep-hints value the application should create a - representation for. This value can either come from FileRepresentationType enum or manually createdArray of files or folders to be part of the created zip
options - - -Object - - - - - - <optional>
- - - - - - 		Additional options. Can be left empty -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - -
NameTypeAttributesDefaultDescription
generateRepresentationsstream -boolean +Stream @@ -7658,8 +7887,6 @@
Properties
 - <optional>
- @@ -7668,21 +7895,8 @@
Properties
- 		- - false - - Set to true to return representation info where all states resolve to success.
- 		Stream to pipe the readable stream of the zip file
Passed an array of representaton objects if successfulPassed a zip download status object
The ID of the file to get tasks forBox ID of the file being requested
Passed the file tasks if successful, error otherwisePassed the file information if it was acquired successfully
Passed the thumbnail file or the URL to a placeholder thumbnail if successful.Passed the file information if it was acquired successfully
The ID of the file being requested
options - - -Object - - - - - - <optional>
- - - - - - 		Additional options for the request. Can be left null in most cases.the ID of the file to get metadata for
Passed the trashed file information if successful, error otherwisecalled with an array of metadata when successful
sessionIDfileID @@ -8608,7 +8782,7 @@
Parameters:
- 		The ID of the upload session to get the status ofthe ID of the file to get metadata for
Passed the session status if successfulcalled with an array of metadata when successful
sessionIDfolderID @@ -8813,7 +8988,106 @@
Parameters:
- 		The ID of the session to get a list of parts fromThe ID of the folder to upload the file to
size + + +int + + + + + + + + + + The size of the file that will be uploaded
name + + +string + + + + + + + + + + The name of the file to be created
file + + +Buffer +| + +string +| + +Readable + + + + + + + + + + The file to upload
Optional parameters, can be left null + Optional parameters for the upload
Properties
@@ -8874,13 +9148,13 @@
Properties
offsetparallelism -string +int @@ -8900,14 +9174,14 @@
Properties
- 		Paging offset for the list of partsThe number of chunks to upload concurrently
limitretryInterval @@ -8933,7 +9207,40 @@
Properties
- 		Maximum number of parts to returnThe amount of time to wait before retrying a failed chunk upload, in ms
fileAttributes + + +Object + + + + + + <optional>
+ + + + + + 		Attributes to set on the newly-uploaded file
Passed the list of parts if successfulPassed the uploader if successful
fileIDfolderID @@ -9146,20 +9453,20 @@
Parameters:
- 		The ID of the file to view version forThe ID of the folder to upload the file to
optionssize -Object +int @@ -9168,8 +9475,6 @@
Parameters:
 - <optional>
- @@ -9179,20 +9484,20 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The size of the file that will be uploaded
callbackname -function +string @@ -9201,8 +9506,6 @@
Parameters:
 - <optional>
- @@ -9212,129 +9515,79 @@
Parameters:
- 		Passed a list of previous file versions if successful, error otherwiseThe name of the file to be created
+
file + + +Buffer +| +string +| +Readable -
+ +
+ - + - + + The file to upload
options + + +Object - - + + + + <optional>
+ - + - -
Source:
-
- + + 		Optional parameters for the upload +
Properties
+ @@ -9360,13 +9613,13 @@
Parameters:
- + + - + + + + + + + + + + + + + + + + + + + + + + + + +
fileIDparallelism -string +int @@ -9375,6 +9628,8 @@
Parameters:
 + <optional>
+ @@ -9384,14 +9639,47 @@
Parameters:
- 		The Box ID of the file to get watermark forThe number of chunks to upload concurrently
optionsretryInterval + + +int + + + + + + <optional>
+ + + + + + 		The amount of time to wait before retrying a failed chunk upload, in ms
fileAttributes @@ -9417,7 +9705,14 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.Attributes to set on the newly-uploaded file
+ +
Passed the watermark information if successful, error otherwisePassed the uploader if successful
The ID of the file to lockBox ID of the file being requested
Optional parameters, can be left null in most cases + Additional options. Can be left null in most cases.
Properties
@@ -9683,13 +9978,13 @@
Properties
expires_atlimit -string +int @@ -9702,7 +9997,38 @@
Properties
- <nullable>
+ + + 		The maximum number of collaborations to return
offset + + +int + + + + + + <optional>
+ + @@ -9711,20 +10037,20 @@
Properties
- 		The time the lock expiresPaging parameter for the collaborations collection
is_download_preventedfields -boolean +string @@ -9744,7 +10070,7 @@
Properties
- 		Whether or not the file can be downloaded while lockedComma-separated list of fields to return on the collaboration objects
Passed with the locked file information if successful, error otherwisePassed the collaborations if successful, error otherwise
The Box ID of the file being requestedBox ID of the file being requested
newParentIDoptions -string +Object @@ -9978,6 +10304,8 @@
Parameters:
 + <optional>
+ @@ -9987,20 +10315,41 @@
Parameters:
- 		The Box ID for the new parent folder. '0' to move to All Files.
Additional options. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + - -
NameTypeAttributesDescription
callbacklimit -function +int @@ -10020,12 +10369,118 @@
Parameters:
- 		Passed the updated file information if it was acquired successfullyThe maximum number of collaborations to return
+ +
offset + + +int + + + + + + <optional>
+ + + + + + 		Paging parameter for the collaborations collection
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields to return on the collaboration objects
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the collaborations if successful, error otherwise
@@ -10061,7 +10516,7 @@
Parameters:
Source:
@@ -10090,7 +10545,7 @@
Returns:
- A promise resolving to the updated file object + A promise resolving to the collection of collaborations on the file
@@ -10101,7 +10556,7 @@
Returns:
-Promise.<Object> +Promise.<schemas.Collaborations>
@@ -10119,7 +10574,7 @@
Returns:
-

preflightUploadFile(parentFolderID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+

getComments(fileID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -10127,17 +10582,10 @@

pr
- Get preflight information for a new file upload. Without any file data, -this will return an upload URL and token to be used when uploading the file. -Using this upload URL will allow for the fastest upload, and the one-time -token can be passed to a worker or other client to actually perform the -upload with. If file data (e.g. size, parent, name) is passed, it will be -validated as if the actual file were being uploaded. This enables checking -of preconditions such as name uniqueness and available storage space before -attempting a large file upload. + Gets the comments on a file. -API Endpoint: '/files/content' -Method: OPTIONS +API Endpoint: '/files/:fileID/comments' +Method: GET
@@ -10175,7 +10623,7 @@

Parameters:
parentFolderIDfileID @@ -10199,40 +10647,7 @@
Parameters:
- 		The id of the parent folder to upload to
fileData - - -Object - - - - - - <optional>
- - - - - - 		Optional data about the file to be uploadedBox file id of the file
Called with upload data if successful, or err if the upload would not succeedpassed the file comments if they were successfully acquired
The file ID to which a new version will be uploaded
fileData - - -Object - - - - - - <optional>
- - - - - - 		Optional data about the file to be uploadedBox file id of the file
Called with upload data if successful, or err if the upload would not succeedpassed the file comments if they were successfully acquired
The file ID which version will be promotedBox ID of the file being requested
versionIDoptions -string +Object @@ -10773,6 +11148,8 @@
Parameters:
 + <optional>
+ @@ -10782,7 +11159,7 @@
Parameters:
- 		The ID of the file_version that you want to make currentAdditional options for the request. Can be left null in most cases.
Passed the promoted file version information if successful, error otherwisePassed the download URL if request was successful.
The file to remove from the collectionBox ID of the file being requested
collectionIDoptions -string +Object @@ -11009,6 +11389,8 @@
Parameters:
 + <optional>
+ @@ -11018,7 +11400,7 @@
Parameters:
- 		The collection to remove the file fromAdditional options for the request. Can be left null in most cases.
Passed the updated file if successful, error otherwisePassed the download URL if request was successful.
The Box ID of the file to remove watermark fromThe ID of the file to generate embed link for
Empty response body passed if successful, error otherwisePassed with the embed link if successful, error otherwise
The ID of the file to restore
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters, can be left null in most cases -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
name - - -string - - - - - - <optional>
- - - - - - 		The new name for this item
parent_id - - -string - - - - - - <optional>
- - - - - - 		The new parent folder for this item
- - 		The ID of the file to generate embed link for
Called with item information if successful, error otherwisePassed with the embed link if successful, error otherwise
The file to set metadata onThe ID of the file to retrive the metadata of
The scope of the metadata templateThe scope of the metadata template, e.g. "global"
The key of the metadata template
metadata - - -Object - - - - - - - - - - The metadata to setThe metadata template to retrieve
Called with updated metadata if successfulPassed the metadata template if successful
The ID of the file to unlockThe ID of the file to retrive the metadata of
callbackscope -function +string @@ -12081,8 +12306,6 @@
Parameters:
 - <optional>
- @@ -12092,12 +12315,76 @@
Parameters:
- 		Passed with the unlocked file information if successful, error otherwiseThe scope of the metadata template, e.g. "global"
+ + + + template + + + + + +string + + + + + + + + + + + + + + + + + + The metadata template to retrieve + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the metadata template if successful + + + + + @@ -12133,7 +12420,7 @@
Parameters:
Source:
@@ -12162,7 +12449,7 @@
Returns:
- A promise resolving to the unlocked file object + A promise resolving to the metadata template
@@ -12191,7 +12478,7 @@
Returns:
-

update(fileID, updates, callbackopt) → {Promise.<Object>}

+

getNewVersionChunkedUploader(fileID, size, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

@@ -12199,10 +12486,11 @@

update - Update some information about a given file. + Upload a new file version in chunks, which is generally faster and more +reliable for large files. -API Endpoint: '/files/:fileID' -Method: PUT +API Endpoint: '/files/:fileID/upload_sessions' +Method: POST @@ -12264,14 +12552,82 @@
Parameters:
- Box ID of the file being requested + The ID of the file to upload a new version of - updates + size + + + + + +int + + + + + + + + + + + + + + + + + + The size of the file that will be uploaded + + + + + + + file + + + + + +Buffer +| + +string +| + +Readable + + + + + + + + + + + + + + + + + + The file to upload + + + + + + + options @@ -12286,6 +12642,8 @@
Parameters:
+ <optional>
+ @@ -12295,7 +12653,7 @@
Parameters:
- File fields to update + Optional parameters for the upload
Properties
@@ -12323,13 +12681,13 @@
Properties
- etag + parallelism -string +int @@ -12349,20 +12707,20 @@
Properties
- Only apply the updates if the file etag matches + The number of chunks to upload concurrently - fields + retryInterval -string +int @@ -12382,7 +12740,40 @@
Properties
- Comma-separated list of fields to return + The amount of time to wait before retrying a failed chunk upload, in ms + + + + + + + fileAttributes + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Attributes to set on the updated file object @@ -12422,7 +12813,7 @@
Properties
- Passed the updated file information if it was acquired successfully + Passed the uploader if successful @@ -12463,7 +12854,7 @@
Properties
Source:
@@ -12492,7 +12883,7 @@
Returns:
- A promise resolving to the update file object + A promise resolving to the chunked uploader
@@ -12503,7 +12894,7 @@
Returns:
-Promise.<Object> +Promise.<ChunkedUploader>
@@ -12521,7 +12912,7 @@
Returns:
-

updateMetadata(fileID, scope, template, patch, callbackopt) → {Promise.<Object>}

+

getNewVersionChunkedUploader(fileID, size, file, optionsopt, callbackopt) → {Promise.<ChunkedUploader>}

@@ -12529,10 +12920,11 @@

updateM
- Updates a metadata template instance with JSON Patch-formatted data. + Upload a new file version in chunks, which is generally faster and more +reliable for large files. -API Endpoint: '/files/:fileID/metadata/:scope/:template' -Method: PUT +API Endpoint: '/files/:fileID/upload_sessions' +Method: POST
@@ -12594,14 +12986,13041 @@

Parameters:
- The file to update metadata for + The ID of the file to upload a new version of + + + + + + + size + + + + + +int + + + + + + + + + + + + + + + + + + The size of the file that will be uploaded + + + + + + + file + + + + + +Buffer +| + +string +| + +Readable + + + + + + + + + + + + + + + + + + The file to upload + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters for the upload +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parallelism + + +int + + + + + + <optional>
+ + + + + + 		The number of chunks to upload concurrently
retryInterval + + +int + + + + + + <optional>
+ + + + + + 		The amount of time to wait before retrying a failed chunk upload, in ms
fileAttributes + + +Object + + + + + + <optional>
+ + + + + + 		Attributes to set on the updated file object
+ + + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the uploader if successful + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the chunked uploader +
+ + + +
+
+ Type +
+
+ +Promise.<ChunkedUploader> + + +
+
+ + + + + + + + + + + + + +

getReadStream(fileID, optionsopt, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Requests a Readable Stream for the given file ID. + +API Endpoint: '/files/:fileID/content' +Method: GET +Special Expected Responses: + 202 ACCEPTED - Download isn't available yet. Returns an error. + 302 FOUND - Download is available. A Download stream is returned. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
version + + +string + + + + + + <optional>
+ + + + + + 		ID of the version of this file to download
byteRange + + +Array.<int> + + + + + + <optional>
+ + + + + + 		starting and ending bytes of the file to read, e.g. [0, 99] to read the first 100 bytes
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the readable stream if request was successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving for the file stream +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getReadStream(fileID, optionsopt, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Requests a Readable Stream for the given file ID. + +API Endpoint: '/files/:fileID/content' +Method: GET +Special Expected Responses: + 202 ACCEPTED - Download isn't available yet. Returns an error. + 302 FOUND - Download is available. A Download stream is returned. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
version + + +string + + + + + + <optional>
+ + + + + + 		ID of the version of this file to download
byteRange + + +Array.<int> + + + + + + <optional>
+ + + + + + 		starting and ending bytes of the file to read, e.g. [0, 99] to read the first 100 bytes
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the readable stream if request was successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving for the file stream +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getRepresentationContent(fileID, representationType, optionsopt, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Get the contents of a representation of a file, e.g, the binary content of an image or pdf. + +API Endpoint: '/files/:fileID?fields=representations' +Method : GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID to get the representation of
representationType + + +string + + + + + + + + + + The X-Rep-Hints type to request
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assetPath + + +string + + + + + + <optional>
+ + + + + + 		Asset path for representations with multiple files
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a stream over the representation contents if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a stream over the representation contents +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getRepresentationContent(fileID, representationType, optionsopt, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Get the contents of a representation of a file, e.g, the binary content of an image or pdf. + +API Endpoint: '/files/:fileID?fields=representations' +Method : GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID to get the representation of
representationType + + +string + + + + + + + + + + The X-Rep-Hints type to request
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assetPath + + +string + + + + + + <optional>
+ + + + + + 		Asset path for representations with multiple files
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a stream over the representation contents if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a stream over the representation contents +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getRepresentationInfo(fileID, representationType, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests information for all representation objects generated for a specific Box file + +API Endpoint: '/files/:fileID?fields=representations' +Method : GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
representationType + + +client.files.representation + + + + + + + + + + The x-rep-hints value the application should create a + representation for. This value can either come from FileRepresentationType enum or manually created
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left empty +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
generateRepresentations + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + + Set to true to return representation info where all states resolve to success.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed an array of representaton objects if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the representation response objects +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getRepresentationInfo(fileID, representationType, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests information for all representation objects generated for a specific Box file + +API Endpoint: '/files/:fileID?fields=representations' +Method : GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
representationType + + +client.files.representation + + + + + + + + + + The x-rep-hints value the application should create a + representation for. This value can either come from FileRepresentationType enum or manually created
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left empty +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
generateRepresentations + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + + Set to true to return representation info where all states resolve to success.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed an array of representaton objects if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the representation response objects +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTasks(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves all of the tasks for given file. + +API Endpoint: '/files/:fileID/tasks' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to get tasks for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the file tasks if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a collections of tasks on the file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTasks(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves all of the tasks for given file. + +API Endpoint: '/files/:fileID/tasks' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to get tasks for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the file tasks if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a collections of tasks on the file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTrashedFile(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves a file that has been moved to the trash. + +API Endpoint: '/files/:fileID/trash' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the trashed file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the trashed file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTrashedFile(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves a file that has been moved to the trash. + +API Endpoint: '/files/:fileID/trash' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the trashed file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the trashed file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUploadSession(sessionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get the status of an upload session, e.g. whether or not is has started or +finished committing + +API Endpoint: '/files/upload_sessions/:sessionID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
sessionID + + +string + + + + + + + + + + The ID of the upload session to get the status of
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the session status if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload session object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUploadSession(sessionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get the status of an upload session, e.g. whether or not is has started or +finished committing + +API Endpoint: '/files/upload_sessions/:sessionID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
sessionID + + +string + + + + + + + + + + The ID of the upload session to get the status of
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the session status if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload session object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUploadSessionParts(sessionID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of all parts that have been uploaded to an upload session + +API Endpoint: '/files/upload_sessions/:sessionID/parts' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
sessionID + + +string + + + + + + + + + + The ID of the session to get a list of parts from
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
offset + + +string + + + + + + <optional>
+ + + + + + 		Paging offset for the list of parts
limit + + +int + + + + + + <optional>
+ + + + + + 		Maximum number of parts to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the list of parts if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of uploaded parts +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUploadSessionParts(sessionID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of all parts that have been uploaded to an upload session + +API Endpoint: '/files/upload_sessions/:sessionID/parts' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
sessionID + + +string + + + + + + + + + + The ID of the session to get a list of parts from
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
offset + + +string + + + + + + <optional>
+ + + + + + 		Paging offset for the list of parts
limit + + +int + + + + + + <optional>
+ + + + + + 		Maximum number of parts to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the list of parts if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of uploaded parts +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getVersions(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ If there are previous versions of this file, this method can be used to retrieve information +about the older versions. + +API Endpoint: '/files/:fileID/versions' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to view version for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of previous file versions if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of file versions +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getVersions(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ If there are previous versions of this file, this method can be used to retrieve information +about the older versions. + +API Endpoint: '/files/:fileID/versions' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to view version for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of previous file versions if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of file versions +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to retrieve the watermark for a corresponding Box file. + +API Endpoint: '/files/:fileID/watermark' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file to get watermark for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the watermark information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the watermark info +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getWatermark(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to retrieve the watermark for a corresponding Box file. + +API Endpoint: '/files/:fileID/watermark' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file to get watermark for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the watermark information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the watermark info +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

lock(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Locks a file. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to lock
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
expires_at + + +string + + + + + + <optional>
+ + + + <nullable>
+ + + + 		The time the lock expires
is_download_prevented + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not the file can be downloaded while locked
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed with the locked file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the locked file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

lock(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Locks a file. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to lock
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
expires_at + + +string + + + + + + <optional>
+ + + + <nullable>
+ + + + 		The time the lock expires
is_download_prevented + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not the file can be downloaded while locked
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed with the locked file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the locked file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

move(fileID, newParentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Move a file into a new parent folder. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file being requested
newParentID + + +string + + + + + + + + + + The Box ID for the new parent folder. '0' to move to All Files.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

move(fileID, newParentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Move a file into a new parent folder. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file being requested
newParentID + + +string + + + + + + + + + + The Box ID for the new parent folder. '0' to move to All Files.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

preflightUploadFile(parentFolderID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get preflight information for a new file upload. Without any file data, +this will return an upload URL and token to be used when uploading the file. +Using this upload URL will allow for the fastest upload, and the one-time +token can be passed to a worker or other client to actually perform the +upload with. If file data (e.g. size, parent, name) is passed, it will be +validated as if the actual file were being uploaded. This enables checking +of preconditions such as name uniqueness and available storage space before +attempting a large file upload. + +API Endpoint: '/files/content' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parentFolderID + + +string + + + + + + + + + + The id of the parent folder to upload to
fileData + + +Object + + + + + + <optional>
+ + + + + + 		Optional data about the file to be uploaded
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with upload data if successful, or err if the upload would not succeed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload data +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

preflightUploadFile(parentFolderID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get preflight information for a new file upload. Without any file data, +this will return an upload URL and token to be used when uploading the file. +Using this upload URL will allow for the fastest upload, and the one-time +token can be passed to a worker or other client to actually perform the +upload with. If file data (e.g. size, parent, name) is passed, it will be +validated as if the actual file were being uploaded. This enables checking +of preconditions such as name uniqueness and available storage space before +attempting a large file upload. + +API Endpoint: '/files/content' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parentFolderID + + +string + + + + + + + + + + The id of the parent folder to upload to
fileData + + +Object + + + + + + <optional>
+ + + + + + 		Optional data about the file to be uploaded
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with upload data if successful, or err if the upload would not succeed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload data +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

preflightUploadNewFileVersion(fileID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get preflight information for a file version upload. Without any file data, +this will return an upload URL and token to be used when uploading the file. +Using this upload URL will allow for the fastest upload, and the one-time +token can be passed to a worker or other client to actually perform the +upload with. If file data (e.g. size, parent, name) is passed, it will be +validated as if the actual file were being uploaded. This enables checking +of preconditions such as name uniqueness and available storage space before +attempting a large file upload. + +API Endpoint: '/files/:fileID/content' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID to which a new version will be uploaded
fileData + + +Object + + + + + + <optional>
+ + + + + + 		Optional data about the file to be uploaded
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with upload data if successful, or err if the upload would not succeed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload data +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

preflightUploadNewFileVersion(fileID, fileDataopt, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get preflight information for a file version upload. Without any file data, +this will return an upload URL and token to be used when uploading the file. +Using this upload URL will allow for the fastest upload, and the one-time +token can be passed to a worker or other client to actually perform the +upload with. If file data (e.g. size, parent, name) is passed, it will be +validated as if the actual file were being uploaded. This enables checking +of preconditions such as name uniqueness and available storage space before +attempting a large file upload. + +API Endpoint: '/files/:fileID/content' +Method: OPTIONS +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID to which a new version will be uploaded
fileData + + +Object + + + + + + <optional>
+ + + + + + 		Optional data about the file to be uploaded
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with upload data if successful, or err if the upload would not succeed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the upload data +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

promoteVersion(fileID, versionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ If there are previous versions of this file, this method can be used to promote one of the older +versions to the top of the stack. This actually mints a copy of the old version and puts it on +the top of the versions stack. The file will have the exact same contents, the same SHA1/etag, +and the same name as the original. Other properties such as comments do not get updated to their former values. + +API Endpoint: '/files/:fileID/versions/current' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID which version will be promoted
versionID + + +string + + + + + + + + + + The ID of the file_version that you want to make current
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the promoted file version information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the promoted file version +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

promoteVersion(fileID, versionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ If there are previous versions of this file, this method can be used to promote one of the older +versions to the top of the stack. This actually mints a copy of the old version and puts it on +the top of the versions stack. The file will have the exact same contents, the same SHA1/etag, +and the same name as the original. Other properties such as comments do not get updated to their former values. + +API Endpoint: '/files/:fileID/versions/current' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file ID which version will be promoted
versionID + + +string + + + + + + + + + + The ID of the file_version that you want to make current
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the promoted file version information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the promoted file version +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeFromCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Remove a file from a given collection + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to remove from the collection
collectionID + + +string + + + + + + + + + + The collection to remove the file from
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeFromCollection(fileID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Remove a file from a given collection + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to remove from the collection
collectionID + + +string + + + + + + + + + + The collection to remove the file from
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeWatermark(fileID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to remove the watermark for a corresponding Box file. + +API Endpoint: '/files/:fileID/watermark' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file to remove watermark from
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

removeWatermark(fileID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to remove the watermark for a corresponding Box file. + +API Endpoint: '/files/:fileID/watermark' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The Box ID of the file to remove watermark from
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

restoreFromTrash(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Restores an item that has been moved to the trash. Default behavior is to +restore the item to the folder it was in before it was moved to the trash. +If that parent folder no longer exists or if there is now an item with the +same name in that parent folder, the new parent folder and/or new name will +need to be included in the request. + +API Endpoint: '/files/:fileID' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to restore
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		The new name for this item
parent_id + + +string + + + + + + <optional>
+ + + + + + 		The new parent folder for this item
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with item information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the restored file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

restoreFromTrash(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Restores an item that has been moved to the trash. Default behavior is to +restore the item to the folder it was in before it was moved to the trash. +If that parent folder no longer exists or if there is now an item with the +same name in that parent folder, the new parent folder and/or new name will +need to be included in the request. + +API Endpoint: '/files/:fileID' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to restore
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		The new name for this item
parent_id + + +string + + + + + + <optional>
+ + + + + + 		The new parent folder for this item
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with item information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the restored file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

setMetadata(fileID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Sets metadata on a file, overwriting any metadata that exists for the provided keys. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to set metadata on
scope + + +string + + + + + + + + + + The scope of the metadata template
template + + +string + + + + + + + + + + The key of the metadata template
metadata + + +Object + + + + + + + + + + The metadata to set
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with updated metadata if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated metadata +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

setMetadata(fileID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Sets metadata on a file, overwriting any metadata that exists for the provided keys. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to set metadata on
scope + + +string + + + + + + + + + + The scope of the metadata template
template + + +string + + + + + + + + + + The key of the metadata template
metadata + + +Object + + + + + + + + + + The metadata to set
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with updated metadata if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated metadata +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

unlock(fileID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Unlocks a file. + +API Endpoint: '/files/:fileID' + Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to unlock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed with the unlocked file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the unlocked file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

unlock(fileID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Unlocks a file. + +API Endpoint: '/files/:fileID' + Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the file to unlock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed with the unlocked file information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the unlocked file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

update(fileID, updates, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Update some information about a given file. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
updates + + +Object + + + + + + + + + + File fields to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only apply the updates if the file etag matches
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the update file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

update(fileID, updates, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Update some information about a given file. + +API Endpoint: '/files/:fileID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + Box ID of the file being requested
updates + + +Object + + + + + + + + + + File fields to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only apply the updates if the file etag matches
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated file information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the update file object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

updateMetadata(fileID, scope, template, patch, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Updates a metadata template instance with JSON Patch-formatted data. + +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to update metadata for
scope + + +string + + + + + + + + + + The scope of the template to update
template + + +string + + + + + + + + + + The template to update
patch + + +Object + + + + + + + + + + The patch data
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with updated metadata if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated metadata +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

updateMetadata(fileID, scope, template, patch, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Updates a metadata template instance with JSON Patch-formatted data. + +API Endpoint: '/files/:fileID/metadata/:scope/:template' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The file to update metadata for
scope + + +string + + + + + + + + + + The scope of the template to update
template + + +string + + + + + + + + + + The template to update
patch + + +Object + + + + + + + + + + The patch data
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with updated metadata if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated metadata +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

uploadFile(parentFolderID, filename, content, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Uploads a new file. Unlike non-upload methods, this method will not perform any retries. +This method currently does not support any optional parameters such as contentModifiedAt. + +API Endpoint: '/files/content' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parentFolderID + + +string + + + + + + + + + + the id of the parent folder to upload to
filename + + +string + + + + + + + + + + the file name that the uploaded file should have
content + + +string +| + +Buffer +| + +ReadStream + + + + + + + + + + the content of the file. It can be a string, a Buffer, or a read stream +(like that returned by fs.createReadStream()).
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
content_created_at + + +string + + + + + + <optional>
+ + + + + + 		RFC 3339 timestamp when the file was created
content_modified_at + + +string + + + + + + <optional>
+ + + + + + 		RFC 3339 timestamp when the file was last modified
content_length + + +int + + + + + + <optional>
+ + + + + + 		Optional length of the content. Required if content is a read stream of any type other than fs stream.
description + + +string + + + + + + <optional>
+ + + + + + 		Optional description of the uploaded file.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		called with data about the upload if successful, or an error if the +upload failed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the uploaded file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

uploadFile(parentFolderID, filename, content, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Uploads a new file. Unlike non-upload methods, this method will not perform any retries. +This method currently does not support any optional parameters such as contentModifiedAt. + +API Endpoint: '/files/content' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
parentFolderID + + +string + + + + + + + + + + the id of the parent folder to upload to
filename + + +string + + + + + + + + + + the file name that the uploaded file should have
content + + +string +| + +Buffer +| + +ReadStream + + + + + + + + + + the content of the file. It can be a string, a Buffer, or a read stream +(like that returned by fs.createReadStream()).
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
content_created_at + + +string + + + + + + <optional>
+ + + + + + 		RFC 3339 timestamp when the file was created
content_modified_at + + +string + + + + + + <optional>
+ + + + + + 		RFC 3339 timestamp when the file was last modified
content_length + + +int + + + + + + <optional>
+ + + + + + 		Optional length of the content. Required if content is a read stream of any type other than fs stream.
description + + +string + + + + + + <optional>
+ + + + + + 		Optional description of the uploaded file.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		called with data about the upload if successful, or an error if the +upload failed
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the uploaded file +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

uploadNewFileVersion(fileID, content, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Uploads a new version of a file. Unlike non-upload methods, this method will not perform any retries. +This method currently does not support any optional parameters such as contentModifiedAt. + +API Endpoint: '/files/:fileID/content' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12720,7 +26152,8 @@
Parameters:
- + @@ -12761,7 +26194,7 @@
Parameters:
Source:
@@ -12790,7 +26223,7 @@
Returns:
- A promise resolving to the updated metadata + A promise resolving to the uploaded file
@@ -12819,7 +26252,7 @@
Returns:
-

uploadFile(parentFolderID, filename, content, optionsopt, callbackopt) → {Promise.<Object>}

+

uploadNewFileVersion(fileID, content, optionsopt, callbackopt) → {Promise.<Object>}

@@ -12827,10 +26260,10 @@

uploadFile<
- Uploads a new file. Unlike non-upload methods, this method will not perform any retries. + Uploads a new version of a file. Unlike non-upload methods, this method will not perform any retries. This method currently does not support any optional parameters such as contentModifiedAt. -API Endpoint: '/files/content' +API Endpoint: '/files/:fileID/content' Method: POST
@@ -12869,38 +26302,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + + @@ -12943,7 +26345,7 @@
Parameters:
Buffer | -ReadStream +Stream @@ -13023,7 +26425,7 @@
Properties
- + + - + + @@ -13148,7 +26550,7 @@
Properties
- + @@ -13230,7 +26632,7 @@
Properties
Source:
@@ -13288,7 +26690,7 @@
Returns:
-

uploadNewFileVersion(fileID, content, optionsopt, callbackopt) → {Promise.<Object>}

+

uploadPart(sessionID, part, offset, totalSize, callbackopt) → {Promise.<Object>}

@@ -13296,11 +26698,10 @@

u
- Uploads a new version of a file. Unlike non-upload methods, this method will not perform any retries. -This method currently does not support any optional parameters such as contentModifiedAt. + Uploads a chunk of a file to an open upload session -API Endpoint: '/files/:fileID/content' -Method: POST +API Endpoint: '/files/upload_sessions/:sessionID' +Method: PUT
@@ -13338,7 +26739,7 @@

Parameters:
- + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -13626,8 +26892,7 @@
Properties
- + @@ -13668,7 +26933,7 @@
Properties
Source:
@@ -13697,7 +26962,7 @@
Returns:
- A promise resolving to the uploaded file + A promise resolving to the part object
@@ -13969,7 +27234,7 @@
Parameters:
Source:
@@ -14037,13 +27302,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderBase.html b/docs/jsdoc/FolderBase.html index 35c9a42e..567cfa58 100644 --- a/docs/jsdoc/FolderBase.html +++ b/docs/jsdoc/FolderBase.html @@ -76,7 +76,7 @@

FolderBase

Source:
@@ -166,7 +166,7 @@
Type:
Source:
@@ -245,7 +245,7 @@
Type:
Source:
@@ -318,7 +318,7 @@
Type:
Source:
@@ -352,13 +352,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/FolderMini.html b/docs/jsdoc/FolderMini.html index e7ddbaa5..bab701f4 100644 --- a/docs/jsdoc/FolderMini.html +++ b/docs/jsdoc/FolderMini.html @@ -75,7 +75,7 @@

FolderMini

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -248,7 +248,7 @@
Type:
Source:
@@ -282,13 +282,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Folders.html b/docs/jsdoc/Folders.html index fd1ec63b..ce47ab5d 100644 --- a/docs/jsdoc/Folders.html +++ b/docs/jsdoc/Folders.html @@ -457,7 +457,7 @@
Parameters:
Source:
@@ -515,7 +515,7 @@
Returns:
-

addToCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

+

addMetadata(folderID, scope, template, data, callbackopt) → {Promise.<Object>}

@@ -523,10 +523,11 @@

addToC
- Add a folder to a given collection + Adds metadata to a folder. Metadata must either match a template schema or +be placed into the unstructured "properties" template in global scope. -API Endpoint: '/folders/:folderID' -Method: PUT +API Endpoint: '/folders/:folderID/metadata/:scope/:template' +Method: POST
@@ -588,14 +589,14 @@

Parameters:
- + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -652,7 +715,7 @@
Parameters:
- + @@ -693,7 +756,7 @@
Parameters:
Source:
@@ -722,7 +785,7 @@
Returns:
- A promise resolving to the updated folder object + A promise resolving to the created metadata
@@ -751,7 +814,7 @@
Returns:
-

applyWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

addToCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

@@ -759,9 +822,9 @@

applyWa
- Used to apply or update the watermark for a corresponding Box folder. + Add a folder to a given collection -API Endpoint: '/folders/:folderID/watermark' +API Endpoint: '/folders/:folderID' Method: PUT
@@ -824,20 +887,20 @@

Parameters:
- + - + + @@ -890,7 +951,7 @@
Parameters:
- + @@ -931,7 +992,7 @@
Parameters:
Source:
@@ -960,7 +1021,7 @@
Returns:
- A promise resolving to the watermark info + A promise resolving to the updated folder object
@@ -989,7 +1050,7 @@
Returns:
-

copy(folderID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

+

addToCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

@@ -997,10 +1058,10 @@

copy - Copy a folder into a new, different folder + Add a folder to a given collection -API Endpoint: '/folders/:folderID/copy -Method: POST +API Endpoint: '/folders/:folderID' +Method: PUT @@ -1062,99 +1123,14 @@
Parameters:
-

- - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - + @@ -1220,7 +1187,7 @@
Properties
- + @@ -1261,7 +1228,7 @@
Properties
Source:
@@ -1290,7 +1257,7 @@
Returns:
- A promise resolving to the new folder object + A promise resolving to the updated folder object
@@ -1319,7 +1286,7 @@
Returns:
-

create(parentFolderID, name, callbackopt) → {Promise.<Object>}

+

applyWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1327,10 +1294,10 @@

create - Creates a new Folder within a parent folder + Used to apply or update the watermark for a corresponding Box folder. -API Endpoint: '/folders -Method: POST +API Endpoint: '/folders/:folderID/watermark' +Method: PUT @@ -1368,7 +1335,7 @@
Parameters:

- + + - + + @@ -1456,7 +1425,7 @@
Parameters:
- + @@ -1497,7 +1466,7 @@
Parameters:
Source:
@@ -1526,7 +1495,7 @@
Returns:
- A promise resolving to the created folder object + A promise resolving to the watermark info
@@ -1555,7 +1524,7 @@
Returns:
-

delete(folderID, optionsopt, callbackopt) → {Promise.<void>}

+

applyWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1563,10 +1532,10 @@

delete - Delete a given folder. + Used to apply or update the watermark for a corresponding Box folder. -API Endpoint: '/folders/:folderID' -Method: DELETE +API Endpoint: '/folders/:folderID/watermark' +Method: PUT @@ -1628,7 +1597,7 @@
Parameters:
-

+ @@ -1661,69 +1630,8 @@
Parameters:
- - + + @@ -1755,7 +1663,7 @@
Properties
- + @@ -1796,7 +1704,7 @@
Properties
Source:
@@ -1825,7 +1733,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the watermark info
@@ -1836,7 +1744,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1854,7 +1762,7 @@
Returns:
-

deleteLock(folderLockID, callbackopt) → {Promise.<void>}

+

copy(folderID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1862,10 +1770,10 @@

deleteLock<
- Used to delete a lock on a folder. + Copy a folder into a new, different folder -API Endpoint: '/folder_locks/:folderLockID' -Method: DELETE +API Endpoint: '/folders/:folderID/copy +Method: POST
@@ -1903,7 +1811,7 @@

Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1960,7 +1993,7 @@
Parameters:
- + @@ -2001,7 +2034,7 @@
Parameters:
Source:
@@ -2030,7 +2063,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new folder object
@@ -2041,7 +2074,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2059,7 +2092,7 @@
Returns:
-

deleteMetadata(folderID, scope, template, callbackopt) → {Promise.<void>}

+

copy(folderID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2067,10 +2100,10 @@

deleteM
- Deletes a metadata template from a folder. + Copy a folder into a new, different folder -API Endpoint: '/folders/:folderID/metadata/:scope/:template' -Method: DELETE +API Endpoint: '/folders/:folderID/copy +Method: POST
@@ -2132,14 +2165,14 @@

Parameters:
- + - + + - + - + + + + + + + + + + + + + + + + + + + @@ -2268,7 +2364,7 @@
Parameters:
Source:
@@ -2297,7 +2393,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the new folder object
@@ -2308,7 +2404,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2326,7 +2422,7 @@
Returns:
-

deletePermanently(folderID, optionsopt, callbackopt) → {Promise.<void>}

+

create(parentFolderID, name, callbackopt) → {Promise.<Object>}

@@ -2334,10 +2430,10 @@

dele
- Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone + Creates a new Folder within a parent folder -API Endpoint: '/folders/:folderID/trash' -Method: DELETE +API Endpoint: '/folders +Method: POST
@@ -2375,7 +2471,7 @@

Parameters:
- + + - - - - - - - - - - - - + @@ -2526,7 +2559,7 @@
Properties
- + @@ -2567,7 +2600,7 @@
Properties
Source:
@@ -2596,7 +2629,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the created folder object
@@ -2607,7 +2640,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2625,7 +2658,7 @@
Returns:
-

get(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

create(parentFolderID, name, callbackopt) → {Promise.<Object>}

@@ -2633,10 +2666,10 @@

get - Requests a folder object with the given ID. + Creates a new Folder within a parent folder -API Endpoint: '/folders/:folderID' -Method: GET +API Endpoint: '/folders +Method: POST @@ -2674,7 +2707,7 @@
Parameters:

- + + - + + @@ -2764,7 +2795,7 @@
Parameters:
- + @@ -2805,7 +2836,7 @@
Parameters:
Source:
@@ -2834,7 +2865,7 @@
Returns:
- A promise resolving to the folder object + A promise resolving to the created folder object
@@ -2863,7 +2894,7 @@
Returns:
-

getAllMetadata(folderID, callbackopt) → {Promise.<Object>}

+

delete(folderID, optionsopt, callbackopt) → {Promise.<void>}

@@ -2871,10 +2902,10 @@

getAllM
- Retrieves all metadata associated with a folder. + Delete a given folder. -API Endpoint: '/folders/:folderID/metadata' -Method: GET +API Endpoint: '/folders/:folderID' +Method: DELETE
@@ -2936,20 +2967,20 @@

Parameters:
- + - + - - - - -
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + the id of the file to upload a new version of
content + + +string +| + +Buffer +| + +Stream + + + + + + + + + + the content of the file. It can be a string, a Buffer, or a read stream +(like that returned by fs.createReadStream()).
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + - + + + + + + +
NameTypeAttributesDescription
content_modified_at + + +string + + + + + + <optional>
+ + + + + + 		RFC 3339 timestamp when the file was last modified
scopename @@ -12616,6 +26035,8 @@
Parameters:
 + <optional>
+ @@ -12625,20 +26046,20 @@
Parameters:
- 		The scope of the template to updateA new name for the file
templatecontent_length -string +int @@ -12647,6 +26068,8 @@
Parameters:
 + <optional>
+ @@ -12656,20 +26079,20 @@
Parameters:
- 		The template to updateOptional length of the content. Required if content is a read stream of any type other than fs stream.
patchdescription -Object +string @@ -12678,6 +26101,8 @@
Parameters:
 + <optional>
+ @@ -12687,7 +26112,14 @@
Parameters:
- 		The patch dataOptional description of the uploaded new file version.
+ +
Called with updated metadata if successfulcalled with data about the upload if successful, or an error if the +upload failed
parentFolderID - - -string - - - - - - - - - - the id of the parent folder to upload to
filenamefileID @@ -12924,7 +26326,7 @@
Parameters:
- 		the file name that the uploaded file should havethe id of the file to upload a new version of
content_created_atcontent_modified_at @@ -13049,14 +26451,14 @@
Properties
- 		RFC 3339 timestamp when the file was createdRFC 3339 timestamp when the file was last modified
content_modified_atname @@ -13082,7 +26484,7 @@
Properties
- 		RFC 3339 timestamp when the file was last modifiedA new name for the file
Optional description of the uploaded file.Optional description of the uploaded new file version.
fileIDsessionID @@ -13362,144 +26763,22 @@
Parameters:
- 		the id of the file to upload a new version ofThe ID of the upload session to upload to
contentpart -string -| - Buffer | -Stream - - - - - - - - - - the content of the file. It can be a string, a Buffer, or a read stream -(like that returned by fs.createReadStream()).
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + - + - - - - -
NameTypeAttributesDescription
content_modified_at - - -string - - - - - - <optional>
- - - - - - 		RFC 3339 timestamp when the file was last modified
name - - string @@ -13509,8 +26788,6 @@
Properties
 - <optional>
- @@ -13520,14 +26797,14 @@
Properties
- 		A new name for the fileThe chunk of the file to upload
content_lengthoffset @@ -13542,8 +26819,6 @@
Properties
 - <optional>
- @@ -13553,20 +26828,20 @@
Properties
- 		Optional length of the content. Required if content is a read stream of any type other than fs stream.The byte position where the chunk begins in the file
descriptiontotalSize -string +int @@ -13575,8 +26850,6 @@
Properties
 - <optional>
- @@ -13586,14 +26859,7 @@
Properties
- 		Optional description of the uploaded new file version.
- - 		The total size of the file being uploaded
called with data about the upload if successful, or an error if the -upload failedPassed the part definition if successful
The folder to add to the collectionThe ID of the folder to add metadata to
collectionIDscope @@ -619,7 +620,69 @@
Parameters:
- 		The collection to add the folder toThe scope of the metadata template, e.g. "enterprise"
template + + +string + + + + + + + + + + The metadata template schema to add
data + + +Object + + + + + + + + + + Key/value pairs to add as metadata
Passed the updated folder if successful, error otherwiseCalled with error if unsuccessful
The Box ID of the folder to update watermark forThe folder to add to the collection
optionscollectionID -Object +string @@ -846,8 +909,6 @@
Parameters:
 - <optional>
- @@ -857,7 +918,7 @@
Parameters:
- 		Optional parameters, can be left nullThe collection to add the folder to
Passed the watermark information if successful, error otherwisePassed the updated folder if successful, error otherwise
The Box ID of the folder being requested
newParentID - - -string - - - - - - - - - - The Box ID for the new parent folder. '0' to copy to All Files.The folder to add to the collection
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters for the copy operation, can be left null in most cases -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - -
NameTypeAttributesDescription
namecollectionID @@ -1169,8 +1145,6 @@
Properties
 - <optional>
- @@ -1180,14 +1154,7 @@
Properties
- 		A new name to use if there is an identically-named item in the new parent folder
- - 		The collection to add the folder to
passed the new folder info if call was successfulPassed the updated folder if successful, error otherwise
parentFolderIDfolderID @@ -1392,20 +1359,20 @@
Parameters:
- 		Box folder id of the folder to add intoThe Box ID of the folder to update watermark for
nameoptions -string +Object @@ -1414,6 +1381,8 @@
Parameters:
 + <optional>
+ @@ -1423,7 +1392,7 @@
Parameters:
- 		The name for the new folderOptional parameters, can be left null
passed the new folder info if call was successfulPassed the watermark information if successful, error otherwise
Box ID of the folder being requestedThe Box ID of the folder to update watermark for
Additional options for the request. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
etag - - -string - - - - - - <optional>
- - - - - - 		Only delete the folder if the ETag matches
- -
Optional parameters, can be left null
Empty response body passed if successful.Passed the watermark information if successful, error otherwise
folderLockIDfolderID @@ -1927,7 +1835,132 @@
Parameters:
- 		The Box ID of the folder lockThe Box ID of the folder being requested
newParentID + + +string + + + + + + + + + + The Box ID for the new parent folder. '0' to copy to All Files.
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters for the copy operation, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		A new name to use if there is an identically-named item in the new parent folder
+ +
Empty response body passed if successful, error otherwisepassed the new folder info if call was successful
The ID of the folder to remove metadata fromThe Box ID of the folder being requested
scopenewParentID @@ -2163,20 +2196,20 @@
Parameters:
- 		The scope of the metadata templateThe Box ID for the new parent folder. '0' to copy to All Files.
templateoptions -string +Object @@ -2185,6 +2218,8 @@
Parameters:
 + <optional>
+ @@ -2194,20 +2229,41 @@
Parameters:
- 		The template to remove from the folder
Optional parameters for the copy operation, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + +
NameTypeAttributesDescription
callbackname -function +string @@ -2227,7 +2283,47 @@
Parameters:
- 		Called with nothing if successful, error otherwiseA new name to use if there is an identically-named item in the new parent folder
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the new folder info if call was successful
folderIDparentFolderID @@ -2399,68 +2495,14 @@
Parameters:
- 		Box ID of the folder being requestedBox folder id of the folder to add into
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - -
NameTypeAttributesDescription
etagname @@ -2475,8 +2517,6 @@
Properties
 - <optional>
- @@ -2486,14 +2526,7 @@
Properties
- 		Only delete the folder if the ETag matches
- - 		The name for the new folder
Called with nothing if successful, error otherwisepassed the new folder info if call was successful
folderIDparentFolderID @@ -2698,20 +2731,20 @@
Parameters:
- 		Box ID of the folder being requestedBox folder id of the folder to add into
optionsname -Object +string @@ -2720,8 +2753,6 @@
Parameters:
 - <optional>
- @@ -2731,7 +2762,7 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The name for the new folder
Passed the folder information if it was acquired successfullypassed the new folder info if call was successful
the ID of the folder to get metadata forBox ID of the folder being requested
callbackoptions -function +Object @@ -2969,57 +3000,151 @@
Parameters:
- 		called with an array of metadata when successful
- + Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + -
+
+ + + - + + + + - + - + + + - + - + + + +
NameTypeAttributesDescription
etag + + +string - - + + + + <optional>
+ - + - + + 		Only delete the folder if the ETag matches
- + + - -
Source:
-
- + + + callback + - + + + +function - -

+ + + + + + + + <optional>
+ + + + + + + + + + + Empty response body passed if successful. + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
@@ -3039,7 +3164,7 @@
Returns:
- A promise resolving to the collection of metadata on the folder + A promise resolving to nothing
@@ -3050,7 +3175,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -3068,7 +3193,7 @@
Returns:
-

getCollaborations(folderID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

+

delete(folderID, optionsopt, callbackopt) → {Promise.<void>}

@@ -3076,10 +3201,10 @@

getC
- Requests collaborations on a given folder. + Delete a given folder. -API Endpoint: '/folders/:folderID/collaborations' -Method: GET +API Endpoint: '/folders/:folderID' +Method: DELETE
@@ -3174,7 +3299,68 @@

Parameters:
- Additional options for the request. Can be left null in most cases. + Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only delete the folder if the ETag matches
+ + @@ -3207,7 +3393,7 @@
Parameters:
- Passed the folder information if it was acquired successfully + Empty response body passed if successful. @@ -3248,7 +3434,7 @@
Parameters:
Source:
@@ -3277,7 +3463,7 @@
Returns:
- A promise resolving to the collection of collaborations + A promise resolving to nothing
@@ -3288,7 +3474,7 @@
Returns:
-Promise.<schemas.Collaborations> +Promise.<void>
@@ -3306,7 +3492,7 @@
Returns:
-

getItems(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

deleteLock(folderLockID, callbackopt) → {Promise.<void>}

@@ -3314,10 +3500,10 @@

getItems - Requests items contained within a given folder. + Used to delete a lock on a folder. -API Endpoint: '/folders/:folderID/items' -Method: GET +API Endpoint: '/folder_locks/:folderLockID' +Method: DELETE @@ -3355,7 +3541,7 @@
Parameters:
- folderID + folderLockID @@ -3379,40 +3565,7 @@
Parameters:
- Box ID of the folder being requested - - - - - - - options - - - - - -Object - - - - - - - - - <optional>
- - - - - - - - - - - Additional options for the request. Can be left null in most cases. + The Box ID of the folder lock @@ -3445,7 +3598,7 @@
Parameters:
- Passed the folder information if it was acquired successfully + Empty response body passed if successful, error otherwise @@ -3486,7 +3639,7 @@
Parameters:
Source:
@@ -3515,7 +3668,7 @@
Returns:
- A promise resolving to the collection of the items in the folder + A promise resolving to nothing
@@ -3526,7 +3679,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -3544,7 +3697,7 @@
Returns:
-

getLocks(folderID, callbackopt) → {Promise.<void>}

+

deleteLock(folderLockID, callbackopt) → {Promise.<void>}

@@ -3552,10 +3705,10 @@

getLocks - Used to get all locks on a folder. + Used to delete a lock on a folder. -API Endpoint: '/folder_locks' -Method: GET +API Endpoint: '/folder_locks/:folderLockID' +Method: DELETE @@ -3593,7 +3746,7 @@
Parameters:
- folderID + folderLockID @@ -3617,7 +3770,7 @@
Parameters:
- The Box ID of the folder to lock + The Box ID of the folder lock @@ -3650,7 +3803,7 @@
Parameters:
- Passed a collection of folder lock objects if successful, error otherwise + Empty response body passed if successful, error otherwise @@ -3691,7 +3844,7 @@
Parameters:
Source:
@@ -3720,7 +3873,7 @@
Returns:
- A promise resolving to a collection of folder lock objects + A promise resolving to nothing
@@ -3749,7 +3902,7 @@
Returns:
-

getMetadata(folderID, scope, template, callbackopt) → {Promise.<Object>}

+

deleteMetadata(folderID, scope, template, callbackopt) → {Promise.<void>}

@@ -3757,10 +3910,10 @@

getMetadat
- Retrieve a single metadata template instance for a folder. + Deletes a metadata template from a folder. API Endpoint: '/folders/:folderID/metadata/:scope/:template' -Method: GET +Method: DELETE
@@ -3822,7 +3975,7 @@

Parameters:
- The ID of the folder to retrive the metadata of + The ID of the folder to remove metadata from @@ -3853,7 +4006,7 @@
Parameters:
- The scope of the metadata template, e.g. "global" + The scope of the metadata template @@ -3884,7 +4037,7 @@
Parameters:
- The metadata template to retrieve + The template to remove from the folder @@ -3917,7 +4070,7 @@
Parameters:
- Passed the metadata template if successful + Called with nothing if successful, error otherwise @@ -3958,7 +4111,7 @@
Parameters:
Source:
@@ -3987,7 +4140,7 @@
Returns:
- A promise resolving to the metadata template + A promise resolving to nothing
@@ -3998,7 +4151,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -4016,7 +4169,7 @@
Returns:
-

getTrashedFolder(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

deleteMetadata(folderID, scope, template, callbackopt) → {Promise.<void>}

@@ -4024,10 +4177,10 @@

getTr
- Retrieves a folder that has been moved to the trash + Deletes a metadata template from a folder. -API Endpoint: '/folders/:folderID/trash' -Method: GET +API Endpoint: '/folders/:folderID/metadata/:scope/:template' +Method: DELETE
@@ -4089,20 +4242,20 @@

Parameters:
- The ID of the folder being requested + The ID of the folder to remove metadata from - options + scope -Object +string @@ -4111,8 +4264,6 @@
Parameters:
- <optional>
- @@ -4122,20 +4273,20 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + The scope of the metadata template - callback + template -function +string @@ -4144,8 +4295,6 @@
Parameters:
- <optional>
- @@ -4155,13 +4304,46 @@
Parameters:
- Passed the folder information if it was acquired successfully + The template to remove from the folder - - - + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Called with nothing if successful, error otherwise + + + + + + @@ -4196,7 +4378,7 @@
Parameters:
Source:
@@ -4225,7 +4407,7 @@
Returns:
- A promise resolving to the trashed folder object + A promise resolving to nothing
@@ -4236,7 +4418,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -4254,7 +4436,7 @@
Returns:
-

getWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

deletePermanently(folderID, optionsopt, callbackopt) → {Promise.<void>}

@@ -4262,10 +4444,10 @@

getWaterm
- Used to retrieve the watermark for a corresponding Box folder. + Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone -API Endpoint: '/folders/:folderID/watermark' -Method: GET +API Endpoint: '/folders/:folderID/trash' +Method: DELETE
@@ -4327,7 +4509,7 @@

Parameters:
- The Box ID of the folder to get watermark for + Box ID of the folder being requested @@ -4360,7 +4542,68 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only delete the folder if the ETag matches
+ + @@ -4393,7 +4636,7 @@
Parameters:
- Passed the watermark information if successful, error otherwise + Called with nothing if successful, error otherwise @@ -4434,7 +4677,7 @@
Parameters:
Source:
@@ -4463,7 +4706,7 @@
Returns:
- A promise resolving to the watermark info + A promise resolving to nothing
@@ -4474,7 +4717,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -4492,7 +4735,7 @@
Returns:
-

lock(folderID, callbackopt) → {Promise.<void>}

+

deletePermanently(folderID, optionsopt, callbackopt) → {Promise.<void>}

@@ -4500,10 +4743,10 @@

lock - Used to lock a Box folder. + Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone -API Endpoint: '/folder_locks' -Method: POST +API Endpoint: '/folders/:folderID/trash' +Method: DELETE @@ -4565,7 +4808,101 @@
Parameters:
- The Box ID of the folder to lock + Box ID of the folder being requested + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
etag + + +string + + + + + + <optional>
+ + + + + + 		Only delete the folder if the ETag matches
+ + @@ -4598,7 +4935,7 @@
Parameters:
- Passed the folder lock object if successful, error otherwise + Called with nothing if successful, error otherwise @@ -4639,7 +4976,7 @@
Parameters:
Source:
@@ -4668,7 +5005,7 @@
Returns:
- A promise resolving to a folder lock object + A promise resolving to nothing
@@ -4697,7 +5034,7 @@
Returns:
-

move(folderID, newParentID, callbackopt) → {Promise.<Object>}

+

get(folderID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -4705,10 +5042,10 @@

move - Move a folder into a new parent folder. + Requests a folder object with the given ID. API Endpoint: '/folders/:folderID' -Method: PUT +Method: GET @@ -4770,20 +5107,20 @@
Parameters:
- The Box ID of the folder being requested + Box ID of the folder being requested - newParentID + options -string +Object @@ -4792,6 +5129,8 @@
Parameters:
+ <optional>
+ @@ -4801,7 +5140,7 @@
Parameters:
- The Box ID for the new parent folder. '0' to move to All Files. + Additional options for the request. Can be left null in most cases. @@ -4834,7 +5173,7 @@
Parameters:
- Passed the updated folder information if it was acquired successfully + Passed the folder information if it was acquired successfully @@ -4875,7 +5214,7 @@
Parameters:
Source:
@@ -4904,7 +5243,7 @@
Returns:
- A promise resolving to the updated folder object + A promise resolving to the folder object
@@ -4933,7 +5272,7 @@
Returns:
-

removeFromCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

+

get(folderID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -4941,10 +5280,10 @@

r
- Remove a folder from a given collection + Requests a folder object with the given ID. API Endpoint: '/folders/:folderID' -Method: PUT +Method: GET
@@ -5006,20 +5345,20 @@

Parameters:
- The folder to remove from the collection + Box ID of the folder being requested - collectionID + options -string +Object @@ -5028,7 +5367,5907 @@
Parameters:
- + <optional>
+ + + + + + + + + + + Additional options for the request. Can be left null in most cases. + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the folder information if it was acquired successfully + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAllMetadata(folderID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves all metadata associated with a folder. + +API Endpoint: '/folders/:folderID/metadata' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + the ID of the folder to get metadata for
callback + + +function + + + + + + <optional>
+ + + + + + 		called with an array of metadata when successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of metadata on the folder +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAllMetadata(folderID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves all metadata associated with a folder. + +API Endpoint: '/folders/:folderID/metadata' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + the ID of the folder to get metadata for
callback + + +function + + + + + + <optional>
+ + + + + + 		called with an array of metadata when successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of metadata on the folder +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCollaborations(folderID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

+ + + + + + +
+ Requests collaborations on a given folder. + +API Endpoint: '/folders/:folderID/collaborations' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + Box ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of collaborations +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.Collaborations> + + +
+
+ + + + + + + + + + + + + +

getCollaborations(folderID, optionsopt, callbackopt) → {Promise.<schemas.Collaborations>}

+ + + + + + +
+ Requests collaborations on a given folder. + +API Endpoint: '/folders/:folderID/collaborations' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + Box ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of collaborations +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.Collaborations> + + +
+
+ + + + + + + + + + + + + +

getItems(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests items contained within a given folder. + +API Endpoint: '/folders/:folderID/items' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + Box ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of the items in the folder +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getItems(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests items contained within a given folder. + +API Endpoint: '/folders/:folderID/items' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + Box ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of the items in the folder +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getLocks(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to get all locks on a folder. + +API Endpoint: '/folder_locks' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to lock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a collection of folder lock objects if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a collection of folder lock objects +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getLocks(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to get all locks on a folder. + +API Endpoint: '/folder_locks' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to lock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a collection of folder lock objects if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a collection of folder lock objects +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getMetadata(folderID, scope, template, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve a single metadata template instance for a folder. + +API Endpoint: '/folders/:folderID/metadata/:scope/:template' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to retrive the metadata of
scope + + +string + + + + + + + + + + The scope of the metadata template, e.g. "global"
template + + +string + + + + + + + + + + The metadata template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the metadata template if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the metadata template +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getMetadata(folderID, scope, template, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve a single metadata template instance for a folder. + +API Endpoint: '/folders/:folderID/metadata/:scope/:template' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to retrive the metadata of
scope + + +string + + + + + + + + + + The scope of the metadata template, e.g. "global"
template + + +string + + + + + + + + + + The metadata template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the metadata template if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the metadata template +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTrashedFolder(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves a folder that has been moved to the trash + +API Endpoint: '/folders/:folderID/trash' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the trashed folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTrashedFolder(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieves a folder that has been moved to the trash + +API Endpoint: '/folders/:folderID/trash' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the trashed folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to retrieve the watermark for a corresponding Box folder. + +API Endpoint: '/folders/:folderID/watermark' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to get watermark for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the watermark information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the watermark info +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getWatermark(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to retrieve the watermark for a corresponding Box folder. + +API Endpoint: '/folders/:folderID/watermark' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to get watermark for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the watermark information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the watermark info +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

lock(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to lock a Box folder. + +API Endpoint: '/folder_locks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to lock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder lock object if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a folder lock object +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

lock(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to lock a Box folder. + +API Endpoint: '/folder_locks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to lock
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the folder lock object if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to a folder lock object +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

move(folderID, newParentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Move a folder into a new parent folder. + +API Endpoint: '/folders/:folderID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder being requested
newParentID + + +string + + + + + + + + + + The Box ID for the new parent folder. '0' to move to All Files.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

move(folderID, newParentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Move a folder into a new parent folder. + +API Endpoint: '/folders/:folderID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder being requested
newParentID + + +string + + + + + + + + + + The Box ID for the new parent folder. '0' to move to All Files.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated folder information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeFromCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Remove a folder from a given collection + +API Endpoint: '/folders/:folderID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The folder to remove from the collection
collectionID + + +string + + + + + + + + + + The collection to remove the folder from
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated folder if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeFromCollection(folderID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Remove a folder from a given collection + +API Endpoint: '/folders/:folderID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The folder to remove from the collection
collectionID + + +string + + + + + + + + + + The collection to remove the folder from
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated folder if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

removeWatermark(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to remove the watermark for a corresponding Box folder. + +API Endpoint: '/folders/:folderID/watermark' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to remove watermark from
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

removeWatermark(folderID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Used to remove the watermark for a corresponding Box folder. + +API Endpoint: '/folders/:folderID/watermark' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The Box ID of the folder to remove watermark from
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

restoreFromTrash(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Restores an item that has been moved to the trash. Default behavior is to restore the item +to the folder it was in before it was moved to the trash. If that parent folder no longer +exists or if there is now an item with the same name in that parent folder, the new parent +older and/or new name will need to be included in the request. + +API Endpoint: '/folders/:folderID' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to restore
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + <nullable>
+ + + + 		The new name for this item
parent_id + + +string + + + + + + <optional>
+ + + + + + 		The new parent folder for this item
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with folder information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the restored folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

restoreFromTrash(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Restores an item that has been moved to the trash. Default behavior is to restore the item +to the folder it was in before it was moved to the trash. If that parent folder no longer +exists or if there is now an item with the same name in that parent folder, the new parent +older and/or new name will need to be included in the request. + +API Endpoint: '/folders/:folderID' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to restore
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + <nullable>
+ + + + 		The new name for this item
parent_id + + +string + + + + + + <optional>
+ + + + + + 		The new parent folder for this item
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with folder information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the restored folder object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

setMetadata(folderID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Sets metadata on a folder, overwriting any metadata that exists for the provided keys. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5070,7 +11402,7 @@
Parameters:
- + @@ -5111,7 +11443,7 @@
Parameters:
Source:
@@ -5140,7 +11472,7 @@
Returns:
- A promise resolving to the updated folder object + A promise resolving to the updated metadata
@@ -5154,77 +11486,167 @@
Returns:
Promise.<Object> - - + + + + + + + + + + + + + + + +

setMetadata(folderID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Sets metadata on a folder, overwriting any metadata that exists for the provided keys. +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
folderID + + +string + + + + + + @@ -5037,7 +11276,100 @@
Parameters:
- 		The collection to remove the folder fromThe folder to set metadata on
scope + + +string + + + + + + + + + + The scope of the metadata template
template + + +string + + + + + + + + + + The key of the metadata template
metadata + + +Object + + + + + + + + + + The metadata to set
Passed the updated folder if successful, error otherwiseCalled with updated metadata if successful
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + -

removeWatermark(folderID, callbackopt) → {Promise.<void>}

- - + + + + + -API Endpoint: '/folders/:folderID/watermark' -Method: DELETE - + + + + + + + + + + + + -
NameTypeAttributesDescription
folderID + + +string - + + + + + + The folder to set metadata on
scope + + +string -
- Used to remove the watermark for a corresponding Box folder. + +
+ + + + The scope of the metadata template
template + + +string -
Parameters:
- + +
- - - - - + + + - - - + + + - + - - - + + - - + + @@ -5275,7 +11697,7 @@
Parameters:
- + @@ -5316,7 +11738,7 @@
Parameters:
Source:
@@ -5345,7 +11767,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the updated metadata
@@ -5356,7 +11778,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -5374,7 +11796,7 @@
Returns:
-

restoreFromTrash(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+

update(folderID, updates, callbackopt) → {Promise.<Object>}

@@ -5382,13 +11804,10 @@

resto
- Restores an item that has been moved to the trash. Default behavior is to restore the item -to the folder it was in before it was moved to the trash. If that parent folder no longer -exists or if there is now an item with the same name in that parent folder, the new parent -older and/or new name will need to be included in the request. + Update some information about a given folder. API Endpoint: '/folders/:folderID' -Method: POST +Method: PUT
@@ -5450,14 +11869,14 @@

Parameters:
- + - + - + @@ -5539,14 +11954,14 @@
Properties
- + - + + @@ -5612,7 +12027,7 @@
Properties
- + @@ -5653,7 +12068,7 @@
Properties
Source:
@@ -5682,7 +12097,7 @@
Returns:
- A promise resolving to the restored folder object + A promise resolving to the updated folder object
@@ -5711,7 +12126,7 @@
Returns:
-

setMetadata(folderID, scope, template, metadata, callbackopt) → {Promise.<Object>}

+

update(folderID, updates, callbackopt) → {Promise.<Object>}

@@ -5719,7 +12134,10 @@

setMetadat
- Sets metadata on a folder, overwriting any metadata that exists for the provided keys. + Update some information about a given folder. + +API Endpoint: '/folders/:folderID' +Method: PUT
@@ -5781,20 +12199,20 @@

Parameters:
- + - + - + @@ -5907,7 +12357,7 @@
Parameters:
- + @@ -5948,7 +12398,7 @@
Parameters:
Source:
@@ -5977,7 +12427,7 @@
Returns:
- A promise resolving to the updated metadata + A promise resolving to the updated folder object
@@ -6006,7 +12456,7 @@
Returns:
-

update(folderID, updates, callbackopt) → {Promise.<Object>}

+

updateMetadata(folderID, scope, template, patch, callbackopt) → {Promise.<Object>}

@@ -6014,9 +12464,9 @@

update - Update some information about a given folder. + Updates a metadata template instance with JSON Patch-formatted data. -API Endpoint: '/folders/:folderID' +API Endpoint: '/folders/:folderID/metadata/:scope/:template' Method: PUT @@ -6079,20 +12529,20 @@
Parameters:
-

+ - + + @@ -6237,7 +12655,7 @@
Properties
- + @@ -6278,7 +12696,7 @@
Properties
Source:
@@ -6307,7 +12725,7 @@
Returns:
- A promise resolving to the updated folder object + A promise resolving to the updated metadata
@@ -6576,7 +12994,7 @@
Parameters:
Source:
@@ -6644,13 +13062,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Groups.html b/docs/jsdoc/Groups.html index 3ca2b713..cd1b8183 100644 --- a/docs/jsdoc/Groups.html +++ b/docs/jsdoc/Groups.html @@ -265,7 +265,7 @@
Type:
Source:
@@ -337,7 +337,7 @@
Type:
Source:
@@ -637,7 +637,7 @@
Properties
Source:
@@ -695,6 +695,767 @@
Returns:
+

addUser(groupID, userID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Add a user to a group, which creates a membership record for the user + +API Endpoint: '/group_memberships' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + +
Name + - TypeAttributesDescription
The key of the metadata template
folderIDmetadata -string +Object @@ -5242,7 +11664,7 @@
Parameters:
- 		The Box ID of the folder to remove watermark fromThe metadata to set
Empty response body passed if successful, error otherwiseCalled with updated metadata if successful
The ID of the folder to restoreThe Box ID of the folder being requested
optionsupdates @@ -5472,8 +11891,6 @@
Parameters:
 - <optional>
- @@ -5483,7 +11900,7 @@
Parameters:
- 		Optional parameters, can be left null + Folder fields to update
Properties
@@ -5511,7 +11928,7 @@
Properties
nameetag @@ -5530,8 +11947,6 @@
Properties
- <nullable>
- 		The new name for this itemOnly update the folder if the ETag matches
parent_idfields @@ -5572,7 +11987,7 @@
Properties
- 		The new parent folder for this itemComma-separated list of fields to return
Called with folder information if successful, error otherwisePassed the updated folder information if it was acquired successfully
The folder to set metadata onThe Box ID of the folder being requested
scopeupdates -string +Object @@ -5812,14 +12230,35 @@
Parameters:
- 		The scope of the metadata template
Folder fields to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + - + + + + + + +
NameTypeAttributesDescription
templateetag @@ -5834,6 +12273,8 @@
Parameters:
 + <optional>
+ @@ -5843,20 +12284,20 @@
Parameters:
- 		The key of the metadata templateOnly update the folder if the ETag matches
metadatafields -Object +string @@ -5865,6 +12306,8 @@
Parameters:
 + <optional>
+ @@ -5874,7 +12317,14 @@
Parameters:
- 		The metadata to setComma-separated list of fields to return
+ +
Called with updated metadata if successfulPassed the updated folder information if it was acquired successfully
The Box ID of the folder being requestedThe folder to update metadata for
updatesscope -Object +string @@ -6110,35 +12560,14 @@
Parameters:
- 		Folder fields to update -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + + - + - - - - -
NameTypeAttributesDescription
The scope of the template to update
etagtemplate @@ -6153,8 +12582,6 @@
Properties
 - <optional>
- @@ -6164,20 +12591,20 @@
Properties
- 		Only update the folder if the ETag matchesThe template to update
fieldspatch -string +Object @@ -6186,8 +12613,6 @@
Properties
 - <optional>
- @@ -6197,14 +12622,7 @@
Properties
- 		Comma-separated list of fields to return
- - 		The patch data
Passed the updated folder information if it was acquired successfullyCalled with updated metadata if successful
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to add the user to
userID + + +string + + + + + + + + + + The ID of the user to add the the group
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters for adding the user, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
role + + +GroupUserRole + + + + + + <optional>
+ + + + + + 		The role of the user in the group
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the membership record if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new membership object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(name, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to create a new group + +API Endpoint: '/groups' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + + + + + The name for the new group
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
provenance + + +string + + + + + + <optional>
+ + + + + + 		Used to track the external source where the group is coming from
external_sync_identifier + + +string + + + + + + <optional>
+ + + + + + 		Used as a group identifier for groups coming from an external source
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the group
invitability_level + + +GroupAccessLevel + + + + + + <optional>
+ + + + + + 		Specifies who can invite this group to collaborate on folders
member_viewability_level + + +GroupAccessLevel + + + + + + <optional>
+ + + + + + 		Specifies who can view the members of this group
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new group object if it was created successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new group object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + +

create(name, optionsopt, callbackopt) → {Promise.<Object>}

@@ -703,10 +1464,2331 @@

create - Used to create a new group + Used to create a new group + +API Endpoint: '/groups' +Method: POST + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + + + + + The name for the new group
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
provenance + + +string + + + + + + <optional>
+ + + + + + 		Used to track the external source where the group is coming from
external_sync_identifier + + +string + + + + + + <optional>
+ + + + + + 		Used as a group identifier for groups coming from an external source
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the group
invitability_level + + +GroupAccessLevel + + + + + + <optional>
+ + + + + + 		Specifies who can invite this group to collaborate on folders
member_viewability_level + + +GroupAccessLevel + + + + + + <optional>
+ + + + + + 		Specifies who can view the members of this group
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new group object if it was created successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new group object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(groupID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a group + +API Endpoint: '/groups/:groupID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

delete(groupID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a group + +API Endpoint: '/groups/:groupID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to fetch information about a group + +API Endpoint: '/groups/:groupID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the group object if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the group object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to fetch information about a group + +API Endpoint: '/groups/:groupID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the group object if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the group object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retreieve a list of groups in the caller's enterprise. This ability is +restricted to certain users with permission to view groups. + +API Endpoint: '/groups' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
filter_term + + +string + + + + + + <optional>
+ + + + + + 		Limits the results to only groups whose name starts with the search term
limit + + +int + + + + + + <optional>
+ + + + + + 		The number of memberships to retrieve
offset + + +int + + + + + + <optional>
+ + + + + + 		Paging marker, retrieve records starting at this position in the list
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of groups if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of groups +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retreieve a list of groups in the caller's enterprise. This ability is +restricted to certain users with permission to view groups. + +API Endpoint: '/groups' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
filter_term + + +string + + + + + + <optional>
+ + + + + + 		Limits the results to only groups whose name starts with the search term
limit + + +int + + + + + + <optional>
+ + + + + + 		The number of memberships to retrieve
offset + + +int + + + + + + <optional>
+ + + + + + 		Paging marker, retrieve records starting at this position in the list
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of groups if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of groups +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCollaborations(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retreieve a list of collaborations for the group, which show which items the +group has access to. + +API Endpoint: '/groups/:groupID/collaborations' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
groupID + + +string + + + + + + + + + + The ID of the group to get collaborations for
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		The number of memberships to retrieve
offset + + +int + + + + + + <optional>
+ + + + + + 		Paging marker, retrieve records starting at this position in the list
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a list of collaborations if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of collaborations for the group +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCollaborations(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retreieve a list of collaborations for the group, which show which items the +group has access to. -API Endpoint: '/groups' -Method: POST +API Endpoint: '/groups/:groupID/collaborations' +Method: GET
@@ -744,7 +3826,7 @@
Parameters:
- name + groupID @@ -768,7 +3850,7 @@
Parameters:
- The name for the new group + The ID of the group to get collaborations for @@ -801,7 +3883,7 @@
Parameters:
- Additional parameters + Optional parameters, can be left null in most cases
Properties
@@ -829,13 +3911,13 @@
Properties
- provenance + limit -string +int @@ -855,20 +3937,20 @@
Properties
- Used to track the external source where the group is coming from + The number of memberships to retrieve - external_sync_identifier + offset -string +int @@ -888,20 +3970,27 @@
Properties
- Used as a group identifier for groups coming from an external source + Paging marker, retrieve records starting at this position in the list + + + + + + + - description + callback -string +function @@ -921,20 +4010,162 @@
Properties
- Description of the group + Passed a list of collaborations if successful, error otherwise + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of collaborations for the group +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getMembership(membershipID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetch a specific membership record, which shows that a given user is a member +of some group. + +API Endpoint: '/group_memberships/:membershipID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + - + + - + - - - - -
NameTypeAttributesDescription
invitability_levelmembershipID -GroupAccessLevel +string @@ -943,8 +4174,6 @@
Properties
 - <optional>
- @@ -954,20 +4183,20 @@
Properties
- 		Specifies who can invite this group to collaborate on foldersThe ID of the membership to fetch
member_viewability_leveloptions -GroupAccessLevel +Object @@ -987,14 +4216,7 @@
Properties
- 		Specifies who can view the members of this group
- - + Additional options for the request. Can be left null in most cases. @@ -1027,7 +4249,7 @@
Properties
- Passed the new group object if it was created successfully, error otherwise + Passed the membership record if successful, error otherwise @@ -1068,7 +4290,7 @@
Properties
Source:
@@ -1097,7 +4319,7 @@
Returns:
- A promise resolving to the new group object + A promise resolving to the membership object
@@ -1126,7 +4348,7 @@
Returns:
-

delete(groupID, callbackopt) → {Promise.<void>}

+

getMembership(membershipID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1134,10 +4356,11 @@

delete - Delete a group + Fetch a specific membership record, which shows that a given user is a member +of some group. -API Endpoint: '/groups/:groupID' -Method: DELETE +API Endpoint: '/group_memberships/:membershipID' +Method: GET @@ -1175,7 +4398,7 @@
Parameters:
- groupID + membershipID @@ -1199,7 +4422,40 @@
Parameters:
- The ID of the group to delete + The ID of the membership to fetch + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Additional options for the request. Can be left null in most cases. @@ -1232,7 +4488,7 @@
Parameters:
- Passed nothing if successful, error otherwise + Passed the membership record if successful, error otherwise @@ -1273,7 +4529,7 @@
Parameters:
Source:
@@ -1302,7 +4558,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the membership object
@@ -1313,7 +4569,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1331,7 +4587,7 @@
Returns:
-

get(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+

getMemberships(groupID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1339,9 +4595,10 @@

get - Used to fetch information about a group + Retreieve a list of memberships for the group, which show which users +belong to the group -API Endpoint: '/groups/:groupID' +API Endpoint: '/groups/:groupID/memberships' Method: GET @@ -1404,7 +4661,7 @@
Parameters:
- The ID of the group to retrieve + The ID of the group to get memberships for @@ -1437,7 +4694,101 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		The number of memberships to retrieve
offset + + +int + + + + + + <optional>
+ + + + + + 		Paging marker, retrieve records starting at this position in the list
+ + @@ -1470,7 +4821,7 @@
Parameters:
- Passed the group object if successful, error otherwise + Passed a list of memberships if successful, error otherwise @@ -1511,7 +4862,7 @@
Parameters:
Source:
@@ -1540,7 +4891,7 @@
Returns:
- A promise resolving to the group object + A promise resolving to the collection of memberships
@@ -1569,7 +4920,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

getMemberships(groupID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1577,10 +4928,10 @@

getAll - Retreieve a list of groups in the caller's enterprise. This ability is -restricted to certain users with permission to view groups. + Retreieve a list of memberships for the group, which show which users +belong to the group -API Endpoint: '/groups' +API Endpoint: '/groups/:groupID/memberships' Method: GET @@ -1619,13 +4970,13 @@
Parameters:
- options + groupID -Object +string @@ -1634,8 +4985,6 @@
Parameters:
- <optional>
- @@ -1645,41 +4994,20 @@
Parameters:
- Optional parameters, can be left null in most cases -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + - + - - - - - - - + - + - - +
NameTypeAttributesDescription
The ID of the group to get memberships for
filter_termoptions -string +Object @@ -1699,9 +5027,30 @@
Properties
- 		Limits the results to only groups whose name starts with the search term
Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + @@ -1805,7 +5154,7 @@
Properties
- + @@ -1846,7 +5195,7 @@
Properties
Source:
@@ -1875,7 +5224,7 @@
Returns:
- A promise resolving to the collection of groups + A promise resolving to the collection of memberships
@@ -1904,7 +5253,7 @@
Returns:
-

getCollaborations(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+

removeMembership(membershipID, callbackopt) → {Promise.<void>}

@@ -1912,108 +5261,22 @@

getC
- Retreieve a list of collaborations for the group, which show which items the -group has access to. - -API Endpoint: '/groups/:groupID/collaborations' -Method: GET -
- - - - - - - - - -

Parameters:
- - -
NameTypeAttributesDescription
Passed a list of groups if successful, error otherwisePassed a list of memberships if successful, error otherwise
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Used to remove a group membership - +API Endpoint: '/group_memberships/:membershipID' +Method: DELETE + - - - - - - - - - - + @@ -2138,7 +5359,7 @@
Properties
- + @@ -2179,7 +5400,7 @@
Properties
Source:
@@ -2208,7 +5429,7 @@
Returns:
- A promise resolving to the collection of collaborations for the group + A promise resolving to nothing
@@ -2219,7 +5440,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2237,7 +5458,7 @@
Returns:
-

getMembership(membershipID, optionsopt, callbackopt) → {Promise.<Object>}

+

removeMembership(membershipID, callbackopt) → {Promise.<void>}

@@ -2245,11 +5466,10 @@

getMembe
- Fetch a specific membership record, which shows that a given user is a member -of some group. + Used to remove a group membership API Endpoint: '/group_memberships/:membershipID' -Method: GET +Method: DELETE
@@ -2311,40 +5531,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + @@ -2377,7 +5564,7 @@
Parameters:
- + @@ -2418,7 +5605,7 @@
Parameters:
Source:
@@ -2447,7 +5634,7 @@
Returns:
- A promise resolving to the membership object + A promise resolving to nothing
@@ -2458,7 +5645,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2476,7 +5663,7 @@
Returns:
-

getMemberships(groupID, optionsopt, callbackopt) → {Promise.<Object>}

+

terminateSession(groupIDs) → {Promise.<Object>}

@@ -2484,11 +5671,11 @@

getMemb
- Retreieve a list of memberships for the group, which show which users -belong to the group + Validates the roles and permissions of the group, +and creates asynchronous jobs to terminate the group's sessions. -API Endpoint: '/groups/:groupID/memberships' -Method: GET +API Endpoint: '/groups/terminate_sessions' +Method: POST
@@ -2512,8 +5699,6 @@

Parameters:
- - @@ -2526,191 +5711,186 @@
Parameters:
- + - - - + + +
NameTypeAttributesDescription
groupID - - -string - - - - - - - - - - The ID of the group to get collaborations for
options - - -Object - - - - <optional>
- - - - 		Optional parameters, can be left null in most cases -
Properties
- +
Parameters:
+ @@ -2039,46 +5302,13 @@
Properties
- - - - - - - - - - - - - - - - - - - + - - - - -
limit - - -int - - - - - - <optional>
- - - - - - 		The number of memberships to retrieve
offsetmembershipID -int +string @@ -2087,8 +5317,6 @@
Properties
 - <optional>
- @@ -2098,14 +5326,7 @@
Properties
- 		Paging marker, retrieve records starting at this position in the list
- - 		The ID of the membership to be removed
Passed a list of collaborations if successful, error otherwisePassed nothing if successful, error otherwise
The ID of the membership to fetch
options - - -Object - - - - - - <optional>
- - - - - - 		Additional options for the request. Can be left null in most cases.The ID of the membership to be removed
Passed the membership record if successful, error otherwisePassed nothing if successful, error otherwise
TypeAttributes
groupIDgroupIDs -string +Array.<string> - - - - - - The ID of the group to get memberships forA list of group IDs
-
options - - -Object - - - - <optional>
- - +
- -
Optional parameters, can be left null in most cases -
Properties
- + - - - - - - + - + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
- - +
+ A promise resolving a message about the request status. +
+ + +
+
+ Type +
+
+Promise.<Object> -
- - - + + + - - - - - + - - + +

terminateSession(groupIDs) → {Promise.<Object>}

+ - + - - - - - - - +
+ Validates the roles and permissions of the group, +and creates asynchronous jobs to terminate the group's sessions. + +API Endpoint: '/groups/terminate_sessions' +Method: POST +
- - - - - - - +
Parameters:
- -
NameTypeAttributesDescription
limit - - -int - - - - <optional>
- - + - - 		The number of memberships to retrieve
offset - - -int - - - - <optional>
- - - - 		Paging marker, retrieve records starting at this position in the list
-
+ + + + + + + + + + + + + + + + - + - - - + @@ -2751,7 +5931,7 @@
Properties
Source:
@@ -2780,7 +5960,7 @@
Returns:
- A promise resolving to the collection of memberships + A promise resolving a message about the request status.
@@ -2809,7 +5989,7 @@
Returns:
-

removeMembership(membershipID, callbackopt) → {Promise.<void>}

+

update(groupID, updates, callbackopt) → {Promise.<Object>}

@@ -2817,10 +5997,10 @@

remov
- Used to remove a group membership + Used to update or modify a group object -API Endpoint: '/group_memberships/:membershipID' -Method: DELETE +API Endpoint: '/groups/:groupID' +Method: PUT
@@ -2858,7 +6038,7 @@

Parameters:
- + + + + + + + + + + + + + + + + + + + + @@ -2915,7 +6126,7 @@
Parameters:
- + @@ -2956,7 +6167,7 @@
Parameters:
Source:
@@ -2985,7 +6196,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the updated group object
@@ -2996,7 +6207,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -3014,7 +6225,7 @@
Returns:
-

terminateSession(groupIDs) → {Promise.<Object>}

+

update(groupID, updates, callbackopt) → {Promise.<Object>}

@@ -3022,11 +6233,10 @@

termi
- Validates the roles and permissions of the group, -and creates asynchronous jobs to terminate the group's sessions. + Used to update or modify a group object -API Endpoint: '/groups/terminate_sessions' -Method: POST +API Endpoint: '/groups/:groupID' +Method: PUT
@@ -3050,6 +6260,8 @@

Parameters:
+ + @@ -3062,23 +6274,95 @@
Parameters:
- + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3119,7 +6403,7 @@
Parameters:
Source:
@@ -3148,7 +6432,7 @@
Returns:
- A promise resolving a message about the request status. + A promise resolving to the updated group object
@@ -3177,7 +6461,7 @@
Returns:
-

update(groupID, updates, callbackopt) → {Promise.<Object>}

+

updateMembership(membershipID, options, callbackopt) → {Promise.<Object>}

@@ -3187,7 +6471,7 @@

update Used to update or modify a group object -API Endpoint: '/groups/:groupID' +API Endpoint: '/group_memberships/:membershipID' Method: PUT @@ -3226,7 +6510,7 @@
Parameters:

- + + - + + @@ -3314,7 +6598,7 @@
Parameters:
- + @@ -3355,7 +6639,7 @@
Parameters:
Source:
@@ -3384,7 +6668,7 @@
Returns:
- A promise resolving to the updated group object + A promise resolving to the updated membership object
@@ -3591,7 +6875,7 @@
Parameters:
Source:
@@ -3659,13 +6943,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/LegalHoldPolicies.html b/docs/jsdoc/LegalHoldPolicies.html index 47c1cf7b..ec0510c4 100644 --- a/docs/jsdoc/LegalHoldPolicies.html +++ b/docs/jsdoc/LegalHoldPolicies.html @@ -264,7 +264,7 @@
Type:
Source:
@@ -501,7 +501,7 @@
Parameters:
Source:
@@ -559,7 +559,7 @@
Returns:
-

create(name, optionsopt, callbackopt) → {Promise.<Object>}

+

assign(policyID, assignType, assignID, callbackopt) → {Promise.<Object>}

@@ -567,9 +567,9 @@

create - Used to create a single legal hold policy for an enterprise + Assign a lehal hold policy to an object -API Endpoint: '/legal_hold_policies' +API Endpoint: '/legal_hold_policy_assignments Method: POST @@ -608,7 +608,3042 @@
Parameters:

- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
callbackgroupIDs -function +Array.<string> - - <optional>
- - - - - - 		Passed a list of memberships if successful, error otherwiseA list of group IDs
membershipIDgroupID @@ -2882,7 +6062,38 @@
Parameters:
- 		The ID of the membership to be removedThe ID of the group to update
updates + + +Object + + + + + + + + + + Group fields to update
Passed nothing if successful, error otherwisePassed the updated group object if successful, error otherwise
TypeAttributes
groupIDsgroupID -Array.<string> +string + + + + + + A list of group IDsThe ID of the group to update
updates + + +Object + + + + + + + + + + Group fields to update
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated group object if successful, error otherwise
groupIDmembershipID @@ -3250,14 +6534,14 @@
Parameters:
- 		The ID of the group to updateThe ID of the membership to update
updatesoptions @@ -3281,7 +6565,7 @@
Parameters:
- 		Group fields to updateMembership record fields to update
Passed the updated group object if successful, error otherwisePassed the updated membership object if successful, error otherwise
namepolicyID + + +string + + + + + + + + + + The ID of the policy to assign
assignType + + +LegalHoldPolicyAssignmentType + + + + + + + + + + The type of object the policy will be assigned to
assignID + + +string + + + + + + + + + + The Box ID of the object to assign the legal hold policy to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new assignment object if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(name, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to create a single legal hold policy for an enterprise + +API Endpoint: '/legal_hold_policies' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + + + + + The name of the legal hold policy to be created
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the legal hold policy
filter_started_at + + +string + + + + + + <optional>
+ + + + + + 		Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
filter_ended_at + + +string + + + + + + <optional>
+ + + + + + 		Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
is_ongoing + + +boolean + + + + + + <optional>
+ + + + + + 		After initialization, Assignments under this Policy will continue applying to files based on events, indefinitely
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created policy +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(name, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to create a single legal hold policy for an enterprise + +API Endpoint: '/legal_hold_policies' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + + + + + The name of the legal hold policy to be created
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the legal hold policy
filter_started_at + + +string + + + + + + <optional>
+ + + + + + 		Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
filter_ended_at + + +string + + + + + + <optional>
+ + + + + + 		Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
is_ongoing + + +boolean + + + + + + <optional>
+ + + + + + 		After initialization, Assignments under this Policy will continue applying to files based on events, indefinitely
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created policy +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(policyID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Sends request to delete an existing legal hold policy. Note that this is an +asynchronous process - the policy will not be fully deleted yet when the +response comes back. + +API Endpoint: '/legal_hold_policies/:policyID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The legal hold policy to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

delete(policyID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Sends request to delete an existing legal hold policy. Note that this is an +asynchronous process - the policy will not be fully deleted yet when the +response comes back. + +API Endpoint: '/legal_hold_policies/:policyID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The legal hold policy to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Sends request to delete an existing legal hold policy. Note that this is an +asynchronous process - the policy will not be fully deleted yet when the +response comes back. + +API Endpoint: '/legal_hold_policy_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The legal hold policy assignment to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Sends request to delete an existing legal hold policy. Note that this is an +asynchronous process - the policy will not be fully deleted yet when the +response comes back. + +API Endpoint: '/legal_hold_policy_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The legal hold policy assignment to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches details about a specific legal hold policy + +API Endpoint: '/legal_hold_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the legal hold policy being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches details about a specific legal hold policy + +API Endpoint: '/legal_hold_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the legal hold policy being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a list of legal hold policies for the enterprise + +API Endpoint: '/legal_hold_policies' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policy_name + + +string + + + + + + <optional>
+ + + + + + 		A full or partial name to filter the legal hold policies by
limit + + +int + + + + + + <optional>
+ + + + + + 		Limit result size to this number
marker + + +string + + + + + + <optional>
+ + + + + + 		Paging marker, leave blank to start at the first page
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a list of legal hold policies for the enterprise + +API Endpoint: '/legal_hold_policies' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policy_name + + +string + + + + + + <optional>
+ + + + + + 		A full or partial name to filter the legal hold policies by
limit + + +int + + + + + + <optional>
+ + + + + + 		Limit result size to this number
marker + + +string + + + + + + <optional>
+ + + + + + 		Paging marker, leave blank to start at the first page
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAllFileVersionLegalHolds(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of legal hold records for held file versions in an enterprise. + +API Endpoint: '/file_version_legal_holds' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -665,41 +3700,20 @@
Parameters:
- - - - - - - - + + + + + + + + + + - - + + + +

getAllFileVersionLegalHolds(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of legal hold records for held file versions in an enterprise. + +API Endpoint: '/file_version_legal_holds' +Method: GET +
+ + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
policyID @@ -632,7 +3667,7 @@
Parameters:
- 		The name of the legal hold policy to be createdID of Legal Hold Policy to get File Version Legal Holds for
Additional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + + + +
NameTypeAttributesDescription
Additional options for the request. Can be left null in most cases.
descriptioncallback -string +function @@ -719,47 +3733,155 @@
Properties
- 		Description of the legal hold policyPass the file version legal holds records if successful, error otherwise
-
filter_started_at - - -string - - - - <optional>
- - +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of all file version legal holds +
+ + + +
+
+ Type +
+
+ +Promise.<Object> - -
Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
+ + + + + + + + + + + + + + + + + + + - + + - + - - - - -
NameTypeAttributesDescription
filter_ended_atpolicyID @@ -774,8 +3896,6 @@
Properties
 - <optional>
- @@ -785,20 +3905,20 @@
Properties
- 		Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date rangeID of Legal Hold Policy to get File Version Legal Holds for
is_ongoingoptions -boolean +Object @@ -818,14 +3938,7 @@
Properties
- 		After initialization, Assignments under this Policy will continue applying to files based on events, indefinitely
- - + Additional options for the request. Can be left null in most cases. @@ -858,7 +3971,7 @@
Properties
- Passed the new policy information if it was acquired successfully, error otherwise + Pass the file version legal holds records if successful, error otherwise @@ -899,7 +4012,7 @@
Properties
Source:
@@ -928,7 +4041,7 @@
Returns:
- A promise resolving to the created policy + A promise resolving to the collection of all file version legal holds
@@ -957,7 +4070,7 @@
Returns:
-

delete(policyID, callbackopt) → {Promise.<void>}

+

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -965,12 +4078,10 @@

delete - Sends request to delete an existing legal hold policy. Note that this is an -asynchronous process - the policy will not be fully deleted yet when the -response comes back. + Fetch a specific policy assignment -API Endpoint: '/legal_hold_policies/:policyID' -Method: DELETE +API Endpoint: '/legal_hold_policy_assignments/:assignmentID' +Method: GET @@ -1008,7 +4119,7 @@
Parameters:
- policyID + assignmentID @@ -1032,7 +4143,40 @@
Parameters:
- The legal hold policy to delete + The Box ID of the policy assignment object to fetch + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Additional options for the request. Can be left null in most cases. @@ -1065,7 +4209,7 @@
Parameters:
- Passed nothing if successful, error otherwise + Passed the assignment object if it was acquired successfully, error otherwise @@ -1106,7 +4250,7 @@
Parameters:
Source:
@@ -1135,7 +4279,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the assignment object
@@ -1146,7 +4290,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1164,7 +4308,7 @@
Returns:
-

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1172,12 +4316,10 @@

delet
- Sends request to delete an existing legal hold policy. Note that this is an -asynchronous process - the policy will not be fully deleted yet when the -response comes back. + Fetch a specific policy assignment API Endpoint: '/legal_hold_policy_assignments/:assignmentID' -Method: DELETE +Method: GET
@@ -1239,7 +4381,40 @@

Parameters:
- The legal hold policy assignment to delete + The Box ID of the policy assignment object to fetch + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Additional options for the request. Can be left null in most cases. @@ -1272,7 +4447,7 @@
Parameters:
- Passed nothing if successful, error otherwise + Passed the assignment object if it was acquired successfully, error otherwise @@ -1313,7 +4488,7 @@
Parameters:
Source:
@@ -1342,7 +4517,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the assignment object
@@ -1353,7 +4528,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1371,7 +4546,7 @@
Returns:
-

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1379,9 +4554,9 @@

get - Fetches details about a specific legal hold policy + Fetch a list of assignments for a given legal hold policy -API Endpoint: '/legal_hold_policies/:policyID' +API Endpoint: '/legal_hold_policies/:policyID/assignments' Method: GET @@ -1444,7 +4619,7 @@
Parameters:
- The Box ID of the legal hold policy being requested + The Box ID of the legal hold policy to get assignments for @@ -1477,7 +4652,101 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assign_to_type + + +LegalHoldPolicyAssignmentType + + + + + + <optional>
+ + + + + + 		Filter assignments of this type only
assign_to_id + + +string + + + + + + <optional>
+ + + + + + 		Filter assignments to this ID only. Note that this will only show assignments applied directly to this entity.
+ + @@ -1510,7 +4779,7 @@
Parameters:
- Passed the policy information if it was acquired successfully, error otherwise + Passed the assignment objects if they were acquired successfully, error otherwise @@ -1551,7 +4820,7 @@
Parameters:
Source:
@@ -1580,7 +4849,7 @@
Returns:
- A promise resolving to the policy object + A promise resolving to the collection of policy assignments
@@ -1609,7 +4878,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1617,9 +4886,9 @@

getAll - Fetches a list of legal hold policies for the enterprise + Fetch a list of assignments for a given legal hold policy -API Endpoint: '/legal_hold_policies' +API Endpoint: '/legal_hold_policies/:policyID/assignments' Method: GET @@ -1658,13 +4927,13 @@
Parameters:
- options + policyID -Object +string @@ -1673,8 +4942,6 @@
Parameters:
- <optional>
- @@ -1684,41 +4951,20 @@
Parameters:
- Additional options for the request. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + - + + - + +
NameTypeAttributesDescription
The Box ID of the legal hold policy to get assignments for
policy_nameoptions -string +Object @@ -1738,20 +4984,41 @@
Properties
- 		A full or partial name to filter the legal hold policies by
Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + - + + @@ -1844,7 +5111,7 @@
Properties
- + @@ -1885,7 +5152,7 @@
Properties
Source:
@@ -1914,7 +5181,7 @@
Returns:
- A promise resolving to the collection of policies + A promise resolving to the collection of policy assignments
@@ -1943,7 +5210,7 @@
Returns:
-

getAllFileVersionLegalHolds(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+

getFileVersionLegalHold(legalHoldID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1951,9 +5218,9 @@

<
- Get a list of legal hold records for held file versions in an enterprise. + Get the specific legal hold record for a held file version. -API Endpoint: '/file_version_legal_holds' +API Endpoint: '/file_version_legal_holds/:legalHoldID' Method: GET
@@ -1992,7 +5259,7 @@
Parameters:

- + + @@ -2082,7 +5349,7 @@
Parameters:
- + @@ -2123,7 +5390,7 @@
Parameters:
Source:
@@ -2152,7 +5419,7 @@
Returns:
- A promise resolving to the collection of all file version legal holds + A promise resolving to the legal hold record
@@ -2181,7 +5448,7 @@
Returns:
-

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+

getFileVersionLegalHold(legalHoldID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2189,9 +5456,9 @@

getAssig
- Fetch a specific policy assignment + Get the specific legal hold record for a held file version. -API Endpoint: '/legal_hold_policy_assignments/:assignmentID' +API Endpoint: '/file_version_legal_holds/:legalHoldID' Method: GET
@@ -2230,7 +5497,7 @@

Parameters:
- + + @@ -2320,7 +5587,7 @@
Parameters:
- + @@ -2361,7 +5628,7 @@
Parameters:
Source:
@@ -2390,7 +5657,7 @@
Returns:
- A promise resolving to the assignment object + A promise resolving to the legal hold record
@@ -2419,7 +5686,7 @@
Returns:
-

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+

update(policyID, updates, callbackopt) → {Promise.<Object>}

@@ -2427,10 +5694,10 @@

getAssi
- Fetch a list of assignments for a given legal hold policy + Update or modify a legal hold policy. -API Endpoint: '/legal_hold_policies/:policyID/assignments' -Method: GET +API Endpoint: '/legal_hold_policies/:policyID' +Method: PUT
@@ -2492,14 +5759,14 @@

Parameters:
- + - + - + + - + - - - - -
NameTypeAttributesDescription
limitassign_to_type -int +LegalHoldPolicyAssignmentType @@ -1771,14 +5038,14 @@
Properties
- 		Limit result size to this numberFilter assignments of this type only
markerassign_to_id @@ -1804,7 +5071,7 @@
Properties
- 		Paging marker, leave blank to start at the first pageFilter assignments to this ID only. Note that this will only show assignments applied directly to this entity.
Passed the policy objects if they were acquired successfully, error otherwisePassed the assignment objects if they were acquired successfully, error otherwise
policyIDlegalHoldID @@ -2016,7 +5283,7 @@
Parameters:
- 		ID of Legal Hold Policy to get File Version Legal Holds forThe ID for the file legal hold record to retrieve
Pass the file version legal holds records if successful, error otherwisePass the file version legal hold record if successful, error otherwise
assignmentIDlegalHoldID @@ -2254,7 +5521,7 @@
Parameters:
- 		The Box ID of the policy assignment object to fetchThe ID for the file legal hold record to retrieve
Passed the assignment object if it was acquired successfully, error otherwisePass the file version legal hold record if successful, error otherwise
The Box ID of the legal hold policy to get assignments forThe Box ID of the legal hold policy to update
optionsupdates @@ -2514,8 +5781,6 @@
Parameters:
 - <optional>
- @@ -2525,7 +5790,7 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases. + The information to be updated
Properties
@@ -2553,13 +5818,13 @@
Properties
assign_to_typepolicy_name -LegalHoldPolicyAssignmentType +string @@ -2579,14 +5844,14 @@
Properties
- 		Filter assignments of this type onlyName of Legal Hold Policy
assign_to_iddescription @@ -2612,27 +5877,20 @@
Properties
- 		Filter assignments to this ID only. Note that this will only show assignments applied directly to this entity.
- - 		Description of Legal Hold Policy
callbackrelease_notes -function +string @@ -2652,212 +5910,14 @@
Properties
- 		Passed the assignment objects if they were acquired successfully, error otherwiseNotes around why the policy was released
- - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
- A promise resolving to the collection of policy assignments -
- - - -
-
- Type -
-
- -Promise.<Object> - - -
-
- - - - - - - - - - - - - -

getFileVersionLegalHold(legalHoldID, optionsopt, callbackopt) → {Promise.<Object>}

- - - - - - -
- Get the specific legal hold record for a held file version. - -API Endpoint: '/file_version_legal_holds/:legalHoldID' -Method: GET -
- - - - - - - - - -
Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2890,7 +5950,7 @@
Parameters:
- + @@ -2931,7 +5991,7 @@
Parameters:
Source:
@@ -2960,7 +6020,7 @@
Returns:
- A promise resolving to the legal hold record + A promise resolving to the updated policy
@@ -3294,7 +6354,7 @@
Properties
Source:
@@ -3362,13 +6422,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Metadata.html b/docs/jsdoc/Metadata.html index 1172eab9..bed43488 100644 --- a/docs/jsdoc/Metadata.html +++ b/docs/jsdoc/Metadata.html @@ -264,7 +264,7 @@
Type:
Source:
@@ -503,7 +503,7 @@
Parameters:
Source:
@@ -561,7 +561,7 @@
Returns:
-

createTemplate(templateName, fields, optionsopt, callbackopt) → {Promise.<Object>}

+

createCascadePolicy(scope, templateKey, folderID, callbackopt) → {Promise.<Object>}

@@ -569,9 +569,11 @@

createT
- Create a new metadata template + Add a new cascade policy to a folder/metadata template, causing the +metadata template to be applied to all items and subfolders inside the +folder. -API Endpoint: '/metadata_templates/schema', +API Endpoint: '/metadata_cascade_policies' Method: POST
@@ -610,7 +612,7 @@

Parameters:
- + - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - + @@ -911,7 +731,7 @@
Properties
- + @@ -952,7 +772,7 @@
Properties
Source:
@@ -981,7 +801,7 @@
Returns:
- A promise resolving to the created template + Promise resolving to the cascade policy
@@ -1010,7 +830,7 @@
Returns:
-

deleteCascadePolicy(policyID, callbackopt) → {Promise.<void>}

+

createTemplate(templateName, fields, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1018,10 +838,10 @@

de
- Delete the metadata cascade policy with the given ID + Create a new metadata template -API Endpoint: '/metadata_cascade_policies/:policyID' -Method: DELETE +API Endpoint: '/metadata_templates/schema', +Method: POST
@@ -1059,7 +879,7 @@

Parameters:
- + + - + + - -
NameTypeAttributesDescription
legalHoldID - - -string - - - - - - - - - - The ID for the file legal hold record to retrieve
options - - -Object - - - - - <optional>
- - - - - - 		Additional options for the request. Can be left null in most cases.
Pass the file version legal hold record if successful, error otherwisePassed the updated policy information if it was acquired successfully, error otherwise
templateNamescope @@ -634,98 +636,11 @@
Parameters:
- 		The name of the metadata template
fields - - -Array.<MetadataTemplateField> - - - - - - - - - - A list of fields for the templateMetadata template scope for the template to cascade
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters, can be left null in many cases -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - @@ -743,45 +658,6 @@
Properties
- - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDefaultDescription
templateKey - <optional>
- - - - - - 		- - The programmatic key for the template
hidden - - -boolean - - - - - - <optional>
- @@ -790,19 +666,15 @@
Properties
- 		- - Whether the template should be hidden in the UIMetadata template key for the template to cascade
scopefolderID @@ -817,47 +689,6 @@
Properties
 - <optional>
- - - - - - 		- - enterprise - - The scope for the template, only 'enterprise' is supported for now
copyInstanceOnItemCopy - - -boolean - - - - - - <optional>
- @@ -866,19 +697,8 @@
Properties
- 		- - Whether to include the metadata when a file or folder is copied
- 		The ID of the folder to cascade over
Passed the template if successful, error otherwisePassed the cascade policy if successful
policyIDtemplateName @@ -1083,20 +903,20 @@
Parameters:
- 		The ID of the policy to deleteThe name of the metadata template
callbackfields -function +Array.<MetadataTemplateField> @@ -1105,8 +925,6 @@
Parameters:
 - <optional>
- @@ -1116,150 +934,139 @@
Parameters:
- 		Passed nothing if successfulA list of fields for the template
- + + + options + + + + +Object + + -
+ + + + <optional>
+ - + - + + + - + - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
+ Optional parameters, can be left null in many cases +
Properties
+ + + + -
- Promise resolving to nothing -
- - - -
-
- Type -
-
+
-Promise.<void> - - - - - - - - + + + + - + + - + + + - -

deleteTemplate(scope, template, callbackopt) → {Promise.<void>}

+ - + + + + + -API Endpoint: '/metadata_templates/:scope/:template/schema' -Method: DELETE - + + + + + + + + + + + + + + -
NameTypeAttributesDefaultDescription
templateKey + + +string -
- Delete a metadata template from an enterprise. + +
+ + <optional>
+ + + + 		+ + The programmatic key for the template
hidden + + +boolean -
Parameters:
- + +
- - - - - + + + - - - + + + - + + + - - - + + - @@ -1279,6 +1086,8 @@
Parameters:
+ - + - + + - + + + + + +
Name + + <optional>
+ - 		TypeAttributes + + Description
Whether the template should be hidden in the UI
+ <optional>
+ @@ -1287,21 +1096,27 @@
Parameters:
+ 		+ + enterprise + + The scope of the template to deleteThe scope for the template, only 'enterprise' is supported for now
templatecopyInstanceOnItemCopy -string +boolean @@ -1310,6 +1125,8 @@
Parameters:
 + <optional>
+ @@ -1318,8 +1135,19 @@
Parameters:
+ 		+ + The template to deleteWhether to include the metadata when a file or folder is copied
+ + @@ -1352,7 +1180,7 @@
Parameters:
- Passed empty response body if successful, err otherwise + Passed the template if successful, error otherwise @@ -1393,20 +1221,13 @@
Parameters:
Source:
-
See:
-
- -
-

@@ -1429,7 +1250,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the created template
@@ -1440,7 +1261,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1458,7 +1279,7 @@
Returns:
-

forceApplyCascadePolicy(policyID, resolutionMethod, callbackopt) → {Promise.<void>}

+

createTemplate(templateName, fields, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1466,10 +1287,9 @@

- If a policy already exists on a folder, this will apply that policy to all existing files and -sub-folders within the target folder. + Create a new metadata template -API Endpoint: '/metadata_cascade_policies/:policyID/apply' +API Endpoint: '/metadata_templates/schema', Method: POST @@ -1508,7 +1328,7 @@
Parameters:
- policyID + templateName @@ -1532,20 +1352,20 @@
Parameters:
- The ID of the policy to delete + The name of the metadata template - resolutionMethod + fields -string +Array.<MetadataTemplateField> @@ -1563,20 +1383,20 @@
Parameters:
- How to resolve conflicts, either "none" or "overwrite" + A list of fields for the template - callback + options -function +Object @@ -1596,161 +1416,80 @@
Parameters:
- Passed nothing if successful - - - - - - - + Optional parameters, can be left null in many cases +
Properties
+ + + + + + + + + + + -
+ +
+ - + + + + - + + + + - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - - - - - - - - - - - - - - - - - -
Returns:
- - -
- Promise resolving to nothing -
- - - -
-
- Type -
-
- -Promise.<void> - - -
-
- - - - - - - - + -
NameTypeAttributesDefaultDescription
templateKey - - - - -

getCascadePolicies(folderID, optionsopt, callbackopt) → {Promise.<Object>}

- - - - - - -
- Get the cascade policies associated with a given folder. - -API Endpoint: '/metadata_cascade_policies' -Method: GET -
- - - - - - - + +string -
Parameters:
- + +
- - - - - + + + - - - + + + - + + + - - - + + - - + + - + - + + -
Name + + <optional>
+ - 		TypeAttributes + + Description
The programmatic key for the template
folderIDhidden -string +boolean @@ -1759,6 +1498,8 @@
Parameters:
 + <optional>
+ @@ -1767,21 +1508,25 @@
Parameters:
+ 		+ + The ID of the folder to get cascade policies forWhether the template should be hidden in the UI
optionsscope -Object +string @@ -1800,42 +1545,27 @@
Parameters:
- - 		Optional parameters -
Properties
+ 		+ enterprise + +
- - - - - - - - - - - - - - - - - + + - - + + - + @@ -1895,7 +1629,7 @@
Properties
- + @@ -1936,7 +1670,7 @@
Properties
Source:
@@ -1965,7 +1699,7 @@
Returns:
- Promise resolving to the collection of policies + A promise resolving to the created template
@@ -1994,7 +1728,7 @@
Returns:
-

getCascadePolicy(policyID, callbackopt) → {Promise.<Object>}

+

deleteCascadePolicy(policyID, callbackopt) → {Promise.<void>}

@@ -2002,10 +1736,10 @@

getCa
- Get a metadata cascade policy object by ID + Delete the metadata cascade policy with the given ID API Endpoint: '/metadata_cascade_policies/:policyID' -Method: GET +Method: DELETE
@@ -2067,7 +1801,7 @@

Parameters:
- + @@ -2100,7 +1834,7 @@
Parameters:
- + @@ -2141,7 +1875,7 @@
Parameters:
Source:
@@ -2170,7 +1904,7 @@
Returns:
- Promise resolving to the cascade policy + Promise resolving to nothing
@@ -2181,7 +1915,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2199,7 +1933,7 @@
Returns:
-

getTemplateByID(templateID, callbackopt) → {Promise.<Object>}

+

deleteCascadePolicy(policyID, callbackopt) → {Promise.<void>}

@@ -2207,10 +1941,10 @@

getTem
- Retrieve the schema definition for a metadata template by ID + Delete the metadata cascade policy with the given ID -API Endpoint: '/metadata_templates/:id' -Method: GET +API Endpoint: '/metadata_cascade_policies/:policyID' +Method: DELETE
@@ -2248,7 +1982,7 @@

Parameters:
- + + @@ -2305,7 +2039,7 @@
Parameters:
- + @@ -2346,7 +2080,7 @@
Parameters:
Source:
@@ -2375,7 +2109,7 @@
Returns:
- A promise resolving to the template schema + Promise resolving to nothing
@@ -2386,7 +2120,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2404,7 +2138,7 @@
Returns:
-

getTemplates(scope, callbackopt) → {Promise.<Object>}

+

deleteTemplate(scope, template, callbackopt) → {Promise.<void>}

@@ -2412,10 +2146,10 @@

getTempla
- Get all templates in a given scope + Delete a metadata template from an enterprise. -API Endpoint: '/metadata_templates/:scope' -Method: GET +API Endpoint: '/metadata_templates/:scope/:template/schema' +Method: DELETE
@@ -2477,20 +2211,20 @@

Parameters:
- + - + + - -
NameTypeAttributesDescription
The scope for the template, only 'enterprise' is supported for now
owner_enterprise_idcopyInstanceOnItemCopy -string +boolean @@ -1854,8 +1584,12 @@
Properties
+ 		+ + ID of the enterprise to get policies forWhether to include the metadata when a file or folder is copied
Passed the collection of policies if successfulPassed the template if successful, error otherwise
The ID of the policy to retrieveThe ID of the policy to delete
Passed the cascade policy if successfulPassed nothing if successful
templateIDpolicyID @@ -2272,7 +2006,7 @@
Parameters:
- 		The ID of the template to retrieveThe ID of the policy to delete
Called with the template schema if successfulPassed nothing if successful
The scope to retrieve templates forThe scope of the template to delete
callbacktemplate -function +string @@ -2499,8 +2233,6 @@
Parameters:
 - <optional>
- @@ -2510,12 +2242,45 @@
Parameters:
- 		Called with an array of templates when successfulThe template to delete
+ + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed empty response body if successful, err otherwise + + + + + @@ -2551,13 +2316,20 @@
Parameters:
Source:
+
See:
+
+ +
+

@@ -2580,7 +2352,7 @@
Returns:
- A promise resolving to the collection of templates + A promise resolving to nothing
@@ -2591,7 +2363,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2609,7 +2381,7 @@
Returns:
-

getTemplateSchema(scope, template, callbackopt) → {Promise.<Object>}

+

deleteTemplate(scope, template, callbackopt) → {Promise.<void>}

@@ -2617,10 +2389,10 @@

getT
- Retrieve the schema definition for a metadata template + Delete a metadata template from an enterprise. -API Endpoint: '/metadata_templates/:scope/:template' -Method: GET +API Endpoint: '/metadata_templates/:scope/:template/schema' +Method: DELETE
@@ -2682,20 +2454,3650 @@

Parameters:
- The scope of the template, e.g. "enterprise" + The scope of the template to delete + + + + + + + template + + + + + +string + + + + + + + + + + + + + + + + + + The template to delete + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed empty response body if successful, err otherwise + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + +
See:
+
+ +
+ + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

forceApplyCascadePolicy(policyID, resolutionMethod, callbackopt) → {Promise.<void>}

+ + + + + + +
+ If a policy already exists on a folder, this will apply that policy to all existing files and +sub-folders within the target folder. + +API Endpoint: '/metadata_cascade_policies/:policyID/apply' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The ID of the policy to delete
resolutionMethod + + +string + + + + + + + + + + How to resolve conflicts, either "none" or "overwrite"
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

forceApplyCascadePolicy(policyID, resolutionMethod, callbackopt) → {Promise.<void>}

+ + + + + + +
+ If a policy already exists on a folder, this will apply that policy to all existing files and +sub-folders within the target folder. + +API Endpoint: '/metadata_cascade_policies/:policyID/apply' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The ID of the policy to delete
resolutionMethod + + +string + + + + + + + + + + How to resolve conflicts, either "none" or "overwrite"
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getCascadePolicies(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get the cascade policies associated with a given folder. + +API Endpoint: '/metadata_cascade_policies' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to get cascade policies for
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
owner_enterprise_id + + +string + + + + + + <optional>
+ + + + + + 		ID of the enterprise to get policies for
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the collection of policies if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCascadePolicies(folderID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get the cascade policies associated with a given folder. + +API Endpoint: '/metadata_cascade_policies' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
folderID + + +string + + + + + + + + + + The ID of the folder to get cascade policies for
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
owner_enterprise_id + + +string + + + + + + <optional>
+ + + + + + 		ID of the enterprise to get policies for
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the collection of policies if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCascadePolicy(policyID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a metadata cascade policy object by ID + +API Endpoint: '/metadata_cascade_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The ID of the policy to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the cascade policy if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the cascade policy +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getCascadePolicy(policyID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a metadata cascade policy object by ID + +API Endpoint: '/metadata_cascade_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The ID of the policy to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the cascade policy if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the cascade policy +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplateByID(templateID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve the schema definition for a metadata template by ID + +API Endpoint: '/metadata_templates/:id' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
templateID + + +string + + + + + + + + + + The ID of the template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with the template schema if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the template schema +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplateByID(templateID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve the schema definition for a metadata template by ID + +API Endpoint: '/metadata_templates/:id' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
templateID + + +string + + + + + + + + + + The ID of the template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with the template schema if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the template schema +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplates(scope, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all templates in a given scope + +API Endpoint: '/metadata_templates/:scope' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
scope + + +string + + + + + + + + + + The scope to retrieve templates for
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with an array of templates when successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of templates +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplates(scope, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all templates in a given scope + +API Endpoint: '/metadata_templates/:scope' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
scope + + +string + + + + + + + + + + The scope to retrieve templates for
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with an array of templates when successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of templates +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplateSchema(scope, template, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve the schema definition for a metadata template + +API Endpoint: '/metadata_templates/:scope/:template' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
scope + + +string + + + + + + + + + + The scope of the template, e.g. "enterprise"
template + + +string + + + + + + + + + + The template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with the template schema if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the template schema +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getTemplateSchema(scope, template, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve the schema definition for a metadata template + +API Endpoint: '/metadata_templates/:scope/:template' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
scope + + +string + + + + + + + + + + The scope of the template, e.g. "enterprise"
template + + +string + + + + + + + + + + The template to retrieve
callback + + +function + + + + + + <optional>
+ + + + + + 		Called with the template schema if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the template schema +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

query(from, ancestorFolderId, optionsopt, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Query Box items by their metadata. + +API Endpoint: '/metadata_queries/execute_read' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
from + + +string + + + + + + + + + + The template used in the query. Must be in the form scope.templateKey
ancestorFolderId + + +string + + + + + + + + + + The folder_id to which to restrain the query
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
query + + +string + + + + + + <optional>
+ + + + + + 		The logical expression of the query
query_parameters + + +Object + + + + + + <optional>
+ + + + + + 		Required if query present. The arguments for the query
order_by + + +Object + + + + + + <optional>
+ + + + + + 		The field_key(s) to order on and the corresponding direction(s)
fields + + +Array + + + + + + <optional>
+ + + + + + 		An array of fields to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a collection of items and their associated metadata
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to a collection of items and their associated metadata +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

query(from, ancestorFolderId, optionsopt, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Query Box items by their metadata. + +API Endpoint: '/metadata_queries/execute_read' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2746,7 +6157,7 @@
Parameters:
- + @@ -2787,7 +6198,7 @@
Parameters:
Source:
@@ -2816,7 +6227,7 @@
Returns:
- A promise resolving to the template schema + Promise resolving to a collection of items and their associated metadata
@@ -2827,7 +6238,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -2845,7 +6256,7 @@
Returns:
-

query(from, ancestorFolderId, optionsopt, callbackopt) → {Promise.<void>}

+

updateTemplate(scope, template, operations, callbackopt) → {Promise.<Object>}

@@ -2853,12 +6264,12 @@

query - Query Box items by their metadata. -We no longer require the index_name/use_index for queries that leverage indexes, -internal analysis engine determines which existing index will satisfy the query. + Update a metadata template via one or more non-breaking operations. Each +operation is a an object descrbing one change to the template or its +fields. -API Endpoint: '/metadata_queries/execute_read' -Method: POST +API Endpoint: '/metadata_templates/:scope/:template/schema' +Method: PUT @@ -2896,123 +6307,7 @@
Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -3210,7 +6426,7 @@
Properties
- + @@ -3251,13 +6467,20 @@
Properties
Source:
+
See:
+
+ +
+ @@ -3280,7 +6503,7 @@
Returns:
- Promise resolving to a collection of items and their associated metadata + A promise resolving to the updated template
@@ -3291,7 +6514,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -3520,7 +6743,7 @@
Parameters:
Source:
@@ -3595,13 +6818,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator.html b/docs/jsdoc/PagingIterator.html index 2cbbb96a..563f6188 100644 --- a/docs/jsdoc/PagingIterator.html +++ b/docs/jsdoc/PagingIterator.html @@ -250,6 +250,13 @@
Returns:
+

Classes

+ +
+
PagingIterator
+
+
+ @@ -369,7 +376,166 @@
Parameters:
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ Whether the response is iterable +
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + + + + +

(static) isIterable(response) → {boolean}

+ + + + + + +
+ Determine if a response is iterable +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
from + + +string + + + + + + + + + + The template used in the query. Must be in the form scope.templateKey
ancestorFolderId + + +string + + + + + + + + + + The folder_id to which to restrain the query
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + +
NameTypeAttributesDescription
query + + +string + + + + + + <optional>
+ + + + + + 		The logical expression of the query
query_parameters + + +Object + + + + + + <optional>
+ + + + + + 		Required if query present. The arguments for the query
order_by + + +Object + + + + + + <optional>
+ + + + + + 		The field_key(s) to order on and the corresponding direction(s)
templatefields -string +Array @@ -2704,6 +6106,8 @@
Parameters:
 + <optional>
+ @@ -2713,7 +6117,14 @@
Parameters:
- 		The template to retrieveAn array of fields to return
+ +
Called with the template schema if successfulPassed a collection of items and their associated metadata
from - - -string - - - - - - - - - - The template used in the query. Must be in the form scope.templateKey
ancestorFolderId - - -string - - - - - - - - - - The folder_id to which to restrain the query
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - + - + - - - - - - - - - - - - - - - - - - + - + - - - - -
NameTypeAttributesDescription
queryscope @@ -3027,41 +6322,6 @@
Properties
 - <optional>
- - - - - - 		The logical expression of the query
query_parameters - - -Object - - - - - - <optional>
- @@ -3071,14 +6331,14 @@
Properties
- 		Required if query present. The arguments for the queryThe scope of the template to modify
index_nametemplate @@ -3093,41 +6353,6 @@
Properties
 - <optional>
- - - - - - 		DEPRECATED: This parameter is ignored. The name of the index to use
order_by - - -Object - - - - - - <optional>
- @@ -3137,20 +6362,20 @@
Properties
- 		The field_key(s) to order on and the corresponding direction(s)The template to modify
fieldsoperations -Array +Array.<Object> @@ -3159,8 +6384,6 @@
Properties
 - <optional>
- @@ -3170,14 +6393,7 @@
Properties
- 		An array of fields to return
- - 		The operations to perform
Passed a collection of items and their associated metadataPassed the updated template if successful, error otherwise
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
response + + +Object + + + + The API response
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -479,7 +645,117 @@

_getDataSource:
+ + + + + + + +

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to iterator state +
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + + + + +

_getData() → {Promise}

+ + + + + + +
+ Fetch the next page of results +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -589,7 +865,120 @@

getNextM
Source:
+ + + + + + + +

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ String that is the next marker or int that is the next offset +
+ + + +
+
+ Type +
+
+ +string +| + +int + + +
+
+ + + + + + + + + + + + + +

getNextMarker() → {string|int}

+ + + + + + +
+ Fetch the next marker +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -702,7 +1091,117 @@

nextSource:
+ + + + + + + +

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to iterator state +
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + + + + +

next() → {Promise}

+ + + + + + +
+ Fetch the next page of the collection +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -770,13 +1269,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/PagingIterator_PagingIterator.html b/docs/jsdoc/PagingIterator_PagingIterator.html new file mode 100644 index 00000000..71df3f7a --- /dev/null +++ b/docs/jsdoc/PagingIterator_PagingIterator.html @@ -0,0 +1,286 @@ + + + + + JSDoc: Class: PagingIterator + + + + + + + + + + +
+ +

Class: PagingIterator

+ + + + + + +
+ +
+ +

+ PagingIterator#PagingIterator(response, client) → {void}

+ + +
+ +
+
+ + + + + + +

new PagingIterator(response, client) → {void}

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
response + + +Object + + + + The original API response
client + + +BoxClient + + + + An API client to make further requests
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Throws:
+ + + +
+
+
+ Will throw when collection cannot be paged +
+
+
+
+
+
+ Type +
+
+ +Error + + +
+
+
+
+
+ + + + + +
Returns:
+ + + + +
+
+ Type +
+
+ +void + + +
+
+ + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/PersistentSession.html b/docs/jsdoc/PersistentSession.html index a40d7ba7..c25ef062 100644 --- a/docs/jsdoc/PersistentSession.html +++ b/docs/jsdoc/PersistentSession.html @@ -130,7 +130,7 @@
Parameters:
-TokenStore +TokenStore @@ -550,7 +550,7 @@
Properties
Source:
@@ -604,7 +604,7 @@
Returns:
-

getAccessToken(optionsopt) → {Promise.<string>}

+

exchangeToken(scopes, resourceopt, optionsopt) → {void}

@@ -612,10 +612,7 @@

getAcce
- Returns the clients access token. - -If tokens don't yet exist, first attempt to retrieve them. -If tokens are expired, first attempt to refresh them. + Exchange the client access token for one with lower scope
@@ -651,6 +648,73 @@

Parameters:
+ + + scopes + + + + + +string +| + +Array.<string> + + + + + + + + + + + + + + + + + + The scope(s) requested for the new token + + + + + + + resource + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + The absolute URL of an API resource to scope the new token to + + + + options @@ -659,6 +723,60 @@
Parameters:
+Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tokenRequestOptions + + TokenRequestOptions @@ -686,6 +804,13 @@
Parameters:
+ + + + + + + @@ -720,7 +845,7 @@
Parameters:
Source:
@@ -748,10 +873,6 @@
Parameters:
Returns:
-
- Promise resolving to the access token -
-
@@ -760,7 +881,7 @@
Returns:
-Promise.<string> +void
@@ -778,7 +899,7 @@
Returns:
-

handleExpiredTokensError(err) → {Promise.<Error>}

+

getAccessToken(optionsopt) → {Promise.<string>}

@@ -786,8 +907,10 @@

- Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token -store (if present) before continuing. + Returns the clients access token. + +If tokens don't yet exist, first attempt to retrieve them. +If tokens are expired, first attempt to refresh them. @@ -811,6 +934,8 @@
Parameters:
Type + Attributes + @@ -823,24 +948,33 @@
Parameters:
- err + options -Errors~ExpiredTokensError +TokenRequestOptions + + + <optional>
+ + + + + + + - An "expired tokens" error including information - about the request/response. + Sets optional behavior for the token grant @@ -881,7 +1015,7 @@
Parameters:
Source:
@@ -910,9 +1044,7 @@
Returns:
- Promise resolving to an error. This will - usually be the original response error, but could an error from trying to access the - token store as well. + Promise resolving to the access token
@@ -923,7 +1055,680 @@
Returns:
-Promise.<Error> +Promise.<string> + + +
+

+ + + + + + + + + + + + + +

getAccessToken(optionsopt) → {Promise.<string>}

+ + + + + + +
+ Returns the clients access token. + +If tokens don't yet exist, first attempt to retrieve them. +If tokens are expired, first attempt to refresh them. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the access token +
+ + + +
+
+ Type +
+
+ +Promise.<string> + + +
+
+ + + + + + + + + + + + + +

handleExpiredTokensError(err) → {Promise.<Error>}

+ + + + + + +
+ Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token +store (if present) before continuing. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
err + + +Errors~ExpiredTokensError + + + + An "expired tokens" error including information + about the request/response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to an error. This will + usually be the original response error, but could an error from trying to access the + token store as well. +
+ + + +
+
+ Type +
+
+ +Promise.<Error> + + +
+
+ + + + + + + + + + + + + +

handleExpiredTokensError(err) → {Promise.<Error>}

+ + + + + + +
+ Handle an an "Expired Tokens" Error. If our tokens are expired, we need to clear the token +store (if present) before continuing. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
err + + +Errors~ExpiredTokensError + + + + An "expired tokens" error including information + about the request/response.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to an error. This will + usually be the original response error, but could an error from trying to access the + token store as well. +
+ + + +
+
+ Type +
+
+ +Promise.<Error> + + +
+
+ + + + + + + + + + + + + +

revokeTokens(optionsopt) → {Promise}

+ + + + + + +
+ Revokes the session's tokens. If the session has a refresh token we'll use that, +since it is more likely to be up to date. Otherwise, we'll revoke the accessToken. +Revoking either one will disable the other as well. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise that resolves when the revoke succeeds +
+ + + +
+
+ Type +
+
+ +Promise
@@ -1056,7 +1861,7 @@
Parameters:
Source:
@@ -1124,13 +1929,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RecentItems.html b/docs/jsdoc/RecentItems.html index ccecba47..8e544339 100644 --- a/docs/jsdoc/RecentItems.html +++ b/docs/jsdoc/RecentItems.html @@ -492,7 +492,341 @@
Properties
Source:
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of items in the collection +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests all items that have been accessed by a user in the last 90 days or the last 1000 items accessed. + +API Endpoint: '/recent_items' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		Maximum number of items to return
marker + + +string + + + + + + <optional>
+ + + + + + 		The position marker for marker-based paging
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields to include in the response
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the items information if they were acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -560,13 +894,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/RetentionPolicies.html b/docs/jsdoc/RetentionPolicies.html index def455c2..0ba63eed 100644 --- a/docs/jsdoc/RetentionPolicies.html +++ b/docs/jsdoc/RetentionPolicies.html @@ -264,7 +264,7 @@
Type:
Source:
@@ -337,7 +337,7 @@
Type:
Source:
@@ -410,7 +410,7 @@
Type:
Source:
@@ -482,7 +482,7 @@
Type:
Source:
@@ -846,7 +846,7 @@
Properties
Source:
@@ -904,7 +904,7 @@
Returns:
-

create(name, type, action, optionsopt, callbackopt) → {Promise.<Object>}

+

assign(policyID, assignType, assignID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -912,9 +912,9 @@

create - Used to create a single retention policy for an enterprise + Assign a retention policy to a folder or the entire enterprise. -API Endpoint: '/retention_policies' +API Endpoint: '/retention_policy_assignments Method: POST @@ -953,7 +953,7 @@
Parameters:
- name + policyID @@ -977,20 +977,20 @@
Parameters:
- The name of the retention policy to be created + The ID of the policy to assign - type + assignType -RetentionPolicyType +RetentionPolicyAssignmentType @@ -1008,20 +1008,20 @@
Parameters:
- The type of policy to create + The type of object the policy will be assigned to - action + assignID -RetentionPolicyDispositionAction +string @@ -1039,7 +1039,7 @@
Parameters:
- The disposition action for the new policy + The Box ID of the object to assign the retention policy to @@ -1072,7 +1072,7 @@
Parameters:
- Additional parameters + Optional parameters for the request
Properties
@@ -1100,79 +1100,13 @@
Properties
- are_owners_notified - - - - - -boolean - - - - - - - - - <optional>
- - - - - - - - - - - Whether or not owner and co-owners of a file are notified when the policy nears expiration - - - - - - - can_owner_extend_retention - - - - - -boolean - - - - - - - - - <optional>
- - - - - - - - - - - Whether or not the owner of a file will be allowed to extend the retention - - - - - - - custom_notification_recipients + filter_fields -Array.<UserMini> +Array.<MetadataFilterField> @@ -1192,14 +1126,14 @@
Properties
- A list of users notified when the retention policy duration is about to end + Metadata fields to filter against, if assigning to a metadata template - description + start_date_field @@ -1225,73 +1159,7 @@
Properties
- The additional text description of the retention policy - - - - - - - retention_length - - - - - -int - - - - - - - - - <optional>
- - - - - - - - - - - For finite policies, the number of days to retain the content - - - - - - - retention_type - - - - - -RetentionType - - - - - - - - - <optional>
- - - - - - - - - - - The type of retention for the new policy + Id of Metadata field which will be used to specify the start date for the retention policy, or set this to "upload_date" as value to use the date when the file was uploaded to Box @@ -1331,7 +1199,7 @@
Properties
- Passed the new policy information if it was acquired successfully, error otherwise + Passed the new assignment object if successful, error otherwise @@ -1372,7 +1240,7 @@
Properties
Source:
@@ -1401,7 +1269,7 @@
Returns:
- A promise resolving to the new policy object + A promise resolving to the created assignment object
@@ -1430,7 +1298,7 @@
Returns:
-

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+

create(name, type, action, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1438,10 +1306,10 @@

delet
- Delete a specific policy assignment. + Used to create a single retention policy for an enterprise -API Endpoint: '/retention_policy_assignments/:assignmentID' -Method: DELETE +API Endpoint: '/retention_policies' +Method: POST
@@ -1479,7 +1347,7 @@

Parameters:
- assignmentID + name @@ -1503,20 +1371,20 @@
Parameters:
- The Box ID of the policy assignment object to delete + The name of the retention policy to be created - callback + type -function +RetentionPolicyType @@ -1525,8 +1393,6 @@
Parameters:
- <optional>
- @@ -1536,161 +1402,237 @@
Parameters:
- Empty response body passed if successful. + The type of policy to create - - - - + + + action + + + + +RetentionPolicyDispositionAction -
+ + - + + + - + - + + + - + - + The disposition action for the new policy + - + + + options + - + + + +Object - - + + - + + + + <optional>
+ - - - -
Source:
-
- - - - - - - -
+ + + + + + Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + -
-
- Type -
-
- -Promise.<void> + +
+ + + - - + + + + - - + + -

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

- - + + + + + -API Endpoint: '/retention_policies/:policyID' -Method: GET - + + + + + + + + + + + + -
NameTypeAttributesDescription
are_owners_notified + + +boolean + + + + <optional>
+ -
Returns:
+ - -
- A promise resolving to nothing -
+ + 		Whether or not owner and co-owners of a file are notified when the policy nears expiration
can_owner_extend_retention + + +boolean - + + + + <optional>
+ + + + 		Whether or not the owner of a file will be allowed to extend the retention
custom_notification_recipients + + +Array.<UserMini> -
- Fetches details about a specific retention policy + +
+ + <optional>
+ + + + 		A list of users notified when the retention policy duration is about to end
description + + +string -
Parameters:
- + +
- - - - - + + + - - - + + + - + - - - + + - - + + - + + + + + + +
Name + + <optional>
+ - 		TypeAttributesDescription
The additional text description of the retention policy
policyIDretention_length -string +int @@ -1699,6 +1641,8 @@
Parameters:
 + <optional>
+ @@ -1708,20 +1652,20 @@
Parameters:
- 		The Box ID of the retention policy being requestedFor finite policies, the number of days to retain the content
optionsretention_type -Object +RetentionType @@ -1741,7 +1685,14 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The type of retention for the new policy
+ + @@ -1774,7 +1725,7 @@
Parameters:
- Passed the policy information if it was acquired successfully, error otherwise + Passed the new policy information if it was acquired successfully, error otherwise @@ -1815,7 +1766,7 @@
Parameters:
Source:
@@ -1844,7 +1795,7 @@
Returns:
- A promise resolving to the policy object + A promise resolving to the new policy object
@@ -1873,7 +1824,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

create(name, type, action, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1881,10 +1832,10 @@

getAll - Fetches a list of retention policies for the enterprise + Used to create a single retention policy for an enterprise -API Endpoint: '/retention_policies -Method: GET +API Endpoint: '/retention_policies' +Method: POST @@ -1922,13 +1873,13 @@
Parameters:
- options + name -Object +string @@ -1937,8 +1888,6 @@
Parameters:
- <optional>
- @@ -1948,41 +1897,20 @@
Parameters:
- Additional options for the request. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + + - + + - + - - - - -
NameTypeAttributesDescription
The name of the retention policy to be created
policy_nametype -string +RetentionPolicyType @@ -1991,8 +1919,6 @@
Properties
 - <optional>
- @@ -2002,20 +1928,20 @@
Properties
- 		A full or partial name to filter the retention policies byThe type of policy to create
policy_typeaction -RetentionPolicyType +RetentionPolicyDispositionAction @@ -2024,8 +1950,6 @@
Properties
 - <optional>
- @@ -2035,20 +1959,20 @@
Properties
- 		A policy type to filter the retention policies byThe disposition action for the new policy
created_by_user_idoptions -string +Object @@ -2068,17 +1992,4200 @@
Properties
- 		A user id to filter the retention policies by
+ Additional parameters +
Properties
+ - - + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
are_owners_notified + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not owner and co-owners of a file are notified when the policy nears expiration
can_owner_extend_retention + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not the owner of a file will be allowed to extend the retention
custom_notification_recipients + + +Array.<UserMini> + + + + + + <optional>
+ + + + + + 		A list of users notified when the retention policy duration is about to end
description + + +string + + + + + + <optional>
+ + + + + + 		The additional text description of the retention policy
retention_length + + +int + + + + + + <optional>
+ + + + + + 		For finite policies, the number of days to retain the content
retention_type + + +RetentionType + + + + + + <optional>
+ + + + + + 		The type of retention for the new policy
+ + + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the new policy information if it was acquired successfully, error otherwise + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a specific policy assignment. + +API Endpoint: '/retention_policy_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a specific policy assignment. + +API Endpoint: '/retention_policy_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches details about a specific retention policy + +API Endpoint: '/retention_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the retention policy being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches details about a specific retention policy + +API Endpoint: '/retention_policies/:policyID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the retention policy being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a list of retention policies for the enterprise + +API Endpoint: '/retention_policies +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policy_name + + +string + + + + + + <optional>
+ + + + + + 		A full or partial name to filter the retention policies by
policy_type + + +RetentionPolicyType + + + + + + <optional>
+ + + + + + 		A policy type to filter the retention policies by
created_by_user_id + + +string + + + + + + <optional>
+ + + + + + 		A user id to filter the retention policies by
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a list of retention policies for the enterprise + +API Endpoint: '/retention_policies +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policy_name + + +string + + + + + + <optional>
+ + + + + + 		A full or partial name to filter the retention policies by
policy_type + + +RetentionPolicyType + + + + + + <optional>
+ + + + + + 		A policy type to filter the retention policies by
created_by_user_id + + +string + + + + + + <optional>
+ + + + + + 		A user id to filter the retention policies by
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the policy objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAllFileVersionRetentions(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of retention records for a retained file versions in an enterprise. +To use this feature, you must have the manage retention policies scope enabled +for your API key via your application management console. + +API Endpoint: '/file_version_retentions' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
file_id + + +string + + + + + + <optional>
+ + + + + + 		A file id to filter the file version retentions by
file_version_id + + +string + + + + + + <optional>
+ + + + + + 		A file version id to filter the file version retentions by
policy_id + + +string + + + + + + <optional>
+ + + + + + 		A policy id to filter the file version retentions by
disposition_action + + +RetentionPolicyDispositionAction + + + + + + <optional>
+ + + + + + 		The disposition action of the retention policy to filter by
disposition_before + + +string + + + + + + <optional>
+ + + + + + 		Filter by retention policies which will complete before a certain time
disposition_after + + +string + + + + + + <optional>
+ + + + + + 		Filter by retention policies which will complete after a certain time
limit + + +int + + + + + + <optional>
+ + + + + + 		The maximum number of items to return in a page
marker + + +string + + + + + + <optional>
+ + + + + + 		Paging marker, left blank to begin paging from the beginning
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Pass the file version retention record if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of retention records +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAllFileVersionRetentions(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of retention records for a retained file versions in an enterprise. +To use this feature, you must have the manage retention policies scope enabled +for your API key via your application management console. + +API Endpoint: '/file_version_retentions' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
file_id + + +string + + + + + + <optional>
+ + + + + + 		A file id to filter the file version retentions by
file_version_id + + +string + + + + + + <optional>
+ + + + + + 		A file version id to filter the file version retentions by
policy_id + + +string + + + + + + <optional>
+ + + + + + 		A policy id to filter the file version retentions by
disposition_action + + +RetentionPolicyDispositionAction + + + + + + <optional>
+ + + + + + 		The disposition action of the retention policy to filter by
disposition_before + + +string + + + + + + <optional>
+ + + + + + 		Filter by retention policies which will complete before a certain time
disposition_after + + +string + + + + + + <optional>
+ + + + + + 		Filter by retention policies which will complete after a certain time
limit + + +int + + + + + + <optional>
+ + + + + + 		The maximum number of items to return in a page
marker + + +string + + + + + + <optional>
+ + + + + + 		Paging marker, left blank to begin paging from the beginning
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Pass the file version retention record if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of retention records +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetch a specific policy assignment + +API Endpoint: '/retention_policy_assignments/:assignmentID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to fetch
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment object if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetch a specific policy assignment + +API Endpoint: '/retention_policy_assignments/:assignmentID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to fetch
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment object if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetch a list of assignments for a given retention policy + +API Endpoint: '/retention_policies/:policyID/assignments' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the retention policy to get assignments for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +RetentionPolicyAssignmentType + + + + + + <optional>
+ + + + + + 		The type of the retention policy assignment to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policy assignments +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetch a list of assignments for a given retention policy + +API Endpoint: '/retention_policies/:policyID/assignments' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the retention policy to get assignments for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +RetentionPolicyAssignmentType + + + + + + <optional>
+ + + + + + 		The type of the retention policy assignment to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment objects if they were acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of policy assignments +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getFilesUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get files under retention by each assignment +To use this feature, you must have the manage retention policies scope enabled +for your API key via your application management console. + +API Endpoint: '/retention_policy_assignments/:assignmentID/files_under_retention' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2108,7 +6215,7 @@
Properties
- + @@ -2149,7 +6256,7 @@
Properties
Source:
@@ -2178,7 +6285,7 @@
Returns:
- A promise resolving to the collection of policies + A promise resolving to the collection of retention records
@@ -2207,7 +6314,7 @@
Returns:
-

getAllFileVersionRetentions(optionsopt, callbackopt) → {Promise.<Object>}

+

getFilesUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2215,11 +6322,11 @@

<
- Get a list of retention records for a retained file versions in an enterprise. + Get files under retention by each assignment To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. -API Endpoint: '/file_version_retentions' +API Endpoint: '/retention_policy_assignments/:assignmentID/files_under_retention' Method: GET
@@ -2256,6 +6363,37 @@
Parameters:

+ + + + + + + + + + + + + + + + + + @@ -2312,13 +6450,13 @@
Properties
- + + - + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to fetch
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		The maximum number of items to return in a page
marker + + +string + + + + + + <optional>
+ + + + + + 		Paging marker, left blank to begin paging from the beginning
+ +
Passed the policy objects if they were acquired successfully, error otherwisePass the file version retention record if successful, error otherwise
assignmentID + + +string + + + + + + + + + + The Box ID of the policy assignment object to fetch
options
file_idlimit -string +int @@ -2338,14 +6476,14 @@
Properties
- 		A file id to filter the file version retentions byThe maximum number of items to return in a page
file_version_idmarker @@ -2371,20 +6509,27 @@
Properties
- 		A file version id to filter the file version retentions byPaging marker, left blank to begin paging from the beginning
+ + - policy_id + callback -string +function @@ -2404,119 +6549,163 @@
Properties
- A policy id to filter the file version retentions by + Pass the file version retention record if successful, error otherwise + + - - - disposition_action - - - - -RetentionPolicyDispositionAction - - - - - - <optional>
- - +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of retention records +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + - - - + - The disposition action of the retention policy to filter by - + +

getFileVersionRetention(retentionID, optionsopt, callbackopt) → {Promise.<Object>}

+ - - - disposition_before - + - - - -string - - +
+ Get the specific retention record for a retained file version. To use this feature, +you must have the manage retention policies scope enabled for your API key +via your application management console. - - - - <optional>
- +API Endpoint: '/file_version_retentions/:retentionID' +Method: GET +
- - - - - - Filter by retention policies which will complete before a certain time - - - - - disposition_after - - - - -string - - +
Parameters:
+ - - - - <optional>
- + + + + + + - + - - - + + + - + - - + + + + - + + - + - - - - -
NameTypeAttributesFilter by retention policies which will complete after a certain time
Description
limitretentionID -int +string @@ -2525,8 +6714,6 @@
Properties
 - <optional>
- @@ -2536,20 +6723,20 @@
Properties
- 		The maximum number of items to return in a pageThe ID for the file retention record to retrieve
markeroptions -string +Object @@ -2569,14 +6756,7 @@
Properties
- 		Paging marker, left blank to begin paging from the beginning
- - + Additional options for the request. Can be left null in most cases. @@ -2650,7 +6830,7 @@
Properties
Source:
@@ -2679,7 +6859,7 @@
Returns:
- A promise resolving to the collection of retention records + A promise resolving to the retention record
@@ -2708,7 +6888,7 @@
Returns:
-

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+

getFileVersionRetention(retentionID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2716,9 +6896,11 @@

getAssig
- Fetch a specific policy assignment + Get the specific retention record for a retained file version. To use this feature, +you must have the manage retention policies scope enabled for your API key +via your application management console. -API Endpoint: '/retention_policy_assignments/:assignmentID' +API Endpoint: '/file_version_retentions/:retentionID' Method: GET
@@ -2757,7 +6939,7 @@

Parameters:
- assignmentID + retentionID @@ -2781,7 +6963,7 @@
Parameters:
- The Box ID of the policy assignment object to fetch + The ID for the file retention record to retrieve @@ -2847,7 +7029,7 @@
Parameters:
- Passed the assignment object if it was acquired successfully, error otherwise + Pass the file version retention record if successful, error otherwise @@ -2888,7 +7070,7 @@
Parameters:
Source:
@@ -2917,7 +7099,7 @@
Returns:
- A promise resolving to the assignment object + A promise resolving to the retention record
@@ -2946,7 +7128,7 @@
Returns:
-

getAssignments(policyID, optionsopt, callbackopt) → {Promise.<Object>}

+

getFileVersionsUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -2954,9 +7136,11 @@

getAssi
- Fetch a list of assignments for a given retention policy + Get file versions under retention by each assignment +To use this feature, you must have the manage retention policies scope enabled +for your API key via your application management console. -API Endpoint: '/retention_policies/:policyID/assignments' +API Endpoint: '/retention_policy_assignments/:assignmentID/file_versions_under_retention' Method: GET
@@ -2995,7 +7179,7 @@

Parameters:
- policyID + assignmentID @@ -3019,7 +7203,7 @@
Parameters:
- The Box ID of the retention policy to get assignments for + The Box ID of the policy assignment object to fetch @@ -3080,13 +7264,13 @@
Properties
- type + limit -RetentionPolicyAssignmentType +int @@ -3106,7 +7290,40 @@
Properties
- The type of the retention policy assignment to retrieve + The maximum number of items to return in a page + + + + + + + marker + + + + + +string + + + + + + + + + <optional>
+ + + + + + + + + + + Paging marker, left blank to begin paging from the beginning @@ -3146,7 +7363,7 @@
Properties
- Passed the assignment objects if they were acquired successfully, error otherwise + Pass the file version retention record if successful, error otherwise @@ -3187,7 +7404,7 @@
Properties
Source:
@@ -3216,7 +7433,7 @@
Returns:
- A promise resolving to the collection of policy assignments + A promise resolving to the collection of retention records
@@ -3245,7 +7462,7 @@
Returns:
-

getFilesUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+

getFileVersionsUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -3253,11 +7470,11 @@

- Get files under retention by each assignment + Get file versions under retention by each assignment To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. -API Endpoint: '/retention_policy_assignments/:assignmentID/files_under_retention' +API Endpoint: '/retention_policy_assignments/:assignmentID/file_versions_under_retention' Method: GET @@ -3521,7 +7738,7 @@
Properties
Source:
@@ -3579,7 +7796,7 @@
Returns:
-

getFileVersionRetention(retentionID, optionsopt, callbackopt) → {Promise.<Object>}

+

update(policyID, updates, callbackopt) → {Promise.<Object>}

@@ -3587,24 +7804,105 @@

- Get the specific retention record for a retained file version. To use this feature, -you must have the manage retention policies scope enabled for your API key -via your application management console. + Update or modify a retention policy. + +API Endpoint: '/retention_policies/:policyID' +Method: PUT + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -API Endpoint: '/file_version_retentions/:retentionID' -Method: GET - + + + + + + + + + + -
Parameters:
- + + + + - + + + - + - -

getFileVersionsUnderRetentionForAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

- + + + + + + - -
- Get file versions under retention by each assignment -To use this feature, you must have the manage retention policies scope enabled -for your API key via your application management console. - -API Endpoint: '/retention_policy_assignments/:assignmentID/file_versions_under_retention' -Method: GET -
- - - - - - - + -
NameTypeAttributesDescription
policyID + + +string + + + + + + + + + + The Box ID of the retention policy to update
updates + + +Object + + + + + + The information to be updated +
Properties
+ @@ -3630,7 +7928,7 @@
Parameters:
- + + - + + - + + - -
retentionIDpolicy_name @@ -3645,6 +7943,8 @@
Parameters:
 + <optional>
+ @@ -3654,20 +7954,20 @@
Parameters:
- 		The ID for the file retention record to retrieveThe name of the retention policy
optionsdisposition_action -Object +RetentionPolicyDispositionAction @@ -3687,20 +7987,20 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases.The disposition action for the updated policy
callbackare_owners_notified -function +boolean @@ -3720,157 +8020,80 @@
Parameters:
- 		Pass the file version retention record if successful, error otherwiseWhether or not owner and co-owners of a file are notified when the policy nears expiration
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
- A promise resolving to the retention record -
- - - -
-
- Type -
-
- -Promise.<Object> - - -
-
+
can_owner_extend_retention + + +boolean + + + + <optional>
+ + - + + 		Whether or not the owner of a file will be allowed to extend the retention
custom_notification_recipients + + +Array.<UserMini> -
Parameters:
- + +
- - - - - + + + - - - + + + - + - - - + + - - + + - + + + + + + + + + + + + + + + + + + + @@ -745,9 +782,163 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + + + + +
Name + + <optional>
+ - 		TypeAttributesDescription
A list of users notified when the retention policy duration is about to end
assignmentIDdescription @@ -3885,6 +8108,8 @@
Parameters:
 + <optional>
+ @@ -3894,20 +8119,20 @@
Parameters:
- 		The Box ID of the policy assignment object to fetchThe additional text description of the retention policy
optionsretention_length -Object +int @@ -3927,41 +8152,20 @@
Parameters:
- 		Additional options for the request. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - + + - - + + - + + @@ -4054,7 +8258,7 @@
Properties
- + @@ -4095,7 +8299,7 @@
Properties
Source:
@@ -4124,7 +8328,7 @@
Returns:
- A promise resolving to the collection of retention records + A promise resolving to the updated policy object
@@ -4656,7 +8860,7 @@
Properties
Source:
@@ -4724,13 +8928,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Search.html b/docs/jsdoc/Search.html index 9ae7eb36..333ab758 100644 --- a/docs/jsdoc/Search.html +++ b/docs/jsdoc/Search.html @@ -264,7 +264,7 @@
Type:
Source:
@@ -1134,7 +1134,907 @@
Properties
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of search results +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

query(searchString, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Searches Box for the given query. +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
For finite policies, the number of days to retain the content
limitretention_type -int +RetentionType @@ -3981,14 +8185,14 @@
Properties
- 		The maximum number of items to return in a pageThe type of retention. The only possible value here is non_modifiable. You can convert a modifiable policy to non_modifiable, but not the other way around.
markerstatus @@ -4014,7 +8218,7 @@
Properties
- 		Paging marker, left blank to begin paging from the beginningUsed to retire a retention policy if status is set to retired
Pass the file version retention record if successful, error otherwisePassed the updated policy information if it was acquired successfully, error otherwise
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
searchString + + +string + + + + + + + + + + The query string to use for search
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional search filters. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
scope + + +SearchScope + + + + + + <optional>
+ + + + + + 		+ + The scope on which you want search. Can be user_content for a search limited to the current user or enterprise_content to search an entire enterprise
file_extensions + + +string + + + + + + <optional>
+ + + + + + 		+ + Single or comma-delimited list of file extensions to filter against
created_at_range + + +string + + + + + + <optional>
+ + + + + + 		+ + Date range for filtering on item creation time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
updated_at_range + + +string + + + + + + <optional>
+ + + + + + 		+ + Date range for filtering on item update time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
size_range + + +string + + + + + + <optional>
+ + + + + + 		+ + Range of item sizes (in bytes) to filter on, as lower_bound,upper_bound. Either bound can be ommitted, e.g. ',100000' for <= 100KB
owner_user_ids + + +string + + + + + + <optional>
+ + + + + + 		+ + Comma-delimited list of user IDs to filter item owner against
ancestor_folder_ids + + +string + + + + + + <optional>
+ + + + + + 		+ + Comma-delimited list of folder IDs, search results will contain only items in these folders (and folders within them)
content_types + + +string + + + + + + <optional>
+ + + + + + 		+ + Query within specified comma-delimited fields. The types can be name, description, file_content, comments, or tags
type + + +string + + + + + + <optional>
+ + + + + + 		+ + The type of objects you want to include in the search results. The type can be file, folder, or web_link
trash_content + + +string + + + + + + <optional>
+ + + + + + 		+ + non_trashed_only + + Controls whether to search in the trash. The value can be trashed_only or non_trashed_only
mdfilters + + +Array.<SearchMetadataFilter> + + + + + + <optional>
+ + + + + + 		+ + Searches for objects with a specific metadata object association. Searches with this parameter do not require a query string
include_recent_shared_links + + +boolean + + + + + + <optional>
+ + + + + + 		+ + Determines whether to include items accessible only via shared link in the response.
fields + + +string + + + + + + <optional>
+ + + + + + 		+ + Comma-delimited list of fields to be included in the response
limit + + +int + + + + + + <optional>
+ + + + + + 		+ + 30 + + The number of search results to return, max 200
offset + + +int + + + + + + <optional>
+ + + + + + 		+ + 0 + + The search result at which to start the response, must be a multiple of limit
sort + + +string + + + + + + <optional>
+ + + + + + 		+ + The field on which the results should be sorted, e.g. "modified_at"
direction + + +string + + + + + + <optional>
+ + + + + + 		+ + The sort direction: "ASC" for ascending and "DESC" for descending
+ +
callback + + +APIRequest~Callback + + + + + + <optional>
+ + + + + + 		passed the new comment data if it was posted successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -1202,13 +2102,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SharedItems.html b/docs/jsdoc/SharedItems.html index 493d6be7..9b70be70 100644 --- a/docs/jsdoc/SharedItems.html +++ b/docs/jsdoc/SharedItems.html @@ -429,7 +429,278 @@
Parameters:
Source:
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the shared item object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(url, passwordopt, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests a Box item associated with a shared link. + +API Endpoint: '/shared_items' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
url + + +string + + + + + + + + + + Shared Link URL
password + + +string + + + + + + <optional>
+ + + + + + 		Shared Link Password (null if no password)
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the shared item if it was successfully acquired
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -497,13 +768,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrier.html b/docs/jsdoc/ShieldInformationBarrier.html index 4c3edb99..004600a8 100644 --- a/docs/jsdoc/ShieldInformationBarrier.html +++ b/docs/jsdoc/ShieldInformationBarrier.html @@ -75,7 +75,7 @@

ShieldInformationBarrier

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -309,7 +309,7 @@
Type:
Source:
@@ -381,7 +381,7 @@
Type:
Source:
@@ -453,7 +453,7 @@
Type:
Source:
@@ -526,7 +526,7 @@
Type:
Source:
@@ -611,7 +611,7 @@
Type:
Source:
@@ -684,7 +684,7 @@
Type:
Source:
@@ -757,7 +757,7 @@
Type:
Source:
@@ -829,7 +829,7 @@
Type:
Source:
@@ -863,13 +863,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierBase.html b/docs/jsdoc/ShieldInformationBarrierBase.html index d3f0ac05..49ca7f55 100644 --- a/docs/jsdoc/ShieldInformationBarrierBase.html +++ b/docs/jsdoc/ShieldInformationBarrierBase.html @@ -75,7 +75,7 @@

ShieldInformationBarrierBase

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager.html index bd216954..b3cc4404 100644 --- a/docs/jsdoc/ShieldInformationBarrierManager.html +++ b/docs/jsdoc/ShieldInformationBarrierManager.html @@ -176,6 +176,13 @@
Parameters:
+

Classes

+ +
+
ShieldInformationBarrierManager
+
+
+ @@ -373,7 +380,7 @@
Parameters:
Source:
@@ -431,7 +438,7 @@
Returns:
-

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

+

changeStatusById(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

@@ -439,11 +446,9 @@

create - Create shield information barrier + Add changed status of shield information barrier with specified ID -Creates a shield information barrier to -separate individuals/groups within the same -firm and prevents confidential information passing between them. +Change status of shield information barrier with the specified ID. @@ -487,7 +492,7 @@
Parameters:

 -schemas.ShieldInformationBarrier +object @@ -612,7 +617,7 @@
Parameters:
Source:
@@ -670,7 +675,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<object>}

+

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

@@ -678,10 +683,11 @@

getAll - List shield information barriers + Create shield information barrier -Retrieves a list of shield information barrier objects -for the enterprise of JWT. +Creates a shield information barrier to +separate individuals/groups within the same +firm and prevents confidential information passing between them. @@ -717,6 +723,37 @@
Parameters:

body + + +schemas.ShieldInformationBarrier + + + + + + + + + +
optionsOptions for the request -
Properties
+ 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrier> + + +
+
+ + + + + + + + + + + + + +

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

+ + + + + + +
+ Create shield information barrier + +Creates a shield information barrier to +separate individuals/groups within the same +firm and prevents confidential information passing between them. +
+ + + + + + + + + +
Parameters:
+ @@ -773,13 +964,13 @@
Properties
- + + - + - - - - -
markerbody -string +schemas.ShieldInformationBarrier @@ -788,8 +979,6 @@
Properties
 - <optional>
- @@ -799,20 +988,20 @@
Properties
- 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limitoptions -number +object @@ -832,14 +1021,7 @@
Properties
- 		The maximum number of items to return per page.
- - + Options for the request @@ -913,7 +1095,7 @@
Properties
Source:
@@ -953,7 +1135,862 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrier> + + +
+

+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barriers + +Retrieves a list of shield information barrier objects +for the enterprise of JWT. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barriers + +Retrieves a list of shield information barrier objects +for the enterprise of JWT. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrier>}

+ + + + + + +
+ Get shield information barrier with specified ID + +Get shield information barrier based on provided ID.. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_id + + +string + + + + The ID of the shield information barrier.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrier>
@@ -1166,7 +2203,7 @@
Properties
Source:
@@ -1234,13 +2271,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html new file mode 100644 index 00000000..e6d16e15 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierManager_ShieldInformationBarrierManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: ShieldInformationBarrierManager + + + + + + + + + + +
+ +

Class: ShieldInformationBarrierManager

+ + + + + + +
+ +
+ +

+ ShieldInformationBarrierManager#ShieldInformationBarrierManager(client)

+ + +
+ +
+
+ + + + + + +

new ShieldInformationBarrierManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierReference.html b/docs/jsdoc/ShieldInformationBarrierReference.html index 9af3dce4..50e18e81 100644 --- a/docs/jsdoc/ShieldInformationBarrierReference.html +++ b/docs/jsdoc/ShieldInformationBarrierReference.html @@ -74,7 +74,7 @@

ShieldInformationBarrierReference

Source:
@@ -119,13 +119,13 @@

ShieldInformationBarrierReference


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReport.html b/docs/jsdoc/ShieldInformationBarrierReport.html index fd04cb07..83b9287a 100644 --- a/docs/jsdoc/ShieldInformationBarrierReport.html +++ b/docs/jsdoc/ShieldInformationBarrierReport.html @@ -75,7 +75,7 @@

ShieldInformationBarrierReport

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -318,7 +318,7 @@
Type:
Source:
@@ -392,7 +392,7 @@
Type:
Source:
@@ -426,13 +426,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportBase.html b/docs/jsdoc/ShieldInformationBarrierReportBase.html index d558b879..959571ef 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportBase.html +++ b/docs/jsdoc/ShieldInformationBarrierReportBase.html @@ -75,7 +75,7 @@

ShieldInformationBarrierReportBase

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportDetails.html b/docs/jsdoc/ShieldInformationBarrierReportDetails.html index 14c4ee79..fa7004ca 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportDetails.html +++ b/docs/jsdoc/ShieldInformationBarrierReportDetails.html @@ -75,7 +75,7 @@

ShieldInformationBarrierReportDetails

Source:
@@ -120,13 +120,13 @@

ShieldInformationBarrierReportDetails


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager.html index 1defa4e3..d4940bb1 100644 --- a/docs/jsdoc/ShieldInformationBarrierReportsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager.html @@ -176,6 +176,13 @@
Parameters:
+

Classes

+ +
+
ShieldInformationBarrierReportsManager
+
+
+ @@ -373,7 +380,244 @@
Parameters:
Source:
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierReport> + + +
+
+ + + + + + + + + + + + + +

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierReport>}

+ + + + + + +
+ Create shield information barrier report + +Creates a shield information barrier report for a given barrier. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.ShieldInformationBarrierReference + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -702,7 +946,7 @@
Properties
Source:
@@ -760,6 +1004,588 @@
Returns:
+

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier reports + +Lists shield information barrier reports with specific IDs. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_id + + +string + + + + + + + + + + The ID of the shield information barrier.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierReport>}

+ + + + + + +
+ Get shield information barrier report by ID + +Retrieves a shield information barrier report by its ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_report_id + + +string + + + + The ID of the shield information barrier Report.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierReport> + + +
+
+ + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierReport>}

@@ -955,7 +1781,7 @@
Properties
Source:
@@ -1023,13 +1849,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html new file mode 100644 index 00000000..65050327 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierReportsManager_ShieldInformationBarrierReportsManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: ShieldInformationBarrierReportsManager + + + + + + + + + + +
+ +

Class: ShieldInformationBarrierReportsManager

+ + + + + + +
+ +
+ +

+ ShieldInformationBarrierReportsManager#ShieldInformationBarrierReportsManager(client)

+ + +
+ +
+
+ + + + + + +

new ShieldInformationBarrierReportsManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegment.html b/docs/jsdoc/ShieldInformationBarrierSegment.html index df9d8390..306f94ae 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegment.html +++ b/docs/jsdoc/ShieldInformationBarrierSegment.html @@ -74,7 +74,7 @@

ShieldInformationBarrierSegment

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -235,7 +235,7 @@
Type:
Source:
@@ -309,7 +309,7 @@
Type:
Source:
@@ -382,7 +382,7 @@
Type:
Source:
@@ -455,7 +455,7 @@
Type:
Source:
@@ -528,7 +528,7 @@
Type:
Source:
@@ -602,7 +602,7 @@
Type:
Source:
@@ -674,7 +674,7 @@
Type:
Source:
@@ -708,13 +708,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html index 21ad2606..d45820fa 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMember.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMember.html @@ -75,7 +75,7 @@

ShieldInformationBarrierSegmentMember

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -309,7 +309,7 @@
Type:
Source:
@@ -383,7 +383,7 @@
Type:
Source:
@@ -455,7 +455,7 @@
Type:
Source:
@@ -527,7 +527,7 @@
Type:
Source:
@@ -561,13 +561,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html index 08508345..5d1e72be 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberBase.html @@ -75,7 +75,7 @@

ShieldInformationBarrierSegmentMemberBase

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -237,7 +237,7 @@
Type:
Source:
@@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html index a87bafb5..995f15d2 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMemberMini.html @@ -75,7 +75,7 @@

ShieldInformationBarrierSegmentMemberMini

Source:
@@ -162,7 +162,7 @@
Type:
Source:
@@ -196,13 +196,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html index 1cab18c4..2e609f6c 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager.html @@ -176,6 +176,13 @@
Parameters:
+

Classes

+ +
+
ShieldInformationBarrierSegmentMembersManager
+
+
+ @@ -373,7 +380,7 @@
Parameters:
Source:
@@ -431,7 +438,7 @@
Returns:
-

deleteById(options, callbackopt) → {Promise.<void>}

+

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentMember>}

@@ -439,10 +446,9 @@

deleteById<
- Delete shield information barrier segment member by ID + Create shield information barrier segment member -Deletes a shield information barrier -segment member based on provided ID. +Creates a new shield information barrier segment member.
@@ -480,7 +486,7 @@

Parameters:
- options + body @@ -504,56 +510,40 @@
Parameters:
- Options for the request -
Properties
- - - - - - - - - - - - - - - - - - + + - - + + - + + + - - -
NameTypeDescription
shield_information_barrier_segment_member_idoptions -string +object + + <optional>
+ - + - 		The ID of the shield information barrier segment Member.
+ - + Options for the request @@ -627,7 +617,7 @@
Properties
Source:
@@ -667,7 +657,7 @@
Returns:
-Promise.<void> +Promise.<schemas.ShieldInformationBarrierSegmentMember>
@@ -685,7 +675,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

deleteById(options, callbackopt) → {Promise.<void>}

@@ -693,10 +683,10 @@

getAll - List shield information barrier segment members + Delete shield information barrier segment member by ID -Lists shield information barrier segment members -based on provided segment IDs. +Deletes a shield information barrier +segment member based on provided ID. @@ -772,8 +762,6 @@
Properties
Type - Attributes - @@ -786,38 +774,7 @@
Properties
- shield_information_barrier_segment_id - - - - - -string - - - - - - - - - - - - - - - - - - The ID of the shield information barrier segment. - - - - - - - marker + shield_information_barrier_segment_member_id @@ -830,53 +787,10 @@
Properties
- - - <optional>
- - - - - - - - - - - Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. - - - - - - - limit - - - - - -number - - - - - - - - - <optional>
- - - - - - - - The maximum number of items to return per page. + The ID of the shield information barrier segment Member. @@ -957,7 +871,7 @@
Properties
Source:
@@ -997,7 +911,1175 @@
Returns:
-Promise.<object> +Promise.<void> + + +
+

+ + + + + + + + + + + + + +

deleteById(options, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete shield information barrier segment member by ID + +Deletes a shield information barrier +segment member based on provided ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_member_id + + +string + + + + The ID of the shield information barrier segment Member.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier segment members + +Lists shield information barrier segment members +based on provided segment IDs. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_segment_id + + +string + + + + + + + + + + The ID of the shield information barrier segment.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier segment members + +Lists shield information barrier segment members +based on provided segment IDs. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_segment_id + + +string + + + + + + + + + + The ID of the shield information barrier segment.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentMember>}

+ + + + + + +
+ Get shield information barrier segment member by ID + +Retrieves a shield information barrier +segment member by its ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_member_id + + +string + + + + The ID of the shield information barrier segment Member.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierSegmentMember>
@@ -1211,7 +2293,7 @@
Properties
Source:
@@ -1279,13 +2361,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html new file mode 100644 index 00000000..2c4b7f05 --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegmentMembersManager_ShieldInformationBarrierSegmentMembersManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: ShieldInformationBarrierSegmentMembersManager + + + + + + + + + + +
+ +

Class: ShieldInformationBarrierSegmentMembersManager

+ + + + + + +
+ +
+ +

+ ShieldInformationBarrierSegmentMembersManager#ShieldInformationBarrierSegmentMembersManager(client)

+ + +
+ +
+
+ + + + + + +

new ShieldInformationBarrierSegmentMembersManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html index 1771f42d..2152926f 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestriction.html @@ -76,7 +76,7 @@

ShieldInformationBarrierSegmentRestriction

Source:
@@ -166,7 +166,7 @@
Type:
Source:
@@ -238,7 +238,7 @@
Type:
Source:
@@ -313,7 +313,7 @@
Type:
Source:
@@ -385,7 +385,7 @@
Type:
Source:
@@ -419,13 +419,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html index 9065c894..6d046a4d 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionBase.html @@ -76,7 +76,7 @@

ShieldInformationBarrierSegmentRestrictionBase

Source:
@@ -165,7 +165,7 @@
Type:
Source:
@@ -238,7 +238,7 @@
Type:
Source:
@@ -272,13 +272,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html index 880c87fc..de89a7fd 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionMini.html @@ -76,7 +76,7 @@

ShieldInformationBarrierSegmentRestrictionMini

Source:
@@ -164,7 +164,7 @@
Type:
Source:
@@ -237,7 +237,7 @@
Type:
Source:
@@ -271,13 +271,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html index d2de8b2f..73104320 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager.html @@ -176,6 +176,13 @@
Parameters:
+

Classes

+ +
+
ShieldInformationBarrierSegmentRestrictionsManager
+
+
+ @@ -374,7 +381,7 @@
Parameters:
Source:
@@ -432,7 +439,7 @@
Returns:
-

deleteById(options, callbackopt) → {Promise.<void>}

+

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentRestriction>}

@@ -440,10 +447,10 @@

deleteById<
- Delete shield information barrier segment restriction by ID + Create shield information barrier segment restriction -Delete shield information barrier segment restriction -based on provided ID. +Creates a shield information barrier +segment restriction object.
@@ -481,7 +488,7 @@

Parameters:
- options + body @@ -505,56 +512,40 @@
Parameters:
- Options for the request -
Properties
- - - - - - - - - - - - - - - - - - + + - - + + - + + + - - -
NameTypeDescription
shield_information_barrier_segment_restriction_idoptions -string +object + + <optional>
+ - + - 		The ID of the shield information barrier segment Restriction.
+ - + Options for the request @@ -628,7 +619,7 @@
Properties
Source:
@@ -668,7 +659,7 @@
Returns:
-Promise.<void> +Promise.<schemas.ShieldInformationBarrierSegmentRestriction>
@@ -686,7 +677,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

deleteById(options, callbackopt) → {Promise.<void>}

@@ -694,10 +685,10 @@

getAll - List shield information barrier segment restrictions + Delete shield information barrier segment restriction by ID -Lists shield information barrier segment restrictions -based on provided segment ID. +Delete shield information barrier segment restriction +based on provided ID. @@ -773,8 +764,6 @@
Properties
Type - Attributes - @@ -787,38 +776,7 @@
Properties
- shield_information_barrier_segment_id - - - - - -string - - - - - - - - - - - - - - - - - - The ID of the shield information barrier segment. - - - - - - - marker + shield_information_barrier_segment_restriction_id @@ -831,53 +789,10 @@
Properties
- - - <optional>
- - - - - - - - - - - Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. - - - - - - - limit - - - - - -number - - - - - - - - - <optional>
- - - - - - - - The maximum number of items to return per page. + The ID of the shield information barrier segment Restriction. @@ -958,7 +873,7 @@
Properties
Source:
@@ -998,7 +913,1175 @@
Returns:
-Promise.<object> +Promise.<void> + + +
+

+ + + + + + + + + + + + + +

deleteById(options, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete shield information barrier segment restriction by ID + +Delete shield information barrier segment restriction +based on provided ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_restriction_id + + +string + + + + The ID of the shield information barrier segment Restriction.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier segment restrictions + +Lists shield information barrier segment restrictions +based on provided segment ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_segment_id + + +string + + + + + + + + + + The ID of the shield information barrier segment.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier segment restrictions + +Lists shield information barrier segment restrictions +based on provided segment ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_segment_id + + +string + + + + + + + + + + The ID of the shield information barrier segment.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegmentRestriction>}

+ + + + + + +
+ Get shield information barrier segment restriction by ID + +Retrieves a shield information barrier segment +restriction based on provided ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_restriction_id + + +string + + + + The ID of the shield information barrier segment Restriction.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierSegmentRestriction>
@@ -1212,7 +2295,7 @@
Properties
Source:
@@ -1280,13 +2363,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html new file mode 100644 index 00000000..5970e86f --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegmentRestrictionsManager_ShieldInformationBarrierSegmentRestrictionsManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: ShieldInformationBarrierSegmentRestrictionsManager + + + + + + + + + + +
+ +

Class: ShieldInformationBarrierSegmentRestrictionsManager

+ + + + + + +
+ +
+ +

+ ShieldInformationBarrierSegmentRestrictionsManager#ShieldInformationBarrierSegmentRestrictionsManager(client)

+ + +
+ +
+
+ + + + + + +

new ShieldInformationBarrierSegmentRestrictionsManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html index 042cad0f..cf1a043d 100644 --- a/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager.html @@ -176,6 +176,13 @@
Parameters:
+

Classes

+ +
+
ShieldInformationBarrierSegmentsManager
+
+
+ @@ -194,7 +201,1319 @@

Methods

-

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

+

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

+ + + + + + +
+ Create shield information barrier segment + +Creates a shield information barrier segment. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +object + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierSegment> + + +
+
+ + + + + + + + + + + + + +

create(body, optionsopt, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

+ + + + + + +
+ Create shield information barrier segment + +Creates a shield information barrier segment. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +object + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.ShieldInformationBarrierSegment> + + +
+
+ + + + + + + + + + + + + +

deleteById(options, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete shield information barrier segment + +Deletes the shield information barrier segment +based on provided ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_id + + +string + + + + The ID of the shield information barrier segment.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteById(options, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete shield information barrier segment + +Deletes the shield information barrier segment +based on provided ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
shield_information_barrier_segment_id + + +string + + + + The ID of the shield information barrier segment.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

+ + + + + + +
+ List shield information barrier segments + +Retrieves a list of shield information barrier segment objects +for the specified Information Barrier ID. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_id + + +string + + + + + + + + + + The ID of the shield information barrier.
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<object> + + +
+
+ + + + + + + + + + + + + +

getAll(options, callbackopt) → {Promise.<object>}

@@ -202,9 +1521,10 @@

create - Create shield information barrier segment + List shield information barrier segments -Creates a shield information barrier segment. +Retrieves a list of shield information barrier segment objects +for the specified Information Barrier ID. @@ -242,7 +1562,7 @@
Parameters:
- body + options @@ -266,20 +1586,72 @@
Parameters:
- + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
shield_information_barrier_id + + +string + + + + + + + + + + The ID of the shield information barrier.
optionsmarker -object +string @@ -299,7 +1671,47 @@
Parameters:
- 		Options for the requestDefines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ + @@ -373,7 +1785,7 @@
Parameters:
Source:
@@ -413,7 +1825,7 @@
Returns:
-Promise.<schemas.ShieldInformationBarrierSegment> +Promise.<object>
@@ -431,7 +1843,7 @@
Returns:
-

deleteById(options, callbackopt) → {Promise.<void>}

+

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

@@ -439,10 +1851,9 @@

deleteById<
- Delete shield information barrier segment + Get shield information barrier segment with specified ID -Deletes the shield information barrier segment -based on provided ID. +Retrieves shield information barrier segment based on provided ID..
@@ -627,7 +2038,7 @@

Properties
Source:
@@ -667,7 +2078,7 @@
Returns:
-Promise.<void> +Promise.<schemas.ShieldInformationBarrierSegment>
@@ -685,7 +2096,7 @@
Returns:
-

getAll(options, callbackopt) → {Promise.<object>}

+

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

@@ -693,10 +2104,9 @@

getAll - List shield information barrier segments + Get shield information barrier segment with specified ID -Retrieves a list of shield information barrier segment objects -for the specified Information Barrier ID. +Retrieves shield information barrier segment based on provided ID.. @@ -772,8 +2182,6 @@
Properties
Type - Attributes - @@ -786,38 +2194,7 @@
Properties
- shield_information_barrier_id - - - - - -string - - - - - - - - - - - - - - - - - - The ID of the shield information barrier. - - - - - - - marker + shield_information_barrier_segment_id @@ -830,53 +2207,10 @@
Properties
- - - <optional>
- - - - - - - - - - - Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. - - - - - - - limit - - - - - -number - - - - - - - - - <optional>
- - - - - - - - The maximum number of items to return per page. + The ID of the shield information barrier segment. @@ -957,7 +2291,7 @@
Properties
Source:
@@ -997,7 +2331,7 @@
Returns:
-Promise.<object> +Promise.<schemas.ShieldInformationBarrierSegment>
@@ -1015,7 +2349,7 @@
Returns:
-

getById(options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

+

update(body, options, callbackopt) → {Promise.<schemas.ShieldInformationBarrierSegment>}

@@ -1023,9 +2357,9 @@

getById - Get shield information barrier segment with specified ID + Update shield information barrier segment with specified ID -Retrieves shield information barrier segment based on provided ID.. +Updates the shield information barrier segment based on provided ID.. @@ -1061,6 +2395,37 @@
Parameters:
+ + + body + + + + + +object + + + + + + + + + + + + + + + + + + + + + + options @@ -1210,7 +2575,7 @@
Properties
Source:
@@ -1494,7 +2859,7 @@
Properties
Source:
@@ -1562,13 +2927,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html new file mode 100644 index 00000000..f39f472d --- /dev/null +++ b/docs/jsdoc/ShieldInformationBarrierSegmentsManager_ShieldInformationBarrierSegmentsManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: ShieldInformationBarrierSegmentsManager + + + + + + + + + + +
+ +

Class: ShieldInformationBarrierSegmentsManager

+ + + + + + +
+ +
+ +

+ ShieldInformationBarrierSegmentsManager#ShieldInformationBarrierSegmentsManager(client)

+ + +
+ +
+
+ + + + + + +

new ShieldInformationBarrierSegmentsManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/SignRequest.html b/docs/jsdoc/SignRequest.html index 5afeca30..68054be9 100644 --- a/docs/jsdoc/SignRequest.html +++ b/docs/jsdoc/SignRequest.html @@ -74,7 +74,7 @@

SignRequest

Source:
@@ -162,7 +162,7 @@
Type:
Source:
@@ -235,7 +235,7 @@
Type:
Source:
@@ -310,7 +310,7 @@
Type:
Source:
@@ -384,7 +384,7 @@
Type:
Source:
@@ -457,7 +457,7 @@
Type:
Source:
@@ -529,7 +529,7 @@
Type:
Source:
@@ -602,7 +602,7 @@
Type:
Source:
@@ -674,7 +674,7 @@
Type:
Source:
@@ -774,7 +774,7 @@
Type:
Source:
@@ -847,7 +847,7 @@
Type:
Source:
@@ -881,13 +881,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestBase.html b/docs/jsdoc/SignRequestBase.html index cfbad4e5..1c1667f9 100644 --- a/docs/jsdoc/SignRequestBase.html +++ b/docs/jsdoc/SignRequestBase.html @@ -74,7 +74,7 @@

SignRequestBase

Source:
@@ -162,7 +162,7 @@
Type:
Source:
@@ -240,7 +240,7 @@
Type:
Source:
@@ -313,7 +313,7 @@
Type:
Source:
@@ -386,7 +386,7 @@
Type:
Source:
@@ -459,7 +459,7 @@
Type:
Source:
@@ -532,7 +532,7 @@
Type:
Source:
@@ -605,7 +605,7 @@
Type:
Source:
@@ -678,7 +678,7 @@
Type:
Source:
@@ -751,7 +751,7 @@
Type:
Source:
@@ -824,7 +824,7 @@
Type:
Source:
@@ -898,7 +898,7 @@
Type:
Source:
@@ -970,7 +970,7 @@
Type:
Source:
@@ -1043,7 +1043,7 @@
Type:
Source:
@@ -1077,13 +1077,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateRequest.html b/docs/jsdoc/SignRequestCreateRequest.html index 1ef2f474..819e21a9 100644 --- a/docs/jsdoc/SignRequestCreateRequest.html +++ b/docs/jsdoc/SignRequestCreateRequest.html @@ -74,7 +74,7 @@

SignRequestCreateRequest

Source:
@@ -168,7 +168,7 @@
Type:
Source:
@@ -241,7 +241,7 @@
Type:
Source:
@@ -316,7 +316,7 @@
Type:
Source:
@@ -350,13 +350,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestCreateSigner.html b/docs/jsdoc/SignRequestCreateSigner.html index ab032bfd..faa6c630 100644 --- a/docs/jsdoc/SignRequestCreateSigner.html +++ b/docs/jsdoc/SignRequestCreateSigner.html @@ -74,7 +74,7 @@

SignRequestCreateSigner

Source:
@@ -165,7 +165,7 @@
Type:
Source:
@@ -238,7 +238,7 @@
Type:
Source:
@@ -312,7 +312,7 @@
Type:
Source:
@@ -386,7 +386,7 @@
Type:
Source:
@@ -462,7 +462,7 @@
Type:
Source:
@@ -535,7 +535,7 @@
Type:
Source:
@@ -609,7 +609,7 @@
Type:
Source:
@@ -687,7 +687,7 @@
Type:
Source:
@@ -774,7 +774,7 @@
Type:
Source:
@@ -848,7 +848,7 @@
Type:
Source:
@@ -882,13 +882,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestPrefillTag.html b/docs/jsdoc/SignRequestPrefillTag.html index dc0eb4b6..06c21416 100644 --- a/docs/jsdoc/SignRequestPrefillTag.html +++ b/docs/jsdoc/SignRequestPrefillTag.html @@ -75,7 +75,7 @@

SignRequestPrefillTag

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -309,7 +309,7 @@
Type:
Source:
@@ -382,7 +382,7 @@
Type:
Source:
@@ -416,13 +416,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSigner.html b/docs/jsdoc/SignRequestSigner.html index 7f9f90a7..7673c6c8 100644 --- a/docs/jsdoc/SignRequestSigner.html +++ b/docs/jsdoc/SignRequestSigner.html @@ -74,7 +74,7 @@

SignRequestSigner

Source:
@@ -162,7 +162,7 @@
Type:
Source:
@@ -235,7 +235,7 @@
Type:
Source:
@@ -307,7 +307,7 @@
Type:
Source:
@@ -341,13 +341,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestSignerInput.html b/docs/jsdoc/SignRequestSignerInput.html index 9060113d..d83ddf4c 100644 --- a/docs/jsdoc/SignRequestSignerInput.html +++ b/docs/jsdoc/SignRequestSignerInput.html @@ -74,7 +74,7 @@

SignRequestSignerInput

Source:
@@ -198,7 +198,7 @@
Type:
Source:
@@ -271,7 +271,7 @@
Type:
Source:
@@ -353,7 +353,7 @@
Type:
Source:
@@ -387,13 +387,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequests.html b/docs/jsdoc/SignRequests.html index 70868e8c..c5776c0d 100644 --- a/docs/jsdoc/SignRequests.html +++ b/docs/jsdoc/SignRequests.html @@ -75,7 +75,7 @@

SignRequests

Source:
@@ -165,7 +165,7 @@
Type:
Source:
@@ -238,7 +238,7 @@
Type:
Source:
@@ -311,7 +311,7 @@
Type:
Source:
@@ -345,13 +345,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager.html b/docs/jsdoc/SignRequestsManager.html index 6800c7a8..f169256e 100644 --- a/docs/jsdoc/SignRequestsManager.html +++ b/docs/jsdoc/SignRequestsManager.html @@ -180,6 +180,13 @@
Parameters:
+

Classes

+ +
+
SignRequestsManager
+
+
+ @@ -198,7 +205,1290 @@

Methods

-

cancelById(options, callbackopt) → {Promise.<schemas.SignRequest>}

+

cancelById(options, callbackopt) → {Promise.<schemas.SignRequest>}

+ + + + + + +
+ Cancel sign request + +Cancels a sign request. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sign_request_id + + +string + + + + The ID of the sign request
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.SignRequest> + + +
+
+ + + + + + + + + + + + + +

cancelById(options, callbackopt) → {Promise.<schemas.SignRequest>}

+ + + + + + +
+ Cancel sign request + +Cancels a sign request. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + + + + + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
sign_request_id + + +string + + + + The ID of the sign request
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.SignRequest> + + +
+
+ + + + + + + + + + + + + +

create(body, optionsopt, callbackopt) → {Promise.<schemas.SignRequest>}

+ + + + + + +
+ Create sign request + +Creates a sign request. This involves preparing a document for signing and +sending the sign request to signers. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.SignRequestCreateRequest + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.SignRequest> + + +
+
+ + + + + + + + + + + + + +

create(body, optionsopt, callbackopt) → {Promise.<schemas.SignRequest>}

+ + + + + + +
+ Create sign request + +Creates a sign request. This involves preparing a document for signing and +sending the sign request to signers. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
body + + +schemas.SignRequestCreateRequest + + + + + + + + + +
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.SignRequest> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<schemas.SignRequests>}

+ + + + + + +
+ List sign requests + +Gets sign requests created by a user. If the `sign_files` and/or +`parent_folder` are deleted, the sign request will not return in the list. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +object + + + + + + <optional>
+ + + + + + 		Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
marker + + +string + + + + + + <optional>
+ + + + + + 		Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit + + +number + + + + + + <optional>
+ + + + + + 		The maximum number of items to return per page.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the result if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the result or rejecting with an error +
+ + + +
+
+ Type +
+
+ +Promise.<schemas.SignRequests> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<schemas.SignRequests>}

@@ -206,9 +1496,10 @@

cancelById<
- Cancel sign request + List sign requests -Cancels a sign request. +Gets sign requests created by a user. If the `sign_files` and/or +`parent_folder` are deleted, the sign request will not return in the list.
@@ -261,6 +1552,8 @@

Parameters:
+ <optional>
+ @@ -284,6 +1577,8 @@
Properties
Type + Attributes + @@ -296,7 +1591,7 @@
Properties
- sign_request_id + marker @@ -309,10 +1604,53 @@
Properties
+ + + <optional>
+ + + + + - The ID of the sign request + + + Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. + + + + + + + limit + + + + + +number + + + + + + + + + <optional>
+ + + + + + + + + + + The maximum number of items to return per page. @@ -393,7 +1731,7 @@
Properties
Source:
@@ -433,7 +1771,7 @@
Returns:
-Promise.<schemas.SignRequest> +Promise.<schemas.SignRequests>
@@ -451,7 +1789,7 @@
Returns:
-

create(body, optionsopt, callbackopt) → {Promise.<schemas.SignRequest>}

+

getById(options, callbackopt) → {Promise.<schemas.SignRequest>}

@@ -459,10 +1797,9 @@

create - Create sign request + Get sign request by ID -Creates a sign request. This involves preparing a document for signing and -sending the sign request to signers. +Gets a sign request by ID. @@ -500,13 +1837,13 @@
Parameters:
- body + options -schemas.SignRequestCreateRequest +object @@ -524,40 +1861,56 @@
Parameters:
- - + Options for the request +
Properties
+ + + + + + + + + + + + + + + + + + + - + - - + + - + + +
NameTypeDescription
optionssign_request_id -object +string - - <optional>
- - - - - 		The ID of the sign request
Options for the request
+ + @@ -631,7 +1984,7 @@
Parameters:
Source:
@@ -689,7 +2042,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<schemas.SignRequests>}

+

getById(options, callbackopt) → {Promise.<schemas.SignRequest>}

@@ -697,10 +2050,9 @@

getAll - List sign requests + Get sign request by ID -Gets sign requests created by a user. If the `sign_files` and/or -`parent_folder` are deleted, the sign request will not return in the list. +Gets a sign request by ID. @@ -753,8 +2105,6 @@
Parameters:
- <optional>
- @@ -778,8 +2128,6 @@
Properties
Type - Attributes - @@ -792,7 +2140,7 @@
Properties
- marker + sign_request_id @@ -805,53 +2153,10 @@
Properties
- - - <optional>
- - - - - - - - - - - Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`. - - - - - - - limit - - - - - -number - - - - - - - - - <optional>
- - - - - - - - The maximum number of items to return per page. + The ID of the sign request @@ -932,7 +2237,7 @@
Properties
Source:
@@ -972,7 +2277,7 @@
Returns:
-Promise.<schemas.SignRequests> +Promise.<schemas.SignRequest>
@@ -990,7 +2295,7 @@
Returns:
-

getById(options, callbackopt) → {Promise.<schemas.SignRequest>}

+

resendById(options, callbackopt) → {Promise.<void>}

@@ -998,9 +2303,9 @@

getById - Get sign request by ID + Resend sign request -Gets a sign request by ID. +Resends a sign request email to all outstanding signers. @@ -1185,7 +2490,7 @@
Properties
Source:
@@ -1225,7 +2530,7 @@
Returns:
-Promise.<schemas.SignRequest> +Promise.<void>
@@ -1438,7 +2743,7 @@
Properties
Source:
@@ -1506,13 +2811,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/SignRequestsManager_SignRequestsManager.html b/docs/jsdoc/SignRequestsManager_SignRequestsManager.html new file mode 100644 index 00000000..f50bf536 --- /dev/null +++ b/docs/jsdoc/SignRequestsManager_SignRequestsManager.html @@ -0,0 +1,216 @@ + + + + + JSDoc: Class: SignRequestsManager + + + + + + + + + + +
+ +

Class: SignRequestsManager

+ + + + + + +
+ +
+ +

+ SignRequestsManager#SignRequestsManager(client)

+ + +
+ +
+
+ + + + + + +

new SignRequestsManager(client)

+ + + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
client + + +BoxClient + + + + The Box API Client that is responsible for making calls to the API
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time) +
+ + + + + \ No newline at end of file diff --git a/docs/jsdoc/StoragePolicies.html b/docs/jsdoc/StoragePolicies.html index 51b06da5..7ba0ebd3 100644 --- a/docs/jsdoc/StoragePolicies.html +++ b/docs/jsdoc/StoragePolicies.html @@ -391,7 +391,240 @@
Parameters:
Source:
+ + + + + + + +

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

assign(storagePolicyID, userID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Assign a storage policy to a user +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
storagePolicyID + + +string + + + + + + + + + + The ID of the storage policy to assign
userID + + +string + + + + + + + + + + The ID of the user to assign the storage policy to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment object if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -519,14 +752,1773 @@
Parameters:
- The ID of the storage policy to assign - + The ID of the storage policy to assign + + + + + + + userID + + + + + +string + + + + + + + + + + + + + + + + + + The ID of the user to assign the storage policy to + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + Passed the assignment object if successful + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

createAssignment(storagePolicyID, userID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Create a new storage policy assignment to a user +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
storagePolicyID + + +string + + + + + + + + + + The ID of the storage policy to assign
userID + + +string + + + + + + + + + + The ID of the user to assign the storage policy to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment object if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(storagePolicyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get information about a specific storage policy +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
storagePolicyID + + +string + + + + + + + + + + The ID of the storage policy
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields of the storage policy to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the storage policy object if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the storage policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(storagePolicyID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get information about a specific storage policy +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
storagePolicyID + + +string + + + + + + + + + + The ID of the storage policy
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields of the storage policy to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the storage policy object if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the storage policy object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all available storage policies for the enterprise +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields of the storage policy to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a collection of storage policies if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the collection of storage policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all available storage policies for the enterprise +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields of the storage policy to retrieve
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a collection of storage policies if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the collection of storage policies +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignment(assignmentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get information about a specific storage policy asisgnment by ID +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The ID of the assignment
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the assignment object if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAssignment(assignmentID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get information about a specific storage policy asisgnment by ID +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + - + + @@ -624,7 +2616,7 @@
Parameters:
Source:
@@ -682,7 +2674,7 @@
Returns:
-

get(storagePolicyID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignmentForTarget(targetID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -690,7 +2682,7 @@

get - Get information about a specific storage policy + Gets the storage policy assignment for a specific user @@ -728,7 +2720,7 @@
Parameters:

- + + @@ -803,6 +2795,8 @@
Properties
+ + @@ -813,7 +2807,7 @@
Properties
- + + - + @@ -879,7 +2879,7 @@
Properties
- + @@ -920,7 +2920,7 @@
Properties
Source:
@@ -949,7 +2949,7 @@
Returns:
- Promise resolving to the storage policy object + Promise resolving to the assignment object
@@ -978,7 +2978,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignmentForTarget(targetID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -986,7 +2986,7 @@

getAll - Get all available storage policies for the enterprise + Gets the storage policy assignment for a specific user @@ -1022,6 +3022,37 @@
Parameters:

+ + + + + + + + + + + + + + + + + + @@ -1068,6 +3099,8 @@
Properties
+ + @@ -1078,7 +3111,7 @@
Properties
- + + - + @@ -1144,7 +3183,7 @@
Properties
- + @@ -1185,7 +3224,7 @@
Properties
Source:
@@ -1214,7 +3253,7 @@
Returns:
- Promise resolving to the collection of storage policies + Promise resolving to the assignment object
@@ -1243,7 +3282,7 @@
Returns:
-

getAssignment(assignmentID, callbackopt) → {Promise.<Object>}

+

removeAssignment(assignmentID, callbackopt) → {Promise.<void>}

@@ -1251,7 +3290,7 @@

getAssig
- Get information about a specific storage policy asisgnment by ID + Remove a storage policy assignment, returning the user to the default policy
@@ -1313,7 +3352,7 @@

Parameters:
- + @@ -1346,7 +3385,7 @@
Parameters:
- + @@ -1387,7 +3426,7 @@
Parameters:
Source:
@@ -1416,7 +3455,7 @@
Returns:
- Promise resolving to the assignment object + Promise resolving if the removal succeeds
@@ -1427,7 +3466,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -1445,7 +3484,7 @@
Returns:
-

getAssignmentForTarget(targetID, optionsopt, callbackopt) → {Promise.<Object>}

+

removeAssignment(assignmentID, callbackopt) → {Promise.<void>}

@@ -1453,7 +3492,7 @@

- Gets the storage policy assignment for a specific user + Remove a storage policy assignment, returning the user to the default policy @@ -1491,94 +3530,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -1650,7 +3587,7 @@
Properties
- + @@ -1691,7 +3628,7 @@
Properties
Source:
@@ -1720,7 +3657,7 @@
Returns:
- Promise resolving to the assignment object + Promise resolving if the removal succeeds
@@ -1731,7 +3668,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -1749,7 +3686,7 @@
Returns:
-

removeAssignment(assignmentID, callbackopt) → {Promise.<void>}

+

updateAssignment(assignmentID, updates, callbackopt) → {Promise.<Object>}

@@ -1757,7 +3694,7 @@

remov
- Remove a storage policy assignment, returning the user to the default policy + Update a storage policy assignment
@@ -1819,7 +3756,38 @@

Parameters:
- + + + + + + + + + + + + + + + + + + + @@ -1852,7 +3820,7 @@
Parameters:
- + @@ -1893,7 +3861,7 @@
Parameters:
Source:
@@ -1922,7 +3890,7 @@
Returns:
- Promise resolving if the removal succeeds + Promise resolving to the updated assignment object
@@ -1933,7 +3901,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2126,7 +4094,7 @@
Parameters:
Source:
@@ -2194,13 +4162,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Tasks.html b/docs/jsdoc/Tasks.html index d2260291..978d11c5 100644 --- a/docs/jsdoc/Tasks.html +++ b/docs/jsdoc/Tasks.html @@ -264,7 +264,7 @@
Type:
Source:
@@ -470,7 +470,243 @@
Parameters:
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

assignByEmail(taskID, email, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Assign a task to a specific user by email address + +API Endpoint: '/task_assignments' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
userIDassignmentID @@ -550,7 +2542,7 @@
Parameters:
- 		The ID of the user to assign the storage policy toThe ID of the assignment
storagePolicyIDtargetID @@ -752,7 +2744,7 @@
Parameters:
- 		The ID of the storage policyThe ID of the target
DefaultDescription
fieldstargetType @@ -838,8 +2832,14 @@
Properties
+ 		+ + user + + Comma-separated list of fields of the storage policy to retrieveThe type of the assignment target to resolve for
Passed the storage policy object if successfulPassed the assignment object if successful
targetID + + +string + + + + + + + + + + The ID of the target
optionsDefaultDescription
fieldstargetType @@ -1103,8 +3136,14 @@
Properties
+ 		+ + user + + Comma-separated list of fields of the storage policy to retrieveThe type of the assignment target to resolve for
Passed a collection of storage policies if successfulPassed the assignment object if successful
The ID of the assignmentThe ID of the assignment to remove
Passed the assignment object if successfulPassed nothing if successful
targetID - - -string - - - - - - - - - - The ID of the target
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - -
NameTypeAttributesDefaultDescription
targetTypeassignmentID @@ -1593,8 +3545,6 @@
Properties
 - <optional>
- @@ -1603,21 +3553,8 @@
Properties
- 		- - user - - The type of the assignment target to resolve for
- 		The ID of the assignment to remove
Passed the assignment object if successfulPassed nothing if successful
The ID of the assignment to removeThe ID of the storage policy assignment to update
updates + + +Object + + + + + + + + + + The updates fields to apply
Passed nothing if successfulPassed the updated assignment object if successful
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task to assign
email + + +string + + + + + + + + + + The email address of the user to assign the task to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the task assignment if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -536,10 +772,2204 @@

assignB
- Assign a task to a specific user by ID + Assign a task to a specific user by ID + +API Endpoint: '/task_assignments' +Method: POST +
+ + + + + + + + + +

Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task to assign
userID + + +string + + + + + + + + + + The ID of the user to assign the task to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the task assignment if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

assignByUserID(taskID, userID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Assign a task to a specific user by ID + +API Endpoint: '/task_assignments' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task to assign
userID + + +string + + + + + + + + + + The ID of the user to assign the task to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the task assignment if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new assignment object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to create a single task for single user on a single file. + +API Endpoint: '/tasks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the item this task is for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
message + + +string + + + + + + <optional>
+ + + + + + 		An optional message to include with the task
due_at + + +string + + + + + + <optional>
+ + + + + + 		The day at which this task is due
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new task information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created task object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Used to create a single task for single user on a single file. + +API Endpoint: '/tasks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fileID + + +string + + + + + + + + + + The ID of the item this task is for
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
message + + +string + + + + + + <optional>
+ + + + + + 		An optional message to include with the task
due_at + + +string + + + + + + <optional>
+ + + + + + 		The day at which this task is due
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new task information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created task object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(taskID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Permanently deletes a specific task. + +API Endpoint: '/tasks/:taskID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task being deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

delete(taskID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Permanently deletes a specific task. + +API Endpoint: '/tasks/:taskID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task being deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a task assignment. This unassigns a user from the related task. + +API Endpoint: '/task_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the task assignment to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a task assignment. This unassigns a user from the related task. + +API Endpoint: '/task_assignments/:assignmentID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
assignmentID + + +string + + + + + + + + + + The Box ID of the task assignment to delete
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(taskID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a specific task. + +API Endpoint: '/tasks/:taskID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
taskID + + +string + + + + + + + + + + The Box ID of the task being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the task information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the task object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(taskID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Fetches a specific task. -API Endpoint: '/task_assignments' -Method: POST +API Endpoint: '/tasks/:taskID' +Method: GET
@@ -601,20 +3031,20 @@
Parameters:
- The Box ID of the task to assign + The Box ID of the task being requested - userID + options -string +Object @@ -623,6 +3053,8 @@
Parameters:
+ <optional>
+ @@ -632,7 +3064,7 @@
Parameters:
- The ID of the user to assign the task to + Additional options for the request. Can be left null in most cases. @@ -665,7 +3097,7 @@
Parameters:
- Passed the task assignment if successful, error otherwise + Passed the task information if it was acquired successfully, error otherwise @@ -706,7 +3138,7 @@
Parameters:
Source:
@@ -735,7 +3167,7 @@
Returns:
- A promise resolving to the new assignment object + A promise resolving to the task object
@@ -764,7 +3196,7 @@
Returns:
-

create(fileID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -772,10 +3204,10 @@

create - Used to create a single task for single user on a single file. + Get a specific task assignment -API Endpoint: '/tasks' -Method: POST +API Endpoint: '/task_assignments/:assignmentID' +Method: GET @@ -813,7 +3245,7 @@
Parameters:
- fileID + assignmentID @@ -837,7 +3269,7 @@
Parameters:
- The ID of the item this task is for + The Box ID of the task assignment to retrieve @@ -870,101 +3302,7 @@
Parameters:
- Additional parameters -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeAttributesDescription
message - - -string - - - - - - <optional>
- - - - - - 		An optional message to include with the task
due_at - - -string - - - - - - <optional>
- - - - - - 		The day at which this task is due
- - + Additional parameters, can be left null in most cases @@ -997,7 +3335,7 @@
Properties
- Passed the new task information if it was acquired successfully, error otherwise + Passed the task assignment if successful, error otherwise @@ -1038,7 +3376,7 @@
Properties
Source:
@@ -1067,7 +3405,7 @@
Returns:
- A promise resolving to the created task object + A promise resolving to the assignment object
@@ -1096,7 +3434,7 @@
Returns:
-

delete(taskID, callbackopt) → {Promise.<void>}

+

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1104,10 +3442,10 @@

delete - Permanently deletes a specific task. + Get a specific task assignment -API Endpoint: '/tasks/:taskID' -Method: DELETE +API Endpoint: '/task_assignments/:assignmentID' +Method: GET @@ -1145,7 +3483,7 @@
Parameters:
- taskID + assignmentID @@ -1169,7 +3507,40 @@
Parameters:
- The Box ID of the task being deleted + The Box ID of the task assignment to retrieve + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Additional parameters, can be left null in most cases @@ -1202,7 +3573,7 @@
Parameters:
- Empty body passed if successful, error otherwise + Passed the task assignment if successful, error otherwise @@ -1243,7 +3614,7 @@
Parameters:
Source:
@@ -1272,7 +3643,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the assignment object
@@ -1283,7 +3654,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1301,7 +3672,7 @@
Returns:
-

deleteAssignment(assignmentID, callbackopt) → {Promise.<void>}

+

getAssignments(taskID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1309,10 +3680,10 @@

delet
- Delete a task assignment. This unassigns a user from the related task. + Get a list of assignments for a given task -API Endpoint: '/task_assignments/:assignmentID' -Method: DELETE +API Endpoint: '/tasks/:taskID/assignments' +Method: GET
@@ -1350,7 +3721,7 @@

Parameters:
- assignmentID + taskID @@ -1374,7 +3745,40 @@
Parameters:
- The Box ID of the task assignment to delete + The Box ID of the task to get assignments for + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Additional parameters, can be left null in most cases @@ -1407,7 +3811,7 @@
Parameters:
- Passed nothing if successful, error otherwise + Passed the list of assignments if successful, error otherwise @@ -1448,7 +3852,7 @@
Parameters:
Source:
@@ -1477,7 +3881,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the collection of assignment objects
@@ -1488,7 +3892,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1506,7 +3910,7 @@
Returns:
-

get(taskID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAssignments(taskID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1514,9 +3918,9 @@

get - Fetches a specific task. + Get a list of assignments for a given task -API Endpoint: '/tasks/:taskID' +API Endpoint: '/tasks/:taskID/assignments' Method: GET @@ -1579,7 +3983,7 @@
Parameters:
- The Box ID of the task being requested + The Box ID of the task to get assignments for @@ -1612,7 +4016,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Additional parameters, can be left null in most cases @@ -1645,7 +4049,7 @@
Parameters:
- Passed the task information if it was acquired successfully, error otherwise + Passed the list of assignments if successful, error otherwise @@ -1686,7 +4090,7 @@
Parameters:
Source:
@@ -1715,7 +4119,7 @@
Returns:
- A promise resolving to the task object + A promise resolving to the collection of assignment objects
@@ -1744,7 +4148,7 @@
Returns:
-

getAssignment(assignmentID, optionsopt, callbackopt) → {Promise.<Object>}

+

update(taskID, updates, callbackopt) → {Promise.<Object>}

@@ -1752,10 +4156,10 @@

getAssig
- Get a specific task assignment + Updates a specific task. -API Endpoint: '/task_assignments/:assignmentID' -Method: GET +API Endpoint: '/tasks/:taskID' +Method: PUT
@@ -1793,7 +4197,7 @@

Parameters:
- assignmentID + taskID @@ -1817,14 +4221,14 @@
Parameters:
- The Box ID of the task assignment to retrieve + The Box ID of the task being updated - options + updates @@ -1834,6 +4238,58 @@
Parameters:
+ + + + + + + + + + + + + + + Fields of the task object to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1850,7 +4306,47 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
message + + +string + + + Additional parameters, can be left null in most casesAn optional message to include with the task
due_at + + +string + + + + + + <optional>
+ + + + + + 		The day at which this task is due
+ + @@ -1883,7 +4379,7 @@
Parameters:
- Passed the task assignment if successful, error otherwise + Passed the updated task information if it was acquired successfully, error otherwise @@ -1924,7 +4420,7 @@
Parameters:
Source:
@@ -1953,7 +4449,7 @@
Returns:
- A promise resolving to the assignment object + A promise resolving to the updated task object
@@ -1982,7 +4478,7 @@
Returns:
-

getAssignments(taskID, optionsopt, callbackopt) → {Promise.<Object>}

+

update(taskID, updates, callbackopt) → {Promise.<Object>}

@@ -1990,10 +4486,10 @@

getAssi
- Get a list of assignments for a given task + Updates a specific task. -API Endpoint: '/tasks/:taskID/assignments' -Method: GET +API Endpoint: '/tasks/:taskID' +Method: PUT
@@ -2055,14 +4551,14 @@

Parameters:
- The Box ID of the task to get assignments for + The Box ID of the task being updated - options + updates @@ -2072,6 +4568,58 @@
Parameters:
+ + + + + + + + + + + + + + + Fields of the task object to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2088,7 +4636,47 @@
Parameters:
- + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
message + + +string + + + Additional parameters, can be left null in most casesAn optional message to include with the task
due_at + + +string + + + + + + <optional>
+ + + + + + 		The day at which this task is due
+ + @@ -2121,7 +4709,7 @@
Parameters:
- Passed the list of assignments if successful, error otherwise + Passed the updated task information if it was acquired successfully, error otherwise @@ -2162,7 +4750,7 @@
Parameters:
Source:
@@ -2191,7 +4779,7 @@
Returns:
- A promise resolving to the collection of assignment objects + A promise resolving to the updated task object
@@ -2220,7 +4808,7 @@
Returns:
-

update(taskID, updates, callbackopt) → {Promise.<Object>}

+

updateAssignment(assignmentID, options, callbackopt) → {Promise.<Object>}

@@ -2228,9 +4816,9 @@

update - Updates a specific task. + Update a task assignment. This is used to resolve or complete a task. -API Endpoint: '/tasks/:taskID' +API Endpoint: '/task_assignments/:assignmentID' Method: PUT @@ -2269,7 +4857,7 @@
Parameters:
- taskID + assignmentID @@ -2293,14 +4881,14 @@
Parameters:
- The Box ID of the task being updated + The Box ID of the task assignment to update - updates + options @@ -2324,7 +4912,7 @@
Parameters:
- Fields of the task object to update + The fields of the assignment to update
Properties
@@ -2378,20 +4966,20 @@
Properties
- An optional message to include with the task + A message from the assignee about this task - due_at + resolution_state -string +TaskResolutionState @@ -2411,7 +4999,7 @@
Properties
- The day at which this task is due + Resolution of the task @@ -2451,7 +5039,7 @@
Properties
- Passed the updated task information if it was acquired successfully, error otherwise + Passed the updated task assignment if successful, error otherwise @@ -2492,7 +5080,7 @@
Properties
Source:
@@ -2521,7 +5109,7 @@
Returns:
- A promise resolving to the updated task object + A promise resolving to the updated assignment object
@@ -2822,7 +5410,7 @@
Properties
Source:
@@ -2890,13 +5478,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TermsOfService.html b/docs/jsdoc/TermsOfService.html index fbcea8d7..54778626 100644 --- a/docs/jsdoc/TermsOfService.html +++ b/docs/jsdoc/TermsOfService.html @@ -246,7 +246,7 @@
Type:
Source:
@@ -318,7 +318,7 @@
Type:
Source:
@@ -555,7 +555,7 @@
Parameters:
Source:
@@ -613,7 +613,7 @@
Returns:
-

createUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

+

create(termsOfServicesType, termsOfServicesStatus, termsOfServicesText, callbackopt) → {Promise.<Object>}

@@ -621,9 +621,9 @@

creat
- Accepts/rejects custom terms of services for the user + Creates a custom terms of services with user specified values -API Endpoint: '/terms_of_service_user_statuses' +API Endpoint: '/terms_of_services' Method: POST
@@ -662,13 +662,13 @@

Parameters:
- termsOfServicesID + termsOfServicesType -string +TermsOfServicesType @@ -686,20 +686,20 @@
Parameters:
- Terms of services ID to retrieve user statuses on + Determine if the custom terms of service is scoped internall or externally to an enterprise - isAccepted + termsOfServicesStatus -boolean +TermsOfServicesStatus @@ -717,68 +717,14 @@
Parameters:
- Determines wehether the terms of services has been accepted or rejected + Determine if the custom terms of service is enabled or disabled - options - - - - - -Object - - - - - - - - - <optional>
- - - - - - - - - - - Additional options. Can be left null in most cases. -
Properties
- - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - -
NameTypeAttributesDescription
user_idtermsOfServicesText @@ -793,8 +739,6 @@
Properties
 - <optional>
- @@ -804,14 +748,7 @@
Properties
- 		Optional, user id to retrieve terms of service status on, default is current user
- - + Text field for message associated with custom terms of services @@ -844,7 +781,7 @@
Properties
- Passed the terms of service user status information if successful, error otherwise + Passed the terms of services information if successful, error otherwise @@ -885,7 +822,7 @@
Properties
Source:
@@ -914,7 +851,7 @@
Returns:
- A promise resolving to the terms of service user status + A promise resolving to the terms of services object
@@ -943,7 +880,7 @@
Returns:
-

get(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

+

createUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

@@ -951,10 +888,10 @@

get - Gets a specific custom terms of services with specified ID + Accepts/rejects custom terms of services for the user -API Endpoint: '/terms_of_services/:termsOfServicesID' -Method: GET +API Endpoint: '/terms_of_service_user_statuses' +Method: POST @@ -1016,7 +953,38 @@
Parameters:
- The id of the custom terms of services to retrieve + Terms of services ID to retrieve user statuses on + + + + + + + isAccepted + + + + + +boolean + + + + + + + + + + + + + + + + + + Determines wehether the terms of services has been accepted or rejected @@ -1077,7 +1045,7 @@
Properties
- fields + user_id @@ -1103,7 +1071,7 @@
Properties
- Comma-separated list of fields to return on the collaboration objects + Optional, user id to retrieve terms of service status on, default is current user @@ -1143,7 +1111,7 @@
Properties
- Passed the terms of services information with specified ID if successful, error otherwise + Passed the terms of service user status information if successful, error otherwise @@ -1184,7 +1152,7 @@
Properties
Source:
@@ -1213,7 +1181,7 @@
Returns:
- A promise resolving to the terms of services object + A promise resolving to the terms of service user status
@@ -1242,7 +1210,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

createUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1250,10 +1218,10 @@

getAll - Gets custom terms of services for the user's enterprise + Accepts/rejects custom terms of services for the user -API Endpoint: '/terms_of_services' -Method: GET +API Endpoint: '/terms_of_service_user_statuses' +Method: POST @@ -1291,13 +1259,13 @@
Parameters:
- options + termsOfServicesID -Object +string @@ -1306,8 +1274,6 @@
Parameters:
- <optional>
- @@ -1317,41 +1283,51 @@
Parameters:
- Additional options. Can be left null in most cases. -
Properties
+ Terms of services ID to retrieve user statuses on + + + + + + + isAccepted + + + + +boolean - - - - - - - + + - - - + + - - + + + + + + + + - - + - + - + + @@ -762,7 +2573,7 @@
Parameters:
Source:
@@ -820,7 +2631,7 @@
Returns:
-

getTokensClientCredentialsGrant(optionsopt) → {Promise.<TokenInfo>}

+

isAccessTokenValid(tokenInfo, bufferMSopt) → {boolean}

@@ -828,7 +2639,9 @@

- Acquires token info using the client credentials grant. + Given a TokenInfo object, returns whether its access token is expired. An access token is considered +expired once its TTL surpasses the current time outside of the given buffer. This is a public method so +that other modules may check the validity of their tokens. @@ -866,13 +2679,44 @@
Parameters:

- + + + + + + + + + + + + + + + + + + + + @@ -933,7 +2778,7 @@
Parameters:
Source:
@@ -962,7 +2807,7 @@
Returns:
- Promise resolving to the token info + True if token is valid outside of buffer, otherwise false
@@ -973,7 +2818,7 @@
Returns:
-Promise.<TokenInfo> +boolean
@@ -991,7 +2836,7 @@
Returns:
-

getTokensJWTGrant(type, id, optionsopt) → {Promise.<TokenInfo>}

+

isAccessTokenValid(tokenInfo, bufferMSopt) → {boolean}

@@ -999,7 +2844,9 @@

getT
- Gets tokens for enterprise administration of app users + Given a TokenInfo object, returns whether its access token is expired. An access token is considered +expired once its TTL surpasses the current time outside of the given buffer. This is a public method so +that other modules may check the validity of their tokens.
@@ -1037,44 +2884,13 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + + - + + @@ -1166,7 +2983,7 @@
Parameters:
Source:
@@ -1195,7 +3012,7 @@
Returns:
- Promise resolving to the token info + True if token is valid outside of buffer, otherwise false
@@ -1206,7 +3023,7 @@
Returns:
-Promise.<TokenInfo> +boolean
@@ -1224,7 +3041,7 @@
Returns:
-

getTokensRefreshGrant(refreshToken, optionsopt) → {Promise.<TokenInfo>}

+

retryJWTGrant(claims, jwtOptionsopt, keyParams, params, optionsopt, error, numRetries) → {Promise.<TokenInfo>}

@@ -1232,7 +3049,8 @@

- Refreshes the access and refresh tokens for a given refresh token. + Attempt a retry if possible and create a new JTI claim. If the request hasn't exceeded it's maximum number of retries, +re-execute the request (after the retry interval). Otherwise, propagate a new error.
@@ -1270,13 +3088,13 @@

Parameters:
- + + - + + - -
NameTypeAttributes + - + - Description
Determines wehether the terms of services has been accepted or rejected
tos_typeoptions -TermsOfServiceType +Object @@ -1371,14 +1347,35 @@
Properties
- 		Optional, indicates whether the terms of service is set for external or managed under enterprise
Additional options. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + - + + @@ -1444,7 +1441,7 @@
Properties
- + @@ -1485,7 +1482,7 @@
Properties
Source:
@@ -1514,7 +1511,7 @@
Returns:
- A promise resolving to the terms of services object + A promise resolving to the terms of service user status
@@ -1543,7 +1540,7 @@
Returns:
-

getUserStatus(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

+

get(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1551,9 +1548,9 @@

getUserS
- Gets a terms os service status given the terms of services id + Gets a specific custom terms of services with specified ID -API Endpoint: '/terms_of_service_user_statuses' +API Endpoint: '/terms_of_services/:termsOfServicesID' Method: GET
@@ -1616,7 +1613,7 @@

Parameters:
- + @@ -1649,7 +1646,7 @@
Parameters:
- - + + @@ -1743,7 +1740,7 @@
Properties
- + @@ -1784,7 +1781,7 @@
Properties
Source:
@@ -1813,7 +1810,7 @@
Returns:
- A promise resolving to the terms of service user status + A promise resolving to the terms of services object
@@ -1842,7 +1839,7 @@
Returns:
-

setUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

+

get(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -1850,10 +1847,10 @@

setUserS
- Creates a user status for terms of service, if already exists then update existing user status for terms of service + Gets a specific custom terms of services with specified ID -API Endpoint: '/terms_of_service_user_statuses' -Method: POST/PUT +API Endpoint: '/terms_of_services/:termsOfServicesID' +Method: GET
@@ -1915,38 +1912,7 @@

Parameters:
- - - - - - - - - - - - - - - - - - - + @@ -2007,7 +1973,7 @@
Properties
- + + @@ -2073,7 +2039,7 @@
Properties
- + @@ -2114,7 +2080,7 @@
Properties
Source:
@@ -2143,7 +2109,7 @@
Returns:
- A promise resolving to the terms of service user status + A promise resolving to the terms of services object
@@ -2172,7 +2138,7 @@
Returns:
-

update(termsOfServicesID, updates, callbackopt) → {Promise.<Object>}

+

getAll(optionsopt, callbackopt) → {Promise.<Object>}

@@ -2180,10 +2146,10 @@

update - Updates a custom terms of services with new specified values + Gets custom terms of services for the user's enterprise -API Endpoint: '/terms_of_services/:termsOfServicesID' -Method: PUT +API Endpoint: '/terms_of_services' +Method: GET @@ -2221,38 +2187,7 @@
Parameters:

- - - - - - - - - - - - - - - - - - - + - + + - + + @@ -2403,7 +2340,7 @@
Properties
- + @@ -2444,7 +2381,7 @@
Properties
Source:
@@ -2502,6 +2439,2461 @@
Returns:
+

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Gets custom terms of services for the user's enterprise + +API Endpoint: '/terms_of_services' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + +
NameTypeAttributesDescription
fieldsuser_id @@ -1404,7 +1401,7 @@
Properties
- 		Comma-separated list of fields to return on the collaboration objectsOptional, user id to retrieve terms of service status on, default is current user
Passed the terms of services information if successful, error otherwisePassed the terms of service user status information if successful, error otherwise
The ID of the terms of services to retrieve status onThe id of the custom terms of services to retrieve
Additional options. Can be left null in most cases + Additional options. Can be left null in most cases.
Properties
@@ -1677,7 +1674,7 @@
Properties
user_idfields @@ -1703,7 +1700,7 @@
Properties
- 		Optional, the id of the user to retrieve status of custom terms and service onComma-separated list of fields to return on the collaboration objects
Passed the terms of service user status information if successful, error otherwisePassed the terms of services information with specified ID if successful, error otherwise
Terms of services ID to retrieve user statuses on
isAccepted - - -boolean - - - - - - - - - - Determines wehether the terms of services has been accepted or rejectedThe id of the custom terms of services to retrieve
user_idfields @@ -2033,7 +1999,7 @@
Properties
- 		Optional, user id to retrieve terms of service status on, default is current userComma-separated list of fields to return on the collaboration objects
Passed the terms of service user status information if successful, error otherwisePassed the terms of services information with specified ID if successful, error otherwise
termsOfServicesID - - -string - - - - - - - - - - The id of the custom terms of services to update
updatesoptions @@ -2267,6 +2202,8 @@
Parameters:
 + <optional>
+ @@ -2276,7 +2213,7 @@
Parameters:
- 		Fields ot the Terms of Service to update + Additional options. Can be left null in most cases.
Properties
@@ -2304,13 +2241,13 @@
Properties
statustos_type -TermsOfServicesStatus +TermsOfServiceType @@ -2330,14 +2267,14 @@
Properties
- 		Determine if the custom terms of service is scoped internall or externally to an enterpriseOptional, indicates whether the terms of service is set for external or managed under enterprise
textfields @@ -2363,7 +2300,7 @@
Properties
- 		Text field for message associated with custom terms of servicesComma-separated list of fields to return on the collaboration objects
Passed the terms of services updated information if successful, error otherwisePassed the terms of services information if successful, error otherwise
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tos_type + + +TermsOfServiceType + + + + + + <optional>
+ + + + + + 		Optional, indicates whether the terms of service is set for external or managed under enterprise
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-separated list of fields to return on the collaboration objects
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of services information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of services object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUserStatus(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Gets a terms os service status given the terms of services id + +API Endpoint: '/terms_of_service_user_statuses' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + The ID of the terms of services to retrieve status on
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
user_id + + +string + + + + + + <optional>
+ + + + + + 		Optional, the id of the user to retrieve status of custom terms and service on
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of service user status information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of service user status +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getUserStatus(termsOfServicesID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Gets a terms os service status given the terms of services id + +API Endpoint: '/terms_of_service_user_statuses' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + The ID of the terms of services to retrieve status on
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
user_id + + +string + + + + + + <optional>
+ + + + + + 		Optional, the id of the user to retrieve status of custom terms and service on
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of service user status information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of service user status +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

setUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Creates a user status for terms of service, if already exists then update existing user status for terms of service + +API Endpoint: '/terms_of_service_user_statuses' +Method: POST/PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + Terms of services ID to retrieve user statuses on
isAccepted + + +boolean + + + + + + + + + + Determines wehether the terms of services has been accepted or rejected
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
user_id + + +string + + + + + + <optional>
+ + + + + + 		Optional, user id to retrieve terms of service status on, default is current user
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of service user status information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of service user status +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

setUserStatus(termsOfServicesID, isAccepted, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Creates a user status for terms of service, if already exists then update existing user status for terms of service + +API Endpoint: '/terms_of_service_user_statuses' +Method: POST/PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + Terms of services ID to retrieve user statuses on
isAccepted + + +boolean + + + + + + + + + + Determines wehether the terms of services has been accepted or rejected
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
user_id + + +string + + + + + + <optional>
+ + + + + + 		Optional, user id to retrieve terms of service status on, default is current user
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of service user status information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of service user status +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

update(termsOfServicesID, updates, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Updates a custom terms of services with new specified values + +API Endpoint: '/terms_of_services/:termsOfServicesID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + The id of the custom terms of services to update
updates + + +Object + + + + + + + + + + Fields ot the Terms of Service to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
status + + +TermsOfServicesStatus + + + + + + <optional>
+ + + + + + 		Determine if the custom terms of service is scoped internall or externally to an enterprise
text + + +string + + + + + + <optional>
+ + + + + + 		Text field for message associated with custom terms of services
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of services updated information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of services object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

update(termsOfServicesID, updates, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Updates a custom terms of services with new specified values + +API Endpoint: '/terms_of_services/:termsOfServicesID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServicesID + + +string + + + + + + + + + + The id of the custom terms of services to update
updates + + +Object + + + + + + + + + + Fields ot the Terms of Service to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
status + + +TermsOfServicesStatus + + + + + + <optional>
+ + + + + + 		Determine if the custom terms of service is scoped internall or externally to an enterprise
text + + +string + + + + + + <optional>
+ + + + + + 		Text field for message associated with custom terms of services
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of services updated information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the terms of services object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

updateUserStatus(termsOfServiceUserStatusID, isAccepted, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Accepts/rejects custom terms of services for the user + +API Endpoint: '/terms_of_service_user_statuses' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
termsOfServiceUserStatusID + + +string + + + + + + + + + + Terms of service user status object ID
isAccepted + + +boolean + + + + + + + + + + Determines wehether the terms of services has been accepted or rejected
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the terms of service user status updated information if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated terms of service user status +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + +

updateUserStatus(termsOfServiceUserStatusID, isAccepted, callbackopt) → {Promise.<Object>}

@@ -2680,7 +5072,7 @@
Parameters:
Source:
@@ -2748,13 +5140,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/TokenManager.html b/docs/jsdoc/TokenManager.html index 7e08c468..e89d9a86 100644 --- a/docs/jsdoc/TokenManager.html +++ b/docs/jsdoc/TokenManager.html @@ -560,7 +560,7 @@
Properties
Source:
@@ -618,6 +618,605 @@
Returns:
+

exchangeToken(accessToken, scopes, resourceopt, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Exchange a valid access token for one with a lower scope, or delegated to +an external user identifier. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
accessToken + + +string + + + + + + + + + + The valid access token to exchange
scopes + + +string +| + +Array.<string> + + + + + + + + + + The scope(s) of the new access token
resource + + +string + + + + + + <optional>
+ + + + + + 		The absolute URL of an API resource to restrict the new token to
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
tokenRequestOptions + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
actor + + +ActorParams + + + + + + <optional>
+ + + + + + 		Optional actor parameters for creating annotator tokens
sharedLink + + +SharedLinkParams + + + + + + <optional>
+ + + + + + 		Optional shared link parameters for creating tokens using shared links
+ +
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the new token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensAuthorizationCodeGrant(authorizationCode, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Acquires token info using an authorization code +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
authorizationCode + + +string + + + + + + + + + + authorization code issued by Box
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + +

getTokensAuthorizationCodeGrant(authorizationCode, optionsopt) → {Promise.<TokenInfo>}

@@ -626,7 +1225,1219 @@

- Acquires token info using an authorization code + Acquires token info using an authorization code + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
authorizationCode + + +string + + + + + + + + + + authorization code issued by Box
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensClientCredentialsGrant(optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Acquires token info using the client credentials grant. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensClientCredentialsGrant(optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Acquires token info using the client credentials grant. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensJWTGrant(type, id, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Gets tokens for enterprise administration of app users +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +string + + + + + + + + + + The type of token to create, "user" or "enterprise"
id + + +string + + + + + + + + + + The ID of the enterprise to generate a token for
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensJWTGrant(type, id, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Gets tokens for enterprise administration of app users +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
type + + +string + + + + + + + + + + The type of token to create, "user" or "enterprise"
id + + +string + + + + + + + + + + The ID of the enterprise to generate a token for
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensRefreshGrant(refreshToken, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Refreshes the access and refresh tokens for a given refresh token. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
refreshToken + + +string + + + + + + + + + + A valid OAuth refresh token
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving to the token info +
+ + + +
+
+ Type +
+
+ +Promise.<TokenInfo> + + +
+
+ + + + + + + + + + + + + +

getTokensRefreshGrant(refreshToken, optionsopt) → {Promise.<TokenInfo>}

+ + + + + + +
+ Refreshes the access and refresh tokens for a given refresh token.
@@ -664,7 +2475,7 @@
Parameters:

authorizationCoderefreshToken @@ -688,7 +2499,7 @@
Parameters:
- 		authorization code issued by BoxA valid OAuth refresh token
optionstokenInfo -TokenRequestOptions +TokenInfo + + + + + + + + + + the token info to be written
bufferMS + + +int @@ -892,7 +2736,8 @@
Parameters:
- 		Sets optional behavior for the token grantAn optional buffer we'd like to test against. The greater this buffer, the more aggressively +we'll call a token invalid.
type - - -string - - - - - - - - - - The type of token to create, "user" or "enterprise"
idtokenInfo -string +TokenInfo @@ -1092,20 +2908,20 @@
Parameters:
- 		The ID of the enterprise to generate a token forthe token info to be written
optionsbufferMS -TokenRequestOptions +int @@ -1125,7 +2941,8 @@
Parameters:
- 		Sets optional behavior for the token grantAn optional buffer we'd like to test against. The greater this buffer, the more aggressively +we'll call a token invalid.
refreshTokenclaims -string +Object @@ -1294,20 +3112,20 @@
Parameters:
- 		A valid OAuth refresh tokenJTI claims object
optionsjwtOptions -TokenRequestOptions +Object @@ -1327,160 +3145,115 @@
Parameters:
- 		Sets optional behavior for the token grantJWT options for the signature
- - - - - - -
- - - - - - - - - - - - - + + + keyParams + - + + + +Object - - + + - + + + - + - -
Source:
-
- + + + - + - + Key JWT parameters object that contains the private key and the passphrase + -
- - - - - - - - - + + + params + + + + +Object + + + + + -
Returns:
- - -
- Promise resolving to the token info -
- - - -
-
- Type -
-
- -Promise.<TokenInfo> - - -
-
- - - - - - + - + + - + - -

isAccessTokenValid(tokenInfo, bufferMSopt) → {boolean}

- + Should contain all params expected by Box OAuth2 token endpoint + + + + options + - -
- Given a TokenInfo object, returns whether its access token is expired. An access token is considered -expired once its TTL surpasses the current time outside of the given buffer. This is a public method so -that other modules may check the validity of their tokens. -
- - - - - - - + + + +TokenRequestOptions -
Parameters:
- + + - - - - - - + + + - - - + + + - + - - - + + - - + + - + + @@ -1573,7 +3343,7 @@
Parameters:
Source:
@@ -1602,7 +3372,7 @@
Returns:
- True if token is valid outside of buffer, otherwise false + Promise resolving to the token info
@@ -1613,7 +3383,7 @@
Returns:
-boolean +Promise.<TokenInfo>
@@ -1933,7 +3703,7 @@
Parameters:
Source:
@@ -2135,7 +3905,209 @@
Parameters:
Source:
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ Promise resolving if the revoke succeeds +
+ + + +
+
+ Type +
+
+ +Promise + + +
+
+ + + + + + + + + + + + + +

revokeTokens(token, optionsopt) → {Promise}

+ + + + + + +
+ Revokes a token pair associated with a given access or refresh token. +
+ + + + + + + + + +
Parameters:
+ + +
Name + + <optional>
+ - 		TypeAttributesDescription
Sets optional behavior for the token grant
tokenInfoerror -TokenInfo +Error @@ -1498,14 +3271,14 @@
Parameters:
- 		the token info to be writtenError from the previous JWT request
bufferMSnumRetries @@ -1520,8 +3293,6 @@
Parameters:
 - <optional>
- @@ -1531,8 +3302,7 @@
Parameters:
- 		An optional buffer we'd like to test against. The greater this buffer, the more aggressively -we'll call a token invalid.Number of retries attempted
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
token + + +string + + + + + + + + + + A valid access or refresh token to revoke
options + + +TokenRequestOptions + + + + + + <optional>
+ + + + + + 		Sets optional behavior for the token grant
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -2203,13 +4175,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Trash.html b/docs/jsdoc/Trash.html index 10b91008..8b691168 100644 --- a/docs/jsdoc/Trash.html +++ b/docs/jsdoc/Trash.html @@ -426,7 +426,275 @@
Properties
Source:
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of trashed items +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get items in the user's trash + +API Endpoint: '/folders/trash/items' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
fields + + +string + + + + + + <optional>
+ + + + + + 		Comma-delimited list of item fields to return
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the list of trashed items if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -494,13 +762,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/UserBase.html b/docs/jsdoc/UserBase.html index 834bbd75..f06b74a1 100644 --- a/docs/jsdoc/UserBase.html +++ b/docs/jsdoc/UserBase.html @@ -75,7 +75,7 @@

UserBase

Source:
@@ -163,7 +163,7 @@
Type:
Source:
@@ -236,7 +236,7 @@
Type:
Source:
@@ -270,13 +270,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Users.html b/docs/jsdoc/Users.html index cfbcb4eb..698908f0 100644 --- a/docs/jsdoc/Users.html +++ b/docs/jsdoc/Users.html @@ -260,7 +260,7 @@
Type:
Source:
@@ -568,7 +568,7 @@
Properties
Source:
@@ -626,6 +626,676 @@
Returns:
+

addEmailAlias(userID, email, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Add a linked email address to a user's account. + +API Endpoint: '/users/:id/email_aliases' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to add an email alias to
email + + +string + + + + + + + + + + The email address to add
options + + +Object + + + + + + <optional>
+ + + + + + 		Optional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
is_confirmed + + +boolean + + + + + + <optional>
+ + + + + + 		+ + false + + Whether or not to attempt to auto-confirm the alias (for admins)
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new alias if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new email alias +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(userID, optionsopt, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Deletes a user in an enterprise account. + +API Endpoint: '/users/:userID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to delete
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
notify + + +boolean + + + + + + <optional>
+ + + + + + 		Determines if the destination user should receive email notification of the transfer.
force + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not the user should be deleted even if this user still own files.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + +

delete(userID, optionsopt, callbackopt) → {Promise.<void>}

@@ -634,10 +1304,2049 @@

delete - Deletes a user in an enterprise account. + Deletes a user in an enterprise account. + +API Endpoint: '/users/:userID' +Method: DELETE + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to delete
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
notify + + +boolean + + + + + + <optional>
+ + + + + + 		Determines if the destination user should receive email notification of the transfer.
force + + +boolean + + + + + + <optional>
+ + + + + + 		Whether or not the user should be deleted even if this user still own files.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAvatar(userID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete the user's avatar image. + +API Endpoint: '/users/:userID/avatar' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user whose avatar should be deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

deleteAvatar(userID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete the user's avatar image. + +API Endpoint: '/users/:userID/avatar' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user whose avatar should be deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed nothing if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(userID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests information for the Box user info associated with a given ID + +API Endpoint: '/users/:id' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the user info if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the user object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(userID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Requests information for the Box user info associated with a given ID + +API Endpoint: '/users/:id' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		passed the user info if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the user object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAvatar(userID, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Retrieve the user's avatar image. + +API Endpoint: '/users/:userID/avatar' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user whose avatar should be retrieved
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a stream over the bytes of the avatar image if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the image stream +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getAvatar(userID, callbackopt) → {Promise.<Readable>}

+ + + + + + +
+ Retrieve the user's avatar image. + +API Endpoint: '/users/:userID/avatar' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user whose avatar should be retrieved
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed a stream over the bytes of the avatar image if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the image stream +
+ + + +
+
+ Type +
+
+ +Promise.<Readable> + + +
+
+ + + + + + + + + + + + + +

getEmailAliases(userID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all linked email addresses for a user. + +API Endpoint: '/users/:id/email_aliases' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to retrieve email alises for
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the email aliases if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of email aliases +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getEmailAliases(userID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get all linked email addresses for a user. + +API Endpoint: '/users/:id/email_aliases' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
userID + + +string + + + + + + + + + + The ID of the user to retrieve email alises for
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the email aliases if successful
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the collection of email aliases +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getGroupMemberships(userID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Retrieve a list of group memberships for the user, which show which groups +the user belongs to. This ability is restricted to group admins. -API Endpoint: '/users/:userID' -Method: DELETE +API Endpoint: '/users/:userID/memberships' +Method: GET
@@ -699,7 +3408,7 @@
Parameters:
- The ID of the user to delete + The ID of the user to get group memberships for @@ -732,7 +3441,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Optional parameters, can be left null in most cases
Properties
@@ -760,13 +3469,13 @@
Properties
- notify + limit -boolean +int @@ -786,20 +3495,20 @@
Properties
- Determines if the destination user should receive email notification of the transfer. + The number of memberships to retrieve - force + offset -boolean +int @@ -819,7 +3528,7 @@
Properties
- Whether or not the user should be deleted even if this user still own files. + Paging marker, retrieve records starting at this position in the list @@ -859,7 +3568,7 @@
Properties
- Empty response body passed if successful, error otherwise + Passed a list of memberships if successful, error otherwise @@ -900,7 +3609,7 @@
Properties
Source:
@@ -929,7 +3638,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the collection of group memberships
@@ -940,7 +3649,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -958,7 +3667,7 @@
Returns:
-

deleteAvatar(userID, callbackopt) → {Promise.<void>}

+

getGroupMemberships(userID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -966,10 +3675,11 @@

deleteAva
- Delete the user's avatar image. + Retrieve a list of group memberships for the user, which show which groups +the user belongs to. This ability is restricted to group admins. -API Endpoint: '/users/:userID/avatar' -Method: DELETE +API Endpoint: '/users/:userID/memberships' +Method: GET
@@ -990,30 +3700,148 @@

Parameters:
Name - Type + Type + + + Attributes + + + + + Description + + + + + + + + + userID + + + + + +string + + + + + + + + + + + + + + + + + + The ID of the user to get group memberships for + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + - + - - - + + - - + + + + + + +
NameTypeAttributesDescription
limit + + +int + + + + + + <optional>
+ + + - - 		AttributesDescription
The number of memberships to retrieve
userIDoffset -string +int @@ -1022,6 +3850,8 @@
Parameters:
 + <optional>
+ @@ -1031,7 +3861,14 @@
Parameters:
- 		The ID of the user whose avatar should be deletedPaging marker, retrieve records starting at this position in the list
+ + @@ -1064,7 +3901,7 @@
Parameters:
- Passed nothing if successful + Passed a list of memberships if successful, error otherwise @@ -1105,7 +3942,7 @@
Parameters:
Source:
@@ -1134,7 +3971,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the collection of group memberships
@@ -1145,7 +3982,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1163,7 +4000,7 @@
Returns:
-

get(userID, optionsopt, callbackopt) → {Promise.<Object>}

+

removeEmailAlias(userID, aliasID, callbackopt) → {Promise.<void>}

@@ -1171,10 +4008,10 @@

get - Requests information for the Box user info associated with a given ID + Remove a linked email address from the current user by alias ID. -API Endpoint: '/users/:id' -Method: GET +API Endpoint: '/users/:id/email_aliases/:aliasID' +Method: DELETE @@ -1236,20 +4073,20 @@
Parameters:
- The ID of the user to retrieve + The ID of the user to remove the email alias from - options + aliasID -Object +string @@ -1258,8 +4095,6 @@
Parameters:
- <optional>
- @@ -1269,7 +4104,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + The ID of the linked email alias to remove @@ -1302,7 +4137,7 @@
Parameters:
- passed the user info if it was acquired successfully + Passed nothing on success @@ -1343,7 +4178,7 @@
Parameters:
Source:
@@ -1372,7 +4207,7 @@
Returns:
- A promise resolving to the user object + A promise resolving to nothing
@@ -1383,7 +4218,7 @@
Returns:
-Promise.<Object> +Promise.<void>
@@ -1401,7 +4236,7 @@
Returns:
-

getAvatar(userID, callbackopt) → {Promise.<Readable>}

+

removeEmailAlias(userID, aliasID, callbackopt) → {Promise.<void>}

@@ -1409,10 +4244,10 @@

getAvatar - Retrieve the user's avatar image. + Remove a linked email address from the current user by alias ID. -API Endpoint: '/users/:userID/avatar' -Method: GET +API Endpoint: '/users/:id/email_aliases/:aliasID' +Method: DELETE @@ -1474,7 +4309,38 @@
Parameters:
- The ID of the user whose avatar should be retrieved + The ID of the user to remove the email alias from + + + + + + + aliasID + + + + + +string + + + + + + + + + + + + + + + + + + The ID of the linked email alias to remove @@ -1507,7 +4373,7 @@
Parameters:
- Passed a stream over the bytes of the avatar image if successful + Passed nothing on success @@ -1548,7 +4414,7 @@
Parameters:
Source:
@@ -1577,7 +4443,7 @@
Returns:
- A promise resolving to the image stream + A promise resolving to nothing
@@ -1588,7 +4454,7 @@
Returns:
-Promise.<Readable> +Promise.<void>
@@ -1606,7 +4472,7 @@
Returns:
-

getEmailAliases(userID, callbackopt) → {Promise.<Object>}

+

setAvatar(userID, avatar, callbackopt) → {Promise.<Object>}

@@ -1614,10 +4480,10 @@

getEma
- Get all linked email addresses for a user. + Set the user's avatar image. -API Endpoint: '/users/:id/email_aliases' -Method: GET +API Endpoint: '/users/:userID/avatar' +Method: POST
@@ -1679,7 +4545,45 @@

Parameters:
- The ID of the user to retrieve email alises for + The ID of the user whose avatar should be set + + + + + + + avatar + + + + + +string +| + +Buffer +| + +ReadStream + + + + + + + + + + + + + + + + + + the content of the file. It can be a string, a Buffer, or a read stream +(like that returned by fs.createReadStream()). @@ -1712,7 +4616,7 @@
Parameters:
- Passed the email aliases if successful + Passed dictionary of picture urls if successful @@ -1753,7 +4657,7 @@
Parameters:
Source:
@@ -1782,7 +4686,7 @@
Returns:
- A promise resolving to the collection of email aliases + A promise resolving to the picture urls
@@ -1811,7 +4715,7 @@
Returns:
-

getGroupMemberships(userID, optionsopt, callbackopt) → {Promise.<Object>}

+

setAvatar(userID, avatar, callbackopt) → {Promise.<Object>}

@@ -1819,11 +4723,10 @@

ge
- Retrieve a list of group memberships for the user, which show which groups -the user belongs to. This ability is restricted to group admins. + Set the user's avatar image. -API Endpoint: '/users/:userID/memberships' -Method: GET +API Endpoint: '/users/:userID/avatar' +Method: POST
@@ -1831,97 +4734,12 @@

ge - - - -

Parameters:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -2045,7 +4859,7 @@
Properties
- + @@ -2086,7 +4900,7 @@
Properties
Source:
@@ -2115,7 +4929,7 @@
Returns:
- A promise resolving to the collection of group memberships + A promise resolving to the picture urls
@@ -2144,7 +4958,7 @@
Returns:
-

removeEmailAlias(userID, aliasID, callbackopt) → {Promise.<void>}

+

terminateSession(options) → {Promise.<Object>}

@@ -2152,10 +4966,11 @@

remov
- Remove a linked email address from the current user by alias ID. + Validates the roles and permissions of the user, +and creates asynchronous jobs to terminate the user's sessions. -API Endpoint: '/users/:id/email_aliases/:aliasID' -Method: DELETE +API Endpoint: '/users/terminate_sessions' +Method: POST
@@ -2179,8 +4994,6 @@

Parameters:
- - @@ -2193,44 +5006,57 @@
Parameters:
- + - - - +
NameTypeAttributesDescription
userID - - -string - - - - - - - - - - The ID of the user to get group memberships for
options - - -Object - - - - - - <optional>
- - - - - - 		Optional parameters, can be left null in most cases -
Properties
- - + + + +
Parameters:
+ + @@ -1946,13 +4764,13 @@
Properties
- + + - + - - - - -
limituserID -int +string @@ -1961,8 +4779,6 @@
Properties
 - <optional>
- @@ -1972,20 +4788,26 @@
Properties
- 		The number of memberships to retrieveThe ID of the user whose avatar should be set
offsetavatar -int +string +| + +Buffer +| + +ReadStream @@ -1994,8 +4816,6 @@
Properties
 - <optional>
- @@ -2005,14 +4825,8 @@
Properties
- 		Paging marker, retrieve records starting at this position in the list
- - 		the content of the file. It can be a string, a Buffer, or a read stream +(like that returned by fs.createReadStream()).
Passed a list of memberships if successful, error otherwisePassed dictionary of picture urls if successful
TypeAttributes
userIDoptions -string +Object - - + + The user IDs or logins to terminate sessions +
Properties
-
+ + + + + - - + + + + + + + + + + + + - + + - + + + + + + +
NameThe ID of the user to remove the email alias from
TypeAttributesDescription
aliasIDuserIDs -string +Array.<string> @@ -2239,6 +5065,8 @@
Parameters:
 + <optional>
+ @@ -2248,20 +5076,20 @@
Parameters:
- 		The ID of the linked email alias to removeThe user IDs to terminate sessions
callbackuserLogins -function +Array.<string> @@ -2281,7 +5109,14 @@
Parameters:
- 		Passed nothing on successThe user logins to terminate sessions
+ + @@ -2322,7 +5157,7 @@
Parameters:
Source:
@@ -2351,7 +5186,7 @@
Returns:
- A promise resolving to nothing + A promise resolving a message about the request status.
@@ -2362,7 +5197,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -2380,7 +5215,7 @@
Returns:
-

setAvatar(userID, avatar, callbackopt) → {Promise.<Object>}

+

terminateSession(options) → {Promise.<Object>}

@@ -2388,9 +5223,10 @@

setAvatar - Set the user's avatar image. + Validates the roles and permissions of the user, +and creates asynchronous jobs to terminate the user's sessions. -API Endpoint: '/users/:userID/avatar' +API Endpoint: '/users/terminate_sessions' Method: POST @@ -2415,8 +5251,6 @@
Parameters:
Type - Attributes - @@ -2429,50 +5263,57 @@
Parameters:
- userID + options -string +Object - - - + + The user IDs or logins to terminate sessions +
Properties
- - - + + + + + + - - + + + + + + + + + + + + - + + - + + + + + + +
NameThe ID of the user whose avatar should be set
TypeAttributesDescription
avataruserIDs -string -| - -Buffer -| - -ReadStream +Array.<string> @@ -2481,6 +5322,8 @@
Parameters:
 + <optional>
+ @@ -2490,21 +5333,20 @@
Parameters:
- 		the content of the file. It can be a string, a Buffer, or a read stream -(like that returned by fs.createReadStream()).The user IDs to terminate sessions
callbackuserLogins -function +Array.<string> @@ -2524,7 +5366,14 @@
Parameters:
- 		Passed dictionary of picture urls if successfulThe user logins to terminate sessions
+ + @@ -2565,7 +5414,7 @@
Parameters:
Source:
@@ -2594,7 +5443,7 @@
Returns:
- A promise resolving to the picture urls + A promise resolving a message about the request status.
@@ -2623,7 +5472,7 @@
Returns:
-

terminateSession(options) → {Promise.<Object>}

+

update(userID, updates, callbackopt) → {Promise.<Object>}

@@ -2631,11 +5480,10 @@

termi
- Validates the roles and permissions of the user, -and creates asynchronous jobs to terminate the user's sessions. + Update some information about a user. -API Endpoint: '/users/terminate_sessions' -Method: POST +API Endpoint: '/users/:id' +Method: PUT
@@ -2659,6 +5507,8 @@

Parameters:
Type + Attributes + @@ -2671,57 +5521,44 @@
Parameters:
- options + userID -Object +string - - - - The user IDs or logins to terminate sessions -
Properties
+ - - - - - - - - + - - - + + + - + - - - + + - - + + - + - - - - -
NameTypeAttributesDescription
The ID of the user to update
userIDsupdates -Array.<string> +Object @@ -2730,8 +5567,6 @@
Properties
 - <optional>
- @@ -2741,20 +5576,20 @@
Properties
- 		The user IDs to terminate sessionsUser fields to update
userLoginscallback -Array.<string> +function @@ -2774,14 +5609,7 @@
Properties
- 		The user logins to terminate sessions
- - + Passed the updated user information if it was acquired successfully @@ -2822,7 +5650,7 @@
Properties
Source:
@@ -2851,7 +5679,7 @@
Returns:
- A promise resolving a message about the request status. + A promise resolving to the updated user object
@@ -3058,7 +5886,7 @@
Parameters:
Source:
@@ -3126,13 +5954,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/WebLinks.html b/docs/jsdoc/WebLinks.html index 6832e403..bbbbfc4b 100644 --- a/docs/jsdoc/WebLinks.html +++ b/docs/jsdoc/WebLinks.html @@ -394,7 +394,243 @@
Parameters:
Source:
+ + + + + + + +

+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the updated web link object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

addToCollection(webLinkID, collectionID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Add a web link to a given collection + +API Endpoint: '/web_links/:webLinkID' +Method: PUT +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
webLinkID + + +string + + + + + + + + + + The web link to add to the collection
collectionID + + +string + + + + + + + + + + The collection to add the web link to
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the updated web link if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -724,7 +960,7 @@
Properties
Source:
@@ -782,7 +1018,7 @@
Returns:
-

create(url, parentID, optionsopt, callbackopt) → {Promise.<Object>}

+

copy(webLinkID, newParentID, optionsopt, callbackopt) → {Promise.<Object>}

@@ -790,9 +1026,9 @@

create - Creates a web link object within a given folder. + Copy a web link into a new, different folder -API Endpoint: '/web_links' +API Endpoint: '/web_links/:webLinkID/copy Method: POST @@ -831,7 +1067,7 @@
Parameters:
- url + webLinkID @@ -855,14 +1091,14 @@
Parameters:
- URL you want the web link to point to. Must include http:// or https:// + The Box ID of the web link being requested - parentID + newParentID @@ -878,50 +1114,1876 @@
Parameters:
- + + + + + + + + + The Box ID for the new parent folder. '0' to copy to All Files. + + + + + + + options + + + + + +Object + + + + + + + + + <optional>
+ + + + + + + + + + + Optional parameters for the copy operation, can be left null in most cases +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		A new name to use if there is an identically-named item in the new parent folder
+ + + + + + + + + callback + + + + + +function + + + + + + + + + <optional>
+ + + + + + + + + + + passed the new web link info if call was successful + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new web link object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(url, parentID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Creates a web link object within a given folder. + +API Endpoint: '/web_links' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
url + + +string + + + + + + + + + + URL you want the web link to point to. Must include http:// or https://
parentID + + +string + + + + + + + + + + The ID of the parent folder where you're creating the web link
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		Name for the web link. Will default to the URL if empty.
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the web link. Will provide more context to users about the web link.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new web link information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created weblink object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(url, parentID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Creates a web link object within a given folder. + +API Endpoint: '/web_links' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
url + + +string + + + + + + + + + + URL you want the web link to point to. Must include http:// or https://
parentID + + +string + + + + + + + + + + The ID of the parent folder where you're creating the web link
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional parameters +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name + + +string + + + + + + <optional>
+ + + + + + 		Name for the web link. Will default to the URL if empty.
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the web link. Will provide more context to users about the web link.
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new web link information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the created weblink object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(weblinkID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Deletes a web link and moves it to the trash + +API Endpoint: '/web_links/:weblinkID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
weblinkID + + +string + + + + + + + + + + The Box ID of the web link being moved to the trash
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(weblinkID, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Deletes a web link and moves it to the trash + +API Endpoint: '/web_links/:weblinkID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
weblinkID + + +string + + + + + + + + + + The Box ID of the web link being moved to the trash
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty body passed if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(weblinkID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Use to get information about the web link. + +API Endpoint: '/web_links/:weblinkID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
weblinkID + + +string + + + + + + + + + + The Box ID of web link being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the web-link information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the weblink object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(weblinkID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Use to get information about the web link. + +API Endpoint: '/web_links/:weblinkID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
weblinkID + + +string + + + + + + + + + + The Box ID of web link being requested
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the web-link information if it was acquired successfully, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the weblink object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

move(webLinkID, newParentID, callbackopt) → {Promise.<Object>}

+ + + - - - - - The ID of the parent folder where you're creating the web link - +
+ Move a web link into a new parent folder. - +API Endpoint: '/web_links/:webLinkID' +Method: PUT +
- - - options - - - - -Object - - - - - - <optional>
- - - - - - - Additional parameters -
Properties
- +
Parameters:
+ @@ -947,7 +3009,7 @@
Properties
- + + - + - - - - -
namewebLinkID @@ -962,8 +3024,6 @@
Properties
 - <optional>
- @@ -973,14 +3033,14 @@
Properties
- 		Name for the web link. Will default to the URL if empty.The Box ID of the web link being requested
descriptionnewParentID @@ -995,8 +3055,6 @@
Properties
 - <optional>
- @@ -1006,14 +3064,7 @@
Properties
- 		Description of the web link. Will provide more context to users about the web link.
- - + The Box ID for the new parent folder. '0' to move to All Files. @@ -1046,7 +3097,7 @@
Properties
- Passed the new web link information if it was acquired successfully, error otherwise + Passed the updated web link information if it was acquired successfully @@ -1087,7 +3138,7 @@
Properties
Source:
@@ -1116,7 +3167,7 @@
Returns:
- A promise resolving to the created weblink object + A promise resolving to the updated web link object
@@ -1145,7 +3196,7 @@
Returns:
-

delete(weblinkID, callbackopt) → {Promise.<Object>}

+

move(webLinkID, newParentID, callbackopt) → {Promise.<Object>}

@@ -1153,10 +3204,10 @@

delete - Deletes a web link and moves it to the trash + Move a web link into a new parent folder. -API Endpoint: '/web_links/:weblinkID' -Method: DELETE +API Endpoint: '/web_links/:webLinkID' +Method: PUT @@ -1194,7 +3245,7 @@
Parameters:
- weblinkID + webLinkID @@ -1218,7 +3269,38 @@
Parameters:
- The Box ID of the web link being moved to the trash + The Box ID of the web link being requested + + + + + + + newParentID + + + + + +string + + + + + + + + + + + + + + + + + + The Box ID for the new parent folder. '0' to move to All Files. @@ -1251,7 +3333,7 @@
Parameters:
- Empty body passed if successful, error otherwise + Passed the updated web link information if it was acquired successfully @@ -1292,7 +3374,7 @@
Parameters:
Source:
@@ -1321,7 +3403,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the updated web link object
@@ -1350,7 +3432,7 @@
Returns:
-

get(weblinkID, optionsopt, callbackopt) → {Promise.<Object>}

+

removeFromCollection(webLinkID, collectionID, callbackopt) → {Promise.<Object>}

@@ -1358,10 +3440,10 @@

get - Use to get information about the web link. + Remove a web link from a given collection -API Endpoint: '/web_links/:weblinkID' -Method: GET +API Endpoint: '/web_links/:webLinkID' +Method: PUT @@ -1399,7 +3481,7 @@
Parameters:
- weblinkID + webLinkID @@ -1423,20 +3505,20 @@
Parameters:
- The Box ID of web link being requested + The web link to remove from the collection - options + collectionID -Object +string @@ -1445,8 +3527,6 @@
Parameters:
- <optional>
- @@ -1456,7 +3536,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + The collection to remove the web link from @@ -1489,7 +3569,7 @@
Parameters:
- Passed the web-link information if it was acquired successfully, error otherwise + Passed the updated web link if successful, error otherwise @@ -1530,7 +3610,7 @@
Parameters:
Source:
@@ -1559,7 +3639,7 @@
Returns:
- A promise resolving to the weblink object + A promise resolving to the updated web link object
@@ -1588,7 +3668,7 @@
Returns:
-

move(webLinkID, newParentID, callbackopt) → {Promise.<Object>}

+

removeFromCollection(webLinkID, collectionID, callbackopt) → {Promise.<Object>}

@@ -1596,7 +3676,7 @@

move - Move a web link into a new parent folder. + Remove a web link from a given collection API Endpoint: '/web_links/:webLinkID' Method: PUT @@ -1661,14 +3741,14 @@
Parameters:
- The Box ID of the web link being requested + The web link to remove from the collection - newParentID + collectionID @@ -1692,7 +3772,7 @@
Parameters:
- The Box ID for the new parent folder. '0' to move to All Files. + The collection to remove the web link from @@ -1725,7 +3805,7 @@
Parameters:
- Passed the updated web link information if it was acquired successfully + Passed the updated web link if successful, error otherwise @@ -1766,7 +3846,7 @@
Parameters:
Source:
@@ -1824,7 +3904,7 @@
Returns:
-

removeFromCollection(webLinkID, collectionID, callbackopt) → {Promise.<Object>}

+

update(weblinkID, updates, callbackopt) → {Promise.<Object>}

@@ -1832,9 +3912,9 @@

r
- Remove a web link from a given collection + Updates information for a web link. -API Endpoint: '/web_links/:webLinkID' +API Endpoint: '/web_links/:weblinkID' Method: PUT
@@ -1873,7 +3953,7 @@

Parameters:
- webLinkID + weblinkID @@ -1897,14 +3977,66 @@
Parameters:
- The web link to remove from the collection + The Box ID of the web link being updated - collectionID + updates + + + + + +Object + + + + + + + + + + + + + + + + + + Fields of the weblink to update +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
name @@ -1919,6 +4051,8 @@
Parameters:
 + <optional>
+ @@ -1928,7 +4062,47 @@
Parameters:
- 		The collection to remove the web link fromName for the web link. Will default to the URL if empty.
description + + +string + + + + + + <optional>
+ + + + + + 		Description of the web link. Will provide more context to users about the web link.
+ + @@ -1961,7 +4135,7 @@
Parameters:
- Passed the updated web link if successful, error otherwise + Passed the updated web link information if it was acquired successfully, error otherwise @@ -2002,7 +4176,7 @@
Parameters:
Source:
@@ -2332,7 +4506,7 @@
Properties
Source:
@@ -2400,13 +4574,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/Webhooks.html b/docs/jsdoc/Webhooks.html index ee89e3d0..90d3086c 100644 --- a/docs/jsdoc/Webhooks.html +++ b/docs/jsdoc/Webhooks.html @@ -246,7 +246,7 @@
Type:
Source:
@@ -264,13 +264,13 @@
Type:
-

(static, nullable) primarySignatureKey :string

+

(static, nullable) secondarySignatureKey :string

- Primary signature key to protect webhooks against attacks. + Secondary signature key to protect webhooks against attacks.
@@ -318,7 +318,7 @@
Type:
Source:
@@ -336,13 +336,13 @@
Type:
-

(static, nullable) secondarySignatureKey :string

+

(nullable) primarySignatureKey :string

- Secondary signature key to protect webhooks against attacks. + Primary signature key to protect webhooks against attacks.
@@ -390,7 +390,7 @@
Type:
Source:
@@ -408,7 +408,7 @@
Type:
-

(static, nullable) secondarySignatureKey :string

+

(nullable) secondarySignatureKey :string

@@ -462,7 +462,7 @@
Type:
Source:
@@ -770,7 +770,7 @@
Properties:
Source:
@@ -942,7 +942,7 @@
Parameters:
Source:
@@ -996,7 +996,7 @@
Returns:
-

(static) validateMessage(body, headers, primaryKeyopt, secondaryKeyopt, maxMessageAgeopt) → {boolean}

+

(static) setSignatureKeys(primaryKey, secondaryKeyopt) → {void}

@@ -1004,7 +1004,7 @@

(static) - Validate a webhook message by verifying the signature and the delivery timestamp + Sets primary and secondary signatures that are used to verify the Webhooks messages @@ -1040,71 +1040,6 @@
Parameters:
- - - body - - - - - -string -| - -Object - - - - - - - - - - - - - - - - - - The request body of the webhook message - - - - - - - headers - - - - - -Object - - - - - - - - - - - - - - - - - - The request headers of the webhook message - - - - primaryKey @@ -1122,8 +1057,6 @@
Parameters:
- <optional>
- @@ -1133,8 +1066,7 @@
Parameters:
- The primary signature to verify the message with. If it is sent as a parameter, - it overrides the static variable primarySignatureKey + The primary signature to verify the message with @@ -1167,41 +1099,7 @@
Parameters:
- The secondary signature to verify the message with. If it is sent as a parameter, - it overrides the static variable primarySignatureKey - - - - - - - maxMessageAge - - - - - -int - - - - - - - - - <optional>
- - - - - - - - - - - The maximum message age (in seconds). Defaults to 10 minutes + The secondary signature to verify the message with @@ -1242,7 +1140,7 @@
Parameters:
Source:
@@ -1270,10 +1168,6 @@
Parameters:
Returns:
-
- - True or false -
-
@@ -1282,7 +1176,7 @@
Returns:
-boolean +void
@@ -1300,7 +1194,7 @@
Returns:
-

create(targetID, targetType, notificationURL, triggerTypes, callbackopt) → {Promise.<Object>}

+

(static) validateMessage(body, headers, primaryKeyopt, secondaryKeyopt, maxMessageAgeopt) → {boolean}

@@ -1308,10 +1202,7 @@

create - Create a new webhook on a given Box object, specified by type and ID. - -API Endpoint: '/webhooks' -Method: POST + Validate a webhook message by verifying the signature and the delivery timestamp @@ -1349,13 +1240,16 @@
Parameters:
- targetID + body string +| + +Object @@ -1373,20 +1267,20 @@
Parameters:
- Box ID of the item to create webhook on + The request body of the webhook message - targetType + headers -ItemType +Object @@ -1404,14 +1298,14 @@
Parameters:
- Type of item the webhook will be created on + The request headers of the webhook message - notificationURL + primaryKey @@ -1426,6 +1320,8 @@
Parameters:
+ <optional>
+ @@ -1435,20 +1331,21 @@
Parameters:
- The URL of your application where Box will notify you of events triggers + The primary signature to verify the message with. If it is sent as a parameter, + it overrides the static variable primarySignatureKey - triggerTypes + secondaryKey -Array.<WebhookTriggerType> +string @@ -1457,6 +1354,8 @@
Parameters:
+ <optional>
+ @@ -1466,20 +1365,21 @@
Parameters:
- Array of event types that trigger notification for the target + The secondary signature to verify the message with. If it is sent as a parameter, + it overrides the static variable primarySignatureKey - callback + maxMessageAge -function +int @@ -1499,7 +1399,7 @@
Parameters:
- Passed the new webhook information if it was acquired successfully + The maximum message age (in seconds). Defaults to 10 minutes @@ -1540,7 +1440,7 @@
Parameters:
Source:
@@ -1569,7 +1469,7 @@
Returns:
- A promise resolving to the new webhook object + - True or false
@@ -1580,7 +1480,7 @@
Returns:
-Promise.<Object> +boolean
@@ -1598,7 +1498,7 @@
Returns:
-

delete(webhookID, callbackopt) → {Promise.<void>}

+

(static) validateMessage(body, headers, primaryKeyopt, secondaryKeyopt, maxMessageAgeopt) → {boolean}

@@ -1606,10 +1506,7 @@

delete - Delete a specified webhook by ID - -API Endpoint: '/webhooks/:webhookID' -Method: DELETE + Validate a webhook message by verifying the signature and the delivery timestamp @@ -1647,13 +1544,16 @@
Parameters:
- webhookID + body string +| + +Object @@ -1671,20 +1571,20 @@
Parameters:
- ID of webhook to be deleted + The request body of the webhook message - callback + headers -function +Object @@ -1693,8 +1593,6 @@
Parameters:
- <optional>
- @@ -1704,50 +1602,1946 @@
Parameters:
- Empty response body passed if successful. + The request headers of the webhook message - - + + + primaryKey + + + + +string + + + + + + <optional>
+ -
+ - + + + - + - + The primary signature to verify the message with. If it is sent as a parameter, + it overrides the static variable primarySignatureKey + - + + + secondaryKey + - + + + +string - - + + - + + + + <optional>
+ - + - + + + - + - -
Source:
-
- + The secondary signature to verify the message with. If it is sent as a parameter, + it overrides the static variable primarySignatureKey + + + + + + + maxMessageAge + + + + + +int + + + + + + + + + <optional>
+ + + + + + + + + + + The maximum message age (in seconds). Defaults to 10 minutes + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ - True or false +
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + + + + + + + + + + +

create(targetID, targetType, notificationURL, triggerTypes, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Create a new webhook on a given Box object, specified by type and ID. + +API Endpoint: '/webhooks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
targetID + + +string + + + + + + + + + + Box ID of the item to create webhook on
targetType + + +ItemType + + + + + + + + + + Type of item the webhook will be created on
notificationURL + + +string + + + + + + + + + + The URL of your application where Box will notify you of events triggers
triggerTypes + + +Array.<WebhookTriggerType> + + + + + + + + + + Array of event types that trigger notification for the target
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new webhook information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new webhook object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

create(targetID, targetType, notificationURL, triggerTypes, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Create a new webhook on a given Box object, specified by type and ID. + +API Endpoint: '/webhooks' +Method: POST +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
targetID + + +string + + + + + + + + + + Box ID of the item to create webhook on
targetType + + +ItemType + + + + + + + + + + Type of item the webhook will be created on
notificationURL + + +string + + + + + + + + + + The URL of your application where Box will notify you of events triggers
triggerTypes + + +Array.<WebhookTriggerType> + + + + + + + + + + Array of event types that trigger notification for the target
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the new webhook information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the new webhook object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

delete(webhookID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a specified webhook by ID + +API Endpoint: '/webhooks/:webhookID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
webhookID + + +string + + + + + + + + + + ID of webhook to be deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

delete(webhookID, callbackopt) → {Promise.<void>}

+ + + + + + +
+ Delete a specified webhook by ID + +API Endpoint: '/webhooks/:webhookID' +Method: DELETE +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
webhookID + + +string + + + + + + + + + + ID of webhook to be deleted
callback + + +function + + + + + + <optional>
+ + + + + + 		Empty response body passed if successful.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to nothing +
+ + + +
+
+ Type +
+
+ +Promise.<void> + + +
+
+ + + + + + + + + + + + + +

get(webhookID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Returns a webhook object with the specified Webhook ID + +API Endpoint: '/webhooks/:webhookID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
webhookID + + +string + + + + + + + + + + ID of the webhook to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the webhook information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the webhook object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

get(webhookID, optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Returns a webhook object with the specified Webhook ID + +API Endpoint: '/webhooks/:webhookID' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
webhookID + + +string + + + + + + + + + + ID of the webhook to retrieve
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases.
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the webhook information if it was acquired successfully
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + +
Returns:
+ + +
+ A promise resolving to the webhook object +
+ + + +
+
+ Type +
+
+ +Promise.<Object> + + +
+
+ + + + + + + + + + + + + +

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+ + + + + + +
+ Get a list of webhooks that are active for the current application and user. + +API Endpoint: '/webhooks' +Method: GET +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDescription
options + + +Object + + + + + + <optional>
+ + + + + + 		Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeAttributesDefaultDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		+ + 100 + + The number of webhooks to return
marker + + +string + + + + + + <optional>
+ + + + + + 		+ + Pagination marker
+ +
callback + + +function + + + + + + <optional>
+ + + + + + 		Passed the list of webhooks if successful, error otherwise
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ @@ -1774,7 +3568,7 @@
Returns:
- A promise resolving to nothing + A promise resolving to the collection of webhooks
@@ -1785,7 +3579,7 @@
Returns:
-Promise.<void> +Promise.<Object>
@@ -1803,7 +3597,7 @@
Returns:
-

get(webhookID, optionsopt, callbackopt) → {Promise.<Object>}

+

getAll(optionsopt, callbackopt) → {Promise.<Object>}

@@ -1811,9 +3605,9 @@

get - Returns a webhook object with the specified Webhook ID + Get a list of webhooks that are active for the current application and user. -API Endpoint: '/webhooks/:webhookID' +API Endpoint: '/webhooks' Method: GET @@ -1852,13 +3646,13 @@
Parameters:
- webhookID + options -string +Object @@ -1867,6 +3661,8 @@
Parameters:
+ <optional>
+ @@ -1876,20 +3672,82 @@
Parameters:
- ID of the webhook to retrieve + Additional options for the request. Can be left null in most cases. +
Properties
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + - + + + + + +
NameTypeAttributesDefaultDescription
limit + + +int + + + + + + <optional>
+ + + + + + 		+ + 100 + + The number of webhooks to return
optionsmarker -Object +string @@ -1908,8 +3766,19 @@
Parameters:
+ 		+ + Additional options for the request. Can be left null in most cases.Pagination marker
+ + @@ -1942,7 +3811,7 @@
Parameters:
- Passed the webhook information if it was acquired successfully + Passed the list of webhooks if successful, error otherwise @@ -1983,7 +3852,7 @@
Parameters:
Source:
@@ -2012,7 +3881,7 @@
Returns:
- A promise resolving to the webhook object + A promise resolving to the collection of webhooks
@@ -2041,7 +3910,7 @@
Returns:
-

getAll(optionsopt, callbackopt) → {Promise.<Object>}

+

update(webhookID, updates, callbackopt) → {Promise.<Object>}

@@ -2049,10 +3918,10 @@

getAll - Get a list of webhooks that are active for the current application and user. + Update a webhook -API Endpoint: '/webhooks' -Method: GET +API Endpoint: '/webhooks/:webhookID' +Method: PUT @@ -2090,13 +3959,13 @@
Parameters:
- options + webhookID -Object +string @@ -2105,7 +3974,36 @@
Parameters:
- <optional>
+ + + + + + + + + + The ID of the webhook to be updated + + + + + + + updates + + + + + +Object + + + + + + + @@ -2116,7 +4014,7 @@
Parameters:
- Additional options for the request. Can be left null in most cases. + Webhook fields to update
Properties
@@ -2134,8 +4032,6 @@
Properties
- Default - Description @@ -2146,13 +4042,13 @@
Properties
- limit + address -int +string @@ -2171,27 +4067,21 @@
Properties
- - - 100 - - - - The number of webhooks to return + The new URL used by Box to send a notification when webhook is triggered - marker + triggers -string +Array.<WebhookTriggerType> @@ -2210,12 +4100,8 @@
Properties
- - - - - Pagination marker + The new events that triggers a notification @@ -2255,7 +4141,7 @@
Properties
- Passed the list of webhooks if successful, error otherwise + Passed the updated webhook information if successful, error otherwise @@ -2296,7 +4182,7 @@
Properties
Source:
@@ -2325,7 +4211,7 @@
Returns:
- A promise resolving to the collection of webhooks + A promise resolving to the updated webhook object
@@ -2626,7 +4512,7 @@
Properties
Source:
@@ -2694,13 +4580,13 @@
Returns:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:36 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request-manager.ts.html b/docs/jsdoc/api-request-manager.ts.html index 97015ce1..85afbb05 100644 --- a/docs/jsdoc/api-request-manager.ts.html +++ b/docs/jsdoc/api-request-manager.ts.html @@ -136,13 +136,13 @@

Source: api-request-manager.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/api-request.ts.html b/docs/jsdoc/api-request.ts.html index 311ba1d9..18ced99f 100644 --- a/docs/jsdoc/api-request.ts.html +++ b/docs/jsdoc/api-request.ts.html @@ -461,13 +461,13 @@

Source: api-request.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-client.ts.html b/docs/jsdoc/box-client.ts.html index f249a639..bfcba575 100644 --- a/docs/jsdoc/box-client.ts.html +++ b/docs/jsdoc/box-client.ts.html @@ -170,40 +170,6 @@

Source: box-client.ts

return defaultBasePath + url; } -/** - * Create a valid request object for the Batch API from a standard request - * params object - * @param {Object} params The request params - * @returns {Object} The batch API request object - * @private - */ -function formatRequestForBatch(params: Record<string, string | object>) { - var relativePath = (params.url as string).replace(/^http.*?\/\d\.\d\//, '/'); - - return { - method: params.method, - relative_url: - relativePath + (params.qs ? `?${qs.stringify(params.qs)}` : ''), - body: params.body, - headers: params.headers, - }; -} - -/** - * Format a Batch API response object into a standard request response - * for use in response handling - * @param {Object} response The batch API response object - * @returns {Object} The standard response object - * @private - */ -function formatResponseForBatch(response: any /* FIXME */) { - return { - statusCode: response.status, - headers: response.headers, - body: response.response, - }; -} - /** * Construct the X-Box-UA header to send analytics identifiers * @param {Object} [client] Analytics client information @@ -267,17 +233,12 @@

Source: box-client.ts

shieldInformationBarrierSegmentRestrictions: ShieldInformationBarrierSegmentRestrictions; shieldInformationBarrierReports: ShieldInformationBarrierReports; - _batch: any; - /* prototype properties assigned below the class declaration */ collaborationRoles!: Record<string, CollaborationRole>; itemTypes!: Record<string, ItemType>; accessLevels!: Record<string, AccessLevel>; CURRENT_USER_ID!: string; - /** @deprecated */ - collaborationWhitelist: any; - /** * The BoxClient can make API calls on behalf of a valid API Session. It is responsible * for formatting the requests and handling the response. Its goal is to deliver @@ -344,11 +305,6 @@

Source: box-client.ts

this.shieldInformationBarrierSegmentMembers = new ShieldInformationBarrierSegmentMembers(this); this.shieldInformationBarrierSegmentRestrictions = new ShieldInformationBarrierSegmentRestrictions(this); this.shieldInformationBarrierReports = new ShieldInformationBarrierReports(this); - // Legacy insensitive language - this.collaborationWhitelist = this.collaborationAllowlist; - - // Array of requests when in batch mode, null otherwise - this._batch = null; } /** @@ -391,48 +347,38 @@

Source: box-client.ts

* @private */ _makeRequest(params: any /* FIXME */, callback?: Function) { - var promise; - - if (this._batch) { - // eslint-disable-next-line promise/avoid-new - promise = new Promise((resolve, reject) => { - this._batch.push({ params, resolve, reject }); - }); - } else { - // Check that tokens are fresh, update if tokens are expired or soon-to-be expired - promise = this._session - .getAccessToken(this._tokenOptions) - .then((accessToken: string) => { - params.headers = this._createHeadersForRequest( - params.headers, - accessToken - ); - - if (params.streaming) { - // streaming is specific to the SDK, so delete it from params before continuing - delete params.streaming; - var responseStream = - this._requestManager.makeStreamingRequest(params); - // Listen to 'response' event, so we can cleanup the token store in case when the request is unauthorized - // due to expired access token - responseStream.on('response', (response: any /* FIXME */) => { - if (isUnauthorizedDueToExpiredAccessToken(response)) { - var expiredTokensError = errors.buildAuthError(response); - - // Give the session a chance to handle the error (ex: a persistent session will clear the token store) - if (this._session.handleExpiredTokensError) { - this._session.handleExpiredTokensError(expiredTokensError); - } + var promise = this._session + .getAccessToken(this._tokenOptions) + .then((accessToken: string) => { + params.headers = this._createHeadersForRequest( + params.headers, + accessToken + ); + + if (params.streaming) { + // streaming is specific to the SDK, so delete it from params before continuing + delete params.streaming; + var responseStream = + this._requestManager.makeStreamingRequest(params); + // Listen to 'response' event, so we can cleanup the token store in case when the request is unauthorized + // due to expired access token + responseStream.on('response', (response: any /* FIXME */) => { + if (isUnauthorizedDueToExpiredAccessToken(response)) { + var expiredTokensError = errors.buildAuthError(response); + + // Give the session a chance to handle the error (ex: a persistent session will clear the token store) + if (this._session.handleExpiredTokensError) { + this._session.handleExpiredTokensError(expiredTokensError); } - }); + } + }); - return responseStream; - } + return responseStream; + } - // Make the request to Box, and perform standard response handling - return this._requestManager.makeRequest(params); - }); - } + // Make the request to Box, and perform standard response handling + return this._requestManager.makeRequest(params); + }); return promise .then((response: any /* FIXME */) => { @@ -676,67 +622,6 @@

Source: box-client.ts

return this._makeRequest(newParams, callback); } - /** - * Puts the client into batch mode, which will queue calls instead of - * immediately making the API request. - * - * DEPRECATED: Batch API is not supported and should not be used; make calls in parallel instead. - * - * @returns {BoxClient} Current client object - */ - batch = util.deprecate(function (this: BoxClient) { - /* eslint-disable no-invalid-this */ - this._batch = []; - return this; - /* eslint-enable no-invalid-this */ - }, 'Batch API is not supported and should not be used; make calls in parallel instead.'); - - /** - * Executes a batch of requests. - * - * DEPRECATED: Batch API is not supported and should not be used; make calls in parallel instead. - * - * @returns {Promise<Object>} Promise resolving to the collection of batch responses - */ - batchExec = util.deprecate(function (this: BoxClient, callback: Function) { - /* eslint-disable no-invalid-this */ - if (!this._batch) { - return Promise.reject( - new Error('Must start a batch before executing') - ).asCallback(callback); - } - - var params = { - body: { - requests: this._batch.map((batchReq: any /* FIXME */) => - formatRequestForBatch(batchReq.params) - ), - }, - }; - - var batch: any[] = this._batch; - this._batch = null; - return this.post('/batch', params) - .then((res: any /* FIXME */) => { - var responses: any[] = res.body.responses; - - responses - .map((x) => formatResponseForBatch(x)) - .forEach((response, index) => { - batch[index].resolve(response); - }); - - return res.body; - }) - .catch((err: any) => { - batch.forEach((req) => req.reject(err)); - - throw err; - }) - .asCallback(callback); - /* eslint-enable no-invalid-this */ - }, 'Batch API is not supported and should not be used; make calls in parallel instead.'); - /** * Build the 'BoxApi' Header used for authenticating access to a shared item * @@ -934,13 +819,13 @@

Source: box-client.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/box-node-sdk.ts.html b/docs/jsdoc/box-node-sdk.ts.html index 87d4137e..40cb1640 100644 --- a/docs/jsdoc/box-node-sdk.ts.html +++ b/docs/jsdoc/box-node-sdk.ts.html @@ -529,13 +529,13 @@

Source: box-node-sdk.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/chunked-uploader.ts.html b/docs/jsdoc/chunked-uploader.ts.html index 0a0c0286..01116e34 100644 --- a/docs/jsdoc/chunked-uploader.ts.html +++ b/docs/jsdoc/chunked-uploader.ts.html @@ -478,13 +478,13 @@

Source: chunked-uploader.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/enterprise-event-stream.ts.html b/docs/jsdoc/enterprise-event-stream.ts.html index d36f54e2..be99318c 100644 --- a/docs/jsdoc/enterprise-event-stream.ts.html +++ b/docs/jsdoc/enterprise-event-stream.ts.html @@ -311,13 +311,13 @@

Source: enterprise-event-stream.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/event-stream.ts.html b/docs/jsdoc/event-stream.ts.html index 7ff73a83..4ef005c8 100644 --- a/docs/jsdoc/event-stream.ts.html +++ b/docs/jsdoc/event-stream.ts.html @@ -398,13 +398,13 @@

Source: event-stream.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/global.html b/docs/jsdoc/global.html index f8927a7f..6cbdfa57 100644 --- a/docs/jsdoc/global.html +++ b/docs/jsdoc/global.html @@ -1876,7 +1876,7 @@
Parameters:
Source:
@@ -2036,7 +2036,7 @@
Parameters:
Source:
@@ -2438,6 +2438,78 @@

Type Definitions

+

AccessLevel

+ + + + +
+ An access level constant. Used for setting and updating shared links, folder upload, etc. +
+ + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + +

ActorParams

@@ -2613,7 +2685,7 @@
Properties:
Source:
@@ -2851,7 +2923,7 @@
Parameters:
Source:
@@ -3213,7 +3285,7 @@
Properties:
Source:
@@ -3454,7 +3526,7 @@
Properties:
Source:
@@ -3809,7 +3881,7 @@
Properties:
Source:
@@ -4424,6 +4496,150 @@
Type:
+

CollaborationRole

+ + + + +
+ A collaboration role constant +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

ItemType

+ + + + +
+ A Box file or folder type constant +
+ + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + @@ -4916,7 +5132,7 @@
Properties:
Source:
@@ -5115,7 +5331,7 @@
Properties:
Source:
@@ -5512,7 +5728,7 @@
Properties:
Source:
@@ -5751,7 +5967,75 @@
Properties:
Source:
+ + + + + + + +

+ + + + + + + + +

SearchTrashContent

+ + + + + + +
Type:
+
    +
  • + +string + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -5898,7 +6182,7 @@
Properties:
Source:
@@ -6242,7 +6526,7 @@
Properties:
Source:
@@ -6410,7 +6694,177 @@
Properties:
Source:
+ + + + + + + +
+ + + + + + + + +

TokenStore

+ + + + +
+ Object representing interface functions for PersistentClient to interact with the consumer app's central storage layer. +
+ + + +
Type:
+
    +
  • + +Object + + +
    • +
+ + + + + +
Properties:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
read + + +ReadTokenInfoFromStore + + + + read TokenInfo from app central store.
write + + +WriteTokenInfoToStore + + + + write TokenInfo to the app's central store.
clear + + +ClearTokenInfoFromStore + + + + delete TokenInfo from the app's central store.
+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
@@ -6645,7 +7099,7 @@
Properties:
Source:
@@ -7785,13 +8239,13 @@
Type:

- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/index.html b/docs/jsdoc/index.html index 4fb13145..27a6027a 100644 --- a/docs/jsdoc/index.html +++ b/docs/jsdoc/index.html @@ -2189,13 +2189,13 @@

util/url-path.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:59 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collaboration-allowlist.ts.html b/docs/jsdoc/managers_collaboration-allowlist.ts.html index 2da66f9b..6973b266 100644 --- a/docs/jsdoc/managers_collaboration-allowlist.ts.html +++ b/docs/jsdoc/managers_collaboration-allowlist.ts.html @@ -73,11 +73,6 @@

Source: managers/collaboration-allowlist.ts

client: BoxClient; directions!: Record<string, string>; - /** @deprecated */ - getWhitelistedDomain: any; - /** @deprecated */ - getAllWhitelistedDomains: any; - constructor(client: BoxClient) { this.client = client; } @@ -298,12 +293,6 @@

Source: managers/collaboration-allowlist.ts

} } -// Legacy insensitive language -CollaborationAllowlist.prototype.getWhitelistedDomain = - CollaborationAllowlist.prototype.getAllowlistedDomain; -CollaborationAllowlist.prototype.getAllWhitelistedDomains = - CollaborationAllowlist.prototype.getAllAllowlistedDomains; - /** * Enum of valid collaboration allowlist directions * @@ -327,13 +316,13 @@

Source: managers/collaboration-allowlist.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collaborations.ts.html b/docs/jsdoc/managers_collaborations.ts.html index c4bac050..bf963129 100644 --- a/docs/jsdoc/managers_collaborations.ts.html +++ b/docs/jsdoc/managers_collaborations.ts.html @@ -424,13 +424,13 @@

Source: managers/collaborations.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_collections.ts.html b/docs/jsdoc/managers_collections.ts.html index f603ff37..21d478ea 100644 --- a/docs/jsdoc/managers_collections.ts.html +++ b/docs/jsdoc/managers_collections.ts.html @@ -125,13 +125,13 @@

Source: managers/collections.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_comments.ts.html b/docs/jsdoc/managers_comments.ts.html index d76879b7..d7826ada 100644 --- a/docs/jsdoc/managers_comments.ts.html +++ b/docs/jsdoc/managers_comments.ts.html @@ -268,13 +268,13 @@

Source: managers/comments.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_device-pins.ts.html b/docs/jsdoc/managers_device-pins.ts.html index 1f464731..2f2e17c9 100644 --- a/docs/jsdoc/managers_device-pins.ts.html +++ b/docs/jsdoc/managers_device-pins.ts.html @@ -163,13 +163,13 @@

Source: managers/device-pins.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_enterprise.ts.html b/docs/jsdoc/managers_enterprise.ts.html index a1d1afed..73146b63 100644 --- a/docs/jsdoc/managers_enterprise.ts.html +++ b/docs/jsdoc/managers_enterprise.ts.html @@ -332,13 +332,13 @@

Source: managers/enterprise.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_events.ts.html b/docs/jsdoc/managers_events.ts.html index 25b2f26a..48f428bf 100644 --- a/docs/jsdoc/managers_events.ts.html +++ b/docs/jsdoc/managers_events.ts.html @@ -402,13 +402,13 @@

Source: managers/events.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_file-requests-manager.ts.html b/docs/jsdoc/managers_file-requests-manager.ts.html index 66c7723c..249bf6b3 100644 --- a/docs/jsdoc/managers_file-requests-manager.ts.html +++ b/docs/jsdoc/managers_file-requests-manager.ts.html @@ -138,13 +138,13 @@

Source: managers/file-requests-manager.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_files.ts.html b/docs/jsdoc/managers_files.ts.html index f7a20b47..8ff72279 100644 --- a/docs/jsdoc/managers_files.ts.html +++ b/docs/jsdoc/managers_files.ts.html @@ -370,65 +370,6 @@

Source: managers/files.ts

); } - /** - * Requests a Thumbnail for a given file. - * - * API Endpoint: '/files/:fileID/thumbnail.png' - * Method: GET - * Special Expected Responses: - * 200 OK - Thumbnail available. Returns a thumbnail file. - * 202 ACCEPTED - Thumbnail isn't available yet. Returns a `location` URL for a generic placeholder thumbnail. - * 302 FOUND - Unable to generate thumbnail. Returns a `location` URL for a generic placeholder thumbnail. - * - * @param {string} fileID - Box ID of the file being requested - * @param {Object} [options] - Additional options for the request. Can be left null in most cases. - * @param {Function} [callback] - Passed the thumbnail file or the URL to a placeholder thumbnail if successful. - * @returns {Promise<Object>} A promise resolving to the thumbnail information - * @deprecated use getRepresentationContent() instead - */ - getThumbnail( - fileID: string, - options?: Record<string, any>, - callback?: Function - ) { - var params = { - qs: options, - json: false, - }; - - var apiPath = urlPath(BASE_PATH, fileID, '/thumbnail.png'); - - // Handle Special API Response - return this.client - .get(apiPath, params) - .then((response: any /* FIXME */) => { - switch (response.statusCode) { - // 202 - Thumbnail will be generated, but is not ready yet - // 302 - Thumbnail can not be generated - // return the url for a thumbnail placeholder - case httpStatusCodes.ACCEPTED: - case httpStatusCodes.FOUND: - return { - statusCode: response.statusCode, - location: response.headers.location, - }; - - // 200 - Thumbnail image recieved - // return the thumbnail file - case httpStatusCodes.OK: - return { - statusCode: response.statusCode, - file: response.body, - }; - - // Unexpected Response - default: - throw errors.buildUnexpectedResponseError(response); - } - }) - .asCallback(callback); - } - /** * Gets the comments on a file. * @@ -1923,7 +1864,7 @@

Source: managers/files.ts

*/ getRepresentationInfo( fileID: string, - representationType: FileRepresentationType, + representationType: FileRepresentationType | string, options?: | { generateRepresentations?: boolean; @@ -2005,7 +1946,7 @@

Source: managers/files.ts

*/ getRepresentationContent( fileID: string, - representationType: FileRepresentationType, + representationType: FileRepresentationType | string, options?: { assetPath?: string; }, @@ -2026,6 +1967,12 @@

Source: managers/files.ts

); } + // If the representation is paged, we need to specify which page to get the content for + // If the assetPath is not specified, we default to the first pages + if (!options?.assetPath && repInfo.properties?.paged == 'true') { + options!.assetPath = `1.${repInfo.representation}`; + } + switch (repInfo.status.state) { case 'success': case 'viewable': @@ -2158,13 +2105,13 @@

Source: managers/files.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_folders.ts.html b/docs/jsdoc/managers_folders.ts.html index f1f51348..08b7f32f 100644 --- a/docs/jsdoc/managers_folders.ts.html +++ b/docs/jsdoc/managers_folders.ts.html @@ -905,13 +905,13 @@

Source: managers/folders.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_groups.ts.html b/docs/jsdoc/managers_groups.ts.html index 7b414130..2e118814 100644 --- a/docs/jsdoc/managers_groups.ts.html +++ b/docs/jsdoc/managers_groups.ts.html @@ -472,13 +472,13 @@

Source: managers/groups.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_legal-hold-policies.ts.html b/docs/jsdoc/managers_legal-hold-policies.ts.html index 082810b6..ed50d11f 100644 --- a/docs/jsdoc/managers_legal-hold-policies.ts.html +++ b/docs/jsdoc/managers_legal-hold-policies.ts.html @@ -427,13 +427,13 @@

Source: managers/legal-hold-policies.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_metadata.ts.html b/docs/jsdoc/managers_metadata.ts.html index d199bde0..2f1db001 100644 --- a/docs/jsdoc/managers_metadata.ts.html +++ b/docs/jsdoc/managers_metadata.ts.html @@ -411,8 +411,6 @@

Source: managers/metadata.ts

/** * Query Box items by their metadata. - * We no longer require the index_name/use_index for queries that leverage indexes, - * internal analysis engine determines which existing index will satisfy the query. * * API Endpoint: '/metadata_queries/execute_read' * Method: POST @@ -422,7 +420,6 @@

Source: managers/metadata.ts

* @param {Object} [options] - Optional parameters * @param {string} [options.query] - The logical expression of the query * @param {Object} [options.query_parameters] - Required if query present. The arguments for the query - * @param {string} [options.index_name] - DEPRECATED: This parameter is ignored. The name of the index to use * @param {Object} [options.order_by] - The field_key(s) to order on and the corresponding direction(s) * @param {Array} [options.fields] - An array of fields to return * @param {Function} [callback] - Passed a collection of items and their associated metadata @@ -434,7 +431,6 @@

Source: managers/metadata.ts

options?: { query?: string; query_parameters?: Record<string, any>; - index_name?: string; order_by: Record<string, any>; fields?: string[]; }, @@ -445,10 +441,8 @@

Source: managers/metadata.ts

ancestor_folder_id: ancestorFolderId, }; - const { index_name: indexName, ...newOptions } = options ?? {}; - var params = { - body: merge(body, newOptions), + body: merge(body, options || {}), }; return this.client.wrapWithDefaultHandler(this.client.post)( @@ -491,13 +485,13 @@

Source: managers/metadata.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_recent-items.ts.html b/docs/jsdoc/managers_recent-items.ts.html index b4da27f8..c5f09570 100644 --- a/docs/jsdoc/managers_recent-items.ts.html +++ b/docs/jsdoc/managers_recent-items.ts.html @@ -109,13 +109,13 @@

Source: managers/recent-items.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_retention-policies.ts.html b/docs/jsdoc/managers_retention-policies.ts.html index 53704415..00dc9642 100644 --- a/docs/jsdoc/managers_retention-policies.ts.html +++ b/docs/jsdoc/managers_retention-policies.ts.html @@ -624,13 +624,13 @@

Source: managers/retention-policies.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_search.ts.html b/docs/jsdoc/managers_search.ts.html index 11089c78..1a949117 100644 --- a/docs/jsdoc/managers_search.ts.html +++ b/docs/jsdoc/managers_search.ts.html @@ -185,13 +185,13 @@

Source: managers/search.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shared-items.ts.html b/docs/jsdoc/managers_shared-items.ts.html index 64e98a78..c48f9018 100644 --- a/docs/jsdoc/managers_shared-items.ts.html +++ b/docs/jsdoc/managers_shared-items.ts.html @@ -128,13 +128,13 @@

Source: managers/shared-items.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html index 77bf6edf..ec1b3b22 100644 --- a/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-reports.generated.ts.html @@ -154,13 +154,13 @@

Source: managers/shield-information-barrier-reports.gener
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html index cd5feffc..48e27faf 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segment-members.generated.ts.html @@ -194,13 +194,13 @@

Source: managers/shield-information-barrier-segment-membe
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html index 0437ac9a..b0d02064 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segment-restrictions.generated.ts.html @@ -195,13 +195,13 @@

Source: managers/shield-information-barrier-segment-restr
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html b/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html index 3055b615..89661812 100644 --- a/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barrier-segments.generated.ts.html @@ -232,13 +232,13 @@

Source: managers/shield-information-barrier-segments.gene
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html index 4b907361..64e8c008 100644 --- a/docs/jsdoc/managers_shield-information-barriers.generated.ts.html +++ b/docs/jsdoc/managers_shield-information-barriers.generated.ts.html @@ -178,13 +178,13 @@

Source: managers/shield-information-barriers.generated.ts
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_sign-requests.generated.ts.html b/docs/jsdoc/managers_sign-requests.generated.ts.html index 79b8e6df..5917c6c5 100644 --- a/docs/jsdoc/managers_sign-requests.generated.ts.html +++ b/docs/jsdoc/managers_sign-requests.generated.ts.html @@ -204,13 +204,13 @@

Source: managers/sign-requests.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_storage-policies.ts.html b/docs/jsdoc/managers_storage-policies.ts.html index 095f7c18..3e9aac86 100644 --- a/docs/jsdoc/managers_storage-policies.ts.html +++ b/docs/jsdoc/managers_storage-policies.ts.html @@ -289,13 +289,13 @@

Source: managers/storage-policies.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_tasks.ts.html b/docs/jsdoc/managers_tasks.ts.html index b04093db..f2aec4ad 100644 --- a/docs/jsdoc/managers_tasks.ts.html +++ b/docs/jsdoc/managers_tasks.ts.html @@ -392,13 +392,13 @@

Source: managers/tasks.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_terms-of-service.ts.html b/docs/jsdoc/managers_terms-of-service.ts.html index 1d83e9c7..55023991 100644 --- a/docs/jsdoc/managers_terms-of-service.ts.html +++ b/docs/jsdoc/managers_terms-of-service.ts.html @@ -432,13 +432,13 @@

Source: managers/terms-of-service.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_trash.ts.html b/docs/jsdoc/managers_trash.ts.html index eb5fe12b..3048cc5d 100644 --- a/docs/jsdoc/managers_trash.ts.html +++ b/docs/jsdoc/managers_trash.ts.html @@ -105,13 +105,13 @@

Source: managers/trash.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_users.ts.html b/docs/jsdoc/managers_users.ts.html index 00790d90..19280309 100644 --- a/docs/jsdoc/managers_users.ts.html +++ b/docs/jsdoc/managers_users.ts.html @@ -392,13 +392,13 @@

Source: managers/users.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_web-links.ts.html b/docs/jsdoc/managers_web-links.ts.html index 64f266da..10677117 100644 --- a/docs/jsdoc/managers_web-links.ts.html +++ b/docs/jsdoc/managers_web-links.ts.html @@ -319,13 +319,13 @@

Source: managers/web-links.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/managers_webhooks.ts.html b/docs/jsdoc/managers_webhooks.ts.html index 6c1fb6e1..adc51888 100644 --- a/docs/jsdoc/managers_webhooks.ts.html +++ b/docs/jsdoc/managers_webhooks.ts.html @@ -564,13 +564,13 @@

Source: managers/webhooks.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_enterprise-base.generated.ts.html b/docs/jsdoc/schemas_enterprise-base.generated.ts.html index 96e0c203..d2eff112 100644 --- a/docs/jsdoc/schemas_enterprise-base.generated.ts.html +++ b/docs/jsdoc/schemas_enterprise-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/enterprise-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-base.generated.ts.html b/docs/jsdoc/schemas_file-base.generated.ts.html index cce1772b..16fd3ce3 100644 --- a/docs/jsdoc/schemas_file-base.generated.ts.html +++ b/docs/jsdoc/schemas_file-base.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/file-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-mini.generated.ts.html b/docs/jsdoc/schemas_file-mini.generated.ts.html index 9926bae4..f24ec055 100644 --- a/docs/jsdoc/schemas_file-mini.generated.ts.html +++ b/docs/jsdoc/schemas_file-mini.generated.ts.html @@ -77,13 +77,13 @@

Source: schemas/file-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-version-base.generated.ts.html b/docs/jsdoc/schemas_file-version-base.generated.ts.html index 01c8f48e..58db4721 100644 --- a/docs/jsdoc/schemas_file-version-base.generated.ts.html +++ b/docs/jsdoc/schemas_file-version-base.generated.ts.html @@ -56,13 +56,13 @@

Source: schemas/file-version-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_file-version-mini.generated.ts.html b/docs/jsdoc/schemas_file-version-mini.generated.ts.html index 9b579149..64ad2681 100644 --- a/docs/jsdoc/schemas_file-version-mini.generated.ts.html +++ b/docs/jsdoc/schemas_file-version-mini.generated.ts.html @@ -50,13 +50,13 @@

Source: schemas/file-version-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_folder-base.generated.ts.html b/docs/jsdoc/schemas_folder-base.generated.ts.html index 17ec44c9..5799d88c 100644 --- a/docs/jsdoc/schemas_folder-base.generated.ts.html +++ b/docs/jsdoc/schemas_folder-base.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/folder-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_folder-mini.generated.ts.html b/docs/jsdoc/schemas_folder-mini.generated.ts.html index 0ed93741..a8763d4c 100644 --- a/docs/jsdoc/schemas_folder-mini.generated.ts.html +++ b/docs/jsdoc/schemas_folder-mini.generated.ts.html @@ -67,13 +67,13 @@

Source: schemas/folder-mini.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html index 0a6f9822..f7d1cb2d 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/shield-information-barrier-base.generated
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html index f2d3d116..6cc1f023 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-reference.generated.ts.html @@ -45,13 +45,13 @@

Source: schemas/shield-information-barrier-reference.gene
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html index 1f831037..321577bd 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/shield-information-barrier-report-base.ge
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html index 363fcea1..527caa8a 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report-details.generated.ts.html @@ -46,13 +46,13 @@

Source: schemas/shield-information-barrier-report-details
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html index e52a9029..fc57ae5c 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-report.generated.ts.html @@ -69,13 +69,13 @@

Source: schemas/shield-information-barrier-report.generat
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html index 29dae516..33a15261 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member-base.generated.ts.html @@ -56,13 +56,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html index d341a21e..1230893a 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member-mini.generated.ts.html @@ -50,13 +50,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html index fa778a59..cf4a100c 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-member.generated.ts.html @@ -76,13 +76,13 @@

Source: schemas/shield-information-barrier-segment-member
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html index fc4b30c7..44559a0f 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-base.generated.ts.html @@ -57,13 +57,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html index 5bf5d2ec..c642e68b 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction-mini.generated.ts.html @@ -57,13 +57,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html index 66edddd4..8a4886e7 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment-restriction.generated.ts.html @@ -70,13 +70,13 @@

Source: schemas/shield-information-barrier-segment-restri
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html index a7537eb4..2e4f7207 100644 --- a/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier-segment.generated.ts.html @@ -86,13 +86,13 @@

Source: schemas/shield-information-barrier-segment.genera
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html b/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html index ff1008ad..7e38589f 100644 --- a/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html +++ b/docs/jsdoc/schemas_shield-information-barrier.generated.ts.html @@ -92,13 +92,13 @@

Source: schemas/shield-information-barrier.generated.ts
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-base.generated.ts.html b/docs/jsdoc/schemas_sign-request-base.generated.ts.html index d50f449e..a430ba43 100644 --- a/docs/jsdoc/schemas_sign-request-base.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-base.generated.ts.html @@ -110,13 +110,13 @@

Source: schemas/sign-request-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html index 2946684f..a1a175b5 100644 --- a/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-request.generated.ts.html @@ -61,13 +61,13 @@

Source: schemas/sign-request-create-request.generated.ts<
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html index ff6b2f11..4b356ecf 100644 --- a/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-create-signer.generated.ts.html @@ -113,13 +113,13 @@

Source: schemas/sign-request-create-signer.generated.ts
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html index 05074260..e3ef0864 100644 --- a/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-prefill-tag.generated.ts.html @@ -65,13 +65,13 @@

Source: schemas/sign-request-prefill-tag.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html index 18597937..f94d8d51 100644 --- a/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer-input.generated.ts.html @@ -72,13 +72,13 @@

Source: schemas/sign-request-signer-input.generated.ts
- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html index e0561b99..22652634 100644 --- a/docs/jsdoc/schemas_sign-request-signer.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request-signer.generated.ts.html @@ -59,13 +59,13 @@

Source: schemas/sign-request-signer.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-request.generated.ts.html b/docs/jsdoc/schemas_sign-request.generated.ts.html index 4ba848ed..3f5ad209 100644 --- a/docs/jsdoc/schemas_sign-request.generated.ts.html +++ b/docs/jsdoc/schemas_sign-request.generated.ts.html @@ -105,13 +105,13 @@

Source: schemas/sign-request.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_sign-requests.generated.ts.html b/docs/jsdoc/schemas_sign-requests.generated.ts.html index 6f4e0055..4a3aa7ed 100644 --- a/docs/jsdoc/schemas_sign-requests.generated.ts.html +++ b/docs/jsdoc/schemas_sign-requests.generated.ts.html @@ -63,13 +63,13 @@

Source: schemas/sign-requests.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/schemas_user-base.generated.ts.html b/docs/jsdoc/schemas_user-base.generated.ts.html index dd4c6594..58dc8a0d 100644 --- a/docs/jsdoc/schemas_user-base.generated.ts.html +++ b/docs/jsdoc/schemas_user-base.generated.ts.html @@ -55,13 +55,13 @@

Source: schemas/user-base.generated.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_app-auth-session.ts.html b/docs/jsdoc/sessions_app-auth-session.ts.html index 405af9b0..cd61193b 100644 --- a/docs/jsdoc/sessions_app-auth-session.ts.html +++ b/docs/jsdoc/sessions_app-auth-session.ts.html @@ -168,10 +168,7 @@

Source: sessions/app-auth-session.ts

* @returns {Promise<string>} Promise resolving to the access token */ getAccessToken(options?: TokenRequestOptions) { - var expirationBuffer = Math.max( - this._config.expiredBufferMS, - this._config.staleBufferMS - ); + var expirationBuffer = this._config.expiredBufferMS; // If we're initializing the client and have a token store, try reading from it if (!this._tokenInfo && this._tokenStore) { @@ -278,13 +275,13 @@

Source: sessions/app-auth-session.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_basic-session.ts.html b/docs/jsdoc/sessions_basic-session.ts.html index addb19dd..78f21ee0 100644 --- a/docs/jsdoc/sessions_basic-session.ts.html +++ b/docs/jsdoc/sessions_basic-session.ts.html @@ -131,13 +131,13 @@

Source: sessions/basic-session.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_ccg-session.ts.html b/docs/jsdoc/sessions_ccg-session.ts.html index 7b073c93..45e517cb 100644 --- a/docs/jsdoc/sessions_ccg-session.ts.html +++ b/docs/jsdoc/sessions_ccg-session.ts.html @@ -124,10 +124,7 @@

Source: sessions/ccg-session.ts

getAccessToken(options?: TokenRequestOptions) { // If the current token is no longer fresh, get a new token. All incoming // requests will be held until a fresh token is retrieved. - var expirationBuffer = Math.max( - this._config.expiredBufferMS, - this._config.staleBufferMS - ); + var expirationBuffer = this._config.expiredBufferMS; if ( !this._tokenInfo || !this._tokenManager.isAccessTokenValid(this._tokenInfo, expirationBuffer) @@ -191,13 +188,13 @@

Source: sessions/ccg-session.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/sessions_persistent-session.ts.html b/docs/jsdoc/sessions_persistent-session.ts.html index aab44611..fa76ee4e 100644 --- a/docs/jsdoc/sessions_persistent-session.ts.html +++ b/docs/jsdoc/sessions_persistent-session.ts.html @@ -253,10 +253,7 @@

Source: sessions/persistent-session.ts

*/ getAccessToken(options?: TokenRequestOptions) { // If our tokens are not fresh, we need to refresh them - const expirationBuffer = Math.max( - this._config.expiredBufferMS, - this._config.staleBufferMS - ); + const expirationBuffer = this._config.expiredBufferMS; if ( !this._tokenManager.isAccessTokenValid(this._tokenInfo, expirationBuffer) ) { @@ -343,13 +340,13 @@

Source: sessions/persistent-session.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/token-manager.ts.html b/docs/jsdoc/token-manager.ts.html index 7a578c3f..7cec4a7f 100644 --- a/docs/jsdoc/token-manager.ts.html +++ b/docs/jsdoc/token-manager.ts.html @@ -674,13 +674,13 @@

Source: token-manager.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_config.ts.html b/docs/jsdoc/util_config.ts.html index faf828e9..d89f9d3e 100644 --- a/docs/jsdoc/util_config.ts.html +++ b/docs/jsdoc/util_config.ts.html @@ -118,7 +118,6 @@

Source: util/config.ts

numMaxRetries: 5, retryStrategy: null, expiredBufferMS: 180000, - staleBufferMS: 0, // DEPRECATED -- token expiration buffer will be max(expiredBufferMS, staleBufferMS) appAuth: undefined, iterators: false, enterpriseID: undefined, @@ -339,13 +338,13 @@

Source: util/config.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_errors.ts.html b/docs/jsdoc/util_errors.ts.html index e4ba55cf..2d80ca59 100644 --- a/docs/jsdoc/util_errors.ts.html +++ b/docs/jsdoc/util_errors.ts.html @@ -214,13 +214,13 @@

Source: util/errors.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_exponential-backoff.ts.html b/docs/jsdoc/util_exponential-backoff.ts.html index 50fa5a39..2ddc6389 100644 --- a/docs/jsdoc/util_exponential-backoff.ts.html +++ b/docs/jsdoc/util_exponential-backoff.ts.html @@ -61,13 +61,13 @@

Source: util/exponential-backoff.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_paging-iterator.ts.html b/docs/jsdoc/util_paging-iterator.ts.html index 2d2778ba..a8625f48 100644 --- a/docs/jsdoc/util_paging-iterator.ts.html +++ b/docs/jsdoc/util_paging-iterator.ts.html @@ -288,13 +288,13 @@

Source: util/paging-iterator.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/docs/jsdoc/util_url-path.ts.html b/docs/jsdoc/util_url-path.ts.html index c8c0179b..bf880603 100644 --- a/docs/jsdoc/util_url-path.ts.html +++ b/docs/jsdoc/util_url-path.ts.html @@ -91,13 +91,13 @@

Source: util/url-path.ts


- Documentation generated by JSDoc 3.6.11 on Thu May 11 2023 06:02:58 GMT-0700 (Pacific Daylight Time) + Documentation generated by JSDoc 3.6.11 on Tue May 23 2023 02:09:35 GMT-0700 (Pacific Daylight Time)
diff --git a/examples/app-auth/package.json b/examples/app-auth/package.json index ce68d0b4..d6a52c1d 100644 --- a/examples/app-auth/package.json +++ b/examples/app-auth/package.json @@ -12,7 +12,7 @@ "license": "Apache-2.0", "dependencies": { "body-parser": "^1.15.0", - "box-node-sdk": "^2.10.0", + "box-node-sdk": "^3.0.0", "express": "^4.13.4", "express-formidable": "^0.1.2", "express-handlebars": "^3.0.0", diff --git a/package-lock.json b/package-lock.json index 578f3c2c..0551dcd7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "box-node-sdk", - "version": "2.10.0", + "version": "3.0.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index b21daa5a..4c1ce4bb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "box-node-sdk", "author": "Box ", - "version": "2.10.0", + "version": "3.0.0", "description": "Official SDK for Box Plaform APIs", "license": "Apache-2.0", "repository": {