box-node-sdk 3.4.2 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/lib/managers/shield-information-barrier-reports.generated.d.ts +3 -3
  3. package/lib/managers/shield-information-barrier-reports.generated.js +2 -2
  4. package/lib/managers/shield-information-barrier-segment-members.generated.d.ts +2 -2
  5. package/lib/managers/shield-information-barrier-segment-members.generated.js +1 -1
  6. package/lib/managers/shield-information-barrier-segment-restrictions.generated.d.ts +2 -2
  7. package/lib/managers/shield-information-barrier-segment-restrictions.generated.js +1 -1
  8. package/lib/managers/shield-information-barrier-segments.generated.d.ts +2 -2
  9. package/lib/managers/shield-information-barrier-segments.generated.js +1 -1
  10. package/lib/managers/shield-information-barriers.generated.d.ts +15 -9
  11. package/lib/managers/shield-information-barriers.generated.js +4 -4
  12. package/lib/managers/shield-information-barriers.generated.js.map +1 -1
  13. package/lib/schemas/folder-mini.generated.d.ts +5 -5
  14. package/lib/schemas/index.generated.d.ts +5 -0
  15. package/lib/schemas/index.generated.js +5 -0
  16. package/lib/schemas/index.generated.js.map +1 -1
  17. package/lib/schemas/shield-information-barrier-reports.generated.d.ts +26 -0
  18. package/lib/schemas/shield-information-barrier-reports.generated.js +3 -0
  19. package/lib/schemas/shield-information-barrier-reports.generated.js.map +1 -0
  20. package/lib/schemas/shield-information-barrier-segment-members.generated.d.ts +26 -0
  21. package/lib/schemas/shield-information-barrier-segment-members.generated.js +3 -0
  22. package/lib/schemas/shield-information-barrier-segment-members.generated.js.map +1 -0
  23. package/lib/schemas/shield-information-barrier-segment-restrictions.generated.d.ts +26 -0
  24. package/lib/schemas/shield-information-barrier-segment-restrictions.generated.js +3 -0
  25. package/lib/schemas/shield-information-barrier-segment-restrictions.generated.js.map +1 -0
  26. package/lib/schemas/shield-information-barrier-segments.generated.d.ts +26 -0
  27. package/lib/schemas/shield-information-barrier-segments.generated.js +3 -0
  28. package/lib/schemas/shield-information-barrier-segments.generated.js.map +1 -0
  29. package/lib/schemas/shield-information-barriers.generated.d.ts +25 -0
  30. package/lib/schemas/shield-information-barriers.generated.js +3 -0
  31. package/lib/schemas/shield-information-barriers.generated.js.map +1 -0
  32. package/lib/schemas/sign-request-create-request.generated.d.ts +6 -2
  33. package/lib/schemas/sign-request-create-signer.generated.d.ts +10 -2
  34. package/lib/schemas/sign-request-prefill-tag.generated.d.ts +1 -1
  35. package/lib/schemas/sign-request-signer-input.generated.d.ts +2 -2
  36. package/lib/schemas/sign-requests.generated.d.ts +3 -8
  37. package/lib/schemas/sign-templates.generated.d.ts +15 -3
  38. package/lib/schemas/template-signer-input.generated.d.ts +6 -1
  39. package/lib/schemas/template-signer.generated.d.ts +7 -0
  40. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -2,6 +2,18 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ## [3.5.0](https://github.com/box/box-node-sdk/compare/v3.4.2...v3.5.0) (2024-02-19)
