Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: minor wording and branding adjustments #27423

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ def initialize
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The name of the project in which the assessment will be created,
# Required. The name of the project in which the assessment is created,
# in the format `projects/{project_number}`.
# @param assessment [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment, ::Hash]
# Required. The assessment details.
Expand Down Expand Up @@ -279,8 +279,8 @@ def create_assessment request, options = nil
# Required. The resource name of the Assessment, in the format
# `projects/{project_number}/assessments/{assessment_id}`.
# @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::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
# Optional. The annotation that is 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.
# @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
# Optional. Reasons for the annotation that are assigned to the event.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ def initialize
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The name of the project in which the assessment will be created,
# Required. The name of the project in which the assessment is created,
# in the format `projects/{project_number}`.
# @param assessment [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment, ::Hash]
# Required. The assessment details.
Expand Down Expand Up @@ -265,8 +265,8 @@ def create_assessment request, options = nil
# Required. The resource name of the Assessment, in the format
# `projects/{project_number}/assessments/{assessment_id}`.
# @param annotation [::Google::Cloud::RecaptchaEnterprise::V1beta1::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
# Optional. The annotation that is 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.
# @param reasons [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
# Optional. Reasons for the annotation that are assigned to the event.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ module V1beta1
# The create assessment request message.
# @!attribute [rw] parent
# @return [::String]
# Required. The name of the project in which the assessment will be created,
# Required. The name of the project in which the assessment is created,
# in the format `projects/{project_number}`.
# @!attribute [rw] assessment
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Assessment]
Expand Down Expand Up @@ -162,8 +162,8 @@ module TransactionEventType
# `projects/{project_number}/assessments/{assessment_id}`.
# @!attribute [rw] annotation
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::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
# Optional. The annotation that is 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.
# @!attribute [rw] reasons
# @return [::Array<::Google::Cloud::RecaptchaEnterprise::V1beta1::AnnotateAssessmentRequest::Reason>]
Expand Down Expand Up @@ -364,12 +364,12 @@ module ClassificationReason

# @!attribute [rw] token
# @return [::String]
# Optional. The user response token provided by the reCAPTCHA Enterprise
# client-side integration on your site.
# Optional. The user response token provided by the reCAPTCHA client-side
# integration on your site.
# @!attribute [rw] site_key
# @return [::String]
# Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
# site and generate the token.
# Optional. The site key that was used to invoke reCAPTCHA on your site and
# generate the token.
# @!attribute [rw] user_agent
# @return [::String]
# Optional. The user agent present in the request from the user's device
Expand All @@ -382,15 +382,15 @@ module ClassificationReason
# @return [::String]
# Optional. The expected action for this type of event. This should be the
# same action provided at token generation time on client-side platforms
# already integrated with recaptcha enterprise.
# already integrated with reCAPTCHA.
# @!attribute [rw] hashed_account_id
# @return [::String]
# Optional. Unique stable hashed user identifier for the request. The
# identifier must be hashed using hmac-sha256 with stable secret.
# @!attribute [rw] transaction_data
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::TransactionData]
# Optional. Data describing a payment transaction to be assessed. Sending
# this data enables reCAPTCHA Enterprise Fraud Prevention and the
# this data enables reCAPTCHA Fraud Prevention and the
# FraudPreventionAssessment component in the response.
# @!attribute [rw] fraud_prevention
# @return [::Google::Cloud::RecaptchaEnterprise::V1beta1::Event::FraudPrevention]
Expand Down Expand Up @@ -418,7 +418,7 @@ module FraudPrevention
end
end

# Transaction data associated with a payment protected by reCAPTCHA Enterprise.
# Transaction data associated with a payment protected by reCAPTCHA.
# @!attribute [rw] transaction_id
# @return [::String]
# Unique identifier for the transaction. This custom identifier can be used
Expand Down Expand Up @@ -558,11 +558,11 @@ class Item
# @!attribute [rw] avs_response_code
# @return [::String]
# AVS response code from the gateway
# (available only when reCAPTCHA Enterprise is called after authorization).
# (available only when reCAPTCHA is called after authorization).
# @!attribute [rw] cvv_response_code
# @return [::String]
# CVV response code from the gateway
# (available only when reCAPTCHA Enterprise is called after authorization).
# (available only when reCAPTCHA is called after authorization).
class GatewayInfo
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down