box-node-sdk 10.1.0 → 10.3.0

package/src/managers/folderLocks.ts

@@ -42,7 +42,7 @@ export class GetFolderLocksOptionals {
 }
 export interface GetFolderLocksOptionalsInput {
   readonly headers?: GetFolderLocksHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateFolderLockOptionals {
   readonly headers: CreateFolderLockHeaders = new CreateFolderLockHeaders({});
@@ -61,7 +61,7 @@ export class CreateFolderLockOptionals {
 }
 export interface CreateFolderLockOptionalsInput {
   readonly headers?: CreateFolderLockHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFolderLockByIdOptionals {
   readonly headers: DeleteFolderLockByIdHeaders =
@@ -86,7 +86,7 @@ export class DeleteFolderLockByIdOptionals {
 }
 export interface DeleteFolderLockByIdOptionalsInput {
   readonly headers?: DeleteFolderLockByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface GetFolderLocksQueryParams {
   /**
@@ -120,11 +120,9 @@ export class GetFolderLocksHeaders {
 export interface GetFolderLocksHeadersInput {
   /**
    * 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 CreateFolderLockRequestBodyLockedOperationsField {
   /**
@@ -174,11 +172,9 @@ export class CreateFolderLockHeaders {
 export interface CreateFolderLockHeadersInput {
   /**
    * 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 DeleteFolderLockByIdHeaders {
   /**
@@ -198,11 +194,9 @@ export class DeleteFolderLockByIdHeaders {
 export interface DeleteFolderLockByIdHeadersInput {
   /**
    * 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 FolderLocksManager {
   readonly auth?: Authentication;
@@ -347,7 +341,7 @@ export class FolderLocksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folder_locks/',
-            toString(folderLockId) as string,
+            (toString(folderLockId) as string)!,
           ) as string,
           method: 'DELETE',
           headers: headersMap,

package/src/managers/folderMetadata.ts

@@ -32,14 +32,25 @@ import { sdIsString } from '../serialization/json';
 import { sdIsList } from '../serialization/json';
 import { sdIsMap } from '../serialization/json';
 export class GetFolderMetadataOptionals {
+  readonly queryParams: GetFolderMetadataQueryParams =
+    {} satisfies GetFolderMetadataQueryParams;
   readonly headers: GetFolderMetadataHeaders = new GetFolderMetadataHeaders({});
   readonly cancellationToken?: CancellationToken = void 0;
   constructor(
-    fields: Omit<GetFolderMetadataOptionals, 'headers' | 'cancellationToken'> &
+    fields: Omit<
+      GetFolderMetadataOptionals,
+      'queryParams' | 'headers' | 'cancellationToken'
+    > &
       Partial<
-        Pick<GetFolderMetadataOptionals, 'headers' | 'cancellationToken'>
+        Pick<
+          GetFolderMetadataOptionals,
+          'queryParams' | 'headers' | 'cancellationToken'
+        >
       >,
   ) {
+    if (fields.queryParams !== undefined) {
+      this.queryParams = fields.queryParams;
+    }
     if (fields.headers !== undefined) {
       this.headers = fields.headers;
     }
@@ -49,8 +60,9 @@ export class GetFolderMetadataOptionals {
   }
 }
 export interface GetFolderMetadataOptionalsInput {
+  readonly queryParams?: GetFolderMetadataQueryParams;
   readonly headers?: GetFolderMetadataHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFolderMetadataByIdOptionals {
   readonly headers: GetFolderMetadataByIdHeaders =
@@ -75,7 +87,7 @@ export class GetFolderMetadataByIdOptionals {
 }
 export interface GetFolderMetadataByIdOptionalsInput {
   readonly headers?: GetFolderMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateFolderMetadataByIdOptionals {
   readonly headers: CreateFolderMetadataByIdHeaders =
@@ -100,7 +112,7 @@ export class CreateFolderMetadataByIdOptionals {
 }
 export interface CreateFolderMetadataByIdOptionalsInput {
   readonly headers?: CreateFolderMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateFolderMetadataByIdOptionals {
   readonly headers: UpdateFolderMetadataByIdHeaders =
@@ -125,7 +137,7 @@ export class UpdateFolderMetadataByIdOptionals {
 }
 export interface UpdateFolderMetadataByIdOptionalsInput {
   readonly headers?: UpdateFolderMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFolderMetadataByIdOptionals {
   readonly headers: DeleteFolderMetadataByIdHeaders =
@@ -150,7 +162,16 @@ export class DeleteFolderMetadataByIdOptionals {
 }
 export interface DeleteFolderMetadataByIdOptionalsInput {
   readonly headers?: DeleteFolderMetadataByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
+}
+export interface GetFolderMetadataQueryParams {
+  /**
+   * 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 GetFolderMetadataHeaders {
   /**
@@ -170,11 +191,9 @@ export class GetFolderMetadataHeaders {
 export interface GetFolderMetadataHeadersInput {
   /**
    * 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 GetFolderMetadataByIdScope = 'global' | 'enterprise' | string;
 export class GetFolderMetadataByIdHeaders {
@@ -195,11 +214,9 @@ export class GetFolderMetadataByIdHeaders {
 export interface GetFolderMetadataByIdHeadersInput {
   /**
    * 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 CreateFolderMetadataByIdScope = 'global' | 'enterprise' | string;
 export type CreateFolderMetadataByIdRequestBody = {
@@ -223,11 +240,9 @@ export class CreateFolderMetadataByIdHeaders {
 export interface CreateFolderMetadataByIdHeadersInput {
   /**
    * 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 UpdateFolderMetadataByIdScope = 'global' | 'enterprise' | string;
 export type UpdateFolderMetadataByIdRequestBodyOpField =
@@ -278,11 +293,9 @@ export class UpdateFolderMetadataByIdHeaders {
 export interface UpdateFolderMetadataByIdHeadersInput {
   /**
    * 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 DeleteFolderMetadataByIdScope = 'global' | 'enterprise' | string;
 export class DeleteFolderMetadataByIdHeaders {
@@ -303,11 +316,9 @@ export class DeleteFolderMetadataByIdHeaders {
 export interface DeleteFolderMetadataByIdHeadersInput {
   /**
    * 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 FolderMetadataManager {
   readonly auth?: Authentication;
@@ -354,11 +365,16 @@ export class FolderMetadataManager {
   ): Promise<Metadatas> {
     const optionals: GetFolderMetadataOptionals =
       new GetFolderMetadataOptionals({
+        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 });
@@ -368,10 +384,11 @@ export class FolderMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/metadata',
           ) as string,
           method: 'GET',
+          params: queryParamsMap,
           headers: headersMap,
           responseFormat: 'json' as ResponseFormat,
           auth: this.auth,
@@ -427,11 +444,11 @@ export class FolderMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/metadata/',
-            toString(scope) as string,
+            (toString(scope) as string)!,
             '/',
-            toString(templateKey) as string,
+            (toString(templateKey) as string)!,
           ) as string,
           method: 'GET',
           headers: headersMap,
@@ -498,11 +515,11 @@ export class FolderMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) 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,
@@ -570,11 +587,11 @@ export class FolderMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) 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,
@@ -635,11 +652,11 @@ export class FolderMetadataManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) 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/folderWatermarks.ts

@@ -43,7 +43,7 @@ export class GetFolderWatermarkOptionals {
 }
 export interface GetFolderWatermarkOptionalsInput {
   readonly headers?: GetFolderWatermarkHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateFolderWatermarkOptionals {
   readonly headers: UpdateFolderWatermarkHeaders =
@@ -68,7 +68,7 @@ export class UpdateFolderWatermarkOptionals {
 }
 export interface UpdateFolderWatermarkOptionalsInput {
   readonly headers?: UpdateFolderWatermarkHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFolderWatermarkOptionals {
   readonly headers: DeleteFolderWatermarkHeaders =
@@ -93,7 +93,7 @@ export class DeleteFolderWatermarkOptionals {
 }
 export interface DeleteFolderWatermarkOptionalsInput {
   readonly headers?: DeleteFolderWatermarkHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFolderWatermarkHeaders {
   /**
@@ -113,11 +113,9 @@ export class GetFolderWatermarkHeaders {
 export interface GetFolderWatermarkHeadersInput {
   /**
    * 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 UpdateFolderWatermarkRequestBodyWatermarkImprintField =
   | 'default'
@@ -174,11 +172,9 @@ export class UpdateFolderWatermarkHeaders {
 export interface UpdateFolderWatermarkHeadersInput {
   /**
    * 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 DeleteFolderWatermarkHeaders {
   /**
@@ -198,11 +194,9 @@ export class DeleteFolderWatermarkHeaders {
 export interface DeleteFolderWatermarkHeadersInput {
   /**
    * 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 FolderWatermarksManager {
   readonly auth?: Authentication;
@@ -260,7 +254,7 @@ export class FolderWatermarksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/watermark',
           ) as string,
           method: 'GET',
@@ -314,7 +308,7 @@ export class FolderWatermarksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/watermark',
           ) as string,
           method: 'PUT',
@@ -368,7 +362,7 @@ export class FolderWatermarksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/watermark',
           ) as string,
           method: 'DELETE',

package/src/managers/folders.ts

@@ -59,7 +59,7 @@ export class GetFolderByIdOptionals {
 export interface GetFolderByIdOptionalsInput {
   readonly queryParams?: GetFolderByIdQueryParams;
   readonly headers?: GetFolderByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateFolderByIdOptionals {
   readonly requestBody: UpdateFolderByIdRequestBody =
@@ -98,7 +98,7 @@ export interface UpdateFolderByIdOptionalsInput {
   readonly requestBody?: UpdateFolderByIdRequestBody;
   readonly queryParams?: UpdateFolderByIdQueryParams;
   readonly headers?: UpdateFolderByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteFolderByIdOptionals {
   readonly queryParams: DeleteFolderByIdQueryParams =
@@ -131,7 +131,7 @@ export class DeleteFolderByIdOptionals {
 export interface DeleteFolderByIdOptionalsInput {
   readonly queryParams?: DeleteFolderByIdQueryParams;
   readonly headers?: DeleteFolderByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetFolderItemsOptionals {
   readonly queryParams: GetFolderItemsQueryParams =
@@ -164,7 +164,7 @@ export class GetFolderItemsOptionals {
 export interface GetFolderItemsOptionalsInput {
   readonly queryParams?: GetFolderItemsQueryParams;
   readonly headers?: GetFolderItemsHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateFolderOptionals {
   readonly queryParams: CreateFolderQueryParams =
@@ -197,7 +197,7 @@ export class CreateFolderOptionals {
 export interface CreateFolderOptionalsInput {
   readonly queryParams?: CreateFolderQueryParams;
   readonly headers?: CreateFolderHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CopyFolderOptionals {
   readonly queryParams: CopyFolderQueryParams =
@@ -230,7 +230,7 @@ export class CopyFolderOptionals {
 export interface CopyFolderOptionalsInput {
   readonly queryParams?: CopyFolderQueryParams;
   readonly headers?: CopyFolderHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export type GetFolderByIdQueryParamsSortField =
   | 'id'
@@ -365,11 +365,9 @@ export interface GetFolderByIdHeadersInput {
   readonly boxapi?: 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 type UpdateFolderByIdRequestBodySyncStateField =
   | 'synced'
@@ -521,7 +519,7 @@ export interface UpdateFolderByIdRequestBody {
    * Passing an empty array `[]` or `null` will remove
    * the folder from all collections.
    *
-   * [1]: e://get-collections */
+   * [1]: https://developer.box.com/reference/get-collections */
   readonly collections?:
     | readonly UpdateFolderByIdRequestBodyCollectionsField[]
     | null;
@@ -591,11 +589,9 @@ export interface UpdateFolderByIdHeadersInput {
   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 interface DeleteFolderByIdQueryParams {
   /**
@@ -642,11 +638,9 @@ export interface DeleteFolderByIdHeadersInput {
   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 type GetFolderItemsQueryParamsSortField =
   | 'id'
@@ -777,11 +771,9 @@ export interface GetFolderItemsHeadersInput {
   readonly boxapi?: 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 interface CreateFolderRequestBodyParentField {
   /**
@@ -871,11 +863,9 @@ export class CreateFolderHeaders {
 export interface CreateFolderHeadersInput {
   /**
    * 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 CopyFolderRequestBodyParentField {
   /**
@@ -931,11 +921,9 @@ export class CopyFolderHeaders {
 export interface CopyFolderHeadersInput {
   /**
    * 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 FoldersManager {
   readonly auth?: Authentication;
@@ -967,10 +955,10 @@ export class FoldersManager {
      * Passing `sort`, `direction`, `offset`, and `limit`
      * parameters in query allows you to manage the
      * list of returned
-     * [folder items](r://folder--full#param-item-collection).
+     * [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection).
      *
      * To fetch more items within the folder, use the
-     * [Get items in a folder](e://get-folders-id-items) endpoint.
+     * [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.
      * @param {string} folderId The unique identifier that represent a folder.
     
     The ID for any folder can be determined
@@ -1023,7 +1011,7 @@ export class FoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
           ) as string,
           method: 'GET',
           params: queryParamsMap,
@@ -1089,7 +1077,7 @@ export class FoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
           ) as string,
           method: 'PUT',
           params: queryParamsMap,
@@ -1153,7 +1141,7 @@ export class FoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
           ) as string,
           method: 'DELETE',
           params: queryParamsMap,
@@ -1223,7 +1211,7 @@ export class FoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/items',
           ) as string,
           method: 'GET',
@@ -1338,7 +1326,7 @@ export class FoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/copy',
           ) as string,
           method: 'POST',