Box TypeScript SDK Gen

https://github.com/box/box-typescript-sdk-gen
Admin
An auto-generated TypeScript SDK for the Box Content Cloud API with comprehensive API support, rapid...
Tokens:179,190
Snippets:1,356
Trust Score:9.9
License:Apache-2.0
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install dependencies with npm install

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/test-browser/README.md

Install the project dependencies. Required before running the test runner.

```bash
npm install
```

--------------------------------

### Install with yarn

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/README.md

Install the Box TypeScript SDK Gen package using yarn.

```console
yarn add box-typescript-sdk-gen
```

--------------------------------

### Install with npm

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/README.md

Install the Box TypeScript SDK Gen package using npm.

```console
npm install box-typescript-sdk-gen
```

--------------------------------

### Legacy chunked upload with getChunkedUploader and start

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/migration-guide.md

In the legacy Box Node SDK, create a chunked uploader with getChunkedUploader(parentFolderId, fileSize, fileName, stream) and start the upload with start().

```typescript
var stream = fs.createReadStream('/path/to/file.txt');
var fileName = 'new_name.txt';
var fileSize = fs.statSync('/path/to/file.txt').size;
var parentFolderId = '0';
client.files
  .getChunkedUploader(parentFolderId, fileSize, fileName, stream)
  .then((uploader) => uploader.start())
  .then((file) => {
    /* ... */
  });
```

--------------------------------

### Start workflow with startWorkflow

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/workflows.md

Calls startWorkflow to initiate a workflow with a manual start trigger. Requires the 'Manage Box Relay' application scope. Returns undefined.

```TypeScript
await adminClient.workflows.startWorkflow(workflowToRun.id!, {
  type: 'workflow_parameters' as StartWorkflowRequestBodyTypeField,
  flow: {
    type: 'flow',
    id: workflowToRun.flows![0].id!,
  } satisfies StartWorkflowRequestBodyFlowField,
  files: [
    {
      type: 'file' as StartWorkflowRequestBodyFilesTypeField,
      id: workflowFileId,
    } satisfies StartWorkflowRequestBodyFilesField,
  ],
  folder: {
    type: 'folder' as StartWorkflowRequestBodyFolderTypeField,
    id: workflowFolderId,
  } satisfies StartWorkflowRequestBodyFolderField,
} satisfies StartWorkflowRequestBody);
```

--------------------------------

### GET /2.0/files/{file_id}/content

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Demonstrates making a custom GET request to download a file's content as a binary stream using the client.makeRequest() method.

```APIDOC
## [GET] /2.0/files/{file_id}/content

### Description
Downloads a file's content as a binary stream using a custom request.

### Method
GET

### Endpoint
https://api.box.com/2.0/files/{file_id}/content

### Parameters
#### Path Parameters
- **file_id** (string) - Required - The ID of the file to download.

### Request Example
GET https://api.box.com/2.0/files/{file_id}/content

### Response
#### Success Response (200)
- **status** (number) - The HTTP status code.
- **content** (stream) - The binary file content stream.

#### Response Example
{
  "status": 200,
  "content": "<binary stream>"
}
```

--------------------------------

### transferOwnedFolder API call example

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/transfer.md

Example of calling transferOwnedFolder to move all items from a source user to a target user. Requires admin permissions and the 'Read and write all files and folders stored in Box' scope. The operation may run asynchronously for large numbers of items, and the destination folder is named '{User}'s Files and Folders'.

```TypeScript
await client.transfer.transferOwnedFolder(
  sourceUser.id,
  {
    ownedBy: {
      id: targetUser.id,
    } satisfies TransferOwnedFolderRequestBodyOwnedByField,
  } satisfies TransferOwnedFolderRequestBody,
  {
    queryParams: { notify: false } satisfies TransferOwnedFolderQueryParams,
  } satisfies TransferOwnedFolderOptionalsInput,
);
```

--------------------------------

### Get AI agent by ID with getAiAgentById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/aiStudio.md

Gets an AI agent using the agent_id parameter. The example passes the created agent's ID and requests only the 'ask' field. Returns an AiSingleAgentResponseFull.

```TypeScript
await client.aiStudio.getAiAgentById(createdAgent.id, {
  queryParams: { fields: ['ask'] } satisfies GetAiAgentByIdQueryParams,
} satisfies GetAiAgentByIdOptionalsInput);
```

--------------------------------

### uploadBigFile

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/chunkedUploads.md

Starts the process of chunk uploading a big file. Returns a File object representing the uploaded file.

```APIDOC
## Function: uploadBigFile

### Description
Starts the process of chunk uploading a big file. Should return a File object representing the uploaded file.

### Method
Function

### Endpoint
client.chunkedUploads.uploadBigFile(fileByteStream, fileName, fileSize, parentFolderId)

### Parameters
#### Arguments
- **file** (ByteStream) - Required - The stream of the file to upload.
- **fileName** (string) - Required - The name of the file, which will be used for storage in Box.
- **fileSize** (number) - Required - The total size of the file for the chunked upload in bytes.
- **parentFolderId** (string) - Required - The ID of the folder where the file should be uploaded.
- **cancellationToken** (undefined | CancellationToken) - Optional - Token used for request cancellation.

### Request Example
```typescript
await client.chunkedUploads.uploadBigFile(
  fileByteStream,
  fileName,
  fileSize,
  parentFolderId,
);
```

### Response
#### Success Response
- **FileFull** - The uploaded file object.

#### Response Example
```json
{
  "id": "string",
  "type": "file",
  "name": "string"
}
```
```

