declare module "wix-captcha.v2" {
interface CaptchaEntity {
}
interface CaptchaRequest {
/** The CAPTCHA token to authorize. */
token?: string;
/** @internal */
referrer?: string;
/** @internal */
siteKey?: string;
/** @internal */
action?: string;
}
interface CaptchaResponse {
/** Value is `true` when authorization is successful. */
success?: boolean;
/** Error information. */
errors?: Errors;
}
interface Errors {
/** ID of error. */
errorId?: number;
}
interface AssessmentResponse {
assessment?: string;
}
/**
* Authorizes a CAPTCHA token.
*
* Following CAPTCHA verification on the client side, you must authorize the generated CAPTCHA
* token in the backend.
*
* `Authorize` checks if the token is valid, making sure it was not tampered with or timed out.
*
* If you're developing a Wix site or Blocks app, call this method when working with the
* [Wix reCAPTCHA](https://dev.wix.com/docs/velo/api-reference/$w/captcha/introduction) element.
*
* If CAPTCHA token authorization fails, the method returns an error message containing a status code.
* The following table lists the possible HTTP error status codes, based on
* [RFC 2616](https://datatracker.ietf.org/doc/html/rfc2616#section-10):
*
*
* | Status Code | Name | Description |
* |---|---|---|
* | 400 | Bad Request | The request could not be understood by the server. This could occur for a number of reasons, such as:
- The request was sent without a token.
- The token is invalid.
- The token has timed out.
|
* | 401 | Unauthenticated | No user identity found in passed request. |
* | 500 | Internal Server Error | The server encountered an unexpected condition, such as a missing or invalid private CAPTCHA key. |
* | 503 | Unavailable | The service is unavailable due to one of the following: - Throttled error: Server overload due to more than the allowed requests in a given time frame.
- Request failed: No response following 10 retries with a 1-second interval.
|
* @param token - The CAPTCHA token to authorize.
* @public
* @documentationMaturity preview
* @requiredField token
* @adminMethod
*/
function authorize(token: string, options?: AuthorizeOptions): Promise;
interface AuthorizeOptions {
/** @internal */
referrer?: string;
/** @internal */
siteKey?: string;
/** @internal */
action?: string;
}
/** @internal
* @documentationMaturity preview
* @adminMethod
*/
function authorizeWithoutDomainValidation(options?: AuthorizeWithoutDomainValidationOptions): Promise;
interface AuthorizeWithoutDomainValidationOptions {
/** The CAPTCHA token to authorize. */
token?: string;
/** @internal */
referrer?: string;
/** @internal */
siteKey?: string;
/** @internal */
action?: string;
}
/** @internal
* @documentationMaturity preview
* @adminMethod
*/
function assessment(options?: AssessmentOptions): Promise;
interface AssessmentOptions {
/** The CAPTCHA token to authorize. */
token?: string;
/** @internal */
referrer?: string;
/** @internal */
siteKey?: string;
/** @internal */
action?: string;
}
type captcharatorV1CaptchaEntity_universal_d_CaptchaEntity = CaptchaEntity;
type captcharatorV1CaptchaEntity_universal_d_CaptchaRequest = CaptchaRequest;
type captcharatorV1CaptchaEntity_universal_d_CaptchaResponse = CaptchaResponse;
type captcharatorV1CaptchaEntity_universal_d_Errors = Errors;
type captcharatorV1CaptchaEntity_universal_d_AssessmentResponse = AssessmentResponse;
const captcharatorV1CaptchaEntity_universal_d_authorize: typeof authorize;
type captcharatorV1CaptchaEntity_universal_d_AuthorizeOptions = AuthorizeOptions;
const captcharatorV1CaptchaEntity_universal_d_authorizeWithoutDomainValidation: typeof authorizeWithoutDomainValidation;
type captcharatorV1CaptchaEntity_universal_d_AuthorizeWithoutDomainValidationOptions = AuthorizeWithoutDomainValidationOptions;
const captcharatorV1CaptchaEntity_universal_d_assessment: typeof assessment;
type captcharatorV1CaptchaEntity_universal_d_AssessmentOptions = AssessmentOptions;
namespace captcharatorV1CaptchaEntity_universal_d {
export {
captcharatorV1CaptchaEntity_universal_d_CaptchaEntity as CaptchaEntity,
captcharatorV1CaptchaEntity_universal_d_CaptchaRequest as CaptchaRequest,
captcharatorV1CaptchaEntity_universal_d_CaptchaResponse as CaptchaResponse,
captcharatorV1CaptchaEntity_universal_d_Errors as Errors,
captcharatorV1CaptchaEntity_universal_d_AssessmentResponse as AssessmentResponse,
captcharatorV1CaptchaEntity_universal_d_authorize as authorize,
captcharatorV1CaptchaEntity_universal_d_AuthorizeOptions as AuthorizeOptions,
captcharatorV1CaptchaEntity_universal_d_authorizeWithoutDomainValidation as authorizeWithoutDomainValidation,
captcharatorV1CaptchaEntity_universal_d_AuthorizeWithoutDomainValidationOptions as AuthorizeWithoutDomainValidationOptions,
captcharatorV1CaptchaEntity_universal_d_assessment as assessment,
captcharatorV1CaptchaEntity_universal_d_AssessmentOptions as AssessmentOptions,
};
}
export { captcharatorV1CaptchaEntity_universal_d as captcha };
}