box-node-sdk - npm Package Compare versions

Comparing version 3.4.2 to 3.5.0

CHANGELOG.md

@@ -5,2 +5,14 @@ # Changelog
 
+## [3.5.0](https://github.com/box/box-node-sdk/compare/v3.4.2...v3.5.0) (2024-02-19)
+
+
+### New Features and Enhancements
+
+* Sign request group ([#870](https://github.com/box/box-node-sdk/issues/870)) ([11bf5d2](https://github.com/box/box-node-sdk/commit/11bf5d2db7e0cefc669aab99c8b65c632289ac46))
+
+### Bug Fixes
+
+* Bumped proxy-agent to 6.4.0 ([#874](https://github.com/box/box-node-sdk/issues/874)) ([55a8a0b](https://github.com/box/box-node-sdk/commit/55a8a0baebe151f4107fdbec0a1022e9534f88a4))
+* Remove delete classification ([#869](https://github.com/box/box-node-sdk/issues/869)) ([22384ab](https://github.com/box/box-node-sdk/commit/22384abc3abbc35800cbcdea7c7eb9a452cc4859))
+
 ### [3.4.2](https://github.com/box/box-node-sdk/compare/v3.4.1...v3.4.2) (2023-11-08)
@@ -7,0 +19,0 @@

lib/managers/shield-information-barrier-reports.generated.d.ts

@@ -29,3 +29,3 @@ import BoxClient from '../box-client';
      *
-     * Lists shield information barrier reports with specific IDs.
+     * Lists shield information barrier reports.
      * @param {object} options Options for the request
@@ -36,3 +36,3 @@ * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error
      */
@@ -55,3 +55,3 @@ getAll(options: {
         readonly limit?: number;
-    }, callback?: Function): Promise<object>;
+    }, callback?: Function): Promise<schemas.ShieldInformationBarrierReports>;
     /**
@@ -58,0 +58,0 @@ * Create shield information barrier report

lib/managers/shield-information-barrier-reports.generated.js

@@ -44,3 +44,3 @@ "use strict";
      *
-     * Lists shield information barrier reports with specific IDs.
+     * Lists shield information barrier reports.
      * @param {object} options Options for the request
@@ -51,3 +51,3 @@ * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error
      */
@@ -54,0 +54,0 @@ ShieldInformationBarrierReportsManager.prototype.getAll = function (options, callback) {

lib/managers/shield-information-barrier-segment-members.generated.d.ts

@@ -37,3 +37,3 @@ import BoxClient from '../box-client';
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegmentMembers>} A promise resolving to the result or rejecting with an error
      */
@@ -56,3 +56,3 @@ getAll(options: {
         readonly limit?: number;
-    }, callback?: Function): Promise<object>;
+    }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegmentMembers>;
     /**
@@ -59,0 +59,0 @@ * Create shield information barrier segment member

lib/managers/shield-information-barrier-segment-members.generated.js

@@ -52,3 +52,3 @@ "use strict";
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegmentMembers>} A promise resolving to the result or rejecting with an error
      */
@@ -55,0 +55,0 @@ ShieldInformationBarrierSegmentMembersManager.prototype.getAll = function (options, callback) {

lib/managers/shield-information-barrier-segment-restrictions.generated.d.ts

@@ -37,3 +37,3 @@ import BoxClient from '../box-client';
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegmentRestrictions>} A promise resolving to the result or rejecting with an error
      */
@@ -56,3 +56,3 @@ getAll(options: {
         readonly limit?: number;
-    }, callback?: Function): Promise<object>;
+    }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegmentRestrictions>;
     /**
@@ -59,0 +59,0 @@ * Create shield information barrier segment restriction

lib/managers/shield-information-barrier-segment-restrictions.generated.js

@@ -52,3 +52,3 @@ "use strict";
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegmentRestrictions>} A promise resolving to the result or rejecting with an error
      */
@@ -55,0 +55,0 @@ ShieldInformationBarrierSegmentRestrictionsManager.prototype.getAll = function (options, callback) {

lib/managers/shield-information-barrier-segments.generated.d.ts

@@ -36,3 +36,3 @@ import BoxClient from '../box-client';
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
      */
@@ -55,3 +55,3 @@ getAll(options: {
         readonly limit?: number;
-    }, callback?: Function): Promise<object>;
+    }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegments>;
     /**
@@ -58,0 +58,0 @@ * Create shield information barrier segment

lib/managers/shield-information-barrier-segments.generated.js

@@ -51,3 +51,3 @@ "use strict";
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
      */
@@ -54,0 +54,0 @@ ShieldInformationBarrierSegmentsManager.prototype.getAll = function (options, callback) {

lib/managers/shield-information-barriers.generated.d.ts

@@ -14,3 +14,3 @@ import BoxClient from '../box-client';
      *
-     * Get shield information barrier based on provided ID..
+     * Get shield information barrier based on provided ID.
      * @param {object} options Options for the request
@@ -33,6 +33,6 @@ * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
      * @param {object} [options] Options for the request
-     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
+     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
      * @param {number} [options.limit] The maximum number of items to return per page.
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
      */
@@ -43,4 +43,2 @@ getAll(options?: {
          * used when paginating using marker-based pagination.
-         *
-         * This requires `usemarker` to be set to `true`.
          */
@@ -52,3 +50,3 @@ readonly marker?: string;
         readonly limit?: number;
-    }, callback?: Function): Promise<object>;
+    }, callback?: Function): Promise<schemas.ShieldInformationBarriers>;
     /**
@@ -60,3 +58,3 @@ * Create shield information barrier
      * firm and prevents confidential information passing between them.
-     * @param {schemas.ShieldInformationBarrier} body
+     * @param {object} body
      * @param {object} [options] Options for the request
@@ -66,3 +64,8 @@ * @param {Function} [callback] Passed the result if successful, error otherwise
      */
-    create(body: schemas.ShieldInformationBarrier, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
+    create(body: {
+        enterprise: {
+            type: string;
+            id: string;
+        };
+    }, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
     /**
@@ -77,4 +80,7 @@ * Add changed status of shield information barrier with specified ID
      */
-    changeStatusById(body: object, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
+    changeStatusById(body: {
+        id: string;
+        status: string;
+    }, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
 }
 export = ShieldInformationBarrierManager;

lib/managers/shield-information-barriers.generated.js

@@ -29,3 +29,3 @@ "use strict";
      *
-     * Get shield information barrier based on provided ID..
+     * Get shield information barrier based on provided ID.
      * @param {object} options Options for the request
@@ -48,6 +48,6 @@ * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
      * @param {object} [options] Options for the request
-     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
+     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
      * @param {number} [options.limit] The maximum number of items to return per page.
      * @param {Function} [callback] Passed the result if successful, error otherwise
-     * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
+     * @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
      */
@@ -66,3 +66,3 @@ ShieldInformationBarrierManager.prototype.getAll = function (options, callback) {
      * firm and prevents confidential information passing between them.
-     * @param {schemas.ShieldInformationBarrier} body
+     * @param {object} body
      * @param {object} [options] Options for the request
@@ -69,0 +69,0 @@ * @param {Function} [callback] Passed the result if successful, error otherwise

lib/schemas/folder-mini.generated.d.ts

@@ -10,7 +10,2 @@ import * as schemas from '.';
     /**
-     * The name of the folder.
-     * Example: Contracts
-     */
-    name?: string;
-    /**
      * A numeric identifier that represents the most recent user event
@@ -32,2 +27,7 @@ * that has been applied to this item.
     sequence_id?: string;
+    /**
+     * The name of the folder.
+     * Example: Contracts
+     */
+    name?: string;
 }

lib/schemas/index.generated.d.ts

@@ -13,10 +13,15 @@ export * from './enterprise-base.generated';
 export * from './shield-information-barrier-report.generated';
+export * from './shield-information-barrier-reports.generated';
 export * from './shield-information-barrier-segment-member-base.generated';
 export * from './shield-information-barrier-segment-member-mini.generated';
 export * from './shield-information-barrier-segment-member.generated';
+export * from './shield-information-barrier-segment-members.generated';
 export * from './shield-information-barrier-segment-restriction-base.generated';
 export * from './shield-information-barrier-segment-restriction-mini.generated';
 export * from './shield-information-barrier-segment-restriction.generated';
+export * from './shield-information-barrier-segment-restrictions.generated';
 export * from './shield-information-barrier-segment.generated';
+export * from './shield-information-barrier-segments.generated';
 export * from './shield-information-barrier.generated';
+export * from './shield-information-barriers.generated';
 export * from './sign-request-base.generated';
@@ -23,0 +28,0 @@ export * from './sign-request-create-request.generated';

lib/schemas/index.generated.js

@@ -29,10 +29,15 @@ "use strict";
 __exportStar(require("./shield-information-barrier-report.generated"), exports);
+__exportStar(require("./shield-information-barrier-reports.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-member-base.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-member-mini.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-member.generated"), exports);
+__exportStar(require("./shield-information-barrier-segment-members.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-restriction-base.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-restriction-mini.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment-restriction.generated"), exports);
+__exportStar(require("./shield-information-barrier-segment-restrictions.generated"), exports);
 __exportStar(require("./shield-information-barrier-segment.generated"), exports);
+__exportStar(require("./shield-information-barrier-segments.generated"), exports);
 __exportStar(require("./shield-information-barrier.generated"), exports);
+__exportStar(require("./shield-information-barriers.generated"), exports);
 __exportStar(require("./sign-request-base.generated"), exports);
@@ -39,0 +44,0 @@ __exportStar(require("./sign-request-create-request.generated"), exports);

lib/schemas/sign-request-create-request.generated.d.ts

@@ -13,6 +13,10 @@ import * as schemas from '.';
     /**
-     * Array of signers for the sign request. 35 is the
-     * max number of signers permitted.
+     * Force a specific color for the signature (blue, black, or red)
+     * Example: blue
      */
+    signature_color?: 'blue' | 'black' | 'red';
+    /**
+     * Array of signers for the sign request. 35 is the max number of signers permitted.
+     */
     signers: schemas.SignRequestCreateSigner[];
 }

lib/schemas/sign-request-create-signer.generated.d.ts

@@ -8,6 +8,7 @@ /**
     /**
-     * Email address of the signer
+     * Email address of the signer.
+     * The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.
      * Example: [e-mail]
      */
-    email: string;
+    email?: string;
     /**
@@ -77,2 +78,9 @@ * Defines the role of the signer in the sign request. A `signer`
     password?: string;
+    /**
+     * If set, signers who have the same group ID will be assigned to the same input.
+     * A signer group is expected to have more than one signer. When a group contains fewer than two signers,
+     * it will be converted to a single signer and the group will be removed.
+     * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
+     */
+    signer_group_id?: string;
 }

lib/schemas/sign-request-prefill-tag.generated.d.ts

@@ -25,5 +25,5 @@ /**
      * Date prefill value
-     * Example: 2021-04-26T08:12:13.982Z
+     * Example: 2021-04-26
      */
     date_value?: string;
 }

lib/schemas/sign-request-signer-input.generated.d.ts

@@ -12,3 +12,3 @@ import * as schemas from '.';
      */
-    type?: 'signature' | 'date' | 'text' | 'checkbox';
+    type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
     /**
@@ -18,3 +18,3 @@ * Content type of input
      */
-    content_type?: 'initial' | 'stamp' | 'signature' | 'company' | 'title' | 'email' | 'full_name' | 'first_name' | 'last_name' | 'text' | 'date' | 'checkbox' | 'attachment';
+    content_type?: 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown';
     /**
@@ -21,0 +21,0 @@ * Index of page that the input is on

lib/schemas/sign-requests.generated.d.ts

 import * as schemas from '.';
 /**
- * Sign Requests
+ * Box Sign
  *
@@ -18,11 +18,6 @@ * The part of an API response that describes marker
      * The marker for the start of the next page of results.
-     * Example: 3000
+     * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
      */
-    next_marker?: number;
+    next_marker?: string;
     /**
-     * The marker for the start of the previous page of results.
-     * Example: 1000
-     */
-    prev_marker?: number;
-    /**
      * A list of sign requests
@@ -29,0 +24,0 @@ */

lib/schemas/sign-templates.generated.d.ts

@@ -10,10 +10,22 @@ import * as schemas from '.';
     /**
-     * A list of templates.
+     * The limit that was used for these entries. This will be the same as the
+     * `limit` query parameter unless that value exceeded the maximum value
+     * allowed. The maximum value varies by API.
+     * Example: 1000
      */
-    entries?: schemas.SignTemplate[];
+    limit?: number;
     /**
-     * The marker for the start of the previous page of results.
+     * The marker for the start of the next page of results.
      * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
      */
+    next_marker?: string;
+    /**
+     * The marker for the start of the previous page of results.
+     * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
+     */
     prev_marker?: string;
+    /**
+     * A list of templates.
+     */
+    entries?: schemas.SignTemplate[];
 }

