box-node-sdk 2.9.0 → 2.10.0

package/lib/schemas/index.js

@@ -10,19 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./file-base.generated"), exports);
-__exportStar(require("./file-mini.generated"), exports);
-__exportStar(require("./file-version-base.generated"), exports);
-__exportStar(require("./file-version-mini.generated"), exports);
-__exportStar(require("./folder-base.generated"), exports);
-__exportStar(require("./folder-mini.generated"), exports);
-__exportStar(require("./sign-request-create-request.generated"), exports);
-__exportStar(require("./sign-request-create-signer.generated"), exports);
-__exportStar(require("./sign-request-prefill-tag.generated"), exports);
-__exportStar(require("./sign-request-signer-input.generated"), exports);
-__exportStar(require("./sign-request-signer.generated"), exports);
-__exportStar(require("./sign-request.generated"), exports);
-__exportStar(require("./sign-requests.generated"), exports);
+__exportStar(require("./index.generated"), exports);
 __exportStar(require("./file-request"), exports);
 __exportStar(require("./user-mini"), exports);
 __exportStar(require("./collaboration"), exports);

package/lib/schemas/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAsC;AACtC,wDAAsC;AACtC,gEAA8C;AAC9C,gEAA8C;AAC9C,0DAAwC;AACxC,0DAAwC;AACxC,0EAAwD;AACxD,yEAAuD;AACvD,uEAAqD;AACrD,wEAAsD;AACtD,kEAAgD;AAChD,2DAAyC;AACzC,4DAA0C;AAC1C,iDAA+B;AAC/B,8CAA4B;AAC5B,kDAAgC;AAChC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schemas/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAkC;AAClC,iDAA+B;AAC/B,8CAA4B;AAC5B,kDAAgC;AAChC,mDAAiC;AACjC,yDAAuC;AACvC,yDAAuC"}

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

@@ -0,0 +1,18 @@
+/**
+ * Shield information barrier (Base)
+ *
+ * A base representation of a
+ * shield information barrier object
+ */
+export interface ShieldInformationBarrierBase {
+    /**
+     * 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';
+}

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

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

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

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

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

@@ -0,0 +1,9 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier reference
+ *
+ * A shield information barrier reference for requests and responses
+ */
+export interface ShieldInformationBarrierReference {
+    shield_information_barrier?: schemas.ShieldInformationBarrierBase;
+}

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

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

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

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

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

@@ -0,0 +1,18 @@
+/**
+ * Shield information barrier report (Base)
+ *
+ * A base representation of a
+ * shield information barrier report object
+ */
+export interface ShieldInformationBarrierReportBase {
+    /**
+     * The unique identifier for the shield information barrier report
+     * Example: 11446498
+     */
+    id?: string;
+    /**
+     * The type of the shield information barrier report
+     * Example: shield_information_barrier_report
+     */
+    type?: 'shield_information_barrier_report';
+}

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

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Shield information barrier report details
+ *
+ * Indicates which folder the report
+ * file is located and any errors when generating the report.
+ */
+export interface ShieldInformationBarrierReportDetails {
+    details?: object;
+}

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

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

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

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

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

@@ -0,0 +1,32 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier report
+ *
+ * A standard representation
+ * of a shield information barrier report object
+ */
+export interface ShieldInformationBarrierReport extends schemas.ShieldInformationBarrierReportBase {
+    shield_information_barrier?: schemas.ShieldInformationBarrierReference;
+    /**
+     * Status of the shield information report
+     * Example: pending
+     */
+    status?: 'pending' | 'error' | 'done' | 'cancelled';
+    details?: schemas.ShieldInformationBarrierReportDetails;
+    /**
+     * ISO date time string when this
+     * shield information barrier report object was created.
+     * Example: 2020-06-26T18:44:45.869Z
+     */
+    created_at?: string;
+    /**
+     * The user who created this shield information barrier report.
+     */
+    created_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this
+     * shield information barrier report was updated.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    updated_at?: string;
+}

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

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

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

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

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

@@ -0,0 +1,19 @@
+/**
+ * Shield information barrier segment member (Base)
+ *
+ * A base representation of a
+ * shield information barrier segment member object
+ */
+export interface ShieldInformationBarrierSegmentMemberBase {
+    /**
+     * The unique identifier for the
+     * shield information barrier segment member
+     * Example: 11446498
+     */
+    id?: string;
+    /**
+     * The type of the shield information barrier segment member
+     * Example: shield_information_barrier_segment_member
+     */
+    type?: 'shield_information_barrier_segment_member';
+}

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

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

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

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

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

@@ -0,0 +1,13 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier segment member (Mini)
+ *
+ * A mini representation of a
+ * shield information barrier segment member object
+ */
+export interface ShieldInformationBarrierSegmentMemberMini extends schemas.ShieldInformationBarrierSegmentMemberBase {
+    /**
+     * The `type` and `id` of the requested shield information barrier segment member.
+     */
+    user?: schemas.UserBase;
+}

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

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

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

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

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

@@ -0,0 +1,39 @@
+import * as schemas from '.';
+/**
+ * Shield information barrier segment member
+ *
+ * A standard representation of a
+ * shield information barrier segment member object
+ */
+export interface ShieldInformationBarrierSegmentMember extends schemas.ShieldInformationBarrierSegmentMemberMini {
+    shield_information_barrier?: schemas.ShieldInformationBarrierBase;
+    /**
+     * The `type` and `id` of the requested
+     * shield information barrier segment.
+     */
+    shield_information_barrier_segment?: object;
+    /**
+     * The `type` and `id` of the requested shield information barrier segment member.
+     */
+    user?: schemas.UserBase;
+    /**
+     * 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 member.
+     */
+    created_by?: schemas.UserBase;
+    /**
+     * ISO date time string when this
+     * shield information barrier segment Member was updated.
+     * Example: 2020-07-26T18:44:45.869Z
+     */
+    updated_at?: string;
+    /**
+     * The user that updated this shield information barrier segment Member.
+     */
+    updated_by?: schemas.UserBase;
+}

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

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

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

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

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

@@ -0,0 +1,20 @@
+/**
+ * Shield information barrier segment restriction (Base)
+ *
+ * A base representation of
+ * a segment restriction object for
+ * the shield information barrier
+ */
+export interface ShieldInformationBarrierSegmentRestrictionBase {
+    /**
+     * Shield information barrier segment restriction
+     * Example: shield_information_barrier_segment_restriction
+     */
+    type?: 'shield_information_barrier_segment_restriction';
+    /**
+     * The unique identifier for the
+     * shield information barrier segment restriction.
+     * Example: 11446498
+     */
+    id?: string;
+}

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

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

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

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

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":""}