--------------------------------

### GET /zip_downloads/{zip_download_id}/status

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/zipDownloads.md

Returns the download status of a zip archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. This endpoint can only be accessed once the download has started and is valid for 12 hours from the start of the download.

```APIDOC
## GET /zip_downloads/{zip_download_id}/status

### Description
Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. This endpoint can only be accessed once the download has started and is valid for 12 hours from the start of the download.

### Method
GET

### Endpoint
`/zip_downloads/{zip_download_id}/status`

### Parameters
#### Path Parameters
- **zip_download_id** (string) - Required - The ID of the zip download.

### Response
#### Success Response (200)
Returns the status of the `zip` archive that is being downloaded.

#### Response Example
```json
{
  "state": "succeeded",
  "total_files": 3,
  "downloaded_files": 3,
  "skipped_files": 0
}
```
```

--------------------------------

### Authenticate and list root folder items

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/README.md

Authenticate with a Developer Token and list items in the root folder. Replace the placeholder token with your own from the Box Developer Console.

```js
const { BoxClient, BoxDeveloperTokenAuth } = require('box-typescript-sdk-gen');

async function main(token) {
  let auth = new BoxDeveloperTokenAuth({ token });
  let client = new BoxClient({ auth });
  let entries = (await client.folders.getFolderItems('0')).entries;
  entries.forEach((entry) => console.log(entry));
}

main('INSERT YOUR DEVELOPER TOKEN HERE');
```

--------------------------------

### Get Box Sign template by ID with getSignTemplateById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/signTemplates.md

Fetches details of a specific template using its ID. The example uses the first entry from a previously retrieved SignTemplates collection.

```TypeScript
await client.signTemplates.getSignTemplateById(signTemplates.entries![0].id!);
```

--------------------------------

### Make custom JSON POST request with client.makeRequest()

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Makes a custom POST request to create a new folder in the root folder using client.makeRequest(). The method accepts a FetchOptions object and returns a FetchResponse. The response status and created folder name are logged.

```javascript
const response: FetchResponse = await client.makeRequest(
    { method: "POST",
      url: "https://api.box.com/2.0/folders",
      data: {name: newFolderName, parent: {id: "0"}}
    } satisfies FetchOptionsInput
);
console.log('Received status code: ', response.status)
console.log('Created folder name: ', getSdValueByKey(response.content, "name"))
```

--------------------------------

### Get shield information barrier by ID

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/shieldInformationBarriers.md

Retrieves a shield information barrier by its ID. The `barrierId` variable should be a string, for example "1910967". Returns a `ShieldInformationBarrier` object.

```ts
await client.shieldInformationBarriers.getShieldInformationBarrierById(
  barrierId,
);
```

--------------------------------

### Create folder with createFolder

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/folders.md

Creates a new empty folder within the specified parent folder. The example uses the root folder '0' as the parent and sets the folder name. Returns a FolderFull object.

```TypeScript
await client.folders.createFolder({
  name: newFolderName,
  parent: { id: '0' } satisfies CreateFolderRequestBodyParentField,
} satisfies CreateFolderRequestBody);
```

--------------------------------

### Get classification on folder

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/folderClassifications.md

Retrieves the classification metadata instance applied to a folder. This example calls the `getClassificationOnFolder` function on the client, passing the folder ID. Returns a `Classification` object containing the `Box__Security__Classification__Key` field.

```TypeScript
await client.folderClassifications.getClassificationOnFolder(folder.id);
```

--------------------------------

### Get zip download status with getZipDownloadStatus

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/zipDownloads.md

Returns the download status of a zip archive. The statusUrl must be obtained from the Create zip download API response. This endpoint is valid for 12 hours from the start of the download.

```ts
await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);
```

--------------------------------

### Get retention on file with getFileVersionRetentionById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileVersionRetentions.md

Returns information about a file version retention. This method is deprecated; use the files under retention or file versions under retention endpoints instead. The example passes the fileVersionRetention.id as the required argument.

```ts
await client.fileVersionRetentions.getFileVersionRetentionById(
  fileVersionRetention.id!,
);
```

--------------------------------

### Use client.withProxy() to configure a proxy

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Creates a new client configured to use a proxy for API calls. The original client remains unmodified. Username and password are optional. Only http/s proxies with basic authentication are supported; NTLM and other authentication methods are not supported. If both custom agent options and proxy are provided, the proxy takes precedence.

```javascript
newClient = client.withProxy({
  url: 'http://127.0.0.1:1234/',
  username: 'user',
  password: 'password',
});
```

--------------------------------

### Get file version legal hold by ID

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileVersionLegalHolds.md

Retrieves information about the legal hold policies assigned to a file version. The fileVersionLegalHoldId argument is the ID of the file version legal hold, for example "2348213". Returns a FileVersionLegalHold object.

```ts
await client.fileVersionLegalHolds.getFileVersionLegalHoldById(
  fileVersionLegalHoldId,
);
```

