@healthcloudai/hc-login-connector 0.1.0 → 0.2.1

package/README.md

@@ -114,7 +114,7 @@ The usage example above reads the value from local state.
 `getBaseUrl()` returns the currently configured base URL from local state.
 
 ```txt
-https://dev-api-healthcheck.healthcloud-services.com/api
+https://dev-api-healthcheck.healthcloud-services.com
 ```
 
 ---
@@ -247,6 +247,10 @@ list expected by the integration.
 - If `verifyEmailCode` is `true`, the client sends `VERIFY_EMAIL_CODE: "true"`.
 - If `verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 
+#### OTP-based registration
+
+Use this when email verification should be handled through an OTP code. In this case, `verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.register(
   "john.smith@example.com",
@@ -268,7 +272,7 @@ await loginClient.register(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -295,6 +299,39 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based registration
+
+Use this when email verification should be handled through an email link. In this case, `verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.register(
+  "john.smith@example.com",
+  "ExamplePassword123!",
+  "John",
+  "Smith"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "TenantID": "test-tenant",
+    "Credentials": {
+      "Email": "john.smith@example.com",
+      "Password": "ExamplePassword123!"
+    },
+    "User": {
+      "FirstName": "John",
+      "LastName": "Smith",
+      "Email": "john.smith@example.com",
+      "Attributes": {}
+    }
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -332,6 +369,10 @@ Registers a patient for the configured tenant using the richer registration payl
 `verifyEmailCode` behaves the same way as in `register(...)`:
 when enabled, the client injects `VERIFY_EMAIL_CODE: "true"` into `User.Attributes`.
 
+#### OTP-based registration
+
+Use this when email verification should be handled through an OTP code. In this case, `verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.registerFull({
   email: "john.smith@example.com",
@@ -406,6 +447,40 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based registration
+
+Use this when email verification should be handled through an email link. In this case, `verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.registerFull({
+  email: "john.smith@example.com",
+  password: "ExamplePassword123!",
+  firstName: "John",
+  lastName: "Smith"
+});
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "TenantID": "test-tenant",
+    "Credentials": {
+      "Email": "john.smith@example.com",
+      "Password": "ExamplePassword123!",
+      "TenantID": "test-tenant"
+    },
+    "User": {
+      "FirstName": "John",
+      "LastName": "Smith",
+      "Email": "john.smith@example.com",
+      "Attributes": {}
+    }
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -440,6 +515,10 @@ when email verification should be handled through an OTP code, the client sends
 - If `options.verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 - Calling `verifyEmail(...)` without `options` keeps OTP email verification disabled by default.
 
+#### OTP-based email verification
+
+Use this when email verification should be handled through an OTP code. In this case, `options.verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.verifyEmail(
   "john.smith@example.com",
@@ -452,7 +531,7 @@ await loginClient.verifyEmail(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -471,6 +550,34 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based email verification
+
+Use this when email verification should be handled through an email link. In this case, `options.verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.verifyEmail(
+  "john.smith@example.com",
+  "123456",
+  "en"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "Data": "123456",
+    "Step": "EMAIL_VERIFY",
+    "User": {
+      "Email": "john.smith@example.com",
+      "TenantID": "test-tenant"
+    },
+    "Language": "en"
+  }
+}
+```
+
 #### API response
 
 Status:
@@ -505,6 +612,10 @@ when email verification should be handled through an OTP code, the client sends
 - If `options.verifyEmailCode` is `false` or omitted, `VERIFY_EMAIL_CODE` is not sent.
 - Calling `resendEmailVerify(...)` without `options` keeps OTP email verification disabled by default.
 
+#### OTP-based resend
+
+Use this when email verification should be handled through an OTP code. In this case, `options.verifyEmailCode` should be `true`.
+
 ```ts
 await loginClient.resendEmailVerify(
   "john.smith@example.com",
@@ -516,7 +627,7 @@ await loginClient.resendEmailVerify(
 ```
 
 #### Full API request
-Request sent for the usage example above:
+Request sent for the OTP example above:
 
 ```json
 {
@@ -535,6 +646,33 @@ Request sent for the usage example above:
 }
 ```
 
+#### Link-based resend
+
+Use this when email verification should be handled through an email link. In this case, `options.verifyEmailCode` should be omitted or `false`.
+
+```ts
+await loginClient.resendEmailVerify(
+  "john.smith@example.com",
+  "en"
+);
+```
+
+Effective request body:
+
+```json
+{
+  "Data": {
+    "Data": "",
+    "Step": "RESEND_EMAIL_VERIFY",
+    "User": {
+      "Email": "john.smith@example.com",
+      "TenantID": "test-tenant"
+    },
+    "Language": "en"
+  }
+}
+```
+
 #### API response
 
 Status: