box-node-sdk 2.8.1 → 2.10.0

package/lib/schemas/shield-information-barrier-segment-restriction-mini.generated.d.ts

@@ -0,0 +1,20 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier segment restriction (Mini)
+ *
+ * A mini representation of
+ * a segment restriction object for
+ * the shield information barrier
+ */
+export interface ShieldInformationBarrierSegmentRestrictionMini extends schemas.ShieldInformationBarrierSegmentRestrictionBase {
+    /**
+     * The `type` and `id` of the
+     * requested shield information barrier segment.
+     */
+    shield_information_barrier_segment: object;
+    /**
+     * The `type` and `id` of the
+     * restricted shield information barrier segment.
+     */
+    restricted_segment: object;
+}

package/lib/schemas/shield-information-barrier-segment-restriction-mini.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shield-information-barrier-segment-restriction-mini.generated.js.map

package/lib/schemas/shield-information-barrier-segment-restriction-mini.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shield-information-barrier-segment-restriction-mini.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segment-restriction-mini.generated.ts"],"names":[],"mappings":""}

package/lib/schemas/shield-information-barrier-segment-restriction.generated.d.ts

@@ -0,0 +1,33 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier segment restriction
+ *
+ * A standard representation of a
+ * segment restriction of a shield information barrier
+ * object
+ */
+export interface ShieldInformationBarrierSegmentRestriction extends schemas.ShieldInformationBarrierSegmentRestrictionMini {
+    shield_information_barrier?: schemas.ShieldInformationBarrierBase;
+    /**
+     * ISO date time string when this
+     * shield information barrier
+     * Segment Restriction object was created.
+     * Example: 2020-06-26T18:44:45.869Z
+     */
+    created_at?: string;
+    /**
+     * The user who created this shield information barrier segment Restriction.
+     */
+    created_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this
+     * shield information barrier segment
+     * Restriction was updated.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    updated_at?: string;
+    /**
+     * The user that updated this shield information barrier segment Restriction.
+     */
+    updated_by?: schemas.UserBase;
+}

package/lib/schemas/shield-information-barrier-segment-restriction.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shield-information-barrier-segment-restriction.generated.js.map

package/lib/schemas/shield-information-barrier-segment-restriction.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shield-information-barrier-segment-restriction.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segment-restriction.generated.ts"],"names":[],"mappings":""}

package/lib/schemas/shield-information-barrier-segment.generated.d.ts

@@ -0,0 +1,50 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier segment
+ *
+ * A shield information barrier segment object
+ */
+export interface ShieldInformationBarrierSegment {
+    /**
+     * The unique identifier for the shield information barrier segment
+     * Example: 11446498
+     */
+    id?: string;
+    /**
+     * The type of the shield information barrier segment
+     * Example: shield_information_barrier_segment
+     */
+    type?: 'shield_information_barrier_segment';
+    shield_information_barrier?: schemas.ShieldInformationBarrierBase;
+    /**
+     * Name of the shield information barrier segment
+     * Example: Investment Banking
+     */
+    name?: string;
+    /**
+     * Description of the shield information barrier segment
+     * Example: 'Corporate division that engages in advisory_based financial
+     *  transactions on behalf of individuals, corporations, and governments.'
+     */
+    description?: string;
+    /**
+     * ISO date time string when this shield information
+     * barrier object was created.
+     * Example: 2020-06-26T18:44:45.869Z
+     */
+    created_at?: string;
+    /**
+     * The user who created this shield information barrier segment.
+     */
+    created_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this
+     * shield information barrier segment was updated.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    updated_at?: string;
+    /**
+     * The user that updated this shield information barrier segment.
+     */
+    updated_by?: schemas.UserBase;
+}

package/lib/schemas/shield-information-barrier-segment.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shield-information-barrier-segment.generated.js.map

package/lib/schemas/shield-information-barrier-segment.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shield-information-barrier-segment.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier-segment.generated.ts"],"names":[],"mappings":""}