--------------------------------

### withCustomBaseUrls

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Creates a new client with custom base URLs for API calls. The original client remains unmodified.

```javascript
const newClient = client.withCustomBaseUrls({
  baseUrl: 'https://api.box.com',
  uploadUrl: 'https://upload.box.com/api',
  oauth2Url: 'https://account.box.com/api/oauth2',
});
```

--------------------------------

### Create folder metadata with createFolderMetadataById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/folderMetadata.md

Applies a metadata template instance to a folder. The example uses the 'enterprise' scope and a template key, providing values for name, age, birthDate, countryCode, and sports. Only values present in the template are accepted, except for the global.properties template which accepts any key-value pair. Requires the enterprise to have Cascading Folder Level Metadata enabled in the admin console.

```typescript
await client.folderMetadata.createFolderMetadataById(
  folder.id,
  'enterprise' as CreateFolderMetadataByIdScope,
  templateKey,
  {
    ['name']: 'John',
    ['age']: 23,
    ['birthDate']: '2001-01-03T02:20:50.520Z',
    ['countryCode']: 'US',
    ['sports']: ['basketball', 'tennis'],
  },
);
```

--------------------------------

### Get classification on file

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileClassifications.md

Retrieves the classification metadata instance applied to a file. The API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`. This operation is performed by calling the `getClassificationOnFile` function. The function returns a value of type `Classification`, which contains a `Box__Security__Classification__Key` field listing all classifications available to the enterprise.

```TypeScript
await client.fileClassifications.getClassificationOnFile(file.id);
```

--------------------------------

### Initialize BoxClient with Developer Token

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/authentication.md

Constructs a BoxClient using a developer token for quick testing. The token is short-lived and cannot be refreshed, so it is only suitable for testing with your own account, not for production.

```javascript
import { BoxClient } from 'box-typescript-sdk-gen/client.generated';
import { BoxDeveloperTokenAuth } from 'box-typescript-sdk-gen/box/developerTokenAuth.generated';

const auth = new BoxDeveloperTokenAuth({ token: 'DEVELOPER_TOKEN_GOES_HERE' });
const client = new BoxClient({ auth });

const me = await client.users.getUserMe();
console.log(`My user ID is ${me.id}`);
```

--------------------------------

### Initialize BoxClient with CCGAuth using user credentials

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/authentication.md

Configures CCG auth with a userId, clientId, and clientSecret, creates a client, and calls getUserMe to fetch the current user. The token is refreshed automatically.

```javascript
import { BoxClient } from 'box-typescript-sdk-gen/client.generated';
import {
  BoxCcgAuth,
  CcgConfig,
} from 'box-typescript-sdk-gen/box/ccgAuth.generated';

const ccgConfig = new CcgConfig({
  userId: 'YOUR_USER_ID',
  clientId: 'YOUR_CLIENT_ID',
  clientSecret: 'YOUR_CLIENT_SECRET',
});
const ccgAuth = new BoxCcgAuth({ config: ccgConfig });
const client = new BoxClient({ auth: ccgAuth });

const me = await client.users.getUserMe();
console.log(`My user ID is ${me.id}`);
```

--------------------------------

### Get download URL

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/downloads.md

Get a URL to download a file.

```APIDOC
## [GET] /files/{file_id}/content

### Description
Get a URL to download a file.

### Method
GET

### Endpoint
/files/{file_id}/content

### Parameters
#### Path Parameters
- **fileId** (string) - Required - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

#### Query Parameters
- **optionalsInput** (GetDownloadFileUrlOptionalsInput) - Optional - Optional parameters for the download URL request.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **url** (string) - The download URL.

#### Response Example
```ts
await client.downloads.getDownloadFileUrl(uploadedFile.id);
```
```

--------------------------------

### Impersonate user with client.withAsUserHeader()

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Creates a new client that impersonates the user with the provided ID. All calls made with the new client are in the context of the impersonated user, leaving the original client unmodified. Requires an admin-level access token or Service Account with appropriate privileges.

```js
const userClient = client.withAsUserHeader('1234567');
```

--------------------------------

### withCustomAgentOptions

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Creates a new client with custom agent options. The original client remains unmodified.

```typescript
const options: AgentOptions = {};

const newClient = client.withCustomAgentOptions(options);
```

--------------------------------

### Download a file with downloadFile

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/downloads.md

Downloads a file as an ArrayBuffer and pipes it to a write stream to save it as a PDF. Requires the 'fs' module and a valid file ID.

```js
const fs = require('fs');

const fileContent = await client.downloads.downloadFile('123456789');
const fileWriteStream = fs.createWriteStream('file.pdf');
fileContent.pipe(fileWriteStream);
```

--------------------------------

### GET /shield-information-barriers/{shield_information_barrier_id}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/shieldInformationBarriers.md

Get shield information barrier based on provided ID.

```APIDOC
## [GET] /shield-information-barriers/{shield_information_barrier_id}

### Description
Get shield information barrier based on provided ID.

### Method
GET

### Endpoint
/shield-information-barriers/{shield_information_barrier_id}

### Parameters
#### Path Parameters
- **shield_information_barrier_id** (string) - Required - The ID of the shield information barrier. Example: "1910967"

### Request Example
No request body required.

