@unumid/server-sdk - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

package.json

		{
		"name": "@unumid/server-sdk",
		"version": "1.3.1",
		"version": "1.3.2",
		"main": "build/index.js",
		@@ -5,0 +5,0 @@ "repository": "git@github.com:UnumID/Server-SDK-TypeScript.git",

README.md

		@@ -258,7 +258,11 @@ This SDK combines the functionality of an [Issuer](#issuer) and [Verifier](#verifier) entities to work with UnumID's SaaS. For necessary account creation and API keys please email admin@unum.id.
		### sendSms
		Use to send a deep link to a user by SMS. The message will be delivered from an UnumID associated phone number. You can of course use your own SMS sending service if you prefer.
		Use to send a deep link to a user by SMS. A templated message will be delivered from an UnumID associated phone number. You can of course use your own SMS sending service if you prefer.

		To request (a presentation of) credentials from a user, you first create the request object and receive a deep link that references it. The user need to receive this deep link, which will open the correct app on their phone and prompt them to share the credentials. SMS is one convenient channel.

		The SMS message will be in the format:
		- Verification Request: [verifier_name]. Click here to complete: [deep_link]

		Note: The verifier is corresponding to the presentation request from which the deeplink references. Because you are the acting verifier, the name will be what ever you provided during [verifier registration](#registerVerifier).

		Parameters
		@@ -268,3 +272,3 @@ ```typescript
		"to": string, // phone number to send SMS to
		"msg": string // message to send
		"deeplink": string // the deeplink corresponding to the presentation request you would like served to the user
		}
		@@ -279,8 +283,11 @@ ```
		### sendEmail
		Use to send a deep link to a user by email. The message will be delivered from no-reply@unum.id. You can of course use your own email sending service if you prefer.
		Use to send a deep link to a user by email. A templated message will be delivered from no-reply@unum.id. You can of course use your own email sending service if you prefer.

		To request (a presentation of) credentials from a user, you first create the request object and receive a deep link that references it. The user need to receive this deep link, which will open the correct app on their phone and prompt them to share the credentials. Email is one convenient channel, though keep in mind that the user will need to click the link from their phone for the deep link to work.

		The email will be in the format:
		- subject: Verification Request: [verifier_name]
		- body: Click here to complete: [deep_link]

		Tip: JSON special characters such a double quote or backslash in the `subject` or `htmlBody` fields will need to be escaped with a single backslash (\\), i.e. "the best org in the country" must be \\"the best org in the country\\".
		Note: The verifier is corresponding to the presentation request from which the deeplink references. Because you are the acting verifier, the name will be what ever you provided during [verifier registration](#registerVerifier).

		@@ -291,7 +298,3 @@ Parameters
		"to": string, // email address to send email to
		"from": string, // from email address
		"replyTo": string, // replyTo email address
		"subject": string, // email subject
		"textBody"?: string, // (optional) email message body (cannot be used with htmlBody)
		"htmlBody"?: string, // (optional) email html message body (cannot be used with textBody)
		"deeplink": string // the deeplink corresponding to the presentation request you would like served to the user
		}
		@@ -298,0 +301,0 @@ ```

.github/workflows/publish.yaml