box-node-sdk 10.1.0 → 10.3.0

package/src/managers/trashedFiles.ts

@@ -63,7 +63,7 @@ export interface RestoreFileFromTrashOptionalsInput {
   readonly requestBody?: RestoreFileFromTrashRequestBody;
   readonly queryParams?: RestoreFileFromTrashQueryParams;
   readonly headers?: RestoreFileFromTrashHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetTrashedFileByIdOptionals {
   readonly queryParams: GetTrashedFileByIdQueryParams =
@@ -98,7 +98,7 @@ export class GetTrashedFileByIdOptionals {
 export interface GetTrashedFileByIdOptionalsInput {
   readonly queryParams?: GetTrashedFileByIdQueryParams;
   readonly headers?: GetTrashedFileByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteTrashedFileByIdOptionals {
   readonly headers: DeleteTrashedFileByIdHeaders =
@@ -123,7 +123,7 @@ export class DeleteTrashedFileByIdOptionals {
 }
 export interface DeleteTrashedFileByIdOptionalsInput {
   readonly headers?: DeleteTrashedFileByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface RestoreFileFromTrashRequestBodyParentField {
   /**
@@ -169,11 +169,9 @@ export class RestoreFileFromTrashHeaders {
 export interface RestoreFileFromTrashHeadersInput {
   /**
    * 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 GetTrashedFileByIdQueryParams {
   /**
@@ -206,11 +204,9 @@ export class GetTrashedFileByIdHeaders {
 export interface GetTrashedFileByIdHeadersInput {
   /**
    * 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 DeleteTrashedFileByIdHeaders {
   /**
@@ -230,11 +226,9 @@ export class DeleteTrashedFileByIdHeaders {
 export interface DeleteTrashedFileByIdHeadersInput {
   /**
    * 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 TrashedFilesManager {
   readonly auth?: Authentication;
@@ -303,7 +297,7 @@ export class TrashedFilesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
           ) as string,
           method: 'POST',
           params: queryParamsMap,
@@ -328,10 +322,10 @@ export class TrashedFilesManager {
      * trash can it be retrieved with this API call. If instead one of
      * its parent folders was moved to the trash, only that folder
      * can be inspected using the
-     * [`GET /folders/:id/trash`](e://get_folders_id_trash) API.
+     * [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.
      *
      * To list all items that have been moved to the trash, please
-     * use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
+     * use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)
      * API.
      * @param {string} fileId The unique identifier that represents a file.
     
@@ -373,7 +367,7 @@ export class TrashedFilesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/trash',
           ) as string,
           method: 'GET',
@@ -424,7 +418,7 @@ export class TrashedFilesManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/trash',
           ) as string,
           method: 'DELETE',

package/src/managers/trashedFolders.ts

@@ -63,7 +63,7 @@ export interface RestoreFolderFromTrashOptionalsInput {
   readonly requestBody?: RestoreFolderFromTrashRequestBody;
   readonly queryParams?: RestoreFolderFromTrashQueryParams;
   readonly headers?: RestoreFolderFromTrashHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetTrashedFolderByIdOptionals {
   readonly queryParams: GetTrashedFolderByIdQueryParams =
@@ -97,7 +97,7 @@ export class GetTrashedFolderByIdOptionals {
 export interface GetTrashedFolderByIdOptionalsInput {
   readonly queryParams?: GetTrashedFolderByIdQueryParams;
   readonly headers?: GetTrashedFolderByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteTrashedFolderByIdOptionals {
   readonly headers: DeleteTrashedFolderByIdHeaders =
@@ -122,7 +122,7 @@ export class DeleteTrashedFolderByIdOptionals {
 }
 export interface DeleteTrashedFolderByIdOptionalsInput {
   readonly headers?: DeleteTrashedFolderByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface RestoreFolderFromTrashRequestBodyParentField {
   /**
@@ -168,11 +168,9 @@ export class RestoreFolderFromTrashHeaders {
 export interface RestoreFolderFromTrashHeadersInput {
   /**
    * 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 GetTrashedFolderByIdQueryParams {
   /**
@@ -205,11 +203,9 @@ export class GetTrashedFolderByIdHeaders {
 export interface GetTrashedFolderByIdHeadersInput {
   /**
    * 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 DeleteTrashedFolderByIdHeaders {
   /**
@@ -229,11 +225,9 @@ export class DeleteTrashedFolderByIdHeaders {
 export interface DeleteTrashedFolderByIdHeadersInput {
   /**
    * 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 TrashedFoldersManager {
   readonly auth?: Authentication;
@@ -312,7 +306,7 @@ export class TrashedFoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
           ) as string,
           method: 'POST',
           params: queryParamsMap,
@@ -337,10 +331,10 @@ export class TrashedFoldersManager {
      * trash can it be retrieved with this API call. If instead one of
      * its parent folders was moved to the trash, only that folder
      * can be inspected using the
-     * [`GET /folders/:id/trash`](e://get_folders_id_trash) API.
+     * [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API.
      *
      * To list all items that have been moved to the trash, please
-     * use the [`GET /folders/trash/items`](e://get-folders-trash-items/)
+     * use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/)
      * API.
      * @param {string} folderId The unique identifier that represent a folder.
     
@@ -385,7 +379,7 @@ export class TrashedFoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/trash',
           ) as string,
           method: 'GET',
@@ -439,7 +433,7 @@ export class TrashedFoldersManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/folders/',
-            toString(folderId) as string,
+            (toString(folderId) as string)!,
             '/trash',
           ) as string,
           method: 'DELETE',

package/src/managers/trashedItems.ts

@@ -98,11 +98,9 @@ export class GetTrashedItemsHeaders {
 export interface GetTrashedItemsHeadersInput {
   /**
    * 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 TrashedItemsManager {
   readonly auth?: Authentication;

package/src/managers/trashedWebLinks.ts

@@ -63,7 +63,7 @@ export interface RestoreWeblinkFromTrashOptionalsInput {
   readonly requestBody?: RestoreWeblinkFromTrashRequestBody;
   readonly queryParams?: RestoreWeblinkFromTrashQueryParams;
   readonly headers?: RestoreWeblinkFromTrashHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetTrashedWebLinkByIdOptionals {
   readonly queryParams: GetTrashedWebLinkByIdQueryParams =
@@ -97,7 +97,7 @@ export class GetTrashedWebLinkByIdOptionals {
 export interface GetTrashedWebLinkByIdOptionalsInput {
   readonly queryParams?: GetTrashedWebLinkByIdQueryParams;
   readonly headers?: GetTrashedWebLinkByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteTrashedWebLinkByIdOptionals {
   readonly headers: DeleteTrashedWebLinkByIdHeaders =
@@ -122,7 +122,7 @@ export class DeleteTrashedWebLinkByIdOptionals {
 }
 export interface DeleteTrashedWebLinkByIdOptionalsInput {
   readonly headers?: DeleteTrashedWebLinkByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface RestoreWeblinkFromTrashRequestBodyParentField {
   /**
@@ -168,11 +168,9 @@ export class RestoreWeblinkFromTrashHeaders {
 export interface RestoreWeblinkFromTrashHeadersInput {
   /**
    * 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 GetTrashedWebLinkByIdQueryParams {
   /**
@@ -205,11 +203,9 @@ export class GetTrashedWebLinkByIdHeaders {
 export interface GetTrashedWebLinkByIdHeadersInput {
   /**
    * 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 DeleteTrashedWebLinkByIdHeaders {
   /**
@@ -229,11 +225,9 @@ export class DeleteTrashedWebLinkByIdHeaders {
 export interface DeleteTrashedWebLinkByIdHeadersInput {
   /**
    * 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 TrashedWebLinksManager {
   readonly auth?: Authentication;
@@ -296,7 +290,7 @@ export class TrashedWebLinksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/web_links/',
-            toString(webLinkId) as string,
+            (toString(webLinkId) as string)!,
           ) as string,
           method: 'POST',
           params: queryParamsMap,
@@ -350,7 +344,7 @@ export class TrashedWebLinksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/web_links/',
-            toString(webLinkId) as string,
+            (toString(webLinkId) as string)!,
             '/trash',
           ) as string,
           method: 'GET',
@@ -395,7 +389,7 @@ export class TrashedWebLinksManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/web_links/',
-            toString(webLinkId) as string,
+            (toString(webLinkId) as string)!,
             '/trash',
           ) as string,
           method: 'DELETE',

package/src/managers/uploads.ts

@@ -63,7 +63,7 @@ export class UploadFileVersionOptionals {
 export interface UploadFileVersionOptionalsInput {
   readonly queryParams?: UploadFileVersionQueryParams;
   readonly headers?: UploadFileVersionHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UploadFileOptionals {
   readonly queryParams: UploadFileQueryParams =
@@ -96,7 +96,7 @@ export class UploadFileOptionals {
 export interface UploadFileOptionalsInput {
   readonly queryParams?: UploadFileQueryParams;
   readonly headers?: UploadFileHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UploadWithPreflightCheckOptionals {
   readonly queryParams: UploadWithPreflightCheckQueryParams =
@@ -130,7 +130,7 @@ export class UploadWithPreflightCheckOptionals {
 export interface UploadWithPreflightCheckOptionalsInput {
   readonly queryParams?: UploadWithPreflightCheckQueryParams;
   readonly headers?: UploadWithPreflightCheckHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface UploadFileVersionRequestBodyAttributesField {
   /**
@@ -237,11 +237,9 @@ export interface UploadFileVersionHeadersInput {
   readonly contentMd5?: 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 PreflightFileUploadCheckRequestBodyParentField {
   /**
@@ -277,11 +275,9 @@ export class PreflightFileUploadCheckHeaders {
 export interface PreflightFileUploadCheckHeadersInput {
   /**
    * 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 UploadFileRequestBodyAttributesParentField {
   /**
@@ -384,11 +380,9 @@ export interface UploadFileHeadersInput {
   readonly contentMd5?: 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 UploadWithPreflightCheckRequestBodyAttributesParentField {
   /**
@@ -481,11 +475,9 @@ export interface UploadWithPreflightCheckHeadersInput {
   readonly contentMd5?: 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 UploadsManager {
   readonly auth?: Authentication;
@@ -564,7 +556,7 @@ export class UploadsManager {
           url: ''.concat(
             this.networkSession.baseUrls.uploadUrl,
             '/2.0/files/',
-            toString(fileId) as string,
+            (toString(fileId) as string)!,
             '/content',
           ) as string,
           method: 'POST',

package/src/managers/userCollaborations.ts

@@ -57,7 +57,7 @@ export class GetCollaborationByIdOptionals {
 export interface GetCollaborationByIdOptionalsInput {
   readonly queryParams?: GetCollaborationByIdQueryParams;
   readonly headers?: GetCollaborationByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateCollaborationByIdOptionals {
   readonly requestBody: UpdateCollaborationByIdRequestBody =
@@ -91,7 +91,7 @@ export class UpdateCollaborationByIdOptionals {
 export interface UpdateCollaborationByIdOptionalsInput {
   readonly requestBody?: UpdateCollaborationByIdRequestBody;
   readonly headers?: UpdateCollaborationByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteCollaborationByIdOptionals {
   readonly headers: DeleteCollaborationByIdHeaders =
@@ -116,7 +116,7 @@ export class DeleteCollaborationByIdOptionals {
 }
 export interface DeleteCollaborationByIdOptionalsInput {
   readonly headers?: DeleteCollaborationByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class CreateCollaborationOptionals {
   readonly queryParams: CreateCollaborationQueryParams =
@@ -151,7 +151,7 @@ export class CreateCollaborationOptionals {
 export interface CreateCollaborationOptionalsInput {
   readonly queryParams?: CreateCollaborationQueryParams;
   readonly headers?: CreateCollaborationHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface GetCollaborationByIdQueryParams {
   /**
@@ -184,11 +184,9 @@ export class GetCollaborationByIdHeaders {
 export interface GetCollaborationByIdHeadersInput {
   /**
    * 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 UpdateCollaborationByIdRequestBodyRoleField =
   | 'editor'
@@ -238,10 +236,14 @@ export interface UpdateCollaborationByIdRequestBody {
    * invitee's **All Files** page. We recommend you limit the number of
    * collaborations with `can_view_path` enabled to 1,000 per user.
    *
-   * Only owner or co-owners can invite collaborators with a `can_view_path` of
-   * `true`.
+   * Only an owner or co-owners can invite collaborators with a `can_view_path` of
+   * `true`. Only an owner can update `can_view_path` on existing collaborations.
+   *
+   * `can_view_path` can only be used for folder collaborations.
    *
-   * `can_view_path` can only be used for folder collaborations. */
+   * When you delete a folder with `can_view_path=true`, collaborators may still see the parent path.
+   * For instructions on how to remove this, see
+   * [Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed). */
   readonly canViewPath?: boolean;
   readonly rawData?: SerializedData;
 }
@@ -263,11 +265,9 @@ export class UpdateCollaborationByIdHeaders {
 export interface UpdateCollaborationByIdHeadersInput {
   /**
    * 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 DeleteCollaborationByIdHeaders {
   /**
@@ -287,11 +287,9 @@ export class DeleteCollaborationByIdHeaders {
 export interface DeleteCollaborationByIdHeadersInput {
   /**
    * 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 CreateCollaborationRequestBodyItemTypeField = 'file' | 'folder';
 export interface CreateCollaborationRequestBodyItemField {
@@ -360,10 +358,14 @@ export interface CreateCollaborationRequestBody {
    * invitee's **All Files** page. We recommend you limit the number of
    * collaborations with `can_view_path` enabled to 1,000 per user.
    *
-   * Only owner or co-owners can invite collaborators with a `can_view_path` of
-   * `true`.
+   * Only an owner or co-owners can invite collaborators with a `can_view_path` of
+   * `true`. Only an owner can update `can_view_path` on existing collaborations.
+   *
+   * `can_view_path` can only be used for folder collaborations.
    *
-   * `can_view_path` can only be used for folder collaborations. */
+   * When you delete a folder with `can_view_path=true`, collaborators may still see the parent path.
+   * For instructions on how to remove this, see
+   * [Even though a folder invited via can_view_path is deleted, the path remains displayed](https://support.box.com/hc/en-us/articles/37472814319891-Even-though-a-folder-invited-via-can-view-path-is-deleted-the-path-remains-displayed). */
   readonly canViewPath?: boolean;
   /**
    * Set the expiration date for the collaboration. At this date, the
@@ -413,11 +415,9 @@ export class CreateCollaborationHeaders {
 export interface CreateCollaborationHeadersInput {
   /**
    * 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 UserCollaborationsManager {
   readonly auth?: Authentication;
@@ -476,7 +476,7 @@ export class UserCollaborationsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/collaborations/',
-            toString(collaborationId) as string,
+            (toString(collaborationId) as string)!,
           ) as string,
           method: 'GET',
           params: queryParamsMap,
@@ -523,7 +523,7 @@ export class UserCollaborationsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/collaborations/',
-            toString(collaborationId) as string,
+            (toString(collaborationId) as string)!,
           ) as string,
           method: 'PUT',
           headers: headersMap,
@@ -570,7 +570,7 @@ export class UserCollaborationsManager {
           url: ''.concat(
             this.networkSession.baseUrls.baseUrl,
             '/2.0/collaborations/',
-            toString(collaborationId) as string,
+            (toString(collaborationId) as string)!,
           ) as string,
           method: 'DELETE',
           headers: headersMap,