Class: Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest

Inherits:

Object

Object
Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

Overview

The request message to annotate an Assessment.

Defined Under Namespace

Modules: Annotation, Reason

Instance Attribute Summary collapse

#account_id ⇒ ::String
Optional.
#annotation ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation
Optional.
#hashed_account_id ⇒ ::String
Optional.
#name ⇒ ::String
Required.
#reasons ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>
Optional.
#transaction_event ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent
Optional.

Instance Attribute Details

#account_id ⇒ `::String`

Returns Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Returns:

(::String) —
Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

#annotation ⇒ `::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation`

Returns Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Returns:

(::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation) —
Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

#hashed_account_id ⇒ `::String`

Returns Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Returns:

(::String) —
Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

#name ⇒ `::String`

Returns Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Returns:

(::String) —
Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

#reasons ⇒ `::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>`

Returns Optional. Reasons for the annotation that are assigned to the event.

Returns:

(::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>) —
Optional. Reasons for the annotation that are assigned to the event.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

#transaction_event ⇒ `::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent`

Returns Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

Returns:

(::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent) —
Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 186

class AnnotateAssessmentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the types of annotations.
  module Annotation
    # Default unspecified type.
    ANNOTATION_UNSPECIFIED = 0

    # Provides information that the event turned out to be legitimate.
    LEGITIMATE = 1

    # Provides information that the event turned out to be fraudulent.
    FRAUDULENT = 2

    # Provides information that the event was related to a login event in which
    # the user typed the correct password. Deprecated, prefer indicating
    # CORRECT_PASSWORD through the reasons field instead.
    PASSWORD_CORRECT = 3

    # Provides information that the event was related to a login event in which
    # the user typed the incorrect password. Deprecated, prefer indicating
    # INCORRECT_PASSWORD through the reasons field instead.
    PASSWORD_INCORRECT = 4
  end

  # Enum that represents potential reasons for annotating an assessment.
  module Reason
    # Default unspecified reason.
    REASON_UNSPECIFIED = 0

    # Indicates that the transaction had a chargeback issued with no other
    # details. When possible, specify the type by using CHARGEBACK_FRAUD or
    # CHARGEBACK_DISPUTE instead.
    CHARGEBACK = 1

    # Indicates that the transaction had a chargeback issued related to an
    # alleged unauthorized transaction from the cardholder's perspective (for
    # example, the card number was stolen).
    CHARGEBACK_FRAUD = 8

    # Indicates that the transaction had a chargeback issued related to the
    # cardholder having provided their card details but allegedly not being
    # satisfied with the purchase (for example, misrepresentation, attempted
    # cancellation).
    CHARGEBACK_DISPUTE = 9

    # Indicates that the completed payment transaction was refunded by the
    # seller.
    REFUND = 10

    # Indicates that the completed payment transaction was determined to be
    # fraudulent by the seller, and was cancelled and refunded as a result.
    REFUND_FRAUD = 11

    # Indicates that the payment transaction was accepted, and the user was
    # charged.
    TRANSACTION_ACCEPTED = 12

    # Indicates that the payment transaction was declined, for example due to
    # invalid card details.
    TRANSACTION_DECLINED = 13

    # Indicates the transaction associated with the assessment is suspected of
    # being fraudulent based on the payment method, billing details, shipping
    # address or other transaction information.
    PAYMENT_HEURISTICS = 2

    # Indicates that the user was served a 2FA challenge. An old assessment
    # with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
    # overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
    # This is equivalent to `FAILED_TWO_FACTOR`.
    INITIATED_TWO_FACTOR = 7

    # Indicates that the user passed a 2FA challenge.
    PASSED_TWO_FACTOR = 3

    # Indicates that the user failed a 2FA challenge.
    FAILED_TWO_FACTOR = 4

    # Indicates the user provided the correct password.
    CORRECT_PASSWORD = 5

    # Indicates the user provided an incorrect password.
    INCORRECT_PASSWORD = 6

    # Indicates that the user sent unwanted and abusive messages to other users
    # of the platform, such as spam, scams, phishing, or social engineering.
    SOCIAL_SPAM = 14
  end
end

Class: Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ ::String

#annotation ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation

#hashed_account_id ⇒ ::String

#name ⇒ ::String

#reasons ⇒ ::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>

#transaction_event ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent

#account_id ⇒ `::String`

#annotation ⇒ `::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Annotation`

#hashed_account_id ⇒ `::String`

#name ⇒ `::String`

#reasons ⇒ `::Array<::Google::Cloud::RecaptchaEnterprise::V1::AnnotateAssessmentRequest::Reason>`

#transaction_event ⇒ `::Google::Cloud::RecaptchaEnterprise::V1::TransactionEvent`