@verdocs/js-sdk 3.0.11 → 3.0.14

package/Envelopes/Recipients.d.ts

@@ -1,14 +1,61 @@
-import { IInPersonAccessKey, TRecipientAction } from './Types';
+import { IEnvelope, IRecipient, IInPersonAccessKey } from './Types';
 import { VerdocsEndpoint } from '../VerdocsEndpoint';
-import { IEnvelope, IRecipient } from './Types';
-export interface IUpdateRecipientParams {
+export interface IUpdateRecipientSubmitParams {
+    action: 'submit';
+}
+export interface IUpdateRecipientDeclineParams {
+    action: 'decline';
+}
+export interface IUpdateRecipientClaimEnvelope {
+    action: 'owner_update';
+    full_name: string;
+    email: string;
+}
+export interface IUpdateRecipientStatus {
     new_full_name?: string;
     agreed?: boolean;
+    action?: 'prepare' | 'update';
+}
+export interface IUpdateRecipientAgreedParams {
+    action: 'update';
+    agreed: boolean;
+}
+export interface IUpdateRecipientNameParams {
+    action: 'update';
+    new_full_name: string;
+}
+export interface IUpdateRecipientPrepareParams {
+    action: 'prepare';
+    recipients: IRecipient[];
 }
 /**
  * Update a recipient's status block
  */
-export declare const updateRecipientStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, action: TRecipientAction, params?: IUpdateRecipientParams) => Promise<IRecipient>;
+export declare const updateRecipient: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, params: IUpdateRecipientSubmitParams | IUpdateRecipientClaimEnvelope | IUpdateRecipientAgreedParams | IUpdateRecipientNameParams | IUpdateRecipientDeclineParams | IUpdateRecipientPrepareParams) => Promise<IRecipient>;
+/**
+ * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
+ */
+export declare const envelopeRecipientSubmit: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
+/**
+ * Decline to complete an envelope (signing will not terminated).
+ */
+export declare const envelopeRecipientDecline: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipient>;
+/**
+ * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
+ */
+export declare const envelopeRecipientChangeOwner: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, email: string, fullName: string) => Promise<IRecipient>;
+/**
+ * Agree to electronic signing.
+ */
+export declare const envelopeRecipientAgree: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, agreed: boolean) => Promise<IRecipient>;
+/**
+ * Change a recipient's name.
+ */
+export declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, fullName: string) => Promise<IRecipient>;
+/**
+ * Change a recipient's name.
+ */
+export declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
 export interface ISignerTokenResponse {
     recipient: IRecipient;
     envelope: IEnvelope;

package/Envelopes/Recipients.js

@@ -1,14 +1,3 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -48,13 +37,47 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 /**
  * Update a recipient's status block
  */
-export var updateRecipientStatus = function (endpoint, envelopeId, roleName, action, params) { return __awaiter(void 0, void 0, void 0, function () {
+export var updateRecipient = function (endpoint, envelopeId, roleName, params) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, endpoint.api //
-                .put("/envelopes/".concat(envelopeId, "/recipients/").concat(roleName), __assign({ role_name: roleName, action: action }, (params || {})))
+                .put("/envelopes/".concat(envelopeId, "/recipients/").concat(roleName), params)
                 .then(function (r) { return r.data; })];
     });
 }); };
+/**
+ * Submit an envelope (signing is finished). Note that all fields must be valid/completed for this to succeed.
+ */
+export var envelopeRecipientSubmit = function (endpoint, envelopeId, roleName) {
+    return updateRecipient(endpoint, envelopeId, roleName, { action: 'submit' });
+};
+/**
+ * Decline to complete an envelope (signing will not terminated).
+ */
+export var envelopeRecipientDecline = function (endpoint, envelopeId, roleName) {
+    return updateRecipient(endpoint, envelopeId, roleName, { action: 'decline' });
+};
+/**
+ * Claim / change ownership of an envelope. This is a special-case operation only available in certain workflows.
+ */
+export var envelopeRecipientChangeOwner = function (endpoint, envelopeId, roleName, email, fullName) { return updateRecipient(endpoint, envelopeId, roleName, { action: 'owner_update', email: email, full_name: fullName }); };
+/**
+ * Agree to electronic signing.
+ */
+export var envelopeRecipientAgree = function (endpoint, envelopeId, roleName, agreed) {
+    return updateRecipient(endpoint, envelopeId, roleName, { action: 'update', agreed: agreed });
+};
+/**
+ * Change a recipient's name.
+ */
+export var envelopeRecipientUpdateName = function (endpoint, envelopeId, roleName, fullName) {
+    return updateRecipient(endpoint, envelopeId, roleName, { action: 'update', new_full_name: fullName });
+};
+/**
+ * Change a recipient's name.
+ */
+export var envelopeRecipientPrepare = function (endpoint, envelopeId, roleName, recipients) {
+    return updateRecipient(endpoint, envelopeId, roleName, { action: 'prepare', recipients: recipients });
+};
 export var getSignerToken = function (endpoint, envelopeId, roleName) {
     return endpoint.api //
         .get("/envelopes/".concat(envelopeId, "/recipients/").concat(encodeURIComponent(roleName), "/signer-token"))

package/Envelopes/Types.d.ts

@@ -54,6 +54,8 @@ export interface IEnvelopesSearchResultEntry {
     recipients: IRecipient[];
     reminder_id: string | null;
     status: TEnvelopeStatus;
+    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
+    visibility: 'private' | 'shared';
     next_recipient: {
         claimed: boolean;
         email: string;
@@ -208,6 +210,8 @@ export interface IEnvelope {
     /** @deprecated. New envelopes will support more than one document attachment so new code should no longer refer to this field. */
     envelope_document_id: string;
     certificate_document_id: string | null;
+    /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
+    visibility: 'private' | 'shared';
     histories: IHistory[];
     recipients: IRecipient[];
     profile?: IProfile | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "3.0.11",
+  "version": "3.0.14",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -39,7 +39,8 @@
     "docs": "npm run docs-md && npm run docs-html",
     "clear-docs": "aws --profile=verdocs cloudfront create-invalidation --distribution-id E29UFGU4KEH1GQ --paths \"/*\"",
     "deploy-docs": "npm run docs && aws --profile=verdocs s3 sync --acl public-read --delete docs-html s3://verdocs-developers-js-sdk/ && yarn clear-docs",
-    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts VerdocsEndpoint.* docs docs-html"
+    "clean": "rm -rf Documents HTTP Organizations Search Templates Users Utils index.js index.d.ts VerdocsEndpoint.* docs docs-html",
+    "push": "npm run build && npm publish"
   },
   "publishConfig": {
     "access": "public"