### Response
#### Success Response (200)
Returns the shield information barrier object.

#### Response Example
```json
{
  "type": "shield_information_barrier",
  "id": "1910967",
  "status": "draft"
}
```
```

--------------------------------

### GET /file_version_legal_holds

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileVersionLegalHolds.md

Get a list of file versions on legal hold for a legal hold assignment.

```APIDOC
## GET /file_version_legal_holds

### Description
Get a list of file versions on legal hold for a legal hold assignment. Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID. Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will be available to request any file versions held in the new architecture. For file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold. The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID. Once the re-architecture is completed this API will be deprecated.

### Method
GET

### Endpoint
/file_version_legal_holds

### Parameters
#### Query Parameters
- **policyId** (string) - Required - The ID of the legal hold policy.

### Request Example
No request body required.

### Response
#### Success Response (200)
Returns the list of file version legal holds for a specific legal hold policy.

#### Response Example
```json
{
  "entries": [
    {
      "type": "file_version_legal_hold",
      "id": "2348213"
    }
  ]
}
```
```

--------------------------------

### Promote File Version with client.fileVersions.promoteFileVersion

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileVersions.md

Calls the `promoteFileVersion` method on a Box client, passing the file ID and a request body specifying the file version to promote. The request body uses the `PromoteFileVersionRequestBody` type with `id` and `type` fields.

```TypeScript
await client.fileVersions.promoteFileVersion(file.id, {
  requestBody: {
    id: fileVersions.entries![0].id,
    type: 'file_version' as PromoteFileVersionRequestBodyTypeField,
  } satisfies PromoteFileVersionRequestBody,
} satisfies PromoteFileVersionOptionalsInput);
```

--------------------------------

### Make custom binary response request with client.makeRequest()

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Makes a custom GET request that expects a binary response by setting responseFormat to "binary" in the FetchOptions object. The response content is piped to a file write stream to save the file.

```javascript
const response: FetchResponse = await client.makeRequest({ method: "GET", url: "".concat("https://api.box.com/2.0/files/", uploadedFile.id, "/content") as string, responseFormat: "binary" as ResponseFormat } satisfies FetchOptionsInput);
console.log('Received status code: ', response.status)
const fileWriteStream = fs.createWriteStream('file.pdf');
response.content.pipe(fileWriteStream);
```

--------------------------------

### Get event stream - getEventStream

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/events.md

Gets an event stream for the Box API. This method returns an EventStream object.

```typescript
client.events.getEventStream();
```

--------------------------------

### GET /files/:id/trash - Get trashed file

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/trashedFiles.md

Retrieves a file that has been moved to the trash. This can only be used if the file itself is in the trash, not if a parent folder was trashed.

```APIDOC
## [GET] /files/:id/trash

### Description
Retrieves a file that has been moved to the trash. This can only be used if the file itself is in the trash, not if a parent folder was trashed. To list all trashed items, use the GET /folders/trash/items endpoint.

### Method
GET

### Endpoint
GET /files/:id/trash

### Parameters
#### Path Parameters
- **fileId** (string) - Required - The unique identifier that represents a file. Example: "12345"

#### Optional Parameters
- **optionalsInput** (GetTrashedFileByIdOptionalsInput) - Optional - Optional parameters for the retrieval operation.

### Request Example
```ts
await client.trashedFiles.getTrashedFileById(file.id);
```

### Response
#### Success Response (200)
Returns the file that was trashed, including information about when it was moved to the trash. The return type is `TrashFile`.
```

--------------------------------

### POST /2.0/folders

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/client.md

Demonstrates making a custom POST request to create a new folder in the root folder using the client.makeRequest() method.

```APIDOC
## [POST] /2.0/folders

### Description
Creates a new folder in the root folder using a custom HTTP request.

### Method
POST

### Endpoint
https://api.box.com/2.0/folders

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new folder.
- **parent** (object) - Required - The parent folder object, containing the `id` of the parent folder.

### Request Example
{
  "name": "newFolderName",
  "parent": {
    "id": "0"
  }
}

### Response
#### Success Response (200)
- **status** (number) - The HTTP status code.
- **content** (object) - The response body, containing the created folder details.

