@facesignai/api 1.0.2 → 1.0.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/build/package.json
CHANGED
|
@@ -65,18 +65,51 @@ export interface GetSessionResponse {
|
|
|
65
65
|
}
|
|
66
66
|
export type Lang = 'en' | 'fr' | 'de' | 'es';
|
|
67
67
|
export type Zone = 'es' | 'eu';
|
|
68
|
+
export declare enum ModuleType {
|
|
69
|
+
EmailVerification = "emailVerification",
|
|
70
|
+
SmsVerification = "smsVerification",
|
|
71
|
+
IdentityVerification = "identityVerification",
|
|
72
|
+
DocumentAuthentication = "documentAuthentication",
|
|
73
|
+
AgeEstimation = "ageEstimation",
|
|
74
|
+
ProofOfIntent = "proofOfIntent",
|
|
75
|
+
KnowledgeVerify = "knowledgeVerify"
|
|
76
|
+
}
|
|
77
|
+
export type EmailVerification = {
|
|
78
|
+
type: ModuleType.EmailVerification;
|
|
79
|
+
};
|
|
80
|
+
export type SmsVerification = {
|
|
81
|
+
type: ModuleType.SmsVerification;
|
|
82
|
+
};
|
|
83
|
+
export type IdentityVerification = {
|
|
84
|
+
type: ModuleType.IdentityVerification;
|
|
85
|
+
};
|
|
86
|
+
export type DocumentAuthentication = {
|
|
87
|
+
type: ModuleType.DocumentAuthentication;
|
|
88
|
+
};
|
|
89
|
+
export type AgeEstimation = {
|
|
90
|
+
type: ModuleType.AgeEstimation;
|
|
91
|
+
age: number;
|
|
92
|
+
};
|
|
93
|
+
export type ProofOfIntent = {
|
|
94
|
+
type: ModuleType.ProofOfIntent;
|
|
95
|
+
requestedData: RequestedData[];
|
|
96
|
+
};
|
|
97
|
+
export type KnowledgeVerify = {
|
|
98
|
+
type: ModuleType.KnowledgeVerify;
|
|
99
|
+
};
|
|
100
|
+
export type Module = EmailVerification | SmsVerification | IdentityVerification | DocumentAuthentication | AgeEstimation | ProofOfIntent | KnowledgeVerify;
|
|
68
101
|
export interface SessionSettings {
|
|
69
102
|
clientReferenceId: string;
|
|
70
103
|
metadata: object;
|
|
71
|
-
requestedData: RequestedData[];
|
|
72
104
|
avatar?: AvatarType;
|
|
73
105
|
initialPhrase?: string;
|
|
74
106
|
finalPhrase?: string;
|
|
75
107
|
providedData?: Record<string, string>;
|
|
76
108
|
avatarId?: string;
|
|
77
109
|
voiceId?: string;
|
|
78
|
-
|
|
110
|
+
langs?: Lang;
|
|
79
111
|
zone?: Zone;
|
|
112
|
+
modules: Module[];
|
|
80
113
|
}
|
|
81
114
|
export interface CreateSessionResponse {
|
|
82
115
|
session: Session;
|
|
@@ -86,7 +119,7 @@ export declare const createSessionEndpoint: {
|
|
|
86
119
|
readonly method: Method.POST;
|
|
87
120
|
readonly pathParams: readonly [];
|
|
88
121
|
readonly queryParams: readonly [];
|
|
89
|
-
readonly bodyParams: readonly ["clientReferenceId", "metadata", "
|
|
122
|
+
readonly bodyParams: readonly ["clientReferenceId", "metadata", "avatar", "initialPhrase", "finalPhrase", "providedData", "avatarId", "voiceId", "langs", "zone", "modules"];
|
|
90
123
|
readonly path: () => string;
|
|
91
124
|
};
|
|
92
125
|
type GetSessionPathParameters = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/api-endpoints.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,KAAK,WAAW;IAChB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,WAAW;CACjB;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEtD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,oBAAY,aAAa;IACvB,aAAa,kBAAkB;IAC/B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,eAAe,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAC5C,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE9B,
|
|
1
|
+
{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../src/api-endpoints.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,KAAK,UAAU;IACf,KAAK,WAAW;IAChB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,SAAS,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,oBAAY,MAAM;IAChB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,WAAW;CACjB;AAED,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEtD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,oBAAY,aAAa;IACvB,aAAa,kBAAkB;IAC/B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,QAAQ,EAAE,eAAe,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAC5C,MAAM,MAAM,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE9B,oBAAY,UAAU;IACpB,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;IACnC,oBAAoB,yBAAyB;IAC7C,sBAAsB,2BAA2B;IACjD,aAAa,kBAAkB;IAC/B,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;CACpC;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,UAAU,CAAC,iBAAiB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,UAAU,CAAC,oBAAoB,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,UAAU,CAAC,sBAAsB,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC,aAAa,CAAA;IAC9B,aAAa,EAAE,aAAa,EAAE,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,MAAM,GACd,iBAAiB,GACjB,eAAe,GACf,oBAAoB,GACpB,sBAAsB,GACtB,aAAa,GACb,aAAa,GACb,eAAe,CAAA;AAEnB,MAAM,WAAW,eAAe;IAC9B,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,IAAI,CAAA;IACZ,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,EAAE,YAAY,CAAA;CAC3B;AAED,eAAO,MAAM,qBAAqB;;;;;yBAiBtB,MAAM;CACR,CAAA;AAEV,KAAK,wBAAwB,GAAG;IAC9B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,kBAAkB;;;;;uBAKnB,wBAAwB,KAAG,MAAM;CACnC,CAAA;AAEV,eAAO,MAAM,0BAA0B;;;;;uBAK3B,wBAAwB,KAAG,MAAM;CAEnC,CAAA"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.createClientSecretEndpoint = exports.getSessionEndpoint = exports.createSessionEndpoint = exports.SessionStatus = exports.Method = exports.ILogLevel = void 0;
|
|
3
|
+
exports.createClientSecretEndpoint = exports.getSessionEndpoint = exports.createSessionEndpoint = exports.ModuleType = exports.SessionStatus = exports.Method = exports.ILogLevel = void 0;
|
|
4
4
|
var ILogLevel;
|
|
5
5
|
(function (ILogLevel) {
|
|
6
6
|
ILogLevel["TRACE"] = "TRACE";
|
|
@@ -24,6 +24,16 @@ var SessionStatus;
|
|
|
24
24
|
SessionStatus["Canceled"] = "canceled";
|
|
25
25
|
SessionStatus["Complete"] = "complete";
|
|
26
26
|
})(SessionStatus = exports.SessionStatus || (exports.SessionStatus = {}));
|
|
27
|
+
var ModuleType;
|
|
28
|
+
(function (ModuleType) {
|
|
29
|
+
ModuleType["EmailVerification"] = "emailVerification";
|
|
30
|
+
ModuleType["SmsVerification"] = "smsVerification";
|
|
31
|
+
ModuleType["IdentityVerification"] = "identityVerification";
|
|
32
|
+
ModuleType["DocumentAuthentication"] = "documentAuthentication";
|
|
33
|
+
ModuleType["AgeEstimation"] = "ageEstimation";
|
|
34
|
+
ModuleType["ProofOfIntent"] = "proofOfIntent";
|
|
35
|
+
ModuleType["KnowledgeVerify"] = "knowledgeVerify";
|
|
36
|
+
})(ModuleType = exports.ModuleType || (exports.ModuleType = {}));
|
|
27
37
|
exports.createSessionEndpoint = {
|
|
28
38
|
method: Method.POST,
|
|
29
39
|
pathParams: [],
|
|
@@ -31,15 +41,15 @@ exports.createSessionEndpoint = {
|
|
|
31
41
|
bodyParams: [
|
|
32
42
|
'clientReferenceId',
|
|
33
43
|
'metadata',
|
|
34
|
-
'requestedData',
|
|
35
44
|
'avatar',
|
|
36
45
|
'initialPhrase',
|
|
37
46
|
'finalPhrase',
|
|
38
47
|
'providedData',
|
|
39
48
|
'avatarId',
|
|
40
49
|
'voiceId',
|
|
41
|
-
'
|
|
50
|
+
'langs',
|
|
42
51
|
'zone',
|
|
52
|
+
'modules',
|
|
43
53
|
],
|
|
44
54
|
path: () => '/sessions',
|
|
45
55
|
};
|