docusign / docusign-esign-node-client

The Official DocuSign Node.js Client Library used to interact with the eSign REST API. Send, sign, and approve documents using this client.
http://docusign.github.io/docusign-esign-node-client
MIT License
146 stars 100 forks source link

phoneNumber for Signer parameter is not in @types package #318

Open peiofour opened 1 year ago

peiofour commented 1 year ago

Hello DocuSign,

I work on a project using the docusign-esign 5.20.0 npm package and its types package 5.19.0. Using the Signer class, I noticed that my linter doesn't accept the phoneNumber parameter. I checked on the types docusign-esign package, it is not in the Signer interface.

image

Is the types package not updated or is the parameter deprecated?

Thanks in advance!

InbarGazit commented 1 year ago

This is the old way to do this, this has moved under workflow. See full code in https://github.com/docusign/code-examples-node/blob/master/lib/eSignature/examples/phoneAuthentication.js


  let signer1 = docusign.Signer.constructFromObject({
    email: args.signerEmail,
    name: args.signerName,
    recipientId: RecipientId,
    routingOrder: "1",
    deliveryMethod: "Email",
    tabs: signer1Tabs,
    identityVerification: { workflowId: args.workflowId, steps: null, "inputOptions":[{"name":"phone_number_list","valueType":"PhoneNumberList","phoneNumberList":[{"countryCode":args.countryCode,"code":"1","number":args.phoneNumber}]}], "idCheckConfigurationName":""}
  });
peiofour commented 1 year ago

So the doc needs to be updated: https://developers.docusign.com/docs/esign-rest-api/how-to/request-signature-sms/

acooper4960 commented 1 year ago

@peiofour for the most up-to-date reference for this SDK, please refer to http://docusign.github.io/docusign-esign-node-client. These get automatically updated during our release process and will be the most consistent reference to the SDK

InbarGazit commented 1 year ago

@peiofour I'm confused, is this about SMS delivery or SMS authentication? these are two different things.

peiofour commented 1 year ago

@InbarGazit It's for SMS delivery (https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/sms-delivery/)

InbarGazit commented 1 year ago

OK, thanks, do you still have an issue? or can I close this out?

peiofour commented 1 year ago

Yes ! The issue didn't change, tslint does'nt accept phoneNumber parameter as we can see here : https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/sms-delivery/

image

Olexandr-Liaguta commented 2 months ago

And there is no additionalNotifications field for the Signer type

Screenshot 2024-09-04 at 13 56 57 Screenshot 2024-09-04 at 13 57 26