diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/__init__.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/__init__.py index a4192178f092..74085402cea4 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/__init__.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/__init__.py @@ -34,6 +34,7 @@ AnnotateAssessmentResponse, AppleDeveloperId, Assessment, + AssessmentEnvironment, ChallengeMetrics, CreateAssessmentRequest, CreateFirewallPolicyRequest, @@ -102,6 +103,7 @@ "AnnotateAssessmentResponse", "AppleDeveloperId", "Assessment", + "AssessmentEnvironment", "ChallengeMetrics", "CreateAssessmentRequest", "CreateFirewallPolicyRequest", diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/gapic_version.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/gapic_version.py index 8b80cf328714..558c8aab67c5 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/gapic_version.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.22.0" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/__init__.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/__init__.py index f71b86ba1dc9..872b50ab387a 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/__init__.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/__init__.py @@ -32,6 +32,7 @@ AnnotateAssessmentResponse, AppleDeveloperId, Assessment, + AssessmentEnvironment, ChallengeMetrics, CreateAssessmentRequest, CreateFirewallPolicyRequest, @@ -99,6 +100,7 @@ "AnnotateAssessmentResponse", "AppleDeveloperId", "Assessment", + "AssessmentEnvironment", "ChallengeMetrics", "CreateAssessmentRequest", "CreateFirewallPolicyRequest", diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/gapic_version.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/gapic_version.py index 8b80cf328714..558c8aab67c5 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/gapic_version.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "1.22.0" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py index 8241b218d463..1ae940ad5ff1 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/async_client.py @@ -344,7 +344,7 @@ async def sample_create_assessment(): message. parent (:class:`str`): Required. The name of the project in which the - assessment will be created, in the format + assessment is created, in the format ``projects/{project}``. This corresponds to the ``parent`` field @@ -471,7 +471,7 @@ async def sample_annotate_assessment(): on the ``request`` instance; if ``request`` is provided, this should not be set. annotation (:class:`google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation`): - Optional. The annotation that will be + 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 @@ -587,8 +587,8 @@ async def sample_create_key(): request (Optional[Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]]): The request object. The create key request message. parent (:class:`str`): - Required. The name of the project in which the key will - be created, in the format ``projects/{project}``. + Required. The name of the project in which the key is + created, in the format ``projects/{project}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -705,8 +705,7 @@ async def sample_list_keys(): The request object. The list keys request message. parent (:class:`str`): Required. The name of the project that contains the keys - that will be listed, in the format - ``projects/{project}``. + that are listed, in the format ``projects/{project}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1052,7 +1051,7 @@ async def sample_update_key(): update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Optional. The mask to control which fields of the key get updated. If the - mask is not present, all fields will be + mask is not present, all fields are updated. This corresponds to the ``update_mask`` field @@ -1316,7 +1315,7 @@ async def add_ip_override( - The maximum number of IP overrides per key is 100. - For any conflict (such as IP already exists or IP part of an - existing IP range), an error will be returned. + existing IP range), an error is returned. .. code-block:: python @@ -1935,7 +1934,7 @@ async def sample_update_firewall_policy(): update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): Optional. The mask to control which fields of the policy get updated. If the - mask is not present, all fields will be + mask is not present, all fields are updated. This corresponds to the ``update_mask`` field diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py index 3369fc67c142..bd62b5ca1e8c 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/client.py @@ -829,7 +829,7 @@ def sample_create_assessment(): message. parent (str): Required. The name of the project in which the - assessment will be created, in the format + assessment is created, in the format ``projects/{project}``. This corresponds to the ``parent`` field @@ -953,7 +953,7 @@ def sample_annotate_assessment(): on the ``request`` instance; if ``request`` is provided, this should not be set. annotation (google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Annotation): - Optional. The annotation that will be + 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 @@ -1066,8 +1066,8 @@ def sample_create_key(): request (Union[google.cloud.recaptchaenterprise_v1.types.CreateKeyRequest, dict]): The request object. The create key request message. parent (str): - Required. The name of the project in which the key will - be created, in the format ``projects/{project}``. + Required. The name of the project in which the key is + created, in the format ``projects/{project}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1181,8 +1181,7 @@ def sample_list_keys(): The request object. The list keys request message. parent (str): Required. The name of the project that contains the keys - that will be listed, in the format - ``projects/{project}``. + that are listed, in the format ``projects/{project}``. This corresponds to the ``parent`` field on the ``request`` instance; if ``request`` is provided, this @@ -1523,7 +1522,7 @@ def sample_update_key(): update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. The mask to control which fields of the key get updated. If the - mask is not present, all fields will be + mask is not present, all fields are updated. This corresponds to the ``update_mask`` field @@ -1779,7 +1778,7 @@ def add_ip_override( - The maximum number of IP overrides per key is 100. - For any conflict (such as IP already exists or IP part of an - existing IP range), an error will be returned. + existing IP range), an error is returned. .. code-block:: python @@ -2383,7 +2382,7 @@ def sample_update_firewall_policy(): update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. The mask to control which fields of the policy get updated. If the - mask is not present, all fields will be + mask is not present, all fields are updated. This corresponds to the ``update_mask`` field diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py index 1e960bab7e13..bb598e78465f 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc.py @@ -504,7 +504,7 @@ def add_ip_override( - The maximum number of IP overrides per key is 100. - For any conflict (such as IP already exists or IP part of an - existing IP range), an error will be returned. + existing IP range), an error is returned. Returns: Callable[[~.AddIpOverrideRequest], diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py index d500b28f4a20..00886fe8df24 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/services/recaptcha_enterprise_service/transports/grpc_asyncio.py @@ -520,7 +520,7 @@ def add_ip_override( - The maximum number of IP overrides per key is 100. - For any conflict (such as IP already exists or IP part of an - existing IP range), an error will be returned. + existing IP range), an error is returned. Returns: Callable[[~.AddIpOverrideRequest], diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/__init__.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/__init__.py index 77aa68a2862c..230f8d821762 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/__init__.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/__init__.py @@ -23,6 +23,7 @@ AnnotateAssessmentResponse, AppleDeveloperId, Assessment, + AssessmentEnvironment, ChallengeMetrics, CreateAssessmentRequest, CreateFirewallPolicyRequest, @@ -89,6 +90,7 @@ "AnnotateAssessmentResponse", "AppleDeveloperId", "Assessment", + "AssessmentEnvironment", "ChallengeMetrics", "CreateAssessmentRequest", "CreateFirewallPolicyRequest", diff --git a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py index c4612c09acf2..129df8657cdd 100644 --- a/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py +++ b/packages/google-cloud-recaptcha-enterprise/google/cloud/recaptchaenterprise_v1/types/recaptchaenterprise.py @@ -87,6 +87,7 @@ "RelatedAccountGroupMembership", "RelatedAccountGroup", "WafSettings", + "AssessmentEnvironment", "IpOverrideData", }, ) @@ -97,8 +98,8 @@ class CreateAssessmentRequest(proto.Message): Attributes: parent (str): - Required. The name of the project in which the assessment - will be created, in the format ``projects/{project}``. + Required. The name of the project in which the assessment is + created, in the format ``projects/{project}``. assessment (google.cloud.recaptchaenterprise_v1.types.Assessment): Required. The assessment details. """ @@ -281,11 +282,11 @@ class AnnotateAssessmentRequest(proto.Message): Required. The resource name of the Assessment, in the format ``projects/{project}/assessments/{assessment}``. annotation (google.cloud.recaptchaenterprise_v1.types.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. + 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. reasons (MutableSequence[google.cloud.recaptchaenterprise_v1.types.AnnotateAssessmentRequest.Reason]): Optional. Reasons for the annotation that are assigned to the event. @@ -684,6 +685,11 @@ class Assessment(proto.Message): Output only. Assessment returned when a site key, a token, and a phone number as ``user_id`` are provided. Account defender and SMS toll fraud protection need to be enabled. + assessment_environment (google.cloud.recaptchaenterprise_v1.types.AssessmentEnvironment): + Optional. The environment creating the + assessment. This describes your environment (the + system invoking CreateAssessment), NOT the + environment of your user. """ name: str = proto.Field( @@ -740,6 +746,11 @@ class Assessment(proto.Message): number=12, message="PhoneFraudAssessment", ) + assessment_environment: "AssessmentEnvironment" = proto.Field( + proto.MESSAGE, + number=14, + message="AssessmentEnvironment", + ) class Event(proto.Message): @@ -775,7 +786,7 @@ class Event(proto.Message): express (bool): Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, ``site_key`` must - reference an Express site key. + reference an express key. requested_uri (str): Optional. The URI resource the user requested that triggered an assessment. @@ -792,15 +803,14 @@ class Event(proto.Message): firewall_policy_evaluation (bool): Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the - firewall policy will be evaluated and a - suggested firewall action will be returned in - the response. + firewall policy is evaluated and a suggested + firewall action is returned in the response. transaction_data (google.cloud.recaptchaenterprise_v1.types.TransactionData): Optional. Data describing a payment transaction to be assessed. Sending this data - enables reCAPTCHA Enterprise Fraud Prevention - and the FraudPreventionAssessment component in - the response. + enables reCAPTCHA Fraud Prevention and the + FraudPreventionAssessment component in the + response. user_info (google.cloud.recaptchaenterprise_v1.types.UserInfo): Optional. Information about the user that generates this event, when they can be @@ -1732,7 +1742,7 @@ class CreateKeyRequest(proto.Message): Attributes: parent (str): - Required. The name of the project in which the key will be + Required. The name of the project in which the key is created, in the format ``projects/{project}``. key (google.cloud.recaptchaenterprise_v1.types.Key): Required. Information to create a reCAPTCHA @@ -1756,7 +1766,7 @@ class ListKeysRequest(proto.Message): Attributes: parent (str): Required. The name of the project that contains the keys - that will be listed, in the format ``projects/{project}``. + that are listed, in the format ``projects/{project}``. page_size (int): Optional. The maximum number of keys to return. Default is 10. Max limit is 1000. @@ -1844,7 +1854,7 @@ class UpdateKeyRequest(proto.Message): update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. The mask to control which fields of the key get updated. If the mask is not present, - all fields will be updated. + all fields are updated. """ key: "Key" = proto.Field( @@ -1977,7 +1987,7 @@ class UpdateFirewallPolicyRequest(proto.Message): update_mask (google.protobuf.field_mask_pb2.FieldMask): Optional. The mask to control which fields of the policy get updated. If the mask is not - present, all fields will be updated. + present, all fields are updated. """ firewall_policy: "FirewallPolicy" = proto.Field( @@ -2090,12 +2100,12 @@ class Metrics(proto.Message): start_time (google.protobuf.timestamp_pb2.Timestamp): Inclusive start time aligned to a day (UTC). score_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ScoreMetrics]): - Metrics will be continuous and in order by - dates, and in the granularity of day. All Key - types should have score-based data. + Metrics are continuous and in order by dates, + and in the granularity of day. All Key types + should have score-based data. challenge_metrics (MutableSequence[google.cloud.recaptchaenterprise_v1.types.ChallengeMetrics]): - Metrics will be continuous and in order by - dates, and in the granularity of day. Only + Metrics are continuous and in order by dates, + and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. """ @@ -2175,8 +2185,8 @@ class Key(proto.Message): This field is a member of `oneof`_ ``platform_settings``. express_settings (google.cloud.recaptchaenterprise_v1.types.ExpressKeySettings): - Settings for keys that can be used by - reCAPTCHA Express. + Settings specific to keys that can be used + for reCAPTCHA Express. This field is a member of `oneof`_ ``platform_settings``. labels (MutableMapping[str, str]): @@ -2594,13 +2604,12 @@ class FirewallPolicyAssessment(proto.Message): Attributes: error (google.rpc.status_pb2.Status): Output only. If the processing of a policy config fails, an - error will be populated and the firewall_policy will be left - empty. + error is populated and the firewall_policy is left empty. firewall_policy (google.cloud.recaptchaenterprise_v1.types.FirewallPolicy): Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the - incoming request, the policy field will be left + incoming request, the policy field is left empty. """ @@ -3199,6 +3208,40 @@ class WafService(proto.Enum): ) +class AssessmentEnvironment(proto.Message): + r"""The environment creating the assessment. This describes your + environment (the system invoking CreateAssessment), NOT the + environment of your user. + + Attributes: + client (str): + Optional. Identifies the client module + initiating the CreateAssessment request. This + can be the link to the client module's project. + Examples include: + + - + "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" + - + "cloud.google.com/recaptcha/docs/implement-waf-akamai" + - + "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" + - "wordpress.org/plugins/recaptcha-something". + version (str): + Optional. The version of the client module. + For example, "1.0.0". + """ + + client: str = proto.Field( + proto.STRING, + number=1, + ) + version: str = proto.Field( + proto.STRING, + number=2, + ) + + class IpOverrideData(proto.Message): r"""Information about the IP or IP range override. diff --git a/packages/google-cloud-recaptcha-enterprise/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json b/packages/google-cloud-recaptcha-enterprise/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json index cc98231dae95..b2ad3f987f98 100644 --- a/packages/google-cloud-recaptcha-enterprise/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json +++ b/packages/google-cloud-recaptcha-enterprise/samples/generated_samples/snippet_metadata_google.cloud.recaptchaenterprise.v1.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-cloud-recaptcha-enterprise", - "version": "1.22.0" + "version": "0.1.0" }, "snippets": [ {