box-node-sdk 10.1.0 → 10.3.0

package/src/managers/fileMetadata.ts

@@ -32,12 +32,25 @@ import { sdIsString } from '../serialization/json';
 import { sdIsList } from '../serialization/json';
 import { sdIsMap } from '../serialization/json';
 export class GetFileMetadataOptionals {
+  readonly queryParams: GetFileMetadataQueryParams =
+    {} satisfies GetFileMetadataQueryParams;
   readonly headers: GetFileMetadataHeaders = new GetFileMetadataHeaders({});
   readonly cancellationToken?: CancellationToken = void 0;
   constructor(
-    fields: Omit<GetFileMetadataOptionals, 'headers' | 'cancellationToken'> &
-      Partial<Pick<GetFileMetadataOptionals, 'headers' | 'cancellationToken'>>,
+    fields: Omit<
+      GetFileMetadataOptionals,
+      'queryParams' | 'headers' | 'cancellationToken'
+    > &
+      Partial<
+        Pick<
+          GetFileMetadataOptionals,
+          'queryParams' | 'headers' | 'cancellationToken'
+        >
+      >,
   ) {
+    if (fields.queryParams !== undefined) {
+      this.queryParams = fields.queryParams;
+    }
     if (fields.headers !== undefined) {
       this.headers = fields.headers;
     }
@@ -47,10 +60,13 @@ export class GetFileMetadataOptionals {
   }
 }
 export interface GetFileMetadataOptionalsInput {
+  readonly queryParams?: GetFileMetadataQueryParams;
   readonly headers?: GetFileMetadataHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFileMetadataByIdOptionals {
+  readonly queryParams: GetFileMetadataByIdQueryParams =
+    {} satisfies GetFileMetadataByIdQueryParams;
   readonly headers: GetFileMetadataByIdHeaders = new GetFileMetadataByIdHeaders(
     {},
   );
@@ -58,12 +74,18 @@ export class GetFileMetadataByIdOptionals {
   constructor(
     fields: Omit<
       GetFileMetadataByIdOptionals,
-      'headers' | 'cancellationToken'
+      'queryParams' | 'headers' | 'cancellationToken'
     > &
       Partial<
-        Pick<GetFileMetadataByIdOptionals, 'headers' | 'cancellationToken'>
+        Pick<
+          GetFileMetadataByIdOptionals,
+          'queryParams' | 'headers' | 'cancellationToken'
+        >
       >,
   ) {
+    if (fields.queryParams !== undefined) {
+      this.queryParams = fields.queryParams;
+    }
     if (fields.headers !== undefined) {
       this.headers = fields.headers;
     }
@@ -73,8 +95,9 @@ export class GetFileMetadataByIdOptionals {
   }
 }
 export interface GetFileMetadataByIdOptionalsInput {
+  readonly queryParams?: GetFileMetadataByIdQueryParams;
   readonly headers?: GetFileMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateFileMetadataByIdOptionals {
   readonly headers: CreateFileMetadataByIdHeaders =
@@ -99,7 +122,7 @@ export class CreateFileMetadataByIdOptionals {
 }
 export interface CreateFileMetadataByIdOptionalsInput {
   readonly headers?: CreateFileMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateFileMetadataByIdOptionals {
   readonly headers: UpdateFileMetadataByIdHeaders =
@@ -124,7 +147,7 @@ export class UpdateFileMetadataByIdOptionals {
 }
 export interface UpdateFileMetadataByIdOptionalsInput {
   readonly headers?: UpdateFileMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFileMetadataByIdOptionals {
   readonly headers: DeleteFileMetadataByIdHeaders =
@@ -149,7 +172,16 @@ export class DeleteFileMetadataByIdOptionals {
 }
 export interface DeleteFileMetadataByIdOptionalsInput {
   readonly headers?: DeleteFileMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
+}
+export interface GetFileMetadataQueryParams {
+  /**
+   * Taxonomy field values are returned in `API view` by default, meaning
+   * the value is represented with a taxonomy node identifier.
+   * To retrieve the `Hydrated view`, where taxonomy values are represented
+   * with the full taxonomy node information, set this parameter to `hydrated`.
+   * This is the only supported value for this parameter. */
+  readonly view?: string;
 }
 export class GetFileMetadataHeaders {
   /**
@@ -169,13 +201,20 @@ export class GetFileMetadataHeaders {
 export interface GetFileMetadataHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type GetFileMetadataByIdScope = 'global' | 'enterprise' | string;
+export interface GetFileMetadataByIdQueryParams {
+  /**
+   * Taxonomy field values are returned in `API view` by default, meaning
+   * the value is represented with a taxonomy node identifier.
+   * To retrieve the `Hydrated view`, where taxonomy values are represented
+   * with the full taxonomy node information, set this parameter to `hydrated`.
+   * This is the only supported value for this parameter. */
+  readonly view?: string;
+}
 export class GetFileMetadataByIdHeaders {
   /**
    * Extra headers that will be included in the HTTP request. */
@@ -194,11 +233,9 @@ export class GetFileMetadataByIdHeaders {
 export interface GetFileMetadataByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type CreateFileMetadataByIdScope = 'global' | 'enterprise' | string;
 export type CreateFileMetadataByIdRequestBody = {
@@ -222,11 +259,9 @@ export class CreateFileMetadataByIdHeaders {
 export interface CreateFileMetadataByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type UpdateFileMetadataByIdScope = 'global' | 'enterprise' | string;
 export type UpdateFileMetadataByIdRequestBodyOpField =
@@ -277,11 +312,9 @@ export class UpdateFileMetadataByIdHeaders {
 export interface UpdateFileMetadataByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export type DeleteFileMetadataByIdScope = 'global' | 'enterprise' | string;
 export class DeleteFileMetadataByIdHeaders {
@@ -302,11 +335,9 @@ export class DeleteFileMetadataByIdHeaders {
 export interface DeleteFileMetadataByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class FileMetadataManager {
   readonly auth?: Authentication;
@@ -348,11 +379,16 @@ export class FileMetadataManager {
     optionalsInput: GetFileMetadataOptionalsInput = {},
   ): Promise<Metadatas> {
     const optionals: GetFileMetadataOptionals = new GetFileMetadataOptionals({
+      queryParams: optionalsInput.queryParams,
       headers: optionalsInput.headers,
       cancellationToken: optionalsInput.cancellationToken,
     });
+    const queryParams: any = optionals.queryParams;
     const headers: any = optionals.headers;
     const cancellationToken: any = optionals.cancellationToken;
+    const queryParamsMap: {
+      readonly [key: string]: string;
+    } = prepareParams({ ['view']: toString(queryParams.view) as string });
     const headersMap: {
       readonly [key: string]: string;
     } = prepareParams({ ...{}, ...headers.extraHeaders });
@@ -362,10 +398,11 @@ export class FileMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/metadata',
           ) as string,
           method: 'GET',
+          params: queryParamsMap,
           headers: headersMap,
           responseFormat: 'json' as ResponseFormat,
           auth: this.auth,
@@ -404,11 +441,16 @@ export class FileMetadataManager {
   ): Promise<MetadataFull> {
     const optionals: GetFileMetadataByIdOptionals =
       new GetFileMetadataByIdOptionals({
+        queryParams: optionalsInput.queryParams,
         headers: optionalsInput.headers,
         cancellationToken: optionalsInput.cancellationToken,
       });
+    const queryParams: any = optionals.queryParams;
     const headers: any = optionals.headers;
     const cancellationToken: any = optionals.cancellationToken;
+    const queryParamsMap: {
+      readonly [key: string]: string;
+    } = prepareParams({ ['view']: toString(queryParams.view) as string });
     const headersMap: {
       readonly [key: string]: string;
     } = prepareParams({ ...{}, ...headers.extraHeaders });
@@ -418,13 +460,14 @@ export class FileMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/metadata/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
           ) as string,
           method: 'GET',
+          params: queryParamsMap,
           headers: headersMap,
           responseFormat: 'json' as ResponseFormat,
           auth: this.auth,
@@ -482,11 +525,11 @@ export class FileMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/metadata/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
           ) as string,
           method: 'POST',
           headers: headersMap,
@@ -551,11 +594,11 @@ export class FileMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/metadata/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
           ) as string,
           method: 'PUT',
           headers: headersMap,
@@ -613,11 +656,11 @@ export class FileMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/metadata/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
           ) as string,
           method: 'DELETE',
           headers: headersMap,

package/src/managers/fileRequests.ts

@@ -49,7 +49,7 @@ export class GetFileRequestByIdOptionals {
 }
 export interface GetFileRequestByIdOptionalsInput {
   readonly headers?: GetFileRequestByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateFileRequestByIdOptionals {
   readonly headers: UpdateFileRequestByIdHeaders =
@@ -74,7 +74,7 @@ export class UpdateFileRequestByIdOptionals {
 }
 export interface UpdateFileRequestByIdOptionalsInput {
   readonly headers?: UpdateFileRequestByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFileRequestByIdOptionals {
   readonly headers: DeleteFileRequestByIdHeaders =
@@ -99,7 +99,7 @@ export class DeleteFileRequestByIdOptionals {
 }
 export interface DeleteFileRequestByIdOptionalsInput {
   readonly headers?: DeleteFileRequestByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateFileRequestCopyOptionals {
   readonly headers: CreateFileRequestCopyHeaders =
@@ -124,7 +124,7 @@ export class CreateFileRequestCopyOptionals {
 }
 export interface CreateFileRequestCopyOptionalsInput {
   readonly headers?: CreateFileRequestCopyHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFileRequestByIdHeaders {
   /**
@@ -144,11 +144,9 @@ export class GetFileRequestByIdHeaders {
 export interface GetFileRequestByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class UpdateFileRequestByIdHeaders {
   /**
@@ -189,11 +187,9 @@ export interface UpdateFileRequestByIdHeadersInput {
   readonly ifMatch?: string;
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class DeleteFileRequestByIdHeaders {
   /**
@@ -213,11 +209,9 @@ export class DeleteFileRequestByIdHeaders {
 export interface DeleteFileRequestByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class CreateFileRequestCopyHeaders {
   /**
@@ -237,11 +231,9 @@ export class CreateFileRequestCopyHeaders {
 export interface CreateFileRequestCopyHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class FileRequestsManager {
   readonly auth?: Authentication;
@@ -297,7 +289,7 @@ export class FileRequestsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_requests/',
-            toString(fileRequestId) as string,
+            (toString(fileRequestId) as string)!,
           ) as string,
           method: 'GET',
           headers: headersMap,
@@ -351,7 +343,7 @@ export class FileRequestsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_requests/',
-            toString(fileRequestId) as string,
+            (toString(fileRequestId) as string)!,
           ) as string,
           method: 'PUT',
           headers: headersMap,
@@ -401,7 +393,7 @@ export class FileRequestsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_requests/',
-            toString(fileRequestId) as string,
+            (toString(fileRequestId) as string)!,
           ) as string,
           method: 'DELETE',
           headers: headersMap,
@@ -449,7 +441,7 @@ export class FileRequestsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_requests/',
-            toString(fileRequestId) as string,
+            (toString(fileRequestId) as string)!,
             '/copy',
           ) as string,
           method: 'POST',

package/src/managers/fileVersionLegalHolds.ts

@@ -51,7 +51,7 @@ export class GetFileVersionLegalHoldByIdOptionals {
 }
 export interface GetFileVersionLegalHoldByIdOptionalsInput {
   readonly headers?: GetFileVersionLegalHoldByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFileVersionLegalHoldsOptionals {
   readonly headers: GetFileVersionLegalHoldsHeaders =
@@ -76,7 +76,7 @@ export class GetFileVersionLegalHoldsOptionals {
 }
 export interface GetFileVersionLegalHoldsOptionalsInput {
   readonly headers?: GetFileVersionLegalHoldsHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFileVersionLegalHoldByIdHeaders {
   /**
@@ -96,11 +96,9 @@ export class GetFileVersionLegalHoldByIdHeaders {
 export interface GetFileVersionLegalHoldByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export interface GetFileVersionLegalHoldsQueryParams {
   /**
@@ -135,11 +133,9 @@ export class GetFileVersionLegalHoldsHeaders {
 export interface GetFileVersionLegalHoldsHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class FileVersionLegalHoldsManager {
   readonly auth?: Authentication;
@@ -188,7 +184,7 @@ export class FileVersionLegalHoldsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_version_legal_holds/',
-            toString(fileVersionLegalHoldId) as string,
+            (toString(fileVersionLegalHoldId) as string)!,
           ) as string,
           method: 'GET',
           headers: headersMap,

package/src/managers/fileVersionRetentions.ts

@@ -51,7 +51,7 @@ export class GetFileVersionRetentionByIdOptionals {
 }
 export interface GetFileVersionRetentionByIdOptionalsInput {
   readonly headers?: GetFileVersionRetentionByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export type GetFileVersionRetentionsQueryParamsDispositionActionField =
   | 'permanently_delete'
@@ -107,11 +107,9 @@ export class GetFileVersionRetentionsHeaders {
 export interface GetFileVersionRetentionsHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class GetFileVersionRetentionByIdHeaders {
   /**
@@ -131,11 +129,9 @@ export class GetFileVersionRetentionByIdHeaders {
 export interface GetFileVersionRetentionByIdHeadersInput {
   /**
    * Extra headers that will be included in the HTTP request. */
-  readonly extraHeaders?:
-    | undefined
-    | {
-        readonly [key: string]: undefined | string;
-      };
+  readonly extraHeaders?: {
+    readonly [key: string]: undefined | string;
+  };
 }
 export class FileVersionRetentionsManager {
   readonly auth?: Authentication;
@@ -162,7 +158,7 @@ export class FileVersionRetentionsManager {
    * **Note**:
    * File retention API is now **deprecated**.
    * To get information about files and file versions under retention,
-   * see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
+   * see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
    * @param {GetFileVersionRetentionsQueryParams} queryParams Query parameters of getFileVersionRetentions method
    * @param {GetFileVersionRetentionsHeadersInput} headersInput Headers of getFileVersionRetentions method
    * @param {CancellationToken} cancellationToken Token used for request cancellation.
@@ -221,7 +217,7 @@ export class FileVersionRetentionsManager {
      * **Note**:
      * File retention API is now **deprecated**.
      * To get information about files and file versions under retention,
-     * see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
+     * see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
      * @param {string} fileVersionRetentionId The ID of the file version retention.
     Example: "3424234"
      * @param {GetFileVersionRetentionByIdOptionalsInput} optionalsInput
@@ -247,7 +243,7 @@ export class FileVersionRetentionsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/file_version_retentions/',
-            toString(fileVersionRetentionId) as string,
+            (toString(fileVersionRetentionId) as string)!,
           ) as string,
           method: 'GET',
           headers: headersMap,