#### Response Example
{
  "status": 201,
  "content": {
    "name": "newFolderName",
    "parent": {
      "id": "0"
    }
  }
}
```

--------------------------------

### Listen to the Box Event Stream (getEventStream)

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/event-stream.md

Set up an event stream by calling client.events.getEventStream(), then attach listeners for 'data', 'error', and 'end' events. The stream starts long-polling asynchronously and forwards received events to listeners; errors and the end of the stream are also emitted.

```ts
const eventsStream = await client.events.getEventStream();
eventsStream.on('data', (event) => {
  console.log('Received event:', event);
});
eventsStream.on('error', (error) => {
  console.error('Error in events stream:', error);
});
eventsStream.on('end', () => {
  console.log('Events stream ended');
});
```

--------------------------------

### Get download URL with getDownloadFileUrl

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/downloads.md

Gets a URL to download a file. The function returns a string value and requires the file ID as an argument.

```ts
await client.downloads.getDownloadFileUrl(uploadedFile.id);
```

--------------------------------

### Create terms of service using createTermsOfService

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/termsOfServices.md

Creates a terms of service for a given enterprise and type of user. The example passes a request body with status, tosType, and text fields, using the 'satisfies' operator to enforce the request body type.

```TypeScript
await client.termsOfServices.createTermsOfService({
  status: 'disabled' as CreateTermsOfServiceRequestBodyStatusField,
  tosType: 'managed' as CreateTermsOfServiceRequestBodyTosTypeField,
  text: 'Test TOS',
} satisfies CreateTermsOfServiceRequestBody);
```

--------------------------------

### List Enterprise Metadata Templates with getEnterpriseMetadataTemplates

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/metadataTemplates.md

Used to retrieve all metadata templates created for the user's enterprise. This example calls the getEnterpriseMetadataTemplates method with no arguments.

```ts
await client.metadataTemplates.getEnterpriseMetadataTemplates();
```

--------------------------------

### Create Metadata Template with createMetadataTemplate

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/metadataTemplates.md

Creates a new metadata template that can be applied to files and folders. The example demonstrates constructing a request body with fields of type string, float, date, enum, and multiSelect, using the satisfies operator for type safety.

```ts
await client.metadataTemplates.createMetadataTemplate({
  scope: 'enterprise',
  displayName: templateKey,
  templateKey: templateKey,
  fields: [
    {
      type: 'string' as CreateMetadataTemplateRequestBodyFieldsTypeField,
      key: 'testName',
      displayName: 'testName',
    } satisfies CreateMetadataTemplateRequestBodyFieldsField,
    {
      type: 'float' as CreateMetadataTemplateRequestBodyFieldsTypeField,
      key: 'age',
      displayName: 'age',
    } satisfies CreateMetadataTemplateRequestBodyFieldsField,
    {
      type: 'date' as CreateMetadataTemplateRequestBodyFieldsTypeField,
      key: 'birthDate',
      displayName: 'birthDate',
    } satisfies CreateMetadataTemplateRequestBodyFieldsField,
    {
      type: 'enum' as CreateMetadataTemplateRequestBodyFieldsTypeField,
      key: 'countryCode',
      displayName: 'countryCode',
      options: [
        {
          key: 'US',
        } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
        {
          key: 'CA',
        } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
      ],
    } satisfies CreateMetadataTemplateRequestBodyFieldsField,
    {
      type: 'multiSelect' as CreateMetadataTemplateRequestBodyFieldsTypeField,
      key: 'sports',
      displayName: 'sports',
      options: [
        {
          key: 'basketball',
        } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
        {
          key: 'football',
        } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
        {
          key: 'tennis',
        } satisfies CreateMetadataTemplateRequestBodyFieldsOptionsField,
      ],
    } satisfies CreateMetadataTemplateRequestBodyFieldsField,
  ],
} satisfies CreateMetadataTemplateRequestBody);
```

--------------------------------

### GET /webhooks/{webhook_id}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/webhooks.md

Retrieves a specific webhook.

```APIDOC
## GET /webhooks/{webhook_id}

### Description
Retrieves a specific webhook.

### Method
GET

### Endpoint
/webhooks/{webhook_id}

### Parameters
#### Path Parameters
- **webhookId** (string) - Required - The ID of the webhook. Example: "3321123"

### Request Example
```ts
await client.webhooks.getWebhookById(webhook.id!);
```

### Response
#### Success Response (200)
- **Webhook** (Webhook) - Returns a webhook object.

#### Response Example
```ts
// Returns a value of type Webhook
```
```

--------------------------------

### Create file metadata instance with fileMetadata.createFileMetadataById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/fileMetadata.md

Applies a metadata template instance to a file. Accepts custom key-value pairs for the global.properties template. Returns a MetadataFull with the applied data. Required arguments include fileId, scope, templateKey, requestBody, and optional optionalsInput.

```ts
await client.fileMetadata.createFileMetadataById(
  file.id,
  'enterprise' as CreateFileMetadataByIdScope,
  templateKey,
  {
    ['name']: 'John',
    ['age']: 23,
    ['birthDate']: '2001-01-03T02:20:50.520Z',
    ['countryCode']: 'US',
    ['sports']: ['basketball', 'tennis'],
  },
);
```

--------------------------------

### GET /metadata_templates/enterprise

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/metadataTemplates.md

Retrieves all metadata templates for the enterprise.

```APIDOC
## [GET] /metadata_templates/enterprise

### Description
Used to retrieve all metadata templates created to be used specifically within the user's enterprise.

### Method
GET

### Endpoint
/metadata_templates/enterprise

### Parameters
#### Query Parameters
- **queryParams** (GetEnterpriseMetadataTemplatesQueryParams) - Optional - Query parameters of getEnterpriseMetadataTemplates method
- **headersInput** (GetEnterpriseMetadataTemplatesHeadersInput) - Optional - Headers of getEnterpriseMetadataTemplates method
- **cancellationToken** (undefined | CancellationToken) - Optional - Token used for request cancellation.

### Request Example
```ts
await client.metadataTemplates.getEnterpriseMetadataTemplates();
```

### Response
#### Success Response (200)
- **MetadataTemplates** - Returns all of the metadata templates within an enterprise and their corresponding schema.