package/lib/schemas/shield-information-barrier.generated.d.ts

@@ -0,0 +1,56 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier
+ *
+ * A standard representation of a
+ * shield information barrier object
+ */
+export interface ShieldInformationBarrier {
+    /**
+     * The unique identifier for the shield information barrier
+     * Example: 11446498
+     */
+    id?: string;
+    /**
+     * The type of the shield information barrier
+     * Example: shield_information_barrier
+     */
+    type?: 'shield_information_barrier';
+    /**
+     * The `type` and `id` of enterprise this barrier is under.
+     */
+    enterprise?: schemas.EnterpriseBase;
+    /**
+     * Status of the shield information barrier
+     * Example: draft
+     */
+    status?: 'draft' | 'pending' | 'disabled' | 'enabled' | 'invalid';
+    /**
+     * ISO date time string when this
+     * shield information barrier object was created.
+     * Example: 2020-06-26T18:44:45.869Z
+     */
+    created_at?: string;
+    /**
+     * The user who created this shield information barrier.
+     */
+    created_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this shield information barrier was updated.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    updated_at?: string;
+    /**
+     * The user that updated this shield information barrier.
+     */
+    updated_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this shield information barrier was enabled.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    enabled_at?: string;
+    /**
+     * The user that enabled this shield information barrier.
+     */
+    enabled_by?: schemas.UserBase;
+}

package/lib/schemas/shield-information-barrier.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shield-information-barrier.generated.js.map

package/lib/schemas/shield-information-barrier.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shield-information-barrier.generated.js","sourceRoot":"","sources":["../../src/schemas/shield-information-barrier.generated.ts"],"names":[],"mappings":""}

package/lib/schemas/sign-request-base.generated.d.ts

@@ -0,0 +1,74 @@
+import * as schemas from '.';
+/**
+ * Create a sign request
+ *
+ * A request to create a sign request object
+ */
+export interface SignRequestBase {
+    /**
+     * Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI.
+     * Example: true
+     */
+    is_document_preparation_needed?: boolean;
+    /**
+     * When specified, signature request will be redirected to this url when a document is signed.
+     * Example: https://www.example.com
+     */
+    redirect_url?: string;
+    /**
+     * The uri that a signer will be redirected to after declining to sign a document.
+     * Example: https://declined-redirect.com
+     */
+    declined_redirect_url?: string;
+    /**
+     * Disables the usage of signatures generated by typing (text).
+     * Example: true
+     * @default true
+     */
+    are_text_signatures_enabled?: boolean;
+    /**
+     * Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
+     * Example: Sign Request from Acme
+     */
+    email_subject?: string;
+    /**
+     * Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
+     * Example: Hello! Please sign the document below
+     */
+    email_message?: string;
+    /**
+     * Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.
+     * Example: true
+     */
+    are_reminders_enabled?: boolean;
+    /**
+     * The destination folder to place final, signed document and signing
+     * log. Only `ID` and `type` fields are required. The root folder,
+     * folder ID `0`, cannot be used.
+     */
+    parent_folder: schemas.FolderMini;
+    /**
+     * Name of the sign request.
+     * Example: name
+     */
+    name?: string;
+    /**
+     * When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
+     */
+    prefill_tags?: schemas.SignRequestPrefillTag[];
+    /**
+     * Number of days after which this request will automatically expire if not completed.
+     * Example: 2
+     */
+    days_valid?: number;
+    /**
+     * This can be used to reference an ID in an external system that the sign request is related to.
+     * Example: 123
+     */
+    external_id?: string;
+    /**
+     * Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.
+     * Example: true
+     */
+    is_phone_verification_required_to_view?: boolean;
+}

package/lib/schemas/sign-request-base.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sign-request-base.generated.js.map

package/lib/schemas/sign-request-base.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-request-base.generated.js","sourceRoot":"","sources":["../../src/schemas/sign-request-base.generated.ts"],"names":[],"mappings":""}

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

