generated with codegen at box/box-codegen@23a331c6 and spec at box/box-openapi@d4c873b (#41)

Author: box-sdk-build

.github/workflows/build_and_test.yml

@@ -33,6 +33,7 @@ jobs:
           CLIENT_SECRET: ${{ secrets.CLIENT_SECRET }}
           USER_ID: ${{ secrets.USER_ID }}
           ENTERPRISE_ID: ${{ secrets.ENTERPRISE_ID }}
+          BOX_FILE_REQUEST_ID: ${{ secrets.BOX_FILE_REQUEST_ID }}
       - name: Coveralls
         uses: coverallsapp/github-action@master
         with:

README.md

@@ -23,6 +23,10 @@ Embrace the new generation of Box SDKs and unlock the full potential of the Box
 
 - [Installing](#installing)
 - [Getting Started](#getting-started)
+- [Integration Tests](#integration-tests)
+  - [Running integration tests locally](#running-integration-tests-locally)
+    - [Create Custom Application](#create-custom-application)
+    - [Export configuration](#export-configuration)
 - [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
 - [Copyright and License](#copyright-and-license)
 
@@ -69,6 +73,29 @@ async function main(token) {
 main('INSERT YOUR DEVELOPER TOKEN HERE');
 ```
 
+# Integration Tests
+
+## Running integration tests locally
+
+### Create Custom Application
+
+To run integration tests locally you will need a `Custom App` created in the [Box Developer
+Console](https://app.box.com/developers/console) with `Server Authentication (with JWT)` selected as authentication method.
+Once created you can edit properties of the application:
+
+- In section `App Access Level` select `App + Enterprise Access`. You can enable all `Application Scopes`.
+- In section `Advanced Features` enable `Make API calls using the as-user header` and `Generate user access tokens`.
+
+Now select `Authorization` and submit application to be reviewed by account admin.
+
+### Export configuration
+
+1. Select `Configuration` tab and in the bottom in the section `App Settings`
+   download your app configuration settings as JSON.
+2. Encode configuration file to Base64, e.g. using command: `base64 -i path_to_json_file`
+3. Set environment variable: `JWT_CONFIG_BASE_64` with base64 encoded jwt configuration file
+4. Set environment variable: `BOX_FILE_REQUEST_ID` with ID of file request already created in the user account.
+
 # Questions, Bugs, and Feature Requests?
 
 Need to contact us directly? [Browse the issues

docs/authentication.md

@@ -18,7 +18,6 @@
 - [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 -->
 
@@ -354,11 +353,3 @@ const config = {
 };
 const oauth = new BoxOAuth({ config: config });
 ```
-
-# Setting as-user header
-
-Use the code below to set the as-user header for your current client
-
-```js
-client.networkSession!.setAsUserId('id');
-```

docs/chunkedUploads.md

@@ -255,3 +255,5 @@ await client.chunkedUploads.uploadBigFile(
   - The total size of the file for the chunked upload in bytes.
 - parentFolderId `string`
   - The ID of the folder where the file should be uploaded.
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.

docs/client.md

@@ -0,0 +1,63 @@
+# Client
+
+This is the central entrypoint for all SDK interaction. The BoxClient houses all the API endpoints
+divided across resource managers.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Additional headers](#additional-headers)
+  - [As-User header](#as-user-header)
+  - [Suppress notifications](#suppress-notifications)
+  - [Custom headers](#custom-headers)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# Additional headers
+
+BoxClient provides a convenient methods, which allow passing additional headers, which will be included
+in every API call made by the client.
+
+## As-User header
+
+The As-User header is used by enterprise admins to make API calls on behalf of their enterprise's users.
+This requires the API request to pass an As-User: USER-ID header. For more details see the [documentation on As-User](https://developer.box.com/en/guides/authentication/oauth2/as-user/).
+
+The following example assume that the client has been instantiated with an access token belonging to an admin-level user
+or Service Account with appropriate privileges to make As-User calls.
+
+Calling the `client.withAsUserHeader()` method creates a new client to impersonate user with the provided ID.
+All calls made with the new client will be made in context of the impersonated user, leaving the original client unmodified.
+
+<!-- sample x_auth init_with_as_user_header -->
+
+```js
+const userClient = client.withAsUserHeader('1234567');
+```
+
+## Suppress notifications
+
+If you are making administrative API calls (that is, your application has “Manage an Enterprise”
+scope, and the user signing in is a co-admin with the correct "Edit settings for your company"
+permission) then you can suppress both email and webhook notifications. This can be used, for
+example, for a virus-scanning tool to download copies of everyone’s files in an enterprise,
+without every collaborator on the file getting an email. All actions will still appear in users'
+updates feed and audit logs.
+
+> **Note:** This functionality is only available for approved applications.
+
+Calling the `client.withSuppressedNotifications()` method creates a new client.
+For all calls made with the new client the notifications will be suppressed.
+
+```js
+const newClient = client.withSuppressedNotifications();
+```
+
+## Custom headers
+
+You can also specify the custom set of headers, which will be included in every API call made by client.
+Calling the `client.withExtraHeaders()` method creates a new client, leaving the original client unmodified.
+
+```js
+const newClient = client.withExtraHeaders({ ['customHeader']: 'customValue' });
+```

docs/fileRequests.md

@@ -14,7 +14,11 @@ This operation is performed by calling function `getFileRequestById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-file-requests-id/).
 
-_Currently we don't have an example for calling `getFileRequestById` in integration tests_
+<!-- sample get_file_requests_id -->
+
+```ts
+await client.fileRequests.getFileRequestById(updatedFileRequest.id);
+```
 
 ### Arguments
 
@@ -41,7 +45,14 @@ This operation is performed by calling function `updateFileRequestById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/put-file-requests-id/).
 
-_Currently we don't have an example for calling `updateFileRequestById` in integration tests_
+<!-- sample put_file_requests_id -->
+
+```ts
+await client.fileRequests.updateFileRequestById(copiedFileRequest.id, {
+  title: 'updated title',
+  description: 'updated description',
+} satisfies FileRequestUpdateRequest);
+```
 
 ### Arguments
 
@@ -69,7 +80,11 @@ This operation is performed by calling function `deleteFileRequestById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/delete-file-requests-id/).
 
-_Currently we don't have an example for calling `deleteFileRequestById` in integration tests_
+<!-- sample delete_file_requests_id -->
+
+```ts
+await client.fileRequests.deleteFileRequestById(updatedFileRequest.id);
+```
 
 ### Arguments
 
@@ -97,7 +112,16 @@ This operation is performed by calling function `createFileRequestCopy`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/post-file-requests-id-copy/).
 
-_Currently we don't have an example for calling `createFileRequestCopy` in integration tests_
+<!-- sample post_file_requests_id_copy -->
+
+```ts
+await client.fileRequests.createFileRequestCopy(fileRequestId, {
+  folder: {
+    id: fileRequest.folder.id,
+    type: 'folder' as FileRequestCopyRequestFolderFieldTypeField,
+  } satisfies FileRequestCopyRequestFolderField,
+} satisfies FileRequestCopyRequest);
+```
 
 ### Arguments
 

docs/legalHoldPolicies.md

@@ -16,7 +16,11 @@ This operation is performed by calling function `getLegalHoldPolicies`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-legal-hold-policies/).
 
-_Currently we don't have an example for calling `getLegalHoldPolicies` in integration tests_
+<!-- sample get_legal_hold_policies -->
+
+```ts
+await client.legalHoldPolicies.getLegalHoldPolicies();
+```
 
 ### Arguments
 
@@ -42,7 +46,15 @@ This operation is performed by calling function `createLegalHoldPolicy`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/post-legal-hold-policies/).
 
-_Currently we don't have an example for calling `createLegalHoldPolicy` in integration tests_
+<!-- sample post_legal_hold_policies -->
+
+```ts
+await client.legalHoldPolicies.createLegalHoldPolicy({
+  policyName: legalHoldPolicyName,
+  description: legalHoldDescription,
+  isOngoing: true,
+} satisfies CreateLegalHoldPolicyRequestBodyArg);
+```
 
 ### Arguments
 
@@ -68,7 +80,11 @@ This operation is performed by calling function `getLegalHoldPolicyById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-legal-hold-policies-id/).
 
-_Currently we don't have an example for calling `getLegalHoldPolicyById` in integration tests_
+<!-- sample get_legal_hold_policies_id -->
+
+```ts
+await client.legalHoldPolicies.getLegalHoldPolicyById(legalHoldPolicyId);
+```
 
 ### Arguments
 
@@ -94,7 +110,13 @@ This operation is performed by calling function `updateLegalHoldPolicyById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/put-legal-hold-policies-id/).
 
-_Currently we don't have an example for calling `updateLegalHoldPolicyById` in integration tests_
+<!-- sample put_legal_hold_policies_id -->
+
+```ts
+await client.legalHoldPolicies.updateLegalHoldPolicyById(legalHoldPolicyId, {
+  policyName: updatedLegalHoldPolicyName,
+} satisfies UpdateLegalHoldPolicyByIdRequestBodyArg);
+```
 
 ### Arguments
 
@@ -125,7 +147,11 @@ This operation is performed by calling function `deleteLegalHoldPolicyById`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/delete-legal-hold-policies-id/).
 
-_Currently we don't have an example for calling `deleteLegalHoldPolicyById` in integration tests_
+<!-- sample delete_legal_hold_policies_id -->
+
+```ts
+await client.legalHoldPolicies.deleteLegalHoldPolicyById(legalHoldPolicyId);
+```
 
 ### Arguments
 

docs/zipDownloads.md

@@ -3,6 +3,7 @@
 - [Create zip download](#create-zip-download)
 - [Download zip archive](#download-zip-archive)
 - [Get zip download status](#get-zip-download-status)
+- [](#)
 
 ## Create zip download
 
@@ -28,7 +29,27 @@ This operation is performed by calling function `createZipDownload`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/post-zip-downloads/).
 
-_Currently we don't have an example for calling `createZipDownload` in integration tests_
+<!-- sample post_zip_downloads -->
+
+```ts
+await client.zipDownloads.createZipDownload({
+  items: [
+    {
+      id: file1.id,
+      type: 'file' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+    {
+      id: file2.id,
+      type: 'file' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+    {
+      id: folder1.id,
+      type: 'folder' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+  ],
+  downloadFileName: 'zip',
+} satisfies ZipDownloadRequest);
+```
 
 ### Arguments
 
@@ -68,12 +89,16 @@ This operation is performed by calling function `getZipDownloadContent`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-zip-downloads-id-content/).
 
-_Currently we don't have an example for calling `getZipDownloadContent` in integration tests_
+<!-- sample get_zip_downloads_id_content -->
+
+```ts
+await client.zipDownloads.getZipDownloadContent(zipDownload.downloadUrl!);
+```
 
 ### Arguments
 
-- zipDownloadId `string`
-  - The unique identifier that represent this `zip` archive. Example: "Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd"
+- downloadUrl `string`
+  - The URL that can be used to download created `zip` archive. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content`
 - headers `GetZipDownloadContentHeadersArg`
   - Headers of getZipDownloadContent method
 - cancellationToken `undefined | CancellationToken`
@@ -106,12 +131,16 @@ This operation is performed by calling function `getZipDownloadStatus`.
 See the endpoint docs at
 [API Reference](https://developer.box.com/reference/get-zip-downloads-id-status/).
 
-_Currently we don't have an example for calling `getZipDownloadStatus` in integration tests_
+<!-- sample get_zip_downloads_id_status -->
+
+```ts
+await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);
+```
 
 ### Arguments
 
-- zipDownloadId `string`
-  - The unique identifier that represent this `zip` archive. Example: "Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd"
+- statusUrl `string`
+  - The URL that can be used to get the status of the `zip` archive being downloaded. Example: `https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status`
 - headers `GetZipDownloadStatusHeadersArg`
   - Headers of getZipDownloadStatus method
 - cancellationToken `undefined | CancellationToken`
@@ -122,3 +151,45 @@ _Currently we don't have an example for calling `getZipDownloadStatus` in integr
 This function returns a value of type `ZipDownloadStatus`.
 
 Returns the status of the `zip` archive that is being downloaded.
+
+##
+
+This operation is performed by calling function `downloadZip`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference//).
+
+<!-- sample  -->
+
+```ts
+await client.zipDownloads.downloadZip({
+  items: [
+    {
+      id: file1.id,
+      type: 'file' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+    {
+      id: file2.id,
+      type: 'file' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+    {
+      id: folder1.id,
+      type: 'folder' as ZipDownloadRequestItemsFieldTypeField,
+    } satisfies ZipDownloadRequestItemsField,
+  ],
+  downloadFileName: 'zip',
+} satisfies ZipDownloadRequest);
+```
+
+### Arguments
+
+- requestBody `ZipDownloadRequest`
+  - Zip download request body
+- headers `DownloadZipHeadersArg`
+  - Headers of zip download method
+- cancellationToken `undefined | CancellationToken`
+  - Token used for request cancellation.
+
+### Returns
+
+This function returns a value of type `ByteStream`.