box-node-sdk 2.5.0 → 2.7.0

package/lib/schemas/collaboration.d.ts

@@ -0,0 +1,108 @@
+import { UserMini } from "./user-mini";
+export declare type CollaborationRole = "editor" | "viewer" | "previewer" | "uploader" | "previewer uploader" | "viewer uploader" | "co-owner" | "owner";
+export declare type CollaborationStatus = "accepted" | "pending" | "rejected";
+declare type StrongPasswordRequirement = {
+    /**
+     * Whether the enterprise that owns the content requires a strong password to collaborate on the content.
+     */
+    enterprise_has_strong_password_required_for_external_users?: boolean;
+    /**
+     * Whether or not the user has a strong password set for their account. The field is null when a strong password is not required.
+     */
+    user_has_strong_password?: boolean | null;
+};
+declare type TermsOfServiceRequirement = {
+    /**
+     * Whether or not the terms of service have been accepted. The field is null when there is no terms of service required.
+     */
+    is_accepted: boolean | null;
+    /**
+     * The terms of service that must be accepted before the collaboration can be accepted. The field is null when there is no terms of service required.
+     */
+    terms_of_service: {
+        /**
+         * The unique identifier for this terms of service.
+         */
+        id: string;
+        type: 'terms_of_service';
+    } | null;
+};
+declare type TwoFactorAuthenticationRequirement = {
+    /**
+     * Whether or not the enterprise that owns the content requires two-factor authentication to be enabled in order to collaborate on the content.
+     */
+    enterprise_has_two_factor_auth_enabled: boolean;
+    /**
+     * Whether or not the user has two-factor authentication enabled. The field is null when two-factor authentication is not required.
+     */
+    user_has_two_factor_authentication_enabled: boolean | null;
+};
+declare type AcceptanceRequirementsStatus = {
+    strong_password_requirement?: StrongPasswordRequirement;
+    terms_of_service_requirement?: TermsOfServiceRequirement;
+    two_factor_authentication_requirement?: TwoFactorAuthenticationRequirement;
+};
+export interface Collaboration {
+    /**
+     * The unique identifier for this collaboration.
+     */
+    id: string;
+    /**
+     * Value is always collaboration
+     */
+    type: 'collaboration';
+    /**
+     * Describes acceptance criteria for password, terms of service and two-factor authentication
+     */
+    acceptance_requirements_status?: AcceptanceRequirementsStatus;
+    /**
+     * The user or group that is granted access
+     */
+    accessible_by?: UserMini;
+    /**
+     * When the status of the collaboration object changed to accepted or rejected
+     */
+    acknowledged_at?: string;
+    /**
+     * When the collaboration object was created
+     */
+    created_at?: string;
+    /**
+     * The user who created the collaboration object
+     */
+    created_by?: UserMini;
+    /**
+     * When the collaboration will expire, or null if no expiration date is set.
+     */
+    expires_at?: string;
+    /**
+     * The email address used to invite an unregistered collaborator, if they are not a registered user.
+     */
+    invite_email?: string;
+    /**
+     * The file or folder to which access is granted. The field is null when the collaboration status is pending.
+     */
+    item?: any;
+    /**
+     * When the collaboration object was last modified
+     */
+    modified_at?: string;
+    /**
+     * The level of access granted.
+     */
+    role?: CollaborationRole;
+    /**
+     * The status of the collaboration invitation.
+     */
+    status?: CollaborationStatus;
+    /**
+     * WARN: Feature not yet available.
+     * Do not display collaborated items on collaborator's All Files Pages and suppress notifications
+     * sent to collaborators regarding access-only content.
+     * This feature is going to be released in Q4. Watch our [announcements](https://developer.box.com/changelog/)
+     * to learn about its availability.
+     */
+    is_access_only?: boolean;
+    [key: string]: any;
+}
+export {};

package/lib/schemas/collaboration.js

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

package/lib/schemas/collaboration.js.map

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

package/lib/schemas/collaborations.d.ts

@@ -0,0 +1,13 @@
+import { Collaboration } from "./collaboration";
+declare type CollaborationsOrder = {
+    by: string;
+    direction: 'ASC' | 'DESC';
+};
+export interface Collaborations {
+    entries: Collaboration[];
+    limit: number;
+    offset: number;
+    order: CollaborationsOrder;
+    total_count: number;
+}
+export {};

package/lib/schemas/collaborations.js

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

package/lib/schemas/collaborations.js.map

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

package/lib/schemas/file-mini.generated.d.ts