#### Response Example
```json
{
  "type": "metadata_templates",
  "entries": []
}
```
```

--------------------------------

### GET /retention-policies/{retention_policy_id}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/retentionPolicies.md

Retrieves a retention policy.

```APIDOC
## GET /retention-policies/{retention_policy_id}

### Description
Retrieves a retention policy.

### Method
GET

### Endpoint
/retention-policies/{retention_policy_id}

### Parameters
#### Path Parameters
- **retentionPolicyId** (string) - Required - The ID of the retention policy. Example: "982312"

#### Query Parameters
- **optionalsInput** (GetRetentionPolicyByIdOptionalsInput) - Optional - Optional input parameters.

### Request Example
```ts
await client.retentionPolicies.getRetentionPolicyById(retentionPolicy.id);
```

### Response
#### Success Response (200)
Returns the retention policy object.

#### Response Example
```ts
RetentionPolicy
```
```

--------------------------------

### Initialize BoxClient with developer token and get current user

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/example.html

Use this snippet to initialize the Box SDK in a browser environment using a developer token. It creates a BoxClient with BoxDeveloperTokenAuth, fetches the current user's name, and displays an alert. The token is obtained via a prompt dialog.

```javascript
const { BoxClient, BoxDeveloperTokenAuth } = window['box-typescript-sdk-gen'];
async function main(token) {
  try {
    const client = new BoxClient({
      auth: new BoxDeveloperTokenAuth({ token }),
    });
    const { name } = await client.users.getUserMe();
    alert(`Hello ${name}!`);
  } catch (e) {
    alert(String(e));
    console.error(e);
  }
}
main(prompt('Provide the developer token'));
```

--------------------------------

### GET /retention-policies

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/retentionPolicies.md

Retrieves all of the retention policies for an enterprise.

```APIDOC
## GET /retention-policies

### Description
Retrieves all of the retention policies for an enterprise.

### Method
GET

### Endpoint
/retention-policies

### Parameters
#### Query Parameters
- **queryParams** (GetRetentionPoliciesQueryParams) - Optional - Query parameters of getRetentionPolicies method.
- **headersInput** (GetRetentionPoliciesHeadersInput) - Optional - Headers of getRetentionPolicies method.
- **cancellationToken** (undefined | CancellationToken) - Optional - Token used for request cancellation.

### Request Example
```ts
await client.retentionPolicies.getRetentionPolicies();
```

### Response
#### Success Response (200)
Returns a list retention policies in the enterprise.

#### Response Example
```ts
RetentionPolicies
```
```

--------------------------------

### GET /files/{file_id}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/files.md

Retrieves the details about a file.

```APIDOC
## [GET] /files/{file_id}

### Description
Retrieves the details about a file.

### Method
GET

### Endpoint
/files/{file_id}

### Parameters
#### Path Parameters
- **fileId** (string) - Required - The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"

#### Query Parameters
- **fields** (array) - Optional - A list of fields to include in the response. Use this to request specific fields not returned by default.

### Request Example
```ts
await client.files.getFileById(uploadedFile.id, {
  queryParams: {
    fields: ['is_externally_owned', 'has_collaborations'],
  } satisfies GetFileByIdQueryParams,
} satisfies GetFileByIdOptionalsInput);
```

### Response
#### Success Response (200)
Returns a file object. Not all available fields are returned by default. Use the `fields` query parameter to explicitly request any specific fields.

#### Response Example
```ts
FileFull
```
```

--------------------------------

### Create task with createTask

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/tasks.md

Creates a single task on a file. The task is not assigned to any user and must be assigned separately. Returns the newly created task.

```ts
await client.tasks.createTask({
  item: {
    type: 'file' as CreateTaskRequestBodyItemTypeField,
    id: file.id,
  } satisfies CreateTaskRequestBodyItemField,
  message: 'test message',
  dueAt: dateTime,
  action: 'review' as CreateTaskRequestBodyActionField,
  completionRule: 'all_assignees' as CreateTaskRequestBodyCompletionRuleField,
} satisfies CreateTaskRequestBody);
```

--------------------------------

### GET /collections/{collectionId}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/collections.md

Retrieves a collection by its ID.

```APIDOC
## GET /collections/{collectionId}

### Description
Retrieves a collection by its ID.

### Method
GET

### Endpoint
/collections/{collectionId}

### Parameters
#### Path Parameters
- `collectionId` (string) - Required - The ID of the collection. Example: "926489"

#### Query Parameters
- `optionalsInput` (GetCollectionByIdOptionalsInput) - Optional - Optional parameters for the method.

### Request Example
```ts
await client.collections.getCollectionById(collections.entries![0].id!);
```

### Response
#### Success Response (200)
Returns a value of type `Collection`. Returns an array of items in the collection.

```

--------------------------------

### Create Box Hub using createHubV2025R0

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/hubs.md

Creates a new Box Hub with a title and description. Returns a HubV2025R0 object.

```TypeScript
await client.hubs.createHubV2025R0({
  title: hubTitle,
  description: hubDescription,
} satisfies HubCreateRequestV2025R0);
```

--------------------------------

### getAiAgentById

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/aiStudio.md

Gets an AI Agent using the `agent_id` parameter.

```APIDOC
## getAiAgentById

### Description
Gets an AI Agent using the `agent_id` parameter.

### Method
GET

