@friendlycaptcha/server-sdk 0.1.0

package/docs/server-sdk.friendlycaptchaoptions.strict.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) &gt; [strict](./server-sdk.friendlycaptchaoptions.strict.md)
+
+## FriendlyCaptchaOptions.strict property
+
+Whether to use strict mode, which rejects all captcha responses which were not strictly verified.
+
+This is not recommended. Defaults to `false`<!-- -->.
+
+**Signature:**
+
+```typescript
+strict?: boolean;
+```

package/docs/server-sdk.md

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md)
+
+## server-sdk package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [FriendlyCaptchaClient](./server-sdk.friendlycaptchaclient.md) | A client for the Friendly Captcha API. |
+|  [VerifyResult](./server-sdk.verifyresult.md) | The result of a captcha siteverify request. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [FriendlyCaptchaOptions](./server-sdk.friendlycaptchaoptions.md) | Configuration options when creating a new <code>FriendlyCaptchaClient</code>. |
+|  [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) |  |
+|  [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) |  |
+|  [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) |  |
+|  [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) |  |
+|  [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE](./server-sdk.failed_due_to_client_error_code.md) | <p>An error occured on the client side that could've been prevented. This generally means your configuration is wrong.</p><p>Check your API key and sitekey.</p> |
+|  [FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE](./server-sdk.failed_to_decode_response_error_code.md) | The response from the Friendly Captcha API could not be decoded. |
+|  [FAILED\_TO\_ENCODE\_ERROR\_CODE](./server-sdk.failed_to_encode_error_code.md) | Failed to encode the captcha response. This means the captcha response was invalid and should never be accepted. |
+|  [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md) | The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable. |
+|  [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md) | The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [SiteverifyResponse](./server-sdk.siteverifyresponse.md) |  |
+|  [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) |  |
+

package/docs/server-sdk.request_failed_error_code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md)
+
+## REQUEST\_FAILED\_ERROR\_CODE variable
+
+The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
+
+**Signature:**
+
+```typescript
+REQUEST_FAILED_ERROR_CODE = "request_failed"
+```

package/docs/server-sdk.request_failed_timeout_error_code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md)
+
+## REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE variable
+
+The request couldn't be made, perhaps there is a network outage, DNS issue, or the API is unreachable.
+
+**Signature:**
+
+```typescript
+REQUEST_FAILED_TIMEOUT_ERROR_CODE = "request_failed_due_to_timeout"
+```

package/docs/server-sdk.siteverifyerrorresponse.error.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) &gt; [error](./server-sdk.siteverifyerrorresponse.error.md)
+
+## SiteverifyErrorResponse.error property
+
+**Signature:**
+
+```typescript
+error: SiteverifyErrorResponseErrorData;
+```

package/docs/server-sdk.siteverifyerrorresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md)
+
+## SiteverifyErrorResponse interface
+
+
+**Signature:**
+
+```typescript
+export interface SiteverifyErrorResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [error](./server-sdk.siteverifyerrorresponse.error.md) |  | [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) |  |
+|  [success](./server-sdk.siteverifyerrorresponse.success.md) |  | false |  |
+

package/docs/server-sdk.siteverifyerrorresponse.success.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md) &gt; [success](./server-sdk.siteverifyerrorresponse.success.md)
+
+## SiteverifyErrorResponse.success property
+
+**Signature:**
+
+```typescript
+success: false;
+```

package/docs/server-sdk.siteverifyerrorresponseerrordata.detail.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) &gt; [detail](./server-sdk.siteverifyerrorresponseerrordata.detail.md)
+
+## SiteverifyErrorResponseErrorData.detail property
+
+**Signature:**
+
+```typescript
+detail: string;
+```

package/docs/server-sdk.siteverifyerrorresponseerrordata.error_code.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) &gt; [error\_code](./server-sdk.siteverifyerrorresponseerrordata.error_code.md)
+
+## SiteverifyErrorResponseErrorData.error\_code property
+
+**Signature:**
+
+```typescript
+error_code: SiteverifyErrorCode;
+```

package/docs/server-sdk.siteverifyerrorresponseerrordata.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md)
+
+## SiteverifyErrorResponseErrorData interface
+
+
+**Signature:**
+
+```typescript
+export interface SiteverifyErrorResponseErrorData 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [detail](./server-sdk.siteverifyerrorresponseerrordata.detail.md) |  | string |  |
+|  [error\_code](./server-sdk.siteverifyerrorresponseerrordata.error_code.md) |  | SiteverifyErrorCode |  |
+