lib/schemas/template-signer-input.generated.d.ts

@@ -12,3 +12,3 @@ import * as schemas from '.';
      */
-    type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
+    type?: 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown';
     /**
@@ -52,2 +52,7 @@ * Content type of input
     dimensions?: object;
+    /**
+     * The label field is used especially for text, attachment, radio, and checkbox type inputs.
+     * Example: Legal name
+     */
+    label?: string;
 }

lib/schemas/template-signer.generated.d.ts

@@ -36,2 +36,9 @@ import * as schemas from '.';
     order?: number;
+    /**
+     * If set, signers who have the same group ID will be assigned to the same input.
+     * A signer group is expected to have more than one signer. When a group contains fewer than two signers,
+     * it will be converted to a single signer and the group will be removed.
+     * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
+     */
+    signer_group_id?: string;
 }

package.json

 {
   "name": "box-node-sdk",
   "author": "Box <[e-mail]>",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Official SDK for Box Plaform APIs",
@@ -46,3 +46,3 @@ "license": "Apache-2.0",
     "promise-queue": "^2.2.3",
-    "proxy-agent": "^6.3.1",
+    "proxy-agent": "^6.4.0",
     "url-template": "^2.0.8",
@@ -49,0 +49,0 @@ "uuid": "^9.0.0"

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1154596

0.8%

Number of package files

317

4.97%

Lines of code

19449

0.97%

Dependency changes

• + Added

  @types/node@18.19.113
  (transitive)

• - Removed

  @types/node@18.19.112
  (transitive)

• Updated

  proxy-agent@^6.4.0