box-node-sdk 10.1.0 → 10.2.0

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;

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;

package/src/managers/users.ts

@@ -59,7 +59,7 @@ export class CreateUserOptionals {
 export interface CreateUserOptionalsInput {
   readonly queryParams?: CreateUserQueryParams;
   readonly headers?: CreateUserHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetUserByIdOptionals {
   readonly queryParams: GetUserByIdQueryParams =
@@ -92,7 +92,7 @@ export class GetUserByIdOptionals {
 export interface GetUserByIdOptionalsInput {
   readonly queryParams?: GetUserByIdQueryParams;
   readonly headers?: GetUserByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateUserByIdOptionals {
   readonly requestBody: UpdateUserByIdRequestBody =
@@ -131,7 +131,7 @@ export interface UpdateUserByIdOptionalsInput {
   readonly requestBody?: UpdateUserByIdRequestBody;
   readonly queryParams?: UpdateUserByIdQueryParams;
   readonly headers?: UpdateUserByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteUserByIdOptionals {
   readonly queryParams: DeleteUserByIdQueryParams =
@@ -164,7 +164,7 @@ export class DeleteUserByIdOptionals {
 export interface DeleteUserByIdOptionalsInput {
   readonly queryParams?: DeleteUserByIdQueryParams;
   readonly headers?: DeleteUserByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export type GetUsersQueryParamsUserTypeField =
   | 'all'
@@ -258,11 +258,9 @@ export class GetUsersHeaders {
 export interface GetUsersHeadersInput {
   /**
    * 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 CreateUserRequestBodyRoleField = 'coadmin' | 'user' | string;
 export type CreateUserRequestBodyStatusField =
@@ -371,11 +369,9 @@ export class CreateUserHeaders {
 export interface CreateUserHeadersInput {
   /**
    * 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 GetUserMeQueryParams {
   /**
@@ -408,11 +404,9 @@ export class GetUserMeHeaders {
 export interface GetUserMeHeadersInput {
   /**
    * 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 GetUserByIdQueryParams {
   /**
@@ -445,11 +439,9 @@ export class GetUserByIdHeaders {
 export interface GetUserByIdHeadersInput {
   /**
    * 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 UpdateUserByIdRequestBodyRoleField = 'coadmin' | 'user' | string;
 export type UpdateUserByIdRequestBodyStatusField =
@@ -583,11 +575,9 @@ export class UpdateUserByIdHeaders {
 export interface UpdateUserByIdHeadersInput {
   /**
    * 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 DeleteUserByIdQueryParams {
   /**
@@ -617,11 +607,9 @@ export class DeleteUserByIdHeaders {
 export interface DeleteUserByIdHeadersInput {
   /**
    * 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 UsersManager {
   readonly auth?: Authentication;

package/src/managers/webLinks.ts

@@ -42,7 +42,7 @@ export class CreateWebLinkOptionals {
 }
 export interface CreateWebLinkOptionalsInput {
   readonly headers?: CreateWebLinkHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetWebLinkByIdOptionals {
   readonly headers: GetWebLinkByIdHeaders = new GetWebLinkByIdHeaders({});
@@ -61,7 +61,7 @@ export class GetWebLinkByIdOptionals {
 }
 export interface GetWebLinkByIdOptionalsInput {
   readonly headers?: GetWebLinkByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateWebLinkByIdOptionals {
   readonly requestBody: UpdateWebLinkByIdRequestBody =
@@ -94,7 +94,7 @@ export class UpdateWebLinkByIdOptionals {
 export interface UpdateWebLinkByIdOptionalsInput {
   readonly requestBody?: UpdateWebLinkByIdRequestBody;
   readonly headers?: UpdateWebLinkByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteWebLinkByIdOptionals {
   readonly headers: DeleteWebLinkByIdHeaders = new DeleteWebLinkByIdHeaders({});
@@ -115,7 +115,7 @@ export class DeleteWebLinkByIdOptionals {
 }
 export interface DeleteWebLinkByIdOptionalsInput {
   readonly headers?: DeleteWebLinkByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface CreateWebLinkRequestBodyParentField {
   /**
@@ -157,11 +157,9 @@ export class CreateWebLinkHeaders {
 export interface CreateWebLinkHeadersInput {
   /**
    * 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 GetWebLinkByIdHeaders {
   /**
@@ -208,11 +206,9 @@ export interface GetWebLinkByIdHeadersInput {
   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 UpdateWebLinkByIdRequestBodyParentField {
   /**
@@ -302,11 +298,9 @@ export class UpdateWebLinkByIdHeaders {
 export interface UpdateWebLinkByIdHeadersInput {
   /**
    * 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 DeleteWebLinkByIdHeaders {
   /**
@@ -326,11 +320,9 @@ export class DeleteWebLinkByIdHeaders {
 export interface DeleteWebLinkByIdHeadersInput {
   /**
    * 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 WebLinksManager {
   readonly auth?: Authentication;

package/src/managers/webhooks.ts

@@ -50,7 +50,7 @@ export class CreateWebhookOptionals {
 }
 export interface CreateWebhookOptionalsInput {
   readonly headers?: CreateWebhookHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class GetWebhookByIdOptionals {
   readonly headers: GetWebhookByIdHeaders = new GetWebhookByIdHeaders({});
@@ -69,7 +69,7 @@ export class GetWebhookByIdOptionals {
 }
 export interface GetWebhookByIdOptionalsInput {
   readonly headers?: GetWebhookByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class UpdateWebhookByIdOptionals {
   readonly requestBody: UpdateWebhookByIdRequestBody =
@@ -102,7 +102,7 @@ export class UpdateWebhookByIdOptionals {
 export interface UpdateWebhookByIdOptionalsInput {
   readonly requestBody?: UpdateWebhookByIdRequestBody;
   readonly headers?: UpdateWebhookByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class DeleteWebhookByIdOptionals {
   readonly headers: DeleteWebhookByIdHeaders = new DeleteWebhookByIdHeaders({});
@@ -123,7 +123,7 @@ export class DeleteWebhookByIdOptionals {
 }
 export interface DeleteWebhookByIdOptionalsInput {
   readonly headers?: DeleteWebhookByIdHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class ValidateMessageOptionals {
   readonly secondaryKey?: string = void 0;
@@ -141,8 +141,8 @@ export class ValidateMessageOptionals {
   }
 }
 export interface ValidateMessageOptionalsInput {
-  readonly secondaryKey?: undefined | string;
-  readonly maxAge?: undefined | number;
+  readonly secondaryKey?: string;
+  readonly maxAge?: number;
 }
 export interface GetWebhooksQueryParams {
   /**
@@ -173,11 +173,9 @@ export class GetWebhooksHeaders {
 export interface GetWebhooksHeadersInput {
   /**
    * 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 CreateWebhookRequestBodyTargetTypeField = 'file' | 'folder';
 export interface CreateWebhookRequestBodyTargetField {
@@ -265,11 +263,9 @@ export class CreateWebhookHeaders {
 export interface CreateWebhookHeadersInput {
   /**
    * 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 GetWebhookByIdHeaders {
   /**
@@ -289,11 +285,9 @@ export class GetWebhookByIdHeaders {
 export interface GetWebhookByIdHeadersInput {
   /**
    * 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 UpdateWebhookByIdRequestBodyTargetTypeField = 'file' | 'folder';
 export interface UpdateWebhookByIdRequestBodyTargetField {
@@ -381,11 +375,9 @@ export class UpdateWebhookByIdHeaders {
 export interface UpdateWebhookByIdHeadersInput {
   /**
    * 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 DeleteWebhookByIdHeaders {
   /**
@@ -405,11 +397,9 @@ export class DeleteWebhookByIdHeaders {
 export interface DeleteWebhookByIdHeadersInput {
   /**
    * 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 WebhooksManager {
   readonly auth?: Authentication;

package/src/managers/workflows.ts

@@ -42,7 +42,7 @@ export class GetWorkflowsOptionals {
 }
 export interface GetWorkflowsOptionalsInput {
   readonly headers?: GetWorkflowsHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export class StartWorkflowOptionals {
   readonly headers: StartWorkflowHeaders = new StartWorkflowHeaders({});
@@ -61,7 +61,7 @@ export class StartWorkflowOptionals {
 }
 export interface StartWorkflowOptionalsInput {
   readonly headers?: StartWorkflowHeaders;
-  readonly cancellationToken?: undefined | CancellationToken;
+  readonly cancellationToken?: CancellationToken;
 }
 export interface GetWorkflowsQueryParams {
   /**
@@ -107,11 +107,9 @@ export class GetWorkflowsHeaders {
 export interface GetWorkflowsHeadersInput {
   /**
    * 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 StartWorkflowRequestBodyTypeField = 'workflow_parameters';
 export interface StartWorkflowRequestBodyFlowField {
@@ -180,11 +178,9 @@ export class StartWorkflowHeaders {
 export interface StartWorkflowHeadersInput {
   /**
    * 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 WorkflowsManager {
   readonly auth?: Authentication;