6
+
7
+
8
+ ### New Features and Enhancements
9
+
10
+ * Sign request group ([#870](https://github.com/box/box-node-sdk/issues/870)) ([11bf5d2](https://github.com/box/box-node-sdk/commit/11bf5d2db7e0cefc669aab99c8b65c632289ac46))
11
+
12
+ ### Bug Fixes
13
+
14
+ * 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))
15
+ * Remove delete classification ([#869](https://github.com/box/box-node-sdk/issues/869)) ([22384ab](https://github.com/box/box-node-sdk/commit/22384abc3abbc35800cbcdea7c7eb9a452cc4859))
16
+
5
17
  ### [3.4.2](https://github.com/box/box-node-sdk/compare/v3.4.1...v3.4.2) (2023-11-08)
6
18
 
7
19
 
@@ -26,13 +26,13 @@ declare class ShieldInformationBarrierReportsManager {
26
26
  /**
27
27
  * List shield information barrier reports
28
28
  *
29
- * Lists shield information barrier reports with specific IDs.
29
+ * Lists shield information barrier reports.
30
30
  * @param {object} options Options for the request
31
31
  * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
32
32
  * @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`.
33
33
  * @param {number} [options.limit] The maximum number of items to return per page.
34
34
  * @param {Function} [callback] Passed the result if successful, error otherwise
35
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
35
+ * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error
36
36
  */
37
37
  getAll(options: {
38
38
  /**
@@ -50,7 +50,7 @@ declare class ShieldInformationBarrierReportsManager {
50
50
  * The maximum number of items to return per page.
51
51
  */
52
52
  readonly limit?: number;
53
- }, callback?: Function): Promise<object>;
53
+ }, callback?: Function): Promise<schemas.ShieldInformationBarrierReports>;
54
54
  /**
55
55
  * Create shield information barrier report
56
56
  *
@@ -41,13 +41,13 @@ var ShieldInformationBarrierReportsManager = /** @class */ (function () {
41
41
  /**
42
42
  * List shield information barrier reports
43
43
  *
44
- * Lists shield information barrier reports with specific IDs.
44
+ * Lists shield information barrier reports.
45
45
  * @param {object} options Options for the request
46
46
  * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
47
47
  * @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`.
48
48
  * @param {number} [options.limit] The maximum number of items to return per page.
49
49
  * @param {Function} [callback] Passed the result if successful, error otherwise
50
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
50
+ * @returns {Promise<schemas.ShieldInformationBarrierReports>} A promise resolving to the result or rejecting with an error
51
51
  */
52
52
  ShieldInformationBarrierReportsManager.prototype.getAll = function (options, callback) {
53
53
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('shield_information_barrier_reports'), params = {
@@ -34,7 +34,7 @@ declare class ShieldInformationBarrierSegmentMembersManager {
34
34
  * @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`.
35
35
  * @param {number} [options.limit] The maximum number of items to return per page.
36
36
  * @param {Function} [callback] Passed the result if successful, error otherwise
37
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
37
+ * @returns {Promise<schemas.ShieldInformationBarrierSegmentMembers>} A promise resolving to the result or rejecting with an error
38
38
  */
39
39
  getAll(options: {
40
40
  /**
@@ -52,7 +52,7 @@ declare class ShieldInformationBarrierSegmentMembersManager {
52
52
  * The maximum number of items to return per page.
53
53
  */
54
54
  readonly limit?: number;
55
- }, callback?: Function): Promise<object>;
55
+ }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegmentMembers>;
56
56
  /**
57
57
  * Create shield information barrier segment member
58
58
  *
@@ -49,7 +49,7 @@ var ShieldInformationBarrierSegmentMembersManager = /** @class */ (function () {
49
49
  * @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`.
50
50
  * @param {number} [options.limit] The maximum number of items to return per page.
51
51
  * @param {Function} [callback] Passed the result if successful, error otherwise
52
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
52
+ * @returns {Promise<schemas.ShieldInformationBarrierSegmentMembers>} A promise resolving to the result or rejecting with an error
53
53
  */
54
54
  ShieldInformationBarrierSegmentMembersManager.prototype.getAll = function (options, callback) {
55
55
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('shield_information_barrier_segment_members'), params = {
@@ -34,7 +34,7 @@ declare class ShieldInformationBarrierSegmentRestrictionsManager {
34
34
  * @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`.
35
35
  * @param {number} [options.limit] The maximum number of items to return per page.
36
36
  * @param {Function} [callback] Passed the result if successful, error otherwise
37
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
37
+ * @returns {Promise<schemas.ShieldInformationBarrierSegmentRestrictions>} A promise resolving to the result or rejecting with an error
38
38
  */
39
39
  getAll(options: {
40
40
  /**
@@ -52,7 +52,7 @@ declare class ShieldInformationBarrierSegmentRestrictionsManager {
52
52
  * The maximum number of items to return per page.
53
53
  */
54
54
  readonly limit?: number;
55
- }, callback?: Function): Promise<object>;
55
+ }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegmentRestrictions>;
56
56
  /**
57
57
  * Create shield information barrier segment restriction
58
58
  *
@@ -49,7 +49,7 @@ var ShieldInformationBarrierSegmentRestrictionsManager = /** @class */ (function
49
49
  * @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`.
50
50
  * @param {number} [options.limit] The maximum number of items to return per page.
51
51
  * @param {Function} [callback] Passed the result if successful, error otherwise
52
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
52
+ * @returns {Promise<schemas.ShieldInformationBarrierSegmentRestrictions>} A promise resolving to the result or rejecting with an error
53
53
  */
54
54
  ShieldInformationBarrierSegmentRestrictionsManager.prototype.getAll = function (options, callback) {
55
55
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('shield_information_barrier_segment_restrictions'), params = {
@@ -33,7 +33,7 @@ declare class ShieldInformationBarrierSegmentsManager {
33
33
  * @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`.
34
34
  * @param {number} [options.limit] The maximum number of items to return per page.
35
35
  * @param {Function} [callback] Passed the result if successful, error otherwise
36
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
36
+ * @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
37
37
  */
38
38
  getAll(options: {
39
39
  /**
@@ -51,7 +51,7 @@ declare class ShieldInformationBarrierSegmentsManager {
51
51
  * The maximum number of items to return per page.
52
52
  */
53
53
  readonly limit?: number;
54
- }, callback?: Function): Promise<object>;
54
+ }, callback?: Function): Promise<schemas.ShieldInformationBarrierSegments>;
55
55
  /**
56
56
  * Create shield information barrier segment
57
57
  *
@@ -48,7 +48,7 @@ var ShieldInformationBarrierSegmentsManager = /** @class */ (function () {
48
48
  * @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`.
49
49
  * @param {number} [options.limit] The maximum number of items to return per page.
50
50
  * @param {Function} [callback] Passed the result if successful, error otherwise
51
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
51
+ * @returns {Promise<schemas.ShieldInformationBarrierSegments>} A promise resolving to the result or rejecting with an error
52
52
  */
53
53
  ShieldInformationBarrierSegmentsManager.prototype.getAll = function (options, callback) {
54
54
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('shield_information_barrier_segments'), params = {
@@ -11,7 +11,7 @@ declare class ShieldInformationBarrierManager {
11
11
  /**
12
12
  * Get shield information barrier with specified ID
13
13
  *
14
- * Get shield information barrier based on provided ID..
14
+ * Get shield information barrier based on provided ID.
15
15
  * @param {object} options Options for the request
16
16
  * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
17
17
  * @param {Function} [callback] Passed the result if successful, error otherwise
@@ -29,36 +29,39 @@ declare class ShieldInformationBarrierManager {
29
29
  * Retrieves a list of shield information barrier objects
30
30
  * for the enterprise of JWT.
31
31
  * @param {object} [options] Options for the request
32
- * @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`.
32
+ * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
33
33
  * @param {number} [options.limit] The maximum number of items to return per page.
34
34
  * @param {Function} [callback] Passed the result if successful, error otherwise
35
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
35
+ * @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
36
36
  */
37
37
  getAll(options?: {
38
38
  /**
39
39
  * Defines the position marker at which to begin returning results. This is
40
40
  * used when paginating using marker-based pagination.
41
- *
42
- * This requires `usemarker` to be set to `true`.
43
41
  */
44
42
  readonly marker?: string;
45
43
  /**
46
44
  * The maximum number of items to return per page.
47
45
  */
48
46
  readonly limit?: number;
49
- }, callback?: Function): Promise<object>;
47
+ }, callback?: Function): Promise<schemas.ShieldInformationBarriers>;
50
48
  /**
51
49
  * Create shield information barrier
52
50
  *
53
51
  * Creates a shield information barrier to
54
52
  * separate individuals/groups within the same
55
53
  * firm and prevents confidential information passing between them.
56
- * @param {schemas.ShieldInformationBarrier} body
54
+ * @param {object} body
57
55
  * @param {object} [options] Options for the request
58
56
  * @param {Function} [callback] Passed the result if successful, error otherwise
59
57
  * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
60
58
  */
61
- create(body: schemas.ShieldInformationBarrier, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
59
+ create(body: {
60
+ enterprise: {
61
+ type: string;
62
+ id: string;
63
+ };
64
+ }, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
62
65
  /**
63
66
  * Add changed status of shield information barrier with specified ID
64
67
  *
@@ -68,6 +71,9 @@ declare class ShieldInformationBarrierManager {
68
71
  * @param {Function} [callback] Passed the result if successful, error otherwise
69
72
  * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
70
73
  */
71
- changeStatusById(body: object, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
74
+ changeStatusById(body: {
75
+ id: string;
76
+ status: string;
77
+ }, options?: {}, callback?: Function): Promise<schemas.ShieldInformationBarrier>;
72
78
  }
73
79
  export = ShieldInformationBarrierManager;
@@ -26,7 +26,7 @@ var ShieldInformationBarrierManager = /** @class */ (function () {
26
26
  /**
27
27
  * Get shield information barrier with specified ID
28
28
  *
29
- * Get shield information barrier based on provided ID..
29
+ * Get shield information barrier based on provided ID.
30
30
  * @param {object} options Options for the request
31
31
  * @param {string} options.shield_information_barrier_id The ID of the shield information barrier.
32
32
  * @param {Function} [callback] Passed the result if successful, error otherwise
@@ -44,10 +44,10 @@ var ShieldInformationBarrierManager = /** @class */ (function () {
44
44
  * Retrieves a list of shield information barrier objects
45
45
  * for the enterprise of JWT.
46
46
  * @param {object} [options] Options for the request
47
- * @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`.
47
+ * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
48
48
  * @param {number} [options.limit] The maximum number of items to return per page.
49
49
  * @param {Function} [callback] Passed the result if successful, error otherwise
50
- * @returns {Promise<object>} A promise resolving to the result or rejecting with an error
50
+ * @returns {Promise<schemas.ShieldInformationBarriers>} A promise resolving to the result or rejecting with an error
51
51
  */
52
52
  ShieldInformationBarrierManager.prototype.getAll = function (options, callback) {
53
53
  var queryParams = __rest(options, []), apiPath = (0, url_path_1.default)('shield_information_barriers'), params = {
@@ -61,7 +61,7 @@ var ShieldInformationBarrierManager = /** @class */ (function () {
61
61
  * Creates a shield information barrier to
62
62
  * separate individuals/groups within the same
63
63
  * firm and prevents confidential information passing between them.
64
- * @param {schemas.ShieldInformationBarrier} body
64
+ * @param {object} body
65
65
  * @param {object} [options] Options for the request
66
66
  * @param {Function} [callback] Passed the result if successful, error otherwise
67
67
  * @returns {Promise<schemas.ShieldInformationBarrier>} A promise resolving to the result or rejecting with an error
@@ -1 +1 @@
1
- {"version":3,"file":"shield-information-barriers.generated.js","sourceRoot":"","sources":["../../src/managers/shield-information-barriers.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,8DAAuC;AAEvC;GACG;AACH;IAEC;;OAEG;IACH,yCAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD;;;;;;;;OAQG;IACH,iDAAO,GAAP,UACC,OAKC,EACD,QAAmB;QAGjB,IAA+B,0BAA0B,GAEtD,OAAO,8BAF+C,EACtD,WAAW,UACX,OAAO,EAHN,iCAGJ,CADc,EAEf,OAAO,GAAG,IAAA,kBAAO,EAChB,6BAA6B,EAC7B,0BAA0B,CAC1B,EACD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;SACf,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;;;OAUG;IACH,gDAAM,GAAN,UACC,OAYC,EACD,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;SACf,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;;;OAUG;IACH,gDAAM,GAAN,UACC,IAAsC,EACtC,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;OAQG;IACH,0DAAgB,GAAhB,UACC,IAAY,EACZ,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,EAAE,eAAe,CAAC,EACjE,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,sCAAC;AAAD,CAAC,AAvID,IAuIC;AACD,iBAAS,+BAA+B,CAAC"}
1
+ {"version":3,"file":"shield-information-barriers.generated.js","sourceRoot":"","sources":["../../src/managers/shield-information-barriers.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,8DAAuC;AAEvC;GACG;AACH;IAEC;;OAEG;IACH,yCAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IACD;;;;;;;;OAQG;IACH,iDAAO,GAAP,UACC,OAKC,EACD,QAAmB;QAGjB,IAA+B,0BAA0B,GAEtD,OAAO,8BAF+C,EACtD,WAAW,UACX,OAAO,EAHN,iCAGJ,CADc,EAEf,OAAO,GAAG,IAAA,kBAAO,EAChB,6BAA6B,EAC7B,0BAA0B,CAC1B,EACD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;SACf,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;;;OAUG;IACH,gDAAM,GAAN,UACC,OAUC,EACD,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;SACf,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;;;OAUG;IACH,gDAAM,GAAN,UACC,IAKC,EACD,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAChD,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACD;;;;;;;;OAQG;IACH,0DAAgB,GAAhB,UACC,IAGC,EACD,OAAY,EACZ,QAAmB;QAEnB,IAAW,WAAW,UAAK,OAAO,EAA5B,EAAkB,CAAF,EACrB,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,EAAE,eAAe,CAAC,EACjE,MAAM,GAAG;YACR,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACV,CAAC;QACH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,sCAAC;AAAD,CAAC,AA7ID,IA6IC;AACD,iBAAS,+BAA+B,CAAC"}
@@ -6,11 +6,6 @@ import * as schemas from '.';
6
6
  * nested under another resource.
7
7
  */
8
8
  export interface FolderMini extends schemas.FolderBase {
9
- /**
10
- * The name of the folder.
11
- * Example: Contracts
12
- */
13
- name?: string;
14
9
  /**
15
10
  * A numeric identifier that represents the most recent user event
16
11
  * that has been applied to this item.
@@ -28,4 +23,9 @@ export interface FolderMini extends schemas.FolderBase {
28
23
  * Example: 3
29
24
  */
30
25
  sequence_id?: string;
26
+ /**
27
+ * The name of the folder.
28
+ * Example: Contracts
29
+ */
30
+ name?: string;
31
31
  }
@@ -10,14 +10,19 @@ export * from './shield-information-barrier-reference.generated';
10
10
  export * from './shield-information-barrier-report-base.generated';
11
11
  export * from './shield-information-barrier-report-details.generated';
12
12
  export * from './shield-information-barrier-report.generated';
13
+ export * from './shield-information-barrier-reports.generated';
13
14
  export * from './shield-information-barrier-segment-member-base.generated';
14
15
  export * from './shield-information-barrier-segment-member-mini.generated';
15
16
  export * from './shield-information-barrier-segment-member.generated';
17
+ export * from './shield-information-barrier-segment-members.generated';
16
18
  export * from './shield-information-barrier-segment-restriction-base.generated';
17
19
  export * from './shield-information-barrier-segment-restriction-mini.generated';
18
20
  export * from './shield-information-barrier-segment-restriction.generated';
21
+ export * from './shield-information-barrier-segment-restrictions.generated';
19
22
  export * from './shield-information-barrier-segment.generated';
23
+ export * from './shield-information-barrier-segments.generated';
20
24
  export * from './shield-information-barrier.generated';
25
+ export * from './shield-information-barriers.generated';
21
26
  export * from './sign-request-base.generated';
22
27
  export * from './sign-request-create-request.generated';
23
28
  export * from './sign-request-create-signer.generated';
@@ -26,14 +26,19 @@ __exportStar(require("./shield-information-barrier-reference.generated"), export
26
26
  __exportStar(require("./shield-information-barrier-report-base.generated"), exports);
27
27
  __exportStar(require("./shield-information-barrier-report-details.generated"), exports);
28
28
  __exportStar(require("./shield-information-barrier-report.generated"), exports);
29
+ __exportStar(require("./shield-information-barrier-reports.generated"), exports);
29
30
  __exportStar(require("./shield-information-barrier-segment-member-base.generated"), exports);
30
31
  __exportStar(require("./shield-information-barrier-segment-member-mini.generated"), exports);
31
32
  __exportStar(require("./shield-information-barrier-segment-member.generated"), exports);
33
+ __exportStar(require("./shield-information-barrier-segment-members.generated"), exports);
32
34
  __exportStar(require("./shield-information-barrier-segment-restriction-base.generated"), exports);
33
35
  __exportStar(require("./shield-information-barrier-segment-restriction-mini.generated"), exports);
34
36
  __exportStar(require("./shield-information-barrier-segment-restriction.generated"), exports);
37
+ __exportStar(require("./shield-information-barrier-segment-restrictions.generated"), exports);
35
38
  __exportStar(require("./shield-information-barrier-segment.generated"), exports);
39
+ __exportStar(require("./shield-information-barrier-segments.generated"), exports);
36
40
  __exportStar(require("./shield-information-barrier.generated"), exports);
41
+ __exportStar(require("./shield-information-barriers.generated"), exports);
37
42
  __exportStar(require("./sign-request-base.generated"), exports);
38
43
  __exportStar(require("./sign-request-create-request.generated"), exports);
39
44
  __exportStar(require("./sign-request-create-signer.generated"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.generated.js","sourceRoot":"","sources":["../../src/schemas/index.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,gEAA8C;AAC9C,0DAAwC;AACxC,0DAAwC;AACxC,8EAA4D;AAC5D,mFAAiE;AACjE,qFAAmE;AACnE,wFAAsE;AACtE,gFAA8D;AAC9D,6FAA2E;AAC3E,6FAA2E;AAC3E,wFAAsE;AACtE,kGAAgF;AAChF,kGAAgF;AAChF,6FAA2E;AAC3E,iFAA+D;AAC/D,yEAAuD;AACvD,gEAA8C;AAC9C,0EAAwD;AACxD,yEAAuD;AACvD,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,2DAAyC;AACzC,4DAA0C;AAC1C,4DAA0C;AAC1C,6DAA2C;AAC3C,oEAAkD;AAClD,8DAA4C;AAC5C,wDAAsC"}
1
+ {"version":3,"file":"index.generated.js","sourceRoot":"","sources":["../../src/schemas/index.generated.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8DAA4C;AAC5C,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,gEAA8C;AAC9C,0DAAwC;AACxC,0DAAwC;AACxC,8EAA4D;AAC5D,mFAAiE;AACjE,qFAAmE;AACnE,wFAAsE;AACtE,gFAA8D;AAC9D,iFAA+D;AAC/D,6FAA2E;AAC3E,6FAA2E;AAC3E,wFAAsE;AACtE,yFAAuE;AACvE,kGAAgF;AAChF,kGAAgF;AAChF,6FAA2E;AAC3E,8FAA4E;AAC5E,iFAA+D;AAC/D,kFAAgE;AAChE,yEAAuD;AACvD,0EAAwD;AACxD,gEAA8C;AAC9C,0EAAwD;AACxD,yEAAuD;AACvD,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,2DAAyC;AACzC,4DAA0C;AAC1C,4DAA0C;AAC1C,6DAA2C;AAC3C,oEAAkD;AAClD,8DAA4C;AAC5C,wDAAsC"}
@@ -0,0 +1,26 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barrier Reports
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarrierReports {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information
23
+ * barrier reports.
24
+ */
25
+ entries?: schemas.ShieldInformationBarrierReport[];
26
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barrier-reports.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barrier-reports.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-reports.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,26 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barrier Segment Members
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarrierSegmentMembers {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information
23
+ * barrier segment members
24
+ */
25
+ entries?: schemas.ShieldInformationBarrierSegmentMember[];
26
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barrier-segment-members.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barrier-segment-members.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segment-members.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,26 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barrier Segment Restrictions
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarrierSegmentRestrictions {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information barrier
23
+ * segment restriction objects
24
+ */
25
+ entries?: schemas.ShieldInformationBarrierSegmentRestriction[];
26
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barrier-segment-restrictions.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barrier-segment-restrictions.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segment-restrictions.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,26 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barrier Segments
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarrierSegments {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information barrier
23
+ * segments
24
+ */
25
+ entries?: schemas.ShieldInformationBarrierSegment[];
26
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barrier-segments.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barrier-segments.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segments.generated.ts"],"names":[],"mappings":""}
@@ -0,0 +1,25 @@
1
+ import * as schemas from '.';
2
+ /**
3
+ * List of Shield Information Barriers
4
+ *
5
+ * The part of an API response that describes marker
6
+ * based pagination
7
+ */
8
+ export interface ShieldInformationBarriers {
9
+ /**
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
14
+ */
15
+ limit?: number;
16
+ /**
17
+ * The marker for the start of the next page of results.
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
+ */
20
+ next_marker?: string;
21
+ /**
22
+ * A list of shield information barrier objects
23
+ */
24
+ entries?: schemas.ShieldInformationBarrier[];
25
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=shield-information-barriers.generated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"shield-information-barriers.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barriers.generated.ts"],"names":[],"mappings":""}
@@ -10,8 +10,12 @@ export interface SignRequestCreateRequest extends schemas.SignRequestBase {
10
10
  */
11
11
  source_files?: schemas.FileBase[];
12
12
  /**
13
- * Array of signers for the sign request. 35 is the
14
- * max number of signers permitted.
13
+ * Force a specific color for the signature (blue, black, or red)
14
+ * Example: blue
15
+ */
16
+ signature_color?: 'blue' | 'black' | 'red';
17
+ /**
18
+ * Array of signers for the sign request. 35 is the max number of signers permitted.
15
19
  */
16
20
  signers: schemas.SignRequestCreateSigner[];
17
21
  }
@@ -5,10 +5,11 @@
5
5
  */
6
6
  export interface SignRequestCreateSigner {
7
7
  /**
8
- * Email address of the signer
8
+ * Email address of the signer.
9
+ * The email address of the signer is required when making signature requests, except when using templates that are configured to include emails.
9
10
  * Example: example@gmail.com
10
11
  */
11
- email: string;
12
+ email?: string;
12
13
  /**
13
14
  * Defines the role of the signer in the sign request. A `signer`
14
15
  * must sign the document and an `approver` must approve the document. A
@@ -73,4 +74,11 @@ export interface SignRequestCreateSigner {
73
74
  * Example: SecretPassword123
74
75
  */
75
76
  password?: string;
77
+ /**
78
+ * If set, signers who have the same group ID will be assigned to the same input.
79
+ * A signer group is expected to have more than one signer. When a group contains fewer than two signers,
80
+ * it will be converted to a single signer and the group will be removed.
81
+ * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
82
+ */
83
+ signer_group_id?: string;
76
84
  }
@@ -22,7 +22,7 @@ export interface SignRequestPrefillTag {
22
22
  checkbox_value?: boolean;
23
23
  /**
24
24
  * Date prefill value
25
- * Example: 2021-04-26T08:12:13.982Z
25
+ * Example: 2021-04-26
26
26
  */
27
27
  date_value?: string;
28
28
  }
@@ -9,12 +9,12 @@ export interface SignRequestSignerInput extends schemas.SignRequestPrefillTag {
9
9
  * Type of input
10
10
  * Example: text
11
11
  */
12
- type?: 'signature' | 'date' | 'text' | 'checkbox';
12
+ type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
13
13
  /**
14
14
  * Content type of input
15
15
  * Example: signature
16
16
  */
17
- content_type?: 'initial' | 'stamp' | 'signature' | 'company' | 'title' | 'email' | 'full_name' | 'first_name' | 'last_name' | 'text' | 'date' | 'checkbox' | 'attachment';
17
+ content_type?: 'signature' | 'initial' | 'stamp' | 'date' | 'checkbox' | 'text' | 'full_name' | 'first_name' | 'last_name' | 'company' | 'title' | 'email' | 'attachment' | 'radio' | 'dropdown';
18
18
  /**
19
19
  * Index of page that the input is on
20
20
  * Example: 4
@@ -1,6 +1,6 @@
1
1
  import * as schemas from '.';
2
2
  /**
3
- * Sign Requests
3
+ * Box Sign
4
4
  *
5
5
  * The part of an API response that describes marker
6
6
  * based pagination
@@ -15,14 +15,9 @@ export interface SignRequests {
15
15
  limit?: number;
16
16
  /**
17
17
  * The marker for the start of the next page of results.
18
- * Example: 3000
18
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
19
19
  */
20
- next_marker?: number;
21
- /**
22
- * The marker for the start of the previous page of results.
23
- * Example: 1000
24
- */
25
- prev_marker?: number;
20
+ next_marker?: string;
26
21
  /**
27
22
  * A list of sign requests
28
23
  */
@@ -7,12 +7,24 @@ import * as schemas from '.';
7
7
  */
8
8
  export interface SignTemplates {
9
9
  /**
10
- * A list of templates.
10
+ * The limit that was used for these entries. This will be the same as the
11
+ * `limit` query parameter unless that value exceeded the maximum value
12
+ * allowed. The maximum value varies by API.
13
+ * Example: 1000
11
14
  */
12
- entries?: schemas.SignTemplate[];
15
+ limit?: number;
13
16
  /**
14
- * The marker for the start of the previous page of results.
17
+ * The marker for the start of the next page of results.
15
18
  * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
16
19
  */
20
+ next_marker?: string;
21
+ /**
22
+ * The marker for the start of the previous page of results.
23
+ * Example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
24
+ */
17
25
  prev_marker?: string;
26
+ /**
27
+ * A list of templates.
28
+ */
29
+ entries?: schemas.SignTemplate[];
18
30
  }
@@ -9,7 +9,7 @@ export interface TemplateSignerInput extends schemas.SignRequestPrefillTag {
9
9
  * Type of input
10
10
  * Example: text
11
11
  */
12
- type?: 'signature' | 'date' | 'text' | 'checkbox' | 'radio' | 'dropdown';
12
+ type?: 'signature' | 'date' | 'text' | 'checkbox' | 'attachment' | 'radio' | 'dropdown';
13
13
  /**
14
14
  * Content type of input
15
15
  * Example: text
@@ -48,4 +48,9 @@ export interface TemplateSignerInput extends schemas.SignRequestPrefillTag {
48
48
  * The size of the input.
49
49
  */
50
50
  dimensions?: object;
51
+ /**
52
+ * The label field is used especially for text, attachment, radio, and checkbox type inputs.
53
+ * Example: Legal name
54
+ */
55
+ label?: string;
51
56
  }
@@ -33,4 +33,11 @@ export interface TemplateSigner {
33
33
  * Example: 2
34
34
  */
35
35
  order?: number;
36
+ /**
37
+ * If set, signers who have the same group ID will be assigned to the same input.
38
+ * A signer group is expected to have more than one signer. When a group contains fewer than two signers,
39
+ * it will be converted to a single signer and the group will be removed.
40
+ * Example: cd4ff89-8fc1-42cf-8b29-1890dedd26d7
41
+ */
42
+ signer_group_id?: string;
36
43
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "box-node-sdk",
3
3
  "author": "Box <oss@box.com>",
4
- "version": "3.4.2",
4
+ "version": "3.5.0",
5
5
  "description": "Official SDK for Box Plaform APIs",
6
6
  "license": "Apache-2.0",
7
7
  "repository": {
@@ -43,7 +43,7 @@
43
43
  "jsonwebtoken": "^9.0.2",
44
44
  "merge-options": "^1.0.1",
45
45
  "promise-queue": "^2.2.3",
46
- "proxy-agent": "^6.3.1",
46
+ "proxy-agent": "^6.4.0",
47
47
  "url-template": "^2.0.8",
48
48
  "uuid": "^9.0.0"
49
49
  },