package/docs/server-sdk.siteverifyresponse.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponse](./server-sdk.siteverifyresponse.md)
+
+## SiteverifyResponse type
+
+
+**Signature:**
+
+```typescript
+export type SiteverifyResponse = SiteverifySuccessResponse | SiteverifyErrorResponse;
+```
+**References:** [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md)<!-- -->, [SiteverifyErrorResponse](./server-sdk.siteverifyerrorresponse.md)
+

package/docs/server-sdk.siteverifyresponsechallengedata.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md)
+
+## SiteverifyResponseChallengeData interface
+
+
+**Signature:**
+
+```typescript
+export interface SiteverifyResponseChallengeData 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [origin](./server-sdk.siteverifyresponsechallengedata.origin.md) |  | string | The origin of the site where the captcha was solved (if known, can be empty string if not known). |
+|  [timestamp](./server-sdk.siteverifyresponsechallengedata.timestamp.md) |  | string | Timestamp when the captcha challenge was completed (RFC3339). |
+

package/docs/server-sdk.siteverifyresponsechallengedata.origin.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) &gt; [origin](./server-sdk.siteverifyresponsechallengedata.origin.md)
+
+## SiteverifyResponseChallengeData.origin property
+
+The origin of the site where the captcha was solved (if known, can be empty string if not known).
+
+**Signature:**
+
+```typescript
+origin: string;
+```

package/docs/server-sdk.siteverifyresponsechallengedata.timestamp.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) &gt; [timestamp](./server-sdk.siteverifyresponsechallengedata.timestamp.md)
+
+## SiteverifyResponseChallengeData.timestamp property
+
+Timestamp when the captcha challenge was completed (RFC3339).
+
+**Signature:**
+
+```typescript
+timestamp: string;
+```

package/docs/server-sdk.siteverifyresponsedata.challenge.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) &gt; [challenge](./server-sdk.siteverifyresponsedata.challenge.md)
+
+## SiteverifyResponseData.challenge property
+
+**Signature:**
+
+```typescript
+challenge: SiteverifyResponseChallengeData;
+```

package/docs/server-sdk.siteverifyresponsedata.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md)
+
+## SiteverifyResponseData interface
+
+
+**Signature:**
+
+```typescript
+export interface SiteverifyResponseData 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [challenge](./server-sdk.siteverifyresponsedata.challenge.md) |  | [SiteverifyResponseChallengeData](./server-sdk.siteverifyresponsechallengedata.md) |  |
+

package/docs/server-sdk.siteverifysuccessresponse.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md) &gt; [data](./server-sdk.siteverifysuccessresponse.data.md)
+
+## SiteverifySuccessResponse.data property
+
+**Signature:**
+
+```typescript
+data: SiteverifyResponseData;
+```

package/docs/server-sdk.siteverifysuccessresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md)
+
+## SiteverifySuccessResponse interface
+
+
+**Signature:**
+
+```typescript
+export interface SiteverifySuccessResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./server-sdk.siteverifysuccessresponse.data.md) |  | [SiteverifyResponseData](./server-sdk.siteverifyresponsedata.md) |  |
+|  [success](./server-sdk.siteverifysuccessresponse.success.md) |  | true |  |
+

package/docs/server-sdk.siteverifysuccessresponse.success.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [SiteverifySuccessResponse](./server-sdk.siteverifysuccessresponse.md) &gt; [success](./server-sdk.siteverifysuccessresponse.success.md)
+
+## SiteverifySuccessResponse.success property
+
+**Signature:**
+
+```typescript
+success: true;
+```

package/docs/server-sdk.verifyclienterrorcode.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md)
+
+## VerifyClientErrorCode type
+
+
+**Signature:**
+
+```typescript
+export type VerifyClientErrorCode = typeof FAILED_TO_ENCODE_ERROR_CODE | typeof REQUEST_FAILED_ERROR_CODE | typeof REQUEST_FAILED_TIMEOUT_ERROR_CODE | typeof FAILED_DUE_TO_CLIENT_ERROR_CODE | typeof FAILED_TO_DECODE_RESPONSE_ERROR_CODE;
+```
+**References:** [FAILED\_TO\_ENCODE\_ERROR\_CODE](./server-sdk.failed_to_encode_error_code.md)<!-- -->, [REQUEST\_FAILED\_ERROR\_CODE](./server-sdk.request_failed_error_code.md)<!-- -->, [REQUEST\_FAILED\_TIMEOUT\_ERROR\_CODE](./server-sdk.request_failed_timeout_error_code.md)<!-- -->, [FAILED\_DUE\_TO\_CLIENT\_ERROR\_CODE](./server-sdk.failed_due_to_client_error_code.md)<!-- -->, [FAILED\_TO\_DECODE\_RESPONSE\_ERROR\_CODE](./server-sdk.failed_to_decode_response_error_code.md)
+

package/docs/server-sdk.verifyresult._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [(constructor)](./server-sdk.verifyresult._constructor_.md)
+
+## VerifyResult.(constructor)
+
+Constructs a new instance of the `VerifyResult` class
+
+**Signature:**
+
+```typescript
+constructor(strict: boolean);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  strict | boolean |  |
+