### Endpoint
/ai/agents/{agentId}

### Parameters
#### Path Parameters
- agentId (string) - Required - The agent id to get. Example: "1234"

#### Query Parameters
- queryParams (GetAiAgentByIdQueryParams) - Optional - Query parameters for the getAiAgentById method.
- optionalsInput (GetAiAgentByIdOptionalsInput) - Optional - Optional parameters.

### Request Example
```ts
await client.aiStudio.getAiAgentById(createdAgent.id, {
  queryParams: { fields: ['ask'] } satisfies GetAiAgentByIdQueryParams,
} satisfies GetAiAgentByIdOptionalsInput);
```

### Response
#### Success Response (200)
- Returns a value of type `AiSingleAgentResponseFull`.

#### Response Example
A successful response including the agent.
```

--------------------------------

### Access SDK in browser

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/README.md

Access the SDK classes in a browser environment after including the lib/bundle.js file.

```js
const { BoxClient, BoxDeveloperTokenAuth } = window['box-typescript-sdk-gen'];
```

--------------------------------

### List Box Skill cards on file with getBoxSkillCardsOnFile

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/skills.md

Lists the Box Skills metadata cards attached to a file. The file ID is passed as the only argument.

```ts
await client.skills.getBoxSkillCardsOnFile(file.id);
```

--------------------------------

### GET /web-links/:id/trash

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/trashedWebLinks.md

Retrieves a web link that has been moved to the trash.

```APIDOC
## [GET] /web-links/:id/trash

### Description
Retrieves a web link that has been moved to the trash.

### Method
GET

### Endpoint
/web-links/:id/trash

### Parameters
#### Path Parameters
- **webLinkId** (string) - Required - The ID of the web link. Example: "12345"

### Request Example
```ts
await client.trashedWebLinks.getTrashedWebLinkById(weblink.id);
```

### Response
#### Success Response (200)
Returns the web link that was trashed, including information about when the it was moved to the trash.

#### Response Example
```ts
TrashWebLink
```
```

--------------------------------

### GET /docgen/jobs

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/docgen.md

Lists all Box Doc Gen jobs for a user.

```APIDOC
## GET /docgen/jobs

### Description
Lists all Box Doc Gen jobs for a user.

### Method
GET

### Endpoint
`/docgen/jobs`

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return per page.

### Request Example
```ts
await client.docgen.getDocgenJobsV2025R0({
  limit: 10000,
} satisfies GetDocgenJobsV2025R0QueryParams);
```

### Response
#### Success Response (200)
- **DocGenJobsFullV2025R0** (object) - A list of Box Doc Gen jobs.

#### Response Example
```json
{
  "entries": [
    {
      "type": "docgen_job",
      "id": "12345",
      "status": "success"
    }
  ],
  "limit": 10000,
  "next_marker": "eyz"
}
```
```

--------------------------------

### createSlackIntegrationMapping

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/integrationMappings.md

Creates a Slack integration mapping by mapping a Slack channel to a Box item. Requires Admin or Co-Admin role.

```APIDOC
## createSlackIntegrationMapping

### Description
Creates a Slack integration mapping by mapping a Slack channel to a Box item. Requires Admin or Co-Admin role.

### Method
POST

### Endpoint
/integration_mappings/slack

### Parameters
#### Request Body
- **requestBody** (IntegrationMappingSlackCreateRequest) - Required - Request body of createSlackIntegrationMapping method.
- **optionalsInput** (CreateSlackIntegrationMappingOptionalsInput) - Optional - Optional parameters.

### Request Example
```ts
await userClient.integrationMappings.createSlackIntegrationMapping({
  partnerItem: new IntegrationMappingPartnerItemSlack({
    id: slackPartnerItemId,
    slackOrgId: slackOrgId,
  }),
  boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
} satisfies IntegrationMappingSlackCreateRequest);
```

### Response
#### Success Response (200)
Returns a value of type `IntegrationMapping`.

#### Response Example
Returns the created integration mapping.
```

--------------------------------

### List all webhooks with getWebhooks

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/webhooks.md

Returns all webhooks for the requesting application. Only webhooks applied to files or folders owned by the authenticated user are returned.

```TypeScript
await client.webhooks.getWebhooks();
```

--------------------------------

### GET /metadata_templates

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/metadataTemplates.md

Finds a metadata template by searching for the ID of an instance of the template.

```APIDOC
## GET /metadata_templates

### Description
Finds a metadata template by searching for the ID of an instance of the template.

### Method
GET

### Endpoint
/metadata_templates

### Parameters
#### Query Parameters
- **metadata_instance_id** (string) - Required - The ID of an instance of the metadata template to find.

### Request Example
```ts
await client.metadataTemplates.getMetadataTemplatesByInstanceId({
  metadataInstanceId: createdMetadataInstance.id!,
} satisfies GetMetadataTemplatesByInstanceIdQueryParams);
```

### Response
#### Success Response (200)
Returns a list containing the 1 metadata template that matches the instance ID.

#### Response Example
```ts
MetadataTemplates
```
```

--------------------------------

### GET /legal_hold_policy_assignments/:legal_hold_policy_assignment_id

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/legalHoldPolicyAssignments.md

Retrieves a legal hold policy assignment by its ID.

```APIDOC
## GET /legal_hold_policy_assignments/:legal_hold_policy_assignment_id

