botshield-sdk 4.0.1 → 4.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/README.md +3 -5
- package/bin/mcp-server.js +15 -13
- package/bin/mcp-server.js.map +19 -19
- package/dist/commonjs/funcs/census-confirm-link.d.ts +1 -1
- package/dist/commonjs/funcs/census-confirm-link.js +1 -1
- package/dist/commonjs/funcs/census-send-by-number.d.ts +1 -1
- package/dist/commonjs/funcs/census-send-by-number.js +1 -1
- package/dist/commonjs/funcs/census-verify-token.d.ts +1 -1
- package/dist/commonjs/funcs/census-verify-token.js +1 -1
- package/dist/commonjs/funcs/verification-get-status.d.ts +1 -1
- package/dist/commonjs/funcs/verification-get-status.js +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -12
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +3 -13
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.js +1 -1
- package/dist/commonjs/models/bot-shield-action.d.ts +7 -7
- package/dist/commonjs/models/bot-shield-action.js +1 -1
- package/dist/commonjs/models/error-body.d.ts +1 -1
- package/dist/commonjs/models/operations/actions-propose.d.ts +1 -1
- package/dist/commonjs/models/operations/gates-api-actions-create.d.ts +2 -2
- package/dist/commonjs/models/operations/gates-api-actions-list.d.ts +1 -1
- package/dist/commonjs/models/operations/gates-api-actions-request.d.ts +2 -2
- package/dist/commonjs/models/operations/gates-api-actions-set-state.d.ts +1 -1
- package/dist/commonjs/models/operations/gates-api-actions-update.d.ts +2 -2
- package/dist/commonjs/models/operations/sdk-create-verification-link.d.ts +2 -2
- package/dist/commonjs/models/operations/sdk-send-by-number.d.ts +1 -1
- package/dist/commonjs/models/operations/sdk-verify-token.d.ts +7 -7
- package/dist/commonjs/models/operations/secured-accounts-list.d.ts +5 -0
- package/dist/commonjs/models/operations/secured-accounts-list.d.ts.map +1 -1
- package/dist/commonjs/models/operations/secured-accounts-list.js +2 -0
- package/dist/commonjs/models/operations/secured-accounts-list.js.map +1 -1
- package/dist/commonjs/models/operations/secured-accounts-status.d.ts +5 -0
- package/dist/commonjs/models/operations/secured-accounts-status.d.ts.map +1 -1
- package/dist/commonjs/models/operations/secured-accounts-status.js +2 -0
- package/dist/commonjs/models/operations/secured-accounts-status.js.map +1 -1
- package/dist/commonjs/models/operations/verification-get-status.d.ts +6 -6
- package/dist/commonjs/models/operations/verification-get-status.js +1 -1
- package/dist/commonjs/sdk/census.d.ts +3 -3
- package/dist/commonjs/sdk/census.js +3 -3
- package/dist/commonjs/sdk/verification.d.ts +1 -1
- package/dist/commonjs/sdk/verification.js +1 -1
- package/dist/esm/funcs/census-confirm-link.d.ts +1 -1
- package/dist/esm/funcs/census-confirm-link.js +1 -1
- package/dist/esm/funcs/census-send-by-number.d.ts +1 -1
- package/dist/esm/funcs/census-send-by-number.js +1 -1
- package/dist/esm/funcs/census-verify-token.d.ts +1 -1
- package/dist/esm/funcs/census-verify-token.js +1 -1
- package/dist/esm/funcs/verification-get-status.d.ts +1 -1
- package/dist/esm/funcs/verification-get-status.js +1 -1
- package/dist/esm/lib/config.d.ts +2 -12
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +2 -12
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.js +1 -1
- package/dist/esm/models/bot-shield-action.d.ts +7 -7
- package/dist/esm/models/bot-shield-action.js +1 -1
- package/dist/esm/models/error-body.d.ts +1 -1
- package/dist/esm/models/operations/actions-propose.d.ts +1 -1
- package/dist/esm/models/operations/gates-api-actions-create.d.ts +2 -2
- package/dist/esm/models/operations/gates-api-actions-list.d.ts +1 -1
- package/dist/esm/models/operations/gates-api-actions-request.d.ts +2 -2
- package/dist/esm/models/operations/gates-api-actions-set-state.d.ts +1 -1
- package/dist/esm/models/operations/gates-api-actions-update.d.ts +2 -2
- package/dist/esm/models/operations/sdk-create-verification-link.d.ts +2 -2
- package/dist/esm/models/operations/sdk-send-by-number.d.ts +1 -1
- package/dist/esm/models/operations/sdk-verify-token.d.ts +7 -7
- package/dist/esm/models/operations/secured-accounts-list.d.ts +5 -0
- package/dist/esm/models/operations/secured-accounts-list.d.ts.map +1 -1
- package/dist/esm/models/operations/secured-accounts-list.js +2 -0
- package/dist/esm/models/operations/secured-accounts-list.js.map +1 -1
- package/dist/esm/models/operations/secured-accounts-status.d.ts +5 -0
- package/dist/esm/models/operations/secured-accounts-status.d.ts.map +1 -1
- package/dist/esm/models/operations/secured-accounts-status.js +2 -0
- package/dist/esm/models/operations/secured-accounts-status.js.map +1 -1
- package/dist/esm/models/operations/verification-get-status.d.ts +6 -6
- package/dist/esm/models/operations/verification-get-status.js +1 -1
- package/dist/esm/sdk/census.d.ts +3 -3
- package/dist/esm/sdk/census.js +3 -3
- package/dist/esm/sdk/verification.d.ts +1 -1
- package/dist/esm/sdk/verification.js +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/census-confirm-link.ts +1 -1
- package/src/funcs/census-send-by-number.ts +1 -1
- package/src/funcs/census-verify-token.ts +1 -1
- package/src/funcs/verification-get-status.ts +1 -1
- package/src/lib/config.ts +2 -12
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/bot-shield-action.ts +7 -7
- package/src/models/error-body.ts +1 -1
- package/src/models/operations/actions-propose.ts +1 -1
- package/src/models/operations/gates-api-actions-create.ts +2 -2
- package/src/models/operations/gates-api-actions-list.ts +1 -1
- package/src/models/operations/gates-api-actions-request.ts +2 -2
- package/src/models/operations/gates-api-actions-set-state.ts +1 -1
- package/src/models/operations/gates-api-actions-update.ts +2 -2
- package/src/models/operations/sdk-create-verification-link.ts +2 -2
- package/src/models/operations/sdk-send-by-number.ts +1 -1
- package/src/models/operations/sdk-verify-token.ts +7 -7
- package/src/models/operations/secured-accounts-list.ts +7 -0
- package/src/models/operations/secured-accounts-status.ts +7 -0
- package/src/models/operations/verification-get-status.ts +6 -6
- package/src/sdk/census.ts +3 -3
- package/src/sdk/verification.ts +1 -1
|
@@ -24,6 +24,10 @@ export type SecuredAccountsStatusDataData = {
|
|
|
24
24
|
* When recent presence lapses (in the past when `stale`); null when `none`.
|
|
25
25
|
*/
|
|
26
26
|
freshUntil: Date | null;
|
|
27
|
+
/**
|
|
28
|
+
* True while the person's number changed without approval from another phone: this account answers nothing (refusals say account_reconfirm_required) until your signed-in link ceremony completes again. null when it can't be read; false when there is no live account.
|
|
29
|
+
*/
|
|
30
|
+
paused?: boolean | null | undefined;
|
|
27
31
|
};
|
|
28
32
|
export type SecuredAccountsStatusData = {
|
|
29
33
|
data?: SecuredAccountsStatusDataData | undefined;
|
|
@@ -68,6 +72,7 @@ export declare const SecuredAccountsStatusDataData$inboundSchema: z.ZodType<Secu
|
|
|
68
72
|
export type SecuredAccountsStatusDataData$Outbound = {
|
|
69
73
|
state: string;
|
|
70
74
|
fresh_until: string | null;
|
|
75
|
+
paused?: boolean | null | undefined;
|
|
71
76
|
};
|
|
72
77
|
/** @internal */
|
|
73
78
|
export declare const SecuredAccountsStatusDataData$outboundSchema: z.ZodType<SecuredAccountsStatusDataData$Outbound, z.ZodTypeDef, SecuredAccountsStatusDataData>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"secured-accounts-status.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/secured-accounts-status.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,EAAE,0BAA0B,CAAC;IAClC;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"secured-accounts-status.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/secured-accounts-status.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,6BAA6B,GAAG;IAC1C,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;CAI7B,CAAC;AACX,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,OAAO,0BAA0B,CAClC,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,EAAE,0BAA0B,CAAC;IAClC;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,IAAI,CAAC,EAAE,6BAA6B,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,yBAAyB,CAAC;CACjC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,sCAAsC,GAAG;IACnD,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,sCAAsC,EACtC,CAAC,CAAC,UAAU,EACZ,6BAA6B,CAO7B,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,6BAA6B,EAAE,6BAA6B,GAC3D,MAAM,CAMR;AACD,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE;AAED,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,OAAO,CAChE,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,qCAAqC,GAAG;IAClD,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,qCAAqC,EACrC,CAAC,CAAC,UAAU,EACZ,4BAA4B,CAO5B,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,4BAA4B,EAAE,4BAA4B,GACzD,MAAM,CAMR;AACD,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,EAAE,kBAAkB,CAAC,CAMnE;AAED,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAC8C,CAAC;AACxD,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,OAAO,CAC/D,MAAM,EACN,CAAC,CAAC,UAAU,EACZ,0BAA0B,CAC4B,CAAC;AAEzD,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,sCAAsC,GAAG;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,sCAAsC,EACtC,CAAC,CAAC,UAAU,EACZ,6BAA6B,CAS7B,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,6BAA6B,EAAE,6BAA6B,GAC3D,MAAM,CAMR;AACD,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE;AAED,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,OAAO,CAC7D,yBAAyB,EACzB,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,CAAC,EAAE,sCAAsC,GAAG,SAAS,CAAC;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC,kBAAkB,GAAG,SAAS,CAAC;CAC/C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,kCAAkC,EAClC,CAAC,CAAC,UAAU,EACZ,yBAAyB,CAIzB,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,yBAAyB,EAAE,yBAAyB,GACnD,MAAM,CAIR;AACD,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,yBAAyB,EAAE,kBAAkB,CAAC,CAMhE;AAED,gBAAgB;AAChB,eAAO,MAAM,2CAA2C,EAAE,CAAC,CAAC,OAAO,CACjE,6BAA6B,EAC7B,CAAC,CAAC,UAAU,EACZ,OAAO,CAGP,CAAC;AACH,gBAAgB;AAChB,MAAM,MAAM,sCAAsC,GAAG;IACnD,IAAI,EAAE,kCAAkC,CAAC;CAC1C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,OAAO,CAClE,sCAAsC,EACtC,CAAC,CAAC,UAAU,EACZ,6BAA6B,CAG7B,CAAC;AAEH,wBAAgB,mCAAmC,CACjD,6BAA6B,EAAE,6BAA6B,GAC3D,MAAM,CAMR;AACD,wBAAgB,qCAAqC,CACnD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,6BAA6B,EAAE,kBAAkB,CAAC,CAMpE"}
|
|
@@ -110,6 +110,7 @@ exports.SecuredAccountsStatusState$outboundSchema = openEnums.outboundSchema(exp
|
|
|
110
110
|
exports.SecuredAccountsStatusDataData$inboundSchema = z.object({
|
|
111
111
|
state: exports.SecuredAccountsStatusState$inboundSchema,
|
|
112
112
|
fresh_until: types.nullable(types.date()),
|
|
113
|
+
paused: z.nullable(types.boolean()).optional(),
|
|
113
114
|
}).transform((v) => {
|
|
114
115
|
return (0, primitives_js_1.remap)(v, {
|
|
115
116
|
"fresh_until": "freshUntil",
|
|
@@ -119,6 +120,7 @@ exports.SecuredAccountsStatusDataData$inboundSchema = z.object({
|
|
|
119
120
|
exports.SecuredAccountsStatusDataData$outboundSchema = z.object({
|
|
120
121
|
state: exports.SecuredAccountsStatusState$outboundSchema,
|
|
121
122
|
freshUntil: z.nullable(z.date().transform(v => v.toISOString())),
|
|
123
|
+
paused: z.nullable(z.boolean()).optional(),
|
|
122
124
|
}).transform((v) => {
|
|
123
125
|
return (0, primitives_js_1.remap)(v, {
|
|
124
126
|
freshUntil: "fresh_until",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"secured-accounts-status.js","sourceRoot":"","sources":["../../../../src/models/operations/secured-accounts-status.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,MAAY,CAAC,mCAAe;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,MAAY,SAAS,iDAA6B;AAGlD,MAAY,KAAK,sDAAkC;AAEnD,MAAY,MAAM,wCAAoB;AAazB,QAAA,0BAA0B,GAAG;IACxC,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;CACN,CAAC;
|
|
1
|
+
{"version":3,"file":"secured-accounts-status.js","sourceRoot":"","sources":["../../../../src/models/operations/secured-accounts-status.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,MAAY,CAAC,mCAAe;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,MAAY,SAAS,iDAA6B;AAGlD,MAAY,KAAK,sDAAkC;AAEnD,MAAY,MAAM,wCAAoB;AAazB,QAAA,0BAA0B,GAAG;IACxC,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;CACN,CAAC;AAgCX,gBAAgB;AACH,QAAA,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE;CAC3B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,YAAY,EAAE,YAAY;KAC3B,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAMH,gBAAgB;AACH,QAAA,4CAA4C,GAIrD,CAAC,CAAC,MAAM,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,UAAU,EAAE,YAAY;KACzB,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAEH,6CACE,6BAA4D,EACpD;IACR,OAAO,IAAI,CAAC,SAAS,CACnB,QAAA,4CAA4C,CAAC,KAAK,CAChD,6BAA6B,CAC9B,CACF,CAAC;AAAA,CACH;AACD,+CACE,UAAkB,EACkD;IACpE,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AAAA,CACH;AAED,gBAAgB;AACH,QAAA,0CAA0C,GAInD,CAAC,CAAC,MAAM,CAAC;IACX,iBAAiB,EAAE,KAAK,CAAC,MAAM,EAAE;CAClC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,mBAAmB,EAAE,iBAAiB;KACvC,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAMH,gBAAgB;AACH,QAAA,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;CAC5B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,eAAe,EAAE,mBAAmB;KACrC,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAEH,4CACE,4BAA0D,EAClD;IACR,OAAO,IAAI,CAAC,SAAS,CACnB,QAAA,2CAA2C,CAAC,KAAK,CAC/C,4BAA4B,CAC7B,CACF,CAAC;AAAA,CACH;AACD,8CACE,UAAkB,EACiD;IACnE,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,0CAA0C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACtE,0DAA0D,CAC3D,CAAC;AAAA,CACH;AAED,gBAAgB;AACH,QAAA,wCAAwC,GAIjD,SAAS,CAAC,aAAa,CAAC,QAAA,0BAA0B,CAAC,CAAC;AACxD,gBAAgB;AACH,QAAA,yCAAyC,GAIlD,SAAS,CAAC,cAAc,CAAC,QAAA,0BAA0B,CAAC,CAAC;AAEzD,gBAAgB;AACH,QAAA,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,QAAA,wCAAwC;IAC/C,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACzC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,aAAa,EAAE,YAAY;KAC5B,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAQH,gBAAgB;AACH,QAAA,4CAA4C,GAIrD,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,QAAA,yCAAyC;IAChD,UAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAChE,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC3C,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,UAAU,EAAE,aAAa;KAC1B,CAAC,CAAC;AAAA,CACJ,CAAC,CAAC;AAEH,6CACE,6BAA4D,EACpD;IACR,OAAO,IAAI,CAAC,SAAS,CACnB,QAAA,4CAA4C,CAAC,KAAK,CAChD,6BAA6B,CAC9B,CACF,CAAC;AAAA,CACH;AACD,+CACE,UAAkB,EACkD;IACpE,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AAAA,CACH;AAED,gBAAgB;AACH,QAAA,uCAAuC,GAIhD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,KAAK,CAAC,QAAQ,CAClB,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAA,2CAA2C,CAAC,CAC1D;IACD,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,uBAAuB,CAAC;CACtD,CAAC,CAAC;AAOH,gBAAgB;AACH,QAAA,wCAAwC,GAIjD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAA,4CAA4C,CAAC,CAAC,QAAQ,EAAE;IAC3E,KAAK,EAAE,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAEH,yCACE,yBAAoD,EAC5C;IACR,OAAO,IAAI,CAAC,SAAS,CACnB,QAAA,wCAAwC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAC1E,CAAC;AAAA,CACH;AACD,2CACE,UAAkB,EAC8C;IAChE,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,uCAAuC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnE,uDAAuD,CACxD,CAAC;AAAA,CACH;AAED,gBAAgB;AACH,QAAA,2CAA2C,GAIpD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAA,uCAAuC,CAAC;CAC5D,CAAC,CAAC;AAMH,gBAAgB;AACH,QAAA,4CAA4C,GAIrD,CAAC,CAAC,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAA,wCAAwC,CAAC;CAC7D,CAAC,CAAC;AAEH,6CACE,6BAA4D,EACpD;IACR,OAAO,IAAI,CAAC,SAAS,CACnB,QAAA,4CAA4C,CAAC,KAAK,CAChD,6BAA6B,CAC9B,CACF,CAAC;AAAA,CACH;AACD,+CACE,UAAkB,EACkD;IACpE,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,QAAA,2CAA2C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvE,2DAA2D,CAC5D,CAAC;AAAA,CACH"}
|
|
@@ -10,7 +10,7 @@ export type VerificationGetStatusSecurity = {
|
|
|
10
10
|
export type VerificationGetStatusRequest = {
|
|
11
11
|
requestId: string;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* The `read_secret` create-verification-link returned for a request started with your site key. Without it such a request's `verification_token` / `signed_token` are never returned. A request your server started reads them with your secret key (`Authorization: Bearer bs_…`) instead. A passkey sign-in's answer is never returned here (use signin/confirm).
|
|
14
14
|
*/
|
|
15
15
|
xBotShieldRequestSecret?: string | undefined;
|
|
16
16
|
};
|
|
@@ -142,7 +142,7 @@ export declare const VerificationGetStatusGateType: {
|
|
|
142
142
|
*/
|
|
143
143
|
export type VerificationGetStatusGateType = OpenEnum<typeof VerificationGetStatusGateType>;
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
145
|
+
* Where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
|
|
146
146
|
*/
|
|
147
147
|
export declare const LinkState: {
|
|
148
148
|
readonly Pending: "pending";
|
|
@@ -151,7 +151,7 @@ export declare const LinkState: {
|
|
|
151
151
|
readonly Refused: "refused";
|
|
152
152
|
};
|
|
153
153
|
/**
|
|
154
|
-
*
|
|
154
|
+
* Where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
|
|
155
155
|
*/
|
|
156
156
|
export type LinkState = OpenEnum<typeof LinkState>;
|
|
157
157
|
export type VerificationGetStatusData = {
|
|
@@ -239,15 +239,15 @@ export type VerificationGetStatusData = {
|
|
|
239
239
|
*/
|
|
240
240
|
ageSource?: string | null | undefined;
|
|
241
241
|
/**
|
|
242
|
-
*
|
|
242
|
+
* Where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
|
|
243
243
|
*/
|
|
244
244
|
linkState?: LinkState | null | undefined;
|
|
245
245
|
/**
|
|
246
|
-
*
|
|
246
|
+
* When a pending link expires (24 hours after the tap). Null unless `link_state` is `pending`.
|
|
247
247
|
*/
|
|
248
248
|
linkExpiresAt?: Date | null | undefined;
|
|
249
249
|
/**
|
|
250
|
-
*
|
|
250
|
+
* `link_pending` while the link waits for your server.
|
|
251
251
|
*/
|
|
252
252
|
linkCode?: string | undefined;
|
|
253
253
|
linkMessage?: string | undefined;
|
|
@@ -103,7 +103,7 @@ exports.VerificationGetStatusGateType = {
|
|
|
103
103
|
Age: "age",
|
|
104
104
|
};
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
106
|
+
* Where the link stands on this request. Null on a plain check and on a link from before 4.0. A pass whose link is not live carries no destination.
|
|
107
107
|
*/
|
|
108
108
|
exports.LinkState = {
|
|
109
109
|
Pending: "pending",
|
|
@@ -21,7 +21,7 @@ export declare class Census extends ClientSDK {
|
|
|
21
21
|
* Validate a verification token
|
|
22
22
|
*
|
|
23
23
|
* @remarks
|
|
24
|
-
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent.
|
|
24
|
+
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent. The check needs your secret key (`Authorization: Bearer bs_…`); without it the answer is `valid: false, code: secret_key_required` and the token is not spent. Send `expected_request_id` (the request your server made) and a token for any other request is refused (`code: request_mismatch`), unspent. A passkey sign-in's token is refused here: redeem a sign-in with signin/confirm.
|
|
25
25
|
*/
|
|
26
26
|
verifyToken(security: operations.SDKVerifyTokenSecurity, request: operations.SDKVerifyTokenRequest, options?: RequestOptions): Promise<operations.SDKVerifyTokenResponse>;
|
|
27
27
|
/**
|
|
@@ -60,14 +60,14 @@ export declare class Census extends ClientSDK {
|
|
|
60
60
|
* Confirm a pending link
|
|
61
61
|
*
|
|
62
62
|
* @remarks
|
|
63
|
-
*
|
|
63
|
+
* On a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
|
|
64
64
|
*/
|
|
65
65
|
confirmLink(security: operations.SDKConfirmLinkSecurity, request: operations.SDKConfirmLinkRequest, options?: RequestOptions): Promise<operations.SDKConfirmLinkResponse>;
|
|
66
66
|
/**
|
|
67
67
|
* Send a request to verify by phone number
|
|
68
68
|
*
|
|
69
69
|
* @remarks
|
|
70
|
-
*
|
|
70
|
+
* From your server, with your SECRET key, send a request to verify to the person whose BotShield ID carries this phone number. BotShield keeps none of your customer data: the number is used once and is not stored, logged or returned. The answer is the same whether or not anyone holds the number: status `sent`, the request id, its expiry and a two-digit `match_number` — show it to your customer; they pick it in the BotShield app before their passkey. Outcomes arrive as webhooks (or verification/status with this key): verified, declined, or expired. A person who has not linked your company first sees an introduction from you; your request can be answered only after they allow it. Production sends need a verified business. Limits: a cap per key per hour and on unanswered sends per company.
|
|
71
71
|
*/
|
|
72
72
|
sendByNumber(security: operations.SDKSendByNumberSecurity, request: operations.SDKSendByNumberRequest, options?: RequestOptions): Promise<operations.SDKSendByNumberResponse>;
|
|
73
73
|
}
|
|
@@ -41,7 +41,7 @@ class Census extends sdks_js_1.ClientSDK {
|
|
|
41
41
|
* Validate a verification token
|
|
42
42
|
*
|
|
43
43
|
* @remarks
|
|
44
|
-
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent.
|
|
44
|
+
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent. The check needs your secret key (`Authorization: Bearer bs_…`); without it the answer is `valid: false, code: secret_key_required` and the token is not spent. Send `expected_request_id` (the request your server made) and a token for any other request is refused (`code: request_mismatch`), unspent. A passkey sign-in's token is refused here: redeem a sign-in with signin/confirm.
|
|
45
45
|
*/
|
|
46
46
|
async verifyToken(security, request, options) {
|
|
47
47
|
return (0, fp_js_1.unwrapAsync)((0, census_verify_token_js_1.censusVerifyToken)(this, security, request, options));
|
|
@@ -92,7 +92,7 @@ class Census extends sdks_js_1.ClientSDK {
|
|
|
92
92
|
* Confirm a pending link
|
|
93
93
|
*
|
|
94
94
|
* @remarks
|
|
95
|
-
*
|
|
95
|
+
* On a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
|
|
96
96
|
*/
|
|
97
97
|
async confirmLink(security, request, options) {
|
|
98
98
|
return (0, fp_js_1.unwrapAsync)((0, census_confirm_link_js_1.censusConfirmLink)(this, security, request, options));
|
|
@@ -101,7 +101,7 @@ class Census extends sdks_js_1.ClientSDK {
|
|
|
101
101
|
* Send a request to verify by phone number
|
|
102
102
|
*
|
|
103
103
|
* @remarks
|
|
104
|
-
*
|
|
104
|
+
* From your server, with your SECRET key, send a request to verify to the person whose BotShield ID carries this phone number. BotShield keeps none of your customer data: the number is used once and is not stored, logged or returned. The answer is the same whether or not anyone holds the number: status `sent`, the request id, its expiry and a two-digit `match_number` — show it to your customer; they pick it in the BotShield app before their passkey. Outcomes arrive as webhooks (or verification/status with this key): verified, declined, or expired. A person who has not linked your company first sees an introduction from you; your request can be answered only after they allow it. Production sends need a verified business. Limits: a cap per key per hour and on unanswered sends per company.
|
|
105
105
|
*/
|
|
106
106
|
async sendByNumber(security, request, options) {
|
|
107
107
|
return (0, fp_js_1.unwrapAsync)((0, census_send_by_number_js_1.censusSendByNumber)(this, security, request, options));
|
|
@@ -5,7 +5,7 @@ export declare class Verification extends ClientSDK {
|
|
|
5
5
|
* Check verification status
|
|
6
6
|
*
|
|
7
7
|
* @remarks
|
|
8
|
-
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
|
|
8
|
+
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. Knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
|
|
9
9
|
*/
|
|
10
10
|
getStatus(security: operations.VerificationGetStatusSecurity, request: operations.VerificationGetStatusRequest, options?: RequestOptions): Promise<operations.VerificationGetStatusResponse>;
|
|
11
11
|
}
|
|
@@ -12,7 +12,7 @@ class Verification extends sdks_js_1.ClientSDK {
|
|
|
12
12
|
* Check verification status
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
|
|
15
|
+
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. Knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
|
|
16
16
|
*/
|
|
17
17
|
async getStatus(security, request, options) {
|
|
18
18
|
return (0, fp_js_1.unwrapAsync)((0, verification_get_status_js_1.verificationGetStatus)(this, security, request, options));
|
|
@@ -11,7 +11,7 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
* Confirm a pending link
|
|
12
12
|
*
|
|
13
13
|
* @remarks
|
|
14
|
-
*
|
|
14
|
+
* On a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
|
|
15
15
|
*/
|
|
16
16
|
export declare function censusConfirmLink(client: BotShieldCore, security: operations.SDKConfirmLinkSecurity, request: operations.SDKConfirmLinkRequest, options?: RequestOptions): APIPromise<Result<operations.SDKConfirmLinkResponse, BotShieldError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
17
17
|
//# sourceMappingURL=census-confirm-link.d.ts.map
|
|
@@ -14,7 +14,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
14
14
|
* Confirm a pending link
|
|
15
15
|
*
|
|
16
16
|
* @remarks
|
|
17
|
-
*
|
|
17
|
+
* On a key with “Pending until your server confirms” on, a link waits after the person's tap (account.link_pending). Confirm it from your server with your SECRET key, sending the account your own session shows. The same account makes the link live (account.link_live, account.secured) and returns the finished token on this response only. Another account is refused and the waiting link is dropped. A link not confirmed within 24 hours expires. You can also confirm by passing `partner_user_ref` to sdk/verify-token with your secret key.
|
|
18
18
|
*/
|
|
19
19
|
export function censusConfirmLink(client, security, request, options) {
|
|
20
20
|
return new APIPromise($do(client, security, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Send a request to verify by phone number
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
*
|
|
15
|
+
* From your server, with your SECRET key, send a request to verify to the person whose BotShield ID carries this phone number. BotShield keeps none of your customer data: the number is used once and is not stored, logged or returned. The answer is the same whether or not anyone holds the number: status `sent`, the request id, its expiry and a two-digit `match_number` — show it to your customer; they pick it in the BotShield app before their passkey. Outcomes arrive as webhooks (or verification/status with this key): verified, declined, or expired. A person who has not linked your company first sees an introduction from you; your request can be answered only after they allow it. Production sends need a verified business. Limits: a cap per key per hour and on unanswered sends per company.
|
|
16
16
|
*/
|
|
17
17
|
export declare function censusSendByNumber(client: BotShieldCore, security: operations.SDKSendByNumberSecurity, request: operations.SDKSendByNumberRequest, options?: RequestOptions): APIPromise<Result<operations.SDKSendByNumberResponse, errors.ErrorResponse | BotShieldError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=census-send-by-number.d.ts.map
|
|
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
15
15
|
* Send a request to verify by phone number
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
|
-
*
|
|
18
|
+
* From your server, with your SECRET key, send a request to verify to the person whose BotShield ID carries this phone number. BotShield keeps none of your customer data: the number is used once and is not stored, logged or returned. The answer is the same whether or not anyone holds the number: status `sent`, the request id, its expiry and a two-digit `match_number` — show it to your customer; they pick it in the BotShield app before their passkey. Outcomes arrive as webhooks (or verification/status with this key): verified, declined, or expired. A person who has not linked your company first sees an introduction from you; your request can be answered only after they allow it. Production sends need a verified business. Limits: a cap per key per hour and on unanswered sends per company.
|
|
19
19
|
*/
|
|
20
20
|
export function censusSendByNumber(client, security, request, options) {
|
|
21
21
|
return new APIPromise($do(client, security, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Validate a verification token
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent.
|
|
15
|
+
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent. The check needs your secret key (`Authorization: Bearer bs_…`); without it the answer is `valid: false, code: secret_key_required` and the token is not spent. Send `expected_request_id` (the request your server made) and a token for any other request is refused (`code: request_mismatch`), unspent. A passkey sign-in's token is refused here: redeem a sign-in with signin/confirm.
|
|
16
16
|
*/
|
|
17
17
|
export declare function censusVerifyToken(client: BotShieldCore, security: operations.SDKVerifyTokenSecurity, request: operations.SDKVerifyTokenRequest, options?: RequestOptions): APIPromise<Result<operations.SDKVerifyTokenResponse, errors.InvalidInputError | errors.ErrorResponse | BotShieldError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=census-verify-token.d.ts.map
|
|
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
15
15
|
* Validate a verification token
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
|
-
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent.
|
|
18
|
+
* Validates a BotShield attestation JWT — the primary server-side check. Attestations are ES256-signed; the public key is published at /.well-known/jwks.json (kid in the header), so you may also verify locally with any JWT library. Claims are anonymous by construction: the token attests the event, never the person. Each attestation is for one organization (aud = its organization_id; pass `audience` to enforce it) and one check: a repeat check is refused (`valid: false`, `replayed: true`). Check it once, on your server. Each token names its `kind` (`verification` or `action`) and the `environment` it was issued in. A token of any other kind is refused, and when you call with your secret key (`Authorization: Bearer bs_…`) a token from the other environment is refused (a development token never passes a production check). A refused token is not spent. The check needs your secret key (`Authorization: Bearer bs_…`); without it the answer is `valid: false, code: secret_key_required` and the token is not spent. Send `expected_request_id` (the request your server made) and a token for any other request is refused (`code: request_mismatch`), unspent. A passkey sign-in's token is refused here: redeem a sign-in with signin/confirm.
|
|
19
19
|
*/
|
|
20
20
|
export function censusVerifyToken(client, security, request, options) {
|
|
21
21
|
return new APIPromise($do(client, security, request, options));
|
|
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
|
|
|
12
12
|
* Check verification status
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
|
-
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
|
|
15
|
+
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. Knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
|
|
16
16
|
*/
|
|
17
17
|
export declare function verificationGetStatus(client: BotShieldCore, security: operations.VerificationGetStatusSecurity, request: operations.VerificationGetStatusRequest, options?: RequestOptions): APIPromise<Result<operations.VerificationGetStatusResponse, errors.InvalidInputError | errors.ErrorResponse | BotShieldError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
18
18
|
//# sourceMappingURL=verification-get-status.d.ts.map
|
|
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
15
15
|
* Check verification status
|
|
16
16
|
*
|
|
17
17
|
* @remarks
|
|
18
|
-
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`.
|
|
18
|
+
* Poll a verification request. Carries the signed attestation on completion and NO identity — no user_email, partner_user_id, auth_mode, or botshield_user_id ever cross this boundary. Called without a key, it is rate-limited per client address (a page polling every 2 seconds stays well inside it); over the limit the call is refused with HTTP 403 and `errors[0].code = "RATE_LIMITED"`. Knowing the request id is not enough to read the finished tokens. A request started with a site key returns them only with its `read_secret` (`X-BotShield-Request-Secret`); a request your server started, only to your secret key. A passkey sign-in's tokens are never returned here.
|
|
19
19
|
*/
|
|
20
20
|
export function verificationGetStatus(client, security, request, options) {
|
|
21
21
|
return new APIPromise($do(client, security, request, options));
|
package/dist/esm/lib/config.d.ts
CHANGED
|
@@ -6,21 +6,11 @@ import { RetryConfig } from "./retries.js";
|
|
|
6
6
|
* Production (default)
|
|
7
7
|
*/
|
|
8
8
|
export declare const ServerProduction = "production";
|
|
9
|
-
/**
|
|
10
|
-
* Staging
|
|
11
|
-
*/
|
|
12
|
-
export declare const ServerStaging = "staging";
|
|
13
|
-
/**
|
|
14
|
-
* Local development
|
|
15
|
-
*/
|
|
16
|
-
export declare const ServerLocal = "local";
|
|
17
9
|
/**
|
|
18
10
|
* Contains the list of servers available to the SDK
|
|
19
11
|
*/
|
|
20
12
|
export declare const ServerList: {
|
|
21
13
|
readonly production: "https://api.botshield.ai/operations";
|
|
22
|
-
readonly staging: "https://wg-staging.botshield.ai/operations";
|
|
23
|
-
readonly local: "http://localhost:9991/operations";
|
|
24
14
|
};
|
|
25
15
|
export type SDKOptions = {
|
|
26
16
|
/**
|
|
@@ -51,8 +41,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
|
|
|
51
41
|
export declare const SDK_METADATA: {
|
|
52
42
|
readonly language: "typescript";
|
|
53
43
|
readonly openapiDocVersion: "2.0.0";
|
|
54
|
-
readonly sdkVersion: "4.0.
|
|
44
|
+
readonly sdkVersion: "4.0.3";
|
|
55
45
|
readonly genVersion: "2.934.1";
|
|
56
|
-
readonly userAgent: "speakeasy-sdk/typescript 4.0.
|
|
46
|
+
readonly userAgent: "speakeasy-sdk/typescript 4.0.3 2.934.1 2.0.0 botshield-sdk";
|
|
57
47
|
};
|
|
58
48
|
//# sourceMappingURL=config.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C;;GAEG;AACH,eAAO,MAAM,
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAC7C;;GAEG;AACH,eAAO,MAAM,UAAU;;CAEb,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC;IAE1E,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,OAAO,UAAU,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,UAAU,GAAG,GAAG,GAAG,IAAI,CAYpE;AAED,eAAO,MAAM,YAAY;;;;;;CAMf,CAAC"}
|
package/dist/esm/lib/config.js
CHANGED
|
@@ -6,21 +6,11 @@ import { pathToFunc } from "./url.js";
|
|
|
6
6
|
* Production (default)
|
|
7
7
|
*/
|
|
8
8
|
export const ServerProduction = "production";
|
|
9
|
-
/**
|
|
10
|
-
* Staging
|
|
11
|
-
*/
|
|
12
|
-
export const ServerStaging = "staging";
|
|
13
|
-
/**
|
|
14
|
-
* Local development
|
|
15
|
-
*/
|
|
16
|
-
export const ServerLocal = "local";
|
|
17
9
|
/**
|
|
18
10
|
* Contains the list of servers available to the SDK
|
|
19
11
|
*/
|
|
20
12
|
export const ServerList = {
|
|
21
13
|
[ServerProduction]: "https://api.botshield.ai/operations",
|
|
22
|
-
[ServerStaging]: "https://wg-staging.botshield.ai/operations",
|
|
23
|
-
[ServerLocal]: "http://localhost:9991/operations",
|
|
24
14
|
};
|
|
25
15
|
export function serverURLFromOptions(options) {
|
|
26
16
|
let serverURL = options.serverURL;
|
|
@@ -35,8 +25,8 @@ export function serverURLFromOptions(options) {
|
|
|
35
25
|
export const SDK_METADATA = {
|
|
36
26
|
language: "typescript",
|
|
37
27
|
openapiDocVersion: "2.0.0",
|
|
38
|
-
sdkVersion: "4.0.
|
|
28
|
+
sdkVersion: "4.0.3",
|
|
39
29
|
genVersion: "2.934.1",
|
|
40
|
-
userAgent: "speakeasy-sdk/typescript 4.0.
|
|
30
|
+
userAgent: "speakeasy-sdk/typescript 4.0.3 2.934.1 2.0.0 botshield-sdk",
|
|
41
31
|
};
|
|
42
32
|
//# sourceMappingURL=config.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAU,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAC7C;;GAEG;AACH,MAAM,CAAC,MAAM,
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/lib/config.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAU,UAAU,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAC7C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,CAAC,gBAAgB,CAAC,EAAE,qCAAqC;CACjD,CAAC;AA6BX,MAAM,UAAU,oBAAoB,CAAC,OAAmB,EAAc;IACpE,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,gBAAgB,CAAC;QAClD,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AAAA,CACnB;AAED,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,OAAO;IAC1B,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,4DAA4D;CAC/D,CAAC"}
|
|
@@ -12,7 +12,7 @@ import { tool$actionsProposeAction } from "./tools/actions-propose-action.js";
|
|
|
12
12
|
export function createMCPServer(deps) {
|
|
13
13
|
const server = new McpServer({
|
|
14
14
|
name: "BotShield",
|
|
15
|
-
version: "4.0.
|
|
15
|
+
version: "4.0.3",
|
|
16
16
|
});
|
|
17
17
|
const client = new BotShieldCore({
|
|
18
18
|
security: deps.security,
|
|
@@ -19,7 +19,7 @@ export declare const BotShieldActionEnvironment: {
|
|
|
19
19
|
};
|
|
20
20
|
export type BotShieldActionEnvironment = OpenEnum<typeof BotShieldActionEnvironment>;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
|
|
23
23
|
*/
|
|
24
24
|
export declare const BotShieldActionKind: {
|
|
25
25
|
readonly Action: "action";
|
|
@@ -27,7 +27,7 @@ export declare const BotShieldActionKind: {
|
|
|
27
27
|
readonly Signin: "signin";
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
|
|
31
31
|
*/
|
|
32
32
|
export type BotShieldActionKind = OpenEnum<typeof BotShieldActionKind>;
|
|
33
33
|
/**
|
|
@@ -59,23 +59,23 @@ export type BotShieldAction = {
|
|
|
59
59
|
*/
|
|
60
60
|
staffCanSend?: boolean | undefined;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
|
|
63
63
|
*/
|
|
64
64
|
kind?: BotShieldActionKind | undefined;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* On a Sign-on Action, whether BotShield's own QR may finish a sign-in (default off: your page's passkey only). Always false on other kinds.
|
|
67
67
|
*/
|
|
68
68
|
signinQr?: boolean | undefined;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* A Recovery Action's new landing address while it waits to take effect (24 hours in Production; every admin is told). `where_url` is the address in effect until then.
|
|
71
71
|
*/
|
|
72
72
|
pendingWhereUrl?: string | null | undefined;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* When `pending_where_url` takes effect.
|
|
75
75
|
*/
|
|
76
76
|
pendingWhereUrlAt?: Date | null | undefined;
|
|
77
77
|
/**
|
|
78
|
-
*
|
|
78
|
+
* High-value. It starts only from your customer's signed-in session (your server naming the account by your own reference); by phone number or by staff it is refused (`action_requires_signed_in`). Set with `highValue` on create or update.
|
|
79
79
|
*/
|
|
80
80
|
highValue?: boolean | undefined;
|
|
81
81
|
};
|
|
@@ -18,7 +18,7 @@ export const BotShieldActionEnvironment = {
|
|
|
18
18
|
Production: "production",
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* `action` (a BotShield Action), `recovery` (your one Recovery Action: only your customer starts it, from the Recover Account with BotShield button) or `signin` (your one Sign-on Action: only signin/request starts it). Recovery and Sign-on Actions are placed in the Console; no `act`, server ask, send by number or staff send reaches them (`action_is_recovery` / `action_is_signin`). `action` on an engine before 4.0.
|
|
22
22
|
*/
|
|
23
23
|
export const BotShieldActionKind = {
|
|
24
24
|
Action: "action",
|
|
@@ -24,7 +24,7 @@ export type ErrorBody = {
|
|
|
24
24
|
message: string;
|
|
25
25
|
statusCode: number;
|
|
26
26
|
/**
|
|
27
|
-
* `ttl_below_floor`, `ttl_above_ceiling`, `trust_layer_rejected`, `trust_layer_unavailable`, `gate_required`, `alias_retired`, `RATE_LIMITED`, `inline_not_for_age_gate`, `act_label_has_link`, and in
|
|
27
|
+
* `ttl_below_floor`, `ttl_above_ceiling`, `trust_layer_rejected`, `trust_layer_unavailable`, `gate_required`, `alias_retired`, `RATE_LIMITED`, `inline_not_for_age_gate`, `act_label_has_link`, and in `link_requires_server_session`, `account_override_refused`, `action_is_recovery`, `action_is_signin`, `invalid_key`, `recovery_code_invalid`, `handle_invalid`, `signin_not_set_up`, `not_verified`, `account_paused`, `signin_unknown`, `signin_pending`, `signin_refused`, `signin_expired`, `signin_used`, `signin_wrong_account`, `unavailable`.
|
|
28
28
|
*/
|
|
29
29
|
code?: string | undefined;
|
|
30
30
|
minTtlSeconds?: number | undefined;
|
|
@@ -51,7 +51,7 @@ export type ActionsProposeRequest = {
|
|
|
51
51
|
*/
|
|
52
52
|
userEmail?: string | undefined;
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* The person's phone number, in place of `opaque_id` / `botshield_user_id` / `user_email` (never together with them). Used for one lookup, then dropped: never stored, logged or sent in a webhook. The answer is the same whether or not anyone holds the number. Show the returned `match_number` to the person; they pick it in the app before approving. A person not yet linked to your company gets an introduction first, never the card; the ask is held and becomes the card if they allow. An ask nobody answers reads `queued`, then `expired`. Production needs a verified business.
|
|
55
55
|
*/
|
|
56
56
|
phoneNumber?: string | undefined;
|
|
57
57
|
action: ActionsProposeAction;
|
|
@@ -23,7 +23,7 @@ export type GatesApiActionsCreateRequest = {
|
|
|
23
23
|
*/
|
|
24
24
|
staffCanSend?: boolean | undefined;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* High-value. It starts only from your customer's signed-in session (your server naming the account by your own reference). It is refused by phone number and for staff sends (`action_requires_signed_in`).
|
|
27
27
|
*/
|
|
28
28
|
highValue?: boolean | undefined;
|
|
29
29
|
};
|
|
@@ -41,7 +41,7 @@ export type GatesApiActionsCreateData = {
|
|
|
41
41
|
error?: models.GatesApiError | undefined;
|
|
42
42
|
};
|
|
43
43
|
/**
|
|
44
|
-
* The placed action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_key_taken` (409), `not_migrated` (503 — `staffCanSend` is not available yet), `internal` (500).
|
|
44
|
+
* The placed action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_key_taken` (409), `not_migrated` (503 — `staffCanSend` is not available yet), `internal` (500). Each action carries `kind` (`action`, `recovery` or `signin`), `signin_qr` and, for a Recovery Action, `pending_where_url` / `pending_where_url_at`. Recovery and Sign-on Actions are placed in the Console, not here.
|
|
45
45
|
*/
|
|
46
46
|
export type GatesApiActionsCreateResponse = {
|
|
47
47
|
data: GatesApiActionsCreateData;
|
|
@@ -16,7 +16,7 @@ export type GatesApiActionsListData = {
|
|
|
16
16
|
error?: models.GatesApiError | undefined;
|
|
17
17
|
};
|
|
18
18
|
/**
|
|
19
|
-
* Actions. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `internal` (500). Each action carries `staff_can_send`.
|
|
19
|
+
* Actions. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `internal` (500). Each action carries `staff_can_send`. Each action carries `kind` (`action`, `recovery` or `signin`), `signin_qr` and, for a Recovery Action, `pending_where_url` / `pending_where_url_at`. Recovery and Sign-on Actions are placed in the Console, not here.
|
|
20
20
|
*/
|
|
21
21
|
export type GatesApiActionsListResponse = {
|
|
22
22
|
data: GatesApiActionsListData;
|
|
@@ -32,7 +32,7 @@ export type GatesApiActionsRequestRequest = {
|
|
|
32
32
|
*/
|
|
33
33
|
partnerUserRef?: string | undefined;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* The person's phone number, in place of `partner_user_ref` (exactly one of the two). Used for one lookup, then dropped: never stored, logged or sent in a webhook. The answer is the same whether or not anyone holds the number. Show the returned `match_number` to the person; they pick it in the app before approving. A person not yet linked to your company gets an introduction first, never the card; the ask is held and becomes the card if they allow. An ask nobody answers reads `queued`, then `expired`. Production needs a verified business.
|
|
36
36
|
*/
|
|
37
37
|
phoneNumber?: string | undefined;
|
|
38
38
|
/**
|
|
@@ -73,7 +73,7 @@ export type GatesApiActionsRequestData = {
|
|
|
73
73
|
error?: models.GatesApiError | undefined;
|
|
74
74
|
};
|
|
75
75
|
/**
|
|
76
|
-
* Queued. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `org_not_found` (404), `action_invalid` (400), `action_not_found` (404), `action_off` (404), `agent_not_found` (404), `not_linked` (409 — the person isn't linked to your company), `details_invalid` (400), `agent_removed_by_person` (409 — the person removed this agent), `account_reconfirm_required` (409 — the customer changed their phone number without approval from another phone, so they must confirm this account with BotShield again from your signed-in page before anything can be sent to them; nothing is counted or sent), `request_id_reused` (409 — also when the same request_id is sent with other terms), `too_many_open_requests` (429 — this person already has 5 of your requests waiting; carries `retry_after_seconds`), `daily_request_limit` (429 — 50 requests to this person in 24 hours; carries `retry_after_seconds`), `request_limit_unavailable` (503 — the request could not be counted, so it was not sent; retry), `one_addressee_required` (400 — send exactly one of partner_user_ref and phone_number), `phone_invalid` (400), `org_not_verified` (403 — by phone number in production), `send_rate_limited` (429 — asks by phone number per key per hour), `unanswered_limit_reached` (429 — too many unanswered asks by phone number in 24 hours), `unavailable` (503), `internal` (500).
|
|
76
|
+
* Queued. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401), `gates_scope_required` (403), `org_not_found` (404), `action_invalid` (400), `action_not_found` (404), `action_off` (404), `agent_not_found` (404), `not_linked` (409 — the person isn't linked to your company), `details_invalid` (400), `agent_removed_by_person` (409 — the person removed this agent), `account_reconfirm_required` (409 — the customer changed their phone number without approval from another phone, so they must confirm this account with BotShield again from your signed-in page before anything can be sent to them; nothing is counted or sent), `request_id_reused` (409 — also when the same request_id is sent with other terms), `too_many_open_requests` (429 — this person already has 5 of your requests waiting; carries `retry_after_seconds`), `daily_request_limit` (429 — 50 requests to this person in 24 hours; carries `retry_after_seconds`), `request_limit_unavailable` (503 — the request could not be counted, so it was not sent; retry), `one_addressee_required` (400 — send exactly one of partner_user_ref and phone_number), `phone_invalid` (400), `org_not_verified` (403 — by phone number in production), `send_rate_limited` (429 — asks by phone number per key per hour), `unanswered_limit_reached` (429 — too many unanswered asks by phone number in 24 hours), `unavailable` (503), `internal` (500). `action_is_recovery` / `action_is_signin` (404 — that act is your Recovery Action or Sign-on Action, which no request starts).
|
|
77
77
|
*/
|
|
78
78
|
export type GatesApiActionsRequestResponse = {
|
|
79
79
|
data: GatesApiActionsRequestData;
|
|
@@ -32,7 +32,7 @@ export type GatesApiActionsSetStateData = {
|
|
|
32
32
|
error?: models.GatesApiError | undefined;
|
|
33
33
|
};
|
|
34
34
|
/**
|
|
35
|
-
* The action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_not_found` (404), `internal` (500). Each action carries `staff_can_send`.
|
|
35
|
+
* The action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: `invalid_key` (401 — missing, malformed or inactive key), `gates_scope_required` (403 — the key lacks Gates API access), `org_not_found` (404), `action_not_found` (404), `internal` (500). Each action carries `staff_can_send`. Each action carries `kind` (`action`, `recovery` or `signin`), `signin_qr` and, for a Recovery Action, `pending_where_url` / `pending_where_url_at`. Recovery and Sign-on Actions are placed in the Console, not here.
|
|
36
36
|
*/
|
|
37
37
|
export type GatesApiActionsSetStateResponse = {
|
|
38
38
|
data: GatesApiActionsSetStateData;
|