@verdocs/js-sdk 5.2.2 → 5.2.3

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.
package/dist/index.d.mts CHANGED
@@ -1387,6 +1387,7 @@ interface ICreateEnvelopeFromTemplateRequest {
1387
1387
  name?: string;
1388
1388
  description?: string;
1389
1389
  fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
1390
+ /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
1390
1391
  environment?: string;
1391
1392
  /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
1392
1393
  no_contact?: boolean;
@@ -1405,7 +1406,11 @@ interface ICreateEnvelopeDirectlyRequest {
1405
1406
  visiblity?: "private" | "shared";
1406
1407
  recipients: ICreateEnvelopeRecipient[];
1407
1408
  documents: IEnvelopeDocument[];
1408
- fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
1409
+ /** Fields to create in the envelope. Note that document_id is a number in this call and should match the index of the document in the documents array. */
1410
+ fields: (Pick<IEnvelopeField, "name" | "role_name" | "type" | "page" | "x" | "y"> & Partial<Pick<IEnvelopeField, "default" | "placeholder" | "multiline" | "group" | "options" | "required" | "readonly" | "label" | "page" | "width" | "height">> & {
1411
+ document_id: number;
1412
+ })[];
1413
+ /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
1409
1414
  environment?: string;
1410
1415
  /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
1411
1416
  no_contact?: boolean;
package/dist/index.d.ts CHANGED
@@ -1387,6 +1387,7 @@ interface ICreateEnvelopeFromTemplateRequest {
1387
1387
  name?: string;
1388
1388
  description?: string;
1389
1389
  fields?: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
1390
+ /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
1390
1391
  environment?: string;
1391
1392
  /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
1392
1393
  no_contact?: boolean;
@@ -1405,7 +1406,11 @@ interface ICreateEnvelopeDirectlyRequest {
1405
1406
  visiblity?: "private" | "shared";
1406
1407
  recipients: ICreateEnvelopeRecipient[];
1407
1408
  documents: IEnvelopeDocument[];
1408
- fields: Pick<IEnvelopeField, "name" | "role_name" | "default">[];
1409
+ /** Fields to create in the envelope. Note that document_id is a number in this call and should match the index of the document in the documents array. */
1410
+ fields: (Pick<IEnvelopeField, "name" | "role_name" | "type" | "page" | "x" | "y"> & Partial<Pick<IEnvelopeField, "default" | "placeholder" | "multiline" | "group" | "options" | "required" | "readonly" | "label" | "page" | "width" | "height">> & {
1411
+ document_id: number;
1412
+ })[];
1413
+ /** Environment in which to execute the envelope. Do not set this unless instructed to do so by Verdocs support. */
1409
1414
  environment?: string;
1410
1415
  /** If set, Verdocs will not attempt to contact the recipient via email or SMS. */
1411
1416
  no_contact?: boolean;