codegen output 4db10943597d42a59fb95dab8dec4ddf (#40)

Author: box-sdk-build

docs/authentication.md

@@ -13,6 +13,12 @@
     - [Obtaining User token](#obtaining-user-token)
     - [Switching between Service Account and User](#switching-between-service-account-and-user)
   - [OAuth 2.0 Auth](#oauth-20-auth)
+    - [Authentication with OAuth2](#authentication-with-oauth2)
+    - [Downscoping tokens](#downscoping-tokens)
+- [Token storage](#token-storage)
+  - [In-memory token storage](#in-memory-token-storage)
+  - [Custom storage](#custom-storage)
+- [Setting as-user header](#setting-as-user-header)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -246,6 +252,8 @@ to authenticate as User with provided ID. The new token will be automatically fe
 
 ## OAuth 2.0 Auth
 
+### Authentication with OAuth2
+
 If your application needs to integrate with existing Box users who will provide
 their login credentials to grant your application access to their account, you
 will need to go through the standard OAuth2 login flow. A detailed guide for
@@ -287,6 +295,35 @@ You need to provide the auth code to the SDK to obtain an access token, then you
 await oauth.getTokensAuthorizationCodeGrant('code');
 ```
 
+### Revoking tokens
+
+Access tokens for a client can be revoked when needed. As this removes the client's way of authenticating this client can no
+longer be used after this call. This method is only available for OAuth2 clients.
+
+To revoke current client's tokens in the storage use the following code:
+
+<!-- sample post_oauth2_revoke -->
+
+```js
+await oauth.revokeTokens();
+// client's tokens have been revoked
+```
+
+### Downscoping tokens
+
+You can exchange a client's access token for one with a lower scope, in order
+to restrict the permissions for a child client or to pass to a less secure
+location (e.g. a browser-based app). This method is only available for OAuth2 clients.
+
+For example to exchange the client's token for one with scopes to upload and delete items, but not to view their contents, which would be suitable for an less-trusted server-side process; use the following code:
+
+<!-- sample post_oauth2_token downscope_token -->
+
+```js
+let accessToken = await oauth.downscopeToken(['item_upload', 'item_delete']);
+// accessToken contains the new downscoped access token
+```
+
 # Token storage
 
 ## In-memory token storage

docs/authorization.md

@@ -25,6 +25,8 @@ _Currently we don't have an example for calling `getAuthorize` in integration te
   - Query parameters of getAuthorize method
 - headers `GetAuthorizeHeadersArg`
   - Headers of getAuthorize method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/avatars.md

@@ -25,6 +25,8 @@ await client.avatars.getUserAvatar(user.id);
   - The ID of the user. Example: "12345"
 - headers `GetUserAvatarHeadersArg`
   - Headers of getUserAvatar method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -63,6 +65,8 @@ await client.avatars.createUserAvatar(user.id, {
   - Request body of createUserAvatar method
 - headers `CreateUserAvatarHeadersArg`
   - Headers of createUserAvatar method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -94,6 +98,8 @@ await client.avatars.deleteUserAvatar(user.id);
   - The ID of the user. Example: "12345"
 - headers `DeleteUserAvatarHeadersArg`
   - Headers of deleteUserAvatar method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/chunkedUploads.md

@@ -29,6 +29,8 @@ _Currently we don't have an example for calling `createFileUploadSession` in int
   - Request body of createFileUploadSession method
 - headers `CreateFileUploadSessionHeadersArg`
   - Headers of createFileUploadSession method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -55,6 +57,8 @@ _Currently we don't have an example for calling `createFileUploadSessionForExist
   - Request body of createFileUploadSessionForExistingFile method
 - headers `CreateFileUploadSessionForExistingFileHeadersArg`
   - Headers of createFileUploadSessionForExistingFile method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -79,6 +83,8 @@ _Currently we don't have an example for calling `getFileUploadSessionById` in in
   - The ID of the upload session. Example: "D5E3F7A"
 - headers `GetFileUploadSessionByIdHeadersArg`
   - Headers of getFileUploadSessionById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -105,6 +111,8 @@ _Currently we don't have an example for calling `uploadFilePart` in integration
   - Request body of uploadFilePart method
 - headers `UploadFilePartHeadersArg`
   - Headers of uploadFilePart method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -131,6 +139,8 @@ _Currently we don't have an example for calling `deleteFileUploadSessionById` in
   - The ID of the upload session. Example: "D5E3F7A"
 - headers `DeleteFileUploadSessionByIdHeadersArg`
   - Headers of deleteFileUploadSessionById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -159,6 +169,8 @@ _Currently we don't have an example for calling `getFileUploadSessionParts` in i
   - Query parameters of getFileUploadSessionParts method
 - headers `GetFileUploadSessionPartsHeadersArg`
   - Headers of getFileUploadSessionParts method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -186,6 +198,8 @@ _Currently we don't have an example for calling `createFileUploadSessionCommit`
   - Request body of createFileUploadSessionCommit method
 - headers `CreateFileUploadSessionCommitHeadersArg`
   - Headers of createFileUploadSessionCommit method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/classifications.md

@@ -27,6 +27,8 @@ _Currently we don't have an example for calling `getMetadataTemplateEnterpriseSe
 
 - headers `GetMetadataTemplateEnterpriseSecurityClassificationSchemaHeadersArg`
   - Headers of getMetadataTemplateEnterpriseSecurityClassificationSchema method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -52,6 +54,8 @@ _Currently we don't have an example for calling `deleteMetadataTemplateEnterpris
 
 - headers `DeleteMetadataTemplateEnterpriseSecurityClassificationSchemaHeadersArg`
   - Headers of deleteMetadataTemplateEnterpriseSecurityClassificationSchema method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -82,6 +86,8 @@ _Currently we don't have an example for calling `updateMetadataTemplateEnterpris
   - Request body of updateMetadataTemplateEnterpriseSecurityClassificationSchemaAdd method
 - headers `UpdateMetadataTemplateEnterpriseSecurityClassificationSchemaAddHeadersArg`
   - Headers of updateMetadataTemplateEnterpriseSecurityClassificationSchemaAdd method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -113,6 +119,8 @@ _Currently we don't have an example for calling `updateMetadataTemplateEnterpris
   - Request body of updateMetadataTemplateEnterpriseSecurityClassificationSchemaUpdate method
 - headers `UpdateMetadataTemplateEnterpriseSecurityClassificationSchemaUpdateHeadersArg`
   - Headers of updateMetadataTemplateEnterpriseSecurityClassificationSchemaUpdate method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -144,6 +152,8 @@ _Currently we don't have an example for calling `updateMetadataTemplateEnterpris
   - Request body of updateMetadataTemplateEnterpriseSecurityClassificationSchemaDelete method
 - headers `UpdateMetadataTemplateEnterpriseSecurityClassificationSchemaDeleteHeadersArg`
   - Headers of updateMetadataTemplateEnterpriseSecurityClassificationSchemaDelete method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -176,6 +186,8 @@ _Currently we don't have an example for calling `createMetadataTemplateSchemaCla
   - Request body of createMetadataTemplateSchemaClassification method
 - headers `CreateMetadataTemplateSchemaClassificationHeadersArg`
   - Headers of createMetadataTemplateSchemaClassification method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/collaborationAllowlistEntries.md

@@ -27,6 +27,8 @@ await client.collaborationAllowlistEntries.getCollaborationWhitelistEntries();
   - Query parameters of getCollaborationWhitelistEntries method
 - headers `GetCollaborationWhitelistEntriesHeadersArg`
   - Headers of getCollaborationWhitelistEntries method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -59,6 +61,8 @@ await client.collaborationAllowlistEntries.createCollaborationWhitelistEntry({
   - Request body of createCollaborationWhitelistEntry method
 - headers `CreateCollaborationWhitelistEntryHeadersArg`
   - Headers of createCollaborationWhitelistEntry method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -90,6 +94,8 @@ await client.collaborationAllowlistEntries.getCollaborationWhitelistEntryById(
   - The ID of the entry in the list. Example: "213123"
 - headers `GetCollaborationWhitelistEntryByIdHeadersArg`
   - Headers of getCollaborationWhitelistEntryById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -121,6 +127,8 @@ await client.collaborationAllowlistEntries.deleteCollaborationWhitelistEntryById
   - The ID of the entry in the list. Example: "213123"
 - headers `DeleteCollaborationWhitelistEntryByIdHeadersArg`
   - Headers of deleteCollaborationWhitelistEntryById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/collaborationAllowlistExemptTargets.md

@@ -27,6 +27,8 @@ await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExempt
   - Query parameters of getCollaborationWhitelistExemptTargets method
 - headers `GetCollaborationWhitelistExemptTargetsHeadersArg`
   - Headers of getCollaborationWhitelistExemptTargets method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -62,6 +64,8 @@ await client.collaborationAllowlistExemptTargets.createCollaborationWhitelistExe
   - Request body of createCollaborationWhitelistExemptTarget method
 - headers `CreateCollaborationWhitelistExemptTargetHeadersArg`
   - Headers of createCollaborationWhitelistExemptTarget method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -93,6 +97,8 @@ await client.collaborationAllowlistExemptTargets.getCollaborationWhitelistExempt
   - The ID of the exemption to the list. Example: "984923"
 - headers `GetCollaborationWhitelistExemptTargetByIdHeadersArg`
   - Headers of getCollaborationWhitelistExemptTargetById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -124,6 +130,8 @@ await client.collaborationAllowlistExemptTargets.deleteCollaborationWhitelistExe
   - The ID of the exemption to the list. Example: "984923"
 - headers `DeleteCollaborationWhitelistExemptTargetByIdHeadersArg`
   - Headers of deleteCollaborationWhitelistExemptTargetById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/collections.md

@@ -27,6 +27,8 @@ await client.collections.getCollections();
   - Query parameters of getCollections method
 - headers `GetCollectionsHeadersArg`
   - Headers of getCollections method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -58,6 +60,8 @@ await client.collections.getCollectionItems(favouriteCollection.id!);
   - Query parameters of getCollectionItems method
 - headers `GetCollectionItemsHeadersArg`
   - Headers of getCollectionItems method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/comments.md

@@ -29,6 +29,8 @@ await client.comments.getFileComments(fileId);
   - Query parameters of getFileComments method
 - headers `GetFileCommentsHeadersArg`
   - Headers of getFileComments method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -61,6 +63,8 @@ await client.comments.getCommentById(newComment.id!);
   - Query parameters of getCommentById method
 - headers `GetCommentByIdHeadersArg`
   - Headers of getCommentById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -95,6 +99,8 @@ await client.comments.updateCommentById(newReplyComment.id!, {
   - Query parameters of updateCommentById method
 - headers `UpdateCommentByIdHeadersArg`
   - Headers of updateCommentById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -123,6 +129,8 @@ await client.comments.deleteCommentById(newComment.id!);
   - The ID of the comment. Example: "12345"
 - headers `DeleteCommentByIdHeadersArg`
   - Headers of deleteCommentById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -160,6 +168,8 @@ await client.comments.createComment({
   - Query parameters of createComment method
 - headers `CreateCommentHeadersArg`
   - Headers of createComment method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 

docs/devicePinners.md

@@ -21,6 +21,8 @@ _Currently we don't have an example for calling `getDevicePinnerById` in integra
   - The ID of the device pin Example: "2324234"
 - headers `GetDevicePinnerByIdHeadersArg`
   - Headers of getDevicePinnerById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -45,6 +47,8 @@ _Currently we don't have an example for calling `deleteDevicePinnerById` in inte
   - The ID of the device pin Example: "2324234"
 - headers `DeleteDevicePinnerByIdHeadersArg`
   - Headers of deleteDevicePinnerById method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns
 
@@ -74,6 +78,8 @@ _Currently we don't have an example for calling `getEnterpriseDevicePinners` in
   - Query parameters of getEnterpriseDevicePinners method
 - headers `GetEnterpriseDevicePinnersHeadersArg`
   - Headers of getEnterpriseDevicePinners method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
 
 ### Returns