package/docs/server-sdk.verifyresult.clienterrortype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [clientErrorType](./server-sdk.verifyresult.clienterrortype.md)
+
+## VerifyResult.clientErrorType property
+
+**Signature:**
+
+```typescript
+clientErrorType: VerifyClientErrorCode | null;
+```

package/docs/server-sdk.verifyresult.geterrorcode.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getErrorCode](./server-sdk.verifyresult.geterrorcode.md)
+
+## VerifyResult.getErrorCode() method
+
+**Signature:**
+
+```typescript
+getErrorCode(): VerifyClientErrorCode | null;
+```
+**Returns:**
+
+[VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) \| null
+

package/docs/server-sdk.verifyresult.getresponse.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getResponse](./server-sdk.verifyresult.getresponse.md)
+
+## VerifyResult.getResponse() method
+
+**Signature:**
+
+```typescript
+getResponse(): SiteverifyResponse | null;
+```
+**Returns:**
+
+[SiteverifyResponse](./server-sdk.siteverifyresponse.md) \| null
+
+The response from the Friendly Captcha API, or null if the request was not made at all.
+

package/docs/server-sdk.verifyresult.getresponseerror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [getResponseError](./server-sdk.verifyresult.getresponseerror.md)
+
+## VerifyResult.getResponseError() method
+
+**Signature:**
+
+```typescript
+getResponseError(): SiteverifyErrorResponseErrorData | null;
+```
+**Returns:**
+
+[SiteverifyErrorResponseErrorData](./server-sdk.siteverifyerrorresponseerrordata.md) \| null
+
+The `error` field form the response, or null if it is not present.
+

