AnnotateAssessmentRequest

google.cloud.recaptchaenterprise.v1beta1. AnnotateAssessmentRequest

Represents an AnnotateAssessmentRequest.

Constructor

new AnnotateAssessmentRequest(propertiesopt)

Constructs a new AnnotateAssessmentRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest <optional>

Properties to set
Implements:
  • IAnnotateAssessmentRequest

Members

annotation

AnnotateAssessmentRequest annotation.

hashedAccountId

AnnotateAssessmentRequest hashedAccountId.

name

AnnotateAssessmentRequest name.

reasons

AnnotateAssessmentRequest reasons.

transactionEvent

AnnotateAssessmentRequest transactionEvent.

Annotation

Annotation enum.

Properties:
Name Type Description
ANNOTATION_UNSPECIFIED number

ANNOTATION_UNSPECIFIED value
LEGITIMATE number

LEGITIMATE value
FRAUDULENT number

FRAUDULENT value
PASSWORD_CORRECT number

PASSWORD_CORRECT value
PASSWORD_INCORRECT number

PASSWORD_INCORRECT value

Reason

Reason enum.

Properties:
Name Type Description
REASON_UNSPECIFIED number

REASON_UNSPECIFIED value
CHARGEBACK number

CHARGEBACK value
CHARGEBACK_FRAUD number

CHARGEBACK_FRAUD value
CHARGEBACK_DISPUTE number

CHARGEBACK_DISPUTE value
REFUND number

REFUND value
REFUND_FRAUD number

REFUND_FRAUD value
TRANSACTION_ACCEPTED number

TRANSACTION_ACCEPTED value
TRANSACTION_DECLINED number

TRANSACTION_DECLINED value
PAYMENT_HEURISTICS number

PAYMENT_HEURISTICS value
INITIATED_TWO_FACTOR number

INITIATED_TWO_FACTOR value
PASSED_TWO_FACTOR number

PASSED_TWO_FACTOR value
FAILED_TWO_FACTOR number

FAILED_TWO_FACTOR value
CORRECT_PASSWORD number

CORRECT_PASSWORD value
INCORRECT_PASSWORD number

INCORRECT_PASSWORD value
SOCIAL_SPAM number

SOCIAL_SPAM value

Methods

toJSON() → {Object.<string, *>}

Converts this AnnotateAssessmentRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest}

Creates a new AnnotateAssessmentRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest <optional>

Properties to set
Returns:
Type Description
google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

AnnotateAssessmentRequest instance

(static) decode(reader, lengthopt) → {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest}

Decodes an AnnotateAssessmentRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

AnnotateAssessmentRequest
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest}

Decodes an AnnotateAssessmentRequest message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

AnnotateAssessmentRequest
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified AnnotateAssessmentRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest

AnnotateAssessmentRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified AnnotateAssessmentRequest message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest

AnnotateAssessmentRequest message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest}

Creates an AnnotateAssessmentRequest message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

AnnotateAssessmentRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AnnotateAssessmentRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an AnnotateAssessmentRequest message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest

AnnotateAssessmentRequest
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an AnnotateAssessmentRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not