@@ -22,7 +22,7 @@ export interface FileMini extends schemas.FileBase {
      * fetched resource.
      * Example: 3
      */
-    sequence_id?: string;
+    sequence_id: string;
     /**
      * The name of the file
      * Example: Contract.pdf
@@ -33,7 +33,7 @@ export interface FileMini extends schemas.FileBase {
      * of a file on Box with a local file.
      * Example: 85136C79CBF9FE36BB9D05D0639C70C265C18D37
      */
-    sha1?: string;
+    sha1: string;
     /**
      * The information about the current version of the file.
      */

package/lib/schemas/file-version-base.generated.d.ts

@@ -10,10 +10,10 @@ export interface FileVersionBase {
      * The unique identifier that represent a file version.
      * Example: 12345
      */
-    id?: string;
+    id: string;
     /**
      * `file_version`
      * Example: file_version
      */
-    type?: 'file_version';
+    type: 'file_version';
 }

package/lib/schemas/index.d.ts

@@ -13,3 +13,7 @@ export * from './sign-request.generated';
 export * from './sign-requests.generated';
 export * from './file-request';
 export * from './user-mini';
+export * from './collaboration';
+export * from './collaborations';
+export * from './collaboration-create';
+export * from './collaboration-update';

package/lib/schemas/index.js

@@ -25,4 +25,8 @@ __exportStar(require("./sign-request.generated"), exports);
 __exportStar(require("./sign-requests.generated"), exports);
 __exportStar(require("./file-request"), exports);
 __exportStar(require("./user-mini"), exports);
+__exportStar(require("./collaboration"), exports);
+__exportStar(require("./collaborations"), exports);
+__exportStar(require("./collaboration-create"), exports);
+__exportStar(require("./collaboration-update"), exports);
 //# sourceMappingURL=index.js.map

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"}
+{"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"}

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

@@ -6,12 +6,30 @@ import * as schemas from '.';
  */
 export interface SignRequestCreateRequest {
     /**
-     * Indicates if the sender should receive a `prepare_url` in the response to complete document preparation via UI.
+     * If set, the sender receives a `prepare_url` in the response for completed document preparation via UI.
      * Example: true
      */
     is_document_preparation_needed?: boolean;
     /**
-     * Disables the usage of signatures generated by typing (text)
+     * 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
+     */
+    redirect_url?: string;
+    /**
+     * 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
      */
@@ -27,7 +45,7 @@ export interface SignRequestCreateRequest {
      */
     email_message?: string;
     /**
-     * Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.
+     * 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;
@@ -36,7 +54,7 @@ export interface SignRequestCreateRequest {
      */
     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.
+     * 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[];
     /**
@@ -59,4 +77,9 @@ export interface SignRequestCreateRequest {
      * 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

@@ -20,7 +20,7 @@ export interface SignRequestCreateSigner {
     role?: 'signer' | 'approver' | 'final_copy_reader';
     /**
      * Used in combination with an embed URL for a sender. After the
-     * sender signs, they will be redirected to the next `in_person` signer.
+     * sender signs, they are redirected to the next `in_person` signer.
      * Example: true
      */
     is_in_person?: boolean;
@@ -35,4 +35,34 @@ export interface SignRequestCreateSigner {
      * Example: 1234
      */
     embed_url_external_user_id?: string;
+    /**
+     * The URL that a signer will be redirected
+     * to after signing a document. Defining this URL
+     * overrides default or global redirect URL
+     * settings for a specific signer.
+     * If no declined redirect URL is specified,
+     * this URL will be used for decline actions as well.
+     * Example: https://example.com
+     */
+    redirect_url?: string;
+    /**
+     * The URL that a signer will be redirect
+     * to after declining to sign a document.
+     * Defining this URL overrides default or global
+     * declined redirect URL settings for a specific signer.
+     * Example: https://declined-example.com
+     */
+    declined_redirect_url?: string;
+    /**
+     * If set, this phone number is be used to verify the signer
+     * via two factor authentication before they are able to sign the document.
+     * Example: 6314578901
+     */
+    verification_phone_number?: string;
+    /**
+     * If set, the signer is required to enter the password before they are able
+     * to sign a document. This field is write only.
+     * Example: SecretPassword123
+     */
+    password?: string;
 }

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

@@ -9,7 +9,7 @@ export interface SignRequestPrefillTag {
      * This references the ID of a specific tag contained in a file of the sign request.
      * Example: 1234
      */
-    document_tag_id: string;
+    document_tag_id?: string;
     /**
      * Text prefill value
      * Example: text

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

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

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

@@ -18,7 +18,7 @@ export interface SignRequest extends schemas.SignRequestCreateRequest {
      * Sign request ID
      * Example: 12345
      */
-    id: string;
+    id?: string;
     /**
      * This URL is returned if `is_document_preparation_needed` is
      * set to `true` in the request. It is used to prepare the sign request
@@ -28,14 +28,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
+     * the request. `Null` if the signing log is deleted.
      */
     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';
+    status?: 'converting' | 'created' | 'sent' | 'viewed' | 'signed' | 'cancelled' | 'declined' | 'error_converting' | 'error_sending' | 'expired' | 'downloaded' | 'signed and downloaded';
     /**
      * 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

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

@@ -1,6 +1,6 @@
 import * as schemas from '.';
 /**
- * Box Sign
+ * Sign Requests
  *
  * The part of an API response that describes marker
  * based pagination

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "box-node-sdk",
   "author": "Box <oss@box.com>",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "description": "Official SDK for Box Plaform APIs",
   "license": "Apache-2.0",
   "repository": {
@@ -23,7 +23,7 @@
   "main": "./lib/box-node-sdk.js",
   "scripts": {
     "test": "node Makefile.js",
-    "jest": "jest",
+    "jest": "npm run build && jest",
     "build": "node Makefile.js build",
     "codegen": "ts-node codegen/codegen.tsx",
     "lint": "node Makefile.js lint",
@@ -48,7 +48,7 @@
     "uuid": "^3.3.3"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.2",
+    "@types/jest": "^28.1.6",
     "@types/jsonwebtoken": "^8.5.1",
     "@types/lodash": "^4.14.172",
     "@types/prettier": "^2.3.2",
@@ -61,6 +61,7 @@
     "chai": "^4.2.0",
     "doctoc": "^2.0.1",
     "eslint": "^4.19.1",
+    "eslint-plugin-jest": "^23.20.0",
     "eslint-plugin-node": "^6.0.1",
     "eslint-plugin-promise": "^3.8.0",
     "eslint-plugin-unicorn": "^4.0.3",