package/docs/server-sdk.verifyresult.isclienterror.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isClientError](./server-sdk.verifyresult.isclienterror.md)
+
+## VerifyResult.isClientError() method
+
+Something went wrong on the client side, this generally means your configuration is wrong. Check your secrets (API key) and sitekey.
+
+See `getResponseError()` for more information.
+
+**Signature:**
+
+```typescript
+isClientError(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/server-sdk.verifyresult.isdecodeerror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isDecodeError](./server-sdk.verifyresult.isdecodeerror.md)
+
+## VerifyResult.isDecodeError() method
+
+Something went wrong decoding the response from the Friendly Captcha API.
+
+**Signature:**
+
+```typescript
+isDecodeError(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/server-sdk.verifyresult.isencodeerror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isEncodeError](./server-sdk.verifyresult.isencodeerror.md)
+
+## VerifyResult.isEncodeError() method
+
+Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted.
+
+**Signature:**
+
+```typescript
+isEncodeError(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/server-sdk.verifyresult.isrequestortimeouterror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isRequestOrTimeoutError](./server-sdk.verifyresult.isrequestortimeouterror.md)
+
+## VerifyResult.isRequestOrTimeoutError() method
+
+Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue?
+
+**Signature:**
+
+```typescript
+isRequestOrTimeoutError(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/server-sdk.verifyresult.isstrict.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [isStrict](./server-sdk.verifyresult.isstrict.md)
+
+## VerifyResult.isStrict() method
+
+**Signature:**
+
+```typescript
+isStrict(): boolean;
+```
+**Returns:**
+
+boolean
+
+Whether strict mode was enabled for this verification.
+

package/docs/server-sdk.verifyresult.md

@@ -0,0 +1,44 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md)
+
+## VerifyResult class
+
+The result of a captcha siteverify request.
+
+**Signature:**
+
+```typescript
+export declare class VerifyResult 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(strict)](./server-sdk.verifyresult._constructor_.md) |  | Constructs a new instance of the <code>VerifyResult</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [clientErrorType](./server-sdk.verifyresult.clienterrortype.md) |  | [VerifyClientErrorCode](./server-sdk.verifyclienterrorcode.md) \| null |  |
+|  [response](./server-sdk.verifyresult.response.md) |  | [SiteverifyResponse](./server-sdk.siteverifyresponse.md) \| null | The response from the Friendly Captcha API, or null if the request was not made at all. |
+|  [status](./server-sdk.verifyresult.status.md) |  | number | The HTTP status code of the response. <code>-1</code> if there was no response. |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getErrorCode()](./server-sdk.verifyresult.geterrorcode.md) |  |  |
+|  [getResponse()](./server-sdk.verifyresult.getresponse.md) |  |  |
+|  [getResponseError()](./server-sdk.verifyresult.getresponseerror.md) |  |  |
+|  [isClientError()](./server-sdk.verifyresult.isclienterror.md) |  | <p>Something went wrong on the client side, this generally means your configuration is wrong. Check your secrets (API key) and sitekey.</p><p>See <code>getResponseError()</code> for more information.</p> |
+|  [isDecodeError()](./server-sdk.verifyresult.isdecodeerror.md) |  | Something went wrong decoding the response from the Friendly Captcha API. |
+|  [isEncodeError()](./server-sdk.verifyresult.isencodeerror.md) |  | Was unable to encode the captcha response. This means the captcha response was invalid and should never be accepted. |
+|  [isRequestOrTimeoutError()](./server-sdk.verifyresult.isrequestortimeouterror.md) |  | Something went wrong making the request to the Friendly Captcha API, perhaps there is a network connection issue? |
+|  [isStrict()](./server-sdk.verifyresult.isstrict.md) |  |  |
+|  [shouldAccept()](./server-sdk.verifyresult.shouldaccept.md) |  |  |
+|  [shouldReject()](./server-sdk.verifyresult.shouldreject.md) |  |  |
+|  [wasAbleToVerify()](./server-sdk.verifyresult.wasabletoverify.md) |  | Whether the request to verify the captcha was completed. In other words: the API responded with status 200.' If this is false, you should notify yourself and use <code>getErrorCode()</code> and <code>getResponseError()</code> to see what is wrong. |
+

package/docs/server-sdk.verifyresult.response.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [response](./server-sdk.verifyresult.response.md)
+
+## VerifyResult.response property
+
+The response from the Friendly Captcha API, or null if the request was not made at all.
+
+**Signature:**
+
+```typescript
+response: SiteverifyResponse | null;
+```

package/docs/server-sdk.verifyresult.shouldaccept.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [shouldAccept](./server-sdk.verifyresult.shouldaccept.md)
+
+## VerifyResult.shouldAccept() method
+
+**Signature:**
+
+```typescript
+shouldAccept(): boolean;
+```
+**Returns:**
+
+boolean
+
+Whether the captcha should be accepted. Note that this does not necessarily mean it was verified.
+

package/docs/server-sdk.verifyresult.shouldreject.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [shouldReject](./server-sdk.verifyresult.shouldreject.md)
+
+## VerifyResult.shouldReject() method
+
+**Signature:**
+
+```typescript
+shouldReject(): boolean;
+```
+**Returns:**
+
+boolean
+
+The reverse of `shouldAccept()`<!-- -->.
+

package/docs/server-sdk.verifyresult.status.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@friendlycaptcha/server-sdk](./server-sdk.md) &gt; [VerifyResult](./server-sdk.verifyresult.md) &gt; [status](./server-sdk.verifyresult.status.md)
+
+## VerifyResult.status property
+
+The HTTP status code of the response. `-1` if there was no response.
+
+**Signature:**
+
+```typescript
+status: number;
+```