### Description
Retrieves a legal hold policy assignment.

### Method
GET

### Endpoint
/legal_hold_policy_assignments/:legal_hold_policy_assignment_id

### Parameters
#### Path Parameters
- **legal_hold_policy_assignment_id** (string) - Required - The ID of the legal hold policy assignment. Example: "753465"

### Request Example
No request body required.

### Response
#### Success Response (200)
- **LegalHoldPolicyAssignment** (object) - Returns a legal hold policy object.

#### Response Example
{
  "type": "legal_hold_policy_assignment",
  "id": "753465"
}
```

--------------------------------

### Create webhook with createWebhook

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/webhooks.md

Creates a webhook with a target folder, address, and triggers. The target type is specified as 'folder' and the trigger is 'FILE.UPLOADED'.

```TypeScript
await client.webhooks.createWebhook({
  target: {
    id: folder.id,
    type: 'folder' as CreateWebhookRequestBodyTargetTypeField,
  } satisfies CreateWebhookRequestBodyTargetField,
  address: 'https://example.com/new-webhook',
  triggers: ['FILE.UPLOADED' as CreateWebhookRequestBodyTriggersField],
} satisfies CreateWebhookRequestBody);
```

--------------------------------

### GET /legal_hold_policy_assignments

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/legalHoldPolicyAssignments.md

Retrieves a list of items a legal hold policy has been assigned to.

```APIDOC
## [GET] /legal_hold_policy_assignments

### Description
Retrieves a list of items a legal hold policy has been assigned to.

### Method
GET

### Endpoint
/legal_hold_policy_assignments

### Parameters
#### Query Parameters
- **policyId** (string) - Required - The ID of the legal hold policy.

### Request Example
```ts
await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignments({
  policyId: legalHoldPolicyId,
} satisfies GetLegalHoldPolicyAssignmentsQueryParams);
```

### Response
#### Success Response (200)
Returns a list of legal hold policy assignments.

#### Response Example
```ts
const legalHoldPolicyAssignments: LegalHoldPolicyAssignments = await client.legalHoldPolicyAssignments.getLegalHoldPolicyAssignments({
  policyId: legalHoldPolicyId,
} satisfies GetLegalHoldPolicyAssignmentsQueryParams);
```
```

--------------------------------

### GET /docgen/batch_jobs/{batch_id}

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/docgen.md

Lists Box Doc Gen jobs in a batch.

```APIDOC
## GET /docgen/batch_jobs/{batch_id}

### Description
Lists Box Doc Gen jobs in a batch.

### Method
GET

### Endpoint
`/docgen/batch_jobs/{batch_id}`

### Parameters
#### Path Parameters
- **batchId** (string) - Required - Box Doc Gen batch ID. Example: 123

### Request Example
```ts
await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);
```

### Response
#### Success Response (200)
- **DocGenJobsV2025R0** (object) - Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.

#### Response Example
```json
{
  "entries": [
    {
      "type": "docgen_job",
      "id": "12345",
      "status": "success"
    }
  ]
}
```
```

--------------------------------

### Switch to service account subject

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/authentication.md

Creates a new auth object authenticated as a service account using withEnterpriseSubject. Use this to switch from a user to an enterprise subject.

```javascript
const enterpriseAuth = ccgAuth.withEnterpriseSubject('YOUR_ENTERPRISE_ID');
const enterpriseClient = new BoxClient({ auth: enterpriseAuth });
```

--------------------------------

### Legacy Box Node SDK: Custom TokenStore with callbacks

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/migration-guide.md

Defines a TokenStore constructor with read, write, and clear methods using callbacks. Each method should handle errors and call the callback with the appropriate arguments.

```typescript
function TokenStore() {
  // The token store constructor should create a specific store instance
  // for the user in question — it may need to take in a user ID or other
  // identifier.
}

TokenStore.prototype.read = function (callback) {
  // Read the user's tokens from your data store and
  // call the callback.
  // callback(error) if some error occured
  // callback(null, tokenInfo) if the read succeeded
};

TokenStore.prototype.write = function (tokenInfo, callback) {
  // Write the token information to the store.
  // The tokenInfo argument is an Object, and can be
  // serialized as JSON for storage.
  // Call the callback after the write.
  // callback(error) if some error occured
  // callback(null) if the write succeeded
};

TokenStore.prototype.clear = function (callback) {
  // Delete the user's token information from the store,
  // and call the callback after the write.
  // callback(error) if some error occured
  // callback(null) if the deletion succeeded
};
```

--------------------------------

### Switch to user subject

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/authentication.md

Creates a new auth object authenticated as a user using withUserSubject. Use this to switch from a service account to a user subject.

```javascript
const userAuth = ccgAuth.withUserSubject('YOUR_USER_ID');
const userClient = new BoxClient({ auth: userAuth });
```

--------------------------------

### List tasks on file with getFileTasks

Source: https://github.com/box/box-typescript-sdk-gen/blob/main/docs/tasks.md

Retrieves a list of all tasks for a file. The endpoint does not support pagination. Returns an empty collection if there are no tasks on the file.

```ts
await client.tasks.getFileTasks(file.id);
```
Tokens:
Raw