feat: Support getting file download URL and file thumbnail URL (box/box-codegen#617) (#435)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "d435f50", "specHash": "544d370", "version": "1.7.0" }
+{ "engineHash": "f073ce3", "specHash": "544d370", "version": "1.7.0" }

docs/downloads.md

@@ -5,7 +5,11 @@ Downloads module is used to download files from Box.
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [Download a File](#download-a-file)
+- [Downloads](#downloads)
+  - [Download a File](#download-a-file)
+  - [Get download URL](#get-download-url)
+    - [Arguments](#arguments)
+    - [Returns](#returns)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -23,3 +27,23 @@ const fileContent = await client.downloads.downloadFile('123456789');
 const fileWriteStream = fs.createWriteStream('file.pdf');
 fileContent.pipe(fileWriteStream);
 ```
+
+## Get download URL
+
+Get a URL to download a file
+
+This operation is performed by calling function `getDownloadFileUrl`.
+
+```ts
+await client.downloads.getDownloadFileUrl(uploadedFile.id);
+```
+
+### Arguments
+
+- fileId `string`
+  - 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"
+- ## optionalsInput `GetDownloadFileUrlOptionalsInput`
+
+### Returns
+
+This function returns a value of type `string`.

docs/files.md

@@ -4,6 +4,7 @@
 - [Update file](#update-file)
 - [Delete file](#delete-file)
 - [Copy file](#copy-file)
+- [Get file thumbnail URL](#get-file-thumbnail-url)
 - [Get file thumbnail](#get-file-thumbnail)
 
 ## Get file information
@@ -147,6 +148,47 @@ Not all available fields are returned by default. Use the
 [fields](#param-fields) query parameter to explicitly request
 any specific fields.
 
+## Get file thumbnail URL
+
+Get the download URL without downloading the content.
+
+This operation is performed by calling function `getFileThumbnailUrl`.
+
+See the endpoint docs at
+[API Reference](https://developer.box.com/reference/get-files-id-thumbnail-id/).
+
+<!-- sample get_files_id_thumbnail_id -->
+
+```ts
+await client.files.getFileThumbnailUrl(
+  thumbnailFile.id,
+  'png' as GetFileThumbnailUrlExtension,
+);
+```
+
+### Arguments
+
+- fileId `string`
+  - 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"
+- extension `GetFileThumbnailUrlExtension`
+  - The file format for the thumbnail Example: "png"
+- optionalsInput `GetFileThumbnailUrlOptionalsInput`
+  -
+
+### Returns
+
+This function returns a value of type `string`.
+
+When a thumbnail can be created the thumbnail data will be
+returned in the body of the response.Sometimes generating a thumbnail can take a few seconds. In these
+situations the API returns a `Location`-header pointing to a
+placeholder graphic for this file type.
+
+The placeholder graphic can be used in a user interface until the
+thumbnail generation has completed. The `Retry-After`-header indicates
+when to the thumbnail will be ready. At that time, retry this endpoint
+to retrieve the thumbnail.
+
 ## Get file thumbnail
 
 Retrieves a thumbnail, or smaller image representation, of a file.

src/box/ccgAuth.generated.ts

@@ -30,19 +30,19 @@ export class CcgConfig {
     fields: Omit<CcgConfig, 'tokenStorage'> &
       Partial<Pick<CcgConfig, 'tokenStorage'>>,
   ) {
-    if (fields.clientId) {
+    if (fields.clientId !== undefined) {
       this.clientId = fields.clientId;
     }
-    if (fields.clientSecret) {
+    if (fields.clientSecret !== undefined) {
       this.clientSecret = fields.clientSecret;
     }
-    if (fields.enterpriseId) {
+    if (fields.enterpriseId !== undefined) {
       this.enterpriseId = fields.enterpriseId;
     }
-    if (fields.userId) {
+    if (fields.userId !== undefined) {
       this.userId = fields.userId;
     }
-    if (fields.tokenStorage) {
+    if (fields.tokenStorage !== undefined) {
       this.tokenStorage = fields.tokenStorage;
     }
   }
@@ -92,7 +92,7 @@ export class BoxCcgAuth implements Authentication {
       | 'revokeToken'
     >,
   ) {
-    if (fields.config) {
+    if (fields.config !== undefined) {
       this.config = fields.config;
     }
     this.tokenStorage = this.config.tokenStorage;

src/box/developerTokenAuth.generated.ts

@@ -34,10 +34,10 @@ export class BoxDeveloperTokenAuth implements Authentication {
     > &
       Partial<Pick<BoxDeveloperTokenAuth, 'config'>>,
   ) {
-    if (fields.token) {
+    if (fields.token !== undefined) {
       this.token = fields.token;
     }
-    if (fields.config) {
+    if (fields.config !== undefined) {
       this.config = fields.config;
     }
     this.tokenStorage = new InMemoryTokenStorage({

src/box/jwtAuth.generated.ts

@@ -92,31 +92,31 @@ export class JwtConfig {
     > &
       Partial<Pick<JwtConfig, 'algorithm' | 'tokenStorage'>>,
   ) {
-    if (fields.clientId) {
+    if (fields.clientId !== undefined) {
       this.clientId = fields.clientId;
     }
-    if (fields.clientSecret) {
+    if (fields.clientSecret !== undefined) {
       this.clientSecret = fields.clientSecret;
     }
-    if (fields.jwtKeyId) {
+    if (fields.jwtKeyId !== undefined) {
       this.jwtKeyId = fields.jwtKeyId;
     }
-    if (fields.privateKey) {
+    if (fields.privateKey !== undefined) {
       this.privateKey = fields.privateKey;
     }
-    if (fields.privateKeyPassphrase) {
+    if (fields.privateKeyPassphrase !== undefined) {
       this.privateKeyPassphrase = fields.privateKeyPassphrase;
     }
-    if (fields.enterpriseId) {
+    if (fields.enterpriseId !== undefined) {
       this.enterpriseId = fields.enterpriseId;
     }
-    if (fields.userId) {
+    if (fields.userId !== undefined) {
       this.userId = fields.userId;
     }
-    if (fields.algorithm) {
+    if (fields.algorithm !== undefined) {
       this.algorithm = fields.algorithm;
     }
-    if (fields.tokenStorage) {
+    if (fields.tokenStorage !== undefined) {
       this.tokenStorage = fields.tokenStorage;
     }
   }
@@ -225,7 +225,7 @@ export class BoxJwtAuth implements Authentication {
       | 'revokeToken'
     >,
   ) {
-    if (fields.config) {
+    if (fields.config !== undefined) {
       this.config = fields.config;
     }
     this.tokenStorage = this.config.tokenStorage;

src/box/oauth.generated.ts

@@ -20,13 +20,13 @@ export class OAuthConfig {
     fields: Omit<OAuthConfig, 'tokenStorage'> &
       Partial<Pick<OAuthConfig, 'tokenStorage'>>,
   ) {
-    if (fields.clientId) {
+    if (fields.clientId !== undefined) {
       this.clientId = fields.clientId;
     }
-    if (fields.clientSecret) {
+    if (fields.clientSecret !== undefined) {
       this.clientSecret = fields.clientSecret;
     }
-    if (fields.tokenStorage) {
+    if (fields.tokenStorage !== undefined) {
       this.tokenStorage = fields.tokenStorage;
     }
   }
@@ -73,7 +73,7 @@ export class BoxOAuth implements Authentication {
       | 'downscopeToken'
     >,
   ) {
-    if (fields.config) {
+    if (fields.config !== undefined) {
       this.config = fields.config;
     }
     this.tokenStorage = this.config.tokenStorage;

src/box/tokenStorage.generated.ts

@@ -20,7 +20,7 @@ export class InMemoryTokenStorage implements TokenStorage {
     fields: Omit<InMemoryTokenStorage, 'token' | 'store' | 'get' | 'clear'> &
       Partial<Pick<InMemoryTokenStorage, 'token'>>,
   ) {
-    if (fields.token) {
+    if (fields.token !== undefined) {
       this.token = fields.token;
     }
   }

src/client.generated.ts

@@ -248,10 +248,10 @@ export class BoxClient {
     > &
       Partial<Pick<BoxClient, 'networkSession'>>,
   ) {
-    if (fields.auth) {
+    if (fields.auth !== undefined) {
       this.auth = fields.auth;
     }
-    if (fields.networkSession) {
+    if (fields.networkSession !== undefined) {
       this.networkSession = fields.networkSession;
     }
     this.authorization = new AuthorizationManager({
@@ -562,6 +562,7 @@ export class BoxClient {
       auth: fetchOptionsInput.auth,
       networkSession: fetchOptionsInput.networkSession,
       cancellationToken: fetchOptionsInput.cancellationToken,
+      followRedirects: fetchOptionsInput.followRedirects,
     });
     const auth: Authentication =
       fetchOptions.auth == void 0 ? this.auth : fetchOptions.auth!;
@@ -581,6 +582,7 @@ export class BoxClient {
       multipartData: fetchOptions.multipartData,
       contentType: fetchOptions.contentType,
       responseFormat: fetchOptions.responseFormat,
+      followRedirects: fetchOptions.followRedirects,
     });
     return (await fetch(enrichedFetchOptions)) as FetchResponse;
   }

src/internal/utils.ts

@@ -2,7 +2,6 @@ import { Buffer } from 'buffer';
 import type { Readable } from 'stream';
 import { v4 as uuidv4 } from 'uuid';
 import { SignJWT, importPKCS8 } from 'jose';
-import { sdIsMap, SerializedData } from '../serialization/json';
 
 export function isBrowser() {
   return (
@@ -23,7 +22,7 @@ export function hexToBase64(data: string): string {
 }
 
 export { Buffer, Readable as ByteStream };
-export type { CancellationToken };
+export type { CancellationController, CancellationToken };
 export type Iterator<T = any> = AsyncIterator<T>;
 export type AgentOptions = any;
 export type Agent = any;
@@ -293,6 +292,7 @@ export function toString(value: any): string {
   return String(value);
 }
 
+type CancellationController = AbortController;
 type CancellationToken = AbortSignal;
 
 /**
@@ -446,3 +446,10 @@ export function getValueFromObjectRawData(obj: any, key: string): any {
 export function createNull(): null {
   return null;
 }
+
+/**
+ * Create a cancellation controller.
+ */
+export function createCancellationController(): CancellationController {
+  return new AbortController();
+}