crisp-api 9.10.0 → 9.12.0
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/CHANGELOG.md +12 -0
- package/EXAMPLES.md +25 -0
- package/README.md +33 -0
- package/lib/resources/WebsiteConversation.js +51 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
Changelog
|
|
2
2
|
=========
|
|
3
3
|
|
|
4
|
+
## v9.12.0
|
|
5
|
+
|
|
6
|
+
### New Features
|
|
7
|
+
|
|
8
|
+
* Added the new `CrispClient.website.redeemIdentityVerificationLinkForConversation` method.
|
|
9
|
+
|
|
10
|
+
## v9.11.0
|
|
11
|
+
|
|
12
|
+
### New Features
|
|
13
|
+
|
|
14
|
+
* Added the new `CrispClient.website.requestIdentityVerificationForConversation` method.
|
|
15
|
+
|
|
4
16
|
## v9.10.0
|
|
5
17
|
|
|
6
18
|
### New Features
|
package/EXAMPLES.md
CHANGED
|
@@ -441,6 +441,31 @@ CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, veri
|
|
|
441
441
|
|
|
442
442
|
=========================
|
|
443
443
|
|
|
444
|
+
https://docs.crisp.chat/references/rest-api/v1/#request-identity-verification-for-conversation
|
|
445
|
+
|
|
446
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
447
|
+
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
|
|
448
|
+
|
|
449
|
+
var verification = {
|
|
450
|
+
"identity": "email"
|
|
451
|
+
};
|
|
452
|
+
|
|
453
|
+
CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification);
|
|
454
|
+
|
|
455
|
+
=========================
|
|
456
|
+
|
|
457
|
+
https://docs.crisp.chat/references/rest-api/v1/#redeem-identity-verification-link-for-conversation
|
|
458
|
+
|
|
459
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
460
|
+
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
|
|
461
|
+
|
|
462
|
+
var identity = "email";
|
|
463
|
+
var token = "709691";
|
|
464
|
+
|
|
465
|
+
CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, identity, token);
|
|
466
|
+
|
|
467
|
+
=========================
|
|
468
|
+
|
|
444
469
|
https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation
|
|
445
470
|
|
|
446
471
|
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
package/README.md
CHANGED
|
@@ -772,6 +772,39 @@ All methods that you will most likely need when building a Crisp integration are
|
|
|
772
772
|
```
|
|
773
773
|
</details>
|
|
774
774
|
|
|
775
|
+
* **Request Identity Verification For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-identity-verification-for-conversation)
|
|
776
|
+
* `CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification)`
|
|
777
|
+
* <details>
|
|
778
|
+
<summary>See Example</summary>
|
|
779
|
+
|
|
780
|
+
```javascript
|
|
781
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
782
|
+
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
|
|
783
|
+
|
|
784
|
+
var verification = {
|
|
785
|
+
"identity": "email"
|
|
786
|
+
};
|
|
787
|
+
|
|
788
|
+
CrispClient.website.requestIdentityVerificationForConversation(websiteID, sessionID, verification);
|
|
789
|
+
```
|
|
790
|
+
</details>
|
|
791
|
+
|
|
792
|
+
* **Redeem Identity Verification Link For Conversation**: [Reference](https://docs.crisp.chat/references/rest-api/v1/#redeem-identity-verification-link-for-conversation)
|
|
793
|
+
* `CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, identity, token)`
|
|
794
|
+
* <details>
|
|
795
|
+
<summary>See Example</summary>
|
|
796
|
+
|
|
797
|
+
```javascript
|
|
798
|
+
var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc";
|
|
799
|
+
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881";
|
|
800
|
+
|
|
801
|
+
var identity = "email";
|
|
802
|
+
var token = "709691";
|
|
803
|
+
|
|
804
|
+
CrispClient.website.redeemIdentityVerificationLinkForConversation(websiteID, sessionID, identity, token);
|
|
805
|
+
```
|
|
806
|
+
</details>
|
|
807
|
+
|
|
775
808
|
* **Request Email Transcript For Conversation** [`user`, `plugin`]: [Reference](https://docs.crisp.chat/references/rest-api/v1/#request-email-transcript-for-conversation)
|
|
776
809
|
* `CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)`
|
|
777
810
|
* <details>
|
|
@@ -810,6 +810,57 @@ function WebsiteConversation(service, crisp) {
|
|
|
810
810
|
);
|
|
811
811
|
};
|
|
812
812
|
|
|
813
|
+
/**
|
|
814
|
+
* Request Identity Verification For Conversation
|
|
815
|
+
* @memberof WebsiteConversation
|
|
816
|
+
* @public
|
|
817
|
+
* @method requestIdentityVerificationForConversation
|
|
818
|
+
* @param {string} websiteID
|
|
819
|
+
* @param {string} sessionID
|
|
820
|
+
* @param {object} verification
|
|
821
|
+
* @return {Promise}
|
|
822
|
+
*/
|
|
823
|
+
service.requestIdentityVerificationForConversation = function(
|
|
824
|
+
websiteID, sessionID, verification
|
|
825
|
+
) {
|
|
826
|
+
return crisp.post(
|
|
827
|
+
crisp._prepareRestUrl([
|
|
828
|
+
"website", websiteID, "conversation", sessionID, "verify", "identity"
|
|
829
|
+
]),
|
|
830
|
+
|
|
831
|
+
null, verification
|
|
832
|
+
);
|
|
833
|
+
};
|
|
834
|
+
|
|
835
|
+
/**
|
|
836
|
+
* Redeem Identity Verification Link For Conversation
|
|
837
|
+
* @memberof WebsiteConversation
|
|
838
|
+
* @public
|
|
839
|
+
* @method redeemIdentityVerificationLinkForConversation
|
|
840
|
+
* @param {string} websiteID
|
|
841
|
+
* @param {string} sessionID
|
|
842
|
+
* @param {string} identity
|
|
843
|
+
* @param {string} token
|
|
844
|
+
* @return {Promise}
|
|
845
|
+
*/
|
|
846
|
+
service.redeemIdentityVerificationLinkForConversation = function(
|
|
847
|
+
websiteID, sessionID, identity, token
|
|
848
|
+
) {
|
|
849
|
+
return crisp.put(
|
|
850
|
+
crisp._prepareRestUrl([
|
|
851
|
+
"website", websiteID, "conversation", sessionID, "verify", "identity",
|
|
852
|
+
"link"
|
|
853
|
+
]),
|
|
854
|
+
|
|
855
|
+
null,
|
|
856
|
+
|
|
857
|
+
{
|
|
858
|
+
identity : identity,
|
|
859
|
+
token : token
|
|
860
|
+
}
|
|
861
|
+
);
|
|
862
|
+
};
|
|
863
|
+
|
|
813
864
|
/**
|
|
814
865
|
* Request Email Transcript For Conversation
|
|
815
866
|
* @memberof WebsiteConversation
|
package/package.json
CHANGED