@@ -4,82 +4,22 @@ import * as schemas from '.';
  *
  * A request to create a sign request object
  */
-export interface SignRequestCreateRequest {
+export interface SignRequestCreateRequest extends schemas.SignRequestBase {
     /**
-     * If set, the sender receives a `prepare_url` in the response for completed document preparation via UI.
-     * Example: true
+     * List of files to create a signing document from. This is currently
+     * limited to 10 files. Only the ID and type fields are required
+     * for each file. The array will be empty if the `source_files`
+     * are deleted.
      */
-    is_document_preparation_needed?: boolean;
+    source_files?: schemas.FileMini[];
     /**
-     * The URL that a signer will be redirected to
-     * after signing a document. Defining this URL
-     * overrides the default redirect URL for all
-     * signers.
-     * If no declined redirect URL is specified,
-     * this URL will be used for decline actions as well.
-     * Example: https://example.com
+     * Force a specific signature color (blue, black, or red).
+     * Example: blue
      */
-    redirect_url?: string;
+    signature_color?: 'blue' | 'black' | 'red';
     /**
-     * The URL that a signer will be redirected to
-     * after declining to sign a document.
-     * Defining this URL overrides the default
-     * redirect URL for all signers.
-     * Example: https://declined-example.com
-     */
-    declined_redirect_url?: string;
-    /**
-     * Disables the usage of signatures generated by typing (text).
-     * Example: true
-     * @default true
-     */
-    are_text_signatures_enabled?: boolean;
-    /**
-     * Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
-     * Example: Sign Request from Acme
-     */
-    email_subject?: string;
-    /**
-     * Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
-     * Example: Hello! Please sign the document below
-     */
-    email_message?: string;
-    /**
-     * If set, signers receive reminders to sign a document on day 3, 8, 13 and 18. Reminders are only sent to any outstanding signers.
-     * Example: true
-     */
-    are_reminders_enabled?: boolean;
-    /**
-     * Array of signers for the sign request. 35 is the max number of signers permitted.
+     * Array of signers for the sign request. 35 is the
+     * max number of signers permitted.
      */
     signers: schemas.SignRequestCreateSigner[];
-    /**
-     * List of files to create a signing document from. This is currently limited to one file. Only the ID and type fields are required for each file. The array will be empty if the `source_files` are deleted.
-     */
-    source_files: schemas.FileMini[];
-    /**
-     * The destination folder to place final, signed document and signing
-     * log. Only `ID` and `type` fields are required. The root folder,
-     * folder ID `0`, cannot be used.
-     */
-    parent_folder: schemas.FolderMini;
-    /**
-     * When a document contains sign related tags in the content, you can prefill them using this `prefill_tags` by referencing the 'id' of the tag as the `external_id` field of the prefill tag.
-     */
-    prefill_tags?: schemas.SignRequestPrefillTag[];
-    /**
-     * Number of days after which this request will automatically expire if not completed
-     * Example: 2
-     */
-    days_valid?: number;
-    /**
-     * This can be used to reference an ID in an external system that the sign request is related to.
-     * Example: 123
-     */
-    external_id?: string;
-    /**
-     * If set, signers must complete a two factor authentication text message prior to viewing the document. A `verification_phone_number` must be specified for a signer for this setting to apply.
-     * Example: true
-     */
-    is_phone_verification_required_to_view?: boolean;
 }

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

@@ -53,6 +53,14 @@ export interface SignRequestCreateSigner {
      * Example: https://declined-example.com
      */
     declined_redirect_url?: string;
+    /**
+     * If set to true, signer will need to login to a Box account
+     * before signing the request. If the signer does not have
+     * an existing account, they will have an option to create
+     * a free Box account.
+     * Example: true
+     */
+    login_required?: boolean;
     /**
      * If set, this phone number is be used to verify the signer
      * via two factor authentication before they are able to sign the document.

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

@@ -14,7 +14,7 @@ export interface SignRequestSignerInput extends schemas.SignRequestPrefillTag {
      * Content type of input
      * Example: signature
      */
-    content_type?: 'initial' | 'stamp' | 'signature' | 'company' | 'title' | 'email' | 'full_name' | 'first_name' | 'last_name' | 'text' | 'date' | 'checkbox';
+    content_type?: 'initial' | 'stamp' | 'signature' | 'company' | 'title' | 'email' | 'full_name' | 'first_name' | 'last_name' | 'text' | 'date' | 'checkbox' | 'attachment';
     /**
      * Index of page that the input is on
      * Example: 4

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

@@ -4,7 +4,7 @@ import * as schemas from '.';
  *
  * A Sign Request Object
  */
-export interface SignRequest extends schemas.SignRequestCreateRequest {
+export interface SignRequest extends schemas.SignRequestBase {
     /**
      * object type
      * Example: sign-request
@@ -13,7 +13,12 @@ export interface SignRequest extends schemas.SignRequestCreateRequest {
     /**
      * Array of signers for the sign request
      */
-    signers: schemas.SignRequestSigner[];
+    signers?: schemas.SignRequestSigner[];
+    /**
+     * Force a specific color for the signature (blue, black, or red).
+     * Example: blue
+     */
+    signature_color?: string;
     /**
      * Sign request ID
      * Example: 12345
@@ -28,14 +33,14 @@ export interface SignRequest extends schemas.SignRequestCreateRequest {
     prepare_url?: string;
     /**
      * Reference to a file that holds a log of all signer activity for
-     * the request. `Null` if the signing log is deleted.
+     * the request
      */
     signing_log?: schemas.FileMini;
     /**
      * Describes the status of the sign request
      * Example: converting
      */
-    status?: 'converting' | 'created' | 'sent' | 'viewed' | 'signed' | 'cancelled' | 'declined' | 'error_converting' | 'error_sending' | 'expired' | 'downloaded' | 'signed and downloaded';
+    status?: 'converting' | 'created' | 'sent' | 'viewed' | 'signed' | 'cancelled' | 'declined' | 'error_converting' | 'error_sending' | 'expired';
     /**
      * List of files that will be signed, which are copies of the original
      * source files. A new version of these files are created as signers sign
@@ -47,4 +52,8 @@ export interface SignRequest extends schemas.SignRequestCreateRequest {
      * Example: 2021-04-26T08:12:13.982Z
      */
     auto_expire_at?: string;
+    /**
+     * List of files to create a signing document from. Only the ID and type fields are required for each file. The array will be empty if the `source_files` are deleted.
+     */
+    source_files?: schemas.FileMini[];
 }

package/lib/schemas/user-base.generated.d.ts

@@ -0,0 +1,18 @@
+/**
+ * User (Base)
+ *
+ * A mini representation of a user, used when
+ * nested within another resource.
+ */
+export interface UserBase {
+    /**
+     * The unique identifier for this user
+     * Example: 11446498
+     */
+    id?: string;
+    /**
+     * `user`
+     * Example: user
+     */
+    type: 'user';
+}

package/lib/schemas/user-base.generated.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-base.generated.js.map

package/lib/schemas/user-base.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-base.generated.js","sourceRoot":"","sources":["../../src/schemas/user-base.generated.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box <oss@box.com>",
-  "version": "2.8.1",
+  "version": "2.10.0",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {
@@ -48,7 +48,7 @@
     "uuid": "^3.3.3"
   },
   "devDependencies": {
-    "@types/jest": "^28.1.6",
+    "@types/jest": "^27.1.5",
     "@types/jsonwebtoken": "^8.5.1",
     "@types/lodash": "^4.14.172",
     "@types/prettier": "^2.3.2",
@@ -63,7 +63,7 @@
     "eslint": "^6.8.0",
     "eslint-plugin-jest": "^23.20.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-unicorn": "^4.0.3",
     "istanbul": "^0.4.3",
     "jest": "^27.5.1",